web/license.html: make it clear that paraslash is licensed under the GPL V2
[paraslash.git] / para.h
diff --git a/para.h b/para.h
index e645cb1cd8259e6bf59a48ef8531abe8797d5d2e..7b0ca09c6c0b5f84c7ddab93eb92912e83245a44 100644 (file)
--- a/para.h
+++ b/para.h
@@ -1,19 +1,7 @@
 /*
- * 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
- *     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 */
 #include <sys/stat.h>
 #include <fcntl.h>
 #include <sys/wait.h>
-#include <signal.h>
-#include <sys/signal.h>
 #include <stdio.h>
 #include <stdlib.h>
-#include <string.h>
 #include <time.h> /* time(), localtime() */
 #include <unistd.h>
 #include <errno.h>
 #include <limits.h>
 #include <stdarg.h>
-#include <stropts.h>
-#include <poll.h>
-#include <sys/socket.h>
+#include <ctype.h>
 #include <netinet/in.h>
 #include <arpa/inet.h>
-#include <sys/ipc.h>
-#include <sys/sem.h>
-#include <ctype.h>
+#include <sys/socket.h>
 #include <sys/un.h> /* needed by create_pf_socket */
+#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))
 
-#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 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(...)
+#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
 
-#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 "\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 */
@@ -122,16 +144,7 @@ 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,7 +152,7 @@ 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,
@@ -156,54 +169,23 @@ enum {
        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)
-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];
+       SI_AUDIOD_UPTIME,       SI_SELECTOR,            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
-
+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);
+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++)
 
-__printf_2_3 void para_log(int, char*, ...);
+__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; \
@@ -222,12 +204,3 @@ __printf_2_3 void para_log(int, char*, ...);
                p = para_realloc(p, size); \
        } \
 }
-
-
-
-enum supported_dbtools {DBT_DOPEY,
-#ifdef HAVE_MYSQL
-       DBT_MYSQL,
-#endif
-       NUM_DBTOOLS
-};