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 Message;
  29
  30 typedef void (Message::* cmdhandler)(QStringList);
  31
  32 /**
  33  * This contains information that depends (solely) on the message type, such as the handler function and help texts.
  34  * Most of these are defined at compile time, but more may be added at runtime.
  35  */
  36 struct CmdType {
  37   QString cmd;
  38   QString cmdDescr;
  39   QString args;
  40   QString argsDescr;
  41   cmdhandler handler;
  42
  43 };
  44
  45 /**
  46  *
  47 */
  48 class Message {
  49   public:
  50     uint type;
  51     QString prefix;
  52     QString cmd;
  53     QStringList params;
  54
  55     Message(QString cmd, QStringList args = QStringList());
  56
  57     virtual ~Message() {};
  58
  59     static void init();
  60     //static registerCmd();
  61     //static unregisterCmd();
  62
  63     cmdhandler getCmdHandler();
  64
  65     void test1(QStringList);
  66     void test2(QStringList);
  67
  68   protected:
  69     static QHash<QString, CmdType> cmdTypes;
  70 };
  71
  72
  73 /** This is only used to have a nice way for defining builtin commands.
  74  *  We create an array of these in builtin_cmds.cpp and read this to fill our
  75  *  command hash.
  76  */
  77 struct BuiltinCmd {
  78   QString cmd;
  79   QString cmdDescr;
  80   QString args;
  81   QString argsDescr;
  82   cmdhandler handler;
  83 };
  84
  85 #endif