experimental --inplace flag implementation

[wxWidgets.git] / src / motif / cursor.cpp

/////////////////////////////////////////////////////////////////////////////
// Name:        cursor.cpp
// Purpose:     wxCursor class
// Author:      Julian Smart
// Modified by:
// Created:     17/09/98
// RCS-ID:      $Id$
// Copyright:   (c) Julian Smart
// Licence:   	wxWindows licence
/////////////////////////////////////////////////////////////////////////////

#ifdef __GNUG__
#pragma implementation "cursor.h"
#endif

#include "wx/cursor.h"
#include "wx/gdicmn.h"
#include "wx/icon.h"
#include "wx/app.h"
#include "wx/utils.h"
#if wxUSE_IMAGE
#include "wx/image.h"
#endif									     

#ifdef __VMS__
#pragma message disable nosimpint
#endif
#include <Xm/Xm.h>
#include <X11/cursorfont.h>
#ifdef __VMS__
#pragma message enable nosimpint
#endif

#include "wx/motif/private.h"

IMPLEMENT_DYNAMIC_CLASS(wxCursor, wxBitmap)
IMPLEMENT_DYNAMIC_CLASS(wxXCursor, wxObject)

wxCursorRefData::wxCursorRefData()
{
    m_width = 32; m_height = 32;
    m_cursorId = wxCURSOR_NONE;
}

wxCursorRefData::~wxCursorRefData()
{
    wxNode* node = m_cursors.First();
    while (node)
    {
        wxXCursor* c = (wxXCursor*) node->Data();
        // TODO: how to delete cursor?
        // XDestroyCursor((Display*) c->m_display, (Cursor) c->m_cursor); // ??
        delete c;
        node = node->Next();
    }
}

wxCursor::wxCursor()
{
}

