updated docs for fgPlatformMainLoopPreliminaryWork
[freeglut] / src / mswin / fg_main_mswin.c
index 6701051..be412ba 100644 (file)
@@ -128,26 +128,61 @@ void fgPlatformProcessSingleEvent ( void )
 
 
 
+static void fghUpdateWindowStatus(SFG_Window *window, GLboolean visState)
+{
+    SFG_Window* child;
+
+    if (window->State.Visible != visState)
+    {
+        window->State.Visible = visState;
+        INVOKE_WCB( *window, WindowStatus, ( visState ? GLUT_FULLY_RETAINED:GLUT_HIDDEN ) );
+    }
+
+    /* Also set visibility state for children */
+    for( child = ( SFG_Window * )window->Children.First;
+         child;
+         child = ( SFG_Window * )child->Node.Next )
+    {
+        fghUpdateWindowStatus(child, visState);
+    }
+}
+
+static void fghNotifyWindowStatus(SFG_Window *window)
+{
+    SFG_Window* child;
+
+    INVOKE_WCB( *window, WindowStatus, ( window->State.Visible?GLUT_FULLY_RETAINED:GLUT_HIDDEN ) );
+
+    /* Also notify children */
+    for( child = ( SFG_Window * )window->Children.First;
+         child;
+         child = ( SFG_Window * )child->Node.Next )
+    {
+        fghNotifyWindowStatus(child);
+    }
+}
+
 void fgPlatformMainLoopPreliminaryWork ( void )
 {
     SFG_Window *window = (SFG_Window *)fgStructure.Windows.First ;
 
     /*
      * Processing before the main loop:  If there is a window which is open and
-     * which has a visibility callback, call it.  I know this is an ugly hack,
-     * but I'm not sure what else to do about it.  Ideally we should leave
-     * something uninitialized in the create window code and initialize it in
-     * the main loop, and have that initialization create a "WM_ACTIVATE"
-     * message.  Then we would put the visibility callback code in the
-     * "case WM_ACTIVATE" block below.         - John Fay -- 10/24/02
+     * which has a visibility/windowStatus callback, call it to inform the client
+     * code that the window is visible.  I know this is an ugly hack,
+     * but I'm not sure what else to do about it.  Depending on WM_ACTIVATE would
+     * not work as not all windows get this when you are opening multiple before
+     * the mainloop starts. WM_SHOWWINDOW looked like an interesting candidate, but
+     * it is generated and processed before glutCreate(Sub)Window returns, so no
+     * callback can yet be set on the window.
      */
     while( window )
     {
-        if ( FETCH_WCB( *window, Visibility ) )
+        if ( FETCH_WCB( *window, WindowStatus ) )
         {
             SFG_Window *current_window = fgStructure.CurrentWindow ;
 
-            INVOKE_WCB( *window, Visibility, ( window->State.Visible ) );
+            fghNotifyWindowStatus(window);
             fgSetWindow( current_window );
         }
 
@@ -321,35 +356,37 @@ static LRESULT fghWindowProcKeyPress(SFG_Window *window, UINT uMsg, GLboolean ke
         return 1;
 }
 
-void fghWindowUnderCursor(SFG_Window *window, SFG_Window **child_window)
+static SFG_Window* fghWindowUnderCursor(SFG_Window *window)
 {
     /* Check if the current window that the mouse is over is a child window
-     * of the window the message was sent to.
+     * of the window the message was sent to. Some events only sent to main window,
+     * and when handling some messages, we need to make sure that we process
+     * callbacks on the child window instead. This mirrors how GLUT does things.
+     * returns either the original window or the found child.
      */
-    if (window && window->Children.First)
+    if (window && window->Children.First)   /* This window has childs */
     {
-        POINT mouse_pos;
         SFG_WindowHandleType hwnd;
-        SFG_Window* temp_window;
+        SFG_Window* child_window;
 
         /* Get mouse position at time of message */
-        DWORD mouse_pos_Dword = GetMessagePos();
-        mouse_pos.x = GET_X_LPARAM(mouse_pos_Dword);
-        mouse_pos.y = GET_Y_LPARAM(mouse_pos_Dword);
+        DWORD mouse_pos_dw = GetMessagePos();
+        POINT mouse_pos = {GET_X_LPARAM(mouse_pos_dw), GET_Y_LPARAM(mouse_pos_dw)};
         ScreenToClient( window->Window.Handle, &mouse_pos );
         
         hwnd = ChildWindowFromPoint(window->Window.Handle, mouse_pos);
         if (hwnd && hwnd!=window->Window.Handle)   /* can be NULL if mouse outside parent by the time we get here, or can be same as parent if we didn't find a child */
         {
-            temp_window = fgWindowByHandle(hwnd);
-            if (temp_window)    /* Verify we got a FreeGLUT window */
+            child_window = fgWindowByHandle(hwnd);
+            if (child_window)    /* Verify we got a FreeGLUT window */
             {
-                *child_window = temp_window;
                 /* ChildWindowFromPoint only searches immediate children, so search again to see if actually in grandchild or further descendant */
-                fghWindowUnderCursor(temp_window,child_window);
+                window = fghWindowUnderCursor(child_window);
             }
         }
     }
+
+    return window;
 }
 
 /*
@@ -357,9 +394,9 @@ void fghWindowUnderCursor(SFG_Window *window, SFG_Window **child_window)
  */
 LRESULT CALLBACK fgPlatformWindowProc( HWND hWnd, UINT uMsg, WPARAM wParam, LPARAM lParam )
 {
-    SFG_Window *window, *child_window = NULL;
-    PAINTSTRUCT ps;
+    SFG_Window *window;
     LRESULT lRet = 1;
+    static int setCaptureActive = 0;
 
     FREEGLUT_INTERNAL_ERROR_EXIT_IF_NOT_INITIALISED ( "Event Handler" ) ;
 
@@ -371,13 +408,6 @@ LRESULT CALLBACK fgPlatformWindowProc( HWND hWnd, UINT uMsg, WPARAM wParam, LPAR
     /* printf ( "Window %3d message <%04x> %12d %12d\n", window?window->ID:0,
              uMsg, wParam, lParam ); */
 
-    /* Some events only sent to main window. Check if the current window that
-     * the mouse is over is a child window. Below when handling some messages,
-     * we make sure that we process callbacks on the child window instead.
-     * This mirrors how GLUT does things.
-     */
-    fghWindowUnderCursor(window, &child_window);
-    
     switch( uMsg )
     {
     case WM_CREATE:
@@ -471,6 +501,7 @@ LRESULT CALLBACK fgPlatformWindowProc( HWND hWnd, UINT uMsg, WPARAM wParam, LPAR
         break;
 
     case WM_SIZE:
+        //printf("WM_SIZE (ID: %i): wParam: %i, new size: %ix%i \n",window->ID,wParam,LOWORD(lParam),HIWORD(lParam));
         /*
          * If the window is visible, then it is the user manually resizing it.
          * If it is not, then it is the system sending us a dummy resize with
@@ -493,28 +524,35 @@ LRESULT CALLBACK fgPlatformWindowProc( HWND hWnd, UINT uMsg, WPARAM wParam, LPAR
                 window->State.NeedToResize = GL_TRUE;
         }
 
+        /* according to docs, should return 0 */
+        lRet = 0;
         break;
 
     case WM_MOVE:
         {
             SFG_Window* saved_window = fgStructure.CurrentWindow;
             RECT windowRect;
-            GetWindowRect( window->Window.Handle, &windowRect );
-            
-            if (window->Parent)
+
+            /* Check window visible, we don't want to call the position callback when the user minimized the window */
+            if (window->State.Visible)
             {
-                /* For child window, we should return relative to upper-left
-                * of parent's client area.
-                */
-                POINT topleft = {windowRect.left,windowRect.top};
-
-                ScreenToClient(window->Parent->Window.Handle,&topleft);
-                windowRect.left = topleft.x;
-                windowRect.top  = topleft.y;
-            }
+                GetWindowRect( window->Window.Handle, &windowRect );
+            
+                if (window->Parent)
+                {
+                    /* For child window, we should return relative to upper-left
+                     * of parent's client area.
+                     */
+                    POINT topleft = {windowRect.left,windowRect.top};
 
-            INVOKE_WCB( *window, Position, ( windowRect.left, windowRect.top ) );
-            fgSetWindow(saved_window);
+                    ScreenToClient(window->Parent->Window.Handle,&topleft);
+                    windowRect.left = topleft.x;
+                    windowRect.top  = topleft.y;
+                }
+
+                INVOKE_WCB( *window, Position, ( windowRect.left, windowRect.top ) );
+                fgSetWindow(saved_window);
+            }
         }
         break;
 
@@ -523,31 +561,15 @@ LRESULT CALLBACK fgPlatformWindowProc( HWND hWnd, UINT uMsg, WPARAM wParam, LPAR
 
         lRet = DefWindowProc( hWnd, uMsg, wParam, lParam );
 
-        if (child_window)
-        {
-            /* If we're dealing with a child window, make sure it has input focus instead, set it here. */
-            SetFocus(child_window->Window.Handle);
-            SetActiveWindow( child_window->Window.Handle );
-            INVOKE_WCB( *child_window, Entry, ( GLUT_ENTERED ) );
-            UpdateWindow ( child_window->Window.Handle );
-        }
-        else
-        {
-            SetActiveWindow( window->Window.Handle );
-            INVOKE_WCB( *window, Entry, ( GLUT_ENTERED ) );
-        }
-        /* Always request update on main window to be safe */
+        SetActiveWindow( window->Window.Handle );
         UpdateWindow ( hWnd );
 
         break;
 
     case WM_KILLFOCUS:
         {
-            SFG_Window* saved_window = fgStructure.CurrentWindow;
 /*            printf("WM_KILLFOCUS: %p\n", window ); */
             lRet = DefWindowProc( hWnd, uMsg, wParam, lParam );
-            INVOKE_WCB( *window, Entry, ( GLUT_LEFT ) );
-            fgSetWindow(saved_window);
 
             /* Check if there are any open menus that need to be closed */
             fgPlatformCheckMenuDeactivate();
@@ -556,7 +578,7 @@ LRESULT CALLBACK fgPlatformWindowProc( HWND hWnd, UINT uMsg, WPARAM wParam, LPAR
 
 #if 0
     case WM_ACTIVATE:
-        //printf("WM_ACTIVATE: %x %d %d\n",lParam, HIWORD(wParam), LOWORD(wParam));
+        //printf("WM_ACTIVATE: %x (ID: %i) %d %d\n",lParam, window->ID, HIWORD(wParam), LOWORD(wParam));
         if (LOWORD(wParam) != WA_INACTIVE)
         {
 /*            printf("WM_ACTIVATE: fgSetCursor( %p, %d)\n", window,
@@ -571,24 +593,69 @@ LRESULT CALLBACK fgPlatformWindowProc( HWND hWnd, UINT uMsg, WPARAM wParam, LPAR
     case WM_SETCURSOR:
 /*      printf ( "Cursor event %x %x %x %x\n", window, window->State.Cursor, lParam, wParam ) ; */
         if( LOWORD( lParam ) == HTCLIENT )
-            fgSetCursor ( window, window->State.Cursor ) ;
+        {
+            if (!window->State.pWState.MouseTracking)
+            {
+                TRACKMOUSEEVENT tme;
+
+                /* Cursor just entered window, set cursor look */ 
+                fgSetCursor ( window, window->State.Cursor ) ;
+
+                /* If an EntryFunc callback is specified by the user, also
+                 * invoke that callback and start mouse tracking so that
+                 * we get a WM_MOUSELEAVE message
+                 */
+                if (FETCH_WCB( *window, Entry ))
+                {
+                    INVOKE_WCB( *window, Entry, ( GLUT_ENTERED ) );
+
+                    tme.cbSize = sizeof(TRACKMOUSEEVENT);
+                    tme.dwFlags = TME_LEAVE;
+                    tme.hwndTrack = window->Window.Handle;
+                    TrackMouseEvent(&tme);
+
+                    window->State.pWState.MouseTracking = GL_TRUE;
+                }
+            }
+        }
         else
+            /* Only pass non-client WM_SETCURSOR to DefWindowProc, or we get WM_SETCURSOR on parents of children as well */
             lRet = DefWindowProc( hWnd, uMsg, wParam, lParam );
         break;
 
+    case WM_MOUSELEAVE:
+        {
+            /* NB: This message is only received when a EntryFunc callback
+             * is specified by the user, as that is the only condition under
+             * which mouse tracking is setup in WM_SETCURSOR handler above
+             */
+            SFG_Window* saved_window = fgStructure.CurrentWindow;
+            INVOKE_WCB( *window, Entry, ( GLUT_LEFT ) );
+            fgSetWindow(saved_window);
+
+            window->State.pWState.MouseTracking = GL_FALSE;
+            lRet = 0;   /* As per docs, must return zero */
+        }
+        break;
+
     case WM_SHOWWINDOW:
-        window->State.Visible = GL_TRUE;
+        //printf("WM_SHOWWINDOW\n");
+        fghUpdateWindowStatus(window, GL_TRUE);
         window->State.Redisplay = GL_TRUE;
         break;
 
     case WM_PAINT:
+    {
+        PAINTSTRUCT ps;
         /* Turn on the visibility in case it was turned off somehow */
         window->State.Visible = GL_TRUE;
+
         InvalidateRect( hWnd, NULL, GL_FALSE ); /* Make sure whole window is repainted. Bit of a hack, but a safe one from what google turns up... */
         BeginPaint( hWnd, &ps );
         fghRedrawWindow( window );
         EndPaint( hWnd, &ps );
-        break;
+    }
+    break;
 
     case WM_CLOSE:
         fgDestroyWindow ( window );
@@ -715,17 +782,20 @@ LRESULT CALLBACK fgPlatformWindowProc( HWND hWnd, UINT uMsg, WPARAM wParam, LPAR
                                window->State.MouseX, window->State.MouseY ) )
             break;
 
-        /* Set capture so that the window captures all the mouse messages */
-        /*
-         * XXX - Multiple button support:  Under X11, the mouse is not released
-         * XXX - from the window until all buttons have been released, even if the
-         * XXX - user presses a button in another window.  This will take more
-         * XXX - code changes than I am up to at the moment (10/5/04).  The present
-         * XXX - is a 90 percent solution.
+        /* Set capture so that the window captures all the mouse messages
+         *
+         * The mouse is not released from the window until all buttons have
+         * been released, even if the user presses a button in another window.
+         * This is consistent with the behavior on X11.
          */
         if ( pressed == GL_TRUE )
-          SetCapture ( window->Window.Handle ) ;
-        else
+        {
+            if (!setCaptureActive)
+                SetCapture ( window->Window.Handle ) ;
+            setCaptureActive = 1; /* Set to false in WM_CAPTURECHANGED handler */
+        }
+        else if (!GetAsyncKeyState(VK_LBUTTON) && !GetAsyncKeyState(VK_MBUTTON) && !GetAsyncKeyState(VK_RBUTTON))
+          /* Make sure all mouse buttons are released before releasing capture */
           ReleaseCapture () ;
 
         if( ! FETCH_WCB( *window, Mouse ) )
@@ -744,15 +814,21 @@ LRESULT CALLBACK fgPlatformWindowProc( HWND hWnd, UINT uMsg, WPARAM wParam, LPAR
         );
 
         fgState.Modifiers = INVALID_MODIFIERS;
+
+        /* As per docs, should return zero */
+        lRet = 0;
     }
     break;
 
     case WM_MOUSEWHEEL:
     {
+        SFG_Window *child_window = NULL;
         int wheel_number = LOWORD( wParam );
         short ticks = ( short )HIWORD( wParam );
-               fgState.MouseWheelTicks += ticks;
 
+        window = fghWindowUnderCursor(window);
+
+               fgState.MouseWheelTicks += ticks;
         if ( abs ( fgState.MouseWheelTicks ) >= WHEEL_DELTA )
                {
                        int direction = ( fgState.MouseWheelTicks > 0 ) ? 1 : -1;
@@ -806,23 +882,24 @@ LRESULT CALLBACK fgPlatformWindowProc( HWND hWnd, UINT uMsg, WPARAM wParam, LPAR
 
     case WM_SYSKEYDOWN:
     case WM_KEYDOWN:
-        if (child_window)
-            window = child_window;
+    {
+        window = fghWindowUnderCursor(window);
         lRet = fghWindowProcKeyPress(window,uMsg,GL_TRUE,wParam,lParam);
+    }
     break;
 
     case WM_SYSKEYUP:
     case WM_KEYUP:
-        if (child_window)
-            window = child_window;
+    {
+        window = fghWindowUnderCursor(window);
         lRet = fghWindowProcKeyPress(window,uMsg,GL_FALSE,wParam,lParam);
+    }
     break;
 
     case WM_SYSCHAR:
     case WM_CHAR:
     {
-      if (child_window)
-        window = child_window;
+      window = fghWindowUnderCursor(window);
 
       if( (fgState.KeyRepeat==GLUT_KEY_REPEAT_OFF || window->State.IgnoreKeyRepeat==GL_TRUE) && (HIWORD(lParam) & KF_REPEAT) )
             break;
@@ -837,10 +914,13 @@ LRESULT CALLBACK fgPlatformWindowProc( HWND hWnd, UINT uMsg, WPARAM wParam, LPAR
     break;
 
     case WM_CAPTURECHANGED:
-        /* User has finished resizing the window, force a redraw */
-        INVOKE_WCB( *window, Display, ( ) );
-
-        /*lRet = DefWindowProc( hWnd, uMsg, wParam, lParam ); */
+        if (!lParam || !fgWindowByHandle((HWND)lParam))
+            /* Capture released or capture taken by non-FreeGLUT window */
+            setCaptureActive = 0;
+        /* Docs advise a redraw */
+        InvalidateRect( hWnd, NULL, GL_FALSE );
+        UpdateWindow(hWnd);
+        lRet = 0;   /* Per docs, should return zero */
         break;
 
         /* Other messages that I have seen and which are not handled already */
@@ -904,7 +984,7 @@ LRESULT CALLBACK fgPlatformWindowProc( HWND hWnd, UINT uMsg, WPARAM wParam, LPAR
             case SC_MINIMIZE   :
                 /* User has clicked on the "-" to minimize the window */
                 /* Turn off the visibility */
-                window->State.Visible = GL_FALSE ;
+                fghUpdateWindowStatus(window, GL_FALSE);
 
                 break ;
 
@@ -937,6 +1017,7 @@ LRESULT CALLBACK fgPlatformWindowProc( HWND hWnd, UINT uMsg, WPARAM wParam, LPAR
                 break ;
 
             case SC_RESTORE    :
+                fghUpdateWindowStatus(window, GL_TRUE);
                 break ;
 
             case SC_TASKLIST   :