Don't modify errno. (#116617, Balazs Scheidler)
[platform/upstream/glib.git] / glib / gstrfuncs.c
index 905bc05..e28f93b 100644 (file)
@@ -28,9 +28,7 @@
  * MT safe
  */
 
-#ifdef HAVE_CONFIG_H
-#include <config.h>
-#endif
+#include "config.h"
 
 #define _GNU_SOURCE            /* For stpcpy */
 
@@ -44,7 +42,9 @@
 #if !defined (HAVE_STRSIGNAL) || !defined(NO_SYS_SIGLIST_DECL)
 #include <signal.h>
 #endif
+
 #include "glib.h"
+#include "gprintf.h"
 #include "gprintfint.h"
 
 #ifdef G_OS_WIN32
@@ -52,7 +52,7 @@
 #endif
 
 /* do not include <unistd.h> in this place since it
- * inteferes with g_strsignal() on some OSes
+ * interferes with g_strsignal() on some OSes
  */
 
 static const guint16 ascii_table_data[256] = {
@@ -84,11 +84,13 @@ gchar*
 g_strdup (const gchar *str)
 {
   gchar *new_str;
+  gsize length;
 
   if (str)
     {
-      new_str = g_new (char, strlen (str) + 1);
-      strcpy (new_str, str);
+      length = strlen (str) + 1;
+      new_str = g_new (char, length);
+      memcpy (new_str, str, length);
     }
   else
     new_str = NULL;
@@ -180,29 +182,13 @@ g_stpcpy (gchar       *dest,
 
 gchar*
 g_strdup_vprintf (const gchar *format,
-                 va_list      args1)
+                 va_list      args)
 {
-  gchar *buffer;
-#ifdef HAVE_VASPRINTF
-  if (_g_vasprintf (&buffer, format, args1) < 0)
-    buffer = NULL;
-  else if (!g_mem_is_system_malloc ()) 
-    {
-      gchar *buffer1 = g_strdup (buffer);
-      free (buffer);
-      buffer = buffer1;
-    }
-#else
-  va_list args2;
-
-  G_VA_COPY (args2, args1);
+  gchar *string = NULL;
 
-  buffer = g_new (gchar, g_printf_string_upper_bound (format, args1));
+  g_vasprintf (&string, format, args);
 
-  _g_vsprintf (buffer, format, args2);
-  va_end (args2);
-#endif
-  return buffer;
+  return string;
 }
 
 gchar*
@@ -228,7 +214,8 @@ g_strconcat (const gchar *string1, ...)
   gchar          *concat;
   gchar   *ptr;
 
-  g_return_val_if_fail (string1 != NULL, NULL);
+  if (!string1)
+    return NULL;
 
   l = 1 + strlen (string1);
   va_start (args, string1);
@@ -326,7 +313,7 @@ g_strtod (const gchar *nptr,
  * To handle input from the user you should normally use the
  * locale-sensitive system strtod() function.
  *
- * To convert from a string to #gdouble in a locale-insensitive
+ * To convert from a #gdouble to a string in a locale-insensitive
  * way, use g_ascii_dtostr().
  *
  * If the correct value would cause overflow, plus or minus %HUGE_VAL
@@ -447,7 +434,7 @@ g_ascii_strtod (const gchar *nptr,
 
       if (fail_pos)
        {
-         if (fail_pos > decimal_point_pos)
+         if (fail_pos - copy > decimal_point_pos - nptr)
            fail_pos = (char *)nptr + (fail_pos - copy) - (decimal_point_len - 1);
          else
            fail_pos = (char *)nptr + (fail_pos - copy);
@@ -476,7 +463,7 @@ g_ascii_strtod (const gchar *nptr,
  * decimal point. 
  * 
  * This functions generates enough precision that converting
- * the string back using g_strtod() gives the same machine-number
+ * the string back using g_ascii_strtod() gives the same machine-number
  * (on machines with IEEE compatible 64bit doubles). It is
  * guaranteed that the size of the resulting string will never
  * be larger than @G_ASCII_DTOSTR_BUF_SIZE bytes.
@@ -495,13 +482,13 @@ g_ascii_dtostr (gchar       *buffer,
  * g_ascii_formatd:
  * @buffer: A buffer to place the resulting string in
  * @buf_len: The length of the buffer.
- * @format: The printf-style format to use for the
+ * @format: The printf()-style format to use for the
  *          code to use for converting. 
  * @d: The #gdouble to convert
  *
  * Converts a #gdouble to a string, using the '.' as
  * decimal point. To format the number you pass in
- * a printf-style formating string. Allowed conversion
+ * a printf()-style format string. Allowed conversion
  * specifiers are 'e', 'E', 'f', 'F', 'g' and 'G'. 
  * 
  * If you just want to want to serialize the value into a
@@ -603,6 +590,8 @@ g_ascii_formatd (gchar       *buffer,
  * is returned, and %ERANGE is stored in %errno.
  *
  * Return value: the #guint64 value.
+ *
+ * Since: 2.2
  **/
 guint64
 g_ascii_strtoull (const gchar *nptr,
@@ -738,13 +727,17 @@ g_strerror (gint errnum)
 {
   static GStaticPrivate msg_private = G_STATIC_PRIVATE_INIT;
   char *msg;
+  int saved_errno = errno;
 
 #ifdef HAVE_STRERROR
   const char *msg_locale;
 
   msg_locale = strerror (errnum);
   if (g_get_charset (NULL))
-    return msg_locale;
+    {
+      errno = saved_errno;
+      return msg_locale;
+    }
   else
     {
       gchar *msg_utf8 = g_locale_to_utf8 (msg_locale, -1, NULL, NULL, NULL);
@@ -755,7 +748,9 @@ g_strerror (gint errnum)
          GQuark msg_quark = g_quark_from_string (msg_utf8);
          g_free (msg_utf8);
          
-         return g_quark_to_string (msg_quark);
+         msg_utf8 = (gchar *) g_quark_to_string (msg_quark);
+         errno = saved_errno;
+         return msg_utf8;
        }
     }
 #elif NO_SYS_ERRLIST
@@ -1190,6 +1185,7 @@ g_strerror (gint errnum)
 
   _g_sprintf (msg, "unknown error (%d)", errnum);
 
+  errno = saved_errno;
   return msg;
 }
 
@@ -1529,6 +1525,18 @@ g_ascii_strup (const gchar *str,
   return result;
 }
 
+/**
+ * g_strdown:
+ * @string: the string to convert.
+ * 
+ * Converts a string to lower case.  
+ * 
+ * Return value: the string 
+ *
+ * Deprecated: This function is totally broken for the reasons discussed in 
+ * the g_strncasecmp() docs - use g_ascii_strdown() or g_utf8_strdown() 
+ * instead.
+ **/
 gchar*
 g_strdown (gchar *string)
 {
@@ -1548,6 +1556,17 @@ g_strdown (gchar *string)
   return (gchar *) string;
 }
 
+/**
+ * g_strup:
+ * @string: the string to convert.
+ * 
+ * Converts a string to upper case. 
+ * 
+ * Return value: the string
+ *
+ * Deprecated: This function is totally broken for the reasons discussed in 
+ * the g_strncasecmp() docs - use g_ascii_strup() or g_utf8_strup() instead.
+ **/
 gchar*
 g_strup (gchar *string)
 {
@@ -1710,8 +1729,8 @@ g_ascii_strcasecmp (const gchar *s1,
 
   while (*s1 && *s2)
     {
-      c1 = (gint)(guchar) g_ascii_tolower (*s1);
-      c2 = (gint)(guchar) g_ascii_tolower (*s2);
+      c1 = (gint)(guchar) TOLOWER (*s1);
+      c2 = (gint)(guchar) TOLOWER (*s2);
       if (c1 != c2)
        return (c1 - c2);
       s1++; s2++;
@@ -1751,8 +1770,8 @@ g_ascii_strncasecmp (const gchar *s1,
   while (n && *s1 && *s2)
     {
       n -= 1;
-      c1 = (gint)(guchar) g_ascii_tolower (*s1);
-      c2 = (gint)(guchar) g_ascii_tolower (*s2);
+      c1 = (gint)(guchar) TOLOWER (*s1);
+      c2 = (gint)(guchar) TOLOWER (*s2);
       if (c1 != c2)
        return (c1 - c2);
       s1++; s2++;
@@ -1764,6 +1783,20 @@ g_ascii_strncasecmp (const gchar *s1,
     return 0;
 }
 
+/**
+ * g_strcasecmp:
+ * @s1: a string.
+ * @s2: a string to compare with @s1.
+ * 
+ * A case-insensitive string comparison, corresponding to the standard
+ * strcasecmp() function on platforms which support it.
+ *
+ * Return value: 0 if the strings match, a negative value if @s1 &lt; @s2, 
+ *   or a positive value if @s1 &gt; @s2.
+ *
+ * Deprecated: See g_strncasecmp() for a discussion of why this function is 
+ *   deprecated and how to replace it.
+ **/
 gint
 g_strcasecmp (const gchar *s1,
              const gchar *s2)
@@ -1795,6 +1828,34 @@ g_strcasecmp (const gchar *s1,
 #endif
 }
 
+/**
+ * g_strncasecmp:
+ * @s1: a string.
+ * @s2: a string to compare with @s1.
+ * @n: the maximum number of characters to compare.
+ * 
+ * A case-insensitive string comparison, corresponding to the standard
+ * strncasecmp() function on platforms which support it.
+ * It is similar to g_strcasecmp() except it only compares the first @n 
+ * characters of the strings.
+ * 
+ * Return value: 0 if the strings match, a negative value if @s1 &lt; @s2, 
+ *   or a positive value if @s1 &gt; @s2.
+ *
+ * Deprecated: The problem with g_strncasecmp() is that it does the 
+ * comparison by calling toupper()/tolower(). These functions are
+ * locale-specific and operate on single bytes. However, it is impossible
+ * to handle things correctly from an I18N standpoint by operating on
+ * bytes, since characters may be multibyte. Thus g_strncasecmp() is
+ * broken if your string is guaranteed to be ASCII, since it's
+ * locale-sensitive, and it's broken if your string is localized, since
+ * it doesn't work on many encodings at all, including UTF-8, EUC-JP,
+ * etc.
+ *
+ * There are therefore two replacement functions: g_ascii_strncasecmp(),
+ * which only works on ASCII and is not locale-sensitive, and
+ * g_utf8_casefold(), which is good for case-insensitive sorting of UTF-8.
+ **/
 gint
 g_strncasecmp (const gchar *s1,
               const gchar *s2,
@@ -2117,6 +2178,113 @@ g_strsplit (const gchar *string,
   return str_array;
 }
 
+/**
+ * g_strsplit_set:
+ * @string: The string to be tokenized
+ * @delimiters: A nul-terminated string containing bytes that are used
+ *              to split the string.
+ * @max_tokens: The maximum number of tokens to split @string into. 
+ *              If this is less than 1, the string is split completely
+ * 
+ * Splits @string into a number of tokens not containing any of the characters
+ * in @delimiter. A token is the (possibly empty) longest string that does not
+ * contain any of the characters in @delimiters. If @max_tokens is reached, the
+ * remainder is appended to the last token.
+ *
+ * For example the result of g_strtokenize ("abc:def/ghi", ":/", -1) is a
+ * %NULL-terminated vector containing the three strings "abc", "def", 
+ * and "ghi".
+ *
+ * The result if g_strtokenize (":def/ghi:", ":/", -1) is a %NULL-terminated
+ * vector containing the four strings "", "def", "ghi", and "".
+ * 
+ * As a special case, the result of splitting the empty string "" is an empty
+ * vector, not a vector containing a single string. The reason for this
+ * special case is that being able to represent a empty vector is typically
+ * more useful than consistent handling of empty elements. If you do need
+ * to represent empty elements, you'll need to check for the empty string
+ * before calling g_strsplit().
+ *
+ * Note that this function works on bytes not characters, so it can't be used 
+ * to delimit UTF-8 strings for anything but ASCII characters.
+ * 
+ * Return value: a newly-allocated %NULL-terminated array of strings. Use 
+ *    g_strfreev() to free it.
+ * 
+ * Since: 2.4
+ **/
+gchar **
+g_strsplit_set (const gchar *string,
+               const gchar *delimiters,
+               gint         max_tokens)
+{
+  gboolean delim_table[256];
+  GSList *tokens, *list;
+  gint n_tokens;
+  const gchar *s;
+  const gchar *current;
+  gchar *token;
+  gchar **result;
+  
+  g_return_val_if_fail (string != NULL, NULL);
+  g_return_val_if_fail (delimiters != NULL, NULL);
+
+  if (max_tokens < 1)
+    max_tokens = G_MAXINT;
+
+  if (*string == '\0')
+    {
+      result = g_new (char *, 1);
+      result[0] = NULL;
+      return result;
+    }
+  
+  memset (delim_table, FALSE, sizeof (delim_table));
+  for (s = delimiters; *s != '\0'; ++s)
+    delim_table[*(guchar *)s] = TRUE;
+
+  tokens = NULL;
+  n_tokens = 0;
+
+  s = current = string;
+  while (*s != '\0')
+    {
+      if (delim_table[*(guchar *)s] && n_tokens + 1 < max_tokens)
+       {
+         gchar *token;
+
+         token = g_strndup (current, s - current);
+         tokens = g_slist_prepend (tokens, token);
+         ++n_tokens;
+
+         current = s + 1;
+       }
+      
+      ++s;
+    }
+
+  token = g_strndup (current, s - current);
+  tokens = g_slist_prepend (tokens, token);
+  ++n_tokens;
+
+  result = g_new (gchar *, n_tokens + 1);
+
+  result[n_tokens] = NULL;
+  for (list = tokens; list != NULL; list = list->next)
+    result[--n_tokens] = list->data;
+
+  g_slist_free (tokens);
+  
+  return result;
+}
+
+/**
+ * g_strfreev:
+ * @str_array: a %NULL-terminated array of strings to free.
+
+ * Frees a %NULL-terminated array of strings, and the array itself.
+ * If called on a %NULL value, g_strfreev() simply returns. 
+ **/
 void
 g_strfreev (gchar **str_array)
 {
@@ -2485,3 +2653,30 @@ g_str_has_prefix (const gchar  *str,
   return strncmp (str, prefix, prefix_len) == 0;
 }
 
+
+/**
+ * g_strip_context:
+ * @msgid: a string
+ * @msgval: another string
+ * 
+ * An auxiliary function for gettext() support (see Q_()).
+ * 
+ * Return value: @msgval, unless @msgval is identical to @msgid and contains
+ *   a '|' character, in which case a pointer to the substring of msgid after
+ *   the first '|' character is returned. 
+ *
+ * Since: 2.4
+ **/
+G_CONST_RETURN gchar *
+g_strip_context  (const gchar *msgid, 
+                 const gchar *msgval)
+{
+  if (msgval == msgid)
+    {
+      const char *c = strchr (msgid, '|');
+      if (c != NULL)
+       return c + 1;
+    }
+  
+  return msgval;
+}