Main Page | Namespace List | Class Hierarchy | Alphabetical List | Class List | Directories | File List | Namespace Members | Class Members | File Members

home » brain » inspircd-cvs » inspircd » include

ctables.h

Go to the documentation of this file.

/*       +------------------------------------+
 *       | Inspire Internet Relay Chat Daemon |
 *       +------------------------------------+
 *
 *  InspIRCd: (C) 2002-2008 InspIRCd Development Team
 * See: http://www.inspircd.org/wiki/index.php/Credits
 *
 * This program is free but copyrighted software; see
 *            the file COPYING for details.
 *
 * ---------------------------------------------------
 */
 
#ifndef __CTABLES_H__
#define __CTABLES_H__

enum CmdResult
{
        CMD_FAILURE = 0,        /* Command exists, but failed */
        CMD_SUCCESS = 1,        /* Command exists, and succeeded */
        CMD_INVALID = 2         /* Command doesnt exist at all! */
};

enum TranslateType
{
        TR_END,                 /* End of known parameters, everything after this is TR_TEXT */
        TR_TEXT,                /* Raw text, leave as-is */
        TR_NICK,                /* Nickname, translate to UUID for server->server */
        TR_NICKLIST,            /* Comma seperated nickname list, translate to UUIDs */
        TR_SPACENICKLIST,       /* Space seperated nickname list, translate to UUIDs */
        TR_CUSTOM               /* Custom translation handled by EncodeParameter/DecodeParameter */
};

#define CMD_LOCALONLY CMD_FAILURE


class CoreExport Command : public Extensible
{
 protected:
        InspIRCd* ServerInstance;
 public:
         std::string command;
        char flags_needed;
        unsigned int min_params;
        long double use_count;
        long double total_bytes;
        std::string source;
        bool disabled;
        bool works_before_reg;
        std::string syntax;

        std::vector<TranslateType> translation;

        const int Penalty;

        Command(InspIRCd* Instance, const std::string &cmd, const char *flags, int minpara, int before_reg = false, int penalty = 1) :  ServerInstance(Instance), command(cmd), flags_needed(flags ? *flags : 0), min_params(minpara), disabled(false), works_before_reg(before_reg),   Penalty(penalty)
        {
                use_count = 0;
                total_bytes = 0;
                source = "<core>";
                syntax = "";
                translation.clear();
        }

        virtual CmdResult Handle(const std::vector<std::string>& parameters, User* user) = 0;

        virtual CmdResult HandleInternal(const unsigned int /* id */, const std::deque<classbase*>& /* params */)
        {
                return CMD_INVALID;
        }

        virtual CmdResult HandleServer(const std::vector<std::string>& /* parameters */, const std::string& /* servername */)
        {
                return CMD_INVALID;
        }

        virtual void EncodeParameter(std::string& parameter, int index)
        {
        }

        virtual void DecodeParameter(std::string& parameter, int index)
        {
        }

        void Disable(bool setting)
        {
                disabled = setting;
        }

        bool IsDisabled()
        {
                return disabled;
        }

        bool WorksBeforeReg()
        {
                return works_before_reg;
        }

        virtual ~Command()
        {
                syntax.clear();
        }
};

typedef nspace::hash_map<std::string,Command*> Commandtable;

#define TRANSLATE1(x1)  translation.push_back(x1);
#define TRANSLATE2(x1,x2)  translation.push_back(x1);translation.push_back(x2);
#define TRANSLATE3(x1,x2,x3)  translation.push_back(x1);translation.push_back(x2);translation.push_back(x3);
#define TRANSLATE4(x1,x2,x3,x4)  translation.push_back(x1);translation.push_back(x2);translation.push_back(x3);translation.push_back(x4);
#define TRANSLATE5(x1,x2,x3,x4,x5)  translation.push_back(x1);translation.push_back(x2);translation.push_back(x3);translation.push_back(x4);\
        translation.push_back(x5);
#define TRANSLATE6(x1,x2,x3,x4,x5,x6)  translation.push_back(x1);translation.push_back(x2);translation.push_back(x3);translation.push_back(x4);\
        translation.push_back(x5);translation.push_back(x6);
#define TRANSLATE7(x1,x2,x3,x4,x5,x6,x7)  translation.push_back(x1);translation.push_back(x2);translation.push_back(x3);translation.push_back(x4);\
        translation.push_back(x5);translation.push_back(x6);translation.push_back(x7);
#define TRANSLATE8(x1,x2,x3,x4,x5,x6,x7,x8)  translation.push_back(x1);translation.push_back(x2);translation.push_back(x3);translation.push_back(x4);\
        translation.push_back(x5);translation.push_back(x6);translation.push_back(x7);translation.push_back(x8);

#endif