be more carful wrt. signed vs. unsigned argument passing
[paraslash.git] / string.c
index 156404c..9ad6bfb 100644 (file)
--- a/string.c
+++ b/string.c
@@ -1,5 +1,5 @@
 /*
- * Copyright (C) 2004-2006 Andre Noll <maan@systemlinux.org>
+ * Copyright (C) 2004-2007 Andre Noll <maan@systemlinux.org>
  *
  *     This program is free software; you can redistribute it and/or modify
  *     it under the terms of the GNU General Public License as published by
 
 /** \file string.c memory allocation and string handling functions */
 
-#include <sys/time.h> /* gettimeofday */
 #include "para.h"
-#include <regex.h>
+#include "string.h"
+
+#include <sys/time.h> /* gettimeofday */
 #include <pwd.h>
 #include <sys/utsname.h> /* uname() */
+#include <string.h>
+
 #include "error.h"
-#include "string.h"
 
 /**
  * paraslash's version of realloc()
  *
  * A wrapper for realloc(3). It calls \p exit(\p EXIT_FAILURE) on errors,
  * i.e. there is no need to check the return value in the caller.
+ *
+ * \return A pointer to  the newly allocated memory, which is suitably aligned
+ * for any kind of variable and may be different from \p p.
+ *
  * \sa realloc(3)
  */
 __must_check __malloc void *para_realloc(void *p, size_t size)
@@ -43,7 +49,8 @@ __must_check __malloc void *para_realloc(void *p, size_t size)
         * to realloc is equivalent to malloc(size)
         */
        if (!(p = realloc(p, size))) {
-               PARA_EMERG_LOG("%s", "realloc failed, aborting\n");
+               PARA_EMERG_LOG("realloc failed (size = %zu), aborting\n",
+                       size);
                exit(EXIT_FAILURE);
        }
        return p;
@@ -55,6 +62,10 @@ __must_check __malloc void *para_realloc(void *p, size_t size)
  * \param size desired new size
  *
  * A wrapper for malloc(3) which exits on errors.
+ *
+ * \return A pointer to the allocated memory, which is suitably aligned for any
+ * kind  of variable.
+ *
  * \sa malloc(3)
  */
 __must_check __malloc void *para_malloc(size_t size)
@@ -74,6 +85,10 @@ __must_check __malloc void *para_malloc(size_t size)
  * \param size desired new size
  *
  * A wrapper for calloc(3) which exits on errors.
+ *
+ * \return A pointer to the allocated and zeroed-out memory, which is suitably
+ * aligned for any kind  of variable.
+ *
  * \sa calloc(3)
  */
 __must_check __malloc void *para_calloc(size_t size)
@@ -87,12 +102,13 @@ __must_check __malloc void *para_calloc(size_t size)
 /**
  * paraslash's version of strdup()
  *
- * \param s: string to be duplicated
+ * \param s string to be duplicated
+ *
+ * A wrapper for strdup(3). It calls \p exit(EXIT_FAILURE) on errors, i.e.
+ * there is no need to check the return value in the caller.
  *
- * A wrapper for strdup(3). It calls exit(EXIT_FAILURE) on
- * errors, i.e. there is no need to check the return value in the caller.
- * Moreover, this wrapper checks for \a s being NULL and returns an empty
- * string in this case.
+ * \return A pointer to the duplicated string. If \p s was the NULL pointer,
+ * an pointer to an empty string is returned.
  *
  * \sa strdup(3)
  */
@@ -111,9 +127,11 @@ __must_check __malloc char *para_strdup(const char *s)
  *
  * \param fmt usual format string
  *
- * Produce output according to \a fmt. No artificial bound on the length of the
- * resulting string is imposed. This function either returns a pointer to a
- * string that must be freed by the caller or aborts without returning.
+ * Produce output according to \p fmt. No artificial bound on the length of the
+ * resulting string is imposed.
+ *
+ * \return This function either returns a pointer to a string that must be
+ * freed by the caller or aborts without returning.
  *
  * \sa printf(3)
  */
@@ -131,10 +149,12 @@ __must_check __printf_1_2 __malloc char *make_message(const char *fmt, ...)
  * \param a string to be appended to
  * \param b string to append
  *
