X-Git-Url: http://git.tuebingen.mpg.de/?p=paraslash.git;a=blobdiff_plain;f=para.h;h=2c95f817b5bb8a43538ab93743fa92148c886ba6;hp=5dec070f00458bd59d62fbb8fed1b3bc60cb31da;hb=e0133f661a998cf76eafd8ed36769c5d840410f6;hpb=ae15406fdf6ac44dc7a15e62c2d0056abe7192ac

diff --git a/para.h b/para.h
index 5dec070f..2c95f817 100644
--- 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
-};
+enum status_items {STATUS_ITEM_ENUM NUM_STAT_ITEMS};
+extern const char *status_item_list[];
 
 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);
+/** Loop over each status item. */
 #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 */