1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219
|
<refentry id="camel-camel-string-utils">
<refmeta>
<refentrytitle role="top_of_page" id="camel-camel-string-utils.top_of_page">camel-string-utils</refentrytitle>
<manvolnum>3</manvolnum>
<refmiscinfo>CAMEL Library</refmiscinfo>
</refmeta>
<refnamediv>
<refname>camel-string-utils</refname>
<refpurpose></refpurpose>
<!--[<xref linkend="desc" endterm="desc.title"/>]-->
</refnamediv>
<refsynopsisdiv id="camel-camel-string-utils.synopsis" role="synopsis">
<title role="synopsis.title">Synopsis</title>
<synopsis>
<link linkend="int">int</link> <link linkend="camel-strcase-equal">camel_strcase_equal</link> (<link linkend="gconstpointer">gconstpointer</link> a,
<link linkend="gconstpointer">gconstpointer</link> b);
<link linkend="guint">guint</link> <link linkend="camel-strcase-hash">camel_strcase_hash</link> (<link linkend="gconstpointer">gconstpointer</link> v);
<link linkend="void">void</link> <link linkend="camel-string-list-free">camel_string_list_free</link> (<link linkend="GList">GList</link> *string_list);
<link linkend="char">char</link>* <link linkend="camel-strstrcase">camel_strstrcase</link> (const <link linkend="char">char</link> *haystack,
const <link linkend="char">char</link> *needle);
const <link linkend="char">char</link>* <link linkend="camel-strdown">camel_strdown</link> (<link linkend="char">char</link> *str);
<link linkend="char">char</link> <link linkend="camel-tolower">camel_tolower</link> (<link linkend="char">char</link> c);
<link linkend="char">char</link> <link linkend="camel-toupper">camel_toupper</link> (<link linkend="char">char</link> c);
const <link linkend="char">char</link>* <link linkend="camel-pstring-add">camel_pstring_add</link> (<link linkend="char">char</link> *str,
<link linkend="gboolean">gboolean</link> own);
const <link linkend="char">char</link>* <link linkend="camel-pstring-strdup">camel_pstring_strdup</link> (const <link linkend="char">char</link> *s);
<link linkend="void">void</link> <link linkend="camel-pstring-free">camel_pstring_free</link> (const <link linkend="char">char</link> *s);
</synopsis>
</refsynopsisdiv>
<refsect1 id="camel-camel-string-utils.description" role="desc">
<title role="desc.title">Description</title>
<para>
</para>
</refsect1>
<refsect1 id="camel-camel-string-utils.details" role="details">
<title role="details.title">Details</title>
<refsect2 id="camel-strcase-equal" role="function">
<title>camel_strcase_equal ()</title>
<indexterm zone="camel-strcase-equal"><primary>camel_strcase_equal</primary></indexterm><programlisting><link linkend="int">int</link> camel_strcase_equal (<link linkend="gconstpointer">gconstpointer</link> a,
<link linkend="gconstpointer">gconstpointer</link> b);</programlisting>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>a</parameter> :</term>
<listitem><simpara>
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>b</parameter> :</term>
<listitem><simpara>
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara>
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="camel-strcase-hash" role="function">
<title>camel_strcase_hash ()</title>
<indexterm zone="camel-strcase-hash"><primary>camel_strcase_hash</primary></indexterm><programlisting><link linkend="guint">guint</link> camel_strcase_hash (<link linkend="gconstpointer">gconstpointer</link> v);</programlisting>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>v</parameter> :</term>
<listitem><simpara>
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara>
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="camel-string-list-free" role="function">
<title>camel_string_list_free ()</title>
<indexterm zone="camel-string-list-free"><primary>camel_string_list_free</primary></indexterm><programlisting><link linkend="void">void</link> camel_string_list_free (<link linkend="GList">GList</link> *string_list);</programlisting>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>string_list</parameter> :</term>
<listitem><simpara>
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="camel-strstrcase" role="function">
<title>camel_strstrcase ()</title>
<indexterm zone="camel-strstrcase"><primary>camel_strstrcase</primary></indexterm><programlisting><link linkend="char">char</link>* camel_strstrcase (const <link linkend="char">char</link> *haystack,
const <link linkend="char">char</link> *needle);</programlisting>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>haystack</parameter> :</term>
<listitem><simpara>
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>needle</parameter> :</term>
<listitem><simpara>
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara>
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="camel-strdown" role="function">
<title>camel_strdown ()</title>
<indexterm zone="camel-strdown"><primary>camel_strdown</primary></indexterm><programlisting>const <link linkend="char">char</link>* camel_strdown (<link linkend="char">char</link> *str);</programlisting>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>str</parameter> :</term>
<listitem><simpara>
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara>
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="camel-tolower" role="function">
<title>camel_tolower ()</title>
<indexterm zone="camel-tolower"><primary>camel_tolower</primary></indexterm><programlisting><link linkend="char">char</link> camel_tolower (<link linkend="char">char</link> c);</programlisting>
<para>
ASCII to-lower function.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>c</parameter> :</term>
<listitem><simpara>
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara>
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="camel-toupper" role="function">
<title>camel_toupper ()</title>
<indexterm zone="camel-toupper"><primary>camel_toupper</primary></indexterm><programlisting><link linkend="char">char</link> camel_toupper (<link linkend="char">char</link> c);</programlisting>
<para>
ASCII to-upper function.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>c</parameter> :</term>
<listitem><simpara>
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara>
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="camel-pstring-add" role="function">
<title>camel_pstring_add ()</title>
<indexterm zone="camel-pstring-add"><primary>camel_pstring_add</primary></indexterm><programlisting>const <link linkend="char">char</link>* camel_pstring_add (<link linkend="char">char</link> *str,
<link linkend="gboolean">gboolean</link> own);</programlisting>
<para>
Add the string to the pool.
</para>
<para>
The NULL and empty strings are special cased to constant values.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>str</parameter> :</term>
<listitem><simpara> string to add to the string pool
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>own</parameter> :</term>
<listitem><simpara> whether the string pool will own the memory pointed to by <parameter>str</parameter>, if <parameter>str</parameter> is not yet in the pool
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> A pointer to an equivalent string of <parameter>s</parameter>. Use
<link linkend="camel-pstring-free"><function>camel_pstring_free()</function></link> when it is no longer needed.
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="camel-pstring-strdup" role="function">
<title>camel_pstring_strdup ()</title>
<indexterm zone="camel-pstring-strdup"><primary>camel_pstring_strdup</primary></indexterm><programlisting>const <link linkend="char">char</link>* camel_pstring_strdup (const <link linkend="char">char</link> *s);</programlisting>
<para>
Create a new pooled string entry for the string <parameter>s</parameter>. A pooled
string is a table where common strings are uniquified to the same
pointer value. They are also refcounted, so freed when no longer
in use. In a thread-safe manner.
</para>
<para>
The NULL and empty strings are special cased to constant values.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>s</parameter> :</term>
<listitem><simpara> String to copy.
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> A pointer to an equivalent string of <parameter>s</parameter>. Use
<link linkend="camel-pstring-free"><function>camel_pstring_free()</function></link> when it is no longer needed.
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="camel-pstring-free" role="function">
<title>camel_pstring_free ()</title>
<indexterm zone="camel-pstring-free"><primary>camel_pstring_free</primary></indexterm><programlisting><link linkend="void">void</link> camel_pstring_free (const <link linkend="char">char</link> *s);</programlisting>
<para>
De-ref a pooled string. If no more refs exist to this string, it will be deallocated.
</para>
<para>
NULL and the empty string are special cased.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>s</parameter> :</term>
<listitem><simpara> String to free.
</simpara></listitem></varlistentry>
</variablelist></refsect2>
</refsect1>
</refentry>
|