Editing Module:Test

Jump to navigation Jump to search

Warning: You are not logged in. Your IP address will be publicly visible if you make any edits. If you log in or create an account, your edits will be attributed to your username, along with other benefits.

The edit can be undone. Please check the comparison below to verify that this is what you want to do, and then save the changes below to finish undoing the edit.

Latest revision Your text
Line 1: Line 1:
−
DefInfo = {}
+
if mw then
−
local wiki = {}
+
  ENV = "wiki"
−
 
+
else
−
local function runTime()
+
  mw = {}
−
   return string.format("%i", os.clock() * 1000)
+
   ENV = "dev"
 
end
 
end
  
−
------------------------------------------------------------------
+
INFO = true
−
-- deal with differences between MediaWiki and dev environments --
 
−
------------------------------------------------------------------
 
  
−
if mw then
+
---------------
 +
-- load data --
 +
---------------
  
−
  log = mw.log
+
data = {}
−
  logObject = mw.logObject
 
  
−
   local timeDataStart = runTime()
+
if ENV == "dev" then
−
    
+
   data["Biomes"] = loadfile("./data/BiomeDefs.lua")()
−
   Data   = mw.loadData('Module:Test/data')
+
   data["Races"] = loadfile("./data/ThingDefs_Races.lua")()
 +
elseif ENV == "wiki" then
 +
   data["Biomes"] = mw.loadData('Module:Test/data/biomes')
 +
   data["Races"] = mw.loadData('Module:Test/data/races')
 +
end
  
−
  local timeDataEnd = runTime()
+
------------------
−
  log(string.format('@%ims, data loaded in %ims', timeDataEnd, timeDataEnd - timeDataStart))
+
-- virtual keys --
 +
------------------
  
−
  Util  = require("Module:Test/lib/util")
+
-- this could be implemented with metatable events
−
  Search = require("Module:Test/lib/search")
+
-- they get added in get(id_pair)
−
  VF    = require("Module:Test/data/virtual")
 
  
−
   log(string.format('@%ims, modules loaded', runTime()))
+
local virtual_keys = {
 +
   ["Races"] = {
 +
    ["lives_in"] = function (race, biomes)
 +
      local list = {}
 +
      for biome_key, biome in pairs(biomes) do
 +
        for _,animal in ipairs(biome.wildAnimals) do
 +
          if race.defName == animal then
 +
            table.insert(list, biome_key)
 +
          end
 +
        end
 +
      end
 +
      return list
 +
    end
 +
  }
 +
}
  
−
else
+
--------------------
 +
-- load libraries --
 +
--------------------
  
−
  logDevStore = {}
+
log_entries = {}
  
−
   log = function(str)
+
if ENV == "dev" then
−
    table.insert(logDevStore, str)
+
  inspect = require './lib/inspect'
−
  end
+
   util = require("./lib/util")
 +
  search = require("./lib/search")
  
−
   logObject = function(obj, prefix)
+
   function pinspect(tbl, title)
−
     if prefix then
+
     if INFO then
−
       assert(type(prefix) == "string")
+
       util.hl(title)
−
      table.insert(logDevStore, prefix .. " = " .. Inspect(obj))
+
       print(inspect(tbl))
−
    else
 
−
       table.insert(logDevStore, Inspect(obj))
 
 
     end
 
     end
 
   end
 
   end
  
−
   function pp(tbl, title) -- pretty print tables
+
   mw.logObject = function(arg)
−
     Util.hl(title)
+
     table.insert(log_entries, inspect(arg))
−
    print(Inspect(tbl))
 
 
   end
 
   end
  
−
   local timeDataStart = runTime()
+
   mw.dumpObject = function(arg)
 +
    return inspect(arg)
 +
  end
  
−
   Data    = require "data/data"
+
   log = function(arg)
 +
    table.insert(log_entries, arg)
 +
  end
 +
end
  
−
   local timeDataEnd = runTime()
+
if ENV == "wiki" then
−
   log(string.format('@%ims, data loaded in %ims', timeDataEnd, timeDataEnd - timeDataStart))
+
  INFO = false
 +
  log = mw.log
 +
   util = require("Module:Test/lib/util")
 +
   search = require("Module:Test/lib/search")
 +
  function pinspect() end
 +
end
  
−
  Util    = require "lib/util"
+
-------------
−
  Search  = require "lib/search"
+
-- private --
−
  Inspect = require "lib/inspect"
+
-------------
−
  VF      = require "data/virtual"
 
  
−
   log(string.format('@%ims, modules loaded', runTime()))
