Modul:string: Redaktələr arasındakı fərq
Silinən məzmun Əlavə edilmiş məzmun
k Drabdullayev17 moved page Module:String to Module:string without leaving a redirect |
Redaktənin izahı yoxdur |
||
Sətir 1:
local str = {}
-- Cannot include null byte.
local UTF8_char = "[\1-\127\194-\244][\128-\191]*"
--[[
ulen
Counts UTF-8 characters. Faster than mw.ustring.len.
Assumes that the encoding is correct. Unlike mw.ustring.len, does not return nil
if encoding is invalid.
Does not count the bytes 192, 193, and 245-255. They are not used in UTF-8 and
will not occur if the string is valid. They are replaced with the replacement
character (U+FFFD) on MediaWiki pages.
--]]
function str.ulen(text)
local _, length = string.gsub(text, UTF8_char, "")
return length
end
--[[
Sətir 31 ⟶ 27:
Usage:
{{#invoke:
OR
{{#invoke:
Parameters
Sətir 39 ⟶ 35:
If invoked using named parameters, Mediawiki will automatically remove any leading or
trailing whitespace from the target string.
]]
function str.len(
end
Sətir 53 ⟶ 49:
Usage:
{{#invoke:
OR
{{#invoke:
Parameters
Sətir 63 ⟶ 59:
The first character of the string is assigned an index of 1. If either i or j
is a negative value, it is interpreted the same as selecting a character by
counting from the end of the string. Hence, a value of -1 is the same as
selecting the last character of the string.
If the requested indices are out of range for the given string, an error is
reported.
]]
function str.sub(
end
Sətir 100 ⟶ 96:
to maintain these older templates.
]]
function str.sublength(
end
Sətir 109 ⟶ 105:
match
This function returns a substring from the source string that matches a
specified pattern.
Usage:
{{#invoke:
OR
{{#invoke:
|match=match_number|plain=plain_flag|nomatch=nomatch_output}}
Sətir 123 ⟶ 119:
start: The index within the source string to start the search. The first
character of the string has index 1. Defaults to 1.
match: In some cases it may be possible to make multiple matches on a single
string. This specifies which match to return, where the first match is
match= 1. If a negative number is specified then a match is returned
counting from the last match. Hence match = -1 is the same as requesting
the last match. Defaults to 1.
Sətir 133 ⟶ 129:
If invoked using named parameters, Mediawiki will automatically remove any leading or
trailing whitespace from each string. In some circumstances this is desirable, in
other cases one may want to preserve the whitespace.
If the match_number or start_index are out of range for the string being queried, then
this function generates an error. An error is also generated if no match is found.
If one adds the parameter ignore_errors=true, then the error will be suppressed and
an empty string will be returned on any failure.
Sətir 148 ⟶ 144:
]]
function str.match(
end
end
end
end
end
Sətir 222 ⟶ 218:
Usage:
{{#invoke:
OR
{{#invoke:
Parameters
Sətir 231 ⟶ 227:
If invoked using named parameters, Mediawiki will automatically remove any leading or
trailing whitespace from the target string. In some circumstances this is desirable, in
other cases one may want to preserve the whitespace.
The first character has an index value of 1.
If one requests a negative value, this function will select a character by counting backwards
from the end of the string. In other words pos = -1 is the same as asking for the last character.
A requested value of zero, or a value greater than the length of the string returns an error.
]]
function str.pos(
end
Sətir 257 ⟶ 253:
This function duplicates the behavior of {{str_find}}, including all of its quirks.
This is provided in order to support existing templates, but is NOT RECOMMENDED for
new code and templates. New code is recommended to use the "find" function instead.
Sətir 267 ⟶ 263:
separatetly.
]]
function str.str_find(
end
Sətir 291 ⟶ 287:
Usage:
{{#invoke:
OR
{{#invoke:
Parameters
Sətir 303 ⟶ 299:
If invoked using named parameters, Mediawiki will automatically remove any leading or
trailing whitespace from the parameter. In some circumstances this is desirable, in
other cases one may want to preserve the whitespace.
This function returns the first index >= "start" where "target" can be found
within "source". Indices are 1-based. If "target" is not found, then this
function returns
function also returns
This function should be safe for UTF-8 strings.
]]
function str.find(
local params = {
[1] = { required = true },
[2] = { required = true },
[3] = { type = "number" },
[4] = { type = "boolean" },
}
local args = require("Module:parameters").process(frame.args, params)
return mw.ustring.find(args[1], args[2], args[3], args[4])
end
Sətir 341 ⟶ 329:
Usage:
{{#invoke:
OR
{{#invoke:
count=replacement_count|plain=plain_flag}}
Sətir 352 ⟶ 340:
count: The number of occurences to replace, defaults to all.
plain: Boolean flag indicating that pattern should be understood as plain
text and not as a Lua style regular expression, defaults to true
]]
function str.
local new_args = str._getParameters(
local source_str = new_args['source'] or '';
local pattern = new_args['pattern'] or '';
local replace = new_args['replace'] or '';
local count = tonumber(new_args['count']);
local plain = new_args['plain'] or true;
if source_str == '' or pattern == '' then
return source_str;
end
plain = str._getBoolean(plain);
if plain then
pattern = str.pattern_escape(pattern);
replace = mw.ustring.gsub(replace, "%%", "%%%%"); --Only need to escape replacement sequences.
end
local result;
result = mw.ustring.gsub(source_str, pattern, replace, count);
return result;
end
function str.gsub(frame)
local params = {
[1] = { required = true, allow_empty = true, allow_whitespace = true},
[2] = { required = true, allow_empty = true, allow_whitespace = true},
[3] = { required = true, allow_empty = true, allow_whitespace = true},
[4] = { type = "number" },
}
local args = require("Module:parameters").process(frame.args, params)
return (mw.ustring.gsub(args[1], args[2], args[3], args[4]))
end
--[[
simple function to pipe string.rep to templates.
]]
function str.rep(frame)
local repetitions = tonumber(frame.args[2])
return str._error('function rep expects a number as second parameter, received "' .. (frame.args[2] or '') .. '"')
end
return string.rep(frame.args[1] or '', repetitions)
end
function str.lower(frame)
local text = frame.args[1] or ''
return mw.ustring.lower(text)
end
str.lc = str.lower
--[[
Sətir 459 ⟶ 407:
we sometimes want to either preserve or remove that whitespace depending on the application.
]]
function str._getParameters(
end
--[[
Helper function to handle error messages.
]]
function str._error(
end
end
Sətir 500 ⟶ 448:
Helper Function to interpret boolean strings
]]
function str._getBoolean(
end
end
--[[
Helper function that escapes all pattern characters – ().%+-*?[^$] – so that they will be treated
as plain text.
]]
function str.
local invoked = false
if type(pattern_str) == "table" then
if pattern_str.args then
local frame = pattern_str
invoked = true
if frame.args[1] then
pattern_str = frame.args[1]
else
pattern_str = frame:getParent().args[1]
end
else
error("First argument to pattern_escape should be a string, a number, or a frame object.")
end
elseif not (type(pattern_str) == "string" or type(pattern_str) == "number") then
error("First argument to pattern_escape should be a string or a number.")
end
if invoked then
local escaped = mw.ustring.gsub(pattern_str, "([%(%)%.%%%+%-%*%?%[%^%$%]])", "%%%1")
return escaped
else
return mw.ustring.gsub(pattern_str, "([%(%)%.%%%+%-%*%?%[%^%$%]])", "%%%1");
end
end
function str.count(text, pattern, plain)
if not (type(text) == "string" or type(text) == "number") then
error('The first argument to the function "count" must be a string or a number, not a ' .. type(text) .. '.')
end
if not (type(pattern) == "string" or type(pattern) == "number") then
error('The first argument to the function "count" must be a string or a number, not a ' .. type(text) .. '.')
end
if plain then
pattern = str.pattern_escape(pattern)
end
local _, count = mw.ustring.gsub(text, pattern, "")
return count
end
function str.plain_gsub(text, pattern, replacement)
local invoked = false
if type(text) == "table" then
invoked = true
if text.args then
local frame = text
local params = {
[1] = {},
[2] = {},
[3] = { allow_empty = true },
}
local args = require("Module:parameters").process(frame.args, params)
text = args[1]
pattern = args[2]
replacement = args[3]
else
error("If the first argument to plain_gsub is a table, it should be a frame object.")
end
else
if not (type(pattern) == "string" or type(pattern) == "number") then
error("The second argument to plain_gsub should be a string or a number.")
end
if not (type(replacement) == "string" or type(replacement) == "number") then
error("The third argument to plain_gsub should be a string or a number.")
end
end
pattern = str.pattern_escape(pattern)
if invoked then
text = mw.ustring.gsub(text, pattern, replacement)
return text
else
return mw.ustring.gsub(text, pattern, replacement)
end
end
function str.matchToArray(text, pattern)
local invoked = false
if type(text) == "table" then
invoked = true
if text.args then
local frame = text
local params = {
[1] = { required = true },
[2] = { required = true },
}
local args = require("Module:parameters").process(frame.args, params)
text = args[1]
pattern = args[2]
else
error("If the first argument to matchToArray is a table, it should be a frame object.")
end
else
if not (type(pattern) == "string" or type(pattern) == "number") then
error("The second argument to matchToArray should be a string or a number.")
end
end
local matches = {}
local i = 0
for match in mw.ustring.gmatch(text, pattern) do
i = i + 1
matches[i] = match
end
if i > 0 then
if invoked then
return table.concat(matches, ", ")
else
return matches
end
else
if invoked then
return ""
else
return nil
end
end
end
--[=[
Similar to gmatch, but it returns the count of the match in addition to the
list of captures, something like ipairs().
If the pattern doesn't contain any captures, the whole match is returned.
Invoke thus:
for i, whole_match in require("Module:string").imatch(text, pattern) do
[ do something with i and whole_match ]
end
or
for i, capture1[, capture2[, capture3[, ...]]] in require("Module:string").imatch(text, pattern) do
[ do something with i and capture1 ]
end
For example, this code
for i, whole_match in require("Module:string").imatch("a b c", "[a-z]") do
mw.log(i, whole_match)
end
will log
1 a
2 b
3 c
]=]
function str.imatch(text, pattern, pos, plain, use_basic_Lua_function)
local i = 0
pos = pos or 0
if not string.find(pattern, "%b()") then
pattern = "(" .. pattern .. ")"
end
local find = use_basic_Lua_function and string.find or mw.ustring.find
return function()
i = i + 1
local return_values = { find(text, pattern, pos, plain) }
local j = return_values[2]
if return_values[3] then
pos = j + 1
-- Skip the first two returned values, which are the indices of the
-- whole match.
return i, unpack(return_values, 3)
end
end
end
function str.escapebytes(s)
return (string.gsub(s,
'.',
function(char)
return ('\\%03d'):format(string.byte(char))
end))
end
function str.URIdecode(frame)
return mw.uri.decode(frame.args[1], frame.args[2] or "PATH")
end
|