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 "console.hpp"
23 #include "video/drawing_context.hpp"
24 #include "video/surface.hpp"
25 #include "scripting/squirrel_error.hpp"
26 #include "scripting/squirrel_util.hpp"
27 #include "physfs/physfs_stream.hpp"
28 #include "player_status.hpp"
31 #include "resources.hpp"
32 #include "gameconfig.hpp"
34 /// speed (pixels/s) the console closes
35 static const float FADE_SPEED = 1;
38 : history_position(history.end()), vm(NULL), backgroundOffset(0),
39 height(0), alpha(1.0), offset(0), focused(false), stayOpen(0) {
46 sq_release(Scripting::global_vm, &vm_object);
51 Console::init_graphics()
53 font.reset(new Font(Font::FIXED,
54 "images/engine/fonts/white-small.png",
55 "images/engine/fonts/shadow-small.png", 8, 9, 1));
56 fontheight = font->get_height();
57 background.reset(new Surface("images/engine/console.png"));
58 background2.reset(new Surface("images/engine/console2.png"));
62 Console::flush(ConsoleStreamBuffer* buffer)
64 if (buffer == &outputBuffer) {
65 std::string s = outputBuffer.str();
66 if ((s.length() > 0) && ((s[s.length()-1] == '\n') || (s[s.length()-1] == '\r'))) {
67 while ((s[s.length()-1] == '\n') || (s[s.length()-1] == '\r')) s.erase(s.length()-1);
69 outputBuffer.str(std::string());
72 if (buffer == &inputBuffer) {
73 std::string s = inputBuffer.str();
74 if ((s.length() > 0) && ((s[s.length()-1] == '\n') || (s[s.length()-1] == '\r'))) {
75 while ((s[s.length()-1] == '\n') || (s[s.length()-1] == '\r')) s.erase(s.length()-1);
78 inputBuffer.str(std::string());
87 vm = Scripting::global_vm;
88 HSQUIRRELVM new_vm = sq_newthread(vm, 16);
90 throw Scripting::SquirrelError(vm, "Couldn't create new VM thread for console");
92 // store reference to thread
93 sq_resetobject(&vm_object);
94 if(SQ_FAILED(sq_getstackobj(vm, -1, &vm_object)))
95 throw Scripting::SquirrelError(vm, "Couldn't get vm object for console");
96 sq_addref(vm, &vm_object);
99 // create new roottable for thread
101 sq_pushroottable(new_vm);
102 if(SQ_FAILED(sq_setdelegate(new_vm, -2)))
103 throw Scripting::SquirrelError(new_vm, "Couldn't set console_table delegate");
105 sq_setroottable(new_vm);
110 std::string filename = "scripts/console.nut";
111 IFileStream stream(filename);
112 Scripting::compile_and_run(vm, stream, filename);
113 } catch(std::exception& e) {
114 log_warning << "Couldn't load console.nut: " << e.what() << std::endl;
120 Console::execute_script(const std::string& command)
122 using namespace Scripting;
126 SQInteger oldtop = sq_gettop(vm);
128 if(SQ_FAILED(sq_compilebuffer(vm, command.c_str(), command.length(),
130 throw SquirrelError(vm, "Couldn't compile command");
132 sq_pushroottable(vm);
133 if(SQ_FAILED(sq_call(vm, 1, SQTrue, SQTrue)))
134 throw SquirrelError(vm, "Problem while executing command");
136 if(sq_gettype(vm, -1) != OT_NULL)
137 addLines(squirrel2string(vm, -1));
138 } catch(std::exception& e) {
141 SQInteger newtop = sq_gettop(vm);
142 if(newtop < oldtop) {
143 log_fatal << "Script destroyed squirrel stack..." << std::endl;
145 sq_settop(vm, oldtop);
152 std::string s = inputBuffer.str();
153 if (s.length() > 0) {
154 s.erase(s.length()-1);
156 inputBuffer.pubseekoff(0, std::ios_base::end, std::ios_base::out);
161 Console::scroll(int numLines)
164 if (offset > 0) offset = 0;
168 Console::show_history(int offset)
170 while ((offset > 0) && (history_position != history.end())) {
174 while ((offset < 0) && (history_position != history.begin())) {
178 if (history_position == history.end()) {
179 inputBuffer.str(std::string());
181 inputBuffer.str(*history_position);
182 inputBuffer.pubseekoff(0, std::ios_base::end, std::ios_base::out);
186 // Helper functions for Console::autocomplete
187 // TODO: Fix rough documentation
190 void sq_insert_commands(std::list<std::string>& cmds, HSQUIRRELVM vm, std::string table_prefix, std::string search_prefix);
193 * Acts upon key,value on top of stack:
194 * Appends key (plus type-dependent suffix) to cmds if table_prefix+key starts with search_prefix;
195 * Calls sq_insert_commands if search_prefix starts with table_prefix+key (and value is a table/class/instance);
198 sq_insert_command(std::list<std::string>& cmds, HSQUIRRELVM vm, std::string table_prefix, std::string search_prefix)
200 const SQChar* key_chars;
201 if (SQ_FAILED(sq_getstring(vm, -2, &key_chars))) return;
202 std::string key_string = table_prefix + key_chars;
204 switch (sq_gettype(vm, -1)) {
207 if (search_prefix.substr(0, key_string.length()) == key_string) {
209 sq_insert_commands(cmds, vm, key_string, search_prefix);
216 if (search_prefix.substr(0, key_string.length()) == key_string) {
217 sq_insert_commands(cmds, vm, key_string, search_prefix);
221 case OT_NATIVECLOSURE:
228 if (key_string.substr(0, search_prefix.length()) == search_prefix) {
229 cmds.push_back(key_string);
235 * calls sq_insert_command for all entries of table/class on top of stack
238 sq_insert_commands(std::list<std::string>& cmds, HSQUIRRELVM vm, std::string table_prefix, std::string search_prefix)
240 sq_pushnull(vm); // push iterator
241 while (SQ_SUCCEEDED(sq_next(vm,-2))) {
242 sq_insert_command(cmds, vm, table_prefix, search_prefix);
243 sq_pop(vm, 2); // pop key, val
245 sq_pop(vm, 1); // pop iterator
250 // End of Console::autocomplete helper functions
253 Console::autocomplete()
255 std::string prefix = inputBuffer.str();
256 addLines("> "+prefix);
258 std::list<std::string> cmds;
262 // append all keys of the current root table to list
263 sq_pushroottable(vm); // push root table
265 // check all keys (and their children) for matches
266 sq_insert_commands(cmds, vm, "", prefix);
268 // cycle through parent(delegate) table
269 SQInteger oldtop = sq_gettop(vm);
270 if(SQ_FAILED(sq_getdelegate(vm, -1)) || oldtop == sq_gettop(vm)) {
273 sq_remove(vm, -2); // remove old table
275 sq_pop(vm, 1); // remove table
277 // depending on number of hits, show matches or autocomplete
278 if (cmds.size() == 0) addLines("No known command starts with \""+prefix+"\"");
279 if (cmds.size() == 1) {
280 // one match: just replace input buffer with full command
281 inputBuffer.str(cmds.front());
282 inputBuffer.pubseekoff(0, std::ios_base::end, std::ios_base::out);
284 if (cmds.size() > 1) {
285 // multiple matches: show all matches and set input buffer to longest common prefix
286 std::string commonPrefix = cmds.front();
287 while (cmds.begin() != cmds.end()) {
288 std::string cmd = cmds.front();
291 for (int n = commonPrefix.length(); n >= 1; n--) {
292 if (cmd.compare(0, n, commonPrefix) != 0) commonPrefix.resize(n-1); else break;
295 inputBuffer.str(commonPrefix);
296 inputBuffer.pubseekoff(0, std::ios_base::end, std::ios_base::out);
301 Console::addLines(std::string s)
303 std::istringstream iss(s);
305 while (std::getline(iss, line, '\n')) addLine(line);
309 Console::addLine(std::string s)
311 // output line to stderr
312 std::cerr << s << std::endl;
315 std::string overflow;
317 lines.push_front(Font::wrap_to_chars(s, 99, &overflow));
319 } while (s.length() > 0);
321 // trim scrollback buffer
322 while (lines.size() >= 1000)
325 // increase console height if necessary
329 height += fontheight;
332 // reset console to full opacity
335 // increase time that console stays open
341 Console::parse(std::string s)
343 // make sure we actually have something to parse
344 if (s.length() == 0) return;
346 // add line to history
347 history.push_back(s);
348 history_position = history.end();
350 // split line into list of args
351 std::vector<std::string> args;
355 start = s.find_first_not_of(" ,", end);
356 end = s.find_first_of(" ,", start);
357 if (start == s.npos) break;
358 args.push_back(s.substr(start, end-start));
361 // command is args[0]
362 if (args.size() == 0) return;
363 std::string command = args.front();
364 args.erase(args.begin());
366 // ignore if it's an internal command
367 if (consoleCommand(command,args)) return;
371 } catch(std::exception& e) {
378 Console::consoleCommand(std::string /*command*/, std::vector<std::string> /*arguments*/)
392 if(!config->console_enabled)
398 SDL_EnableKeyRepeat(SDL_DEFAULT_REPEAT_DELAY, SDL_DEFAULT_REPEAT_INTERVAL);
408 // clear input buffer
409 inputBuffer.str(std::string());
410 SDL_EnableKeyRepeat(0, SDL_DEFAULT_REPEAT_INTERVAL);
416 if (Console::hasFocus()) {
425 Console::update(float elapsed_time)
428 stayOpen -= elapsed_time;
431 } else if(!focused && height > 0) {
432 alpha -= elapsed_time * FADE_SPEED;
441 Console::draw(DrawingContext& context)
446 int layer = LAYER_GUI + 1;
448 context.push_transform();
449 context.set_alpha(alpha);
450 context.draw_surface(background2.get(), Vector(SCREEN_WIDTH/2 - background->get_width()/2 - background->get_width() + backgroundOffset, height - background->get_height()), layer);
451 context.draw_surface(background2.get(), Vector(SCREEN_WIDTH/2 - background->get_width()/2 + backgroundOffset, height - background->get_height()), layer);
452 context.draw_surface(background.get(), Vector(SCREEN_WIDTH/2 - background->get_width()/2, height - background->get_height()), layer);
453 backgroundOffset+=10;
454 if (backgroundOffset > (int)background->get_width()) backgroundOffset -= (int)background->get_width();
460 float py = height-4-1*9;
461 context.draw_text(font.get(), "> "+inputBuffer.str()+"_", Vector(4, py), ALIGN_LEFT, layer);
464 int skipLines = -offset;
465 for (std::list<std::string>::iterator i = lines.begin(); i != lines.end(); i++) {
466 if (skipLines-- > 0) continue;
468 float py = height-4-lineNo*9;
470 context.draw_text(font.get(), *i, Vector(4, py), ALIGN_LEFT, layer);
472 context.pop_transform();
475 Console* Console::instance = NULL;
476 ConsoleStreamBuffer Console::inputBuffer;
477 ConsoleStreamBuffer Console::outputBuffer;
478 std::ostream Console::input(&Console::inputBuffer);
479 std::ostream Console::output(&Console::outputBuffer);