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