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

From m204wiki
Jump to navigation Jump to search
m
Line 7: Line 7:
 
<table class="syntaxTable">
 
<table class="syntaxTable">
 
<tr><th>%boolean</th>
 
<tr><th>%boolean</th>
<td>The <var>Boolean</var> result of <var>IsStartOf</var> is <var>True</var> if:<ul><li>The length of the method object <var class="term">string</var> is at least the value of the <var>MinLength</var> argument<br><b>and</b>:<li>the method object <var class="term">string</var> is the same as the initial substring, whose length is the length of <var class="term">string</var>, of the <var class="term">longerString</var> argument.</ul>If either of the above conditions does not hold, the result is <var>False</var>.</td></tr>
+
<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>.
 +
 
 +
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.
 +
</td></tr>
 
<tr><th>string</th>
 
<tr><th>string</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>
+
<td>The method object string.  Depending upon whether the <var>StartsWith</var> or <var>IsStartOf</var> method is being used, <var class="term">string</var> may be either the:
 +
<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>
 +
<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>longerString</th>
 
<tr><th>longerString</th>
<td>A string which is examined to see if the method object <var class="term">string</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 the method object <var class="term">string</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></tr>
+
<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.
 +
</td></tr>
 
</table>
 
</table>
  

Revision as of 17:16, 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 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 (i.e., 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

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