X-Git-Url: http://git.tuebingen.mpg.de/?p=paraslash.git;a=blobdiff_plain;f=para.h;h=7b0ca09c6c0b5f84c7ddab93eb92912e83245a44;hp=fc0edf9a43df1e3840c5c55fe49740256f1a364c;hb=cbef31a5d0b06802f55f6de4867e27cc6f92fd79;hpb=b9f9601828dd1a103ec9315bd430d39b458d2b80 diff --git a/para.h b/para.h index fc0edf9a..7b0ca09c 100644 --- a/para.h +++ b/para.h @@ -1,19 +1,7 @@ /* * Copyright (C) 1997-2007 Andre Noll * - * 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 - * the Free Software Foundation; either version 2 of the License, or - * (at your option) any later version. - * - * This program is distributed in the hope that it will be useful, - * but WITHOUT ANY WARRANTY; without even the implied warranty of - * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the - * GNU General Public License for more details. - * - * You should have received a copy of the GNU General Public License - * along with this program; if not, write to the Free Software - * Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111, USA. + * Licensed under the GPL v2. For licencing details see COPYING. */ /** \file para.h global paraslash definitions */ @@ -38,64 +26,72 @@ #include #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__) +#define PARA_DEBUG_LOG(f,...) para_log(DEBUG, "%s: " f, __FUNCTION__, ## __VA_ARGS__) #else #define PARA_DEBUG_LOG(...) do {;} while (0) #endif #if INFO > COMPILE_TIME_LOGLEVEL -#define PARA_INFO_LOG(f,...) para_log(INFO, "%s: " f, __FUNCTION__, __VA_ARGS__) +#define PARA_INFO_LOG(f,...) para_log(INFO, "%s: " f, __FUNCTION__, ## __VA_ARGS__) #else #define PARA_INFO_LOG(...) do {;} while (0) #endif #if NOTICE > COMPILE_TIME_LOGLEVEL -#define PARA_NOTICE_LOG(f,...) para_log(NOTICE, "%s: " f, __FUNCTION__, __VA_ARGS__) +#define PARA_NOTICE_LOG(f,...) para_log(NOTICE, "%s: " f, __FUNCTION__, ## __VA_ARGS__) #else #define PARA_NOTICE_LOG(...) do {;} while (0) #endif #if WARNING > COMPILE_TIME_LOGLEVEL -#define PARA_WARNING_LOG(f,...) para_log(WARNING, "%s: " f, __FUNCTION__, __VA_ARGS__) +#define PARA_WARNING_LOG(f,...) para_log(WARNING, "%s: " f, __FUNCTION__, ## __VA_ARGS__) #else #define PARA_WARNING_LOG(...) do {;} while (0) #endif #if ERROR > COMPILE_TIME_LOGLEVEL -#define PARA_ERROR_LOG(f,...) para_log(ERROR, "%s: " f, __FUNCTION__, __VA_ARGS__) +#define PARA_ERROR_LOG(f,...) para_log(ERROR, "%s: " f, __FUNCTION__, ## __VA_ARGS__) #else #define PARA_ERROR_LOG(...) do {;} while (0) #endif #if CRIT > COMPILE_TIME_LOGLEVEL -#define PARA_CRIT_LOG(f,...) para_log(CRIT, "%s: " f, __FUNCTION__, __VA_ARGS__) +#define PARA_CRIT_LOG(f,...) para_log(CRIT, "%s: " f, __FUNCTION__, ## __VA_ARGS__) #else #define PARA_CRIT_LOG(...) do {;} while (0) #endif #if EMERG > COMPILE_TIME_LOGLEVEL -#define PARA_EMERG_LOG(f,...) para_log(EMERG, "%s: " f, __FUNCTION__, __VA_ARGS__) +#define PARA_EMERG_LOG(f,...) para_log(EMERG, "%s: " f, __FUNCTION__, ## __VA_ARGS__) #else #define PARA_EMERG_LOG(...) #endif @@ -103,7 +99,7 @@ /** * 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. * */ @@ -118,16 +114,29 @@ va_end(argp); \ } - -#define COPYRIGHT "Copyright (c) 1997-2006 by Andre Noll" - -#define LICENSE "This is free software with ABSOLUTELY NO WARRANTY. " \ - "See COPYING for details." - +/** 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 .\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 */ @@ -165,50 +174,18 @@ enum { int stat_item_valid(const char *item); int stat_line_valid(const char *); -void stat_client_write(char *msg, int itemnum); +void stat_client_write(const char *msg, int itemnum); int stat_client_add(int fd, long unsigned mask); -unsigned for_each_line(char *, int, void (*)(char *)); +size_t for_each_line(char *buf, size_t n, void (*line_handler)(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 */ #define PARA_VSPRINTF(fmt, p) \ { \ - int n, size = 100; \ + int n; \ + size_t size = 100; \ p = para_malloc(size); \ while (1) { \ va_list ap; \