doc/doxygen/platform_lua.doc

   1 /*! \page platform_lua Describing the platform with lua
   2
   3 @tableofcontents
   4
   5
   6 To describe your virtual platform, you can provide a lua script
   7 instead of an XML file. This is really easy: just pass the script file
   8 where an XML file was expected (eg in @ref MSG_create_environment()),
   9 and you are done.
  10
  11 In the near future, it should become possible to change the platform
  12 from in C++ and Java thanks to the the S4U interface. When this
  13 happens, the lua interface will be changed to match the S4U one.
  14
  15 That is why the current lua API is not documented. It is very close to
  16 the XML interface, and you have some examples that you can use to
  17 understand this module. If you use the current API, just drop us a
  18 mail so that we keep it working once S4U is out, to give you the time
  19 to switch at your pace.
  20
  21
  22 \section pf_lua_why Why lua ?
  23
  24 Lua is a fast and portable scripting language. Its main goal is to
  25 make the internal mechanics of C/C++ programs easily recombinable from
  26 a script. It is for example heavily used in the gaming industry: C++
  27 programmers do fast 3D game engines, that game designers reuse easily to
  28 tell stories.
  29
  30 Similarly, our goal is to decouple the internals of the simulation
  31 engine from the usage of that engine. It should give our users the
  32 full power of reconfiguring the tool without digging into our
  33 implementation. Admittedly, we are not there yet...
  34
  35 */