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 "rxvtlib.h"
  35 #include "rxvtutil.h"
  36
  37 #include "callback.h"
  38
  39 // see rxvttoolkit.C:xa_names, which must be kept in sync
  40 enum {
  41   XA_TEXT,
  42   XA_COMPOUND_TEXT,
  43   XA_UTF8_STRING,
  44   XA_MULTIPLE,
  45   XA_TARGETS,
  46   XA_TIMESTAMP,
  47   XA_VT_SELECTION,
  48   XA_INCR,
  49   XA_WM_PROTOCOLS,
  50   XA_WM_DELETE_WINDOW,
  51   XA_CLIPBOARD,
  52   XA_AVERAGE_WIDTH,
  53   XA_WEIGHT_NAME,
  54   XA_SLANT,
  55   XA_CHARSET_REGISTRY,
  56   XA_CHARSET_ENCODING,
  57 #if ENABLE_FRILLS
  58   XA_MOTIF_WM_HINTS,
  59 #endif
  60 #if ENABLE_EWMH
  61   XA_NET_WM_PID,
  62   XA_NET_WM_NAME,
  63   XA_NET_WM_ICON_NAME,
  64   XA_NET_WM_PING,
  65 #endif
  66 #if USE_XIM
  67   XA_WM_LOCALE_NAME,
  68   XA_XIM_SERVERS,
  69 #endif
  70 #if ENABLE_TRANSPARENCY
  71   XA_XROOTPMAP_ID,
  72   XA_ESETROOT_PMAP_ID,
  73 #endif
  74 #if ENABLE_XEMBED
  75   XA_XEMBED,
  76   XA_XEMBED_INFO,
  77 #endif
  78 #if !ENABLE_MINIMAL
  79   // these are usually allocated by other subsystens, but we do it
  80   // here to avoid a server roundtrip.
  81   XA_SCREEN_RESOURCES,
  82   XA_XDCCC_LINEAR_RGB_CORRECTION,
  83   XA_XDCCC_LINEAR_RGB_MATRICES,
  84   XA_WM_COLORMAP_WINDOWS,
  85   XA_WM_STATE,
  86   XA_cursor,
  87 # if USE_XIM
  88   // various selection targets used by XIM
  89   XA_TRANSPORT,
  90   XA_LOCALES,
  91   XA__XIM_PROTOCOL,
  92   XA__XIM_XCONNECT,
  93   XA__XIM_MOREDATA,
  94 # endif
  95 #endif
  96   NUM_XA
  97 };
  98
  99 struct rxvt_term;
 100 struct rxvt_display;
 101
 102 struct im_watcher;
 103 struct xevent_watcher;
 104
 105 template<class watcher>
 106 struct event_vec : vector<watcher *>
 107 {
 108   void erase_unordered (unsigned int pos)
 109   {
 110     watcher *w = (*this)[this->size () - 1];
 111     this->pop_back ();
 112
 113     if (!this->empty ())
 114       if (((*this)[pos] = w)) // '=' is correct!
 115         w->active = pos + 1;
 116   }
 117 };
 118
 119 struct rxvt_watcher
 120 {
 121   int active; /* 0 == inactive, else index into respective vector */
 122
 123   bool is_active () { return active; }
 124
 125   rxvt_watcher () : active (0) { }
 126 };
 127
 128 struct refcounted
 129 {
 130   int referenced;
 131   char *id;
 132
 133   refcounted (const char *id);
 134   bool ref_init () { return false; }
 135   void ref_next () { }
 136   ~refcounted ();
 137 };
 138
 139 template<class T>
 140 struct refcache : vector<T *>
 141 {
 142   T *get (const char *id);
 143   void put (T *obj);
 144   void clear ();
 145
 146   ~refcache ()
 147   {
 148     clear ();
 149   }
 150 };
 151
 152 /////////////////////////////////////////////////////////////////////////////
 153
 154 struct rxvt_screen;
 155
 156 struct rxvt_drawable
 157 {
 158   rxvt_screen *screen;
 159   Drawable drawable;
 160   operator Drawable() { return drawable; }
 161
 162 #if XFT
 163   XftDraw *xftdrawable;
 164   operator XftDraw *();
 165 #endif
 166
 167   rxvt_drawable (rxvt_screen *screen, Drawable drawable)
 168   : screen(screen),
 169 #if XFT
 170     xftdrawable(0),
 171 #endif
 172     drawable(drawable)
 173   { }
 174
 175 #if XFT
 176   ~rxvt_drawable ();
 177 #endif
 178 };
 179
 180 /////////////////////////////////////////////////////////////////////////////
 181
 182 #ifdef USE_XIM
 183 struct rxvt_xim : refcounted
 184 {
 185   void destroy ();
 186   rxvt_display *display;
 187
 188 //public
 189   XIM xim;
 190
 191   rxvt_xim (const char *id) : refcounted (id) { }
 192   bool ref_init ();
 193   ~rxvt_xim ();
 194 };
 195 #endif
 196
 197 struct rxvt_screen
 198 {
 199   rxvt_display *display;
 200   Display *dpy;
 201   int depth;
 202   Visual *visual;
 203   Colormap cmap;
 204
 205 #if XFT
 206   // scratch pixmap
 207   rxvt_drawable *scratch_area;
 208   int scratch_w, scratch_h;
 209
 210   rxvt_drawable &scratch_drawable (int w, int h);
 211
 212   rxvt_screen ();
 213 #endif
 214
 215   void set (rxvt_display *disp);
 216   void select_visual (int bitdepth);
 217   void clear ();
 218 };
 219
 220 struct rxvt_display : refcounted
 221 {
 222   event_vec<xevent_watcher> xw;
 223
 224   ev::io x_ev; void x_cb (ev::io &w, int revents);
 225
 226 #ifdef USE_XIM
 227   refcache<rxvt_xim> xims;
 228   vector<im_watcher *> imw;
 229
 230   void im_change_cb ();
 231   void im_change_check ();
 232 #endif
 233
 234 //public
 235   Display   *dpy;
 236   int       screen;
 237   Window    root;
 238   rxvt_term *selection_owner;
 239   Atom      xa[NUM_XA];
 240   bool      is_local;
 241 #ifdef POINTER_BLANK
 242   Cursor    blank_cursor;
 243 #endif
 244
 245   rxvt_display (const char *id);
 246   XrmDatabase get_resources (bool refresh);
 247   bool ref_init ();
 248   void ref_next ();
 249   ~rxvt_display ();
 250
 251   void flush ();
 252   Atom atom (const char *name);
 253   void set_selection_owner (rxvt_term *owner);
 254
 255   void reg (xevent_watcher *w);
 256   void unreg (xevent_watcher *w);
 257
 258 #ifdef USE_XIM
 259   void reg (im_watcher *w);
 260   void unreg (im_watcher *w);
 261
 262   rxvt_xim *get_xim (const char *locale, const char *modifiers);
 263   void put_xim (rxvt_xim *xim);
 264 #endif
 265 };
 266
 267 #ifdef USE_XIM
 268 struct im_watcher : rxvt_watcher, callback<void (void)> {
 269   void start (rxvt_display *display)
 270   {
 271     display->reg (this);
 272   }
 273
 274   void stop (rxvt_display *display)
 275   {
 276     display->unreg (this);
 277   }
 278 };
 279 #endif
 280
 281 struct xevent_watcher : rxvt_watcher, callback<void (XEvent &)>
 282 {
 283   Window window;
 284
 285   void start (rxvt_display *display, Window window)
 286   {
 287     this->window = window;
 288     display->reg (this);
 289   }
 290
 291   void stop (rxvt_display *display)
 292   {
 293     display->unreg (this);
 294   }
 295 };
 296
 297 extern refcache<rxvt_display> displays;
 298
 299 /////////////////////////////////////////////////////////////////////////////
 300
 301 typedef unsigned long Pixel;
 302
 303 struct rgba
 304 {
 305   unsigned short r, g, b, a;
 306
 307   enum { MIN_CC = 0x0000, MAX_CC  = 0xffff };
 308
 309   rgba ()
 310   { }
 311
 312   rgba (unsigned short r, unsigned short g, unsigned short b, unsigned short a = MAX_CC)
 313   : r(r), g(g), b(b), a(a)
 314   { }
 315 };
 316
 317 struct rxvt_color
 318 {
 319 #if XFT
 320   XftColor c;
 321 #else
 322   XColor c;
 323 #endif
 324
 325   operator Pixel () const { return c.pixel; }
 326
 327   bool operator == (const rxvt_color &b) const { return Pixel (*this) == Pixel (b); }
 328   bool operator != (const rxvt_color &b) const { return Pixel (*this) != Pixel (b); }
 329
 330   bool alloc (rxvt_screen *screen, const rgba &color);
 331   void free (rxvt_screen *screen);
 332
 333   void get (rgba &color);
 334   void get (XColor &color);
 335
 336   bool set (rxvt_screen *screen, const char *name);
 337   bool set (rxvt_screen *screen, const rgba &color);
 338
 339   void fade (rxvt_screen *screen, int percent, rxvt_color &result, const rgba &to = rgba (0, 0, 0));
 340 };
 341
 342 #if TRACE_PIXMAPS
 343 Pixmap trace_XCreatePixmap (const char *file, int line, Display *dpy, Window r, unsigned int w, unsigned int h, unsigned int d);
 344 void trace_XFreePixmap (const char *file, int line, Display *dpy, Pixmap p);
 345
 346 # define XCreatePixmap(dpy,r,w,h,d) trace_XCreatePixmap (__FILE__,__LINE__,dpy,r,w,h,d)
 347 # define XFreePixmap(dpy,p) trace_XFreePixmap (__FILE__,__LINE__,dpy,p)
 348 #endif
 349
 350 #endif
 351