src/bindings/lua/simgrid_lua.cpp

   1 /* Copyright (c) 2010-2015. The SimGrid Team.
   2  * All rights reserved.                                                     */
   3
   4 /* This program is free software; you can redistribute it and/or modify it
   5  * under the terms of the license (GNU LGPL) which comes with this package. */
   6
   7 /* SimGrid Lua bindings                                                     */
   8
   9 #include "lua_private.h"
  10 #include "lua_utils.h"
  11 #include "xbt.h"
  12 #include "simgrid/msg.h"
  13 #include "simgrid/simdag.h"
  14 #include "surf/surfxml_parse.h"
  15
  16
  17 XBT_LOG_NEW_DEFAULT_SUBCATEGORY(lua, bindings, "Lua Bindings");
  18
  19 extern "C" {
  20 #include <lauxlib.h>
  21
  22 int luaopen_simgrid(lua_State *L);
  23 static void sglua_register_c_functions(lua_State *L);
  24 }
  25
  26 /* ********************************************************************************* */
  27 /*                                  simgrid API                                      */
  28 /* ********************************************************************************* */
  29
  30 /**
  31  * \brief Prints a log string with debug level.
  32  * \param L a Lua state
  33  * \return number of values returned to Lua
  34  *
  35  * - Argument 1 (string): the text to print
  36  */
  37 static int debug(lua_State* L) {
  38
  39   const char* str = luaL_checkstring(L, 1);
  40   XBT_DEBUG("%s", str);
  41   return 0;
  42 }
  43
  44 /**
  45  * \brief Prints a log string with info level.
  46  * \param L a Lua state
  47  * \return number of values returned to Lua
  48  *
  49  * - Argument 1 (string): the text to print
  50  */
  51 static int info(lua_State* L) {
  52
  53   const char* str = luaL_checkstring(L, 1);
  54   XBT_INFO("%s", str);
  55   return 0;
  56 }
  57
  58 static int error(lua_State* L) {
  59
  60   const char* str = luaL_checkstring(L, 1);
  61   XBT_ERROR("%s", str);
  62   return 0;
  63 }
  64
  65 static int critical(lua_State* L) {
  66
  67   const char* str = luaL_checkstring(L, 1);
  68   XBT_CRITICAL("%s", str);
  69   return 0;
  70 }
  71
  72 /**
  73  * @brief Dumps a lua table with XBT_DEBUG
  74  *
  75  * This function can be called from within lua via "simgrid.dump(table)". It will
  76  * then dump the table via XBT_DEBUG
  77  */
  78 static int dump(lua_State* L) {
  79   int argc = lua_gettop(L);
  80
  81   for (int i = 1; i <= argc; i++) {
  82     if (lua_istable(L, i)) {
  83       lua_pushnil(L); /* table nil */
  84
  85       //lua_next pops the topmost element from the stack and
  86       //gets the next pair from the table at the specified index
  87       while (lua_next(L, i)) { /* table key val  */
  88         // we need to copy here, as a cast from "Number" to "String"
  89         // could happen in Lua.
  90         // see remark in the lua manual, function "lua_tolstring"
  91         // http://www.lua.org/manual/5.3/manual.html#lua_tolstring
  92
  93         lua_pushvalue(L, -2); /* table key val key */
  94
  95         XBT_DEBUG("%s", sglua_keyvalue_tostring(L, -1, -2));
  96       }
  97
  98       lua_settop(L, argc); // Remove everything except the initial arguments
  99     }
 100   }
 101
 102   return 0;
 103 }
 104
 105 static const luaL_Reg simgrid_functions[] = {
 106   {"dump", dump},
 107   {"debug", debug},
 108   {"info", info},
 109   {"critical", critical},
 110   {"error", error},
 111   {NULL, NULL}
 112 };
 113
 114 /* ********************************************************************************* */
 115 /*                           module management functions                             */
 116 /* ********************************************************************************* */
 117
 118 /**
 119  * \brief Opens the simgrid Lua module.
 120  *
 121  * This function is called automatically by the Lua interpreter when some
 122  * Lua code requires the "simgrid" module.
 123  *
 124  * \param L the Lua state
 125  */
 126 int luaopen_simgrid(lua_State *L)
 127 {
 128   XBT_DEBUG("luaopen_simgrid *****");
 129
 130   sglua_register_c_functions(L);
 131
 132   return 1;
 133 }
 134
 135
 136 /**
 137  * \brief Makes the core functions available to the Lua world.
 138  * \param L a Lua world
 139  */
 140 static void sglua_register_core_functions(lua_State *L)
 141 {
 142   /* register the core C functions to lua */
 143   luaL_newlib(L, simgrid_functions); /* simgrid */
 144   lua_pushvalue(L, -1);              /* simgrid simgrid */
 145   lua_setglobal(L, "simgrid");       /* simgrid */
 146 }
 147
 148 /**
 149  * \brief Creates the simgrid module and make it available to Lua.
 150  * \param L a Lua world
 151  */
 152 static void sglua_register_c_functions(lua_State *L)
 153 {
 154   sglua_register_core_functions(L);
 155   sglua_register_host_functions(L);
 156   sglua_register_platf_functions(L);
 157 }