4
4
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
5
5
<title>camel-utf8</title>
6
<meta name="generator" content="DocBook XSL Stylesheets V1.76.1">
6
<meta name="generator" content="DocBook XSL Stylesheets V1.75.2">
7
7
<link rel="home" href="index.html" title="Camel Reference Manual">
8
8
<link rel="up" href="Utilities.html" title="Utilities">
9
9
<link rel="prev" href="camel-camel-url-scanner.html" title="camel-url-scanner">
10
10
<link rel="next" href="Deprecated.html" title="Deprecated Objects">
11
<meta name="generator" content="GTK-Doc V1.17 (XML mode)">
11
<meta name="generator" content="GTK-Doc V1.18 (XML mode)">
12
12
<link rel="stylesheet" href="style.css" type="text/css">
14
14
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
37
37
</tr></table></div>
38
38
<div class="refsynopsisdiv">
39
39
<a name="camel-camel-utf8.synopsis"></a><h2>Synopsis</h2>
40
<pre class="synopsis"><span class="returnvalue">void</span> <a class="link" href="camel-camel-utf8.html#camel-utf8-putc" title="camel_utf8_putc ()">camel_utf8_putc</a> (<em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#guchar"><span class="type">guchar</span></a> **ptr</code></em>,
41
<em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#guint32"><span class="type">guint32</span></a> c</code></em>);
42
<a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#guint32"><span class="returnvalue">guint32</span></a> <a class="link" href="camel-camel-utf8.html#camel-utf8-getc" title="camel_utf8_getc ()">camel_utf8_getc</a> (<em class="parameter"><code>const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#guchar"><span class="type">guchar</span></a> **ptr</code></em>);
43
<a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#guint32"><span class="returnvalue">guint32</span></a> <a class="link" href="camel-camel-utf8.html#camel-utf8-getc-limit" title="camel_utf8_getc_limit ()">camel_utf8_getc_limit</a> (<em class="parameter"><code>const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#guchar"><span class="type">guchar</span></a> **ptr</code></em>,
44
<em class="parameter"><code>const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#guchar"><span class="type">guchar</span></a> *end</code></em>);
45
<span class="returnvalue">void</span> <a class="link" href="camel-camel-utf8.html#g-string-append-u" title="g_string_append_u ()">g_string_append_u</a> (<em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Strings.html#GString"><span class="type">GString</span></a> *out</code></em>,
46
<em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#guint32"><span class="type">guint32</span></a> c</code></em>);
47
<a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="returnvalue">gchar</span></a> * <a class="link" href="camel-camel-utf8.html#camel-utf7-utf8" title="camel_utf7_utf8 ()">camel_utf7_utf8</a> (<em class="parameter"><code>const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *ptr</code></em>);
48
<a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="returnvalue">gchar</span></a> * <a class="link" href="camel-camel-utf8.html#camel-utf8-utf7" title="camel_utf8_utf7 ()">camel_utf8_utf7</a> (<em class="parameter"><code>const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *ptr</code></em>);
49
<a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="returnvalue">gchar</span></a> * <a class="link" href="camel-camel-utf8.html#camel-utf8-ucs2" title="camel_utf8_ucs2 ()">camel_utf8_ucs2</a> (<em class="parameter"><code>const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *ptr</code></em>);
50
<a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="returnvalue">gchar</span></a> * <a class="link" href="camel-camel-utf8.html#camel-ucs2-utf8" title="camel_ucs2_utf8 ()">camel_ucs2_utf8</a> (<em class="parameter"><code>const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *ptr</code></em>);
51
<a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="returnvalue">gchar</span></a> * <a class="link" href="camel-camel-utf8.html#camel-utf8-make-valid" title="camel_utf8_make_valid ()">camel_utf8_make_valid</a> (<em class="parameter"><code>const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *text</code></em>);
40
<pre class="synopsis"><span class="returnvalue">void</span> <a class="link" href="camel-camel-utf8.html#camel-utf8-putc" title="camel_utf8_putc ()">camel_utf8_putc</a> (<em class="parameter"><code><span class="type">guchar</span> **ptr</code></em>,
41
<em class="parameter"><code><span class="type">guint32</span> c</code></em>);
42
<span class="returnvalue">guint32</span> <a class="link" href="camel-camel-utf8.html#camel-utf8-getc" title="camel_utf8_getc ()">camel_utf8_getc</a> (<em class="parameter"><code>const <span class="type">guchar</span> **ptr</code></em>);
43
<span class="returnvalue">guint32</span> <a class="link" href="camel-camel-utf8.html#camel-utf8-getc-limit" title="camel_utf8_getc_limit ()">camel_utf8_getc_limit</a> (<em class="parameter"><code>const <span class="type">guchar</span> **ptr</code></em>,
44
<em class="parameter"><code>const <span class="type">guchar</span> *end</code></em>);
45
<span class="returnvalue">void</span> <a class="link" href="camel-camel-utf8.html#g-string-append-u" title="g_string_append_u ()">g_string_append_u</a> (<em class="parameter"><code><span class="type">GString</span> *out</code></em>,
46
<em class="parameter"><code><span class="type">guint32</span> c</code></em>);
47
<span class="returnvalue">gchar</span> * <a class="link" href="camel-camel-utf8.html#camel-utf7-utf8" title="camel_utf7_utf8 ()">camel_utf7_utf8</a> (<em class="parameter"><code>const <span class="type">gchar</span> *ptr</code></em>);
48
<span class="returnvalue">gchar</span> * <a class="link" href="camel-camel-utf8.html#camel-utf8-utf7" title="camel_utf8_utf7 ()">camel_utf8_utf7</a> (<em class="parameter"><code>const <span class="type">gchar</span> *ptr</code></em>);
49
<span class="returnvalue">gchar</span> * <a class="link" href="camel-camel-utf8.html#camel-utf8-ucs2" title="camel_utf8_ucs2 ()">camel_utf8_ucs2</a> (<em class="parameter"><code>const <span class="type">gchar</span> *ptr</code></em>);
50
<span class="returnvalue">gchar</span> * <a class="link" href="camel-camel-utf8.html#camel-ucs2-utf8" title="camel_ucs2_utf8 ()">camel_ucs2_utf8</a> (<em class="parameter"><code>const <span class="type">gchar</span> *ptr</code></em>);
51
<span class="returnvalue">gchar</span> * <a class="link" href="camel-camel-utf8.html#camel-utf8-make-valid" title="camel_utf8_make_valid ()">camel_utf8_make_valid</a> (<em class="parameter"><code>const <span class="type">gchar</span> *text</code></em>);
54
54
<div class="refsect1">
60
60
<a name="camel-camel-utf8.details"></a><h2>Details</h2>
61
61
<div class="refsect2">
62
62
<a name="camel-utf8-putc"></a><h3>camel_utf8_putc ()</h3>
63
<pre class="programlisting"><span class="returnvalue">void</span> camel_utf8_putc (<em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#guchar"><span class="type">guchar</span></a> **ptr</code></em>,
64
<em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#guint32"><span class="type">guint32</span></a> c</code></em>);</pre>
63
<pre class="programlisting"><span class="returnvalue">void</span> camel_utf8_putc (<em class="parameter"><code><span class="type">guchar</span> **ptr</code></em>,
64
<em class="parameter"><code><span class="type">guint32</span> c</code></em>);</pre>
66
66
Output a 32 bit unicode character as utf8 octets. At most 4 octets will
67
67
be written to <em class="parameter"><code>ptr</code></em>. <em class="parameter"><code>ptr</code></em> will be advanced to the next character position.
71
71
<div class="refsect2">
72
72
<a name="camel-utf8-getc"></a><h3>camel_utf8_getc ()</h3>
73
<pre class="programlisting"><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#guint32"><span class="returnvalue">guint32</span></a> camel_utf8_getc (<em class="parameter"><code>const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#guchar"><span class="type">guchar</span></a> **ptr</code></em>);</pre>
73
<pre class="programlisting"><span class="returnvalue">guint32</span> camel_utf8_getc (<em class="parameter"><code>const <span class="type">guchar</span> **ptr</code></em>);</pre>
75
75
Get a Unicode character from a utf8 stream. <em class="parameter"><code>ptr</code></em> will be advanced
76
76
to the next character position. Invalid utf8 characters will be
89
89
<div class="refsect2">
90
90
<a name="camel-utf8-getc-limit"></a><h3>camel_utf8_getc_limit ()</h3>
91
<pre class="programlisting"><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#guint32"><span class="returnvalue">guint32</span></a> camel_utf8_getc_limit (<em class="parameter"><code>const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#guchar"><span class="type">guchar</span></a> **ptr</code></em>,
92
<em class="parameter"><code>const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#guchar"><span class="type">guchar</span></a> *end</code></em>);</pre>
91
<pre class="programlisting"><span class="returnvalue">guint32</span> camel_utf8_getc_limit (<em class="parameter"><code>const <span class="type">guchar</span> **ptr</code></em>,
92
<em class="parameter"><code>const <span class="type">guchar</span> *end</code></em>);</pre>
94
94
Get the next utf8 gchar at <em class="parameter"><code>ptr</code></em>, and return it, advancing <em class="parameter"><code>ptr</code></em> to
95
95
the next character. If <em class="parameter"><code>end</code></em> is reached before a full utf8
115
115
<div class="refsect2">
116
116
<a name="g-string-append-u"></a><h3>g_string_append_u ()</h3>
117
<pre class="programlisting"><span class="returnvalue">void</span> g_string_append_u (<em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Strings.html#GString"><span class="type">GString</span></a> *out</code></em>,
118
<em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#guint32"><span class="type">guint32</span></a> c</code></em>);</pre>
117
<pre class="programlisting"><span class="returnvalue">void</span> g_string_append_u (<em class="parameter"><code><span class="type">GString</span> *out</code></em>,
118
<em class="parameter"><code><span class="type">guint32</span> c</code></em>);</pre>
123
123
<div class="refsect2">
124
124
<a name="camel-utf7-utf8"></a><h3>camel_utf7_utf8 ()</h3>
125
<pre class="programlisting"><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="returnvalue">gchar</span></a> * camel_utf7_utf8 (<em class="parameter"><code>const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *ptr</code></em>);</pre>
125
<pre class="programlisting"><span class="returnvalue">gchar</span> * camel_utf7_utf8 (<em class="parameter"><code>const <span class="type">gchar</span> *ptr</code></em>);</pre>
127
127
Convert a modified utf7 string to utf8. If the utf7 string
128
128
contains 8 bit characters, they are treated as iso-8859-1.
153
153
<div class="refsect2">
154
154
<a name="camel-utf8-ucs2"></a><h3>camel_utf8_ucs2 ()</h3>
155
<pre class="programlisting"><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="returnvalue">gchar</span></a> * camel_utf8_ucs2 (<em class="parameter"><code>const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *ptr</code></em>);</pre>
155
<pre class="programlisting"><span class="returnvalue">gchar</span> * camel_utf8_ucs2 (<em class="parameter"><code>const <span class="type">gchar</span> *ptr</code></em>);</pre>
157
157
Convert a utf8 string into a ucs2 one. The ucs string will be in
158
158
network byte order, and terminated with a 16 bit NULL.
162
162
<div class="refsect2">
163
163
<a name="camel-ucs2-utf8"></a><h3>camel_ucs2_utf8 ()</h3>
164
<pre class="programlisting"><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="returnvalue">gchar</span></a> * camel_ucs2_utf8 (<em class="parameter"><code>const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *ptr</code></em>);</pre>
164
<pre class="programlisting"><span class="returnvalue">gchar</span> * camel_ucs2_utf8 (<em class="parameter"><code>const <span class="type">gchar</span> *ptr</code></em>);</pre>
166
166
Convert a ucs2 string into a utf8 one. The ucs2 string is treated
167
167
as network byte ordered, and terminated with a 16 bit NUL.
171
171
<div class="refsect2">
172
172
<a name="camel-utf8-make-valid"></a><h3>camel_utf8_make_valid ()</h3>
173
<pre class="programlisting"><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="returnvalue">gchar</span></a> * camel_utf8_make_valid (<em class="parameter"><code>const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *text</code></em>);</pre>
173
<pre class="programlisting"><span class="returnvalue">gchar</span> * camel_utf8_make_valid (<em class="parameter"><code>const <span class="type">gchar</span> *text</code></em>);</pre>
175
175
Ensures the returned text will be valid UTF-8 string, with incorrect letters
176
176
changed to question marks. Returned pointer should be freed with g_free.