UnicodeUnspace (Unicode function): Difference between revisions

From m204wiki
Jump to navigation Jump to search
mNo edit summary
mNo edit summary
 
(8 intermediate revisions by 2 users not shown)
Line 1: Line 1:
{{Template:Unicode:UnicodeUnspace subtitle}}
{{Template:Unicode:UnicodeUnspace subtitle}}


The <var>UnicodeUnspace</var> [[Intrinsic classes|intrinsic]] function removes the whitespace characters from the <var>[[Unicode class|Unicode]]</var> string method object and it returns the resulting string. Options are available to:<ul><li>
The <var>UnicodeUnspace</var> [[Intrinsic classes|intrinsic]] function removes the whitespace characters from the <var>[[Unicode class|Unicode]]</var> string method object, and it returns the resulting string. Options are available to:
Define which character or characters are to be interpreted as whitespace<li>Remove leading whitespace, trailing whitespace, both or neither;<li>Collapse to a single whitespace character any sequences of non-leading, non-trailing whitespace</ul>
<ul>
<li>Define which character or characters are to be interpreted as whitespace
<li>Remove leading whitespace, trailing whitespace, both, or neither
<li>Collapse to a single whitespace character any sequences of non-leading, non-trailing whitespace
</ul>
 
==Syntax==
==Syntax==
{{Template:Unicode:UnicodeUnspace syntax}}
{{Template:Unicode:UnicodeUnspace syntax}}
===Syntax terms===
===Syntax terms===
<table class="syntaxTable">
<table class="syntaxTable">
<tr><th>%outUnicode</th><td>A <var>Unicode</var> variable to receive the result of the <var>UnicodeUnspace</var> function.</td></tr>
<tr><th>%outUnicode</th><td>A <var>Unicode</var> variable to receive the result of the <var>UnicodeUnspace</var> function.</td></tr>
<tr><th>unicode</th>
<tr><th>unicode</th>
<td>The method object <var>Unicode</var> string.</td></tr>
<td>The method object <var>Unicode</var> string.</td></tr>
<tr><th><var>Spaces</var></th>
<tr><th><var>Spaces</var></th>
<td><var class="term">Spaces</var> is an optional, [[Methods#Named parameters|name required]], parameter, which is a <var>Unicode</var> string that specifies the set of characters considered to be whitespace. The default set is the blank space (<code>' '</code>) character.  If you specify multiple <var class="term">Spaces</var> characters, the first character is the replacement space character: a single one of these is substituted for each sequence (which may be one) of non-leading, non-trailing <var class="term">Spaces</var> characters in the method object string.</td></tr>
<td><var>Spaces</var> is an optional, [[Notation conventions for methods#Named parameters|name required]], parameter that is a <var>Unicode</var> string that specifies the set of characters considered to be whitespace. The default set is the blank space (<tt>' '</tt>) character.</td></tr>
 
<tr><th><var>Leading</var></th>
<tr><th><var>Leading</var></th>
<td><var class="term">Leading</var> is an optional, but <var class="term">Name-Required</var>, parameter, which is a <var>[[Enumerations#Using_Boolean_enumerations|"Boolean Enumeration"]]</var> value that specifies whether to strip all leading whitespace characters. The default is <code>True</code>, strip leading whitespace.</td></tr>
<td><var>Leading</var> is an optional, name required, parameter that is a <var>[[Enumerations#Using_Boolean_enumerations|Boolean]]</var> value that specifies whether to strip all leading whitespace characters. The default is <var>True</var>, strip leading whitespace.</td></tr>
 
<tr><th><var>Trailing</var></th>
<tr><th><var>Trailing</var></th>
<td><var class="term">Trailing</var> is an optional, but <var class="term">Name-Required</var>, parameter, which is a <var>[[Enumerations#Using_Boolean_enumerations|"Boolean Enumeration"]]</var> value that specifies whether to strip all trailing whitespace characters. The default is <code>True</code>, strip trailing whitespace.</td></tr>
<td><var>Trailing</var> is an optional, name required, parameter that is a <var>Boolean</var> value that specifies whether to strip all trailing whitespace characters. The default is <var>True</var>, strip trailing whitespace.</td></tr>
 
<tr><th><var>Compress</var></th>
<tr><th><var>Compress</var></th>
<td><var class="term">Compress</var> is an optional, but <var class="term">Name-Required</var>, parameter, which is a <var>[[Enumerations#Using_Boolean_enumerations|"Boolean Enumeration"]]</var> value that specifies whether to collapse each sequence of spaces to a single space. The default is <code>True</code>, collapse such sequences.</td></tr>
<td><var>Compress</var> is an optional, name required, parameter that is a <var>Boolean</var> value that specifies whether to collapse each sequence of spaces to a single space (the replacement space is the first character in the <var>Spaces</var> argument). The default is <var>True</var>, collapse such sequences.</td></tr>
</table>
</table>
==Usage notes==
==Usage notes==
<ul>
<ul>
<li>Duplicate <var class="term">Spaces</var> characters are tolerated and do not affect the result.
<li>Duplicate <var>Spaces</var> characters are tolerated and do not affect the result.
</ul>
</ul>
==Examples==
==Examples==
The following fragment returns the contents of the Unicode variable <code>%in</code> with leading and trailing whitespace removed and with intermediate sequences of whitespace replaced by a single space character, where <i>whitespace</i> is a sequence of space, tab, linefeed, and carriage return characters:
<p class=code>%out = %in:unicodeUnspace(spaces='&amp;#x20;&amp;#x09;&amp;#x0a;&amp;#x0d;':u)</p>
==See also==
==See also==
{{Template:Unicode:UnicodeUnspace footer}}
{{Template:Unicode:UnicodeUnspace footer}}

Latest revision as of 20:16, 6 November 2012

Remove whitespace characters from the string (Unicode class)

[Introduced in Sirius Mods 8.0]


The UnicodeUnspace intrinsic function removes the whitespace characters from the Unicode string method object, and it returns the resulting string. Options are available to:

  • Define which character or characters are to be interpreted as whitespace
  • Remove leading whitespace, trailing whitespace, both, or neither
  • Collapse to a single whitespace character any sequences of non-leading, non-trailing whitespace

Syntax

%outUnicode = unicode:UnicodeUnspace[( [Spaces= string], [Leading= boolean], - [Trailing= boolean], - [Compress= boolean])]

Syntax terms

%outUnicodeA Unicode variable to receive the result of the UnicodeUnspace function.
unicode The method object Unicode string.
Spaces Spaces is an optional, name required, parameter that is a Unicode string that specifies the set of characters considered to be whitespace. The default set is the blank space (' ') character.
Leading Leading is an optional, name required, parameter that is a Boolean value that specifies whether to strip all leading whitespace characters. The default is True, strip leading whitespace.
Trailing Trailing is an optional, name required, parameter that is a Boolean value that specifies whether to strip all trailing whitespace characters. The default is True, strip trailing whitespace.
Compress Compress is an optional, name required, parameter that is a Boolean value that specifies whether to collapse each sequence of spaces to a single space (the replacement space is the first character in the Spaces argument). The default is True, collapse such sequences.

Usage notes

  • Duplicate Spaces characters are tolerated and do not affect the result.

Examples

The following fragment returns the contents of the Unicode variable %in with leading and trailing whitespace removed and with intermediate sequences of whitespace replaced by a single space character, where whitespace is a sequence of space, tab, linefeed, and carriage return characters:

%out = %in:unicodeUnspace(spaces='&#x20;&#x09;&#x0a;&#x0d;':u)

See also