set _NET_WM_USER_TIME on the window
[dana/urxvt.git] / src / rxvttoolkit.h
index 90b47f3..d0ef9d6 100644 (file)
@@ -1,6 +1,25 @@
-/*
- * rxvttoolkit.h - provide toolkit-functionality for rxvt.
- */
+/*----------------------------------------------------------------------*
+ * File:       rxvttoolkit.h - provide toolkit-functionality for rxvt.
+ *----------------------------------------------------------------------*
+ *
+ * All portions of code are copyright by their respective author/s.
+ * Copyright (c) 2003-2006 Marc Lehmann <pcg@goof.com>
+ *
+ * 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 2 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, write to the Free Software
+ * Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
+ *----------------------------------------------------------------------*/
+
 #ifndef RXVT_TOOLKIT_H
 #define RXVT_TOOLKIT_H
 
 # include <X11/Xft/Xft.h>
 #endif
 
-#include "iom.h"
+#include "ev_cpp.h"
 
-#include "rxvtlib.h"
 #include "rxvtutil.h"
 
 #include "callback.h"
 
+// see rxvttoolkit.C:xa_names, which must be kept in sync
+enum {
+  XA_TEXT,
+  XA_COMPOUND_TEXT,
+  XA_UTF8_STRING,
+  XA_MULTIPLE,
+  XA_TARGETS,
+  XA_TIMESTAMP,
+  XA_VT_SELECTION,
+  XA_INCR,
+  XA_WM_PROTOCOLS,
+  XA_WM_DELETE_WINDOW,
+  XA_CLIPBOARD,
+  XA_AVERAGE_WIDTH,
+  XA_WEIGHT_NAME,
+  XA_SLANT,
+  XA_CHARSET_REGISTRY,
+  XA_CHARSET_ENCODING,
+#if ENABLE_FRILLS
+  XA_MOTIF_WM_HINTS,
+#endif
+#if ENABLE_EWMH
+  XA_NET_WM_PID,
+  XA_NET_WM_NAME,
+  XA_NET_WM_ICON_NAME,
+  XA_NET_WM_PING,
+  XA_NET_WM_ICON,
+  XA_NET_WM_USER_TIME,
+#endif
+#if USE_XIM
+  XA_WM_LOCALE_NAME,
+  XA_XIM_SERVERS,
+#endif
+#if ENABLE_TRANSPARENCY
+  XA_XROOTPMAP_ID,
+  XA_ESETROOT_PMAP_ID,
+#endif
+#if ENABLE_XEMBED
+  XA_XEMBED,
+  XA_XEMBED_INFO,
+#endif
+#if !ENABLE_MINIMAL
+  // these are usually allocated by other subsystems, but we do it
+  // here to avoid a server roundtrip.
+  XA_SCREEN_RESOURCES,
+  XA_XDCCC_LINEAR_RGB_CORRECTION,
+  XA_XDCCC_LINEAR_RGB_MATRICES,
+  XA_WM_COLORMAP_WINDOWS,
+  XA_WM_STATE,
+  XA_cursor,
+# if USE_XIM
+  // various selection targets used by XIM
+  XA_TRANSPORT,
+  XA_LOCALES,
+  XA__XIM_PROTOCOL,
+  XA__XIM_XCONNECT,
+  XA__XIM_MOREDATA,
+# endif
+#endif
+  NUM_XA
+};
+
 struct rxvt_term;
 struct rxvt_display;
 
 struct im_watcher;
 struct xevent_watcher;
 
