| 1 | /*****************************************************************************/ |
| 2 | /** Copyright 1991 by Andreas Stolcke **/ |
| 3 | /** Copyright 1990 by Solbourne Computer Inc. **/ |
| 4 | /** Longmont, Colorado **/ |
| 5 | /** **/ |
| 6 | /** All Rights Reserved **/ |
| 7 | /** **/ |
| 8 | /** Permission to use, copy, modify, and distribute this software and **/ |
| 9 | /** its documentation for any purpose and without fee is hereby **/ |
| 10 | /** granted, provided that the above copyright notice appear in all **/ |
| 11 | /** copies and that both that copyright notice and this permis- **/ |
| 12 | /** sion notice appear in supporting documentation, and that the **/ |
| 13 | /** name of Solbourne not be used in advertising **/ |
| 14 | /** in publicity pertaining to distribution of the software without **/ |
| 15 | /** specific, written prior permission. **/ |
| 16 | /** **/ |
| 17 | /** ANDREAS STOLCKE AND SOLBOURNE COMPUTER INC. DISCLAIMS ALL WARRANTIES **/ |
| 18 | /** WITH REGARD TO THIS SOFTWARE, INCLUDING ALL IMPLIED WARRANTIES OF **/ |
| 19 | /** MERCHANTABILITY AND FITNESS, IN NO EVENT SHALL ANDREAS STOLCKE **/ |
| 20 | /** OR SOLBOURNE BE LIABLE FOR ANY SPECIAL, INDIRECT OR CONSEQUENTIAL **/ |
| 21 | /** DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE, DATA **/ |
| 22 | /** OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER **/ |
| 23 | /** TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE **/ |
| 24 | /** OR PERFORMANCE OF THIS SOFTWARE. **/ |
| 25 | /*****************************************************************************/ |
| 26 | /* |
| 27 | * vroot.h -- Virtual Root Window handling header file |
| 28 | * |
| 29 | * This header file redefines the X11 macros RootWindow and DefaultRootWindow, |
| 30 | * making them look for a virtual root window as provided by certain `virtual' |
| 31 | * window managers like swm and tvtwm. If none is found, the ordinary root |
| 32 | * window is returned, thus retaining backward compatibility with standard |
| 33 | * window managers. |
| 34 | * The function implementing the virtual root lookup remembers the result of |
| 35 | * its last invocation to avoid overhead in the case of repeated calls |
| 36 | * on the same display and screen arguments. |
| 37 | * The lookup code itself is taken from Tom LaStrange's ssetroot program. |
| 38 | * |
| 39 | * Most simple root window changing X programs can be converted to using |
| 40 | * virtual roots by just including |
| 41 | * |
| 42 | * #include <X11/vroot.h> |
| 43 | * |
| 44 | * after all the X11 header files. It has been tested on such popular |
| 45 | * X clients as xphoon, xfroot, xloadimage, and xaqua. |
| 46 | * It also works with the core clients xprop, xwininfo, xwd, and editres |
| 47 | * (and is necessary to get those clients working under tvtwm). |
| 48 | * It does NOT work with xsetroot; get the xsetroot replacement included in |
| 49 | * the tvtwm distribution instead. |
| 50 | * |
| 51 | * Andreas Stolcke <stolcke@ICSI.Berkeley.EDU>, 9/7/90 |
| 52 | * - replaced all NULL's with properly cast 0's, 5/6/91 |
| 53 | * - free children list (suggested by Mark Martin <mmm@cetia.fr>), 5/16/91 |
| 54 | * - include X11/Xlib.h and support RootWindowOfScreen, too 9/17/91 |
| 55 | * |
| 56 | * Jamie Zawinski <jwz@jwz.org>, 28-Apr-1997 |
| 57 | * - use ANSI C |
| 58 | * |
| 59 | * Jamie Zawinski <jwz@jwz.org>, 3-Sep-2003 |
| 60 | * - if the environment variable "XSCREENSAVER_WINDOW" is set, use that |
| 61 | * as the root window instead of searching for __SWM_VROOT. |
| 62 | */ |
| 63 | |
| 64 | #ifndef _VROOT_H_ |
| 65 | #define _VROOT_H_ |
| 66 | #define _XSCREENSAVER_VROOT_H_ |
| 67 | |
| 68 | #if !defined(lint) && !defined(SABER) |
| 69 | static const char vroot_rcsid[] = |
| 70 | "#Id: vroot.h,v 1.5 2003/09/04 01:04:38 jwz Exp #" "\n" |
| 71 | "#Id: vroot.h,v 1.4 1991/09/30 19:23:16 stolcke Exp stolcke #"; |
| 72 | #endif |
| 73 | |
| 74 | #include <X11/X.h> |
| 75 | #include <X11/Xatom.h> |
| 76 | #include <X11/Xlib.h> |
| 77 | |
| 78 | static Window |
| 79 | #ifdef __STDC__ /* ANSIfication added by jwz, to avoid superfluous warnings. */ |
| 80 | VirtualRootWindowOfScreen(Screen * screen) |
| 81 | #else /* !__STDC__ */ |
| 82 | VirtualRootWindowOfScreen(screen) |
| 83 | Screen *screen; |
| 84 | #endif /* !__STDC__ */ |
| 85 | { |
| 86 | static Screen *save_screen = (Screen *) 0; |
| 87 | static Window root = (Window) 0; |
| 88 | |
| 89 | if (screen != save_screen) { |
| 90 | Display *dpy = DisplayOfScreen(screen); |
| 91 | Atom __SWM_VROOT = None; |
| 92 | int i; |
| 93 | Window rootReturn, parentReturn, *children; |
| 94 | unsigned int numChildren; |
| 95 | |
| 96 | /* first check for a hex or decimal window ID in the environment */ |
| 97 | const char *xss_id = getenv("XSCREENSAVER_WINDOW"); |
| 98 | if (xss_id && *xss_id) { |
| 99 | unsigned long id = 0; |
| 100 | char c; |
| 101 | if (1 == sscanf(xss_id, " 0x%lx %c", &id, &c) || |
| 102 | 1 == sscanf(xss_id, " %lu %c", &id, &c)) { |
| 103 | root = (Window) id; |
| 104 | save_screen = screen; |
| 105 | return root; |
| 106 | } |
| 107 | } |
| 108 | |
| 109 | root = RootWindowOfScreen(screen); |
| 110 | |
| 111 | /* go look for a virtual root */ |
| 112 | __SWM_VROOT = XInternAtom(dpy, "__SWM_VROOT", False); |
| 113 | if (XQueryTree(dpy, root, &rootReturn, &parentReturn, &children, &numChildren)) { |
| 114 | for (i = 0; i < numChildren; i++) { |
| 115 | Atom actual_type; |
| 116 | int actual_format; |
| 117 | unsigned long nitems, bytesafter; |
| 118 | Window *newRoot = (Window *) 0; |
| 119 | |
| 120 | if (XGetWindowProperty(dpy, children[i], |
| 121 | __SWM_VROOT, 0, 1, False, XA_WINDOW, |
| 122 | &actual_type, &actual_format, |
| 123 | &nitems, &bytesafter, |
| 124 | (unsigned char **) &newRoot) == Success && newRoot) { |
| 125 | root = *newRoot; |
| 126 | break; |
| 127 | } |
| 128 | } |
| 129 | if (children) |
| 130 | XFree((char *) children); |
| 131 | } |
| 132 | |
| 133 | save_screen = screen; |
| 134 | } |
| 135 | |
| 136 | return root; |
| 137 | } |
| 138 | |
| 139 | #undef RootWindowOfScreen |
| 140 | #define RootWindowOfScreen(s) VirtualRootWindowOfScreen(s) |
| 141 | |
| 142 | #undef RootWindow |
| 143 | #define RootWindow(dpy,screen) VirtualRootWindowOfScreen(ScreenOfDisplay(dpy,screen)) |
| 144 | |
| 145 | #undef DefaultRootWindow |
| 146 | #define DefaultRootWindow(dpy) VirtualRootWindowOfScreen(DefaultScreenOfDisplay(dpy)) |
| 147 | |
| 148 | #endif /* _VROOT_H_ */ |