<!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>libnjb: /builddir/build/BUILD/libnjb-2.2.7/src/unicode.c File Reference</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.7.4 -->
<div id="top">
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
<tbody>
<tr style="height: 56px;">
<td style="padding-left: 0.5em;">
<div id="projectname">libnjb <span id="projectnumber">2.2.7</span></div>
</td>
</tr>
</tbody>
</table>
</div>
<div id="navrow1" class="tabs">
<ul class="tablist">
<li><a href="index.html"><span>Main Page</span></a></li>
<li><a href="modules.html"><span>Modules</span></a></li>
<li><a href="annotated.html"><span>Data Structures</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>
<li><a href="examples.html"><span>Examples</span></a></li>
</ul>
</div>
<div id="navrow2" class="tabs2">
<ul class="tablist">
<li><a href="files.html"><span>File List</span></a></li>
<li><a href="globals.html"><span>Globals</span></a></li>
</ul>
</div>
<div id="nav-path" class="navpath">
<ul>
<li class="navelem"><a class="el" href="dir_55a6aa4feb4da29582c8781b5e808e47.html">src</a> </li>
</ul>
</div>
</div>
<div class="header">
<div class="summary">
<a href="#define-members">Defines</a> |
<a href="#func-members">Functions</a> |
<a href="#var-members">Variables</a> </div>
<div class="headertitle">
<div class="title">unicode.c File Reference</div> </div>
</div>
<div class="contents">
<div class="textblock"><code>#include <stdlib.h></code><br/>
<code>#include <string.h></code><br/>
<code>#include <errno.h></code><br/>
<code>#include "<a class="el" href="libnjb_8h_source.html">libnjb.h</a>"</code><br/>
<code>#include "protocol.h"</code><br/>
<code>#include "<a class="el" href="protocol3_8h_source.html">protocol3.h</a>"</code><br/>
<code>#include "unicode.h"</code><br/>
<code>#include "njb_error.h"</code><br/>
<code>#include "usb_io.h"</code><br/>
<code>#include "ioutil.h"</code><br/>
<code>#include "defs.h"</code><br/>
<code>#include "base.h"</code><br/>
</div><table class="memberdecls">
<tr><td colspan="2"><h2><a name="define-members"></a>
Defines</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a6789ebc0df71a8ef76bfbb4fb5f74aad"></a><!-- doxytag: member="unicode.c::MAX_STRING_LENGTH" ref="a6789ebc0df71a8ef76bfbb4fb5f74aad" args="" -->
#define </td><td class="memItemRight" valign="bottom"><b>MAX_STRING_LENGTH</b>   512</td></tr>
<tr><td colspan="2"><h2><a name="func-members"></a>
Functions</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="unicode_8c.html#a4af1a0bee89d7ee79ebb1bfb557f8e5e">njb_set_unicode</a> (int flag)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="unicode_8c.html#acd147761736f45b4282bebb6147c440a">ucs2strlen</a> (const unsigned char *unicstr)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">char * </td><td class="memItemRight" valign="bottom"><a class="el" href="unicode_8c.html#a4b1829345b6bf2af61d6dbbb1b02726b">strtoutf8</a> (const unsigned char *str)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">char * </td><td class="memItemRight" valign="bottom"><a class="el" href="unicode_8c.html#a767008fdd0e78d87acbc7f1ad3bf4830">utf8tostr</a> (const unsigned char *str)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">char * </td><td class="memItemRight" valign="bottom"><a class="el" href="unicode_8c.html#a841f6472d66d10714cb565821cdb627f">ucs2tostr</a> (const unsigned char *unicstr)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">unsigned char * </td><td class="memItemRight" valign="bottom"><a class="el" href="unicode_8c.html#a7a77d04f2f0563c9c74d28fca28effdd">strtoucs2</a> (const unsigned char *str)</td></tr>
<tr><td colspan="2"><h2><a name="var-members"></a>
Variables</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="unicode_8c.html#a60db410c9e82d9e61b1bf0be607922ed">__sub_depth</a></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="unicode_8c.html#ac04b373ed657c74d96015d8935eb57b0">njb_unicode_flag</a> = NJB_UC_8859</td></tr>
</table>
<hr/><a name="details" id="details"></a><h2>Detailed Description</h2>
<div class="textblock"><p>This file contains general Unicode string manipulation functions. It mainly consist of functions for converting between UCS-2 (used on the devices), UTF-8 (used by several applications) and ISO 8859-1 / Codepage 1252 (fallback). </p>
</div><hr/><h2>Function Documentation</h2>
<a class="anchor" id="a4af1a0bee89d7ee79ebb1bfb557f8e5e"></a><!-- doxytag: member="unicode.c::njb_set_unicode" ref="a4af1a0bee89d7ee79ebb1bfb557f8e5e" args="(int flag)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void njb_set_unicode </td>
<td>(</td>
<td class="paramtype">int </td>
<td class="paramname"><em>flag</em></td><td>)</td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>This flag determines whether to use ISO 8859-1 / codepage 1252 (default) or unicode UTF-8 for ALL strings sent into and out of libnjb, for ALL sessions and devices.</p>
<dl><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramname">flag</td><td>0 for ISO 8859-1 / codepage 1252 or 1 for Unicode UTF-8. </td></tr>
</table>
</dd>
</dl>
<p>Referenced by <a class="el" href="group__internals.html#ga22a893c243cd4398de35fcdea5b49b39">NJB_Set_Unicode()</a>.</p>
</div>
</div>
<a class="anchor" id="a7a77d04f2f0563c9c74d28fca28effdd"></a><!-- doxytag: member="unicode.c::strtoucs2" ref="a7a77d04f2f0563c9c74d28fca28effdd" args="(const unsigned char *str)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">unsigned char* strtoucs2 </td>
<td>(</td>
<td class="paramtype">const unsigned char * </td>
<td class="paramname"><em>str</em></td><td>)</td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Convert a simple ISO 8859-1 or a Unicode UTF8 string (depending on library Unicode flag) to a unicode UCS-2 string.</p>
<dl><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramname">str</td><td>the ISO 8859-1 or UTF-8 string to conver </td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>a pointer to a newly allocated UCS-2 string </dd></dl>
<p>References <a class="el" href="group__unicodeflags.html#ga388e9c70b7a684c777f6b25e2e9d801b">NJB_UC_UTF8</a>.</p>
<p>Referenced by <a class="el" href="datafile_8c.html#afc23fcd58e9e846ae7aa4ff500f5b198">datafile_pack3()</a>, <a class="el" href="datafile_8c.html#aa7ca666051692a0e0c2b458366e8fcf9">new_folder_pack3()</a>, <a class="el" href="group__playlistapi.html#gae1873045c0cd0eb27465992c3479b975">NJB_Update_Playlist()</a>, <a class="el" href="songid_8c.html#a1dcd88c13e7b209d9a5b6e31e71ff6e6">songid_pack()</a>, <a class="el" href="songid_8c.html#a4a04f572c79d5f5c4b813ba8c1932f6b">songid_pack3()</a>, and <a class="el" href="unicode_8c.html#a767008fdd0e78d87acbc7f1ad3bf4830">utf8tostr()</a>.</p>
</div>
</div>
<a class="anchor" id="a4b1829345b6bf2af61d6dbbb1b02726b"></a><!-- doxytag: member="unicode.c::strtoutf8" ref="a4b1829345b6bf2af61d6dbbb1b02726b" args="(const unsigned char *str)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">char* strtoutf8 </td>
<td>(</td>
<td class="paramtype">const unsigned char * </td>
<td class="paramname"><em>str</em></td><td>)</td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>This function converts an ordinary ISO 8859-1 string to a unicode UTF-8 string</p>
<dl><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramname">str</td><td>the ISO 8859-1 string to convert </td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>a newly allocated UTF-8 encoded string with the same content. Should be freed after use. </dd></dl>
<p>Referenced by <a class="el" href="datafile_8c.html#aa0767790f814895d8ddc310d933fb011">datafile_unpack()</a>, <a class="el" href="group__basic.html#gadca7f2a175da4e25244e81a5abafad7d">NJB_Get_Owner_String()</a>, <a class="el" href="playlist_8c.html#a696ec1b911d19920b16b51d865a933f8">playlist_unpack()</a>, and <a class="el" href="songid_8c.html#ab4fd686d31cb66af604ab8cd1b285046">songid_unpack()</a>.</p>
</div>
</div>
<a class="anchor" id="acd147761736f45b4282bebb6147c440a"></a><!-- doxytag: member="unicode.c::ucs2strlen" ref="acd147761736f45b4282bebb6147c440a" args="(const unsigned char *unicstr)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int ucs2strlen </td>
<td>(</td>
<td class="paramtype">const unsigned char * </td>
<td class="paramname"><em>unicstr</em></td><td>)</td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Gets the length (in characters, not bytes) of a unicode UCS-2 string, eg a string which physically is 0x00 0x41 0x00 0x00 will return a value of 1.</p>
<dl><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramname">unicstr</td><td>a UCS-2 Unicode string </td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>the length of the string, in number of characters. If you want to know the length in bytes, multiply this by two and add two (for zero terminator). </dd></dl>
<p>Referenced by <a class="el" href="protocol3_8h.html#a91831b3fc1d2c5ccafd2f62629733074">njb3_create_playlist()</a>, <a class="el" href="protocol3_8h.html#af4c77c8c12bea8f1a8c125e70019d5c1">njb3_update_string_frame()</a>, <a class="el" href="songid_8c.html#a1dcd88c13e7b209d9a5b6e31e71ff6e6">songid_pack()</a>, <a class="el" href="songid_8c.html#a4a04f572c79d5f5c4b813ba8c1932f6b">songid_pack3()</a>, and <a class="el" href="unicode_8c.html#a841f6472d66d10714cb565821cdb627f">ucs2tostr()</a>.</p>
</div>
</div>
<a class="anchor" id="a841f6472d66d10714cb565821cdb627f"></a><!-- doxytag: member="unicode.c::ucs2tostr" ref="a841f6472d66d10714cb565821cdb627f" args="(const unsigned char *unicstr)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">char* ucs2tostr </td>
<td>(</td>
<td class="paramtype">const unsigned char * </td>
<td class="paramname"><em>unicstr</em></td><td>)</td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Converts a Unicode UCS-2 2-byte string to a common ISO 8859-1 string quick and dirty (japanese unicodes etc, that use all 16 bits will fail miserably)</p>
<dl><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramname">unicstr</td><td>the UCS-2 unicode string to convert </td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>a newly allocated ISO 8859-1 string that tries to resemble the UCS-2 string </dd></dl>
<p>References <a class="el" href="group__unicodeflags.html#ga388e9c70b7a684c777f6b25e2e9d801b">NJB_UC_UTF8</a>, and <a class="el" href="unicode_8c.html#acd147761736f45b4282bebb6147c440a">ucs2strlen()</a>.</p>
<p>Referenced by <a class="el" href="songid_8c.html#ab4fd686d31cb66af604ab8cd1b285046">songid_unpack()</a>.</p>
</div>
</div>
<a class="anchor" id="a767008fdd0e78d87acbc7f1ad3bf4830"></a><!-- doxytag: member="unicode.c::utf8tostr" ref="a767008fdd0e78d87acbc7f1ad3bf4830" args="(const unsigned char *str)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">char* utf8tostr </td>
<td>(</td>
<td class="paramtype">const unsigned char * </td>
<td class="paramname"><em>str</em></td><td>)</td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>This function approximates an ISO 8859-1 string from a UTF-8 string, leaving out untranslatable characters</p>
<dl><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramname">str</td><td>the UTF-8 string to use as indata </td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>a newly allocated ISO 8859-1 string which is as close a possible to the UTF-8 string. </dd></dl>
<p>References <a class="el" href="unicode_8c.html#a7a77d04f2f0563c9c74d28fca28effdd">strtoucs2()</a>.</p>
<p>Referenced by <a class="el" href="datafile_8c.html#aa580707078938ef2447d971a96638ce3">datafile_pack()</a>, <a class="el" href="group__basic.html#gac24779b3f78bf1290d09a2b80db49a3d">NJB_Set_Owner_String()</a>, <a class="el" href="group__playlistapi.html#gae1873045c0cd0eb27465992c3479b975">NJB_Update_Playlist()</a>, and <a class="el" href="songid_8c.html#a1dcd88c13e7b209d9a5b6e31e71ff6e6">songid_pack()</a>.</p>
</div>
</div>
<hr/><h2>Variable Documentation</h2>
<a class="anchor" id="a60db410c9e82d9e61b1bf0be607922ed"></a><!-- doxytag: member="unicode.c::__sub_depth" ref="a60db410c9e82d9e61b1bf0be607922ed" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int <a class="el" href="usb__io_8c.html#a60db410c9e82d9e61b1bf0be607922ed">__sub_depth</a></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>The current subroutine depth for all of libnjb (global) </p>
</div>
</div>
<a class="anchor" id="ac04b373ed657c74d96015d8935eb57b0"></a><!-- doxytag: member="unicode.c::njb_unicode_flag" ref="ac04b373ed657c74d96015d8935eb57b0" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int <a class="el" href="unicode_8c.html#ac04b373ed657c74d96015d8935eb57b0">njb_unicode_flag</a> = NJB_UC_8859</td>
</tr>
</table>
</div>
<div class="memdoc">
<p>A flag for if unicode is used or not (global) </p>
</div>
</div>
</div>
<hr class="footer"/><address class="footer"><small>Generated on Sat Jun 25 2011 for libnjb by 
<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.7.4 </small></address>
</body>
</html>
distrib
>
Fedora
>
14
>
x86_64
>
media
>
updates
>
by-pkgid
>
f2adb5ed02e83f2c51981c1b15594e22
>
files
>
149
