stdin: Abort if the consumer terminates.
[paraslash.git] / string.c
index 78d54f6..752fb8f 100644 (file)
--- a/string.c
+++ b/string.c
@@ -1,10 +1,10 @@
 /*
- * Copyright (C) 2004-2007 Andre Noll <maan@systemlinux.org>
+ * Copyright (C) 2004-2008 Andre Noll <maan@systemlinux.org>
  *
  * Licensed under the GPL v2. For licencing details see COPYING.
  */
 
-/** \file string.c memory allocation and string handling functions */
+/** \file string.c Memory allocation and string handling functions. */
 
 #include "para.h"
 #include "string.h"
 #include "error.h"
 
 /**
- * paraslash's version of realloc()
+ * Paraslash's version of realloc().
  *
- * \param p pointer to the memory block, may be NULL
- * \param size desired new size
+ * \param p Pointer to the memory block, may be \p NULL.
+ * \param size The desired new size.
  *
  * 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.
+ * for any kind of variable and may be different from \a p.
  *
- * \sa realloc(3)
+ * \sa realloc(3).
  */
 __must_check __malloc void *para_realloc(void *p, size_t size)
 {
@@ -46,16 +46,16 @@ __must_check __malloc void *para_realloc(void *p, size_t size)
 }
 
 /**
- * paraslash's version of malloc()
+ * Paraslash's version of malloc().
  *
- * \param size desired new size
+ * \param size The 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.
+ * kind of variable.
  *
- * \sa malloc(3)
+ * \sa malloc(3).
  */
 __must_check __malloc void *para_malloc(size_t size)
 {
@@ -63,21 +63,22 @@ __must_check __malloc void *para_malloc(size_t size)
        void *p = malloc(size);
 
        if (!p) {
-               PARA_EMERG_LOG("%s", "malloc failed, aborting\n");
+               PARA_EMERG_LOG("malloc failed (size = %zu),  aborting\n",
+                       size);
                exit(EXIT_FAILURE);
        }
        return p;
 }
 
 /**
- * paraslash's version of calloc()
+ * Paraslash's version of calloc().
  *
- * \param size desired new size
+ * \param size The 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.
+ * aligned for any kind of variable.
  *
  * \sa calloc(3)
  */
@@ -90,9 +91,9 @@ __must_check __malloc void *para_calloc(size_t size)
 }
 
 /**
- * paraslash's version of strdup()
+ * Paraslash's version of strdup().
  *
- * \param s string to be duplicated
+ * \param s The 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.
@@ -108,14 +109,14 @@ __must_check __malloc char *para_strdup(const char *s)
 
        if ((ret = strdup(s? s: "")))
                return ret;
-       PARA_EMERG_LOG("%s", "strdup failed, aborting\n");
+       PARA_EMERG_LOG("strdup failed, aborting\n");
        exit(EXIT_FAILURE);
 }
 
 /**
- * allocate a sufficiently large string and print into it
+ * Allocate a sufficiently large string and print into it.
  *
- * \param fmt usual format string
+ * \param fmt A usual format string.
  *
  * Produce output according to \p fmt. No artificial bound on the length of the
  * resulting string is imposed.
@@ -123,7 +124,7 @@ __must_check __malloc char *para_strdup(const char *s)
  * \return This function either returns a pointer to a string that must be
  * freed by the caller or aborts without returning.
  *
- * \sa printf(3)
+ * \sa printf(3).
  */
 __must_check __printf_1_2 __malloc char *make_message(const char *fmt, ...)
 {
@@ -134,17 +135,17 @@ __must_check __printf_1_2 __malloc char *make_message(const char *fmt, ...)
 }
 
 /**
- * paraslash's version of strcat()
+ * Paraslash's version of strcat().
  *
- * \param a string to be appended to
- * \param b string to append
+ * \param a String to be appended to.
+ * \param b String to append.
  *
  * 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.
+ * \return If \a a is \p NULL, return a pointer to a copy of \a b, i.e.
+ * para_strcat(NULL, b) is equivalent to para_strdup(b). If \a b is \p 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.
  *
  * \sa strcat(3)
  */
