/usr/share/doc/libghc-text-icu-doc/html/Data-Text-ICU-Convert.html

<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"><html xmlns="http://www.w3.org/1999/xhtml"><head><meta http-equiv="Content-Type" content="text/html; charset=UTF-8" /><title>Data.Text.ICU.Convert</title><link href="ocean.css" rel="stylesheet" type="text/css" title="Ocean" /><script src="haddock-util.js" type="text/javascript"></script><script type="text/javascript">//<![CDATA[
window.onload = function () {pageLoad();setSynopsis("mini_Data-Text-ICU-Convert.html");};
//]]>
</script></head><body><div id="package-header"><ul class="links" id="page-menu"><li><a href="src/Data-Text-ICU-Convert.html">Source</a></li><li><a href="index.html">Contents</a></li><li><a href="doc-index.html">Index</a></li></ul><p class="caption">text-icu-0.6.3.4: Bindings to the ICU library</p></div><div id="content"><div id="module-header"><table class="info"><tr><th>Portability</th><td>GHC</td></tr><tr><th>Stability</th><td>experimental</td></tr><tr><th>Maintainer</th><td>bos@serpentine.com</td></tr><tr><th>Safe Haskell</th><td>Safe-Infered</td></tr></table><p class="caption">Data.Text.ICU.Convert</p></div><div id="table-of-contents"><p class="caption">Contents</p><ul><li><a href="#g:1">Character set conversion
</a><ul><li><a href="#g:2">Basic functions
</a></li><li><a href="#g:3">Converter metadata
</a></li></ul></li><li><a href="#g:4">Functions for controlling global behavior
</a></li><li><a href="#g:5">Miscellaneous functions
</a></li><li><a href="#g:6">Metadata
</a></li></ul></div><div id="description"><p class="caption">Description</p><div class="doc"><p>Character set conversion functions for Unicode, implemented as
 bindings to the International Components for Unicode (ICU)
 libraries.
