lua_common.cpp

Go to the documentation of this file.

/*
    Copyright (C) 2014 - 2025
    by Chris Beck <render787@gmail.com>
    Part of the Battle for Wesnoth Project https://www.wesnoth.org/
 
    This program is free software; you can redistribute it and/or modify
    it under the terms of the GNU General Public License as published by
    the Free Software Foundation; either version 2 of the License, or
    (at your option) any later version.
    This program is distributed in the hope that it will be useful,
    but WITHOUT ANY WARRANTY.
 
    See the COPYING file for more details.
*/
 
/**
 * @file
 * Contains code common to the application and game lua kernels which
 * cannot or should not go into the lua kernel base files.
 *
 * Currently contains implementation functions related to vconfig and
 * gettext, also some macros to assist in writing C lua callbacks.
 */
 
#include "scripting/lua_common.hpp"
 
#include "config.hpp"
#include "scripting/push_check.hpp"
#include "tstring.hpp"                  // for t_string
#include "variable.hpp" // for vconfig
#include "log.hpp"
#include "gettext.hpp"
#include "lua_jailbreak_exception.hpp"
#include "game_display.hpp"
 
#include <cstring>
#include <iterator>                     // for distance, advance
#include <string>                       // for string, basic_string
 
 
static const char gettextKey[] = "gettext";
static const char vconfigKey[] = "vconfig";
static const char vconfigpairsKey[] = "vconfig pairs";
static const char tstringKey[] = "translatable string";
static const char executeKey[] = "err";
 
static lg::log_domain log_scripting_lua("scripting/lua");
#define LOG_LUA LOG_STREAM(info, log_scripting_lua)
#define WRN_LUA LOG_STREAM(warn, log_scripting_lua)
#define ERR_LUA LOG_STREAM(err, log_scripting_lua)
 
static lg::log_domain log_wml("wml");
#define ERR_WML LOG_STREAM(err, log_wml)
 
