Add g_str_is_ascii()
[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 functions 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 buf[64];
1254   gchar *msg;
1255   gchar *tofree;
1256   const gchar *ret;
1257   gint saved_errno = errno;
1258
1259   msg = tofree = NULL;
1260
1261 #ifdef HAVE_STRERROR
1262   msg = strerror (errnum);
1263   if (!g_get_charset (NULL))
1264     msg = tofree = g_locale_to_utf8 (msg, -1, NULL, NULL, NULL);
1265 #endif
1266
1267   if (!msg)
1268     {
1269       msg = buf;
1270       _g_sprintf (msg, "unknown error (%d)", errnum);
1271     }
1272
1273   ret = g_intern_string (msg);
1274   g_free (tofree);
1275   errno = saved_errno;
1276   return ret;
1277 }
1278
1279 /**
1280  * g_strsignal:
1281  * @signum: the signal number. See the <literal>signal</literal>
1282  *     documentation
1283  *
1284  * Returns a string describing the given signal, e.g. "Segmentation fault".
1285  * You should use this function in preference to strsignal(), because it
1286  * returns a string in UTF-8 encoding, and since not all platforms support
1287  * the strsignal() function.
1288  *
1289  * Returns: a UTF-8 string describing the signal. If the signal is unknown,
1290  *     it returns "unknown signal (&lt;signum&gt;)".
1291  */
1292 const gchar *
1293 g_strsignal (gint signum)
1294 {
1295   gchar *msg;
1296   gchar *tofree;
1297   const gchar *ret;
1298
1299   msg = tofree = NULL;
1300
1301 #ifdef HAVE_STRSIGNAL
1302   msg = strsignal (signum);
1303   if (!g_get_charset (NULL))
1304     msg = tofree = g_locale_to_utf8 (msg, -1, NULL, NULL, NULL);
1305 #endif
1306
1307   if (!msg)
1308     msg = tofree = g_strdup_printf ("unknown signal (%d)", signum);
1309   ret = g_intern_string (msg);
1310   g_free (tofree);
1311
1312   return ret;
1313 }
1314
1315 /* Functions g_strlcpy and g_strlcat were originally developed by
1316  * Todd C. Miller <Todd.Miller@courtesan.com> to simplify writing secure code.
1317  * See http://www.openbsd.org/cgi-bin/man.cgi?query=strlcpy 
1318  * for more information.
1319  */
1320
1321 #ifdef HAVE_STRLCPY
1322 /* Use the native ones, if available; they might be implemented in assembly */
1323 gsize
1324 g_strlcpy (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 strlcpy (dest, src, dest_size);
1332 }
1333
1334 gsize
1335 g_strlcat (gchar       *dest,
1336            const gchar *src,
1337            gsize        dest_size)
1338 {
1339   g_return_val_if_fail (dest != NULL, 0);
1340   g_return_val_if_fail (src  != NULL, 0);
1341
1342   return strlcat (dest, src, dest_size);
1343 }
1344
1345 #else /* ! HAVE_STRLCPY */
1346 /**
1347  * g_strlcpy:
1348  * @dest: destination buffer
1349  * @src: source buffer
1350  * @dest_size: length of @dest in bytes
1351  *
1352  * Portability wrapper that calls strlcpy() on systems which have it,
1353  * and emulates strlcpy() otherwise. Copies @src to @dest; @dest is
1354  * guaranteed to be nul-terminated; @src must be nul-terminated;
1355  * @dest_size is the buffer size, not the number of chars to copy.
1356  *
1357  * At most dest_size - 1 characters will be copied. Always nul-terminates
1358  * (unless dest_size == 0). This function does <emphasis>not</emphasis>
1359  * allocate memory. Unlike strncpy(), this function doesn't pad dest (so
1360  * it's often faster). It returns the size of the attempted result,
1361  * strlen (src), so if @retval >= @dest_size, truncation occurred.
1362  *
1363  * <note><para>Caveat: strlcpy() is supposedly more secure than
1364  * strcpy() or strncpy(), but if you really want to avoid screwups,
1365  * g_strdup() is an even better idea.</para></note>
1366  *
1367  * Returns: length of @src
1368  */
1369 gsize
1370 g_strlcpy (gchar       *dest,
1371            const gchar *src,
1372            gsize        dest_size)
1373 {
1374   register gchar *d = dest;
1375   register const gchar *s = src;
1376   register gsize n = dest_size;
1377
1378   g_return_val_if_fail (dest != NULL, 0);
1379   g_return_val_if_fail (src  != NULL, 0);
1380
1381   /* Copy as many bytes as will fit */
1382   if (n != 0 && --n != 0)
1383     do
1384       {
1385         register gchar c = *s++;
1386
1387         *d++ = c;
1388         if (c == 0)
1389           break;
1390       }
1391     while (--n != 0);
1392
1393   /* If not enough room in dest, add NUL and traverse rest of src */
1394   if (n == 0)
1395     {
1396       if (dest_size != 0)
1397         *d = 0;
1398       while (*s++)
1399         ;
1400     }
1401
1402   return s - src - 1;  /* count does not include NUL */
1403 }
1404
1405 /**
1406  * g_strlcat:
1407  * @dest: destination buffer, already containing one nul-terminated string
1408  * @src: source buffer
1409  * @dest_size: length of @dest buffer in bytes (not length of existing string
1410  *     inside @dest)
1411  *
1412  * Portability wrapper that calls strlcat() on systems which have it,
1413  * and emulates it otherwise. Appends nul-terminated @src string to @dest,
1414  * guaranteeing nul-termination for @dest. The total size of @dest won't
1415  * exceed @dest_size.
1416  *
1417  * At most dest_size - 1 characters will be copied.
1418  * Unlike strncat, dest_size is the full size of dest, not the space left over.
1419  * This function does NOT allocate memory.
1420  * This always NUL terminates (unless siz == 0 or there were no NUL characters
1421  * in the dest_size characters of dest to start with).
1422  *
1423  * <note><para>Caveat: this is supposedly a more secure alternative to
1424  * strcat() or strncat(), but for real security g_strconcat() is harder
1425  * to mess up.</para></note>
1426  *
1427  * Returns: size of attempted result, which is MIN (dest_size, strlen
1428  *          (original dest)) + strlen (src), so if retval >= dest_size,
1429  *          truncation occurred.
1430  **/
1431 gsize
1432 g_strlcat (gchar       *dest,
1433            const gchar *src,
1434            gsize        dest_size)
1435 {
1436   register gchar *d = dest;
1437   register const gchar *s = src;
1438   register gsize bytes_left = dest_size;
1439   gsize dlength;  /* Logically, MIN (strlen (d), dest_size) */
1440
1441   g_return_val_if_fail (dest != NULL, 0);
1442   g_return_val_if_fail (src  != NULL, 0);
1443
1444   /* Find the end of dst and adjust bytes left but don't go past end */
1445   while (*d != 0 && bytes_left-- != 0)
1446     d++;
1447   dlength = d - dest;
1448   bytes_left = dest_size - dlength;
1449
1450   if (bytes_left == 0)
1451     return dlength + strlen (s);
1452
1453   while (*s != 0)
1454     {
1455       if (bytes_left != 1)
1456         {
1457           *d++ = *s;
1458           bytes_left--;
1459         }
1460       s++;
1461     }
1462   *d = 0;
1463
1464   return dlength + (s - src);  /* count does not include NUL */
1465 }
1466 #endif /* ! HAVE_STRLCPY */
1467
1468 /**
1469  * g_ascii_strdown:
1470  * @str: a string.
1471  * @len: length of @str in bytes, or -1 if @str is nul-terminated.
1472  *
1473  * Converts all upper case ASCII letters to lower case ASCII letters.
1474  *
1475  * Return value: a newly-allocated string, with all the upper case
1476  *               characters in @str converted to lower case, with
1477  *               semantics that exactly match g_ascii_tolower(). (Note
1478  *               that this is unlike the old g_strdown(), which modified
1479  *               the string in place.)
1480  **/
1481 gchar*
1482 g_ascii_strdown (const gchar *str,
1483                  gssize       len)
1484 {
1485   gchar *result, *s;
1486
1487   g_return_val_if_fail (str != NULL, NULL);
1488
1489   if (len < 0)
1490     len = strlen (str);
1491
1492   result = g_strndup (str, len);
1493   for (s = result; *s; s++)
1494     *s = g_ascii_tolower (*s);
1495
1496   return result;
1497 }
1498
1499 /**
1500  * g_ascii_strup:
1501  * @str: a string.
1502  * @len: length of @str in bytes, or -1 if @str is nul-terminated.
1503  *
1504  * Converts all lower case ASCII letters to upper case ASCII letters.
1505  *
1506  * Return value: a newly allocated string, with all the lower case
1507  *               characters in @str converted to upper case, with
1508  *               semantics that exactly match g_ascii_toupper(). (Note
1509  *               that this is unlike the old g_strup(), which modified
1510  *               the string in place.)
1511  **/
1512 gchar*
1513 g_ascii_strup (const gchar *str,
1514                gssize       len)
1515 {
1516   gchar *result, *s;
1517
1518   g_return_val_if_fail (str != NULL, NULL);
1519
1520   if (len < 0)
1521     len = strlen (str);
1522
1523   result = g_strndup (str, len);
1524   for (s = result; *s; s++)
1525     *s = g_ascii_toupper (*s);
1526
1527   return result;
1528 }
1529
1530 /**
1531  * g_str_is_ascii:
1532  * @string: a string.
1533  *
1534  * Determines if a string is pure ASCII.  A string is pure ASCII if it
1535  * contains no bytes with the high bit set.
1536  *
1537  * Returns: %TRUE if @string is ascii
1538  *
1539  * Since: 2.40
1540  **/
1541 gboolean
1542 g_str_is_ascii (const gchar *string)
1543 {
1544   gint i;
1545
1546   for (i = 0; string[i]; i++)
1547     if (string[i] & 0x80)
1548       return FALSE;
1549
1550   return TRUE;
1551 }
1552
1553 /**
1554  * g_strdown:
1555  * @string: the string to convert.
1556  *
1557  * Converts a string to lower case.
1558  *
1559  * Return value: the string
1560  *
1561  * Deprecated:2.2: This function is totally broken for the reasons discussed
1562  * in the g_strncasecmp() docs - use g_ascii_strdown() or g_utf8_strdown()
1563  * instead.
1564  **/
1565 gchar*
1566 g_strdown (gchar *string)
1567 {
1568   register guchar *s;
1569
1570   g_return_val_if_fail (string != NULL, NULL);
1571
1572   s = (guchar *) string;
1573
1574   while (*s)
1575     {
1576       if (isupper (*s))
1577         *s = tolower (*s);
1578       s++;
1579     }
1580
1581   return (gchar *) string;
1582 }
1583
1584 /**
1585  * g_strup:
1586  * @string: the string to convert.
1587  *
1588  * Converts a string to upper case.
1589  *
1590  * Return value: the string
1591  *
1592  * Deprecated:2.2: This function is totally broken for the reasons discussed
1593  * in the g_strncasecmp() docs - use g_ascii_strup() or g_utf8_strup() instead.
1594  **/
1595 gchar*
1596 g_strup (gchar *string)
1597 {
1598   register guchar *s;
1599
1600   g_return_val_if_fail (string != NULL, NULL);
1601
1602   s = (guchar *) string;
1603
1604   while (*s)
1605     {
1606       if (islower (*s))
1607         *s = toupper (*s);
1608       s++;
1609     }
1610
1611   return (gchar *) string;
1612 }
1613
1614 /**
1615  * g_strreverse:
1616  * @string: the string to reverse
1617  *
1618  * Reverses all of the bytes in a string. For example,
1619  * <literal>g_strreverse ("abcdef")</literal> will result
1620  * in "fedcba".
1621  *
1622  * Note that g_strreverse() doesn't work on UTF-8 strings
1623  * containing multibyte characters. For that purpose, use
1624  * g_utf8_strreverse().
1625  *
1626  * Returns: the same pointer passed in as @string
1627  */
1628 gchar*
1629 g_strreverse (gchar *string)
1630 {
1631   g_return_val_if_fail (string != NULL, NULL);
1632
1633   if (*string)
1634     {
1635       register gchar *h, *t;
1636
1637       h = string;
1638       t = string + strlen (string) - 1;
1639
1640       while (h < t)
1641         {
1642           register gchar c;
1643
1644           c = *h;
1645           *h = *t;
1646           h++;
1647           *t = c;
1648           t--;
1649         }
1650     }
1651
1652   return string;
1653 }
1654
1655 /**
1656  * g_ascii_tolower:
1657  * @c: any character.
1658  *
1659  * Convert a character to ASCII lower case.
1660  *
1661  * Unlike the standard C library tolower() function, this only
1662  * recognizes standard ASCII letters and ignores the locale, returning
1663  * all non-ASCII characters unchanged, even if they are lower case
1664  * letters in a particular character set. Also unlike the standard
1665  * library function, this takes and returns a char, not an int, so
1666  * don't call it on <literal>EOF</literal> but no need to worry about casting to #guchar
1667  * before passing a possibly non-ASCII character in.
1668  *
1669  * Return value: the result of converting @c to lower case.
1670  *               If @c is not an ASCII upper case letter,
1671  *               @c is returned unchanged.
1672  **/
1673 gchar
1674 g_ascii_tolower (gchar c)
1675 {
1676   return g_ascii_isupper (c) ? c - 'A' + 'a' : c;
1677 }
1678
1679 /**
1680  * g_ascii_toupper:
1681  * @c: any character.
1682  *
1683  * Convert a character to ASCII upper case.
1684  *
1685  * Unlike the standard C library toupper() function, this only
1686  * recognizes standard ASCII letters and ignores the locale, returning
1687  * all non-ASCII characters unchanged, even if they are upper case
1688  * letters in a particular character set. Also unlike the standard
1689  * library function, this takes and returns a char, not an int, so
1690  * don't call it on <literal>EOF</literal> but no need to worry about casting to #guchar
1691  * before passing a possibly non-ASCII character in.
1692  *
1693  * Return value: the result of converting @c to upper case.
1694  *               If @c is not an ASCII lower case letter,
1695  *               @c is returned unchanged.
1696  **/
1697 gchar
1698 g_ascii_toupper (gchar c)
1699 {
1700   return g_ascii_islower (c) ? c - 'a' + 'A' : c;
1701 }
1702
1703 /**
1704  * g_ascii_digit_value:
1705  * @c: an ASCII character.
1706  *
1707  * Determines the numeric value of a character as a decimal
1708  * digit. Differs from g_unichar_digit_value() because it takes
1709  * a char, so there's no worry about sign extension if characters
1710  * are signed.
1711  *
1712  * Return value: If @c is a decimal digit (according to
1713  * g_ascii_isdigit()), its numeric value. Otherwise, -1.
1714  **/
1715 int
1716 g_ascii_digit_value (gchar c)
1717 {
1718   if (g_ascii_isdigit (c))
1719     return c - '0';
1720   return -1;
1721 }
1722
1723 /**
1724  * g_ascii_xdigit_value:
1725  * @c: an ASCII character.
1726  *
1727  * Determines the numeric value of a character as a hexidecimal
1728  * digit. Differs from g_unichar_xdigit_value() because it takes
1729  * a char, so there's no worry about sign extension if characters
1730  * are signed.
1731  *
1732  * Return value: If @c is a hex digit (according to
1733  * g_ascii_isxdigit()), its numeric value. Otherwise, -1.
1734  **/
1735 int
1736 g_ascii_xdigit_value (gchar c)
1737 {
1738   if (c >= 'A' && c <= 'F')
1739     return c - 'A' + 10;
1740   if (c >= 'a' && c <= 'f')
1741     return c - 'a' + 10;
1742   return g_ascii_digit_value (c);
1743 }
1744
1745 /**
1746  * g_ascii_strcasecmp:
1747  * @s1: string to compare with @s2.
1748  * @s2: string to compare with @s1.
1749  *
1750  * Compare two strings, ignoring the case of ASCII characters.
1751  *
1752  * Unlike the BSD strcasecmp() function, this only recognizes standard
1753  * ASCII letters and ignores the locale, treating all non-ASCII
1754  * bytes as if they are not letters.
1755  *
1756  * This function should be used only on strings that are known to be
1757  * in encodings where the bytes corresponding to ASCII letters always
1758  * represent themselves. This includes UTF-8 and the ISO-8859-*
1759  * charsets, but not for instance double-byte encodings like the
1760  * Windows Codepage 932, where the trailing bytes of double-byte
1761  * characters include all ASCII letters. If you compare two CP932
1762  * strings using this function, you will get false matches.
1763  *
1764  * Return value: 0 if the strings match, a negative value if @s1 &lt; @s2,
1765  *   or a positive value if @s1 &gt; @s2.
1766  **/
1767 gint
1768 g_ascii_strcasecmp (const gchar *s1,
1769                     const gchar *s2)
1770 {
1771   gint c1, c2;
1772
1773   g_return_val_if_fail (s1 != NULL, 0);
1774   g_return_val_if_fail (s2 != NULL, 0);
1775
1776   while (*s1 && *s2)
1777     {
1778       c1 = (gint)(guchar) TOLOWER (*s1);
1779       c2 = (gint)(guchar) TOLOWER (*s2);
1780       if (c1 != c2)
1781         return (c1 - c2);
1782       s1++; s2++;
1783     }
1784
1785   return (((gint)(guchar) *s1) - ((gint)(guchar) *s2));
1786 }
1787
1788 /**
1789  * g_ascii_strncasecmp:
1790  * @s1: string to compare with @s2.
1791  * @s2: string to compare with @s1.
1792  * @n:  number of characters to compare.
1793  *
1794  * Compare @s1 and @s2, ignoring the case of ASCII characters and any
1795  * characters after the first @n in each string.
1796  *
1797  * Unlike the BSD strcasecmp() function, this only recognizes standard
1798  * ASCII letters and ignores the locale, treating all non-ASCII
1799  * characters as if they are not letters.
1800  *
1801  * The same warning as in g_ascii_strcasecmp() applies: Use this
1802  * function only on strings known to be in encodings where bytes
1803  * corresponding to ASCII letters always represent themselves.
1804  *
1805  * Return value: 0 if the strings match, a negative value if @s1 &lt; @s2,
1806  *   or a positive value if @s1 &gt; @s2.
1807  **/
1808 gint
1809 g_ascii_strncasecmp (const gchar *s1,
1810                      const gchar *s2,
1811                      gsize n)
1812 {
1813   gint c1, c2;
1814
1815   g_return_val_if_fail (s1 != NULL, 0);
1816   g_return_val_if_fail (s2 != NULL, 0);
1817
1818   while (n && *s1 && *s2)
1819     {
1820       n -= 1;
1821       c1 = (gint)(guchar) TOLOWER (*s1);
1822       c2 = (gint)(guchar) TOLOWER (*s2);
1823       if (c1 != c2)
1824         return (c1 - c2);
1825       s1++; s2++;
1826     }
1827
1828   if (n)
1829     return (((gint) (guchar) *s1) - ((gint) (guchar) *s2));
1830   else
1831     return 0;
1832 }
1833
1834 /**
1835  * g_strcasecmp:
1836  * @s1: a string.
1837  * @s2: a string to compare with @s1.
1838  *
1839  * A case-insensitive string comparison, corresponding to the standard
1840  * strcasecmp() function on platforms which support it.
1841  *
1842  * Return value: 0 if the strings match, a negative value if @s1 &lt; @s2,
1843  *   or a positive value if @s1 &gt; @s2.
1844  *
1845  * Deprecated:2.2: See g_strncasecmp() for a discussion of why this function
1846  *   is deprecated and how to replace it.
1847  **/
1848 gint
1849 g_strcasecmp (const gchar *s1,
1850               const gchar *s2)
1851 {
1852 #ifdef HAVE_STRCASECMP
1853   g_return_val_if_fail (s1 != NULL, 0);
1854   g_return_val_if_fail (s2 != NULL, 0);
1855
1856   return strcasecmp (s1, s2);
1857 #else
1858   gint c1, c2;
1859
1860   g_return_val_if_fail (s1 != NULL, 0);
1861   g_return_val_if_fail (s2 != NULL, 0);
1862
1863   while (*s1 && *s2)
1864     {
1865       /* According to A. Cox, some platforms have islower's that
1866        * don't work right on non-uppercase
1867        */
1868       c1 = isupper ((guchar)*s1) ? tolower ((guchar)*s1) : *s1;
1869       c2 = isupper ((guchar)*s2) ? tolower ((guchar)*s2) : *s2;
1870       if (c1 != c2)
1871         return (c1 - c2);
1872       s1++; s2++;
1873     }
1874
1875   return (((gint)(guchar) *s1) - ((gint)(guchar) *s2));
1876 #endif
1877 }
1878
1879 /**
1880  * g_strncasecmp:
1881  * @s1: a string.
1882  * @s2: a string to compare with @s1.
1883  * @n: the maximum number of characters to compare.
1884  *
1885  * A case-insensitive string comparison, corresponding to the standard
1886  * strncasecmp() function on platforms which support it.
1887  * It is similar to g_strcasecmp() except it only compares the first @n
1888  * characters of the strings.
1889  *
1890  * Return value: 0 if the strings match, a negative value if @s1 &lt; @s2,
1891  *   or a positive value if @s1 &gt; @s2.
1892  *
1893  * Deprecated:2.2: The problem with g_strncasecmp() is that it does the
1894  * comparison by calling toupper()/tolower(). These functions are
1895  * locale-specific and operate on single bytes. However, it is impossible
1896  * to handle things correctly from an I18N standpoint by operating on
1897  * bytes, since characters may be multibyte. Thus g_strncasecmp() is
1898  * broken if your string is guaranteed to be ASCII, since it's
1899  * locale-sensitive, and it's broken if your string is localized, since
1900  * it doesn't work on many encodings at all, including UTF-8, EUC-JP,
1901  * etc.
1902  *
1903  * There are therefore two replacement techniques: g_ascii_strncasecmp(),
1904  * which only works on ASCII and is not locale-sensitive, and
1905  * g_utf8_casefold() followed by strcmp() on the resulting strings, which is
1906  * good for case-insensitive sorting of UTF-8.
1907  **/
1908 gint
1909 g_strncasecmp (const gchar *s1,
1910                const gchar *s2,
1911                guint n)
1912 {
1913 #ifdef HAVE_STRNCASECMP
1914   return strncasecmp (s1, s2, n);
1915 #else
1916   gint c1, c2;
1917
1918   g_return_val_if_fail (s1 != NULL, 0);
1919   g_return_val_if_fail (s2 != NULL, 0);
1920
1921   while (n && *s1 && *s2)
1922     {
1923       n -= 1;
1924       /* According to A. Cox, some platforms have islower's that
1925        * don't work right on non-uppercase
1926        */
1927       c1 = isupper ((guchar)*s1) ? tolower ((guchar)*s1) : *s1;
1928       c2 = isupper ((guchar)*s2) ? tolower ((guchar)*s2) : *s2;
1929       if (c1 != c2)
1930         return (c1 - c2);
1931       s1++; s2++;
1932     }
1933
1934   if (n)
1935     return (((gint) (guchar) *s1) - ((gint) (guchar) *s2));
1936   else
1937     return 0;
1938 #endif
1939 }
1940
1941 /**
1942  * g_strdelimit:
1943  * @string: the string to convert
1944  * @delimiters: (allow-none): a string containing the current delimiters, or %NULL
1945  *     to use the standard delimiters defined in #G_STR_DELIMITERS
1946  * @new_delimiter: the new delimiter character
1947  *
1948  * Converts any delimiter characters in @string to @new_delimiter.
1949  * Any characters in @string which are found in @delimiters are
1950  * changed to the @new_delimiter character. Modifies @string in place,
1951  * and returns @string itself, not a copy. The return value is to
1952  * allow nesting such as
1953  * |[
1954  *   g_ascii_strup (g_strdelimit (str, "abc", '?'))
1955  * ]|
1956  *
1957  * Returns: @string
1958  */
1959 gchar *
1960 g_strdelimit (gchar       *string,
1961               const gchar *delimiters,
1962               gchar        new_delim)
1963 {
1964   register gchar *c;
1965
1966   g_return_val_if_fail (string != NULL, NULL);
1967
1968   if (!delimiters)
1969     delimiters = G_STR_DELIMITERS;
1970
1971   for (c = string; *c; c++)
1972     {
1973       if (strchr (delimiters, *c))
1974         *c = new_delim;
1975     }
1976
1977   return string;
1978 }
1979
1980 /**
1981  * g_strcanon:
1982  * @string: a nul-terminated array of bytes
1983  * @valid_chars: bytes permitted in @string
1984  * @substitutor: replacement character for disallowed bytes
1985  *
1986  * For each character in @string, if the character is not in
1987  * @valid_chars, replaces the character with @substitutor.
1988  * Modifies @string in place, and return @string itself, not
1989  * a copy. The return value is to allow nesting such as
1990  * |[
1991  *   g_ascii_strup (g_strcanon (str, "abc", '?'))
1992  * ]|
1993  *
1994  * Returns: @string
1995  */
1996 gchar *
1997 g_strcanon (gchar       *string,
1998             const gchar *valid_chars,
1999             gchar        substitutor)
2000 {
2001   register gchar *c;
2002
2003   g_return_val_if_fail (string != NULL, NULL);
2004   g_return_val_if_fail (valid_chars != NULL, NULL);
2005
2006   for (c = string; *c; c++)
2007     {
2008       if (!strchr (valid_chars, *c))
2009         *c = substitutor;
2010     }
2011
2012   return string;
2013 }
2014
2015 /**
2016  * g_strcompress:
2017  * @source: a string to compress
2018  *
2019  * Replaces all escaped characters with their one byte equivalent.
2020  *
2021  * This function does the reverse conversion of g_strescape().
2022  *
2023  * Returns: a newly-allocated copy of @source with all escaped
2024  *     character compressed
2025  */
2026 gchar *
2027 g_strcompress (const gchar *source)
2028 {
2029   const gchar *p = source, *octal;
2030   gchar *dest;
2031   gchar *q;
2032
2033   g_return_val_if_fail (source != NULL, NULL);
2034
2035   dest = g_malloc (strlen (source) + 1);
2036   q = dest;
2037
2038   while (*p)
2039     {
2040       if (*p == '\\')
2041         {
2042           p++;
2043           switch (*p)
2044             {
2045             case '\0':
2046               g_warning ("g_strcompress: trailing \\");
2047               goto out;
2048             case '0':  case '1':  case '2':  case '3':  case '4':
2049             case '5':  case '6':  case '7':
2050               *q = 0;
2051               octal = p;
2052               while ((p < octal + 3) && (*p >= '0') && (*p <= '7'))
2053                 {
2054                   *q = (*q * 8) + (*p - '0');
2055                   p++;
2056                 }
2057               q++;
2058               p--;
2059               break;
2060             case 'b':
2061               *q++ = '\b';
2062               break;
2063             case 'f':
2064               *q++ = '\f';
2065               break;
2066             case 'n':
2067               *q++ = '\n';
2068               break;
2069             case 'r':
2070               *q++ = '\r';
2071               break;
2072             case 't':
2073               *q++ = '\t';
2074               break;
2075             case 'v':
2076               *q++ = '\v';
2077               break;
2078             default:            /* Also handles \" and \\ */
2079               *q++ = *p;
2080               break;
2081             }
2082         }
2083       else
2084         *q++ = *p;
2085       p++;
2086     }
2087 out:
2088   *q = 0;
2089
2090   return dest;
2091 }
2092
2093 /**
2094  * g_strescape:
2095  * @source: a string to escape
2096  * @exceptions: a string of characters not to escape in @source
2097  *
2098  * Escapes the special characters '\b', '\f', '\n', '\r', '\t', '\v', '\'
2099  * and '&quot;' in the string @source by inserting a '\' before
2100  * them. Additionally all characters in the range 0x01-0x1F (everything
2101  * below SPACE) and in the range 0x7F-0xFF (all non-ASCII chars) are
2102  * replaced with a '\' followed by their octal representation.
2103  * Characters supplied in @exceptions are not escaped.
2104  *
2105  * g_strcompress() does the reverse conversion.
2106  *
2107  * Returns: a newly-allocated copy of @source with certain
2108  *     characters escaped. See above.
2109  */
2110 gchar *
2111 g_strescape (const gchar *source,
2112              const gchar *exceptions)
2113 {
2114   const guchar *p;
2115   gchar *dest;
2116   gchar *q;
2117   guchar excmap[256];
2118
2119   g_return_val_if_fail (source != NULL, NULL);
2120
2121   p = (guchar *) source;
2122   /* Each source byte needs maximally four destination chars (\777) */
2123   q = dest = g_malloc (strlen (source) * 4 + 1);
2124
2125   memset (excmap, 0, 256);
2126   if (exceptions)
2127     {
2128       guchar *e = (guchar *) exceptions;
2129
2130       while (*e)
2131         {
2132           excmap[*e] = 1;
2133           e++;
2134         }
2135     }
2136
2137   while (*p)
2138     {
2139       if (excmap[*p])
2140         *q++ = *p;
2141       else
2142         {
2143           switch (*p)
2144             {
2145             case '\b':
2146               *q++ = '\\';
2147               *q++ = 'b';
2148               break;
2149             case '\f':
2150               *q++ = '\\';
2151               *q++ = 'f';
2152               break;
2153             case '\n':
2154               *q++ = '\\';
2155               *q++ = 'n';
2156               break;
2157             case '\r':
2158               *q++ = '\\';
2159               *q++ = 'r';
2160               break;
2161             case '\t':
2162               *q++ = '\\';
2163               *q++ = 't';
2164               break;
2165             case '\v':
2166               *q++ = '\\';
2167               *q++ = 'v';
2168               break;
2169             case '\\':
2170               *q++ = '\\';
2171               *q++ = '\\';
2172               break;
2173             case '"':
2174               *q++ = '\\';
2175               *q++ = '"';
2176               break;
2177             default:
2178               if ((*p < ' ') || (*p >= 0177))
2179                 {
2180                   *q++ = '\\';
2181                   *q++ = '0' + (((*p) >> 6) & 07);
2182                   *q++ = '0' + (((*p) >> 3) & 07);
2183                   *q++ = '0' + ((*p) & 07);
2184                 }
2185               else
2186                 *q++ = *p;
2187               break;
2188             }
2189         }
2190       p++;
2191     }
2192   *q = 0;
2193   return dest;
2194 }
2195
2196 /**
2197  * g_strchug:
2198  * @string: a string to remove the leading whitespace from
2199  *
2200  * Removes leading whitespace from a string, by moving the rest
2201  * of the characters forward.
2202  *
2203  * This function doesn't allocate or reallocate any memory;
2204  * it modifies @string in place. The pointer to @string is
2205  * returned to allow the nesting of functions.
2206  *
2207  * Also see g_strchomp() and g_strstrip().
2208  *
2209  * Returns: @string
2210  */
2211 gchar *
2212 g_strchug (gchar *string)
2213 {
2214   guchar *start;
2215
2216   g_return_val_if_fail (string != NULL, NULL);
2217
2218   for (start = (guchar*) string; *start && g_ascii_isspace (*start); start++)
2219     ;
2220
2221   g_memmove (string, start, strlen ((gchar *) start) + 1);
2222
2223   return string;
2224 }
2225
2226 /**
2227  * g_strchomp:
2228  * @string: a string to remove the trailing whitespace from
2229  *
2230  * Removes trailing whitespace from a string.
2231  *
2232  * This function doesn't allocate or reallocate any memory;
2233  * it modifies @string in place. The pointer to @string is
2234  * returned to allow the nesting of functions.
2235  *
2236  * Also see g_strchug() and g_strstrip().
2237  *
2238  * Returns: @string.
2239  */
2240 gchar *
2241 g_strchomp (gchar *string)
2242 {
2243   gsize len;
2244
2245   g_return_val_if_fail (string != NULL, NULL);
2246
2247   len = strlen (string);
2248   while (len--)
2249     {
2250       if (g_ascii_isspace ((guchar) string[len]))
2251         string[len] = '\0';
2252       else
2253         break;
2254     }
2255
2256   return string;
2257 }
2258
2259 /**
2260  * g_strsplit:
2261  * @string: a string to split
2262  * @delimiter: a string which specifies the places at which to split
2263  *     the string. The delimiter is not included in any of the resulting
2264  *     strings, unless @max_tokens is reached.
2265  * @max_tokens: the maximum number of pieces to split @string into.
2266  *     If this is less than 1, the string is split completely.
2267  *
2268  * Splits a string into a maximum of @max_tokens pieces, using the given
2269  * @delimiter. If @max_tokens is reached, the remainder of @string is
2270  * appended to the last token.
2271  *
2272  * As a special case, the result of splitting the empty string "" is an empty
2273  * vector, not a vector containing a single string. The reason for this
2274  * special case is that being able to represent a empty vector is typically
2275  * more useful than consistent handling of empty elements. If you do need
2276  * to represent empty elements, you'll need to check for the empty string
2277  * before calling g_strsplit().
2278  *
2279  * Return value: a newly-allocated %NULL-terminated array of strings. Use
2280  *    g_strfreev() to free it.
2281  */
2282 gchar**
2283 g_strsplit (const gchar *string,
2284             const gchar *delimiter,
2285             gint         max_tokens)
2286 {
2287   GSList *string_list = NULL, *slist;
2288   gchar **str_array, *s;
2289   guint n = 0;
2290   const gchar *remainder;
2291
2292   g_return_val_if_fail (string != NULL, NULL);
2293   g_return_val_if_fail (delimiter != NULL, NULL);
2294   g_return_val_if_fail (delimiter[0] != '\0', NULL);
2295
2296   if (max_tokens < 1)
2297     max_tokens = G_MAXINT;
2298
2299   remainder = string;
2300   s = strstr (remainder, delimiter);
2301   if (s)
2302     {
2303       gsize delimiter_len = strlen (delimiter);
2304
2305       while (--max_tokens && s)
2306         {
2307           gsize len;
2308
2309           len = s - remainder;
2310           string_list = g_slist_prepend (string_list,
2311                                          g_strndup (remainder, len));
2312           n++;
2313           remainder = s + delimiter_len;
2314           s = strstr (remainder, delimiter);
2315         }
2316     }
2317   if (*string)
2318     {
2319       n++;
2320       string_list = g_slist_prepend (string_list, g_strdup (remainder));
2321     }
2322
2323   str_array = g_new (gchar*, n + 1);
2324
2325   str_array[n--] = NULL;
2326   for (slist = string_list; slist; slist = slist->next)
2327     str_array[n--] = slist->data;
2328
2329   g_slist_free (string_list);
2330
2331   return str_array;
2332 }
2333
2334 /**
2335  * g_strsplit_set:
2336  * @string: The string to be tokenized
2337  * @delimiters: A nul-terminated string containing bytes that are used
2338  *     to split the string.
2339  * @max_tokens: The maximum number of tokens to split @string into.
2340  *     If this is less than 1, the string is split completely
2341  *
2342  * Splits @string into a number of tokens not containing any of the characters
2343  * in @delimiter. A token is the (possibly empty) longest string that does not
2344  * contain any of the characters in @delimiters. If @max_tokens is reached, the
2345  * remainder is appended to the last token.
2346  *
2347  * For example the result of g_strsplit_set ("abc:def/ghi", ":/", -1) is a
2348  * %NULL-terminated vector containing the three strings "abc", "def",
2349  * and "ghi".
2350  *
2351  * The result if g_strsplit_set (":def/ghi:", ":/", -1) is a %NULL-terminated
2352  * vector containing the four strings "", "def", "ghi", and "".
2353  *
2354  * As a special case, the result of splitting the empty string "" is an empty
2355  * vector, not a vector containing a single string. The reason for this
2356  * special case is that being able to represent a empty vector is typically
2357  * more useful than consistent handling of empty elements. If you do need
2358  * to represent empty elements, you'll need to check for the empty string
2359  * before calling g_strsplit_set().
2360  *
2361  * Note that this function works on bytes not characters, so it can't be used
2362  * to delimit UTF-8 strings for anything but ASCII characters.
2363  *
2364  * Return value: a newly-allocated %NULL-terminated array of strings. Use
2365  *    g_strfreev() to free it.
2366  *
2367  * Since: 2.4
2368  **/
2369 gchar **
2370 g_strsplit_set (const gchar *string,
2371                 const gchar *delimiters,
2372                 gint         max_tokens)
2373 {
2374   gboolean delim_table[256];
2375   GSList *tokens, *list;
2376   gint n_tokens;
2377   const gchar *s;
2378   const gchar *current;
2379   gchar *token;
2380   gchar **result;
2381
2382   g_return_val_if_fail (string != NULL, NULL);
2383   g_return_val_if_fail (delimiters != NULL, NULL);
2384
2385   if (max_tokens < 1)
2386     max_tokens = G_MAXINT;
2387
2388   if (*string == '\0')
2389     {
2390       result = g_new (char *, 1);
2391       result[0] = NULL;
2392       return result;
2393     }
2394
2395   memset (delim_table, FALSE, sizeof (delim_table));
2396   for (s = delimiters; *s != '\0'; ++s)
2397     delim_table[*(guchar *)s] = TRUE;
2398
2399   tokens = NULL;
2400   n_tokens = 0;
2401
2402   s = current = string;
2403   while (*s != '\0')
2404     {
2405       if (delim_table[*(guchar *)s] && n_tokens + 1 < max_tokens)
2406         {
2407           token = g_strndup (current, s - current);
2408           tokens = g_slist_prepend (tokens, token);
2409           ++n_tokens;
2410
2411           current = s + 1;
2412         }
2413
2414       ++s;
2415     }
2416
2417   token = g_strndup (current, s - current);
2418   tokens = g_slist_prepend (tokens, token);
2419   ++n_tokens;
2420
2421   result = g_new (gchar *, n_tokens + 1);
2422
2423   result[n_tokens] = NULL;
2424   for (list = tokens; list != NULL; list = list->next)
2425     result[--n_tokens] = list->data;
2426
2427   g_slist_free (tokens);
2428
2429   return result;
2430 }
2431
2432 /**
2433  * g_strfreev:
2434  * @str_array: a %NULL-terminated array of strings to free
2435
2436  * Frees a %NULL-terminated array of strings, and the array itself.
2437  * If called on a %NULL value, g_strfreev() simply returns.
2438  **/
2439 void
2440 g_strfreev (gchar **str_array)
2441 {
2442   if (str_array)
2443     {
2444       int i;
2445
2446       for (i = 0; str_array[i] != NULL; i++)
2447         g_free (str_array[i]);
2448
2449       g_free (str_array);
2450     }
2451 }
2452
2453 /**
2454  * g_strdupv:
2455  * @str_array: a %NULL-terminated array of strings
2456  *
2457  * Copies %NULL-terminated array of strings. The copy is a deep copy;
2458  * the new array should be freed by first freeing each string, then
2459  * the array itself. g_strfreev() does this for you. If called
2460  * on a %NULL value, g_strdupv() simply returns %NULL.
2461  *
2462  * Return value: a new %NULL-terminated array of strings.
2463  */
2464 gchar**
2465 g_strdupv (gchar **str_array)
2466 {
2467   if (str_array)
2468     {
2469       gint i;
2470       gchar **retval;
2471
2472       i = 0;
2473       while (str_array[i])
2474         ++i;
2475
2476       retval = g_new (gchar*, i + 1);
2477
2478       i = 0;
2479       while (str_array[i])
2480         {
2481           retval[i] = g_strdup (str_array[i]);
2482           ++i;
2483         }
2484       retval[i] = NULL;
2485
2486       return retval;
2487     }
2488   else
2489     return NULL;
2490 }
2491
2492 /**
2493  * g_strjoinv:
2494  * @separator: (allow-none): a string to insert between each of the strings, or %NULL
2495  * @str_array: a %NULL-terminated array of strings to join
2496  *
2497  * Joins a number of strings together to form one long string, with the
2498  * optional @separator inserted between each of them. The returned string
2499  * should be freed with g_free().
2500  *
2501  * Returns: a newly-allocated string containing all of the strings joined
2502  *     together, with @separator between them
2503  */
2504 gchar*
2505 g_strjoinv (const gchar  *separator,
2506             gchar       **str_array)
2507 {
2508   gchar *string;
2509   gchar *ptr;
2510
2511   g_return_val_if_fail (str_array != NULL, NULL);
2512
2513   if (separator == NULL)
2514     separator = "";
2515
2516   if (*str_array)
2517     {
2518       gint i;
2519       gsize len;
2520       gsize separator_len;
2521
2522       separator_len = strlen (separator);
2523       /* First part, getting length */
2524       len = 1 + strlen (str_array[0]);
2525       for (i = 1; str_array[i] != NULL; i++)
2526         len += strlen (str_array[i]);
2527       len += separator_len * (i - 1);
2528
2529       /* Second part, building string */
2530       string = g_new (gchar, len);
2531       ptr = g_stpcpy (string, *str_array);
2532       for (i = 1; str_array[i] != NULL; i++)
2533         {
2534           ptr = g_stpcpy (ptr, separator);
2535           ptr = g_stpcpy (ptr, str_array[i]);
2536         }
2537       }
2538   else
2539     string = g_strdup ("");
2540
2541   return string;
2542 }
2543
2544 /**
2545  * g_strjoin:
2546  * @separator: (allow-none): a string to insert between each of the strings, or %NULL
2547  * @...: a %NULL-terminated list of strings to join
2548  *
2549  * Joins a number of strings together to form one long string, with the
2550  * optional @separator inserted between each of them. The returned string
2551  * should be freed with g_free().
2552  *
2553  * Returns: a newly-allocated string containing all of the strings joined
2554  *     together, with @separator between them
2555  */
2556 gchar*
2557 g_strjoin (const gchar *separator,
2558            ...)
2559 {
2560   gchar *string, *s;
2561   va_list args;
2562   gsize len;
2563   gsize separator_len;
2564   gchar *ptr;
2565
2566   if (separator == NULL)
2567     separator = "";
2568
2569   separator_len = strlen (separator);
2570
2571   va_start (args, separator);
2572
2573   s = va_arg (args, gchar*);
2574
2575   if (s)
2576     {
2577       /* First part, getting length */
2578       len = 1 + strlen (s);
2579
2580       s = va_arg (args, gchar*);
2581       while (s)
2582         {
2583           len += separator_len + strlen (s);
2584           s = va_arg (args, gchar*);
2585         }
2586       va_end (args);
2587
2588       /* Second part, building string */
2589       string = g_new (gchar, len);
2590
2591       va_start (args, separator);
2592
2593       s = va_arg (args, gchar*);
2594       ptr = g_stpcpy (string, s);
2595
2596       s = va_arg (args, gchar*);
2597       while (s)
2598         {
2599           ptr = g_stpcpy (ptr, separator);
2600           ptr = g_stpcpy (ptr, s);
2601           s = va_arg (args, gchar*);
2602         }
2603     }
2604   else
2605     string = g_strdup ("");
2606
2607   va_end (args);
2608
2609   return string;
2610 }
2611
2612
2613 /**
2614  * g_strstr_len:
2615  * @haystack: a string
2616  * @haystack_len: the maximum length of @haystack. Note that -1 is
2617  *     a valid length, if @haystack is nul-terminated, meaning it will
2618  *     search through the whole string.
2619  * @needle: the string to search for
2620  *
2621  * Searches the string @haystack for the first occurrence
2622  * of the string @needle, limiting the length of the search
2623  * to @haystack_len.
2624  *
2625  * Return value: a pointer to the found occurrence, or
2626  *    %NULL if not found.
2627  */
2628 gchar *
2629 g_strstr_len (const gchar *haystack,
2630               gssize       haystack_len,
2631               const gchar *needle)
2632 {
2633   g_return_val_if_fail (haystack != NULL, NULL);
2634   g_return_val_if_fail (needle != NULL, NULL);
2635
2636   if (haystack_len < 0)
2637     return strstr (haystack, needle);
2638   else
2639     {
2640       const gchar *p = haystack;
2641       gsize needle_len = strlen (needle);
2642       const gchar *end;
2643       gsize i;
2644
2645       if (needle_len == 0)
2646         return (gchar *)haystack;
2647
2648       if (haystack_len < needle_len)
2649         return NULL;
2650
2651       end = haystack + haystack_len - needle_len;
2652
2653       while (p <= end && *p)
2654         {
2655           for (i = 0; i < needle_len; i++)
2656             if (p[i] != needle[i])
2657               goto next;
2658
2659           return (gchar *)p;
2660
2661         next:
2662           p++;
2663         }
2664
2665       return NULL;
2666     }
2667 }
2668
2669 /**
2670  * g_strrstr:
2671  * @haystack: a nul-terminated string
2672  * @needle: the nul-terminated string to search for
2673  *
2674  * Searches the string @haystack for the last occurrence
2675  * of the string @needle.
2676  *
2677  * Return value: a pointer to the found occurrence, or
2678  *    %NULL if not found.
2679  */
2680 gchar *
2681 g_strrstr (const gchar *haystack,
2682            const gchar *needle)
2683 {
2684   gsize i;
2685   gsize needle_len;
2686   gsize haystack_len;
2687   const gchar *p;
2688
2689   g_return_val_if_fail (haystack != NULL, NULL);
2690   g_return_val_if_fail (needle != NULL, NULL);
2691
2692   needle_len = strlen (needle);
2693   haystack_len = strlen (haystack);
2694
2695   if (needle_len == 0)
2696     return (gchar *)haystack;
2697
2698   if (haystack_len < needle_len)
2699     return NULL;
2700
2701   p = haystack + haystack_len - needle_len;
2702
2703   while (p >= haystack)
2704     {
2705       for (i = 0; i < needle_len; i++)
2706         if (p[i] != needle[i])
2707           goto next;
2708
2709       return (gchar *)p;
2710
2711     next:
2712       p--;
2713     }
2714
2715   return NULL;
2716 }
2717
2718 /**
2719  * g_strrstr_len:
2720  * @haystack: a nul-terminated string
2721  * @haystack_len: the maximum length of @haystack
2722  * @needle: the nul-terminated string to search for
2723  *
2724  * Searches the string @haystack for the last occurrence
2725  * of the string @needle, limiting the length of the search
2726  * to @haystack_len.
2727  *
2728  * Return value: a pointer to the found occurrence, or
2729  *    %NULL if not found.
2730  */
2731 gchar *
2732 g_strrstr_len (const gchar *haystack,
2733                gssize        haystack_len,
2734                const gchar *needle)
2735 {
2736   g_return_val_if_fail (haystack != NULL, NULL);
2737   g_return_val_if_fail (needle != NULL, NULL);
2738
2739   if (haystack_len < 0)
2740     return g_strrstr (haystack, needle);
2741   else
2742     {
2743       gsize needle_len = strlen (needle);
2744       const gchar *haystack_max = haystack + haystack_len;
2745       const gchar *p = haystack;
2746       gsize i;
2747
2748       while (p < haystack_max && *p)
2749         p++;
2750
2751       if (p < haystack + needle_len)
2752         return NULL;
2753
2754       p -= needle_len;
2755
2756       while (p >= haystack)
2757         {
2758           for (i = 0; i < needle_len; i++)
2759             if (p[i] != needle[i])
2760               goto next;
2761
2762           return (gchar *)p;
2763
2764         next:
2765           p--;
2766         }
2767
2768       return NULL;
2769     }
2770 }
2771
2772
2773 /**
2774  * g_str_has_suffix:
2775  * @str: a nul-terminated string
2776  * @suffix: the nul-terminated suffix to look for
2777  *
2778  * Looks whether the string @str ends with @suffix.
2779  *
2780  * Return value: %TRUE if @str end with @suffix, %FALSE otherwise.
2781  *
2782  * Since: 2.2
2783  */
2784 gboolean
2785 g_str_has_suffix (const gchar *str,
2786                   const gchar *suffix)
2787 {
2788   int str_len;
2789   int suffix_len;
2790
2791   g_return_val_if_fail (str != NULL, FALSE);
2792   g_return_val_if_fail (suffix != NULL, FALSE);
2793
2794   str_len = strlen (str);
2795   suffix_len = strlen (suffix);
2796
2797   if (str_len < suffix_len)
2798     return FALSE;
2799
2800   return strcmp (str + str_len - suffix_len, suffix) == 0;
2801 }
2802
2803 /**
2804  * g_str_has_prefix:
2805  * @str: a nul-terminated string
2806  * @prefix: the nul-terminated prefix to look for
2807  *
2808  * Looks whether the string @str begins with @prefix.
2809  *
2810  * Return value: %TRUE if @str begins with @prefix, %FALSE otherwise.
2811  *
2812  * Since: 2.2
2813  */
2814 gboolean
2815 g_str_has_prefix (const gchar *str,
2816                   const gchar *prefix)
2817 {
2818   int str_len;
2819   int prefix_len;
2820
2821   g_return_val_if_fail (str != NULL, FALSE);
2822   g_return_val_if_fail (prefix != NULL, FALSE);
2823
2824   str_len = strlen (str);
2825   prefix_len = strlen (prefix);
2826
2827   if (str_len < prefix_len)
2828     return FALSE;
2829
2830   return strncmp (str, prefix, prefix_len) == 0;
2831 }
2832
2833 /**
2834  * g_strv_length:
2835  * @str_array: a %NULL-terminated array of strings
2836  *
2837  * Returns the length of the given %NULL-terminated
2838  * string array @str_array.
2839  *
2840  * Return value: length of @str_array.
2841  *
2842  * Since: 2.6
2843  */
2844 guint
2845 g_strv_length (gchar **str_array)
2846 {
2847   guint i = 0;
2848
2849   g_return_val_if_fail (str_array != NULL, 0);
2850
2851   while (str_array[i])
2852     ++i;
2853
2854   return i;
2855 }