Added support for $pid_uid, $pid_euid, $pid_suid, $pid_fsuid, $pid_gid, $pid_egid...
[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_cmdline_to_pid,
237         OBJ_pid_chroot,
238         OBJ_pid_cmdline,
239         OBJ_pid_cwd,
240         OBJ_pid_environ,
241         OBJ_pid_environ_list,
242         OBJ_pid_exe,
243         OBJ_pid_openfiles,
244         OBJ_pid_parent,
245         OBJ_pid_state,
246         OBJ_pid_state_short,
247         OBJ_pid_stderr,
248         OBJ_pid_stdin,
249         OBJ_pid_stdout,
250         OBJ_pid_uid,
251         OBJ_pid_euid,
252         OBJ_pid_suid,
253         OBJ_pid_fsuid,
254         OBJ_pid_gid,
255         OBJ_pid_egid,
256         OBJ_pid_sgid,
257         OBJ_pid_fsgid,
258         OBJ_processes,
259         OBJ_running_processes,
260         OBJ_shadecolor,
261         OBJ_outlinecolor,
262         OBJ_stippled_hr,
263         OBJ_swap,
264         OBJ_swapfree,
265         OBJ_swapbar,
266         OBJ_swapmax,
267         OBJ_swapperc,
268         OBJ_sysname,
269         OBJ_text,
270         OBJ_threads,
271         OBJ_time,
272         OBJ_utime,
273         OBJ_tztime,
274         OBJ_totaldown,
275         OBJ_totalup,
276         OBJ_updates,
277         OBJ_upspeed,
278         OBJ_upspeedf,
279 #ifdef X11
280         OBJ_upspeedgraph,
281 #endif /* X11 */
282         OBJ_uptime,
283         OBJ_uptime_short,
284         OBJ_user_names,
285         OBJ_user_terms,
286         OBJ_user_times,
287         OBJ_user_time,
288         OBJ_user_number,
289         OBJ_imap_messages,
290         OBJ_imap_unseen,
291         OBJ_pop3_unseen,
292         OBJ_pop3_used,
293 #if (defined(__FreeBSD__) || defined(__FreeBSD_kernel__) \
294                 || defined(__OpenBSD__)) && (defined(i386) || defined(__i386__))
295         OBJ_apm_adapter,
296         OBJ_apm_battery_time,
297         OBJ_apm_battery_life,
298 #endif /* __FreeBSD__ __OpenBSD__ */
299 #ifdef __OpenBSD__
300         OBJ_obsd_sensors_temp,
301         OBJ_obsd_sensors_fan,
302         OBJ_obsd_sensors_volt,
303         OBJ_obsd_vendor,
304         OBJ_obsd_product,
305 #endif /* __OpenBSD__ */
306 #ifdef MPD
307         OBJ_mpd_title,
308         OBJ_mpd_artist,
309         OBJ_mpd_album,
310         OBJ_mpd_random,
311         OBJ_mpd_repeat,
312         OBJ_mpd_vol,
313         OBJ_mpd_bitrate,
314         OBJ_mpd_status,
315         OBJ_mpd_bar,
316         OBJ_mpd_elapsed,
317         OBJ_mpd_length,
318         OBJ_mpd_track,
319         OBJ_mpd_name,
320         OBJ_mpd_file,
321         OBJ_mpd_percent,
322         OBJ_mpd_smart,
323         OBJ_if_mpd_playing,
324 #endif /* MPD */
325 #ifdef MOC
326         OBJ_moc_state,
327         OBJ_moc_file,
328         OBJ_moc_title,
329         OBJ_moc_artist,
330         OBJ_moc_song,
331         OBJ_moc_album,
332         OBJ_moc_totaltime,
333         OBJ_moc_timeleft,
334         OBJ_moc_curtime,
335         OBJ_moc_bitrate,
336         OBJ_moc_rate,
337 #endif /* MOC */
338 #ifdef XMMS2
339         OBJ_xmms2_artist,
340         OBJ_xmms2_album,
341         OBJ_xmms2_title,
342         OBJ_xmms2_genre,
343         OBJ_xmms2_comment,
344         OBJ_xmms2_url,
345         OBJ_xmms2_date,
346         OBJ_xmms2_tracknr,
347         OBJ_xmms2_bitrate,
348         OBJ_xmms2_id,
349         OBJ_xmms2_duration,
350         OBJ_xmms2_elapsed,
351         OBJ_xmms2_size,
352         OBJ_xmms2_percent,
353         OBJ_xmms2_status,
354 #ifdef X11
355         OBJ_xmms2_bar,
356 #endif /* X11 */
357         OBJ_xmms2_smart,
358         OBJ_xmms2_playlist,
359         OBJ_xmms2_timesplayed,
360         OBJ_if_xmms2_connected,
361 #endif /* XMMS2 */
362 #ifdef AUDACIOUS
363         OBJ_audacious_status,
364         OBJ_audacious_title,
365         OBJ_audacious_length,
366         OBJ_audacious_length_seconds,
367         OBJ_audacious_position,
368         OBJ_audacious_position_seconds,
369         OBJ_audacious_bitrate,
370         OBJ_audacious_frequency,
371         OBJ_audacious_channels,
372         OBJ_audacious_filename,
373         OBJ_audacious_playlist_length,
374         OBJ_audacious_playlist_position,
375         OBJ_audacious_main_volume,
376 #ifdef X11
377         OBJ_audacious_bar,
378 #endif /* X11 */
379 #endif /* AUDACIOUS */
380 #ifdef BMPX
381         OBJ_bmpx_title,
382         OBJ_bmpx_artist,
383         OBJ_bmpx_album,
384         OBJ_bmpx_track,
385         OBJ_bmpx_uri,
386         OBJ_bmpx_bitrate,
387 #endif /* BMPX */
388 #ifdef EVE
389         OBJ_eve,
390 #endif /* EVE */
391 #ifdef HAVE_CURL
392         OBJ_curl,
393 #endif /* HAVE_CURL */
394 #ifdef RSS
395         OBJ_rss,
396 #endif /* RSS */
397 #ifdef WEATHER
398         OBJ_weather,
399 #endif /* WEATHER */
400 #ifdef XOAP
401         OBJ_weather_forecast,
402 #endif /* XOAP */
403 #ifdef HAVE_LUA
404         OBJ_lua,
405         OBJ_lua_parse,
406         OBJ_lua_bar,
407 #ifdef X11
408         OBJ_lua_graph,
409         OBJ_lua_gauge,
410 #endif /* X11 */
411 #endif /* HAVE_LUA */
412 #ifdef TCP_PORT_MONITOR
413         OBJ_tcp_portmon,
414 #endif /* TCP_PORT_MONITOR */
415 #ifdef HAVE_ICONV
416         OBJ_iconv_start,
417         OBJ_iconv_stop,
418 #endif /* HAVE_ICONV */
419 #ifdef HDDTEMP
420         OBJ_hddtemp,
421 #endif /* HDDTEMP */
422         OBJ_include,
423         OBJ_blink,
424         OBJ_to_bytes,
425         OBJ_scroll,
426         OBJ_combine,
427         OBJ_entropy_avail,
428         OBJ_entropy_perc,
429         OBJ_entropy_poolsize,
430         OBJ_entropy_bar,
431 #ifdef APCUPSD
432         OBJ_apcupsd,
433         OBJ_apcupsd_name,
434         OBJ_apcupsd_model,
435         OBJ_apcupsd_upsmode,
436         OBJ_apcupsd_cable,
437         OBJ_apcupsd_status,
438         OBJ_apcupsd_linev,
439         OBJ_apcupsd_load,
440         OBJ_apcupsd_loadbar,
441 #ifdef X11
442         OBJ_apcupsd_loadgraph,
443         OBJ_apcupsd_loadgauge,
444 #endif /* X11 */
445         OBJ_apcupsd_charge,
446         OBJ_apcupsd_timeleft,
447         OBJ_apcupsd_temp,
448         OBJ_apcupsd_lastxfer,
449 #endif /* APCUPSD */
450 };
451
452 struct text_object {
453         struct text_object *next, *prev;        /* doubly linked list of text objects */
454         struct text_object *sub;                /* for objects parsing text into objects */
455         union {
456                 void *opaque;           /* new style generic per object data */
457                 char *s;                /* some string */
458                 int i;                  /* some integer */
459                 long l;                 /* some long integer */
460         } data;
461
462         void *special_data;
463         int type;
464         long line;
465 };
466
467 /* text object list helpers */
468 int append_object(struct text_object *root, struct text_object *obj);
469
470 /* ifblock helpers
471  *
472  * Opaque is a pointer to the address of the ifblock stack's top object.
473  * Calling clients should pass the address of a defined void pointer which
474  * was initialised to NULL (empty stack).
475  * */
476 int obj_be_ifblock_if(void **opaque, struct text_object *);
477 int obj_be_ifblock_else(void **opaque, struct text_object *);
478 int obj_be_ifblock_endif(void **opaque, struct text_object *);
479 int ifblock_stack_empty(void **opaque);
480
481 #endif /* _TEXT_OBJECT_H */