namespace lua_common {
 
/**
 * Creates a t_string object (__call metamethod).
 * - Arg 1: userdata containing the domain.
 * - Arg 2: string to translate.
 * - Ret 1: string containing the translatable string.
 */
static int impl_gettext(lua_State *L)
{
    char const *m = luaL_checkstring(L, 2);
    char const *d = static_cast<char *>(lua_touserdata(L, 1));
    // Hidden metamethod, so d has to be a string. Use it to create a t_string.
    if(lua_isstring(L, 3)) {
        const char* pl = luaL_checkstring(L, 3);
        int count = luaL_checkinteger(L, 4);
        luaW_pushtstring(L, t_string(m, pl, count, d));
    } else {
        luaW_pushtstring(L, t_string(m, d));
    }
    return 1;
}
 
static int impl_gettext_tostr(lua_State* L)
{
    char* d = static_cast<char*>(lua_touserdata(L, 1));
    using namespace std::literals;
    std::string str = "textdomain: "s + d;
    lua_push(L, str);
    return 1;
}
 
/**
 * Creates an interface for gettext
 * - Arg 1: string containing the domain.
 * - Ret 1: a full userdata with __call pointing to lua_gettext.
 */
int intf_textdomain(lua_State *L)
{
    std::size_t l;
    char const *m = luaL_checklstring(L, 1, &l);
 
    void *p = lua_newuserdatauv(L, l + 1, 0);
    memcpy(p, m, l + 1);
 
    luaL_setmetatable(L, gettextKey);
    return 1;
}
 
/**
 * Converts a Lua value at position @a src and appends it to @a dst.
 * @note This function is private to lua_tstring_concat. It expects two things.
 *       First, the t_string metatable is at the top of the stack on entry. (It
 *       is still there on exit.) Second, the caller hasn't any valuable object
 *       with dynamic lifetime, since they would be leaked on error.
 */
static void tstring_concat_aux(lua_State *L, t_string &dst, int src)
{
    switch (lua_type(L, src)) {
        case LUA_TNUMBER:
        case LUA_TSTRING:
            dst += lua_tostring(L, src);
            return;
        case LUA_TUSERDATA:
            // Compare its metatable with t_string's metatable.
            if (t_string * src_ptr = static_cast<t_string *> (luaL_testudata(L, src, tstringKey))) {
                dst += *src_ptr;
                return;
            }
            //intentional fall-through
        default:
            luaW_type_error(L, src, "string");
    }
}
 
/**
 * Appends a scalar to a t_string object (__concat metamethod).
 */
static int impl_tstring_concat(lua_State *L)
{
    // Create a new t_string.
    t_string *t = new(L) t_string;
    luaL_setmetatable(L, tstringKey);
 
    // Append both arguments to t.
    tstring_concat_aux(L, *t, 1);
    tstring_concat_aux(L, *t, 2);
 
    return 1;
}
 
static int impl_tstring_len(lua_State* L)
{
    t_string* t = static_cast<t_string*>(lua_touserdata(L, 1));
    lua_pushnumber(L, t->size());
    return 1;
}
 
/**
 * Destroys a t_string object before it is collected (__gc metamethod).
 */
static int impl_tstring_collect(lua_State *L)
{
    t_string *t = static_cast<t_string *>(lua_touserdata(L, 1));
    t->t_string::~t_string();
    return 0;
}
 
static int impl_tstring_lt(lua_State *L)
{
    t_string *t1 = static_cast<t_string *>(luaL_checkudata(L, 1, tstringKey));
    t_string *t2 = static_cast<t_string *>(luaL_checkudata(L, 2, tstringKey));
    lua_pushboolean(L, translation::compare(t1->get(), t2->get()) < 0);
    return 1;
}
 
static int impl_tstring_le(lua_State *L)
{
    t_string *t1 = static_cast<t_string *>(luaL_checkudata(L, 1, tstringKey));
    t_string *t2 = static_cast<t_string *>(luaL_checkudata(L, 2, tstringKey));
    lua_pushboolean(L, translation::compare(t1->get(), t2->get()) < 1);
    return 1;
}
 
static int impl_tstring_eq(lua_State *L)
{
    t_string *t1 = static_cast<t_string *>(lua_touserdata(L, 1));
    t_string *t2 = static_cast<t_string *>(lua_touserdata(L, 2));
    lua_pushboolean(L, translation::compare(t1->get(), t2->get()) == 0);
    return 1;
}
 
/**
 * Converts a t_string object to a string (__tostring metamethod);
 * that is, performs a translation.
 */
static int impl_tstring_tostring(lua_State *L)
{
    t_string *t = static_cast<t_string *>(lua_touserdata(L, 1));
    lua_pushstring(L, t->c_str());
    return 1;
}
 
/**
 * Gets the parsed field of a vconfig object (_index metamethod).
 * Special fields __literal, __shallow_literal, __parsed, and
 * __shallow_parsed, return Lua tables.
 */
static int impl_vconfig_get(lua_State *L)
{
    vconfig *v = static_cast<vconfig *>(lua_touserdata(L, 1));
 
    if (lua_isnumber(L, 2))
    {
        vconfig::all_children_iterator i = v->ordered_begin();
        unsigned len = std::distance(i, v->ordered_end());
        unsigned pos = lua_tointeger(L, 2) - 1;
        if (pos >= len) return 0;
        std::advance(i, pos);
 
        luaW_push_namedtuple(L, {"tag", "contents"});
        lua_pushstring(L, i.get_key().c_str());
        lua_rawseti(L, -2, 1);
        luaW_pushvconfig(L, i.get_child());
        lua_rawseti(L, -2, 2);
        return 1;
    }
 
    char const *m = luaL_checkstring(L, 2);
    if (strcmp(m, "__literal") == 0) {
        luaW_pushconfig(L, v->get_config());
        return 1;
    }
    if (strcmp(m, "__parsed") == 0) {
        luaW_pushconfig(L, v->get_parsed_config());
        return 1;
    }
 
    bool shallow_literal = strcmp(m, "__shallow_literal") == 0;
    if (shallow_literal || strcmp(m, "__shallow_parsed") == 0)
    {
        lua_newtable(L);
        for(const auto& [key, value] : v->get_config().attribute_range()) {
            if (shallow_literal)
                luaW_pushscalar(L, value);
            else
                luaW_pushscalar(L, v->expand(key));
            lua_setfield(L, -2, key.c_str());
        }
        vconfig::all_children_iterator i = v->ordered_begin(),
            i_end = v->ordered_end();
        if (shallow_literal) {
            i.disable_insertion();
            i_end.disable_insertion();
        }
        for (int j = 1; i != i_end; ++i, ++j)
        {
            luaW_push_namedtuple(L, {"tag", "contents"});
            lua_pushlstring(L, i.get_key().c_str(), i.get_key().size());
            lua_rawseti(L, -2, 1);
            luaW_pushvconfig(L, i.get_child());
            lua_rawseti(L, -2, 2);
            lua_rawseti(L, -2, j);
        }
        return 1;
    }
 
    if (v->null() || !v->has_attribute(m)) return 0;
    luaW_pushscalar(L, (*v)[m]);
    return 1;
}
 
static int impl_vconfig_dir(lua_State* L)
{
    vconfig *v = static_cast<vconfig *>(lua_touserdata(L, 1));
    std::vector<std::string> attributes;
    for(const auto& [key, value] : v->get_config().attribute_range()) {
        attributes.push_back(key);
    }
    lua_push(L, attributes);
    return 1;
}
 
/**
 * Returns the number of a child of a vconfig object.
 */
static int impl_vconfig_size(lua_State *L)
{
    vconfig *v = static_cast<vconfig *>(lua_touserdata(L, 1));
    lua_pushinteger(L, v->null() ? 0 :
        std::distance(v->ordered_begin(), v->ordered_end()));
    return 1;
}
 
/**
 * Destroys a vconfig object before it is collected (__gc metamethod).
 */
static int impl_vconfig_collect(lua_State *L)
{
    vconfig *v = static_cast<vconfig *>(lua_touserdata(L, 1));
    v->~vconfig();
    return 0;
}
 
/**
 * Iterate through the attributes of a vconfig
 */
static int impl_vconfig_pairs_iter(lua_State *L)
{
    vconfig vcfg = luaW_checkvconfig(L, 1);
    void* p = luaL_checkudata(L, lua_upvalueindex(1), vconfigpairsKey);
    config::const_attr_itors& range = *static_cast<config::const_attr_itors*>(p);
    if (range.empty()) {
        return 0;
    }
    config::attribute value = range.front();
    range.pop_front();
    lua_pushlstring(L, value.first.c_str(), value.first.length());
    luaW_pushscalar(L, vcfg[value.first]);
    return 2;
}
 
/**
 * Destroy a vconfig pairs iterator
 */
static int impl_vconfig_pairs_collect(lua_State *L)
{
    typedef config::const_attr_itors const_attr_itors;
    void* p = lua_touserdata(L, 1);
 
    // Triggers a false positive of C4189 with Visual Studio. Suppress.
#if defined(_MSC_VER)
#pragma warning(push)
#pragma warning(disable: 4189)
#endif
 
    const_attr_itors* cai = static_cast<const_attr_itors*>(p);
    cai->~const_attr_itors();
 
#if defined(_MSC_VER)
#pragma warning(pop)
#endif
 
    return 0;
}
 
/**
 * Construct an iterator to iterate through the attributes of a vconfig
 */
static int impl_vconfig_pairs(lua_State *L)
{
    vconfig vcfg = luaW_checkvconfig(L, 1);
    new(L) config::const_attr_itors(vcfg.get_config().attribute_range());
    luaL_newmetatable(L, vconfigpairsKey);
    lua_setmetatable(L, -2);
    lua_pushcclosure(L, &impl_vconfig_pairs_iter, 1);
    lua_pushvalue(L, 1);
    return 2;
}
 
/**
 * Creates a vconfig containing the WML table.
 * - Arg 1: WML table.
 * - Ret 1: vconfig userdata.
 */
int intf_tovconfig(lua_State *L)
{
    vconfig vcfg = luaW_checkvconfig(L, 1);
    luaW_pushvconfig(L, vcfg);
    return 1;
}
 
/**
 * Adds the gettext metatable
 */
std::string register_gettext_metatable(lua_State *L)
{
    luaL_newmetatable(L, gettextKey);
 
    static luaL_Reg const callbacks[] {
        { "__call",         &impl_gettext},
        { "__tostring",     &impl_gettext_tostr},
        { nullptr, nullptr }
    };
    luaL_setfuncs(L, callbacks, 0);
 
    lua_pushstring(L, "message domain");
    lua_setfield(L, -2, "__metatable");
 
    return "Adding gettext metatable...\n";
}
 
/**
 * Adds the tstring metatable
 */
std::string register_tstring_metatable(lua_State *L)
{
    luaL_newmetatable(L, tstringKey);
 
    static luaL_Reg const callbacks[] {
        { "__concat",       &impl_tstring_concat},
        { "__gc",           &impl_tstring_collect},
        { "__tostring",     &impl_tstring_tostring},
        { "__len",          &impl_tstring_len},
        { "__lt",           &impl_tstring_lt},
        { "__le",           &impl_tstring_le},
        { "__eq",           &impl_tstring_eq},
        { nullptr, nullptr }
    };
    luaL_setfuncs(L, callbacks, 0);
 
    lua_createtable(L, 0, 1);
    luaW_getglobal(L, "string", "format");
    lua_setfield(L, -2, "format");
    luaW_getglobal(L, "stringx", "vformat");
    lua_setfield(L, -2, "vformat");
    lua_setfield(L, -2, "__index");
 
    lua_pushstring(L, "translatable string");
    lua_setfield(L, -2, "__metatable");
 
    return "Adding tstring metatable...\n";
}
 
/**
 * Adds the vconfig metatable
 */
std::string register_vconfig_metatable(lua_State *L)
{
    luaL_newmetatable(L, vconfigKey);
 
    static luaL_Reg const callbacks[] {
        { "__gc",           &impl_vconfig_collect},
        { "__index",        &impl_vconfig_get},
        { "__dir",          &impl_vconfig_dir},
        { "__len",          &impl_vconfig_size},
        { "__pairs",        &impl_vconfig_pairs},
        { nullptr, nullptr }
    };
    luaL_setfuncs(L, callbacks, 0);
 
    lua_pushstring(L, "wml object");
    lua_setfield(L, -2, "__metatable");
 
    // Metatables for the iterator userdata
 
    // I don't bother setting __metatable because this
    // userdata is only ever stored in the iterator's
    // upvalues, so it's never visible to the user.
    luaL_newmetatable(L, vconfigpairsKey);
    lua_pushstring(L, "__gc");
    lua_pushcfunction(L, &impl_vconfig_pairs_collect);
    lua_rawset(L, -3);
 
    return "Adding vconfig metatable...\n";
}
 
} // end namespace lua_common
 
