conky/src/x11.c

/*
 * Conky, a system monitor, based on torsmo
 *
 * 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-2007 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$
 */

#include "conky.h"

#ifdef X11
#include <X11/Xlib.h>
#include <X11/Xatom.h>
#include <X11/Xmd.h>
#include <X11/Xutil.h>
#ifdef XFT
#include <X11/Xft/Xft.h>
#endif

#ifdef HAVE_XDBE
int use_xdbe;
#endif

#ifdef XFT
int use_xft = 0;
#endif

/* some basic X11 stuff */
Display *display;
int display_width;
int display_height;
int screen;
static int set_transparent;
static int background_colour;

/* workarea from _NET_WORKAREA, this is where window / text is aligned */
int workarea[4];

/* Window stuff */
struct conky_window window;

/* local prototypes */
static void update_workarea();
static Window find_desktop_window(Window *p_root, Window *p_desktop);
static Window find_subwindow(Window win, int w, int h);

/* X11 initializer */
void init_X11()
{
	if ((display = XOpenDisplay(0)) == NULL)
		CRIT_ERR("can't open display: %s", XDisplayName(0));

	screen = DefaultScreen(display);
	display_width = DisplayWidth(display, screen);
	display_height = DisplayHeight(display, screen);

	update_workarea();
}

static void update_workarea()
{
	Window root = RootWindow(display, screen);
	unsigned long nitems, bytes;
	unsigned char *buf = NULL;
	Atom type;
	int format;

	/* default work area is display */
	workarea[0] = 0;
	workarea[1] = 0;
	workarea[2] = display_width;
	workarea[3] = display_height;

	/* get current desktop */
	if (XGetWindowProperty(display, root, ATOM(_NET_CURRENT_DESKTOP),
			       0, 1, False, XA_CARDINAL, &type, &format,
			       &nitems, &bytes, &buf) == Success
	    && type == XA_CARDINAL && nitems > 0) {

		//Currently unused 
		/*  long desktop = * (long *) buf; */

		XFree(buf);
		buf = 0;

	}

	if (buf) {
		XFree(buf);
		buf = 0;
	}
}

/* Find root window and desktop window.  Return desktop window on success, 
 * and set root and desktop byref return values.  Return 0 on failure. */  
static Window find_desktop_window(Window *p_root, Window *p_desktop)
{
	Atom type;
	int format, i;
	unsigned long nitems, bytes;
	unsigned int n;
	Window root = RootWindow(display, screen);
	Window win = root;
	Window troot, parent, *children;
	unsigned char *buf = NULL;

	if (!p_root || !p_desktop)
	    return(0);

	/* some window managers set __SWM_VROOT to some child of root window */

	XQueryTree(display, root, &troot, &parent, &children, &n);
	for (i = 0; i < (int) n; i++) {
		if (XGetWindowProperty
		    (display, children[i], ATOM(__SWM_VROOT), 0, 1, False,
		     XA_WINDOW, &type, &format, &nitems, &bytes,
		     &buf) == Success && type == XA_WINDOW) {
			win = *(Window *) buf;
			XFree(buf);
			XFree(children);
			fprintf(stderr,
				"Conky: desktop window (%lx) found from __SWM_VROOT property\n", win);
			fflush(stderr);
			*p_root=win;
			*p_desktop=win;
			return win;
		}

		if (buf) {
			XFree(buf);
			buf = 0;
		}
	}
	XFree(children);

	/* get subwindows from root */
	win = find_subwindow(root, -1, -1);

	update_workarea();

	win = find_subwindow(win, workarea[2], workarea[3]);

	if (buf) {
		XFree(buf);
		buf = 0;
	}

	if (win != root)
		fprintf(stderr,
			"Conky: desktop window (%lx) is subwindow of root window (%lx)\n",win,root);
	else
		fprintf(stderr, "Conky: desktop window (%lx) is root window\n",win);

	fflush(stderr);

	*p_root=root;
	*p_desktop=win;

	return win;
}