#if wxUSE_IMAGE
wxCursor::wxCursor(const wxImage & image)
{
    unsigned char * rgbBits = image.GetData();
    int w = image.GetWidth() ;
    int h = image.GetHeight();
    bool bHasMask = image.HasMask();
    int imagebitcount = (w*h)/8;

    unsigned char * bits = new unsigned char [imagebitcount];
    unsigned char * maskBits = new unsigned char [imagebitcount];

    int i, j, i8; unsigned char c, cMask;
    for (i=0; i<imagebitcount; i++)
    {
        bits[i] = 0;
        i8 = i * 8;

        cMask = 1;
        for (j=0; j<8; j++)
        {
            // possible overflow if we do the summation first ?
            c = rgbBits[(i8+j)*3]/3 + rgbBits[(i8+j)*3+1]/3 + rgbBits[(i8+j)*3+2]/3;
            //if average value is > mid grey
            if (c>127)
                bits[i] = bits[i] | cMask;
            cMask = cMask * 2;
        }
    }

    unsigned long keyMaskColor;
    if (bHasMask)
    {
        unsigned char
            r = image.GetMaskRed(),
            g = image.GetMaskGreen(),
            b = image.GetMaskBlue();

        for (i=0; i<imagebitcount; i++)
        {
            maskBits[i] = 0x0;
            i8 = i * 8;

            cMask = 1;
            for (j=0; j<8; j++)
            {
                if (rgbBits[(i8+j)*3] != r || rgbBits[(i8+j)*3+1] != g || rgbBits[(i8+j)*3+2] != b)
                    maskBits[i] = maskBits[i] | cMask;
                cMask = cMask * 2;
            }
        }

        keyMaskColor = (r << 16) | (g << 8) | b;
    }
    else // no mask
    {
        for (i=0; i<imagebitcount; i++)
            maskBits[i] = 0xFF;

        // init it to avoid compiler warnings
        keyMaskColor = 0;
    }
/*
    // find the most frequent color(s)
    wxImageHistogram histogram;
    image.ComputeHistogram(histogram);

    // colors as rrggbb
    unsigned long key;
    unsigned long value;

    long colMostFreq = 0;
    unsigned long nMost = 0;
    long colNextMostFreq = 0;
    unsigned long nNext = 0;
    for ( wxImageHistogram::iterator entry = histogram.begin();
          entry != histogram.end();
          ++entry )
    {
        value = entry->second.value;
        key = entry->first;
        if ( !bHasMask || (key != keyMaskColor) )
        {
            if (value > nMost)
            {
                nMost = value;
                colMostFreq = key;
            }
            else if (value > nNext)
            {
                nNext = value;
                colNextMostFreq = key;
            }
        }
    }

    wxColour fg = wxColour ( (unsigned char)(colMostFreq >> 16),
                             (unsigned char)(colMostFreq >> 8),
                             (unsigned char)(colMostFreq) );

    wxColour bg = wxColour ( (unsigned char)(colNextMostFreq >> 16),
                             (unsigned char)(colNextMostFreq >> 8),
                             (unsigned char)(colNextMostFreq) );
end of color code
 */
    int hotSpotX;
    int hotSpotY;

    if (image.HasOption(wxCUR_HOTSPOT_X))
        hotSpotX = image.GetOptionInt(wxCUR_HOTSPOT_X);
    else
        hotSpotX = 0;

    if (image.HasOption(wxCUR_HOTSPOT_Y))
        hotSpotY = image.GetOptionInt(wxCUR_HOTSPOT_Y);
    else
        hotSpotY = 0;

    if (hotSpotX < 0 || hotSpotX >= w)
        hotSpotX = 0;
    if (hotSpotY < 0 || hotSpotY >= h)
        hotSpotY = 0;
   
    m_refData = new wxCursorRefData;

    Display *dpy = (Display*) wxGetDisplay();
    int screen_num =  DefaultScreen (dpy);

    Pixmap pixmap = XCreatePixmapFromBitmapData (dpy,
                                          RootWindow (dpy, DefaultScreen(dpy)),
                                          (char*) bits, w, h,
                                          1 , 0 , 1);

    Pixmap mask_pixmap = None;
    if (maskBits != NULL)
    {
        mask_pixmap = XCreatePixmapFromBitmapData (dpy,
                                          RootWindow (dpy, DefaultScreen(dpy)),
                                          (char*) maskBits, w, h,
                                          1 , 0 , 1);
    }

    XColor foreground_color;
    XColor background_color;
    foreground_color.pixel = BlackPixel(dpy, screen_num);
    background_color.pixel = WhitePixel(dpy, screen_num);
    Colormap cmap = (Colormap) wxTheApp->GetMainColormap((WXDisplay*) dpy);
    XQueryColor(dpy, cmap, &foreground_color);
    XQueryColor(dpy, cmap, &background_color);

    Cursor cursor = XCreatePixmapCursor (dpy,
                                  pixmap,
                                  mask_pixmap,
                                  &foreground_color,
                                  &background_color,
                                  hotSpotX , 
                                  hotSpotY);

    XFreePixmap( dpy, pixmap );
    if (mask_pixmap != None)
    {
        XFreePixmap( dpy, mask_pixmap );
    }

    if (cursor)
    {
        wxXCursor *c = new wxXCursor;

        c->m_cursor = (WXCursor) cursor;
        c->m_display = (WXDisplay*) dpy;
        M_CURSORDATA->m_cursors.Append(c);
        M_CURSORDATA->m_ok = TRUE;
    }
    else
    {
        M_CURSORDATA->m_ok = TRUE;
    }
    
}
#endif