scoped_lua_argument::scoped_lua_argument(lua_State* L, int arg_index)
    : state_(L)
{
    lua_geti(state_, -1, arg_index);
}
 
scoped_lua_argument::scoped_lua_argument(lua_State* L, int value_index, int arg_index)
    : state_(L)
{
    lua_geti(state_, value_index, arg_index);
}
 
scoped_lua_argument::~scoped_lua_argument()
{
    lua_pop(state_, 1);
}
 
void* operator new(std::size_t sz, lua_State *L, int nuv)
{
    return lua_newuserdatauv(L, sz, nuv);
}
 
void operator delete(void*, lua_State *L, int)
{
    // Not sure if this is needed since it's a no-op
    // It's only called if a constructor throws while using the above operator new
    // By removing the userdata from the stack, this should ensure that Lua frees it
    lua_pop(L, 1);
}
 
bool luaW_getmetafield(lua_State *L, int idx, const char* key)
{
    if(key == nullptr) {
        return false;
    }
    int n = strlen(key);
    if(n == 0) {
        return false;
    }
    if(n >= 2 && key[0] == '_' && key[1] == '_') {
        return false;
    }
    return luaL_getmetafield(L, idx, key) != 0;
}
 
void luaW_pushvconfig(lua_State *L, const vconfig& cfg)
{
    new(L) vconfig(cfg);
    luaL_setmetatable(L, vconfigKey);
}
 
