Modul:Arguments

Arguments[mi ez?] • [dokumentáció: mutat, ] • [tesztek: létrehozás]

Ez a modul az #invoke-kal hívott modulok paramétereinek egyszerű feldolgozását segíti. Ez egy meta-modul, azaz más modulok használják, ezért az #invoke-kal történő közvetlen hívása értelmetlen. Képességei:

• A paraméterek kezdő és záró szőközöktől való megtisztítása (trim). Az üres paraméterek eldobása
• A paramétereket az aktuális és a szülő feldolgozókeret is egyszerre át tudja adni. (Részletek lejjebb.)
• A paraméterek átadhatók: más Lua modulból közvetlenül, vagy hibakereső (debug) konzolról.
• A paraméterek, akkor kerülnek átvételre, amikor szükség van rájuk, ezzel elkerülhetők egyes, a referencia tag-ekből adódó problémák.
• A legtöbb képesség testreszabható.

Alap felhasználási mód

Legelőször be kell tölteni a modult. Egyetlen függvényt, a getArgs-ot tartalmazza.

local getArgs = require('Modul:Arguments').getArgs

A legegyszerűbb esetben a getArgs a hívó modul fő függvényből meghívható. Az args változó egy tábla, amely az #invoke-ból jövő paramétereket tartalmazza. (Részletek lejjebb.)

local getArgs = require('Modul:Arguments').getArgs
local p = {}

function p.main(frame)
	local args = getArgs(frame)
	-- Ide jön a modul fő kódja.
end

return p

Javasolt a függvényt elsősorban az #invoke-ból jövő paraméterek kezelésére használni. Azért, mert ha modulunkat egy másik Lua-modul közvetlenül hívja, nem kell külön keret-objektumot alkalmazni, ami növeli a kód futási teljesítményét.

local getArgs = require('Modul:Arguments').getArgs
local p = {}

function p.main(frame)
	local args = getArgs(frame)
	return p._main(args)
end

function p._main(args)
	-- Ide jön a modul fő kódja.
end

return p

Ha több függvényben akarjuk felhasználni az #invoke-ból elérhető paramétereket, akkor egy külön függvénybe csomagolhatjuk a getArgs-ot:

local getArgs = require('Modul:Arguments').getArgs

local function makeInvokeFunc(funcName)
	return function (frame)
		local args = getArgs(frame)
		return p[funcName](args)
	end
end

local p = {}

p.func1 = makeInvokeFunc('_func1')

function p._func1(args)
	-- Ide jön az első függvény kódja.
end

p.func2 = makeInvokeFunc('_func2')

function p._func2(args)
	-- Ide jön a második függvény kódja.
end

return p

Opciók

A következő opciók érhetők el (az alábbi szakaszokban elmagyarázzuk):

local args = getArgs(frame, {
	trim = false,
	removeBlanks = false,
	valueFunc = function (key, value)
		-- a paramétreket feldolgozó kód
	end,
	frameOnly = true,
	parentOnly = true,
	parentFirst = true,
	wrappers = {
		'Sablon:Burkoló sablon',
		'Sablon:Másik burkoló sablon'
	},
	readOnly = true,
	noOverwrite = true
})

Szóközök elhagyása és üres paraméterek eltávolítása

Az üres paraméterek problémájába gyakran beleütköznek a MediaWiki-sablonokat Luába konvertálni kívánó kezdő programozók. A sablon szintaxisában az üres vagy csak white space-t tartalmazó karakterláncok hamis értékűnek számítanak. Ugyanakkor a Lua ezeket a karakterláncokat igaz értékűnek tekinti. Ha tehát nem figyelünk ezekre a különbségekre, akkor előfordulhat, hogy a Lua-modulban igazként kezelünk valamit, amit valójában hamis értékűnek kellene vennünk. Hogy az ilyen helyzeteket elkerülhessük, ez a modul alapértelmezésben eltávolítja az üres paramétereket.

Hasonló gondot okozhatnak a névtelen paraméterek is. Jóllehet a white space el van távolítva az #invoke-ból nevesített paraméterek elejéről és végéről, ez nem történik meg a névtelen, ún. pozicionális paraméterek esetén. A legtöbbször nincs szükség ezekre a karakterekre, ezért ez a modul alapértelmezésben eltávolítja azokat.

Ha mégis szükség van az üres paraméterekre, illetve a paraméterszéleken megtalálható white space-re, például bizonyos sablonok működésének pontos lemásolása céljából, akkor a trim illetve removeBlanks paramétereket hamisra (false) kell állítani.

