[hbelusca] 69843: [NTVDM]: Implement mouse capture. There are still "bugs" remaining, namely, if somebody moves the NTVDM console window, or, if resolution changes, the mouse clip rectangle is not ...

Author: hbelusca
Date: Sat Nov  7 23:40:26 2015
New Revision: 69843
URL: http://svn.reactos.org/svn/reactos?rev=69843&view=rev
Log:
[NTVDM]: Implement mouse capture. There are still "bugs" remaining, namely, if
somebody moves the NTVDM console window, or, if resolution changes, the mouse clip
rectangle is not recomputed. This is left as an exercice for the programmer (or, if I
don't find patches in Jira soon, I or somebody else will fix it).
Modified:
    trunk/reactos/subsystems/mvdm/ntvdm/console/console.c
    trunk/reactos/subsystems/mvdm/ntvdm/lang/cs-CZ.rc
    trunk/reactos/subsystems/mvdm/ntvdm/lang/de-DE.rc
    trunk/reactos/subsystems/mvdm/ntvdm/lang/en-US.rc
    trunk/reactos/subsystems/mvdm/ntvdm/lang/es-ES.rc
    trunk/reactos/subsystems/mvdm/ntvdm/lang/fr-FR.rc
    trunk/reactos/subsystems/mvdm/ntvdm/lang/it-IT.rc
    trunk/reactos/subsystems/mvdm/ntvdm/lang/pl-PL.rc
    trunk/reactos/subsystems/mvdm/ntvdm/lang/ro-RO.rc
    trunk/reactos/subsystems/mvdm/ntvdm/lang/ru-RU.rc
    trunk/reactos/subsystems/mvdm/ntvdm/lang/tr-TR.rc
    trunk/reactos/subsystems/mvdm/ntvdm/lang/zh-CN.rc
    trunk/reactos/subsystems/mvdm/ntvdm/resource.h
Modified: trunk/reactos/subsystems/mvdm/ntvdm/console/console.c
URL:
http://svn.reactos.org/svn/reactos/trunk/reactos/subsystems/mvdm/ntvdm/cons…
==============================================================================
--- trunk/reactos/subsystems/mvdm/ntvdm/console/console.c       [iso-8859-1] (original)
+++ trunk/reactos/subsystems/mvdm/ntvdm/console/console.c       [iso-8859-1] Sat Nov  7
23:40:26 2015
@@ -18,9 +18,9 @@
 static DWORD  OrgConsoleInputMode, OrgConsoleOutputMode;
 HWND hConsoleWnd = NULL;
-static HMENU hConsoleMenu  = NULL;
-static INT   VdmMenuPos    = -1;
-static BOOLEAN ShowPointer = TRUE;
+static HMENU hConsoleMenu = NULL;
+static INT   VdmMenuPos   = -1;
+static BOOL  CaptureMouse = FALSE;
 /*
  * Those menu helpers were taken from the GUI frontend in winsrv.dll
@@ -48,8 +48,8 @@
 static const VDM_MENUITEM VdmMainMenuItems[] =
 {
     { -1, NULL, 0 },    /* Separator */
-    { IDS_HIDE_MOUSE,   NULL, ID_SHOWHIDE_MOUSE },  /* "Hide mouse"; can be
renamed to "Show mouse" */
-    { IDS_VDM_MENU  ,   VdmMenuItems,         0 },  /* ReactOS VDM Menu */
+    { IDS_CAPTURE_MOUSE, NULL, ID_CAPTURE_MOUSE },  /* "Capture mouse"; can be
renamed to "Release mouse" */
+    { IDS_VDM_MENU , VdmMenuItems, 0 },             /* ReactOS VDM Menu */
     { 0, NULL, 0 }      /* End of list */
 };