</p></div></div><div id="synopsis"><p id="control.syn" class="caption expander" onclick="toggleSection('syn')">Synopsis</p><ul id="section.syn" class="hide" onclick="toggleSection('syn')"><li class="src short"><span class="keyword">data</span>  <a href="#t:Converter">Converter</a> </li><li class="src short"><a href="#v:open">open</a> :: <a href="/usr/share/doc/ghc-doc/html/libraries/base-4.5.0.0/Data-String.html#t:String">String</a> -&gt; <a href="/usr/share/doc/ghc-doc/html/libraries/base-4.5.0.0/Data-Maybe.html#t:Maybe">Maybe</a> <a href="/usr/share/doc/ghc-doc/html/libraries/base-4.5.0.0/Data-Bool.html#t:Bool">Bool</a> -&gt; <a href="/usr/share/doc/ghc-doc/html/libraries/base-4.5.0.0/System-IO.html#t:IO">IO</a> <a href="Data-Text-ICU-Convert.html#t:Converter">Converter</a></li><li class="src short"><a href="#v:fromUnicode">fromUnicode</a> :: <a href="Data-Text-ICU-Convert.html#t:Converter">Converter</a> -&gt; <a href="/usr/share/doc/libghc-text-doc/html/Data-Text-Internal.html#t:Text">Text</a> -&gt; <a href="/usr/share/doc/ghc-doc/html/libraries/bytestring-0.9.2.1/Data-ByteString.html#t:ByteString">ByteString</a></li><li class="src short"><a href="#v:toUnicode">toUnicode</a> :: <a href="Data-Text-ICU-Convert.html#t:Converter">Converter</a> -&gt; <a href="/usr/share/doc/ghc-doc/html/libraries/bytestring-0.9.2.1/Data-ByteString.html#t:ByteString">ByteString</a> -&gt; <a href="/usr/share/doc/libghc-text-doc/html/Data-Text-Internal.html#t:Text">Text</a></li><li class="src short"><a href="#v:getName">getName</a> :: <a href="Data-Text-ICU-Convert.html#t:Converter">Converter</a> -&gt; <a href="/usr/share/doc/ghc-doc/html/libraries/base-4.5.0.0/Data-String.html#t:String">String</a></li><li class="src short"><a href="#v:usesFallback">usesFallback</a> :: <a href="Data-Text-ICU-Convert.html#t:Converter">Converter</a> -&gt; <a href="/usr/share/doc/ghc-doc/html/libraries/base-4.5.0.0/Data-Bool.html#t:Bool">Bool</a></li><li class="src short"><a href="#v:isAmbiguous">isAmbiguous</a> :: <a href="Data-Text-ICU-Convert.html#t:Converter">Converter</a> -&gt; <a href="/usr/share/doc/ghc-doc/html/libraries/base-4.5.0.0/Data-Bool.html#t:Bool">Bool</a></li><li class="src short"><a href="#v:getDefaultName">getDefaultName</a> :: <a href="/usr/share/doc/ghc-doc/html/libraries/base-4.5.0.0/System-IO.html#t:IO">IO</a> <a href="/usr/share/doc/ghc-doc/html/libraries/base-4.5.0.0/Data-String.html#t:String">String</a></li><li class="src short"><a href="#v:setDefaultName">setDefaultName</a> :: <a href="/usr/share/doc/ghc-doc/html/libraries/base-4.5.0.0/Data-String.html#t:String">String</a> -&gt; <a href="/usr/share/doc/ghc-doc/html/libraries/base-4.5.0.0/System-IO.html#t:IO">IO</a> <a href="/usr/share/doc/ghc-doc/html/libraries/ghc-prim-0.2.0.0/GHC-Tuple.html#t:-40--41-">()</a></li><li class="src short"><a href="#v:compareNames">compareNames</a> :: <a href="/usr/share/doc/ghc-doc/html/libraries/base-4.5.0.0/Data-String.html#t:String">String</a> -&gt; <a href="/usr/share/doc/ghc-doc/html/libraries/base-4.5.0.0/Data-String.html#t:String">String</a> -&gt; <a href="/usr/share/doc/ghc-doc/html/libraries/base-4.5.0.0/Data-Ord.html#t:Ordering">Ordering</a></li><li class="src short"><a href="#v:aliases">aliases</a> :: <a href="/usr/share/doc/ghc-doc/html/libraries/base-4.5.0.0/Data-String.html#t:String">String</a> -&gt; [<a href="/usr/share/doc/ghc-doc/html/libraries/base-4.5.0.0/Data-String.html#t:String">String</a>]</li><li class="src short"><a href="#v:converterNames">converterNames</a> :: [<a href="/usr/share/doc/ghc-doc/html/libraries/base-4.5.0.0/Data-String.html#t:String">String</a>]</li><li class="src short"><a href="#v:standardNames">standardNames</a> :: [<a href="/usr/share/doc/ghc-doc/html/libraries/base-4.5.0.0/Data-String.html#t:String">String</a>]</li></ul></div><div id="interface"><h1 id="g:1">Character set conversion
</h1><div class="top"><p class="src"><span class="keyword">data</span>  <a name="t:Converter" class="def">Converter</a>  <a href="src/Data-Text-ICU-Convert-Internal.html#Converter" class="link">Source</a></p><div class="doc"><p>Character set converter type.  <em>Note</em>: this structure is not
 thread safe. It is <em>not</em> safe to use value of this type
 simultaneously from multiple threads.
