Module:Form calculator

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

-- implements [[Template:Form calculator]]
--    for generating form calculators
-- [[RuneScape:Calculators/Form calculators]]
-- 
-- performs some minor checks on the input; the javascript still does most of it, though
-- 
-- <nowiki>
local pt = require('Module:Paramtest')
local hascontent = pt.has_content
local defto = pt.default_to

-- possible parameter types
local param_types = {string = true, article = true, number = true, int = true, select = true, check = true, hs = true, fixed = true, hidden = true, semihidden = true}

local p = {}
--used internally but can also be an entry point
function p.jsnotice(frame)
    page = mw.title.getCurrentTitle()
    return 'The calculator form will appear here soon. You will need Javascript enabled and cannot be using the mobile version of the Wiki.\n\nIf you are on a mobile device, you can load the full version of the site by [' .. page:fullUrl('useskin=oasis') .. ' clicking here].'
end

--used internally but can also be an entry point
function p.resnotice(frame)
    return 'The result will appear here when you submit the form.'
end

--main entry for constructing a calculator
function p.main(frame)
    local args = frame.args --frame:getParent().args
    local template, form, result
    local err = ''
    if hascontent(args.template) then
        template = args.template
    else
        err = 'No template specified<br />'
    end
    
    if hascontent(args.form) then
        form = args.form
    else
        err = err .. 'No form ID specified<br />'
    end
    
    if hascontent(args.result) then
        result = args.result
    else
        err = err .. 'No result ID specified<br />'
    end
    
    if err ~= '' then
        return '<span class="error">'.."'''Fatal error(s) found in form definition:'''<br />" .. err .. '</span> [[Category:Form calculators]] [[Category:Form calculator errors]]'
    end
    
    local conf = mw.html.create('div')
    conf:addClass('hidden jcConfig')
        :wikitext('\n')
        :wikitext('template = ' .. template .. '\n')
        :wikitext('form = ' .. form .. '\n')
        :wikitext('result = ' .. result .. '\n')
        :done()
        
    if hascontent(args.suggestns) then
        --check ns stuff
        for i,v in pairs(mw.text.split(args.suggestns, ',', true)) do
            if not mw.site.namespaces(tonumber(v)) then
                err = err .. 'Invalid namespace(s) detected in suggestns<br />'
                break
            end
        end
        
        conf:wikitext('suggestns = ' .. args.suggestns)
    end
    
    local i = 1
    while hascontent(args['param' .. i]) do
        process_param(args, conf, i)
        i = i + 1
    end
    
    local outtype = defto(args.outputtype, 'none')
    local out
    if outtype == 'none' or outtype == '0' then
        out = ''
    elseif outtype == 'basic' or outtype == '1'  then
        out = '\n\n<div id="'..form..'">'..p.jsnotice(frame)..'</div>\n<div id="'..result..'">'..p.resnotice(frame)..'</div>'
    elseif outtype == 'verticaltable' then
        out='\n\nvtable here'
    elseif outtype == 'horizontaltable' then
        out='\n\nhtable here'
    end
    
    if err ~= '' then
        err = '<span class="error">' .. "'''Minor error(s) found in form definition:'''<br />" .. err .. '</span>'
    end
    
    return tostring(conf) .. err .. out .. '[[Category:Form calculators]]'
end

function type_check(arg)
    if hascontent(arg) and param_types[arg] then
        return arg
    else
        return 'string'
    end
end

function process_param(args, conf, num)
    local param = args['param' .. num]
    local label = defto(args['label' .. num], param)
    local type = type_check(args['type' .. num])
    local default = defto(args['default' .. num], '')
    local range = defto(args['range' .. num], '')
    
    --for clarity, do this here
    local str = param .. '|' .. label .. '|' .. default .. '|' .. type .. '|' .. range
    
    conf:wikitext('param = ' .. str .. '\n')
end

return p