2 // Copyright (C) 2006 Christoph Sommer <christoph.sommer@2006.expires.deltadevelopment.de>
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.
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.
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/>.
17 #ifndef HEADER_SUPERTUX_SUPERTUX_CONSOLE_HPP
18 #define HEADER_SUPERTUX_SUPERTUX_CONSOLE_HPP
26 #include "util/currenton.hpp"
27 #include "video/font_ptr.hpp"
28 #include "video/surface_ptr.hpp"
31 class ConsoleStreamBuffer;
32 class ConsoleCommandReceiver;
35 class Console : public Currenton<Console>
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. */
45 void input(char c); /**< add character to inputBuffer */
46 void backspace(); /**< delete character left of inputBufferPosition */
47 void eraseChar(); /**< delete character at inputBufferPosition */
48 void enter(); /**< process and clear input stream */
49 void scroll(int offset); /**< scroll console text up or down by @c offset lines */
50 void autocomplete(); /**< autocomplete current command */
51 void show_history(int offset); /**< move @c offset lines forward through history; Negative offset moves backward */
52 void move_cursor(int offset); /**< move the cursor @c offset chars to the right; Negative offset moves backward; 0xFFFF moves to the end */
54 void draw(DrawingContext& context); /**< draw the console in a DrawingContext */
55 void update(float elapsed_time);
57 void show(); /**< display the console */
58 void open(); /**< open the console for viewing for 6 seconds */
59 void hide(); /**< hide the console */
60 void toggle(); /**< display the console if hidden, hide otherwise */
62 bool hasFocus(); /**< true if characters should be sent to the console instead of their normal target */
65 std::list<std::string> history; /**< command history. New lines get added to back. */
66 std::list<std::string>::iterator history_position; /**< item of command history that is currently displayed */
67 std::list<std::string> lines; /**< backbuffer of lines sent to the console. New lines get added to front. */
69 SurfacePtr background; /**< console background image */
70 SurfacePtr background2; /**< second, moving console background image */
72 HSQUIRRELVM vm; /**< squirrel thread for the console (with custom roottable) */
75 int backgroundOffset; /**< current offset of scrolling background image */
76 float height; /**< height of the console in px */
78 int offset; /**< decrease to scroll text up */
79 bool focused; /**< true if console has input focus */
81 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 */
85 static int inputBufferPosition; /**< position in inputBuffer before which to append new characters */
86 static std::string inputBuffer; /**< string used for keyboard input */
87 static ConsoleStreamBuffer outputBuffer; /**< stream buffer used by output stream */
89 void addLines(std::string s); /**< display a string of (potentially) multiple lines in the console */
90 void addLine(std::string s); /**< display a line in the console */
91 void parse(std::string s); /**< react to a given command */
93 /** ready a virtual machine instance, creating a new thread and loading default .nut files if needed */
96 /** execute squirrel script and output result */
97 void execute_script(const std::string& s);
99 bool consoleCommand(std::string command, std::vector<std::string> arguments); /**< process internal command; return false if command was unknown, true otherwise */
101 friend class ConsoleStreamBuffer;
102 void flush(ConsoleStreamBuffer* buffer); /**< act upon changes in a ConsoleStreamBuffer */
105 Console(const Console&);
106 Console & operator=(const Console&);
109 class ConsoleStreamBuffer : public std::stringbuf
114 int result = std::stringbuf::sync();
115 if(Console::current())
116 Console::current()->flush(this);