Merge /fml/ag-raetsch/home/maan/scm/paraslash_meins/paraslash/
[paraslash.git] / para.h
diff --git a/para.h b/para.h
index 8e1c721..5e83921 100644 (file)
--- a/para.h
+++ b/para.h
 #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
 /**
  * define a standard log function that always writes to stderr
  *
- * \param loglevel_barier If the loglevel of the current message
+ * \param loglevel_barrier If the loglevel of the current message
  * is less than that, the message is going to be ignored.
  *
  */
                va_end(argp); \
        }
 
-
-#define COPYRIGHT "Copyright (c) 1997-2006 by Andre Noll"
-
-
+/** 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 */
@@ -168,39 +191,6 @@ int stat_client_add(int fd, long unsigned mask);
 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;
-       unsigned x, y, len;
-       int fg, bg, align;
-};
-
-/* gui_theme */
-struct gui_theme {
-       const char *name;
-       const char *author;
-       int sb_fg, sb_bg;
-       int cmd_fg, cmd_bg;
-       int output_fg, output_bg;
-       int msg_fg, msg_bg;
-       int err_msg_fg, err_msg_bg;
-       int welcome_fg, welcome_bg;
-       int sep_fg, sep_bg;
-       const char *sep_str;
-       int default_fg, default_bg;
-
-       int top_lines_default, top_lines_min;
-       int lines_min, cols_min;
-       struct stat_item_data data[NUM_STAT_ITEMS];
-};
-
-void init_theme(int i, struct gui_theme *);
-void next_theme(struct gui_theme *);
-void prev_theme(struct gui_theme *);
-#define LEFT 1
-#define RIGHT 2
-#define CENTER 3
-
-
 __printf_2_3 void para_log(int, const char*, ...);
 
 /* taken from printf man page */