void luaW_pushtstring(lua_State *L, const t_string& v)
{
    new(L) t_string(v);
    luaL_setmetatable(L, tstringKey);
}
 
 
namespace {
    struct luaW_pushscalar_visitor
#ifdef USING_BOOST_VARIANT
        : boost::static_visitor<>
#endif
    {
        lua_State *L;
        luaW_pushscalar_visitor(lua_State *l): L(l) {}
 
        void operator()(const utils::monostate&) const
        { lua_pushnil(L); }
        void operator()(bool b) const
        { lua_pushboolean(L, b); }
        void operator()(int i) const
        { lua_pushinteger(L, i); }
        void operator()(unsigned long long ull) const
        { lua_pushnumber(L, ull); }
        void operator()(double d) const
        { lua_pushnumber(L, d); }
        void operator()(const std::string& s) const
        { lua_pushlstring(L, s.c_str(), s.size()); }
        void operator()(const t_string& s) const
        { luaW_pushtstring(L, s); }
    };
}//unnamed namespace for luaW_pushscalar_visitor
 
void luaW_pushscalar(lua_State *L, const config::attribute_value& v)
{
    v.apply_visitor(luaW_pushscalar_visitor(L));
}
 
bool luaW_toscalar(lua_State *L, int index, config::attribute_value& v)
{
    switch (lua_type(L, index)) {
        case LUA_TBOOLEAN:
            v = luaW_toboolean(L, -1);
            break;
        case LUA_TNUMBER:
            v = lua_tonumber(L, -1);
            break;
        case LUA_TSTRING:
            v = std::string(luaW_tostring(L, -1));
            break;
        case LUA_TUSERDATA:
        {
            if (t_string * tptr = static_cast<t_string *>(luaL_testudata(L, -1, tstringKey))) {
                v = *tptr;
                break;
            } else {
                return false;
            }
        }
        default:
            return false;
    }
    return true;
}
 
bool luaW_totstring(lua_State *L, int index, t_string &str)
{
    switch (lua_type(L, index)) {
        case LUA_TBOOLEAN:
            str = lua_toboolean(L, index) ? "yes" : "no";
            break;
        case LUA_TNUMBER:
        case LUA_TSTRING:
            str = lua_tostring(L, index);
            break;
        case LUA_TUSERDATA:
        {
            if (t_string * tstr = static_cast<t_string *> (luaL_testudata(L, index, tstringKey))) {
                str = *tstr;
                break;
            } else {
                return false;
            }
        }
        default:
            return false;
    }
    return true;
}
 
t_string luaW_checktstring(lua_State *L, int index)
{
    t_string result;
    if (!luaW_totstring(L, index, result))
        luaW_type_error(L, index, "translatable string");
    return result;
}
 
bool luaW_iststring(lua_State* L, int index)
{
    if(lua_isstring(L, index)) {
        return true;
    }
    if(lua_isuserdata(L, index) && luaL_testudata(L, index, tstringKey)) {
        return true;
    }
    return false;
}
 
void luaW_filltable(lua_State *L, const config& cfg)
{
    if (!lua_checkstack(L, LUA_MINSTACK))
        return;
 
    int k = 1;
    for(const auto [child_key, child_cfg] : cfg.all_children_view())
    {
        luaW_push_namedtuple(L, {"tag", "contents"});
        lua_pushstring(L, child_key.c_str());
        lua_rawseti(L, -2, 1);
        lua_newtable(L);
        luaW_filltable(L, child_cfg);
        lua_rawseti(L, -2, 2);
        lua_rawseti(L, -2, k++);
    }
    for(const auto& [key, value] : cfg.attribute_range())
    {
        luaW_pushscalar(L, value);
        lua_setfield(L, -2, key.c_str());
    }
}
 
