here comes the big header include rewrite
[monky] / src / conky.h
index cccd937..d87ab3c 100644 (file)
-/*
- * Conky, a system monitor, based on torsmo
+/* Conky, a system monitor, based on torsmo
  *
- * This program is licensed under BSD license, read COPYING
+ * Any original torsmo code is licensed under the BSD license
+ *
+ * All code written since the fork of torsmo is licensed under the GPL
+ *
+ * Please see COPYING for details
+ *
+ * Copyright (c) 2004, Hannu Saransaari and Lauri Hakkarainen
+ * Copyright (c) 2005-2008 Brenden Matthews, Philip Kovacs, et. al.
+ *     (see AUTHORS)
+ * All rights reserved.
+ *
+ * This program is free software: you can redistribute it and/or modify
+ * it under the terms of the GNU General Public License as published by
+ * the Free Software Foundation, either version 3 of the License, or
+ * (at your option) any later version.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ * GNU General Public License for more details.
+ * You should have received a copy of the GNU General Public License
+ * along with this program.  If not, see <http://www.gnu.org/licenses/>.
  *
- *  $Id$
  */
 
 #ifndef _conky_h_
 #define _conky_h_
 
+#include "config.h"    /* defines */
+#include "common.h"    /* at least for struct dns_data */
+#include <sys/utsname.h> /* struct uname_s */
+
 #if defined(HAS_MCHECK_H)
 #include <mcheck.h>
 #endif /* HAS_MCHECK_H */
-#include "config.h"
-#include <sys/utsname.h>
-#include <stdio.h>
-#include <stdlib.h>
-#include <string.h>
-#include <locale.h>
-#include <langinfo.h>
-#include <wchar.h>
-#include <sys/param.h>
-#if defined(__FreeBSD__)
-#include <sys/mount.h>
-#include <sys/ucred.h>
-#include <fcntl.h>
-#include <kvm.h>
-#endif /* __FreeBSD__ */
-
-#if defined(__FreeBSD__) && (defined(i386) || defined(__i386__))
-#include <machine/apm_bios.h>
-#endif /* __FreeBSD__ */
-
-#ifdef HAVE_LIBDEXTER
-#include <dexter.h>
-#endif
 
-#ifdef AUDACIOUS
-#include "audacious.h"
-#endif
-
-#ifdef XMMS2
-#include <xmmsclient/xmmsclient.h>
-#endif
+#undef EQUAL
+#undef FALSE
+#undef TRUE
+#define EQUAL 0        //returnvalue of strcmp-variants when strings are equal
+#define FALSE 0
+#define TRUE 1
 
-#include "timed_thread.h"
 
-#define TOP_CPU 1
-#define TOP_NAME 2
-#define TOP_PID 3
-#define TOP_MEM 4
-
-#define TEXT_BUFFER_SIZE 1280
-#define P_MAX_SIZE ((TEXT_BUFFER_SIZE * 4) - 2) 
-
-/* maximum number of special things, e.g. fonts, offsets, aligns, etc. */
-#define MAX_SPECIALS_DEFAULT 512
+#if !defined(__GNUC__)
+#  define __attribute__(x) /* nothing */
+#endif
 
-/* maximum size of config TEXT buffer, i.e. below TEXT line. */
-#define MAX_USER_TEXT_DEFAULT 16384
+#ifndef HAVE_STRNDUP
+// use our own strndup() if it's not available
+char *strndup(const char *s, size_t n);
+#endif /* HAVE_STRNDUP */
 
-#include <sys/socket.h>
+/* headers of optional features
+ * include them here, so we don't need to run the check
+ * in every code file optionally using the feature
+ */
 