/* sets background to ParentRelative for the Window and all parents */
inline void set_transparent_background(Window win)
{
	static int colour_set = -1;
	if (set_transparent) {
		Window parent = win;
		unsigned int i;
		for (i = 0; i < 50 && parent != RootWindow(display, screen); i++) {
			Window r, *children;
			unsigned int n;
			
			XSetWindowBackgroundPixmap(display, parent, ParentRelative);
	
			XQueryTree(display, parent, &r, &parent, &children, &n);
			XFree(children);
			}
	} else if (colour_set != background_colour) {
		XSetWindowBackground(display, win, background_colour);
		colour_set = background_colour;
}
	//XClearWindow(display, win); not sure why this was here
}

void init_window(int own_window, int w, int h, int set_trans, int back_colour, 
		             char **argv, int argc)
{
	/* There seems to be some problems with setting transparent background (on
	 * fluxbox this time). It doesn't happen always and I don't know why it
	 * happens but I bet the bug is somewhere here. */
	set_transparent = set_trans;
	background_colour = back_colour;

#ifdef OWN_WINDOW
	if (own_window) {
		
		if ( !find_desktop_window( &window.root, &window.desktop ) )
		     	return;

		if (window.type == TYPE_OVERRIDE) {
	
			/* 
			   An override_redirect True window.  No WM hints or button processing needed. 
			*/
			XSetWindowAttributes attrs = {
				ParentRelative,0L,0,0L,0,0,Always,0L,0L,False,
				StructureNotifyMask|ExposureMask,
				0L,
				True,
				0,0 };

			/* Parent is desktop window (which might be a child of root) */
			window.window = XCreateWindow(display, 
						   window.desktop, 
					      	   window.x, window.y, w, h, 0, 
						   CopyFromParent,
						   InputOutput,
						   CopyFromParent,
						   CWBackPixel|CWOverrideRedirect,
						   &attrs);

			XLowerWindow(display, window.window);	

			fprintf(stderr, "Conky: window type - override\n"); fflush(stderr);

		}

		else { /* window.type != TYPE_OVERRIDE */

			/* 
			   A window managed by the window manager.  Process hints and buttons. 
			*/
			XSetWindowAttributes attrs = {
				ParentRelative,0L,0,0L,0,0,Always,0L,0L,False,
				StructureNotifyMask|ExposureMask|ButtonPressMask|ButtonReleaseMask,
				0L,
				False,
				0,0 };

			XClassHint classHint;
			XWMHints wmHint;
			Atom xa;

			/* Parent is root window so WM can take control */
			window.window = XCreateWindow(display, 
						   window.root, 
					     window.x, window.y, w, h, 0, 
						   CopyFromParent,
						   InputOutput,
						   CopyFromParent,
						   CWBackPixel|CWOverrideRedirect,
						   &attrs);

			classHint.res_name = window.class_name;
			classHint.res_class = classHint.res_name;

			wmHint.flags = InputHint | StateHint;
      /* allow decorated windows to be given input focus by WM */
			wmHint.input = TEST_HINT(window.hints,HINT_UNDECORATED) ? False : True;
			wmHint.initial_state = NormalState;

			XmbSetWMProperties (display, window.window, window.title, NULL, 
					    argv, argc,
					    NULL, &wmHint, &classHint);

			/* Sets an empty WM_PROTOCOLS property */
			XSetWMProtocols(display,window.window,NULL,0);


			/* Set window type */
			if ( (xa = ATOM(_NET_WM_WINDOW_TYPE)) != None ) 
			{
				Atom prop;
				switch(window.type) {
				case TYPE_DESKTOP:
					{
				    	prop = ATOM(_NET_WM_WINDOW_TYPE_DESKTOP);
					fprintf(stderr, "Conky: window type - desktop\n"); fflush(stderr);
					}
					break;				
				case TYPE_NORMAL:
				default:
					{
				    	prop = ATOM(_NET_WM_WINDOW_TYPE_NORMAL);
					fprintf(stderr, "Conky: window type - normal\n"); fflush(stderr);
					}
					break;
				}
				XChangeProperty(display, window.window, xa,
						XA_ATOM, 32,
						PropModeReplace,
						(unsigned char *) &prop, 1);
			}

			/* Set desired hints */
			
			/* Window decorations */
			if (TEST_HINT(window.hints,HINT_UNDECORATED)) {
			    /*fprintf(stderr, "Conky: hint - undecorated\n"); fflush(stderr);*/

			    xa = ATOM(_MOTIF_WM_HINTS);
			    if (xa != None) {
				long prop[5] = { 2, 0, 0, 0, 0 };
				XChangeProperty(display, window.window, xa,
						xa, 32, PropModeReplace,
						(unsigned char *) prop, 5);
			    }
			}

			/* Below other windows */
			if (TEST_HINT(window.hints,HINT_BELOW)) {
			    /*fprintf(stderr, "Conky: hint - below\n"); fflush(stderr); */

         		    xa = ATOM(_WIN_LAYER);
         		    if (xa != None) {
            			long prop = 0;
            			XChangeProperty(display, window.window, xa,
            					XA_CARDINAL, 32,
            					PropModeAppend,
            					(unsigned char *) &prop, 1);
			    }
			
			    xa = ATOM(_NET_WM_STATE);
			    if (xa != None) {
				Atom xa_prop = ATOM(_NET_WM_STATE_BELOW);
				XChangeProperty(display, window.window, xa,
					XA_ATOM, 32,
					PropModeAppend,
					(unsigned char *) &xa_prop,
					1);
			    }
			}

			/* Above other windows */
			if (TEST_HINT(window.hints,HINT_ABOVE)) {
                            /*fprintf(stderr, "Conky: hint - above\n"); fflush(stderr);*/

                            xa = ATOM(_WIN_LAYER);
                            if (xa != None) {
                                long prop = 6;
                                XChangeProperty(display, window.window, xa,
                                                XA_CARDINAL, 32,
                                                PropModeAppend,
                                                (unsigned char *) &prop, 1);
                            }

                            xa = ATOM(_NET_WM_STATE);
                            if (xa != None) {
                                Atom xa_prop = ATOM(_NET_WM_STATE_ABOVE);
                                XChangeProperty(display, window.window, xa,
                                        XA_ATOM, 32,
                                        PropModeAppend,
                                        (unsigned char *) &xa_prop,
                                        1);
                            }
                        }

			/* Sticky */
			if (TEST_HINT(window.hints,HINT_STICKY)) {
                            /*fprintf(stderr, "Conky: hint - sticky\n"); fflush(stderr); */

                            xa = ATOM(_NET_WM_DESKTOP);
                            if (xa != None) {
                                CARD32 xa_prop = 0xFFFFFFFF;
                                XChangeProperty(display, window.window, xa,
                                        XA_CARDINAL, 32,
                                        PropModeAppend,
                                        (unsigned char *) &xa_prop,
                                        1);
                            }

			    xa = ATOM(_NET_WM_STATE);
                            if (xa != None) {
                                Atom xa_prop = ATOM(_NET_WM_STATE_STICKY);
                                XChangeProperty(display, window.window, xa,
                                        XA_ATOM, 32,
                                        PropModeAppend,
                                        (unsigned char *) &xa_prop,
                                        1);
                            }
                        }

			/* Skip taskbar */
                        if (TEST_HINT(window.hints,HINT_SKIP_TASKBAR)) {
                            /*fprintf(stderr, "Conky: hint - skip_taskbar\n"); fflush(stderr);*/

                            xa = ATOM(_NET_WM_STATE);
                            if (xa != None) {
                                Atom xa_prop = ATOM(_NET_WM_STATE_SKIP_TASKBAR);
                                XChangeProperty(display, window.window, xa,
                                        XA_ATOM, 32,
                                        PropModeAppend,
                                        (unsigned char *) &xa_prop,
                                        1);
                            }
                        }

			/* Skip pager */
                        if (TEST_HINT(window.hints,HINT_SKIP_PAGER)) {
                            /*fprintf(stderr, "Conky: hint - skip_pager\n"); fflush(stderr);*/

                            xa = ATOM(_NET_WM_STATE);
                            if (xa != None) {
                                Atom xa_prop = ATOM(_NET_WM_STATE_SKIP_PAGER);
                                XChangeProperty(display, window.window, xa,
                                        XA_ATOM, 32,
                                        PropModeAppend,
                                        (unsigned char *) &xa_prop,
                                        1);
                            }
                        }

		} /* else { window.type != TYPE_OVERRIDE */
			
		fprintf(stderr, "Conky: drawing to created window (%lx)\n", window.window);
		fflush(stderr);

		XMapWindow(display, window.window);

	} else /* if (own_window) { */
#endif
		/* root / desktop window */
	{
		XWindowAttributes attrs;

		if (!window.window)
			window.window = find_desktop_window( &window.root, &window.desktop );

		if (XGetWindowAttributes(display, window.window, &attrs)) {
			window.width = attrs.width;
			window.height = attrs.height;
		}

		fprintf(stderr, "Conky: drawing to desktop window\n");
	}

	/* Drawable is same as window. This may be changed by double buffering. */
	window.drawable = window.window;

#ifdef HAVE_XDBE
	if (use_xdbe) {
		int major, minor;
		if (!XdbeQueryExtension(display, &major, &minor)) {
			use_xdbe = 0;
		} else {
			window.back_buffer =
			    XdbeAllocateBackBufferName(display,
						       window.window,
						       XdbeBackground);
			if (window.back_buffer != None) {
				window.drawable = window.back_buffer;
				fprintf(stderr,
					"Conky: drawing to double buffer\n");
			} else
				use_xdbe = 0;
		}
		if (!use_xdbe)
			ERR("failed to set up double buffer");
	}
	if (!use_xdbe)
		fprintf(stderr, "Conky: drawing to single buffer\n");
#endif

	XFlush(display);

	/*set_transparent_background(window.window); must be done after double buffer stuff? */
#ifdef OWN_WINDOW
	/*if (own_window) {
	set_transparent_background(window.window);
		XClearWindow(display, window.window);
}*/
#endif

	XSelectInput(display, window.window, ExposureMask
#ifdef OWN_WINDOW
		     | (own_window
			? (StructureNotifyMask | PropertyChangeMask | 
			   ButtonPressMask | ButtonReleaseMask) : 0)
#endif
	    );
}

