para.h: Add documentation of PARA_MAX, PARA_MIN, PARA_ABS
[paraslash.git] / para.h
1 /*
2 * Copyright (C) 1997-2007 Andre Noll <maan@systemlinux.org>
3 *
4 * This program is free software; you can redistribute it and/or modify
5 * it under the terms of the GNU General Public License as published by
6 * the Free Software Foundation; either version 2 of the License, or
7 * (at your option) any later version.
8 *
9 * This program is distributed in the hope that it will be useful,
10 * but WITHOUT ANY WARRANTY; without even the implied warranty of
11 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
12 * GNU General Public License for more details.
13 *
14 * You should have received a copy of the GNU General Public License
15 * along with this program; if not, write to the Free Software
16 * Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111, USA.
17 */
18
19 /** \file para.h global paraslash definitions */
20
21 #include "config.h"
22
23 #include <sys/stat.h>
24 #include <fcntl.h>
25 #include <sys/wait.h>
26 #include <stdio.h>
27 #include <stdlib.h>
28 #include <time.h> /* time(), localtime() */
29 #include <unistd.h>
30 #include <errno.h>
31 #include <limits.h>
32 #include <stdarg.h>
33 #include <ctype.h>
34 #include <netinet/in.h>
35 #include <arpa/inet.h>
36 #include <sys/socket.h>
37 #include <sys/un.h> /* needed by create_pf_socket */
38 #include <string.h>
39 #include "gcc-compat.h"
40
41 /** used in various contexts */
42 #define MAXLINE 255
43
44 /** compute the minimum of \a a and \a b */
45 #define PARA_MIN(a,b) ((a) < (b) ? (a) : (b))
46 /** compute the maximum of \a a and \a b */
47 #define PARA_MAX(a,b) ((a) > (b) ? (a) : (b))
48 /** compute the absolute value of \a a */
49 #define PARA_ABS(a) ((a) > 0 ? (a) : -(a))
50
51 /* Loglevels */
52 #define DEBUG 1
53 #define INFO 2
54 #define NOTICE 3
55 #define WARNING 4
56 #define ERROR 5
57 #define CRIT 6
58 #define EMERG 7
59
60 #define COMPILE_TIME_LOGLEVEL 0
61
62 #if DEBUG > COMPILE_TIME_LOGLEVEL
63 #define PARA_DEBUG_LOG(f,...) para_log(DEBUG, "%s: " f, __FUNCTION__, __VA_ARGS__)
64 #else
65 #define PARA_DEBUG_LOG(...) do {;} while (0)
66 #endif
67
68 #if INFO > COMPILE_TIME_LOGLEVEL
69 #define PARA_INFO_LOG(f,...) para_log(INFO, "%s: " f, __FUNCTION__, __VA_ARGS__)
70 #else
71 #define PARA_INFO_LOG(...) do {;} while (0)
72 #endif
73
74 #if NOTICE > COMPILE_TIME_LOGLEVEL
75 #define PARA_NOTICE_LOG(f,...) para_log(NOTICE, "%s: " f, __FUNCTION__, __VA_ARGS__)
76 #else
77 #define PARA_NOTICE_LOG(...) do {;} while (0)
78 #endif
79
80 #if WARNING > COMPILE_TIME_LOGLEVEL
81 #define PARA_WARNING_LOG(f,...) para_log(WARNING, "%s: " f, __FUNCTION__, __VA_ARGS__)
82 #else
83 #define PARA_WARNING_LOG(...) do {;} while (0)
84 #endif
85
86 #if ERROR > COMPILE_TIME_LOGLEVEL
87 #define PARA_ERROR_LOG(f,...) para_log(ERROR, "%s: " f, __FUNCTION__, __VA_ARGS__)
88 #else
89 #define PARA_ERROR_LOG(...) do {;} while (0)
90 #endif
91
92 #if CRIT > COMPILE_TIME_LOGLEVEL
93 #define PARA_CRIT_LOG(f,...) para_log(CRIT, "%s: " f, __FUNCTION__, __VA_ARGS__)
94 #else
95 #define PARA_CRIT_LOG(...) do {;} while (0)
96 #endif
97
98 #if EMERG > COMPILE_TIME_LOGLEVEL
99 #define PARA_EMERG_LOG(f,...) para_log(EMERG, "%s: " f, __FUNCTION__, __VA_ARGS__)
100 #else
101 #define PARA_EMERG_LOG(...)
102 #endif
103
104 /**
105 * define a standard log function that always writes to stderr
106 *
107 * \param loglevel_barier If the loglevel of the current message
108 * is less than that, the message is going to be ignored.
109 *
110 */
111 #define INIT_STDERR_LOGGING(loglevel_barrier) \
112 __printf_2_3 void para_log(int ll, const char* fmt,...) \
113 { \
114 va_list argp; \
115 if (ll < loglevel_barrier) \
116 return; \
117 va_start(argp, fmt); \
118 vfprintf(stderr, fmt, argp); \
119 va_end(argp); \
120 }
121
122
123 #define VERSION_TEXT(prefix) "para_" prefix " " PACKAGE_VERSION "\n" \
124 "Copyright (C) 2007 Andre Noll\n" \
125 "This is free software with ABSOLUTELY NO WARRANTY." \
126 " See COPYING for details.\n" \
127 "Written by Andre Noll.\n" \
128 "Report bugs to <maan@systemlinux.org>.\n"
129
130 #define HANDLE_VERSION_FLAG(_prefix, _args_info_struct) \
131 if (_args_info_struct.version_given) { \
132 printf("%s", VERSION_TEXT(_prefix)); \
133 exit(EXIT_SUCCESS); \
134 }
135
136 #define AWAITING_DATA_MSG "\nAwaiting Data."
137 #define PROCEED_MSG "\nProceed.\n"
138 #define PROCEED_MSG_LEN strlen(PROCEED_MSG)
139 #define EOC_MSG "\nEnd of Command."
140 #define CHALLENGE_RESPONSE_MSG "challenge_response:"
141
142 /* gui_common */
143 int para_open_audiod_pipe(char *);
144 int read_audiod_pipe(int, void (*)(char *));
145
146 /* exec */
147 int para_exec_cmdline_pid(pid_t *pid, const char *cmdline, int *fds);
148
149 /* time */
150 int tv_diff(const struct timeval *b, const struct timeval *a, struct timeval *diff);
151 long unsigned tv2ms(const struct timeval*);
152 void d2tv(double, struct timeval*);
153 void tv_add(const struct timeval*, const struct timeval *, struct timeval *);
154 void tv_scale(const unsigned long, const struct timeval *, struct timeval *);
155 void tv_divide(const unsigned long divisor, const struct timeval *tv,
156 struct timeval *result);
157 int tv_convex_combination(const long a, const struct timeval *tv1,
158 const long b, const struct timeval *tv2,
159 struct timeval *result);
160 void ms2tv(const long unsigned n, struct timeval *tv);
161
162 /* stat */
163 enum {
164 SI_STATUS_BAR, SI_STATUS, SI_NUM_PLAYED,
165 SI_MTIME, SI_LENGTH_MIN, SI_LENGTH_SEC,
166 SI_FILE_SIZE, SI_STATUS_FLAGS, SI_FORMAT,
167 SI_SCORE, SI_AUDIO_INFO1, SI_AUDIO_INFO2,
168 SI_AUDIO_INFO3, SI_DBINFO1, SI_DBINFO2,
169 SI_DBINFO3, SI_DECODER_FLAGS, SI_AUDIOD_STATUS,
170 SI_PLAY_TIME, SI_UPTIME, SI_OFFSET,
171 SI_LENGTH, SI_STREAM_START, SI_CURRENT_TIME,
172 SI_AUDIOD_UPTIME, SI_SELECTOR, NUM_STAT_ITEMS
173 };
174
175 int stat_item_valid(const char *item);
176 int stat_line_valid(const char *);
177 void stat_client_write(char *msg, int itemnum);
178 int stat_client_add(int fd, long unsigned mask);
179 unsigned for_each_line(char *, int, void (*)(char *));
180 #define FOR_EACH_STAT_ITEM(i) for (i = 0; i < NUM_STAT_ITEMS; i++)
181
182 struct stat_item_data {
183 const char *prefix, *postfix;
184 unsigned x, y, len;
185 int fg, bg, align;
186 };
187
188 /* gui_theme */
189 struct gui_theme {
190 const char *name;
191 const char *author;
192 int sb_fg, sb_bg;
193 int cmd_fg, cmd_bg;
194 int output_fg, output_bg;
195 int msg_fg, msg_bg;
196 int err_msg_fg, err_msg_bg;
197 int welcome_fg, welcome_bg;
198 int sep_fg, sep_bg;
199 const char *sep_str;
200 int default_fg, default_bg;
201
202 int top_lines_default, top_lines_min;
203 int lines_min, cols_min;
204 struct stat_item_data data[NUM_STAT_ITEMS];
205 };
206
207 void init_theme(int i, struct gui_theme *);
208 void next_theme(struct gui_theme *);
209 void prev_theme(struct gui_theme *);
210 #define LEFT 1
211 #define RIGHT 2
212 #define CENTER 3
213
214
215 __printf_2_3 void para_log(int, const char*, ...);
216
217 /* taken from printf man page */
218 #define PARA_VSPRINTF(fmt, p) \
219 { \
220 int n, size = 100; \
221 p = para_malloc(size); \
222 while (1) { \
223 va_list ap; \
224 /* Try to print in the allocated space. */ \
225 va_start(ap, fmt); \
226 n = vsnprintf(p, size, fmt, ap); \
227 va_end(ap); \
228 /* If that worked, return the string. */ \
229 if (n > -1 && n < size) \
230 break; \
231 /* Else try again with more space. */ \
232 if (n > -1) /* glibc 2.1 */ \
233 size = n + 1; /* precisely what is needed */ \
234 else /* glibc 2.0 */ \
235 size *= 2; /* twice the old size */ \
236 p = para_realloc(p, size); \
237 } \
238 }