-#define ERR(s, varargs...) \
-fprintf(stderr, "Conky: " s "\n", ##varargs)
+#ifdef AUDACIOUS
+#include "audacious.h"
+#endif
 
-/* critical error */
-#define CRIT_ERR(s, varargs...) \
-{ fprintf(stderr, "Conky: " s "\n", ##varargs);  exit(EXIT_FAILURE); }
+#ifdef BMPX
+#include "bmpx.h"
+#endif
 
-struct i8k_struct {
-       char *version;
-       char *bios;
-       char *serial;
-       char *cpu_temp;
-       char *left_fan_status;
-       char *right_fan_status;
-       char *left_fan_rpm;
-       char *right_fan_rpm;
-       char *ac_status;
-       char *buttons_status;
-};
+#ifdef EVE
+#include "eve.h"
+#endif
 
-struct i8k_struct i8k;
-
-struct net_stat {
-       const char *dev;
-       int up;
-       long long last_read_recv, last_read_trans;
-       long long recv, trans;
-       double recv_speed, trans_speed;
-       struct sockaddr addr;
-       int linkstatus;
-       double net_rec[15], net_trans[15];
-};
+#ifdef HDDTEMP
+#include "hddtemp.h"
+#endif /* HDDTEMP */
 
-unsigned int diskio_value;
-unsigned int diskio_read_value;
-unsigned int diskio_write_value;
+#ifdef MOC
+#include "moc.h"
+#endif
 
-struct fs_stat {
-       char *path;
-       long long size;
-       long long avail;
-       long long free;
-};
+#ifdef MPD
+#include "mpd.h"
+#endif
 
-struct mail_s {                        // for imap and pop3
-       unsigned long unseen;
-       unsigned long messages;
-       unsigned long used;
-       unsigned long quota;
-       unsigned long port;
-       float interval;
-       double last_update;
-       char host[128];
-       char user[128];
-       char pass[128];
-       char command[1024];
-       char folder[128];
-       char secure;
-       timed_thread *p_timed_thread;
-} mail;
-
-/*struct cpu_stat {
-       unsigned int user, nice, system, idle, iowait, irq, softirq;
-       int cpu_avg_samples;
-};*/
+#ifdef NVIDIA
+#include "nvidia.h"
+#endif
 
-#ifdef MPD
-struct mpd_s {
-       char *title;
-       char *artist;
-       char *album;
-       char *status;
-       char *random;
-       char *repeat;
-       char *track;
-       char *name;
-       char *file;
-       int volume;
-       unsigned int port;
-       char host[128];
-       char password[128];
-       float progress;
-       int bitrate;
-       int length;
-       int elapsed;
-};
+#ifdef RSS
+#include "rss.h"
 #endif
 
-#ifdef XMMS2
-struct xmms2_s {
-    char* artist;
-    char* album;
-    char* title;
-    char* genre;
-    char* comment;
-    char* decoder;
-    char* transport;
-    char* url;
-    char* date;
-    int tracknr;
-    int bitrate;
-    unsigned int id;
-    int duration;
-    int elapsed;
-    float size;
-
-    float progress;
-    char* status;
-};
+#ifdef SMAPI
+#include "smapi.h"
 #endif
 
-#ifdef AUDACIOUS
-struct audacious_s {
-       audacious_t items;              /* e.g. items[AUDACIOUS_STATUS] */
-       int max_title_len;              /* e.g. ${audacious_title 50} */
-       timed_thread *p_timed_thread;
-};
+#ifdef TCP_PORT_MONITOR
+#include "tcp-portmon.h"
 #endif
 
-#ifdef BMPX
-void update_bmpx();
-struct bmpx_s {
-       char *title;
-       char *artist;
-       char *album;
-       char *uri;
-       int bitrate;
-       int track;
-};
+#ifdef XMMS2
+#include "xmms2.h"
 #endif
 
-void update_entropy();
+/* A size for temporary, static buffers to use when
+ * one doesn't know what to choose. Defaults to 256.  */
+extern unsigned int text_buffer_size;
+
 struct entropy_s {
        unsigned int entropy_avail;
        unsigned int poolsize;
 };
 
-#ifdef TCP_PORT_MONITOR
-#include "libtcp-portmon.h"
-#define MAX_PORT_MONITOR_CONNECTIONS_DEFAULT 256
-#endif
-
-#ifdef HAVE_LIBDEXTER
-/* main start/stop for libdexter */
-void dexter_library_init (void);
-void dexter_library_exit (void);
-
-/* os-specific init/exit for libdexter client activity */
-int dexter_client_init (void);
-int dexter_client_exit (void);
-
-/* dexter channel events, i.e. we want to know if channel closes */
-void dexter_channel_events (DexterChannel *, gint);
+struct usr_info {
+       char *names;
+       char *times;
+       char *terms;
+       int number;
+};
 
-/* info struct for libdexter */
-struct dexter_s {
-  DexterChannel       *channel;
-  DexterServer        *server;
-  DexterServiceBroker *broker;
+struct gateway_info {
+       char *iface;
+       char *ip;
+       int count;
 };
 
-/* public config items for libdexter */
-int dexter_client;
-int dexter_server;
+#ifdef X11
+struct monitor_info {
+       int number;
+       int current;
+};
 
-/* data packet arrival time */
-struct timespec packet_arrival_time;
-GMutex *packet_mutex;
-GCond  *packet_cond;
+struct x11_info {
+       struct monitor_info monitor;
+};
 #endif
 
 enum {
@@ -243,7 +145,7 @@ enum {
        INFO_UPTIME = 6,
        INFO_BUFFERS = 7,
        INFO_FS = 8,
-       INFO_I2C = 9,
+       INFO_SYSFS = 9,
        INFO_MIXER = 10,
        INFO_LOADAVG = 11,
        INFO_UNAME = 12,
@@ -256,7 +158,7 @@ enum {
        INFO_DISKIO = 17,
        INFO_I8K = 18,
 #ifdef TCP_PORT_MONITOR
-        INFO_TCP_PORT_MONITOR = 19,
+       INFO_TCP_PORT_MONITOR = 19,
 #endif
 #ifdef AUDACIOUS
        INFO_AUDACIOUS = 20,
@@ -268,23 +170,40 @@ enum {
        INFO_XMMS2 = 22,
 #endif
        INFO_ENTROPY = 23,
+#ifdef RSS
+       INFO_RSS = 24,
+#endif
+#ifdef SMAPI
+       INFO_SMAPI = 25,
+#endif
+       INFO_USERS = 26,
+       INFO_GW = 27,
+#ifdef NVIDIA
+       INFO_NVIDIA = 28,
+#endif
+#ifdef X11
+       INFO_X11 = 29,
+#endif
+       INFO_DNS = 30,
+#ifdef MOC
+  INFO_MOC = 31
+#endif
 };
 
-
-/* get_battery_stuff() item selector */
+/* get_battery_stuff() item selector
+ * needed by conky.c, linux.c and freebsd.c */
 enum {
        BATTERY_STATUS,
        BATTERY_TIME
 };
 
-#ifdef MPD
-#include "libmpdclient.h"
-#endif
-
-/* Update interval */
-double update_interval;
-
-volatile int g_signal_pending;
+/* if_up strictness selector
+ * needed by conky.c and linux.c (and potentially others) */
+enum {
+       IFUP_UP,
+       IFUP_LINK,
+       IFUP_ADDR
+} ifup_strictness;
 
 struct information {
        unsigned int mask;
@@ -296,14 +215,14 @@ struct information {
        double uptime;
 
        /* memory information in kilobytes */
-       unsigned long long mem, memmax, swap, swapmax;
+       unsigned long long mem, memeasyfree, memfree, memmax, swap, swapmax;
        unsigned long long bufmem, buffers, cached;
 
        unsigned short procs;
        unsigned short run_procs;
 
        float *cpu_usage;
-       /*      struct cpu_stat cpu_summed; what the hell is this? */
+       /* struct cpu_stat cpu_summed; what the hell is this? */
        unsigned int cpu_count;
        unsigned int cpu_avg_samples;
 
@@ -311,293 +230,79 @@ struct information {
 
        float loadavg[3];
 
-       int new_mail_count, mail_count;
-       struct mail_s* mail;
+       struct mail_s *mail;
        int mail_running;
 #ifdef MPD
        struct mpd_s mpd;
-       mpd_Connection *conn;
+#endif
+#ifdef MOC
+  struct moc_s moc;
 #endif
 #ifdef XMMS2
        struct xmms2_s xmms2;
        int xmms2_conn_state;
-       xmms_socket_t xmms2_fd; 
+       xmms_socket_t xmms2_fd;
        fd_set xmms2_fdset;
        xmmsc_connection_t *xmms2_conn;
 #endif
 #ifdef AUDACIOUS
-       struct audacious_s audacious;
+       AUDACIOUS_S audacious;
 #endif
 #ifdef BMPX
        struct bmpx_s bmpx;
 #endif
+       struct usr_info users;
+       struct gateway_info gw_info;
+       struct dns_data nameserver_info;
        struct process *cpu[10];
        struct process *memu[10];
        struct process *first_process;
        unsigned long looped;
-#ifdef TCP_PORT_MONITOR
-  tcp_port_monitor_collection_t * p_tcp_port_monitor_collection;
-#endif
-#ifdef HAVE_LIBDEXTER
-  struct dexter_s dexter;
-#endif
-       short kflags;  /* kernel settings, see enum KFLAG */
        struct entropy_s entropy;
-};
-
-enum {
-       KFLAG_IS_LONGSTAT = 0x01,         /* set to true if kernel uses "long" format for /proc/stats */
-       KFLAG_PROC_IS_THREADS=0x02       /* set to true if kernel shows # of threads for the proc value in sysinfo() call */
-/*     KFLAG_NEXT_ONE=0x04                 bits 0x04, 0x08, 0x10, 0x20, 0x40, 0x80 available for future use */
-     };        
-
-#define KFLAG_SETON(a) info.kflags |= a 
-#define KFLAG_SETOFF(a) info.kflags &= (~a)
-#define KFLAG_FLIP(a) info.kflags ^= a
-#define KFLAG_ISSET(a) info.kflags & a
-
-
-int out_to_console;
-
-int top_cpu;
-int top_mem;
-
-int use_spacer;
-
-char tmpstring1[TEXT_BUFFER_SIZE];
-char tmpstring2[TEXT_BUFFER_SIZE];
+       double music_player_interval;
 
 #ifdef X11
-/* in x11.c */
-
-#include <X11/Xlib.h>
-#include <X11/Xlib.h>
-#include <X11/Xatom.h>
-
-#ifdef XFT
-#include <X11/Xft/Xft.h>
-#endif
-
-#ifdef HAVE_XDBE
-#include <X11/extensions/Xdbe.h>
+       struct x11_info x11;
 #endif
 
-#define ATOM(a) XInternAtom(display, #a, False)
+       short kflags;   /* kernel settings, see enum KFLAG */
 
-#ifdef OWN_WINDOW
-enum _window_type {
-        TYPE_NORMAL = 0,
-        TYPE_DESKTOP,
-       TYPE_OVERRIDE
+       unsigned int diskio_value;
+       unsigned int diskio_read_value;
+       unsigned int diskio_write_value;
 };
 
-enum _window_hints {
-       HINT_UNDECORATED = 0,
-       HINT_BELOW,
-       HINT_ABOVE,
-       HINT_STICKY,
-       HINT_SKIP_TASKBAR,
-       HINT_SKIP_PAGER
-};
-#define SET_HINT(mask,hint)    (mask |= (1<<hint))
-#define TEST_HINT(mask,hint)   (mask & (1<<hint))
-#endif
-struct conky_window {
-       Window root,window,desktop;
-       Drawable drawable;
-       GC gc;
-#ifdef HAVE_XDBE
-       XdbeBackBuffer back_buffer;
-#endif
-#ifdef XFT
-       XftDraw *xftdraw;
-#endif
-
-       int width;
-       int height;
-#ifdef OWN_WINDOW
-       char class_name[256];
-  char title[256];
-       int x;
-       int y;
-       unsigned int type;
-       unsigned long hints;
-#endif
+/* needed by linux.c and top.c -> outsource somewhere */
+enum {
+       /* set to true if kernel uses "long" format for /proc/stats */
+       KFLAG_IS_LONGSTAT = 0x01,
+       /* set to true if kernel shows # of threads for the proc value
+        * in sysinfo() call */
+       KFLAG_PROC_IS_THREADS = 0x02
+       /* bits 0x04, 0x08, 0x10, 0x20, 0x40, 0x80 available for future use */
+       /* KFLAG_NEXT_ONE = 0x04 */
 };
+#define KFLAG_SETON(a) info.kflags |= a
+#define KFLAG_SETOFF(a) info.kflags &= (~a)
+#define KFLAG_FLIP(a) info.kflags ^= a
+#define KFLAG_ISSET(a) info.kflags & a
 
-#ifdef HAVE_XDBE
-extern int use_xdbe;
-#endif
-
-
-#ifdef XFT
-extern int use_xft;
-#endif
-
-extern Display *display;
-extern int display_width;
-extern int display_height;
-extern int screen;
-
-extern int workarea[4];
-
-extern struct conky_window window;
-
-void init_X11();
-void init_window(int use_own_window, int width, int height, int set_trans, int back_colour, 
-                 char **argv, int argc);
-void create_gc();
-void set_transparent_background(Window win);
-long get_x11_color(const char *);
-
-#endif /* X11 */
-
-/* in common.c */
-
-/* struct that has all info */
-struct information info;
-
-void signal_handler(int);
-void reload_config(void);
-void clean_up(void);
+/* defined in conky.c, needed by top.c */
+extern int top_cpu, top_mem;
 
-void update_uname();
-double get_time(void);
-FILE *open_file(const char *file, int *reported);
-void variable_substitute(const char *s, char *dest, unsigned int n);
-void format_seconds(char *buf, unsigned int n, long t);
-void format_seconds_short(char *buf, unsigned int n, long t);
-struct net_stat *get_net_stat(const char *dev);
-void clear_net_stats(void);
+enum spacer_opts { NO_SPACER = 0, LEFT_SPACER, RIGHT_SPACER };
 
-void update_stuff();
+/* defined in conky.c, needed by top.c */
+extern int cpu_separate;
 
-int round_to_int(float f);
+/* struct that has all info to be shared between
+ * instances of the same text object */
+extern struct information info;
 
-#define SET_NEED(a) need_mask |= 1 << (a)
-extern unsigned long long need_mask;
+/* defined in users.c */
+void update_users(void);
 
+/* defined in conky.c */
 extern double current_update_time, last_update_time;
 
-extern int no_buffers;
-
-/* system dependant (in linux.c) */
-
-void update_diskio(void);
-void prepare_update(void);
-void update_uptime(void);
-void update_meminfo(void);
-void update_net_stats(void);
-void update_wifi_stats(void);
-void update_cpu_usage(void);
-void update_total_processes(void);
-void update_running_processes(void);
-void update_i8k(void);
-char get_freq( char *, size_t, char *, int, unsigned int ); 
-void get_freq_dynamic( char *, size_t, char *, int ); 
-char get_voltage(char *, size_t, char *, int, unsigned int ); /* ptarjan */
-void update_load_average();
-int open_i2c_sensor(const char *dev, const char *type, int n, int *div,
-                   char *devtype);
-double get_i2c_info(int *fd, int arg, char *devtype, char *type);
-
-void get_adt746x_cpu( char *, size_t ); 
-void get_adt746x_fan( char *, size_t ); 
-unsigned int get_diskio(void);
-
-int open_acpi_temperature(const char *name);
-double get_acpi_temperature(int fd);
-void get_acpi_ac_adapter( char *, size_t ); 
-void get_acpi_fan( char *, size_t ); 
-void get_battery_stuff(char *buf, unsigned int n, const char *bat, int item);
-void get_ibm_acpi_fan(char *buf, size_t client_buffer_size);
-void get_ibm_acpi_temps(void);
-void get_ibm_acpi_volume(char *buf, size_t client_buffer_size);
-void get_ibm_acpi_brightness(char *buf, size_t client_buffer_size);
-void get_cpu_count();
-
-struct ibm_acpi_struct {
-    unsigned int temps[8];
-};
-
-struct ibm_acpi_struct ibm_acpi;
-
-enum { PB_BATT_STATUS, PB_BATT_PERCENT, PB_BATT_TIME};
-void get_powerbook_batt_info(char*, size_t, int);
-
-struct process {
-       struct process *next;
-       struct process *previous;
-
-       pid_t pid;
-       char *name;
-       float amount;
-       unsigned long user_time;
-       unsigned long total;
-       unsigned long kernel_time;
-       unsigned long previous_user_time;
-       unsigned long previous_kernel_time;
-       unsigned int vsize;
-       unsigned int rss;
-       unsigned int time_stamp;
-       unsigned int counted;
-       unsigned int changed;
-       float totalmem;
-};
-
-void update_top();
-void free_all_processes();
-struct process *get_first_process();
-
-/* fs-stuff is possibly system dependant (in fs.c) */
-
-void update_fs_stats(void);
-struct fs_stat *prepare_fs_stat(const char *path);
-void clear_fs_stats(void);
-
-/* in mixer.c */
-
-int mixer_init(const char *);
-int mixer_get_avg(int);
-int mixer_get_left(int);
-int mixer_get_right(int);
-
-/* in mail.c */
-
-extern char *current_mail_spool;
-
-void update_mail_count();
-
-/* in freebsd.c */
-#if defined(__FreeBSD__)
-kvm_t *kd;
 #endif
-
-#if defined(__FreeBSD__) && (defined(i386) || defined(__i386__))
-int apm_getinfo(int fd, apm_info_t aip);
-char *get_apm_adapter(void);
-char *get_apm_battery_life(void);
-char *get_apm_battery_time(void);
-#endif
-
-/* in mpd.c */
-#ifdef MPD
-void update_mpd();
-#endif
-
-/* in xmms2.c */
-#ifdef XMMS2
-void update_xmms2();
-#endif
-
-/* in hddtemp.c */
-#ifdef HDDTEMP
-int scan_hddtemp(const char *arg, char **dev, char **addr, int *port);
-char *get_hddtemp_info(char *dev, char *addr, int port, char *unit);
-#endif /* HDDTEMP */
-
-/* in linux.c */
-
-#endif
-
-