f8747e4e4a313de81b7fe3b43536a6cdf8eda335
[monky] / src / text_object.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  */
29 #ifndef _TEXT_OBJECT_H
30 #define _TEXT_OBJECT_H
31
32 #include "config.h"             /* for the defines */
33 #include "specials.h"           /* enum special_types */
34
35 enum text_object_type {
36         OBJ_read_tcp,
37         OBJ_addr,
38 #if defined(__linux__)
39         OBJ_addrs,
40 #endif /* __linux__ */
41 #ifndef __OpenBSD__
42         OBJ_acpiacadapter,
43         OBJ_acpifan,
44         OBJ_acpitemp,
45         OBJ_battery,
46         OBJ_battery_time,
47         OBJ_battery_percent,
48         OBJ_battery_bar,
49         OBJ_battery_short,
50 #endif /* !__OpenBSD__ */
51         OBJ_buffers,
52         OBJ_cached,
53         OBJ_color,
54         OBJ_color0,
55         OBJ_color1,
56         OBJ_color2,
57         OBJ_color3,
58         OBJ_color4,
59         OBJ_color5,
60         OBJ_color6,
61         OBJ_color7,
62         OBJ_color8,
63         OBJ_color9,
64         OBJ_conky_version,
65         OBJ_conky_build_date,
66         OBJ_conky_build_arch,
67         OBJ_font,
68         OBJ_cpu,
69         OBJ_cpubar,
70 #ifdef X11
71         OBJ_cpugauge,
72         OBJ_cpugraph,
73         OBJ_loadgraph,
74 #endif /* X11 */
75         OBJ_diskio,
76         OBJ_diskio_read,
77         OBJ_diskio_write,
78 #ifdef X11
79         OBJ_diskiograph,
80         OBJ_diskiograph_read,
81         OBJ_diskiograph_write,
82 #endif /* X11 */
83         OBJ_downspeed,
84         OBJ_downspeedf,
85 #ifdef X11
86         OBJ_downspeedgraph,
87 #endif /* X11 */
88         OBJ_else,
89         OBJ_endif,
90         OBJ_eval,
91         OBJ_image,
92         OBJ_exec,
93         OBJ_execi,
94         OBJ_texeci,
95         OBJ_execbar,
96         OBJ_execibar,
97 #ifdef X11
98         OBJ_execgauge,
99         OBJ_execgraph,
100         OBJ_execigraph,
101         OBJ_execigauge,
102 #endif /* X11 */
103         OBJ_execp,
104         OBJ_execpi,
105         OBJ_freq,
106         OBJ_freq_g,
107         OBJ_fs_bar,
108         OBJ_fs_bar_free,
109         OBJ_fs_free,
110         OBJ_fs_free_perc,
111         OBJ_fs_size,
112         OBJ_fs_type,
113         OBJ_fs_used,
114         OBJ_fs_used_perc,
115         OBJ_goto,
116         OBJ_tab,
117         OBJ_hr,
118         OBJ_offset,
119         OBJ_voffset,
120         OBJ_alignr,
121         OBJ_alignc,
122         OBJ_i2c,
123         OBJ_platform,
124         OBJ_hwmon,
125 #if defined(__linux__)
126         OBJ_disk_protect,
127         OBJ_i8k_version,
128         OBJ_i8k_bios,
129         OBJ_i8k_serial,
130         OBJ_i8k_cpu_temp,
131         OBJ_i8k_left_fan_status,
132         OBJ_i8k_right_fan_status,
133         OBJ_i8k_left_fan_rpm,
134         OBJ_i8k_right_fan_rpm,
135         OBJ_i8k_ac_status,
136         OBJ_i8k_buttons_status,
137 #if defined(IBM)
138         OBJ_ibm_fan,
139         OBJ_ibm_temps,
140         OBJ_ibm_volume,
141         OBJ_ibm_brightness,
142         OBJ_smapi,
143 #ifdef X11
144         OBJ_smapi_bat_bar,
145 #endif /* X11 */
146         OBJ_smapi_bat_perc,
147         OBJ_smapi_bat_temp,
148         OBJ_smapi_bat_power,
149         OBJ_if_smapi_bat_installed,
150 #endif /* IBM */
151         /* information from sony_laptop kernel module
152          * /sys/devices/platform/sony-laptop */
153         OBJ_sony_fanspeed,
154         OBJ_if_gw,
155         OBJ_ioscheduler,
156         OBJ_gw_iface,
157         OBJ_gw_ip,
158         OBJ_laptop_mode,
159         OBJ_pb_battery,
160         OBJ_voltage_mv,
161         OBJ_voltage_v,
162         OBJ_wireless_essid,
163         OBJ_wireless_mode,
164         OBJ_wireless_bitrate,
165         OBJ_wireless_ap,
166         OBJ_wireless_link_qual,
167         OBJ_wireless_link_qual_max,
168         OBJ_wireless_link_qual_perc,
169         OBJ_wireless_link_bar,
170 #endif /* __linux__ */
171 #if defined(__FreeBSD__) || defined(__linux__)
172         OBJ_if_up,
173 #endif
174         OBJ_if_empty,
175         OBJ_if_match,
176         OBJ_if_existing,
177         OBJ_if_mounted,
178         OBJ_if_running,
179         OBJ_if_updatenr,
180         OBJ_top,
181         OBJ_top_mem,
182         OBJ_top_time,
183 #ifdef IOSTATS
184         OBJ_top_io,
185 #endif
186         OBJ_tail,
187         OBJ_head,
188         OBJ_lines,
189         OBJ_words,
190         OBJ_kernel,
191         OBJ_loadavg,
192         OBJ_machine,
193         OBJ_mails,
194         OBJ_new_mails,
195         OBJ_seen_mails,
196         OBJ_unseen_mails,
197         OBJ_flagged_mails,
198         OBJ_unflagged_mails,
199         OBJ_forwarded_mails,
200         OBJ_unforwarded_mails,
201         OBJ_replied_mails,
202         OBJ_unreplied_mails,
203         OBJ_draft_mails,
204         OBJ_trashed_mails,
205         OBJ_mboxscan,
206         OBJ_mem,
207         OBJ_memeasyfree,
208         OBJ_memfree,
209 #ifdef X11
210         OBJ_memgauge,
211         OBJ_memgraph,
212 #endif /* X11 */
213         OBJ_membar,
214         OBJ_memmax,
215         OBJ_memperc,
216         OBJ_mixer,
217         OBJ_mixerl,
218         OBJ_mixerr,
219 #ifdef X11
220         OBJ_mixerbar,
221         OBJ_mixerlbar,
222         OBJ_mixerrbar,
223 #endif /* X11 */
224         OBJ_if_mixer_mute,
225 #ifdef X11
226         OBJ_monitor,
227         OBJ_monitor_number,
228         OBJ_desktop,
229         OBJ_desktop_number,
230         OBJ_desktop_name,
231 #endif /* X11 */
232         OBJ_nameserver,
233         OBJ_nodename,
234         OBJ_nvidia,
235         OBJ_pre_exec,
236         OBJ_pid_cmdline,
237         OBJ_pid_cwd,
238         OBJ_pid_environ,
239         OBJ_pid_environ_list,
240         OBJ_pid_exe,
241         OBJ_pid_openfiles,
242         OBJ_pid_stderr,
243         OBJ_pid_stdin,
244         OBJ_pid_stdout,
245         OBJ_processes,
246         OBJ_running_processes,
247         OBJ_shadecolor,
248         OBJ_outlinecolor,
249         OBJ_stippled_hr,
250         OBJ_swap,
251         OBJ_swapfree,
252         OBJ_swapbar,
253         OBJ_swapmax,
254         OBJ_swapperc,
255         OBJ_sysname,
256         OBJ_text,
257         OBJ_threads,
258         OBJ_time,
259         OBJ_utime,
260         OBJ_tztime,
261         OBJ_totaldown,
262         OBJ_totalup,
263         OBJ_updates,
264         OBJ_upspeed,
265         OBJ_upspeedf,
266 #ifdef X11
267         OBJ_upspeedgraph,
268 #endif /* X11 */
269         OBJ_uptime,
270         OBJ_uptime_short,
271         OBJ_user_names,
272         OBJ_user_terms,
273         OBJ_user_times,
274         OBJ_conky_user_time,
275         OBJ_user_number,
276         OBJ_imap_messages,
277         OBJ_imap_unseen,
278         OBJ_pop3_unseen,
279         OBJ_pop3_used,
280 #if (defined(__FreeBSD__) || defined(__FreeBSD_kernel__) \
281                 || defined(__OpenBSD__)) && (defined(i386) || defined(__i386__))
282         OBJ_apm_adapter,
283         OBJ_apm_battery_time,
284         OBJ_apm_battery_life,
285 #endif /* __FreeBSD__ __OpenBSD__ */
286 #ifdef __OpenBSD__
287         OBJ_obsd_sensors_temp,
288         OBJ_obsd_sensors_fan,
289         OBJ_obsd_sensors_volt,
290         OBJ_obsd_vendor,
291         OBJ_obsd_product,
292 #endif /* __OpenBSD__ */
293 #ifdef MPD
294         OBJ_mpd_title,
295         OBJ_mpd_artist,
296         OBJ_mpd_album,
297         OBJ_mpd_random,
298         OBJ_mpd_repeat,
299         OBJ_mpd_vol,
300         OBJ_mpd_bitrate,
301         OBJ_mpd_status,
302         OBJ_mpd_bar,
303         OBJ_mpd_elapsed,
304         OBJ_mpd_length,
305         OBJ_mpd_track,
306         OBJ_mpd_name,
307         OBJ_mpd_file,
308         OBJ_mpd_percent,
309         OBJ_mpd_smart,
310         OBJ_if_mpd_playing,
311 #endif /* MPD */
312 #ifdef MOC
313         OBJ_moc_state,
314         OBJ_moc_file,
315         OBJ_moc_title,
316         OBJ_moc_artist,
317         OBJ_moc_song,
318         OBJ_moc_album,
319         OBJ_moc_totaltime,
320         OBJ_moc_timeleft,
321         OBJ_moc_curtime,
322         OBJ_moc_bitrate,
323         OBJ_moc_rate,
324 #endif /* MOC */
325 #ifdef XMMS2
326         OBJ_xmms2_artist,
327         OBJ_xmms2_album,
328         OBJ_xmms2_title,
329         OBJ_xmms2_genre,
330         OBJ_xmms2_comment,
331         OBJ_xmms2_url,
332         OBJ_xmms2_date,
333         OBJ_xmms2_tracknr,
334         OBJ_xmms2_bitrate,
335         OBJ_xmms2_id,
336         OBJ_xmms2_duration,
337         OBJ_xmms2_elapsed,
338         OBJ_xmms2_size,
339         OBJ_xmms2_percent,
340         OBJ_xmms2_status,
341 #ifdef X11
342         OBJ_xmms2_bar,
343 #endif /* X11 */
344         OBJ_xmms2_smart,
345         OBJ_xmms2_playlist,
346         OBJ_xmms2_timesplayed,
347         OBJ_if_xmms2_connected,
348 #endif /* XMMS2 */
349 #ifdef AUDACIOUS
350         OBJ_audacious_status,
351         OBJ_audacious_title,
352         OBJ_audacious_length,
353         OBJ_audacious_length_seconds,
354         OBJ_audacious_position,
355         OBJ_audacious_position_seconds,
356         OBJ_audacious_bitrate,
357         OBJ_audacious_frequency,
358         OBJ_audacious_channels,
359         OBJ_audacious_filename,
360         OBJ_audacious_playlist_length,
361         OBJ_audacious_playlist_position,
362         OBJ_audacious_main_volume,
363 #ifdef X11
364         OBJ_audacious_bar,
365 #endif /* X11 */
366 #endif /* AUDACIOUS */
367 #ifdef BMPX
368         OBJ_bmpx_title,
369         OBJ_bmpx_artist,
370         OBJ_bmpx_album,
371         OBJ_bmpx_track,
372         OBJ_bmpx_uri,
373         OBJ_bmpx_bitrate,
374 #endif /* BMPX */
375 #ifdef EVE
376         OBJ_eve,
377 #endif /* EVE */
378 #ifdef HAVE_CURL
379         OBJ_curl,
380 #endif /* HAVE_CURL */
381 #ifdef RSS
382         OBJ_rss,
383 #endif /* RSS */
384 #ifdef WEATHER
385         OBJ_weather,
386 #endif /* WEATHER */
387 #ifdef XOAP
388         OBJ_weather_forecast,
389 #endif /* XOAP */
390 #ifdef HAVE_LUA
391         OBJ_lua,
392         OBJ_lua_parse,
393         OBJ_lua_bar,
394 #ifdef X11
395         OBJ_lua_graph,
396         OBJ_lua_gauge,
397 #endif /* X11 */
398 #endif /* HAVE_LUA */
399 #ifdef TCP_PORT_MONITOR
400         OBJ_tcp_portmon,
401 #endif /* TCP_PORT_MONITOR */
402 #ifdef HAVE_ICONV
403         OBJ_iconv_start,
404         OBJ_iconv_stop,
405 #endif /* HAVE_ICONV */
406 #ifdef HDDTEMP
407         OBJ_hddtemp,
408 #endif /* HDDTEMP */
409         OBJ_include,
410         OBJ_blink,
411         OBJ_to_bytes,
412         OBJ_scroll,
413         OBJ_combine,
414         OBJ_entropy_avail,
415         OBJ_entropy_perc,
416         OBJ_entropy_poolsize,
417         OBJ_entropy_bar,
418 #ifdef APCUPSD
419         OBJ_apcupsd,
420         OBJ_apcupsd_name,
421         OBJ_apcupsd_model,
422         OBJ_apcupsd_upsmode,
423         OBJ_apcupsd_cable,
424         OBJ_apcupsd_status,
425         OBJ_apcupsd_linev,
426         OBJ_apcupsd_load,
427         OBJ_apcupsd_loadbar,
428 #ifdef X11
429         OBJ_apcupsd_loadgraph,
430         OBJ_apcupsd_loadgauge,
431 #endif /* X11 */
432         OBJ_apcupsd_charge,
433         OBJ_apcupsd_timeleft,
434         OBJ_apcupsd_temp,
435         OBJ_apcupsd_lastxfer,
436 #endif /* APCUPSD */
437 };
438
439 struct text_object {
440         struct text_object *next, *prev;        /* doubly linked list of text objects */
441         struct text_object *sub;                /* for objects parsing text into objects */
442         union {
443                 void *opaque;           /* new style generic per object data */
444                 char *s;                /* some string */
445                 int i;                  /* some integer */
446                 long l;                 /* some long integer */
447         } data;
448
449         void *special_data;
450         int type;
451         long line;
452 };
453
454 /* text object list helpers */
455 int append_object(struct text_object *root, struct text_object *obj);
456
457 /* ifblock helpers
458  *
459  * Opaque is a pointer to the address of the ifblock stack's top object.
460  * Calling clients should pass the address of a defined void pointer which
461  * was initialised to NULL (empty stack).
462  * */
463 int obj_be_ifblock_if(void **opaque, struct text_object *);
464 int obj_be_ifblock_else(void **opaque, struct text_object *);
465 int obj_be_ifblock_endif(void **opaque, struct text_object *);
466 int ifblock_stack_empty(void **opaque);
467
468 #endif /* _TEXT_OBJECT_H */