wxCursor::wxCursor(const char bits[], int width, int height,
    int hotSpotX, int hotSpotY, const char maskBits[])
{
    m_refData = new wxCursorRefData;

    Display *dpy = (Display*) wxGetDisplay();
    int screen_num =  DefaultScreen (dpy);

    Pixmap pixmap = XCreatePixmapFromBitmapData (dpy,
                                          RootWindow (dpy, DefaultScreen(dpy)),
                                          (char*) bits, width, height,
                                          1 , 0 , 1);

    Pixmap mask_pixmap = None;
    if (maskBits != NULL)
    {
        mask_pixmap = XCreatePixmapFromBitmapData (dpy,
                                          RootWindow (dpy, DefaultScreen(dpy)),
                                          (char*) maskBits, width, height,
                                          1 , 0 , 1);
    }

    XColor foreground_color;
    XColor background_color;
    foreground_color.pixel = BlackPixel(dpy, screen_num);
    background_color.pixel = WhitePixel(dpy, screen_num);
    Colormap cmap = (Colormap) wxTheApp->GetMainColormap((WXDisplay*) dpy);
    XQueryColor(dpy, cmap, &foreground_color);
    XQueryColor(dpy, cmap, &background_color);

    Cursor cursor = XCreatePixmapCursor (dpy,
                                  pixmap,
                                  mask_pixmap,
                                  &foreground_color,
                                  &background_color,
                                  hotSpotX , 
                                  hotSpotY);

    XFreePixmap( dpy, pixmap );
    if (mask_pixmap != None)
    {
        XFreePixmap( dpy, mask_pixmap );
    }

    if (cursor)
    {
        wxXCursor *c = new wxXCursor;

        c->m_cursor = (WXCursor) cursor;
        c->m_display = (WXDisplay*) dpy;
        M_CURSORDATA->m_cursors.Append(c);
        M_CURSORDATA->m_ok = TRUE;
    }
    else
    {
        M_CURSORDATA->m_ok = TRUE;
    }
}

wxCursor::wxCursor(const wxString& name, long flags, int hotSpotX, int hotSpotY)
{
    // Must be an XBM file
    if (flags != wxBITMAP_TYPE_XBM)
        return;

    m_refData = new wxCursorRefData;

    int hotX = -1, hotY = -1;
    unsigned int w, h;
    Pixmap pixmap;

    Display *dpy = (Display*) wxGetDisplay();
    int screen_num =  DefaultScreen (dpy);

    int value = XReadBitmapFile (dpy, RootWindow (dpy, DefaultScreen (dpy)),
                        (char*) (const char*) name, &w, &h, &pixmap, &hotX, &hotY);

    M_BITMAPDATA->m_width = w;
    M_BITMAPDATA->m_height = h;
    M_BITMAPDATA->m_depth = 1;

    if ((value == BitmapFileInvalid) ||
        (value == BitmapOpenFailed) ||
        (value == BitmapNoMemory))
    {
    }
    else
    {
        XColor foreground_color;
        XColor background_color;
        foreground_color.pixel = BlackPixel(dpy, screen_num);
        background_color.pixel = WhitePixel(dpy, screen_num);
        Colormap cmap = (Colormap) wxTheApp->GetMainColormap((WXDisplay*) dpy);
        XQueryColor(dpy, cmap, &foreground_color);
        XQueryColor(dpy, cmap, &background_color);

        // TODO: how do we determine whether hotX, hotY were read correctly?
        if (hotX < 0 || hotY < 0)
        {
            hotX = hotSpotX;
            hotY = hotSpotY;
        }
        if (hotX < 0 || hotY < 0)
        {
            hotX = 0;
            hotY = 0;
        }

        Pixmap mask_pixmap = None;
        Cursor cursor = XCreatePixmapCursor (dpy,
                                      pixmap,
                                      mask_pixmap,
                                      &foreground_color,
                                      &background_color,
                                      hotX,
                                      hotY);

        XFreePixmap( dpy, pixmap );
        if (cursor)
        {
            wxXCursor *c = new wxXCursor;

            c->m_cursor = (WXCursor) cursor;
            c->m_display = (WXDisplay*) dpy;
            M_CURSORDATA->m_cursors.Append(c);
            M_CURSORDATA->m_ok = TRUE;
        }
    }

}

// Cursors by stock number
wxCursor::wxCursor(wxStockCursor id)
{
    m_refData = new wxCursorRefData;
    M_CURSORDATA->m_cursorId = id;
    M_CURSORDATA->m_ok = TRUE;

    WXDisplay* display = wxGetDisplay();
    if (!display)
      return;

    WXCursor cursor = GetXCursor(display);
    if (cursor)
    {
        wxXCursor* c = new wxXCursor;
        c->m_cursor = cursor;
        c->m_display = wxGetDisplay();
        M_CURSORDATA->m_cursors.Append(c);
        M_CURSORDATA->m_ok = TRUE;
    }
}

wxCursor::~wxCursor()
{
}

