vcs.maemo.org Git - monky/blob - src/conky.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  * vim: ts=4 sw=4 noet ai cindent syntax=c
  29  *
  30  */
  31
  32 #ifndef _conky_h_
  33 #define _conky_h_
  34
  35 #include "config.h"     /* defines */
  36 #include "common.h"     /* at least for struct dns_data */
  37 #include <sys/utsname.h> /* struct uname_s */
  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 #ifdef AUDACIOUS
  67 #include "audacious.h"
  68 #endif
  69
  70 #ifdef BMPX
  71 #include "bmpx.h"
  72 #endif
  73
  74 #ifdef EVE
  75 #include "eve.h"
  76 #endif
  77
  78 #ifdef HDDTEMP
  79 #include "hddtemp.h"
  80 #endif /* HDDTEMP */
  81
  82 #ifdef MOC
  83 #include "moc.h"
  84 #endif
  85
  86 #ifdef MPD
  87 #include "mpd.h"
  88 #endif
  89
  90 #ifdef NVIDIA
  91 #include "nvidia.h"
  92 #endif
  93
  94 #ifdef HAVE_CURL
  95 #include "ccurl_thread.h"
  96 #endif /* HAVE_CURL */
  97
  98 #ifdef RSS
  99 #include "rss.h"
 100 #endif /* RSS */
 101
 102 #ifdef XOAP
 103 #ifndef WEATHER
 104 #error "WEATHER needs to be defined if XOAP is defined"
 105 #endif /* WEATHER */
 106 #endif /* XOAP */
 107
 108 #ifdef WEATHER
 109 #include "weather.h"
 110 #endif /* WEATHER */
 111
 112 #ifdef TCP_PORT_MONITOR
 113 #include "tcp-portmon.h"
 114 #endif
 115
 116 #ifdef XMMS2
 117 #include "xmms2.h"
 118 #endif
 119
 120 #ifdef IBM
 121 #include "ibm.h"
 122 #include "smapi.h"
 123 #endif
 124
 125 #ifdef APCUPSD
 126 #include "apcupsd.h"
 127 #endif
 128
 129 /* sony support */
 130 #include "sony.h"
 131
 132 /* A size for temporary, static buffers to use when
 133  * one doesn't know what to choose. Defaults to 256.  */
 134 extern unsigned int text_buffer_size;
 135
 136 struct entropy_s {
 137         unsigned int entropy_avail;
 138         unsigned int poolsize;
 139 };
 140
 141 struct usr_info {
 142         char *names;
 143         char *times;
 144         char *terms;
 145         int number;
 146 };
 147
 148 struct gateway_info {
 149         char *iface;
 150         char *ip;
 151         int count;
 152 };
 153
 154 #ifdef X11
 155 struct monitor_info {
 156         int number;
 157         int current;
 158 };
 159
 160 struct desktop_info {
 161         int current;
 162         int number;
 163         unsigned int nitems;
 164         char *all_names;
 165         char *name;
 166 };
 167
 168 struct x11_info {
 169         struct monitor_info monitor;
 170         struct desktop_info desktop;
 171 };
 172
 173 int get_stippled_borders(void);
 174
 175 #endif /* X11 */
 176
 177 /* defined in conky.c */
 178 extern long default_fg_color, default_bg_color, default_out_color;
 179 extern long color0, color1, color2, color3, color4, color5, color6, color7,
 180            color8, color9;
 181 void set_current_text_color(long colour);
 182 long get_current_text_color(void);
 183
 184 void set_updatereset(int);
 185 int get_updatereset(void);
 186
 187 struct conftree {
 188         char* string;
 189         struct conftree* horz_next;
 190         struct conftree* vert_next;
 191         struct conftree* back;
 192 };
 193
 194 char load_config_file(const char *);
 195
 196 char *get_global_text(void);
 197 extern long global_text_lines;
 198
 199 //adds newstring to to the tree unless you can already see it when travelling back.
 200 //if it's possible to attach it then it returns a pointer to the leaf, else it returns NULL
 201 struct conftree* conftree_add(struct conftree* previous, const char* newstring);
 202
 203 extern struct conftree *currentconffile;
 204
 205 #define MAX_TEMPLATES 10
 206 char **get_templates(void);
 207
 208 enum {
 209         INFO_CPU = 0,
 210         INFO_MAIL = 1,
 211         INFO_MEM = 2,
 212         INFO_NET = 3,
 213         INFO_PROCS = 4,
 214         INFO_RUN_PROCS = 5,
 215         INFO_UPTIME = 6,
 216         INFO_BUFFERS = 7,
 217         INFO_FS = 8,
 218         INFO_SYSFS = 9,
 219         INFO_MIXER = 10,
 220         INFO_LOADAVG = 11,
 221         INFO_UNAME = 12,
 222         INFO_FREQ = 13,
 223 #ifdef MPD
 224         INFO_MPD = 14,
 225 #endif
 226         INFO_TOP = 15,
 227         INFO_WIFI = 16,
 228         INFO_DISKIO = 17,
 229         INFO_I8K = 18,
 230 #ifdef TCP_PORT_MONITOR
 231         INFO_TCP_PORT_MONITOR = 19,
 232 #endif
 233 #ifdef AUDACIOUS
 234         INFO_AUDACIOUS = 20,
 235 #endif
 236 #ifdef BMPX
 237         INFO_BMPX = 21,
 238 #endif
 239 #ifdef XMMS2
 240         INFO_XMMS2 = 22,
 241 #endif
 242         INFO_ENTROPY = 23,
 243 #ifdef IBM
 244         INFO_SMAPI = 25,
 245 #endif
 246         INFO_USERS = 26,
 247         INFO_GW = 27,
 248 #ifdef NVIDIA
 249         INFO_NVIDIA = 28,
 250 #endif
 251 #ifdef X11
 252         INFO_X11 = 29,
 253 #endif
 254         INFO_DNS = 30,
 255 #ifdef MOC
 256         INFO_MOC = 31,
 257 #endif
 258 #ifdef APCUPSD
 259         INFO_APCUPSD = 32,
 260 #endif
 261 #ifdef WEATHER
 262         INFO_WEATHER = 33,
 263 #endif
 264 };
 265
 266 /* get_battery_stuff() item selector
 267  * needed by conky.c, linux.c and freebsd.c */
 268 enum {
 269         BATTERY_STATUS,
 270         BATTERY_TIME
 271 };
 272
 273 /* if_up strictness selector
 274  * needed by conky.c and linux.c (and potentially others) */
 275 enum {
 276         IFUP_UP,
 277         IFUP_LINK,
 278         IFUP_ADDR
 279 } ifup_strictness;
 280
 281 struct information {
 282         unsigned int mask;
 283
 284         struct utsname uname_s;
 285
 286         char freq[10];
 287
 288         double uptime;
 289
 290         /* memory information in kilobytes */
 291         unsigned long long mem, memeasyfree, memfree, memmax, swap, swapfree, swapmax;
 292         unsigned long long bufmem, buffers, cached;
 293
 294         unsigned short procs;
 295         unsigned short run_procs;
 296
 297         float *cpu_usage;
 298         /* struct cpu_stat cpu_summed; what the hell is this? */
 299         unsigned int cpu_count;
 300         int cpu_avg_samples;
 301
 302         int net_avg_samples;
 303
 304         int diskio_avg_samples;
 305
 306         float loadavg[3];
 307
 308         struct mail_s *mail;
 309         int mail_running;
 310 #ifdef XMMS2
 311         struct xmms2_s xmms2;
 312 #endif
 313 #ifdef AUDACIOUS
 314         AUDACIOUS_S audacious;
 315 #endif
 316 #ifdef BMPX
 317         struct bmpx_s bmpx;
 318 #endif
 319         struct usr_info users;
 320         struct gateway_info gw_info;
 321         struct dns_data nameserver_info;
 322         struct process *cpu[10];
 323         struct process *memu[10];
 324         struct process *time[10];
 325 #ifdef IOSTATS
 326         struct process *io[10];
 327 #endif
 328         struct process *first_process;
 329         unsigned long looped;
 330         struct entropy_s entropy;
 331         double music_player_interval;
 332
 333 #ifdef X11
 334         struct x11_info x11;
 335 #endif
 336
 337 #ifdef APCUPSD
 338         APCUPSD_S apcupsd;
 339 #endif
 340
 341         short kflags;   /* kernel settings, see enum KFLAG */
 342 };
 343
 344 #ifdef HAVE_LUA
 345 #include "llua.h"
 346 #endif /* HAVE_LUA */
 347
 348 /* needed by linux.c and top.c -> outsource somewhere */
 349 enum {
 350         /* set to true if kernel uses "long" format for /proc/stats */
 351         KFLAG_IS_LONGSTAT = 0x01,
 352         /* set to true if kernel shows # of threads for the proc value
 353          * in sysinfo() call */
 354         KFLAG_PROC_IS_THREADS = 0x02
 355         /* bits 0x04, 0x08, 0x10, 0x20, 0x40, 0x80 available for future use */
 356         /* KFLAG_NEXT_ONE = 0x04 */
 357 };
 358 #define KFLAG_SETON(a) info.kflags |= a
 359 #define KFLAG_SETOFF(a) info.kflags &= (~a)
 360 #define KFLAG_FLIP(a) info.kflags ^= a
 361 #define KFLAG_ISSET(a) info.kflags & a
 362
 363 /* defined in conky.c, needed by top.c */
 364 extern int top_cpu, top_mem, top_time;
 365 #ifdef IOSTATS
 366 extern int top_io;
 367 #endif
 368
 369 /* defined in conky.c, needed by top.c */
 370 extern int cpu_separate;
 371
 372 /* struct that has all info to be shared between
 373  * instances of the same text object */
 374 extern struct information info;
 375
 376 /* defined in users.c */
 377 void update_users(void);
 378
 379 /* defined in conky.c */
 380 extern double current_update_time, last_update_time, update_interval;
 381
 382 /* defined in conky.c */
 383 int spaced_print(char *, int, const char *, int, ...)
 384         __attribute__((format(printf, 3, 5)));
 385 extern int inotify_fd;
 386
 387 /* defined in conky.c
 388  * evaluates 'text' and places the result in 'buffer'
 389  */
 390 void evaluate(const char *text, char *buffer);
 391
 392 /* maximum size of config TEXT buffer, i.e. below TEXT line. */
 393 extern unsigned int max_user_text;
 394
 395 /* path to config file */
 396 extern char *current_config;
 397
 398 /* just a wrapper for read_exec() defined in conky.c */
 399 void do_read_exec(const char *data, char *buf, const int size);
 400
 401 #ifdef X11
 402 #define TO_X 1
 403 #endif /* X11 */
 404 #define TO_STDOUT 2
 405 #define TO_STDERR 4
 406 #define OVERWRITE_FILE 8
 407 #define APPEND_FILE 16
 408 #ifdef NCURSES
 409 #define TO_NCURSES 32
 410 #endif /* NCURSES */
 411 enum x_initialiser_state {
 412         NO = 0,
 413         YES = 1,
 414         NEVER = 2
 415 };
 416 extern int output_methods;
 417 extern enum x_initialiser_state x_initialised;
 418
 419 void set_update_interval(double interval);
 420
 421 #define DEFAULT_TEXT_BUFFER_SIZE_S "##DEFAULT_TEXT_BUFFER_SIZE"
 422
 423 #define NOBATTERY 0
 424
 425 /* to get rid of 'unused variable' warnings */
 426 #define UNUSED(a)  (void)a
 427 #define UNUSED_ATTR __attribute__ ((unused))
 428
 429 #endif /* _conky_h_ */