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