Module:String: Difference between revisions

    From Nonbinary Wiki
    imported>Unai01
    (Created page with "-- <nowiki> --[[ Source: http://en.wikipedia.org/wiki/Module:String This module is intended to provide access to basic string functions. Most of the functions provided her...")
    m (9 revisions imported from wikipedia:Module:String: see Topic:Vtixlm0q28eo6jtf)
     
    (14 intermediate revisions by 9 users not shown)
    Line 1: Line 1:
    -- <nowiki>
    --[[
    --[[
     
    Source: http://en.wikipedia.org/wiki/Module:String
    This module is intended to provide access to basic string functions.
    This module is intended to provide access to basic string functions.
     
    Most of the functions provided here can be invoked with named parameters,  
    Most of the functions provided here can be invoked with named parameters,
    unnamed parameters, or a mixture.  If named parameters are used, Mediawiki will  
    unnamed parameters, or a mixture.  If named parameters are used, Mediawiki will
    automatically remove any leading or trailing whitespace from the parameter.
    automatically remove any leading or trailing whitespace from the parameter.
    Depending on the intended use, it may be advantageous to either preserve or
    Depending on the intended use, it may be advantageous to either preserve or
    remove such whitespace.
    remove such whitespace.
     
    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.
    ]]
    ]]
     
    local str = {}
    local str = {}
     
    --[[
    --[[
    len
    len
     
    This function returns the length of the target string.
    This function returns the length of the target string.
     
    Usage:
    Usage:
    {{#invoke:String|len|target_string|}}
    {{#invoke:String|len|target_string|}}
    OR
    OR
    {{#invoke:String|len|s=target_string}}
    {{#invoke:String|len|s=target_string}}
     
    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
    trailing whitespace from the target string.
    trailing whitespace from the target string.
    ]]
    ]]
    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
     
    --[[
    --[[
    sub
    sub
     
    This function returns a substring of the target string at specified indices.
    This function returns a substring of the target string at specified indices.
     
    Usage:
    Usage:
    {{#invoke:String|sub|target_string|start_index|end_index}}
    {{#invoke:String|sub|target_string|start_index|end_index}}
    OR
    OR
    {{#invoke:String|sub|s=target_string|i=start_index|j=end_index}}
    {{#invoke:String|sub|s=target_string|i=start_index|j=end_index}}
     
    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 fist 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
    is a negative value, it is interpreted the same as selecting a character by  
    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  
    counting from the end of the string.  Hence, a value of -1 is the same as
    selecting the last character of the string.
    selecting the last character of the string.
     
    If the requested indices are out of range for the given string, an error is