otk/display.cc

   1 // -*- mode: C++; indent-tabs-mode: nil; c-basic-offset: 2; -*-
   2
   3 #ifdef HAVE_CONFIG_H
   4 # include "../config.h"
   5 #endif
   6
   7 #include "display.hh"
   8 #include "screeninfo.hh"
   9 #include "gccache.hh"
  10 #include "util.hh"
  11
  12 extern "C" {
  13 #include <X11/keysym.h>
  14
  15 #ifdef    XKB
  16 #include <X11/XKBlib.h>
  17 #endif // XKB
  18
  19 #ifdef    SHAPE
  20 #include <X11/extensions/shape.h>
  21 #endif // SHAPE
  22
  23 #ifdef    XINERAMA
  24 #include <X11/extensions/Xinerama.h>
  25 #endif // XINERAMA
  26
  27 #ifdef    HAVE_STDIO_H
  28 #  include <stdio.h>
  29 #endif // HAVE_STDIO_H
  30
  31 #ifdef    HAVE_SIGNAL_H
  32 #  include <signal.h>
  33 #endif // HAVE_SIGNAL_H
  34
  35 #ifdef    HAVE_FCNTL_H
  36 #  include <fcntl.h>
  37 #endif // HAVE_FCNTL_H
  38
  39 #ifdef    HAVE_UNISTD_H
  40 #  include <sys/types.h>
  41 #  include <unistd.h>
  42 #endif // HAVE_UNISTD_H
  43
  44 #include "gettext.h"
  45 #define _(str) gettext(str)
  46 }
  47
  48 namespace otk {
  49
  50
  51 Display *OBDisplay::display = (Display*) 0;
  52 bool OBDisplay::_xkb = false;
  53 int  OBDisplay::_xkb_event_basep = 0;
  54 bool OBDisplay::_shape = false;
  55 int  OBDisplay::_shape_event_basep = 0;
  56 bool OBDisplay::_xinerama = false;
  57 int  OBDisplay::_xinerama_event_basep = 0;
  58 unsigned int OBDisplay::_mask_list[8];
  59 unsigned int OBDisplay::_scrollLockMask = 0;
  60 unsigned int OBDisplay::_numLockMask = 0;
  61 OBDisplay::ScreenInfoList OBDisplay::_screenInfoList;
  62 BGCCache *OBDisplay::_gccache = (BGCCache*) 0;
  63 int OBDisplay::_grab_count = 0;
  64
  65
  66 int OBDisplay::xerrorHandler(Display *d, XErrorEvent *e)
  67 {
  68 #ifdef DEBUG
  69   char errtxt[128];
  70
  71   //if (e->error_code != BadWindow)
  72   {
  73     XGetErrorText(d, e->error_code, errtxt, 128);
  74     printf("X Error: %s\n", errtxt);
  75     if (e->error_code != BadWindow)
  76       abort();
  77   }
  78 #else
  79   (void)d;
  80   (void)e;
  81 #endif
  82
  83   return false;
  84 }
  85
  86
  87 void OBDisplay::initialize(char *name)
  88 {
  89   int junk;
  90   (void)junk;
  91
  92   // Open the X display
  93   if (!(display = XOpenDisplay(name))) {
  94     printf(_("Unable to open connection to the X server. Please set the \n\
  95 DISPLAY environment variable approriately, or use the '-display' command \n\
  96 line argument.\n\n"));
  97     ::exit(1);
  98   }
  99   if (fcntl(ConnectionNumber(display), F_SETFD, 1) == -1) {
 100     printf(_("Couldn't mark display connection as close-on-exec.\n\n"));
 101     ::exit(1);
 102   }
 103
 104   // set our error handler for X errors
 105   XSetErrorHandler(xerrorHandler);
 106
 107   // set the DISPLAY environment variable for any lauched children, to the
 108   // display we're using, so they open in the right place.
 109   // XXX rm -> std::string dtmp = "DISPLAY=" + DisplayString(display);
 110   putenv(std::string("DISPLAY=") + DisplayString(display));
 111
 112   // find the availability of X extensions we like to use
 113 #ifdef XKB
 114   _xkb = XkbQueryExtension(display, &junk, &_xkb_event_basep, &junk, NULL,
 115                            NULL);
 116 #endif
 117
 118 #ifdef SHAPE
 119   _shape = XShapeQueryExtension(display, &_shape_event_basep, &junk);
 120 #endif
 121
 122 #ifdef XINERAMA
 123   _xinerama = XineramaQueryExtension(display, &_xinerama_event_basep, &junk);
 124 #endif // XINERAMA
 125
 126   // get lock masks that are defined by the display (not constant)
 127   XModifierKeymap *modmap;
 128
 129   modmap = XGetModifierMapping(display);
 130   if (modmap && modmap->max_keypermod > 0) {
 131     const int mask_table[] = {
 132       ShiftMask, LockMask, ControlMask, Mod1Mask,
 133       Mod2Mask, Mod3Mask, Mod4Mask, Mod5Mask
 134     };
 135     const size_t size = (sizeof(mask_table) / sizeof(mask_table[0])) *
 136       modmap->max_keypermod;
 137     // get the values of the keyboard lock modifiers
 138     // Note: Caps lock is not retrieved the same way as Scroll and Num lock
 139     // since it doesn't need to be.
 140     const KeyCode num_lock = XKeysymToKeycode(display, XK_Num_Lock);
 141     const KeyCode scroll_lock = XKeysymToKeycode(display, XK_Scroll_Lock);
 142
 143     for (size_t cnt = 0; cnt < size; ++cnt) {
 144       if (! modmap->modifiermap[cnt]) continue;
 145
 146       if (num_lock == modmap->modifiermap[cnt])
 147         _numLockMask = mask_table[cnt / modmap->max_keypermod];
 148       if (scroll_lock == modmap->modifiermap[cnt])
 149         _scrollLockMask = mask_table[cnt / modmap->max_keypermod];
 150     }
 151   }
 152
 153   if (modmap) XFreeModifiermap(modmap);
 154
 155   _mask_list[0] = 0;
 156   _mask_list[1] = LockMask;
 157   _mask_list[2] = _numLockMask;
 158   _mask_list[3] = LockMask | _numLockMask;
 159   _mask_list[4] = _scrollLockMask;
 160   _mask_list[5] = _scrollLockMask | LockMask;
 161   _mask_list[6] = _scrollLockMask | _numLockMask;
 162   _mask_list[7] = _scrollLockMask | LockMask | _numLockMask;
 163
 164   // Get information on all the screens which are available.
 165   _screenInfoList.reserve(ScreenCount(display));
 166   for (int i = 0; i < ScreenCount(display); ++i)
 167     _screenInfoList.push_back(ScreenInfo(i));
 168
 169   _gccache = new BGCCache(_screenInfoList.size());
 170 }
 171
 172
 173 void OBDisplay::destroy()
 174 {
 175   delete _gccache;
 176   while (_grab_count > 0)
 177     ungrab();
 178   XCloseDisplay(display);
 179 }
 180
 181
 182 const ScreenInfo* OBDisplay::screenInfo(int snum) {
 183   assert(snum >= 0);
 184   assert(snum < static_cast<int>(_screenInfoList.size()));
 185   return &_screenInfoList[snum];
 186 }
 187
 188
 189 const ScreenInfo* OBDisplay::findScreen(Window root)
 190 {
 191   ScreenInfoList::iterator it, end = _screenInfoList.end();
 192   for (it = _screenInfoList.begin(); it != end; ++it)
 193     if (it->rootWindow() == root)
 194       return &(*it);
 195   return 0;
 196 }
 197
 198
 199 void OBDisplay::grab()
 200 {
 201   if (_grab_count == 0)
 202     XGrabServer(display);
 203   _grab_count++;
 204 }
 205
 206
 207 void OBDisplay::ungrab()
 208 {
 209   if (_grab_count == 0) return;
 210   _grab_count--;
 211   if (_grab_count == 0)
 212     XUngrabServer(display);
 213 }
 214
 215
 216
 217
 218
 219
 220
 221 /*
 222  * Grabs a button, but also grabs the button in every possible combination
 223  * with the keyboard lock keys, so that they do not cancel out the event.
 224
 225  * if allow_scroll_lock is true then only the top half of the lock mask
 226  * table is used and scroll lock is ignored.  This value defaults to false.
 227  */
 228 void OBDisplay::grabButton(unsigned int button, unsigned int modifiers,
 229                          Window grab_window, bool owner_events,
 230                          unsigned int event_mask, int pointer_mode,
 231                          int keyboard_mode, Window confine_to,
 232                          Cursor cursor, bool allow_scroll_lock) {
 233   unsigned int length = (allow_scroll_lock) ? 8 / 2:
 234                                               8;
 235   for (size_t cnt = 0; cnt < length; ++cnt)
 236     XGrabButton(otk::OBDisplay::display, button, modifiers | _mask_list[cnt],
 237                 grab_window, owner_events, event_mask, pointer_mode,
 238                 keyboard_mode, confine_to, cursor);
 239 }
 240
 241
 242 /*
 243  * Releases the grab on a button, and ungrabs all possible combinations of the
 244  * keyboard lock keys.
 245  */
 246 void OBDisplay::ungrabButton(unsigned int button, unsigned int modifiers,
 247                            Window grab_window) {
 248   for (size_t cnt = 0; cnt < 8; ++cnt)
 249     XUngrabButton(otk::OBDisplay::display, button, modifiers | _mask_list[cnt],
 250                   grab_window);
 251 }
 252
 253 void OBDisplay::grabKey(unsigned int keycode, unsigned int modifiers,
 254                         Window grab_window, bool owner_events,
 255                         int pointer_mode, int keyboard_mode,
 256                         bool allow_scroll_lock)
 257 {
 258   unsigned int length = (allow_scroll_lock) ? 8 / 2:
 259                                               8;
 260   for (size_t cnt = 0; cnt < length; ++cnt)
 261     XGrabKey(otk::OBDisplay::display, keycode, modifiers | _mask_list[cnt],
 262                 grab_window, owner_events, pointer_mode, keyboard_mode);
 263 }
 264
 265 void OBDisplay::ungrabKey(unsigned int keycode, unsigned int modifiers,
 266                           Window grab_window)
 267 {
 268   for (size_t cnt = 0; cnt < 8; ++cnt)
 269     XUngrabKey(otk::OBDisplay::display, keycode, modifiers | _mask_list[cnt],
 270                grab_window);
 271 }
 272
 273 }