src/scripting/script_interpreter.cpp

   1 #include <config.h>
   2
   3 #include "script_interpreter.hpp"
   4
   5 #include <stdarg.h>
   6 #include <stdexcept>
   7 #include <sstream>
   8 #include <fstream>
   9 #include <sqstdio.h>
  10 #include <sqstdaux.h>
  11 #include <sqstdblob.h>
  12 #include <sqstdsystem.h>
  13 #include <sqstdmath.h>
  14 #include <sqstdstring.h>
  15
  16 #include "wrapper.hpp"
  17 #include "wrapper_util.hpp"
  18 #include "sector.hpp"
  19 #include "file_system.hpp"
  20 #include "game_session.hpp"
  21 #include "resources.hpp"
  22 #include "physfs/physfs_stream.hpp"
  23 #include "object/text_object.hpp"
  24 #include "object/scripted_object.hpp"
  25 #include "object/display_effect.hpp"
  26 #include "object/player.hpp"
  27 #include "scripting/sound.hpp"
  28 #include "scripting/scripted_object.hpp"
  29 #include "scripting/display_effect.hpp"
  30 #include "scripting/squirrel_error.hpp"
  31
  32 static void printfunc(HSQUIRRELVM, const char* str, ...)
  33 {
  34   va_list arglist;
  35   va_start(arglist, str);
  36   vprintf(str, arglist);
  37   va_end(arglist);
  38 }
  39
  40 ScriptInterpreter* ScriptInterpreter::_current = 0;
  41
  42 ScriptInterpreter::ScriptInterpreter(const std::string& new_working_directory)
  43   : working_directory(new_working_directory), sound(0), level(0)
  44 {
  45   v = sq_open(1024);
  46   if(v == 0)
  47     throw std::runtime_error("Couldn't initialize squirrel vm");
  48
  49   // register default error handlers
  50   sqstd_seterrorhandlers(v);
  51   // register squirrel libs
  52   sq_pushroottable(v);
  53   if(sqstd_register_bloblib(v) < 0)
  54     throw Scripting::SquirrelError(v, "Couldn't register blob lib");
  55   if(sqstd_register_iolib(v) < 0)
  56     throw Scripting::SquirrelError(v, "Couldn't register io lib");
  57   if(sqstd_register_systemlib(v) < 0)
  58     throw Scripting::SquirrelError(v, "Couldn't register system lib");
  59   if(sqstd_register_mathlib(v) < 0)
  60     throw Scripting::SquirrelError(v, "Couldn't register math lib");
  61   if(sqstd_register_stringlib(v) < 0)
  62     throw Scripting::SquirrelError(v, "Couldn't register string lib");
  63
  64   // register print function
  65   sq_setprintfunc(v, printfunc);
  66
  67   // register supertux API
  68   Scripting::register_supertux_wrapper(v);
  69
  70   // expose some "global" objects
  71   sound = new Scripting::Sound();
  72   expose_object(sound, "Sound");
  73
  74   level = new Scripting::Level();
  75   expose_object(level, "Level");
  76 }
  77
  78 void
  79 ScriptInterpreter::register_sector(Sector* sector)
  80 {
  81   // expose ScriptedObjects to the script
  82   for(Sector::GameObjects::iterator i = sector->gameobjects.begin();
  83       i != sector->gameobjects.end(); ++i) {
  84     GameObject* object = *i;
  85     Scripting::ScriptedObject* scripted_object
  86       = dynamic_cast<Scripting::ScriptedObject*> (object);
  87     if(!scripted_object)
  88       continue;
  89
  90     expose_object(scripted_object, scripted_object->get_name());
  91   }
  92
  93   expose_object(static_cast<Scripting::Player*> (sector->player), "Tux");
  94   TextObject* text_object = new TextObject();
  95   sector->add_object(text_object);
  96   Scripting::Text* text = static_cast<Scripting::Text*> (text_object);
  97   expose_object(text, "Text");
  98
  99   DisplayEffect* display_effect = new DisplayEffect();
 100   sector->add_object(display_effect);
 101   Scripting::DisplayEffect* display_effect_api
 102     = static_cast<Scripting::DisplayEffect*> (display_effect);
 103   expose_object(display_effect_api, "DisplayEffect");
 104 }
 105
 106 ScriptInterpreter::~ScriptInterpreter()
 107 {
 108   sq_close(v);
 109   delete sound;
 110   delete level;
 111 }
 112
 113 static SQInteger squirrel_read_char(SQUserPointer file)
 114 {
 115   std::istream* in = reinterpret_cast<std::istream*> (file);
 116   char c = in->get();
 117   if(in->eof())
 118     return 0;
 119   return c;
 120 }
 121
 122 void
 123 ScriptInterpreter::run_script(std::istream& in, const std::string& sourcename,
 124         bool remove_when_terminated)
 125 {
 126   if(sq_compile(v, squirrel_read_char, &in, sourcename.c_str(), true) < 0)
 127     throw Scripting::SquirrelError(v, "Couldn't parse script");
 128
 129   _current = this;
 130   sq_push(v, -2);
 131   if(sq_call(v, 1, false) < 0)
 132     throw Scripting::SquirrelError(v, "Couldn't start script");
 133   _current = 0;
 134   if(sq_getvmstate(v) != SQ_VMSTATE_SUSPENDED) {
 135     if(remove_when_terminated) {
 136       remove_me();
 137     }
 138     // remove closure from stack
 139     sq_pop(v, 1);
 140   }
 141 }
 142
 143 void
 144 ScriptInterpreter::set_wakeup_time(float seconds)
 145 {
 146   wakeup_timer.start(seconds);
 147 }
 148
 149 void
 150 ScriptInterpreter::update(float )
 151 {
 152   if(!wakeup_timer.check())
 153     return;
 154
 155   _current = this;
 156   if(sq_wakeupvm(v, false, false) < 0)
 157     throw Scripting::SquirrelError(v, "Couldn't resume script");
 158   _current = 0;
 159   if(sq_getvmstate(v) != SQ_VMSTATE_SUSPENDED) {
 160     printf("script ended...\n");
 161     remove_me();
 162   }
 163 }
 164
 165 void
 166 ScriptInterpreter::draw(DrawingContext& )
 167 {
 168 }
 169
 170 void
 171 ScriptInterpreter::add_script_object(Sector* sector, const std::string& name,
 172     const std::string& script)
 173 {
 174   try {
 175     std::string workdir = GameSession::current()->get_working_directory();
 176     std::auto_ptr<ScriptInterpreter> interpreter(
 177                 new ScriptInterpreter(workdir));
 178     interpreter->register_sector(sector);
 179
 180     // load global default.nut file if it exists
 181     //TODO: Load all .nut files from that directory
 182     try {
 183       std::string filename = "script/default.nut";
 184       IFileStream in(filename);
 185       interpreter->run_script(in, filename, false);
 186     } catch(std::exception& e) {
 187       // nothing
 188     }
 189
 190     // load world-specific default.nut file if it exists
 191     try {
 192       std::string filename = workdir + "/default.nut";
 193       IFileStream in(filename);
 194       interpreter->run_script(in, filename, false);
 195     } catch(std::exception& e) {
 196       // nothing
 197     }
 198
 199     std::istringstream in(script);
 200     interpreter->run_script(in, name);
 201     sector->add_object(interpreter.release());
 202   } catch(std::exception& e) {
 203     std::cerr << "Couldn't start '" << name << "' script: " << e.what() << "\n";
 204   }
 205 }
 206