network/message.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 _MESSAGE_H_
  22 #define _MESSAGE_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   int cmdCode;
  41   QString cmd;
  42   QString cmdDescr;
  43   QString args;
  44   QString argsDescr;
  45   recvHandlerType recvHandler;
  46   sendHandlerType sendHandler;
  47
  48 };
  49
  50 /**
  51  *
  52 */
  53 class Message {
  54   public:
  55     Message(Server *server, Buffer *buffer, QString cmd, QString prefix, QStringList args = QStringList());
  56
  57     virtual ~Message() {};
  58
  59     static void init(recvHandlerType defaultRevcHandler, sendHandlerType defaultSendHandler);
  60     static Message * createFromServerString(Server *server, QString srvMsg);
  61     //static Message * createFromUserString(Server *server, Buffer *buffer, QString usrMsg);
  62     //static registerCmd();
  63     //static unregisterCmd();
  64
  65     inline Server * getServer() { return server; }
  66     inline Buffer * getBuffer() { return buffer; }
  67     inline int getCmdCode() { return cmdCode; }
  68     inline QString getPrefix() { return prefix; }
  69     inline QString getCmd() { return cmd; }
  70     inline QStringList getParams() { return params; }
  71     inline recvHandlerType getRecvHandler();
  72     inline sendHandlerType getSendHandler();
  73
  74   protected:
  75     Server *server;
  76     Buffer *buffer;
  77     int cmdCode;
  78     QString prefix;
  79     QString cmd;
  80     QStringList params;
  81     recvHandlerType recvHandler;
  82     sendHandlerType sendHandler;
  83     static recvHandlerType defaultRecvHandler;
  84     static sendHandlerType defaultSendHandler;
  85
  86     static QHash<QString, CmdType> cmdTypes;
  87 };
  88
  89
  90 /** This is only used to have a nice way for defining builtin commands.
  91  *  We create an array of these in builtin_cmds.cpp and read this to fill our
  92  *  command hash.
  93  */
  94 struct BuiltinCmd {
  95   int cmdCode;
  96   QString cmd;
  97   QString cmdDescr;
  98   QString args;
  99   QString argsDescr;
 100   recvHandlerType recvHandler;
 101   sendHandlerType sendHandler;
 102 };
 103
 104 #endif