@@ -116,7 +116,7 @@
     /* Check for the presence of one of the VDM menu items */
     for (i = 0; i <= MenuPos; i++)
     {
-        if (GetMenuItemID(hConsoleMenu, i) == ID_SHOWHIDE_MOUSE)
+        if (GetMenuItemID(hConsoleMenu, i) == ID_CAPTURE_MOUSE)
         {
             /* Set VdmMenuPos to the position of the existing menu */
             VdmMenuPos = i - 1;
@@ -131,14 +131,14 @@
 {
     WCHAR szMenuString[256];
-    /* Update "Hide/Show mouse" menu item */
+    /* Update "Capture/Release mouse" menu item */
     if (LoadStringW(GetModuleHandle(NULL),
-                    (!ShowPointer ? IDS_SHOW_MOUSE : IDS_HIDE_MOUSE),
+                    (CaptureMouse ? IDS_RELEASE_MOUSE : IDS_CAPTURE_MOUSE),
                     szMenuString,
                     ARRAYSIZE(szMenuString)) > 0)
     {
-        ModifyMenuW(hConsoleMenu, ID_SHOWHIDE_MOUSE,
-                    MF_BYCOMMAND, ID_SHOWHIDE_MOUSE, szMenuString);
+        ModifyMenuW(hConsoleMenu, ID_CAPTURE_MOUSE,
+                    MF_BYCOMMAND, ID_CAPTURE_MOUSE, szMenuString);
     }
 }
@@ -210,7 +210,7 @@
     WCHAR szMenuString1[256], szMenuString2[256];
     hConsoleMenu = ConsoleMenuControl(ConOutHandle,
-                                      ID_SHOWHIDE_MOUSE,
+                                      ID_CAPTURE_MOUSE,
                                       ID_VDM_DRIVES + (2 *
ARRAYSIZE(GlobalSettings.FloppyDisks)));
     if (hConsoleMenu == NULL) return;
@@ -285,17 +285,33 @@
     DrawMenuBar(hConsoleWnd);
 }
-static VOID ShowHideMousePointer(HANDLE ConOutHandle, BOOLEAN ShowPtr)
-{
-    if (ShowPtr)
-    {
+static VOID CaptureMousePointer(HANDLE ConOutHandle, BOOLEAN Capture)
+{
+    static BOOL IsClipped = FALSE; // For debugging purposes
+    UNREFERENCED_PARAMETER(IsClipped);
+
+    if (Capture)
+    {
+        RECT rcClip;
+
+        // if (IsClipped) return;
+
+        /* Be sure the cursor will be hidden */
+        while (ShowConsoleCursor(ConOutHandle, FALSE) >= 0) ;
+
+        GetClientRect(hConsoleWnd, &rcClip);
+        MapWindowPoints(hConsoleWnd, HWND_DESKTOP /*NULL*/, (LPPOINT)&rcClip, 2 /*
Magic value when the LPPOINT parameter is a RECT */);
+        IsClipped = ClipCursor(&rcClip);
+    }
+    else
+    {
+        // if (!IsClipped) return;
+
+        ClipCursor(NULL);
+        IsClipped = FALSE;
+
         /* Be sure the cursor will be shown */
         while (ShowConsoleCursor(ConOutHandle, TRUE) < 0) ;
-    }
-    else
-    {
-        /* Be sure the cursor will be hidden */
-        while (ShowConsoleCursor(ConOutHandle, FALSE) >= 0) ;
     }
 }
@@ -373,7 +389,7 @@
 ConsoleCleanupUI(VOID)
 {
     /* Display again properly the mouse pointer */
-    if (ShowPointer) ShowHideMousePointer(ConsoleOutput, ShowPointer);
+    if (CaptureMouse) CaptureMousePointer(ConsoleOutput, !CaptureMouse);
     DestroyVdmMenu();
 }
@@ -423,7 +439,7 @@
     CreateVdmMenu(ConOutHandle);
     /* Synchronize mouse cursor display with console screenbuffer switches */
-    ShowHideMousePointer(CurrentConsoleOutput, ShowPointer);
+    CaptureMousePointer(CurrentConsoleOutput, CaptureMouse);
 }
 static BOOL
@@ -493,21 +509,25 @@
          */
         case WM_INITMENU:
-            DPRINT1("WM_INITMENU\n");
-            break;
-
         case WM_MENUSELECT:
-            DPRINT1("WM_MENUSELECT\n");
-            break;
+        {
+            /*
+             * If the mouse is captured, release it or recapture it
+             * when the menu opens or closes, respectively.
+             */
+            if (!CaptureMouse) break;
+            CaptureMousePointer(CurrentConsoleOutput, MenuEvent->dwCommandId ==
WM_INITMENU ? FALSE : TRUE);
+            break;
+        }
         /*
          * User-defined menu commands
          */
-        case ID_SHOWHIDE_MOUSE:
-            ShowPointer = !ShowPointer;
-            ShowHideMousePointer(CurrentConsoleOutput, ShowPointer);
+        case ID_CAPTURE_MOUSE:
+            CaptureMouse = !CaptureMouse;
+            CaptureMousePointer(CurrentConsoleOutput, CaptureMouse);
             UpdateVdmMenuMouse();
             break;
@@ -555,5 +575,10 @@
 VOID FocusEventHandler(PFOCUS_EVENT_RECORD FocusEvent)
 {
-    DPRINT1("Focus events not handled\n");
-}
+    /*
+     * If the mouse is captured, release it or recapture it
+     * when we lose or regain focus, respectively.
+     */
+    if (!CaptureMouse) return;
+    CaptureMousePointer(CurrentConsoleOutput, FocusEvent->bSetFocus);
+}
Modified: trunk/reactos/subsystems/mvdm/ntvdm/lang/cs-CZ.rc
URL:
http://svn.reactos.org/svn/reactos/trunk/reactos/subsystems/mvdm/ntvdm/lang…
==============================================================================
--- trunk/reactos/subsystems/mvdm/ntvdm/lang/cs-CZ.rc   [iso-8859-1] (original)
+++ trunk/reactos/subsystems/mvdm/ntvdm/lang/cs-CZ.rc   [iso-8859-1] Sat Nov  7 23:40:26
2015
@@ -8,9 +8,9 @@
 STRINGTABLE
 BEGIN
-    IDS_HIDE_MOUSE, "&Skrýt ukazatel myši"
-    IDS_SHOW_MOUSE, "&Zobrazit ukazatel myši"
-    IDS_VDM_MENU  , "ReactOS &VDM"
+    IDS_CAPTURE_MOUSE, "&Capture Mouse Pointer"
+    IDS_RELEASE_MOUSE, "&Release Mouse Pointer"
+    IDS_VDM_MENU     , "ReactOS &VDM"
 END
 STRINGTABLE
Modified: trunk/reactos/subsystems/mvdm/ntvdm/lang/de-DE.rc
URL:
http://svn.reactos.org/svn/reactos/trunk/reactos/subsystems/mvdm/ntvdm/lang…
==============================================================================
--- trunk/reactos/subsystems/mvdm/ntvdm/lang/de-DE.rc   [iso-8859-1] (original)
+++ trunk/reactos/subsystems/mvdm/ntvdm/lang/de-DE.rc   [iso-8859-1] Sat Nov  7 23:40:26
2015
@@ -2,9 +2,9 @@
 STRINGTABLE
 BEGIN
-    IDS_HIDE_MOUSE, "Mauszeiger &verstecken"
-    IDS_SHOW_MOUSE, "Mauszeiger &anzeigen"
-    IDS_VDM_MENU  , "&ReactOS VDM"
+    IDS_CAPTURE_MOUSE, "&Capture Mouse Pointer"
+    IDS_RELEASE_MOUSE, "&Release Mouse Pointer"
+    IDS_VDM_MENU     , "ReactOS &VDM"
 END
 STRINGTABLE
Modified: trunk/reactos/subsystems/mvdm/ntvdm/lang/en-US.rc
URL:
http://svn.reactos.org/svn/reactos/trunk/reactos/subsystems/mvdm/ntvdm/lang…
==============================================================================
--- trunk/reactos/subsystems/mvdm/ntvdm/lang/en-US.rc   [iso-8859-1] (original)
+++ trunk/reactos/subsystems/mvdm/ntvdm/lang/en-US.rc   [iso-8859-1] Sat Nov  7 23:40:26
2015
@@ -2,9 +2,9 @@
 STRINGTABLE
 BEGIN
-    IDS_HIDE_MOUSE, "&Hide Mouse Pointer"
-    IDS_SHOW_MOUSE, "&Display Mouse Pointer"
-    IDS_VDM_MENU  , "ReactOS &VDM"
+    IDS_CAPTURE_MOUSE, "&Capture Mouse Pointer"
+    IDS_RELEASE_MOUSE, "&Release Mouse Pointer"
+    IDS_VDM_MENU     , "ReactOS &VDM"
 END
 STRINGTABLE
Modified: trunk/reactos/subsystems/mvdm/ntvdm/lang/es-ES.rc
URL:
http://svn.reactos.org/svn/reactos/trunk/reactos/subsystems/mvdm/ntvdm/lang…
==============================================================================
--- trunk/reactos/subsystems/mvdm/ntvdm/lang/es-ES.rc   [iso-8859-1] (original)
+++ trunk/reactos/subsystems/mvdm/ntvdm/lang/es-ES.rc   [iso-8859-1] Sat Nov  7 23:40:26
2015
@@ -2,9 +2,9 @@
 STRINGTABLE
 BEGIN
-    IDS_HIDE_MOUSE, "&Ocultar puntero del ratón"
-    IDS_SHOW_MOUSE, "&Mostrar puntero del ratón"
-    IDS_VDM_MENU  , "ReactOS &VDM"
+    IDS_CAPTURE_MOUSE, "&Capture Mouse Pointer"
+    IDS_RELEASE_MOUSE, "&Release Mouse Pointer"
+    IDS_VDM_MENU     , "ReactOS &VDM"
 END
 STRINGTABLE
Modified: trunk/reactos/subsystems/mvdm/ntvdm/lang/fr-FR.rc
URL:
http://svn.reactos.org/svn/reactos/trunk/reactos/subsystems/mvdm/ntvdm/lang…
==============================================================================
--- trunk/reactos/subsystems/mvdm/ntvdm/lang/fr-FR.rc   [iso-8859-1] (original)
+++ trunk/reactos/subsystems/mvdm/ntvdm/lang/fr-FR.rc   [iso-8859-1] Sat Nov  7 23:40:26
2015
@@ -2,9 +2,9 @@
 STRINGTABLE
 BEGIN
-    IDS_HIDE_MOUSE, "Mas&quer le pointeur de la souris"
-    IDS_SHOW_MOUSE, "&Afficher le pointeur de la souris"
-    IDS_VDM_MENU  , "ReactOS &VDM"
+    IDS_CAPTURE_MOUSE, "&Capturer le pointeur de la souris"
+    IDS_RELEASE_MOUSE, "&Libérer le pointeur de la souris"
+    IDS_VDM_MENU     , "ReactOS &VDM"
 END
 STRINGTABLE
Modified: trunk/reactos/subsystems/mvdm/ntvdm/lang/it-IT.rc
URL:
http://svn.reactos.org/svn/reactos/trunk/reactos/subsystems/mvdm/ntvdm/lang…
==============================================================================
--- trunk/reactos/subsystems/mvdm/ntvdm/lang/it-IT.rc   [iso-8859-1] (original)
+++ trunk/reactos/subsystems/mvdm/ntvdm/lang/it-IT.rc   [iso-8859-1] Sat Nov  7 23:40:26
2015
@@ -2,9 +2,9 @@
 STRINGTABLE
 BEGIN
-    IDS_HIDE_MOUSE, "&Nascondi il mouse"
-    IDS_SHOW_MOUSE, "&Mostra il mouse"
-    IDS_VDM_MENU  , "ReactOS &VDM"
+    IDS_CAPTURE_MOUSE, "&Capture Mouse Pointer"
+    IDS_RELEASE_MOUSE, "&Release Mouse Pointer"
+    IDS_VDM_MENU     , "ReactOS &VDM"
 END
 STRINGTABLE
Modified: trunk/reactos/subsystems/mvdm/ntvdm/lang/pl-PL.rc
URL:
http://svn.reactos.org/svn/reactos/trunk/reactos/subsystems/mvdm/ntvdm/lang…
==============================================================================
--- trunk/reactos/subsystems/mvdm/ntvdm/lang/pl-PL.rc   [iso-8859-1] (original)
+++ trunk/reactos/subsystems/mvdm/ntvdm/lang/pl-PL.rc   [iso-8859-1] Sat Nov  7 23:40:26
2015
@@ -4,9 +4,9 @@
 STRINGTABLE
 BEGIN
-    IDS_HIDE_MOUSE, "&Ukryj Wskaźnik Myszki"
-    IDS_SHOW_MOUSE, "&Pokaż Wskaźnik Myszki"
-    IDS_VDM_MENU  , "ReactOS &VDM"
+    IDS_CAPTURE_MOUSE, "&Capture Mouse Pointer"
+    IDS_RELEASE_MOUSE, "&Release Mouse Pointer"
+    IDS_VDM_MENU     , "ReactOS &VDM"
 END
 STRINGTABLE
Modified: trunk/reactos/subsystems/mvdm/ntvdm/lang/ro-RO.rc
URL:
http://svn.reactos.org/svn/reactos/trunk/reactos/subsystems/mvdm/ntvdm/lang…
==============================================================================
--- trunk/reactos/subsystems/mvdm/ntvdm/lang/ro-RO.rc   [iso-8859-1] (original)
+++ trunk/reactos/subsystems/mvdm/ntvdm/lang/ro-RO.rc   [iso-8859-1] Sat Nov  7 23:40:26
2015
@@ -3,9 +3,9 @@
 STRINGTABLE
 BEGIN
-    IDS_HIDE_MOUSE, "Asc&unde indicatorul șoricelului"
-    IDS_SHOW_MOUSE, "Afișea&ză indicatorul șoricelului"
-    IDS_VDM_MENU  , "ReactOS &VDM"
+    IDS_CAPTURE_MOUSE, "&Capture Mouse Pointer"
+    IDS_RELEASE_MOUSE, "&Release Mouse Pointer"
+    IDS_VDM_MENU     , "ReactOS &VDM"
 END
 STRINGTABLE
Modified: trunk/reactos/subsystems/mvdm/ntvdm/lang/ru-RU.rc
URL:
http://svn.reactos.org/svn/reactos/trunk/reactos/subsystems/mvdm/ntvdm/lang…
==============================================================================
--- trunk/reactos/subsystems/mvdm/ntvdm/lang/ru-RU.rc   [iso-8859-1] (original)
+++ trunk/reactos/subsystems/mvdm/ntvdm/lang/ru-RU.rc   [iso-8859-1] Sat Nov  7 23:40:26
2015
@@ -2,9 +2,9 @@
 STRINGTABLE
 BEGIN
-    IDS_HIDE_MOUSE, "&Спрятать указатель мыши"
-    IDS_SHOW_MOUSE, "&Отобразить указатель мыши"
-    IDS_VDM_MENU  , "ReactOS &VDM"
+    IDS_CAPTURE_MOUSE, "&Capture Mouse Pointer"
+    IDS_RELEASE_MOUSE, "&Release Mouse Pointer"
+    IDS_VDM_MENU     , "ReactOS &VDM"
 END
 STRINGTABLE
Modified: trunk/reactos/subsystems/mvdm/ntvdm/lang/tr-TR.rc
URL:
http://svn.reactos.org/svn/reactos/trunk/reactos/subsystems/mvdm/ntvdm/lang…
==============================================================================
--- trunk/reactos/subsystems/mvdm/ntvdm/lang/tr-TR.rc   [iso-8859-1] (original)
+++ trunk/reactos/subsystems/mvdm/ntvdm/lang/tr-TR.rc   [iso-8859-1] Sat Nov  7 23:40:26
2015
@@ -4,9 +4,9 @@
 STRINGTABLE
 BEGIN
-    IDS_HIDE_MOUSE, "&Fâre İmlecini Gizle"
-    IDS_SHOW_MOUSE, "Fâre &İmlecini Göster"
-    IDS_VDM_MENU  , "&ReactOS VDM"
+    IDS_CAPTURE_MOUSE, "&Capture Mouse Pointer"
+    IDS_RELEASE_MOUSE, "&Release Mouse Pointer"
+    IDS_VDM_MENU     , "ReactOS &VDM"
 END
 STRINGTABLE
Modified: trunk/reactos/subsystems/mvdm/ntvdm/lang/zh-CN.rc
URL:
http://svn.reactos.org/svn/reactos/trunk/reactos/subsystems/mvdm/ntvdm/lang…
==============================================================================
--- trunk/reactos/subsystems/mvdm/ntvdm/lang/zh-CN.rc   [iso-8859-1] (original)
+++ trunk/reactos/subsystems/mvdm/ntvdm/lang/zh-CN.rc   [iso-8859-1] Sat Nov  7 23:40:26
2015
@@ -4,9 +4,9 @@
 STRINGTABLE
 BEGIN
-    IDS_HIDE_MOUSE, "éšè—é¼ æ ‡æŒ‡é’ˆ (&H)"
-    IDS_SHOW_MOUSE, "æ˜¾ç¤ºé¼ æ ‡æŒ‡é’ˆ (&D)"
-    IDS_VDM_MENU  , "ReactOS DOS 虚拟机 (&V)"
+    IDS_CAPTURE_MOUSE, "&Capture Mouse Pointer"
+    IDS_RELEASE_MOUSE, "&Release Mouse Pointer"
+    IDS_VDM_MENU     , "ReactOS DOS 虚拟机 (&V)"
 END
 STRINGTABLE
Modified: trunk/reactos/subsystems/mvdm/ntvdm/resource.h
URL:
http://svn.reactos.org/svn/reactos/trunk/reactos/subsystems/mvdm/ntvdm/reso…
==============================================================================
--- trunk/reactos/subsystems/mvdm/ntvdm/resource.h      [iso-8859-1] (original)
+++ trunk/reactos/subsystems/mvdm/ntvdm/resource.h      [iso-8859-1] Sat Nov  7 23:40:26
2015
@@ -1,7 +1,7 @@
 #pragma once
 /* Menu IDs */
-#define ID_SHOWHIDE_MOUSE   1000
+#define ID_CAPTURE_MOUSE    1000
 #define ID_VDM_DUMPMEM_TXT  1001
 #define ID_VDM_DUMPMEM_BIN  1002
 #define ID_VDM_QUIT         1003
@@ -10,9 +10,9 @@
 #define ID_VDM_DRIVES       1010
 /* String IDs */
-#define IDS_HIDE_MOUSE  100
-#define IDS_SHOW_MOUSE  101
-#define IDS_VDM_MENU    102
+#define IDS_CAPTURE_MOUSE   100
+#define IDS_RELEASE_MOUSE   101
+#define IDS_VDM_MENU        102
 #define IDS_VDM_DUMPMEM_TXT     200
 #define IDS_VDM_DUMPMEM_BIN     201