*** empty log message ***
[dana/urxvt.git] / 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, 0, 0, 0);
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, 0);
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 (bool refresh)
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 rdb1, database = 0;
263
264   // for ordering, see for example http://www.faqs.org/faqs/Xt-FAQ/ Subject: 20
265
266   // 6. System wide per application default file.
267
268   /* Add in $XAPPLRESDIR/Rxvt only; not bothering with XUSERFILESEARCHPATH */
269   if ((xe = (char *)getenv ("XAPPLRESDIR")))
270     {
271       snprintf (fname, sizeof (fname), "%s/%s", xe, RESCLASS);
272
273       if ((rdb1 = XrmGetFileDatabase (fname)))
274         XrmMergeDatabases (rdb1, &database);
275     }
276
277   // 5. User's per application default file.
278   // none
279
280   // 4. User's defaults file.
281   /* Get any Xserver defaults */
282   if (refresh)
283     {
284       // fucking xlib keeps a copy of the rm string
285       Atom actual_type;
286       int actual_format;
287       unsigned long nitems, nremaining;
288       char *val = 0;
289
290 #if XLIB_ILLEGAL_ACCESS
291       if (display->xdefaults)
292         XFree (display->xdefaults);
293 #endif
294
295       if (XGetWindowProperty (display, root, XA_RESOURCE_MANAGER,
296                               0L, 100000000L, False,
297                               XA_STRING, &actual_type, &actual_format,
298                               &nitems, &nremaining,
299                               (unsigned char **)&val) == Success
300           && actual_type == XA_STRING
301           && actual_format == 8)
302          displayResource = val;
303        else
304          {
305            displayResource = 0;
306            if (val)
307              XFree(val);
308          }
309
310 #if XLIB_ILLEGAL_ACCESS
311       display->xdefaults = displayResource;
312 #endif
313     }
314   else
315     displayResource = XResourceManagerString (display);
316
317   if (displayResource)
318     {
319       if ((rdb1 = XrmGetStringDatabase (displayResource)))
320         XrmMergeDatabases (rdb1, &database);
321     }
322   else if (homedir)
323     {
324       snprintf (fname, sizeof (fname), "%s/.Xdefaults", homedir);
325
326       if ((rdb1 = XrmGetFileDatabase (fname)))
327         XrmMergeDatabases (rdb1, &database);
328     }
329
330 #if !XLIB_ILLEGAL_ACCESS
331   if (refresh && displayResource)
332     XFree (displayResource);
333 #endif
334
335   /* Get screen specific resources */
336   displayResource = XScreenResourceString (ScreenOfDisplay (display, screen));
337
338   if (displayResource)
339     {
340       if ((rdb1 = XrmGetStringDatabase (displayResource)))
341         /* Merge with screen-independent resources */
342         XrmMergeDatabases (rdb1, &database);
343
344       XFree (displayResource);
345     }
346
347   // 3. User's per host defaults file
348   /* Add in XENVIRONMENT file */
349   if ((xe = (char *)getenv ("XENVIRONMENT"))
350       && (rdb1 = XrmGetFileDatabase (xe)))
351     XrmMergeDatabases (rdb1, &database);
352   else if (homedir)
353     {
354       struct utsname un;
355
356       if (!uname (&un))
357         {
358           snprintf (fname, sizeof (fname), "%s/.Xdefaults-%s", homedir, un.nodename);
359
360           if ((rdb1 = XrmGetFileDatabase (fname)))
361             XrmMergeDatabases (rdb1, &database);
362         }
363     }
364
365   return database;
366 }
367
368 bool rxvt_display::ref_init ()
369 {
370 #ifdef LOCAL_X_IS_UNIX
371   if (id[0] == ':')
372     {
373       val = rxvt_malloc (5 + strlen (id) + 1);
374       strcpy (val, "unix/");
375       strcat (val, id);
376       display = XOpenDisplay (val);
377       free (val);
378     }
379   else
380 #endif
381     display = 0;
382
383   if (!display)
384     display = XOpenDisplay (id);
385
386   if (!display)
387     return false;
388
389   screen = DefaultScreen     (display);
390   root   = DefaultRootWindow (display);
391
392   assert (sizeof (xa_names) / sizeof (char *) == NUM_XA);
393   XInternAtoms (display, (char **)xa_names, NUM_XA, False, xa);
394
395   XrmSetDatabase (display, get_resources (false));
396
397 #ifdef POINTER_BLANK
398   XColor blackcolour;
399   blackcolour.red   = 0;
400   blackcolour.green = 0;
401   blackcolour.blue  = 0;
402   Font f = XLoadFont (display, "fixed");
403   blank_cursor = XCreateGlyphCursor (display, f, f, ' ', ' ',
404                                      &blackcolour, &blackcolour);
405   XUnloadFont (display, f);
406 #endif
407
408   int fd = XConnectionNumber (display);
409
410 #ifndef NO_SLOW_LINK_SUPPORT
411   // try to detect wether we have a local connection.
412   // assume unix domains socket == local, everything else not
413   // TODO: might want to check for inet/127.0.0.1
414   is_local = 0;
415   sockaddr_un sa;
416   socklen_t sl = sizeof (sa);
417
418   if (!getsockname (fd, (sockaddr *)&sa, &sl))
419     is_local = sa.sun_family == AF_LOCAL;
420 #endif
421
422   x_ev.start (fd, EVENT_READ);
423   fcntl (fd, F_SETFD, FD_CLOEXEC);
424
425   XSelectInput (display, root, PropertyChangeMask);
426
427   flush ();
428
429   return true;
430 }
431
432 void
433 rxvt_display::ref_next ()
434 {
435   // TODO: somehow check wether the database files/resources changed
436   // before affording re-loading/parsing
437   XrmDestroyDatabase (XrmGetDatabase (display));
438   XrmSetDatabase (display, get_resources (true));
439 }
440
441 rxvt_display::~rxvt_display ()
442 {
443   if (!display)
444     return;
445
446 #ifdef POINTER_BLANK
447   XFreeCursor (display, blank_cursor);
448 #endif
449   x_ev.stop ();
450 #ifdef USE_XIM
451   xims.clear ();
452 #endif
453   XCloseDisplay (display);
454 }
455
456 #ifdef USE_XIM
457 void rxvt_display::im_change_cb ()
458 {
459   for (im_watcher **i = imw.begin (); i != imw.end (); ++i)
460     (*i)->call ();
461 }
462
463 void rxvt_display::im_change_check ()
464 {
465   // try to only call im_change_cb when a new input method
466   // registers, as xlib crashes due to a race otherwise.
467   Atom actual_type, *atoms;
468   int actual_format;
469   unsigned long nitems, bytes_after;
470
471   if (XGetWindowProperty (display, root, xa[XA_XIM_SERVERS], 0L, 1000000L,
472                           False, XA_ATOM, &actual_type, &actual_format,
473                           &nitems, &bytes_after, (unsigned char **)&atoms)
474       != Success )
475     return;
476
477   if (actual_type == XA_ATOM  && actual_format == 32)
478     for (int i = 0; i < nitems; i++)
479       if (XGetSelectionOwner (display, atoms[i]))
480         {
481           im_change_cb ();
482           break;
483         }
484
485   XFree (atoms);
486 }
487 #endif
488
489 void rxvt_display::x_cb (io_watcher &w, short revents)
490 {
491   do
492     {
493       XEvent xev;
494       XNextEvent (display, &xev);
495
496 #ifdef USE_XIM
497       if (!XFilterEvent (&xev, None))
498         {
499           if (xev.type == PropertyNotify
500               && xev.xany.window == root
501               && xev.xproperty.atom == xa[XA_XIM_SERVERS])
502             im_change_check ();
503 #endif
504           for (int i = xw.size (); i--; )
505             {
506               if (!xw[i])
507                 xw.erase_unordered (i);
508               else if (xw[i]->window == xev.xany.window)
509                 xw[i]->call (xev);
510             }
511 #ifdef USE_XIM
512         }
513 #endif
514     }
515   while (XEventsQueued (display, QueuedAlready));
516
517   XFlush (display);
518 }
519
520 void rxvt_display::flush ()
521 {
522   if (XEventsQueued (display, QueuedAlready))
523     x_cb (x_ev, EVENT_READ);
524
525   XFlush (display);
526 }
527
528 void rxvt_display::reg (xevent_watcher *w)
529 {
530   xw.push_back (w);
531   w->active = xw.size ();
532 }
533
534 void rxvt_display::unreg (xevent_watcher *w)
535 {
536   if (w->active)
537     xw[w->active - 1] = 0;
538 }
539
540 void rxvt_display::set_selection_owner (rxvt_term *owner)
541 {
542   if (selection_owner && selection_owner != owner)
543     selection_owner->selection_clear ();
544
545   selection_owner = owner;
546 }
547
548 #ifdef USE_XIM
549
550 void rxvt_display::reg (im_watcher *w)
551 {
552   imw.push_back (w);
553 }
554
555 void rxvt_display::unreg (im_watcher *w)
556 {
557   imw.erase (find (imw.begin (), imw.end (), w));
558 }
559
560 rxvt_xim *rxvt_display::get_xim (const char *locale, const char *modifiers)
561 {
562   char *id;
563   int l, m;
564
565   l = strlen (locale);
566   m = strlen (modifiers);
567
568   if (!(id = (char *)malloc (l + m + 2)))
569     return 0;
570
571   memcpy (id, locale, l); id[l] = '\n';
572   memcpy (id + l + 1, modifiers, m); id[l + m + 1] = 0;
573
574   rxvt_xim *xim = xims.get (id);
575
576   free (id);
577
578   return xim;
579 }
580
581 void rxvt_display::put_xim (rxvt_xim *xim)
582 {
583 # if XLIB_IS_RACEFREE
584   xims.put (xim);
585 # endif
586 }
587
588 #endif
589
590 Atom rxvt_display::atom (const char *name)
591 {
592   return XInternAtom (display, name, False);
593 }
594
595 /////////////////////////////////////////////////////////////////////////////
596
597 template class refcache<rxvt_display>;
598 refcache<rxvt_display> displays;
599
600 /////////////////////////////////////////////////////////////////////////////
601  
602 bool
603 rxvt_color::alloc (rxvt_screen *screen, const rgba &color)
604 {
605 #if XFT
606   XRenderPictFormat *format;
607
608   // FUCKING Xft gets it wrong, of course, so work around it.
609   // Transparency users should eat shit and die, and then
610   // XRenderQueryPictIndexValues themselves plenty.
611   if ((screen->visual->c_class == TrueColor)
612       && (format = XRenderFindVisualFormat (screen->xdisp, screen->visual)))
613     {
614       // the fun lies in doing everything manually...
615       c.color.red   = color.r;
616       c.color.green = color.g;
617       c.color.blue  = color.b;
618       c.color.alpha = color.a;
619
620       c.pixel = ((color.r * format->direct.redMask   / rgba::MAX_CC) << format->direct.red  )
621               | ((color.g * format->direct.greenMask / rgba::MAX_CC) << format->direct.green)
622               | ((color.b * format->direct.blueMask  / rgba::MAX_CC) << format->direct.blue )
623               | ((color.a * format->direct.alphaMask / rgba::MAX_CC) << format->direct.alpha);
624
625       return true;
626     }
627   else
628     {
629       XRenderColor d;
630
631       d.red   = color.r;
632       d.green = color.g;
633       d.blue  = color.b;
634       d.alpha = color.a;
635
636       return XftColorAllocValue (screen->xdisp, screen->visual, screen->cmap, &d, &c);
637     }
638 #else
639   c.red   = color.r;
640   c.green = color.g;
641   c.blue  = color.b;
642
643   if (screen->visual->c_class == TrueColor)
644     {
645       c.pixel = (color.r * (screen->visual->red_mask   >> ctz (screen->visual->red_mask  ))
646                          / rgba::MAX_CC) << ctz (screen->visual->red_mask  )
647               | (color.g * (screen->visual->green_mask >> ctz (screen->visual->green_mask))
648                          / rgba::MAX_CC) << ctz (screen->visual->green_mask)
649               | (color.b * (screen->visual->blue_mask  >> ctz (screen->visual->blue_mask ))
650                          / rgba::MAX_CC) << ctz (screen->visual->blue_mask );
651
652       return true;
653     }
654   else if (XAllocColor (screen->xdisp, screen->cmap, &c))
655     return true;
656   else
657     c.pixel = (color.r + color.g + color.b) > 128*3
658             ? WhitePixelOfScreen (DefaultScreenOfDisplay (screen->xdisp))
659             : BlackPixelOfScreen (DefaultScreenOfDisplay (screen->xdisp));
660 #endif
661
662   return false;
663 }
664
665 bool
666 rxvt_color::set (rxvt_screen *screen, const char *name)
667 {
668   rgba c;
669   char eos;
670   int skip;
671
672   // parse the nonstandard "[alphapercent]" prefix
673   if (1 <= sscanf (name, "[%hd]%n", &c.a, &skip))
674     {
675       c.a = lerp<int, int, int> (0, rgba::MAX_CC, c.a);
676       name += skip;
677     }
678   else
679     c.a = rgba::MAX_CC;
680
681   // parse the non-standard "rgba:rrrr/gggg/bbbb/aaaa" format
682   if (strlen (name) != 4+5*4 || 4 != sscanf (name, "rgba:%4hx/%4hx/%4hx/%4hx%c", &c.r, &c.g, &c.b, &c.a, &eos))
683     {
684       XColor xc, xc_exact;
685
686       if (XParseColor (screen->xdisp, screen->cmap, name, &xc))
687         {
688           c.r = xc.red;
689           c.g = xc.green;
690           c.b = xc.blue;
691         }
692       else
693         {
694           c.r = 0xffff;
695           c.g = 0x6969;
696           c.b = 0xb4b4;
697
698           rxvt_warn ("unable to parse color '%s', using pink instead.\n", name);
699         }
700     }
701
702   return set (screen, c);
703 }
704
705 bool
706 rxvt_color::set (rxvt_screen *screen, const rgba &color)
707 {
708   bool got = alloc (screen, color);
709
710 #if !ENABLE_MINIMAL
711   int cmap_size = screen->visual->map_entries;
712
713   if (!got
714       && screen->visual->c_class == PseudoColor
715       && cmap_size < 4096)
716     {
717       XColor *colors = new XColor [screen->visual->map_entries];
718
719       for (int i = 0; i < cmap_size; i++)
720         colors [i].pixel = i;
721  
722       // many kilobytes transfer per colour, but pseudocolor isn't worth
723       // many extra optimisations.
724       XQueryColors (screen->xdisp, screen->cmap, colors, cmap_size);
725
726       int diff = 0x7fffffffUL;
727       XColor *best = colors;
728
729       for (int i = 0; i < cmap_size; i++)
730         {
731           int d = (squared_diff<int> (color.r >> 2, colors [i].red   >> 2))
732                 + (squared_diff<int> (color.g >> 2, colors [i].green >> 2))
733                 + (squared_diff<int> (color.b >> 2, colors [i].blue  >> 2));
734
735           if (d < diff)
736             {
737               diff = d;
738               best = colors + i;
739             }
740         }
741
742       //rxvt_warn ("could not allocate %04x %04x %04x, getting %04x %04x %04x instead (%d)\n",
743       //    color.r, color.g, color.b, best->red, best->green, best->blue, diff);
744           
745       got = alloc (screen, rgba (best->red, best->green, best->blue));
746
747       delete colors;
748     }
749 #endif
750
751   return got;
752 }
753
754 void
755 rxvt_color::get (rgba &color)
756 {
757 #if XFT
758   color.r = c.color.red;
759   color.g = c.color.green;
760   color.b = c.color.blue;
761   color.a = c.color.alpha;
762 #else
763   color.r = c.red;
764   color.g = c.green;
765   color.b = c.blue;
766   color.a = rgba::MAX_CC;
767 #endif
768 }
769
770 void
771 rxvt_color::get (XColor &color)
772 {
773   rgba c;
774   get (c);
775
776   color.red   = c.r;
777   color.green = c.g;
778   color.blue  = c.b;
779   color.pixel = (Pixel)*this;
780 }
781
782 void 
783 rxvt_color::free (rxvt_screen *screen)
784 {
785 #if XFT
786   XftColorFree (screen->xdisp, screen->visual, screen->cmap, &c);
787 #else
788   XFreeColors (screen->xdisp, screen->cmap, &c.pixel, 1, AllPlanes);
789 #endif
790 }
791
792 void
793 rxvt_color::fade (rxvt_screen *screen, int percent, rxvt_color &result, const rgba &to)
794 {
795   rgba c;
796   get (c);
797
798   result.set (
799     screen,
800     rgba (
801       lerp (c.r, to.r, percent),
802       lerp (c.g, to.g, percent),
803       lerp (c.b, to.b, percent),
804       lerp (c.a, to.a, percent)
805     )
806   );
807 }
808