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 #endif
  65 #if USE_XIM
  66   XA_WM_LOCALE_NAME,
  67   XA_XIM_SERVERS,
  68 #endif
  69 #if ENABLE_TRANSPARENCY
  70   XA_XROOTPMAP_ID,
  71   XA_ESETROOT_PMAP_ID,
  72 #endif
  73 #if ENABLE_XEMBED
  74   XA_XEMBED,
  75   XA_XEMBED_INFO,
  76 #endif
  77 #if !ENABLE_MINIMAL
  78   // these are usually allocated by other subsystems, but we do it
  79   // here to avoid a server roundtrip.
  80   XA_SCREEN_RESOURCES,
  81   XA_XDCCC_LINEAR_RGB_CORRECTION,
  82   XA_XDCCC_LINEAR_RGB_MATRICES,
  83   XA_WM_COLORMAP_WINDOWS,
  84   XA_WM_STATE,
  85   XA_cursor,
  86 # if USE_XIM
  87   // various selection targets used by XIM
  88   XA_TRANSPORT,
  89   XA_LOCALES,
  90   XA__XIM_PROTOCOL,
  91   XA__XIM_XCONNECT,
  92   XA__XIM_MOREDATA,
  93 # endif
  94 #endif
  95   NUM_XA
  96 };
  97
  98 struct rxvt_term;
  99 struct rxvt_display;
 100
 101 struct im_watcher;
 102 struct xevent_watcher;
 103
 104 template<class watcher>
 105 struct event_vec : vector<watcher *>
 106 {
 107   void erase_unordered (unsigned int pos)
 108   {
 109     watcher *w = (*this)[this->size () - 1];
 110     this->pop_back ();
 111
 112     if (!this->empty ())
 113       if (((*this)[pos] = w)) // '=' is correct!
 114         w->active = pos + 1;
 115   }
 116 };
 117
 118 struct rxvt_watcher
 119 {
 120   int active; /* 0 == inactive, else index into respective vector */
 121
 122   bool is_active () { return active; }
 123
 124   rxvt_watcher () : active (0) { }
 125 };
 126
 127 struct refcounted
 128 {
 129   int referenced;
 130   char *id;
 131
 132   refcounted (const char *id);
 133   bool ref_init () { return false; }
 134   void ref_next () { }
 135   ~refcounted ();
 136 };
 137
 138 template<class T>
 139 struct refcache : vector<T *>
 140 {
 141   T *get (const char *id);
 142   void put (T *obj);
 143   void clear ();
 144
 145   ~refcache ()
 146   {
 147     clear ();
 148   }
 149 };
 150
 151 /////////////////////////////////////////////////////////////////////////////
 152
 153 struct rxvt_screen;
 154
 155 struct rxvt_drawable
 156 {
 157   rxvt_screen *screen;
 158   Drawable drawable;
 159   operator Drawable() { return drawable; }
 160
 161 #if XFT
 162   XftDraw *xftdrawable;
 163   operator XftDraw *();
 164 #endif
 165
 166   rxvt_drawable (rxvt_screen *screen, Drawable drawable)
 167   : screen(screen),
 168 #if XFT
 169     xftdrawable(0),
 170 #endif
 171     drawable(drawable)
 172   { }
 173
 174 #if XFT
 175   ~rxvt_drawable ();
 176 #endif
 177 };
 178
 179 /////////////////////////////////////////////////////////////////////////////
 180
 181 #ifdef USE_XIM
 182 struct rxvt_xim : refcounted
 183 {
 184   void destroy ();
 185   rxvt_display *display;
 186
 187 //public
 188   XIM xim;
 189
 190   rxvt_xim (const char *id) : refcounted (id) { }
 191   bool ref_init ();
 192   ~rxvt_xim ();
 193 };
 194 #endif
 195
 196 struct rxvt_screen
 197 {
 198   rxvt_display *display;
 199   Display *dpy;
 200   int depth;
 201   Visual *visual;
 202   Colormap cmap;
 203
 204 #if XFT
 205   // scratch pixmap
 206   rxvt_drawable *scratch_area;
 207   int scratch_w, scratch_h;
 208
 209   rxvt_drawable &scratch_drawable (int w, int h);
 210
 211   rxvt_screen ();
 212 #endif
 213
 214   void set (rxvt_display *disp);
 215   void select_visual (int bitdepth);
 216   void clear ();
 217 };
 218
 219 struct rxvt_display : refcounted
 220 {
 221   event_vec<xevent_watcher> xw;
 222
 223   ev::prepare flush_ev; void flush_cb (ev::prepare &w, int revents);
 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   {
 253     flush_ev.start ();
 254   }
 255
 256   Atom atom (const char *name);
 257   void set_selection_owner (rxvt_term *owner);
 258
 259   void reg (xevent_watcher *w);
 260   void unreg (xevent_watcher *w);
 261
 262 #ifdef USE_XIM
 263   void reg (im_watcher *w);
 264   void unreg (im_watcher *w);
 265
 266   rxvt_xim *get_xim (const char *locale, const char *modifiers);
 267   void put_xim (rxvt_xim *xim);
 268 #endif
 269 };
 270
 271 #ifdef USE_XIM
 272 struct im_watcher : rxvt_watcher, callback<void (void)> {
 273   void start (rxvt_display *display)
 274   {
 275     display->reg (this);
 276   }
 277
 278   void stop (rxvt_display *display)
 279   {
 280     display->unreg (this);
 281   }
 282 };
 283 #endif
 284
 285 struct xevent_watcher : rxvt_watcher, callback<void (XEvent &)>
 286 {
 287   Window window;
 288
 289   void start (rxvt_display *display, Window window)
 290   {
 291     this->window = window;
 292     display->reg (this);
 293   }
 294
 295   void stop (rxvt_display *display)
 296   {
 297     display->unreg (this);
 298   }
 299 };
 300
 301 extern refcache<rxvt_display> displays;
 302
 303 /////////////////////////////////////////////////////////////////////////////
 304
 305 typedef unsigned long Pixel;
 306
 307 struct rgba
 308 {
 309   unsigned short r, g, b, a;
 310
 311   enum { MIN_CC = 0x0000, MAX_CC  = 0xffff };
 312
 313   rgba ()
 314   { }
 315
 316   rgba (unsigned short r, unsigned short g, unsigned short b, unsigned short a = MAX_CC)
 317   : r(r), g(g), b(b), a(a)
 318   { }
 319 };
 320
 321 struct rxvt_color
 322 {
 323 #if XFT
 324   XftColor c;
 325 #else
 326   XColor c;
 327 #endif
 328
 329   operator Pixel () const { return c.pixel; }
 330
 331   bool operator == (const rxvt_color &b) const { return Pixel (*this) == Pixel (b); }
 332   bool operator != (const rxvt_color &b) const { return Pixel (*this) != Pixel (b); }
 333
 334   bool is_opaque () const
 335   {
 336 #if XFT
 337     return c.color.alpha == rgba::MAX_CC;
 338 #else
 339     return 1;
 340 #endif
 341   }
 342
 343   bool alloc (rxvt_screen *screen, const rgba &color);
 344   void free (rxvt_screen *screen);
 345
 346   void get (rgba &color);
 347   void get (XColor &color);
 348
 349   bool set (rxvt_screen *screen, const char *name);
 350   bool set (rxvt_screen *screen, const rgba &color);
 351
 352   void fade (rxvt_screen *screen, int percent, rxvt_color &result, const rgba &to = rgba (0, 0, 0));
 353 };
 354
 355 #if TRACE_PIXMAPS
 356 Pixmap trace_XCreatePixmap (const char *file, int line, Display *dpy, Window r, unsigned int w, unsigned int h, unsigned int d);
 357 void trace_XFreePixmap (const char *file, int line, Display *dpy, Pixmap p);
 358
 359 # define XCreatePixmap(dpy,r,w,h,d) trace_XCreatePixmap (__FILE__,__LINE__,dpy,r,w,h,d)
 360 # define XFreePixmap(dpy,p) trace_XFreePixmap (__FILE__,__LINE__,dpy,p)
 361 #endif
 362
 363 #endif
 364