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

From m204wiki
Jump to navigation Jump to search
m
m
Line 1: Line 1:
 
{{Template:String:StartsWith and IsStartOf subtitle}}
 
{{Template:String:StartsWith and IsStartOf subtitle}}
 +
<var>StartsWith</var> can be conveniently used to check whether a starts with a known string; <var>IsStartOf</var> can be conveniently used to check whether a string is an abbreviation of a known string.
 
   
 
   
 
==Syntax==
 
==Syntax==
 
{{Template:String:StartsWith syntax}}
 
{{Template:String:StartsWith syntax}}
 
{{Template:String:IsStartOf syntax}}
 
{{Template:String:IsStartOf syntax}}
<var>StartsWith</var> can be conveniently used to check whether a starts with a known string; <var>IsStartOf</var> can be conveniently used to check whether a string is an abbreviation of a known string.
+
 
 
===Syntax terms===
 
===Syntax terms===
 
<table class="syntaxTable">
 
<table class="syntaxTable">
 
<tr><th>%boolean</th>
 
<tr><th>%boolean</th>
<td>The <var>Boolean</var> result is <var>True</var> if <var class="term">abbreviation</var> is the same as the initial substring, whose length is the length of <var class="term">abbreviation</var>, of <var class="term">longerString</var>.
+
<td>The <var>[[Boolean enumeration|Boolean]]</var> result is <var>True</var> if <var class="term">abbreviation</var> is the same as the initial substring, whose length is the length of <var class="term">abbreviation</var>, of <var class="term">longerString</var>.
  
 
In addition, for <var>IsStartOf</var>, the length of the method object <var class="term">abbreviation</var> is at least the value of the <var>MinLength</var> argument.
 
In addition, for <var>IsStartOf</var>, the length of the method object <var class="term">abbreviation</var> is at least the value of the <var>MinLength</var> argument.
Line 16: Line 17:
 
<ul><li><var class="term">longerString</var>, whose intial characters are examined, for <var>StartsWith</var>
 
<ul><li><var class="term">longerString</var>, whose intial characters are examined, for <var>StartsWith</var>
 
<li><var class="term">abbreviation</var>, for <var>IsStartOf</var></ul></td></tr>
 
<li><var class="term">abbreviation</var>, for <var>IsStartOf</var></ul></td></tr>
<tr><th>abbreviation</th><td>A string which is examined to see if it is an abbreviation (i.e., an initial substring) of <var class="term">longerString</var>.</td></tr>
+
 
 +
<tr><th>abbreviation</th><td>A string which is examined to see if it is an abbreviation (that is, an initial substring) of <var class="term">longerString</var>.</td></tr>
 +
 
 
<tr><th>longerString</th>
 
<tr><th>longerString</th>
 
<td>A string which is examined to see if the <var class="term">abbreviation</var> is an abbreviation of it.</td></tr>
 
<td>A string which is examined to see if the <var class="term">abbreviation</var> is an abbreviation of it.</td></tr>
 +
 
<tr><th><var>MinLength</var></th>
 
<tr><th><var>MinLength</var></th>
<td>This name-required argument is a non-negative number, specifying the minimum length of <var class="term">abbreviation</var> to be considered an abbreviation of <var class="term">longerString</var>. Note that if this is 0, then the null string is an abbreviation of any value of the <var class="term">longerString</var> argument; if this is non-0, then the null string is never an abbreviation.
+
<td>This name-required argument is a non-negative number, specifying the minimum length of <var class="term">abbreviation</var> to be considered an abbreviation of <var class="term">longerString</var>. Note that if this is 0, then the null string is an abbreviation of any value of the <var class="term">longerString</var> argument; if this is non-0, then the null string is never an abbreviation.
  
 
This argument is only used by <var>IsStartOf</var>; for <var>StartsWith</var>, <var>MinLength</var> is effectively 0.
 
This argument is only used by <var>IsStartOf</var>; for <var>StartsWith</var>, <var>MinLength</var> is effectively 0.
Line 27: Line 31:
  
 
==Examples==
 
==Examples==
===Checking whether string starts with some literal===
+
====Checking whether string starts with some literal====
 
Hopefully the following fragment is self-evident:
 
Hopefully the following fragment is self-evident:
 
<p class="code">if %name:toUpper:startsWith('DAV') then
 
<p class="code">if %name:toUpper:startsWith('DAV') then
Line 33: Line 37:
 
</p>
 
</p>
  
===Determining if option is valid abbreviation===
+
====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 <var>MinLength</var> argument; there may be overlap in the initial substrings of the longer terms.  Consider the following fragment:
 
A common task is checking user input for a valid abbreviation for one of several longer terms.  This is one motivation for the <var>MinLength</var> argument; there may be overlap in the initial substrings of the longer terms.  Consider the following fragment:
 
<p class="code">%opt = %(system):[[Arguments (System function)|arguments]]:toUpper
 
<p class="code">%opt = %(system):[[Arguments (System function)|arguments]]:toUpper
Line 44: Line 48:
 
If the argument to this proc is <code>max</code>, that would not distinguish it between <code>maxAmount</code> and <code>maxTime</code>; hence the <var>MinLength</var> argument value of 5 is used to enforce that at least <code>maxAm</code> or <code>maxTi</code> is entered (a value of 4 would also have disambiguated the abbreviations in this case).
 
If the argument to this proc is <code>max</code>, that would not distinguish it between <code>maxAmount</code> and <code>maxTime</code>; hence the <var>MinLength</var> argument value of 5 is used to enforce that at least <code>maxAm</code> or <code>maxTi</code> is entered (a value of 4 would also have disambiguated the abbreviations in this case).
  
===Several single-line examples===
+
====Several single-line examples====
 
The following fragment:
 
The following fragment:
 
<p class="code">PrintText {~= 'a':IsStartOf('abc', MinLength=1) }
 
<p class="code">PrintText {~= 'a':IsStartOf('abc', MinLength=1) }

Revision as of 01:47, 24 February 2012

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

[Introduced in Sirius Mods 7.9]

StartsWith can be conveniently used to check whether a starts with a known string; IsStartOf can be conveniently used to check whether a string is an abbreviation of a known string.

Syntax

%boolean = string:StartsWith( abbreviation)

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

Syntax terms

%boolean The Boolean result is True if abbreviation is the same as the initial substring, whose length is the length of abbreviation, of longerString.

In addition, for IsStartOf, the length of the method object abbreviation is at least the value of the MinLength argument.

string The method object string. Depending upon whether the StartsWith or IsStartOf method is being used, string may be either the:
  • longerString, whose intial characters are examined, for StartsWith
  • abbreviation, for IsStartOf
abbreviationA string which is examined to see if it is an abbreviation (that is, an initial substring) of longerString.
longerString A string which is examined to see if the abbreviation is an abbreviation of it.
MinLength This name-required argument is a non-negative number, specifying the minimum length of abbreviation 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.

This argument is only used by IsStartOf; for StartsWith, MinLength is effectively 0.

Examples

Checking whether string starts with some literal

Hopefully the following fragment is self-evident:

if %name:toUpper:startsWith('DAV') then print 'Name is probably Dave or David'

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