« Module:String » : différence entre les versions

Aller à la navigation Aller à la recherche

Module:String (voir la source)

Version du 11 août 2025 à 20:48

4 466 octets ajoutés ,  11 août 2025
Fix
(utilisation du "default" donné à str.find dans tous les cas)
 
(Fix)
Ligne 10 : Ligne 10 :


Global options
Global options
ignore_errors: If set to 'true' or 1, any error condition will result in
    ignore_errors: If set to 'true' or 1, any error condition will result in
an empty string being returned rather than an error message.
        an empty string being returned rather than an error message.


error_category: If an error occurs, specifies the name of a category to
    error_category: If an error occurs, specifies the name of a category to
include with the error message.  The default category is
        include with the error message.  The default category is
[Category:Errors reported by Module String].
        [Category:Errors reported by Module String].


no_category: If set to 'true' or 1, no category will be added if an error
    no_category: If set to 'true' or 1, no category will be added if an error
is generated.
        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
    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
    s: The string to return a subset of
i: The fist index of the substring to return, defaults to 1.
    i: The first index of the substring to return, defaults to 1.
j: The last index of the string to return, defaults to the last character.
    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
_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. It is exported for use in other modules


Usage:
Usage:
{{#invoke:String|match|source_string|pattern_string|start_index|match_number|plain_flag|nomatch_output}}
strmatch = require("Module:String")._match
OR
sresult = strmatch( s, pattern, start, match, plain, nomatch )
{{#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
    s: The string to search
pattern: The pattern or string to find within the string
    pattern: The pattern or string to find within the string
start: The index within the source string to start the search.  The first
    start: The index within the source string to start the search.  The first
character of the string has index 1.  Defaults to 1.
        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
    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
        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
        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
        counting from the last match.  Hence match = -1 is the same as requesting
the last match.  Defaults to 1.
        the last match.  Defaults to 1.
plain: A flag indicating that the pattern should be understood as plain
    plain: A flag indicating that the pattern should be understood as plain
text.  Defaults to false.
        text.  Defaults to false.
nomatch: If no match is found, output the "nomatch" value rather than an error.
    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 148 : Ligne 137 :


]]
]]
function str.match( frame )
-- This sub-routine is exported for use in other modules
local new_args = str._getParameters( frame.args, { 's', 'pattern', 'start', 'match', 'plain', 'nomatch' } )
function str._match( s, pattern, start, match_index, plain_flag, 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
start = tonumber(start) or 1
-- return str._error( 'Requested start is out of range' )
if math.abs(start) < 1 or math.abs(start) > mw.ustring.len( s ) then
return str._error( 'Requested start is out of range' )
end
end
if match_index == 0 then
if match_index == 0 then
Ligne 182 : Ligne 165 :
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 197 : Ligne 180 :
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 214 : Ligne 197 :
return result
return result
end
end
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|match|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
]]
-- This is the entry point for #invoke:String|match
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']
return str._match( s, pattern, start, match_index, plain_flag, nomatch )
end
end


Ligne 227 : Ligne 265 :


Parameters
Parameters
target: The string to search
    target: The string to search
pos: The index for the character to return
    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 242 : Ligne 280 :
]]
]]
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
--[[
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
end


Ligne 265 : Ligne 334 :


Parameters
Parameters
source: The string to search
    source: The string to search
target: The string or pattern to find within source
    target: The string or pattern to find within source
start: The index within the source string to start the search, defaults to 1
    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
    plain: Boolean flag indicating that target should be understood as plain
text and not as a Lua style regular expression, defaults to true
        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 283 : Ligne 352 :
]]
]]
function str.find( frame )
function str.find( frame )
local new_args = str._getParameters( frame.args, { 'source', 'target', 'start', 'plain', 'trim', 'default' } )
local new_args = str._getParameters( frame.args, {'source', 'target', 'start', 'plain' } )
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
return default
return 0
end
end


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 = default
start = 0
end
end


Ligne 322 : Ligne 385 :


Parameters
Parameters
source: The string to search
    source: The string to search
pattern: The string or pattern to find within source
    pattern: The string or pattern to find within source
replace: The replacement text
    replace: The replacement text
count: The number of occurences to replace, defaults to all.
    count: The number of occurences to replace, defaults to all.
plain: Boolean flag indicating that pattern should be understood as plain
    plain: Boolean flag indicating that pattern should be understood as plain
text and not as a Lua style regular expression, defaults to true
        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 344 : Ligne 407 :
if plain then
if plain then
pattern = str._escapePattern( pattern )
pattern = str._escapePattern( pattern )
replace = string.gsub( replace, "%%", "%%%%" ); --Only need to escape replacement sequences.
replace = string.gsub( replace, "%%", "%%%%" ) --Only need to escape replacement sequences.
end
end


Ligne 359 : Ligne 422 :


