X-Git-Url: http://git.tuebingen.mpg.de/?p=paraslash.git;a=blobdiff_plain;f=para.h;h=403ca7d43e91882df6bce3e8e00de71408bfbb5f;hp=e645cb1cd8259e6bf59a48ef8531abe8797d5d2e;hb=5b8e525dfb2f18a4e0d67b9da264259159ad2184;hpb=c141cc6915a32fb92766dc27f0df222d13f27d8b diff --git a/para.h b/para.h index e645cb1c..403ca7d4 100644 --- a/para.h +++ b/para.h @@ -1,19 +1,7 @@ /* - * Copyright (C) 1997-2006 Andre Noll + * Copyright (C) 1997-2008 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 */ @@ -23,115 +11,139 @@ #include #include #include -#include -#include #include #include -#include #include /* time(), localtime() */ #include #include #include #include -#include -#include -#include +#include #include #include -#include -#include -#include +#include #include /* needed by create_pf_socket */ +#include +#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)) -#define MIN(a,b) ((a) < (b) ? (a) : (b)) -#define MAX(a,b) ((a) > (b) ? (a) : (b)) -#define 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 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__) +#define PARA_DEBUG_LOG(f,...) para_log(DEBUG, "%s: " f, __FUNCTION__, ## __VA_ARGS__) #else -#define PARA_DEBUG_LOG(...) +#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(...) +#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(...) +#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(...) +#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(...) +#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(...) +#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 +/** \endcond */ -#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_barrier 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 " (" CODENAME ")" "\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 */ -int para_open_audiod_pipe(char *); -int read_audiod_pipe(int, void (*)(char *)); - /* exec */ -int file_exists(const char *); -int para_exec(pid_t *, const char *, char *const [], int *); -int para_exec_cmdline_pid(pid_t *, char *, int *); - -/* signal */ -int para_signal_init(void); -int para_install_sighandler(int); -void para_reap_children(void); -pid_t para_reap_child(void); -int para_next_signal(void); +int para_exec_cmdline_pid(pid_t *pid, const char *cmdline, int *fds); /* time */ int tv_diff(const struct timeval *b, const struct timeval *a, struct timeval *diff); @@ -139,71 +151,36 @@ long unsigned tv2ms(const struct timeval*); void d2tv(double, struct timeval*); void tv_add(const struct timeval*, const struct timeval *, struct timeval *); void tv_scale(const unsigned long, const struct timeval *, struct timeval *); -void tv_divide(const unsigned long div, const struct timeval *tv, +void tv_divide(const unsigned long divisor, const struct timeval *tv, struct timeval *result); int tv_convex_combination(const long a, const struct timeval *tv1, const long b, const struct timeval *tv2, 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_DBTOOL, -}; -#define NUM_STAT_ITEMS (SI_DBTOOL + 1) +/** The enum of all status items. */ +enum status_items {STATUS_ITEM_ENUM NUM_STAT_ITEMS}; +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(char *msg); -int stat_client_add(int); -void dump_empty_status(void); -unsigned for_each_line(char *, int, void (*)(char *), int); - -struct stat_item_data { - char *prefix, *postfix; - unsigned x, y, len; - int fg, bg, align; -}; - -/* gui_theme */ -struct gui_theme { - char *name; - 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; - 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, char*, ...); - -/* taken from printf man page */ +void stat_client_write(const char *msg, int itemnum); +int stat_client_add(int fd, long unsigned mask); + +__printf_2_3 void para_log(int, const char*, ...); + +/** + * 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, size = 100; \ + int n; \ + size_t size = 100; \ p = para_malloc(size); \ while (1) { \ va_list ap; \ @@ -223,11 +200,35 @@ __printf_2_3 void para_log(int, char*, ...); } \ } +/** + * 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) * (random() / (RAND_MAX + 1.0))); +} +/** Round up x to a multiple of y */ +#define ROUND_UP(x, y) (((x) + ((y) - 1) / (y)) * (y)) -enum supported_dbtools {DBT_DOPEY, -#ifdef HAVE_MYSQL - DBT_MYSQL, -#endif - NUM_DBTOOLS -}; +/** Get the size of an array */ +#define ARRAY_SIZE(x) (sizeof(x) / sizeof((x)[0])) + +/** + * Wrapper for isspace. + * NetBSD needs this. + */ +/* + * The values should be cast to an unsigned char first, then to int. + * Why? Because the isdigit (as do all other is/to functions/macros) + * expect a number from 0 upto and including 255 as their (int) argument. + * Because char is signed on most systems, casting it to int immediately + * gives the functions an argument between -128 and 127 (inclusive), + * which they will use as an array index, and which will thus fail + * horribly for characters which have their most significant bit set. + */ +#define para_isspace(c) isspace((int)(unsigned char)(c))