Experimental option to allow moving the mouse outside the view, "Continuous Grab...
[blender.git] / intern / ghost / intern / GHOST_WindowX11.cpp
index 2f7aee95b82fb5ed372df816fa69d2943822fe71..c2dc1048ea0db362f1d9db5f67ababe2ef25caca 100644 (file)
@@ -42,6 +42,9 @@
 #include <cstring>
 #include <cstdio>
 
+#include <algorithm>
+#include <string>
+
 // For obscure full screen mode stuuf
 // lifted verbatim from blut.
 
@@ -55,9 +58,9 @@ typedef struct {
 #define MWM_HINTS_DECORATIONS         (1L << 1)
 
 /*
- * A client can't change the window property, that is the
- * work of the window manager. We send a ClientMessage
- * event to the Root window with the property
+ * A Client can't change the window property, that is
+ * the work of the window manager. In case, we send
+ * a ClientMessage to the RootWindow with the property
  * and the Action (WM-spec define this):
  */
 #define _NET_WM_STATE_REMOVE 0
@@ -164,10 +167,10 @@ GHOST_WindowX11(
        
        // Set up the minimum atrributes that we require and see if
        // X can find us a visual matching those requirements.
-       Atom atoms[2];
-       int natom;
+
        int attributes[40], i = 0;
-       
+       Atom atoms[2];
+       int natom;      
        
        if(m_stereoVisual)
                attributes[i++] = GLX_STEREO;
@@ -187,6 +190,8 @@ GHOST_WindowX11(
                printf("%s:%d: X11 glxChooseVisual() failed for OpenGL, verify working openGL system!\n", __FILE__, __LINE__);
                return;
        }
+       
+       memset(&m_xtablet, 0, sizeof(m_xtablet));
 
        // Create a bunch of attributes needed to create an X window.
 
@@ -268,20 +273,16 @@ GHOST_WindowX11(
                
        }       
        
-       
-       // Are we in fullscreen mode - then include
-       // some obscure blut code to remove decorations.
-
        /*
-        * One of the problem with WM_spec is that can't set a property
+        * One of the problem with WM-spec is that can't set a property
         * to a window that isn't mapped. That is why we can't "just
         * call setState" here.
         *
         * To fix this, we first need know that the window is really
-        * mapped waiting for the MapNotify event.
+        * map waiting for the MapNotify event.
         *
         * So, m_post_init indicate that we need wait for the MapNotify
-        * event and then set the window state to the m_post_state.
+        * event and then set the Window state to the m_post_state.
         */
        if ((state != GHOST_kWindowStateNormal) && (state != GHOST_kWindowStateMinimized)) {
                m_post_init = True;
@@ -291,9 +292,9 @@ GHOST_WindowX11(
                m_post_init = False;
                m_post_state = GHOST_kWindowStateNormal;
        }
-
+       
        // Create some hints for the window manager on how
-       // we want this window treated. 
+       // we want this window treated.
 
        XSizeHints * xsizehints = XAllocSizeHints();
        xsizehints->flags = USPosition | USSize;
@@ -376,7 +377,8 @@ GHOST_WindowX11(
        XDestroyImage( mask_image );
        
        xwmhints->initial_state = NormalState;
-       xwmhints->flags         = IconPixmapHint|IconMaskHint|StateHint;
+       xwmhints->input= True;
+       xwmhints->flags= InputHint|IconPixmapHint|IconMaskHint|StateHint;
        XSetWMHints(display, m_window, xwmhints );
        XFree(xwmhints);
        // done setting the icon
@@ -412,6 +414,100 @@ static int ApplicationErrorHandler(Display *display, XErrorEvent *theEvent) {
        return 0 ;
 }
 
+/* These C functions are copied from Wine 1.1.13's wintab.c */
+#define BOOL int
+#define TRUE 1
+#define FALSE 0
+
+static bool match_token(const char *haystack, const char *needle)
+{
+       const char *p, *q;
+       for (p = haystack; *p; )
+       {
+               while (*p && isspace(*p))
+                       p++;
+               if (! *p)
+                       break;
+
+               for (q = needle; *q && *p && tolower(*p) == tolower(*q); q++)
+                       p++;
+               if (! *q && (isspace(*p) || !*p))
+                       return TRUE;
+
+               while (*p && ! isspace(*p))
+                       p++;
+       }
+       return FALSE;
+}
+
+/*     Determining if an X device is a Tablet style device is an imperfect science.
+**  We rely on common conventions around device names as well as the type reported
+**  by Wacom tablets.  This code will likely need to be expanded for alternate tablet types
+**
+**     Wintab refers to any device that interacts with the tablet as a cursor,
+**  (stylus, eraser, tablet mouse, airbrush, etc)
+**  this is not to be confused with wacom x11 configuration "cursor" device.
+**  Wacoms x11 config "cursor" refers to its device slot (which we mirror with
+**  our gSysCursors) for puck like devices (tablet mice essentially).
+*/
+#if 0 // unused
+static BOOL is_tablet_cursor(const char *name, const char *type)
+{
+       int i;
+       static const char *tablet_cursor_whitelist[] = {
+               "wacom",
+               "wizardpen",
+               "acecad",
+               "tablet",
+               "cursor",
+               "stylus",
+               "eraser",
+               "pad",
+               NULL
+       };
+
+       for (i=0; tablet_cursor_whitelist[i] != NULL; i++) {
+               if (name && match_token(name, tablet_cursor_whitelist[i]))
+                       return TRUE;
+               if (type && match_token(type, tablet_cursor_whitelist[i]))
+                       return TRUE;
+       }
+       return FALSE;
+}
+#endif
+static BOOL is_stylus(const char *name, const char *type)
+{
+       int i;
+       static const char* tablet_stylus_whitelist[] = {
+               "stylus",
+               "wizardpen",
+               "acecad",
+               NULL
+       };
+
+       for (i=0; tablet_stylus_whitelist[i] != NULL; i++) {
+               if (name && match_token(name, tablet_stylus_whitelist[i]))
+                       return TRUE;
+               if (type && match_token(type, tablet_stylus_whitelist[i]))
+                       return TRUE;
+       }
+
+       return FALSE;
+}
+
+static BOOL is_eraser(const char *name, const char *type)
+{
+       if (name && match_token(name, "eraser"))
+               return TRUE;
+       if (type && match_token(type, "eraser"))
+               return TRUE;
+       return FALSE;
+}
+#undef BOOL
+#undef TRUE
+#undef FALSE
+/* end code copied from wine */
+
 void GHOST_WindowX11::initXInputDevices()
 {
        static XErrorHandler old_handler = (XErrorHandler) 0 ;
@@ -421,15 +517,21 @@ void GHOST_WindowX11::initXInputDevices()
                if(version->present) {
                        int device_count;
                        XDeviceInfo* device_info = XListInputDevices(m_display, &device_count);
-                       m_xtablet.StylusDevice = 0;
-                       m_xtablet.EraserDevice = 0;
-                       m_xtablet.CommonData.Active= 0;
+                       m_xtablet.StylusDevice = NULL;
+                       m_xtablet.EraserDevice = NULL;
+                       m_xtablet.CommonData.Active= GHOST_kTabletModeNone;
 
                        /* Install our error handler to override Xlib's termination behavior */
                        old_handler = XSetErrorHandler(ApplicationErrorHandler) ;
 
                        for(int i=0; i<device_count; ++i) {
-                               if(!strcasecmp(device_info[i].name, "stylus")) {
+                               char *device_type = device_info[i].type ? XGetAtomName(m_display, device_info[i].type) : NULL;
+                               
+//                             printf("Tablet type:'%s', name:'%s', index:%d\n", device_type, device_info[i].name, i);
+
+
+                               if(m_xtablet.StylusDevice==NULL && is_stylus(device_info[i].name, device_type)) {
+//                                     printf("\tfound stylus\n");
                                        m_xtablet.StylusID= device_info[i].id;
                                        m_xtablet.StylusDevice = XOpenDevice(m_display, m_xtablet.StylusID);
 
@@ -438,6 +540,7 @@ void GHOST_WindowX11::initXInputDevices()
                                                XAnyClassPtr ici = device_info[i].inputclassinfo;
                                                for(int j=0; j<m_xtablet.StylusDevice->num_classes; ++j) {
                                                        if(ici->c_class==ValuatorClass) {
+//                                                             printf("\t\tfound ValuatorClass\n");
                                                                XValuatorInfo* xvi = (XValuatorInfo*)ici;
                                                                m_xtablet.PressureLevels = xvi->axes[2].max_value;
                                                        
@@ -454,11 +557,16 @@ void GHOST_WindowX11::initXInputDevices()
                                                m_xtablet.StylusID= 0;
                                        }
                                }
-                               if(!strcasecmp(device_info[i].name, "eraser")) {
+                               else if(m_xtablet.EraserDevice==NULL && is_eraser(device_info[i].name, device_type)) {
+//                                     printf("\tfound eraser\n");
                                        m_xtablet.EraserID= device_info[i].id;
                                        m_xtablet.EraserDevice = XOpenDevice(m_display, m_xtablet.EraserID);
                                        if (m_xtablet.EraserDevice == NULL) m_xtablet.EraserID= 0;
                                }
+
+                               if(device_type) {
+                                       XFree((void*)device_type);
+                               }
                        }
 
                        /* Restore handler */
@@ -499,7 +607,7 @@ GHOST_WindowX11::
 getXWindow(
 ){
        return m_window;
-}      
+}
 
        bool 
 GHOST_WindowX11::
@@ -513,7 +621,17 @@ GHOST_WindowX11::
 setTitle(
        const STR_String& title
 ){
+       Atom name = XInternAtom(m_display, "_NET_WM_NAME", 0);
+       Atom utf8str = XInternAtom(m_display, "UTF8_STRING", 0);
+       XChangeProperty(m_display, m_window,
+                       name, utf8str, 8, PropModeReplace,
+                       (const unsigned char*) title.ReadPtr(),
+                       strlen(title.ReadPtr()));
+
+// This should convert to valid x11 string
+//  and getTitle would need matching change
        XStoreName(m_display,m_window,title);
+
        XFlush(m_display);
 }
 
@@ -610,7 +728,7 @@ screenToClient(
        GHOST_TInt32& outX,
        GHOST_TInt32& outY
 ) const {
-       // not sure about this one!
+       // This is correct!
 
        int ax,ay;
        Window temp;
@@ -699,7 +817,7 @@ void GHOST_WindowX11::netwmMaximized(bool set)
 {
        XEvent xev;
 
-       xev.xclient.type= ClientMessage;
+       xev.xclient.type = ClientMessage;
        xev.xclient.serial = 0;
        xev.xclient.send_event = True;
        xev.xclient.window = m_window;
@@ -715,7 +833,7 @@ void GHOST_WindowX11::netwmMaximized(bool set)
        xev.xclient.data.l[2] = m_system->m_net_max_vert;
        xev.xclient.data.l[3] = 0;
        xev.xclient.data.l[4] = 0;
-       XSendEvent (m_display, RootWindow(m_display, DefaultScreen(m_display)),
+       XSendEvent(m_display, RootWindow(m_display, DefaultScreen(m_display)),
                False, SubstructureRedirectMask | SubstructureNotifyMask, &xev);
 }
 
@@ -725,14 +843,14 @@ bool GHOST_WindowX11::netwmIsMaximized(void) const
        unsigned long bytes_after, num_ret, i;
        Atom type_ret;
        bool st;
-       int format_ret, count;
+       int format_ret, ret, count;
 
        prop_ret = NULL;
        st = False;
-       i = XGetWindowProperty(m_display, m_window, m_system->m_net_state, 0,
+       ret = XGetWindowProperty(m_display, m_window, m_system->m_net_state, 0,
                        0x7fffffff, False, XA_ATOM, &type_ret, &format_ret,
                        &num_ret, &bytes_after, &prop_ret);
-       if ((i == Success) && (prop_ret) && (format_ret == 32)) {
+       if ((ret == Success) && (prop_ret) && (format_ret == 32)) {
                count = 0;
                for (i = 0; i < num_ret; i++) {
                        if (((unsigned long *) prop_ret)[i] == m_system->m_net_max_horz)
@@ -771,7 +889,7 @@ void GHOST_WindowX11::netwmFullScreen(bool set)
        xev.xclient.data.l[2] = 0;
        xev.xclient.data.l[3] = 0;
        xev.xclient.data.l[4] = 0;
-       XSendEvent (m_display, RootWindow(m_display, DefaultScreen(m_display)),
+       XSendEvent(m_display, RootWindow(m_display, DefaultScreen(m_display)),
                False, SubstructureRedirectMask | SubstructureNotifyMask, &xev);
 }
 
@@ -781,16 +899,16 @@ bool GHOST_WindowX11::netwmIsFullScreen(void) const
        unsigned long bytes_after, num_ret, i;
        Atom type_ret;
        bool st;
-       int format_ret;
+       int format_ret, ret;
 
        prop_ret = NULL;
        st = False;
-       i = XGetWindowProperty(m_display, m_window, m_system->m_net_state, 0,
+       ret = XGetWindowProperty(m_display, m_window, m_system->m_net_state, 0,
                        0x7fffffff, False, XA_ATOM, &type_ret, &format_ret,
                        &num_ret, &bytes_after, &prop_ret);
-       if ((i == Success) && (prop_ret) && (format_ret == 32)) {
+       if ((ret == Success) && (prop_ret) && (format_ret == 32)) {
                for (i = 0; i < num_ret; i++) {
-                       if (((unsigned long *)prop_ret)[i] == m_system->m_net_fullscreen) {
+                       if (((unsigned long *) prop_ret)[i] == m_system->m_net_fullscreen) {
                                st = True;
                                break;
                        }
@@ -813,8 +931,8 @@ void GHOST_WindowX11::motifFullScreen(bool set)
                hints.decorations = 1;
 
        XChangeProperty(m_display, m_window, m_system->m_motif,
-               m_system->m_motif, 32, PropModeReplace,
-               (unsigned char *)&hints, 4);
+                       m_system->m_motif, 32, PropModeReplace,
+                       (unsigned char *) &hints, 4);
 }
 
 bool GHOST_WindowX11::motifIsFullScreen(void) const
@@ -829,11 +947,11 @@ bool GHOST_WindowX11::motifIsFullScreen(void) const
        prop_ret = NULL;
        state = False;
        st = XGetWindowProperty(m_display, m_window, m_system->m_motif, 0,
-                       0x7fffffff, False, m_system->m_motif,
-                       &type_ret, &format_ret, &num_ret,
-                       &bytes_after, &prop_ret);
+                               0x7fffffff, False, m_system->m_motif,
+                               &type_ret, &format_ret, &num_ret,
+                               &bytes_after, &prop_ret);
        if ((st == Success) && (prop_ret)) {
-               hints = (MotifWmHints *)prop_ret;
+               hints = (MotifWmHints *) prop_ret;
                if (hints->flags & MWM_HINTS_DECORATIONS) {
                        if (!hints->decorations)
                                state = True;
@@ -853,8 +971,8 @@ GHOST_TWindowState GHOST_WindowX11::getState() const
        state_ret = GHOST_kWindowStateNormal;
        state = icccmGetState();
        /*
-        * In the Iconic and Withdrawn state, the window is
-        * unmaped, so only need return a Minimized state.
+        * In the Iconic and Withdrawn state, the window
+        * is unmaped, so only need return a Minimized state.
         */
        if ((state == IconicState) || (state == WithdrawnState))
                state_ret = GHOST_kWindowStateMinimized;
@@ -873,7 +991,7 @@ GHOST_TSuccess GHOST_WindowX11::setState(GHOST_TWindowState state)
        bool is_max, is_full, is_motif_full;
 
        cur_state = getState();
-       if (state == (int)cur_state)
+        if (state == (int)cur_state)
                return GHOST_kSuccess;
 
        if (cur_state != GHOST_kWindowStateMinimized) {
@@ -1100,6 +1218,13 @@ GHOST_WindowX11::
                XFreeCursor(m_display, m_custom_cursor);
        }
        
+       /* close tablet devices */
+       if(m_xtablet.StylusDevice)
+               XCloseDevice(m_display, m_xtablet.StylusDevice);
+       
+       if(m_xtablet.EraserDevice)
+               XCloseDevice(m_display, m_xtablet.EraserDevice);
+       
        if (m_context) {
                if (m_context == s_firstContext) {
                        s_firstContext = NULL;
@@ -1274,6 +1399,38 @@ setWindowCursorVisibility(
 
        GHOST_TSuccess
 GHOST_WindowX11::
+setWindowCursorGrab(
+       bool grab, bool warp
+){
+       if(grab) {
+               if(warp) {
+                       m_system->getCursorPosition(m_cursorWarpInitPos[0], m_cursorWarpInitPos[1]);
+
+                       setCursorWarpAccum(0, 0);
+                       setWindowCursorVisibility(false);
+                       m_cursorWarp= true;
+               }
+               XGrabPointer(m_display, m_window, True, ButtonPressMask| ButtonReleaseMask|PointerMotionMask, GrabModeAsync, GrabModeAsync, None, None, CurrentTime);
+       }
+       else {
+               if(m_cursorWarp) { /* are we exiting warp */
+                       setWindowCursorVisibility(true);
+                       /* Almost works without but important otherwise the mouse GHOST location can be incorrect on exit */
+                       m_system->setCursorPosition(m_cursorWarpInitPos[0], m_cursorWarpInitPos[1]);
+
+                       setCursorWarpAccum(0, 0);
+                       m_cursorWarp= false;
+               }
+               XUngrabPointer(m_display, CurrentTime);
+       }
+
+       XFlush(m_display);
+       
+       return GHOST_kSuccess;
+}
+
+       GHOST_TSuccess
+GHOST_WindowX11::
 setWindowCursorShape(
        GHOST_TStandardCursor shape
 ){
@@ -1311,13 +1468,12 @@ setWindowCustomCursorShape(
        int fg_color, 
        int bg_color
 ){
+       Colormap colormap= DefaultColormap(m_display, DefaultScreen(m_display));
        Pixmap bitmap_pix, mask_pix;
        XColor fg, bg;
        
-       if(XAllocNamedColor(m_display, DefaultColormap(m_display, DefaultScreen(m_display)),
-               "White", &fg, &fg) == 0) return GHOST_kFailure;
-       if(XAllocNamedColor(m_display, DefaultColormap(m_display, DefaultScreen(m_display)),
-               "Black", &bg, &bg) == 0) return GHOST_kFailure;
+       if(XAllocNamedColor(m_display, colormap, "White", &fg, &fg) == 0) return GHOST_kFailure;
+       if(XAllocNamedColor(m_display, colormap, "Black", &bg, &bg) == 0) return GHOST_kFailure;
 
        if (m_custom_cursor) {
                XFreeCursor(m_display, m_custom_cursor);
@@ -1333,6 +1489,9 @@ setWindowCustomCursorShape(
        XFreePixmap(m_display, bitmap_pix);
        XFreePixmap(m_display, mask_pix);
 
+    XFreeColors(m_display, colormap, &fg.pixel, 1, 0L);
+    XFreeColors(m_display, colormap, &bg.pixel, 1, 0L);
+
        return GHOST_kSuccess;
 }