--[[
--[[
rep
    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( 'function rep expects a number as second parameter, received "' .. ( frame.args[2] or '' ) .. '"' )
end
return string.rep( frame.args[1] or '', repetitions )
end
 
--[[
escapePattern
 
This function escapes special characters from a Lua string pattern. See [1]
for details on how patterns work.


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")
[1] https://www.mediawiki.org/wiki/Extension:Scribunto/Lua_reference_manual#Patterns


Usage :
Usage:
{{#invoke:String|rep|s|n}}
{{#invoke:String|escapePattern|pattern_string}}


Paramètres :
Parameters
la chaîne 's' dont on veut répeter
    pattern_string: The pattern string to escape.
l'entier 'n' le nombre d'itération
]]
]]
function str.rep( frame )
function str.escapePattern( frame )
local new_args = str._getParameters( frame.args, { 's', 'n' } )
local pattern_str = frame.args[1]
local s = new_args[ 's' ] or ''
if not pattern_str then
local n = tonumber( new_args[ 'n' ] ) or 1
return str._error( 'No pattern string specified' )
return mw.ustring.rep( s, n )
end
local result = str._escapePattern( pattern_str )
return result
end
end


Ligne 381 : Ligne 459 :
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
endswith
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.
This function determines whether a string ends with another string.
Paramètre : source
]]
]]
function str.non_latin( frame )
function str.endswith(frame)
local args = str._getParameters( frame.args, { 'source' } )
local args = str._getParameters(frame.args, {'source', 'pattern'})
    local s = args.source or ''
local source = args.source or ''
    s = mw.text.decode( s, true )
local pattern = args.pattern or ''
    s = mw.ustring.lower( mw.ustring.gsub( mw.ustring.toNFD( s ), "[^%w]", "" ) )
if pattern == '' then
    s = mw.ustring.gsub( s, "[!-˿Ḁ-ỿ]", "" ) -- U+0021-02FF, U+1E00-1EFF
-- All strings end with the empty string.
    return s
return "yes"
end
if mw.ustring.sub(source, -mw.ustring.len(pattern), -1) == pattern then
return "yes"
else
return ""
end
end
end


--[[
join
Join all non empty arguments together; the first argument is the separator.
Usage:
{{#invoke:String|join|sep|one|two|three}}
]]
function str.join(frame)
local args = {}
local sep
for _, v in ipairs( frame.args ) do
if sep then
if v ~= '' then
table.insert(args, v)
end
else
sep = v
end
end
return table.concat( args, sep or '' )
end


-- findpagetext returns the position of a piece of text in a page
-- First positional parameter or |text is the search text
-- Optional parameter |title is the page title, defaults to current page
-- Optional parameter |plain is either true for plain search (default) or false for Lua pattern search
-- Optional parameter |nomatch is the return value when no match is found; default is nil
function str._findpagetext(args)
-- process parameters
local nomatch = args.nomatch or ""
if nomatch == "" then nomatch = nil end
--
local text = mw.text.trim(args[1] or args.text or "")
if text == "" then return nil end
--
local title = args.title or ""
local titleobj
if title == "" then
titleobj = mw.title.getCurrentTitle()
else
titleobj = mw.title.new(title)
end
--
local plain = args.plain or ""
if plain:sub(1, 1) == "f" then plain = false else plain = true end
-- get the page content and look for 'text' - return position or nomatch
local content = titleobj and titleobj:getContent()
return content and mw.ustring.find(content, text, 1, plain) or nomatch
end
function str.findpagetext(frame)
local args = frame.args
local pargs = frame:getParent().args
for k, v in pairs(pargs) do
args[k] = v
end
if not (args[1] or args.text) then return nil end
-- just the first value
return (str._findpagetext(args))
end
--[[
--[[
Helper function that populates the argument list given that user may need to use a mix of
Helper function that populates the argument list given that user may need to use a mix of
Ligne 417 : Ligne 558 :
local new_args = {}
local new_args = {}
local index = 1
local index = 1
local value


for i = 1, #arg_list do
for _, arg in ipairs( arg_list ) do
local arg = arg_list[ i ]
value = frame_args[arg]
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 434 : Ligne 575 :
Helper function to handle error messages.
Helper function to handle error messages.
]]
]]
function str._error( error_msg )
function str._error( error_str )
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 440 : Ligne 581 :
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: ' .. error_msg .. '</strong>'
local error_str = '<strong class="error">String Module Error: ' .. error_str .. '</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
Ligne 479 : Ligne 620 :
]]
]]
function str._escapePattern( pattern_str )
function str._escapePattern( pattern_str )
return ( string.gsub( pattern_str, "([%(%)%.%%%+%-%*%?%[%^%$%]])", "%%%1" ) )
return ( string.gsub( pattern_str, "[%(%)%.%%%+%-%*%?%[%^%$%]]", "%%%0" ) )
end
end


return str
return str
Utilisateur anonyme
Récupérée de "https://encyclopedieacadienne.org/Spécial:MobileDiff/3200"

Menu de navigation