Module:Yesno

This module provides a consistent interface for processing boolean or boolean-style string input. While Lua allows the true and false boolean values, wikicode templates can only express boolean values through strings such as "yes", "no", etc. This module processes these kinds of strings and turns them into boolean input for Lua to process. It also returns nil values as nil, to allow for distinctions between nil and false. The module also accepts other Lua structures as input, i.e. booleans, numbers, tables, and functions. If it is passed input that it does not recognise as boolean or nil, it is possible to specify a default value to return.

Syntax

<syntaxhighlight lang="lua">yesno(value, default)</syntaxhighlight>

value is the value to be tested. Boolean input or boolean-style input (see below) always evaluates to either true or false, and nil always evaluates to nil. Other values evaluate to default.

Usage

First, load the module. Note that it can only be loaded from other Lua modules, not from normal wiki pages. For normal wiki pages you can use {{yesno}} instead.

<syntaxhighlight lang="lua"> local yesno = require('Module:Yesno') </syntaxhighlight>

Some input values always return true, and some always return false. nil values always return nil.

<syntaxhighlight lang="lua"> -- These always return true: yesno('yes') yesno('y') yesno('true') yesno('t') yesno('1') yesno(1) yesno(true)

-- These always return false: yesno('no') yesno('n') yesno('false') yesno('f') yesno('0') yesno(0) yesno(false)

-- A nil value always returns nil: yesno(nil) </syntaxhighlight>

String values are converted to lower case before they are matched:

<syntaxhighlight lang="lua"> -- These always return true: yesno('Yes') yesno('YES') yesno('yEs') yesno('Y') yesno('tRuE')

-- These always return false: yesno('No') yesno('NO') yesno('nO') yesno('N') yesno('fALsE') </syntaxhighlight>

You can specify a default value if yesno receives input other than that listed above. If you don't supply a default, the module will return nil for these inputs.

<syntaxhighlight lang="lua"> -- These return nil: yesno('foo') yesno({}) yesno(5) yesno(function() return 'This is a function.' end)

-- These return true: yesno('foo', true) yesno({}, true) yesno(5, true) yesno(function() return 'This is a function.' end, true)

-- These return "bar": yesno('foo', 'bar') yesno({}, 'bar') yesno(5, 'bar') yesno(function() return 'This is a function.' end, 'bar') </syntaxhighlight>

Note that the blank string also functions this way: <syntaxhighlight lang="lua"> yesno() -- Returns nil. yesno(, true) -- Returns true. yesno(, 'bar') -- Returns "bar". </syntaxhighlight>

Although the blank string usually evaluates to false in wikitext, it evaluates to true in Lua. This module prefers the Lua behaviour over the wikitext behaviour. If treating the blank string as false is important for your module, you will need to remove blank arguments at an earlier stage of processing.

---

local p = {}
 
function p.yesno( frame )
 
    -- defaults
    local retvals = {
        yes   = "yes",
        no    = "",
        ["¬"] = ""
    }
 
    -- Allow arguments to override defaults.
    -- 'any' tracks the presence of any arguments at all.
    local any = false
    for k,v in pairs( frame.args ) do
        any = true
        retvals[k] = v
    end
 
    val = frame.args[1]
 
    -- According to the template docs, the input should be considered nil
    -- only when no params were provided. If any params at all were present,
    -- the value must be considered blank. A bit weird, if you ask me.
    if (val == nil and not any) or val == '¬' then
        return retvals['¬']
    end
 
    val = (val or ''):lower()          -- Coerce to blank if nil; make lowercase.
    val = val:match'^%s*(.*%S)' or ''  -- Trim whitespace.
 
    if val == '' then
        return retvals['blank'] ~= nil and retvals['blank'] or retvals['no']
    elseif val == 'n' or val == 'no'  or val == '0' then
        return retvals['no']
    elseif val == 'y' or val == 'yes' or val == '1' or retvals['def'] == nil then
        return retvals['yes']
    else
        return retvals['def']
    end
end
 
return p