+
local function vardefine(name, value)
 +
  local f_name = "vardefine"
 +
   assert(var_name, string.format("bad argument #1 to '%s' (argument missing, name of variable to define)", f_name))
 +
  assert(var_name == "string", string.format("bad argument #1 to '%s' (string expected, got %s)", f_name, type(var_name)))
 +
  assert(var_value, string.format("bad argument #2 to '%s' (argument missing, value to assign to variable)", f_name))
 +
  assert(var_value == "string" or var_value == "number", string.format("bad argument #2 to '%s' (string or number expected, got %s)", f_name, type(var_value)))
  
 +
  frame:callParserFunction('#vardefine', var_name, var_value)
 
end
 
end
  
−
-----------------------
 
−
-- private functions --
 
−
-----------------------
 
  
−
function DefInfo.vardefine(name, value, frame)
+
local function search_parent_def_table(key, def_table)
−
  assert(name, "vardefine: missing argument #1 (variable to definePrefix)")
+
   local ParentName = getParentName(def_table)
−
   assert(type(name) == "string", string.format("vardefine: bad argument #1 (string expected, got %s)", type(name)))
+
   if not ParentName then return nil end
−
   assert(value, "vardefine: missing argument #2 (value to assign)")
+
   local parentdef_table = search_table_recursive(ParentName, data)
−
   assert(type(value) == "string" or type(value) == "number" or type(value) =="boolean", string.format("vardefine: bad argument #2 (string, number or boolean expected, got %s)", type(value)))
+
   if not parentdef_table then return nil end
−
   assert(frame, "vardefine: 'frame' missing")
 
−
  frame:callParserFunction('#vardefine', name, value)
 
−
end
 
  
−
function DefInfo.expandDef(def, runMe)
+
  local found = search_table_recursive(key, parentdef_table)
−
   if not runMe then return nil end
+
   if found then return found
−
   local vFuncs = VF
+
   else
−
  for fName,func in pairs(vFuncs) do
+
    found = search_parent_def_table(key, parentdef_table)
−
     if func(def) then
+
     if found then return found end
−
      log(string.format('@%ims, expandDef: %s expanded with %s', runTime(), def.defName, fName))
 
−
    end
 
 
   end
 
   end
 
end
 
end
  
−
function DefInfo.mergeParents(baseDef, ignoreKeys)
 
−
  local ancestorIDs = {}
 
−
  local mergedDef = {}
 
−
  local def = baseDef
 
  
−
  while def._.ParentName do
+
local function merge_def(base_def_table, def_category, ignore_keys)
−
    local parentID = def._.DefCategory .. ":" .. def._.ParentName
 
−
    table.insert(ancestorIDs, parentID)
 
−
    def = Data[parentID]
 
−
  end
 
  
−
   ancestorIDs = Util.table.reverse(ancestorIDs)
+
   local ancestors = {}
−
   table.insert(ancestorIDs, baseDef._.DefCategory .. ":" .. baseDef.defName)
+
   local parent_name = base_def_table["ParentName"]
 +
  local parent_table = data[def_category][parent_name]
  
−
   for _,parentID in ipairs(ancestorIDs) do
+
   while parent_name do
−
     Util.table.overwrite(mergedDef, Data[parentID], ignoreKeys)
+
     table.insert(ancestors, parent_name)
 +
    parent_name = parent_table["ParentName"]
 +
    parent_table = data[def_category][parent_name]
 
   end
 
   end
  
−
   return mergedDef
+
   local inheritance_chain = util.shallowcopy(util.reverse_numeric_table(ancestors))
−
end
+
  table.insert(inheritance_chain, base_def_table.defName)
  
−
function DefInfo.getDef(defID, expandVF)
+
   local merged = {}
−
  if expandVF ~= false then expandVF = true end
+
   for i,v in ipairs(inheritance_chain) do
−
 
+
     util.overwrite_first_table_with_second(merged, data[def_category][inheritance_chain[i]], ignore_keys)
−
   local ignoreKeys = {"Abstract", "Name", "ParentName"}
 
−
  local baseDef
 
−
  local def
 
−
 
 
−
  if not defID then return nil end
 
−
 
 
−
   for _,def in pairs(Data) do
 
−
     if def.defName == defID then
 
−
      baseDef = def
 
−
      break
 
−
    elseif string.upper(def.label or '') == string.upper(defID) then
 
−
      baseDef = def
 
−
      break
 
−
    end
 
 
   end
 
   end
  
−
   if not baseDef then return nil end
+
   return merged
−
 
 
−
  def = DefInfo.mergeParents(baseDef, ignoreKeys)
 
−
 
 
−
  DefInfo.expandDef(def, expandVF)
 
−
 
 
−
  return def
 
 
end
 
end
  
−
local function setPrefix(tbl, parentKey)
 
−
  local mt = getmetatable(tbl) or {}
 
  
−
  for k,v in pairs(tbl) do
