network/messages.h

   1 /***************************************************************************
   2  *   Copyright (C) 2005/06 by The Quassel Team                             *
   3  *   devel@quassel-irc.org                                                 *
   4  *                                                                         *
   5  *   This program is free software; you can redistribute it and/or modify  *
   6  *   it under the terms of the GNU General Public License as published by  *
   7  *   the Free Software Foundation; either version 2 of the License, or     *
   8  *   (at your option) any later version.                                   *
   9  *                                                                         *
  10  *   This program is distributed in the hope that it will be useful,       *
  11  *   but WITHOUT ANY WARRANTY; without even the implied warranty of        *
  12  *   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the         *
  13  *   GNU General Public License for more details.                          *
  14  *                                                                         *
  15  *   You should have received a copy of the GNU General Public License     *
  16  *   along with this program; if not, write to the                         *
  17  *   Free Software Foundation, Inc.,                                       *
  18  *   59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.             *
  19  ***************************************************************************/
  20
  21 #ifndef _MESSAGES_H_
  22 #define _MESSAGES_H_
  23
  24 #include <QHash>
  25 #include <QString>
  26 #include <QStringList>
  27
  28 class Server;
  29 class Buffer;
  30 class Message;
  31
  32 typedef void (*sendHandlerType)(Message *);        // handler for commands sent by the user
  33 typedef void (*recvHandlerType)(Message *);              // handler for incoming messages
  34
  35 /**
  36  * This contains information that depends (solely) on the message type, such as the handler function and help texts.
  37  * Most of these are defined at compile time, but more may be added at runtime.
  38  */
  39 struct CmdType {
  40   QString cmd;
  41   QString cmdDescr;
  42   QString args;
  43   QString argsDescr;
  44   recvHandlerType recvHandler;
  45   sendHandlerType sendHandler;
  46
  47 };
  48
  49 /**
  50  *
  51 */
  52 class Message {
  53   public:
  54     uint type;
  55     QString prefix;
  56     QString cmd;
  57     QStringList params;
  58
  59     Message(QString cmd, QStringList args = QStringList());
  60
  61     virtual ~Message() {};
  62
  63     static void init(recvHandlerType defaultRevcHandler, sendHandlerType defaultSendHandler);
  64     //static registerCmd();
  65     //static unregisterCmd();
  66
  67     recvHandlerType getRecvHandler();
  68     sendHandlerType getSendHandler();
  69
  70   protected:
  71     static recvHandlerType defaultRecvHandler;
  72     static sendHandlerType defaultSendHandler;
  73
  74     static QHash<QString, CmdType> cmdTypes;
  75 };
  76
  77
  78 /** This is only used to have a nice way for defining builtin commands.
  79  *  We create an array of these in builtin_cmds.cpp and read this to fill our
  80  *  command hash.
  81  */
  82 struct BuiltinCmd {
  83   QString cmd;
  84   QString cmdDescr;
  85   QString args;
  86   QString argsDescr;
  87   recvHandlerType recvHandler;
  88   sendHandlerType sendHandler;
  89 };
  90
  91 #endif