</p></div><div class="subs instances"><p id="control.i:Converter" class="caption collapser" onclick="toggleSection('i:Converter')">Instances</p><div id="section.i:Converter" class="show"><table><tr><td class="src"><a href="/usr/share/doc/ghc-doc/html/libraries/base-4.5.0.0/Data-Eq.html#t:Eq">Eq</a> <a href="Data-Text-ICU-Convert.html#t:Converter">Converter</a></td><td class="doc empty">&nbsp;</td></tr><tr><td class="src"><a href="/usr/share/doc/ghc-doc/html/libraries/base-4.5.0.0/Text-Show.html#t:Show">Show</a> <a href="Data-Text-ICU-Convert.html#t:Converter">Converter</a></td><td class="doc empty">&nbsp;</td></tr><tr><td class="src"><a href="/usr/share/doc/ghc-doc/html/libraries/base-4.5.0.0/Data-Typeable-Internal.html#t:Typeable">Typeable</a> <a href="Data-Text-ICU-Convert.html#t:Converter">Converter</a></td><td class="doc empty">&nbsp;</td></tr></table></div></div></div><h2 id="g:2">Basic functions
</h2><div class="top"><p class="src"><a name="v:open" class="def">open</a><a href="src/Data-Text-ICU-Convert.html#open" class="link">Source</a></p><div class="subs arguments"><p class="caption">Arguments</p><table><tr><td class="src">:: <a href="/usr/share/doc/ghc-doc/html/libraries/base-4.5.0.0/Data-String.html#t:String">String</a></td><td class="doc"><p>Name of the converter to use.
</p></td></tr><tr><td class="src">-&gt; <a href="/usr/share/doc/ghc-doc/html/libraries/base-4.5.0.0/Data-Maybe.html#t:Maybe">Maybe</a> <a href="/usr/share/doc/ghc-doc/html/libraries/base-4.5.0.0/Data-Bool.html#t:Bool">Bool</a></td><td class="doc"><p>Whether to use fallback mappings
 (see <code><a href="Data-Text-ICU-Convert.html#v:usesFallback">usesFallback</a></code> for details).
</p></td></tr><tr><td class="src">-&gt; <a href="/usr/share/doc/ghc-doc/html/libraries/base-4.5.0.0/System-IO.html#t:IO">IO</a> <a href="Data-Text-ICU-Convert.html#t:Converter">Converter</a></td><td class="doc empty">&nbsp;</td></tr></table></div><div class="doc"><p>Create a <code><a href="Data-Text-ICU-Convert.html#t:Converter">Converter</a></code> with the name of a coded character set
 specified as a string.  The actual name will be resolved with the
 alias file using a case-insensitive string comparison that ignores
 leading zeroes and all non-alphanumeric characters.  E.g., the
 names <code>&quot;UTF8&quot;</code>, <code>&quot;utf-8&quot;</code>, <code>&quot;u*T@f08&quot;</code> and <code>&quot;Utf 8&quot;</code> are
 all equivalent (see also <code><a href="Data-Text-ICU-Convert.html#v:compareNames">compareNames</a></code>).  If an empty string is
 passed for the converter name, it will create one with the
 <code><a href="Data-Text-ICU-Convert.html#v:getDefaultName">getDefaultName</a></code> return value.
</p><p>A converter name may contain options like a locale specification to
 control the specific behavior of the newly instantiated converter.
 The meaning of the options depends on the particular converter.  If
 an option is not defined for or recognized by a given converter,
 then it is ignored.
</p><p>Options are appended to the converter name string, with a comma
 between the name and the first option and also between adjacent
 options.
</p><p>If the alias is ambiguous, then the preferred converter is used.
</p><p>The conversion behavior and names can vary between platforms. ICU
 may convert some characters differently from other
 platforms. Details on this topic are in the ICU User's Guide at
 <a href="http://icu-project.org/userguide/conversion.html">http://icu-project.org/userguide/conversion.html</a>. Aliases
 starting with a <code>&quot;cp&quot;</code> prefix have no specific meaning other than
 its an alias starting with the letters <code>&quot;cp&quot;</code>. Please do not
 associate any meaning to these aliases.
</p></div></div><div class="top"><p class="src"><a name="v:fromUnicode" class="def">fromUnicode</a> :: <a href="Data-Text-ICU-Convert.html#t:Converter">Converter</a> -&gt; <a href="/usr/share/doc/libghc-text-doc/html/Data-Text-Internal.html#t:Text">Text</a> -&gt; <a href="/usr/share/doc/ghc-doc/html/libraries/bytestring-0.9.2.1/Data-ByteString.html#t:ByteString">ByteString</a><a href="src/Data-Text-ICU-Convert.html#fromUnicode" class="link">Source</a></p><div class="doc"><p>Convert the Unicode string into a codepage string using the given
 converter.