static Window find_subwindow(Window win, int w, int h)
{
	unsigned int i, j;
	Window troot, parent, *children;
	unsigned int n;

	/* search subwindows with same size as display or work area */

	for (i = 0; i < 10; i++) {
		XQueryTree(display, win, &troot, &parent, &children, &n);

		for (j = 0; j < n; j++) {
			XWindowAttributes attrs;

			if (XGetWindowAttributes
			    (display, children[j], &attrs)) {
				/* Window must be mapped and same size as display or work space */
				if (attrs.map_state != 0 &&
				    ((attrs.width == display_width
				      && attrs.height == display_height)
				     || (attrs.width == w
					 && attrs.height == h))) {
					win = children[j];
					break;
				}
			}
		}

		XFree(children);
		if (j == n)
			break;
	}

	return win;
}

long get_x11_color(const char *name)
{
	XColor color;
	color.pixel = 0;
	if (!XParseColor
	    (display, DefaultColormap(display, screen), name, &color)) {
		/* lets check if it's a hex colour with the # missing in front
		 * if yes, then do something about it
		 */
		char newname[64];
		newname[0] = '#';
		strncpy(&newname[1], name, 62);
		/* now lets try again */
		if (!XParseColor(display, DefaultColormap(display, screen), &newname[0], &color)) {
			ERR("can't parse X color '%s'", name);
			return 0xFF00FF;
		}
	}
	if (!XAllocColor
	    (display, DefaultColormap(display, screen), &color))
		ERR("can't allocate X color '%s'", name);

	return (long) color.pixel;
}

void create_gc()
{
	XGCValues values;
	values.graphics_exposures = 0;
	values.function = GXcopy;
	window.gc = XCreateGC(display, window.drawable,
			      GCFunction | GCGraphicsExposures, &values);
}

#endif /* X11 */