// Motif-specific: create/get a cursor for the current display
WXCursor wxCursor::GetXCursor(WXDisplay* display)
{
    if (!M_CURSORDATA)
        return (WXCursor) 0;
    wxNode* node = M_CURSORDATA->m_cursors.First();
    while (node)
    {
        wxXCursor* c = (wxXCursor*) node->Data();
        if (c->m_display == display)
            return c->m_cursor;
        node = node->Next();
    }

    // No cursor for this display, so let's see if we're an id-type cursor.

    if (M_CURSORDATA->m_cursorId != wxCURSOR_NONE)
    {
        WXCursor cursor = MakeCursor(display, M_CURSORDATA->m_cursorId);
        if (cursor)
        {
            wxXCursor* c = new wxXCursor;
            c->m_cursor = cursor;
            c->m_display = display;
            M_CURSORDATA->m_cursors.Append(c);
            return cursor;
        }
        else
            return (WXCursor) 0;
    }

    // Not an id-type cursor, so we don't know how to create it.
    return (WXCursor) 0;
}

// Make a cursor from standard id
WXCursor wxCursor::MakeCursor(WXDisplay* display, wxStockCursor id)
{
    Display* dpy = (Display*) display;
    Cursor cursor = (Cursor) 0;

    switch (id)
    {
        case wxCURSOR_WAIT:
        {
            cursor = XCreateFontCursor (dpy, XC_watch);
            break;
        }
        case wxCURSOR_CROSS:
        {
            cursor = XCreateFontCursor (dpy, XC_crosshair);
            break;
        }
        case wxCURSOR_CHAR:
        {
            // Nothing
            break;
        }
        case wxCURSOR_HAND:
        {
            cursor = XCreateFontCursor (dpy, XC_hand1);
            break;
        }
        case wxCURSOR_BULLSEYE:
        {
            cursor = XCreateFontCursor (dpy, XC_target);
            break;
        }
        case wxCURSOR_PENCIL:
       {
            cursor = XCreateFontCursor (dpy, XC_pencil);
            break;
        }
        case wxCURSOR_MAGNIFIER:
        {
            cursor = XCreateFontCursor (dpy, XC_sizing);
            break;
        }
        case wxCURSOR_IBEAM:
        {
            cursor = XCreateFontCursor (dpy, XC_xterm);
            break;
        }
        case wxCURSOR_NO_ENTRY:
        {
            cursor = XCreateFontCursor (dpy, XC_pirate);
            break;
        }
        case wxCURSOR_LEFT_BUTTON:
        {
            cursor = XCreateFontCursor (dpy, XC_leftbutton);
            break;
        }
        case wxCURSOR_RIGHT_BUTTON:
        {
            cursor = XCreateFontCursor (dpy, XC_rightbutton);
            break;
        }
        case wxCURSOR_MIDDLE_BUTTON:
        {
            cursor = XCreateFontCursor (dpy, XC_middlebutton);
            break;
        }
        case wxCURSOR_QUESTION_ARROW:
        {
            cursor = XCreateFontCursor (dpy, XC_question_arrow);
            break;
        }
        case wxCURSOR_SIZING:
        {
            cursor = XCreateFontCursor (dpy, XC_sizing);
            break;
        }
        case wxCURSOR_WATCH:
        {
            cursor = XCreateFontCursor (dpy, XC_watch);
            break;
        }
        case wxCURSOR_SPRAYCAN:
        {
            cursor = XCreateFontCursor (dpy, XC_spraycan);
            break;
        }
        case wxCURSOR_PAINT_BRUSH:
        {
            cursor = XCreateFontCursor (dpy, XC_spraycan);
            break;
        }
        case wxCURSOR_SIZENWSE:
        case wxCURSOR_SIZENESW:
        {
            // Not available in X
            cursor = XCreateFontCursor (dpy, XC_crosshair);
            break;
        }
        case wxCURSOR_SIZEWE:
        {
            cursor = XCreateFontCursor (dpy, XC_sb_h_double_arrow);
            break;
        }
        case wxCURSOR_SIZENS:
        {
            cursor = XCreateFontCursor (dpy, XC_sb_v_double_arrow);
            break;
        }
        case wxCURSOR_POINT_LEFT:
        {
            cursor = XCreateFontCursor (dpy, XC_sb_left_arrow);
            break;
        }
        case wxCURSOR_POINT_RIGHT:
        {
            cursor = XCreateFontCursor (dpy, XC_sb_right_arrow);
            break;
        }
        // (JD Huggins) added more stock cursors for X
        // X-only cursors BEGIN
        case wxCURSOR_CROSS_REVERSE:
        {
            cursor = XCreateFontCursor(dpy, XC_cross_reverse);
            break;
        }
        case wxCURSOR_DOUBLE_ARROW:
        {
            cursor = XCreateFontCursor(dpy, XC_double_arrow);
            break;
        }
        case wxCURSOR_BASED_ARROW_UP:
        {
            cursor = XCreateFontCursor(dpy, XC_based_arrow_up);
            break;
        }
        case wxCURSOR_BASED_ARROW_DOWN:
        {
            cursor = XCreateFontCursor(dpy, XC_based_arrow_down);
            break;
        }
        default:
        case wxCURSOR_ARROW:
        {
            cursor = XCreateFontCursor (dpy, XC_top_left_arrow);
            break;
        }
        case wxCURSOR_BLANK:
        {
            GC gc;
            XGCValues gcv;
            Pixmap empty_pixmap;
            XColor blank_color;

            empty_pixmap = XCreatePixmap (dpy, RootWindow (dpy, DefaultScreen (dpy)),
                              16, 16, 1);
            gcv.function = GXxor;
            gc = XCreateGC (dpy,
                    empty_pixmap,
                    GCFunction,
                    &gcv);
            XCopyArea (dpy,
                   empty_pixmap,
                   empty_pixmap,
                   gc,
                   0, 0,
                   16, 16,
                   0, 0);
            XFreeGC (dpy, gc);
            cursor = XCreatePixmapCursor (dpy,
                            empty_pixmap,
                            empty_pixmap,
                            &blank_color,
                            &blank_color,
                            8, 8);

            break;
        }
    }
    return (WXCursor) cursor;
}

