src/motif/cursor.cpp

   1 /////////////////////////////////////////////////////////////////////////////
   2 // Name:        src/motif/cursor.cpp
   3 // Purpose:     wxCursor class
   4 // Author:      Julian Smart
   5 // Modified by:
   6 // Created:     17/09/98
   7 // RCS-ID:      $Id$
   8 // Copyright:   (c) Julian Smart
   9 // Licence:     wxWindows licence
  10 /////////////////////////////////////////////////////////////////////////////
  11
  12 // For compilers that support precompilation, includes "wx.h".
  13 #include "wx/wxprec.h"
  14
  15 #ifndef WX_PRECOMP
  16     #include "wx/list.h"
  17 #endif
  18
  19 #include "wx/cursor.h"
  20
  21 #ifndef WX_PRECOMP
  22     #include "wx/app.h"
  23     #include "wx/utils.h"
  24     #include "wx/window.h"
  25     #include "wx/image.h"
  26 #endif
  27
  28 #ifdef __VMS__
  29 #pragma message disable nosimpint
  30 #endif
  31 #include <Xm/Xm.h>
  32 #include <X11/cursorfont.h>
  33 #ifdef __VMS__
  34 #pragma message enable nosimpint
  35 #endif
  36
  37 #include "wx/motif/private.h"
  38
  39 // Cursor for one display, so we can choose the correct one for
  40 // the current display.
  41 class wxXCursor
  42 {
  43 public:
  44     WXDisplay*  m_display;
  45     WXCursor    m_cursor;
  46 };
  47
  48 WX_DECLARE_LIST(wxXCursor, wxXCursorList);
  49 #include "wx/listimpl.cpp"
  50 WX_DEFINE_LIST(wxXCursorList)
  51
  52 class WXDLLEXPORT wxCursorRefData: public wxGDIRefData
  53 {
  54 public:
  55     wxCursorRefData();
  56     virtual ~wxCursorRefData();
  57
  58     wxXCursorList m_cursors;  // wxXCursor objects, one per display
  59     wxStockCursor m_cursorId; // wxWidgets standard cursor id
  60
  61     friend class wxCursor;
  62 };
  63
  64 #define M_CURSORDATA ((wxCursorRefData *)m_refData)
  65 #define M_CURSORHANDLERDATA ((wxCursorRefData *)bitmap->m_refData)
  66
  67 IMPLEMENT_DYNAMIC_CLASS(wxCursor, wxObject)
  68
  69 wxCursorRefData::wxCursorRefData()
  70 {
  71     m_cursorId = wxCURSOR_NONE;
  72 }
  73
  74 wxCursorRefData::~wxCursorRefData()
  75 {
  76     wxXCursorList::compatibility_iterator node = m_cursors.GetFirst();
  77     while (node)
  78     {
  79         wxXCursor* c = node->GetData();
  80         XFreeCursor((Display*) c->m_display, (Cursor) c->m_cursor);
  81         delete c;
  82         node = node->GetNext();
  83     }
  84 }
  85
  86 wxCursor::wxCursor()
  87 {
  88 }
  89
  90 #if wxUSE_IMAGE
  91 wxCursor::wxCursor(const wxImage & image)
  92 {
  93     unsigned char * rgbBits = image.GetData();
  94     int w = image.GetWidth() ;
  95     int h = image.GetHeight();
  96     bool bHasMask = image.HasMask();
  97     int imagebitcount = (w*h)/8;
  98
  99     unsigned char * bits = new unsigned char [imagebitcount];
 100     unsigned char * maskBits = new unsigned char [imagebitcount];
 101
 102     int i, j, i8;
 103     unsigned char c, cMask;
 104     for (i=0; i<imagebitcount; i++)
 105     {
 106         bits[i] = 0xff;
 107         i8 = i * 8;
 108
 109         cMask = 0xfe; // 11111110
 110         for (j=0; j<8; j++)
 111         {
 112             // possible overflow if we do the summation first ?
 113             c = (unsigned char)(rgbBits[(i8+j)*3]/3 + rgbBits[(i8+j)*3+1]/3 + rgbBits[(i8+j)*3+2]/3);
 114             // if average value is > mid grey
 115             if (c>127)
 116                 bits[i] = bits[i] & cMask;
 117             cMask = (unsigned char)((cMask << 1) | 1);
 118         }
 119     }
 120
 121     if (bHasMask)
 122     {
 123         unsigned char
 124             r = image.GetMaskRed(),
 125             g = image.GetMaskGreen(),
 126             b = image.GetMaskBlue();
 127
 128         for (i=0; i<imagebitcount; i++)
 129         {
 130             maskBits[i] = 0x0;
 131             i8 = i * 8;
 132
 133             cMask = 0x1;
 134             for (j=0; j<8; j++)
 135             {
 136                 if (rgbBits[(i8+j)*3] != r || rgbBits[(i8+j)*3+1] != g || rgbBits[(i8+j)*3+2] != b)
 137                     maskBits[i] = maskBits[i] | cMask;
 138                 cMask = (unsigned char)(cMask << 1);
 139             }
 140         }
 141     }
 142     else // no mask
 143     {
 144         for (i=0; i<imagebitcount; i++)
 145             maskBits[i] = 0xFF;
 146     }
 147
 148     int hotSpotX;
 149     int hotSpotY;
 150
 151     if (image.HasOption(wxIMAGE_OPTION_CUR_HOTSPOT_X))
 152         hotSpotX = image.GetOptionInt(wxIMAGE_OPTION_CUR_HOTSPOT_X);
 153     else
 154         hotSpotX = 0;
 155
 156     if (image.HasOption(wxIMAGE_OPTION_CUR_HOTSPOT_Y))
 157         hotSpotY = image.GetOptionInt(wxIMAGE_OPTION_CUR_HOTSPOT_Y);
 158     else
 159         hotSpotY = 0;
 160
 161     if (hotSpotX < 0 || hotSpotX >= w)
 162         hotSpotX = 0;
 163     if (hotSpotY < 0 || hotSpotY >= h)
 164         hotSpotY = 0;
 165
 166     Create( (const char*)bits, w, h, hotSpotX, hotSpotY,
 167             (const char*)maskBits );
 168
 169     delete[] bits;
 170     delete[] maskBits;
 171 }
 172 #endif
 173
 174 void wxCursor::Create(const char bits[], int width, int height,
 175                       int hotSpotX, int hotSpotY, const char maskBits[])
 176 {
 177     if( !m_refData )
 178         m_refData = new wxCursorRefData;
 179
 180     Display *dpy = (Display*) wxGetDisplay();
 181     int screen_num =  DefaultScreen (dpy);
 182
 183     Pixmap pixmap = XCreatePixmapFromBitmapData (dpy,
 184                                           RootWindow (dpy, screen_num),
 185                                           (char*) bits, width, height,
 186                                           1 , 0 , 1);
 187
 188     Pixmap mask_pixmap = None;
 189     if (maskBits != NULL)
 190     {
 191         mask_pixmap = XCreatePixmapFromBitmapData (dpy,
 192                                           RootWindow (dpy, screen_num),
 193                                           (char*) maskBits, width, height,
 194                                           1 , 0 , 1);
 195     }
 196
 197     Create( (WXPixmap)pixmap, (WXPixmap)mask_pixmap, hotSpotX, hotSpotY );
 198
 199     XFreePixmap( dpy, pixmap );
 200     if (mask_pixmap != None)
 201     {
 202         XFreePixmap( dpy, mask_pixmap );
 203     }
 204 }
 205
 206 void wxCursor::Create(WXPixmap pixmap, WXPixmap mask_pixmap,
 207                       int hotSpotX, int hotSpotY)
 208 {
 209     if( !m_refData )
 210         m_refData = new wxCursorRefData;
 211
 212     Display *dpy = (Display*) wxGetDisplay();
 213     int screen_num =  DefaultScreen (dpy);
 214
 215     XColor foreground_color;
 216     XColor background_color;
 217     foreground_color.pixel = BlackPixel(dpy, screen_num);
 218     background_color.pixel = WhitePixel(dpy, screen_num);
 219     Colormap cmap = (Colormap) wxTheApp->GetMainColormap((WXDisplay*) dpy);
 220     XQueryColor(dpy, cmap, &foreground_color);
 221     XQueryColor(dpy, cmap, &background_color);
 222
 223     Cursor cursor = XCreatePixmapCursor (dpy,
 224                                   (Pixmap)pixmap,
 225                                   (Pixmap)mask_pixmap,
 226                                   &foreground_color,
 227                                   &background_color,
 228                                   hotSpotX ,
 229                                   hotSpotY);
 230
 231     if (cursor)
 232     {
 233         wxXCursor *c = new wxXCursor;
 234
 235         c->m_cursor = (WXCursor) cursor;
 236         c->m_display = (WXDisplay*) dpy;
 237         M_CURSORDATA->m_cursors.Append(c);
 238     }
 239 }
 240
 241 wxCursor::wxCursor(const char bits[], int width, int height,
 242                    int hotSpotX, int hotSpotY, const char maskBits[])
 243 {
 244     Create(bits, width, height, hotSpotX, hotSpotY, maskBits);
 245 }
 246
 247 wxCursor::wxCursor(const wxString& name, long flags, int hotSpotX, int hotSpotY)
 248 {
 249     // Must be an XBM file
 250     if (flags != wxBITMAP_TYPE_XBM)
 251         return;
 252
 253     m_refData = new wxCursorRefData;
 254
 255     int hotX = -1, hotY = -1;
 256     unsigned int w, h;
 257     Pixmap pixmap = None, mask_pixmap = None;
 258
 259     Display *dpy = (Display*) wxGetDisplay();
 260     int screen_num =  DefaultScreen (dpy);
 261
 262     int value = XReadBitmapFile (dpy, RootWindow (dpy, screen_num),
 263                                  name.mb_str(),
 264                                  &w, &h, &pixmap, &hotX, &hotY);
 265
 266     if (value == BitmapSuccess)
 267     {
 268         // TODO: how do we determine whether hotX, hotY were read correctly?
 269         if (hotX < 0 || hotY < 0)
 270         {
 271             hotX = hotSpotX;
 272             hotY = hotSpotY;
 273         }
 274         if (hotX < 0 || hotY < 0)
 275         {
 276             hotX = 0;
 277             hotY = 0;
 278         }
 279
 280         Create( (WXPixmap)pixmap, (WXPixmap)mask_pixmap, hotX, hotY );
 281
 282         XFreePixmap( dpy, pixmap );
 283     }
 284 }
 285
 286 // Cursors by stock number
 287 wxCursor::wxCursor(wxStockCursor id)
 288 {
 289     m_refData = new wxCursorRefData;
 290     M_CURSORDATA->m_cursorId = id;
 291 }
 292
 293 wxCursor::~wxCursor()
 294 {
 295 }
 296
 297 wxGDIRefData *wxCursor::CreateGDIRefData() const
 298 {
 299     return new wxCursorRefData;
 300 }
 301
 302 wxGDIRefData *wxCursor::CloneGDIRefData(const wxGDIRefData *data) const
 303 {
 304     return new wxCursorRefData(*wx_static_cast(const wxCursorRefData *, data));
 305 }
 306
 307 // Motif-specific: create/get a cursor for the current display
 308 WXCursor wxCursor::GetXCursor(WXDisplay* display) const
 309 {
 310     if (!M_CURSORDATA)
 311         return (WXCursor) 0;
 312     wxXCursorList::compatibility_iterator node = M_CURSORDATA->m_cursors.GetFirst();
 313     while (node)
 314     {
 315         wxXCursor* c = node->GetData();
 316         if (c->m_display == display)
 317             return c->m_cursor;
 318         node = node->GetNext();
 319     }
 320
 321     // No cursor for this display, so let's see if we're an id-type cursor.
 322
 323     if (M_CURSORDATA->m_cursorId != wxCURSOR_NONE)
 324     {
 325         WXCursor cursor = MakeCursor(display, M_CURSORDATA->m_cursorId);
 326         if (cursor)
 327         {
 328             wxXCursor* c = new wxXCursor;
 329             c->m_cursor = cursor;
 330             c->m_display = display;
 331             M_CURSORDATA->m_cursors.Append(c);
 332             return cursor;
 333         }
 334         else
 335             return (WXCursor) 0;
 336     }
 337
 338     // Not an id-type cursor, so we don't know how to create it.
 339     return (WXCursor) 0;
 340 }
 341
 342 // Make a cursor from standard id
 343 WXCursor wxCursor::MakeCursor(WXDisplay* display, wxStockCursor id) const
 344 {
 345     Display* dpy = (Display*) display;
 346     Cursor cursor = (Cursor) 0;
 347     int x_cur = -1;
 348
 349     switch (id)
 350     {
 351     case wxCURSOR_CHAR:             return (WXCursor)cursor;
 352
 353     case wxCURSOR_WAIT:             x_cur = XC_watch; break;
 354     case wxCURSOR_CROSS:            x_cur = XC_crosshair; break;
 355     case wxCURSOR_HAND:             x_cur = XC_hand1; break;
 356     case wxCURSOR_BULLSEYE:         x_cur = XC_target; break;
 357     case wxCURSOR_PENCIL:           x_cur = XC_pencil; break;
 358     case wxCURSOR_MAGNIFIER:        x_cur = XC_sizing; break;
 359     case wxCURSOR_IBEAM:            x_cur = XC_xterm; break;
 360     case wxCURSOR_NO_ENTRY:         x_cur = XC_pirate; break;
 361     case wxCURSOR_LEFT_BUTTON:      x_cur = XC_leftbutton; break;
 362     case wxCURSOR_RIGHT_BUTTON:     x_cur = XC_rightbutton; break;
 363     case wxCURSOR_MIDDLE_BUTTON:    x_cur =  XC_middlebutton; break;
 364     case wxCURSOR_QUESTION_ARROW:   x_cur = XC_question_arrow; break;
 365     case wxCURSOR_SIZING:           x_cur = XC_sizing; break;
 366     case wxCURSOR_WATCH:            x_cur = XC_watch; break;
 367     case wxCURSOR_SPRAYCAN:         x_cur = XC_spraycan; break;
 368     case wxCURSOR_PAINT_BRUSH:      x_cur = XC_spraycan; break;
 369     case wxCURSOR_SIZENWSE:
 370     case wxCURSOR_SIZENESW:         x_cur = XC_crosshair; break;
 371     case wxCURSOR_SIZEWE:           x_cur = XC_sb_h_double_arrow; break;
 372     case wxCURSOR_SIZENS:           x_cur = XC_sb_v_double_arrow; break;
 373     case wxCURSOR_POINT_LEFT:       x_cur = XC_sb_left_arrow; break;
 374     case wxCURSOR_POINT_RIGHT:      x_cur = XC_sb_right_arrow; break;
 375         // (JD Huggins) added more stock cursors for X
 376         // X-only cursors BEGIN
 377     case wxCURSOR_CROSS_REVERSE:    x_cur = XC_cross_reverse; break;
 378     case wxCURSOR_DOUBLE_ARROW:     x_cur = XC_double_arrow; break;
 379     case wxCURSOR_BASED_ARROW_UP:   x_cur = XC_based_arrow_up; break;
 380     case wxCURSOR_BASED_ARROW_DOWN: x_cur = XC_based_arrow_down; break;
 381     case wxCURSOR_BLANK:
 382     {
 383         GC gc;
 384         XGCValues gcv;
 385         Pixmap empty_pixmap;
 386         XColor blank_color;
 387
 388         empty_pixmap =
 389             XCreatePixmap (dpy, RootWindow (dpy, DefaultScreen (dpy)),
 390                            16, 16, 1);
 391         gcv.function = GXxor;
 392         gc = XCreateGC (dpy,
 393                         empty_pixmap,
 394                         GCFunction,
 395                         &gcv);
 396         XCopyArea (dpy,
 397                    empty_pixmap,
 398                    empty_pixmap,
 399                    gc,
 400                    0, 0,
 401                    16, 16,
 402                    0, 0);
 403         XFreeGC (dpy, gc);
 404         cursor = XCreatePixmapCursor (dpy,
 405                                       empty_pixmap,
 406                                       empty_pixmap,
 407                                       &blank_color,
 408                                       &blank_color,
 409                                       8, 8);
 410
 411         break;
 412     }
 413     case wxCURSOR_ARROW:
 414     default:       x_cur =  XC_top_left_arrow; break;
 415     }
 416
 417     if( x_cur == -1 )
 418         return (WXCursor)cursor;
 419
 420     cursor = XCreateFontCursor (dpy, x_cur);
 421     return (WXCursor) cursor;
 422 }
 423
 424 // Global cursor setting
 425 void wxSetCursor(const wxCursor& WXUNUSED(cursor))
 426 {
 427   // Nothing to do for Motif (no global cursor)
 428 }
 429
 430
 431 // ----------------------------------------------------------------------------
 432 // busy cursor stuff
 433 // ----------------------------------------------------------------------------
 434
 435 static int wxBusyCursorCount = 0;
 436
 437 // Helper function
 438 static void
 439 wxXSetBusyCursor (wxWindow * win, const wxCursor * cursor)
 440 {
 441     Display *display = (Display*) win->GetXDisplay();
 442
 443     Window xwin = (Window) win->GetXWindow();
 444     if (!xwin)
 445        return;
 446
 447     XSetWindowAttributes attrs;
 448
 449     if (cursor)
 450     {
 451         attrs.cursor = (Cursor) cursor->GetXCursor(display);
 452     }
 453     else
 454     {
 455         // Restore old cursor
 456         if (win->GetCursor().Ok())
 457             attrs.cursor = (Cursor) win->GetCursor().GetXCursor(display);
 458         else
 459             attrs.cursor = None;
 460     }
 461     if (xwin)
 462         XChangeWindowAttributes (display, xwin, CWCursor, &attrs);
 463
 464     XFlush (display);
 465
 466     for(wxWindowList::compatibility_iterator node = win->GetChildren().GetFirst (); node;
 467         node = node->GetNext())
 468     {
 469         wxWindow *child = node->GetData ();
 470         wxXSetBusyCursor (child, cursor);
 471     }
 472 }
 473
 474 // Set the cursor to the busy cursor for all windows
 475 void wxBeginBusyCursor(const wxCursor *cursor)
 476 {
 477     wxBusyCursorCount++;
 478     if (wxBusyCursorCount == 1)
 479     {
 480         for(wxWindowList::compatibility_iterator node = wxTopLevelWindows.GetFirst (); node;
 481             node = node->GetNext())
 482         {
 483             wxWindow *win = node->GetData ();
 484             wxXSetBusyCursor (win, cursor);
 485         }
 486     }
 487 }
 488
 489 // Restore cursor to normal
 490 void wxEndBusyCursor()
 491 {
 492     if (wxBusyCursorCount == 0)
 493         return;
 494
 495     wxBusyCursorCount--;
 496     if (wxBusyCursorCount == 0)
 497     {
 498         for(wxWindowList::compatibility_iterator node = wxTopLevelWindows.GetFirst (); node;
 499             node = node->GetNext())
 500         {
 501             wxWindow *win = node->GetData ();
 502             wxXSetBusyCursor (win, NULL);
 503         }
 504     }
 505 }
 506
 507 // true if we're between the above two calls
 508 bool wxIsBusy()
 509 {
 510     return (wxBusyCursorCount > 0);
 511 }