string: Clean up for_each_line() and related functions.

[paraslash.git] / para.h

diff --git a/para.h b/para.h
index 3121850f87ae27581d45da79e0f3ae9d57eced78..4208ae6a9083a0e2e3a956c163808db1b72a761f 100644 (file)
--- a/para.h
+++ b/para.h
@@ -1,5 +1,5 @@
 /*
- * Copyright (C) 1997-2011 Andre Noll <maan@systemlinux.org>
+ * Copyright (C) 1997-2013 Andre Noll <maan@systemlinux.org>
  *
  * Licensed under the GPL v2. For licencing details see COPYING.
  */
@@ -25,6 +25,7 @@
 #include <sys/un.h> /* needed by create_pf_socket */
 #include <string.h>
 #include <assert.h>
+#include <stdbool.h>
 #include "gcc-compat.h"
 
 /** used in various contexts */
@@ -49,15 +50,19 @@
        typeof(x) _x = (x); \
        _x > 0? _x : -_x; })
 
+
+extern __printf_2_3 void (*para_log)(int, const char*, ...);
 /**
  * Define a standard log function that always writes to stderr.
  *
+ * \param funcname The name of the function to be defined.
+ *
  * \param loglevel_barrier If the loglevel of the current message
  * is less than that, the message is going to be ignored.
  *
  */
-#define INIT_STDERR_LOGGING(loglevel_barrier) \
-       __printf_2_3 void para_log(int ll, const char* fmt,...) \
+#define DEFINE_STDERR_LOGGER(funcname, loglevel_barrier) \
+       __printf_2_3 void funcname(int ll, const char* fmt,...) \
        { \
                va_list argp; \
                if (ll < loglevel_barrier) \
@@ -66,6 +71,14 @@
                vfprintf(stderr, fmt, argp); \
                va_end(argp); \
        }
+/**
+ * Define the standard log function and activate it.
+ *
+ * \param loglevel_barrier See \ref DEFINE_STDERR_LOGGER.
+ */
+#define INIT_STDERR_LOGGING(loglevel_barrier) \
+       DEFINE_STDERR_LOGGER(stderr_log, loglevel_barrier); \
+       __printf_2_3 void (*para_log)(int, const char*, ...) = stderr_log;
 
 /** Sent by para_client to initiate the authentication procedure. */
 #define AUTH_REQUEST_MSG "auth rsa "
@@ -105,48 +118,29 @@ extern const char *status_item_list[];
 int for_each_stat_item(char *item_buf, size_t num_bytes,
        int (*item_handler)(int, char *));
 
-__printf_2_3 void para_log(int, const char*, ...);
 
 /**
- * Write a log message to a dynamically allocated string.
+ * Return a random non-negative integer in an interval.
  *
- * \param fmt Usual format string.
- * \param p Result pointer.
+ * \param max Determines maximal possible return value.
  *
- * \sa printf(3). */
-#define PARA_VSPRINTF(fmt, p) \
-{ \
-       int n; \
-       size_t size = 100; \
-       p = para_malloc(size); \
-       while (1) { \
-               va_list ap; \
-               /* Try to print in the allocated space. */ \
-               va_start(ap, fmt); \
-               n = vsnprintf(p, size, fmt, ap); \
-               va_end(ap); \
-               /* If that worked, return the string. */ \
-               if (n > -1 && n < size) \
-                       break; \
-               /* Else try again with more space. */ \
-               if (n > -1) /* glibc 2.1 */ \
-                       size = n + 1; /* precisely what is needed */ \
-               else /* glibc 2.0 */ \
-                       size *= 2; /* twice the old size */ \
-               p = para_realloc(p, size); \
-       } \
+ * \return An integer between zero and \p max - 1, inclusively.
+ */
+_static_inline_ long int para_random(unsigned max)
+{
+       return ((max + 0.0) * (random() / (RAND_MAX + 1.0)));
 }
 
 /**
- *  Return a random non-negative integer in an interval.
+ * Simple sanity check for I/O vectors.
  *
- * \param max Determines maximal possible return value.
+ * \param iov Pointer to the I/O vector to check.
  *
- * \return An integer between zero and \p max - 1, inclusively.
+ * \return True if \a iov points to a non-empty buffer.
  */
-_static_inline_ long int para_random(unsigned max)
+_static_inline_ bool iov_valid(const struct iovec *iov)
 {
-       return ((max + 0.0) * (random() / (RAND_MAX + 1.0)));
+       return iov && iov->iov_len > 0 && iov->iov_base;
 }
 
 /** Round up x to next multiple of y. */
@@ -176,7 +170,7 @@ _static_inline_ long int para_random(unsigned max)
  */
 #define EXPR_BUILD_ASSERT(cond) (sizeof(char [1 - 2 * !(cond)]) - 1)
 
-/* &a[0] degrades to a pointer: a different type from an array */
+/** &a[0] degrades to a pointer: a different type from an array */
 #define _array_size_chk(arr) EXPR_BUILD_ASSERT(\
        !__builtin_types_compatible_p(typeof(arr), typeof(&(arr)[0])))
 /** Get the size of an array */
@@ -200,11 +194,15 @@ _static_inline_ long int para_random(unsigned max)
 /** Data that indicates an eof-condition for a fec-encoded stream. */
 #define FEC_EOF_PACKET "\xec\x0d\xcc\xfe\0\0\0\0" \
        "\0\0\0\0\0\0\0\0" "\0\0\0\0\0\0\0\0" "\0\0\0\0\0\0\0\0"
+/** The number of bytes of the \a FEC_EOF_PACKET. */
 #define FEC_EOF_PACKET_LEN 32
 
 /** Used to avoid a shortcoming in vim's syntax highlighting. */
 #define EMBRACE(...) { __VA_ARGS__}
 
+/** A nice cup of STFU for Mr gcc. */
+#define do_nothing do {/* nothing */} while (0)
+
 /**
  * The sample formats supported by paraslash.
  *
@@ -225,10 +223,12 @@ _static_inline_ long int para_random(unsigned max)
        SAMPLE_FORMAT(SF_U16_LE, "16 bit unsigned, little endian"), \
        SAMPLE_FORMAT(SF_U16_BE, "16 bit unsigned, big endian"), \
 
+/** \cond sample_format */
 #define SAMPLE_FORMAT(a, b) a
 enum sample_format {SAMPLE_FORMATS};
 #undef SAMPLE_FORMAT
 #define SAMPLE_FORMAT(a, b) b
+/** \endcond sample_format */
 
 /** Debug loglevel, gets really noisy. */
 #define LL_DEBUG 0
@@ -250,7 +250,7 @@ enum sample_format {SAMPLE_FORMATS};
 /** Log messages with lower priority than that will not be compiled in. */
 #define COMPILE_TIME_LOGLEVEL 0
 
-/** \cond */
+/** \cond log */
 #if LL_DEBUG >= COMPILE_TIME_LOGLEVEL
 #define PARA_DEBUG_LOG(f,...) para_log(LL_DEBUG, "%s: " f, __FUNCTION__, ## __VA_ARGS__)
 #else
@@ -292,4 +292,4 @@ enum sample_format {SAMPLE_FORMATS};
 #else
 #define PARA_EMERG_LOG(...)
 #endif
-/** \endcond */
+/** \endcond log */