Jump to content
Wikipedia The Free Encyclopedia

Module:Lua call

From Wikipedia, the free encyclopedia
Module documentation[view] [edit] [history] [purge]
This module is rated as alpha. It is ready for limited use and third-party feedback. It may be used on a small number of pages, but should be monitored closely. Suggestions for new features or adjustments to input and output are welcome.

This module allows you to call any one single preinstalled Lua function, so that you don't need to write a module for one desired feature.

Usage

[edit ]

Main

[edit ]

{{#invoke:Lua call|main|arbitrary variables|parameters|functioncall}}

The arbitrary variables are any key of your choice = any value of your choice. Values are interpreted as strings unless tonumber(value) isn't nil, i.e. numbers should be converted to the numeric type. No effort is made to interpret tables.

The parameters all begin with reserved_, which arbitrary variable should use.

  • reserved_return sets which output from the function you want, and defaults to 1. For example, setting it to 2 for mw.ustring.gsub will return the number of replacements made.
  • reserved_debug - nonzero value forces display of a not particularly useful debug text

The functioncall is written as some.function.name(a,b,c) where some.function.name means something in the Extension:Scribunto/Lua reference manual and a,b,c are the arbitrary variable names you've chosen.

Examples

[edit ]

Main

[edit ]
  • {{#invoke:Lua call|main|a=test |b=7|string.rep(a,b)}} → test test test test test test test 
  • {{#invoke:Lua call|main|pattern=(%a)|replace=%1.|string=I can't get no satisfaction|mw.ustring.gsub(string,pattern,replace)|reserved_return=1}} → I. c.a.n.'t. g.e.t. n.o. s.a.t.i.s.f.a.c.t.i.o.n.
  • {{#invoke:Lua call|main|pattern=(%a)|replace=%1.|string=I can't get no satisfaction|mw.ustring.gsub(string,pattern,replace)|reserved_return=2}} → 22
  • {{#invoke:Lua call|main|value=1.4512|math.ceil(value)}} → 2
  • {{#invoke:Lua call|main|value=1.4512|math.modf(value)}} → 1
  • {{#invoke:Lua call|main|value=1.4512|math.modf(value)|reserved_return=2}} → 0.4512
  • {{#invoke:Lua call|main|mw.text.nowiki(s)|s={{URL|1=https://www.Amazon.com/}}}} → <span class="url">[https://www.Amazon.com/ www<wbr/>.amazon<wbr/>.com]</span>

Call

[edit ]
  • {{#invoke:Lua call|call|string.format|%04x|127}} → 007f
  • {{#invoke:Lua call|call|math.modf|1.4512}} → 1
  • {{#invoke:Lua call|call|math.modf|1.4512|return=2}} → 1

Errors

[edit ]

The module may generate script errors — whenever your call is not valid Lua code, you see the error you would normally have. For example,

{{#invoke:Lua call|main|value=1.4512|math.fmod(value)}}Lua error at line 42: bad argument #2 to 'fn' (number expected, got no value).

because the second value is lacking. No effort is made to trap these.

The above documentation is transcluded from Module:Lua call/doc. (edit | history)
Editors can experiment in this module's sandbox (edit | diff) and testcases (edit | run) pages.
Subpages of this module.

 require[[strict]]
 localp={}

 functionp.main(frame)
 localparent=frame.getParent(frame)or{}
 localexplist={}
 localfnname,varlist
 localvars={}
 fork,vinpairs(_G)do
 vars[k]=v-- transfer every global directly to our variable table
 end
 fork,vinpairs(parent.argsor{})do
 vars[k]=tonumber(v)orv-- transfer every parameter directly to our variable table
 end
 fork,vinpairs(frame.argsor{})do
 vars[k]=tonumber(v)orv-- transfer every parameter directly to our variable table
 end
 --- Alas Scribunto does NOT implement coroutines, according to
 --- https://www.mediawiki.org/wiki/Extension:Scribunto/Lua_reference_manual#string.format
 --- this will not stop us from trying to implement one single lousy function call
 ifvars[1]then
 fnname,varlist=mw.ustring.match(vars[1],"^%s*(%a[^%s%(]*)%(([^%)]*)%)%s*$")
 end
 ifvarlistthen
 localexpn=0
 repeat
 expn=expn+1
 explist[expn]=vars[mw.ustring.match(varlist,"([^%,]+)")]
 varlist=mw.ustring.match(varlist,"[^%,]+,(.*)$")
 untilnotvarlist
 end
 localscopetab=vars
 whilemw.ustring.match(fnname,"%.")do
 localscopekey
 scopekey,fnname=mw.ustring.match(fnname,"^(%a[^%.]*)%.(.*)$")
 scopetab=scopetab[scopekey]
 end
 localfn=scopetab[fnname]
 iftype(fn)~="function"then--XXX: What about callable tables?
 returntostring(fn)
 else
 localoutput={fn(unpack(explist))}
 returnoutput[vars.reserved_returnor1]
 end
 end

 localfunctiontonumberOrString(v)
 returntonumber(v)orv:gsub("^\\","",1)
 end

 localfunctioncallWithTonumberOrStringOnPairs(f,...)
 localargs={}
 for_,vin...do
 table.insert(args,tonumberOrString(v))
 end
 return(f(unpack(args)))
 end

 --[[
 ------------------------------------------------------------------------------------
 -- ipairsAtOffset

 -- This is an iterator for arrays. It can be used like ipairs, but with
 -- specified i as first index to iterate. i is an offset from 1
 --
 ------------------------------------------------------------------------------------
 --]]
 localfunctionipairsAtOffset(t,i)
 localf,s,i0=ipairs(t)
 returnf,s,i0+i
 end

 localfunctionget(s)
 localG=_G;for_inmw.text.gsplit(
 mw.text.trim(s,'%s'),'%s*%.%s*'
 )do
 G=G[_]
 end
 returnG
 end

 --[[
 ------------------------------------------------------------------------------------
 -- call
 --
 -- This function is usually useful for debugging template parameters.
 -- Prefix parameter with backslash (\) to force interpreting parameter as string.
 -- The leading backslash will be removed before passed to Lua function.
 --
 -- Example:
 -- {{#invoke:Lua call|call|mw.log|a|1|2|3}} will return results of mw.log('a', 1, 2, 3)
 -- {{#invoke:Lua call|call|mw.logObject|\a|321|321円| 321円 }} will return results of mw.logObject('a', 321, '321', ' \321円 ')
 --
 -- This example show the debugging to see which Unicode characters are allowed in template parameters,
 -- {{#invoke:Lua call|call|mw.ustring.codepoint|{{#invoke:Lua call|call|mw.ustring.char|0x0061}}}} return 97
 -- {{#invoke:Lua call|call|mw.ustring.codepoint|{{#invoke:Lua call|call|mw.ustring.char|0x0000}}}} return 65533
 -- {{#invoke:Lua call|call|mw.ustring.codepoint|{{#invoke:Lua call|call|mw.ustring.char|0x0001}}}} return 65533
 -- {{#invoke:Lua call|call|string.format|0x%04x|{{#invoke:Lua call|call|mw.ustring.codepoint|{{#invoke:Lua call|call|mw.ustring.char|0x0002}}}}}} return 0xfffd
 -- {{#invoke:Lua call|call|string.format|0x%04x|{{#invoke:Lua call|call|mw.ustring.codepoint|{{#invoke:Lua call|call|mw.ustring.char|0x007e}}}}}} return 0x007e
 -- {{#invoke:Lua call|call|string.format|0x%04x|{{#invoke:Lua call|call|mw.ustring.codepoint|{{#invoke:Lua call|call|mw.ustring.char|0x007f}}}}}} return 0x007f
 -- {{#invoke:Lua call|call|string.format|0x%04x|{{#invoke:Lua call|call|mw.ustring.codepoint|{{#invoke:Lua call|call|mw.ustring.char|0x0080}}}}}} return 0x0080
 -- {{#invoke:Lua call|call|string.format|0x%04x|{{#invoke:Lua call|call|mw.ustring.codepoint|{{#invoke:Lua call|call|mw.ustring.char|0x00a0}}}}}} return 0x00a0
 --
 ------------------------------------------------------------------------------------
 --]]
 functionp.call(frame)
 returncallWithTonumberOrStringOnPairs(get(frame.args[1]),
 ipairsAtOffset(frame.args,1)
 )
 end

 --local TableTools = require('Module:TableTools')
 --[[
 ------------------------------------------------------------------------------------
 -- get
 --
 -- Example:
 -- {{#invoke:Lua call|get| math.pi }} will return value of math.pi
 -- {{#invoke:Lua call|get|math|pi}} will return value of math.pi
 -- {{#invoke:Lua call|get| math |pi}} will return value of _G[' math '].pi
 -- {{#invoke:Lua call|get|_G| math.pi }} will return value of _G[' math.pi ']
 -- {{#invoke:Lua call|get|obj.a.5.c}} will return value of obj.a['5'].c
 -- {{#invoke:Lua call|get|obj|a|5|c}} will return value of obj.a[5].c
 --
 ------------------------------------------------------------------------------------
 --]]
 functionp.get(frame)
 -- #frame.args always return 0, regardless of number of unnamed
 -- template parameters, so check manually instead
 ifframe.args[2]==nilthen
 -- not do tonumber() for this args style,
 -- always treat it as string,
 -- so 'obj.1' will mean obj['1'] rather obj[1]
 returnget(frame.args[1])
 else
 localG=_G
 for_,vinipairs(frame.args)do
 G=G[tonumberOrString(v)]
 end
 returnG
 end
 end

 --[[
 ------------------------------------------------------------------------------------
 -- invoke
 --
 -- This function is used by Template:Invoke
 --
 ------------------------------------------------------------------------------------
 --]]
 functionp.invoke(frame)
 localpframe,usedpargs=frame:getParent(),{}
 -- get module and function names from parent args if not provided
 localpfargs=setmetatable({frame.args[1],frame.args[2]},{__index=table})
 ifnotpfargs[1]then
 pfargs[1],usedpargs[1]=pframe.args[1],true
 ifnotpfargs[2]then
 pfargs[2],usedpargs[2]=pframe.args[2],true
 end
 elseifnotpfargs[2]then
 pfargs[2],usedpargs[1]=pframe.args[1],true
 end
 -- repack sequential args
 fori,vinipairs(pframe.args)do
 ifnotusedpargs[i]then
 pfargs:insert(v)
 usedpargs[i]=true
 end
 end
 -- copy other args
 fork,vinpairs(pframe.args)do
 ifnotpfargs[k]andnotusedpargs[k]then
 pfargs[k],usedpargs[k]=v,true
 end
 end
 -- #invoke off parent frame so the new frame has the same parent
 returnpframe:callParserFunction{name='#invoke',args=pfargs}
 end

 returnp

AltStyle によって変換されたページ (->オリジナル) /