Модуль:String
Внимание! Это один из самых используемых модулей. |
Прежде чем вносить какие-либо изменения в этот модуль, просьба оттестировать их в /песочнице и проверить результат на странице с /контрольными примерами. |
Этот модуль предназначен для обеспечения доступа к основным строковым функциям.
Большая часть функций, имеющихся в модуле, может быть вызвана именованными, неименованными параметрами или обоими вариантами. Если используются именованные параметры, движок Mediawiki автоматически удаляет любые начальные или конечные пробелы из параметра. В зависимости от предполагаемого использования может быть предпочтительным либо сохранение, либо удаление таких пробелов. Экспериментировать с модулем можно на странице Модуль:String/песочница.
Глобальные параметры
ignore_errors :
|
Если параметру присвоено значение true или 1 , вместо любого сообщения об ошибке выводится пустая строка.
|
error_category :
|
В случае возникновения ошибки определяет название категории, в которую помещается страница с сообщением об ошибке. По умолчанию помещается в категорию «Страницы с ошибками модуля String». |
no_category :
|
Если параметру присвоено значение true или 1 , то в случае сообщения об ошибке страница не будет помещена в соответствующую категорию.
|
subcount
Функция возвращает количество подстрок внутри строки.
- Использование
{{#invoke:String|subcount|исходная_строка|подстрока|true / false}}
- или
{{#invoke:String|subcount|s=исходная_строка|pattern=подстрока|plain=true / false}}
- Параметры
s :
|
Целевая строка, часть которой необходимо найти. |
pattern :
|
Строка, совпадение с которой необходимо найти в целевой строке. |
plain :
|
Если параметру присвоено значение false , функция воспринимает заданную строку как регулярное выражение. По умолчанию — true .
|
len
Функция возвращает длину целевой строки.
- Использование
{{#invoke:String|len|целевая_строка}}
- или
{{#invoke:String|len|s= целевая_строка }}
- Параметры
s :
|
Строка, длину которой необходимо найти. |
sub
Функция возвращает часть целевой стоки между указанными индексами (порядковыми номерами символов в целевой строке)
- Использование
{{#invoke:String|sub|целевая_строка|начальный_индекс|конечный_индекс}}
- или
{{#invoke:String|sub|s= целевая_строка |i= начальный_индекс |j= конечный_индекс }}
- Параметры
s :
|
Строка, часть которой необходимо вывести. |
i :
|
Порядковый номер символа, начиная с которого необходимо вывести строку. Значение по умолчанию — 1. |
j :
|
Порядковый номер символа, до которого необходимо вывести строку. Значение по умолчанию — порядковый номер последнего символа. |
Первому символу строки присваивается индекс 1
. Если параметрам i
или j
присвоено отрицательное значение, то оно распознается модулем как порядковый номер символа, отсчитываемый с конца строки. Другими словами, значение -1
распознается модулем как порядковый номер последнего символа в строке.
Если введённые индексы по модулю больше длины целевой строки, то выводится сообщение об ошибке.
sublength
С помощью этой функции реализован шаблон {{Str sub}}, она сохраняется для поддержания его работоспособности.
match
Функция возвращает часть целевой строки, которая соответствует заданной строке.
- Использование
{{#invoke:String|match|исходная_строка|заданная_строка|начальный_индекс|номер_совпадения|true / false|значение_если_нет_совпадений}}
- или
{{#invoke:String|match|s= исходная_строка |pattern= заданная_строка |start= начальный_индекс|match= номер_совпадения|plain= true / false |nomatch= значение_если_нет_совпадений }}
- Параметры
s :
|
Целевая строка, часть которой необходимо найти. |
pattern :
|
Строка, совпадение с которой необходимо найти в целевой строке. |
start :
|
Порядковый номер символа, начиная с которого необходимо произвести поиск совпадения. По умолчанию — 1 . Если начиная с заданного символа совпадений не найдено, функция возвращает сообщение об ошибке.
|
match :
|
В некоторых случаях может оказаться несколько совпадений с заданной строкой в одной целевой строке. Параметр задает номер совпадения, которое необходимо вывести. Если параметру присвоено отрицательное значение, то оно распознается модулем как порядковый номер совпадения, отсчитываемый с конца строки. Другими словами, значение -1 распознается модулем как порядковый номер последнего совпадения в строке. По умолчанию — 1.
|
plain :
|
Если параметру присвоено значение true , функция воспринимает заданную строку как обычный текст, а не регулярное выражение. По умолчанию — false .
|
nomatch :
|
Последовательность символов, выводимая строкой в случае отсутствия совпадений вместо сообщения об ошибке. |
Если введённый индекс по модулю больше длины целевой строки или совпадений найдено меньше, чем число, заданное в параметре match
, то выводится сообщение об ошибке.
Если добавить параметр ignore_errors=true
, то вместо любого из сообщений об ошибке будет возвращена пустая строка.
Подробнее о регулярных выражениях, используемых в Lua, см. Руководство по метасимволам.
pos
Функция возвращает один символ из целевой строки под заданным порядковым номером.
- Использование
{{#invoke:String|pos|целевая_строка|значение_индекса}}
- или
{{#invoke:String|pos|target= целевая_строка |pos= значение_индекса }}
- Параметры
target :
|
Строка, в которой производится поиск символа. |
pos :
|
Порядковый номер возвращаемого символа |
Если параметру pos
присвоено отрицательное значение, то оно распознается модулем как порядковый номер символа, отсчитываемый с конца строки. Другими словами, значение -1
распознается модулем как порядковый номер последнего символа в строке.
Если заданный порядковый номер равен 0 или больше длины строки, функция возвращает сообщение об ошибке.
str_find
Эта фунция предназначена для поддержания функционирования шаблона {{str find}}. Она сохраняется для того, чтобы поддерживать существующие шаблоны, но она крайне не рекомендуется для использования в новых шаблонах. Рекомендуется вместо неё использовать функцию find
.
Возвращает порядковый номер символа, начиная с которого целевая строка, заданная параметром source
совпадает со строкой в параметре target
. Функция возвращает −1
, если совпадений между строками не найдено.
Важно: Если в параметре target
не задана строка, либо отсутствует сам параметр, функция возвращает 1
, что, как правило, является полной неожиданностью для пользователей.
find
Функция позволяет выполнить поиск целевой строки в другой строке.
- Использование
{{#invoke:String|find|исходная_строка|целевая_строка|начальный_индекс|true / false}}
- или
{{#invoke:String|find|source= исходная_строка |target= целевая_строка |start= начальный_индекс|plain= true / false }}
- Параметры
source :
|
Строка, в которой ведется поиск целевой строки. |
target :
|
Целевая строка, которая ищется в другой строке. |
start :
|
Порядковый номер символа, начиная с которого ведется поиск совпадений. Значение по умолчанию — 1. |
plain :
|
Если параметру присвоено значение true , функция воспринимает заданную строку как обычный текст, а не регулярное выражение. По умолчанию — true .
|
Функция возвращает значение, большее либо равное значению параметра start
. Если совпадений не найдено, функция возвращает 0
, если одна из строк пустая или не задана, функция также возвращает 0
.
replace
Функция позволяет заменить целевую строку в другой строке.
- Использование
{{#invoke:String|replace|исходная_строка|целевая_строка|заменяющая_строка|количество_замен|true / false}}
- или
{{#invoke:String|replace|source= исходная_строка |pattern= целевая_строка|replace= заменяющая_строка |count= количество_замен |plain= true / false }}
- Параметры
source :
|
Строка, в которой ведется поиск. |
pattern :
|
Строка, которая ищется в исходной строке. |
replace :
|
Строка, заменяющая целевую. |
count :
|
Количество заменяемых совпадений; по умолчанию — все. |
plain :
|
Если параметру присвоено значение true , функция воспринимает заданную строку как обычный текст, а не регулярное выражение. По умолчанию — true .
|
rep
Функция возвращает строку, состоящую из повторений n раз исходной строки.
- Использование
{{#invoke:String|rep|строка|количество_повторов}}
- Параметры
source :
|
Строка, которую необходимо повторить n раз. |
count :
|
Количество повторов. |
- Пример
{{#invoke:String|rep|привет!|3}}
→ привет!привет!привет!
--[[
This module is intended to provide access to basic string functions.
Most of the functions provided here can be invoked with named parameters,
unnamed parameters, or a mixture. If named parameters are used, Mediawiki will
automatically remove any leading or trailing whitespace from the parameter.
Depending on the intended use, it may be advantageous to either preserve or
remove such whitespace.
Global options
ignore_errors: If set to 'true' or 1, any error condition will result in
an empty string being returned rather than an error message.
error_category: If an error occurs, specifies the name of a category to
include with the error message. The default category is
[Category:Errors reported by Module String].
no_category: If set to 'true' or 1, no category will be added if an error
is generated.
Unit tests for this module are available at Module:String/tests.
]]
local str = {}
--[[
subcount
This function returns the count of substring in source string.
Usage:
{{#invoke:String|subcount|source_string|substring|plain_flag}}
OR
{{#invoke:String|subcount|s=source_string|pattern=substring|plain=plain_flag}}
Parameters
s: The string to search
pattern: The pattern or string to find within the string
plain: A flag indicating that the substring should be understood as plain
text. Defaults to true.
If invoked using named parameters, Mediawiki will automatically remove any leading or
trailing whitespace from the target string.
]]
function str.subcount( frame )
local new_args = str._getParameters( frame.args, {'s', 'pattern', 'plain'} );
local s = new_args['s'] or '';
local plain_flag = str._getBoolean( new_args['plain'] or true );
local pattern = new_args['pattern'] or '';
if s == '' or pattern == '' then
return 0;
end
if plain_flag then
pattern = str._escapePattern( pattern );
end
local _, count = mw.ustring.gsub(s, pattern, "")
return count;
end
--[[
len
This function returns the length of the target string.
Usage:
{{#invoke:String|len|target_string|}}
OR
{{#invoke:String|len|s=target_string}}
Parameters
s: The string whose length to report
If invoked using named parameters, Mediawiki will automatically remove any leading or
trailing whitespace from the target string.
]]
function str.len( frame )
local new_args = str._getParameters( frame.args, {'s'} );
local s = new_args['s'] or '';
return mw.ustring.len( s )
end
--[[
sub
This function returns a substring of the target string at specified indices.
Usage:
{{#invoke:String|sub|target_string|start_index|end_index}}
OR
{{#invoke:String|sub|s=target_string|i=start_index|j=end_index}}
Parameters
s: The string to return a subset of
i: The fist index of the substring to return, defaults to 1.
j: The last index of the string to return, defaults to the last character.
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( frame )
local new_args = str._getParameters( frame.args, { 's', 'i', 'j' } );
local s = new_args['s'] or '';
local i = tonumber( new_args['i'] ) or 1;
local j = tonumber( new_args['j'] ) or -1;
local len = mw.ustring.len( s );
-- Convert negatives for range checking
if i < 0 then
i = len + i + 1;
end
if j < 0 then
j = len + j + 1;
end
if i > len or j > len or i < 1 or j < 1 then
return str._error( 'Значение индекса подстроки выходит за допустимые границы' );
end
if j < i then
return str._error( 'Неверный порядок индексов подстроки' );
end
return mw.ustring.sub( s, i, j )
end
--[[
This function implements that features of {{str sub old}} and is kept in order
to maintain these older templates.
]]
function str.sublength( frame )
local i = tonumber( frame.args.i ) or 0
local len = tonumber( frame.args.len )
return mw.ustring.sub( frame.args.s, i + 1, len and ( i + len ) )
end
--[[
match
This function returns a substring from the source string that matches a
specified pattern.
Usage:
{{#invoke:String|match|source_string|pattern_string|start_index|match_number|plain_flag|nomatch_output}}
OR
{{#invoke:String|pos|s=source_string|pattern=pattern_string|start=start_index
|match=match_number|plain=plain_flag|nomatch=nomatch_output}}
Parameters
s: The string to search
pattern: The pattern or string to find within the string
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.
plain: A flag indicating that the pattern should be understood as plain
text. Defaults to false.
nomatch: If no match is found, output the "nomatch" value rather than an error.
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.
For information on constructing Lua patterns, a form of [regular expression], see:
* http://www.lua.org/manual/5.1/manual.html#5.4.1
* http://www.mediawiki.org/wiki/Extension:Scribunto/Lua_reference_manual#Patterns
* http://www.mediawiki.org/wiki/Extension:Scribunto/Lua_reference_manual#Ustring_patterns
]]
function str.match( frame )
local new_args = str._getParameters( frame.args, {'s', 'pattern', 'start', 'match', 'plain', 'nomatch'} );
local s = new_args['s'] or '';
local start = tonumber( new_args['start'] ) or 1;
local plain_flag = str._getBoolean( new_args['plain'] or false );
local pattern = new_args['pattern'] or '';
local match_index = math.floor( tonumber(new_args['match']) or 1 );
local nomatch = new_args['nomatch'];
if s == '' then
return str._error( 'Пустая строка поиска' );
end
if pattern == '' then
return str._error( 'Пустой шаблон поиска' );
end
if math.abs(start) < 1 or math.abs(start) > mw.ustring.len( s ) then
return str._error( 'Индекс начала поиска выходит за допустимые границы' );
end
if match_index == 0 then
return str._error( 'Индекс совпадения выходит за допустимые границы' );
end
if plain_flag then
pattern = str._escapePattern( pattern );
end
local result
if match_index == 1 then
-- Find first match is simple case
result = mw.ustring.match( s, pattern, start )
else
if start > 1 then
s = mw.ustring.sub( s, start );
end
local iterator = mw.ustring.gmatch(s, pattern);
if match_index > 0 then
-- Forward search
for w in iterator do
match_index = match_index - 1;
if match_index == 0 then
result = w;
break;
end
end
else
-- Reverse search
local result_table = {};
local count = 1;
for w in iterator do
result_table[count] = w;
count = count + 1;
end
result = result_table[ count + match_index ];
end
end
if result == nil then
if nomatch == nil then
return str._error( 'Совпадение не найдено' );
else
return nomatch;
end
else
return result;
end
end
--[[
pos
This function returns a single character from the target string at position pos.
Usage:
{{#invoke:String|pos|target_string|index_value}}
OR
{{#invoke:String|pos|target=target_string|pos=index_value}}
Parameters
target: The string to search
pos: The index for the character to return
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( frame )
local new_args = str._getParameters( frame.args, {'target', 'pos'} );
local target_str = new_args['target'] or '';
local pos = tonumber( new_args['pos'] ) or 0;
if pos == 0 or math.abs(pos) > mw.ustring.len( target_str ) then
return str._error( 'Значение индекса строки выходит за допустимые границы' );
end
return mw.ustring.sub( target_str, pos, pos );
end
--[[
str_find
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.
Returns the first index in "source" that is a match to "target". Indexing is 1-based,
and the function returns -1 if the "target" string is not present in "source".
Important Note: If the "target" string is empty / missing, this function returns a
value of "1", which is generally unexpected behavior, and must be accounted for
separatetly.
]]
function str.str_find( frame )
local new_args = str._getParameters( frame.args, {'source', 'target'} );
local source_str = new_args['source'] or '';
local target_str = new_args['target'] or '';
if target_str == '' then
return 1;
end
local start = mw.ustring.find( source_str, target_str, 1, true )
if start == nil then
start = -1
end
return start
end
--[[
find
This function allows one to search for a target string or pattern within another
string.
Usage:
{{#invoke:String|find|source_str|target_string|start_index|plain_flag}}
OR
{{#invoke:String|find|source=source_str|target=target_str|start=start_index|plain=plain_flag}}
Parameters
source: The string to search
target: The string or pattern to find within source
start: The index within the source string to start the search, defaults to 1
plain: Boolean flag indicating that target should be understood as plain
text and not as a Lua style regular expression, defaults to true
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 0. If either "source" or "target" are missing / empty, this
function also returns 0.
This function should be safe for UTF-8 strings.
]]
function str.find( frame )
local new_args = str._getParameters( frame.args, {'source', 'target', 'start', 'plain' } );
local source_str = new_args['source'] or '';
local pattern = new_args['target'] or '';
local start_pos = tonumber(new_args['start']) or 1;
local plain = new_args['plain'] or true;
if source_str == '' or pattern == '' then
return 0;
end
plain = str._getBoolean( plain );
local start = mw.ustring.find( source_str, pattern, start_pos, plain )
if start == nil then
start = 0
end
return start
end
--[[
replace
This function allows one to replace a target string or pattern within another
string.
Usage:
{{#invoke:String|replace|source_str|pattern_string|replace_string|replacement_count|plain_flag}}
OR
{{#invoke:String|replace|source=source_string|pattern=pattern_string|replace=replace_string|
count=replacement_count|plain=plain_flag}}
Parameters
source: The string to search
pattern: The string or pattern to find within source
replace: The replacement text
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.replace( frame )
local new_args = str._getParameters( frame.args, {'source', 'pattern', 'replace', 'count', 'plain' } );
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._escapePattern( pattern );
replace = string.gsub( replace, "%%", "%%%%" ) --Only need to escape replacement sequences.
end
local result;
if count ~= nil then
result = mw.ustring.gsub( source_str, pattern, replace, count );
else
result = mw.ustring.gsub( source_str, pattern, replace );
end
return result;
end
--[[
This function adds support for escaping parts of the patterns when using [plain=false].
]]
function str.escape( frame )
local new_args = str._getParameters( frame.args, {'pattern' } );
local pattern = new_args['pattern'] or '';
local result = '';
result = str._escapePattern( pattern );
return result;
end
--[[
Internal compare string function
]]
function str._strcmp(a , b)
local s1c = mw.ustring.gcodepoint( a );
local s2c = mw.ustring.gcodepoint( b );
while true do
local c1 = s1c();
local c2 = s2c();
if c1 == nil then
if c2 == nil then
return 0
else
return -1
end
else
if c2 ~= nil then
if c1 ~= c2 then
return c1 < c2 and -1 or 1
end
else
return 1
end
end
end
return 0
end
--[[
compare
This function compare two UTF-8 strings
Usage:
{{#invoke:String|compare|str1|str2}}
Returns:
0 - if strings are equal
1 - if st1 > str2
-1 - if str1 < str2
]]
function str.compare(frame)
local str1 = frame.args[1] or '';
local str2 = frame.args[2] or '';
return str._strcmp(str1 , str2)
end
--[[
simple function to pipe string.rep to templates.
]]
function str.rep( frame )
local repetitions = tonumber( frame.args[2] )
if not repetitions then
return str._error( 'функция rep ожидает число во втором параметре, а получено "' .. ( frame.args[2] or '' ) .. '"' )
end
return string.rep( frame.args[1] or '', repetitions )
end
--[[
Helper function that populates the argument list given that user may need to use a mix of
named and unnamed parameters. This is relevant because named parameters are not
identical to unnamed parameters due to string trimming, and when dealing with strings
we sometimes want to either preserve or remove that whitespace depending on the application.
]]
function str._getParameters( frame_args, arg_list )
local new_args = {};
local index = 1;
local value;
for i,arg in ipairs( arg_list ) do
value = frame_args[arg]
if value == nil then
value = frame_args[index];
index = index + 1;
end
new_args[arg] = value;
end
return new_args;
end
--[[
Helper function to handle error messages.
]]
function str._error( error_str )
local frame = mw.getCurrentFrame();
local error_category = frame.args.error_category or 'Страницы с ошибками модуля String';
local ignore_errors = frame.args.ignore_errors or false;
local no_category = frame.args.no_category or false;
if str._getBoolean(ignore_errors) then
return '';
end
local error_str = '<strong class="error">Ошибка модуля String: ' .. error_str .. '</strong>';
if error_category ~= '' and not str._getBoolean( no_category ) then
error_str = '[[Категория:' .. error_category .. ']]' .. error_str;
end
return error_str;
end
--[[
Helper Function to interpret boolean strings
]]
function str._getBoolean( boolean_str )
local boolean_value;
if type( boolean_str ) == 'string' then
boolean_str = boolean_str:lower();
if boolean_str == 'false' or boolean_str == 'no' or boolean_str == '0'
or boolean_str == '' then
boolean_value = false;
else
boolean_value = true;
end
elseif type( boolean_str ) == 'boolean' then
boolean_value = boolean_str;
else
error( 'Логическое значение не найдено' );
end
return boolean_value
end
--[[
Helper function that escapes all pattern characters so that they will be treated
as plain text.
]]
function str._escapePattern( pattern_str )
return ( string.gsub( pattern_str, "[%(%)%.%%%+%-%*%?%[%^%$%]]", "%%%0" ) )
end
return str