implement variable log levels

so that one need not see all the spammy stuff
if the only things of interest are e.g. warnings
This commit is contained in:
Vanessa Dannenberg 2021-04-07 05:16:11 -04:00
parent 6009f261c2
commit 50f921a85a
2 changed files with 46 additions and 36 deletions

12
API.txt
View File

@ -446,12 +446,22 @@ question is already loaded, or false if not.
===== =====
dbg(string) dbg(string, level)
This is a simple debug output function which takes one string parameter. It This is a simple debug output function which takes one string parameter. It
just checks if DEBUG is true and outputs the phrase "[Plantlife] " followed by just checks if DEBUG is true and outputs the phrase "[Plantlife] " followed by
the supplied string, via the print() function, if so. the supplied string, via the print() function, if so.
'level' is a number that, if supplied, dictates the lowest 'biome_lib_debug'
can be set to in minetest.conf for this message to be displayed. Both the
default log level and the default message level are 0, thus always showing the
supplied message.
Although it's not set in stone, a good practice is to use a level of 0 (or
just omit the value) for anything that generally important enough that it
ought always be shown, 1 for errors, 2 for warnings, 3 for info, 4 for verbose
spammy stuff.
===== =====
biome_lib:generate_tree(pos, treemodel) biome_lib:generate_tree(pos, treemodel)
biome_lib:grow_tree(pos, treemodel) biome_lib:grow_tree(pos, treemodel)

View File

