EbcdicToUnicode (String function): Difference between revisions

From m204wiki
Jump to navigation Jump to search
mNo edit summary
mNo edit summary
 
(12 intermediate revisions by 4 users not shown)
Line 1: Line 1:
{{Template:String:EbcdicToUnicode subtitle}}
{{Template:String:EbcdicToUnicode subtitle}}


<var>EbcdicToUnicode</var> is an [[Intrinsic classes|intrinsic]] function that converts an EBCDIC string to <var>Unicode</var> using the current <var>[[Unicode]]</var> tables.  Options are available to control:<ul><li>the conversion of XML style hexadecimal character references, XHTML entity references, and ''''&amp;amp;'''' references to the represented <var>Unicode</var> character;<li>how to handle untranslatable EBCDIC characters</ul>
<var>EbcdicToUnicode</var> is an [[Intrinsic classes|intrinsic]] function that converts an EBCDIC string to Unicode using the current [[Unicode]] tables.  Options are available to control:<ul><li>The conversion to the represented Unicode character of XML-style hexadecimal character references, XHTML entity references, and <code>&amp;amp;</code> references<li>How to handle untranslatable EBCDIC characters</ul>


==Syntax==
==Syntax==
Line 8: Line 8:
<table class="syntaxTable">
<table class="syntaxTable">
<tr><th>%unicode</th>
<tr><th>%unicode</th>
<td>A string variable to receive the method object <var class="term">string</var> translated to <var>Unicode</var>.</td></tr>
<td>A <var>Unicode</var> variable to receive the method object <var class="term">string</var> translated to Unicode.</td></tr>
 
<tr><th>string</th>
<tr><th>string</th>
<td>An EBCDIC character string.</td></tr>
<td>An EBCDIC character string.</td></tr>
<tr><th>CharacterDecode</th>
 
