4 // Copyright (C) 2006 Christoph Sommer <christoph.sommer@2006.expires.deltadevelopment.de>
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.
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.
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.
20 #ifndef SUPERTUX_CONSOLE_H
21 #define SUPERTUX_CONSOLE_H
32 class ConsoleStreamBuffer;
33 class ConsoleCommandReceiver;
44 static Console* instance;
46 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. */
47 static std::ostream output; /**< stream of characters to output to the console. Do not forget to send std::endl or to flush the stream. */
51 void backspace(); /**< delete last character sent to the input stream */
52 void scroll(int offset); /**< scroll console text up or down by @c offset lines */
53 void autocomplete(); /**< autocomplete current command */
54 void show_history(int offset); /**< move @c offset lines forward through history; Negative offset moves backward */
56 void draw(DrawingContext& context); /**< draw the console in a DrawingContext */
57 void update(float elapsed_time);
59 void show(); /**< display the console */
60 void hide(); /**< hide the console */
61 void toggle(); /**< display the console if hidden, hide otherwise */
63 bool hasFocus(); /**< true if characters should be sent to the console instead of their normal target */
64 void registerCommand(std::string command, ConsoleCommandReceiver* ccr); /**< associate command with the given CCR */
65 void unregisterCommand(std::string command, ConsoleCommandReceiver* ccr); /**< dissociate command and CCR */
66 void unregisterCommands(ConsoleCommandReceiver* ccr); /**< dissociate all commands of given CCR */
68 template<typename T> static bool string_is(std::string s) {
69 std::istringstream iss(s);
71 if ((iss >> i) && iss.eof()) {
78 template<typename T> static T string_to(std::string s) {
79 std::istringstream iss(s);
81 if ((iss >> i) && iss.eof()) {
89 std::list<std::string> history; /**< command history. New lines get added to back. */
90 std::list<std::string>::iterator history_position; /**< item of command history that is currently displayed */
91 std::list<std::string> lines; /**< backbuffer of lines sent to the console. New lines get added to front. */
92 std::map<std::string, std::list<ConsoleCommandReceiver*> > commands; /**< map of console commands and a list of associated ConsoleCommandReceivers */
94 std::auto_ptr<Surface> background; /**< console background image */
95 std::auto_ptr<Surface> background2; /**< second, moving console background image */
97 HSQUIRRELVM vm; /**< squirrel thread for the console (with custom roottable) */
100 int backgroundOffset; /**< current offset of scrolling background image */
101 float height; /**< height of the console in px */
103 int offset; /**< decrease to scroll text up */
104 bool focused; /**< true if console has input focus */
105 std::auto_ptr<Font> font;
106 float fontheight; /**< height of the font (this is a separate var, because the font could not be initialized yet but is needed in the addLine message */
110 static ConsoleStreamBuffer inputBuffer; /**< stream buffer used by input stream */
111 static ConsoleStreamBuffer outputBuffer; /**< stream buffer used by output stream */
113 void addLines(std::string s); /**< display a string of (potentially) multiple lines in the console */
114 void addLine(std::string s); /**< display a line in the console */
115 void parse(std::string s); /**< react to a given command */
117 /** ready a virtual machine instance, creating a new thread and loading default .nut files if needed */
120 /** execute squirrel script and output result */
121 void execute_script(const std::string& s);
123 bool consoleCommand(std::string command, std::vector<std::string> arguments); /**< process internal command; return false if command was unknown, true otherwise */
125 friend class ConsoleStreamBuffer;
126 void flush(ConsoleStreamBuffer* buffer); /**< act upon changes in a ConsoleStreamBuffer */
129 class ConsoleStreamBuffer : public std::stringbuf
134 int result = std::stringbuf::sync();
135 if(Console::instance != NULL)
136 Console::instance->flush(this);
141 class ConsoleCommandReceiver
144 virtual ~ConsoleCommandReceiver()
146 Console::instance->unregisterCommands(this);
150 * callback from Console; return false if command was unknown,
153 virtual bool consoleCommand(std::string command, std::vector<std::string> arguments) = 0;