@ -67,10 +67,11 @@ else
end end
biome_lib.intllib = S biome_lib.intllib = S
local DEBUG = minetest.settings:get_bool("biome_lib_debug", false) local DEBUG_LEVEL = tonumber(minetest.settings:get("biome_lib_debug")) or 0
function biome_lib:dbg(msg) function biome_lib.dbg(msg, level)
if DEBUG then local l = tonumber(level) or 0
if DEBUG_LEVEL >= l then
print("[Biome Lib] "..msg) print("[Biome Lib] "..msg)
minetest.log("verbose", "[Biome Lib] "..msg) minetest.log("verbose", "[Biome Lib] "..msg)
end end
@ -176,17 +177,17 @@ function biome_lib:register_generate_plant(biomedef, nodes_or_function_or_model)
if type(nodes_or_function_or_model) == "string" if type(nodes_or_function_or_model) == "string"
and string.find(nodes_or_function_or_model, ":") and string.find(nodes_or_function_or_model, ":")
and not minetest.registered_nodes[nodes_or_function_or_model] then and not minetest.registered_nodes[nodes_or_function_or_model] then
biome_lib:dbg("Warning: Ignored registration for undefined spawn node: "..dump(nodes_or_function_or_model)) biome_lib.dbg("Warning: Ignored registration for undefined spawn node: "..dump(nodes_or_function_or_model), 2)
return return
end end
if type(nodes_or_function_or_model) == "string" if type(nodes_or_function_or_model) == "string"
and not string.find(nodes_or_function_or_model, ":") then and not string.find(nodes_or_function_or_model, ":") then
biome_lib:dbg("Warning: Registered function call using deprecated string method: "..dump(nodes_or_function_or_model)) biome_lib.dbg("Warning: Registered function call using deprecated string method: "..dump(nodes_or_function_or_model), 2)
end end
if biomedef.check_air == false then if biomedef.check_air == false then
biome_lib:dbg("Register no-air-check mapgen hook: "..dump(nodes_or_function_or_model)) biome_lib.dbg("Register no-air-check mapgen hook: "..dump(nodes_or_function_or_model), 3)
biome_lib.actionslist_no_aircheck[#biome_lib.actionslist_no_aircheck + 1] = { biomedef, nodes_or_function_or_model } biome_lib.actionslist_no_aircheck[#biome_lib.actionslist_no_aircheck + 1] = { biomedef, nodes_or_function_or_model }
local s = biomedef.surface local s = biomedef.surface
if type(s) == "string" then if type(s) == "string" then
@ -195,7 +196,7 @@ function biome_lib:register_generate_plant(biomedef, nodes_or_function_or_model)
biome_lib.surfaceslist_no_aircheck[#biome_lib.surfaceslist_no_aircheck + 1] = s biome_lib.surfaceslist_no_aircheck[#biome_lib.surfaceslist_no_aircheck + 1] = s
end end
else else
biome_lib:dbg("Warning: Ignored no-air-check registration for undefined surface node: "..dump(s)) biome_lib.dbg("Warning: Ignored no-air-check registration for undefined surface node: "..dump(s), 2)
end end
else else
for i = 1, #biomedef.surface do for i = 1, #biomedef.surface do
@ -205,12 +206,12 @@ function biome_lib:register_generate_plant(biomedef, nodes_or_function_or_model)
biome_lib.surfaceslist_no_aircheck[#biome_lib.surfaceslist_no_aircheck + 1] = s biome_lib.surfaceslist_no_aircheck[#biome_lib.surfaceslist_no_aircheck + 1] = s
end end
else else
biome_lib:dbg("Warning: Ignored no-air-check registration for undefined surface node: "..dump(s)) biome_lib.dbg("Warning: Ignored no-air-check registration for undefined surface node: "..dump(s), 2)
end end
end end
end end
else else
biome_lib:dbg("Register with-air-checking mapgen hook: "..dump(nodes_or_function_or_model)) biome_lib.dbg("Register with-air-checking mapgen hook: "..dump(nodes_or_function_or_model), 3)
biome_lib.actionslist_aircheck[#biome_lib.actionslist_aircheck + 1] = { biomedef, nodes_or_function_or_model } biome_lib.actionslist_aircheck[#biome_lib.actionslist_aircheck + 1] = { biomedef, nodes_or_function_or_model }
local s = biomedef.surface local s = biomedef.surface
if type(s) == "string" then if type(s) == "string" then
@ -219,7 +220,7 @@ function biome_lib:register_generate_plant(biomedef, nodes_or_function_or_model)
biome_lib.surfaceslist_aircheck[#biome_lib.surfaceslist_aircheck + 1] = s biome_lib.surfaceslist_aircheck[#biome_lib.surfaceslist_aircheck + 1] = s
end end
else else
biome_lib:dbg("Warning: Ignored with-air-checking registration for undefined surface node: "..dump(s)) biome_lib.dbg("Warning: Ignored with-air-checking registration for undefined surface node: "..dump(s), 2)
end end
else else
for i = 1, #biomedef.surface do for i = 1, #biomedef.surface do
@ -229,7 +230,7 @@ function biome_lib:register_generate_plant(biomedef, nodes_or_function_or_model)
biome_lib.surfaceslist_aircheck[#biome_lib.surfaceslist_aircheck + 1] = s biome_lib.surfaceslist_aircheck[#biome_lib.surfaceslist_aircheck + 1] = s
end end
else else
biome_lib:dbg("Warning: Ignored with-air-checking registration for undefined surface node: "..dump(s)) biome_lib.dbg("Warning: Ignored with-air-checking registration for undefined surface node: "..dump(s), 2)
end end
end end
end end
@ -381,7 +382,7 @@ function biome_lib.populate_surfaces(biome, nodes_or_function_or_model, snodes,
if objtype == "table" then if objtype == "table" then
if nodes_or_function_or_model.axiom then if nodes_or_function_or_model.axiom then
biome_lib:generate_tree(p_top, nodes_or_function_or_model) biome_lib:generate_tree(p_top, nodes_or_function_or_model)
biome_lib:dbg("An L-tree was spawned at "..minetest.pos_to_string(p_top)) biome_lib.dbg("An L-tree was spawned at "..minetest.pos_to_string(p_top), 4)
spawned = true spawned = true
else else
local fdir = nil local fdir = nil
@ -390,7 +391,7 @@ function biome_lib.populate_surfaces(biome, nodes_or_function_or_model, snodes,
end end
local n=nodes_or_function_or_model[math.random(#nodes_or_function_or_model)] local n=nodes_or_function_or_model[math.random(#nodes_or_function_or_model)]
minetest.swap_node(p_top, { name = n, param2 = fdir }) minetest.swap_node(p_top, { name = n, param2 = fdir })
biome_lib:dbg("Node \""..n.."\" was randomly picked from a list and placed at "..minetest.pos_to_string(p_top)) biome_lib.dbg("Node \""..n.."\" was randomly picked from a list and placed at "..minetest.pos_to_string(p_top), 4)
spawned = true spawned = true
end end
elseif objtype == "string" and elseif objtype == "string" and
@ -400,18 +401,18 @@ function biome_lib.populate_surfaces(biome, nodes_or_function_or_model, snodes,
fdir = math.random(biome.random_facedir[1], biome.random_facedir[2]) fdir = math.random(biome.random_facedir[1], biome.random_facedir[2])
end end
minetest.swap_node(p_top, { name = nodes_or_function_or_model, param2 = fdir }) minetest.swap_node(p_top, { name = nodes_or_function_or_model, param2 = fdir })
biome_lib:dbg("Node \""..nodes_or_function_or_model.."\" was placed at "..minetest.pos_to_string(p_top)) biome_lib.dbg("Node \""..nodes_or_function_or_model.."\" was placed at "..minetest.pos_to_string(p_top), 4)
spawned = true spawned = true
elseif objtype == "function" then elseif objtype == "function" then
nodes_or_function_or_model(pos) nodes_or_function_or_model(pos)
biome_lib:dbg("A function was run on surface node at "..minetest.pos_to_string(pos)) biome_lib.dbg("A function was run on surface node at "..minetest.pos_to_string(pos), 4)
spawned = true spawned = true
elseif objtype == "string" and pcall(loadstring(("return %s(...)"): elseif objtype == "string" and pcall(loadstring(("return %s(...)"):
format(nodes_or_function_or_model)),pos) then format(nodes_or_function_or_model)),pos) then
spawned = true spawned = true
biome_lib:dbg("An obsolete string-specified function was run on surface node at "..minetest.pos_to_string(p_top)) biome_lib.dbg("An obsolete string-specified function was run on surface node at "..minetest.pos_to_string(p_top), 4)
else else
biome_lib:dbg("Warning: Ignored invalid definition for object "..dump(nodes_or_function_or_model).." that was pointed at {"..dump(pos).."}") biome_lib.dbg("Warning: Ignored invalid definition for object "..dump(nodes_or_function_or_model).." that was pointed at {"..dump(pos).."}", 2)
end end
else else
tries = tries + 1 tries = tries + 1
@ -484,8 +485,8 @@ function biome_lib.generate_block(shutting_down)
table.remove(biome_lib.block_log, 1) table.remove(biome_lib.block_log, 1)
end end
biome_lib.pos_hash = nil biome_lib.pos_hash = nil
biome_lib:dbg("Mapblock at "..minetest.pos_to_string(minp).. biome_lib.dbg("Mapblock at "..minetest.pos_to_string(minp)..
" had a neighbor not fully emerged, skipped it for now.") " had a neighbor not fully emerged, skipped it for now.", 4)
return return
else else
biome_lib.pos_hash.surface_node_list = airflag biome_lib.pos_hash.surface_node_list = airflag
@ -493,16 +494,16 @@ function biome_lib.generate_block(shutting_down)
or minetest.find_nodes_in_area(minp, maxp, biome_lib.surfaceslist_no_aircheck) or minetest.find_nodes_in_area(minp, maxp, biome_lib.surfaceslist_no_aircheck)
biome_lib.pos_hash.action_index = 1 biome_lib.pos_hash.action_index = 1
if #biome_lib.pos_hash.surface_node_list > 0 then if #biome_lib.pos_hash.surface_node_list > 0 then
biome_lib:dbg("Mapblock at "..minetest.pos_to_string(minp).. biome_lib.dbg("Mapblock at "..minetest.pos_to_string(minp)..
" has "..#biome_lib.pos_hash.surface_node_list.. " has "..#biome_lib.pos_hash.surface_node_list..
" surface nodes to work on (airflag="..dump(airflag)..")") " surface nodes to work on (airflag="..dump(airflag)..")", 4)
end end
end end
elseif not (airflag and biome_lib.actionslist_aircheck[biome_lib.pos_hash.action_index]) elseif not (airflag and biome_lib.actionslist_aircheck[biome_lib.pos_hash.action_index])
and not (not airflag and biome_lib.actionslist_no_aircheck[biome_lib.pos_hash.action_index]) then and not (not airflag and biome_lib.actionslist_no_aircheck[biome_lib.pos_hash.action_index]) then
-- the block is finished, remove it -- the block is finished, remove it
if #biome_lib.pos_hash.surface_node_list > 0 then if #biome_lib.pos_hash.surface_node_list > 0 then
biome_lib:dbg("Deleted mapblock "..minetest.pos_to_string(minp).." from the block log") biome_lib.dbg("Deleted mapblock "..minetest.pos_to_string(minp).." from the block log", 4)
end end
table.remove(blocklog, 1) table.remove(blocklog, 1)
biome_lib.pos_hash = nil biome_lib.pos_hash = nil
@ -527,9 +528,9 @@ function biome_lib.generate_block(shutting_down)
end end
end end
if added > 0 then if added > 0 then
biome_lib:dbg("biome_lib.populate_surfaces ran on mapblock at ".. biome_lib.dbg("biome_lib.populate_surfaces ran on mapblock at "..
minetest.pos_to_string(minp)..". Entry #".. minetest.pos_to_string(minp)..". Entry #"..
(biome_lib.pos_hash.action_index-1).." added "..added.." items.") (biome_lib.pos_hash.action_index-1).." added "..added.." items.", 4)
end end
end end
end end
@ -558,8 +559,8 @@ minetest.register_on_shutdown(function()
return return
end end
print("[biome_lib] Stand by, playing out the rest of the mapblock log") biome_lib.dbg("[biome_lib] Stand by, playing out the rest of the mapblock log", 0)
print("(there are "..(#biome_lib.block_log + #biome_lib.block_recheck_list).." entries)...") biome_lib.dbg("(there are "..(#biome_lib.block_log + #biome_lib.block_recheck_list).." entries)...", 0)
while #biome_lib.block_log > 0 do while #biome_lib.block_log > 0 do
biome_lib.generate_block(true) biome_lib.generate_block(true)
end end
@ -762,24 +763,23 @@ function biome_lib:get_nodedef_field(nodename, fieldname)
return minetest.registered_nodes[nodename][fieldname] return minetest.registered_nodes[nodename][fieldname]
end end
if DEBUG then if DEBUG_LEVEL >= 3 then
biome_lib.last_count = 0 biome_lib.last_count = 0
function biome_lib.show_pending_block_count() function biome_lib.show_pending_block_count()
if biome_lib.last_count ~= #biome_lib.block_log then if biome_lib.last_count ~= #biome_lib.block_log then
biome_lib:dbg("Pending block count: "..(#biome_lib.block_log + #biome_lib.block_recheck_list)) biome_lib.dbg("Pending block count: "..(#biome_lib.block_log + #biome_lib.block_recheck_list), 3)
biome_lib.last_count = #biome_lib.block_log biome_lib.last_count = #biome_lib.block_log
end end
minetest.after(1, biome_lib.show_pending_block_count) minetest.after(1, biome_lib.show_pending_block_count)
end end
biome_lib.show_pending_block_count() biome_lib.show_pending_block_count()
minetest.after(0, function()
print("Registered a total of "..(#biome_lib.surfaceslist_aircheck)+(#biome_lib.surfaceslist_no_aircheck).." surface types to be evaluated, spread")
print("across "..#biome_lib.actionslist_aircheck.." actions with air-checking and "..#biome_lib.actionslist_no_aircheck.." actions without.")
end)
end end
print("[Biome Lib] Loaded") minetest.after(0, function()
biome_lib.dbg("Registered a total of "..(#biome_lib.surfaceslist_aircheck)+(#biome_lib.surfaceslist_no_aircheck).." surface types to be evaluated, spread", 0)
biome_lib.dbg("across "..#biome_lib.actionslist_aircheck.." actions with air-checking and "..#biome_lib.actionslist_no_aircheck.." actions without.", 0)
end)
biome_lib.dbg("[Biome Lib] Loaded", 0)