git.maemo.org Git - monky/blob - 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-2010 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         OBJ_cpugauge,
  71 #ifdef X11
  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         OBJ_execgauge,
  98         OBJ_execigauge,
  99 #ifdef X11
 100         OBJ_execgraph,
 101         OBJ_execigraph,
 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_format_time,
 200         OBJ_forwarded_mails,
 201         OBJ_unforwarded_mails,
 202         OBJ_replied_mails,
 203         OBJ_unreplied_mails,
 204         OBJ_draft_mails,
 205         OBJ_trashed_mails,
 206         OBJ_mboxscan,
 207         OBJ_mem,
 208         OBJ_memeasyfree,
 209         OBJ_memfree,
 210         OBJ_memgauge,
 211 #ifdef X11
 212         OBJ_memgraph,
 213 #endif /* X11 */
 214         OBJ_membar,
 215         OBJ_memmax,
 216         OBJ_memperc,
 217         OBJ_mixer,
 218         OBJ_mixerl,
 219         OBJ_mixerr,
 220         OBJ_mixerbar,
 221         OBJ_mixerlbar,
 222         OBJ_mixerrbar,
 223         OBJ_if_mixer_mute,
 224 #ifdef X11
 225         OBJ_monitor,
 226         OBJ_monitor_number,
 227         OBJ_desktop,
 228         OBJ_desktop_number,
 229         OBJ_desktop_name,
 230 #endif /* X11 */
 231         OBJ_nameserver,
 232         OBJ_nodename,
 233         OBJ_nodename_short,
 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_nice,
 244         OBJ_pid_openfiles,
 245         OBJ_pid_parent,
 246         OBJ_pid_priority,
 247         OBJ_pid_state,
 248         OBJ_pid_state_short,
 249         OBJ_pid_stderr,
 250         OBJ_pid_stdin,
 251         OBJ_pid_stdout,
 252         OBJ_pid_threads,
 253         OBJ_pid_thread_list,
 254         OBJ_pid_time_kernelmode,
 255         OBJ_pid_time_usermode,
 256         OBJ_pid_time,
 257         OBJ_pid_uid,
 258         OBJ_pid_euid,
 259         OBJ_pid_suid,
 260         OBJ_pid_fsuid,
 261         OBJ_pid_gid,
 262         OBJ_pid_egid,
 263         OBJ_pid_sgid,
 264         OBJ_pid_fsgid,
 265         OBJ_pid_read,
 266         OBJ_pid_vmpeak,
 267         OBJ_pid_vmsize,
 268         OBJ_pid_vmlck,
 269         OBJ_pid_vmhwm,
 270         OBJ_pid_vmrss,
 271         OBJ_pid_vmdata,
 272         OBJ_pid_vmstk,
 273         OBJ_pid_vmexe,
 274         OBJ_pid_vmlib,
 275         OBJ_pid_vmpte,
 276         OBJ_pid_write,
 277         OBJ_gid_name,
 278         OBJ_uid_name,
 279         OBJ_processes,
 280         OBJ_running_processes,
 281         OBJ_shadecolor,
 282         OBJ_outlinecolor,
 283         OBJ_stippled_hr,
 284         OBJ_swap,
 285         OBJ_swapfree,
 286         OBJ_swapbar,
 287         OBJ_swapmax,
 288         OBJ_swapperc,
 289         OBJ_sysname,
 290         OBJ_text,
 291         OBJ_threads,
 292         OBJ_running_threads,
 293         OBJ_time,
 294         OBJ_utime,
 295         OBJ_tztime,
 296         OBJ_totaldown,
 297         OBJ_totalup,
 298         OBJ_updates,
 299         OBJ_upspeed,
 300         OBJ_upspeedf,
 301 #ifdef X11
 302         OBJ_upspeedgraph,
 303 #endif /* X11 */
 304         OBJ_uptime,
 305         OBJ_uptime_short,
 306         OBJ_user_names,
 307         OBJ_user_terms,
 308         OBJ_user_times,
 309         OBJ_user_time,
 310         OBJ_user_number,
 311         OBJ_imap_messages,
 312         OBJ_imap_unseen,
 313         OBJ_pop3_unseen,
 314         OBJ_pop3_used,
 315 #if (defined(__FreeBSD__) || defined(__FreeBSD_kernel__) \
 316                 || defined(__OpenBSD__)) && (defined(i386) || defined(__i386__))
 317         OBJ_apm_adapter,
 318         OBJ_apm_battery_time,
 319         OBJ_apm_battery_life,
 320 #endif /* __FreeBSD__ __OpenBSD__ */
 321 #ifdef __OpenBSD__
 322         OBJ_obsd_sensors_temp,
 323         OBJ_obsd_sensors_fan,
 324         OBJ_obsd_sensors_volt,
 325         OBJ_obsd_vendor,
 326         OBJ_obsd_product,
 327 #endif /* __OpenBSD__ */
 328 #ifdef MPD
 329         OBJ_mpd_title,
 330         OBJ_mpd_artist,
 331         OBJ_mpd_album,
 332         OBJ_mpd_random,
 333         OBJ_mpd_repeat,
 334         OBJ_mpd_vol,
 335         OBJ_mpd_bitrate,
 336         OBJ_mpd_status,
 337         OBJ_mpd_bar,
 338         OBJ_mpd_elapsed,
 339         OBJ_mpd_length,
 340         OBJ_mpd_track,
 341         OBJ_mpd_name,
 342         OBJ_mpd_file,
 343         OBJ_mpd_percent,
 344         OBJ_mpd_smart,
 345         OBJ_if_mpd_playing,
 346 #endif /* MPD */
 347 #ifdef MOC
 348         OBJ_moc_state,
 349         OBJ_moc_file,
 350         OBJ_moc_title,
 351         OBJ_moc_artist,
 352         OBJ_moc_song,
 353         OBJ_moc_album,
 354         OBJ_moc_totaltime,
 355         OBJ_moc_timeleft,
 356         OBJ_moc_curtime,
 357         OBJ_moc_bitrate,
 358         OBJ_moc_rate,
 359 #endif /* MOC */
 360 #ifdef XMMS2
 361         OBJ_xmms2_artist,
 362         OBJ_xmms2_album,
 363         OBJ_xmms2_title,
 364         OBJ_xmms2_genre,
 365         OBJ_xmms2_comment,
 366         OBJ_xmms2_url,
 367         OBJ_xmms2_date,
 368         OBJ_xmms2_tracknr,
 369         OBJ_xmms2_bitrate,
 370         OBJ_xmms2_id,
 371         OBJ_xmms2_duration,
 372         OBJ_xmms2_elapsed,
 373         OBJ_xmms2_size,
 374         OBJ_xmms2_percent,
 375         OBJ_xmms2_status,
 376 #ifdef X11
 377         OBJ_xmms2_bar,
 378 #endif /* X11 */
 379         OBJ_xmms2_smart,
 380         OBJ_xmms2_playlist,
 381         OBJ_xmms2_timesplayed,
 382         OBJ_if_xmms2_connected,
 383 #endif /* XMMS2 */
 384 #ifdef AUDACIOUS
 385         OBJ_audacious_status,
 386         OBJ_audacious_title,
 387         OBJ_audacious_length,
 388         OBJ_audacious_length_seconds,
 389         OBJ_audacious_position,
 390         OBJ_audacious_position_seconds,
 391         OBJ_audacious_bitrate,
 392         OBJ_audacious_frequency,
 393         OBJ_audacious_channels,
 394         OBJ_audacious_filename,
 395         OBJ_audacious_playlist_length,
 396         OBJ_audacious_playlist_position,
 397         OBJ_audacious_main_volume,
 398 #ifdef X11
 399         OBJ_audacious_bar,
 400 #endif /* X11 */
 401 #endif /* AUDACIOUS */
 402 #ifdef BMPX
 403         OBJ_bmpx_title,
 404         OBJ_bmpx_artist,
 405         OBJ_bmpx_album,
 406         OBJ_bmpx_track,
 407         OBJ_bmpx_uri,
 408         OBJ_bmpx_bitrate,
 409 #endif /* BMPX */
 410 #ifdef EVE
 411         OBJ_eve,
 412 #endif /* EVE */
 413 #ifdef HAVE_CURL
 414         OBJ_curl,
 415 #endif /* HAVE_CURL */
 416 #ifdef RSS
 417         OBJ_rss,
 418 #endif /* RSS */
 419 #ifdef WEATHER
 420         OBJ_weather,
 421 #endif /* WEATHER */
 422 #ifdef XOAP
 423         OBJ_weather_forecast,
 424 #endif /* XOAP */
 425 #ifdef HAVE_LUA
 426         OBJ_lua,
 427         OBJ_lua_parse,
 428         OBJ_lua_bar,
 429         OBJ_lua_gauge,
 430 #ifdef X11
 431         OBJ_lua_graph,
 432 #endif /* X11 */
 433 #endif /* HAVE_LUA */
 434 #ifdef TCP_PORT_MONITOR
 435         OBJ_tcp_portmon,
 436 #endif /* TCP_PORT_MONITOR */
 437 #ifdef HAVE_ICONV
 438         OBJ_iconv_start,
 439         OBJ_iconv_stop,
 440 #endif /* HAVE_ICONV */
 441 #ifdef HDDTEMP
 442         OBJ_hddtemp,
 443 #endif /* HDDTEMP */
 444         OBJ_include,
 445         OBJ_blink,
 446         OBJ_to_bytes,
 447         OBJ_scroll,
 448         OBJ_combine,
 449         OBJ_entropy_avail,
 450         OBJ_entropy_perc,
 451         OBJ_entropy_poolsize,
 452         OBJ_entropy_bar,
 453 #ifdef APCUPSD
 454         OBJ_apcupsd,
 455         OBJ_apcupsd_name,
 456         OBJ_apcupsd_model,
 457         OBJ_apcupsd_upsmode,
 458         OBJ_apcupsd_cable,
 459         OBJ_apcupsd_status,
 460         OBJ_apcupsd_linev,
 461         OBJ_apcupsd_load,
 462         OBJ_apcupsd_loadbar,
 463         OBJ_apcupsd_loadgauge,
 464 #ifdef X11
 465         OBJ_apcupsd_loadgraph,
 466 #endif /* X11 */
 467         OBJ_apcupsd_charge,
 468         OBJ_apcupsd_timeleft,
 469         OBJ_apcupsd_temp,
 470         OBJ_apcupsd_lastxfer,
 471 #endif /* APCUPSD */
 472 };
 473
 474 struct text_object {
 475         struct text_object *next, *prev;        /* doubly linked list of text objects */
 476         struct text_object *sub;                /* for objects parsing text into objects */
 477         struct text_object *ifblock_next;       /* jump target for ifblock objects */
 478         union {
 479                 void *opaque;           /* new style generic per object data */
 480                 char *s;                /* some string */
 481                 int i;                  /* some integer */
 482                 long l;                 /* some long integer */
 483         } data;
 484
 485         void *special_data;
 486         int type;
 487         long line;
 488 };
 489
 490 /* text object list helpers */
 491 int append_object(struct text_object *root, struct text_object *obj);
 492
 493 /* ifblock helpers
 494  *
 495  * Opaque is a pointer to the address of the ifblock stack's top object.
 496  * Calling clients should pass the address of a defined void pointer which
 497  * was initialised to NULL (empty stack).
 498  * */
 499 int obj_be_ifblock_if(void **opaque, struct text_object *);
 500 int obj_be_ifblock_else(void **opaque, struct text_object *);
 501 int obj_be_ifblock_endif(void **opaque, struct text_object *);
 502 int ifblock_stack_empty(void **opaque);
 503
 504 #endif /* _TEXT_OBJECT_H */