more doxygen docu, some small cleanups

[paraslash.git] / para.h

diff --git a/para.h b/para.h
index 47d54a1f805d917576351dd4af5a6e660e98693d..869749d15058ed2835c69e38588f8f619e067eee 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,26 +38,34 @@
 #include <string.h>
 #include "gcc-compat.h"
 
-/* some internal constants */
-#define STRINGSIZE 4096
+/** used in various contexts */
 #define MAXLINE 255
 
-
+/** 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 */
+/** debug loglevel, gets really noisy */
 #define DEBUG 1
+/** still noisy, but won't fill your disk */
 #define INFO  2
+/** normal, but significant event */
 #define NOTICE 3
+/** unexpected event that can be handled */
 #define WARNING 4
+/** unhandled error condition */
 #define ERROR 5
+/** system might be unreliable */
 #define CRIT 6
+/** last message before exit */
 #define EMERG 7
 
-
+/** log messages with lower proirity than that will not be compiled in*/
 #define COMPILE_TIME_LOGLEVEL 0
+
 #if DEBUG > COMPILE_TIME_LOGLEVEL
 #define PARA_DEBUG_LOG(f,...) para_log(DEBUG, "%s: " f, __FUNCTION__, __VA_ARGS__)
 #else
@@ -100,15 +108,47 @@
 #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); \
+       }
+
+/** version text used by various commands if -V switch was given */
+#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"
+
+/** print out \p VERSION_TEXT and exit if version flag was given */
+#define HANDLE_VERSION_FLAG(_prefix, _args_info_struct) \
+       if (_args_info_struct.version_given) { \
+               printf("%s", VERSION_TEXT(_prefix)); \
+               exit(EXIT_SUCCESS); \
+       }
+/** 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"
+/** 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:"
 
 /* gui_common */