-struct refcounted {
+template<class watcher>
+struct event_vec : vector<watcher *>
+{
+  void erase_unordered (unsigned int pos)
+  {
+    watcher *w = (*this)[this->size () - 1];
+    this->pop_back ();
+
+    if (!this->empty ())
+      if (((*this)[pos] = w)) // '=' is correct!
+        w->active = pos + 1;
+  }
+};
+
+struct rxvt_watcher
+{
+  int active; /* 0 == inactive, else index into respective vector */
+
+  bool is_active () { return active; }
+
+  rxvt_watcher () : active (0) { }
+};
+
+struct refcounted
+{
   int referenced;
   char *id;
 
   refcounted (const char *id);
-  bool init () { return false; }
+  bool ref_init () { return false; }
+  void ref_next () { }
   ~refcounted ();
 };
 
 template<class T>
-struct refcache : vector<T *> {
+struct refcache : vector<T *>
+{
   T *get (const char *id);
   void put (T *obj);
   void clear ();
@@ -46,8 +152,37 @@ struct refcache : vector<T *> {
 
 /////////////////////////////////////////////////////////////////////////////
 
+struct rxvt_screen;
+
+struct rxvt_drawable
+{
+  rxvt_screen *screen;
+  Drawable drawable;
+  operator Drawable() { return drawable; }
+
+#if XFT
+  XftDraw *xftdrawable;
+  operator XftDraw *();
+#endif
+
+  rxvt_drawable (rxvt_screen *screen, Drawable drawable)
+  : screen(screen),
+#if XFT
+    xftdrawable(0),
+#endif
+    drawable(drawable)
+  { }
+
+#if XFT
+  ~rxvt_drawable ();
+#endif
+};
+
+/////////////////////////////////////////////////////////////////////////////
+
 #ifdef USE_XIM
-struct rxvt_xim : refcounted {
+struct rxvt_xim : refcounted
+{
   void destroy ();
   rxvt_display *display;
 
@@ -55,17 +190,40 @@ struct rxvt_xim : refcounted {
   XIM xim;
 
   rxvt_xim (const char *id) : refcounted (id) { }
-  bool init ();
+  bool ref_init ();
   ~rxvt_xim ();
 };
 #endif
 
-struct rxvt_display : refcounted {
-  Atom xa_xim_servers;
+struct rxvt_screen
+{
+  rxvt_display *display;
+  Display *dpy;
+  int depth;
+  Visual *visual;
+  Colormap cmap;
 
-  io_manager_vec<xevent_watcher> xw;
+#if XFT
+  // scratch pixmap
+  rxvt_drawable *scratch_area;
+  int scratch_w, scratch_h;
 
-  io_watcher x_ev; void x_cb (io_watcher &w, short revents);
+  rxvt_drawable &scratch_drawable (int w, int h);
+
+  rxvt_screen ();
+#endif
+
+  void set (rxvt_display *disp);
+  void select_visual (int bitdepth);
+  void clear ();
+};
+
+struct rxvt_display : refcounted
+{
+  event_vec<xevent_watcher> xw;
+
+  ev::prepare flush_ev; void flush_cb (ev::prepare &w, int revents);
+  ev::io      x_ev    ; void x_cb     (ev::io      &w, int revents);
 
 #ifdef USE_XIM
   refcache<rxvt_xim> xims;
@@ -76,29 +234,30 @@ struct rxvt_display : refcounted {
 #endif
 
 //public
-  Display   *display;
-  int       depth;
+  Display   *dpy;
   int       screen;
-  Visual    *visual;
-  Colormap  cmap;
   Window    root;
   rxvt_term *selection_owner;
-#ifndef NO_SLOW_LINK_SUPPORT
+  rxvt_term *clipboard_owner;
+  Atom      xa[NUM_XA];
   bool      is_local;
-#endif
 #ifdef POINTER_BLANK
   Cursor    blank_cursor;
 #endif
 
   rxvt_display (const char *id);
-  bool init ();
+  XrmDatabase get_resources (bool refresh);
+  bool ref_init ();
+  void ref_next ();
   ~rxvt_display ();
 
-  operator Display *() const { return display; }
+  void flush ()
+  {
+    flush_ev.start ();
+  }
 
-  void flush ();
   Atom atom (const char *name);
-  void set_selection_owner (rxvt_term *owner);
+  void set_selection_owner (rxvt_term *owner, bool clipboard);
 
   void reg (xevent_watcher *w);
   void unreg (xevent_watcher *w);
@@ -113,16 +272,13 @@ struct rxvt_display : refcounted {
 };
 
 #ifdef USE_XIM
-struct im_watcher : watcher, callback0<void> {
-  template<class O1, class O2>
-  im_watcher (O1 *object, void (O2::*method) ())
-  : callback0<void> (object,method)
-  { }
-
+struct im_watcher : rxvt_watcher, callback<void (void)>
+{
   void start (rxvt_display *display)
   {
     display->reg (this);
   }
+
   void stop (rxvt_display *display)
   {
     display->unreg (this);
@@ -130,19 +286,16 @@ struct im_watcher : watcher, callback0<void> {
 };
 #endif
 
-struct xevent_watcher : watcher, callback1<void, XEvent &> {
+struct xevent_watcher : rxvt_watcher, callback<void (XEvent &)>
+{
   Window window;
 
-  template<class O1, class O2>
-  xevent_watcher (O1 *object, void (O2::*method) (XEvent &))
-  : callback1<void, XEvent &> (object,method)
-  { }
-
   void start (rxvt_display *display, Window window)
   {
     this->window = window;
     display->reg (this);
   }
+
   void stop (rxvt_display *display)
   {
     display->unreg (this);
@@ -155,29 +308,61 @@ extern refcache<rxvt_display> displays;
 
 typedef unsigned long Pixel;
 
-struct rxvt_color {
+struct rgba
+{
+  unsigned short r, g, b, a;
+
+  enum { MIN_CC = 0x0000, MAX_CC  = 0xffff };
+
+  rgba ()
+  { }
+
+  rgba (unsigned short r, unsigned short g, unsigned short b, unsigned short a = MAX_CC)
+  : r(r), g(g), b(b), a(a)
+  { }
+};
+
+struct rxvt_color
+{
 #if XFT
   XftColor c;
-  operator Pixel () const { return c.pixel; }
 #else
-  Pixel p;
-  operator Pixel () const { return p; }
+  XColor c;
 #endif
 
+  operator Pixel () const { return c.pixel; }
+
   bool operator == (const rxvt_color &b) const { return Pixel (*this) == Pixel (b); }
   bool operator != (const rxvt_color &b) const { return Pixel (*this) != Pixel (b); }
 
-  void get (rxvt_display *display, unsigned short &cr, unsigned short &cg, unsigned short &cb);
-  bool set (rxvt_display *display, Pixel p);
-  bool set (rxvt_display *display, const char *name);
-  bool set (rxvt_display *display, unsigned short cr, unsigned short cg, unsigned short cb);
+  bool is_opaque () const
+  {
+#if XFT
+    return c.color.alpha == rgba::MAX_CC;
+#else
+    return 1;
+#endif
+  }
+
+  bool alloc (rxvt_screen *screen, const rgba &color);
+  void free (rxvt_screen *screen);
 
-  rxvt_color fade (rxvt_display *, int percent); // fades to black
-  rxvt_color fade (rxvt_display *, int percent, rxvt_color &fadeto);
+  void get (rgba &color);
+  void get (XColor &color);
 
-  void free (rxvt_display *display);
+  bool set (rxvt_screen *screen, const char *name);
+  bool set (rxvt_screen *screen, const rgba &color);
+
+  void fade (rxvt_screen *screen, int percent, rxvt_color &result, const rgba &to = rgba (0, 0, 0));
 };
 
+#if TRACE_PIXMAPS
+Pixmap trace_XCreatePixmap (const char *file, int line, Display *dpy, Window r, unsigned int w, unsigned int h, unsigned int d);
+void trace_XFreePixmap (const char *file, int line, Display *dpy, Pixmap p);
+
+# define XCreatePixmap(dpy,r,w,h,d) trace_XCreatePixmap (__FILE__,__LINE__,dpy,r,w,h,d)
+# define XFreePixmap(dpy,p) trace_XFreePixmap (__FILE__,__LINE__,dpy,p)
+#endif
+
 #endif