Logo AND Algorithmique Numérique Distribuée

Public GIT Repository
Cleanups in smpi::Win (use std::vector, and simplify constructor).
[simgrid.git] / src / bindings / lua / simgrid_lua.cpp
1 /* Copyright (c) 2010-2020. 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.hpp"
10 #include "lua_utils.hpp"
11 #include "src/surf/xml/platf.hpp"
12 #include <lauxlib.h>
13
14 XBT_LOG_NEW_DEFAULT_CATEGORY(lua, "Lua Bindings");
15
16 extern "C" int luaopen_simgrid(lua_State* L);
17
18 /* ********************************************************************************* */
19 /*                                  simgrid API                                      */
20 /* ********************************************************************************* */
21
22 /**
23  * @brief Prints a log string with debug level.
24  * @param L a Lua state
25  * @return number of values returned to Lua
26  *
27  * - Argument 1 (string): the text to print
28  */
29 static int debug(lua_State* L)
30 {
31   const char* str = luaL_checkstring(L, 1);
32   XBT_DEBUG("%s", str);
33   return 0;
34 }
35
36 /**
37  * @brief Prints a log string with info level.
38  * @param L a Lua state
39  * @return number of values returned to Lua
40  *
41  * - Argument 1 (string): the text to print
42  */
43 static int info(lua_State* L)
44 {
45   const char* str = luaL_checkstring(L, 1);
46   XBT_INFO("%s", str);
47   return 0;
48 }
49
50 static int error(lua_State* L)
51 {
52   const char* str = luaL_checkstring(L, 1);
53   XBT_ERROR("%s", str);
54   return 0;
55 }
56
57 static int critical(lua_State* L)
58 {
59   const char* str = luaL_checkstring(L, 1);
60   XBT_CRITICAL("%s", str);
61   return 0;
62 }
63
64 /**
65  * @brief Dumps a lua table with XBT_DEBUG
66  *
67  * This function can be called from within lua via "simgrid.dump(table)". It will
68  * then dump the table via XBT_DEBUG
69  */
70 static int dump(lua_State* L)
71 {
72   int argc = lua_gettop(L);
73
74   for (int i = 1; i <= argc; i++) {
75     if (lua_istable(L, i)) {
76       lua_pushnil(L); /* table nil */
77
78       //lua_next pops the topmost element from the stack and
79       //gets the next pair from the table at the specified index
80       while (lua_next(L, i)) { /* table key val  */
81         // we need to copy here, as a cast from "Number" to "String"
82         // could happen in Lua.
83         // see remark in the lua manual, function "lua_tolstring"
84         // http://www.lua.org/manual/5.3/manual.html#lua_tolstring
85
86         lua_pushvalue(L, -2); /* table key val key */
87
88         XBT_DEBUG("%s", sglua_keyvalue_tostring(L, -1, -2).c_str());
89       }
90
91       lua_settop(L, argc); // Remove everything except the initial arguments
92     }
93   }
94
95   return 0;
96 }
97
98 static const luaL_Reg simgrid_functions[] = {
99   {"dump", dump},
100   {"debug", debug},
101   {"info", info},
102   {"critical", critical},
103   {"error", error},
104   {nullptr, nullptr}
105 };
106
107 /* ********************************************************************************* */
108 /*                           module management functions                             */
109 /* ********************************************************************************* */
110
111 /**
112  * @brief Makes the core functions available to the Lua world.
113  * @param L a Lua world
114  */
115 static void sglua_register_core_functions(lua_State *L)
116 {
117   /* register the core C functions to lua */
118   luaL_newlib(L, simgrid_functions); /* simgrid */
119   lua_pushvalue(L, -1);              /* simgrid simgrid */
120   lua_setglobal(L, "simgrid");       /* simgrid */
121 }
122
123 /**
124  * @brief Opens the simgrid Lua module.
125  *
126  * This function is called automatically by the Lua interpreter when some
127  * Lua code requires the "simgrid" module.
128  *
129  * @param L the Lua state
130  */
131 int luaopen_simgrid(lua_State *L)
132 {
133   XBT_DEBUG("luaopen_simgrid *****");
134
135   sglua_register_core_functions(L);
136   sglua_register_host_functions(L);
137   sglua_register_platf_functions(L);
138
139   return 1;
140 }