<td>The optional, but <var class="term">nameRequired</var>, argument <var class="term">CharacterDecode</var> is a <var>[[Boolean enumeration]]</var>:
<tr><th><var>CharacterDecode</var></th>
<ul><li>If its value is <code>True</code>, an ampersand (<code>&</code>) in the input EBCDIC string is allowed <b><i>only</i></b> as the beginning of one of these types of character or entity reference:<ul><li>The substring ''''&amp;amp;''''. This substring is converted to a single ''''&'''' character.<li>A hexadecimal character reference (for example, the eight characters '&amp;#x201C;' for the <var>Unicode</var> <i>Left double quotation mark</i> <code>'&#x201C;'</code>). The character reference is converted to the referenced character.<li>As of <var class=product>Sirius Mods</var> version 7.6, an XHTML entity reference (for example, the six characters '&amp;copy;' for the <i>copyright</i> character <code>'&copy;'</code>). The entity reference is converted to the referenced character.</ul><p> A decimal character reference (for example, &amp;#172;) is <b><i>not</i></b> allowed.</p>
<td>The optional, [[Notation conventions for methods#Named parameters|name required]], argument <var>CharacterDecode</var> is a <var>[[Boolean enumeration]]</var>:
<li>If its value is <code>False</code>, the default, an ampersand is treated only as a normal character.</ul></td></tr>
<ul>
<tr><th>Untranslatable</th>
<li>If its value is <var>True</var>, an ampersand (<code>&amp;</code>) in the input EBCDIC string is allowed <b>only</b> as the beginning of one of these types of character or entity reference:
<td>The optional, but <var class="term">nameRequired</var>, argument <var class="term">Untranslatable</var> is a single character or a null string that specifies how to handle EBCDIC input characters that are not translatable to <var>Unicode</var>:<ul><li>If the value is a single <var>Unicode</var> character, any untranslatable EBCDIC characters are replaced with that <var>Unicode</var> character.<li>If the value is the null string, any untranslatable EBCDIC characters are removed from the input string.</ul>The <var class="term">Untranslatable</var> parameter is optional. If it is omitted and an EBCDIC character is encountered that is not translatable to <var>Unicode</var>, a <var>[[CharacterTranslationException class|CharacterTranslationException]]</var> exception is thrown.<p>The <var class="term">Untranslatable</var> parameter is available as of <var class="product">Sirius Mods</var> version 7.5. It provides the functionality formerly provided by the <var>EbcdicTranslateNonUnicode</var> and the <var>EbcdicRemoveNonUnicode</var> methods, which are invalid as of <var class="product">Sirius Mods</var> 7.5.</p></td></tr>
<ul>
<li>The substring <code>&amp;amp;</code>. This substring is converted to a single <code>&amp;</code> character.
<li>A hexadecimal character reference (for example, the eight characters <code>&amp;#x201C;</code> for the Unicode <i>Left double quotation mark</i>, &#x201C;). The character reference is converted to the referenced character.
<li>As of <var class=product>Sirius Mods</var> version 7.6, an XHTML entity reference (for example, the six characters <code>&amp;copy;</code> for the <i>copyright</i> character, &copy;). The entity reference is converted to the referenced character.</ul>
<p> A decimal character reference (for example, <code>&amp;#172;</code>) is <b>not</b> allowed.</p>
<li>If its value is <var>False</var>, the default, an ampersand is treated only as a normal character.
</ul></td></tr>
<tr><th><var>Untranslatable</var></th>
<td>The optional, name required, argument <var>Untranslatable</var> is a single character or a null string that specifies how to handle EBCDIC input characters that are not translatable to Unicode:
<ul>
<li>If the value is a single Unicode character, any untranslatable EBCDIC characters are replaced with that Unicode character.
<li>If the value is the null string, any untranslatable EBCDIC characters are removed from the input string.
</ul>
The <var>Untranslatable</var> parameter is optional. If it is omitted and an EBCDIC character is encountered that is not translatable to Unicode, a <var>[[CharacterTranslationException class|CharacterTranslationException]]</var> exception is thrown.<p>The <var>Untranslatable</var> parameter is available as of <var class="product">Sirius Mods</var> version 7.5. It provides the functionality formerly provided by the <var>EbcdicTranslateNonUnicode</var> and the <var>EbcdicRemoveNonUnicode</var> methods, which are invalid as of <var class="product">Sirius Mods</var> 7.5.</p></td></tr>
</table>
</table>


Line 27: Line 41:


==Usage notes==
==Usage notes==
<ul><li>Using <var>EbcdicToUnicode</var> (or the <var>[[U (String function)|U]]</var> function) is necessary if the string you want to convert to <var>Unicode</var> may contain a hexadecimal character reference. Such a reference cannot be meaningfully assigned to a <var>Unicode</var> variable otherwise.
<ul>
<li><var>EbcdicToUnicode</var> is available as of <var class="product">Sirius Mods</var>version 7.3.</ul>
<li>Using <var>EbcdicToUnicode</var> with <code>CharacterDecode=True</code> (or using the <var>[[U (String function)|U]]</var> function) is necessary if the string you want to convert to Unicode may contain a hexadecimal or XHTML entity character reference which you want converted to the corresponding Unicode character.
<li><var>EbcdicToUnicode</var> is available as of <var class="product">Sirius Mods</var> version 7.3.
</ul>


==Examples==
==Examples==
<ol><li>The following fragment shows four calls of <var>EbcdicToUnicode</var>: respectively against translatable EBCDIC characters, a string with a character reference, a string with an entity reference, and a string with an EBCDIC character that cannot be translated to <var>Unicode</var>.  The <var>[[X (String function)|X]]</var> constant function is used in the example.
The following fragment shows four calls of <var>EbcdicToUnicode</var>: respectively against translatable EBCDIC characters, a string with a character reference, a string with an entity reference, and a string with an EBCDIC character that cannot be translated to Unicode.  The <var>[[X (String function)|X]]</var> constant function is used in the example.
<p class="code">%e string Len 20
<p class="code">%e string Len 20
%u unicode
%u unicode
Line 56: Line 72:
003121220032
003121220032
&copy;
&copy;
CANCELLING REQUEST: MSIR.0751: Class STRING, function
CANCELLING REQUEST: MSIR.0751: Class STRING, function EBCDICTOUNICODE: CHARACTER TRANSLATIONEXCEPTION
  EBCDICTOUNICODE: CHARACTER TRANSLATIONEXCEPTION
   exception: EBCDIC character X'FF' without valid translation to Unicode at byte position 2 ...
   exception: EBCDIC character X'FF' without valid
  translation to Unicode at byte position 2 ...
</p><p>
</p><p>
<b><i>Note:</i></b> The initial <code>Print %u</code> statement in the example above is not very revealing because it is equivalent to specifying <code>Print %u:[[UnicodeToEbcdic (Unicode function)|UnicodeToEbcdic]]'&mdash;'</code>; a <var>Unicode</var> string is implicitly converted to EBCDIC when it is used in an EBCDIC context like a Print statement.  <var>[[UnicodeToUtf16 (Unicode function)|UnicodeToUtf16]]</var>, however, converts the Unicode variable to a byte-stream string, which <var>[[StringToHex (String function)|StringToHex]]</var> converts to its hex representation.</p></ol>
<b>Note:</b> The initial <code>Print %u</code> statement in the example above is not very revealing because it is equivalent to specifying <code>Print %u:[[UnicodeToEbcdic (Unicode function)|UnicodeToEbcdic]]</code> &mdash; a <var>Unicode</var> string is implicitly converted to EBCDIC when it is used in an EBCDIC context like a Print statement.  <var>[[UnicodeToUtf16 (Unicode function)|UnicodeToUtf16]]</var>, however, converts the <var>Unicode</var> variable to a byte-stream string, which <var>[[StringToHex (String function)|StringToHex]]</var> converts to its hex representation.</p>


==See also==
==See also==
<ul><li><var>[[U (String function)|U]]</var> is a compile-time-only equivalent of the <var>EbcdicToUnicode</var> method (with CharacterDecode argument implicitly set to <code>True</code>).
<ul><li><var>[[U (String function)|U]]</var> is a compile-time-only equivalent of the <var>EbcdicToUnicode</var> method (with the <var>CharacterDecode</var> argument implicitly set to <code>True</code>).
<li>You can find the list of XHTML entities on the Internet at the following URL:
<li>You can find the list of XHTML entities on the Internet at the following URL:
<p class="code">http://www.w3.org/TR/xhtml1/dtds.html#h-A2
<p class="code">http://www.w3.org/TR/xhtml1/dtds.html#h-A2
</p>
</p>
<li>More information is available about <var>[[Unicode]]</var>.
<li>More information is available about [[Unicode]].
<li>The <var>[[EbcdicToAscii (String function)|EbcdicToAscii]]</var> method converts an EBCDIC string to ASCII.</ul>
<li>The <var>[[EbcdicToAscii (String function)|EbcdicToAscii]]</var> method converts an EBCDIC string to ASCII.</ul>
{{Template:String:EbcdicToUnicode footer}}
{{Template:String:EbcdicToUnicode footer}}

Latest revision as of 19:16, 6 November 2012

Convert EBCDIC string to Unicode (String class)


EbcdicToUnicode is an intrinsic function that converts an EBCDIC string to Unicode using the current Unicode tables. Options are available to control:

  • The conversion to the represented Unicode character of XML-style hexadecimal character references, XHTML entity references, and &amp; references
  • How to handle untranslatable EBCDIC characters

Syntax

%unicode = string:EbcdicToUnicode[( [CharacterDecode= boolean], - [Untranslatable= unicode])] Throws CharacterTranslationException

Syntax terms

%unicode A Unicode variable to receive the method object string translated to Unicode.
string An EBCDIC character string.
CharacterDecode The optional, name required, argument CharacterDecode is a Boolean enumeration:
  • If its value is True, an ampersand (&) in the input EBCDIC string is allowed only as the beginning of one of these types of character or entity reference:
    • The substring &amp;. This substring is converted to a single & character.
    • A hexadecimal character reference (for example, the eight characters &#x201C; for the Unicode Left double quotation mark, “). The character reference is converted to the referenced character.
    • As of Sirius Mods version 7.6, an XHTML entity reference (for example, the six characters &copy; for the copyright character, ©). The entity reference is converted to the referenced character.

    A decimal character reference (for example, &#172;) is not allowed.

  • If its value is False, the default, an ampersand is treated only as a normal character.
Untranslatable The optional, name required, argument Untranslatable is a single character or a null string that specifies how to handle EBCDIC input characters that are not translatable to Unicode:
  • If the value is a single Unicode character, any untranslatable EBCDIC characters are replaced with that Unicode character.
  • If the value is the null string, any untranslatable EBCDIC characters are removed from the input string.
The Untranslatable parameter is optional. If it is omitted and an EBCDIC character is encountered that is not translatable to Unicode, a CharacterTranslationException exception is thrown.

The Untranslatable parameter is available as of Sirius Mods version 7.5. It provides the functionality formerly provided by the EbcdicTranslateNonUnicode and the EbcdicRemoveNonUnicode methods, which are invalid as of Sirius Mods 7.5.

Exceptions

EbcdicToUnicode can throw the following exception:

CharacterTranslationException
If the method encounters a translation problem, properties of the exception object may indicate the location and type of problem.

Usage notes

  • Using EbcdicToUnicode with CharacterDecode=True (or using the U function) is necessary if the string you want to convert to Unicode may contain a hexadecimal or XHTML entity character reference which you want converted to the corresponding Unicode character.
  • EbcdicToUnicode is available as of Sirius Mods version 7.3.

Examples

The following fragment shows four calls of EbcdicToUnicode: respectively against translatable EBCDIC characters, a string with a character reference, a string with an entity reference, and a string with an EBCDIC character that cannot be translated to Unicode. The X constant function is used in the example.

%e string Len 20 %u unicode %e = '12' %u = %e:EbcdicToUnicode Print %u Print %u:UnicodeToUtf16:StringToHex %e = '1&#x2122;2' %u = %e:EbcdicToUnicode(CharacterDecode=True) Print %u:UnicodeToUtf16:StringToHex %e = '&copy;' %u = %e:EbcdicToUnicode(CharacterDecode=True) Print %u %e = 'F1FFF2':X %u = %e:EbcdicToUnicode

The result of the above fragment is:

12 00310032 003121220032 © CANCELLING REQUEST: MSIR.0751: Class STRING, function EBCDICTOUNICODE: CHARACTER TRANSLATIONEXCEPTION exception: EBCDIC character X'FF' without valid translation to Unicode at byte position 2 ...

Note: The initial Print %u statement in the example above is not very revealing because it is equivalent to specifying Print %u:UnicodeToEbcdic — a Unicode string is implicitly converted to EBCDIC when it is used in an EBCDIC context like a Print statement. UnicodeToUtf16, however, converts the Unicode variable to a byte-stream string, which StringToHex converts to its hex representation.

See also

  • U is a compile-time-only equivalent of the EbcdicToUnicode method (with the CharacterDecode argument implicitly set to True).
  • You can find the list of XHTML entities on the Internet at the following URL:

    http://www.w3.org/TR/xhtml1/dtds.html#h-A2

  • More information is available about Unicode.
  • The EbcdicToAscii method converts an EBCDIC string to ASCII.