Module:Arguments: Difference between revisions

    From Nonbinary Wiki
    No edit summary
    m>Mr. Stradivarius
    (add a "wrappers" option and fix bug when frame:getParent() returns nil, per protected edit request by User:Jackmcbarn)
    Line 2: Line 2:
    -- #invoke. It is intended for use by other Lua modules, and should not be
    -- #invoke. It is intended for use by other Lua modules, and should not be
    -- called from #invoke directly.
    -- called from #invoke directly.
     
    local libraryUtil = require('libraryUtil')
    local libraryUtil = require('libraryUtil')
    local checkType = libraryUtil.checkType
    local checkType = libraryUtil.checkType
     
    local arguments = {}
    local arguments = {}
     
    -- Generate four different tidyVal functions, so that we don't have to check the
    -- Generate four different tidyVal functions, so that we don't have to check the
    -- options every time we call it.
    -- options every time we call it.
     
    local function tidyValDefault(key, val)
    local function tidyValDefault(key, val)
    if type(val) == 'string' then
    if type(val) == 'string' then
    Line 23: Line 23:
    end
    end
    end
    end
     
    local function tidyValTrimOnly(key, val)
    local function tidyValTrimOnly(key, val)
    if type(val) == 'string' then
    if type(val) == 'string' then
    Line 31: Line 31:
    end
    end
    end
    end
     
    local function tidyValRemoveBlanksOnly(key, val)
    local function tidyValRemoveBlanksOnly(key, val)
    if type(val) == 'string' then
    if type(val) == 'string' then
    Line 43: Line 43:
    end
    end
    end
    end
     
    local function tidyValNoChange(key, val)
    local function tidyValNoChange(key, val)
    return val
    return val
    end
    end
     
    function arguments.getArgs(frame, options)
    function arguments.getArgs(frame, options)
    checkType('getArgs', 1, frame, 'table', true)
    checkType('getArgs', 1, frame, 'table', true)
    Line 53: Line 53:
    frame = frame or {}
    frame = frame or {}
    options = options or {}
    options = options or {}
     
    --[[
    --[[
    -- Get the arguments from the frame object if available. If the frame object
    -- Get the argument tables. If we were passed a valid frame object, get the
    -- is not available, we are being called from another Lua module or from the
    -- frame arguments (fargs) and the parent frame arguments (pargs), depending
    -- debug console, so assign the args to a new variable so we can
    -- on the options set and on the parent frame's availability. If we weren't
    -- differentiate them.
    -- passed a valid frame object, we are being called from another Lua module
    -- or from the debug console, so assume that we were passed a table of args
    -- directly, and assign it to a new variable (luaArgs).
    --]]
    --]]
    local fargs, pargs, luaArgs
    local fargs, pargs, luaArgs
    if type(frame.args) == 'table' and type(frame.getParent) == 'function' then
    if type(frame.args) == 'table' and type(frame.getParent) == 'function' then
    if not options.parentOnly then
    if options.wrappers then
    fargs = frame.args
    --[[
    end
    -- The wrappers option makes Module:Arguments look up arguments in
    if not options.frameOnly then
    -- either the frame argument table or the parent argument table, but
    pargs = frame:getParent().args
    -- not both. This means that users can use either the #invoke syntax
    end
    -- or a wrapper template without the loss of performance associated
    if options.parentFirst then
    -- with looking arguments up in both the frame and the parent frame.
    fargs, pargs = pargs, fargs
    -- Module:Arguments will look up arguments in the parent frame
    -- if it finds the parent frame's title in options.wrapper;
    -- otherwise it will look up arguments in the frame object passed
    -- to getArgs.
    --]]
    local parent = frame:getParent()
    if not parent then
    fargs = frame.args
    else
    local title = parent:getTitle():gsub('/sandbox$', '')
    local found = false
    if type(options.wrappers) == 'table' then
    for _,v in pairs(options.wrappers) do
    if v == title then
    found = true