From a6ba042cf792d29cda4f7f7924a68a017d9b0335 Mon Sep 17 00:00:00 2001 From: ShadowNinja Date: Thu, 5 Jun 2014 12:40:34 -0400 Subject: [PATCH] Add strict module Also fix leaking globals found by it. --- builtin/common/strict.lua | 47 ++++++++++++++++++++++++++++++++++++ builtin/game/auth.lua | 4 +-- builtin/game/item_entity.lua | 2 +- builtin/init.lua | 1 + 4 files changed, 51 insertions(+), 3 deletions(-) create mode 100644 builtin/common/strict.lua diff --git a/builtin/common/strict.lua b/builtin/common/strict.lua new file mode 100644 index 000000000..c4b181970 --- /dev/null +++ b/builtin/common/strict.lua @@ -0,0 +1,47 @@ + +-- Always warn when creating a global variable, even outside of a function. +-- This ignores mod namespaces (variables with the same name as the current mod). +local WARN_INIT = false + + +local function warn(message) + print(os.date("%H:%M:%S: WARNING: ")..message) +end + + +local meta = {} +local declared = {} + + +function meta:__newindex(name, value) + local info = debug.getinfo(2, "Sl") + local desc = ("%s:%d"):format(info.short_src, info.currentline) + if not declared[name] then + if info.what ~= "main" and info.what ~= "C" then + warn(("Assignment to undeclared global %q inside" + .." a function at %s.") + :format(name, desc)) + end + declared[name] = true + end + -- Ignore mod namespaces + if WARN_INIT and (not core.get_current_modname or + name ~= core.get_current_modname()) then + warn(("Global variable %q created at %s.") + :format(name, desc)) + end + rawset(self, name, value) +end + + +function meta:__index(name) + local info = debug.getinfo(2, "Sl") + if not declared[name] and info.what ~= "C" then + warn(("Undeclared global variable %q accessed at %s:%s") + :format(name, info.short_src, info.currentline)) + end + return rawget(self, name) +end + +setmetatable(_G, meta) + diff --git a/builtin/game/auth.lua b/builtin/game/auth.lua index baeb0159c..93b009981 100644 --- a/builtin/game/auth.lua +++ b/builtin/game/auth.lua @@ -7,7 +7,7 @@ function core.string_to_privs(str, delim) assert(type(str) == "string") delim = delim or ',' - privs = {} + local privs = {} for _, priv in pairs(string.split(str, delim)) do privs[priv:trim()] = true end @@ -17,7 +17,7 @@ end function core.privs_to_string(privs, delim) assert(type(privs) == "table") delim = delim or ',' - list = {} + local list = {} for priv, bool in pairs(privs) do if bool then table.insert(list, priv) diff --git a/builtin/game/item_entity.lua b/builtin/game/item_entity.lua index afbade98e..c0b9ae46f 100644 --- a/builtin/game/item_entity.lua +++ b/builtin/game/item_entity.lua @@ -56,7 +56,7 @@ core.register_entity(":__builtin:item", { item_texture = core.registered_items[itemname].inventory_image item_type = core.registered_items[itemname].type end - prop = { + local prop = { is_visible = true, visual = "wielditem", textures = {itemname}, diff --git a/builtin/init.lua b/builtin/init.lua index 6fc1bf6d5..095771d19 100644 --- a/builtin/init.lua +++ b/builtin/init.lua @@ -17,6 +17,7 @@ local gamepath = scriptdir.."game"..DIR_DELIM local commonpath = scriptdir.."common"..DIR_DELIM local asyncpath = scriptdir.."async"..DIR_DELIM +dofile(commonpath.."strict.lua") dofile(commonpath.."serialize.lua") dofile(commonpath.."misc_helpers.lua")