src/supertux/console.hpp

   1 //  SuperTux - Console
   2 //  Copyright (C) 2006 Christoph Sommer <christoph.sommer@2006.expires.deltadevelopment.de>
   3 //
   4 //  This program is free software: you can redistribute it and/or modify
   5 //  it under the terms of the GNU General Public License as published by
   6 //  the Free Software Foundation, either version 3 of the License, or
   7 //  (at your option) any later version.
   8 //
   9 //  This program is distributed in the hope that it will be useful,
  10 //  but WITHOUT ANY WARRANTY; without even the implied warranty of
  11 //  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  12 //  GNU General Public License for more details.
  13 //
  14 //  You should have received a copy of the GNU General Public License
  15 //  along with this program.  If not, see <http://www.gnu.org/licenses/>.
  16
  17 #ifndef HEADER_SUPERTUX_SUPERTUX_CONSOLE_HPP
  18 #define HEADER_SUPERTUX_SUPERTUX_CONSOLE_HPP
  19
  20 #include <list>
  21 #include <memory>
  22 #include <squirrel.h>
  23 #include <sstream>
  24 #include <vector>
  25
  26 #include "util/currenton.hpp"
  27 #include "video/font_ptr.hpp"
  28 #include "video/surface_ptr.hpp"
  29
  30 class Console;
  31 class ConsoleStreamBuffer;
  32 class ConsoleCommandReceiver;
  33 class DrawingContext;
  34
  35 class Console : public Currenton<Console>
  36 {
  37 public:
  38   Console();
  39   ~Console();
  40
  41   static std::ostream output; /**< stream of characters to output to the console. Do not forget to send std::endl or to flush the stream. */
  42
  43   void input(char c); /**< add character to inputBuffer */
  44   void backspace(); /**< delete character left of inputBufferPosition */
  45   void eraseChar(); /**< delete character at inputBufferPosition */
  46   void enter(); /**< process and clear input stream */
  47   void scroll(int offset); /**< scroll console text up or down by @c offset lines */
  48   void autocomplete(); /**< autocomplete current command */
  49   void show_history(int offset); /**< move @c offset lines forward through history; Negative offset moves backward */
  50   void move_cursor(int offset); /**< move the cursor @c offset chars to the right; Negative offset moves backward; 0xFFFF moves to the end */
  51
  52   void draw(DrawingContext& context); /**< draw the console in a DrawingContext */
  53   void update(float elapsed_time);
  54
  55   void show(); /**< display the console */
  56   void open(); /**< open the console for viewing for 6 seconds */
  57   void hide(); /**< hide the console */
  58   void toggle(); /**< display the console if hidden, hide otherwise */
  59
  60   bool hasFocus(); /**< true if characters should be sent to the console instead of their normal target */
  61
  62 private:
  63   std::list<std::string> m_history; /**< command history. New lines get added to back. */
  64   std::list<std::string>::iterator m_history_position; /**< item of command history that is currently displayed */
  65   std::list<std::string> m_lines; /**< backbuffer of lines sent to the console. New lines get added to front. */
  66
  67   SurfacePtr m_background; /**< console background image */
  68   SurfacePtr m_background2; /**< second, moving console background image */
  69
  70   HSQUIRRELVM m_vm; /**< squirrel thread for the console (with custom roottable) */
  71   HSQOBJECT m_vm_object;
  72
  73   int m_backgroundOffset; /**< current offset of scrolling background image */
  74   float m_height; /**< height of the console in px */
  75   float m_alpha;
  76   int m_offset; /**< decrease to scroll text up */
  77   bool m_focused; /**< true if console has input focus */
  78   FontPtr m_font;
  79
  80   float m_stayOpen;
  81
  82   static int inputBufferPosition; /**< position in inputBuffer before which to append new characters */
  83   static std::string inputBuffer; /**< string used for keyboard input */
  84   static ConsoleStreamBuffer outputBuffer; /**< stream buffer used by output stream */
  85
  86   void addLines(std::string s); /**< display a string of (potentially) multiple lines in the console */
  87   void addLine(std::string s); /**< display a line in the console */
  88   void parse(std::string s); /**< react to a given command */
  89
  90   /** ready a virtual machine instance, creating a new thread and loading default .nut files if needed */
  91   void ready_vm();
  92
  93   /** execute squirrel script and output result */
  94   void execute_script(const std::string& s);
  95
  96   bool consoleCommand(std::string command, std::vector<std::string> arguments); /**< process internal command; return false if command was unknown, true otherwise */
  97
  98   friend class ConsoleStreamBuffer;
  99   void flush(ConsoleStreamBuffer* buffer); /**< act upon changes in a ConsoleStreamBuffer */
 100
 101 private:
 102   Console(const Console&);
 103   Console & operator=(const Console&);
 104 };
 105
 106 class ConsoleStreamBuffer : public std::stringbuf
 107 {
 108 public:
 109   int sync()
 110   {
 111     int result = std::stringbuf::sync();
 112     if(Console::current())
 113       Console::current()->flush(this);
 114     return result;
 115   }
 116 };
 117
 118 #endif
 119
 120 /* EOF */