local args = getArgs(frame, {
	trim = false,
	removeBlanks = false
})

A paraméterek testreszabott formázása

Néha bizonyos üres paramétereket el kívánunk hagyni, másokat azonban nem, vagy esetleg minden névtelen paramétert kisbetűssé kívánunk tenni. Ilyen feladatokat a valueFunc opció segítségével tudunk megoldani. Ennek a bemenete egy kétváltozós függvény (key és value), visszatérési értéke pedig egyetlen érték, ami az args táblában a key mezőben lesz található.

1. példa: A függvény az első névtelen paraméter értékét pontosan megtartja, az összes többi paraméter széleiről eltávolítja a white space-t, és a többi üres paramétert pedig elhagyja.

local args = getArgs(frame, {
	valueFunc = function (key, value)
		if key == 1 then
			return value
		elseif value then
			value = mw.text.trim(value)
			if value ~= '' then
				return value
			end
		end
		return nil
	end
})

2. példa: Ez a függvény elhagyja az üres paramétereket, és valamennyi értékét kisbetűsíti, de nem távolítja el a white space-t.

local args = getArgs(frame, {
	valueFunc = function (key, value)
		if not value then
			return nil
		end
		value = mw.ustring.lower(value)
		if mw.ustring.find(value, '%S') then
			return value
		end
		return nil
	end
})

Megjegyzés: a fenti függvény hibás, ha a bemenete nem string típusú vagy nil. Ez olyankor fordulhat elő, ha a getArgs függvényt modulunk fő függvényében használjuk, amelyet viszont egy másik Lua-modul hív meg. Ebben az esetben ellenőrizni kell a bemeneti paraméter típusát. Ilyen gond nem lép fel, ha egy speciális függvényt használunk fel az #invoke paramétereinek beolvasására (pl. p.main a fő kódunk és a p._main speciális függvényt alkalmazzuk).

A valueFunc függvényt szinte minden alkalommal meghívjuk, ha szükségünk van a args tábla egy elemére; ha szempont számunkra a kód hatékonysága, akkor figyeljük, hogy ne maradjanak a kódunkban rossz hatékonyságú elemek.

Keretek és szülő-keretek

Mind az aktuális, mind a szülősablon kerete adhat át paramétereket az args táblába. A legegyszerűbben ezt egy példán keresztül érthetjük meg. Legyen ez a Modul:ExampleArgs modul. Ez a neki átadott két első névtelen paramétert írja ki.

