Difference between revisions of "StartsWith and IsStartOf (String functions)"

From m204wiki
Jump to navigation Jump to search
m
Line 1: Line 1:
{{Template:String:IsStartOf subtitle}}
+
{{Template:String:StartsWith and IsStartOf subtitle}}
 
   
 
   
 
==Syntax==
 
==Syntax==
 +
{{Template:String:StartsWith syntax}}
 
{{Template:String:IsStartOf syntax}}
 
{{Template:String:IsStartOf syntax}}
 
===Syntax terms===
 
===Syntax terms===
Line 45: Line 46:
  
 
==See also==
 
==See also==
{{Template:String:IsStartOf footer}}
+
{{Template:String:StartsWith and IsStartOf footer}}

Revision as of 16:57, 29 June 2011

Is one string an initial substring of a longer string? (String class)

[Introduced in Sirius Mods 7.9]


Syntax

%boolean = string:StartsWith( abbreviation)

%boolean = string:IsStartOf( longerString, MinLength= number)

Syntax terms

%boolean The Boolean result of IsStartOf is True if:
  • The length of the method object string is at least the value of the MinLength argument
    and:
  • the method object string is the same as the initial substring, whose length is the length of string, of the longerString argument.
If either of the above conditions does not hold, the result is False.
string A string which is examined to see if it is an abbreviation (i.e., an initial substring) of longerString.
longerString A string which is examined to see if the method object string is an abbreviation of it.
MinLength This name-required argument is a non-negative number, specifying the minimum length of the method object string to be considered an abbreviation of longerString. Note that if this is 0, then the null string is an abbreviation of any value of the longerString argument; if this is non-0, then the null string is never an abbreviation.

Examples

Determining if option is valid abbreviation

A common task is checking user input for a valid abbreviation for one of several longer terms. This is one motivation for the MinLength argument; there may be overlap in the initial substrings of the longer terms. Consider the following fragment:

%opt = %(system):arguments:toUpper if %opt:isStartOf('MAXAMOUNT', MinLength=5) then ... elseIf %opt:isStartOf('MAXTIME', MinLenth=5) then ... else PrintText Invalid argument: {%opt}

If the argument to this proc is max, that would not distinguish it between maxAmount and maxTime; hence the MinLength argument value of 5 is used to enforce that at least maxAm or maxTi is entered (a value of 4 would also have disambiguated the abbreviations in this case).

Several single-line examples

The following fragment:

PrintText {~= 'a':IsStartOf('abc', MinLength=1) } PrintText {~= 'a':IsStartOf('abc', MinLength=2) } PrintText {~= 'a':IsStartOf('abc', MinLength=0) } PrintText {~= 'x':IsStartOf('abc', MinLength=1) } PrintText {~= 'x':IsStartOf('abc', MinLength=0) } PrintText {~= :IsStartOf('abc', MinLength=0) }

produces the following output:

'a':IsStartOf('abc', MinLength=1) = True 'a':IsStartOf('abc', MinLength=2) = False 'a':IsStartOf('abc', MinLength=0) = True 'x':IsStartOf('abc', MinLength=1) = False 'x':IsStartOf('abc', MinLength=0) = False

See also