</p></div></div><div class="top"><p class="src"><a name="v:toUnicode" class="def">toUnicode</a> :: <a href="Data-Text-ICU-Convert.html#t:Converter">Converter</a> -&gt; <a href="/usr/share/doc/ghc-doc/html/libraries/bytestring-0.9.2.1/Data-ByteString.html#t:ByteString">ByteString</a> -&gt; <a href="/usr/share/doc/libghc-text-doc/html/Data-Text-Internal.html#t:Text">Text</a><a href="src/Data-Text-ICU-Convert.html#toUnicode" class="link">Source</a></p><div class="doc"><p>Convert the codepage string into a Unicode string using the given
 converter.
</p></div></div><h2 id="g:3">Converter metadata
</h2><div class="top"><p class="src"><a name="v:getName" class="def">getName</a> :: <a href="Data-Text-ICU-Convert.html#t:Converter">Converter</a> -&gt; <a href="/usr/share/doc/ghc-doc/html/libraries/base-4.5.0.0/Data-String.html#t:String">String</a><a href="src/Data-Text-ICU-Convert-Internal.html#getName" class="link">Source</a></p><div class="doc"><p>Gets the internal, canonical name of the converter.
</p></div></div><div class="top"><p class="src"><a name="v:usesFallback" class="def">usesFallback</a> :: <a href="Data-Text-ICU-Convert.html#t:Converter">Converter</a> -&gt; <a href="/usr/share/doc/ghc-doc/html/libraries/base-4.5.0.0/Data-Bool.html#t:Bool">Bool</a><a href="src/Data-Text-ICU-Convert.html#usesFallback" class="link">Source</a></p><div class="doc"><p>Determines whether the converter uses fallback mappings or not.
 This flag has restrictions.  Regardless of this flag, the converter
 will always use fallbacks from Unicode Private Use code points, as
 well as reverse fallbacks (to Unicode).  For details see &quot;.ucm
 File Format&quot; in the Conversion Data chapter of the ICU User Guide:
 <a href="http://www.icu-project.org/userguide/conversion-data.html#ucmformat">http://www.icu-project.org/userguide/conversion-data.html#ucmformat</a>
</p></div></div><div class="top"><p class="src"><a name="v:isAmbiguous" class="def">isAmbiguous</a> :: <a href="Data-Text-ICU-Convert.html#t:Converter">Converter</a> -&gt; <a href="/usr/share/doc/ghc-doc/html/libraries/base-4.5.0.0/Data-Bool.html#t:Bool">Bool</a><a href="src/Data-Text-ICU-Convert.html#isAmbiguous" class="link">Source</a></p><div class="doc"><p>Indicates whether the converter contains ambiguous mappings of
 the same character or not.
</p></div></div><h1 id="g:4">Functions for controlling global behavior
</h1><div class="top"><p class="src"><a name="v:getDefaultName" class="def">getDefaultName</a> :: <a href="/usr/share/doc/ghc-doc/html/libraries/base-4.5.0.0/System-IO.html#t:IO">IO</a> <a href="/usr/share/doc/ghc-doc/html/libraries/base-4.5.0.0/Data-String.html#t:String">String</a><a href="src/Data-Text-ICU-Convert.html#getDefaultName" class="link">Source</a></p><div class="doc"><p>Returns the current default converter name. If you want to <code><a href="Data-Text-ICU-Convert.html#v:open">open</a></code>
 a default converter, you do not need to use this function.  It is
 faster to pass the empty string to <code><a href="Data-Text-ICU-Convert.html#v:open">open</a></code> the default converter.