A Modul:ExampleArgs modulunkat meghívja a Sablon:ExampleArgs sablon, amely a következő kódot tartalmazza: {{#invoke:ExampleArgs|main|firstInvokeArg}}. Ez a hívás a firstInvokeArg kimenetet eredményezi.

Ha most meghívjuk aSablon:ExampleArgs-t, a következő történik:

Kód	Eredmény
{{ExampleArgs}}	firstInvokeArg
{{ExampleArgs|firstTemplateArg}}	firstInvokeArg
{{ExampleArgs|firstTemplateArg|secondTemplateArg}}	firstInvokeArg secondTemplateArg

Három kapcsoló áll rendelkezésünkre, hogy ezt a viselkedést megváltoztassuk: a frameOnly, a parentOnly és a parentFirst. Ha frameOnly kapcsolót használjuk, akkor csak az aktuális keret paramétereit fogadjuk el; ha a parentOnly kapcsolót állítjuk be, akkor csak szülőkeret paramétereit fogadjuk el, ha a parentFirst kapcsolót állítjuk be, mindkét helyről megkapjuk a paramétereket, de a szülőkeret élvez elsőbbséget az aktuálissal szemben. Ezek a TSAblonExampleArgs futásának eredményei:

frameOnly

Kód	Eredmény
{{ExampleArgs}}	firstInvokeArg
{{ExampleArgs|firstTemplateArg}}	firstInvokeArg
{{ExampleArgs|firstTemplateArg|secondTemplateArg}}	firstInvokeArg

parentOnly

Kód	Eredmény
{{ExampleArgs}}
{{ExampleArgs|firstTemplateArg}}	firstTemplateArg
{{ExampleArgs|firstTemplateArg|secondTemplateArg}}	firstTemplateArg secondTemplateArg

parentFirst

Kód	Eredmény
{{ExampleArgs}}	firstInvokeArg
{{ExampleArgs|firstTemplateArg}}	firstTemplateArg
{{ExampleArgs|firstTemplateArg|secondTemplateArg}}	firstTemplateArg secondTemplateArg

Megjegyzések:

1. Ha a frameOnly és a parentOnly kapcsolót is beállítjuk, a modul egyik paramétert sem fogja beolvasni. Valószínűleg ilyet nem akarunk.
2. Bizonyos esetekben a szülő-keret nem elérhető: pl. getArgs eleve a szülőkeretet kapja meg aktuális helyett. Ebben az esetben csak az átadott keret paraméterei használhatóak (kivéve ha a parentOnly be van kapcsolva, mert ilyenkor egyetlen paramétert sem használunk fel). Ilyenkor a parentFirst és frameOnly kapcsolók hatástalanok.

Burkolósablonok (Wrappers)

A wrappers kapcsolót arra használjuk, hogy megjelöljük az ún. burkolósablonokat, vagyis olyan sablonokat, amelyeknek egyetlen funkciója az, hogy egy adott modult meghívjanak. Ha a modul érzékeli, hogy a burkolósablon hívja, akkor csak a szülősablon keretének paramétereit fogja tekintetbe venni, azaz csak a getArgs-nak átadott keret paramétereit fogja ellenőrizni. Ezzel elérjük, hogy a modult akár #invoke-kal, akár burkolósablonnal hívjuk, csak a szükséges paramétereket fogja ellenőrizni, növelve ezzel a kód hatékonyságát.

Például: Ha Sablon:Side box összes valódi tartalma (a noinclude tag-ek en kívül): {{#invoke:Side box|main}}, akkor semmi értelme, hogy megpróbáljuk megkeresni az #invoke parancsnak átadott paramétereket, mivel ilyenek egyszerűen nincsenek. Az #invoke paramétereinek fölösleges ellenőrzése elkerülhető parentOnly kapcsoló használatával is, de ha ezt tesszük, akkor a más sablonokban elhelyezett #invoke-ok paramétereit sem fogjuk látni. Pl. a |text=Some text a {{#invoke:Side box|main|text=Some text}} kódban mindig figyelmen kívül maradna, függetlenül attól, hogy mely lapról alkalmaznánk. A wrappers kapcsoló segítségével a Sablon:Side boxot burkolósablonként jelöljük meg, így a {{#invoke:Side box|main|text=Some text}} kód a legtöbb lapról működni fog, míg magán a Sablon:Side box lapon továbbra sem történik meg a fölösleges paraméter-ellenőrzés.

A burkolósablonokat karakterláncként, vagy azok tömbjeként adhatjuk meg.

local args = getArgs(frame, {
	wrappers = 'Sablon:Burkolósablon'
})

local args = getArgs(frame, {
	wrappers = {
		'Template:Burkoló 1',
		'Template:Burkoló 2',
		-- akárhány további (burkoló-) sablon neve megadható itt
	}
})

Megjegyzések:

1. A modul automatikusan érzékeli, ha burkolósablon /sandbox allapjáról hívják, ezért a homokozóallapokat nem szükséges explicit módon megadni.
2. A wrappers kapcsoló automatikusan igazítja a frameOnly és parentOnly kapcsolókat az értelemszerűen helyes működésre. Például, ha parentOnly kapcsolót a wrappers beállításával automatikusan false-ra állítanánk, akkor a burkolósablonon keresztül történő hívások a keret és a szülőkeret paramétereit minden esetben beolvasnák, míg a nem burkolósablonokon keresztül történő hívások mindig csak a keret paramétereit adnák át.
3. Ha a wrappers kapcsoló be van állítva, de nem érhető el szülő keret, a modul monden esetben a getArgs-nak átadott keret paramétereit fogja kiolvasni.

Az args paramétertábla írása

Néha hasznosnak bizonyulhat, ha a paraméterek táblájába új értékeket tudunk elhelyezni. Ez ennek a modulnak az alapbeállításaival is lehetséges. (Jóllehet, általában véve jobb kódolási gyakorlat, ha új táblát hozunk létre az új értékekkel, és belemásoljuk a paraméterek közül a szükségeseket.)

args.foo = 'valamilyen érték'

Ez az alapviselkedés megváltoztatható a readOnly és noOverwrite kapcsolókkal. Ha a readOnly kapcsoló be van állítva, akkor az args paramétertáblába nem írható semmilyen új érték. Ha a noOverwrite be van állítva, akkor új értékek adhatók a táblához, de meglévőek nem írhatóak felül.

Lábjegyzetek

Ez a modul metatáblákat használ arra, hogy a paramétereket olvassanak ki az #invoke-ból. Ez lehetővé teszi, hogy mind a keret, és mind a szülőkeret paramétereit kiolvassuk anélkül, hogy a pairs() függvényt használnánk. Ez hasznos lehet akkor, ha a modulunk lábjegyzeteket (<ref> címkéket) tartalmazó bemenetet kaphat.

Ha a Luából <ref> címkét tartalmazó szöveget érünk el, a MediaWiki szoftver azonnal feldolgozza azt, és a lábjegyzet megjelenik a cikk alján. Amennyiben a szöveg végül nem kerül bele a kimenetbe, egy fantomjegyzet keletkezik – a listában megjelenik, de nem mutat rá hivatkozás. Ez olyan modulok számára volt probléma, amelyek a pairs() függvényt használták annak eldöntésére, hogy a paramétereket az aktuális keretből vagy annak szülőkeretéből vegyék, mivel ezek a modulok így automatikusan minden elérhető paramétert feldogoztak.

Ez a modul megoldja ezt a problémát azzal, hogy lehetővé teszi mind az aktuális, mind a szülő keret paramétereinek kiolvasását, de csak akkor, ha ténylegesen szükség van rájuk. A probléma azonban még előfordulhat, ha a pairs(args) függvényt a modul másik részén felhasználjuk.

Ismert problémák

A metatáblák használatának hátrányai is vannak. A legtöbb szokásos Lua-táblaeszköz nem működik rendesen az args táblán, beleértve a # operátort, a next() függvényt és a table könyvtár függvényeit. Ha mindenképpen szükséged van ezekre a modulodban, saját paraméterfeldolgozó függvényt kell írnod ennek a modulnak a használata helyett.

-- This module provides easy processing of arguments passed to Scribunto from
-- #invoke. It is intended for use by other Lua modules, and should not be
-- called from #invoke directly.

local libraryUtil = require('libraryUtil')
local checkType = libraryUtil.checkType

local arguments = {}

-- Generate four different tidyVal functions, so that we don't have to check the
-- options every time we call it.

local function tidyValDefault(key, val)
	if type(val) == 'string' then
		val = val:match('^%s*(.-)%s*$')
		if val == '' then
			return nil
		else
			return val
		end
	else
		return val
	end
end

local function tidyValTrimOnly(key, val)
	if type(val) == 'string' then
		return val:match('^%s*(.-)%s*$')
	else
		return val
	end
end

local function tidyValRemoveBlanksOnly(key, val)
	if type(val) == 'string' then
		if val:find('%S') then
			return val
		else
			return nil
		end
	else
		return val
	end
end

local function tidyValNoChange(key, val)
	return val
end

function arguments.getArgs(frame, options)
	checkType('getArgs', 1, frame, 'table', true)
	checkType('getArgs', 2, options, 'table', true)
	frame = frame or {}
	options = options or {}

	--[[
	-- Get the argument tables. If we were passed a valid frame object, get the
	-- frame arguments (fargs) and the parent frame arguments (pargs), depending
	-- on the options set and on the parent frame's availability. If we weren't
	-- 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
	if type(frame.args) == 'table' and type(frame.getParent) == 'function' then
		if options.wrappers then
			--[[
			-- The wrappers option makes Module:Arguments look up arguments in
			-- either the frame argument table or the parent argument table, but
			-- not both. This means that users can use either the #invoke syntax
			-- or a wrapper template without the loss of performance associated
			-- with looking arguments up in both the frame and the parent frame.
			-- 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
							break
						end
					end
				elseif options.wrappers == title then
					found = true
				end
				
				-- We test for false specifically here so that nil (the default) acts like true.
				if found or options.frameOnly == false then
					pargs = parent.args
				end
				if not found or options.parentOnly == false then
					fargs = frame.args
				end
			end
		else
			-- options.wrapper isn't set, so check the other options.
			if not options.parentOnly then
				fargs = frame.args
			end
			if not options.frameOnly then
				local parent = frame:getParent()
				pargs = parent and parent.args or nil
			end
		end
		if options.parentFirst then
			fargs, pargs = pargs, fargs
		end
	else
		luaArgs = frame
	end
	
	-- Set the order of precedence of the argument tables. If the variables are
	-- nil, nothing will be added to the table, which is how we avoid clashes
	-- between the frame/parent args and the Lua args.	
	local argTables = {fargs}
	argTables[#argTables + 1] = pargs
	argTables[#argTables + 1] = luaArgs

	--[[
	-- Generate the tidyVal function. If it has been specified by the user, we
	-- use that; if not, we choose one of four functions depending on the
	-- options chosen. This is so that we don't have to call the options table
	-- every time the function is called.
	--]]
	local tidyVal = options.valueFunc
	if tidyVal then
		if type(tidyVal) ~= 'function' then
			error(
				"bad value assigned to option 'valueFunc'"
					.. '(function expected, got '
					.. type(tidyVal)
					.. ')',
				2
			)
		end
	elseif options.trim ~= false then
		if options.removeBlanks ~= false then
			tidyVal = tidyValDefault
		else
			tidyVal = tidyValTrimOnly
		end
	else
		if options.removeBlanks ~= false then
			tidyVal = tidyValRemoveBlanksOnly
		else
			tidyVal = tidyValNoChange
		end
	end

	--[[
	-- Set up the args, metaArgs and nilArgs tables. args will be the one
	-- accessed from functions, and metaArgs will hold the actual arguments. Nil
	-- arguments are memoized in nilArgs, and the metatable connects all of them
	-- together.
	--]]
	local args, metaArgs, nilArgs, metatable = {}, {}, {}, {}
	setmetatable(args, metatable)

	local function mergeArgs(iterator, tables)
		--[[
		-- Accepts multiple tables as input and merges their keys and values
		-- into one table using the specified iterator. If a value is already
		-- present it is not overwritten; tables listed earlier have precedence.
		-- We are also memoizing nil values, but those values can be
		-- overwritten.
		--]]
		for _, t in ipairs(tables) do
			for key, val in iterator(t) do
				if metaArgs[key] == nil then
					local tidiedVal = tidyVal(key, val)
					if tidiedVal == nil then
						nilArgs[key] = true
					else
						metaArgs[key] = tidiedVal
					end
				end
			end
		end
	end

	--[[
	-- Define metatable behaviour. Arguments are memoized in the metaArgs table,
	-- and are only fetched from the argument tables once. Fetching arguments
	-- from the argument tables is the most resource-intensive step in this
	-- module, so we try and avoid it where possible. For this reason, nil
	-- arguments are also memoized, in the nilArgs table. Also, we keep a record
	-- in the metatable of when pairs and ipairs have been called, so we do not
	-- run pairs and ipairs on the argument tables more than once. We also do
	-- not run ipairs on fargs and pargs if pairs has already been run, as all
	-- the arguments will already have been copied over.
	--]]

	metatable.__index = function (t, key)
		--[[
		-- Fetches an argument when the args table is indexed. First we check
		-- to see if the value is memoized, and if not we try and fetch it from
		-- the argument tables. When we check memoization, we need to check
		-- metaArgs before nilArgs, as both can be non-nil at the same time.
		-- If the argument is not present in metaArgs, we also check whether
		-- pairs has been run yet. If pairs has already been run, we return nil.
		-- This is because all the arguments will have already been copied into
		-- metaArgs by the mergeArgs function, meaning that any other arguments
		-- must be nil.
		--]]
		local val = metaArgs[key]
		if val ~= nil then
			return val
		elseif metatable.donePairs or nilArgs[key] then
			return nil
		end
		for _, argTable in ipairs(argTables) do
			local argTableVal = tidyVal(key, argTable[key])
			if argTableVal == nil then
				nilArgs[key] = true
			else
				metaArgs[key] = argTableVal
				return argTableVal
			end
		end
		return nil
	end

	metatable.__newindex = function (t, key, val)
		-- This function is called when a module tries to add a new value to the
		-- args table, or tries to change an existing value.
		if options.readOnly then
			error(
				'could not write to argument table key "'
					.. tostring(key)
					.. '"; the table is read-only',
				2
			)
		elseif options.noOverwrite and args[key] ~= nil then
			error(
				'could not write to argument table key "'
					.. tostring(key)
					.. '"; overwriting existing arguments is not permitted',
				2
			)
		elseif val == nil then
			--[[
			-- If the argument is to be overwritten with nil, we need to erase
			-- the value in metaArgs, so that __index, __pairs and __ipairs do
			-- not use a previous existing value, if present; and we also need
			-- to memoize the nil in nilArgs, so that the value isn't looked
			-- up in the argument tables if it is accessed again.
			--]]
			metaArgs[key] = nil
			nilArgs[key] = true
		else
			metaArgs[key] = val
		end
	end

	metatable.__pairs = function ()
		-- Called when pairs is run on the args table.
		if not metatable.donePairs then
			mergeArgs(pairs, argTables)
			metatable.donePairs = true
			metatable.doneIpairs = true
		end
		return pairs(metaArgs)
	end

	metatable.__ipairs = function ()
		-- Called when ipairs is run on the args table.
		if not metatable.doneIpairs then
			mergeArgs(ipairs, argTables)
			metatable.doneIpairs = true
		end
		return ipairs(metaArgs)
	end

	return args
end

return arguments