command.hpp

   1 #ifndef _command__hpp__included__
   2 #define _command__hpp__included__
   3
   4 #include <stdexcept>
   5 #include <string>
   6
   7
   8 class window;
   9
  10 /**
  11  * A command.
  12  */
  13 class command
  14 {
  15 public:
  16 /**
  17  * Register a new command.
  18  *
  19  * parameter cmd: The command to register.
  20  * throws std::bad_alloc: Not enough memory.
  21  */
  22         command(const std::string& cmd) throw(std::bad_alloc);
  23
  24 /**
  25  * Deregister a command.
  26  */
  27         virtual ~command() throw();
  28
  29 /**
  30  * Invoke a command.
  31  *
  32  * parameter arguments: Arguments to command.
  33  * parameter window: Handle to graphics system.
  34  * throws std::bad_alloc: Not enough memory.
  35  * throws std::runtime_error: Command execution failed.
  36  */
  37         virtual void invoke(const std::string& arguments, window* win) throw(std::bad_alloc, std::runtime_error) = 0;
  38
  39 /**
  40  * Look up and invoke a command. The command will undergo alias expansion and recursion checking.
  41  *
  42  * parameter cmd: Command to exeucte.
  43  * parameter window: Handle to graphics system.
  44  */
  45         static void invokeC(const std::string& cmd, window* win) throw();
  46
  47 /**
  48  * Get short help for command.
  49  */
  50         virtual std::string get_short_help() throw(std::bad_alloc);
  51
  52 /**
  53  * Get long help for command.
  54  */
  55         virtual std::string get_long_help() throw(std::bad_alloc);
  56 private:
  57         command(const command&);
  58         command& operator=(const command&);
  59         std::string commandname;
  60 };
  61
  62 /**
  63  * Splits string to fields on ' ' and '\t', with multiple whitespace collapsed into one.
  64  */
  65 class tokensplitter
  66 {
  67 public:
  68 /**
  69  * Create a new splitter.
  70  *
  71  * parameter _line: The line to start splitting.
  72  * throws std::bad_alloc: Not enough memory.
  73  */
  74         tokensplitter(const std::string& _line) throw(std::bad_alloc);
  75 /**
  76  * Is there more coming?
  77  *
  78  * returns: True if there is more, false otherwise.
  79  * throws std::bad_alloc: Not enough memory.
  80  */
  81         operator bool() throw();
  82 /**
  83  * Get the next token.
  84  *
  85  * returns: The next token from line. If there is no more tokens, returns "".
  86  * throws std::bad_alloc: Not enough memory.
  87  */
  88         operator std::string() throw(std::bad_alloc);
  89 /**
  90  * Get all that is remaining.
  91  *
  92  * returns: All remaining parts of line as-is.
  93  * throws std::bad_alloc: Not enough memory.
  94  */
  95         std::string tail() throw(std::bad_alloc);
  96 private:
  97         std::string line;
  98         size_t position;
  99 };
 100
 101
 102 #endif