Module:Args: Difference between revisions

From Zelda Dungeon Wiki
Jump to navigation Jump to search
Want an adless experience? Log in or Create an account.
(add an alternative method ("expand") that isn't so convoluted to work with but is slightly more limited. still looking for better ways of doing this)
(remove the Arg class)
 
(3 intermediate revisions by the same user not shown)
Line 1: Line 1:
local Arg = {}
Arg.__index = Arg
function Arg.new( value )
  return setmetatable( {
    __value = value
  }, Arg )
end
-- get the Arg node's value, if it has one
function Arg:val()
  return self.__value
end
-- get the values of the Arg node's direct children
-- this is used to re-flatten/unwrap a particular piece of an Arg tree
function Arg:values()
  local vals = {}
  for k, v in pairs( self ) do
    if type( v ) == 'table' and v.val then
      vals[k] = v:val()
    end
  end
  return vals
end
local p = {}
local p = {}


function insertInto( tbl, key, value )
-- place the value in the right spot in the arg tree, determined by underscores in the key
function p.expandInto( args, key, value )
   local first, rest = string.match( key, '^(.-)_(.*)$' )
   local first, rest = string.match( key, '^(.-)_(.*)$' )
   local myKey = first or key
   local myKey = first or key
   myKey = tonumber( myKey ) or myKey
   myKey = tonumber( myKey ) or myKey
  -- make sure the node exists
  if not tbl[myKey] then tbl[myKey] = Arg.new() end


   if first then -- this is an internal node so insert children
   if first then -- this is an internal node so insert children
     insertInto( tbl[myKey], rest, value )
     args[myKey] = type( args[myKey] ) == 'table' and args[myKey] -- already a table
      or args[myKey] and { __value = args[myKey] } -- move existing value into a new table
      or {} -- create new table
    p.expandInto( args[myKey], rest, value )
   else -- this is a leaf so set value
   else -- this is a leaf so set value
     tbl[myKey].__value = value
     if type( args[myKey] ) == 'table' then args[myKey].__value = value
    else args[myKey] = value
    end
   end
   end
end
end


function p.parse( args )
-- expand the arg tree for the given flattened args
   local parsedArgs = Arg.new()
function p.expand( args )
   local expandedArgs = {}
   for k, v in pairs( args ) do
   for k, v in pairs( args ) do
     insertInto( parsedArgs, k, v )
     p.expandInto( expandedArgs, k, v )
   end
   end


   return parsedArgs
   return expandedArgs
end
 
-- coerce the given node into a table, in case it is a standalone value
function p.getTable( val )
  return type( val ) == 'table' and val or { __value = val }
end
 
-- get the value at the given node, in case the node contains a table
function p.getValue( val )
  return type( val ) == 'table' and val.__value or val
end
end


function p.expandInto( args, key, value )
-- expand the arg tree from the given frame and its parent
  local first, rest = string.match( key, '^(.-)_(.*)$' )
function p.fromFrame( frame )
   local myKey = first or key
   local parsedArgs = {}
  myKey = tonumber( myKey ) or myKey


   if first then -- this is an internal node so insert children
   for k, v in pairs( frame.args ) do
    -- note this will overwrite values in the case of { arg = 'val', arg_sub = 'val' }
     p.expandInto( parsedArgs, k, v )
    args[myKey] = type( args[myKey] ) == 'table' and args[myKey] or {}
     p.expandInto( args[myKey], rest, value )
  else -- this is a leaf so set value
    args[myKey] = args[myKey] or value -- don't overwrite a table
   end
   end
end


function p.expand( args )
  local parentFrame = frame:getParent()
   local expandedArgs = {}
   if parentFrame and parentFrame.args then
  for k, v in pairs( args ) do
    for k, v in pairs (parentFrame.args ) do
    p.expandInto( expandedArgs, k, v )
      p.expandInto( parsedArgs, k, v )
    end
   end
   end


   return expandedArgs
   return parsedArgs
end
end


-- parse and expand the arg tree for the given template on the given page
function p.fromPageContent( content, templateName )
function p.fromPageContent( content, templateName )
   templateName = templateName or 'Properties'
   templateName = templateName or 'Properties'
   local parsedArgs = Arg.new()
   local parsedArgs = {}


   local templateContents = string.match( content, '{{%s*' .. templateName .. '%s*|%s*(.-)%s*}}' )
   local templateContents = string.match( content, '{{%s*' .. templateName .. '%s*|%s*(.-)%s*}}' )


   if templateContents then
   if templateContents then
     for prop in mw.text.gsplit( templateContents, '|' ) do
     for prop in mw.text.gsplit( templateContents, '%s*|%s*' ) do
       local k, v = unpack( mw.text.split( prop, '=' ) )
       local k, v = unpack( mw.text.split( prop, '%s*=%s*' ) )
       insertInto( parsedArgs, k, v )
       p.expandInto( parsedArgs, k, v )
     end
     end
   end
   end

Latest revision as of 16:51, June 27, 2020

Documentation for this module may be created at Module:Args/doc

local p = {}

-- place the value in the right spot in the arg tree, determined by underscores in the key
function p.expandInto( args, key, value )
  local first, rest = string.match( key, '^(.-)_(.*)$' )
  local myKey = first or key
  myKey = tonumber( myKey ) or myKey

  if first then -- this is an internal node so insert children
    args[myKey] = type( args[myKey] ) == 'table' and args[myKey] -- already a table
      or args[myKey] and { __value = args[myKey] } -- move existing value into a new table
      or {} -- create new table
    p.expandInto( args[myKey], rest, value )
  else -- this is a leaf so set value
    if type( args[myKey] ) == 'table' then args[myKey].__value = value
    else args[myKey] = value
    end
  end
end

-- expand the arg tree for the given flattened args
function p.expand( args )
  local expandedArgs = {}
  for k, v in pairs( args ) do
    p.expandInto( expandedArgs, k, v )
  end

  return expandedArgs
end

-- coerce the given node into a table, in case it is a standalone value
function p.getTable( val )
  return type( val ) == 'table' and val or { __value = val }
end

-- get the value at the given node, in case the node contains a table
function p.getValue( val )
  return type( val ) == 'table' and val.__value or val
end

-- expand the arg tree from the given frame and its parent
function p.fromFrame( frame )
  local parsedArgs = {}

  for k, v in pairs( frame.args ) do
    p.expandInto( parsedArgs, k, v )
  end

  local parentFrame = frame:getParent()
  if parentFrame and parentFrame.args then
    for k, v in pairs (parentFrame.args ) do
      p.expandInto( parsedArgs, k, v )
    end
  end

  return parsedArgs
end

-- parse and expand the arg tree for the given template on the given page
function p.fromPageContent( content, templateName )
  templateName = templateName or 'Properties'
  local parsedArgs = {}

  local templateContents = string.match( content, '{{%s*' .. templateName .. '%s*|%s*(.-)%s*}}' )

  if templateContents then
    for prop in mw.text.gsplit( templateContents, '%s*|%s*' ) do
      local k, v = unpack( mw.text.split( prop, '%s*=%s*' ) )
      p.expandInto( parsedArgs, k, v )
    end
  end

  return parsedArgs
end

return p