Let's try __attribute__ this time for unused vars.
[monky] / src / conky.h
1 /* -*- mode: c; c-basic-offset: 4; tab-width: 4; indent-tabs-mode: t -*-
2  *
3  * Conky, a system monitor, based on torsmo
4  *
5  * Any original torsmo code is licensed under the BSD license
6  *
7  * All code written since the fork of torsmo is licensed under the GPL
8  *
9  * Please see COPYING for details
10  *
11  * Copyright (c) 2004, Hannu Saransaari and Lauri Hakkarainen
12  * Copyright (c) 2005-2009 Brenden Matthews, Philip Kovacs, et. al.
13  *      (see AUTHORS)
14  * All rights reserved.
15  *
16  * This program is free software: you can redistribute it and/or modify
17  * it under the terms of the GNU General Public License as published by
18  * the Free Software Foundation, either version 3 of the License, or
19  * (at your option) any later version.
20  *
21  * This program is distributed in the hope that it will be useful,
22  * but WITHOUT ANY WARRANTY; without even the implied warranty of
23  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
24  * GNU General Public License for more details.
25  * You should have received a copy of the GNU General Public License
26  * along with this program.  If not, see <http://www.gnu.org/licenses/>.
27  *
28  * vim: ts=4 sw=4 noet ai cindent syntax=c
29  *
30  */
31
32 #ifndef _conky_h_
33 #define _conky_h_
34
35 #include "config.h"     /* defines */
36 #include "common.h"     /* at least for struct dns_data */
37 #include <sys/utsname.h> /* struct uname_s */
38
39 #if defined(HAS_MCHECK_H)
40 #include <mcheck.h>
41 #endif /* HAS_MCHECK_H */
42
43 #undef EQUAL
44 #undef FALSE
45 #undef TRUE
46 #define EQUAL 0 //returnvalue of strcmp-variants when strings are equal
47 #define FALSE 0
48 #define TRUE 1
49
50 #define DEFAULT_BAR_WIDTH_NO_X 10
51
52 #if !defined(__GNUC__)
53 #  define __attribute__(x) /* nothing */
54 #endif
55
56 #ifndef HAVE_STRNDUP
57 // use our own strndup() if it's not available
58 char *strndup(const char *s, size_t n);
59 #endif /* HAVE_STRNDUP */
60
61 /* headers of optional features
62  * include them here, so we don't need to run the check
63  * in every code file optionally using the feature
64  */
65
66 #ifdef AUDACIOUS
67 #include "audacious.h"
68 #endif
69
70 #ifdef BMPX
71 #include "bmpx.h"
72 #endif
73
74 #ifdef EVE
75 #include "eve.h"
76 #endif
77
78 #ifdef HDDTEMP
79 #include "hddtemp.h"
80 #endif /* HDDTEMP */
81
82 #ifdef MOC
83 #include "moc.h"
84 #endif
85
86 #ifdef MPD
87 #include "mpd.h"
88 #endif
89
90 #ifdef NVIDIA
91 #include "nvidia.h"
92 #endif
93
94 #ifdef HAVE_CURL
95 #include "ccurl_thread.h"
96 #endif /* HAVE_CURL */
97
98 #ifdef RSS
99 #include "rss.h"
100 #endif /* RSS */
101
102 #ifdef XOAP
103 #ifndef WEATHER
104 #error "WEATHER needs to be defined if XOAP is defined"
105 #endif /* WEATHER */
106 #endif /* XOAP */
107
108 #ifdef WEATHER
109 #include "weather.h"
110 #endif /* WEATHER */
111
112 #ifdef TCP_PORT_MONITOR
113 #include "tcp-portmon.h"
114 #endif
115
116 #ifdef XMMS2
117 #include "xmms2.h"
118 #endif
119
120 #ifdef IBM
121 #include "ibm.h"
122 #include "smapi.h"
123 #endif
124
125 #ifdef APCUPSD
126 #include "apcupsd.h"
127 #endif
128
129 /* sony support */
130 #include "sony.h"
131
132 /* A size for temporary, static buffers to use when
133  * one doesn't know what to choose. Defaults to 256.  */
134 extern unsigned int text_buffer_size;
135
136 struct entropy_s {
137         unsigned int entropy_avail;
138         unsigned int poolsize;
139 };
140
141 struct usr_info {
142         char *names;
143         char *times;
144         char *terms;
145         int number;
146 };
147
148 struct gateway_info {
149         char *iface;
150         char *ip;
151         int count;
152 };
153
154 #ifdef X11
155 struct monitor_info {
156         int number;
157         int current;
158 };
159
160 struct desktop_info {
161         int current;
162         int number;
163         unsigned int nitems;
164         char *all_names;
165         char *name;
166 };
167
168 struct x11_info {
169         struct monitor_info monitor;
170         struct desktop_info desktop;
171 };
172 #endif
173
174 enum {
175         INFO_CPU = 0,
176         INFO_MAIL = 1,
177         INFO_MEM = 2,
178         INFO_NET = 3,
179         INFO_PROCS = 4,
180         INFO_RUN_PROCS = 5,
181         INFO_UPTIME = 6,
182         INFO_BUFFERS = 7,
183         INFO_FS = 8,
184         INFO_SYSFS = 9,
185         INFO_MIXER = 10,
186         INFO_LOADAVG = 11,
187         INFO_UNAME = 12,
188         INFO_FREQ = 13,
189 #ifdef MPD
190         INFO_MPD = 14,
191 #endif
192         INFO_TOP = 15,
193         INFO_WIFI = 16,
194         INFO_DISKIO = 17,
195         INFO_I8K = 18,
196 #ifdef TCP_PORT_MONITOR
197         INFO_TCP_PORT_MONITOR = 19,
198 #endif
199 #ifdef AUDACIOUS
200         INFO_AUDACIOUS = 20,
201 #endif
202 #ifdef BMPX
203         INFO_BMPX = 21,
204 #endif
205 #ifdef XMMS2
206         INFO_XMMS2 = 22,
207 #endif
208         INFO_ENTROPY = 23,
209 #ifdef IBM
210         INFO_SMAPI = 25,
211 #endif
212         INFO_USERS = 26,
213         INFO_GW = 27,
214 #ifdef NVIDIA
215         INFO_NVIDIA = 28,
216 #endif
217 #ifdef X11
218         INFO_X11 = 29,
219 #endif
220         INFO_DNS = 30,
221 #ifdef MOC
222         INFO_MOC = 31,
223 #endif
224 #ifdef APCUPSD
225         INFO_APCUPSD = 32,
226 #endif
227 #ifdef WEATHER
228         INFO_WEATHER = 33,
229 #endif
230 };
231
232 /* get_battery_stuff() item selector
233  * needed by conky.c, linux.c and freebsd.c */
234 enum {
235         BATTERY_STATUS,
236         BATTERY_TIME
237 };
238
239 /* if_up strictness selector
240  * needed by conky.c and linux.c (and potentially others) */
241 enum {
242         IFUP_UP,
243         IFUP_LINK,
244         IFUP_ADDR
245 } ifup_strictness;
246
247 struct information {
248         unsigned int mask;
249
250         struct utsname uname_s;
251
252         char freq[10];
253
254         double uptime;
255
256         /* memory information in kilobytes */
257         unsigned long long mem, memeasyfree, memfree, memmax, swap, swapfree, swapmax;
258         unsigned long long bufmem, buffers, cached;
259
260         unsigned short procs;
261         unsigned short run_procs;
262
263         float *cpu_usage;
264         /* struct cpu_stat cpu_summed; what the hell is this? */
265         unsigned int cpu_count;
266         int cpu_avg_samples;
267
268         int net_avg_samples;
269
270         int diskio_avg_samples;
271
272         float loadavg[3];
273
274         struct mail_s *mail;
275         int mail_running;
276 #ifdef XMMS2
277         struct xmms2_s xmms2;
278 #endif
279 #ifdef AUDACIOUS
280         AUDACIOUS_S audacious;
281 #endif
282 #ifdef BMPX
283         struct bmpx_s bmpx;
284 #endif
285         struct usr_info users;
286         struct gateway_info gw_info;
287         struct dns_data nameserver_info;
288         struct process *cpu[10];
289         struct process *memu[10];
290         struct process *time[10];
291 #ifdef IOSTATS
292         struct process *io[10];
293 #endif
294         struct process *first_process;
295         unsigned long looped;
296         struct entropy_s entropy;
297         double music_player_interval;
298
299 #ifdef X11
300         struct x11_info x11;
301 #endif
302
303 #ifdef APCUPSD
304         APCUPSD_S apcupsd;
305 #endif
306
307         short kflags;   /* kernel settings, see enum KFLAG */
308 };
309
310 #ifdef HAVE_LUA
311 #include "llua.h"
312 #endif /* HAVE_LUA */
313
314 /* needed by linux.c and top.c -> outsource somewhere */
315 enum {
316         /* set to true if kernel uses "long" format for /proc/stats */
317         KFLAG_IS_LONGSTAT = 0x01,
318         /* set to true if kernel shows # of threads for the proc value
319          * in sysinfo() call */
320         KFLAG_PROC_IS_THREADS = 0x02
321         /* bits 0x04, 0x08, 0x10, 0x20, 0x40, 0x80 available for future use */
322         /* KFLAG_NEXT_ONE = 0x04 */
323 };
324 #define KFLAG_SETON(a) info.kflags |= a
325 #define KFLAG_SETOFF(a) info.kflags &= (~a)
326 #define KFLAG_FLIP(a) info.kflags ^= a
327 #define KFLAG_ISSET(a) info.kflags & a
328
329 /* defined in conky.c, needed by top.c */
330 extern int top_cpu, top_mem, top_time;
331 #ifdef IOSTATS
332 extern int top_io;
333 #endif
334
335 /* defined in conky.c, needed by top.c */
336 extern int cpu_separate;
337
338 /* struct that has all info to be shared between
339  * instances of the same text object */
340 extern struct information info;
341
342 /* defined in users.c */
343 void update_users(void);
344
345 /* defined in conky.c */
346 extern double current_update_time, last_update_time, update_interval;
347
348 /* defined in conky.c */
349 int spaced_print(char *, int, const char *, int, ...)
350         __attribute__((format(printf, 3, 5)));
351 extern int inotify_fd;
352
353 /* defined in conky.c
354  * evaluates 'text' and places the result in 'buffer'
355  */
356 void evaluate(const char *text, char *buffer);
357
358 /* maximum size of config TEXT buffer, i.e. below TEXT line. */
359 extern unsigned int max_user_text;
360
361 /* path to config file */
362 extern char *current_config;
363
364 #ifdef X11
365 #define TO_X 1
366 #endif
367 #define TO_STDOUT 2
368 #define TO_STDERR 4
369 #define OVERWRITE_FILE 8
370 #define APPEND_FILE 16
371 #ifdef NCURSES
372 #define TO_NCURSES 32
373 #endif
374 enum x_initialiser_state {
375         NO = 0,
376         YES = 1,
377         NEVER = 2
378 };
379 extern int output_methods;
380 extern enum x_initialiser_state x_initialised;
381
382 void set_update_interval(double interval);
383
384 #define DEFAULT_TEXT_BUFFER_SIZE_S "##DEFAULT_TEXT_BUFFER_SIZE"
385
386 #define NOBATTERY 0
387
388 /* to get rid of 'unused variable' warnings */
389 #define UNUSED(a)  (void)a
390 #define UNUSED_ATTR __attribute__ ((unused))
391
392 #endif /* _conky_h_ */