Module:Test

This module is used for development.

Purpose

This module is used to query information from the uploaded and parsed game files.

Its main purpose is to populate the infoboxes.

Usage

A note on the order of named parameters. All of the parameters that look like ...=... are called named parameters and their order is not important (this is true for all templates).

query

{{#invoke:Test|query|<def ID>[|...|][|tag|][|sibling=...]}}

The work-horse. Output varies based on use:

If only the <def ID> parameter is set, it will show the whole Def in the log.

If simple values are queried it will return them.

If lists are queried it will return nothing but call {{#vardefine}} on all the simple values within it. What got defined can be seen in the page's log.

Named parameters:

<def ID>

This parameter identifies the Def so it is mandatory. It can take two forms, if both are defined then defName takes preference.

defName=<defName>

<defName> (case sensitive) should be replaced with the actual defName of a Def.

label=<label>

<label> (case insensitive) should be replaced with the actual label of a Def.

[sibling=...] (optional) (case sensitive)

Allows querying for something if we know its sibling's value (works only for values at the moment).

Anonymous parameters:

[|...|] (optional) (case sensitive)

Anonymous paramaters before the last one ([tag]) are here to help uniquely identify it. If the [tag] is already unique within a Def tree, then these additional parameters are not needed.

[|tag|] (optional) (case sensitive)

The final anonymous parameter defines what is to be queried.

count

{{#invoke:Test|count|<def ID>[|...|][|tag|][|sibling=...]}}

Parameters are the same as for query. It's basically a wrapped up query that behaves a bit differently.

The difference is in how it handles lists. If a list is queried, unlike query, it will return the length of the list.

How-to

Take a look at a Def

{{#invoke:Test|query|label=desert}}

Data is in the log.

Retrieve a simple value

{{#invoke:Test|query|defName=Caribou|description}}

Dealing with lists

{{#invoke:Test|query|defName=Mech_Scyther|tools}}

When a list is retrieved there will be no output but the log will contain a list of defined variables.

For convenience the list is reprinted here:

tools_1_linkedBodyPartsGroup = LeftBlade
tools_1_cooldownTime = 2
tools_1_label = left blade
tools_1_DPS = 10
tools_1_power = 20
tools_1_capacities_1 = Cut
tools_1_capacities_2 = Stab
tools_2_linkedBodyPartsGroup = RightBlade
tools_2_cooldownTime = 2
tools_2_label = right blade
tools_2_DPS = 10
tools_2_power = 20
tools_2_capacities_1 = Cut
tools_2_capacities_2 = Stab
tools_3_linkedBodyPartsGroup = HeadAttackTool
tools_3_capacities_1 = Blunt
tools_3_label = head
tools_3_DPS = 4.5
tools_3_chanceFactor = 0.2
tools_3_power = 9
tools_3_cooldownTime = 2

All of the above can be accessed with the use of {{#var:...}}.

{{#var:tools_1_DPS}}

DPS is not a normal member of this table but has been added with Lua. Let's call it a virtual field.

Retrieve something if a sibling is known

{{#invoke:Test|query|label=guinea pig|minAge|sibling=AnimalAdult}}

---

---@diagnostic disable: lowercase-global
local p = {}

------------------------------------------------------------------
-- deal with differences between MediaWiki and dev environments --
------------------------------------------------------------------

if mw then
  ENV = "wiki"
  log = mw.log

  util = require("Module:Test/lib/util")
  search = require("Module:Test/lib/search")
else
  ENV = "dev"

  mw = {}
  log = {}

  inspect = require './module/lib/inspect'
  util = require("./module/lib/util")
  search = require("./module/lib/search")
  diet = require("./module/data/diet")

  function pp(tbl, title) -- pretty print tables
    util.hl(title)
    print(inspect(tbl))
  end

  -- (re)define used mw functions that don't exist in dev environment
  mw.logObject = function(obj, prefix)
    if prefix then
      assert(type(prefix) == "string")
      table.insert(log, prefix .. " = " .. inspect(obj))
    else
      table.insert(log, inspect(obj))
    end
  end

  mw.dumpObject = function(arg)
    return inspect(arg)
  end

  mw.log = function(arg)
    table.insert(log, arg)
  end
end

---------------
-- load data --
---------------

if ENV == "dev" then
  data = loadfile("./data.lua")()
  -- diet = loadfile("./diet.lua")()
elseif ENV == "wiki" then
  data = mw.loadData('Module:Test/data')
end

version = data.version

------------------
-- virtual keys --
------------------

local virtual_store = {}
local virtual_keys = {
  ["Pawn"] = {

    function (def)
      virtField = "lives_in"
      biomes = {}
      for k,v in pairs(data) do
        prefix = string.match(k, '(.+):')
        if prefix == "BiomeDef" then
          table.insert(biomes, v)
        end
      end

      local list = {}
      for _,biome in pairs(biomes) do
        for animal,_ in pairs(biome.wildAnimals or {}) do
          if def.defName == animal then
            table.insert(list, biome.label)
          end
        end
      end

      if #list > 0 then
        def._virtual_[virtField] = list
      end
    end,

    function (def)
      virtField = "diet"
      diet = def.race.foodType
      flags = {}
      virtual_store.diet = {}

      for _,foodType in ipairs(diet) do
        if type(util.diet.foodType[foodType]) == "boolean" then
          flags[foodType] = true
        else
          for foodItem,_ in pairs(util.diet.foodType[foodType]) do
            flags[foodItem] = true
          end
        end
      end

      for flag,_ in pairs(flags) do
        table.insert(virtual_store.diet, flag)
      end

      if #virtual_store.diet > 0 then
        def._virtual_[virtField] = virtual_store.diet
      end
    end,

  }
}

-----------------------
-- private functions --
-----------------------

local function vardefine(name, value)
  local f_name = "vardefine"
  frame = mw.getCurrentFrame()
  assert(name, string.format("bad argument #1 to '%s' (argument missing, name of variable to define)", f_name))
  assert(type(name) == "string", string.format("bad argument #1 to '%s' (string expected, got %s)", f_name, type(name)))
  assert(value, string.format("bad argument #2 to '%s' (argument missing, value to assign to variable)", f_name))
  -- assert(value == "string" or value == "number", string.format("bad argument #2 to '%s' (string or number expected, got %s)", f_name, type(value)))

  frame:callParserFunction('#vardefine', name, value)
end


local function mergeParents(baseDef, ignoreKeys)
  local ancestorIDs = {}
  local mergedDef = {}
  local def = baseDef

  while def._.ParentName do
    local parentID = def._.DefCategory .. ":" .. def._.ParentName
    table.insert(ancestorIDs, parentID)
    def = data[parentID]
  end

  ancestorIDs = util.table.reverse(ancestorIDs)
  table.insert(ancestorIDs, baseDef._.DefCategory .. ":" .. baseDef.defName)

  for _,parentID in ipairs(ancestorIDs) do
    util.table.overwrite(mergedDef, data[parentID], ignoreKeys)
  end

  return mergedDef
end


function getDef(defIDsuffix, defIDprefix)
  local ignoreKeys = {"Abstract", "Name", "ParentName"}
  local baseDef
  local mergedDef

  if defIDprefix then
    local defID = defIDprefix .. ":" .. defIDsuffix
    baseDef = data[defID]
    assert(not baseDef, string.format("getDef: Def '%s' not found", defID))
  else
    for defID,def in pairs(data) do
      -- WARNING: this depends on there not being any preexisting colons in the relevant substrings
      prefix = string.match(defID, '(.+):')
      suffix = string.match(defID, ':(.+)')
      if suffix == defIDsuffix then
        assert(not baseDef, string.format("getDef: Def conflict (more than one '%s')", defIDsuffix))
        baseDef = def
      end
    end
    assert(baseDef, string.format("getDef: Def '%s' not found", defIDsuffix))
  end

  mergedDef = mergeParents(baseDef, ignoreKeys)

  if virtual_keys[mergedDef.category] then
    mergedDef._virtual_ = {}
    for k,func in ipairs(virtual_keys[mergedDef.category]) do
      func(mergedDef)
    end
  end

  return mergedDef
end


----------------------
-- public interface --
----------------------

local function setMeta(table, parentKey)
  local mw = {}
  for k,v in pairs(table) do

    if type(v) == 'table' then
      setMeta(v, parentKey .. "_" .. k)
    else
      mw[k] = parentKey .. "_" .. k
    end
  end
  setmetatable(table, mw)
end


local function defineRecursive(tbl)
  for k,v in pairs(tbl) do
    if type(v) ~= 'table' then
      local mt = getmetatable(tbl)
      mw.log(string.format("%s = %s", mt[k], v))
      vardefine(mt[k], v)
    else 
      defineRecursive(v)
    end
  end
end


-- procedure
function p.define(frame)
  local argLen = util.table.count(frame.args, "number") -- #frame.args won't work as expected, check the doc
  local tbl = p.query(frame)
  if type(tbl) == 'table' then
    setMeta(tbl, frame.args[argLen])
    defineRecursive(tbl)  
  end
end


function p.getDefName(frame)
  local defName
  local label = frame.args[1]

  if not label then
    mw.logObject(frame.args, "frame.args")
    mw.log("getDefName: missing argument #1 (label)")
    return nil
  end

  for defID,def in pairs(data) do
    if string.upper(def.label or "") == string.upper(label) then
      defName = def.defName
    end
  end

  if not defName then
    mw.logObject(frame.args, "frame.args")
    mw.log(string.format("getDefName: '%s' not found", label))
  end

  return defName
end


function p.count(frame)
  local query = p.query(frame)
  if type(query) == 'table' then
    return #query
  else
    return type(query)
  end
end


function p.query(frame)
  local argLen = util.table.count(frame.args, "number") -- #frame.args won't work as expected, check the doc

  -- implement expressive argument checks so we know what's going on
  -- use them as a kind of usage guide (give as much info as possible)

  if not frame.args[1] then
    mw.logObject(frame.args, "frame.args")
    mw.log("query: missing argument #1 (defName or Name, for abstract Defs)")
    return nil
  end

  local def = getDef(frame.args[1])

  if not def then
    mw.logObject(frame.args, "frame.args")
    mw.log(string.format("query: bad argument #1 ('%s' not found)", frame.args[1]))
    return nil
  end

  local prune = def

  for i,arg in ipairs(frame.args) do -- arguments

    arg = tonumber(arg) or arg -- frame.args are always strings on MediaWiki so convert back the numbers

    -- NOTE: might consider doing something about the if tree (trim it down a bit)

    if i > 1 then -- additional arguments

      if i == argLen then -- if final argument

        if frame.args["sibling"] then -- sibling
          prune = search.conductor({nil, frame.args["sibling"]} , prune)
          if not prune then
            mw.logObject(frame.args, "frame.args")
            mw.log(string.format("query: bad argument 'sibling' ('%s' not found in '%s')", frame.args["sibling"], frame.args[i-1]))
            return nil
          else
            prune = prune.parent.table[arg]
            if not prune then
              mw.logObject(frame.args, "frame.args")
              mw.log(string.format("query: bad argument #%i ('%s' is not a sibling of '%s')", i, arg, frame.args["sibling"]))
            end
          end
        else
          prune = search.conductor(arg, prune)
          if not prune then
            mw.logObject(frame.args, "frame.args")
            mw.log(string.format("query: bad argument #%i ('%s' not found in '%s')", i, frame.args[i], frame.args[i-1]))
            return nil
          else
            prune = prune.value
          end
        end -- sibling

      else -- if not final argument
        prune = search.conductor(arg, prune)
        if not prune then
          mw.logObject(frame.args, "frame.args")
          mw.log(string.format("query: bad argument #%i ('%s' not found in '%s')", i, frame.args[i], frame.args[i-1]))
          return nil
        else
          prune = prune.value
        end
      end

    end -- additional arguments

  end -- for arguments

  if type(prune) == "table" then
    setMeta(prune, frame.args[argLen])
    defineRecursive(prune)
  end

  return prune
end

---------------------------------
-- simulate module invocation  --
---------------------------------

local simframe = { ["args"] = {} }
frame = frame or simframe

--~ simframe.args[1] = "Penoxycyline"
simframe.args[1] = "Mech_Scyther"
simframe.args[2] = "tools"
-- simframe.args[3] = "1"
--~ simframe.args[3] = 3

if ENV == "dev" then

  print(p.query(frame))

end

local clock = string.format("os.clock(): %i ms", os.clock() * 1000)
mw.log("--" .. string.rep("-", #clock) .. "--")
mw.log("- " .. clock .. " -")
mw.log("--" .. string.rep("-", #clock) .. "--")

----------------------------------------
-- simulate wiki log while developing --
----------------------------------------

if ENV == "dev" then
  util.hl("log")
  for _,v in ipairs(log) do
    print(v)
  end
end

return p -- return module