(234) Fixed part of bug #926883 (Video mode matching code, memory leaks,
[freeglut] / src / freeglut_window.c
index 50e900f..3815716 100644 (file)
  * CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
  */
 
-#ifdef HAVE_CONFIG_H
-#include "config.h"
-#endif
-
 #include <GL/freeglut.h>
 #include "freeglut_internal.h"
 
@@ -36,7 +32,7 @@
 #include <aygshell.h>
 #pragma comment( lib, "Aygshell.lib" )
 
-wchar_t* wstr_from_str(const char* str)
+static wchar_t* fghWstrFromStr(const char* str)
 {
     int i,len=strlen(str);
     wchar_t* wstr = (wchar_t*)malloc(2*len+2);
@@ -87,12 +83,10 @@ XVisualInfo* fgChooseVisual( void )
     int attributes[ 32 ];
     int where = 0;
 
-    /*
-     * First we have to process the display mode settings...
-     */
+    /* First we have to process the display mode settings... */
 /*
- * Why is there a semi-colon in this #define?  The code
- * that uses the macro seems to always add more semicolons...
+ * XXX Why is there a semi-colon in this #define?  The code
+ * XXX that uses the macro seems to always add more semicolons...
  */
 #define ATTRIB(a) attributes[where++]=a;
 #define ATTRIB_VAL(a,v) {ATTRIB(a); ATTRIB(v);}
@@ -133,9 +127,7 @@ XVisualInfo* fgChooseVisual( void )
             ATTRIB_VAL( GLX_ACCUM_ALPHA_SIZE, 1 );
     }
 
-    /*
-     * Push a null at the end of the list
-     */
+    /* Push a null at the end of the list */
     ATTRIB( None );
 
     if( ! wantIndexedMode )
