మాడ్యూల్:Ustring
This module is rated as ready for general use. It has reached a mature form and is thought to be relatively bug-free and ready for use wherever appropriate. It is ready to mention on help pages and other Wikipedia resources as an option for new users to learn. To reduce server load and bad output, it should be improved by sandbox testing rather than repeated trial-and-error editing. |
This module directly imports all functions from the
mw.ustring
library. Documentation for each function can be found there.
The module takes an indefinite number of arguments. All arguments are coerced as number type if possible. If you wish for something to remain a string, you can simply escape it by insert \
at the beginning of the string.
You can also wrap results in tags. All non-number indexed arguments will be passed to
frame:extensionTag
Usage
మార్చు{{#invoke:Ustring|function_name|arg1|arg2|...}}
is equivalent to mw.ustring.function_name
( arg1, arg2, ... )
Example using mw.ustring.sub
మార్చు{{#invoke:Ustring|sub|abcde|2|4}}
produces:
bcd
Example using mw.ustring.gsub
మార్చు{{#invoke:Ustring|gsub|1234|23|}}
produces:
14
Example using mw.ustring.char
మార్చు&#{{#invoke:ustring|char|49|48|59}}
produces:
This is nice for escaping character sequences in other modules; for example:
p = {}
function p.main(frame)
local str = '1-2-2{{#invoke:ustring|char|45}}1-3'
return frame:preprocess(str:gsub('-', '/'))-- == '1/2/2-1/3'
end
return p
Example using mw.ustring.match
మార్చు{{#invoke:Ustring|match|abcde|(c%w)}}
produces:
cd
Note: Only the first match is returned. Additional returns are omitted because mw.ustring.gsub's second return value is generally undesirable.
Example using tag arguments
మార్చు{{#invoke:Ustring|match |{{Module:Ustring}}|%s%sif.+% <!--enter an actual newline character to match '\n'-->%s%send |tag=syntaxhighlight|lang=lua}}
produces:
if type(what) ~= "function" then
return what
end
return function(frame)
local fargs = frame.args
local fargsused = { tag = true }
local args = {}
local str_i = 1
while fargs['s' .. str_i] do
fargsused['s' .. str_i] = true
args[str_i] = fargs['s' .. str_i]
str_i = str_i + 1
end
for i, v in ipairs(fargs) do
fargsused[i] = true
args[i + str_i - 1] = tonumber(v) or v:gsub("^\\", "", 1)
end
if not fargs.tag then
return (what(unpack(args))) -- Outside parens truncate to first result avoiding tail call
end
local tagargs = {}
for x, y in pairs(fargs) do
if not fargsused[x] then tagargs[x] = y end
end
return frame:extensionTag{name = fargs.tag, content = what(unpack(args)), args = tagargs}
end
Note that:
<syntaxhighlight lang="lua">{{#invoke:Ustring|match |{{Module:Ustring}}|%s%sif.+% <!--enter an actual newline character to match '\n'-->%s%send}}</syntaxhighlight>
produces:
{{#invoke:Ustring|match
|{{Module:Ustring}}|%s%sif.+%
<!--enter an actual newline character to match '\n'-->%s%send}}
require('strict')
return setmetatable({}, {
__index = function(t, k)
local what = mw.ustring[k]
if type(what) ~= "function" then
return what
end
return function(frame)
local fargs = frame.args
local fargsused = { tag = true }
local args = {}
local str_i = 1
while fargs['s' .. str_i] do
fargsused['s' .. str_i] = true
args[str_i] = fargs['s' .. str_i]
str_i = str_i + 1
end
for i, v in ipairs(fargs) do
fargsused[i] = true
args[i + str_i - 1] = tonumber(v) or v:gsub("^\\", "", 1)
end
if not fargs.tag then
return (what(unpack(args))) -- Outside parens truncate to first result avoiding tail call
end
local tagargs = {}
for x, y in pairs(fargs) do
if not fargsused[x] then tagargs[x] = y end
end
return frame:extensionTag{name = fargs.tag, content = what(unpack(args)), args = tagargs}
end
end
})