Changeset 886 in vbox

Timestamp:

Feb 13, 2007 5:51:42 PM (18 years ago)

Author:

vboxsync

svn:sync-xref-src-repo-rev:

18598

Message:

Main: Implemented sending essential notifications (such as the current mouse shape and state) to a callback registered during the VM runtime (defect #1817).

Location:

trunk/src/VBox/Main

Files:

• ConsoleImpl.cpp (modified) (10 diffs)
• include/ConsoleImpl.h (modified) (2 diffs)

trunk/src/VBox/Main/ConsoleImpl.cpp

@@ -306 +306 @@
     AssertReturn (mAudioSniffer, E_FAIL);
 
+    memset (&mCallbackData, 0, sizeof (mCallbackData));    
+    
     /* Confirm a successful initialization when it's the case */
     autoInitSpan.setSucceeded();
@@ -419 +421 @@
     unconst (mMachine).setNull();
 
-    // Release all callbacks. Do this after uninitializing the components,
-    // as some of them are well-behaved and unregister their callbacks.
-    // These would trigger error messages complaining about trying to
-    // unregister a non-registered callback.
+    /* Release all callbacks. Do this after uninitializing the components,
+     * as some of them are well-behaved and unregister their callbacks.
+     * These would trigger error messages complaining about trying to
+     * unregister a non-registered callback. */
     mCallbacks.clear();
+
+    /* dynamically allocated members of mCallbackData are uninitialized
+     * at the end of powerDown() */
+    Assert (!mCallbackData.mpsc.valid && mCallbackData.mpsc.shape == NULL);
+    Assert (!mCallbackData.mcc.valid);
+    Assert (!mCallbackData.klc.valid);
 
     LogFlowThisFuncLeave();
@@ -2355 +2363 @@
     mCallbacks.push_back (CallbackList::value_type (aCallback));
 
-#if 0
-    /* @todo dmik please implement this.
-     * Inform the callback about the current status, because the new callback
-     * must know at least the current mouse capabilities and the pointer shape.
-     */
-    aCallback->OnMousePointerShapeChange (mCallbacksStatus.pointerShape.fVisible,
-                                          mCallbackStatus.pointerShape.fAlpha,
-                                          mCallbackStatus.pointerShape.xHot,
-                                          mCallbackStatus.pointerShape.yHot,
-                                          mCallbackStatus.pointerShape.width,
-                                          mCallbackStatus.pointerShape.height,
-                                          mCallbackStatus.pointerShape.pShape);
-    aCallback->OnMouseCapabilityChange (mCallbackStatus.mouseCapability.supportsAbsolute,
-                                        mCallbackStatus.mouseCapability.needsHostCursor);
-    aCallback->OnStateChange (mCallbackStatus.machineState);
+    /* Inform the callback about the current status (for example, the new
+     * callback must know the current mouse capabilities and the pointer
+     * shape in order to properly integrate the mouse pointer). */
+
+    if (mCallbackData.mpsc.valid)
+        aCallback->OnMousePointerShapeChange (mCallbackData.mpsc.visible,
+                                              mCallbackData.mpsc.alpha,
+                                              mCallbackData.mpsc.xHot,
+                                              mCallbackData.mpsc.yHot,
+                                              mCallbackData.mpsc.width,
+                                              mCallbackData.mpsc.height,
+                                              mCallbackData.mpsc.shape);
+    if (mCallbackData.mcc.valid)
+        aCallback->OnMouseCapabilityChange (mCallbackData.mcc.supportsAbsolute,
+                                            mCallbackData.mcc.needsHostCursor);
+
+    aCallback->OnStateChange (mMachineState);
     aCallback->OnAdditionsStateChange();
-    aCallback->OnKeyboardLedsChange(mCallbackStatus.keyboardLeds.fNumLock,
-                                    mCallbackStatus.keyboardLeds.fCapsLock,
-                                    mCallbackStatus.keyboardLeds.fScrollLock);
-#endif
+
+    if (mCallbackData.klc.valid)
+        aCallback->OnKeyboardLedsChange (mCallbackData.klc.numLock,
+                                         mCallbackData.klc.capsLock,
+                                         mCallbackData.klc.scrollLock);
 
     return S_OK;
@@ -3264 +3275 @@
 
 /**
- *  @note Locks this object for reading.
+ *  @note Locks this object for writing.
  */
 void Console::onMousePointerShapeChange(bool fVisible, bool fAlpha,
@@ -3275 +3286 @@
                       fVisible, fAlpha, xHot, yHot, width, height, pShape));
 
