d0ef9d6fddcc133cbce3d94a1d56ca626f47c8e2
[dana/urxvt.git] / src / rxvttoolkit.h
1 /*----------------------------------------------------------------------*
2  * File:        rxvttoolkit.h - provide toolkit-functionality for rxvt.
3  *----------------------------------------------------------------------*
4  *
5  * All portions of code are copyright by their respective author/s.
6  * Copyright (c) 2003-2006 Marc Lehmann <pcg@goof.com>
7  *
8  * This program is free software; you can redistribute it and/or modify
9  * it under the terms of the GNU General Public License as published by
10  * the Free Software Foundation; either version 2 of the License, or
11  * (at your option) any later version.
12  *
13  * This program is distributed in the hope that it will be useful,
14  * but WITHOUT ANY WARRANTY; without even the implied warranty of
15  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
16  * GNU General Public License for more details.
17  *
18  * You should have received a copy of the GNU General Public License
19  * along with this program; if not, write to the Free Software
20  * Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
21  *----------------------------------------------------------------------*/
22
23 #ifndef RXVT_TOOLKIT_H
24 #define RXVT_TOOLKIT_H
25
26 #include <X11/Xlib.h>
27
28 #if XFT
29 # include <X11/Xft/Xft.h>
30 #endif
31
32 #include "ev_cpp.h"
33
34 #include "rxvtutil.h"
35
36 #include "callback.h"
37
38 // see rxvttoolkit.C:xa_names, which must be kept in sync
39 enum {
40   XA_TEXT,
41   XA_COMPOUND_TEXT,
42   XA_UTF8_STRING,
43   XA_MULTIPLE,
44   XA_TARGETS,
45   XA_TIMESTAMP,
46   XA_VT_SELECTION,
47   XA_INCR,
48   XA_WM_PROTOCOLS,
49   XA_WM_DELETE_WINDOW,
50   XA_CLIPBOARD,
51   XA_AVERAGE_WIDTH,
52   XA_WEIGHT_NAME,
53   XA_SLANT,
54   XA_CHARSET_REGISTRY,
55   XA_CHARSET_ENCODING,
56 #if ENABLE_FRILLS
57   XA_MOTIF_WM_HINTS,
58 #endif
59 #if ENABLE_EWMH
60   XA_NET_WM_PID,
61   XA_NET_WM_NAME,
62   XA_NET_WM_ICON_NAME,
63   XA_NET_WM_PING,
64   XA_NET_WM_ICON,
65   XA_NET_WM_USER_TIME,
66 #endif
67 #if USE_XIM
68   XA_WM_LOCALE_NAME,
69   XA_XIM_SERVERS,
70 #endif
71 #if ENABLE_TRANSPARENCY
72   XA_XROOTPMAP_ID,
73   XA_ESETROOT_PMAP_ID,
74 #endif
75 #if ENABLE_XEMBED
76   XA_XEMBED,
77   XA_XEMBED_INFO,
78 #endif
79 #if !ENABLE_MINIMAL
80   // these are usually allocated by other subsystems, but we do it
81   // here to avoid a server roundtrip.
82   XA_SCREEN_RESOURCES,
83   XA_XDCCC_LINEAR_RGB_CORRECTION,
84   XA_XDCCC_LINEAR_RGB_MATRICES,
85   XA_WM_COLORMAP_WINDOWS,
86   XA_WM_STATE,
87   XA_cursor,
88 # if USE_XIM
89   // various selection targets used by XIM
90   XA_TRANSPORT,
91   XA_LOCALES,
92   XA__XIM_PROTOCOL,
93   XA__XIM_XCONNECT,
94   XA__XIM_MOREDATA,
95 # endif
96 #endif
97   NUM_XA
98 };
99
100 struct rxvt_term;
101 struct rxvt_display;
102
103 struct im_watcher;
104 struct xevent_watcher;
105
106 template<class watcher>
107 struct event_vec : vector<watcher *>
108 {
109   void erase_unordered (unsigned int pos)
110   {
111     watcher *w = (*this)[this->size () - 1];
112     this->pop_back ();
113
114     if (!this->empty ())
115       if (((*this)[pos] = w)) // '=' is correct!
116         w->active = pos + 1;
117   }
118 };
119
120 struct rxvt_watcher
121 {
122   int active; /* 0 == inactive, else index into respective vector */
123
124   bool is_active () { return active; }
125
126   rxvt_watcher () : active (0) { }
127 };
128
129 struct refcounted
130 {
131   int referenced;
132   char *id;
133
134   refcounted (const char *id);
135   bool ref_init () { return false; }
136   void ref_next () { }
137   ~refcounted ();
138 };
139
140 template<class T>
141 struct refcache : vector<T *>
142 {
143   T *get (const char *id);
144   void put (T *obj);
145   void clear ();
146
147   ~refcache ()
148   {
149     clear ();
150   }
151 };
152
153 /////////////////////////////////////////////////////////////////////////////
154
155 struct rxvt_screen;
156
157 struct rxvt_drawable
158 {
159   rxvt_screen *screen;
160   Drawable drawable;
161   operator Drawable() { return drawable; }
162
163 #if XFT
164   XftDraw *xftdrawable;
165   operator XftDraw *();
166 #endif
167
168   rxvt_drawable (rxvt_screen *screen, Drawable drawable)
169   : screen(screen),
170 #if XFT
171     xftdrawable(0),
172 #endif
173     drawable(drawable)
174   { }
175
176 #if XFT
177   ~rxvt_drawable ();
178 #endif
179 };
180
181 /////////////////////////////////////////////////////////////////////////////
182
183 #ifdef USE_XIM
184 struct rxvt_xim : refcounted
185 {
186   void destroy ();
187   rxvt_display *display;
188
189 //public
190   XIM xim;
191
192   rxvt_xim (const char *id) : refcounted (id) { }
193   bool ref_init ();
194   ~rxvt_xim ();
195 };
196 #endif
197
198 struct rxvt_screen
199 {
200   rxvt_display *display;
201   Display *dpy;
202   int depth;
203   Visual *visual;
204   Colormap cmap;
205
206 #if XFT
207   // scratch pixmap
208   rxvt_drawable *scratch_area;
209   int scratch_w, scratch_h;
210
211   rxvt_drawable &scratch_drawable (int w, int h);
212
213   rxvt_screen ();
214 #endif
215
216   void set (rxvt_display *disp);
217   void select_visual (int bitdepth);
218   void clear ();
219 };
220
221 struct rxvt_display : refcounted
222 {
223   event_vec<xevent_watcher> xw;
224
225   ev::prepare flush_ev; void flush_cb (ev::prepare &w, int revents);
226   ev::io      x_ev    ; void x_cb     (ev::io      &w, int revents);
227
228 #ifdef USE_XIM
229   refcache<rxvt_xim> xims;
230   vector<im_watcher *> imw;
231
232   void im_change_cb ();
233   void im_change_check ();
234 #endif
235
236 //public
237   Display   *dpy;
238   int       screen;
239   Window    root;
240   rxvt_term *selection_owner;
241   rxvt_term *clipboard_owner;
242   Atom      xa[NUM_XA];
243   bool      is_local;
244 #ifdef POINTER_BLANK
245   Cursor    blank_cursor;
246 #endif
247
248   rxvt_display (const char *id);
249   XrmDatabase get_resources (bool refresh);
250   bool ref_init ();
251   void ref_next ();
252   ~rxvt_display ();
253
254   void flush ()
255   {
256     flush_ev.start ();
257   }
258
259   Atom atom (const char *name);
260   void set_selection_owner (rxvt_term *owner, bool clipboard);
261
262   void reg (xevent_watcher *w);
263   void unreg (xevent_watcher *w);
264
265 #ifdef USE_XIM
266   void reg (im_watcher *w);
267   void unreg (im_watcher *w);
268
269   rxvt_xim *get_xim (const char *locale, const char *modifiers);
270   void put_xim (rxvt_xim *xim);
271 #endif
272 };
273
274 #ifdef USE_XIM
275 struct im_watcher : rxvt_watcher, callback<void (void)>
276 {
277   void start (rxvt_display *display)
278   {
279     display->reg (this);
280   }
281
282   void stop (rxvt_display *display)
283   {
284     display->unreg (this);
285   }
286 };
287 #endif
288
289 struct xevent_watcher : rxvt_watcher, callback<void (XEvent &)>
290 {
291   Window window;
292
293   void start (rxvt_display *display, Window window)
294   {
295     this->window = window;
296     display->reg (this);
297   }
298
299   void stop (rxvt_display *display)
300   {
301     display->unreg (this);
302   }
303 };
304
305 extern refcache<rxvt_display> displays;
306
307 /////////////////////////////////////////////////////////////////////////////
308
309 typedef unsigned long Pixel;
310
311 struct rgba
312 {
313   unsigned short r, g, b, a;
314
315   enum { MIN_CC = 0x0000, MAX_CC  = 0xffff };
316
317   rgba ()
318   { }
319
320   rgba (unsigned short r, unsigned short g, unsigned short b, unsigned short a = MAX_CC)
321   : r(r), g(g), b(b), a(a)
322   { }
323 };
324
325 struct rxvt_color
326 {
327 #if XFT
328   XftColor c;
329 #else
330   XColor c;
331 #endif
332
333   operator Pixel () const { return c.pixel; }
334
335   bool operator == (const rxvt_color &b) const { return Pixel (*this) == Pixel (b); }
336   bool operator != (const rxvt_color &b) const { return Pixel (*this) != Pixel (b); }
337
338   bool is_opaque () const
339   {
340 #if XFT
341     return c.color.alpha == rgba::MAX_CC;
342 #else
343     return 1;
344 #endif
345   }
346
347   bool alloc (rxvt_screen *screen, const rgba &color);
348   void free (rxvt_screen *screen);
349
350   void get (rgba &color);
351   void get (XColor &color);
352
353   bool set (rxvt_screen *screen, const char *name);
354   bool set (rxvt_screen *screen, const rgba &color);
355
356   void fade (rxvt_screen *screen, int percent, rxvt_color &result, const rgba &to = rgba (0, 0, 0));
357 };
358
359 #if TRACE_PIXMAPS
360 Pixmap trace_XCreatePixmap (const char *file, int line, Display *dpy, Window r, unsigned int w, unsigned int h, unsigned int d);
361 void trace_XFreePixmap (const char *file, int line, Display *dpy, Pixmap p);
362
363 # define XCreatePixmap(dpy,r,w,h,d) trace_XCreatePixmap (__FILE__,__LINE__,dpy,r,w,h,d)
364 # define XFreePixmap(dpy,p) trace_XFreePixmap (__FILE__,__LINE__,dpy,p)
365 #endif
366
367 #endif
368