Include freeglut header via <GL/freeglut.h> rather than "../include/GL/freeglut.h"
[freeglut] / src / freeglut_cursor.c
index bc7f63a..23839a5 100644 (file)
@@ -29,7 +29,7 @@
 #include "config.h"
 #endif
 
-#include "../include/GL/freeglut.h"
+#include <GL/freeglut.h>
 #include "freeglut_internal.h"
 
 #if TARGET_HOST_UNIX_X11
@@ -38,8 +38,7 @@
 
 /*
  * TODO BEFORE THE STABLE RELEASE:
- *  glutSetCursor()     -- Win32 mappings are incomplete
- *                         X mappings are nearly right.
+ *  glutSetCursor()     -- Win32 mappings are incomplete.
  *
  * It would be good to use custom mouse cursor shapes, and introduce
  * an option to display them using glBitmap() and/or texture mapping,
 
 /* -- INTERNAL FUNCTIONS --------------------------------------------------- */
 
+#if TARGET_HOST_UNIX_X11
+
+int fgGetCursorError( Cursor cursor )
+{
+    int ret = 0;
+    char buf[ 256 ];
+    
+    switch( cursor )
+    {
+    case BadAlloc:
+    case BadFont:
+    case BadMatch:
+    case BadPixmap:
+    case BadValue:
+        XGetErrorText( fgDisplay.Display, cursor, buf, sizeof buf );
+        fgWarning( "Error in setting cursor:\n %s.", buf );
+        ret = cursor;
+        break;
+    default:
+        /* no error */
+        break;
+    }
+
+    return ret;
+}
+
+#endif
+
+
 /* -- INTERFACE FUNCTIONS -------------------------------------------------- */
 
 /*
@@ -61,19 +89,19 @@ void FGAPIENTRY glutSetCursor( int cursorID )
 #if TARGET_HOST_UNIX_X11
     /*
      * Open issues:
-     * (a) GLUT_CURSOR_NONE doesn't do what it should.  We can probably
-     *     build an empty pixmap for it, though, quite painlessly.
-     * (b) Are we allocating resources, or causing X to do so?
-     *     If yes, we should arrange to deallocate!
-     * (c) No error checking.  Is that a problem?
-     * (d) FULL_CROSSHAIR demotes to plain CROSSHAIR.  Old GLUT allows
+     * (a) Partial error checking.  Is that a problem?
+     *     Is fgGetCursorError() correct?  Should we abort on errors?
+     *     Should there be a freeglut-wide X error handler?  Should
+     *     we use the X error-handler mechanism?
+     * (b) FULL_CROSSHAIR demotes to plain CROSSHAIR.  Old GLUT allows
      *     for this, but if there is a system that easily supports a full-
      *     window (or full-screen) crosshair, we might consider it.
-     * (e) Out-of-range cursor-types are ignored.  Should we abort?
-     *     Print a warning message?
+     * (c) Out-of-range cursor-types generate warnings.  Should we abort?
      */
     {
-        Cursor cursor;
+        Cursor cursor = None;
+        Pixmap no_cursor = None ;  /* Used for GLUT_CURSOR_NONE */
+        int error = 0;
 
 #define MAP_CURSOR(a,b)                                     \
     case a:                                                 \
@@ -103,21 +131,59 @@ void FGAPIENTRY glutSetCursor( int cursorID )
             MAP_CURSOR( GLUT_CURSOR_RIGHT_SIDE,  XC_right_side);
             MAP_CURSOR( GLUT_CURSOR_TOP_LEFT_CORNER,     XC_top_left_corner);
             MAP_CURSOR( GLUT_CURSOR_TOP_RIGHT_CORNER,    XC_top_right_corner);
-            MAP_CURSOR( GLUT_CURSOR_BOTTOM_RIGHT_CORNER, XC_bottom_right_corner);
+            MAP_CURSOR( GLUT_CURSOR_BOTTOM_RIGHT_CORNER,
+                        XC_bottom_right_corner);
             MAP_CURSOR( GLUT_CURSOR_BOTTOM_LEFT_CORNER, XC_bottom_left_corner);
-            MAP_CURSOR( GLUT_CURSOR_NONE,        XC_bogosity);
+            /* MAP_CURSOR( GLUT_CURSOR_NONE,        XC_bogosity); */
+
+        case GLUT_CURSOR_NONE:
+        {
+            /*
+             * Note that we *never* change {no_cursor_bits} from anything
+             * but all-zeros.  It is our image and mask.  We also apparently
+             * need to pick a color for foreground/background---but what
+             * one we pick doesn't matter for GLUT_CURSOR_NONE.
+             */
+            static unsigned char no_cursor_bits[ 32 ];
+            XColor black;
+            no_cursor = XCreatePixmapFromBitmapData( fgDisplay.Display,
+                                                     fgDisplay.RootWindow,
+                                                     no_cursor_bits,
+                                                     16, 16,
+                                                     1, 0, 1 );
+            XParseColor( fgDisplay.Display,
+                         DefaultColormap( fgDisplay.Display,
+                                          DefaultScreen( fgDisplay.Display ) ),
+                         "black",
+                         &black );
+            cursor = XCreatePixmapCursor( fgDisplay.Display,
+                                          no_cursor, no_cursor,
+                                          &black, &black,
+                                          0, 0 );
+            break;
+        }
+        
         case GLUT_CURSOR_INHERIT:
             break;
+
         default:
+            fgWarning( "Unknown cursor type: %d\n", cursorID );
             return;
         }
 