</p></div></div><div class="top"><p class="src"><a name="v:setDefaultName" class="def">setDefaultName</a> :: <a href="/usr/share/doc/ghc-doc/html/libraries/base-4.5.0.0/Data-String.html#t:String">String</a> -&gt; <a href="/usr/share/doc/ghc-doc/html/libraries/base-4.5.0.0/System-IO.html#t:IO">IO</a> <a href="/usr/share/doc/ghc-doc/html/libraries/ghc-prim-0.2.0.0/GHC-Tuple.html#t:-40--41-">()</a><a href="src/Data-Text-ICU-Convert.html#setDefaultName" class="link">Source</a></p><div class="doc"><p>Sets the current default converter name. If this function needs
 to be called, it should be called during application
 initialization. Most of the time, the results from <code><a href="Data-Text-ICU-Convert.html#v:getDefaultName">getDefaultName</a></code>
 or <code><a href="Data-Text-ICU-Convert.html#v:open">open</a></code> with an empty string argument is sufficient for your
 application.
</p><p><em>Note</em>: this function is not thread safe. <em>Do not</em> call this
 function when <em>any</em> ICU function is being used from more than one
 thread!
</p></div></div><h1 id="g:5">Miscellaneous functions
</h1><div class="top"><p class="src"><a name="v:compareNames" class="def">compareNames</a> :: <a href="/usr/share/doc/ghc-doc/html/libraries/base-4.5.0.0/Data-String.html#t:String">String</a> -&gt; <a href="/usr/share/doc/ghc-doc/html/libraries/base-4.5.0.0/Data-String.html#t:String">String</a> -&gt; <a href="/usr/share/doc/ghc-doc/html/libraries/base-4.5.0.0/Data-Ord.html#t:Ordering">Ordering</a><a href="src/Data-Text-ICU-Convert.html#compareNames" class="link">Source</a></p><div class="doc"><p>Do a fuzzy compare of two converter/alias names.  The comparison
 is case-insensitive, ignores leading zeroes if they are not
 followed by further digits, and ignores all but letters and digits.
 Thus the strings <code>&quot;UTF-8&quot;</code>, <code>&quot;utf_8&quot;</code>, <code>&quot;u*T@f08&quot;</code> and
 <code>&quot;Utf 8&quot;</code> are exactly equivalent.  See section 1.4, Charset Alias
 Matching in Unicode Technical Standard #22 at
 <a href="http://www.unicode.org/reports/tr22/">http://www.unicode.org/reports/tr22/</a>
</p></div></div><div class="top"><p class="src"><a name="v:aliases" class="def">aliases</a> :: <a href="/usr/share/doc/ghc-doc/html/libraries/base-4.5.0.0/Data-String.html#t:String">String</a> -&gt; [<a href="/usr/share/doc/ghc-doc/html/libraries/base-4.5.0.0/Data-String.html#t:String">String</a>]<a href="src/Data-Text-ICU-Convert.html#aliases" class="link">Source</a></p><div class="doc"><p>Return the aliases for a given converter or alias name.
</p></div></div><h1 id="g:6">Metadata
</h1><div class="top"><p class="src"><a name="v:converterNames" class="def">converterNames</a> :: [<a href="/usr/share/doc/ghc-doc/html/libraries/base-4.5.0.0/Data-String.html#t:String">String</a>]<a href="src/Data-Text-ICU-Convert.html#converterNames" class="link">Source</a></p><div class="doc"><p>A list of the canonical names of all available converters.
</p></div></div><div class="top"><p class="src"><a name="v:standardNames" class="def">standardNames</a> :: [<a href="/usr/share/doc/ghc-doc/html/libraries/base-4.5.0.0/Data-String.html#t:String">String</a>]<a href="src/Data-Text-ICU-Convert.html#standardNames" class="link">Source</a></p><div class="doc"><p>The list of supported standard names.
</p></div></div></div></div><div id="footer"><p>Produced by <a href="http://www.haskell.org/haddock/">Haddock</a> version 2.10.0</p></div></body></html>
libghc-text-icu-doc 0.6.3.4-2 / usr / share / doc / libghc-text-icu-doc / html / Data-Text-ICU-Convert.html