static int impl_namedtuple_get(lua_State* L)
{
    if(lua_type(L, 2) == LUA_TSTRING) {
        std::string k = lua_tostring(L, 2);
        luaL_getmetafield(L, 1, "__names");
        auto names = lua_check<std::vector<std::string>>(L, -1);
        auto iter = std::find(names.begin(), names.end(), k);
        if(iter != names.end()) {
            int i = std::distance(names.begin(), iter) + 1;
            lua_rawgeti(L, 1, i);
            return 1;
        }
    }
    return 0;
}
 
static int impl_namedtuple_set(lua_State* L)
{
    if(lua_type(L, 2) == LUA_TSTRING) {
        std::string k = lua_tostring(L, 2);
        luaL_getmetafield(L, 1, "__names");
        auto names = lua_check<std::vector<std::string>>(L, -1);
        auto iter = std::find(names.begin(), names.end(), k);
        if(iter != names.end()) {
            int i = std::distance(names.begin(), iter) + 1;
            lua_pushvalue(L, 3);
            lua_rawseti(L, 1, i);
            return 0;
        }
    }
    // If it's not one of the special names, just assign normally
    lua_settop(L, 3);
    lua_rawset(L, 1);
    return 0;
}
 
static int impl_namedtuple_dir(lua_State* L)
{
    luaL_getmetafield(L, 1, "__names");
    return 1;
}
 
static int impl_namedtuple_tostring(lua_State* L)
{
    std::vector<std::string> elems;
    for(unsigned i = 1; i <= lua_rawlen(L, 1); i++) {
        lua_getglobal(L, "tostring");
        lua_rawgeti(L, 1, i);
        lua_call(L, 1, 1);
        elems.push_back(lua_tostring(L, -1));
    }
    lua_push(L, "(" + utils::join(elems) + ")");
    return 1;
}
 
static int impl_namedtuple_compare(lua_State* L) {
    // Comparing a named tuple with any other table is always false.
    if(lua_type(L, 1) != LUA_TTABLE || lua_type(L, 2) != LUA_TTABLE) {
        NOT_EQUAL:
        lua_pushboolean(L, false);
        return 1;
    }
    luaL_getmetafield(L, 1, "__name");
    luaL_getmetafield(L, 2, "__name");
    if(!lua_rawequal(L, 3, 4)) goto NOT_EQUAL;
    lua_pop(L, 2);
    // Named tuples can be equal only if they both have the exact same set of names.
    luaL_getmetafield(L, 1, "__names");
    luaL_getmetafield(L, 2, "__names");
    auto lnames = lua_check<std::vector<std::string>>(L, 3);
    auto rnames = lua_check<std::vector<std::string>>(L, 4);
    if(lnames != rnames) goto NOT_EQUAL;
    lua_pop(L, 2);
    // They are equal if all of the corresponding members in each tuple are equal.
    for(std::size_t i = 1; i <= lnames.size(); i++) {
        lua_rawgeti(L, 1, i);
        lua_rawgeti(L, 2, i);
        if(!lua_compare(L, 3, 4, LUA_OPEQ)) goto NOT_EQUAL;
        lua_pop(L, 2);
    }
    // Theoretically, they could have other members besides the special named ones.
    // But we ignore those for the purposes of equality.
    lua_pushboolean(L, true);
    return 1;
}
 
void luaW_push_namedtuple(lua_State* L, const std::vector<std::string>& names)
{
    lua_createtable(L, names.size(), 0);
    lua_createtable(L, 0, 8);
    static luaL_Reg callbacks[] = {
        { "__index", &impl_namedtuple_get },
        { "__newindex", &impl_namedtuple_set },
        { "__dir", &impl_namedtuple_dir },
        { "__eq", &impl_namedtuple_compare },
        { "__tostring", &impl_namedtuple_tostring },
        { nullptr, nullptr }
    };
    luaL_setfuncs(L, callbacks, 0);
    static const char baseName[] = "named tuple";
    std::ostringstream str;
    str << baseName << '(';
    if(!names.empty()) {
        str << names[0];
    }
    for(std::size_t i = 1; i < names.size(); i++) {
        str << ", " << names[i];
    }
    str << ')';
    lua_push(L, str.str());
    lua_setfield(L, -2, "__metatable");
    lua_push(L, names);
    lua_setfield(L, -2, "__names");
    lua_pushstring(L, "named tuple");
    lua_setfield(L, -2, "__name");
    lua_setmetatable(L, -2);
}
 
std::vector<std::string> luaW_to_namedtuple(lua_State* L, int idx) {
    std::vector<std::string> names;
    if(luaL_getmetafield(L, idx, "__name")) {
        if(lua_check<std::string>(L, -1) == "named tuple") {
            luaL_getmetafield(L, idx, "__names");
            names = lua_check<std::vector<std::string>>(L, -1);
            lua_pop(L, 1);
        }
        lua_pop(L, 1);
    }
    return names;
}
 
