Add new ls option: -lc to print out the chunk table.
[paraslash.git] / string.c
index f1f016f..bd53e8d 100644 (file)
--- a/string.c
+++ b/string.c
@@ -4,7 +4,7 @@
  * 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)
 {
@@ -71,14 +71,14 @@ __must_check __malloc void *para_malloc(size_t size)
 }
 
 /**
- * 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)
  */
@@ -91,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.
@@ -109,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.
@@ -124,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, ...)
 {
@@ -135,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)
  */
@@ -169,8 +169,8 @@ __must_check __malloc char *para_strcat(char *a, const char *b)
  *
  * Compute the directory 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 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)
@@ -195,7 +195,7 @@ __must_check __malloc char *para_dirname(const char *name)
  *
  * Compute the filename component of \a name.
  *
- * \return \p NULL if (a) \a name is the empty string of \p NULL, or (b) name
+ * \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.
  */
@@ -213,9 +213,9 @@ __must_check const char *para_basename(const char *name)
 }
 
 /**
- * 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.
@@ -230,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)
 {
@@ -251,40 +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, a negative value is returned.
- */
-__must_check int para_mkstemp(char *template, mode_t mode)
-{
-       int tmp, fd = mkstemp(template);
-
-       if (fd < 0)
-               return -ERRNO_TO_PARA_ERROR(errno);
-       tmp = fchmod(fd, mode);
-       if (tmp >= 0)
-               return fd;
-       tmp = errno;
-       close(fd);
-       unlink(template);
-       return -ERRNO_TO_PARA_ERROR(tmp);
-}
-
-/**
- * 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)
 {
@@ -572,7 +542,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).
  */
@@ -601,7 +571,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().
 */