-    AutoReaderLock alock (this);
+    AutoCaller autoCaller (this);
+    AssertComRCReturnVoid (autoCaller.rc());
+
+    /* We need a write lock because we alter the cached callback data */
+    AutoLock alock (this);
+
+    /* save the callback arguments */
+    mCallbackData.mpsc.visible = fVisible;
+    mCallbackData.mpsc.alpha = fAlpha;
+    mCallbackData.mpsc.xHot = xHot;
+    mCallbackData.mpsc.yHot = yHot;
+    mCallbackData.mpsc.width = width;
+    mCallbackData.mpsc.height = height;
+    
+    if (pShape != NULL)
+    {
+        size_t cb = (width + 7) / 8 * height; /* size of the AND mask */
+        cb += (cb + 3) & ~3 + width * 4 * height; /* + gap + size of the XOR mask */
+        mCallbackData.mpsc.shape = (BYTE *) RTMemAllocZ (cb);
+        AssertReturnVoid (mCallbackData.mpsc.shape);
+        memcpy (mCallbackData.mpsc.shape, pShape, cb);
+    }
+    else
+        mCallbackData.mpsc.shape = NULL;
+
+    mCallbackData.mpsc.valid = true;
 
     CallbackList::iterator it = mCallbacks.begin();
@@ -3284 +3320 @@
 
 /**
- *  @note Locks this object for reading.
+ *  @note Locks this object for writing.
  */
 void Console::onMouseCapabilityChange (BOOL supportsAbsolute, BOOL needsHostCursor)
@@ -3294 +3330 @@
     AssertComRCReturnVoid (autoCaller.rc());
 
-    AutoReaderLock alock (this);
-
+    /* We need a write lock because we alter the cached callback data */
+    AutoLock alock (this);
+
+    /* save the callback arguments */
+    mCallbackData.mcc.supportsAbsolute = supportsAbsolute;
+    mCallbackData.mcc.needsHostCursor = needsHostCursor;
+    mCallbackData.mcc.valid = true;
+    
     CallbackList::iterator it = mCallbacks.begin();
     while (it != mCallbacks.end())
@@ -3352 +3394 @@
 
 /**
- *  @note Locks this object for reading.
+ *  @note Locks this object for writing.
  */
 void Console::onKeyboardLedsChange(bool fNumLock, bool fCapsLock, bool fScrollLock)
@@ -3359 +3401 @@
     AssertComRCReturnVoid (autoCaller.rc());
 
-    AutoReaderLock alock (this);
+    /* We need a write lock because we alter the cached callback data */
+    AutoLock alock (this);
+
+    /* save the callback arguments */
+    mCallbackData.klc.numLock = fNumLock;
+    mCallbackData.klc.capsLock = fCapsLock;
+    mCallbackData.klc.scrollLock = fScrollLock;
+    mCallbackData.klc.valid = true;
 
     CallbackList::iterator it = mCallbacks.begin();
@@ -3657 +3706 @@
         mVMDestroying = false;
 
+    if (SUCCEEDED (rc))
+    {
+        /* uninit dynamically allocated members of mCallbackData */
+        if (mCallbackData.mpsc.valid)
+        {
+            if (mCallbackData.mpsc.shape != NULL)
+                RTMemFree (mCallbackData.mpsc.shape);
+        }
+        memset (&mCallbackData, 0, sizeof (mCallbackData));    
+    }
+    
     LogFlowThisFuncLeave();
     return rc;

trunk/src/VBox/Main/include/ConsoleImpl.h

@@ -478 +478 @@
     bool mVMStateChangeCallbackDisabled;
 
-    // local state value
+    /* Local machine state value */
     MachineState_T mMachineState;
 
@@ -484 +484 @@
     CallbackList mCallbacks;
 
+    struct
+    {
+        /** OnMousePointerShapeChange() cache */
+        struct
+        {
+            bool valid;
+            bool visible;
+            bool alpha;
+            uint32_t xHot;
+            uint32_t yHot;
+            uint32_t width;
+            uint32_t height;
+            BYTE *shape;
+        }
+        mpsc;
+
+        /** OnMouseCapabilityChange() cache */
+        struct
+        {
+            bool valid;
+            BOOL supportsAbsolute;
+            BOOL needsHostCursor;
+        }
+        mcc;
+
+        /** OnKeyboardLedsChange() cache */
+        struct
+        {
+            bool valid;
+            bool numLock;
+            bool capsLock;
+            bool scrollLock;
+        }
+        klc;
+    }
+    mCallbackData;
+    
     friend struct VMTask;
 };