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 #define _GNU_SOURCE             /* For stpcpy */
  34
  35 #include <stdarg.h>
  36 #include <stdio.h>
  37 #include <stdlib.h>
  38 #include <string.h>
  39 #include <locale.h>
  40 #include <errno.h>
  41 #include <ctype.h>              /* For tolower() */
  42 #if !defined (HAVE_STRSIGNAL) || !defined(NO_SYS_SIGLIST_DECL)
  43 #include <signal.h>
  44 #endif
  45
  46 #include "glib.h"
  47 #include "gprintf.h"
  48 #include "gprintfint.h"
  49
  50 #include "galias.h"
  51
  52 #ifdef G_OS_WIN32
  53 #include <windows.h>
  54 #endif
  55
  56 /* do not include <unistd.h> in this place since it
  57  * interferes with g_strsignal() on some OSes
  58  */
  59
  60 static const guint16 ascii_table_data[256] = {
  61   0x004, 0x004, 0x004, 0x004, 0x004, 0x004, 0x004, 0x004,
  62   0x004, 0x104, 0x104, 0x004, 0x104, 0x104, 0x004, 0x004,
  63   0x004, 0x004, 0x004, 0x004, 0x004, 0x004, 0x004, 0x004,
  64   0x004, 0x004, 0x004, 0x004, 0x004, 0x004, 0x004, 0x004,
  65   0x140, 0x0d0, 0x0d0, 0x0d0, 0x0d0, 0x0d0, 0x0d0, 0x0d0,
  66   0x0d0, 0x0d0, 0x0d0, 0x0d0, 0x0d0, 0x0d0, 0x0d0, 0x0d0,
  67   0x459, 0x459, 0x459, 0x459, 0x459, 0x459, 0x459, 0x459,
  68   0x459, 0x459, 0x0d0, 0x0d0, 0x0d0, 0x0d0, 0x0d0, 0x0d0,
  69   0x0d0, 0x653, 0x653, 0x653, 0x653, 0x653, 0x653, 0x253,
  70   0x253, 0x253, 0x253, 0x253, 0x253, 0x253, 0x253, 0x253,
  71   0x253, 0x253, 0x253, 0x253, 0x253, 0x253, 0x253, 0x253,
  72   0x253, 0x253, 0x253, 0x0d0, 0x0d0, 0x0d0, 0x0d0, 0x0d0,
  73   0x0d0, 0x473, 0x473, 0x473, 0x473, 0x473, 0x473, 0x073,
  74   0x073, 0x073, 0x073, 0x073, 0x073, 0x073, 0x073, 0x073,
  75   0x073, 0x073, 0x073, 0x073, 0x073, 0x073, 0x073, 0x073,
  76   0x073, 0x073, 0x073, 0x0d0, 0x0d0, 0x0d0, 0x0d0, 0x004
  77   /* the upper 128 are all zeroes */
  78 };
  79
  80 const guint16 * const g_ascii_table = ascii_table_data;
  81
  82 gchar*
  83 g_strdup (const gchar *str)
  84 {
  85   gchar *new_str;
  86   gsize length;
  87
  88   if (str)
  89     {
  90       length = strlen (str) + 1;
  91       new_str = g_new (char, length);
  92       memcpy (new_str, str, length);
  93     }
  94   else
  95     new_str = NULL;
  96
  97   return new_str;
  98 }
  99
 100 gpointer
 101 g_memdup (gconstpointer mem,
 102           guint         byte_size)
 103 {
 104   gpointer new_mem;
 105
 106   if (mem)
 107     {
 108       new_mem = g_malloc (byte_size);
 109       memcpy (new_mem, mem, byte_size);
 110     }
 111   else
 112     new_mem = NULL;
 113
 114   return new_mem;
 115 }
 116
 117 gchar*
 118 g_strndup (const gchar *str,
 119            gsize        n)
 120 {
 121   gchar *new_str;
 122
 123   if (str)
 124     {
 125       new_str = g_new (gchar, n + 1);
 126       strncpy (new_str, str, n);
 127       new_str[n] = '\0';
 128     }
 129   else
 130     new_str = NULL;
 131
 132   return new_str;
 133 }
 134
 135 gchar*
 136 g_strnfill (gsize length,
 137             gchar fill_char)
 138 {
 139   gchar *str;
 140
 141   str = g_new (gchar, length + 1);
 142   memset (str, (guchar)fill_char, length);
 143   str[length] = '\0';
 144
 145   return str;
 146 }
 147
 148 /**
 149  * g_stpcpy:
 150  * @dest: destination buffer.
 151  * @src: source string.
 152  *
 153  * Copies a nul-terminated string into the dest buffer, include the
 154  * trailing nul, and return a pointer to the trailing nul byte.
 155  * This is useful for concatenating multiple strings together
 156  * without having to repeatedly scan for the end.
 157  *
 158  * Return value: a pointer to trailing nul byte.
 159  **/
 160 gchar *
 161 g_stpcpy (gchar       *dest,
 162           const gchar *src)
 163 {
 164 #ifdef HAVE_STPCPY
 165   g_return_val_if_fail (dest != NULL, NULL);
 166   g_return_val_if_fail (src != NULL, NULL);
 167   return stpcpy (dest, src);
 168 #else
 169   register gchar *d = dest;
 170   register const gchar *s = src;
 171
 172   g_return_val_if_fail (dest != NULL, NULL);
 173   g_return_val_if_fail (src != NULL, NULL);
 174   do
 175     *d++ = *s;
 176   while (*s++ != '\0');
 177
 178   return d - 1;
 179 #endif
 180 }
 181
 182 gchar*
 183 g_strdup_vprintf (const gchar *format,
 184                   va_list      args)
 185 {
 186   gchar *string = NULL;
 187
 188   g_vasprintf (&string, format, args);
 189
 190   return string;
 191 }
 192
 193 gchar*
 194 g_strdup_printf (const gchar *format,
 195                  ...)
 196 {
 197   gchar *buffer;
 198   va_list args;
 199
 200   va_start (args, format);
 201   buffer = g_strdup_vprintf (format, args);
 202   va_end (args);
 203
 204   return buffer;
 205 }
 206
 207 gchar*
 208 g_strconcat (const gchar *string1, ...)
 209 {
 210   gsize   l;
 211   va_list args;
 212   gchar   *s;
 213   gchar   *concat;
 214   gchar   *ptr;
 215
 216   if (!string1)
 217     return NULL;
 218
 219   l = 1 + strlen (string1);
 220   va_start (args, string1);
 221   s = va_arg (args, gchar*);
 222   while (s)
 223     {
 224       l += strlen (s);
 225       s = va_arg (args, gchar*);
 226     }
 227   va_end (args);
 228
 229   concat = g_new (gchar, l);
 230   ptr = concat;
 231
 232   ptr = g_stpcpy (ptr, string1);
 233   va_start (args, string1);
 234   s = va_arg (args, gchar*);
 235   while (s)
 236     {
 237       ptr = g_stpcpy (ptr, s);
 238       s = va_arg (args, gchar*);
 239     }
 240   va_end (args);
 241
 242   return concat;
 243 }
 244
 245 /**
 246  * g_strtod:
 247  * @nptr:    the string to convert to a numeric value.
 248  * @endptr:  if non-%NULL, it returns the character after
 249  *           the last character used in the conversion.
 250  *
 251  * Converts a string to a #gdouble value.
 252  * It calls the standard strtod() function to handle the conversion, but
 253  * if the string is not completely converted it attempts the conversion
 254  * again with g_ascii_strtod(), and returns the best match.
 255  *
 256  * This function should seldomly be used. The normal situation when reading
 257  * numbers not for human consumption is to use g_ascii_strtod(). Only when
 258  * you know that you must expect both locale formatted and C formatted numbers
 259  * should you use this. Make sure that you don't pass strings such as comma
 260  * separated lists of values, since the commas may be interpreted as a decimal
 261  * point in some locales, causing unexpected results.
 262  *
 263  * Return value: the #gdouble value.
 264  **/
 265 gdouble
 266 g_strtod (const gchar *nptr,
 267           gchar      **endptr)
 268 {
 269   gchar *fail_pos_1;
 270   gchar *fail_pos_2;
 271   gdouble val_1;
 272   gdouble val_2 = 0;
 273
 274   g_return_val_if_fail (nptr != NULL, 0);
 275
 276   fail_pos_1 = NULL;
 277   fail_pos_2 = NULL;
 278
 279   val_1 = strtod (nptr, &fail_pos_1);
 280
 281   if (fail_pos_1 && fail_pos_1[0] != 0)
 282     val_2 = g_ascii_strtod (nptr, &fail_pos_2);
 283
 284   if (!fail_pos_1 || fail_pos_1[0] == 0 || fail_pos_1 >= fail_pos_2)
 285     {
 286       if (endptr)
 287         *endptr = fail_pos_1;
 288       return val_1;
 289     }
 290   else
 291     {
 292       if (endptr)
 293         *endptr = fail_pos_2;
 294       return val_2;
 295     }
 296 }
 297
 298 /**
 299  * g_ascii_strtod:
 300  * @nptr:    the string to convert to a numeric value.
 301  * @endptr:  if non-%NULL, it returns the character after
 302  *           the last character used in the conversion.
 303  *
 304  * Converts a string to a #gdouble value.
 305  * This function behaves like the standard strtod() function
 306  * does in the C locale. It does this without actually
 307  * changing the current locale, since that would not be
 308  * thread-safe.
 309  *
 310  * This function is typically used when reading configuration
 311  * files or other non-user input that should be locale independent.
 312  * To handle input from the user you should normally use the
 313  * locale-sensitive system strtod() function.
 314  *
 315  * To convert from a #gdouble to a string in a locale-insensitive
 316  * way, use g_ascii_dtostr().
 317  *
 318  * If the correct value would cause overflow, plus or minus %HUGE_VAL
 319  * is returned (according to the sign of the value), and %ERANGE is
 320  * stored in %errno. If the correct value would cause underflow,
 321  * zero is returned and %ERANGE is stored in %errno.
 322  *
 323  * This function resets %errno before calling strtod() so that
 324  * you can reliably detect overflow and underflow.
 325  *
 326  * Return value: the #gdouble value.
 327  **/
 328 gdouble
 329 g_ascii_strtod (const gchar *nptr,
 330                 gchar      **endptr)
 331 {
 332   gchar *fail_pos;
 333   gdouble val;
 334   struct lconv *locale_data;
 335   const char *decimal_point;
 336   int decimal_point_len;
 337   const char *p, *decimal_point_pos;
 338   const char *end = NULL; /* Silence gcc */
 339   int strtod_errno;
 340
 341   g_return_val_if_fail (nptr != NULL, 0);
 342
 343   fail_pos = NULL;
 344
 345   locale_data = localeconv ();
 346   decimal_point = locale_data->decimal_point;
 347   decimal_point_len = strlen (decimal_point);
 348
 349   g_assert (decimal_point_len != 0);
 350
 351   decimal_point_pos = NULL;
 352   end = NULL;
 353
 354   if (decimal_point[0] != '.' ||
 355       decimal_point[1] != 0)
 356     {
 357       p = nptr;
 358       /* Skip leading space */
 359       while (g_ascii_isspace (*p))
 360         p++;
 361
 362       /* Skip leading optional sign */
 363       if (*p == '+' || *p == '-')
 364         p++;
 365
 366       if (p[0] == '0' &&
 367           (p[1] == 'x' || p[1] == 'X'))
 368         {
 369           p += 2;
 370           /* HEX - find the (optional) decimal point */
 371
 372           while (g_ascii_isxdigit (*p))
 373             p++;
 374
 375           if (*p == '.')
 376             decimal_point_pos = p++;
 377
 378           while (g_ascii_isxdigit (*p))
 379             p++;
 380
 381           if (*p == 'p' || *p == 'P')
 382             p++;
 383           if (*p == '+' || *p == '-')
 384             p++;
 385           while (g_ascii_isdigit (*p))
 386             p++;
 387
 388           end = p;
 389         }
 390       else if (g_ascii_isdigit (*p) || *p == '.')
 391         {
 392           while (g_ascii_isdigit (*p))
 393             p++;
 394
 395           if (*p == '.')
 396             decimal_point_pos = p++;
 397
 398           while (g_ascii_isdigit (*p))
 399             p++;
 400
 401           if (*p == 'e' || *p == 'E')
 402             p++;
 403           if (*p == '+' || *p == '-')
 404             p++;
 405           while (g_ascii_isdigit (*p))
 406             p++;
 407
 408           end = p;
 409         }
 410       /* For the other cases, we need not convert the decimal point */
 411     }
 412
 413   if (decimal_point_pos)
 414     {
 415       char *copy, *c;
 416
 417       /* We need to convert the '.' to the locale specific decimal point */
 418       copy = g_malloc (end - nptr + 1 + decimal_point_len);
 419
 420       c = copy;
 421       memcpy (c, nptr, decimal_point_pos - nptr);
 422       c += decimal_point_pos - nptr;
 423       memcpy (c, decimal_point, decimal_point_len);
 424       c += decimal_point_len;
 425       memcpy (c, decimal_point_pos + 1, end - (decimal_point_pos + 1));
 426       c += end - (decimal_point_pos + 1);
 427       *c = 0;
 428
 429       errno = 0;
 430       val = strtod (copy, &fail_pos);
 431       strtod_errno = errno;
 432
 433       if (fail_pos)
 434         {
 435           if (fail_pos - copy > decimal_point_pos - nptr)
 436             fail_pos = (char *)nptr + (fail_pos - copy) - (decimal_point_len - 1);
 437           else
 438             fail_pos = (char *)nptr + (fail_pos - copy);
 439         }
 440
 441       g_free (copy);
 442
 443     }
 444   else if (end)
 445     {
 446       char *copy;
 447
 448       copy = g_malloc (end - (char *)nptr + 1);
 449       memcpy (copy, nptr, end - nptr);
 450       *(copy + (end - (char *)nptr)) = 0;
 451
 452       errno = 0;
 453       val = strtod (copy, &fail_pos);
 454       strtod_errno = errno;
 455
 456       if (fail_pos)
 457         {
 458           fail_pos = (char *)nptr + (fail_pos - copy);
 459         }
 460
 461       g_free (copy);
 462     }
 463   else
 464     {
 465       errno = 0;
 466       val = strtod (nptr, &fail_pos);
 467       strtod_errno = errno;
 468     }
 469
 470   if (endptr)
 471     *endptr = fail_pos;
 472
 473   errno = strtod_errno;
 474
 475   return val;
 476 }
 477
 478
 479 /**
 480  * g_ascii_dtostr:
 481  * @buffer: A buffer to place the resulting string in
 482  * @buf_len: The length of the buffer.
 483  * @d: The #gdouble to convert
 484  *
 485  * Converts a #gdouble to a string, using the '.' as
 486  * decimal point.
 487  *
 488  * This functions generates enough precision that converting
 489  * the string back using g_ascii_strtod() gives the same machine-number
 490  * (on machines with IEEE compatible 64bit doubles). It is
 491  * guaranteed that the size of the resulting string will never
 492  * be larger than @G_ASCII_DTOSTR_BUF_SIZE bytes.
 493  *
 494  * Return value: The pointer to the buffer with the converted string.
 495  **/
 496 gchar *
 497 g_ascii_dtostr (gchar       *buffer,
 498                 gint         buf_len,
 499                 gdouble      d)
 500 {
 501   return g_ascii_formatd (buffer, buf_len, "%.17g", d);
 502 }
 503
 504 /**
 505  * g_ascii_formatd:
 506  * @buffer: A buffer to place the resulting string in
 507  * @buf_len: The length of the buffer.
 508  * @format: The printf()-style format to use for the
 509  *          code to use for converting.
 510  * @d: The #gdouble to convert
 511  *
 512  * Converts a #gdouble to a string, using the '.' as
 513  * decimal point. To format the number you pass in
 514  * a printf()-style format string. Allowed conversion
 515  * specifiers are 'e', 'E', 'f', 'F', 'g' and 'G'.
 516  *
 517  * If you just want to want to serialize the value into a
 518  * string, use g_ascii_dtostr().
 519  *
 520  * Return value: The pointer to the buffer with the converted string.
 521  **/
 522 gchar *
 523 g_ascii_formatd (gchar       *buffer,
 524                  gint         buf_len,
 525                  const gchar *format,
 526                  gdouble      d)
 527 {
 528   struct lconv *locale_data;
 529   const char *decimal_point;
 530   int decimal_point_len;
 531   gchar *p;
 532   int rest_len;
 533   gchar format_char;
 534
 535   g_return_val_if_fail (buffer != NULL, NULL);
 536   g_return_val_if_fail (format[0] == '%', NULL);
 537   g_return_val_if_fail (strpbrk (format + 1, "'l%") == NULL, NULL);
 538
 539   format_char = format[strlen (format) - 1];
 540
 541   g_return_val_if_fail (format_char == 'e' || format_char == 'E' ||
 542                         format_char == 'f' || format_char == 'F' ||
 543                         format_char == 'g' || format_char == 'G',
 544                         NULL);
 545
 546   if (format[0] != '%')
 547     return NULL;
 548
 549   if (strpbrk (format + 1, "'l%"))
 550     return NULL;
 551
 552   if (!(format_char == 'e' || format_char == 'E' ||
 553         format_char == 'f' || format_char == 'F' ||
 554         format_char == 'g' || format_char == 'G'))
 555     return NULL;
 556
 557
 558   _g_snprintf (buffer, buf_len, format, d);
 559
 560   locale_data = localeconv ();
 561   decimal_point = locale_data->decimal_point;
 562   decimal_point_len = strlen (decimal_point);
 563
 564   g_assert (decimal_point_len != 0);
 565
 566   if (decimal_point[0] != '.' ||
 567       decimal_point[1] != 0)
 568     {
 569       p = buffer;
 570
 571       if (*p == '+' || *p == '-')
 572         p++;
 573
 574       while (isdigit ((guchar)*p))
 575         p++;
 576
 577       if (strncmp (p, decimal_point, decimal_point_len) == 0)
 578         {
 579           *p = '.';
 580           p++;
 581           if (decimal_point_len > 1) {
 582             rest_len = strlen (p + (decimal_point_len-1));
 583             memmove (p, p + (decimal_point_len-1),
 584                      rest_len);
 585             p[rest_len] = 0;
 586
 587           }
 588         }
 589     }
 590
 591   return buffer;
 592 }
 593
 594 /**
 595  * g_ascii_strtoull:
 596  * @nptr:    the string to convert to a numeric value.
 597  * @endptr:  if non-%NULL, it returns the character after
 598  *           the last character used in the conversion.
 599  * @base:    to be used for the conversion, 2..36 or 0
 600  *
 601  * Converts a string to a #guint64 value.
 602  * This function behaves like the standard strtoull() function
 603  * does in the C locale. It does this without actually
 604  * changing the current locale, since that would not be
 605  * thread-safe.
 606  *
 607  * This function is typically used when reading configuration
 608  * files or other non-user input that should be locale independent.
 609  * To handle input from the user you should normally use the
 610  * locale-sensitive system strtoull() function.
 611  *
 612  * If the correct value would cause overflow, %G_MAXUINT64
 613  * is returned, and %ERANGE is stored in %errno.
 614  *
 615  * Return value: the #guint64 value.
 616  *
 617  * Since: 2.2
 618  **/
 619 guint64
 620 g_ascii_strtoull (const gchar *nptr,
 621                   gchar      **endptr,
 622                   guint        base)
 623 {
 624   /* this code is based on on the strtol(3) code from GNU libc released under
 625    * the GNU Lesser General Public License.
 626    *
 627    * Copyright (C) 1991,92,94,95,96,97,98,99,2000,01,02
 628    *        Free Software Foundation, Inc.
 629    */
 630 #define ISSPACE(c)              ((c) == ' ' || (c) == '\f' || (c) == '\n' || \
 631                                  (c) == '\r' || (c) == '\t' || (c) == '\v')
 632 #define ISUPPER(c)              ((c) >= 'A' && (c) <= 'Z')
 633 #define ISLOWER(c)              ((c) >= 'a' && (c) <= 'z')
 634 #define ISALPHA(c)              (ISUPPER (c) || ISLOWER (c))
 635 #define TOUPPER(c)              (ISLOWER (c) ? (c) - 'a' + 'A' : (c))
 636 #define TOLOWER(c)              (ISUPPER (c) ? (c) - 'A' + 'a' : (c))
 637   gboolean negative, overflow;
 638   guint64 cutoff;
 639   guint64 cutlim;
 640   guint64 ui64;
 641   const gchar *s, *save;
 642   guchar c;
 643
 644   g_return_val_if_fail (nptr != NULL, 0);
 645
 646   if (base == 1 || base > 36)
 647     {
 648       errno = EINVAL;
 649       return 0;
 650     }
 651
 652   save = s = nptr;
 653
 654   /* Skip white space.  */
 655   while (ISSPACE (*s))
 656     ++s;
 657   if (!*s)
 658     goto noconv;
 659
 660   /* Check for a sign.  */
 661   negative = FALSE;
 662   if (*s == '-')
 663     {
 664       negative = TRUE;
 665       ++s;
 666     }
 667   else if (*s == '+')
 668     ++s;
 669
 670   /* Recognize number prefix and if BASE is zero, figure it out ourselves.  */
 671   if (*s == '0')
 672     {
 673       if ((base == 0 || base == 16) && TOUPPER (s[1]) == 'X')
 674         {
 675           s += 2;
 676           base = 16;
 677         }
 678       else if (base == 0)
 679         base = 8;
 680     }
 681   else if (base == 0)
 682     base = 10;
 683
 684   /* Save the pointer so we can check later if anything happened.  */
 685   save = s;
 686   cutoff = G_MAXUINT64 / base;
 687   cutlim = G_MAXUINT64 % base;
 688
 689   overflow = FALSE;
 690   ui64 = 0;
 691   c = *s;
 692   for (; c; c = *++s)
 693     {
 694       if (c >= '0' && c <= '9')
 695         c -= '0';
 696       else if (ISALPHA (c))
 697         c = TOUPPER (c) - 'A' + 10;
 698       else
 699         break;
 700       if (c >= base)
 701         break;
 702       /* Check for overflow.  */
 703       if (ui64 > cutoff || (ui64 == cutoff && c > cutlim))
 704         overflow = TRUE;
 705       else
 706         {
 707           ui64 *= base;
 708           ui64 += c;
 709         }
 710     }
 711
 712   /* Check if anything actually happened.  */
 713   if (s == save)
 714     goto noconv;
 715
 716   /* Store in ENDPTR the address of one character
 717      past the last character we converted.  */
 718   if (endptr)
 719     *endptr = (gchar*) s;
 720
 721   if (overflow)
 722     {
 723       errno = ERANGE;
 724       return G_MAXUINT64;
 725     }
 726
 727   /* Return the result of the appropriate sign.  */
 728   return negative ? -ui64 : ui64;
 729
 730  noconv:
 731   /* We must handle a special case here: the base is 0 or 16 and the
 732      first two characters are '0' and 'x', but the rest are no
 733      hexadecimal digits.  This is no error case.  We return 0 and
 734      ENDPTR points to the `x`.  */
 735   if (endptr)
 736     {
 737       if (save - nptr >= 2 && TOUPPER (save[-1]) == 'X'
 738           && save[-2] == '0')
 739         *endptr = (gchar*) &save[-1];
 740       else
 741         /*  There was no number to convert.  */
 742         *endptr = (gchar*) nptr;
 743     }
 744   return 0;
 745 }
 746
 747
 748 G_CONST_RETURN gchar*
 749 g_strerror (gint errnum)
 750 {
 751   static GStaticPrivate msg_private = G_STATIC_PRIVATE_INIT;
 752   char *msg;
 753   int saved_errno = errno;
 754
 755 #ifdef HAVE_STRERROR
 756   const char *msg_locale;
 757
 758   msg_locale = strerror (errnum);
 759   if (g_get_charset (NULL))
 760     {
 761       errno = saved_errno;
 762       return msg_locale;
 763     }
 764   else
 765     {
 766       gchar *msg_utf8 = g_locale_to_utf8 (msg_locale, -1, NULL, NULL, NULL);
 767       if (msg_utf8)
 768         {
 769           /* Stick in the quark table so that we can return a static result
 770            */
 771           GQuark msg_quark = g_quark_from_string (msg_utf8);
 772           g_free (msg_utf8);
 773
 774           msg_utf8 = (gchar *) g_quark_to_string (msg_quark);
 775           errno = saved_errno;
 776           return msg_utf8;
 777         }
 778     }
 779 #elif NO_SYS_ERRLIST
 780   switch (errnum)
 781     {
 782 #ifdef E2BIG
 783     case E2BIG: return "argument list too long";
 784 #endif
 785 #ifdef EACCES
 786     case EACCES: return "permission denied";
 787 #endif
 788 #ifdef EADDRINUSE
 789     case EADDRINUSE: return "address already in use";
 790 #endif
 791 #ifdef EADDRNOTAVAIL
 792     case EADDRNOTAVAIL: return "can't assign requested address";
 793 #endif
 794 #ifdef EADV
 795     case EADV: return "advertise error";
 796 #endif
 797 #ifdef EAFNOSUPPORT
 798     case EAFNOSUPPORT: return "address family not supported by protocol family";
 799 #endif
 800 #ifdef EAGAIN
 801     case EAGAIN: return "try again";
 802 #endif
 803 #ifdef EALIGN
 804     case EALIGN: return "EALIGN";
 805 #endif
 806 #ifdef EALREADY
 807     case EALREADY: return "operation already in progress";
 808 #endif
 809 #ifdef EBADE
 810     case EBADE: return "bad exchange descriptor";
 811 #endif
 812 #ifdef EBADF
 813     case EBADF: return "bad file number";
 814 #endif
 815 #ifdef EBADFD
 816     case EBADFD: return "file descriptor in bad state";
 817 #endif
 818 #ifdef EBADMSG
 819     case EBADMSG: return "not a data message";
 820 #endif
 821 #ifdef EBADR
 822     case EBADR: return "bad request descriptor";
 823 #endif
 824 #ifdef EBADRPC
 825     case EBADRPC: return "RPC structure is bad";
 826 #endif
 827 #ifdef EBADRQC
 828     case EBADRQC: return "bad request code";
 829 #endif
 830 #ifdef EBADSLT
 831     case EBADSLT: return "invalid slot";
 832 #endif
 833 #ifdef EBFONT
 834     case EBFONT: return "bad font file format";
 835 #endif
 836 #ifdef EBUSY
 837     case EBUSY: return "mount device busy";
 838 #endif
 839 #ifdef ECHILD
 840     case ECHILD: return "no children";
 841 #endif
 842 #ifdef ECHRNG
 843     case ECHRNG: return "channel number out of range";
 844 #endif
 845 #ifdef ECOMM
 846     case ECOMM: return "communication error on send";
 847 #endif
 848 #ifdef ECONNABORTED
 849     case ECONNABORTED: return "software caused connection abort";
 850 #endif
 851 #ifdef ECONNREFUSED
 852     case ECONNREFUSED: return "connection refused";
 853 #endif
 854 #ifdef ECONNRESET
 855     case ECONNRESET: return "connection reset by peer";
 856 #endif
 857 #if defined(EDEADLK) && (!defined(EWOULDBLOCK) || (EDEADLK != EWOULDBLOCK))
 858     case EDEADLK: return "resource deadlock avoided";
 859 #endif
 860 #ifdef EDEADLOCK
 861     case EDEADLOCK: return "resource deadlock avoided";
 862 #endif
 863 #ifdef EDESTADDRREQ
 864     case EDESTADDRREQ: return "destination address required";
 865 #endif
 866 #ifdef EDIRTY
 867     case EDIRTY: return "mounting a dirty fs w/o force";
 868 #endif
 869 #ifdef EDOM
 870     case EDOM: return "math argument out of range";
 871 #endif
 872 #ifdef EDOTDOT
 873     case EDOTDOT: return "cross mount point";
 874 #endif
 875 #ifdef EDQUOT
 876     case EDQUOT: return "disk quota exceeded";
 877 #endif
 878 #ifdef EDUPPKG
 879     case EDUPPKG: return "duplicate package name";
 880 #endif
 881 #ifdef EEXIST
 882     case EEXIST: return "file already exists";
 883 #endif
 884 #ifdef EFAULT
 885     case EFAULT: return "bad address in system call argument";
 886 #endif
 887 #ifdef EFBIG
 888     case EFBIG: return "file too large";
 889 #endif
 890 #ifdef EHOSTDOWN
 891     case EHOSTDOWN: return "host is down";
 892 #endif
 893 #ifdef EHOSTUNREACH
 894     case EHOSTUNREACH: return "host is unreachable";
 895 #endif
 896 #ifdef EIDRM
 897     case EIDRM: return "identifier removed";
 898 #endif
 899 #ifdef EINIT
 900     case EINIT: return "initialization error";
 901 #endif
 902 #ifdef EINPROGRESS
 903     case EINPROGRESS: return "operation now in progress";
 904 #endif
 905 #ifdef EINTR
 906     case EINTR: return "interrupted system call";
 907 #endif
 908 #ifdef EINVAL
 909     case EINVAL: return "invalid argument";
 910 #endif
 911 #ifdef EIO
 912     case EIO: return "I/O error";
 913 #endif
 914 #ifdef EISCONN
 915     case EISCONN: return "socket is already connected";
 916 #endif
 917 #ifdef EISDIR
 918     case EISDIR: return "is a directory";
 919 #endif
 920 #ifdef EISNAME
 921     case EISNAM: return "is a name file";
 922 #endif
 923 #ifdef ELBIN
 924     case ELBIN: return "ELBIN";
 925 #endif
 926 #ifdef EL2HLT
 927     case EL2HLT: return "level 2 halted";
 928 #endif
 929 #ifdef EL2NSYNC
 930     case EL2NSYNC: return "level 2 not synchronized";
 931 #endif
 932 #ifdef EL3HLT
 933     case EL3HLT: return "level 3 halted";
 934 #endif
 935 #ifdef EL3RST
 936     case EL3RST: return "level 3 reset";
 937 #endif
 938 #ifdef ELIBACC
 939     case ELIBACC: return "can not access a needed shared library";
 940 #endif
 941 #ifdef ELIBBAD
 942     case ELIBBAD: return "accessing a corrupted shared library";
 943 #endif
 944 #ifdef ELIBEXEC
 945     case ELIBEXEC: return "can not exec a shared library directly";
 946 #endif
 947 #ifdef ELIBMAX
 948     case ELIBMAX: return "attempting to link in more shared libraries than system limit";
 949 #endif
 950 #ifdef ELIBSCN
 951     case ELIBSCN: return ".lib section in a.out corrupted";
 952 #endif
 953 #ifdef ELNRNG
 954     case ELNRNG: return "link number out of range";
 955 #endif
 956 #ifdef ELOOP
 957     case ELOOP: return "too many levels of symbolic links";
 958 #endif
 959 #ifdef EMFILE
 960     case EMFILE: return "too many open files";
 961 #endif
 962 #ifdef EMLINK
 963     case EMLINK: return "too many links";
 964 #endif
 965 #ifdef EMSGSIZE
 966     case EMSGSIZE: return "message too long";
 967 #endif
 968 #ifdef EMULTIHOP
 969     case EMULTIHOP: return "multihop attempted";
 970 #endif
 971 #ifdef ENAMETOOLONG
 972     case ENAMETOOLONG: return "file name too long";
 973 #endif
 974 #ifdef ENAVAIL
 975     case ENAVAIL: return "not available";
 976 #endif
 977 #ifdef ENET
 978     case ENET: return "ENET";
 979 #endif
 980 #ifdef ENETDOWN
 981     case ENETDOWN: return "network is down";
 982 #endif
 983 #ifdef ENETRESET
 984     case ENETRESET: return "network dropped connection on reset";
 985 #endif
 986 #ifdef ENETUNREACH
 987     case ENETUNREACH: return "network is unreachable";
 988 #endif
 989 #ifdef ENFILE
 990     case ENFILE: return "file table overflow";
 991 #endif
 992 #ifdef ENOANO
 993     case ENOANO: return "anode table overflow";
 994 #endif
 995 #if defined(ENOBUFS) && (!defined(ENOSR) || (ENOBUFS != ENOSR))
 996     case ENOBUFS: return "no buffer space available";
 997 #endif
 998 #ifdef ENOCSI
 999     case ENOCSI: return "no CSI structure available";
1000 #endif
1001 #ifdef ENODATA
1002     case ENODATA: return "no data available";
1003 #endif
1004 #ifdef ENODEV
1005     case ENODEV: return "no such device";
1006 #endif
1007 #ifdef ENOENT
1008     case ENOENT: return "no such file or directory";
1009 #endif
1010 #ifdef ENOEXEC
1011     case ENOEXEC: return "exec format error";
1012 #endif
1013 #ifdef ENOLCK
1014     case ENOLCK: return "no locks available";
1015 #endif
1016 #ifdef ENOLINK
1017     case ENOLINK: return "link has be severed";
1018 #endif
1019 #ifdef ENOMEM
1020     case ENOMEM: return "not enough memory";
1021 #endif
1022 #ifdef ENOMSG
1023     case ENOMSG: return "no message of desired type";
1024 #endif
1025 #ifdef ENONET
1026     case ENONET: return "machine is not on the network";
1027 #endif
1028 #ifdef ENOPKG
1029     case ENOPKG: return "package not installed";
1030 #endif
1031 #ifdef ENOPROTOOPT
1032     case ENOPROTOOPT: return "bad proocol option";
1033 #endif
1034 #ifdef ENOSPC
1035     case ENOSPC: return "no space left on device";
1036 #endif
1037 #ifdef ENOSR
1038     case ENOSR: return "out of stream resources";
1039 #endif
1040 #ifdef ENOSTR
1041     case ENOSTR: return "not a stream device";
1042 #endif
1043 #ifdef ENOSYM
1044     case ENOSYM: return "unresolved symbol name";
1045 #endif
1046 #ifdef ENOSYS
1047     case ENOSYS: return "function not implemented";
1048 #endif
1049 #ifdef ENOTBLK
1050     case ENOTBLK: return "block device required";
1051 #endif
1052 #ifdef ENOTCONN
1053     case ENOTCONN: return "socket is not connected";
1054 #endif
1055 #ifdef ENOTDIR
1056     case ENOTDIR: return "not a directory";
1057 #endif
1058 #ifdef ENOTEMPTY
1059     case ENOTEMPTY: return "directory not empty";
1060 #endif
1061 #ifdef ENOTNAM
1062     case ENOTNAM: return "not a name file";
1063 #endif
1064 #ifdef ENOTSOCK
1065     case ENOTSOCK: return "socket operation on non-socket";
1066 #endif
1067 #ifdef ENOTTY
1068     case ENOTTY: return "inappropriate device for ioctl";
1069 #endif
1070 #ifdef ENOTUNIQ
1071     case ENOTUNIQ: return "name not unique on network";
1072 #endif
1073 #ifdef ENXIO
1074     case ENXIO: return "no such device or address";
1075 #endif
1076 #ifdef EOPNOTSUPP
1077     case EOPNOTSUPP: return "operation not supported on socket";
1078 #endif
1079 #ifdef EPERM
1080     case EPERM: return "not owner";
1081 #endif
1082 #ifdef EPFNOSUPPORT
1083     case EPFNOSUPPORT: return "protocol family not supported";
1084 #endif
1085 #ifdef EPIPE
1086     case EPIPE: return "broken pipe";
1087 #endif
1088 #ifdef EPROCLIM
1089     case EPROCLIM: return "too many processes";
1090 #endif
1091 #ifdef EPROCUNAVAIL
1092     case EPROCUNAVAIL: return "bad procedure for program";
1093 #endif
1094 #ifdef EPROGMISMATCH
1095     case EPROGMISMATCH: return "program version wrong";
1096 #endif
1097 #ifdef EPROGUNAVAIL
1098     case EPROGUNAVAIL: return "RPC program not available";
1099 #endif
1100 #ifdef EPROTO
1101     case EPROTO: return "protocol error";
1102 #endif
1103 #ifdef EPROTONOSUPPORT
1104     case EPROTONOSUPPORT: return "protocol not suppored";
1105 #endif
1106 #ifdef EPROTOTYPE
1107     case EPROTOTYPE: return "protocol wrong type for socket";
1108 #endif
1109 #ifdef ERANGE
1110     case ERANGE: return "math result unrepresentable";
1111 #endif
1112 #if defined(EREFUSED) && (!defined(ECONNREFUSED) || (EREFUSED != ECONNREFUSED))
1113     case EREFUSED: return "EREFUSED";
1114 #endif
1115 #ifdef EREMCHG
1116     case EREMCHG: return "remote address changed";
1117 #endif
1118 #ifdef EREMDEV
1119     case EREMDEV: return "remote device";
1120 #endif
1121 #ifdef EREMOTE
1122     case EREMOTE: return "pathname hit remote file system";
1123 #endif
1124 #ifdef EREMOTEIO
1125     case EREMOTEIO: return "remote i/o error";
1126 #endif
1127 #ifdef EREMOTERELEASE
1128     case EREMOTERELEASE: return "EREMOTERELEASE";
1129 #endif
1130 #ifdef EROFS
1131     case EROFS: return "read-only file system";
1132 #endif
1133 #ifdef ERPCMISMATCH
1134     case ERPCMISMATCH: return "RPC version is wrong";
1135 #endif
1136 #ifdef ERREMOTE
1137     case ERREMOTE: return "object is remote";
1138 #endif
1139 #ifdef ESHUTDOWN
1140     case ESHUTDOWN: return "can't send afer socket shutdown";
1141 #endif
1142 #ifdef ESOCKTNOSUPPORT
1143     case ESOCKTNOSUPPORT: return "socket type not supported";
1144 #endif
1145 #ifdef ESPIPE
1146     case ESPIPE: return "invalid seek";
1147 #endif
1148 #ifdef ESRCH
1149     case ESRCH: return "no such process";
1150 #endif
1151 #ifdef ESRMNT
1152     case ESRMNT: return "srmount error";
1153 #endif
1154 #ifdef ESTALE
1155     case ESTALE: return "stale remote file handle";
1156 #endif
1157 #ifdef ESUCCESS
1158     case ESUCCESS: return "Error 0";
1159 #endif
1160 #ifdef ETIME
1161     case ETIME: return "timer expired";
1162 #endif
1163 #ifdef ETIMEDOUT
1164     case ETIMEDOUT: return "connection timed out";
1165 #endif
1166 #ifdef ETOOMANYREFS
1167     case ETOOMANYREFS: return "too many references: can't splice";
1168 #endif
1169 #ifdef ETXTBSY
1170     case ETXTBSY: return "text file or pseudo-device busy";
1171 #endif
1172 #ifdef EUCLEAN
1173     case EUCLEAN: return "structure needs cleaning";
1174 #endif
1175 #ifdef EUNATCH
1176     case EUNATCH: return "protocol driver not attached";
1177 #endif
1178 #ifdef EUSERS
1179     case EUSERS: return "too many users";
1180 #endif
1181 #ifdef EVERSION
1182     case EVERSION: return "version mismatch";
1183 #endif
1184 #if defined(EWOULDBLOCK) && (!defined(EAGAIN) || (EWOULDBLOCK != EAGAIN))
1185     case EWOULDBLOCK: return "operation would block";
1186 #endif
1187 #ifdef EXDEV
1188     case EXDEV: return "cross-domain link";
1189 #endif
1190 #ifdef EXFULL
1191     case EXFULL: return "message tables full";
1192 #endif
1193     }
1194 #else /* NO_SYS_ERRLIST */
1195   extern int sys_nerr;
1196   extern char *sys_errlist[];
1197
1198   if ((errnum > 0) && (errnum <= sys_nerr))
1199     return sys_errlist [errnum];
1200 #endif /* NO_SYS_ERRLIST */
1201
1202   msg = g_static_private_get (&msg_private);
1203   if (!msg)
1204     {
1205       msg = g_new (gchar, 64);
1206       g_static_private_set (&msg_private, msg, g_free);
1207     }
1208
1209   _g_sprintf (msg, "unknown error (%d)", errnum);
1210
1211   errno = saved_errno;
1212   return msg;
1213 }
1214
1215 G_CONST_RETURN gchar*
1216 g_strsignal (gint signum)
1217 {
1218   static GStaticPrivate msg_private = G_STATIC_PRIVATE_INIT;
1219   char *msg;
1220
1221 #ifdef HAVE_STRSIGNAL
1222   const char *msg_locale;
1223
1224 #if defined(G_OS_BEOS) || defined(G_WITH_CYGWIN)
1225 extern const char *strsignal(int);
1226 #else
1227   /* this is declared differently (const) in string.h on BeOS */
1228   extern char *strsignal (int sig);
1229 #endif /* !G_OS_BEOS && !G_WITH_CYGWIN */
1230   msg_locale = strsignal (signum);
1231   if (g_get_charset (NULL))
1232     return msg_locale;
1233   else
1234     {
1235       gchar *msg_utf8 = g_locale_to_utf8 (msg_locale, -1, NULL, NULL, NULL);
1236       if (msg_utf8)
1237         {
1238           /* Stick in the quark table so that we can return a static result
1239            */
1240           GQuark msg_quark = g_quark_from_string (msg_utf8);
1241           g_free (msg_utf8);
1242
1243           return g_quark_to_string (msg_quark);
1244         }
1245     }
1246 #elif NO_SYS_SIGLIST
1247   switch (signum)
1248     {
1249 #ifdef SIGHUP
1250     case SIGHUP: return "Hangup";
1251 #endif
1252 #ifdef SIGINT
1253     case SIGINT: return "Interrupt";
1254 #endif
1255 #ifdef SIGQUIT
1256     case SIGQUIT: return "Quit";
1257 #endif
1258 #ifdef SIGILL
1259     case SIGILL: return "Illegal instruction";
1260 #endif
1261 #ifdef SIGTRAP
1262     case SIGTRAP: return "Trace/breakpoint trap";
1263 #endif
1264 #ifdef SIGABRT
1265     case SIGABRT: return "IOT trap/Abort";
1266 #endif
1267 #ifdef SIGBUS
1268     case SIGBUS: return "Bus error";
1269 #endif
1270 #ifdef SIGFPE
1271     case SIGFPE: return "Floating point exception";
1272 #endif
1273 #ifdef SIGKILL
1274     case SIGKILL: return "Killed";
1275 #endif
1276 #ifdef SIGUSR1
1277     case SIGUSR1: return "User defined signal 1";
1278 #endif
1279 #ifdef SIGSEGV
1280     case SIGSEGV: return "Segmentation fault";
1281 #endif
1282 #ifdef SIGUSR2
1283     case SIGUSR2: return "User defined signal 2";
1284 #endif
1285 #ifdef SIGPIPE
1286     case SIGPIPE: return "Broken pipe";
1287 #endif
1288 #ifdef SIGALRM
1289     case SIGALRM: return "Alarm clock";
1290 #endif
1291 #ifdef SIGTERM
1292     case SIGTERM: return "Terminated";
1293 #endif
1294 #ifdef SIGSTKFLT
1295     case SIGSTKFLT: return "Stack fault";
1296 #endif
1297 #ifdef SIGCHLD
1298     case SIGCHLD: return "Child exited";
1299 #endif
1300 #ifdef SIGCONT
1301     case SIGCONT: return "Continued";
1302 #endif
1303 #ifdef SIGSTOP
1304     case SIGSTOP: return "Stopped (signal)";
1305 #endif
1306 #ifdef SIGTSTP
1307     case SIGTSTP: return "Stopped";
1308 #endif
1309 #ifdef SIGTTIN
1310     case SIGTTIN: return "Stopped (tty input)";
1311 #endif
1312 #ifdef SIGTTOU
1313     case SIGTTOU: return "Stopped (tty output)";
1314 #endif
1315 #ifdef SIGURG
1316     case SIGURG: return "Urgent condition";
1317 #endif
1318 #ifdef SIGXCPU
1319     case SIGXCPU: return "CPU time limit exceeded";
1320 #endif
1321 #ifdef SIGXFSZ
1322     case SIGXFSZ: return "File size limit exceeded";
1323 #endif
1324 #ifdef SIGVTALRM
1325     case SIGVTALRM: return "Virtual time alarm";
1326 #endif
1327 #ifdef SIGPROF
1328     case SIGPROF: return "Profile signal";
1329 #endif
1330 #ifdef SIGWINCH
1331     case SIGWINCH: return "Window size changed";
1332 #endif
1333 #ifdef SIGIO
1334     case SIGIO: return "Possible I/O";
1335 #endif
1336 #ifdef SIGPWR
1337     case SIGPWR: return "Power failure";
1338 #endif
1339 #ifdef SIGUNUSED
1340     case SIGUNUSED: return "Unused signal";
1341 #endif
1342     }
1343 #else /* NO_SYS_SIGLIST */
1344
1345 #ifdef NO_SYS_SIGLIST_DECL
1346   extern char *sys_siglist[];   /*(see Tue Jan 19 00:44:24 1999 in changelog)*/
1347 #endif
1348
1349   return (char*) /* this function should return const --josh */ sys_siglist [signum];
1350 #endif /* NO_SYS_SIGLIST */
1351
1352   msg = g_static_private_get (&msg_private);
1353   if (!msg)
1354     {
1355       msg = g_new (gchar, 64);
1356       g_static_private_set (&msg_private, msg, g_free);
1357     }
1358
1359   _g_sprintf (msg, "unknown signal (%d)", signum);
1360
1361   return msg;
1362 }
1363
1364 /* Functions g_strlcpy and g_strlcat were originally developed by
1365  * Todd C. Miller <Todd.Miller@courtesan.com> to simplify writing secure code.
1366  * See ftp://ftp.openbsd.org/pub/OpenBSD/src/lib/libc/string/strlcpy.3
1367  * for more information.
1368  */
1369
1370 #ifdef HAVE_STRLCPY
1371 /* Use the native ones, if available; they might be implemented in assembly */
1372 gsize
1373 g_strlcpy (gchar       *dest,
1374            const gchar *src,
1375            gsize        dest_size)
1376 {
1377   g_return_val_if_fail (dest != NULL, 0);
1378   g_return_val_if_fail (src  != NULL, 0);
1379
1380   return strlcpy (dest, src, dest_size);
1381 }
1382
1383 gsize
1384 g_strlcat (gchar       *dest,
1385            const gchar *src,
1386            gsize        dest_size)
1387 {
1388   g_return_val_if_fail (dest != NULL, 0);
1389   g_return_val_if_fail (src  != NULL, 0);
1390
1391   return strlcat (dest, src, dest_size);
1392 }
1393
1394 #else /* ! HAVE_STRLCPY */
1395 /* g_strlcpy
1396  *
1397  * Copy string src to buffer dest (of buffer size dest_size).  At most
1398  * dest_size-1 characters will be copied.  Always NUL terminates
1399  * (unless dest_size == 0).  This function does NOT allocate memory.
1400  * Unlike strncpy, this function doesn't pad dest (so it's often faster).
1401  * Returns size of attempted result, strlen(src),
1402  * so if retval >= dest_size, truncation occurred.
1403  */
1404 gsize
1405 g_strlcpy (gchar       *dest,
1406            const gchar *src,
1407            gsize        dest_size)
1408 {
1409   register gchar *d = dest;
1410   register const gchar *s = src;
1411   register gsize n = dest_size;
1412
1413   g_return_val_if_fail (dest != NULL, 0);
1414   g_return_val_if_fail (src  != NULL, 0);
1415
1416   /* Copy as many bytes as will fit */
1417   if (n != 0 && --n != 0)
1418     do
1419       {
1420         register gchar c = *s++;
1421
1422         *d++ = c;
1423         if (c == 0)
1424           break;
1425       }
1426     while (--n != 0);
1427
1428   /* If not enough room in dest, add NUL and traverse rest of src */
1429   if (n == 0)
1430     {
1431       if (dest_size != 0)
1432         *d = 0;
1433       while (*s++)
1434         ;
1435     }
1436
1437   return s - src - 1;  /* count does not include NUL */
1438 }
1439
1440 /* g_strlcat
1441  *
1442  * Appends string src to buffer dest (of buffer size dest_size).
1443  * At most dest_size-1 characters will be copied.
1444  * Unlike strncat, dest_size is the full size of dest, not the space left over.
1445  * This function does NOT allocate memory.
1446  * This always NUL terminates (unless siz == 0 or there were no NUL characters
1447  * in the dest_size characters of dest to start with).
1448  * Returns size of attempted result, which is
1449  * MIN (dest_size, strlen (original dest)) + strlen (src),
1450  * so if retval >= dest_size, truncation occurred.
1451  */
1452 gsize
1453 g_strlcat (gchar       *dest,
1454            const gchar *src,
1455            gsize        dest_size)
1456 {
1457   register gchar *d = dest;
1458   register const gchar *s = src;
1459   register gsize bytes_left = dest_size;
1460   gsize dlength;  /* Logically, MIN (strlen (d), dest_size) */
1461
1462   g_return_val_if_fail (dest != NULL, 0);
1463   g_return_val_if_fail (src  != NULL, 0);
1464
1465   /* Find the end of dst and adjust bytes left but don't go past end */
1466   while (*d != 0 && bytes_left-- != 0)
1467     d++;
1468   dlength = d - dest;
1469   bytes_left = dest_size - dlength;
1470
1471   if (bytes_left == 0)
1472     return dlength + strlen (s);
1473
1474   while (*s != 0)
1475     {
1476       if (bytes_left != 1)
1477         {
1478           *d++ = *s;
1479           bytes_left--;
1480         }
1481       s++;
1482     }
1483   *d = 0;
1484
1485   return dlength + (s - src);  /* count does not include NUL */
1486 }
1487 #endif /* ! HAVE_STRLCPY */
1488
1489 /**
1490  * g_ascii_strdown:
1491  * @str: a string.
1492  * @len: length of @str in bytes, or -1 if @str is nul-terminated.
1493  *
1494  * Converts all upper case ASCII letters to lower case ASCII letters.
1495  *
1496  * Return value: a newly-allocated string, with all the upper case
1497  *               characters in @str converted to lower case, with
1498  *               semantics that exactly match g_ascii_tolower(). (Note
1499  *               that this is unlike the old g_strdown(), which modified
1500  *               the string in place.)
1501  **/
1502 gchar*
1503 g_ascii_strdown (const gchar *str,
1504                  gssize       len)
1505 {
1506   gchar *result, *s;
1507
1508   g_return_val_if_fail (str != NULL, NULL);
1509
1510   if (len < 0)
1511     len = strlen (str);
1512
1513   result = g_strndup (str, len);
1514   for (s = result; *s; s++)
1515     *s = g_ascii_tolower (*s);
1516
1517   return result;
1518 }
1519
1520 /**
1521  * g_ascii_strup:
1522  * @str: a string.
1523  * @len: length of @str in bytes, or -1 if @str is nul-terminated.
1524  *
1525  * Converts all lower case ASCII letters to upper case ASCII letters.
1526  *
1527  * Return value: a newly allocated string, with all the lower case
1528  *               characters in @str converted to upper case, with
1529  *               semantics that exactly match g_ascii_toupper(). (Note
1530  *               that this is unlike the old g_strup(), which modified
1531  *               the string in place.)
1532  **/
1533 gchar*
1534 g_ascii_strup (const gchar *str,
1535                gssize       len)
1536 {
1537   gchar *result, *s;
1538
1539   g_return_val_if_fail (str != NULL, NULL);
1540
1541   if (len < 0)
1542     len = strlen (str);
1543
1544   result = g_strndup (str, len);
1545   for (s = result; *s; s++)
1546     *s = g_ascii_toupper (*s);
1547
1548   return result;
1549 }
1550
1551 /**
1552  * g_strdown:
1553  * @string: the string to convert.
1554  *
1555  * Converts a string to lower case.
1556  *
1557  * Return value: the string
1558  *
1559  * Deprecated: This function is totally broken for the reasons discussed in
1560  * the g_strncasecmp() docs - use g_ascii_strdown() or g_utf8_strdown()
1561  * instead.
1562  **/
1563 gchar*
1564 g_strdown (gchar *string)
1565 {
1566   register guchar *s;
1567
1568   g_return_val_if_fail (string != NULL, NULL);
1569
1570   s = (guchar *) string;
1571
1572   while (*s)
1573     {
1574       if (isupper (*s))
1575         *s = tolower (*s);
1576       s++;
1577     }
1578
1579   return (gchar *) string;
1580 }
1581
1582 /**
1583  * g_strup:
1584  * @string: the string to convert.
1585  *
1586  * Converts a string to upper case.
1587  *
1588  * Return value: the string
1589  *
1590  * Deprecated: This function is totally broken for the reasons discussed in
1591  * the g_strncasecmp() docs - use g_ascii_strup() or g_utf8_strup() instead.
1592  **/
1593 gchar*
1594 g_strup (gchar *string)
1595 {
1596   register guchar *s;
1597
1598   g_return_val_if_fail (string != NULL, NULL);
1599
1600   s = (guchar *) string;
1601
1602   while (*s)
1603     {
1604       if (islower (*s))
1605         *s = toupper (*s);
1606       s++;
1607     }
1608
1609   return (gchar *) string;
1610 }
1611
1612 gchar*
1613 g_strreverse (gchar *string)
1614 {
1615   g_return_val_if_fail (string != NULL, NULL);
1616
1617   if (*string)
1618     {
1619       register gchar *h, *t;
1620
1621       h = string;
1622       t = string + strlen (string) - 1;
1623
1624       while (h < t)
1625         {
1626           register gchar c;
1627
1628           c = *h;
1629           *h = *t;
1630           h++;
1631           *t = c;
1632           t--;
1633         }
1634     }
1635
1636   return string;
1637 }
1638
1639 /**
1640  * g_ascii_tolower:
1641  * @c: any character.
1642  *
1643  * Convert a character to ASCII lower case.
1644  *
1645  * Unlike the standard C library tolower() function, this only
1646  * recognizes standard ASCII letters and ignores the locale, returning
1647  * all non-ASCII characters unchanged, even if they are lower case
1648  * letters in a particular character set. Also unlike the standard
1649  * library function, this takes and returns a char, not an int, so
1650  * don't call it on %EOF but no need to worry about casting to #guchar
1651  * before passing a possibly non-ASCII character in.
1652  *
1653  * Return value: the result of converting @c to lower case.
1654  *               If @c is not an ASCII upper case letter,
1655  *               @c is returned unchanged.
1656  **/
1657 gchar
1658 g_ascii_tolower (gchar c)
1659 {
1660   return g_ascii_isupper (c) ? c - 'A' + 'a' : c;
1661 }
1662
1663 /**
1664  * g_ascii_toupper:
1665  * @c: any character.
1666  *
1667  * Convert a character to ASCII upper case.
1668  *
1669  * Unlike the standard C library toupper() function, this only
1670  * recognizes standard ASCII letters and ignores the locale, returning
1671  * all non-ASCII characters unchanged, even if they are upper case
1672  * letters in a particular character set. Also unlike the standard
1673  * library function, this takes and returns a char, not an int, so
1674  * don't call it on %EOF but no need to worry about casting to #guchar
1675  * before passing a possibly non-ASCII character in.
1676  *
1677  * Return value: the result of converting @c to upper case.
1678  *               If @c is not an ASCII lower case letter,
1679  *               @c is returned unchanged.
1680  **/
1681 gchar
1682 g_ascii_toupper (gchar c)
1683 {
1684   return g_ascii_islower (c) ? c - 'a' + 'A' : c;
1685 }
1686
1687 /**
1688  * g_ascii_digit_value:
1689  * @c: an ASCII character.
1690  *
1691  * Determines the numeric value of a character as a decimal
1692  * digit. Differs from g_unichar_digit_value() because it takes
1693  * a char, so there's no worry about sign extension if characters
1694  * are signed.
1695  *
1696  * Return value: If @c is a decimal digit (according to
1697  * g_ascii_isdigit()), its numeric value. Otherwise, -1.
1698  **/
1699 int
1700 g_ascii_digit_value (gchar c)
1701 {
1702   if (g_ascii_isdigit (c))
1703     return c - '0';
1704   return -1;
1705 }
1706
1707 /**
1708  * g_ascii_xdigit_value:
1709  * @c: an ASCII character.
1710  *
1711  * Determines the numeric value of a character as a hexidecimal
1712  * digit. Differs from g_unichar_xdigit_value() because it takes
1713  * a char, so there's no worry about sign extension if characters
1714  * are signed.
1715  *
1716  * Return value: If @c is a hex digit (according to
1717  * g_ascii_isxdigit()), its numeric value. Otherwise, -1.
1718  **/
1719 int
1720 g_ascii_xdigit_value (gchar c)
1721 {
1722   if (c >= 'A' && c <= 'F')
1723     return c - 'A' + 10;
1724   if (c >= 'a' && c <= 'f')
1725     return c - 'a' + 10;
1726   return g_ascii_digit_value (c);
1727 }
1728
1729 /**
1730  * g_ascii_strcasecmp:
1731  * @s1: string to compare with @s2.
1732  * @s2: string to compare with @s1.
1733  *
1734  * Compare two strings, ignoring the case of ASCII characters.
1735  *
1736  * Unlike the BSD strcasecmp() function, this only recognizes standard
1737  * ASCII letters and ignores the locale, treating all non-ASCII
1738  * characters as if they are not letters.
1739  *
1740  * Return value: an integer less than, equal to, or greater than
1741  *               zero if @s1 is found, respectively, to be less than,
1742  *               to match, or to be greater than @s2.
1743  **/
1744 gint
1745 g_ascii_strcasecmp (const gchar *s1,
1746                     const gchar *s2)
1747 {
1748   gint c1, c2;
1749
1750   g_return_val_if_fail (s1 != NULL, 0);
1751   g_return_val_if_fail (s2 != NULL, 0);
1752
1753   while (*s1 && *s2)
1754     {
1755       c1 = (gint)(guchar) TOLOWER (*s1);
1756       c2 = (gint)(guchar) TOLOWER (*s2);
1757       if (c1 != c2)
1758         return (c1 - c2);
1759       s1++; s2++;
1760     }
1761
1762   return (((gint)(guchar) *s1) - ((gint)(guchar) *s2));
1763 }
1764
1765 /**
1766  * g_ascii_strncasecmp:
1767  * @s1: string to compare with @s2.
1768  * @s2: string to compare with @s1.
1769  * @n:  number of characters to compare.
1770  *
1771  * Compare @s1 and @s2, ignoring the case of ASCII characters and any
1772  * characters after the first @n in each string.
1773  *
1774  * Unlike the BSD strcasecmp() function, this only recognizes standard
1775  * ASCII letters and ignores the locale, treating all non-ASCII
1776  * characters as if they are not letters.
1777  *
1778  * Return value: an integer less than, equal to, or greater than zero
1779  *               if the first @n bytes of @s1 is found, respectively,
1780  *               to be less than, to match, or to be greater than the
1781  *               first @n bytes of @s2.
1782  **/
1783 gint
1784 g_ascii_strncasecmp (const gchar *s1,
1785                      const gchar *s2,
1786                      gsize n)
1787 {
1788   gint c1, c2;
1789
1790   g_return_val_if_fail (s1 != NULL, 0);
1791   g_return_val_if_fail (s2 != NULL, 0);
1792
1793   while (n && *s1 && *s2)
1794     {
1795       n -= 1;
1796       c1 = (gint)(guchar) TOLOWER (*s1);
1797       c2 = (gint)(guchar) TOLOWER (*s2);
1798       if (c1 != c2)
1799         return (c1 - c2);
1800       s1++; s2++;
1801     }
1802
1803   if (n)
1804     return (((gint) (guchar) *s1) - ((gint) (guchar) *s2));
1805   else
1806     return 0;
1807 }
1808
1809 /**
1810  * g_strcasecmp:
1811  * @s1: a string.
1812  * @s2: a string to compare with @s1.
1813  *
1814  * A case-insensitive string comparison, corresponding to the standard
1815  * strcasecmp() function on platforms which support it.
1816  *
1817  * Return value: 0 if the strings match, a negative value if @s1 &lt; @s2,
1818  *   or a positive value if @s1 &gt; @s2.
1819  *
1820  * Deprecated: See g_strncasecmp() for a discussion of why this function is
1821  *   deprecated and how to replace it.
1822  **/
1823 gint
1824 g_strcasecmp (const gchar *s1,
1825               const gchar *s2)
1826 {
1827 #ifdef HAVE_STRCASECMP
1828   g_return_val_if_fail (s1 != NULL, 0);
1829   g_return_val_if_fail (s2 != NULL, 0);
1830
1831   return strcasecmp (s1, s2);
1832 #else
1833   gint c1, c2;
1834
1835   g_return_val_if_fail (s1 != NULL, 0);
1836   g_return_val_if_fail (s2 != NULL, 0);
1837
1838   while (*s1 && *s2)
1839     {
1840       /* According to A. Cox, some platforms have islower's that
1841        * don't work right on non-uppercase
1842        */
1843       c1 = isupper ((guchar)*s1) ? tolower ((guchar)*s1) : *s1;
1844       c2 = isupper ((guchar)*s2) ? tolower ((guchar)*s2) : *s2;
1845       if (c1 != c2)
1846         return (c1 - c2);
1847       s1++; s2++;
1848     }
1849
1850   return (((gint)(guchar) *s1) - ((gint)(guchar) *s2));
1851 #endif
1852 }
1853
1854 /**
1855  * g_strncasecmp:
1856  * @s1: a string.
1857  * @s2: a string to compare with @s1.
1858  * @n: the maximum number of characters to compare.
1859  *
1860  * A case-insensitive string comparison, corresponding to the standard
1861  * strncasecmp() function on platforms which support it.
1862  * It is similar to g_strcasecmp() except it only compares the first @n
1863  * characters of the strings.
1864  *
1865  * Return value: 0 if the strings match, a negative value if @s1 &lt; @s2,
1866  *   or a positive value if @s1 &gt; @s2.
1867  *
1868  * Deprecated: The problem with g_strncasecmp() is that it does the
1869  * comparison by calling toupper()/tolower(). These functions are
1870  * locale-specific and operate on single bytes. However, it is impossible
1871  * to handle things correctly from an I18N standpoint by operating on
1872  * bytes, since characters may be multibyte. Thus g_strncasecmp() is
1873  * broken if your string is guaranteed to be ASCII, since it's
1874  * locale-sensitive, and it's broken if your string is localized, since
1875  * it doesn't work on many encodings at all, including UTF-8, EUC-JP,
1876  * etc.
1877  *
1878  * There are therefore two replacement functions: g_ascii_strncasecmp(),
1879  * which only works on ASCII and is not locale-sensitive, and
1880  * g_utf8_casefold(), which is good for case-insensitive sorting of UTF-8.
1881  **/
1882 gint
1883 g_strncasecmp (const gchar *s1,
1884                const gchar *s2,
1885                guint n)
1886 {
1887 #ifdef HAVE_STRNCASECMP
1888   return strncasecmp (s1, s2, n);
1889 #else
1890   gint c1, c2;
1891
1892   g_return_val_if_fail (s1 != NULL, 0);
1893   g_return_val_if_fail (s2 != NULL, 0);
1894
1895   while (n && *s1 && *s2)
1896     {
1897       n -= 1;
1898       /* According to A. Cox, some platforms have islower's that
1899        * don't work right on non-uppercase
1900        */
1901       c1 = isupper ((guchar)*s1) ? tolower ((guchar)*s1) : *s1;
1902       c2 = isupper ((guchar)*s2) ? tolower ((guchar)*s2) : *s2;
1903       if (c1 != c2)
1904         return (c1 - c2);
1905       s1++; s2++;
1906     }
1907
1908   if (n)
1909     return (((gint) (guchar) *s1) - ((gint) (guchar) *s2));
1910   else
1911     return 0;
1912 #endif
1913 }
1914
1915 gchar*
1916 g_strdelimit (gchar       *string,
1917               const gchar *delimiters,
1918               gchar        new_delim)
1919 {
1920   register gchar *c;
1921
1922   g_return_val_if_fail (string != NULL, NULL);
1923
1924   if (!delimiters)
1925     delimiters = G_STR_DELIMITERS;
1926
1927   for (c = string; *c; c++)
1928     {
1929       if (strchr (delimiters, *c))
1930         *c = new_delim;
1931     }
1932
1933   return string;
1934 }
1935
1936 gchar*
1937 g_strcanon (gchar       *string,
1938             const gchar *valid_chars,
1939             gchar        substitutor)
1940 {
1941   register gchar *c;
1942
1943   g_return_val_if_fail (string != NULL, NULL);
1944   g_return_val_if_fail (valid_chars != NULL, NULL);
1945
1946   for (c = string; *c; c++)
1947     {
1948       if (!strchr (valid_chars, *c))
1949         *c = substitutor;
1950     }
1951
1952   return string;
1953 }
1954
1955 gchar*
1956 g_strcompress (const gchar *source)
1957 {
1958   const gchar *p = source, *octal;
1959   gchar *dest = g_malloc (strlen (source) + 1);
1960   gchar *q = dest;
1961
1962   while (*p)
1963     {
1964       if (*p == '\\')
1965         {
1966           p++;
1967           switch (*p)
1968             {
1969             case '\0':
1970               g_warning ("g_strcompress: trailing \\");
1971               goto out;
1972             case '0':  case '1':  case '2':  case '3':  case '4':
1973             case '5':  case '6':  case '7':
1974               *q = 0;
1975               octal = p;
1976               while ((p < octal + 3) && (*p >= '0') && (*p <= '7'))
1977                 {
1978                   *q = (*q * 8) + (*p - '0');
1979                   p++;
1980                 }
1981               q++;
1982               p--;
1983               break;
1984             case 'b':
1985               *q++ = '\b';
1986               break;
1987             case 'f':
1988               *q++ = '\f';
1989               break;
1990             case 'n':
1991               *q++ = '\n';
1992               break;
1993             case 'r':
1994               *q++ = '\r';
1995               break;
1996             case 't':
1997               *q++ = '\t';
1998               break;
1999             default:            /* Also handles \" and \\ */
2000               *q++ = *p;
2001               break;
2002             }
2003         }
2004       else
2005         *q++ = *p;
2006       p++;
2007     }
2008 out:
2009   *q = 0;
2010
2011   return dest;
2012 }
2013
2014 gchar *
2015 g_strescape (const gchar *source,
2016              const gchar *exceptions)
2017 {
2018   const guchar *p;
2019   gchar *dest;
2020   gchar *q;
2021   guchar excmap[256];
2022
2023   g_return_val_if_fail (source != NULL, NULL);
2024
2025   p = (guchar *) source;
2026   /* Each source byte needs maximally four destination chars (\777) */
2027   q = dest = g_malloc (strlen (source) * 4 + 1);
2028
2029   memset (excmap, 0, 256);
2030   if (exceptions)
2031     {
2032       guchar *e = (guchar *) exceptions;
2033
2034       while (*e)
2035         {
2036           excmap[*e] = 1;
2037           e++;
2038         }
2039     }
2040
2041   while (*p)
2042     {
2043       if (excmap[*p])
2044         *q++ = *p;
2045       else
2046         {
2047           switch (*p)
2048             {
2049             case '\b':
2050               *q++ = '\\';
2051               *q++ = 'b';
2052               break;
2053             case '\f':
2054               *q++ = '\\';
2055               *q++ = 'f';
2056               break;
2057             case '\n':
2058               *q++ = '\\';
2059               *q++ = 'n';
2060               break;
2061             case '\r':
2062               *q++ = '\\';
2063               *q++ = 'r';
2064               break;
2065             case '\t':
2066               *q++ = '\\';
2067               *q++ = 't';
2068               break;
2069             case '\\':
2070               *q++ = '\\';
2071               *q++ = '\\';
2072               break;
2073             case '"':
2074               *q++ = '\\';
2075               *q++ = '"';
2076               break;
2077             default:
2078               if ((*p < ' ') || (*p >= 0177))
2079                 {
2080                   *q++ = '\\';
2081                   *q++ = '0' + (((*p) >> 6) & 07);
2082                   *q++ = '0' + (((*p) >> 3) & 07);
2083                   *q++ = '0' + ((*p) & 07);
2084                 }
2085               else
2086                 *q++ = *p;
2087               break;
2088             }
2089         }
2090       p++;
2091     }
2092   *q = 0;
2093   return dest;
2094 }
2095
2096 gchar*
2097 g_strchug (gchar *string)
2098 {
2099   guchar *start;
2100
2101   g_return_val_if_fail (string != NULL, NULL);
2102
2103   for (start = (guchar*) string; *start && g_ascii_isspace (*start); start++)
2104     ;
2105
2106   g_memmove (string, start, strlen ((gchar *) start) + 1);
2107
2108   return string;
2109 }
2110
2111 gchar*
2112 g_strchomp (gchar *string)
2113 {
2114   gsize len;
2115
2116   g_return_val_if_fail (string != NULL, NULL);
2117
2118   len = strlen (string);
2119   while (len--)
2120     {
2121       if (g_ascii_isspace ((guchar) string[len]))
2122         string[len] = '\0';
2123       else
2124         break;
2125     }
2126
2127   return string;
2128 }
2129
2130 /**
2131  * g_strsplit:
2132  * @string: a string to split.
2133  * @delimiter: a string which specifies the places at which to split the string.
2134  *     The delimiter is not included in any of the resulting strings, unless
2135  *     @max_tokens is reached.
2136  * @max_tokens: the maximum number of pieces to split @string into. If this is
2137  *              less than 1, the string is split completely.
2138  *
2139  * Splits a string into a maximum of @max_tokens pieces, using the given
2140  * @delimiter. If @max_tokens is reached, the remainder of @string is appended
2141  * to the last token.
2142  *
2143  * As a special case, the result of splitting the empty string "" is an empty
2144  * vector, not a vector containing a single string. The reason for this
2145  * special case is that being able to represent a empty vector is typically
2146  * more useful than consistent handling of empty elements. If you do need
2147  * to represent empty elements, you'll need to check for the empty string
2148  * before calling g_strsplit().
2149  *
2150  * Return value: a newly-allocated %NULL-terminated array of strings. Use
2151  *    g_strfreev() to free it.
2152  **/
2153 gchar**
2154 g_strsplit (const gchar *string,
2155             const gchar *delimiter,
2156             gint         max_tokens)
2157 {
2158   GSList *string_list = NULL, *slist;
2159   gchar **str_array, *s;
2160   guint n = 0;
2161   const gchar *remainder;
2162
2163   g_return_val_if_fail (string != NULL, NULL);
2164   g_return_val_if_fail (delimiter != NULL, NULL);
2165   g_return_val_if_fail (delimiter[0] != '\0', NULL);
2166
2167   if (max_tokens < 1)
2168     max_tokens = G_MAXINT;
2169
2170   remainder = string;
2171   s = strstr (remainder, delimiter);
2172   if (s)
2173     {
2174       gsize delimiter_len = strlen (delimiter);
2175
2176       while (--max_tokens && s)
2177         {
2178           gsize len;
2179           gchar *new_string;
2180
2181           len = s - remainder;
2182           new_string = g_new (gchar, len + 1);
2183           strncpy (new_string, remainder, len);
2184           new_string[len] = 0;
2185           string_list = g_slist_prepend (string_list, new_string);
2186           n++;
2187           remainder = s + delimiter_len;
2188           s = strstr (remainder, delimiter);
2189         }
2190     }
2191   if (*string)
2192     {
2193       n++;
2194       string_list = g_slist_prepend (string_list, g_strdup (remainder));
2195     }
2196
2197   str_array = g_new (gchar*, n + 1);
2198
2199   str_array[n--] = NULL;
2200   for (slist = string_list; slist; slist = slist->next)
2201     str_array[n--] = slist->data;
2202
2203   g_slist_free (string_list);
2204
2205   return str_array;
2206 }
2207
2208 /**
2209  * g_strsplit_set:
2210  * @string: The string to be tokenized
2211  * @delimiters: A nul-terminated string containing bytes that are used
2212  *              to split the string.
2213  * @max_tokens: The maximum number of tokens to split @string into.
2214  *              If this is less than 1, the string is split completely
2215  *
2216  * Splits @string into a number of tokens not containing any of the characters
2217  * in @delimiter. A token is the (possibly empty) longest string that does not
2218  * contain any of the characters in @delimiters. If @max_tokens is reached, the
2219  * remainder is appended to the last token.
2220  *
2221  * For example the result of g_strsplit_set ("abc:def/ghi", ":/", -1) is a
2222  * %NULL-terminated vector containing the three strings "abc", "def",
2223  * and "ghi".
2224  *
2225  * The result if g_strsplit_set (":def/ghi:", ":/", -1) is a %NULL-terminated
2226  * vector containing the four strings "", "def", "ghi", and "".
2227  *
2228  * As a special case, the result of splitting the empty string "" is an empty
2229  * vector, not a vector containing a single string. The reason for this
2230  * special case is that being able to represent a empty vector is typically
2231  * more useful than consistent handling of empty elements. If you do need
2232  * to represent empty elements, you'll need to check for the empty string
2233  * before calling g_strsplit_set().
2234  *
2235  * Note that this function works on bytes not characters, so it can't be used
2236  * to delimit UTF-8 strings for anything but ASCII characters.
2237  *
2238  * Return value: a newly-allocated %NULL-terminated array of strings. Use
2239  *    g_strfreev() to free it.
2240  *
2241  * Since: 2.4
2242  **/
2243 gchar **
2244 g_strsplit_set (const gchar *string,
2245                 const gchar *delimiters,
2246                 gint         max_tokens)
2247 {
2248   gboolean delim_table[256];
2249   GSList *tokens, *list;
2250   gint n_tokens;
2251   const gchar *s;
2252   const gchar *current;
2253   gchar *token;
2254   gchar **result;
2255
2256   g_return_val_if_fail (string != NULL, NULL);
2257   g_return_val_if_fail (delimiters != NULL, NULL);
2258
2259   if (max_tokens < 1)
2260     max_tokens = G_MAXINT;
2261
2262   if (*string == '\0')
2263     {
2264       result = g_new (char *, 1);
2265       result[0] = NULL;
2266       return result;
2267     }
2268
2269   memset (delim_table, FALSE, sizeof (delim_table));
2270   for (s = delimiters; *s != '\0'; ++s)
2271     delim_table[*(guchar *)s] = TRUE;
2272
2273   tokens = NULL;
2274   n_tokens = 0;
2275
2276   s = current = string;
2277   while (*s != '\0')
2278     {
2279       if (delim_table[*(guchar *)s] && n_tokens + 1 < max_tokens)
2280         {
2281           gchar *token;
2282
2283           token = g_strndup (current, s - current);
2284           tokens = g_slist_prepend (tokens, token);
2285           ++n_tokens;
2286
2287           current = s + 1;
2288         }
2289
2290       ++s;
2291     }
2292
2293   token = g_strndup (current, s - current);
2294   tokens = g_slist_prepend (tokens, token);
2295   ++n_tokens;
2296
2297   result = g_new (gchar *, n_tokens + 1);
2298
2299   result[n_tokens] = NULL;
2300   for (list = tokens; list != NULL; list = list->next)
2301     result[--n_tokens] = list->data;
2302
2303   g_slist_free (tokens);
2304
2305   return result;
2306 }
2307
2308 /**
2309  * g_strfreev:
2310  * @str_array: a %NULL-terminated array of strings to free.
2311
2312  * Frees a %NULL-terminated array of strings, and the array itself.
2313  * If called on a %NULL value, g_strfreev() simply returns.
2314  **/
2315 void
2316 g_strfreev (gchar **str_array)
2317 {
2318   if (str_array)
2319     {
2320       int i;
2321
2322       for(i = 0; str_array[i] != NULL; i++)
2323         g_free(str_array[i]);
2324
2325       g_free (str_array);
2326     }
2327 }
2328
2329 /**
2330  * g_strdupv:
2331  * @str_array: %NULL-terminated array of strings.
2332  *
2333  * Copies %NULL-terminated array of strings. The copy is a deep copy;
2334  * the new array should be freed by first freeing each string, then
2335  * the array itself. g_strfreev() does this for you. If called
2336  * on a %NULL value, g_strdupv() simply returns %NULL.
2337  *
2338  * Return value: a new %NULL-terminated array of strings.
2339  **/
2340 gchar**
2341 g_strdupv (gchar **str_array)
2342 {
2343   if (str_array)
2344     {
2345       gint i;
2346       gchar **retval;
2347
2348       i = 0;
2349       while (str_array[i])
2350         ++i;
2351
2352       retval = g_new (gchar*, i + 1);
2353
2354       i = 0;
2355       while (str_array[i])
2356         {
2357           retval[i] = g_strdup (str_array[i]);
2358           ++i;
2359         }
2360       retval[i] = NULL;
2361
2362       return retval;
2363     }
2364   else
2365     return NULL;
2366 }
2367
2368 gchar*
2369 g_strjoinv (const gchar  *separator,
2370             gchar       **str_array)
2371 {
2372   gchar *string;
2373   gchar *ptr;
2374
2375   g_return_val_if_fail (str_array != NULL, NULL);
2376
2377   if (separator == NULL)
2378     separator = "";
2379
2380   if (*str_array)
2381     {
2382       gint i;
2383       gsize len;
2384       gsize separator_len;
2385
2386       separator_len = strlen (separator);
2387       /* First part, getting length */
2388       len = 1 + strlen (str_array[0]);
2389       for (i = 1; str_array[i] != NULL; i++)
2390         len += strlen (str_array[i]);
2391       len += separator_len * (i - 1);
2392
2393       /* Second part, building string */
2394       string = g_new (gchar, len);
2395       ptr = g_stpcpy (string, *str_array);
2396       for (i = 1; str_array[i] != NULL; i++)
2397         {
2398           ptr = g_stpcpy (ptr, separator);
2399           ptr = g_stpcpy (ptr, str_array[i]);
2400         }
2401       }
2402   else
2403     string = g_strdup ("");
2404
2405   return string;
2406 }
2407
2408 gchar*
2409 g_strjoin (const gchar  *separator,
2410            ...)
2411 {
2412   gchar *string, *s;
2413   va_list args;
2414   gsize len;
2415   gsize separator_len;
2416   gchar *ptr;
2417
2418   if (separator == NULL)
2419     separator = "";
2420
2421   separator_len = strlen (separator);
2422
2423   va_start (args, separator);
2424
2425   s = va_arg (args, gchar*);
2426
2427   if (s)
2428     {
2429       /* First part, getting length */
2430       len = 1 + strlen (s);
2431
2432       s = va_arg (args, gchar*);
2433       while (s)
2434         {
2435           len += separator_len + strlen (s);
2436           s = va_arg (args, gchar*);
2437         }
2438       va_end (args);
2439
2440       /* Second part, building string */
2441       string = g_new (gchar, len);
2442
2443       va_start (args, separator);
2444
2445       s = va_arg (args, gchar*);
2446       ptr = g_stpcpy (string, s);
2447
2448       s = va_arg (args, gchar*);
2449       while (s)
2450         {
2451           ptr = g_stpcpy (ptr, separator);
2452           ptr = g_stpcpy (ptr, s);
2453           s = va_arg (args, gchar*);
2454         }
2455     }
2456   else
2457     string = g_strdup ("");
2458
2459   va_end (args);
2460
2461   return string;
2462 }
2463
2464
2465 /**
2466  * g_strstr_len:
2467  * @haystack: a string.
2468  * @haystack_len: the maximum length of @haystack.
2469  * @needle: the string to search for.
2470  *
2471  * Searches the string @haystack for the first occurrence
2472  * of the string @needle, limiting the length of the search
2473  * to @haystack_len.
2474  *
2475  * Return value: a pointer to the found occurrence, or
2476  *    %NULL if not found.
2477  **/
2478 gchar *
2479 g_strstr_len (const gchar *haystack,
2480               gssize       haystack_len,
2481               const gchar *needle)
2482 {
2483   g_return_val_if_fail (haystack != NULL, NULL);
2484   g_return_val_if_fail (needle != NULL, NULL);
2485
2486   if (haystack_len < 0)
2487     return strstr (haystack, needle);
2488   else
2489     {
2490       const gchar *p = haystack;
2491       gsize needle_len = strlen (needle);
2492       const gchar *end;
2493       gsize i;
2494
2495       if (needle_len == 0)
2496         return (gchar *)haystack;
2497
2498       if (haystack_len < needle_len)
2499         return NULL;
2500
2501       end = haystack + haystack_len - needle_len;
2502
2503       while (*p && p <= end)
2504         {
2505           for (i = 0; i < needle_len; i++)
2506             if (p[i] != needle[i])
2507               goto next;
2508
2509           return (gchar *)p;
2510
2511         next:
2512           p++;
2513         }
2514
2515       return NULL;
2516     }
2517 }
2518
2519 /**
2520  * g_strrstr:
2521  * @haystack: a nul-terminated string.
2522  * @needle: the nul-terminated string to search for.
2523  *
2524  * Searches the string @haystack for the last occurrence
2525  * of the string @needle.
2526  *
2527  * Return value: a pointer to the found occurrence, or
2528  *    %NULL if not found.
2529  **/
2530 gchar *
2531 g_strrstr (const gchar *haystack,
2532            const gchar *needle)
2533 {
2534   gsize i;
2535   gsize needle_len;
2536   gsize haystack_len;
2537   const gchar *p;
2538
2539   g_return_val_if_fail (haystack != NULL, NULL);
2540   g_return_val_if_fail (needle != NULL, NULL);
2541
2542   needle_len = strlen (needle);
2543   haystack_len = strlen (haystack);
2544
2545   if (needle_len == 0)
2546     return (gchar *)haystack;
2547
2548   if (haystack_len < needle_len)
2549     return NULL;
2550
2551   p = haystack + haystack_len - needle_len;
2552
2553   while (p >= haystack)
2554     {
2555       for (i = 0; i < needle_len; i++)
2556         if (p[i] != needle[i])
2557           goto next;
2558
2559       return (gchar *)p;
2560
2561     next:
2562       p--;
2563     }
2564
2565   return NULL;
2566 }
2567
2568 /**
2569  * g_strrstr_len:
2570  * @haystack: a nul-terminated string.
2571  * @haystack_len: the maximum length of @haystack.
2572  * @needle: the nul-terminated string to search for.
2573  *
2574  * Searches the string @haystack for the last occurrence
2575  * of the string @needle, limiting the length of the search
2576  * to @haystack_len.
2577  *
2578  * Return value: a pointer to the found occurrence, or
2579  *    %NULL if not found.
2580  **/
2581 gchar *
2582 g_strrstr_len (const gchar *haystack,
2583                gssize        haystack_len,
2584                const gchar *needle)
2585 {
2586   g_return_val_if_fail (haystack != NULL, NULL);
2587   g_return_val_if_fail (needle != NULL, NULL);
2588
2589   if (haystack_len < 0)
2590     return g_strrstr (haystack, needle);
2591   else
2592     {
2593       gsize needle_len = strlen (needle);
2594       const gchar *haystack_max = haystack + haystack_len;
2595       const gchar *p = haystack;
2596       gsize i;
2597
2598       while (p < haystack_max && *p)
2599         p++;
2600
2601       if (p < haystack + needle_len)
2602         return NULL;
2603
2604       p -= needle_len;
2605
2606       while (p >= haystack)
2607         {
2608           for (i = 0; i < needle_len; i++)
2609             if (p[i] != needle[i])
2610               goto next;
2611
2612           return (gchar *)p;
2613
2614         next:
2615           p--;
2616         }
2617
2618       return NULL;
2619     }
2620 }
2621
2622
2623 /**
2624  * g_str_has_suffix:
2625  * @str: a nul-terminated string.
2626  * @suffix: the nul-terminated suffix to look for.
2627  *
2628  * Looks whether the string @str ends with @suffix.
2629  *
2630  * Return value: %TRUE if @str end with @suffix, %FALSE otherwise.
2631  *
2632  * Since: 2.2
2633  **/
2634 gboolean
2635 g_str_has_suffix (const gchar  *str,
2636                   const gchar  *suffix)
2637 {
2638   int str_len;
2639   int suffix_len;
2640
2641   g_return_val_if_fail (str != NULL, FALSE);
2642   g_return_val_if_fail (suffix != NULL, FALSE);
2643
2644   str_len = strlen (str);
2645   suffix_len = strlen (suffix);
2646
2647   if (str_len < suffix_len)
2648     return FALSE;
2649
2650   return strcmp (str + str_len - suffix_len, suffix) == 0;
2651 }
2652
2653 /**
2654  * g_str_has_prefix:
2655  * @str: a nul-terminated string.
2656  * @prefix: the nul-terminated prefix to look for.
2657  *
2658  * Looks whether the string @str begins with @prefix.
2659  *
2660  * Return value: %TRUE if @str begins with @prefix, %FALSE otherwise.
2661  *
2662  * Since: 2.2
2663  **/
2664 gboolean
2665 g_str_has_prefix (const gchar  *str,
2666                   const gchar  *prefix)
2667 {
2668   int str_len;
2669   int prefix_len;
2670
2671   g_return_val_if_fail (str != NULL, FALSE);
2672   g_return_val_if_fail (prefix != NULL, FALSE);
2673
2674   str_len = strlen (str);
2675   prefix_len = strlen (prefix);
2676
2677   if (str_len < prefix_len)
2678     return FALSE;
2679
2680   return strncmp (str, prefix, prefix_len) == 0;
2681 }
2682
2683
2684 /**
2685  * g_strip_context:
2686  * @msgid: a string
2687  * @msgval: another string
2688  *
2689  * An auxiliary function for gettext() support (see Q_()).
2690  *
2691  * Return value: @msgval, unless @msgval is identical to @msgid and contains
2692  *   a '|' character, in which case a pointer to the substring of msgid after
2693  *   the first '|' character is returned.
2694  *
2695  * Since: 2.4
2696  **/
2697 G_CONST_RETURN gchar *
2698 g_strip_context  (const gchar *msgid,
2699                   const gchar *msgval)
2700 {
2701   if (msgval == msgid)
2702     {
2703       const char *c = strchr (msgid, '|');
2704       if (c != NULL)
2705         return c + 1;
2706     }
2707
2708   return msgval;
2709 }
2710
2711
2712 /**
2713  * g_strv_length:
2714  * @str_array: a %NULL-terminated array of strings.
2715  *
2716  * Returns the length of the given %NULL-terminated
2717  * string array @str_array.
2718  *
2719  * Return value: length of @str_array.
2720  *
2721  * Since: 2.6
2722  **/
2723 guint
2724 g_strv_length (gchar **str_array)
2725 {
2726   guint i = 0;
2727
2728   g_return_val_if_fail (str_array != NULL, 0);
2729
2730   while (str_array[i])
2731     ++i;
2732
2733   return i;
2734 }
2735
2736 #define __G_STRFUNCS_C__
2737 #include "galiasdef.c"