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.
22 #include <SDL_timer.h>
23 #include "console.hpp"
24 #include "video/drawing_context.hpp"
25 #include "video/surface.hpp"
26 #include "scripting/squirrel_error.hpp"
27 #include "scripting/squirrel_util.hpp"
28 #include "physfs/physfs_stream.hpp"
29 #include "player_status.hpp"
32 #include "resources.hpp"
33 #include "gameconfig.hpp"
35 /// speed (pixels/s) the console closes
36 static const float FADE_SPEED = 1;
39 : history_position(history.end()), vm(NULL), backgroundOffset(0),
40 height(0), alpha(1.0), offset(0), focused(false), stayOpen(0) {
47 sq_release(Scripting::global_vm, &vm_object);
52 Console::init_graphics()
54 font.reset(new Font(Font::FIXED,
55 "images/engine/fonts/andale12.png",
56 "images/engine/fonts/andale12-shadow.png", 7, 14, 1));
57 fontheight = font->get_height();
58 background.reset(new Surface("images/engine/console.png"));
59 background2.reset(new Surface("images/engine/console2.png"));
63 Console::flush(ConsoleStreamBuffer* buffer)
65 if (buffer == &outputBuffer) {
66 std::string s = outputBuffer.str();
67 if ((s.length() > 0) && ((s[s.length()-1] == '\n') || (s[s.length()-1] == '\r'))) {
68 while ((s[s.length()-1] == '\n') || (s[s.length()-1] == '\r')) s.erase(s.length()-1);
70 outputBuffer.str(std::string());
73 if (buffer == &inputBuffer) {
74 std::string s = inputBuffer.str();
75 if ((s.length() > 0) && ((s[s.length()-1] == '\n') || (s[s.length()-1] == '\r'))) {
76 while ((s[s.length()-1] == '\n') || (s[s.length()-1] == '\r')) s.erase(s.length()-1);
86 vm = Scripting::global_vm;
87 HSQUIRRELVM new_vm = sq_newthread(vm, 16);
89 throw Scripting::SquirrelError(vm, "Couldn't create new VM thread for console");
91 // store reference to thread
92 sq_resetobject(&vm_object);
93 if(SQ_FAILED(sq_getstackobj(vm, -1, &vm_object)))
94 throw Scripting::SquirrelError(vm, "Couldn't get vm object for console");
95 sq_addref(vm, &vm_object);
98 // create new roottable for thread
100 sq_pushroottable(new_vm);
101 if(SQ_FAILED(sq_setdelegate(new_vm, -2)))
102 throw Scripting::SquirrelError(new_vm, "Couldn't set console_table delegate");
104 sq_setroottable(new_vm);
109 std::string filename = "scripts/console.nut";
110 IFileStream stream(filename);
111 Scripting::compile_and_run(vm, stream, filename);
112 } catch(std::exception& e) {
113 log_warning << "Couldn't load console.nut: " << e.what() << std::endl;
119 Console::execute_script(const std::string& command)
121 using namespace Scripting;
125 SQInteger oldtop = sq_gettop(vm);
127 if(SQ_FAILED(sq_compilebuffer(vm, command.c_str(), command.length(),
129 throw SquirrelError(vm, "Couldn't compile command");
131 sq_pushroottable(vm);
132 if(SQ_FAILED(sq_call(vm, 1, SQTrue, SQTrue)))
133 throw SquirrelError(vm, "Problem while executing command");
135 if(sq_gettype(vm, -1) != OT_NULL)
136 addLines(squirrel2string(vm, -1));
137 } catch(std::exception& e) {
140 SQInteger newtop = sq_gettop(vm);
141 if(newtop < oldtop) {
142 log_fatal << "Script destroyed squirrel stack..." << std::endl;
144 sq_settop(vm, oldtop);
151 std::string s = inputBuffer.str();
152 if (s.length() > 0) {
153 s.erase(s.length()-1);
155 inputBuffer.pubseekoff(0, std::ios_base::end, std::ios_base::out);
162 std::string s = inputBuffer.str();
165 inputBuffer.str(std::string());
169 Console::scroll(int numLines)
172 if (offset > 0) offset = 0;
176 Console::show_history(int offset)
178 while ((offset > 0) && (history_position != history.end())) {
182 while ((offset < 0) && (history_position != history.begin())) {
186 if (history_position == history.end()) {
187 inputBuffer.str(std::string());
189 inputBuffer.str(*history_position);
190 inputBuffer.pubseekoff(0, std::ios_base::end, std::ios_base::out);
195 Console::move_cursor(int offset)
197 if (offset == -65535) inputBuffer.pubseekoff(0, std::ios_base::beg, std::ios_base::out);
198 if (offset == +65535) inputBuffer.pubseekoff(0, std::ios_base::end, std::ios_base::out);
199 inputBuffer.pubseekoff(offset, std::ios_base::cur, std::ios_base::out);
202 // Helper functions for Console::autocomplete
203 // TODO: Fix rough documentation
206 void sq_insert_commands(std::list<std::string>& cmds, HSQUIRRELVM vm, std::string table_prefix, std::string search_prefix);
209 * Acts upon key,value on top of stack:
210 * Appends key (plus type-dependent suffix) to cmds if table_prefix+key starts with search_prefix;
211 * Calls sq_insert_commands if search_prefix starts with table_prefix+key (and value is a table/class/instance);
214 sq_insert_command(std::list<std::string>& cmds, HSQUIRRELVM vm, std::string table_prefix, std::string search_prefix)
216 const SQChar* key_chars;
217 if (SQ_FAILED(sq_getstring(vm, -2, &key_chars))) return;
218 std::string key_string = table_prefix + key_chars;
220 switch (sq_gettype(vm, -1)) {
223 if (search_prefix.substr(0, key_string.length()) == key_string) {
225 sq_insert_commands(cmds, vm, key_string, search_prefix);
232 if (search_prefix.substr(0, key_string.length()) == key_string) {
233 sq_insert_commands(cmds, vm, key_string, search_prefix);
237 case OT_NATIVECLOSURE:
244 if (key_string.substr(0, search_prefix.length()) == search_prefix) {
245 cmds.push_back(key_string);
251 * calls sq_insert_command for all entries of table/class on top of stack
254 sq_insert_commands(std::list<std::string>& cmds, HSQUIRRELVM vm, std::string table_prefix, std::string search_prefix)
256 sq_pushnull(vm); // push iterator
257 while (SQ_SUCCEEDED(sq_next(vm,-2))) {
258 sq_insert_command(cmds, vm, table_prefix, search_prefix);
259 sq_pop(vm, 2); // pop key, val
261 sq_pop(vm, 1); // pop iterator
266 // End of Console::autocomplete helper functions
269 Console::autocomplete()
271 std::string prefix = inputBuffer.str();
272 addLines("> "+prefix);
274 std::list<std::string> cmds;
278 // append all keys of the current root table to list
279 sq_pushroottable(vm); // push root table
281 // check all keys (and their children) for matches
282 sq_insert_commands(cmds, vm, "", prefix);
284 // cycle through parent(delegate) table
285 SQInteger oldtop = sq_gettop(vm);
286 if(SQ_FAILED(sq_getdelegate(vm, -1)) || oldtop == sq_gettop(vm)) {
289 sq_remove(vm, -2); // remove old table
291 sq_pop(vm, 1); // remove table
293 // depending on number of hits, show matches or autocomplete
294 if (cmds.size() == 0) addLines("No known command starts with \""+prefix+"\"");
295 if (cmds.size() == 1) {
296 // one match: just replace input buffer with full command
297 inputBuffer.str(cmds.front());
298 inputBuffer.pubseekoff(0, std::ios_base::end, std::ios_base::out);
300 if (cmds.size() > 1) {
301 // multiple matches: show all matches and set input buffer to longest common prefix
302 std::string commonPrefix = cmds.front();
303 while (cmds.begin() != cmds.end()) {
304 std::string cmd = cmds.front();
307 for (int n = commonPrefix.length(); n >= 1; n--) {
308 if (cmd.compare(0, n, commonPrefix) != 0) commonPrefix.resize(n-1); else break;
311 inputBuffer.str(commonPrefix);
312 inputBuffer.pubseekoff(0, std::ios_base::end, std::ios_base::out);
317 Console::addLines(std::string s)
319 std::istringstream iss(s);
321 while (std::getline(iss, line, '\n')) addLine(line);
325 Console::addLine(std::string s)
327 // output line to stderr
328 std::cerr << s << std::endl;
331 std::string overflow;
333 lines.push_front(Font::wrap_to_chars(s, 99, &overflow));
335 } while (s.length() > 0);
337 // trim scrollback buffer
338 while (lines.size() >= 1000)
341 // increase console height if necessary
345 height += fontheight;
348 // reset console to full opacity
351 // increase time that console stays open
357 Console::parse(std::string s)
359 // make sure we actually have something to parse
360 if (s.length() == 0) return;
362 // add line to history
363 history.push_back(s);
364 history_position = history.end();
366 // split line into list of args
367 std::vector<std::string> args;
371 start = s.find_first_not_of(" ,", end);
372 end = s.find_first_of(" ,", start);
373 if (start == s.npos) break;
374 args.push_back(s.substr(start, end-start));
377 // command is args[0]
378 if (args.size() == 0) return;
379 std::string command = args.front();
380 args.erase(args.begin());
382 // ignore if it's an internal command
383 if (consoleCommand(command,args)) return;
387 } catch(std::exception& e) {
394 Console::consoleCommand(std::string /*command*/, std::vector<std::string> /*arguments*/)
408 if(!config->console_enabled)
414 SDL_EnableKeyRepeat(SDL_DEFAULT_REPEAT_DELAY, SDL_DEFAULT_REPEAT_INTERVAL);
424 // clear input buffer
425 inputBuffer.str(std::string());
426 SDL_EnableKeyRepeat(0, SDL_DEFAULT_REPEAT_INTERVAL);
432 if (Console::hasFocus()) {
441 Console::update(float elapsed_time)
444 stayOpen -= elapsed_time;
447 } else if(!focused && height > 0) {
448 alpha -= elapsed_time * FADE_SPEED;
457 Console::draw(DrawingContext& context)
462 int layer = LAYER_GUI + 1;
464 context.push_transform();
465 context.set_alpha(alpha);
466 context.draw_surface(background2.get(), Vector(SCREEN_WIDTH/2 - background->get_width()/2 - background->get_width() + backgroundOffset, height - background->get_height()), layer);
467 context.draw_surface(background2.get(), Vector(SCREEN_WIDTH/2 - background->get_width()/2 + backgroundOffset, height - background->get_height()), layer);
468 context.draw_surface(background.get(), Vector(SCREEN_WIDTH/2 - background->get_width()/2, height - background->get_height()), layer);
469 backgroundOffset+=10;
470 if (backgroundOffset > (int)background->get_width()) backgroundOffset -= (int)background->get_width();
476 float py = height-4-1 * font->get_height();
477 context.draw_text(font.get(), "> "+inputBuffer.str(), Vector(4, py), ALIGN_LEFT, layer);
478 if (SDL_GetTicks() % 1000 < 750) {
479 int cursor_px = 2 + inputBuffer.pubseekoff(0, std::ios_base::cur, std::ios_base::out);
480 context.draw_text(font.get(), "_", Vector(4 + (cursor_px * font->get_text_width("X")), py), ALIGN_LEFT, layer);
484 int skipLines = -offset;
485 for (std::list<std::string>::iterator i = lines.begin(); i != lines.end(); i++) {
486 if (skipLines-- > 0) continue;
488 float py = height - 4 - lineNo*font->get_height();
489 if (py < -font->get_height()) break;
490 context.draw_text(font.get(), *i, Vector(4, py), ALIGN_LEFT, layer);
492 context.pop_transform();
495 Console* Console::instance = NULL;
496 ConsoleStreamBuffer Console::inputBuffer;
497 ConsoleStreamBuffer Console::outputBuffer;
498 std::ostream Console::input(&Console::inputBuffer);
499 std::ostream Console::output(&Console::outputBuffer);