@@ -162,14 +163,14 @@ __must_check __malloc char *para_strcat(char *a, const char *b)
 }
 
 /**
- * paraslash's version of dirname()
+ * 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
+ * Compute the directory component of \p name.
  *
- * \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
+ * \return If \a name is \p 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.
  */
 __must_check __malloc char *para_dirname(const char *name)
@@ -188,35 +189,33 @@ __must_check __malloc char *para_dirname(const char *name)
 }
 
 /**
- * paraslash's version of basename()
+ * Paraslash's version of basename().
  *
- * \param name Pointer to the full path
+ * \param name Pointer to the full path.
  *
- * Compute the filename component of \p name
+ * Compute the filename component of \a 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.
+ * \return \p NULL if (a) \a name is the empty string or \p NULL, or (b) name
+ * ends with a slash.  Otherwise, a pointer within \a name is returned.  Caller
+ * must not free the result.
  */
-__must_check __malloc char *para_basename(const char *name)
+__must_check const char *para_basename(const char *name)
 {
-       char *p;
+       const char *ret;
 
        if (!name || !*name)
                return NULL;
-       p = strrchr(name, '/');
-       if (!p)
-               return para_strdup(name);
-       p++;
-       if (!*p)
-               return NULL;
-       return para_strdup(p);
+       ret = strrchr(name, '/');
+       if (!ret)
+               return name;
+       ret++;
+       return ret;
 }
 
 /**
- * cut trailing newline
+ * Cut trailing newline.
  *
- * \param buf the string to be chopped.
+ * \param buf The string to be chopped.
  *
  * Replace the last character in \p buf by zero if it is euqal to
  * the newline character.
@@ -231,14 +230,14 @@ void chop(char *buf)
 }
 
 /**
- * get a random filename
+ * Get a random filename.
  *
  * This is by no means a secure way to create temporary files in a hostile
  * 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.
+ * \return A pointer to a random filename.
  */
 __must_check __malloc char *para_tmpname(void)
 {
@@ -252,39 +251,13 @@ __must_check __malloc char *para_tmpname(void)
 }
 
 /**
- * create unique temporary file
- *
- * \param template the template to be passed to mkstemp()
- * \param mode the desired mode of the tempfile
- *
- * This wrapper for mkstemp additionally uses fchmod() to
- * set the given mode of the tempfile if mkstemp() returned 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)
-{
-       int tmp, fd = mkstemp(template);
-
-       if (fd < 0)
-               return -E_MKSTEMP;
-       tmp = fchmod(fd, mode);
-       if (tmp >= 0)
-               return fd;
-       close(fd);
-       unlink(template);
-       return -E_FCHMOD;
-}
-
-/**
- * get the logname of the current user
+ * Get the logname of the current user.
  *
  * \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.
+ * returns \p NULL.
  *
- * \sa getpwuid(3)
+ * \sa getpwuid(3).
  */
 __must_check __malloc char *para_logname(void)
 {
@@ -293,7 +266,7 @@ __must_check __malloc char *para_logname(void)
 }
 
 /**
- * get the home directory of the current user
+ * Get the home directory of the current user.
  *
  * \return A dynammically allocated string that must be freed by the caller. If
  * the home directory could not be found, this function returns "/tmp".
@@ -305,17 +278,16 @@ __must_check __malloc char *para_homedir(void)
 }
 
 /**
- * split string and return pointers to its parts.
+ * Split string and return pointers to its parts.
  *
- * \param args the string to be split
- * \param argv_ptr  pointer to the list of substrings
- * \param delim delimiter
+ * \param args The string to be split.
+ * \param argv_ptr Pointer to the list of substrings.
+ * \param delim Delimiter.
  *
  * This function modifies \a args by replacing each occurance of \a delim by
  * 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. It's OK
- * to call this function with \a args \a == \p NULL.
+ * within \a args. A pointer to this array is returned via \a argv_ptr.
  *
  * \return The number of substrings found in \a args.
  */
