command_util: Generate properly documented command header files.

[paraslash.git] / para.h

diff --git a/para.h b/para.h
index 4022bec7a90019084f7e326d99f236735788f9d3..66cf9e48d2fa7fb5e5df56ece15ef30df89427a2 100644 (file)
--- a/para.h
+++ b/para.h
@@ -50,61 +50,63 @@
        _x > 0? _x : -_x; })
 
 /** Debug loglevel, gets really noisy. */
-#define LL_DEBUG 1
+#define LL_DEBUG 0
 /** Still noisy, but won't fill your disk. */
-#define LL_INFO  2
+#define LL_INFO  1
 /** Normal, but significant event. */
-#define LL_NOTICE 3
+#define LL_NOTICE 2
 /** Unexpected event that can be handled. */
-#define LL_WARNING 4
+#define LL_WARNING 3
 /** Unhandled error condition. */
-#define LL_ERROR 5
+#define LL_ERROR 4
 /** System might be unreliable. */
-#define LL_CRIT 6
+#define LL_CRIT 5
 /** Last message before exit. */
-#define LL_EMERG 7
+#define LL_EMERG 6
+/** Number of all loglevels. */
+#define NUM_LOGLEVELS 7
 
 /** Log messages with lower priority than that will not be compiled in. */
 #define COMPILE_TIME_LOGLEVEL 0
 
 /** \cond */
-#if LL_DEBUG > COMPILE_TIME_LOGLEVEL
+#if LL_DEBUG >= COMPILE_TIME_LOGLEVEL
 #define PARA_DEBUG_LOG(f,...) para_log(LL_DEBUG, "%s: " f, __FUNCTION__, ## __VA_ARGS__)
 #else
 #define PARA_DEBUG_LOG(...) do {;} while (0)
 #endif
 
-#if LL_INFO > COMPILE_TIME_LOGLEVEL
+#if LL_INFO >= COMPILE_TIME_LOGLEVEL
 #define PARA_INFO_LOG(f,...) para_log(LL_INFO, "%s: " f, __FUNCTION__, ## __VA_ARGS__)
 #else
 #define PARA_INFO_LOG(...) do {;} while (0)
 #endif
 
-#if LL_NOTICE > COMPILE_TIME_LOGLEVEL
+#if LL_NOTICE >= COMPILE_TIME_LOGLEVEL
 #define PARA_NOTICE_LOG(f,...) para_log(LL_NOTICE, "%s: " f, __FUNCTION__, ## __VA_ARGS__)
 #else
 #define PARA_NOTICE_LOG(...) do {;} while (0)
 #endif
 
-#if LL_WARNING > COMPILE_TIME_LOGLEVEL
+#if LL_WARNING >= COMPILE_TIME_LOGLEVEL
 #define PARA_WARNING_LOG(f,...) para_log(LL_WARNING, "%s: " f, __FUNCTION__, ##  __VA_ARGS__)
 #else
 #define PARA_WARNING_LOG(...) do {;} while (0)
 #endif
 
-#if LL_ERROR > COMPILE_TIME_LOGLEVEL
+#if LL_ERROR >= COMPILE_TIME_LOGLEVEL
 #define PARA_ERROR_LOG(f,...) para_log(LL_ERROR, "%s: " f, __FUNCTION__, ## __VA_ARGS__)
 #else
 #define PARA_ERROR_LOG(...) do {;} while (0)
 #endif
 
-#if LL_CRIT > COMPILE_TIME_LOGLEVEL
+#if LL_CRIT >= COMPILE_TIME_LOGLEVEL
 #define PARA_CRIT_LOG(f,...) para_log(LL_CRIT, "%s: " f, __FUNCTION__, ## __VA_ARGS__)
 #else
 #define PARA_CRIT_LOG(...) do {;} while (0)
 #endif
 
-#if LL_EMERG > COMPILE_TIME_LOGLEVEL
+#if LL_EMERG >= COMPILE_TIME_LOGLEVEL
 #define PARA_EMERG_LOG(f,...) para_log(LL_EMERG, "%s: " f, __FUNCTION__, ## __VA_ARGS__)
 #else
 #define PARA_EMERG_LOG(...)
@@ -143,16 +145,17 @@
                printf("%s", VERSION_TEXT(_prefix)); \
                exit(EXIT_SUCCESS); \
        }
+
+/* Sent by para_client to initiate the authentication procedure. */
+#define AUTH_REQUEST_MSG "auth rsa "
 /** sent by para_server for commands that expect a data file */
 #define AWAITING_DATA_MSG "\nAwaiting Data."
 /** sent by para_server if authentication was successful */
-#define PROCEED_MSG "\nProceed.\n"
+#define PROCEED_MSG "Proceed."
 /** length of the \p PROCEED_MSG string */
 #define PROCEED_MSG_LEN strlen(PROCEED_MSG)
 /** sent by para_client to indicate the end of the command line */
 #define EOC_MSG "\nEnd of Command."
-/** sent by para_client, followed by the decrypted challenge number */
-#define CHALLENGE_RESPONSE_MSG "challenge_response:"
 
 /* exec */
 int para_exec_cmdline_pid(pid_t *pid, const char *cmdline, int *fds);
@@ -179,9 +182,11 @@ 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);
+void stat_client_write_item(int item_num);
+int stat_client_add(int fd, uint64_t mask, int parser_friendly);
+int for_each_stat_item(char *item_buf, size_t num_bytes,
+       int (*item_handler)(int, char *));
+void clear_and_dump_items(void);
 
 __printf_2_3 void para_log(int, const char*, ...);
 
@@ -222,13 +227,14 @@ __printf_2_3 void para_log(int, const char*, ...);
  *
  * \return An integer between zero and \p max - 1, inclusively.
  */
-static inline long int para_random(unsigned max)
+_static_inline_ long int para_random(unsigned max)
 {
        return ((max + 0.0) * (random() / (RAND_MAX + 1.0)));
 }
 
 /** Round up x to a multiple of y */
-#define ROUND_UP(x, y) (((x) + ((y) - 1) / (y)) * (y))
+#define ROUND_UP(x, y) ((((x) + ((y) - 1)) / (y)) * (y))
+
 
 /** Get the size of an array */
 #define ARRAY_SIZE(x) (sizeof(x) / sizeof((x)[0]))
@@ -247,3 +253,8 @@ static inline long int para_random(unsigned max)
  * horribly for characters which have their most significant bit set.
  */
 #define para_isspace(c) isspace((int)(unsigned char)(c))
+
+/** 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"
+#define FEC_EOF_PACKET_LEN 32