git.sur5r.net Git - glabels/blob - docs/libglabels/html/libglabels-3.0-str.html

   1 <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
   2 <html>
   3 <head>
   4 <meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
   5 <title>String Utility Functions</title>
   6 <meta name="generator" content="DocBook XSL Stylesheets V1.76.1">
   7 <link rel="home" href="index.html" title="LibGlabels 3.0 Reference Manual">
   8 <link rel="up" href="ch03.html" title="Miscellaneous">
   9 <link rel="prev" href="libglabels-3.0-units.html" title="Units">
  10 <meta name="generator" content="GTK-Doc V1.17 (XML mode)">
  11 <link rel="stylesheet" href="style.css" type="text/css">
  12 </head>
  13 <body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
  14 <table class="navigation" id="top" width="100%" summary="Navigation header" cellpadding="2" cellspacing="2">
  15 <tr valign="middle">
  16 <td><a accesskey="p" href="libglabels-3.0-units.html"><img src="left.png" width="24" height="24" border="0" alt="Prev"></a></td>
  17 <td><a accesskey="u" href="ch03.html"><img src="up.png" width="24" height="24" border="0" alt="Up"></a></td>
  18 <td><a accesskey="h" href="index.html"><img src="home.png" width="24" height="24" border="0" alt="Home"></a></td>
  19 <th width="100%" align="center">LibGlabels 3.0 Reference Manual</th>
  20 <td> </td>
  21 </tr>
  22 <tr><td colspan="5" class="shortcuts">
  23 <a href="#libglabels-3.0-str.synopsis" class="shortcut">Top</a>
  24                    |
  25                   <a href="#libglabels-3.0-str.description" class="shortcut">Description</a>
  26 </td></tr>
  27 </table>
  28 <div class="refentry">
  29 <a name="libglabels-3.0-str"></a><div class="titlepage"></div>
  30 <div class="refnamediv"><table width="100%"><tr>
  31 <td valign="top">
  32 <h2><span class="refentrytitle"><a name="libglabels-3.0-str.top_of_page"></a>String Utility Functions</span></h2>
  33 <p>String Utility Functions — String utility functions provided by libglabels</p>
  34 </td>
  35 <td valign="top" align="right"></td>
  36 </tr></table></div>
  37 <div class="refsynopsisdiv">
  38 <a name="libglabels-3.0-str.synopsis"></a><h2>Synopsis</h2>
  39 <pre class="synopsis">
  40 #include &lt;libglabels/lgl-str.h&gt;
  41
  42 <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gint"><span class="returnvalue">gint</span></a>                <a class="link" href="libglabels-3.0-str.html#lgl-str-utf8-casecmp" title="lgl_str_utf8_casecmp ()">lgl_str_utf8_casecmp</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> *s1</code></em>,
  43                                                          <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> *s2</code></em>);
  44 <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gint"><span class="returnvalue">gint</span></a>                <a class="link" href="libglabels-3.0-str.html#lgl-str-part-name-cmp" title="lgl_str_part_name_cmp ()">lgl_str_part_name_cmp</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> *s1</code></em>,
  45                                                          <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> *s2</code></em>);
  46 <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="returnvalue">gchar</span></a> *             <a class="link" href="libglabels-3.0-str.html#lgl-str-format-fraction" title="lgl_str_format_fraction ()">lgl_str_format_fraction</a>             (<em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gdouble"><span class="type">gdouble</span></a> x</code></em>);
  47 </pre>
  48 </div>
  49 <div class="refsect1">
  50 <a name="libglabels-3.0-str.description"></a><h2>Description</h2>
  51 <p>
  52 This section defines string utility functions used by libglabels and of
  53 possible use to a user of libglabels.
  54 </p>
  55 </div>
  56 <div class="refsect1">
  57 <a name="libglabels-3.0-str.details"></a><h2>Details</h2>
  58 <div class="refsect2">
  59 <a name="lgl-str-utf8-casecmp"></a><h3>lgl_str_utf8_casecmp ()</h3>
  60 <pre class="programlisting"><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gint"><span class="returnvalue">gint</span></a>                lgl_str_utf8_casecmp                (<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> *s1</code></em>,
  61                                                          <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> *s2</code></em>);</pre>
  62 <p>
  63 Compare two UTF-8 strings, ignoring the case of characters.
  64 </p>
  65 <p>
  66 This function should be used only on strings that are known to be encoded
  67 in UTF-8 or a compatible UTF-8 subset.
  68 </p>
  69 <div class="variablelist"><table border="0">
  70 <col align="left" valign="top">
  71 <tbody>
  72 <tr>
  73 <td><p><span class="term"><em class="parameter"><code>s1</code></em> :</span></p></td>
  74 <td>string to compare with s2.</td>
  75 </tr>
  76 <tr>
  77 <td><p><span class="term"><em class="parameter"><code>s2</code></em> :</span></p></td>
  78 <td>string to compare with s1.</td>
  79 </tr>
  80 <tr>
  81 <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
  82 <td>0 if the strings match, a negative value if s1 &lt; s2,
  83 or a positive value if s1 &gt; s2.</td>
  84 </tr>
  85 </tbody>
  86 </table></div>
  87 </div>
  88 <hr>
  89 <div class="refsect2">
  90 <a name="lgl-str-part-name-cmp"></a><h3>lgl_str_part_name_cmp ()</h3>
  91 <pre class="programlisting"><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gint"><span class="returnvalue">gint</span></a>                lgl_str_part_name_cmp               (<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> *s1</code></em>,
  92                                                          <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> *s2</code></em>);</pre>
  93 <p>
  94 Compare two UTF-8 strings representing part names or numbers.  This function
  95 uses a natural sort order:
  96 </p>
  97 <p>
  98  - Ignores case.
  99 </p>
 100 <p>
 101  - Strings are divided into chunks (numeric and non-numeric)
 102 </p>
 103 <p>
 104  - Non-numeric chunks are compared character by character
 105 </p>
 106 <p>
 107  - Numerical chunks are compared numerically, so that "20" precedes "100".
 108 </p>
 109 <p>
 110  - Comparison of chunks is performed left to right until the first difference
 111    is encountered or all chunks evaluate as equal.
 112 </p>
 113 <p>
 114 This function should be used only on strings that are known to be encoded
 115 in UTF-8 or a compatible UTF-8 subset.
 116 </p>
 117 <p>
 118 Numeric chunks are converted to 64 bit unsigned integers for comparison,
 119 so the behaviour may be unpredictable for numeric chunks that exceed
 120 18446744073709551615.
 121 </p>
 122 <div class="variablelist"><table border="0">
 123 <col align="left" valign="top">
 124 <tbody>
 125 <tr>
 126 <td><p><span class="term"><em class="parameter"><code>s1</code></em> :</span></p></td>
 127 <td>string to compare with s2.</td>
 128 </tr>
 129 <tr>
 130 <td><p><span class="term"><em class="parameter"><code>s2</code></em> :</span></p></td>
 131 <td>string to compare with s1.</td>
 132 </tr>
 133 <tr>
 134 <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
 135 <td>0 if the strings match, a negative value if s1 &lt; s2,
 136 or a positive value if s1 &gt; s2.</td>
 137 </tr>
 138 </tbody>
 139 </table></div>
 140 </div>
 141 <hr>
 142 <div class="refsect2">
 143 <a name="lgl-str-format-fraction"></a><h3>lgl_str_format_fraction ()</h3>
 144 <pre class="programlisting"><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="returnvalue">gchar</span></a> *             lgl_str_format_fraction             (<em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gdouble"><span class="type">gdouble</span></a> x</code></em>);</pre>
 145 <p>
 146 Create fractional representation of number, if possible.  Uses UTF-8 superscripts and
 147 subscripts for numerator and denominator values respecively.
 148 </p>
 149 <div class="variablelist"><table border="0">
 150 <col align="left" valign="top">
 151 <tbody>
 152 <tr>
 153 <td><p><span class="term"><em class="parameter"><code>x</code></em> :</span></p></td>
 154 <td>Floating point number to convert to fractional notation</td>
 155 </tr>
 156 <tr>
 157 <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
 158 <td>UTF-8 string containing fractional representation of x.</td>
 159 </tr>
 160 </tbody>
 161 </table></div>
 162 </div>
 163 </div>
 164 </div>
 165 <div class="footer">
 166 <hr>
 167           Generated by GTK-Doc V1.17</div>
 168 </body>
 169 </html>