Module:Ustring

Module documentation[view] [edit] [history] [purge]

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%s%sif%snot%s[^%s]+%sthen.+%
<!--enter an actual newline character to match '\n'-->%s%s%send
|tag=syntaxhighlight|lang=lua}}

produces:

			if not args.tag then
				return (what(unpack(args)))
			end
			local tagargs = {}
			for x, y in pairs(args) do
				if type(x) ~= 'number' and x ~= 'tag' then tagargs[x] = y end
			end

Note that:

<syntaxhighlight lang="lua">{{#invoke:Ustring|match
|{{Module:Ustring}}|%s%s%sif%snot%s[^%s]+%sthen.+%
<!--enter an actual newline character to match '\n'-->%s%s%send}}</syntaxhighlight>

produces:

{{#invoke:Ustring|match
|{{Module:Ustring}}|%s%s%sif%snot%s[^%s]+%sthen.+%
<!--enter an actual newline character to match '\n'-->%s%s%send}}

Errors

Errors from accessing mw.ustring should be maintained, e.g.:

{{#invoke:Ustring|xyzzy}}

should produce:

Script error: The function "xyzzy" does not exist.

and

{{#invoke:Ustring|maxPatternLength}}

should produce:

Script error: "maxPatternLength" is not a function.

See also

require('Module:No globals')
return setmetatable({}, {
	__index = function(t, k)
		local what = mw.ustring[k]
		if type(what) ~= "function" then
			return what
		end
		return function(frame)
			local args = frame.args
			for _, v in ipairs(args) do
				args[_] = tonumber(v) or v:gsub("^\\", "", 1)
			end
			if not args.tag then
				return (what(unpack(args)))
			end
			local tagargs = {}
			for x, y in pairs(args) do
				if type(x) ~= 'number' and x ~= 'tag' then tagargs[x] = y end
			end
			return frame:extensionTag{name = args.tag, content = what(unpack(args)), args = tagargs}
		end
	end
})