- * Append \a b to \a a. If \a a is NULL, return a copy of \a b, i.e.
- * para_strcat(NULL, b) is equivalent to para_strdup(b).  If \a b is NULL,
- * return \a a without making a copy of \a a.  Otherwise, construct the
- * concatenation \a c, free \a a (but not \a b) and return \a c.
+ * Append \p b to \p a.
+ *
+ * \return If \p a is NULL, return a pointer to a copy of \p b, i.e.
+ * para_strcat(NULL, b) is equivalent to para_strdup(b). If \p b is NULL,
+ * return \p a without making a copy of \p a.  Otherwise, construct the
+ * concatenation \p c, free \p a (but not \p b) and return \p c.
  *
  * \sa strcat(3)
  */
@@ -154,11 +174,13 @@ __must_check __malloc char *para_strcat(char *a, const char *b)
 /**
  * paraslash's version of dirname()
  *
- * \param name pointer to The full path
+ * \param name pointer to the full path
+ *
+ * Compute the directory component of \p name
  *
- * If \a name is \þ NULL or the empty string, return \p NULL, Otherwise, Make a
- * copy of \a name and return its directory component. Caller is responsible to
- * free the result.
+ * \return If \p name is \þ NULL or the empty string, return \p NULL.
+ * Otherwise, Make a copy of \p name and return its directory component. Caller
+ * is responsible to free the result.
  */
 __must_check __malloc char *para_dirname(const char *name)
 {
@@ -180,9 +202,11 @@ __must_check __malloc char *para_dirname(const char *name)
  *
  * \param name Pointer to the full path
  *
- * If \a name is \p NULL or the empty string, return \p NULL, Otherwise, make a
- * copy of \a name and return its filename component. Caller is responsible to
- * free the result.
+ * Compute the filename component of \p name
+ *
+ * \return If \p name is \p NULL or the empty string, return \p NULL,
+ * Otherwise, make a copy of \p name and return its filename component. Caller
+ * is responsible to free the result.
  */
 __must_check __malloc char *para_basename(const char *name)
 {
@@ -199,95 +223,12 @@ __must_check __malloc char *para_basename(const char *name)
        return para_strdup(p);
 }
 
-/**
- * simple search and replace routine
- *
- * \param src source string
- * \param macro_name the name of the macro
- * \param replacement the replacement format string
- *
- * Replace \a macro_name(arg) by \a replacement. \a replacement is a format
- * string which may contain a single string conversion specifier which gets
- * replaced by 'arg'.
- *
- * \return A string in which all matches in \a src are replaced, or NULL if an
- * syntax error was encountered. Caller must free the result.
- *
- * \sa regcomp(3)
- */
-__must_check __malloc char *s_a_r(const char *src, const char* macro_name,
-               const char *replacement)
-{
-       regex_t preg;
-       size_t  nmatch = 1;
-       regmatch_t pmatch[1];
-       int eflags = 0;
-       char *dest = NULL;
-       const char *bufptr = src;
-
-       if (!macro_name || !replacement || !src)
-               return para_strdup(src);
-       regcomp(&preg, macro_name, 0);
-       while (regexec(&preg,  bufptr, nmatch, pmatch, eflags)
-                       != REG_NOMATCH) {
-               char *tmp, *arg, *o_bracket, *c_bracket;
-
-               o_bracket = strchr(bufptr + pmatch[0].rm_so, '(');
-               c_bracket = o_bracket? strchr(o_bracket, ')') : NULL;
-               if (!c_bracket)
-                       goto out;
-               tmp = para_strdup(bufptr);
-               tmp[pmatch[0].rm_so] = '\0';
-               dest = para_strcat(dest, tmp);
-               free(tmp);
-
-               arg = para_strdup(o_bracket + 1);
-               arg[c_bracket - o_bracket - 1] = '\0';
-               tmp = make_message(replacement, arg);
-               free(arg);
-               dest = para_strcat(dest, tmp);
-               free(tmp);
-               bufptr = c_bracket;
-               bufptr++;
-       }
-       dest = para_strcat(dest, bufptr);
-//     PARA_DEBUG_LOG("%s: returning %s\n", __func__, dest);
-out:
-       regfree(&preg);
-       return dest;
-}
-
-/**
- * replace a string according to a list of macros
- *
- * \param macro_list the array containing a macro/replacement pairs.
- * \param src the source string
- *
- * This function just calls s_a_r() for each element of \a macro_list.
- */
-__must_check __malloc char *s_a_r_list(struct para_macro *macro_list, char *src)
-{
-       struct para_macro *mp = macro_list;
-       char *ret = NULL, *tmp = para_strdup(src);
-
-       while (mp->name) {
-               ret = s_a_r(tmp, mp->name, mp->replacement);
-               free(tmp);
-               if (!ret) /* syntax error */
-                       return NULL;
-               tmp = ret;
-               mp++;
-       }
-       //PARA_DEBUG_LOG("%s: returning %s\n", __func__, dest);
-       return ret;
-}
-
 /**
  * cut trailing newline
  *
  * \param buf the string to be chopped.
  *
- * Replace the last character in \a buf by zero if it is euqal to
+ * Replace the last character in \p buf by zero if it is euqal to
  * the newline character.
  */
 void chop(char *buf)
@@ -303,14 +244,20 @@ void chop(char *buf)
  * get a random filename
  *
  * This is by no means a secure way to create temporary files in a hostile
- * direcory like /tmp. However, it is OK to use for temp files, fifos, sockets
- * that are created in ~/.paraslash. Result must be freed by the caller.
+ * direcory like \p /tmp. However, it is OK to use for temp files, fifos,
+ * sockets that are created in ~/.paraslash. Result must be freed by the
+ * caller.
+ *
+ * \return a pointer to a random filename.
  */
 __must_check __malloc char *para_tmpname(void)
 {
        struct timeval now;
+       unsigned int seed;
+
        gettimeofday(&now, NULL);
-       srand(now.tv_usec);
+       seed = now.tv_usec;
+       srand(seed);
        return make_message("%08i", rand());
 }
 
@@ -322,7 +269,8 @@ __must_check __malloc char *para_tmpname(void)
  *
  * This wrapper for mkstemp additionally uses fchmod() to
  * set the given mode of the tempfile if mkstemp() returned success.
- * Return value: The file descriptor of the temp file just created on success.
+ *
+ * \return The file descriptor of the temp file just created on success.
  * On errors, -E_MKSTEMP or -E_FCHMOD is returned.
  */
 __must_check int para_mkstemp(char *template, mode_t mode)
@@ -345,6 +293,8 @@ __must_check int para_mkstemp(char *template, mode_t mode)
  * \return A dynammically allocated string that must be freed by the caller. On
  * errors, the string "unknown user" is returned, i.e. this function never
  * returns NULL.
+ *
+ * \sa getpwuid(3)
  */
 __must_check __malloc char *para_logname(void)
 {
@@ -372,39 +322,46 @@ __must_check __malloc char *para_homedir(void)
  * \param delim delimiter
  *
  * This function modifies \a args by replacing each occurance of \a delim by
- * zero. A NULL-terminated array of pointers to char* is allocated dynamically
+ * zero. A \p NULL-terminated array of pointers to char* is allocated dynamically
  * and these pointers are initialized to point to the broken-up substrings
- * within \a args. A pointer to this array is returned via \a argv_ptr.
+ * within \a args. A pointer to this array is returned via \a argv_ptr. It's OK
+ * to call this function with \a args \a == \p NULL.
  *
  * \return The number of substrings found in \a args.
  */
-__must_check unsigned split_args(char *args, char ***argv_ptr, int delim)
+__must_check unsigned split_args(char *args, char ***argv_ptr, const char *delim)
 {
        char *p = args;
        char **argv;
-       ssize_t n = 0, i;
+       size_t n = 0, i, j;
 
-       while ((p = strchr(p, delim))) {
-               p++;
+       p = args + strspn(args, delim);
+       for (;;) {
+               i = strcspn(p, delim);
+               if (!i)
+                       break;
+               p += i;
                n++;
+               p += strspn(p, delim);
        }
-       *argv_ptr = para_malloc((n + 3) * sizeof(char *));
+       *argv_ptr = para_malloc((n + 1) * sizeof(char *));
        argv = *argv_ptr;
        i = 0;
-       p = args;
-//     printf("split_args: a:%s\n", p);
+       p = args + strspn(args, delim);
        while (p) {
                argv[i] = p;
-               p = strchr(p, delim);
-               if (p) {
-//             printf("a:%s\n", p);
+               j = strcspn(p, delim);
+               if (!j)
+                       break;
+               p += strcspn(p, delim);
+               if (*p) {
                        *p = '\0';
-//             printf("b:\n");
                        p++;
-                       i++;
+                       p += strspn(p, delim);
                }
+               i++;
        }
-       argv[n + 1] = NULL;
+       argv[n] = NULL;
        return n;
 }