@@ -186,9 +178,7 @@ GLboolean fgSetupPixelFormat( SFG_Window* window, GLboolean checkOnly,
 #pragma message( "fgSetupPixelFormat(): there is still some work to do here!" )
 #endif
 
-    /*
-     * Specify which pixel format do we opt for...
-     */
+    /* Specify which pixel format do we opt for... */
     pfd.nSize           = sizeof(PIXELFORMATDESCRIPTOR);
     pfd.nVersion        = 1;
     pfd.dwFlags         = flags;
@@ -280,26 +270,16 @@ void fgOpenWindow( SFG_Window* window, const char* title,
     XSizeHints sizeHints;
     XWMHints wmHints;
     unsigned long mask;
+    unsigned int current_DisplayMode = fgState.DisplayMode ;
 
-    freeglut_assert_ready;
+    /* Save the display mode if we are creating a menu window */
+    if( window->IsMenu && ( ! fgStructure.MenuContext ) )
+        fgState.DisplayMode = GLUT_DOUBLE | GLUT_RGB ;
 
-    /*
-     * XXX fgChooseVisual() is a common part of all three.
-     * XXX With a little thought, we should be able to greatly
-     * XXX simplify this.
-     */
-    if( !window->IsMenu )
-        window->Window.VisualInfo = fgChooseVisual( );
-    else if( fgStructure.MenuContext )
-        window->Window.VisualInfo = fgChooseVisual( );
-    else
-    {
-        /* XXX Why are menus double- and depth-buffered? */
-        unsigned int current_DisplayMode = fgState.DisplayMode ;
-        fgState.DisplayMode = GLUT_DOUBLE | GLUT_RGB | GLUT_DEPTH ;
-        window->Window.VisualInfo = fgChooseVisual( );
+    window->Window.VisualInfo = fgChooseVisual( );
+
+    if( window->IsMenu && ( ! fgStructure.MenuContext ) )
         fgState.DisplayMode = current_DisplayMode ;
-    }
 
     if( ! window->Window.VisualInfo )
     {
@@ -321,14 +301,8 @@ void fgOpenWindow( SFG_Window* window, const char* title,
          */
     }
 
-    /*
-     * XXX This seems to be abusing an assert() for error-checking.
-     * XXX It is possible that the visual simply can't be found,
-     * XXX in which case we should print an error and return a 0
-     * XXX for the window id, I think.
-     */
-    assert( window->Window.VisualInfo != NULL );
-
+    FREEGLUT_INTERNAL_ERROR_EXIT( window->Window.VisualInfo != NULL,
+                                  "Visual with necessary capabilities not found", "fgOpenWindow" );
 
     /*
      * XXX HINT: the masks should be updated when adding/removing callbacks.
@@ -389,14 +363,14 @@ void fgOpenWindow( SFG_Window* window, const char* title,
             fgStructure.MenuContext->VisualInfo = window->Window.VisualInfo;
             fgStructure.MenuContext->Context = glXCreateContext(
                 fgDisplay.Display, fgStructure.MenuContext->VisualInfo,
-                NULL, fgState.ForceDirectContext | fgState.TryDirectContext
+                NULL, ( fgState.DirectContext != GLUT_FORCE_INDIRECT_CONTEXT )
             );
         }
 
         /* window->Window.Context = fgStructure.MenuContext->Context; */
         window->Window.Context = glXCreateContext(
             fgDisplay.Display, window->Window.VisualInfo,
-            NULL, fgState.ForceDirectContext | fgState.TryDirectContext
+            NULL, ( fgState.DirectContext != GLUT_FORCE_INDIRECT_CONTEXT )
         );
     }
     else if( fgState.UseCurrentContext )
@@ -406,19 +380,26 @@ void fgOpenWindow( SFG_Window* window, const char* title,
         if( ! window->Window.Context )
             window->Window.Context = glXCreateContext(
                 fgDisplay.Display, window->Window.VisualInfo,
-                NULL, fgState.ForceDirectContext | fgState.TryDirectContext
+                NULL, ( fgState.DirectContext != GLUT_FORCE_INDIRECT_CONTEXT )
             );
     }
     else
         window->Window.Context = glXCreateContext(
             fgDisplay.Display, window->Window.VisualInfo,
-            NULL, fgState.ForceDirectContext | fgState.TryDirectContext
+            NULL, ( fgState.DirectContext != GLUT_FORCE_INDIRECT_CONTEXT )
         );
 
-    if( fgState.ForceDirectContext &&
-        !glXIsDirect( fgDisplay.Display, window->Window.Context ) )
-        fgError( "unable to force direct context rendering for window '%s'",
+#if !defined( __FreeBSD__ ) && !defined( __NetBSD__ )
+    if(  !glXIsDirect( fgDisplay.Display, window->Window.Context ) )
+    {
+      if( fgState.DirectContext == GLUT_FORCE_DIRECT_CONTEXT )
+        fgError( "Unable to force direct context rendering for window '%s'",
+                 title );
+      else if( fgState.DirectContext == GLUT_TRY_DIRECT_CONTEXT )
+        fgWarning( "Unable to create direct context rendering for window '%s'\nThis may hurt performance.",
                  title );
+    }
+#endif
 
     glXMakeCurrent(
         fgDisplay.Display,
@@ -440,29 +421,20 @@ void fgOpenWindow( SFG_Window* window, const char* title,
 
     /*
      * Fill in the size hints values now (the x, y, width and height
-     * settings are obsolote, are there any more WMs that support them?)
+     * settings are obsolete, are there any more WMs that support them?)
      * Unless the X servers actually stop supporting these, we should
      * continue to fill them in.  It is *not* our place to tell the user
      * that they should replace a window manager that they like, and which
      * works, just because *we* think that it's not "modern" enough.
      */
-#if TARGET_HOST_WINCE
-    sizeHints.x      = 0;
-    sizeHints.y      = 0;
-    sizeHints.width  = 320;
-    sizeHints.height = 240;
-#else
     sizeHints.x      = x;
     sizeHints.y      = y;
     sizeHints.width  = w;
     sizeHints.height = h;
-#endif /* TARGET_HOST_WINCE */
 
     wmHints.flags = StateHint;
     wmHints.initial_state = fgState.ForceIconic ? IconicState : NormalState;
-    /*
-     * Prepare the window and iconified window names...
-     */
+    /* Prepare the window and iconified window names... */
     XStringListToTextProperty( (char **) &title, 1, &textProperty );
 
     XSetWMProperties(
@@ -489,17 +461,16 @@ void fgOpenWindow( SFG_Window* window, const char* title,
     DWORD exFlags = 0;
     ATOM atom;
 
-    freeglut_assert_ready;
-
-    /*
-     * Grab the window class we have registered on glutInit():
-     */
+    /* Grab the window class we have registered on glutInit(): */
     atom = GetClassInfo( fgDisplay.Instance, _T("FREEGLUT"), &wc );
-    assert( atom != 0 );
+    FREEGLUT_INTERNAL_ERROR_EXIT ( atom, "Window Class Info Not Found",
+                                   "fgOpenWindow" );
 
     if( gameMode )
     {
-        assert( window->Parent == NULL );
+        FREEGLUT_INTERNAL_ERROR_EXIT ( window->Parent == NULL,
+                                       "Game mode being invoked on a subwindow",
+                                       "fgOpenWindow" );
 
         /*
          * Set the window creation flags appropriately to make the window
@@ -555,7 +526,7 @@ void fgOpenWindow( SFG_Window* window, const char* title,
 
 #if TARGET_HOST_WINCE
     {
-        wchar_t* wstr = wstr_from_str(title);
+        wchar_t* wstr = fghWstrFromStr(title);
 
         window->Window.Handle = CreateWindow(
             _T("FREEGLUT"),
@@ -623,8 +594,6 @@ void fgOpenWindow( SFG_Window* window, const char* title,
  */
 void fgCloseWindow( SFG_Window* window )
 {
-    freeglut_assert_ready;
-
 #if TARGET_HOST_UNIX_X11
 
     glXDestroyContext( fgDisplay.Display, window->Window.Context );
@@ -633,9 +602,7 @@ void fgCloseWindow( SFG_Window* window )
 
 #elif TARGET_HOST_WIN32 || TARGET_HOST_WINCE
 
-    /*
-     * Make sure we don't close a window with current context active
-     */
+    /* Make sure we don't close a window with current context active */
     if( fgStructure.Window == window )
         wglMakeCurrent( NULL, NULL );
 
@@ -672,6 +639,8 @@ void fgCloseWindow( SFG_Window* window )
  */
 int FGAPIENTRY glutCreateWindow( const char* title )
 {
+    FREEGLUT_EXIT_IF_NOT_INITIALISED ( "glutCreateWindow" );
+
     return fgCreateWindow( NULL, title, fgState.Position.X, fgState.Position.Y,
                            fgState.Size.X, fgState.Size.Y, GL_FALSE,
                            GL_FALSE )->ID;
@@ -683,11 +652,10 @@ int FGAPIENTRY glutCreateWindow( const char* title )
 int FGAPIENTRY glutCreateSubWindow( int parentID, int x, int y, int w, int h )
 {
     int ret = 0;
-
     SFG_Window* window = NULL;
     SFG_Window* parent = NULL;
 
-    freeglut_assert_ready;
+    FREEGLUT_EXIT_IF_NOT_INITIALISED ( "glutCreateSubWindow" );
     parent = fgWindowByID( parentID );
     freeglut_return_val_if_fail( parent != NULL, 0 );
     window = fgCreateWindow( parent, "", x, y, w, h, GL_FALSE, GL_FALSE );
@@ -701,7 +669,9 @@ int FGAPIENTRY glutCreateSubWindow( int parentID, int x, int y, int w, int h )
  */
 void FGAPIENTRY glutDestroyWindow( int windowID )
 {
-    SFG_Window* window = fgWindowByID( windowID );
+    SFG_Window* window;
+    FREEGLUT_EXIT_IF_NOT_INITIALISED ( "glutDestroyWindow" );
+    window = fgWindowByID( windowID );
     freeglut_return_if_fail( window != NULL );
     {
         fgExecutionState ExecState = fgState.ExecState;
@@ -717,7 +687,7 @@ void FGAPIENTRY glutSetWindow( int ID )
 {
     SFG_Window* window = NULL;
 
-    freeglut_assert_ready;
+    FREEGLUT_EXIT_IF_NOT_INITIALISED ( "glutSetWindow" );
     if( fgStructure.Window != NULL )
         if( fgStructure.Window->ID == ID )
             return;
@@ -725,7 +695,7 @@ void FGAPIENTRY glutSetWindow( int ID )
     window = fgWindowByID( ID );
     if( window == NULL )
     {
-        fgWarning( "glutSetWindow(): window ID %i not found!", ID );
+        fgWarning( "glutSetWindow(): window ID %d not found!", ID );
         return;
     }
 
@@ -737,7 +707,7 @@ void FGAPIENTRY glutSetWindow( int ID )
  */
 int FGAPIENTRY glutGetWindow( void )
 {
-    freeglut_assert_ready;
+    FREEGLUT_EXIT_IF_NOT_INITIALISED ( "glutGetWindow" );
     if( fgStructure.Window == NULL )
         return 0;
     return fgStructure.Window->ID;
@@ -748,8 +718,8 @@ int FGAPIENTRY glutGetWindow( void )
  */
 void FGAPIENTRY glutShowWindow( void )
 {
-    freeglut_assert_ready;
-    freeglut_assert_window;
+    FREEGLUT_EXIT_IF_NOT_INITIALISED ( "glutShowWindow" );
+    FREEGLUT_EXIT_IF_NO_WINDOW ( "glutShowWindow" );
 
 #if TARGET_HOST_UNIX_X11
 
@@ -770,8 +740,8 @@ void FGAPIENTRY glutShowWindow( void )
  */
 void FGAPIENTRY glutHideWindow( void )
 {
-    freeglut_assert_ready;
-    freeglut_assert_window;
+    FREEGLUT_EXIT_IF_NOT_INITIALISED ( "glutHideWindow" );
+    FREEGLUT_EXIT_IF_NO_WINDOW ( "glutHideWindow" );
 
 #if TARGET_HOST_UNIX_X11
 
@@ -798,8 +768,8 @@ void FGAPIENTRY glutHideWindow( void )
  */
 void FGAPIENTRY glutIconifyWindow( void )
 {
-    freeglut_assert_ready;
-    freeglut_assert_window;
+    FREEGLUT_EXIT_IF_NOT_INITIALISED ( "glutIconifyWindow" );
+    FREEGLUT_EXIT_IF_NO_WINDOW ( "glutIconifyWindow" );
 
     fgStructure.Window->State.Visible   = GL_FALSE;
 #if TARGET_HOST_UNIX_X11
@@ -822,8 +792,8 @@ void FGAPIENTRY glutIconifyWindow( void )
  */
 void FGAPIENTRY glutSetWindowTitle( const char* title )
 {
-    freeglut_assert_ready;
-    freeglut_assert_window;
+    FREEGLUT_EXIT_IF_NOT_INITIALISED ( "glutSetWindowTitle" );
+    FREEGLUT_EXIT_IF_NO_WINDOW ( "glutSetWindowTitle" );
     if( ! fgStructure.Window->Parent )
     {
 #if TARGET_HOST_UNIX_X11
@@ -849,7 +819,7 @@ void FGAPIENTRY glutSetWindowTitle( const char* title )
 
 #elif TARGET_HOST_WINCE
         {
-            wchar_t* wstr = wstr_from_str(title);
+            wchar_t* wstr = fghWstrFromStr(title);
 
             SetWindowText( fgStructure.Window->Window.Handle, wstr );
 
@@ -864,8 +834,8 @@ void FGAPIENTRY glutSetWindowTitle( const char* title )
  */
 void FGAPIENTRY glutSetIconTitle( const char* title )
 {
-    freeglut_assert_ready;
-    freeglut_assert_window;
+    FREEGLUT_EXIT_IF_NOT_INITIALISED ( "glutSetIconTitle" );
+    FREEGLUT_EXIT_IF_NO_WINDOW ( "glutSetIconTitle" );
 
     if( ! fgStructure.Window->Parent )
     {
@@ -892,7 +862,7 @@ void FGAPIENTRY glutSetIconTitle( const char* title )
 
 #elif TARGET_HOST_WINCE
         {
-            wchar_t* wstr = wstr_from_str(title);
+            wchar_t* wstr = fghWstrFromStr(title);
 
             SetWindowText( fgStructure.Window->Window.Handle, wstr );
 
@@ -907,8 +877,8 @@ void FGAPIENTRY glutSetIconTitle( const char* title )
  */
 void FGAPIENTRY glutReshapeWindow( int width, int height )
 {
-    freeglut_assert_ready;
-    freeglut_assert_window;
+    FREEGLUT_EXIT_IF_NOT_INITIALISED ( "glutReshapeWindow" );
+    FREEGLUT_EXIT_IF_NO_WINDOW ( "glutReshapeWindow" );
 
     fgStructure.Window->State.NeedToResize = GL_TRUE;
     fgStructure.Window->State.Width  = width ;
@@ -920,8 +890,8 @@ void FGAPIENTRY glutReshapeWindow( int width, int height )
  */
 void FGAPIENTRY glutPositionWindow( int x, int y )
 {
-    freeglut_assert_ready;
-    freeglut_assert_window;
+    FREEGLUT_EXIT_IF_NOT_INITIALISED ( "glutPositionWindow" );
+    FREEGLUT_EXIT_IF_NO_WINDOW ( "glutPositionWindow" );
 
 #if TARGET_HOST_UNIX_X11
 
@@ -934,6 +904,7 @@ void FGAPIENTRY glutPositionWindow( int x, int y )
     {
         RECT winRect;
 
+        /* "GetWindowRect" returns the pixel coordinates of the outside of the window */
         GetWindowRect( fgStructure.Window->Window.Handle, &winRect );
         MoveWindow(
             fgStructure.Window->Window.Handle,
@@ -953,8 +924,8 @@ void FGAPIENTRY glutPositionWindow( int x, int y )
  */
 void FGAPIENTRY glutPushWindow( void )
 {
-    freeglut_assert_ready;
-    freeglut_assert_window;
+    FREEGLUT_EXIT_IF_NOT_INITIALISED ( "glutPushWindow" );
+    FREEGLUT_EXIT_IF_NO_WINDOW ( "glutPushWindow" );
 
 #if TARGET_HOST_UNIX_X11
 
@@ -977,8 +948,8 @@ void FGAPIENTRY glutPushWindow( void )
  */
 void FGAPIENTRY glutPopWindow( void )
 {
-    freeglut_assert_ready;
-    freeglut_assert_window;
+    FREEGLUT_EXIT_IF_NOT_INITIALISED ( "glutPopWindow" );
+    FREEGLUT_EXIT_IF_NO_WINDOW ( "glutPopWindow" );
 
 #if TARGET_HOST_UNIX_X11
 
@@ -1001,8 +972,8 @@ void FGAPIENTRY glutPopWindow( void )
  */
 void FGAPIENTRY glutFullScreen( void )
 {
-    freeglut_assert_ready;
-    freeglut_assert_window;
+    FREEGLUT_EXIT_IF_NOT_INITIALISED ( "glutFullScreen" );
+    FREEGLUT_EXIT_IF_NO_WINDOW ( "glutFullScreen" );
 
     {
 #if TARGET_HOST_UNIX_X11
@@ -1076,11 +1047,15 @@ void FGAPIENTRY glutFullScreen( void )
  */
 void* FGAPIENTRY glutGetWindowData( void )
 {
+    FREEGLUT_EXIT_IF_NOT_INITIALISED ( "glutGetWindowData" );
+    FREEGLUT_EXIT_IF_NO_WINDOW ( "glutGetWindowData" );
     return fgStructure.Window->UserData;
 }
 
 void FGAPIENTRY glutSetWindowData(void* data)
 {
+    FREEGLUT_EXIT_IF_NOT_INITIALISED ( "glutSetWindowData" );
+    FREEGLUT_EXIT_IF_NO_WINDOW ( "glutSetWindowData" );
     fgStructure.Window->UserData = data;
 }