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