+
local function get(id_pair)
−
    local prefix = parentKey .. "_" .. k
+
  local res = search.conductor(id_pair, data)
−
    if type(v) == 'table' then
+
  if not res then
−
      setPrefix(v, prefix)
+
    log("Def not found")
−
     else
+
     return nil
−
      mt[k] = prefix
 
−
    end
 
 
   end
 
   end
  
−
   setmetatable(tbl, mt)
+
   local base_def_table = res.parent.table
−
end
+
  local def = merge_def(base_def_table, res.ancestors[2], {"ParentName", "Abstract"})
  
−
local function definePrefixed(tbl, frame)
+
  -- add virtual keys
−
   for k,v in pairs(tbl) do
+
   if virtual_keys[res.ancestors[2]] then
−
    if type(v) ~= 'table' then
+
    def._virtual = {}
−
      local mt = getmetatable(tbl)
+
    for k,func in pairs(virtual_keys[res.ancestors[2]]) do
−
      log(string.format('%s = %s', mt[k], tostring(v)))
+
       def._virtual[k] = func(def, data.Biomes)
−
       if mw then DefInfo.vardefine(mt[k], v, frame) end
 
−
    else
 
−
      definePrefixed(v, frame)
 
 
     end
 
     end
 
   end
 
   end
 +
 +
  return def
 
end
 
end
  
−
----------------------
+
------------
−
-- public interface --
+
-- public --
−
----------------------
+
------------
  
−
function wiki.count(frame)
+
local p = {}
−
  local query = wiki.query(frame)
 
−
  if type(wiki.queried) == 'table' then -- WARNING: checks a variable that is set in wiki.query (ugly)
 
−
    return Util.table.count(wiki.queried)
 
−
  end
 
−
end
 
  
−
function wiki.query(frame)
 
  
−
  local argLen = Util.table.count(frame.args, "number") -- #frame.args won't work as expected, check the doc
+
-- one function to rule them all, and in the darkness bind them
−
 
+
function p.query(frame)
−
   if not frame.args['defName'] and not frame.args['label'] then
+
   if not frame.args[1] then
−
     logObject(frame.args, string.format('query @ %ims: missing an identifying argument (defName or label)\nframe.args', runTime()))
+
     log("missing argument #1 (needed to identify a Def, defName or label can be used)")
 
     return nil
 
     return nil
 
   end
 
   end
  
−
   local def = DefInfo.getDef(frame.args['defName']) or DefInfo.getDef(frame.args['label'])
+
   local def = get({"defName", frame.args[1]}) or get({"label", frame.args[1]})
 +
  local pruned = def
  
−
   if not def then
+
   local arg_count = #frame.args
−
    logObject(frame.args, string.format("query @ %ims: Def not found\nframe.args", runTime()))
 
−
    return nil
 
−
  end
 
  
−
   if def and argLen == 0 then
+
   -- look at all the beautiful ifs!
−
    logObject(def, string.format("['%s:%s'] @ %ims", def._.DefCategory, def.defName, runTime()))
+
  for i,arg in ipairs(frame.args) do
−
    return nil
 
−
  end
 
  
−
  local processedDef = def
+
    -- do stuff for additional arguments
 +
    if i > 1 then
  
−
  for i,arg in ipairs(frame.args) do -- arguments
+
      -- special checks for the final argument
−
    arg = tonumber(arg) or arg -- frame.args are always strings on MediaWiki so convert back the numbers
+
      if i == arg_count then
 +
 
 +
        -- sibling_value
 +
        if frame.args["sibling_value"] then
 +
          pruned = search.conductor({nil, frame.args["sibling_value"]} , pruned)
 +
          if not pruned then
 +
            log(string.format("bad argument 'sibling_value' ('%s' not found in '%s')", frame.args["sibling_value"], frame.args[i-1]))
 +
            return nil
 +
          else
 +
            pruned = pruned.parent.table[arg]
 +
            if not pruned then
 +
              log(string.format("bad argument #%i ('%s' is not a sibling of '%s')", i, arg, frame.args["sibling_value"]))
 +
            end
 +
          end
 +
        else
 +
          pruned = search.conductor(arg, pruned)
 +
          if not pruned then
 +
            log(string.format("bad argument #%i ('%s' not found in '%s')", i, frame.args[i], frame.args[i-1]))
 +
            return nil
 +
          else
 +
            pruned = pruned.value
 +
          end
 +
        end
  
−
    if i == argLen and frame.args["sibling"] then
 
−
      processedDef = Search.find({nil, frame.args["sibling"]} , processedDef)
 
−
      if not processedDef then
 
−
        logObject(frame.args, string.format("query @ %ims: bad argument 'sibling' ('%s' not found')\nframe.args", runTime(), frame.args["sibling"]))
 
