src/rxvttoolkit.C

   1 /*--------------------------------*-C-*---------------------------------*
   2  * File:        rxvttoolkit.C
   3  *----------------------------------------------------------------------*
   4  *
   5  * All portions of code are copyright by their respective author/s.
   6  * Copyright (c) 2003-2004 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 #include "../config.h"
  24 #include <rxvt.h>
  25 #include <rxvttoolkit.h>
  26
  27 #include <unistd.h>
  28 #include <fcntl.h>
  29
  30 #include <sys/utsname.h>
  31
  32 #ifndef NO_SLOW_LINK_SUPPORT
  33 # include <sys/socket.h>
  34 # include <sys/un.h>
  35 #endif
  36
  37 #if XFT
  38 # include <X11/extensions/Xrender.h>
  39 #endif
  40
  41 const char *const xa_names[] =
  42 {
  43   "TEXT",
  44   "COMPOUND_TEXT",
  45   "UTF8_STRING",
  46   "MULTIPLE",
  47   "TARGETS",
  48   "TIMESTAMP",
  49   "VT_SELECTION",
  50   "INCR",
  51   "WM_PROTOCOLS",
  52   "WM_DELETE_WINDOW",
  53   "CLIPBOARD",
  54   "AVERAGE_WIDTH",
  55   "WEIGHT_NAME",
  56   "SLANT",
  57   "CHARSET_REGISTRY",
  58   "CHARSET_ENCODING",
  59 #if ENABLE_FRILLS
  60   "_MOTIF_WM_HINTS",
  61 #endif
  62 #if ENABLE_EWMH
  63   "_NET_WM_PID",
  64   "_NET_WM_NAME",
  65   "_NET_WM_ICON_NAME",
  66   "_NET_WM_PING",
  67 #endif
  68 #if USE_XIM
  69   "WM_LOCALE_NAME",
  70   "XIM_SERVERS",
  71 #endif
  72 #ifdef TRANSPARENT
  73   "_XROOTPMAP_ID",
  74   "ESETROOT_PMAP_ID",
  75 #endif
  76 #if ENABLE_XEMBED
  77   "_XEMBED",
  78   "_XEMBED_INFO",
  79 #endif
  80 #if !ENABLE_MINIMAL
  81   "SCREEN_RESOURCES",
  82   "XDCCC_LINEAR_RGB_CORRECTION",
  83   "XDCCC_LINEAR_RGB_MATRICES",
  84   "WM_COLORMAP_WINDOWS",
  85   "WM_STATE",
  86   "cursor",
  87 # if USE_XIM
  88   "TRANSPORT",
  89   "LOCALES",
  90   "_XIM_PROTOCOL",
  91   "_XIM_XCONNECT",
  92   "_XIM_MOREDATA",
  93 # endif
  94 #endif
  95 };
  96
  97 /////////////////////////////////////////////////////////////////////////////
  98
  99 refcounted::refcounted (const char *id)
 100 {
 101   this->id = strdup (id);
 102 }
 103
 104 refcounted::~refcounted ()
 105 {
 106   free (id);
 107 }
 108
 109 template<class T>
 110 T *refcache<T>::get (const char *id)
 111 {
 112   for (T **i = this->begin (); i < this->end (); ++i)
 113     {
 114       if (!strcmp (id, (*i)->id))
 115         {
 116           ++(*i)->referenced;
 117           (*i)->ref_next ();
 118           return *i;
 119         }
 120     }
 121
 122   T *obj = new T (id);
 123
 124   if (obj && obj->ref_init ())
 125     {
 126       obj->referenced = 1;
 127       this->push_back (obj);
 128       return obj;
 129     }
 130   else
 131     {
 132       delete obj;
 133       return 0;
 134     }
 135 }
 136
 137 template<class T>
 138 void refcache<T>::put (T *obj)
 139 {
 140   if (!obj)
 141     return;
 142
 143   if (!--obj->referenced)
 144     {
 145       this->erase (find (this->begin (), this->end (), obj));
 146       delete obj;
 147     }
 148 }
 149
 150 template<class T>
 151 void refcache<T>::clear ()
 152 {
 153   while (this->size ())
 154     put (*this->begin ());
 155 }
 156
 157 /////////////////////////////////////////////////////////////////////////////
 158
 159 #ifdef USE_XIM
 160
 161 static void
 162 #if XIMCB_PROTO_BROKEN
 163 im_destroy_cb (XIC unused1, XPointer client_data, XPointer unused3)
 164 #else
 165 im_destroy_cb (XIM unused1, XPointer client_data, XPointer unused3)
 166 #endif
 167 {
 168   rxvt_xim *xim = (rxvt_xim *)client_data;
 169   rxvt_display *display = xim->display;
 170
 171   xim->xim = 0;
 172
 173   display->xims.erase (find (display->xims.begin (), display->xims.end (), xim));
 174   display->im_change_cb ();
 175 }
 176
 177 bool
 178 rxvt_xim::ref_init ()
 179 {
 180   display = GET_R->display; //HACK: TODO
 181
 182   xim = XOpenIM (display->display, NULL, NULL, NULL);
 183
 184   if (!xim)
 185     return false;
 186
 187   XIMCallback ximcallback;
 188   ximcallback.client_data = (XPointer)this;
 189   ximcallback.callback = im_destroy_cb;
 190
 191   XSetIMValues (xim, XNDestroyCallback, &ximcallback, NULL);
 192
 193   return true;
 194 }
 195
 196 rxvt_xim::~rxvt_xim ()
 197 {
 198   if (xim)
 199     XCloseIM (xim);
 200 }
 201
 202 #endif
 203
 204 /////////////////////////////////////////////////////////////////////////////
 205
 206 void
 207 rxvt_screen::set (rxvt_display *disp)
 208 {
 209   display = disp;
 210   xdisp   = disp->display;
 211
 212   Screen *screen = ScreenOfDisplay (xdisp, disp->screen);
 213
 214   depth   = DefaultDepthOfScreen    (screen);
 215   visual  = DefaultVisualOfScreen   (screen);
 216   cmap    = DefaultColormapOfScreen (screen);
 217 }
 218
 219 void
 220 rxvt_screen::set (rxvt_display *disp, int bitdepth)
 221 {
 222   set (disp);
 223
 224 #if XFT
 225   XVisualInfo vinfo;
 226
 227   if (XMatchVisualInfo (xdisp, display->screen, bitdepth, TrueColor, &vinfo))
 228     {
 229       depth  = bitdepth;
 230       visual = vinfo.visual;
 231       cmap   = XCreateColormap (xdisp, disp->root, visual, AllocNone);
 232     }
 233 #endif
 234 }
 235
 236 void
 237 rxvt_screen::clear ()
 238 {
 239   if (cmap != DefaultColormapOfScreen (ScreenOfDisplay (xdisp, display->screen)))
 240     XFreeColormap (xdisp, cmap);
 241 }
 242
 243 /////////////////////////////////////////////////////////////////////////////
 244
 245 rxvt_display::rxvt_display (const char *id)
 246 : refcounted (id)
 247 , x_ev (this, &rxvt_display::x_cb)
 248 , selection_owner (0)
 249 {
 250 }
 251
 252 XrmDatabase
 253 rxvt_display::get_resources ()
 254 {
 255   char *homedir = (char *)getenv ("HOME");
 256   char fname[1024];
 257
 258   /*
 259    * get resources using the X library function
 260    */
 261   char *displayResource, *xe;
 262   XrmDatabase database, rdb1;
 263
 264   database = NULL;
 265
 266   // for ordering, see for example http://www.faqs.org/faqs/Xt-FAQ/ Subject: 20
 267
 268   // 6. System wide per application default file.
 269
 270   /* Add in $XAPPLRESDIR/Rxvt only; not bothering with XUSERFILESEARCHPATH */
 271   if ((xe = (char *)getenv ("XAPPLRESDIR")))
 272     {
 273       snprintf (fname, sizeof (fname), "%s/%s", xe, RESCLASS);
 274
 275       if ((rdb1 = XrmGetFileDatabase (fname)))
 276         XrmMergeDatabases (rdb1, &database);
 277     }
 278
 279   // 5. User's per application default file.
 280   // none
 281
 282   // 4. User's defaults file.
 283   /* Get any Xserver defaults */
 284   displayResource = XResourceManagerString (display);
 285
 286   if (displayResource != NULL)
 287     {
 288       if ((rdb1 = XrmGetStringDatabase (displayResource)))
 289         XrmMergeDatabases (rdb1, &database);
 290     }
 291   else if (homedir)
 292     {
 293       snprintf (fname, sizeof (fname), "%s/.Xdefaults", homedir);
 294
 295       if ((rdb1 = XrmGetFileDatabase (fname)))
 296         XrmMergeDatabases (rdb1, &database);
 297     }
 298
 299   /* Get screen specific resources */
 300   displayResource = XScreenResourceString (ScreenOfDisplay (display, screen));
 301
 302   if (displayResource != NULL)
 303     {
 304       if ((rdb1 = XrmGetStringDatabase (displayResource)))
 305         /* Merge with screen-independent resources */
 306         XrmMergeDatabases (rdb1, &database);
 307
 308       XFree (displayResource);
 309     }
 310
 311   // 3. User's per host defaults file
 312   /* Add in XENVIRONMENT file */
 313   if ((xe = (char *)getenv ("XENVIRONMENT"))
 314       && (rdb1 = XrmGetFileDatabase (xe)))
 315     XrmMergeDatabases (rdb1, &database);
 316   else if (homedir)
 317     {
 318       struct utsname un;
 319
 320       if (!uname (&un))
 321         {
 322           snprintf (fname, sizeof (fname), "%s/.Xdefaults-%s", homedir, un.nodename);
 323
 324           if ((rdb1 = XrmGetFileDatabase (fname)))
 325             XrmMergeDatabases (rdb1, &database);
 326         }
 327     }
 328
 329   return database;
 330 }
 331
 332 bool rxvt_display::ref_init ()
 333 {
 334 #ifdef LOCAL_X_IS_UNIX
 335   if (id[0] == ':')
 336     {
 337       val = rxvt_malloc (5 + strlen (id) + 1);
 338       strcpy (val, "unix/");
 339       strcat (val, id);
 340       display = XOpenDisplay (val);
 341       free (val);
 342     }
 343   else
 344 #endif
 345     display = 0;
 346
 347   if (!display)
 348     display = XOpenDisplay (id);
 349
 350   if (!display)
 351     return false;
 352
 353   screen = DefaultScreen (display);
 354   root   = DefaultRootWindow (display);
 355
 356   assert (sizeof (xa_names) / sizeof (char *) == NUM_XA);
 357   XInternAtoms (display, (char **)xa_names, NUM_XA, False, xa);
 358
 359   XrmSetDatabase (display, get_resources ());
 360
 361 #ifdef POINTER_BLANK
 362   XColor blackcolour;
 363   blackcolour.red   = 0;
 364   blackcolour.green = 0;
 365   blackcolour.blue  = 0;
 366   Font f = XLoadFont (display, "fixed");
 367   blank_cursor = XCreateGlyphCursor (display, f, f, ' ', ' ',
 368                                      &blackcolour, &blackcolour);
 369   XUnloadFont (display, f);
 370 #endif
 371
 372   int fd = XConnectionNumber (display);
 373
 374 #ifndef NO_SLOW_LINK_SUPPORT
 375   // try to detect wether we have a local connection.
 376   // assume unix domains socket == local, everything else not
 377   // TODO: might want to check for inet/127.0.0.1
 378   is_local = 0;
 379   sockaddr_un sa;
 380   socklen_t sl = sizeof (sa);
 381
 382   if (!getsockname (fd, (sockaddr *)&sa, &sl))
 383     is_local = sa.sun_family == AF_LOCAL;
 384 #endif
 385
 386   x_ev.start (fd, EVENT_READ);
 387   fcntl (fd, F_SETFD, FD_CLOEXEC);
 388
 389   XSelectInput (display, root, PropertyChangeMask);
 390
 391   flush ();
 392
 393   return true;
 394 }
 395
 396 void
 397 rxvt_display::ref_next ()
 398 {
 399   // TODO: somehow check wether the database files/resources changed
 400   // before affording re-loading/parsing
 401   XrmDestroyDatabase (XrmGetDatabase (display));
 402   XrmSetDatabase (display, get_resources ());
 403 }
 404
 405 rxvt_display::~rxvt_display ()
 406 {
 407   if (!display)
 408     return;
 409
 410 #ifdef POINTER_BLANK
 411   XFreeCursor (display, blank_cursor);
 412 #endif
 413   x_ev.stop ();
 414 #ifdef USE_XIM
 415   xims.clear ();
 416 #endif
 417   XCloseDisplay (display);
 418 }
 419
 420 #ifdef USE_XIM
 421 void rxvt_display::im_change_cb ()
 422 {
 423   for (im_watcher **i = imw.begin (); i != imw.end (); ++i)
 424     (*i)->call ();
 425 }
 426
 427 void rxvt_display::im_change_check ()
 428 {
 429   // try to only call im_change_cb when a new input method
 430   // registers, as xlib crashes due to a race otherwise.
 431   Atom actual_type, *atoms;
 432   int actual_format;
 433   unsigned long nitems, bytes_after;
 434
 435   if (XGetWindowProperty (display, root, xa[XA_XIM_SERVERS], 0L, 1000000L,
 436                           False, XA_ATOM, &actual_type, &actual_format,
 437                           &nitems, &bytes_after, (unsigned char **)&atoms)
 438       != Success )
 439     return;
 440
 441   if (actual_type == XA_ATOM  && actual_format == 32)
 442     for (int i = 0; i < nitems; i++)
 443       if (XGetSelectionOwner (display, atoms[i]))
 444         {
 445           im_change_cb ();
 446           break;
 447         }
 448
 449   XFree (atoms);
 450 }
 451 #endif
 452
 453 void rxvt_display::x_cb (io_watcher &w, short revents)
 454 {
 455   do
 456     {
 457       XEvent xev;
 458       XNextEvent (display, &xev);
 459
 460 #ifdef USE_XIM
 461       if (!XFilterEvent (&xev, None))
 462         {
 463           if (xev.type == PropertyNotify
 464               && xev.xany.window == root
 465               && xev.xproperty.atom == xa[XA_XIM_SERVERS])
 466             im_change_check ();
 467 #endif
 468           for (int i = xw.size (); i--; )
 469             {
 470               if (!xw[i])
 471                 xw.erase_unordered (i);
 472               else if (xw[i]->window == xev.xany.window)
 473                 xw[i]->call (xev);
 474             }
 475 #ifdef USE_XIM
 476         }
 477 #endif
 478     }
 479   while (XEventsQueued (display, QueuedAlready));
 480
 481   XFlush (display);
 482 }
 483
 484 void rxvt_display::flush ()
 485 {
 486   if (XEventsQueued (display, QueuedAlready))
 487     x_cb (x_ev, EVENT_READ);
 488
 489   XFlush (display);
 490 }
 491
 492 void rxvt_display::reg (xevent_watcher *w)
 493 {
 494   xw.push_back (w);
 495   w->active = xw.size ();
 496 }
 497
 498 void rxvt_display::unreg (xevent_watcher *w)
 499 {
 500   if (w->active)
 501     xw[w->active - 1] = 0;
 502 }
 503
 504 void rxvt_display::set_selection_owner (rxvt_term *owner)
 505 {
 506   if (selection_owner && selection_owner != owner)
 507     selection_owner->selection_clear ();
 508
 509   selection_owner = owner;
 510 }
 511
 512 #ifdef USE_XIM
 513
 514 void rxvt_display::reg (im_watcher *w)
 515 {
 516   imw.push_back (w);
 517 }
 518
 519 void rxvt_display::unreg (im_watcher *w)
 520 {
 521   imw.erase (find (imw.begin (), imw.end (), w));
 522 }
 523
 524 rxvt_xim *rxvt_display::get_xim (const char *locale, const char *modifiers)
 525 {
 526   char *id;
 527   int l, m;
 528
 529   l = strlen (locale);
 530   m = strlen (modifiers);
 531
 532   if (!(id = (char *)malloc (l + m + 2)))
 533     return 0;
 534
 535   memcpy (id, locale, l); id[l] = '\n';
 536   memcpy (id + l + 1, modifiers, m); id[l + m + 1] = 0;
 537
 538   rxvt_xim *xim = xims.get (id);
 539
 540   free (id);
 541
 542   return xim;
 543 }
 544
 545 void rxvt_display::put_xim (rxvt_xim *xim)
 546 {
 547 # if XLIB_IS_RACEFREE
 548   xims.put (xim);
 549 # endif
 550 }
 551
 552 #endif
 553
 554 Atom rxvt_display::atom (const char *name)
 555 {
 556   return XInternAtom (display, name, False);
 557 }
 558
 559 /////////////////////////////////////////////////////////////////////////////
 560
 561 template class refcache<rxvt_display>;
 562 refcache<rxvt_display> displays;
 563
 564 /////////////////////////////////////////////////////////////////////////////
 565
 566 bool
 567 rxvt_color::alloc (rxvt_screen *screen, const rgba &color)
 568 {
 569 #if XFT
 570   XRenderPictFormat *format;
 571
 572   // FUCKING Xft gets it wrong, of course, so work around it.
 573   // Transparency users should eat shit and die, and then
 574   // XRenderQueryPictIndexValues themselves plenty.
 575   if ((screen->visual->c_class == TrueColor)
 576       && (format = XRenderFindVisualFormat (screen->xdisp, screen->visual)))
 577     {
 578       // the fun lies in doing everything manually...
 579       c.color.red   = color.r;
 580       c.color.green = color.g;
 581       c.color.blue  = color.b;
 582       c.color.alpha = color.a;
 583
 584       c.pixel = ((color.r * format->direct.redMask   / rgba::MAX_CC) << format->direct.red  )
 585               | ((color.g * format->direct.greenMask / rgba::MAX_CC) << format->direct.green)
 586               | ((color.b * format->direct.blueMask  / rgba::MAX_CC) << format->direct.blue )
 587               | ((color.a * format->direct.alphaMask / rgba::MAX_CC) << format->direct.alpha);
 588
 589       return true;
 590     }
 591   else
 592     {
 593       XRenderColor d;
 594
 595       d.red   = color.r;
 596       d.green = color.g;
 597       d.blue  = color.b;
 598       d.alpha = color.a;
 599
 600       return XftColorAllocValue (screen->xdisp, screen->visual, screen->cmap, &d, &c);
 601     }
 602 #else
 603   c.red   = color.r;
 604   c.green = color.g;
 605   c.blue  = color.b;
 606
 607   if (screen->visual->c_class == TrueColor)
 608     {
 609       c.pixel = (color.r * (screen->visual->red_mask   >> ctz (screen->visual->red_mask  ))
 610                          / rgba::MAX_CC) << ctz (screen->visual->red_mask  )
 611               | (color.g * (screen->visual->green_mask >> ctz (screen->visual->green_mask))
 612                          / rgba::MAX_CC) << ctz (screen->visual->green_mask)
 613               | (color.b * (screen->visual->blue_mask  >> ctz (screen->visual->blue_mask ))
 614                          / rgba::MAX_CC) << ctz (screen->visual->blue_mask );
 615
 616       return true;
 617     }
 618   else if (XAllocColor (screen->xdisp, screen->cmap, &c))
 619     return true;
 620   else
 621     c.pixel = (color.r + color.g + color.b) > 128*3
 622             ? WhitePixelOfScreen (DefaultScreenOfDisplay (screen->xdisp))
 623             : BlackPixelOfScreen (DefaultScreenOfDisplay (screen->xdisp));
 624 #endif
 625
 626   return false;
 627 }
 628
 629 bool
 630 rxvt_color::set (rxvt_screen *screen, const char *name)
 631 {
 632   rgba c;
 633   char eos;
 634   int skip;
 635
 636   // parse the nonstandard "[alphapercent]" prefix
 637   if (1 <= sscanf (name, "[%hd]%n", &c.a, &skip))
 638     {
 639       c.a = lerp<int, int, int> (0, rgba::MAX_CC, c.a);
 640       name += skip;
 641     }
 642   else
 643     c.a = rgba::MAX_CC;
 644
 645   // parse the non-standard "rgba:rrrr/gggg/bbbb/aaaa" format
 646   if (strlen (name) != 4+5*4 || 4 != sscanf (name, "rgba:%4hx/%4hx/%4hx/%4hx%c", &c.r, &c.g, &c.b, &c.a, &eos))
 647     {
 648       XColor xc, xc_exact;
 649
 650       if (XParseColor (screen->xdisp, screen->cmap, name, &xc))
 651         {
 652           c.r = xc.red;
 653           c.g = xc.green;
 654           c.b = xc.blue;
 655         }
 656       else
 657         {
 658           c.r = 0xffff;
 659           c.g = 0x6969;
 660           c.b = 0xb4b4;
 661
 662           rxvt_warn ("unable to parse color '%s', using pink instead.\n", name);
 663         }
 664     }
 665
 666   return set (screen, c);
 667 }
 668
 669 bool
 670 rxvt_color::set (rxvt_screen *screen, const rgba &color)
 671 {
 672   bool got = alloc (screen, color);
 673
 674 #if !ENABLE_MINIMAL
 675   int cmap_size = screen->visual->map_entries;
 676
 677   if (!got
 678       && screen->visual->c_class == PseudoColor
 679       && cmap_size < 4096)
 680     {
 681       XColor *colors = new XColor [screen->visual->map_entries];
 682
 683       for (int i = 0; i < cmap_size; i++)
 684         colors [i].pixel = i;
 685
 686       // many kilobytes transfer per colour, but pseudocolor isn't worth
 687       // many extra optimisations.
 688       XQueryColors (screen->xdisp, screen->cmap, colors, cmap_size);
 689
 690       int diff = 0x7fffffffUL;
 691       XColor *best = colors;
 692
 693       for (int i = 0; i < cmap_size; i++)
 694         {
 695           int d = (squared_diff<int> (color.r >> 2, colors [i].red   >> 2))
 696                 + (squared_diff<int> (color.g >> 2, colors [i].green >> 2))
 697                 + (squared_diff<int> (color.b >> 2, colors [i].blue  >> 2));
 698
 699           if (d < diff)
 700             {
 701               diff = d;
 702               best = colors + i;
 703             }
 704         }
 705
 706       //rxvt_warn ("could not allocate %04x %04x %04x, getting %04x %04x %04x instead (%d)\n",
 707       //    color.r, color.g, color.b, best->red, best->green, best->blue, diff);
 708
 709       got = alloc (screen, rgba (best->red, best->green, best->blue));
 710
 711       delete colors;
 712     }
 713 #endif
 714
 715   return got;
 716 }
 717
 718 void
 719 rxvt_color::get (rgba &color)
 720 {
 721 #if XFT
 722   color.r = c.color.red;
 723   color.g = c.color.green;
 724   color.b = c.color.blue;
 725   color.a = c.color.alpha;
 726 #else
 727   color.r = c.red;
 728   color.g = c.green;
 729   color.b = c.blue;
 730   color.a = rgba::MAX_CC;
 731 #endif
 732 }
 733
 734 void
 735 rxvt_color::get (XColor &color)
 736 {
 737   rgba c;
 738   get (c);
 739
 740   color.red   = c.r;
 741   color.green = c.g;
 742   color.blue  = c.b;
 743   color.pixel = (Pixel)*this;
 744 }
 745
 746 void
 747 rxvt_color::free (rxvt_screen *screen)
 748 {
 749 #if XFT
 750   XftColorFree (screen->xdisp, screen->visual, screen->cmap, &c);
 751 #else
 752   XFreeColors (screen->xdisp, screen->cmap, &c.pixel, 1, AllPlanes);
 753 #endif
 754 }
 755
 756 void
 757 rxvt_color::fade (rxvt_screen *screen, int percent, rxvt_color &result, const rgba &to)
 758 {
 759   rgba c;
 760   get (c);
 761
 762   result.set (
 763     screen,
 764     rgba (
 765       lerp (c.r, to.r, percent),
 766       lerp (c.g, to.g, percent),
 767       lerp (c.b, to.b, percent),
 768       lerp (c.a, to.a, percent)
 769     )
 770   );
 771 }
 772