Minor documentation improvements.

[paraslash.git] / para.h

diff --git a/para.h b/para.h
index 5dec070f00458bd59d62fbb8fed1b3bc60cb31da..0cb1538d2725fd79c7de01871bcb617bcd73c706 100644 (file)
--- a/para.h
+++ b/para.h
@@ -52,9 +52,10 @@
 /** last message before exit */
 #define EMERG 7
 
-/** log messages with lower proirity than that will not be compiled in*/
+/** Log messages with lower priority than that will not be compiled in. */
 #define COMPILE_TIME_LOGLEVEL 0
 
+/** \cond */
 #if DEBUG > COMPILE_TIME_LOGLEVEL
 #define PARA_DEBUG_LOG(f,...) para_log(DEBUG, "%s: " f, __FUNCTION__, ## __VA_ARGS__)
 #else
@@ -96,6 +97,7 @@
 #else
 #define PARA_EMERG_LOG(...)
 #endif
+/** \endcond */
 
 /**
  * define a standard log function that always writes to stderr
@@ -156,28 +158,25 @@ int tv_convex_combination(const long a, const struct timeval *tv1,
                struct timeval *result);
 void ms2tv(const long unsigned n, struct timeval *tv);
 
-/* stat */
-enum {
-       SI_STATUS_BAR,          SI_STATUS,              SI_NUM_PLAYED,
-       SI_MTIME,               SI_LENGTH_MIN,          SI_LENGTH_SEC,
-       SI_FILE_SIZE,           SI_STATUS_FLAGS,        SI_FORMAT,
-       SI_SCORE,               SI_AUDIO_INFO1,         SI_AUDIO_INFO2,
-       SI_AUDIO_INFO3,         SI_DBINFO1,             SI_DBINFO2,
-       SI_DBINFO3,             SI_DECODER_FLAGS,       SI_AUDIOD_STATUS,
-       SI_PLAY_TIME,           SI_UPTIME,              SI_OFFSET,
-       SI_LENGTH,              SI_STREAM_START,        SI_CURRENT_TIME,
-       SI_AUDIOD_UPTIME,       SI_SELECTOR,            NUM_STAT_ITEMS
-};
-
+/** The enum of all status items. */
+enum status_items {STATUS_ITEM_ENUM NUM_STAT_ITEMS};
+extern const char *status_item_list[];
+/** Loop over each status item. */
+#define FOR_EACH_STATUS_ITEM(i) for (i = 0; i < NUM_STAT_ITEMS; i++)
 int stat_item_valid(const char *item);
 int stat_line_valid(const char *);
 void stat_client_write(const char *msg, int itemnum);
 int stat_client_add(int fd, long unsigned mask);
-#define FOR_EACH_STAT_ITEM(i) for (i = 0; i < NUM_STAT_ITEMS; i++)
 
 __printf_2_3 void para_log(int, const char*, ...);
 
-/* taken from printf man page */
+/**
+ * Write a log message to a dynamically allocated string.
+ *
+ * \param fmt Usual format string.
+ * \param p Result pointer.
+ *
+ * \sa printf(3). */
 #define PARA_VSPRINTF(fmt, p) \
 { \
        int n; \
@@ -201,9 +200,16 @@ __printf_2_3 void para_log(int, const char*, ...);
        } \
 }
 
-static inline int para_random(unsigned max)
+/**
+ *  Return a random non-negative integer in an interval.
+ *
+ * \param max Determines maximal possible return value.
+ *
+ * \return An integer between zero and \p max - 1, inclusively.
+ */
+static inline long int para_random(unsigned max)
 {
-       return ((max + 0.0) * (rand() / (RAND_MAX + 1.0)));
+       return ((max + 0.0) * (random() / (RAND_MAX + 1.0)));
 }
 
 /** Round up x to a multiple of y */
@@ -211,3 +217,18 @@ static inline int para_random(unsigned max)
 
 /** Get the size of an array */
 #define ARRAY_SIZE(x) (sizeof(x) / sizeof((x)[0]))
+
+/**
+ * Wrapper for isspace.
+ * NetBSD needs this.
+ */
+/*
+ * The values should be cast to an unsigned char first, then to int.
+ * Why? Because the isdigit (as do all other is/to functions/macros)
+ * expect a number from 0 upto and including 255 as their (int) argument.
+ * Because char is signed on most systems, casting it to int immediately
+ * gives the functions an argument between -128 and 127 (inclusive),
+ * which they will use as an array index, and which will thus fail
+ * horribly for characters which have their most significant bit set.
+ */
+#define para_isspace(c) isspace((int)(unsigned char)(c))