// Global cursor setting
void wxSetCursor(const wxCursor& WXUNUSED(cursor))
{
  // Nothing to do for Motif (no global cursor)
}


// ----------------------------------------------------------------------------
// busy cursor stuff
// ----------------------------------------------------------------------------

static int wxBusyCursorCount = 0;

// Helper function
static void
wxXSetBusyCursor (wxWindow * win, wxCursor * cursor)
{
    Display *display = (Display*) win->GetXDisplay();

    Window xwin = (Window) win->GetXWindow();
    if (!xwin)
       return;

    XSetWindowAttributes attrs;

    if (cursor)
    {
        attrs.cursor = (Cursor) cursor->GetXCursor(display);
    }
    else
    {
        // Restore old cursor
        if (win->GetCursor().Ok())
            attrs.cursor = (Cursor) win->GetCursor().GetXCursor(display);
        else
            attrs.cursor = None;
    }
    if (xwin)
        XChangeWindowAttributes (display, xwin, CWCursor, &attrs);

    XFlush (display);

    for(wxNode *node = win->GetChildren().First (); node; node = node->Next())
    {
        wxWindow *child = (wxWindow *) node->Data ();
        wxXSetBusyCursor (child, cursor);
    }
}

// Set the cursor to the busy cursor for all windows
void wxBeginBusyCursor(wxCursor *cursor)
{
    wxBusyCursorCount++;
    if (wxBusyCursorCount == 1)
    {
        for(wxNode *node = wxTopLevelWindows.First (); node; node = node->Next())
        {
            wxWindow *win = (wxWindow *) node->Data ();
            wxXSetBusyCursor (win, cursor);
        }
    }
}

// Restore cursor to normal
void wxEndBusyCursor()
{
    if (wxBusyCursorCount == 0)
        return;

    wxBusyCursorCount--;
    if (wxBusyCursorCount == 0)
    {
        for(wxNode *node = wxTopLevelWindows.First (); node; node = node->Next())
        {
            wxWindow *win = (wxWindow *) node->Data ();
            wxXSetBusyCursor (win, NULL);
        }
    }
}

// TRUE if we're between the above two calls
bool wxIsBusy()
{
    return (wxBusyCursorCount > 0);
}