void luaW_pushlocation(lua_State *L, const map_location& ml)
{
    luaW_push_namedtuple(L, {"x", "y"});
 
    lua_pushinteger(L, ml.wml_x());
    lua_rawseti(L, -2, 1);
 
    lua_pushinteger(L, ml.wml_y());
    lua_rawseti(L, -2, 2);
}
 
bool luaW_tolocation(lua_State *L, int index, map_location& loc) {
    if (!lua_checkstack(L, LUA_MINSTACK)) {
        return false;
    }
    if (lua_isnoneornil(L, index)) {
        // Need this special check because luaW_tovconfig returns true in this case
        return false;
    }
 
    vconfig dummy_vcfg = vconfig::unconstructed_vconfig();
 
    index = lua_absindex(L, index);
 
    if (lua_istable(L, index) || lua_isuserdata(L, index)) {
        map_location result;
        int x_was_num = 0, y_was_num = 0;
        lua_getfield(L, index, "x");
        result.set_wml_x(lua_tointegerx(L, -1, &x_was_num));
        lua_getfield(L, index, "y");
        result.set_wml_y(lua_tointegerx(L, -1, &y_was_num));
        lua_pop(L, 2);
        if (!x_was_num || !y_was_num) {
            // If we get here and it was userdata, checking numeric indices won't help
            // (It won't help if it was a WML table either, but there's no easy way to check that.)
            if (lua_isuserdata(L, index)) {
                return false;
            }
            lua_rawgeti(L, index, 1);
            result.set_wml_x(lua_tointegerx(L, -1, &x_was_num));
            lua_rawgeti(L, index, 2);
            result.set_wml_y(lua_tointegerx(L, -1, &y_was_num));
            lua_pop(L, 2);
        }
        if (x_was_num && y_was_num) {
            loc = result;
            return true;
        }
    } else if (lua_isnumber(L, index) && lua_isnumber(L, index + 1)) {
        // If it's a number, then we consume two elements on the stack
        // Since we have no way of notifying the caller that we have
        // done this, we remove the first number from the stack.
        loc.set_wml_x(lua_tointeger(L, index));
        lua_remove(L, index);
        loc.set_wml_y(lua_tointeger(L, index));
        return true;
    }
    return false;
}
 
map_location luaW_checklocation(lua_State *L, int index)
{
    map_location result;
    if (!luaW_tolocation(L, index, result))
        luaW_type_error(L, index, "location");
    return result;
}
 
int luaW_push_locationset(lua_State* L, const std::set<map_location>& locs)
{
    lua_createtable(L, locs.size(), 0);
    int i = 1;
    for(const map_location& loc : locs) {
        luaW_pushlocation(L, loc);
        lua_rawseti(L, -2, i);
        ++i;
    }
    return 1;
}
 
std::set<map_location> luaW_check_locationset(lua_State* L, int idx)
{
    std::set<map_location> locs;
    if(!lua_istable(L, idx)) {
        luaW_type_error(L, idx, "array of locations");
    }
    lua_len(L, idx);
    int len = luaL_checkinteger(L, -1);
    for(int i = 1; i <= len; i++) {
        const auto arg = scoped_lua_argument{L, idx, i};
        locs.insert(luaW_checklocation(L, -1));
    }
    return locs;
 
}
 
void luaW_pushconfig(lua_State *L, const config& cfg)
{
    lua_newtable(L);
    luaW_filltable(L, cfg);
}
 
luaW_PrintStack luaW_debugstack(lua_State* L) {
    return {L};
}
 
std::ostream& operator<<(std::ostream& os, const luaW_PrintStack& s) {
    int top = lua_gettop(s.L);
    os << "Lua Stack\n";
    for(int i = 1; i <= top; i++) {
        luaW_getglobal(s.L, "wesnoth", "as_text");
        lua_pushvalue(s.L, i);
        lua_call(s.L, 1, 1);
        auto value = luaL_checkstring(s.L, -1);
        lua_pop(s.L, 1);
        os << '[' << i << ']' << value << '\n';
    }
    if(top == 0) os << "(empty)\n";
    os << std::flush;
    return os;
}
 
#define return_misformed() \
  do { lua_settop(L, initial_top); return false; } while (0)
 
