<!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/xhtml;charset=UTF-8"/>
<title>Barry: iconv.h Source File</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<link href="doxygen.css" rel="stylesheet" type="text/css"/>
</head>
<body>
<!-- Generated by Doxygen 1.6.2-20100208 -->
<div class="navigation" id="top">
<div class="tabs">
<ul>
<li><a href="index.html"><span>Main Page</span></a></li>
<li><a href="modules.html"><span>Modules</span></a></li>
<li><a href="namespaces.html"><span>Namespaces</span></a></li>
<li><a href="annotated.html"><span>Classes</span></a></li>
<li class="current"><a href="files.html"><span>Files</span></a></li>
<li><a href="dirs.html"><span>Directories</span></a></li>
</ul>
</div>
<div class="tabs">
<ul>
<li><a href="files.html"><span>File List</span></a></li>
</ul>
</div>
<div class="navpath"><a class="el" href="dir_65781e9408669bb8d7d9c025fdb5fe86.html">src</a>
</div>
</div>
<div class="contents">
<h1>iconv.h</h1><a href="iconv_8h.html">Go to the documentation of this file.</a><div class="fragment"><pre class="fragment"><a name="l00001"></a>00001 <span class="comment">///</span>
<a name="l00002"></a>00002 <span class="comment"></span><span class="comment">/// \file iconv.h</span>
<a name="l00003"></a>00003 <span class="comment"></span><span class="comment">/// iconv wrapper class, and pluggable interface for records</span>
<a name="l00004"></a>00004 <span class="comment"></span><span class="comment">///</span>
<a name="l00005"></a>00005 <span class="comment"></span>
<a name="l00006"></a>00006 <span class="comment">/*</span>
<a name="l00007"></a>00007 <span class="comment"> Copyright (C) 2008-2010, Net Direct Inc. (http://www.netdirect.ca/)</span>
<a name="l00008"></a>00008 <span class="comment"></span>
<a name="l00009"></a>00009 <span class="comment"> This program is free software; you can redistribute it and/or modify</span>
<a name="l00010"></a>00010 <span class="comment"> it under the terms of the GNU General Public License as published by</span>
<a name="l00011"></a>00011 <span class="comment"> the Free Software Foundation; either version 2 of the License, or</span>
<a name="l00012"></a>00012 <span class="comment"> (at your option) any later version.</span>
<a name="l00013"></a>00013 <span class="comment"></span>
<a name="l00014"></a>00014 <span class="comment"> This program is distributed in the hope that it will be useful,</span>
<a name="l00015"></a>00015 <span class="comment"> but WITHOUT ANY WARRANTY; without even the implied warranty of</span>
<a name="l00016"></a>00016 <span class="comment"> MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.</span>
<a name="l00017"></a>00017 <span class="comment"></span>
<a name="l00018"></a>00018 <span class="comment"> See the GNU General Public License in the COPYING file at the</span>
<a name="l00019"></a>00019 <span class="comment"> root directory of this project for more details.</span>
<a name="l00020"></a>00020 <span class="comment">*/</span>
<a name="l00021"></a>00021
<a name="l00022"></a>00022 <span class="preprocessor">#ifndef __BARRY_ICONV_H__</span>
<a name="l00023"></a>00023 <span class="preprocessor"></span><span class="preprocessor">#define __BARRY_ICONV_H__</span>
<a name="l00024"></a>00024 <span class="preprocessor"></span>
<a name="l00025"></a>00025 <span class="preprocessor">#include "<a class="code" href="dll_8h.html" title="Macros for handling DLL/library API visibility.">dll.h</a>"</span>
<a name="l00026"></a>00026 <span class="preprocessor">#include "<a class="code" href="data_8h.html" title="Class to deal with pre-saved data files.">data.h</a>"</span>
<a name="l00027"></a>00027 <span class="preprocessor">#include <<a class="code" href="iconv_8h.html" title="iconv wrapper class, and pluggable interface for records">iconv.h</a>></span>
<a name="l00028"></a>00028 <span class="preprocessor">#include <string></span>
<a name="l00029"></a>00029
<a name="l00030"></a>00030 <span class="keyword">namespace </span>Barry {
<a name="l00031"></a>00031
<a name="l00032"></a>00032 <span class="keyword">class </span>IConverter;
<a name="l00033"></a>00033
<a name="l00034"></a>00034 <span class="comment">//</span>
<a name="l00035"></a>00035 <span class="comment">// IConvHandle class</span>
<a name="l00036"></a>00036 <span class="comment">//</span><span class="comment"></span>
<a name="l00037"></a>00037 <span class="comment">/// Wrapper class for a two-way iconv_t handle pair. Automatically</span>
<a name="l00038"></a>00038 <span class="comment">/// handles closing in the destructor.</span>
<a name="l00039"></a>00039 <span class="comment"></span><span class="comment">//</span>
<a name="l00040"></a><a class="code" href="classBarry_1_1IConvHandle.html">00040</a> <span class="keyword">class </span>BXEXPORT <a class="code" href="classBarry_1_1IConvHandle.html" title="Wrapper class for a two-way iconv_t handle pair.">IConvHandle</a>
<a name="l00041"></a>00041 {
<a name="l00042"></a>00042 <span class="keyword">friend</span> <span class="keyword">class </span><a class="code" href="classBarry_1_1IConverter.html" title="Main charset conversion class, primarily focused on converting between the Blackberry...">IConverter</a>;
<a name="l00043"></a>00043
<a name="l00044"></a>00044 iconv_t m_handle;
<a name="l00045"></a>00045
<a name="l00046"></a>00046 <span class="keyword">private</span>:
<a name="l00047"></a>00047 <span class="comment">// private constructor, used only by IConverter</span>
<a name="l00048"></a>00048 <a class="code" href="classBarry_1_1IConvHandle.html" title="Wrapper class for a two-way iconv_t handle pair.">IConvHandle</a>(<span class="keyword">const</span> <span class="keywordtype">char</span> *fromcode, <span class="keyword">const</span> <span class="keywordtype">char</span> *tocode);
<a name="l00049"></a>00049
<a name="l00050"></a>00050 <span class="keyword">public</span>:
<a name="l00051"></a>00051 <span class="comment">// custom conversions from any to IConverter's 'tocode'</span>
<a name="l00052"></a>00052 <a class="code" href="classBarry_1_1IConvHandle.html" title="Wrapper class for a two-way iconv_t handle pair.">IConvHandle</a>(<span class="keyword">const</span> <span class="keywordtype">char</span> *fromcode, <span class="keyword">const</span> <a class="code" href="classBarry_1_1IConverter.html" title="Main charset conversion class, primarily focused on converting between the Blackberry...">IConverter</a> &ic);
<a name="l00053"></a>00053 <span class="comment">// custom conversions from IConverter's 'tocode' to any</span>
<a name="l00054"></a>00054 <a class="code" href="classBarry_1_1IConvHandle.html" title="Wrapper class for a two-way iconv_t handle pair.">IConvHandle</a>(<span class="keyword">const</span> <a class="code" href="classBarry_1_1IConverter.html" title="Main charset conversion class, primarily focused on converting between the Blackberry...">IConverter</a> &ic, <span class="keyword">const</span> <span class="keywordtype">char</span> *tocode);
<a name="l00055"></a>00055 ~<a class="code" href="classBarry_1_1IConvHandle.html" title="Wrapper class for a two-way iconv_t handle pair.">IConvHandle</a>();
<a name="l00056"></a>00056 };
<a name="l00057"></a>00057
<a name="l00058"></a>00058 <span class="comment">//</span>
<a name="l00059"></a>00059 <span class="comment">// IConverter</span>
<a name="l00060"></a>00060 <span class="comment">//</span><span class="comment"></span>
<a name="l00061"></a>00061 <span class="comment">/// Main charset conversion class, primarily focused on converting</span>
<a name="l00062"></a>00062 <span class="comment">/// between the Blackberry charset and an application-specified one.</span>
<a name="l00063"></a>00063 <span class="comment">/// Additional conversions are possible through custom IConvHandle,</span>
<a name="l00064"></a>00064 <span class="comment">/// but the goal of this class design is to deal with _one_</span>
<a name="l00065"></a>00065 <span class="comment">/// application defined charset, and provide a means to convert</span>
<a name="l00066"></a>00066 <span class="comment">/// to/from that charset to/from any other charset needed by</span>
<a name="l00067"></a>00067 <span class="comment">/// the Blackberry.</span>
<a name="l00068"></a>00068 <span class="comment">///</span>
<a name="l00069"></a>00069 <span class="comment">/// By default, this class assumes the Blackberry's charset is</span>
<a name="l00070"></a>00070 <span class="comment">/// WINDOWS-1252, but some data, such as SMS message bodies, can have</span>
<a name="l00071"></a>00071 <span class="comment">/// custom charsets as specified by the records. To convert from</span>
<a name="l00072"></a>00072 <span class="comment">/// such a custom charset, use:</span>
<a name="l00073"></a>00073 <span class="comment">///</span>
<a name="l00074"></a>00074 <span class="comment">/// // application sets up IConverter</span>
<a name="l00075"></a>00075 <span class="comment">/// IConverter ic("UTF-8");</span>
<a name="l00076"></a>00076 <span class="comment">///</span>
<a name="l00077"></a>00077 <span class="comment">/// // somewhere in the library, needing to convert</span>
<a name="l00078"></a>00078 <span class="comment">/// // from UCS2 to whatever the application selected</span>
<a name="l00079"></a>00079 <span class="comment">/// IConvHandle ucs2("UCS2", ic);</span>
<a name="l00080"></a>00080 <span class="comment">/// application_string = ic.Convert(ucs2, ucs2_string_data);</span>
<a name="l00081"></a>00081 <span class="comment">///</span>
<a name="l00082"></a>00082 <span class="comment">/// // and to convert back...</span>
<a name="l00083"></a>00083 <span class="comment">/// IConvHandle ucs2_reverse(ic, "UCS2");</span>
<a name="l00084"></a>00084 <span class="comment">/// ucs2_string = ic.Convert(ucs2_reverse, application_string_data);</span>
<a name="l00085"></a>00085 <span class="comment">///</span>
<a name="l00086"></a><a class="code" href="classBarry_1_1IConverter.html">00086</a> <span class="comment"></span><span class="keyword">class </span>BXEXPORT <a class="code" href="classBarry_1_1IConverter.html" title="Main charset conversion class, primarily focused on converting between the Blackberry...">IConverter</a>
<a name="l00087"></a>00087 {
<a name="l00088"></a>00088 <span class="keyword">friend</span> <span class="keyword">class </span><a class="code" href="classBarry_1_1IConvHandle.html" title="Wrapper class for a two-way iconv_t handle pair.">IConvHandle</a>;
<a name="l00089"></a>00089
<a name="l00090"></a>00090 <a class="code" href="classBarry_1_1IConvHandle.html" title="Wrapper class for a two-way iconv_t handle pair.">IConvHandle</a> m_from;
<a name="l00091"></a>00091 <a class="code" href="classBarry_1_1IConvHandle.html" title="Wrapper class for a two-way iconv_t handle pair.">IConvHandle</a> m_to;
<a name="l00092"></a>00092 std::string m_tocode;
<a name="l00093"></a>00093
<a name="l00094"></a>00094 <span class="comment">// internal buffer for fast conversions</span>
<a name="l00095"></a>00095 <span class="keyword">mutable</span> <a class="code" href="classBarry_1_1Data.html">Data</a> m_buffer;
<a name="l00096"></a>00096
<a name="l00097"></a>00097 <span class="keywordtype">bool</span> m_throw_on_conv_err;
<a name="l00098"></a>00098
<a name="l00099"></a>00099 <span class="keyword">private</span>:
<a name="l00100"></a>00100 std::string Convert(iconv_t cd, <span class="keyword">const</span> std::string &str) <span class="keyword">const</span>;
<a name="l00101"></a>00101
<a name="l00102"></a>00102 <span class="keyword">public</span>:<span class="comment"></span>
<a name="l00103"></a>00103 <span class="comment"> /// Always throws ErrnoError if unable to open iconv.</span>
<a name="l00104"></a>00104 <span class="comment"> /// If throw_on_conv_err is true, then string conversion operations</span>
<a name="l00105"></a>00105 <span class="comment"> /// that fail will also throw ErrnoError.</span>
<a name="l00106"></a>00106 <span class="comment"></span> <span class="keyword">explicit</span> <a class="code" href="classBarry_1_1IConverter.html" title="Main charset conversion class, primarily focused on converting between the Blackberry...">IConverter</a>(<span class="keyword">const</span> <span class="keywordtype">char</span> *tocode = <span class="stringliteral">"UTF-8"</span>, <span class="keywordtype">bool</span> throw_on_conv_err = <span class="keyword">false</span>);
<a name="l00107"></a>00107 ~<a class="code" href="classBarry_1_1IConverter.html" title="Main charset conversion class, primarily focused on converting between the Blackberry...">IConverter</a>();
<a name="l00108"></a>00108
<a name="l00109"></a>00109 std::string FromBB(<span class="keyword">const</span> std::string &str) <span class="keyword">const</span>;
<a name="l00110"></a>00110 std::string ToBB(<span class="keyword">const</span> std::string &str) <span class="keyword">const</span>;
<a name="l00111"></a>00111
<a name="l00112"></a>00112 <span class="comment">// Custom override functions, meant for converting between</span>
<a name="l00113"></a>00113 <span class="comment">// non-BLACKBERRY_CHARSET charsets and the tocode set by the</span>
<a name="l00114"></a>00114 <span class="comment">// IConverter constructor</span>
<a name="l00115"></a>00115 std::string Convert(<span class="keyword">const</span> <a class="code" href="classBarry_1_1IConvHandle.html" title="Wrapper class for a two-way iconv_t handle pair.">IConvHandle</a> &custom, <span class="keyword">const</span> std::string &str) <span class="keyword">const</span>;
<a name="l00116"></a>00116 };
<a name="l00117"></a>00117
<a name="l00118"></a>00118 } <span class="comment">// namespace Barry</span>
<a name="l00119"></a>00119
<a name="l00120"></a>00120 <span class="preprocessor">#endif</span>
<a name="l00121"></a>00121 <span class="preprocessor"></span>
</pre></div></div>
<hr class="footer"/><address style="text-align: right;"><small>Generated by
<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.6.2-20100208 </small></address>
</body>
</html>
