The Battle for Wesnoth  1.15.5+dev
lua_kernel_base.cpp
Go to the documentation of this file.
1 /*
2  Copyright (C) 2014 - 2018 by Chris Beck <render787@gmail.com>
3  Part of the Battle for Wesnoth Project https://www.wesnoth.org/
4 
5  This program is free software; you can redistribute it and/or modify
6  it under the terms of the GNU General Public License as published by
7  the Free Software Foundation; either version 2 of the License, or
8  (at your option) any later version.
9  This program is distributed in the hope that it will be useful,
10  but WITHOUT ANY WARRANTY.
11 
12  See the COPYING file for more details.
13 */
14 
16 
17 #include "game_config.hpp"
18 #include "game_errors.hpp"
19 #include "gui/core/gui_definition.hpp" // for remove_single_widget_definition
20 #include "log.hpp"
21 #include "lua_jailbreak_exception.hpp" // for lua_jailbreak_exception
22 #include "random.hpp"
23 #include "seed_rng.hpp"
24 #include "deprecation.hpp"
25 #include "language.hpp" // for get_language
26 
27 #ifdef DEBUG_LUA
28 #include "scripting/debug_lua.hpp"
29 #endif
30 
31 #include "scripting/lua_color.hpp"
32 #include "scripting/lua_common.hpp"
36 #include "scripting/lua_gui2.hpp"
37 #include "scripting/lua_wml.hpp"
40 #include "scripting/lua_rng.hpp"
41 #include "scripting/lua_widget.hpp"
42 #include "scripting/lua_widget_methods.hpp" //intf_show_dialog
43 #include "scripting/push_check.hpp"
44 
45 #include "game_version.hpp" // for do_version_check, etc
46 #include "picture.hpp"
47 
48 #include "utils/functional.hpp"
49 #include "utils/name_generator.hpp"
52 
53 #include <cstring>
54 #include <exception>
55 #include <new>
56 #include <string>
57 #include <sstream>
58 #include <vector>
59 
60 #include "lua/lauxlib.h"
61 #include "lua/lua.h"
62 #include "lua/lualib.h"
63 
64 static lg::log_domain log_scripting_lua("scripting/lua");
65 static lg::log_domain log_user("scripting/lua/user");
66 #define DBG_LUA LOG_STREAM(debug, log_scripting_lua)
67 #define LOG_LUA LOG_STREAM(info, log_scripting_lua)
68 #define WRN_LUA LOG_STREAM(warn, log_scripting_lua)
69 #define ERR_LUA LOG_STREAM(err, log_scripting_lua)
70 
71 // Registry key for metatable
72 static const char * Gen = "name generator";
73 // Registry key for lua interpreter environment
74 static const char * Interp = "lua interpreter";
75 
76 // Callback implementations
77 
78 /**
79  * Compares 2 version strings - which is newer.
80  * - Args 1,3: version strings
81  * - Arg 2: comparison operator (string)
82  * - Ret 1: comparison result
83  */
85 {
86  char const *v1 = luaL_checkstring(L, 1);
87 
89  if(vop == OP_INVALID) return luaL_argerror(L, 2, "unknown version comparison operator - allowed are ==, !=, <, <=, > and >=");
90 
91  char const *v2 = luaL_checkstring(L, 3);
92 
93  const bool result = do_version_check(version_info(v1), vop, version_info(v2));
94  lua_pushboolean(L, result);
95 
96  return 1;
97 }
98 
99 /**
100  * Replacement print function -- instead of printing to std::cout, print to the command log.
101  * Intended to be bound to this' command_log at registration time.
102  */
104 {
105  DBG_LUA << "intf_print called:\n";
106  std::size_t nargs = lua_gettop(L);
107 
108  lua_getglobal(L, "tostring");
109  for (std::size_t i = 1; i <= nargs; ++i) {
110  lua_pushvalue(L, -1); // function to call: "tostring"
111  lua_pushvalue(L, i); // value to pass through tostring() before printing
112  lua_call(L, 1, 1);
113  const char * str = lua_tostring(L, -1);
114  if (!str) {
115  LOG_LUA << "'tostring' must return a value to 'print'\n";
116  str = "";
117  }
118  if (i > 1) {
119  cmd_log_ << "\t"; //separate multiple args with tab character
120  }
121  cmd_log_ << str;
122  DBG_LUA << "'" << str << "'\n";
123  lua_pop(L, 1); // Pop the output of tostrring()
124  }
125  lua_pop(L, 1); // Pop 'tostring' global
126 
127  cmd_log_ << "\n";
128  DBG_LUA << "\n";
129 
130  return 0;
131 }
132 
133 /**
134  * Replacement load function. Mostly the same as regular load, but disallows loading binary chunks
135  * due to CVE-2018-1999023.
136  */
137 static int intf_load(lua_State* L)
138 {
139  std::string chunk = luaL_checkstring(L, 1);
140  const char* name = luaL_optstring(L, 2, chunk.c_str());
141  std::string mode = luaL_optstring(L, 3, "t");
142  bool override_env = !lua_isnone(L, 4);
143 
144  if(mode != "t") {
145  return luaL_argerror(L, 3, "binary chunks are not allowed for security reasons");
146  }
147 
148  int result = luaL_loadbufferx(L, chunk.data(), chunk.length(), name, "t");
149  if(result != LUA_OK) {
150  lua_pushnil(L);
151  // Move the nil as the first return value, like Lua's own load() does.
152  lua_insert(L, -2);
153 
154  return 2;
155  }
156 
157  if(override_env) {
158  // Copy "env" to the top of the stack.
159  lua_pushvalue(L, 4);
160  // Set "env" as the first upvalue.
161  const char* upvalue_name = lua_setupvalue(L, -2, 1);
162  if(upvalue_name == nullptr) {
163  // lua_setupvalue() didn't remove the copy of "env" from the stack, so we need to do it ourselves.
164  lua_pop(L, 1);
165  }
166  }
167 
168  return 1;
169 }
170 
171 // The show lua console callback is similarly a method of lua kernel
173 {
174  if (cmd_log_.external_log_) {
175  std::string message = "There is already an external logger attached to this lua kernel, you cannot open the lua console right now.";
176  log_error(message.c_str());
177  cmd_log_ << message << "\n";
178  return 0;
179  }
180 
181  return lua_gui2::show_lua_console(L, this);
182 }
183 
185 {
186  name_generator* gen = static_cast<name_generator*>(lua_touserdata(L, 1));
187  lua_pushstring(L, gen->generate().c_str());
188  return 1;
189 }
190 
192 {
193  name_generator* gen = static_cast<name_generator*>(lua_touserdata(L, 1));
194  gen->~name_generator();
195  return 0;
196 }
197 
199 {
201  name_generator* gen = nullptr;
202  try {
203  if(type == "markov" || type == "markov_chain") {
204  std::vector<std::string> input;
205  if(lua_istable(L, 2)) {
206  input = lua_check<std::vector<std::string>>(L, 2);
207  } else {
208  input = utils::parenthetical_split(luaL_checkstring(L, 2), ',');
209  }
210  int chain_sz = luaL_optinteger(L, 3, 2);
211  int max_len = luaL_optinteger(L, 4, 12);
212  gen = new(L) markov_generator(input, chain_sz, max_len);
213  // Ensure the pointer didn't change when cast
214  assert(static_cast<void*>(gen) == dynamic_cast<markov_generator*>(gen));
215  } else if(type == "context_free" || type == "cfg" || type == "CFG") {
216  if(lua_istable(L, 2)) {
217  std::map<std::string, std::vector<std::string>> data;
218  for(lua_pushnil(L); lua_next(L, 2); lua_pop(L, 1)) {
219  if(lua_type(L, -2) != LUA_TSTRING) {
220  lua_pushstring(L, "CFG generator: invalid nonterminal name (must be a string)");
221  return lua_error(L);
222  }
223  if(lua_isstring(L, -1)) {
224  data[lua_tostring(L,-2)] = utils::split(lua_tostring(L,-1),'|');
225  } else if(lua_istable(L, -1)) {
226  data[lua_tostring(L,-2)] = lua_check<std::vector<std::string>>(L, -1);
227  } else {
228  lua_pushstring(L, "CFG generator: invalid noterminal value (must be a string or list of strings)");
229  return lua_error(L);
230  }
231  }
232  if(!data.empty()) {
233  gen = new(L) context_free_grammar_generator(data);
234  }
235  } else {
237  }
238  if(gen) {
239  assert(static_cast<void*>(gen) == dynamic_cast<context_free_grammar_generator*>(gen));
240  }
241  } else {
242  return luaL_argerror(L, 1, "should be either 'markov_chain' or 'context_free'");
243  }
244  }
245  catch (const name_generator_invalid_exception& ex) {
246  lua_pushstring(L, ex.what());
247  return lua_error(L);
248  }
249 
250  // We set the metatable now, even if the generator is invalid, so that it
251  // will be properly collected if it was invalid.
253  lua_setmetatable(L, -2);
254 
255  return 1;
256 }
257 
258 /**
259 * Returns a random numer, same interface as math.random.
260 */
261 static int intf_random(lua_State *L)
262 {
263  if (lua_isnoneornil(L, 1)) {
264  double r = static_cast<double>(randomness::generator->next_random());
265  double r_max = static_cast<double>(std::numeric_limits<uint32_t>::max());
266  lua_push(L, r / (r_max + 1));
267  return 1;
268  }
269  else {
270  int32_t min;
271  int32_t max;
272  if (lua_isnumber(L, 2)) {
273  min = lua_check<int32_t>(L, 1);
274  max = lua_check<int32_t>(L, 2);
275  }
276  else {
277  min = 1;
278  max = lua_check<int32_t>(L, 1);
279  }
280  if (min > max) {
281  return luaL_argerror(L, 1, "min > max");
282  }
283  lua_push(L, randomness::generator->get_random_int(min, max));
284  return 1;
285  }
286 }
287 
288 /**
289 * Logs a message
290 * Arg 1: (optional) Logger
291 * Arg 2: Message
292 */
293 static int intf_log(lua_State *L) {
294  const std::string& logger = lua_isstring(L, 2) ? luaL_checkstring(L, 1) : "";
296  if(msg.empty() || msg.back() != '\n') {
297  msg += '\n';
298  }
299 
300  if(logger == "err" || logger == "error") {
301  LOG_STREAM(err, log_user) << msg;
302  } else if(logger == "warn" || logger == "wrn" || logger == "warning") {
304  } else if((logger == "debug" || logger == "dbg")) {
306  } else {
308  }
309  return 0;
310 }
311 
312 /**
313  * Logs a deprecation message. See deprecation.cpp for details
314  * Arg 1: Element to be deprecated.
315  * Arg 2: Deprecation level.
316  * Arg 3: Version when element may be removed.
317  * Arg 4: Additional detail message.
318  */
320  const std::string elem = luaL_checkstring(L, 1);
321  // This could produce an invalid deprecation level, but that possibility is handled in deprecated_message()
323  const std::string ver_str = lua_isnoneornil(L, 3) ? "" : luaL_checkstring(L, 3);
324  const std::string detail = luaW_checktstring(L, 4);
325  const version_info ver = ver_str.empty() ? game_config::wesnoth_version.str() : ver_str;
326  const std::string msg = deprecated_message(elem, level, ver, detail);
327  if(level < DEP_LEVEL::INDEFINITE || level >= DEP_LEVEL::REMOVED) {
328  // Invalid deprecation level or level 4 deprecation should raise an interpreter error
329  lua_push(L, msg);
330  return lua_error(L);
331  }
332  return 0;
333 }
334 
335 /**
336 * Gets the dimension of an image.
337 * - Arg 1: string.
338 * - Ret 1: width.
339 * - Ret 2: height.
340 */
342  char const *m = luaL_checkstring(L, 1);
343  image::locator img(m);
344  if(!img.file_exists()) return 0;
345  surface s = get_image(img);
346  lua_pushinteger(L, s->w);
347  lua_pushinteger(L, s->h);
348  return 2;
349 }
350 
351 /**
352 * Returns the time stamp, exactly as [set_variable] time=stamp does.
353 * - Ret 1: integer
354 */
356  lua_pushinteger(L, SDL_GetTicks());
357  return 1;
358 }
359 
361 {
362  lua_push(L, get_language().localename);
363  return 1;
364 }
365 
366 // End Callback implementations
367 
368 // Template which allows to push member functions to the lua kernel base into lua as C functions, using a shim
370 
371 template <member_callback method>
373  return ((lua_kernel_base::get_lua_kernel<lua_kernel_base>(L)).*method)(L);
374 }
375 
376 // Ctor, initialization
378  : mState(luaL_newstate())
379  , cmd_log_()
380 {
382  lua_State *L = mState;
383 
384  cmd_log_ << "Initializing " << my_name() << "...\n";
385 
386  // Define the CPP_function metatable ( so we can override print to point to a C++ member function, add "show_dialog" for this kernel, etc. )
387  // Do it first of all in case C++ functions are ever used in the core Wesnoth libs loaded in the next step
388  cmd_log_ << "Adding boost function proxy...\n";
389 
391 
392  // Open safe libraries.
393  // Debug and OS are not, but most of their functions will be disabled below.
394  cmd_log_ << "Adding standard libs...\n";
395 
396  static const luaL_Reg safe_libs[] {
397  { "", luaopen_base },
398  { "table", luaopen_table },
399  { "string", luaopen_string },
400  { "math", luaopen_math },
401  { "coroutine", luaopen_coroutine },
402  { "debug", luaopen_debug },
403  { "os", luaopen_os },
404  { "utf8", luaopen_utf8 }, // added in Lua 5.3
405  // Wesnoth libraries
406  { "stringx",lua_stringx::luaW_open },
407  { "wml", lua_wml::luaW_open },
408  { "gui", lua_gui2::luaW_open },
409  { nullptr, nullptr }
410  };
411  for (luaL_Reg const *lib = safe_libs; lib->func; ++lib)
412  {
413  luaL_requiref(L, lib->name, lib->func, true);
414  lua_pop(L, 1); /* remove lib */
415  }
416 
417  // Disable functions from os which we don't want.
418  lua_getglobal(L, "os");
419  lua_pushnil(L);
420  while(lua_next(L, -2) != 0) {
421  lua_pop(L, 1);
422  char const* function = lua_tostring(L, -1);
423  if(strcmp(function, "clock") == 0 || strcmp(function, "date") == 0
424  || strcmp(function, "time") == 0 || strcmp(function, "difftime") == 0) continue;
425  lua_pushnil(L);
426  lua_setfield(L, -3, function);
427  }
428  lua_pop(L, 1);
429 
430  // Delete dofile and loadfile.
431  lua_pushnil(L);
432  lua_setglobal(L, "dofile");
433  lua_pushnil(L);
434  lua_setglobal(L, "loadfile");
435 
436  // Store the error handler.
437  cmd_log_ << "Adding error handler...\n";
439 
440 
441  lua_settop(L, 0);
442 
443  // Add some callback from the wesnoth lib
444  cmd_log_ << "Registering basic wesnoth API...\n";
445 
446  static luaL_Reg const callbacks[] {
447  { "compare_versions", &intf_compare_versions },
448  { "deprecated_message", &intf_deprecated_message },
449  { "have_file", &lua_fileops::intf_have_file },
450  { "read_file", &lua_fileops::intf_read_file },
451  { "canonical_path", &lua_fileops::intf_canonical_path },
452  { "textdomain", &lua_common::intf_textdomain },
453  //{ "get_dialog_value", &lua_gui2::intf_get_dialog_value },
454  //{ "set_dialog_tooltip", &lua_gui2::intf_set_dialog_tooltip },
455  //{ "set_dialog_active", &lua_gui2::intf_set_dialog_active },
456  //{ "set_dialog_visible", &lua_gui2::intf_set_dialog_visible },
457  //{ "add_dialog_tree_node", &lua_gui2::intf_add_dialog_tree_node },
458  //{ "set_dialog_callback", &lua_gui2::intf_set_dialog_callback },
459  //{ "set_dialog_canvas", &lua_gui2::intf_set_dialog_canvas },
460  //{ "set_dialog_focus", &lua_gui2::intf_set_dialog_focus },
461  //{ "set_dialog_markup", &lua_gui2::intf_set_dialog_markup },
462  //{ "set_dialog_value", &lua_gui2::intf_set_dialog_value },
463  //{ "remove_dialog_item", &lua_gui2::intf_remove_dialog_item },
464  { "dofile", &dispatch<&lua_kernel_base::intf_dofile> },
465  { "require", &dispatch<&lua_kernel_base::intf_require> },
466  { "kernel_type", &dispatch<&lua_kernel_base::intf_kernel_type> },
467  { "show_dialog", &intf_show_dialog },
468  { "compile_formula", &lua_formula_bridge::intf_compile_formula},
469  { "eval_formula", &lua_formula_bridge::intf_eval_formula},
470  { "name_generator", &intf_name_generator },
471  { "random", &intf_random },
472  { "log", &intf_log },
473  { "get_image_size", &intf_get_image_size },
474  { "get_time_stamp", &intf_get_time_stamp },
475  { "get_language", &intf_get_language },
476  { nullptr, nullptr }
477  };
478 
479  lua_getglobal(L, "wesnoth");
480  if (!lua_istable(L,-1)) {
481  lua_newtable(L);
482  }
483  luaL_setfuncs(L, callbacks, 0);
484  //lua_cpp::set_functions(L, cpp_callbacks, 0);
485  lua_setglobal(L, "wesnoth");
486 
487  // Create the gettext metatable.
489  // Create the tstring metatable.
491 
493 
494  // Override the print function
495  cmd_log_ << "Redirecting print function...\n";
496 
497  lua_getglobal(L, "print");
498  lua_setglobal(L, "std_print"); //storing original impl as 'std_print'
499  lua_settop(L, 0); //clear stack, just to be sure
500 
501  lua_pushcfunction(L, &dispatch<&lua_kernel_base::intf_print>);
502  lua_setglobal(L, "print");
503 
505  lua_setglobal(L, "load");
506  lua_pushnil(L);
507  lua_setglobal(L, "loadstring");
508 
509  cmd_log_ << "Initializing package repository...\n";
510  // Create the package table.
511  lua_getglobal(L, "wesnoth");
512  lua_newtable(L);
513  lua_setfield(L, -2, "package");
514  lua_pop(L, 1);
515  lua_settop(L, 0);
516  lua_pushstring(L, "lua/package.lua");
517  int res = intf_require(L);
518  if(res != 1) {
519  cmd_log_ << "Error: Failed to initialize package repository. Falling back to less flexible C++ implementation.\n";
520  }
521 
522  // Get some callbacks for map locations
523  cmd_log_ << "Adding map table...\n";
524 
525  static luaL_Reg const map_callbacks[] {
526  { "get_direction", &lua_map_location::intf_get_direction },
527  { "vector_sum", &lua_map_location::intf_vector_sum },
528  { "vector_diff", &lua_map_location::intf_vector_diff },
529  { "vector_negation", &lua_map_location::intf_vector_negation },
530  { "rotate_right_around_center", &lua_map_location::intf_rotate_right_around_center },
531  { "tiles_adjacent", &lua_map_location::intf_tiles_adjacent },
532  { "get_adjacent_tiles", &lua_map_location::intf_get_adjacent_tiles },
533  { "distance_between", &lua_map_location::intf_distance_between },
534  { "get_in_basis_N_NE", &lua_map_location::intf_get_in_basis_N_NE },
535  { "get_relative_dir", &lua_map_location::intf_get_relative_dir },
536  { nullptr, nullptr }
537  };
538 
539  // Create the map_location table.
540  lua_getglobal(L, "wesnoth");
541  lua_newtable(L);
542  luaL_setfuncs(L, map_callbacks, 0);
543  lua_setfield(L, -2, "map");
544  lua_pop(L, 1);
545 
546  // Create the game_config variable with its metatable.
547  cmd_log_ << "Adding game_config table...\n";
548 
549  lua_getglobal(L, "wesnoth");
550  lua_newuserdata(L, 0);
551  lua_createtable(L, 0, 3);
552  lua_pushcfunction(L, &dispatch<&lua_kernel_base::impl_game_config_get>);
553  lua_setfield(L, -2, "__index");
554  lua_pushcfunction(L, &dispatch<&lua_kernel_base::impl_game_config_set>);
555  lua_setfield(L, -2, "__newindex");
556  lua_pushstring(L, "game config");
557  lua_setfield(L, -2, "__metatable");
558  lua_setmetatable(L, -2);
559  lua_setfield(L, -2, "game_config");
560  lua_pop(L, 1);
561 
562  // Add mersenne twister rng wrapper
563  cmd_log_ << "Adding rng tables...\n";
565 
566  cmd_log_ << "Adding name generator metatable...\n";
568  static luaL_Reg const generator[] {
569  { "__call", &impl_name_generator_call},
570  { "__gc", &impl_name_generator_collect},
571  { nullptr, nullptr}
572  };
573  luaL_setfuncs(L, generator, 0);
574 
575  // Create formula bridge metatables
577 
579 
580  // Create the Lua interpreter table
581  cmd_log_ << "Sandboxing Lua interpreter...\nTo make variables visible outside the interpreter, assign to _G.variable.\n";
582  cmd_log_ << "The special variable _ holds the result of the last expression (if any).\n";
583  lua_newtable(L);
584  lua_createtable(L, 0, 1);
585  lua_getglobal(L, "_G");
586  lua_setfield(L, -2, "__index");
587  lua_setmetatable(L, -2);
589 
590  // Loading ilua:
591  cmd_log_ << "Loading ilua...\n";
592 
593  lua_settop(L, 0);
594  luaW_getglobal(L, "wesnoth", "require");
595  lua_pushstring(L, "lua/ilua.lua");
596  if(protected_call(1, 1)) {
597  //run "ilua.set_strict()"
598  lua_pushstring(L, "set_strict");
599  lua_gettable(L, -2);
600  if (!this->protected_call(0,0, std::bind(&lua_kernel_base::log_error, this, _1, _2))) {
601  cmd_log_ << "Failed to activate strict mode.\n";
602  } else {
603  cmd_log_ << "Activated strict mode.\n";
604  }
605 
606  lua_setglobal(L, "ilua"); //save ilua table as a global
607  } else {
608  cmd_log_ << "Error: failed to load ilua.\n";
609  }
610  lua_settop(L, 0);
611 
612  // Disable functions from debug which we don't want.
613  // We do this last because ilua needs to be able to use debug.getmetatable
614  lua_getglobal(L, "debug");
615  lua_pushnil(L);
616  while(lua_next(L, -2) != 0) {
617  lua_pop(L, 1);
618  char const* function = lua_tostring(L, -1);
619  if(strcmp(function, "traceback") == 0 || strcmp(function, "getinfo") == 0) continue; //traceback is needed for our error handler
620  lua_pushnil(L); //getinfo is needed for ilua strict mode
621  lua_setfield(L, -3, function);
622  }
623  lua_pop(L, 1);
624 }
625 
627 {
628  for (const auto& pair : this->registered_widget_definitions_) {
629  gui2::remove_single_widget_definition(std::get<0>(pair), std::get<1>(pair));
630  }
631  lua_close(mState);
632 }
633 
634 void lua_kernel_base::log_error(char const * msg, char const * context)
635 {
636  ERR_LUA << context << ": " << msg << '\n';
637 }
638 
639 void lua_kernel_base::throw_exception(char const * msg, char const * context)
640 {
641  throw game::lua_error(msg, context);
642 }
643 
644 bool lua_kernel_base::protected_call(int nArgs, int nRets)
645 {
646  error_handler eh = std::bind(&lua_kernel_base::log_error, this, _1, _2 );
647  return this->protected_call(nArgs, nRets, eh);
648 }
649 
650 bool lua_kernel_base::load_string(char const * prog, const std::string& name)
651 {
652  error_handler eh = std::bind(&lua_kernel_base::log_error, this, _1, _2 );
653  return this->load_string(prog, name, eh);
654 }
655 
656 bool lua_kernel_base::protected_call(int nArgs, int nRets, error_handler e_h)
657 {
658  return this->protected_call(mState, nArgs, nRets, e_h);
659 }
660 
661 bool lua_kernel_base::protected_call(lua_State * L, int nArgs, int nRets, error_handler e_h)
662 {
663  int errcode = luaW_pcall_internal(L, nArgs, nRets);
664 
665  if (errcode != LUA_OK) {
666  char const * msg = lua_tostring(L, -1);
667 
668  std::string context = "When executing, ";
669  if (errcode == LUA_ERRRUN) {
670  context += "Lua runtime error: ";
671  } else if (errcode == LUA_ERRERR) {
672  context += "Lua error in attached debugger: ";
673  } else if (errcode == LUA_ERRMEM) {
674  context += "Lua out of memory error: ";
675  } else if (errcode == LUA_ERRGCMM) {
676  context += "Lua error in garbage collection metamethod: ";
677  } else {
678  context += "unknown lua error: ";
679  }
680  if(lua_isstring(L, -1)) {
681  context += msg ? msg : "null string";
682  } else {
683  context += lua_typename(L, lua_type(L, -1));
684  }
685 
686  lua_pop(L, 1);
687 
688  e_h(context.c_str(), "Lua Error");
689 
690  return false;
691  }
692 
693  return true;
694 }
695 
696 bool lua_kernel_base::load_string(char const * prog, const std::string& name, error_handler e_h)
697 {
698  // pass 't' to prevent loading bytecode which is unsafe and can be used to escape the sandbox.
699  int errcode = luaL_loadbufferx(mState, prog, strlen(prog), name.empty() ? name.c_str() : prog, "t");
700  if (errcode != LUA_OK) {
701  char const * msg = lua_tostring(mState, -1);
702  std::string message = msg ? msg : "null string";
703 
704  std::string context = "When parsing a string to lua, ";
705 
706  if (errcode == LUA_ERRSYNTAX) {
707  context += " a syntax error";
708  } else if(errcode == LUA_ERRMEM){
709  context += " a memory error";
710  } else if(errcode == LUA_ERRGCMM) {
711  context += " an error in garbage collection metamethod";
712  } else {
713  context += " an unknown error";
714  }
715 
716  lua_pop(mState, 1);
717 
718  e_h(message.c_str(), context.c_str());
719 
720  return false;
721  }
722  return true;
723 }
724 
726 {
727  int nArgs = 0;
728  if (const config& args = cfg.child("args")) {
729  luaW_pushconfig(this->mState, args);
730  ++nArgs;
731  }
732  this->run(cfg["code"].str().c_str(), cfg["name"].str(), nArgs);
733 }
734 // Call load_string and protected call. Make them throw exceptions.
735 //
736 void lua_kernel_base::throwing_run(const char * prog, const std::string& name, int nArgs, bool in_interpreter)
737 {
738  cmd_log_ << "$ " << prog << "\n";
739  error_handler eh = std::bind(&lua_kernel_base::throw_exception, this, _1, _2 );
740  this->load_string(prog, name, eh);
741  if(in_interpreter) {
743  if(lua_setupvalue(mState, -2, 1) == nullptr)
744  lua_pop(mState, 1);
745  }
746  lua_insert(mState, -nArgs - 1);
747  this->protected_call(nArgs, in_interpreter ? LUA_MULTRET : 0, eh);
748 }
749 
750 // Do a throwing run, but if we catch a lua_error, reformat it with signature for this function and log it.
751 void lua_kernel_base::run(const char * prog, const std::string& name, int nArgs)
752 {
753  try {
754  this->throwing_run(prog, name, nArgs);
755  } catch (const game::lua_error & e) {
756  cmd_log_ << e.what() << "\n";
757  lua_kernel_base::log_error(e.what(), "In function lua_kernel::run()");
758  }
759 }
760 
761 // Tests if a program resolves to an expression, and pretty prints it if it is, otherwise it runs it normally. Throws exceptions.
762 void lua_kernel_base::interactive_run(char const * prog) {
763  std::string experiment = "return ";
764  experiment += prog;
765  int top = lua_gettop(mState);
766 
767  error_handler eh = std::bind(&lua_kernel_base::throw_exception, this, _1, _2 );
768  luaW_getglobal(mState, "ilua", "_pretty_print");
769 
770  try {
771  // Try to load the experiment without syntax errors
772  this->load_string(experiment.c_str(), "interactive", eh);
774  if(lua_setupvalue(mState, -2, 1) == nullptr)
775  lua_pop(mState, 1);
776  } catch (const game::lua_error &) {
777  this->throwing_run(prog, "interactive", 0, true); // Since it failed, fall back to the usual throwing_run, on the original input.
778  if(lua_gettop(mState) == top + 1) {
779  // Didn't return anything
780  lua_settop(mState, top);
781  return;
782  } else goto PRINT;
783  }
784  // experiment succeeded, now run but log normally.
785  cmd_log_ << "$ " << prog << "\n";
786  this->protected_call(0, LUA_MULTRET, eh);
787 PRINT:
788  int nRets = lua_gettop(mState) - top - 1;
789  {
790  // Assign first result to _
792  int env_idx = lua_gettop(mState);
793  lua_pushvalue(mState, top + 2);
794  lua_setfield(mState, -2, "_");
795  // Now duplicate EVERY result and pass it to table.pack, assigning to _all
796  luaW_getglobal(mState, "table", "pack");
797  for(int i = top + 2; i < env_idx; i++)
799  this->protected_call(nRets, 1, eh);
800  lua_setfield(mState, -2, "_all");
801  lua_pop(mState, 1);
802  }
803  // stack is now ilua._pretty_print followed by any results of prog
804  this->protected_call(lua_gettop(mState) - top - 1, 0, eh);
805 }
806 /**
807  * Loads and executes a Lua file.
808  * - Arg 1: string containing the file name.
809  * - Ret *: values returned by executing the file body.
810  */
812 {
813  luaL_checkstring(L, 1);
814  lua_rotate(L, 1, -1);
815  if (lua_fileops::load_file(L) != 1) return 0;
816  //^ should end with the file contents loaded on the stack. actually it will call lua_error otherwise, the return 0 is redundant.
817  lua_rotate(L, 1, 1);
818  // Using a non-protected call here appears to fix an issue in plugins.
819  // The protected call isn't technically necessary anyway, because this function is called from Lua code,
820  // which should already be in a protected environment.
821  lua_call(L, lua_gettop(L) - 1, LUA_MULTRET);
822  return lua_gettop(L);
823 }
824 
825 /**
826  * Loads and executes a Lua file, if there is no corresponding entry in wesnoth.package.
827  * Stores the result of the script in wesnoth.package and returns it.
828  * - Arg 1: string containing the file name.
829  * - Ret 1: value returned by the script.
830  */
832 {
833  const char * m = luaL_checkstring(L, 1);
834  if(!m) {
835  return luaL_argerror(L, 1, "found a null string argument to wesnoth require");
836  }
837 
838  // Check if there is already an entry.
839 
840  lua_getglobal(L, "wesnoth");
841  lua_pushstring(L, "package");
842  lua_rawget(L, -2);
843  lua_pushvalue(L, 1);
844  lua_rawget(L, -2);
845  if(!lua_isnil(L, -1) && !game_config::debug_lua) {
846  return 1;
847  }
848  lua_pop(L, 1);
849  lua_pushvalue(L, 1);
850  // stack is now [packagename] [wesnoth] [package] [packagename]
851 
852  if(lua_fileops::load_file(L) != 1) {
853  // should end with the file contents loaded on the stack. actually it will call lua_error otherwise, the return 0 is redundant.
854  // stack is now [packagename] [wesnoth] [package] [chunk]
855  return 0;
856  }
857  DBG_LUA << "require: loaded a file, now calling it\n";
858 
859  if (!this->protected_call(L, 0, 1, std::bind(&lua_kernel_base::log_error, this, _1, _2))) {
860  // historically if wesnoth.require fails it just yields nil and some logging messages, not a lua error
861  return 0;
862  }
863  // stack is now [packagename] [wesnoth] [package] [results]
864 
865  lua_pushvalue(L, 1);
866  lua_pushvalue(L, -2);
867  // stack is now [packagename] [wesnoth] [package] [results] [packagename] [results]
868  // Add the return value to the table.
869 
870  lua_settable(L, -4);
871  // stack is now [packagename] [wesnoth] [package] [results]
872  return 1;
873 }
875 {
876  lua_push(L, my_name());
877  return 1;
878 }
880 {
881  char const *m = luaL_checkstring(L, 2);
894  return 0;
895 }
897 {
898  std::string err_msg = "unknown modifiable property of game_config: ";
899  err_msg += luaL_checkstring(L, 2);
900  return luaL_argerror(L, 2, err_msg.c_str());
901 }
902 /**
903  * Loads the "package" package into the Lua environment.
904  * This action is inherently unsafe, as Lua scripts will now be able to
905  * load C libraries on their own, hence granting them the same privileges
906  * as the Wesnoth binary itself.
907  */
909 {
910  lua_State *L = mState;
912  lua_pushstring(L, "package");
913  lua_call(L, 1, 0);
914 }
915 
917 {
918  lua_State* L = mState;
919  lua_settop(L, 0);
920  cmd_log_ << "Loading core...\n";
921  luaW_getglobal(L, "wesnoth", "require");
922  lua_pushstring(L, "lua/core.lua");
923  if(!protected_call(1, 1)) {
924  cmd_log_ << "Error: Failed to load core.\n";
925  }
926  lua_settop(L, 0);
927 }
928 
929 /**
930  * Gets all the global variable names in the Lua environment. This is useful for tab completion.
931  */
932 std::vector<std::string> lua_kernel_base::get_global_var_names()
933 {
934  std::vector<std::string> ret;
935 
936  lua_State *L = mState;
937 
938  int idx = lua_gettop(L);
939  lua_getglobal(L, "_G");
940  lua_pushnil(L);
941 
942  while (lua_next(L, idx+1) != 0) {
943  if (lua_isstring(L, -2)) {
944  ret.push_back(lua_tostring(L,-2));
945  }
946  lua_pop(L,1);
947  }
948  lua_settop(L, idx);
949  return ret;
950 }
951 
952 /**
953  * Gets all attribute names of an extended variable name. This is useful for tab completion.
954  */
955 std::vector<std::string> lua_kernel_base::get_attribute_names(const std::string & input)
956 {
957  std::vector<std::string> ret;
958  std::string base_path = input;
959  std::size_t last_dot = base_path.find_last_of('.');
960  std::string partial_name = base_path.substr(last_dot + 1);
961  base_path.erase(last_dot);
962  std::string load = "return " + base_path;
963 
964  lua_State* L = mState;
965  int save_stack = lua_gettop(L);
966  int result = luaL_loadstring(L, load.c_str());
967  if(result != LUA_OK) {
968  // This isn't at error level because it's a really low priority error; it just means the user tried to tab-complete something that doesn't exist.
969  LOG_LUA << "Error when attempting tab completion:\n";
970  LOG_LUA << luaL_checkstring(L, -1) << '\n';
971  // Just return an empty list; no matches were found
972  lua_settop(L, save_stack);
973  return ret;
974  }
975 
976  luaW_pcall(L, 0, 1);
977  if(lua_istable(L, -1) || lua_isuserdata(L, -1)) {
978  int top = lua_gettop(L);
979  int obj = lua_absindex(L, -1);
980  if(luaL_getmetafield(L, obj, "__tab_enum") == LUA_TFUNCTION) {
981  lua_pushvalue(L, obj);
982  lua_pushlstring(L, partial_name.c_str(), partial_name.size());
983  luaW_pcall(L, 2, 1);
984  ret = lua_check<std::vector<std::string>>(L, -1);
985  } else if(lua_type(L, -1) != LUA_TTABLE) {
986  LOG_LUA << "Userdata missing __tab_enum meta-function for tab completion";
987  lua_settop(L, save_stack);
988  return ret;
989  } else {
990  lua_settop(L, top);
991  // Metafunction not found, so use lua_next to enumerate the table
992  for(lua_pushnil(L); lua_next(L, obj); lua_pop(L, 1)) {
993  if(lua_type(L, -2) == LUA_TSTRING) {
994  std::string attr = lua_tostring(L, -2);
995  if(attr.empty()) {
996  continue;
997  }
998  if(!isalpha(attr[0]) && attr[0] != '_') {
999  continue;
1000  }
1001  if(std::any_of(attr.begin(), attr.end(), [](char c){
1002  return !isalpha(c) && !isdigit(c) && c != '_';
1003  })) {
1004  continue;
1005  }
1006  if(attr.substr(0, partial_name.size()) == partial_name) {
1007  ret.push_back(base_path + "." + attr);
1008  }
1009  }
1010  }
1011  }
1012  }
1013  lua_settop(L, save_stack);
1014  return ret;
1015 }
1016 
1018 {
1019  #ifdef __GNUC__
1020  #pragma GCC diagnostic push
1021  #pragma GCC diagnostic ignored "-Wold-style-cast"
1022  #endif
1023  return *reinterpret_cast<lua_kernel_base**>(lua_getextraspace(L));
1024  #ifdef __GNUC__
1025  #pragma GCC diagnostic pop
1026  #endif
1027 }
1028 
1030 {
1031  return seed_rng::next_seed();
1032 }
int dispatch(lua_State *L)
VERSION_COMP_OP
void interactive_run(char const *prog)
Tests if a program resolves to an expression, and pretty prints it if it is, otherwise it runs it nor...
LUALIB_API void luaL_requiref(lua_State *L, const char *modname, lua_CFunction openf, int glb)
Definition: lauxlib.cpp:971
#define lua_isnoneornil(L, n)
Definition: lua.h:359
surface get_image(const image::locator &i_locator, TYPE type)
function to get the surface corresponding to an image.
Definition: picture.cpp:833
static int intf_name_generator(lua_State *L)
LUA_API void lua_createtable(lua_State *L, int narray, int nrec)
Definition: lapi.cpp:684
#define lua_pushcfunction(L, f)
Definition: lua.h:350
int show_lua_console(lua_State *, lua_kernel_base *lk)
Definition: lua_gui2.cpp:239
config & child(config_key_type key, int n=0)
Returns the nth child with the given key, or a reference to an invalid config if there is none...
Definition: config.cpp:420
std::string register_tstring_metatable(lua_State *L)
Adds the tstring metatable.
Definition: lua_common.cpp:430
int intf_read_file(lua_State *L)
Reads a file into a string, or a directory into a list of files therein.
LUALIB_API lua_State * luaL_newstate(void)
Definition: lauxlib.cpp:1026
LUAMOD_API int luaopen_debug(lua_State *L)
Definition: ldblib.cpp:452
void luaW_pushconfig(lua_State *L, const config &cfg)
Converts a config object to a Lua table pushed at the top of the stack.
Definition: lua_common.cpp:730
LUA_API void lua_settop(lua_State *L, int idx)
Definition: lapi.cpp:172
#define lua_isnone(L, n)
Definition: lua.h:358
LUA_API int lua_type(lua_State *L, int idx)
Definition: lapi.cpp:251
int village_support
Definition: game_config.cpp:55
bool luaW_pcall(lua_State *L, int nArgs, int nRets, bool allow_wml_error)
Calls a Lua function stored below its nArgs arguments at the top of the stack.
int intf_have_file(lua_State *L)
Checks if a file exists (not necessarily a Lua script).
Interfaces for manipulating version numbers of engine, add-ons, etc.
static int intf_get_image_size(lua_State *L)
Gets the dimension of an image.
LUALIB_API int luaL_loadstring(lua_State *L, const char *s)
Definition: lauxlib.cpp:764
int intf_canonical_path(lua_State *L)
LUA_API void lua_pushboolean(lua_State *L, int b)
Definition: lapi.cpp:557
VERSION_COMP_OP parse_version_op(const std::string &op_str)
#define LUA_MULTRET
Definition: lua.h:34
std::vector< game_tip > load(const config &cfg)
Loads the tips from a config.
Definition: tips.cpp:35
std::function< void(char const *, char const *)> error_handler
logger & info()
Definition: log.cpp:90
std::string generate(const std::map< std::string, std::string > &variables) const
int intf_get_direction(lua_State *L)
Expose map_location::get_direction function to lua Arg 1: a location Arg 2: a direction Arg 3: (optio...
LUALIB_API int luaL_getmetafield(lua_State *L, int obj, const char *event)
Definition: lauxlib.cpp:772
LUA_API int lua_gettop(lua_State *L)
Definition: lapi.cpp:167
LUA_API int lua_gettable(lua_State *L, int idx)
Definition: lapi.cpp:612
LUAMOD_API int luaopen_math(lua_State *L)
Definition: lmathlib.cpp:398
LUA_API int lua_getglobal(lua_State *L, const char *name)
Definition: lapi.cpp:605
LUA_API void lua_settable(lua_State *L, int idx)
Definition: lapi.cpp:766
#define return_string_attrib(name, accessor)
Definition: lua_common.hpp:217
int intf_textdomain(lua_State *L)
Creates an interface for gettext.
Definition: lua_common.cpp:93
#define LOG_LUA
std::vector< std::tuple< std::string, std::string > > registered_widget_definitions_
LUA_API int lua_rawget(lua_State *L, int idx)
Definition: lapi.cpp:647
#define luaL_getmetatable(L, n)
Definition: lauxlib.h:135
int intf_kernel_type(lua_State *L)
virtual ~lua_kernel_base()
LUALIB_API lua_Integer luaL_optinteger(lua_State *L, int arg, lua_Integer def)
Definition: lauxlib.cpp:440
static void msg(const char *act, debug_info &i, const char *to="", const char *result="")
Definition: debugger.cpp:109
#define LUA_TFUNCTION
Definition: lua.h:70
LUA_API int lua_isuserdata(lua_State *L, int idx)
Definition: lapi.cpp:289
std::string str
Definition: statement.cpp:110
void lua_push(lua_State *L, const T &val)
Definition: push_check.hpp:400
#define LOG_STREAM(level, domain)
Definition: log.hpp:189
static lg::log_domain log_scripting_lua("scripting/lua")
bool do_version_check(const version_info &a, VERSION_COMP_OP op, const version_info &b)
int luaW_open(lua_State *L)
Definition: lua_gui2.cpp:272
LUA_API int lua_absindex(lua_State *L, int idx)
Definition: lapi.cpp:160
int intf_vector_diff(lua_State *L)
Expose map_location::vector_difference to lua.
LUAMOD_API int luaopen_base(lua_State *L)
Definition: lbaselib.cpp:486
int rest_heal_amount
Definition: game_config.cpp:61
LUA_API void * lua_newuserdata(lua_State *L, size_t size)
Definition: lapi.cpp:1184
int intf_distance_between(lua_State *L)
Expose map_location distance_between.
void remove_single_widget_definition(const std::string &widget_type, const std::string &definition_id)
Removes a widget definition from the default GUI.
#define lua_pop(L, n)
Definition: lua.h:344
int intf_rotate_right_around_center(lua_State *L)
Expose map_location::rotate_right_around_center to lua.
lua_CFunction func
Definition: lauxlib.h:33
int intf_eval_formula(lua_State *)
Evaluates a formula in the formula engine.
int intf_get_relative_dir(lua_State *L)
Expose map_location get_relative_dir.
#define LUA_TSTRING
Definition: lua.h:68
LUAMOD_API int luaopen_coroutine(lua_State *L)
Definition: lcorolib.cpp:164
LUALIB_API int luaL_argerror(lua_State *L, int arg, const char *extramsg)
Definition: lauxlib.cpp:164
int intf_show_dialog(lua_State *L)
Displays a window.
LUAMOD_API int luaopen_os(lua_State *L)
Definition: loslib.cpp:405
std::string deprecated_message(const std::string &elem_name, DEP_LEVEL level, const version_info &version, const std::string &detail)
Definition: deprecation.cpp:29
#define return_int_attrib(name, accessor)
Definition: lua_common.hpp:226
void load_core()
Loads the "core" library into the Lua environment.
bool luaW_getglobal(lua_State *L, const std::vector< std::string > &path)
Pushes the value found by following the variadic names (char *), if the value is not nil...
Definition: lua_common.cpp:871
LUAMOD_API int luaopen_string(lua_State *L)
Definition: lstrlib.cpp:1579
LUA_API int lua_isstring(lua_State *L, int idx)
Definition: lapi.cpp:283
int luaW_open(lua_State *L)
static int intf_get_language(lua_State *L)
LUALIB_API int luaL_loadbufferx(lua_State *L, const char *buff, size_t size, const char *name, const char *mode)
Definition: lauxlib.cpp:755
int intf_show_lua_console(lua_State *L)
static lg::log_domain log_user("scripting/lua/user")
virtual ~name_generator()
LUAMOD_API int luaopen_table(lua_State *L)
Definition: ltablib.cpp:441
t_string luaW_checktstring(lua_State *L, int index)
Converts a scalar to a translatable string.
Definition: lua_common.cpp:620
static int intf_deprecated_message(lua_State *L)
Logs a deprecation message.
LUAMOD_API int luaopen_package(lua_State *L)
Definition: loadlib.cpp:767
void load_package()
Loads the package library into lua environment.
LUA_API void lua_close(lua_State *L)
Definition: lstate.cpp:341
bool protected_call(int nArgs, int nRets, error_handler)
#define lua_getextraspace(L)
Definition: lua.h:339
LUA_API const char * lua_pushlstring(lua_State *L, const char *s, size_t len)
Definition: lapi.cpp:479
int kill_experience
Definition: game_config.cpp:57
LUA_API void lua_setglobal(lua_State *L, const char *name)
Definition: lapi.cpp:759
std::string register_metatables(lua_State *L)
Definition: lua_color.cpp:135
LUA_API int lua_setmetatable(lua_State *L, int objindex)
Definition: lapi.cpp:846
static int impl_name_generator_collect(lua_State *L)
const char * what() const noexcept
Definition: exceptions.hpp:37
int intf_compile_formula(lua_State *)
int(lua_kernel_base::* member_callback)(lua_State *L)
int luaW_pcall_internal(lua_State *L, int nArgs, int nRets)
#define lua_newtable(L)
Definition: lua.h:346
int luaW_open(lua_State *L)
Definition: lua_wml.cpp:244
LUA_API void lua_pushnil(lua_State *L)
Definition: lapi.cpp:450
LUA_API const char * lua_setupvalue(lua_State *L, int funcindex, int n)
Definition: lapi.cpp:1236
int intf_tiles_adjacent(lua_State *L)
Expose map_location tiles_adjacent.
LUAMOD_API int() luaopen_utf8(lua_State *L)
Definition: lutf8lib.cpp:250
virtual int impl_game_config_get(lua_State *L)
#define LUA_ERRGCMM
Definition: lua.h:52
void register_metatable(lua_State *L)
Definition: lua_widget.cpp:192
int intf_vector_negation(lua_State *L)
Expose map_location::vector_negation to lua.
LUALIB_API int luaL_newmetatable(lua_State *L, const char *tname)
Definition: lauxlib.cpp:299
LUA_API void * lua_touserdata(lua_State *L, int idx)
Definition: lapi.cpp:413
#define LUA_ERRERR
Definition: lua.h:53
void run(char const *prog, const std::string &name, int nArgs=0)
Runs a plain script.
static int intf_random(lua_State *L)
Returns a random numer, same interface as math.random.
#define lua_isnil(L, n)
Definition: lua.h:355
int intf_print(lua_State *L)
Replacement print function – instead of printing to std::cout, print to the command log...
std::size_t i
Definition: function.cpp:933
logger & err()
Definition: log.cpp:78
LUALIB_API lua_Integer luaL_checkinteger(lua_State *L, int arg)
Definition: lauxlib.cpp:430
std::string register_metatables(lua_State *)
std::string register_gettext_metatable(lua_State *L)
Adds the gettext metatable.
Definition: lua_common.cpp:410
int village_income
Definition: game_config.cpp:54
int intf_get_in_basis_N_NE(lua_State *L)
Expose map_location get_in_basis_N_NE.
static map_location::DIRECTION s
const language_def & get_language()
Definition: language.cpp:316
virtual uint32_t get_random_seed()
#define LUA_ERRSYNTAX
Definition: lua.h:50
#define lua_tostring(L, i)
Definition: lua.h:366
static int intf_get_time_stamp(lua_State *L)
Returns the time stamp, exactly as [set_variable] time=stamp does.
static int intf_compare_versions(lua_State *L)
Compares 2 version strings - which is newer.
void throwing_run(char const *prog, const std::string &name, int nArgs, bool in_interpreter=false)
Runs a plain script, but reports errors by throwing lua_error.
LUA_API void lua_rotate(lua_State *L, int idx, int n)
Definition: lapi.cpp:207
int combat_experience
Definition: game_config.cpp:58
LUA_API void lua_pushvalue(lua_State *L, int idx)
Definition: lapi.cpp:237
const bool & debug
#define debug(x)
#define LUA_ERRMEM
Definition: lua.h:51
int intf_get_adjacent_tiles(lua_State *L)
Expose map_location get_adjacent_tiles.
int load_file(lua_State *L)
Loads a Lua file and pushes the contents on the stack.
LUA_API int lua_isnumber(lua_State *L, int idx)
Definition: lapi.cpp:276
virtual void log_error(char const *msg, char const *context="Lua error")
Error reporting mechanisms, used by virtual methods protected_call and load_string.
const version_info wesnoth_version(VERSION)
rng * generator
This generator is automatically synced during synced context.
Definition: random.cpp:60
bool load_string(char const *prog, const std::string &name, error_handler)
#define lua_call(L, n, r)
Definition: lua.h:274
virtual int impl_game_config_set(lua_State *L)
#define DBG_LUA
Represents version numbers.
std::vector< std::string > get_global_var_names()
Get tab completion strings.
command_log cmd_log_
int intf_vector_sum(lua_State *L)
Expose map_location::vector_sum to lua.
#define LUA_REGISTRYINDEX
Definition: lua.h:42
#define return_bool_attrib(name, accessor)
Definition: lua_common.hpp:242
static int impl_name_generator_call(lua_State *L)
uint32_t next_seed()
Definition: seed_rng.cpp:45
LUA_API int lua_error(lua_State *L)
Definition: lapi.cpp:1114
logger & warn()
Definition: log.cpp:84
std::vector< std::string > get_attribute_names(const std::string &var_path)
Gets all attribute names of an extended variable name.
#define LUA_OK
Definition: lua.h:47
#define lua_istable(L, n)
Definition: lua.h:353
std::vector< std::string > split(const config_attribute_value &val)
DEP_LEVEL
See https://wiki.wesnoth.org/CompatibilityStandards for more info.
Definition: deprecation.hpp:19
virtual void throw_exception(char const *msg, char const *context="Lua error")
#define lua_insert(L, idx)
Definition: lua.h:369
Standard logging facilities (interface).
std::string str() const
Serializes the version number into string form.
uint32_t next_random()
Provides the next random draw.
Definition: random.cpp:84
void register_metatable(lua_State *L)
#define ERR_LUA
virtual std::string my_name()
User-visible name of the lua kernel that they are talking to.
#define e
LUALIB_API void luaL_setfuncs(lua_State *L, const luaL_Reg *l, int nup)
Definition: lauxlib.cpp:934
void push_error_handler(lua_State *L)
A config object defines a single node in a WML file, with access to child nodes.
Definition: config.hpp:68
int intf_dofile(lua_State *L)
Loads and executes a Lua file.
mock_char c
static const char * Interp
LUA_API int lua_getfield(lua_State *L, int idx, const char *k)
Definition: lapi.cpp:622
lua_State * mState
static int intf_load(lua_State *L)
Replacement load function.
#define LUA_TTABLE
Definition: lua.h:69
LUA_API void lua_pushinteger(lua_State *L, lua_Integer n)
Definition: lapi.cpp:466
#define luaL_optstring(L, n, d)
Definition: lauxlib.h:125
bool file_exists() const
Tests whether the file the locater points at exists.
Definition: picture.cpp:662
int intf_require(lua_State *L)
Loads and executes a Lua file, if there is no corresponding entry in wesnoth.package.
void load_tables(lua_State *L)
Creates the metatable for RNG objects, and adds the Rng table which contains the constructor.
Definition: lua_rng.cpp:80
void run_lua_tag(const config &cfg)
Runs a [lua] tag.
LUA_API const char * lua_pushstring(lua_State *L, const char *s)
Definition: lapi.cpp:491
LUA_API void lua_setfield(lua_State *L, int idx, const char *k)
Definition: lapi.cpp:777
#define LUA_ERRRUN
Definition: lua.h:49
LUA_API int lua_next(lua_State *L, int idx)
Definition: lapi.cpp:1123
const char * what() const noexcept
static lua_kernel_base *& get_lua_kernel_base_ptr(lua_State *L)
LUA_API const char * lua_typename(lua_State *L, int t)
Definition: lapi.cpp:257
static const char * Gen
std::vector< std::string > parenthetical_split(const std::string &val, const char separator, const std::string &left, const std::string &right, const int flags)
Splits a string based either on a separator, except then the text appears within specified parenthesi...
static int intf_log(lua_State *L)
Logs a message Arg 1: (optional) Logger Arg 2: Message.
#define luaL_checkstring(L, n)
Definition: lauxlib.h:124
Error used to report an error in a lua script or in the lua interpreter.
Definition: game_errors.hpp:53