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