bool luaW_toconfig(lua_State *L, int index, config &cfg)
{
    cfg.clear();
    if (!lua_checkstack(L, LUA_MINSTACK))
        return false;
 
    // Get the absolute index of the table.
    index = lua_absindex(L, index);
    int initial_top = lua_gettop(L);
 
    switch (lua_type(L, index))
    {
        case LUA_TTABLE:
            break;
        case LUA_TUSERDATA:
        {
            if (vconfig * ptr = static_cast<vconfig *> (luaL_testudata(L, index, vconfigKey))) {
                cfg = ptr->get_parsed_config();
                return true;
            } else {
                return false;
            }
        }
        case LUA_TNONE:
        case LUA_TNIL:
            return true;
        default:
            return false;
    }
 
    // First convert the children (integer indices).
    for (int i = 1, i_end = lua_rawlen(L, index); i <= i_end; ++i)
    {
        lua_rawgeti(L, index, i);
        if (!lua_istable(L, -1)) return_misformed();
        lua_rawgeti(L, -1, 1);
        char const *m = lua_tostring(L, -1);
        if (!m || !config::valid_tag(m)) return_misformed();
        lua_rawgeti(L, -2, 2);
        if (!luaW_toconfig(L, -1, cfg.add_child(m)))
            return_misformed();
        lua_pop(L, 3);
    }
 
    // Then convert the attributes (string indices).
    for (lua_pushnil(L); lua_next(L, index); lua_pop(L, 1))
    {
        int indextype = lua_type(L, -2);
        if (indextype == LUA_TNUMBER) continue;
        if (indextype != LUA_TSTRING) return_misformed();
        const char* m = lua_tostring(L, -2);
        if(!m || !config::valid_attribute(m)) return_misformed();
        config::attribute_value &v = cfg[m];
        if (lua_istable(L, -1)) {
            int subindex = lua_absindex(L, -1);
            std::ostringstream str;
            for (int i = 1, i_end = lua_rawlen(L, subindex); i <= i_end; ++i, lua_pop(L, 1)) {
                lua_rawgeti(L, -1, i);
                config::attribute_value item;
                if (!luaW_toscalar(L, -1, item)) return_misformed();
                if (i > 1) str << ',';
                str << item;
            }
            // If there are any string keys, it's malformed
            for (lua_pushnil(L); lua_next(L, subindex); lua_pop(L, 1)) {
                if (lua_type(L, -2) != LUA_TNUMBER) return_misformed();
            }
            v = str.str();
        } else if (!luaW_toscalar(L, -1, v)) return_misformed();
    }
 
    lua_settop(L, initial_top);
    return true;
}
 
#undef return_misformed
 
 
config luaW_checkconfig(lua_State *L, int index)
{
    config result;
    if (!luaW_toconfig(L, index, result))
        luaW_type_error(L, index, "WML table");
    return result;
}
 
config luaW_checkconfig(lua_State *L, int index, const vconfig*& vcfg)
{
    config result = luaW_checkconfig(L, index);
    if(void* p = luaL_testudata(L, index, vconfigKey)) {
        vcfg = static_cast<vconfig*>(p);
    }
    return result;
}
 
bool luaW_tovconfig(lua_State *L, int index, vconfig &vcfg)
{
    switch (lua_type(L, index))
    {
        case LUA_TTABLE:
        {
            config cfg;
            bool ok = luaW_toconfig(L, index, cfg);
            if (!ok) return false;
            vcfg = vconfig(std::move(cfg));
            break;
        }
        case LUA_TUSERDATA:
            if (vconfig * ptr = static_cast<vconfig *> (luaL_testudata(L, index, vconfigKey))) {
                vcfg = *ptr;
            } else {
                return false;
            }
        case LUA_TNONE:
        case LUA_TNIL:
            break;
        default:
            return false;
    }
    return true;
}
 
vconfig luaW_checkvconfig(lua_State *L, int index, bool allow_missing)
{
    vconfig result = vconfig::unconstructed_vconfig();
    if (!luaW_tovconfig(L, index, result) || (!allow_missing && result.null()))
        luaW_type_error(L, index, "WML table");
    return result;
}
 
bool luaW_getglobal(lua_State *L, const std::vector<std::string>& path)
{
    lua_pushglobaltable(L);
    for (const std::string& s : path)
    {
        if (!lua_istable(L, -1)) goto discard;
        lua_pushlstring(L, s.c_str(), s.size());
        lua_rawget(L, -2);
        lua_remove(L, -2);
    }
 
    if (lua_isnil(L, -1)) {
        discard:
        lua_pop(L, 1);
        return false;
    }
    return true;
}
 
bool luaW_toboolean(lua_State *L, int n)
{
    return lua_toboolean(L,n) != 0;
}
 
bool luaW_pushvariable(lua_State *L, variable_access_const& v)
{
    try
    {
        if(v.exists_as_attribute())
        {
            luaW_pushscalar(L, v.as_scalar());
            return true;
        }
        else if(v.exists_as_container())
        {
            lua_newtable(L);
            luaW_filltable(L, v.as_container());
            return true;
        }
        else
        {
            lua_pushnil(L);
            return true;
        }
    }
    catch (const invalid_variablename_exception&)
    {
        WRN_LUA << v.get_error_message();
        return false;
    }
}
 
bool luaW_checkvariable(lua_State *L, variable_access_create& v, int n)
{
    int variabletype = lua_type(L, n);
    try
    {
        switch (variabletype) {
        case LUA_TBOOLEAN:
            v.as_scalar() = luaW_toboolean(L, n);
            return true;
        case LUA_TNUMBER:
            v.as_scalar() = lua_tonumber(L, n);
            return true;
        case LUA_TSTRING:
            v.as_scalar() = std::string(luaW_tostring(L, n));
            return true;
        case LUA_TUSERDATA:
            if (t_string * t_str = static_cast<t_string*> (luaL_testudata(L, n, tstringKey))) {
                v.as_scalar() = *t_str;
                return true;
            }
            goto default_explicit;
        case LUA_TTABLE:
            {
                config &cfg = v.as_container();
                if (luaW_toconfig(L, n, cfg)) {
                    return true;
                }
                [[fallthrough]];
            }
        default:
        default_explicit:
            return luaW_type_error(L, n, "WML table or scalar") != 0;
 
        }
    }
    catch (const invalid_variablename_exception&)
    {
        WRN_LUA << v.get_error_message() << " when attempting to write a '" << lua_typename(L, variabletype) << "'";
        return false;
    }
}
 
