para.h: Add documentation of PARA_MAX, PARA_MIN, PARA_ABS

[paraslash.git] / para.h

diff --git a/para.h b/para.h
index 1ac056b31bc38d455a41a08c7ef094ea3d7c8090..f22157d8ae6063969ffabfd29e3e0ecb21cf0af1 100644 (file)
--- a/para.h
+++ b/para.h
@@ -1,5 +1,5 @@
 /*
- * Copyright (C) 1997-2006 Andre Noll <maan@systemlinux.org>
+ * Copyright (C) 1997-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
@@ -38,14 +38,15 @@
 #include <string.h>
 #include "gcc-compat.h"
 
-/* some internal constants */
-#define STRINGSIZE 4096
+/** used in various contexts */
 #define MAXLINE 255
 
-
-#define MIN(a,b) ((a) < (b) ? (a) : (b))
-#define MAX(a,b) ((a) > (b) ? (a) : (b))
-#define ABS(a) ((a) > 0 ? (a) : -(a))
+/** compute the minimum of \a a and \a b */
+#define PARA_MIN(a,b) ((a) < (b) ? (a) : (b))
+/** compute the maximum of \a a and \a b */
+#define PARA_MAX(a,b) ((a) > (b) ? (a) : (b))
+/** compute the absolute value of \a a */
+#define PARA_ABS(a) ((a) > 0 ? (a) : -(a))
 
 /* Loglevels */
 #define DEBUG 1
@@ -56,42 +57,42 @@
 #define CRIT 6
 #define EMERG 7
 
-
 #define COMPILE_TIME_LOGLEVEL 0
+
 #if DEBUG > COMPILE_TIME_LOGLEVEL
 #define PARA_DEBUG_LOG(f,...) para_log(DEBUG, "%s: " f, __FUNCTION__, __VA_ARGS__)
 #else
-#define PARA_DEBUG_LOG(...)
+#define PARA_DEBUG_LOG(...) do {;} while (0)
 #endif
 
 #if INFO > COMPILE_TIME_LOGLEVEL
 #define PARA_INFO_LOG(f,...) para_log(INFO, "%s: " f, __FUNCTION__, __VA_ARGS__)
 #else
-#define PARA_INFO_LOG(...)
+#define PARA_INFO_LOG(...) do {;} while (0)
 #endif
 
 #if NOTICE > COMPILE_TIME_LOGLEVEL
 #define PARA_NOTICE_LOG(f,...) para_log(NOTICE, "%s: " f, __FUNCTION__, __VA_ARGS__)
 #else
-#define PARA_NOTICE_LOG(...)
+#define PARA_NOTICE_LOG(...) do {;} while (0)
 #endif
 
 #if WARNING > COMPILE_TIME_LOGLEVEL
 #define PARA_WARNING_LOG(f,...) para_log(WARNING, "%s: " f, __FUNCTION__, __VA_ARGS__)
 #else
-#define PARA_WARNING_LOG(...)
+#define PARA_WARNING_LOG(...) do {;} while (0)
 #endif
 
 #if ERROR > COMPILE_TIME_LOGLEVEL
 #define PARA_ERROR_LOG(f,...) para_log(ERROR, "%s: " f, __FUNCTION__, __VA_ARGS__)
 #else
-#define PARA_ERROR_LOG(...)
+#define PARA_ERROR_LOG(...) do {;} while (0)
 #endif
 
 #if CRIT > COMPILE_TIME_LOGLEVEL
 #define PARA_CRIT_LOG(f,...) para_log(CRIT, "%s: " f, __FUNCTION__, __VA_ARGS__)
 #else
-#define PARA_CRIT_LOG(...)
+#define PARA_CRIT_LOG(...) do {;} while (0)
 #endif
 
 #if EMERG > COMPILE_TIME_LOGLEVEL
@@ -100,10 +101,37 @@
 #define PARA_EMERG_LOG(...)
 #endif
 
-#define COPYRIGHT "Copyright (c) 1997-2006 by Andre Noll"
-
-#define LICENSE "This is free software with ABSOLUTELY NO WARRANTY. " \
-       "See COPYING for details."
+/**
+ * define a standard log function that always writes to stderr
+ *
+ * \param loglevel_barier 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,...) \
+       { \
+               va_list argp; \
+               if (ll < loglevel_barrier) \
+                       return; \
+               va_start(argp, fmt); \
+               vfprintf(stderr, fmt, argp); \
+               va_end(argp); \
+       }
+
+
+#define VERSION_TEXT(prefix) "para_" prefix " " PACKAGE_VERSION "\n" \
+       "Copyright (C) 2007 Andre Noll\n" \
+       "This is free software with ABSOLUTELY NO WARRANTY." \
+       " See COPYING for details.\n" \
+       "Written by Andre Noll.\n" \
+       "Report bugs to <maan@systemlinux.org>.\n"
+
+#define HANDLE_VERSION_FLAG(_prefix, _args_info_struct) \
+       if (_args_info_struct.version_given) { \
+               printf("%s", VERSION_TEXT(_prefix)); \
+               exit(EXIT_SUCCESS); \
+       }
 
 #define AWAITING_DATA_MSG "\nAwaiting Data."
 #define PROCEED_MSG "\nProceed.\n"
@@ -118,20 +146,13 @@ int read_audiod_pipe(int, void (*)(char *));
 /* exec */
 int para_exec_cmdline_pid(pid_t *pid, const char *cmdline, int *fds);
 
-/* signal */
-int para_signal_init(void);
-int para_install_sighandler(int);
-void para_reap_children(void);
-pid_t para_reap_child(void);
-int para_next_signal(void);
-
 /* time */
 int tv_diff(const struct timeval *b, const struct timeval *a, struct timeval *diff);
 long unsigned tv2ms(const struct timeval*);
 void d2tv(double, struct timeval*);
 void tv_add(const struct timeval*, const struct timeval *, struct timeval *);
 void tv_scale(const unsigned long, const struct timeval *, struct timeval *);
-void tv_divide(const unsigned long div, const struct timeval *tv,
+void tv_divide(const unsigned long divisor, const struct timeval *tv,
        struct timeval *result);
 int tv_convex_combination(const long a, const struct timeval *tv1,
                const long b, const struct timeval *tv2,
@@ -155,8 +176,8 @@ int stat_item_valid(const char *item);
 int stat_line_valid(const char *);
 void stat_client_write(char *msg, int itemnum);
 int stat_client_add(int fd, long unsigned mask);
-void dump_empty_status(void);
 unsigned for_each_line(char *, int, void (*)(char *));
+#define FOR_EACH_STAT_ITEM(i) for (i = 0; i < NUM_STAT_ITEMS; i++)
 
 struct stat_item_data {
        const char *prefix, *postfix;