Merge branch 't/gui_improvements'

[paraslash.git] / para.h

diff --git a/para.h b/para.h
index 5dc3912409b5dd64c71a0d68e2fcbbde2cfe466a..edab4871a03441dc1756054bfe0850b2a4e10c22 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 "
@@ -96,6 +109,7 @@ void ms2tv(const long unsigned n, struct timeval *tv);
 void compute_chunk_time(long unsigned chunk_num,
                struct timeval *chunk_tv, struct timeval *stream_start,
                struct timeval *result);
+struct timeval *clock_get_realtime(struct timeval *tv);
 
 /** The enum of all status items. */
 enum status_items {STATUS_ITEM_ENUM NUM_STAT_ITEMS};
@@ -105,48 +119,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. */
@@ -229,12 +224,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 */
+/** \cond sample_format */
 #define SAMPLE_FORMAT(a, b) a
 enum sample_format {SAMPLE_FORMATS};
 #undef SAMPLE_FORMAT
 #define SAMPLE_FORMAT(a, b) b
-/** \endcond */
+/** \endcond sample_format */
 
 /** Debug loglevel, gets really noisy. */
 #define LL_DEBUG 0
@@ -256,7 +251,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
@@ -298,4 +293,4 @@ enum sample_format {SAMPLE_FORMATS};
 #else
 #define PARA_EMERG_LOG(...)
 #endif
-/** \endcond */
+/** \endcond log */