* Added some power saving features, needs some testing to confirm this is working...
[monky] / src / conky.h
1 /* -*- mode: c; c-basic-offset: 4; tab-width: 4; indent-tabs-mode: t -*-
2  * vim: ts=4 sw=4 noet ai cindent syntax=c
3  *
4  * Conky, a system monitor, based on torsmo
5  *
6  * Any original torsmo code is licensed under the BSD license
7  *
8  * All code written since the fork of torsmo is licensed under the GPL
9  *
10  * Please see COPYING for details
11  *
12  * Copyright (c) 2004, Hannu Saransaari and Lauri Hakkarainen
13  * Copyright (c) 2005-2010 Brenden Matthews, Philip Kovacs, et. al.
14  *      (see AUTHORS)
15  * All rights reserved.
16  *
17  * This program is free software: you can redistribute it and/or modify
18  * it under the terms of the GNU General Public License as published by
19  * the Free Software Foundation, either version 3 of the License, or
20  * (at your option) any later version.
21  *
22  * This program is distributed in the hope that it will be useful,
23  * but WITHOUT ANY WARRANTY; without even the implied warranty of
24  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
25  * GNU General Public License for more details.
26  * You should have received a copy of the GNU General Public License
27  * along with this program.  If not, see <http://www.gnu.org/licenses/>.
28  *
29  */
30
31 #ifndef _conky_h_
32 #define _conky_h_
33
34 #include "config.h"     /* defines */
35 #include "common.h"     /* at least for struct dns_data */
36 #include <sys/utsname.h> /* struct uname_s */
37 #include <arpa/inet.h>
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 /* forward define to make gcc happy */
67 struct text_object;
68
69 #ifdef AUDACIOUS
70 #include "audacious.h"
71 #endif
72
73 #ifdef BMPX
74 #include "bmpx.h"
75 #endif
76
77 #ifdef EVE
78 #include "eve.h"
79 #endif
80
81 #ifdef HDDTEMP
82 #include "hddtemp.h"
83 #endif /* HDDTEMP */
84
85 #ifdef MOC
86 #include "moc.h"
87 #endif
88
89 #ifdef MPD
90 #include "mpd.h"
91 #endif
92
93 #ifdef HAVE_CURL
94 #include "ccurl_thread.h"
95 #endif /* HAVE_CURL */
96
97 #ifdef RSS
98 #include "rss.h"
99 #endif /* RSS */
100
101 #ifdef XOAP
102 #ifndef WEATHER
103 #error "WEATHER needs to be defined if XOAP is defined"
104 #endif /* WEATHER */
105 #endif /* XOAP */
106
107 #ifdef WEATHER
108 #include "weather.h"
109 #endif /* WEATHER */
110
111 #ifdef TCP_PORT_MONITOR
112 #include "tcp-portmon.h"
113 #endif
114
115 #ifdef XMMS2
116 #include "xmms2.h"
117 #endif
118
119 #ifdef IBM
120 #include "ibm.h"
121 #include "smapi.h"
122 #endif
123
124 #ifdef APCUPSD
125 #include "apcupsd.h"
126 #endif
127
128 /* sony support */
129 #include "sony.h"
130
131 #include <dbus/dbus.h>
132 #include <dbus/dbus-glib.h>
133 #include <glib.h>
134 #include <mce/mode-names.h>
135
136
137 DBusConnection* conn;//session bus
138 DBusConnection* conn2;//system bus
139 DBusMessage* msg;
140 DBusMessageIter args;
141 DBusError err;
142 int ret;
143
144 /* A size for temporary, static buffers to use when
145  * one doesn't know what to choose. Defaults to 256.  */
146 extern unsigned int text_buffer_size;
147
148 struct usr_info {
149         char *names;
150         char *times;
151         char *ctime;
152         char *terms;
153         int number;
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
175 int get_stippled_borders(void);
176
177 #endif /* X11 */
178
179 /* defined in conky.c */
180 extern long default_fg_color, default_bg_color, default_out_color;
181 extern long color0, color1, color2, color3, color4, color5, color6, color7,
182            color8, color9;
183 void set_current_text_color(long colour);
184 long get_current_text_color(void);
185
186 void set_updatereset(int);
187 int get_updatereset(void);
188
189 int percent_print(char *, int, unsigned);
190 void human_readable(long long, char *, int);
191
192 struct conftree {
193         char* string;
194         struct conftree* horz_next;
195         struct conftree* vert_next;
196         struct conftree* back;
197 };
198
199 char load_config_file(const char *);
200
201 char *get_global_text(void);
202 extern long global_text_lines;
203
204 //adds newstring to to the tree unless you can already see it when travelling back.
205 //if it's possible to attach it then it returns a pointer to the leaf, else it returns NULL
206 struct conftree* conftree_add(struct conftree* previous, const char* newstring);
207
208 extern struct conftree *currentconffile;
209
210 #define MAX_TEMPLATES 10
211 char **get_templates(void);
212
213 /* get_xxxxx_stuff() item selector
214  * needed by conky.c, linux.c and freebsd.c */
215 enum {
216         BATTERY_STATUS,
217         BATTERY_TIME,
218         BATTERY_VOLTS,
219         BATTERY_TEMP,
220         DBUS_CELL_DBM,
221         DBUS_CELL_PERCENT,
222         DBUS_HAL_BATTERY_CHRG_STATUS,
223         DBUS_HAL_BATTERY_PERCENT,
224         DBUS_HAL_BATTERY_VOLTS_CURRENT
225 };
226
227 /* if_up strictness selector
228  * needed by conky.c and linux.c (and potentially others) */
229 enum {
230         IFUP_UP,
231         IFUP_LINK,
232         IFUP_ADDR
233 } ifup_strictness;
234
235 struct information {
236         unsigned int mask;
237
238         struct utsname uname_s;
239
240         char freq[10];
241
242         double uptime;
243
244         /* memory information in kilobytes */
245         unsigned long long mem, memeasyfree, memfree, memmax, swap, swapfree, swapmax;
246         unsigned long long bufmem, buffers, cached;
247
248         unsigned short procs;
249         unsigned short run_procs;
250         unsigned short threads;
251         unsigned short run_threads;
252
253         float *cpu_usage;
254         /* struct cpu_stat cpu_summed; what the hell is this? */
255         int cpu_count;
256         int cpu_avg_samples;
257
258         int net_avg_samples;
259
260         int diskio_avg_samples;
261
262         float loadavg[3];
263
264 #ifdef XMMS2
265         struct xmms2_s xmms2;
266 #endif
267 #ifdef AUDACIOUS
268         AUDACIOUS_S audacious;
269 #endif
270 #ifdef BMPX
271         struct bmpx_s bmpx;
272 #endif
273         struct usr_info users;
274         struct process *cpu[10];
275         struct process *memu[10];
276         struct process *time[10];
277 #ifdef IOSTATS
278         struct process *io[10];
279 #endif
280         struct process *first_process;
281         unsigned long looped;
282         double music_player_interval;
283
284 #ifdef X11
285         struct x11_info x11;
286 #endif
287
288 #ifdef APCUPSD
289         APCUPSD_S apcupsd;
290 #endif
291
292         short kflags;   /* kernel settings, see enum KFLAG */
293 };
294
295 #ifdef HAVE_LUA
296 #include "llua.h"
297 #endif /* HAVE_LUA */
298
299 /* needed by linux.c and top.c -> outsource somewhere */
300 enum {
301         /* set to true if kernel uses "long" format for /proc/stats */
302         KFLAG_IS_LONGSTAT = 0x01,
303         /* set to true if kernel shows # of threads for the proc value
304          * in sysinfo() call */
305         KFLAG_PROC_IS_THREADS = 0x02
306         /* bits 0x04, 0x08, 0x10, 0x20, 0x40, 0x80 available for future use */
307         /* KFLAG_NEXT_ONE = 0x04 */
308 };
309 #define KFLAG_SETON(a) info.kflags |= a
310 #define KFLAG_SETOFF(a) info.kflags &= (~a)
311 #define KFLAG_FLIP(a) info.kflags ^= a
312 #define KFLAG_ISSET(a) info.kflags & a
313
314 /* defined in conky.c, needed by top.c */
315 extern int top_cpu, top_mem, top_time;
316 #ifdef IOSTATS
317 extern int top_io;
318 #endif
319 extern int top_running;
320
321 /* defined in conky.c, needed by top.c */
322 extern int cpu_separate;
323
324 /* struct that has all info to be shared between
325  * instances of the same text object */
326 extern struct information info;
327
328 /* defined in users.c */
329 int update_users(void);
330 void update_user_time(char *tty);
331
332 /* defined in conky.c */
333 extern double current_update_time, last_update_time, update_interval;
334 extern int update_heartbeat_min, update_heartbeat_max, update_heartbeat_battery_skip, update_skips_when_sleeping;
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 'p' of max length 'p_max_size'
342  */
343 void evaluate(const char *text, char *p, int p_max_size);
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 /* X11 */
354 #define TO_STDOUT 2
355 #define TO_STDERR 4
356 #define OVERWRITE_FILE 8
357 #define APPEND_FILE 16
358 #ifdef NCURSES
359 #define TO_NCURSES 32
360 #endif /* NCURSES */
361 enum x_initialiser_state {
362         NO = 0,
363         YES = 1,
364         NEVER = 2
365 };
366 extern int output_methods;
367 extern enum x_initialiser_state x_initialised;
368
369 void set_update_interval(double interval);
370
371 #define DEFAULT_TEXT_BUFFER_SIZE_S "##DEFAULT_TEXT_BUFFER_SIZE"
372
373 #define NOBATTERY 0
374
375 /* to get rid of 'unused variable' warnings */
376 #define UNUSED(a)  (void)a
377 #define UNUSED_ATTR __attribute__ ((unused))
378
379 void parse_conky_vars(struct text_object *, const char *,
380                         char *, int, struct information *);
381
382 void generate_text_internal(char *, int, struct text_object,
383                                    struct information *);
384 #endif /* _conky_h_ */