ryzom/client/src/commands.h

   1 // Ryzom - MMORPG Framework <http://dev.ryzom.com/projects/ryzom/>
   2 // Copyright (C) 2010  Winch Gate Property Limited
   3 //
   4 // This source file has been modified by the following contributors:
   5 // Copyright (C) 2012  Laszlo KIS-ADAM (dfighter) <dfighter1985@gmail.com>
   6 //
   7 // This program is free software: you can redistribute it and/or modify
   8 // it under the terms of the GNU Affero General Public License as
   9 // published by the Free Software Foundation, either version 3 of the
  10 // License, or (at your option) any later version.
  11 //
  12 // This program is distributed in the hope that it will be useful,
  13 // but WITHOUT ANY WARRANTY; without even the implied warranty of
  14 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  15 // GNU Affero General Public License for more details.
  16 //
  17 // You should have received a copy of the GNU Affero General Public License
  18 // along with this program.  If not, see <http://www.gnu.org/licenses/>.
  19
  20
  21
  22 #ifndef CL_COMMANDS_H
  23 #define CL_COMMANDS_H
  24
  25 #include "nel/misc/types_nl.h"
  26
  27
  28 /// Function to release all things allocated for commands.
  29 void releaseCommands();
  30
  31 /**
  32   * User command class. This NeL command is binded to an action handler with the commands.xml file.
  33   */
  34 class CUserCommand : public NLMISC::ICommand
  35 {
  36 public:
  37         // Mode
  38         class CMode
  39         {
  40         public:
  41                 uint                                    KeywordsCount;
  42                 std::string                             Action;
  43                 std::vector<std::string>                Keywords;
  44         };
  45
  46         CUserCommand (const std::string &commandName, const std::string &help, const std::string &argsHelp);
  47
  48         void addMode (const std::string &action, uint numArg, bool infiniteAgr, const std::vector<std::string> &keywords);
  49
  50         // From ICommand
  51         virtual bool execute(const std::string &rawCommandString, const std::vector<std::string> &args, NLMISC::CLog &log, bool quiet, bool human);
  52
  53         // Create a command
  54         static void createCommand (const char *name, const char *action, const char *params);
  55
  56         // release memory
  57         static void release();
  58
  59         // The command map
  60         static std::map<std::string, CUserCommand*> CommandMap;
  61
  62         // Strings
  63         CMode                                                                   InfiniteMode;
  64         std::map<uint, CMode>                                   FixedArgModes;
  65         std::string     CommandName;
  66         std::string     Params;
  67 };
  68
  69 #endif // CL_COMMANDS_H
  70
  71 /* End of console.h */