@@ -356,7 +328,7 @@ __must_check unsigned split_args(char *args, char *** const argv_ptr, const char
 }
 
 /**
- * ensure that file descriptors 0, 1, and 2 are valid
+ * Ensure that file descriptors 0, 1, and 2 are valid.
  *
  * Common approach that opens /dev/null until it gets a file descriptor greater
  * than two.
@@ -366,9 +338,7 @@ __must_check unsigned split_args(char *args, char *** const argv_ptr, const char
 void valid_fd_012(void)
 {
        while (1) {
-       int     fd;
-
-               fd = open("/dev/null", O_RDWR);
+               int fd = open("/dev/null", O_RDWR);
                if (fd < 0)
                        exit(EXIT_FAILURE);
                if (fd > 2) {
@@ -379,11 +349,11 @@ void valid_fd_012(void)
 }
 
 /**
- * get the own hostname
+ * Get the own hostname.
  *
  * \return A dynammically allocated string containing the hostname.
  *
- * \sa uname(2)
+ * \sa uname(2).
  */
 __malloc char *para_hostname(void)
 {
@@ -393,7 +363,17 @@ __malloc char *para_hostname(void)
        return para_strdup(u.nodename);
 }
 
-enum for_each_line_modes{LINE_MODE_RO, LINE_MODE_RW};
+/**
+ * Used to distinguish between read-only and read-write mode.
+ *
+ * \sa for_each_line(), for_each_line_ro().
+ */
+enum for_each_line_modes{
+       /** Activate read-only mode. */
+       LINE_MODE_RO,
+       /** Activate read-write mode. */
+       LINE_MODE_RW
+};
 
 static int for_each_complete_line(enum for_each_line_modes mode, char *buf,
                size_t size, line_handler_t *line_handler, void *private_data)
@@ -446,12 +426,12 @@ static int for_each_complete_line(enum for_each_line_modes mode, char *buf,
 }
 
 /**
- * call a custom function for each complete line
+ * Call a custom function for each complete line.
  *
- * \param buf the buffer containing data seperated by newlines
- * \param size the number of bytes in \a buf
- * \param line_handler the custom function
- * \param private_data pointer to data which is passed to \a line_handler
+ * \param buf The buffer containing data seperated by newlines.
+ * \param size The number of bytes in \a buf.
+ * \param line_handler The custom function.
+ * \param private_data Pointer passed to \a line_handler.
  *
  * If \p line_handler is \p NULL, the function returns the number of complete
  * lines in \p buf.  Otherwise, \p line_handler is called for each complete
@@ -465,7 +445,7 @@ static int for_each_complete_line(enum for_each_line_modes mode, char *buf,
  * of bytes not handled to \p line_handler on success, or the negative return
  * value of the \p line_handler on errors.
  *
- * \sa for_each_line_ro()
+ * \sa for_each_line_ro().
  */
 int for_each_line(char *buf, size_t size, line_handler_t *line_handler,
                void *private_data)
@@ -475,21 +455,19 @@ int for_each_line(char *buf, size_t size, line_handler_t *line_handler,
 }
 
 /**
- * call a custom function for each complete line
- *
- * \param buf same meaning as in \p for_each_line
- * \param size same meaning as in \p for_each_line
- * \param line_handler same meaning as in \p for_each_line
- * \param private_data same meaning as in \p for_each_line
+ * Call a custom function for each complete line.
  *
- * This function behaves like \p for_each_line() with the following differences:
+ * \param buf Same meaning as in \p for_each_line().
+ * \param size Same meaning as in \p for_each_line().
+ * \param line_handler Same meaning as in \p for_each_line().
+ * \param private_data Same meaning as in \p for_each_line().
  *
- * - buf is left unchanged
+ * This function behaves like \p for_each_line(), but \a buf is left unchanged.
  *
  * \return On success, the function returns the number of complete lines in \p
  * buf, otherwise the (negative) return value of \p line_handler is returned.
  *
- * \sa for_each_line()
+ * \sa for_each_line().
  */
 int for_each_line_ro(char *buf, size_t size, line_handler_t *line_handler,
                void *private_data)
