summaryrefslogtreecommitdiff
path: root/builtin/common/strict.lua
diff options
context:
space:
mode:
authorShadowNinja <shadowninja@minetest.net>2014-06-05 12:40:34 -0400
committerShadowNinja <shadowninja@minetest.net>2014-11-19 12:40:54 -0500
commita6ba042cf792d29cda4f7f7924a68a017d9b0335 (patch)
treec56bf610ed428ccdd819a6033b08e10684fa65a2 /builtin/common/strict.lua
parent6afdb22ba771a828021e25430b82c1cadb835431 (diff)
downloadminetest-a6ba042cf792d29cda4f7f7924a68a017d9b0335.tar.gz
minetest-a6ba042cf792d29cda4f7f7924a68a017d9b0335.tar.bz2
minetest-a6ba042cf792d29cda4f7f7924a68a017d9b0335.zip
Add strict module
Also fix leaking globals found by it.
Diffstat (limited to 'builtin/common/strict.lua')
-rw-r--r--builtin/common/strict.lua47
1 files changed, 47 insertions, 0 deletions
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)
+