« Module:String » : différence entre les versions
ce test n'avait plus pour seule utilité que de micro-optimiser dans le cas "chaîne vide", mais ce n'est généralement pas (peut-être même jamais) le cas, et de toute façon la fonction mw.ustring.rep() est très performante, en fait c'est un alias de string.rep()
m (1 version importée) |
(ce test n'avait plus pour seule utilité que de micro-optimiser dans le cas "chaîne vide", mais ce n'est généralement pas (peut-être même jamais) le cas, et de toute façon la fonction mw.ustring.rep() est très performante, en fait c'est un alias de string.rep()) |
||
| Ligne 10 : | Ligne 10 : | ||
Global options | 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. | Unit tests for this module are available at Module:String/tests. | ||
| Ligne 36 : | Ligne 36 : | ||
Parameters | Parameters | ||
s: The string whose length to report | |||
If invoked using named parameters, Mediawiki will automatically remove any leading or | If invoked using named parameters, Mediawiki will automatically remove any leading or | ||
| Ligne 42 : | Ligne 42 : | ||
]] | ]] | ||
function str.len( frame ) | function str.len( frame ) | ||
local new_args = str._getParameters( frame.args, {'s'} ) | local new_args = str._getParameters( frame.args, { 's' } ) | ||
local s = new_args['s'] or '' | local s = new_args[ 's' ] or '' | ||
return mw.ustring.len( s ) | return mw.ustring.len( s ) | ||
end | end | ||
| Ligne 58 : | Ligne 58 : | ||
Parameters | 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 | The first character of the string is assigned an index of 1. If either i or j | ||
| Ligne 72 : | Ligne 72 : | ||
function str.sub( frame ) | function str.sub( frame ) | ||
local new_args = str._getParameters( frame.args, { 's', 'i', 'j' } ) | local new_args = str._getParameters( frame.args, { 's', 'i', 'j' } ) | ||
local s = new_args['s'] or '' | local s = new_args[ 's' ] or '' | ||
local i = tonumber( new_args['i'] ) or 1 | local i = tonumber( new_args[ 'i' ] ) or 1 | ||
local j = tonumber( new_args['j'] ) or -1 | local j = tonumber( new_args[ 'j' ] ) or -1 | ||
local len = mw.ustring.len( s ) | local len = mw.ustring.len( s ) | ||
| Ligne 107 : | Ligne 107 : | ||
--[[ | --[[ | ||
match | |||
This function returns a substring from the source string that matches a | This function returns a substring from the source string that matches a | ||
specified pattern. | specified pattern. | ||
Usage: | Usage: | ||
{{#invoke:String|match|source_string|pattern_string|start_index|match_number|plain_flag|nomatch_output}} | |||
OR | |||
{{#invoke:String|match|s=source_string|pattern=pattern_string|start=start_index | |||
|match=match_number|plain=plain_flag|nomatch=nomatch_output}} | |||
Parameters | 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: | For information on constructing Lua patterns, a form of [regular expression], see: | ||
| Ligne 137 : | Ligne 148 : | ||
]] | ]] | ||
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 | if s == '' then | ||
return str._error( 'Target string is empty' ) | -- return str._error( 'Target string is empty' ) | ||
end | end | ||
if pattern == '' then | if pattern == '' then | ||
return str._error( 'Pattern string is empty' ) | return str._error( 'Pattern string is empty' ) | ||
end | end | ||
if math.abs( start ) < 1 or math.abs( start ) > mw.ustring.len( s ) then | |||
if math.abs(start) < 1 or math.abs(start) > mw.ustring.len( s ) then | -- return str._error( 'Requested start is out of range' ) | ||
return str._error( 'Requested start is out of range' ) | |||
end | end | ||
if match_index == 0 then | if match_index == 0 then | ||
| Ligne 165 : | Ligne 182 : | ||
end | end | ||
local iterator = mw.ustring.gmatch(s, pattern) | local iterator = mw.ustring.gmatch( s, pattern ) | ||
if match_index > 0 then | if match_index > 0 then | ||
-- Forward search | -- Forward search | ||
| Ligne 180 : | Ligne 197 : | ||
local count = 1 | local count = 1 | ||
for w in iterator do | for w in iterator do | ||
result_table[count] = w | result_table[ count ] = w | ||
count = count + 1 | count = count + 1 | ||
end | end | ||
| Ligne 197 : | Ligne 214 : | ||
return result | return result | ||
end | end | ||
end | end | ||
| Ligne 265 : | Ligne 227 : | ||
Parameters | 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 | If invoked using named parameters, Mediawiki will automatically remove any leading or | ||
| Ligne 280 : | Ligne 242 : | ||
]] | ]] | ||
function str.pos( frame ) | function str.pos( frame ) | ||
local new_args = str._getParameters( frame.args, {'target', 'pos'} ) | local new_args = str._getParameters( frame.args, { 'target', 'pos' } ) | ||
local target_str = new_args['target'] or '' | local target_str = new_args[ 'target' ] or '' | ||
local pos = tonumber( new_args['pos'] ) or 0 | local pos = tonumber( new_args[ 'pos' ] ) or 0 | ||
if pos == 0 or math.abs(pos) > mw.ustring.len( target_str ) then | if pos == 0 or math.abs( pos ) > mw.ustring.len( target_str ) then | ||
return str._error( 'String index out of range' ) | return str._error( 'String index out of range' ) | ||
end | end | ||
return mw.ustring.sub( target_str, pos, pos ) | return mw.ustring.sub( target_str, pos, pos ) | ||
end | end | ||
| Ligne 334 : | Ligne 265 : | ||
Parameters | 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 | If invoked using named parameters, Mediawiki will automatically remove any leading or | ||
| Ligne 352 : | Ligne 283 : | ||
]] | ]] | ||
function str.find( frame ) | function str.find( frame ) | ||
local new_args = str._getParameters( frame.args, {'source', 'target', 'start', 'plain' } ) | local new_args = str._getParameters( frame.args, { 'source', 'target', 'start', 'plain', 'trim', 'default' } ) | ||
local source_str = new_args['source'] or '' | local source_str = new_args[ 'source' ] or '' | ||
local pattern = new_args['target'] or '' | local pattern = new_args[ 'target' ] or '' | ||
local start_pos = tonumber(new_args['start']) or 1 | local start_pos = tonumber( new_args[ 'start' ] ) or 1 | ||
local plain = new_args['plain'] or true | local plain = new_args[ 'plain' ] or true | ||
local trim = new_args[ 'trim' ] or false | |||
local default = new_args[ 'default' ] | |||
if default == 'empty' then default = '' else default = tonumber( default ) or 0 end | |||
if source_str == '' or pattern == '' then | if source_str == '' or pattern == '' then | ||
| Ligne 363 : | Ligne 297 : | ||
plain = str._getBoolean( plain ) | plain = str._getBoolean( plain ) | ||
trim = str._getBoolean( trim ) | |||
if trim then source_str = mw.text.trim( source_str ) end | |||
local start = mw.ustring.find( source_str, pattern, start_pos, plain ) | local start = mw.ustring.find( source_str, pattern, start_pos, plain ) | ||
if start == nil then | if start == nil then | ||
start = | start = default | ||
end | end | ||
| Ligne 385 : | Ligne 322 : | ||
Parameters | 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 ) | function str.replace( frame ) | ||
local new_args = str._getParameters( frame.args, {'source', 'pattern', 'replace', 'count', 'plain' } ) | local new_args = str._getParameters( frame.args, { 'source', 'pattern', 'replace', 'count', 'plain' } ) | ||
local source_str = new_args['source'] or '' | local source_str = new_args[ 'source' ] or '' | ||
local pattern = new_args['pattern'] or '' | local pattern = new_args[ 'pattern' ] or '' | ||
local replace = new_args['replace'] or '' | local replace = new_args[ 'replace' ] or '' | ||
local count = tonumber( new_args['count'] ) | local count = tonumber( new_args[ 'count' ] ) | ||
local plain = new_args['plain'] or true | local plain = new_args[ 'plain' ] or true | ||
if source_str == '' or pattern == '' then | if source_str == '' or pattern == '' then | ||
| Ligne 407 : | Ligne 344 : | ||
if plain then | if plain then | ||
pattern = str._escapePattern( pattern ) | pattern = str._escapePattern( pattern ) | ||
replace = mw.ustring.gsub( replace, "%%", "%%%%" ) --Only need to escape replacement sequences. | replace = mw.ustring.gsub( replace, "%%", "%%%%" ); --Only need to escape replacement sequences. | ||
end | end | ||
| Ligne 422 : | Ligne 359 : | ||
--[[ | --[[ | ||
rep | |||
Cette fonction retourne la concaténation de son premier paramètre n fois où n est le deuxième paramètre (fonction "rep" ou "repeat") | |||
Usage : | |||
{{#invoke:String|rep|s|n}} | |||
Usage: | |||
{{#invoke:String| | |||
Paramètres : | |||
la chaîne 's' dont on veut répeter | |||
l'entier 'n' le nombre d'itération | |||
]] | ]] | ||
function str. | function str.rep( frame ) | ||
local | local new_args = str._getParameters( frame.args, { 's', 'n' } ) | ||
local s = new_args[ 's' ] or '' | |||
local n = tonumber( new_args[ 'n' ] ) or 1 | |||
return mw.ustring.rep( s, n ) | |||
local | |||
return | |||
end | end | ||
| Ligne 459 : | Ligne 381 : | ||
This function counts the number of occurrences of one string in another. | This function counts the number of occurrences of one string in another. | ||
]] | ]] | ||
function str.count(frame) | function str.count( frame ) | ||
local args = str._getParameters(frame.args, {'source', 'pattern', 'plain'}) | local args = str._getParameters( frame.args, { 'source', 'pattern', 'plain' } ) | ||
local source = args.source or '' | local source = args.source or '' | ||
local pattern = args.pattern or '' | local pattern = args.pattern or '' | ||
local plain = str._getBoolean(args.plain or true) | local plain = str._getBoolean( args.plain or true ) | ||
if plain then | if plain then | ||
pattern = str._escapePattern(pattern) | pattern = str._escapePattern( pattern ) | ||
end | end | ||
local _, count = mw.ustring.gsub(source, pattern, '') | local _, count = mw.ustring.gsub( source, pattern, '' ) | ||
return count | return count | ||
end | end | ||
--[[ | --[[ | ||
non_latin | |||
Retire tous les caractères latins d'une chaîne de caractères. Rend la chaîne vide "" si le paramètre est un texte entièrement latin. | |||
Paramètre : source | |||
]] | ]] | ||
function str. | function str.non_latin( frame ) | ||
local args = str._getParameters(frame.args, {'source | local args = str._getParameters( frame.args, { 'source' } ) | ||
local s = args.source or '' | |||
s = mw.text.decode( s, true ) | |||
s = mw.ustring.lower( mw.ustring.gsub( mw.ustring.toNFD( s ), "[^%w]", "" ) ) | |||
s = mw.ustring.gsub( s, "[!-˿Ḁ-ỿ]", "" ) -- U+0021-02FF, U+1E00-1EFF | |||
return s | |||
end | end | ||
--[[ | --[[ | ||
| Ligne 521 : | Ligne 417 : | ||
local new_args = {} | local new_args = {} | ||
local index = 1 | local index = 1 | ||
for | for i = 1, #arg_list do | ||
value = frame_args[arg] | local arg = arg_list[ i ] | ||
local value = frame_args[ arg ] | |||
if value == nil then | if value == nil then | ||
value = frame_args[index] | value = frame_args[ index ] | ||
index = index + 1 | index = index + 1 | ||
end | end | ||
new_args[arg] = value | new_args[ arg ] = value | ||
end | end | ||
| Ligne 538 : | Ligne 434 : | ||
Helper function to handle error messages. | Helper function to handle error messages. | ||
]] | ]] | ||
function str._error( | function str._error( error_msg ) | ||
local frame = mw.getCurrentFrame() | local frame = mw.getCurrentFrame() | ||
local error_category = frame.args.error_category or 'Errors reported by Module String' | local error_category = frame.args.error_category or 'Errors reported by Module String' | ||
| Ligne 544 : | Ligne 440 : | ||
local no_category = frame.args.no_category or false | local no_category = frame.args.no_category or false | ||
if str._getBoolean(ignore_errors) then | if str._getBoolean( ignore_errors ) then | ||
return '' | return '' | ||
end | end | ||
local error_str = '<strong class="error">String Module Error: ' .. | local error_str = '<strong class="error">String Module Error: ' .. error_msg .. '</strong>' | ||
if error_category ~= '' and not str._getBoolean( no_category ) then | if error_category ~= '' and not str._getBoolean( no_category ) then | ||
error_str = '[[Category:' .. error_category .. ']]' .. error_str | error_str = '[[Category:' .. error_category .. ']]' .. error_str | ||