Improve GBookmarkFile test coverage
[platform/upstream/glib.git] / glib / gstrfuncs.c
1 /* GLIB - Library of useful routines for C programming
2  * Copyright (C) 1995-1997  Peter Mattis, Spencer Kimball and Josh MacDonald
3  *
4  * This library is free software; you can redistribute it and/or
5  * modify it under the terms of the GNU Lesser General Public
6  * License as published by the Free Software Foundation; either
7  * version 2 of the License, or (at your option) any later version.
8  *
9  * This library is distributed in the hope that it will be useful,
10  * but WITHOUT ANY WARRANTY; without even the implied warranty of
11  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
12  * Lesser General Public License for more details.
13  *
14  * You should have received a copy of the GNU Lesser General Public
15  * License along with this library; if not, write to the
16  * Free Software Foundation, Inc., 59 Temple Place - Suite 330,
17  * Boston, MA 02111-1307, USA.
18  */
19
20 /*
21  * Modified by the GLib Team and others 1997-2000.  See the AUTHORS
22  * file for a list of people on the GLib Team.  See the ChangeLog
23  * files for a list of changes.  These files are distributed with
24  * GLib at ftp://ftp.gtk.org/pub/gtk/.
25  */
26
27 /*
28  * MT safe
29  */
30
31 #include "config.h"
32
33 #include <stdarg.h>
34 #include <stdio.h>
35 #include <stdlib.h>
36 #include <locale.h>
37 #include <string.h>
38 #include <locale.h>
39 #include <errno.h>
40 #include <ctype.h>              /* For tolower() */
41
42 #ifdef HAVE_XLOCALE_H
43 /* Needed on BSD/OS X for e.g. strtod_l */
44 #include <xlocale.h>
45 #endif
46
47 #ifdef G_OS_WIN32
48 #include <windows.h>
49 #endif
50
51 /* do not include <unistd.h> here, it may interfere with g_strsignal() */
52
53 #include "gstrfuncs.h"
54
55 #include "gprintf.h"
56 #include "gprintfint.h"
57 #include "glibintl.h"
58
59
60 /**
61  * SECTION:string_utils
62  * @title: String Utility Functions
63  * @short_description: various string-related functions
64  *
65  * This section describes a number of utility functions for creating,
66  * duplicating, and manipulating strings.
67  *
68  * Note that the functions g_printf(), g_fprintf(), g_sprintf(),
69  * g_snprintf(), g_vprintf(), g_vfprintf(), g_vsprintf() and g_vsnprintf()
70  * are declared in the header <filename>gprintf.h</filename> which is
71  * <emphasis>not</emphasis> included in <filename>glib.h</filename>
72  * (otherwise using <filename>glib.h</filename> would drag in
73  * <filename>stdio.h</filename>), so you'll have to explicitly include
74  * <literal>&lt;glib/gprintf.h&gt;</literal> in order to use the GLib
75  * printf() functions.
76  *
77  * <para id="string-precision">While you may use the printf() functions
78  * to format UTF-8 strings, notice that the precision of a
79  * <literal>&percnt;Ns</literal> parameter is interpreted as the
80  * number of <emphasis>bytes</emphasis>, not <emphasis>characters</emphasis>
81  * to print. On top of that, the GNU libc implementation of the printf()
82  * functions has the "feature" that it checks that the string given for
83  * the <literal>&percnt;Ns</literal> parameter consists of a whole number
84  * of characters in the current encoding. So, unless you are sure you are
85  * always going to be in an UTF-8 locale or your know your text is restricted
86  * to ASCII, avoid using <literal>&percnt;Ns</literal>. If your intention is
87  * to format strings for a certain number of columns, then
88  * <literal>&percnt;Ns</literal> is not a correct solution anyway, since it
89  * fails to take wide characters (see g_unichar_iswide()) into account.
90  * </para>
91  */
92
93 /**
94  * g_ascii_isalnum:
95  * @c: any character
96  *
97  * Determines whether a character is alphanumeric.
98  *
99  * Unlike the standard C library isalnum() function, this only
100  * recognizes standard ASCII letters and ignores the locale,
101  * returning %FALSE for all non-ASCII characters. Also, unlike
102  * the standard library function, this takes a <type>char</type>,
103  * not an <type>int</type>, so don't call it on <literal>EOF</literal>, but no need to
104  * cast to #guchar before passing a possibly non-ASCII character in.
105  *
106  * Returns: %TRUE if @c is an ASCII alphanumeric character
107  */
108
109 /**
110  * g_ascii_isalpha:
111  * @c: any character
112  *
113  * Determines whether a character is alphabetic (i.e. a letter).
114  *
115  * Unlike the standard C library isalpha() function, this only
116  * recognizes standard ASCII letters and ignores the locale,
117  * returning %FALSE for all non-ASCII characters. Also, unlike
118  * the standard library function, this takes a <type>char</type>,
119  * not an <type>int</type>, so don't call it on <literal>EOF</literal>, but no need to
120  * cast to #guchar before passing a possibly non-ASCII character in.
121  *
122  * Returns: %TRUE if @c is an ASCII alphabetic character
123  */
124
125 /**
126  * g_ascii_iscntrl:
127  * @c: any character
128  *
129  * Determines whether a character is a control character.
130  *
131  * Unlike the standard C library iscntrl() function, this only
132  * recognizes standard ASCII control characters and ignores the
133  * locale, returning %FALSE for all non-ASCII characters. Also,
134  * unlike the standard library function, this takes a <type>char</type>,
135  * not an <type>int</type>, so don't call it on <literal>EOF</literal>, but no need to
136  * cast to #guchar before passing a possibly non-ASCII character in.
137  *
138  * Returns: %TRUE if @c is an ASCII control character.
139  */
140
141 /**
142  * g_ascii_isdigit:
143  * @c: any character
144  *
145  * Determines whether a character is digit (0-9).
146  *
147  * Unlike the standard C library isdigit() function, this takes
148  * a <type>char</type>, not an <type>int</type>, so don't call it
149  * on <literal>EOF</literal>, but no need to cast to #guchar before passing a possibly
150  * non-ASCII character in.
151  *
152  * Returns: %TRUE if @c is an ASCII digit.
153  */
154
155 /**
156  * g_ascii_isgraph:
157  * @c: any character
158  *
159  * Determines whether a character is a printing character and not a space.
160  *
161  * Unlike the standard C library isgraph() function, this only
162  * recognizes standard ASCII characters and ignores the locale,
163  * returning %FALSE for all non-ASCII characters. Also, unlike
164  * the standard library function, this takes a <type>char</type>,
165  * not an <type>int</type>, so don't call it on <literal>EOF</literal>, but no need
166  * to cast to #guchar before passing a possibly non-ASCII character in.
167  *
168  * Returns: %TRUE if @c is an ASCII printing character other than space.
169  */
170
171 /**
172  * g_ascii_islower:
173  * @c: any character
174  *
175  * Determines whether a character is an ASCII lower case letter.
176  *
177  * Unlike the standard C library islower() function, this only
178  * recognizes standard ASCII letters and ignores the locale,
179  * returning %FALSE for all non-ASCII characters. Also, unlike
180  * the standard library function, this takes a <type>char</type>,
181  * not an <type>int</type>, so don't call it on <literal>EOF</literal>, but no need
182  * to worry about casting to #guchar before passing a possibly
183  * non-ASCII character in.
184  *
185  * Returns: %TRUE if @c is an ASCII lower case letter
186  */
187
188 /**
189  * g_ascii_isprint:
190  * @c: any character
191  *
192  * Determines whether a character is a printing character.
193  *
194  * Unlike the standard C library isprint() function, this only
195  * recognizes standard ASCII characters and ignores the locale,
196  * returning %FALSE for all non-ASCII characters. Also, unlike
197  * the standard library function, this takes a <type>char</type>,
198  * not an <type>int</type>, so don't call it on <literal>EOF</literal>, but no need
199  * to cast to #guchar before passing a possibly non-ASCII character in.
200  *
201  * Returns: %TRUE if @c is an ASCII printing character.
202  */
203
204 /**
205  * g_ascii_ispunct:
206  * @c: any character
207  *
208  * Determines whether a character is a punctuation character.
209  *
210  * Unlike the standard C library ispunct() function, this only
211  * recognizes standard ASCII letters and ignores the locale,
212  * returning %FALSE for all non-ASCII characters. Also, unlike
213  * the standard library function, this takes a <type>char</type>,
214  * not an <type>int</type>, so don't call it on <literal>EOF</literal>, but no need to
215  * cast to #guchar before passing a possibly non-ASCII character in.
216  *
217  * Returns: %TRUE if @c is an ASCII punctuation character.
218  */
219
220 /**
221  * g_ascii_isspace:
222  * @c: any character
223  *
224  * Determines whether a character is a white-space character.
225  *
226  * Unlike the standard C library isspace() function, this only
227  * recognizes standard ASCII white-space and ignores the locale,
228  * returning %FALSE for all non-ASCII characters. Also, unlike
229  * the standard library function, this takes a <type>char</type>,
230  * not an <type>int</type>, so don't call it on <literal>EOF</literal>, but no need to
231  * cast to #guchar before passing a possibly non-ASCII character in.
232  *
233  * Returns: %TRUE if @c is an ASCII white-space character
234  */
235
236 /**
237  * g_ascii_isupper:
238  * @c: any character
239  *
240  * Determines whether a character is an ASCII upper case letter.
241  *
242  * Unlike the standard C library isupper() function, this only
243  * recognizes standard ASCII letters and ignores the locale,
244  * returning %FALSE for all non-ASCII characters. Also, unlike
245  * the standard library function, this takes a <type>char</type>,
246  * not an <type>int</type>, so don't call it on <literal>EOF</literal>, but no need to
247  * worry about casting to #guchar before passing a possibly non-ASCII
248  * character in.
249  *
250  * Returns: %TRUE if @c is an ASCII upper case letter
251  */
252
253 /**
254  * g_ascii_isxdigit:
255  * @c: any character
256  *
257  * Determines whether a character is a hexadecimal-digit character.
258  *
259  * Unlike the standard C library isxdigit() function, this takes
260  * a <type>char</type>, not an <type>int</type>, so don't call it
261  * on <literal>EOF</literal>, but no need to cast to #guchar before passing a
262  * possibly non-ASCII character in.
263  *
264  * Returns: %TRUE if @c is an ASCII hexadecimal-digit character.
265  */
266
267 /**
268  * G_ASCII_DTOSTR_BUF_SIZE:
269  *
270  * A good size for a buffer to be passed into g_ascii_dtostr().
271  * It is guaranteed to be enough for all output of that function
272  * on systems with 64bit IEEE-compatible doubles.
273  *
274  * The typical usage would be something like:
275  * |[
276  *   char buf[G_ASCII_DTOSTR_BUF_SIZE];
277  *
278  *   fprintf (out, "value=&percnt;s\n", g_ascii_dtostr (buf, sizeof (buf), value));
279  * ]|
280  */
281
282 /**
283  * g_strstrip:
284  * @string: a string to remove the leading and trailing whitespace from
285  *
286  * Removes leading and trailing whitespace from a string.
287  * See g_strchomp() and g_strchug().
288  *
289  * Returns: @string
290  */
291
292 /**
293  * G_STR_DELIMITERS:
294  *
295  * The standard delimiters, used in g_strdelimit().
296  */
297
298 static const guint16 ascii_table_data[256] = {
299   0x004, 0x004, 0x004, 0x004, 0x004, 0x004, 0x004, 0x004,
300   0x004, 0x104, 0x104, 0x004, 0x104, 0x104, 0x004, 0x004,
301   0x004, 0x004, 0x004, 0x004, 0x004, 0x004, 0x004, 0x004,
302   0x004, 0x004, 0x004, 0x004, 0x004, 0x004, 0x004, 0x004,
303   0x140, 0x0d0, 0x0d0, 0x0d0, 0x0d0, 0x0d0, 0x0d0, 0x0d0,
304   0x0d0, 0x0d0, 0x0d0, 0x0d0, 0x0d0, 0x0d0, 0x0d0, 0x0d0,
305   0x459, 0x459, 0x459, 0x459, 0x459, 0x459, 0x459, 0x459,
306   0x459, 0x459, 0x0d0, 0x0d0, 0x0d0, 0x0d0, 0x0d0, 0x0d0,
307   0x0d0, 0x653, 0x653, 0x653, 0x653, 0x653, 0x653, 0x253,
308   0x253, 0x253, 0x253, 0x253, 0x253, 0x253, 0x253, 0x253,
309   0x253, 0x253, 0x253, 0x253, 0x253, 0x253, 0x253, 0x253,
310   0x253, 0x253, 0x253, 0x0d0, 0x0d0, 0x0d0, 0x0d0, 0x0d0,
311   0x0d0, 0x473, 0x473, 0x473, 0x473, 0x473, 0x473, 0x073,
312   0x073, 0x073, 0x073, 0x073, 0x073, 0x073, 0x073, 0x073,
313   0x073, 0x073, 0x073, 0x073, 0x073, 0x073, 0x073, 0x073,
314   0x073, 0x073, 0x073, 0x0d0, 0x0d0, 0x0d0, 0x0d0, 0x004
315   /* the upper 128 are all zeroes */
316 };
317
318 const guint16 * const g_ascii_table = ascii_table_data;
319
320 #if defined (HAVE_NEWLOCALE) && \
321     defined (HAVE_USELOCALE) && \
322     defined (HAVE_STRTOD_L) && \
323     defined (HAVE_STRTOULL_L) && \
324     defined (HAVE_STRTOLL_L)
325 #define USE_XLOCALE 1
326 #endif
327
328 #ifdef USE_XLOCALE
329 static locale_t
330 get_C_locale (void)
331 {
332   static gsize initialized = FALSE;
333   static locale_t C_locale = NULL;
334
335   if (g_once_init_enter (&initialized))
336     {
337       C_locale = newlocale (LC_ALL_MASK, "C", NULL);
338       g_once_init_leave (&initialized, TRUE);
339     }
340
341   return C_locale;
342 }
343 #endif
344
345 /**
346  * g_strdup:
347  * @str: the string to duplicate
348  *
349  * Duplicates a string. If @str is %NULL it returns %NULL.
350  * The returned string should be freed with g_free()
351  * when no longer needed.
352  *
353  * Returns: a newly-allocated copy of @str
354  */
355 gchar*
356 g_strdup (const gchar *str)
357 {
358   gchar *new_str;
359   gsize length;
360
361   if (str)
362     {
363       length = strlen (str) + 1;
364       new_str = g_new (char, length);
365       memcpy (new_str, str, length);
366     }
367   else
368     new_str = NULL;
369
370   return new_str;
371 }
372
373 /**
374  * g_memdup:
375  * @mem: the memory to copy.
376  * @byte_size: the number of bytes to copy.
377  *
378  * Allocates @byte_size bytes of memory, and copies @byte_size bytes into it
379  * from @mem. If @mem is %NULL it returns %NULL.
380  *
381  * Returns: a pointer to the newly-allocated copy of the memory, or %NULL if @mem
382  *  is %NULL.
383  */
384 gpointer
385 g_memdup (gconstpointer mem,
386           guint         byte_size)
387 {
388   gpointer new_mem;
389
390   if (mem)
391     {
392       new_mem = g_malloc (byte_size);
393       memcpy (new_mem, mem, byte_size);
394     }
395   else
396     new_mem = NULL;
397
398   return new_mem;
399 }
400
401 /**
402  * g_strndup:
403  * @str: the string to duplicate
404  * @n: the maximum number of bytes to copy from @str
405  *
406  * Duplicates the first @n bytes of a string, returning a newly-allocated
407  * buffer @n + 1 bytes long which will always be nul-terminated.
408  * If @str is less than @n bytes long the buffer is padded with nuls.
409  * If @str is %NULL it returns %NULL.
410  * The returned value should be freed when no longer needed.
411  *
412  * <note><para>
413  * To copy a number of characters from a UTF-8 encoded string, use
414  * g_utf8_strncpy() instead.
415  * </para></note>
416  *
417  * Returns: a newly-allocated buffer containing the first @n bytes
418  *          of @str, nul-terminated
419  */
420 gchar*
421 g_strndup (const gchar *str,
422            gsize        n)
423 {
424   gchar *new_str;
425
426   if (str)
427     {
428       new_str = g_new (gchar, n + 1);
429       strncpy (new_str, str, n);
430       new_str[n] = '\0';
431     }
432   else
433     new_str = NULL;
434
435   return new_str;
436 }
437
438 /**
439  * g_strnfill:
440  * @length: the length of the new string
441  * @fill_char: the byte to fill the string with
442  *
443  * Creates a new string @length bytes long filled with @fill_char.
444  * The returned string should be freed when no longer needed.
445  *
446  * Returns: a newly-allocated string filled the @fill_char
447  */
448 gchar*
449 g_strnfill (gsize length,
450             gchar fill_char)
451 {
452   gchar *str;
453
454   str = g_new (gchar, length + 1);
455   memset (str, (guchar)fill_char, length);
456   str[length] = '\0';
457
458   return str;
459 }
460
461 /**
462  * g_stpcpy:
463  * @dest: destination buffer.
464  * @src: source string.
465  *
466  * Copies a nul-terminated string into the dest buffer, include the
467  * trailing nul, and return a pointer to the trailing nul byte.
468  * This is useful for concatenating multiple strings together
469  * without having to repeatedly scan for the end.
470  *
471  * Return value: a pointer to trailing nul byte.
472  **/
473 gchar *
474 g_stpcpy (gchar       *dest,
475           const gchar *src)
476 {
477 #ifdef HAVE_STPCPY
478   g_return_val_if_fail (dest != NULL, NULL);
479   g_return_val_if_fail (src != NULL, NULL);
480   return stpcpy (dest, src);
481 #else
482   register gchar *d = dest;
483   register const gchar *s = src;
484
485   g_return_val_if_fail (dest != NULL, NULL);
486   g_return_val_if_fail (src != NULL, NULL);
487   do
488     *d++ = *s;
489   while (*s++ != '\0');
490
491   return d - 1;
492 #endif
493 }
494
495 /**
496  * g_strdup_vprintf:
497  * @format: a standard printf() format string, but notice
498  *     <link linkend="string-precision">string precision pitfalls</link>
499  * @args: the list of parameters to insert into the format string
500  *
501  * Similar to the standard C vsprintf() function but safer, since it
502  * calculates the maximum space required and allocates memory to hold
503  * the result. The returned string should be freed with g_free() when
504  * no longer needed.
505  *
506  * See also g_vasprintf(), which offers the same functionality, but
507  * additionally returns the length of the allocated string.
508  *
509  * Returns: a newly-allocated string holding the result
510  */
511 gchar*
512 g_strdup_vprintf (const gchar *format,
513                   va_list      args)
514 {
515   gchar *string = NULL;
516
517   g_vasprintf (&string, format, args);
518
519   return string;
520 }
521
522 /**
523  * g_strdup_printf:
524  * @format: a standard printf() format string, but notice
525  *     <link linkend="string-precision">string precision pitfalls</link>
526  * @...: the parameters to insert into the format string
527  *
528  * Similar to the standard C sprintf() function but safer, since it
529  * calculates the maximum space required and allocates memory to hold
530  * the result. The returned string should be freed with g_free() when no
531  * longer needed.
532  *
533  * Returns: a newly-allocated string holding the result
534  */
535 gchar*
536 g_strdup_printf (const gchar *format,
537                  ...)
538 {
539   gchar *buffer;
540   va_list args;
541
542   va_start (args, format);
543   buffer = g_strdup_vprintf (format, args);
544   va_end (args);
545
546   return buffer;
547 }
548
549 /**
550  * g_strconcat:
551  * @string1: the first string to add, which must not be %NULL
552  * @...: a %NULL-terminated list of strings to append to the string
553  *
554  * Concatenates all of the given strings into one long string.
555  * The returned string should be freed with g_free() when no longer needed.
556  *
557  * Note that this function is usually not the right function to use to
558  * assemble a translated message from pieces, since proper translation
559  * often requires the pieces to be reordered.
560  *
561  * <warning><para>The variable argument list <emphasis>must</emphasis> end
562  * with %NULL. If you forget the %NULL, g_strconcat() will start appending
563  * random memory junk to your string.</para></warning>
564  *
565  * Returns: a newly-allocated string containing all the string arguments
566  */
567 gchar*
568 g_strconcat (const gchar *string1, ...)
569 {
570   gsize   l;
571   va_list args;
572   gchar   *s;
573   gchar   *concat;
574   gchar   *ptr;
575
576   if (!string1)
577     return NULL;
578
579   l = 1 + strlen (string1);
580   va_start (args, string1);
581   s = va_arg (args, gchar*);
582   while (s)
583     {
584       l += strlen (s);
585       s = va_arg (args, gchar*);
586     }
587   va_end (args);
588
589   concat = g_new (gchar, l);
590   ptr = concat;
591
592   ptr = g_stpcpy (ptr, string1);
593   va_start (args, string1);
594   s = va_arg (args, gchar*);
595   while (s)
596     {
597       ptr = g_stpcpy (ptr, s);
598       s = va_arg (args, gchar*);
599     }
600   va_end (args);
601
602   return concat;
603 }
604
605 /**
606  * g_strtod:
607  * @nptr:    the string to convert to a numeric value.
608  * @endptr:  if non-%NULL, it returns the character after
609  *           the last character used in the conversion.
610  *
611  * Converts a string to a #gdouble value.
612  * It calls the standard strtod() function to handle the conversion, but
613  * if the string is not completely converted it attempts the conversion
614  * again with g_ascii_strtod(), and returns the best match.
615  *
616  * This function should seldom be used. The normal situation when reading
617  * numbers not for human consumption is to use g_ascii_strtod(). Only when
618  * you know that you must expect both locale formatted and C formatted numbers
619  * should you use this. Make sure that you don't pass strings such as comma
620  * separated lists of values, since the commas may be interpreted as a decimal
621  * point in some locales, causing unexpected results.
622  *
623  * Return value: the #gdouble value.
624  **/
625 gdouble
626 g_strtod (const gchar *nptr,
627           gchar      **endptr)
628 {
629   gchar *fail_pos_1;
630   gchar *fail_pos_2;
631   gdouble val_1;
632   gdouble val_2 = 0;
633
634   g_return_val_if_fail (nptr != NULL, 0);
635
636   fail_pos_1 = NULL;
637   fail_pos_2 = NULL;
638
639   val_1 = strtod (nptr, &fail_pos_1);
640
641   if (fail_pos_1 && fail_pos_1[0] != 0)
642     val_2 = g_ascii_strtod (nptr, &fail_pos_2);
643
644   if (!fail_pos_1 || fail_pos_1[0] == 0 || fail_pos_1 >= fail_pos_2)
645     {
646       if (endptr)
647         *endptr = fail_pos_1;
648       return val_1;
649     }
650   else
651     {
652       if (endptr)
653         *endptr = fail_pos_2;
654       return val_2;
655     }
656 }
657
658 /**
659  * g_ascii_strtod:
660  * @nptr:    the string to convert to a numeric value.
661  * @endptr:  if non-%NULL, it returns the character after
662  *           the last character used in the conversion.
663  *
664  * Converts a string to a #gdouble value.
665  *
666  * This function behaves like the standard strtod() function
667  * does in the C locale. It does this without actually changing
668  * the current locale, since that would not be thread-safe.
669  * A limitation of the implementation is that this function
670  * will still accept localized versions of infinities and NANs.
671  *
672  * This function is typically used when reading configuration
673  * files or other non-user input that should be locale independent.
674  * To handle input from the user you should normally use the
675  * locale-sensitive system strtod() function.
676  *
677  * To convert from a #gdouble to a string in a locale-insensitive
678  * way, use g_ascii_dtostr().
679  *
680  * If the correct value would cause overflow, plus or minus <literal>HUGE_VAL</literal>
681  * is returned (according to the sign of the value), and <literal>ERANGE</literal> is
682  * stored in <literal>errno</literal>. If the correct value would cause underflow,
683  * zero is returned and <literal>ERANGE</literal> is stored in <literal>errno</literal>.
684  *
685  * This function resets <literal>errno</literal> before calling strtod() so that
686  * you can reliably detect overflow and underflow.
687  *
688  * Return value: the #gdouble value.
689  */
690 gdouble
691 g_ascii_strtod (const gchar *nptr,
692                 gchar      **endptr)
693 {
694 #ifdef USE_XLOCALE
695
696   g_return_val_if_fail (nptr != NULL, 0);
697
698   errno = 0;
699
700   return strtod_l (nptr, endptr, get_C_locale ());
701
702 #else
703
704   gchar *fail_pos;
705   gdouble val;
706 #ifndef __BIONIC__
707   struct lconv *locale_data;
708 #endif
709   const char *decimal_point;
710   int decimal_point_len;
711   const char *p, *decimal_point_pos;
712   const char *end = NULL; /* Silence gcc */
713   int strtod_errno;
714
715   g_return_val_if_fail (nptr != NULL, 0);
716
717   fail_pos = NULL;
718
719 #ifndef __BIONIC__
720   locale_data = localeconv ();
721   decimal_point = locale_data->decimal_point;
722   decimal_point_len = strlen (decimal_point);
723 #else
724   decimal_point = ".";
725   decimal_point_len = 1;
726 #endif
727
728   g_assert (decimal_point_len != 0);
729
730   decimal_point_pos = NULL;
731   end = NULL;
732
733   if (decimal_point[0] != '.' ||
734       decimal_point[1] != 0)
735     {
736       p = nptr;
737       /* Skip leading space */
738       while (g_ascii_isspace (*p))
739         p++;
740
741       /* Skip leading optional sign */
742       if (*p == '+' || *p == '-')
743         p++;
744
745       if (p[0] == '0' &&
746           (p[1] == 'x' || p[1] == 'X'))
747         {
748           p += 2;
749           /* HEX - find the (optional) decimal point */
750
751           while (g_ascii_isxdigit (*p))
752             p++;
753
754           if (*p == '.')
755             decimal_point_pos = p++;
756
757           while (g_ascii_isxdigit (*p))
758             p++;
759
760           if (*p == 'p' || *p == 'P')
761             p++;
762           if (*p == '+' || *p == '-')
763             p++;
764           while (g_ascii_isdigit (*p))
765             p++;
766
767           end = p;
768         }
769       else if (g_ascii_isdigit (*p) || *p == '.')
770         {
771           while (g_ascii_isdigit (*p))
772             p++;
773
774           if (*p == '.')
775             decimal_point_pos = p++;
776
777           while (g_ascii_isdigit (*p))
778             p++;
779
780           if (*p == 'e' || *p == 'E')
781             p++;
782           if (*p == '+' || *p == '-')
783             p++;
784           while (g_ascii_isdigit (*p))
785             p++;
786
787           end = p;
788         }
789       /* For the other cases, we need not convert the decimal point */
790     }
791
792   if (decimal_point_pos)
793     {
794       char *copy, *c;
795
796       /* We need to convert the '.' to the locale specific decimal point */
797       copy = g_malloc (end - nptr + 1 + decimal_point_len);
798
799       c = copy;
800       memcpy (c, nptr, decimal_point_pos - nptr);
801       c += decimal_point_pos - nptr;
802       memcpy (c, decimal_point, decimal_point_len);
803       c += decimal_point_len;
804       memcpy (c, decimal_point_pos + 1, end - (decimal_point_pos + 1));
805       c += end - (decimal_point_pos + 1);
806       *c = 0;
807
808       errno = 0;
809       val = strtod (copy, &fail_pos);
810       strtod_errno = errno;
811
812       if (fail_pos)
813         {
814           if (fail_pos - copy > decimal_point_pos - nptr)
815             fail_pos = (char *)nptr + (fail_pos - copy) - (decimal_point_len - 1);
816           else
817             fail_pos = (char *)nptr + (fail_pos - copy);
818         }
819
820       g_free (copy);
821
822     }
823   else if (end)
824     {
825       char *copy;
826
827       copy = g_malloc (end - (char *)nptr + 1);
828       memcpy (copy, nptr, end - nptr);
829       *(copy + (end - (char *)nptr)) = 0;
830
831       errno = 0;
832       val = strtod (copy, &fail_pos);
833       strtod_errno = errno;
834
835       if (fail_pos)
836         {
837           fail_pos = (char *)nptr + (fail_pos - copy);
838         }
839
840       g_free (copy);
841     }
842   else
843     {
844       errno = 0;
845       val = strtod (nptr, &fail_pos);
846       strtod_errno = errno;
847     }
848
849   if (endptr)
850     *endptr = fail_pos;
851
852   errno = strtod_errno;
853
854   return val;
855 #endif
856 }
857
858
859 /**
860  * g_ascii_dtostr:
861  * @buffer: A buffer to place the resulting string in
862  * @buf_len: The length of the buffer.
863  * @d: The #gdouble to convert
864  *
865  * Converts a #gdouble to a string, using the '.' as
866  * decimal point.
867  *
868  * This function generates enough precision that converting
869  * the string back using g_ascii_strtod() gives the same machine-number
870  * (on machines with IEEE compatible 64bit doubles). It is
871  * guaranteed that the size of the resulting string will never
872  * be larger than @G_ASCII_DTOSTR_BUF_SIZE bytes.
873  *
874  * Return value: The pointer to the buffer with the converted string.
875  **/
876 gchar *
877 g_ascii_dtostr (gchar       *buffer,
878                 gint         buf_len,
879                 gdouble      d)
880 {
881   return g_ascii_formatd (buffer, buf_len, "%.17g", d);
882 }
883
884 #pragma GCC diagnostic push
885 #pragma GCC diagnostic ignored "-Wformat-nonliteral"
886
887 /**
888  * g_ascii_formatd:
889  * @buffer: A buffer to place the resulting string in
890  * @buf_len: The length of the buffer.
891  * @format: The printf()-style format to use for the
892  *          code to use for converting.
893  * @d: The #gdouble to convert
894  *
895  * Converts a #gdouble to a string, using the '.' as
896  * decimal point. To format the number you pass in
897  * a printf()-style format string. Allowed conversion
898  * specifiers are 'e', 'E', 'f', 'F', 'g' and 'G'.
899  *
900  * If you just want to want to serialize the value into a
901  * string, use g_ascii_dtostr().
902  *
903  * Return value: The pointer to the buffer with the converted string.
904  */
905 gchar *
906 g_ascii_formatd (gchar       *buffer,
907                  gint         buf_len,
908                  const gchar *format,
909                  gdouble      d)
910 {
911 #ifdef USE_XLOCALE
912   locale_t old_locale;
913
914   old_locale = uselocale (get_C_locale ());
915    _g_snprintf (buffer, buf_len, format, d);
916   uselocale (old_locale);
917
918   return buffer;
919 #else
920 #ifndef __BIONIC__
921   struct lconv *locale_data;
922 #endif
923   const char *decimal_point;
924   int decimal_point_len;
925   gchar *p;
926   int rest_len;
927   gchar format_char;
928
929   g_return_val_if_fail (buffer != NULL, NULL);
930   g_return_val_if_fail (format[0] == '%', NULL);
931   g_return_val_if_fail (strpbrk (format + 1, "'l%") == NULL, NULL);
932
933   format_char = format[strlen (format) - 1];
934
935   g_return_val_if_fail (format_char == 'e' || format_char == 'E' ||
936                         format_char == 'f' || format_char == 'F' ||
937                         format_char == 'g' || format_char == 'G',
938                         NULL);
939
940   if (format[0] != '%')
941     return NULL;
942
943   if (strpbrk (format + 1, "'l%"))
944     return NULL;
945
946   if (!(format_char == 'e' || format_char == 'E' ||
947         format_char == 'f' || format_char == 'F' ||
948         format_char == 'g' || format_char == 'G'))
949     return NULL;
950
951   _g_snprintf (buffer, buf_len, format, d);
952
953 #ifndef __BIONIC__
954   locale_data = localeconv ();
955   decimal_point = locale_data->decimal_point;
956   decimal_point_len = strlen (decimal_point);
957 #else
958   decimal_point = ".";
959   decimal_point_len = 1;
960 #endif
961
962   g_assert (decimal_point_len != 0);
963
964   if (decimal_point[0] != '.' ||
965       decimal_point[1] != 0)
966     {
967       p = buffer;
968
969       while (g_ascii_isspace (*p))
970         p++;
971
972       if (*p == '+' || *p == '-')
973         p++;
974
975       while (isdigit ((guchar)*p))
976         p++;
977
978       if (strncmp (p, decimal_point, decimal_point_len) == 0)
979         {
980           *p = '.';
981           p++;
982           if (decimal_point_len > 1)
983             {
984               rest_len = strlen (p + (decimal_point_len-1));
985               memmove (p, p + (decimal_point_len-1), rest_len);
986               p[rest_len] = 0;
987             }
988         }
989     }
990
991   return buffer;
992 #endif
993 }
994 #pragma GCC diagnostic pop
995
996 #define ISSPACE(c)              ((c) == ' ' || (c) == '\f' || (c) == '\n' || \
997                                  (c) == '\r' || (c) == '\t' || (c) == '\v')
998 #define ISUPPER(c)              ((c) >= 'A' && (c) <= 'Z')
999 #define ISLOWER(c)              ((c) >= 'a' && (c) <= 'z')
1000 #define ISALPHA(c)              (ISUPPER (c) || ISLOWER (c))
1001 #define TOUPPER(c)              (ISLOWER (c) ? (c) - 'a' + 'A' : (c))
1002 #define TOLOWER(c)              (ISUPPER (c) ? (c) - 'A' + 'a' : (c))
1003
1004 #ifndef USE_XLOCALE
1005
1006 static guint64
1007 g_parse_long_long (const gchar  *nptr,
1008                    const gchar **endptr,
1009                    guint         base,
1010                    gboolean     *negative)
1011 {
1012   /* this code is based on on the strtol(3) code from GNU libc released under
1013    * the GNU Lesser General Public License.
1014    *
1015    * Copyright (C) 1991,92,94,95,96,97,98,99,2000,01,02
1016    *        Free Software Foundation, Inc.
1017    */
1018   gboolean overflow;
1019   guint64 cutoff;
1020   guint64 cutlim;
1021   guint64 ui64;
1022   const gchar *s, *save;
1023   guchar c;
1024
1025   g_return_val_if_fail (nptr != NULL, 0);
1026
1027   *negative = FALSE;
1028   if (base == 1 || base > 36)
1029     {
1030       errno = EINVAL;
1031       if (endptr)
1032         *endptr = nptr;
1033       return 0;
1034     }
1035
1036   save = s = nptr;
1037
1038   /* Skip white space.  */
1039   while (ISSPACE (*s))
1040     ++s;
1041
1042   if (G_UNLIKELY (!*s))
1043     goto noconv;
1044
1045   /* Check for a sign.  */
1046   if (*s == '-')
1047     {
1048       *negative = TRUE;
1049       ++s;
1050     }
1051   else if (*s == '+')
1052     ++s;
1053
1054   /* Recognize number prefix and if BASE is zero, figure it out ourselves.  */
1055   if (*s == '0')
1056     {
1057       if ((base == 0 || base == 16) && TOUPPER (s[1]) == 'X')
1058         {
1059           s += 2;
1060           base = 16;
1061         }
1062       else if (base == 0)
1063         base = 8;
1064     }
1065   else if (base == 0)
1066     base = 10;
1067
1068   /* Save the pointer so we can check later if anything happened.  */
1069   save = s;
1070   cutoff = G_MAXUINT64 / base;
1071   cutlim = G_MAXUINT64 % base;
1072
1073   overflow = FALSE;
1074   ui64 = 0;
1075   c = *s;
1076   for (; c; c = *++s)
1077     {
1078       if (c >= '0' && c <= '9')
1079         c -= '0';
1080       else if (ISALPHA (c))
1081         c = TOUPPER (c) - 'A' + 10;
1082       else
1083         break;
1084       if (c >= base)
1085         break;
1086       /* Check for overflow.  */
1087       if (ui64 > cutoff || (ui64 == cutoff && c > cutlim))
1088         overflow = TRUE;
1089       else
1090         {
1091           ui64 *= base;
1092           ui64 += c;
1093         }
1094     }
1095
1096   /* Check if anything actually happened.  */
1097   if (s == save)
1098     goto noconv;
1099
1100   /* Store in ENDPTR the address of one character
1101      past the last character we converted.  */
1102   if (endptr)
1103     *endptr = s;
1104
1105   if (G_UNLIKELY (overflow))
1106     {
1107       errno = ERANGE;
1108       return G_MAXUINT64;
1109     }
1110
1111   return ui64;
1112
1113  noconv:
1114   /* We must handle a special case here: the base is 0 or 16 and the
1115      first two characters are '0' and 'x', but the rest are no
1116      hexadecimal digits.  This is no error case.  We return 0 and
1117      ENDPTR points to the `x`.  */
1118   if (endptr)
1119     {
1120       if (save - nptr >= 2 && TOUPPER (save[-1]) == 'X'
1121           && save[-2] == '0')
1122         *endptr = &save[-1];
1123       else
1124         /*  There was no number to convert.  */
1125         *endptr = nptr;
1126     }
1127   return 0;
1128 }
1129 #endif /* !USE_XLOCALE */
1130
1131 /**
1132  * g_ascii_strtoull:
1133  * @nptr:    the string to convert to a numeric value.
1134  * @endptr:  if non-%NULL, it returns the character after
1135  *           the last character used in the conversion.
1136  * @base:    to be used for the conversion, 2..36 or 0
1137  *
1138  * Converts a string to a #guint64 value.
1139  * This function behaves like the standard strtoull() function
1140  * does in the C locale. It does this without actually
1141  * changing the current locale, since that would not be
1142  * thread-safe.
1143  *
1144  * This function is typically used when reading configuration
1145  * files or other non-user input that should be locale independent.
1146  * To handle input from the user you should normally use the
1147  * locale-sensitive system strtoull() function.
1148  *
1149  * If the correct value would cause overflow, %G_MAXUINT64
1150  * is returned, and <literal>ERANGE</literal> is stored in <literal>errno</literal>.
1151  * If the base is outside the valid range, zero is returned, and
1152  * <literal>EINVAL</literal> is stored in <literal>errno</literal>.
1153  * If the string conversion fails, zero is returned, and @endptr returns
1154  * @nptr (if @endptr is non-%NULL).
1155  *
1156  * Return value: the #guint64 value or zero on error.
1157  *
1158  * Since: 2.2
1159  */
1160 guint64
1161 g_ascii_strtoull (const gchar *nptr,
1162                   gchar      **endptr,
1163                   guint        base)
1164 {
1165 #ifdef USE_XLOCALE
1166   return strtoull_l (nptr, endptr, base, get_C_locale ());
1167 #else
1168   gboolean negative;
1169   guint64 result;
1170
1171   result = g_parse_long_long (nptr, (const gchar **) endptr, base, &negative);
1172
1173   /* Return the result of the appropriate sign.  */
1174   return negative ? -result : result;
1175 #endif
1176 }
1177
1178 /**
1179  * g_ascii_strtoll:
1180  * @nptr:    the string to convert to a numeric value.
1181  * @endptr:  if non-%NULL, it returns the character after
1182  *           the last character used in the conversion.
1183  * @base:    to be used for the conversion, 2..36 or 0
1184  *
1185  * Converts a string to a #gint64 value.
1186  * This function behaves like the standard strtoll() function
1187  * does in the C locale. It does this without actually
1188  * changing the current locale, since that would not be
1189  * thread-safe.
1190  *
1191  * This function is typically used when reading configuration
1192  * files or other non-user input that should be locale independent.
1193  * To handle input from the user you should normally use the
1194  * locale-sensitive system strtoll() function.
1195  *
1196  * If the correct value would cause overflow, %G_MAXINT64 or %G_MININT64
1197  * is returned, and <literal>ERANGE</literal> is stored in <literal>errno</literal>.
1198  * If the base is outside the valid range, zero is returned, and
1199  * <literal>EINVAL</literal> is stored in <literal>errno</literal>. If the
1200  * string conversion fails, zero is returned, and @endptr returns @nptr
1201  * (if @endptr is non-%NULL).
1202  *
1203  * Return value: the #gint64 value or zero on error.
1204  *
1205  * Since: 2.12
1206  */
1207 gint64
1208 g_ascii_strtoll (const gchar *nptr,
1209                  gchar      **endptr,
1210                  guint        base)
1211 {
1212 #ifdef USE_XLOCALE
1213   return strtoll_l (nptr, endptr, base, get_C_locale ());
1214 #else
1215   gboolean negative;
1216   guint64 result;
1217
1218   result = g_parse_long_long (nptr, (const gchar **) endptr, base, &negative);
1219
1220   if (negative && result > (guint64) G_MININT64)
1221     {
1222       errno = ERANGE;
1223       return G_MININT64;
1224     }
1225   else if (!negative && result > (guint64) G_MAXINT64)
1226     {
1227       errno = ERANGE;
1228       return G_MAXINT64;
1229     }
1230   else if (negative)
1231     return - (gint64) result;
1232   else
1233     return (gint64) result;
1234 #endif
1235 }
1236
1237 /**
1238  * g_strerror:
1239  * @errnum: the system error number. See the standard C %errno
1240  *     documentation
1241  *
1242  * Returns a string corresponding to the given error code, e.g.
1243  * "no such process". You should use this function in preference to
1244  * strerror(), because it returns a string in UTF-8 encoding, and since
1245  * not all platforms support the strerror() function.
1246  *
1247  * Returns: a UTF-8 string describing the error code. If the error code
1248  *     is unknown, it returns "unknown error (&lt;code&gt;)".
1249  */
1250 const gchar *
1251 g_strerror (gint errnum)
1252 {
1253   gchar *msg;
1254   gchar *tofree = NULL;
1255   const gchar *ret;
1256   gint saved_errno = errno;
1257
1258   msg = strerror (errnum);
1259   if (!g_get_charset (NULL))
1260     msg = tofree = g_locale_to_utf8 (msg, -1, NULL, NULL, NULL);
1261
1262   ret = g_intern_string (msg);
1263   g_free (tofree);
1264   errno = saved_errno;
1265   return ret;
1266 }
1267
1268 /**
1269  * g_strsignal:
1270  * @signum: the signal number. See the <literal>signal</literal>
1271  *     documentation
1272  *
1273  * Returns a string describing the given signal, e.g. "Segmentation fault".
1274  * You should use this function in preference to strsignal(), because it
1275  * returns a string in UTF-8 encoding, and since not all platforms support
1276  * the strsignal() function.
1277  *
1278  * Returns: a UTF-8 string describing the signal. If the signal is unknown,
1279  *     it returns "unknown signal (&lt;signum&gt;)".
1280  */
1281 const gchar *
1282 g_strsignal (gint signum)
1283 {
1284   gchar *msg;
1285   gchar *tofree;
1286   const gchar *ret;
1287
1288   msg = tofree = NULL;
1289
1290 #ifdef HAVE_STRSIGNAL
1291   msg = strsignal (signum);
1292   if (!g_get_charset (NULL))
1293     msg = tofree = g_locale_to_utf8 (msg, -1, NULL, NULL, NULL);
1294 #endif
1295
1296   if (!msg)
1297     msg = tofree = g_strdup_printf ("unknown signal (%d)", signum);
1298   ret = g_intern_string (msg);
1299   g_free (tofree);
1300
1301   return ret;
1302 }
1303
1304 /* Functions g_strlcpy and g_strlcat were originally developed by
1305  * Todd C. Miller <Todd.Miller@courtesan.com> to simplify writing secure code.
1306  * See http://www.openbsd.org/cgi-bin/man.cgi?query=strlcpy 
1307  * for more information.
1308  */
1309
1310 #ifdef HAVE_STRLCPY
1311 /* Use the native ones, if available; they might be implemented in assembly */
1312 gsize
1313 g_strlcpy (gchar       *dest,
1314            const gchar *src,
1315            gsize        dest_size)
1316 {
1317   g_return_val_if_fail (dest != NULL, 0);
1318   g_return_val_if_fail (src  != NULL, 0);
1319
1320   return strlcpy (dest, src, dest_size);
1321 }
1322
1323 gsize
1324 g_strlcat (gchar       *dest,
1325            const gchar *src,
1326            gsize        dest_size)
1327 {
1328   g_return_val_if_fail (dest != NULL, 0);
1329   g_return_val_if_fail (src  != NULL, 0);
1330
1331   return strlcat (dest, src, dest_size);
1332 }
1333
1334 #else /* ! HAVE_STRLCPY */
1335 /**
1336  * g_strlcpy:
1337  * @dest: destination buffer
1338  * @src: source buffer
1339  * @dest_size: length of @dest in bytes
1340  *
1341  * Portability wrapper that calls strlcpy() on systems which have it,
1342  * and emulates strlcpy() otherwise. Copies @src to @dest; @dest is
1343  * guaranteed to be nul-terminated; @src must be nul-terminated;
1344  * @dest_size is the buffer size, not the number of chars to copy.
1345  *
1346  * At most dest_size - 1 characters will be copied. Always nul-terminates
1347  * (unless dest_size == 0). This function does <emphasis>not</emphasis>
1348  * allocate memory. Unlike strncpy(), this function doesn't pad dest (so
1349  * it's often faster). It returns the size of the attempted result,
1350  * strlen (src), so if @retval >= @dest_size, truncation occurred.
1351  *
1352  * <note><para>Caveat: strlcpy() is supposedly more secure than
1353  * strcpy() or strncpy(), but if you really want to avoid screwups,
1354  * g_strdup() is an even better idea.</para></note>
1355  *
1356  * Returns: length of @src
1357  */
1358 gsize
1359 g_strlcpy (gchar       *dest,
1360            const gchar *src,
1361            gsize        dest_size)
1362 {
1363   register gchar *d = dest;
1364   register const gchar *s = src;
1365   register gsize n = dest_size;
1366
1367   g_return_val_if_fail (dest != NULL, 0);
1368   g_return_val_if_fail (src  != NULL, 0);
1369
1370   /* Copy as many bytes as will fit */
1371   if (n != 0 && --n != 0)
1372     do
1373       {
1374         register gchar c = *s++;
1375
1376         *d++ = c;
1377         if (c == 0)
1378           break;
1379       }
1380     while (--n != 0);
1381
1382   /* If not enough room in dest, add NUL and traverse rest of src */
1383   if (n == 0)
1384     {
1385       if (dest_size != 0)
1386         *d = 0;
1387       while (*s++)
1388         ;
1389     }
1390
1391   return s - src - 1;  /* count does not include NUL */
1392 }
1393
1394 /**
1395  * g_strlcat:
1396  * @dest: destination buffer, already containing one nul-terminated string
1397  * @src: source buffer
1398  * @dest_size: length of @dest buffer in bytes (not length of existing string
1399  *     inside @dest)
1400  *
1401  * Portability wrapper that calls strlcat() on systems which have it,
1402  * and emulates it otherwise. Appends nul-terminated @src string to @dest,
1403  * guaranteeing nul-termination for @dest. The total size of @dest won't
1404  * exceed @dest_size.
1405  *
1406  * At most dest_size - 1 characters will be copied.
1407  * Unlike strncat, dest_size is the full size of dest, not the space left over.
1408  * This function does NOT allocate memory.
1409  * This always NUL terminates (unless siz == 0 or there were no NUL characters
1410  * in the dest_size characters of dest to start with).
1411  *
1412  * <note><para>Caveat: this is supposedly a more secure alternative to
1413  * strcat() or strncat(), but for real security g_strconcat() is harder
1414  * to mess up.</para></note>
1415  *
1416  * Returns: size of attempted result, which is MIN (dest_size, strlen
1417  *          (original dest)) + strlen (src), so if retval >= dest_size,
1418  *          truncation occurred.
1419  **/
1420 gsize
1421 g_strlcat (gchar       *dest,
1422            const gchar *src,
1423            gsize        dest_size)
1424 {
1425   register gchar *d = dest;
1426   register const gchar *s = src;
1427   register gsize bytes_left = dest_size;
1428   gsize dlength;  /* Logically, MIN (strlen (d), dest_size) */
1429
1430   g_return_val_if_fail (dest != NULL, 0);
1431   g_return_val_if_fail (src  != NULL, 0);
1432
1433   /* Find the end of dst and adjust bytes left but don't go past end */
1434   while (*d != 0 && bytes_left-- != 0)
1435     d++;
1436   dlength = d - dest;
1437   bytes_left = dest_size - dlength;
1438
1439   if (bytes_left == 0)
1440     return dlength + strlen (s);
1441
1442   while (*s != 0)
1443     {
1444       if (bytes_left != 1)
1445         {
1446           *d++ = *s;
1447           bytes_left--;
1448         }
1449       s++;
1450     }
1451   *d = 0;
1452
1453   return dlength + (s - src);  /* count does not include NUL */
1454 }
1455 #endif /* ! HAVE_STRLCPY */
1456
1457 /**
1458  * g_ascii_strdown:
1459  * @str: a string.
1460  * @len: length of @str in bytes, or -1 if @str is nul-terminated.
1461  *
1462  * Converts all upper case ASCII letters to lower case ASCII letters.
1463  *
1464  * Return value: a newly-allocated string, with all the upper case
1465  *               characters in @str converted to lower case, with
1466  *               semantics that exactly match g_ascii_tolower(). (Note
1467  *               that this is unlike the old g_strdown(), which modified
1468  *               the string in place.)
1469  **/
1470 gchar*
1471 g_ascii_strdown (const gchar *str,
1472                  gssize       len)
1473 {
1474   gchar *result, *s;
1475
1476   g_return_val_if_fail (str != NULL, NULL);
1477
1478   if (len < 0)
1479     len = strlen (str);
1480
1481   result = g_strndup (str, len);
1482   for (s = result; *s; s++)
1483     *s = g_ascii_tolower (*s);
1484
1485   return result;
1486 }
1487
1488 /**
1489  * g_ascii_strup:
1490  * @str: a string.
1491  * @len: length of @str in bytes, or -1 if @str is nul-terminated.
1492  *
1493  * Converts all lower case ASCII letters to upper case ASCII letters.
1494  *
1495  * Return value: a newly allocated string, with all the lower case
1496  *               characters in @str converted to upper case, with
1497  *               semantics that exactly match g_ascii_toupper(). (Note
1498  *               that this is unlike the old g_strup(), which modified
1499  *               the string in place.)
1500  **/
1501 gchar*
1502 g_ascii_strup (const gchar *str,
1503                gssize       len)
1504 {
1505   gchar *result, *s;
1506
1507   g_return_val_if_fail (str != NULL, NULL);
1508
1509   if (len < 0)
1510     len = strlen (str);
1511
1512   result = g_strndup (str, len);
1513   for (s = result; *s; s++)
1514     *s = g_ascii_toupper (*s);
1515
1516   return result;
1517 }
1518
1519 /**
1520  * g_str_is_ascii:
1521  * @string: a string.
1522  *
1523  * Determines if a string is pure ASCII.  A string is pure ASCII if it
1524  * contains no bytes with the high bit set.
1525  *
1526  * Returns: %TRUE if @string is ascii
1527  *
1528  * Since: 2.40
1529  **/
1530 gboolean
1531 g_str_is_ascii (const gchar *string)
1532 {
1533   gint i;
1534
1535   for (i = 0; string[i]; i++)
1536     if (string[i] & 0x80)
1537       return FALSE;
1538
1539   return TRUE;
1540 }
1541
1542 /**
1543  * g_strdown:
1544  * @string: the string to convert.
1545  *
1546  * Converts a string to lower case.
1547  *
1548  * Return value: the string
1549  *
1550  * Deprecated:2.2: This function is totally broken for the reasons discussed
1551  * in the g_strncasecmp() docs - use g_ascii_strdown() or g_utf8_strdown()
1552  * instead.
1553  **/
1554 gchar*
1555 g_strdown (gchar *string)
1556 {
1557   register guchar *s;
1558
1559   g_return_val_if_fail (string != NULL, NULL);
1560
1561   s = (guchar *) string;
1562
1563   while (*s)
1564     {
1565       if (isupper (*s))
1566         *s = tolower (*s);
1567       s++;
1568     }
1569
1570   return (gchar *) string;
1571 }
1572
1573 /**
1574  * g_strup:
1575  * @string: the string to convert.
1576  *
1577  * Converts a string to upper case.
1578  *
1579  * Return value: the string
1580  *
1581  * Deprecated:2.2: This function is totally broken for the reasons discussed
1582  * in the g_strncasecmp() docs - use g_ascii_strup() or g_utf8_strup() instead.
1583  **/
1584 gchar*
1585 g_strup (gchar *string)
1586 {
1587   register guchar *s;
1588
1589   g_return_val_if_fail (string != NULL, NULL);
1590
1591   s = (guchar *) string;
1592
1593   while (*s)
1594     {
1595       if (islower (*s))
1596         *s = toupper (*s);
1597       s++;
1598     }
1599
1600   return (gchar *) string;
1601 }
1602
1603 /**
1604  * g_strreverse:
1605  * @string: the string to reverse
1606  *
1607  * Reverses all of the bytes in a string. For example,
1608  * <literal>g_strreverse ("abcdef")</literal> will result
1609  * in "fedcba".
1610  *
1611  * Note that g_strreverse() doesn't work on UTF-8 strings
1612  * containing multibyte characters. For that purpose, use
1613  * g_utf8_strreverse().
1614  *
1615  * Returns: the same pointer passed in as @string
1616  */
1617 gchar*
1618 g_strreverse (gchar *string)
1619 {
1620   g_return_val_if_fail (string != NULL, NULL);
1621
1622   if (*string)
1623     {
1624       register gchar *h, *t;
1625
1626       h = string;
1627       t = string + strlen (string) - 1;
1628
1629       while (h < t)
1630         {
1631           register gchar c;
1632
1633           c = *h;
1634           *h = *t;
1635           h++;
1636           *t = c;
1637           t--;
1638         }
1639     }
1640
1641   return string;
1642 }
1643
1644 /**
1645  * g_ascii_tolower:
1646  * @c: any character.
1647  *
1648  * Convert a character to ASCII lower case.
1649  *
1650  * Unlike the standard C library tolower() function, this only
1651  * recognizes standard ASCII letters and ignores the locale, returning
1652  * all non-ASCII characters unchanged, even if they are lower case
1653  * letters in a particular character set. Also unlike the standard
1654  * library function, this takes and returns a char, not an int, so
1655  * don't call it on <literal>EOF</literal> but no need to worry about casting to #guchar
1656  * before passing a possibly non-ASCII character in.
1657  *
1658  * Return value: the result of converting @c to lower case.
1659  *               If @c is not an ASCII upper case letter,
1660  *               @c is returned unchanged.
1661  **/
1662 gchar
1663 g_ascii_tolower (gchar c)
1664 {
1665   return g_ascii_isupper (c) ? c - 'A' + 'a' : c;
1666 }
1667
1668 /**
1669  * g_ascii_toupper:
1670  * @c: any character.
1671  *
1672  * Convert a character to ASCII upper case.
1673  *
1674  * Unlike the standard C library toupper() function, this only
1675  * recognizes standard ASCII letters and ignores the locale, returning
1676  * all non-ASCII characters unchanged, even if they are upper case
1677  * letters in a particular character set. Also unlike the standard
1678  * library function, this takes and returns a char, not an int, so
1679  * don't call it on <literal>EOF</literal> but no need to worry about casting to #guchar
1680  * before passing a possibly non-ASCII character in.
1681  *
1682  * Return value: the result of converting @c to upper case.
1683  *               If @c is not an ASCII lower case letter,
1684  *               @c is returned unchanged.
1685  **/
1686 gchar
1687 g_ascii_toupper (gchar c)
1688 {
1689   return g_ascii_islower (c) ? c - 'a' + 'A' : c;
1690 }
1691
1692 /**
1693  * g_ascii_digit_value:
1694  * @c: an ASCII character.
1695  *
1696  * Determines the numeric value of a character as a decimal
1697  * digit. Differs from g_unichar_digit_value() because it takes
1698  * a char, so there's no worry about sign extension if characters
1699  * are signed.
1700  *
1701  * Return value: If @c is a decimal digit (according to
1702  * g_ascii_isdigit()), its numeric value. Otherwise, -1.
1703  **/
1704 int
1705 g_ascii_digit_value (gchar c)
1706 {
1707   if (g_ascii_isdigit (c))
1708     return c - '0';
1709   return -1;
1710 }
1711
1712 /**
1713  * g_ascii_xdigit_value:
1714  * @c: an ASCII character.
1715  *
1716  * Determines the numeric value of a character as a hexidecimal
1717  * digit. Differs from g_unichar_xdigit_value() because it takes
1718  * a char, so there's no worry about sign extension if characters
1719  * are signed.
1720  *
1721  * Return value: If @c is a hex digit (according to
1722  * g_ascii_isxdigit()), its numeric value. Otherwise, -1.
1723  **/
1724 int
1725 g_ascii_xdigit_value (gchar c)
1726 {
1727   if (c >= 'A' && c <= 'F')
1728     return c - 'A' + 10;
1729   if (c >= 'a' && c <= 'f')
1730     return c - 'a' + 10;
1731   return g_ascii_digit_value (c);
1732 }
1733
1734 /**
1735  * g_ascii_strcasecmp:
1736  * @s1: string to compare with @s2.
1737  * @s2: string to compare with @s1.
1738  *
1739  * Compare two strings, ignoring the case of ASCII characters.
1740  *
1741  * Unlike the BSD strcasecmp() function, this only recognizes standard
1742  * ASCII letters and ignores the locale, treating all non-ASCII
1743  * bytes as if they are not letters.
1744  *
1745  * This function should be used only on strings that are known to be
1746  * in encodings where the bytes corresponding to ASCII letters always
1747  * represent themselves. This includes UTF-8 and the ISO-8859-*
1748  * charsets, but not for instance double-byte encodings like the
1749  * Windows Codepage 932, where the trailing bytes of double-byte
1750  * characters include all ASCII letters. If you compare two CP932
1751  * strings using this function, you will get false matches.
1752  *
1753  * Both @s1 and @s2 must be non-%NULL.
1754  *
1755  * Return value: 0 if the strings match, a negative value if @s1 &lt; @s2,
1756  *   or a positive value if @s1 &gt; @s2.
1757  **/
1758 gint
1759 g_ascii_strcasecmp (const gchar *s1,
1760                     const gchar *s2)
1761 {
1762   gint c1, c2;
1763
1764   g_return_val_if_fail (s1 != NULL, 0);
1765   g_return_val_if_fail (s2 != NULL, 0);
1766
1767   while (*s1 && *s2)
1768     {
1769       c1 = (gint)(guchar) TOLOWER (*s1);
1770       c2 = (gint)(guchar) TOLOWER (*s2);
1771       if (c1 != c2)
1772         return (c1 - c2);
1773       s1++; s2++;
1774     }
1775
1776   return (((gint)(guchar) *s1) - ((gint)(guchar) *s2));
1777 }
1778
1779 /**
1780  * g_ascii_strncasecmp:
1781  * @s1: string to compare with @s2.
1782  * @s2: string to compare with @s1.
1783  * @n:  number of characters to compare.
1784  *
1785  * Compare @s1 and @s2, ignoring the case of ASCII characters and any
1786  * characters after the first @n in each string.
1787  *
1788  * Unlike the BSD strcasecmp() function, this only recognizes standard
1789  * ASCII letters and ignores the locale, treating all non-ASCII
1790  * characters as if they are not letters.
1791  *
1792  * The same warning as in g_ascii_strcasecmp() applies: Use this
1793  * function only on strings known to be in encodings where bytes
1794  * corresponding to ASCII letters always represent themselves.
1795  *
1796  * Return value: 0 if the strings match, a negative value if @s1 &lt; @s2,
1797  *   or a positive value if @s1 &gt; @s2.
1798  **/
1799 gint
1800 g_ascii_strncasecmp (const gchar *s1,
1801                      const gchar *s2,
1802                      gsize n)
1803 {
1804   gint c1, c2;
1805
1806   g_return_val_if_fail (s1 != NULL, 0);
1807   g_return_val_if_fail (s2 != NULL, 0);
1808
1809   while (n && *s1 && *s2)
1810     {
1811       n -= 1;
1812       c1 = (gint)(guchar) TOLOWER (*s1);
1813       c2 = (gint)(guchar) TOLOWER (*s2);
1814       if (c1 != c2)
1815         return (c1 - c2);
1816       s1++; s2++;
1817     }
1818
1819   if (n)
1820     return (((gint) (guchar) *s1) - ((gint) (guchar) *s2));
1821   else
1822     return 0;
1823 }
1824
1825 /**
1826  * g_strcasecmp:
1827  * @s1: a string.
1828  * @s2: a string to compare with @s1.
1829  *
1830  * A case-insensitive string comparison, corresponding to the standard
1831  * strcasecmp() function on platforms which support it.
1832  *
1833  * Return value: 0 if the strings match, a negative value if @s1 &lt; @s2,
1834  *   or a positive value if @s1 &gt; @s2.
1835  *
1836  * Deprecated:2.2: See g_strncasecmp() for a discussion of why this function
1837  *   is deprecated and how to replace it.
1838  **/
1839 gint
1840 g_strcasecmp (const gchar *s1,
1841               const gchar *s2)
1842 {
1843 #ifdef HAVE_STRCASECMP
1844   g_return_val_if_fail (s1 != NULL, 0);
1845   g_return_val_if_fail (s2 != NULL, 0);
1846
1847   return strcasecmp (s1, s2);
1848 #else
1849   gint c1, c2;
1850
1851   g_return_val_if_fail (s1 != NULL, 0);
1852   g_return_val_if_fail (s2 != NULL, 0);
1853
1854   while (*s1 && *s2)
1855     {
1856       /* According to A. Cox, some platforms have islower's that
1857        * don't work right on non-uppercase
1858        */
1859       c1 = isupper ((guchar)*s1) ? tolower ((guchar)*s1) : *s1;
1860       c2 = isupper ((guchar)*s2) ? tolower ((guchar)*s2) : *s2;
1861       if (c1 != c2)
1862         return (c1 - c2);
1863       s1++; s2++;
1864     }
1865
1866   return (((gint)(guchar) *s1) - ((gint)(guchar) *s2));
1867 #endif
1868 }
1869
1870 /**
1871  * g_strncasecmp:
1872  * @s1: a string.
1873  * @s2: a string to compare with @s1.
1874  * @n: the maximum number of characters to compare.
1875  *
1876  * A case-insensitive string comparison, corresponding to the standard
1877  * strncasecmp() function on platforms which support it.
1878  * It is similar to g_strcasecmp() except it only compares the first @n
1879  * characters of the strings.
1880  *
1881  * Return value: 0 if the strings match, a negative value if @s1 &lt; @s2,
1882  *   or a positive value if @s1 &gt; @s2.
1883  *
1884  * Deprecated:2.2: The problem with g_strncasecmp() is that it does the
1885  * comparison by calling toupper()/tolower(). These functions are
1886  * locale-specific and operate on single bytes. However, it is impossible
1887  * to handle things correctly from an I18N standpoint by operating on
1888  * bytes, since characters may be multibyte. Thus g_strncasecmp() is
1889  * broken if your string is guaranteed to be ASCII, since it's
1890  * locale-sensitive, and it's broken if your string is localized, since
1891  * it doesn't work on many encodings at all, including UTF-8, EUC-JP,
1892  * etc.
1893  *
1894  * There are therefore two replacement techniques: g_ascii_strncasecmp(),
1895  * which only works on ASCII and is not locale-sensitive, and
1896  * g_utf8_casefold() followed by strcmp() on the resulting strings, which is
1897  * good for case-insensitive sorting of UTF-8.
1898  **/
1899 gint
1900 g_strncasecmp (const gchar *s1,
1901                const gchar *s2,
1902                guint n)
1903 {
1904 #ifdef HAVE_STRNCASECMP
1905   return strncasecmp (s1, s2, n);
1906 #else
1907   gint c1, c2;
1908
1909   g_return_val_if_fail (s1 != NULL, 0);
1910   g_return_val_if_fail (s2 != NULL, 0);
1911
1912   while (n && *s1 && *s2)
1913     {
1914       n -= 1;
1915       /* According to A. Cox, some platforms have islower's that
1916        * don't work right on non-uppercase
1917        */
1918       c1 = isupper ((guchar)*s1) ? tolower ((guchar)*s1) : *s1;
1919       c2 = isupper ((guchar)*s2) ? tolower ((guchar)*s2) : *s2;
1920       if (c1 != c2)
1921         return (c1 - c2);
1922       s1++; s2++;
1923     }
1924
1925   if (n)
1926     return (((gint) (guchar) *s1) - ((gint) (guchar) *s2));
1927   else
1928     return 0;
1929 #endif
1930 }
1931
1932 /**
1933  * g_strdelimit:
1934  * @string: the string to convert
1935  * @delimiters: (allow-none): a string containing the current delimiters, or %NULL
1936  *     to use the standard delimiters defined in #G_STR_DELIMITERS
1937  * @new_delimiter: the new delimiter character
1938  *
1939  * Converts any delimiter characters in @string to @new_delimiter.
1940  * Any characters in @string which are found in @delimiters are
1941  * changed to the @new_delimiter character. Modifies @string in place,
1942  * and returns @string itself, not a copy. The return value is to
1943  * allow nesting such as
1944  * |[
1945  *   g_ascii_strup (g_strdelimit (str, "abc", '?'))
1946  * ]|
1947  *
1948  * Returns: @string
1949  */
1950 gchar *
1951 g_strdelimit (gchar       *string,
1952               const gchar *delimiters,
1953               gchar        new_delim)
1954 {
1955   register gchar *c;
1956
1957   g_return_val_if_fail (string != NULL, NULL);
1958
1959   if (!delimiters)
1960     delimiters = G_STR_DELIMITERS;
1961
1962   for (c = string; *c; c++)
1963     {
1964       if (strchr (delimiters, *c))
1965         *c = new_delim;
1966     }
1967
1968   return string;
1969 }
1970
1971 /**
1972  * g_strcanon:
1973  * @string: a nul-terminated array of bytes
1974  * @valid_chars: bytes permitted in @string
1975  * @substitutor: replacement character for disallowed bytes
1976  *
1977  * For each character in @string, if the character is not in
1978  * @valid_chars, replaces the character with @substitutor.
1979  * Modifies @string in place, and return @string itself, not
1980  * a copy. The return value is to allow nesting such as
1981  * |[
1982  *   g_ascii_strup (g_strcanon (str, "abc", '?'))
1983  * ]|
1984  *
1985  * Returns: @string
1986  */
1987 gchar *
1988 g_strcanon (gchar       *string,
1989             const gchar *valid_chars,
1990             gchar        substitutor)
1991 {
1992   register gchar *c;
1993
1994   g_return_val_if_fail (string != NULL, NULL);
1995   g_return_val_if_fail (valid_chars != NULL, NULL);
1996
1997   for (c = string; *c; c++)
1998     {
1999       if (!strchr (valid_chars, *c))
2000         *c = substitutor;
2001     }
2002
2003   return string;
2004 }
2005
2006 /**
2007  * g_strcompress:
2008  * @source: a string to compress
2009  *
2010  * Replaces all escaped characters with their one byte equivalent.
2011  *
2012  * This function does the reverse conversion of g_strescape().
2013  *
2014  * Returns: a newly-allocated copy of @source with all escaped
2015  *     character compressed
2016  */
2017 gchar *
2018 g_strcompress (const gchar *source)
2019 {
2020   const gchar *p = source, *octal;
2021   gchar *dest;
2022   gchar *q;
2023
2024   g_return_val_if_fail (source != NULL, NULL);
2025
2026   dest = g_malloc (strlen (source) + 1);
2027   q = dest;
2028
2029   while (*p)
2030     {
2031       if (*p == '\\')
2032         {
2033           p++;
2034           switch (*p)
2035             {
2036             case '\0':
2037               g_warning ("g_strcompress: trailing \\");
2038               goto out;
2039             case '0':  case '1':  case '2':  case '3':  case '4':
2040             case '5':  case '6':  case '7':
2041               *q = 0;
2042               octal = p;
2043               while ((p < octal + 3) && (*p >= '0') && (*p <= '7'))
2044                 {
2045                   *q = (*q * 8) + (*p - '0');
2046                   p++;
2047                 }
2048               q++;
2049               p--;
2050               break;
2051             case 'b':
2052               *q++ = '\b';
2053               break;
2054             case 'f':
2055               *q++ = '\f';
2056               break;
2057             case 'n':
2058               *q++ = '\n';
2059               break;
2060             case 'r':
2061               *q++ = '\r';
2062               break;
2063             case 't':
2064               *q++ = '\t';
2065               break;
2066             case 'v':
2067               *q++ = '\v';
2068               break;
2069             default:            /* Also handles \" and \\ */
2070               *q++ = *p;
2071               break;
2072             }
2073         }
2074       else
2075         *q++ = *p;
2076       p++;
2077     }
2078 out:
2079   *q = 0;
2080
2081   return dest;
2082 }
2083
2084 /**
2085  * g_strescape:
2086  * @source: a string to escape
2087  * @exceptions: a string of characters not to escape in @source
2088  *
2089  * Escapes the special characters '\b', '\f', '\n', '\r', '\t', '\v', '\'
2090  * and '&quot;' in the string @source by inserting a '\' before
2091  * them. Additionally all characters in the range 0x01-0x1F (everything
2092  * below SPACE) and in the range 0x7F-0xFF (all non-ASCII chars) are
2093  * replaced with a '\' followed by their octal representation.
2094  * Characters supplied in @exceptions are not escaped.
2095  *
2096  * g_strcompress() does the reverse conversion.
2097  *
2098  * Returns: a newly-allocated copy of @source with certain
2099  *     characters escaped. See above.
2100  */
2101 gchar *
2102 g_strescape (const gchar *source,
2103              const gchar *exceptions)
2104 {
2105   const guchar *p;
2106   gchar *dest;
2107   gchar *q;
2108   guchar excmap[256];
2109
2110   g_return_val_if_fail (source != NULL, NULL);
2111
2112   p = (guchar *) source;
2113   /* Each source byte needs maximally four destination chars (\777) */
2114   q = dest = g_malloc (strlen (source) * 4 + 1);
2115
2116   memset (excmap, 0, 256);
2117   if (exceptions)
2118     {
2119       guchar *e = (guchar *) exceptions;
2120
2121       while (*e)
2122         {
2123           excmap[*e] = 1;
2124           e++;
2125         }
2126     }
2127
2128   while (*p)
2129     {
2130       if (excmap[*p])
2131         *q++ = *p;
2132       else
2133         {
2134           switch (*p)
2135             {
2136             case '\b':
2137               *q++ = '\\';
2138               *q++ = 'b';
2139               break;
2140             case '\f':
2141               *q++ = '\\';
2142               *q++ = 'f';
2143               break;
2144             case '\n':
2145               *q++ = '\\';
2146               *q++ = 'n';
2147               break;
2148             case '\r':
2149               *q++ = '\\';
2150               *q++ = 'r';
2151               break;
2152             case '\t':
2153               *q++ = '\\';
2154               *q++ = 't';
2155               break;
2156             case '\v':
2157               *q++ = '\\';
2158               *q++ = 'v';
2159               break;
2160             case '\\':
2161               *q++ = '\\';
2162               *q++ = '\\';
2163               break;
2164             case '"':
2165               *q++ = '\\';
2166               *q++ = '"';
2167               break;
2168             default:
2169               if ((*p < ' ') || (*p >= 0177))
2170                 {
2171                   *q++ = '\\';
2172                   *q++ = '0' + (((*p) >> 6) & 07);
2173                   *q++ = '0' + (((*p) >> 3) & 07);
2174                   *q++ = '0' + ((*p) & 07);
2175                 }
2176               else
2177                 *q++ = *p;
2178               break;
2179             }
2180         }
2181       p++;
2182     }
2183   *q = 0;
2184   return dest;
2185 }
2186
2187 /**
2188  * g_strchug:
2189  * @string: a string to remove the leading whitespace from
2190  *
2191  * Removes leading whitespace from a string, by moving the rest
2192  * of the characters forward.
2193  *
2194  * This function doesn't allocate or reallocate any memory;
2195  * it modifies @string in place. The pointer to @string is
2196  * returned to allow the nesting of functions.
2197  *
2198  * Also see g_strchomp() and g_strstrip().
2199  *
2200  * Returns: @string
2201  */
2202 gchar *
2203 g_strchug (gchar *string)
2204 {
2205   guchar *start;
2206
2207   g_return_val_if_fail (string != NULL, NULL);
2208
2209   for (start = (guchar*) string; *start && g_ascii_isspace (*start); start++)
2210     ;
2211
2212   memmove (string, start, strlen ((gchar *) start) + 1);
2213
2214   return string;
2215 }
2216
2217 /**
2218  * g_strchomp:
2219  * @string: a string to remove the trailing whitespace from
2220  *
2221  * Removes trailing whitespace from a string.
2222  *
2223  * This function doesn't allocate or reallocate any memory;
2224  * it modifies @string in place. The pointer to @string is
2225  * returned to allow the nesting of functions.
2226  *
2227  * Also see g_strchug() and g_strstrip().
2228  *
2229  * Returns: @string.
2230  */
2231 gchar *
2232 g_strchomp (gchar *string)
2233 {
2234   gsize len;
2235
2236   g_return_val_if_fail (string != NULL, NULL);
2237
2238   len = strlen (string);
2239   while (len--)
2240     {
2241       if (g_ascii_isspace ((guchar) string[len]))
2242         string[len] = '\0';
2243       else
2244         break;
2245     }
2246
2247   return string;
2248 }
2249
2250 /**
2251  * g_strsplit:
2252  * @string: a string to split
2253  * @delimiter: a string which specifies the places at which to split
2254  *     the string. The delimiter is not included in any of the resulting
2255  *     strings, unless @max_tokens is reached.
2256  * @max_tokens: the maximum number of pieces to split @string into.
2257  *     If this is less than 1, the string is split completely.
2258  *
2259  * Splits a string into a maximum of @max_tokens pieces, using the given
2260  * @delimiter. If @max_tokens is reached, the remainder of @string is
2261  * appended to the last token.
2262  *
2263  * As a special case, the result of splitting the empty string "" is an empty
2264  * vector, not a vector containing a single string. The reason for this
2265  * special case is that being able to represent a empty vector is typically
2266  * more useful than consistent handling of empty elements. If you do need
2267  * to represent empty elements, you'll need to check for the empty string
2268  * before calling g_strsplit().
2269  *
2270  * Return value: a newly-allocated %NULL-terminated array of strings. Use
2271  *    g_strfreev() to free it.
2272  */
2273 gchar**
2274 g_strsplit (const gchar *string,
2275             const gchar *delimiter,
2276             gint         max_tokens)
2277 {
2278   GSList *string_list = NULL, *slist;
2279   gchar **str_array, *s;
2280   guint n = 0;
2281   const gchar *remainder;
2282
2283   g_return_val_if_fail (string != NULL, NULL);
2284   g_return_val_if_fail (delimiter != NULL, NULL);
2285   g_return_val_if_fail (delimiter[0] != '\0', NULL);
2286
2287   if (max_tokens < 1)
2288     max_tokens = G_MAXINT;
2289
2290   remainder = string;
2291   s = strstr (remainder, delimiter);
2292   if (s)
2293     {
2294       gsize delimiter_len = strlen (delimiter);
2295
2296       while (--max_tokens && s)
2297         {
2298           gsize len;
2299
2300           len = s - remainder;
2301           string_list = g_slist_prepend (string_list,
2302                                          g_strndup (remainder, len));
2303           n++;
2304           remainder = s + delimiter_len;
2305           s = strstr (remainder, delimiter);
2306         }
2307     }
2308   if (*string)
2309     {
2310       n++;
2311       string_list = g_slist_prepend (string_list, g_strdup (remainder));
2312     }
2313
2314   str_array = g_new (gchar*, n + 1);
2315
2316   str_array[n--] = NULL;
2317   for (slist = string_list; slist; slist = slist->next)
2318     str_array[n--] = slist->data;
2319
2320   g_slist_free (string_list);
2321
2322   return str_array;
2323 }
2324
2325 /**
2326  * g_strsplit_set:
2327  * @string: The string to be tokenized
2328  * @delimiters: A nul-terminated string containing bytes that are used
2329  *     to split the string.
2330  * @max_tokens: The maximum number of tokens to split @string into.
2331  *     If this is less than 1, the string is split completely
2332  *
2333  * Splits @string into a number of tokens not containing any of the characters
2334  * in @delimiter. A token is the (possibly empty) longest string that does not
2335  * contain any of the characters in @delimiters. If @max_tokens is reached, the
2336  * remainder is appended to the last token.
2337  *
2338  * For example the result of g_strsplit_set ("abc:def/ghi", ":/", -1) is a
2339  * %NULL-terminated vector containing the three strings "abc", "def",
2340  * and "ghi".
2341  *
2342  * The result if g_strsplit_set (":def/ghi:", ":/", -1) is a %NULL-terminated
2343  * vector containing the four strings "", "def", "ghi", and "".
2344  *
2345  * As a special case, the result of splitting the empty string "" is an empty
2346  * vector, not a vector containing a single string. The reason for this
2347  * special case is that being able to represent a empty vector is typically
2348  * more useful than consistent handling of empty elements. If you do need
2349  * to represent empty elements, you'll need to check for the empty string
2350  * before calling g_strsplit_set().
2351  *
2352  * Note that this function works on bytes not characters, so it can't be used
2353  * to delimit UTF-8 strings for anything but ASCII characters.
2354  *
2355  * Return value: a newly-allocated %NULL-terminated array of strings. Use
2356  *    g_strfreev() to free it.
2357  *
2358  * Since: 2.4
2359  **/
2360 gchar **
2361 g_strsplit_set (const gchar *string,
2362                 const gchar *delimiters,
2363                 gint         max_tokens)
2364 {
2365   gboolean delim_table[256];
2366   GSList *tokens, *list;
2367   gint n_tokens;
2368   const gchar *s;
2369   const gchar *current;
2370   gchar *token;
2371   gchar **result;
2372
2373   g_return_val_if_fail (string != NULL, NULL);
2374   g_return_val_if_fail (delimiters != NULL, NULL);
2375
2376   if (max_tokens < 1)
2377     max_tokens = G_MAXINT;
2378
2379   if (*string == '\0')
2380     {
2381       result = g_new (char *, 1);
2382       result[0] = NULL;
2383       return result;
2384     }
2385
2386   memset (delim_table, FALSE, sizeof (delim_table));
2387   for (s = delimiters; *s != '\0'; ++s)
2388     delim_table[*(guchar *)s] = TRUE;
2389
2390   tokens = NULL;
2391   n_tokens = 0;
2392
2393   s = current = string;
2394   while (*s != '\0')
2395     {
2396       if (delim_table[*(guchar *)s] && n_tokens + 1 < max_tokens)
2397         {
2398           token = g_strndup (current, s - current);
2399           tokens = g_slist_prepend (tokens, token);
2400           ++n_tokens;
2401
2402           current = s + 1;
2403         }
2404
2405       ++s;
2406     }
2407
2408   token = g_strndup (current, s - current);
2409   tokens = g_slist_prepend (tokens, token);
2410   ++n_tokens;
2411
2412   result = g_new (gchar *, n_tokens + 1);
2413
2414   result[n_tokens] = NULL;
2415   for (list = tokens; list != NULL; list = list->next)
2416     result[--n_tokens] = list->data;
2417
2418   g_slist_free (tokens);
2419
2420   return result;
2421 }
2422
2423 /**
2424  * g_strfreev:
2425  * @str_array: a %NULL-terminated array of strings to free
2426
2427  * Frees a %NULL-terminated array of strings, and the array itself.
2428  * If called on a %NULL value, g_strfreev() simply returns.
2429  **/
2430 void
2431 g_strfreev (gchar **str_array)
2432 {
2433   if (str_array)
2434     {
2435       int i;
2436
2437       for (i = 0; str_array[i] != NULL; i++)
2438         g_free (str_array[i]);
2439
2440       g_free (str_array);
2441     }
2442 }
2443
2444 /**
2445  * g_strdupv:
2446  * @str_array: a %NULL-terminated array of strings
2447  *
2448  * Copies %NULL-terminated array of strings. The copy is a deep copy;
2449  * the new array should be freed by first freeing each string, then
2450  * the array itself. g_strfreev() does this for you. If called
2451  * on a %NULL value, g_strdupv() simply returns %NULL.
2452  *
2453  * Return value: a new %NULL-terminated array of strings.
2454  */
2455 gchar**
2456 g_strdupv (gchar **str_array)
2457 {
2458   if (str_array)
2459     {
2460       gint i;
2461       gchar **retval;
2462
2463       i = 0;
2464       while (str_array[i])
2465         ++i;
2466
2467       retval = g_new (gchar*, i + 1);
2468
2469       i = 0;
2470       while (str_array[i])
2471         {
2472           retval[i] = g_strdup (str_array[i]);
2473           ++i;
2474         }
2475       retval[i] = NULL;
2476
2477       return retval;
2478     }
2479   else
2480     return NULL;
2481 }
2482
2483 /**
2484  * g_strjoinv:
2485  * @separator: (allow-none): a string to insert between each of the strings, or %NULL
2486  * @str_array: a %NULL-terminated array of strings to join
2487  *
2488  * Joins a number of strings together to form one long string, with the
2489  * optional @separator inserted between each of them. The returned string
2490  * should be freed with g_free().
2491  *
2492  * Returns: a newly-allocated string containing all of the strings joined
2493  *     together, with @separator between them
2494  */
2495 gchar*
2496 g_strjoinv (const gchar  *separator,
2497             gchar       **str_array)
2498 {
2499   gchar *string;
2500   gchar *ptr;
2501
2502   g_return_val_if_fail (str_array != NULL, NULL);
2503
2504   if (separator == NULL)
2505     separator = "";
2506
2507   if (*str_array)
2508     {
2509       gint i;
2510       gsize len;
2511       gsize separator_len;
2512
2513       separator_len = strlen (separator);
2514       /* First part, getting length */
2515       len = 1 + strlen (str_array[0]);
2516       for (i = 1; str_array[i] != NULL; i++)
2517         len += strlen (str_array[i]);
2518       len += separator_len * (i - 1);
2519
2520       /* Second part, building string */
2521       string = g_new (gchar, len);
2522       ptr = g_stpcpy (string, *str_array);
2523       for (i = 1; str_array[i] != NULL; i++)
2524         {
2525           ptr = g_stpcpy (ptr, separator);
2526           ptr = g_stpcpy (ptr, str_array[i]);
2527         }
2528       }
2529   else
2530     string = g_strdup ("");
2531
2532   return string;
2533 }
2534
2535 /**
2536  * g_strjoin:
2537  * @separator: (allow-none): a string to insert between each of the strings, or %NULL
2538  * @...: a %NULL-terminated list of strings to join
2539  *
2540  * Joins a number of strings together to form one long string, with the
2541  * optional @separator inserted between each of them. The returned string
2542  * should be freed with g_free().
2543  *
2544  * Returns: a newly-allocated string containing all of the strings joined
2545  *     together, with @separator between them
2546  */
2547 gchar*
2548 g_strjoin (const gchar *separator,
2549            ...)
2550 {
2551   gchar *string, *s;
2552   va_list args;
2553   gsize len;
2554   gsize separator_len;
2555   gchar *ptr;
2556
2557   if (separator == NULL)
2558     separator = "";
2559
2560   separator_len = strlen (separator);
2561
2562   va_start (args, separator);
2563
2564   s = va_arg (args, gchar*);
2565
2566   if (s)
2567     {
2568       /* First part, getting length */
2569       len = 1 + strlen (s);
2570
2571       s = va_arg (args, gchar*);
2572       while (s)
2573         {
2574           len += separator_len + strlen (s);
2575           s = va_arg (args, gchar*);
2576         }
2577       va_end (args);
2578
2579       /* Second part, building string */
2580       string = g_new (gchar, len);
2581
2582       va_start (args, separator);
2583
2584       s = va_arg (args, gchar*);
2585       ptr = g_stpcpy (string, s);
2586
2587       s = va_arg (args, gchar*);
2588       while (s)
2589         {
2590           ptr = g_stpcpy (ptr, separator);
2591           ptr = g_stpcpy (ptr, s);
2592           s = va_arg (args, gchar*);
2593         }
2594     }
2595   else
2596     string = g_strdup ("");
2597
2598   va_end (args);
2599
2600   return string;
2601 }
2602
2603
2604 /**
2605  * g_strstr_len:
2606  * @haystack: a string
2607  * @haystack_len: the maximum length of @haystack. Note that -1 is
2608  *     a valid length, if @haystack is nul-terminated, meaning it will
2609  *     search through the whole string.
2610  * @needle: the string to search for
2611  *
2612  * Searches the string @haystack for the first occurrence
2613  * of the string @needle, limiting the length of the search
2614  * to @haystack_len.
2615  *
2616  * Return value: a pointer to the found occurrence, or
2617  *    %NULL if not found.
2618  */
2619 gchar *
2620 g_strstr_len (const gchar *haystack,
2621               gssize       haystack_len,
2622               const gchar *needle)
2623 {
2624   g_return_val_if_fail (haystack != NULL, NULL);
2625   g_return_val_if_fail (needle != NULL, NULL);
2626
2627   if (haystack_len < 0)
2628     return strstr (haystack, needle);
2629   else
2630     {
2631       const gchar *p = haystack;
2632       gsize needle_len = strlen (needle);
2633       const gchar *end;
2634       gsize i;
2635
2636       if (needle_len == 0)
2637         return (gchar *)haystack;
2638
2639       if (haystack_len < needle_len)
2640         return NULL;
2641
2642       end = haystack + haystack_len - needle_len;
2643
2644       while (p <= end && *p)
2645         {
2646           for (i = 0; i < needle_len; i++)
2647             if (p[i] != needle[i])
2648               goto next;
2649
2650           return (gchar *)p;
2651
2652         next:
2653           p++;
2654         }
2655
2656       return NULL;
2657     }
2658 }
2659
2660 /**
2661  * g_strrstr:
2662  * @haystack: a nul-terminated string
2663  * @needle: the nul-terminated string to search for
2664  *
2665  * Searches the string @haystack for the last occurrence
2666  * of the string @needle.
2667  *
2668  * Return value: a pointer to the found occurrence, or
2669  *    %NULL if not found.
2670  */
2671 gchar *
2672 g_strrstr (const gchar *haystack,
2673            const gchar *needle)
2674 {
2675   gsize i;
2676   gsize needle_len;
2677   gsize haystack_len;
2678   const gchar *p;
2679
2680   g_return_val_if_fail (haystack != NULL, NULL);
2681   g_return_val_if_fail (needle != NULL, NULL);
2682
2683   needle_len = strlen (needle);
2684   haystack_len = strlen (haystack);
2685
2686   if (needle_len == 0)
2687     return (gchar *)haystack;
2688
2689   if (haystack_len < needle_len)
2690     return NULL;
2691
2692   p = haystack + haystack_len - needle_len;
2693
2694   while (p >= haystack)
2695     {
2696       for (i = 0; i < needle_len; i++)
2697         if (p[i] != needle[i])
2698           goto next;
2699
2700       return (gchar *)p;
2701
2702     next:
2703       p--;
2704     }
2705
2706   return NULL;
2707 }
2708
2709 /**
2710  * g_strrstr_len:
2711  * @haystack: a nul-terminated string
2712  * @haystack_len: the maximum length of @haystack
2713  * @needle: the nul-terminated string to search for
2714  *
2715  * Searches the string @haystack for the last occurrence
2716  * of the string @needle, limiting the length of the search
2717  * to @haystack_len.
2718  *
2719  * Return value: a pointer to the found occurrence, or
2720  *    %NULL if not found.
2721  */
2722 gchar *
2723 g_strrstr_len (const gchar *haystack,
2724                gssize        haystack_len,
2725                const gchar *needle)
2726 {
2727   g_return_val_if_fail (haystack != NULL, NULL);
2728   g_return_val_if_fail (needle != NULL, NULL);
2729
2730   if (haystack_len < 0)
2731     return g_strrstr (haystack, needle);
2732   else
2733     {
2734       gsize needle_len = strlen (needle);
2735       const gchar *haystack_max = haystack + haystack_len;
2736       const gchar *p = haystack;
2737       gsize i;
2738
2739       while (p < haystack_max && *p)
2740         p++;
2741
2742       if (p < haystack + needle_len)
2743         return NULL;
2744
2745       p -= needle_len;
2746
2747       while (p >= haystack)
2748         {
2749           for (i = 0; i < needle_len; i++)
2750             if (p[i] != needle[i])
2751               goto next;
2752
2753           return (gchar *)p;
2754
2755         next:
2756           p--;
2757         }
2758
2759       return NULL;
2760     }
2761 }
2762
2763
2764 /**
2765  * g_str_has_suffix:
2766  * @str: a nul-terminated string
2767  * @suffix: the nul-terminated suffix to look for
2768  *
2769  * Looks whether the string @str ends with @suffix.
2770  *
2771  * Return value: %TRUE if @str end with @suffix, %FALSE otherwise.
2772  *
2773  * Since: 2.2
2774  */
2775 gboolean
2776 g_str_has_suffix (const gchar *str,
2777                   const gchar *suffix)
2778 {
2779   int str_len;
2780   int suffix_len;
2781
2782   g_return_val_if_fail (str != NULL, FALSE);
2783   g_return_val_if_fail (suffix != NULL, FALSE);
2784
2785   str_len = strlen (str);
2786   suffix_len = strlen (suffix);
2787
2788   if (str_len < suffix_len)
2789     return FALSE;
2790
2791   return strcmp (str + str_len - suffix_len, suffix) == 0;
2792 }
2793
2794 /**
2795  * g_str_has_prefix:
2796  * @str: a nul-terminated string
2797  * @prefix: the nul-terminated prefix to look for
2798  *
2799  * Looks whether the string @str begins with @prefix.
2800  *
2801  * Return value: %TRUE if @str begins with @prefix, %FALSE otherwise.
2802  *
2803  * Since: 2.2
2804  */
2805 gboolean
2806 g_str_has_prefix (const gchar *str,
2807                   const gchar *prefix)
2808 {
2809   int str_len;
2810   int prefix_len;
2811
2812   g_return_val_if_fail (str != NULL, FALSE);
2813   g_return_val_if_fail (prefix != NULL, FALSE);
2814
2815   str_len = strlen (str);
2816   prefix_len = strlen (prefix);
2817
2818   if (str_len < prefix_len)
2819     return FALSE;
2820
2821   return strncmp (str, prefix, prefix_len) == 0;
2822 }
2823
2824 /**
2825  * g_strv_length:
2826  * @str_array: a %NULL-terminated array of strings
2827  *
2828  * Returns the length of the given %NULL-terminated
2829  * string array @str_array.
2830  *
2831  * Return value: length of @str_array.
2832  *
2833  * Since: 2.6
2834  */
2835 guint
2836 g_strv_length (gchar **str_array)
2837 {
2838   guint i = 0;
2839
2840   g_return_val_if_fail (str_array != NULL, 0);
2841
2842   while (str_array[i])
2843     ++i;
2844
2845   return i;
2846 }
2847
2848 static void
2849 index_add_folded (GPtrArray   *array,
2850                   const gchar *start,
2851                   const gchar *end)
2852 {
2853   gchar *normal;
2854
2855   normal = g_utf8_normalize (start, end - start, G_NORMALIZE_ALL_COMPOSE);
2856
2857   /* TODO: Invent time machine.  Converse with Mustafa Ataturk... */
2858   if (strstr (normal, "ı") || strstr (normal, "İ"))
2859     {
2860       gchar *s = normal;
2861       GString *tmp;
2862
2863       tmp = g_string_new (NULL);
2864
2865       while (*s)
2866         {
2867           gchar *i, *I, *e;
2868
2869           i = strstr (s, "ı");
2870           I = strstr (s, "İ");
2871
2872           if (!i && !I)
2873             break;
2874           else if (i && !I)
2875             e = i;
2876           else if (I && !i)
2877             e = I;
2878           else if (i < I)
2879             e = i;
2880           else
2881             e = I;
2882
2883           g_string_append_len (tmp, s, e - s);
2884           g_string_append_c (tmp, 'i');
2885           s = g_utf8_next_char (e);
2886         }
2887
2888       g_string_append (tmp, s);
2889       g_free (normal);
2890       normal = g_string_free (tmp, FALSE);
2891     }
2892
2893   g_ptr_array_add (array, g_utf8_casefold (normal, -1));
2894   g_free (normal);
2895 }
2896
2897 static gchar **
2898 split_words (const gchar *value)
2899 {
2900   const gchar *start = NULL;
2901   GPtrArray *result;
2902   const gchar *s;
2903
2904   result = g_ptr_array_new ();
2905
2906   for (s = value; *s; s = g_utf8_next_char (s))
2907     {
2908       gunichar c = g_utf8_get_char (s);
2909
2910       if (start == NULL)
2911         {
2912           if (g_unichar_isalnum (c) || g_unichar_ismark (c))
2913             start = s;
2914         }
2915       else
2916         {
2917           if (!g_unichar_isalnum (c) && !g_unichar_ismark (c))
2918             {
2919               index_add_folded (result, start, s);
2920               start = NULL;
2921             }
2922         }
2923     }
2924
2925   if (start)
2926     index_add_folded (result, start, s);
2927
2928   g_ptr_array_add (result, NULL);
2929
2930   return (gchar **) g_ptr_array_free (result, FALSE);
2931 }
2932
2933 /**
2934  * g_str_tokenize_and_fold:
2935  * @string: a string
2936  * @translit_locale: (allow-none): the language code (like 'de' or
2937  *   'en_GB') from which @string originates
2938  * @ascii_alternates: (out) (transfer full) (array zero-terminated=1): a
2939  *   return location for ASCII alternates
2940  *
2941  * Tokenises @string and performs folding on each token.
2942  *
2943  * A token is a non-empty sequence of alphanumeric characters in the
2944  * source string, separated by non-alphanumeric characters.  An
2945  * "alphanumeric" character for this purpose is one that matches
2946  * g_unichar_isalnum() or g_unichar_ismark().
2947  *
2948  * Each token is then (Unicode) normalised and case-folded.  If
2949  * @ascii_alternates is non-%NULL and some of the returned tokens
2950  * contain non-ASCII characters, ASCII alternatives will be generated.
2951  *
2952  * The number of ASCII alternatives that are generated and the method
2953  * for doing so is unspecified, but @translit_locale (if specified) may
2954  * improve the transliteration if the language of the source string is
2955  * known.
2956  *
2957  * Returns: the folded tokens
2958  *
2959  * Since: 2.40
2960  **/
2961 gchar **
2962 g_str_tokenize_and_fold (const gchar   *string,
2963                          const gchar   *translit_locale,
2964                          gchar       ***ascii_alternates)
2965 {
2966   gchar **result;
2967
2968   if (ascii_alternates && g_str_is_ascii (string))
2969     {
2970       *ascii_alternates = g_new0 (gchar *, 0 + 1);
2971       ascii_alternates = NULL;
2972     }
2973
2974   result = split_words (string);
2975
2976   /* TODO: proper iconv transliteration (locale-dependent) */
2977   if (ascii_alternates)
2978     {
2979       gint i, j, n;
2980
2981       n = g_strv_length (result);
2982       *ascii_alternates = g_new (gchar *, n + 1);
2983       j = 0;
2984
2985       for (i = 0; i < n; i++)
2986         {
2987           if (!g_str_is_ascii (result[i]))
2988             {
2989               gchar *decomposed;
2990               gchar *ascii;
2991               gint k = 0;
2992               gint l = 0;
2993
2994               decomposed = g_utf8_normalize (result[i], -1, G_NORMALIZE_ALL);
2995               ascii = g_malloc (strlen (decomposed) + 1);
2996
2997               for (k = 0; decomposed[k]; k++)
2998                 if (~decomposed[k] & 0x80)
2999                   ascii[l++] = decomposed[k];
3000               ascii[l] = '\0';
3001
3002               (*ascii_alternates)[j++] = ascii;
3003               g_free (decomposed);
3004             }
3005         }
3006
3007       (*ascii_alternates)[j] = NULL;
3008     }
3009
3010   return result;
3011 }
3012
3013 /**
3014  * g_str_match_string:
3015  * @search_term: the search term from the user
3016  * @potential_hit: the text that may be a hit
3017  * @accept_alternates: %TRUE to accept ASCII alternates
3018  *
3019  * Checks if a search conducted for @search_term should match
3020  * @potential_hit.
3021  *
3022  * This function calls g_str_tokenize_and_fold() on both
3023  * @search_term and @potential_hit.  ASCII alternates are never taken
3024  * for @search_term but will be taken for @potential_hit according to
3025  * the value of @accept_alternates.
3026  *
3027  * A hit occurs when each folded token in @search_term is a prefix of a
3028  * folded token from @potential_hit.
3029  *
3030  * Depending on how you're performing the search, it will typically be
3031  * faster to call g_str_tokenize_and_fold() on each string in
3032  * your corpus and build an index on the returned folded tokens, then
3033  * call g_str_tokenize_and_fold() on the search term and
3034  * perform lookups into that index.
3035  *
3036  * As some examples, searching for "fred" would match the potential hit
3037  * "Smith, Fred" and also "Frédéric".  Searching for "Fréd" would match
3038  * "Frédéric" but not "Frederic" (due to the one-directional nature of
3039  * accent matching).  Searching "fo" would match "Foo" and "Bar Foo
3040  * Baz", but not "SFO" (because no word as "fo" as a prefix).
3041  *
3042  * Returns: %TRUE if @potential_hit is a hit
3043  *
3044  * Since: 2.40
3045  **/
3046 gboolean
3047 g_str_match_string (const gchar *search_term,
3048                     const gchar *potential_hit,
3049                     gboolean     accept_alternates)
3050 {
3051   gchar **alternates = NULL;
3052   gchar **term_tokens;
3053   gchar **hit_tokens;
3054   gboolean matched;
3055   gint i, j;
3056
3057   term_tokens = g_str_tokenize_and_fold (search_term, NULL, NULL);
3058   hit_tokens = g_str_tokenize_and_fold (potential_hit, NULL, accept_alternates ? &alternates : NULL);
3059
3060   matched = TRUE;
3061
3062   for (i = 0; term_tokens[i]; i++)
3063     {
3064       for (j = 0; hit_tokens[j]; j++)
3065         if (g_str_has_prefix (hit_tokens[j], term_tokens[i]))
3066           goto one_matched;
3067
3068       if (accept_alternates)
3069         for (j = 0; alternates[j]; j++)
3070           if (g_str_has_prefix (alternates[j], term_tokens[i]))
3071             goto one_matched;
3072
3073       matched = FALSE;
3074       break;
3075
3076 one_matched:
3077       continue;
3078     }
3079
3080   g_strfreev (term_tokens);
3081   g_strfreev (hit_tokens);
3082   g_strfreev (alternates);
3083
3084   return matched;
3085 }