@@ -506,7 +484,15 @@ int for_each_line_ro(char *buf, size_t size, line_handler_t *line_handler,
  *
  * This function prints into the buffer given by \a b at the offset which is
  * also given by \a b. If there is not enough space to hold the result, the
- * buffer size is doubled until the underlying call to vsnprintf() succeeds.
+ * buffer size is doubled until the underlying call to vsnprintf() succeeds
+ * or the size of the buffer exceeds the maximal size specified in \a pb.
+ *
+ * In the latter case the unmodified \a buf and \a offset values as well as the
+ * private_data pointer of \a b are passed to the \a max_size_handler of \a b.
+ * If this function succeeds, i.e. returns a non-negative value, the offset of
+ * \a b is reset to zero and the given data is written to the beginning of the
+ * buffer.
+ *
  * Upon return, the offset of \a b is adjusted accordingly so that subsequent
  * calls to this function append data to what is already contained in the
  * buffer.
@@ -527,34 +513,45 @@ __printf_2_3 int para_printf(struct para_buffer *b, const char *fmt, ...)
                b->buf = para_malloc(128);
                b->size = 128;
                b->offset = 0;
-       } else if (b->size <= b->offset + 1) {
-               b->size *= 2;
-               b->buf = para_realloc(b->buf, b->size);
        }
        while (1) {
                char *p = b->buf + b->offset;
                size_t size = b->size - b->offset;
                va_list ap;
-               va_start(ap, fmt);
-               ret = vsnprintf(p, size, fmt, ap);
-               va_end(ap);
-               if (ret > -1 && ret < size) { /* success */
-                       b->offset += ret;
-                       break;
+               if (size) {
+                       va_start(ap, fmt);
+                       ret = vsnprintf(p, size, fmt, ap);
+                       va_end(ap);
+                       if (ret > -1 && ret < size) { /* success */
+                               b->offset += ret;
+                               return ret;
+                       }
+               }
+               /* check if we may grow the buffer */
+               if (!b->max_size || 2 * b->size < b->max_size) { /* yes */
+                       /* try again with more space */
+                       b->size *= 2;
+                       b->buf = para_realloc(b->buf, b->size);
+                       continue;
                }
-               /* try again with more space */
-               b->size *= 2;
-               b->buf = para_realloc(b->buf, b->size);
+               /* can't grow buffer */
+               if (!b->offset || !b->max_size_handler) /* message too large */
+                       return -ERRNO_TO_PARA_ERROR(ENOSPC);
+               ret = b->max_size_handler(b->buf, b->offset, b->private_data);
+               if (ret < 0)
+                       return ret;
+               b->offset = 0;
        }
-       return ret;
 }
 
+/** \cond LLONG_MAX and LLONG_LIN might not be defined. */
 #ifndef LLONG_MAX
 #define LLONG_MAX (1 << (sizeof(long) - 1))
 #endif
 #ifndef LLONG_MIN
 #define LLONG_MIN (-LLONG_MAX - 1LL)
 #endif
+/** \endcond */
 
 /**
  * Convert a string to a 64-bit signed integer value.
@@ -562,7 +559,7 @@ __printf_2_3 int para_printf(struct para_buffer *b, const char *fmt, ...)
  * \param str The string to be converted.
  * \param value Result pointer.
  *
- * \return Positive on success, negative on errors.
+ * \return Standard.
  *
  * \sa para_atoi32(), strtol(3), atoi(3).
  */
@@ -591,7 +588,7 @@ int para_atoi64(const char *str, int64_t *value)
  * \param str The string to be converted.
  * \param value Result pointer.
  *
- * \return Positive on success, negative on errors.
+ * \return Standard.
  *
  * \sa para_atoi64().
 */