src/console.hpp

   1 //  $Id: worldmap.hpp 3209 2006-04-02 22:19:22Z sommer $
   2 //
   3 //  SuperTux - Console
   4 //  Copyright (C) 2006 Christoph Sommer <christoph.sommer@2006.expires.deltadevelopment.de>
   5 //
   6 //  This program is free software; you can redistribute it and/or
   7 //  modify it under the terms of the GNU General Public License
   8 //  as published by the Free Software Foundation; either version 2
   9 //  of the License, or (at your option) any later version.
  10 //
  11 //  This program is distributed in the hope that it will be useful,
  12 //  but WITHOUT ANY WARRANTY; without even the implied warranty of
  13 //  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  14 //  GNU General Public License for more details.
  15 //
  16 //  You should have received a copy of the GNU General Public License
  17 //  along with this program; if not, write to the Free Software
  18 //  Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.
  19
  20 #ifndef SUPERTUX_CONSOLE_H
  21 #define SUPERTUX_CONSOLE_H
  22
  23 #include <list>
  24 #include <map>
  25 #include <vector>
  26 #include <string>
  27 #include <sstream>
  28 #include <iostream>
  29
  30 class Console;
  31 class ConsoleStreamBuffer;
  32 class ConsoleCommandReceiver;
  33 class DrawingContext;
  34 class Surface;
  35
  36 class Console
  37 {
  38 public:
  39   Console();
  40   ~Console();
  41
  42   static Console* instance;
  43
  44   static std::ostream input; /**< stream of keyboard input to send to the console. Do not forget to send std::endl or to flush the stream. */
  45   static std::ostream output; /**< stream of characters to output to the console. Do not forget to send std::endl or to flush the stream. */
  46
  47   void backspace(); /**< delete last character sent to the input stream */
  48   void scroll(int offset); /**< scroll console text up or down by @c offset lines */
  49   void autocomplete(); /**< autocomplete current command */
  50
  51   void draw(DrawingContext& context); /**< draw the console in a DrawingContext */
  52   void update(float elapsed_time);
  53
  54   void show(); /**< display the console */
  55   void hide(); /**< hide the console */
  56   void toggle(); /**< display the console if hidden, hide otherwise */
  57
  58   bool hasFocus(); /**< true if characters should be sent to the console instead of their normal target */
  59   void registerCommand(std::string command, ConsoleCommandReceiver* ccr); /**< associate command with the given CCR */
  60   void unregisterCommand(std::string command, ConsoleCommandReceiver* ccr); /**< dissociate command and CCR */
  61   void unregisterCommands(ConsoleCommandReceiver* ccr); /**< dissociate all commands of given CCR */
  62
  63   template<typename T> static bool string_is(std::string s) {
  64     std::istringstream iss(s);
  65     T i;
  66     if ((iss >> i) && iss.eof()) {
  67       return true;
  68     } else {
  69       return false;
  70     }
  71   }
  72
  73   template<typename T> static T string_to(std::string s) {
  74     std::istringstream iss(s);
  75     T i;
  76     if ((iss >> i) && iss.eof()) {
  77       return i;
  78     } else {
  79       return T();
  80     }
  81   }
  82
  83 private:
  84   std::list<std::string> lines; /**< backbuffer of lines sent to the console */
  85   std::map<std::string, std::list<ConsoleCommandReceiver*> > commands; /**< map of console commands and a list of associated ConsoleCommandReceivers */
  86
  87   std::auto_ptr<Surface> background; /**< console background image */
  88   std::auto_ptr<Surface> background2; /**< second, moving console background image */
  89
  90   int backgroundOffset; /**< current offset of scrolling background image */
  91   float height; /**< height of the console in px */
  92   int offset; /**< decrease to scroll text up */
  93   bool focused; /**< true if console has input focus */
  94
  95   float stayOpen;
  96
  97   static ConsoleStreamBuffer inputBuffer; /**< stream buffer used by input stream */
  98   static ConsoleStreamBuffer outputBuffer; /**< stream buffer used by output stream */
  99
 100   void addLine(std::string s); /**< display a line in the console */
 101   void parse(std::string s); /**< react to a given command */
 102
 103   /** execute squirrel script and output result */
 104   void execute_script(const std::string& s);
 105
 106   bool consoleCommand(std::string command, std::vector<std::string> arguments); /**< process internal command; return false if command was unknown, true otherwise */
 107
 108   friend class ConsoleStreamBuffer;
 109   void flush(ConsoleStreamBuffer* buffer); /**< act upon changes in a ConsoleStreamBuffer */
 110 };
 111
 112 class ConsoleStreamBuffer : public std::stringbuf
 113 {
 114   public:
 115     int sync()
 116     {
 117       int result = std::stringbuf::sync();
 118       if(Console::instance != NULL)
 119         Console::instance->flush(this);
 120       return result;
 121     }
 122 };
 123
 124 class ConsoleCommandReceiver
 125 {
 126 public:
 127   virtual ~ConsoleCommandReceiver()
 128   {
 129     Console::instance->unregisterCommands(this);
 130   }
 131
 132   /**
 133    * callback from Console; return false if command was unknown,
 134    * true otherwise
 135    */
 136   virtual bool consoleCommand(std::string command, std::vector<std::string> arguments) = 0;
 137 };
 138
 139 #endif