bool luaW_tableget(lua_State *L, int index, const char* key)
{
    index = lua_absindex(L, index);
    lua_pushstring(L, key);
    lua_gettable(L, index);
    if(lua_isnoneornil(L, -1)) {
        lua_pop(L, 1);
        return false;
    }
    return true;
}
 
std::string_view luaW_tostring(lua_State *L, int index)
{
    std::size_t len = 0;
    const char* str = lua_tolstring(L, index, &len);
    if(!str) {
        throw luaL_error (L, "not a string");
    }
    return std::string_view(str, len);
}
 
std::string_view luaW_tostring_or_default(lua_State *L, int index, std::string_view def)
{
    std::size_t len = 0;
    const char* str = lua_tolstring(L, index, &len);
    if(!str) {
        return def;
    }
    return std::string_view(str, len);
}
 
void chat_message(const std::string& caption, const std::string& msg)
{
    if (!game_display::get_singleton()) return;
    game_display::get_singleton()->get_chat_manager().add_chat_message(
        std::chrono::system_clock::now(), caption, 0, msg, events::chat_handler::MESSAGE_PUBLIC, false);
}
 
void push_error_handler(lua_State *L)
{
    luaW_getglobal(L, "debug", "traceback");
    lua_setfield(L, LUA_REGISTRYINDEX, executeKey);
}
 
int luaW_pcall_internal(lua_State *L, int nArgs, int nRets)
{
    // Load the error handler before the function and its arguments.
    lua_getfield(L, LUA_REGISTRYINDEX, executeKey);
    lua_insert(L, -2 - nArgs);
 
    int error_handler_index = lua_gettop(L) - nArgs - 1;
 
    ++lua_jailbreak_exception::jail_depth;
 
    // Call the function.
    int errcode = lua_pcall(L, nArgs, nRets, -2 - nArgs);
 
    --lua_jailbreak_exception::jail_depth;
    lua_jailbreak_exception::rethrow();
 
    // Remove the error handler.
    lua_remove(L, error_handler_index);
 
    return errcode;
}
 
#ifdef _MSC_VER
#pragma warning (push)
#pragma warning (disable: 4706)
#endif
bool luaW_pcall(lua_State *L, int nArgs, int nRets, bool allow_wml_error)
{
    int res = luaW_pcall_internal(L, nArgs, nRets);
 
    if (res)
    {
        /*
         * When an exception is thrown which doesn't derive from
         * std::exception m will be nullptr pointer.
         * When adding a new conditional branch, remember to log the
         * error with ERR_LUA or ERR_WML.
         */
        char const *m = lua_tostring(L, -1);
        if(m) {
            if (allow_wml_error && strncmp(m, "~wml:", 5) == 0) {
                m += 5;
                char const *e = strstr(m, "stack traceback");
                lg::log_to_chat() << std::string(m, e ? e - m : strlen(m)) << '\n';
                ERR_WML << std::string(m, e ? e - m : strlen(m));
            } else if (allow_wml_error && strncmp(m, "~lua:", 5) == 0) {
                m += 5;
                char const *e = nullptr, *em = m;
                while (em[0] && ((em = strstr(em + 1, "stack traceback"))))
#ifdef _MSC_VER
#pragma warning (pop)
#endif
                    e = em;
                ERR_LUA << std::string(m, e ? e - m : strlen(m));
                chat_message("Lua error", std::string(m, e ? e - m : strlen(m)));
            } else {
                ERR_LUA << m;
                chat_message("Lua error", m);
            }
        } else {
            ERR_LUA << "Lua caught unknown exception";
            chat_message("Lua caught unknown exception", "");
        }
        lua_pop(L, 1);
        return false;
    }
 
    return true;
}
 
// Originally luaL_typerror, now deprecated.
// Easier to define it for Wesnoth and not have to worry about it if we update Lua.
int luaW_type_error(lua_State *L, int narg, const char *tname) {
    const char *msg = lua_pushfstring(L, "%s expected, got %s", tname, luaL_typename(L, narg));
    return luaL_argerror(L, narg, msg);
}
 
// An alternate version which raises an error for a key in a table.
// In this version, narg should refer to the stack index of the table rather than the stack index of the key.
// kpath should be the key name or a string such as "key[idx].key2" specifying a path to the key.
int luaW_type_error (lua_State *L, int narg, const char* kpath, const char *tname) {
    const char *msg = lua_pushfstring(L, "%s expected for '%s', got %s", tname, kpath, luaL_typename(L, narg));
    return luaL_argerror(L, narg, msg);
}