−
        return nil
 
 
       else
 
       else
−
         processedDef = Search.meta.parent.table[arg]
+
         pruned = search.conductor(arg, pruned)
−
         if not processedDef then
+
         if not pruned then
−
           logObject(frame.args, string.format("query @ %ims: bad argument #%i ('%s' is not a sibling of '%s')", runTime(), i, arg, frame.args["sibling"]))
+
           log(string.format("bad argument #%i ('%s' not found in '%s')", i, frame.args[i], frame.args[i-1]))
 
           return nil
 
           return nil
 +
        else
 +
          pruned = pruned.value
 
         end
 
         end
 
       end
 
       end
 +
 
     end
 
     end
  
−
    if i < argLen or i == argLen and not frame.args["sibling"] then
+
  end
−
      processedDef = Search.find(arg, processedDef)
 
−
      if not processedDef then
 
−
        logObject(frame.args, string.format("query @ %ims: bad argument #%i ('%s' not found)\nframe.args", runTime(), i, frame.args[i]))
 
−
        return nil
 
−
      else
 
−
        if type(processedDef) ~= 'table' and i < argLen then
 
−
          log(string.format("query @ %ims: warning Def ['%s'] argument #%i ('%s' returns a value, all extra arguments ignored)", runTime(), def['label'], i, frame.args[i]))
 
−
          return processedDef
 
−
        end
 
−
      end
 
−
    end
 
  
−
   end -- for arguments
+
   if type(pruned) == "table" then mw.logObject(pruned) end
 +
  return pruned
 +
end
  
−
  if type(processedDef) == "table" then
+
function p.logObject(frame)
−
    log(string.format("@%ims, query: table vardefined", runTime()))
+
  mw.logObject(get(frame))
−
    setPrefix(processedDef, frame.args[argLen])
+
end
−
    definePrefixed(processedDef, frame)
 
−
    wiki.queried = processedDef -- WARNING: sets a variable that is used in another function wiki.count (ugly)
 
−
    return nil
 
−
  end
 
  
−
   log(string.format("@%ims, query: %s printed", runTime(), type(processedDef)))
+
function p.dumpObject(frame)
−
  return processedDef
+
   return mw.dumpObject(get(frame))
 
end
 
end
  
−
------------------------------------
+
-------------------------------------------------------------------
−
-- simulate MediaWiki environment --
+
-- simulate MediaWiki/Scribunto module invocation using 'frame'  --
−
------------------------------------
+
-------------------------------------------------------------------
  
−
if not mw then
+
local simframe = { ["args"] = {} }
−
  local simframe = { ["args"] = {} }
+
 
−
  simframe.args['label'] = 'ancient cryptosleep casket'
+
simframe.args[1] = "Hare"
−
--~   simframe.args[1] = 'verbs'
+
simframe.args[2] = "race"
−
--~   simframe.args[2] = 'label'
+
--~ simframe.args["sibling_value"] = "AnimalJuvenile"
−
   wiki.query(simframe)
+
 
 +
frame = frame or simframe
 +
 
 +
-- frame.args are always strings on MediaWiki so convert them back to numbers
 +
for k,arg in pairs(frame.args) do
 +
   frame.args[k] = tonumber(arg) or arg
 +
end
 +
 
 +
if ENV == "dev" then
 +
   print(p.query(frame))
 
end
 
end
  
−
if not mw then
+
----------------------------------------
−
   Util.hl("DefInfo log")
+
-- simulate wiki log while developing --
−
   for _,v in ipairs(logDevStore) do
+
----------------------------------------
 +
 
 +
local clock = string.format("os.clock(): %i ms", os.clock() * 1000)
 +
log("--" .. string.rep("-", #clock) .. "--")
 +
log("- " .. clock .. " -")
 +
log("--" .. string.rep("-", #clock) .. "--")
 +
 
 +
if ENV == "dev" then
 +
   util.hl("log")
 +
   for _,v in ipairs(log_entries) do
 
     print(v)
 
     print(v)
 
   end
 
   end
 +
 
end
 
end
  
−
------------
+
return p
−
-- return --
 
−
------------
 
−
 
 
−
if mw then
 
−
  return wiki
 
−
else
 
−
  return DefInfo
 
−
end
 

Please note that all contributions to RimWorld Wiki are considered to be released under the CC BY-SA 3.0 (see RimWorld Wiki:Copyrights for details). If you do not want your writing to be edited mercilessly and redistributed at will, then do not submit it here.
You are also promising us that you wrote this yourself, or copied it from a public domain or similar free resource. Do not submit copyrighted work without permission!

Cancel Editing help (opens in new window)

Templates used on this page:

Retrieved from "https://rimworldwiki.com/wiki/Module:Test"