+        error = fgGetCursorError( cursor );
+
         if( GLUT_CURSOR_INHERIT == cursorID )
             XUndefineCursor( fgDisplay.Display,
                              fgStructure.Window->Window.Handle );
         else
+        {
             XDefineCursor( fgDisplay.Display,
                            fgStructure.Window->Window.Handle, cursor );
+            XFreeCursor( fgDisplay.Display, cursor );
+            if( GLUT_CURSOR_NONE == cursorID )
+                XFreePixmap( fgDisplay.Display, no_cursor );
+        }
     }
 
 #elif TARGET_HOST_WIN32
@@ -134,7 +200,7 @@ void FGAPIENTRY glutSetCursor( int cursorID )
                           ( LONG )LoadCursor( NULL, b ) );       \
         break;
 
-        /* Nuke the cursor AND change it for this window class. */
+    /* Nuke the cursor AND change it for this window class. */
 #       define ZAP_CURSOR(a,b)                                   \
         case a:                                                  \
             SetCursor( NULL );                                   \
@@ -142,27 +208,27 @@ void FGAPIENTRY glutSetCursor( int cursorID )
                           GCL_HCURSOR, ( LONG )NULL );           \
         break;
 
-        switch( cursorID )
-        {
-            MAP_CURSOR( GLUT_CURSOR_RIGHT_ARROW, IDC_ARROW     );
-            MAP_CURSOR( GLUT_CURSOR_LEFT_ARROW,  IDC_ARROW     );
-            MAP_CURSOR( GLUT_CURSOR_INFO,        IDC_HELP      );
-            MAP_CURSOR( GLUT_CURSOR_DESTROY,     IDC_CROSS     );
-            MAP_CURSOR( GLUT_CURSOR_HELP,        IDC_HELP      );
-            MAP_CURSOR( GLUT_CURSOR_CYCLE,       IDC_SIZEALL   );
-            MAP_CURSOR( GLUT_CURSOR_SPRAY,       IDC_CROSS     );
-            MAP_CURSOR( GLUT_CURSOR_WAIT,        IDC_WAIT      );
-            MAP_CURSOR( GLUT_CURSOR_TEXT,        IDC_UPARROW   );
-            MAP_CURSOR( GLUT_CURSOR_CROSSHAIR,   IDC_CROSS     );
-            /* MAP_CURSOR( GLUT_CURSOR_NONE,        IDC_NO        ); */
-            ZAP_CURSOR( GLUT_CURSOR_NONE,        NULL           );
-            
-        default:
-            MAP_CURSOR( GLUT_CURSOR_UP_DOWN,     IDC_ARROW     );
-        }
+    switch( cursorID )
+    {
+        MAP_CURSOR( GLUT_CURSOR_RIGHT_ARROW, IDC_ARROW     );
+        MAP_CURSOR( GLUT_CURSOR_LEFT_ARROW,  IDC_ARROW     );
+        MAP_CURSOR( GLUT_CURSOR_INFO,        IDC_HELP      );
+        MAP_CURSOR( GLUT_CURSOR_DESTROY,     IDC_CROSS     );
+        MAP_CURSOR( GLUT_CURSOR_HELP,        IDC_HELP      );
+        MAP_CURSOR( GLUT_CURSOR_CYCLE,       IDC_SIZEALL   );
+        MAP_CURSOR( GLUT_CURSOR_SPRAY,       IDC_CROSS     );
+        MAP_CURSOR( GLUT_CURSOR_WAIT,        IDC_WAIT      );
+        MAP_CURSOR( GLUT_CURSOR_TEXT,        IDC_UPARROW   );
+        MAP_CURSOR( GLUT_CURSOR_CROSSHAIR,   IDC_CROSS     );
+        /* MAP_CURSOR( GLUT_CURSOR_NONE,        IDC_NO        ); */
+        ZAP_CURSOR( GLUT_CURSOR_NONE,        NULL           );
+        
+    default:
+        MAP_CURSOR( GLUT_CURSOR_UP_DOWN,     IDC_ARROW     );
+    }
 #endif
 
-  fgStructure.Window->State.Cursor = cursorID;
+    fgStructure.Window->State.Cursor = cursorID;
 }
 
 /*
@@ -187,7 +253,10 @@ void FGAPIENTRY glutWarpPointer( int x, int y )
 #elif TARGET_HOST_WIN32
 
     {
-        POINT coords = { x, y };
+        POINT coords;
+        coords.x = x;
+        coords.y = y;
+
         /*
          * ClientToScreen() translates {coords} for us.
          */