Changeset 2463 in vbox for trunk/src/VBox

Timestamp:

May 3, 2007 1:53:29 PM (18 years ago)

Author:

vboxsync

Message:

Main & All Frontends: Prototyped a bunch of Main API changes (IVirtualBoxErrorInfo extension for cascading errors; IMachine/IConsoleCallback extension to properly activate the console window; IVirtualBoxCallback::onExtraDataCanChange() support for error messages; minor IHost::createUSBDeviceFilter/removeUSBDeviceFilter corrections).

Location:

trunk/src/VBox

Files:

• Frontends/VBoxSDL/VBoxSDL.cpp (modified) (2 diffs)
• Frontends/VirtualBox/src/VBoxConsoleView.cpp (modified) (1 diff)
• Frontends/VirtualBox/src/VBoxGlobal.cpp (modified) (2 diffs)
• Frontends/VirtualBox/src/VBoxGlobalSettings.cpp (modified) (2 diffs)
• Frontends/VirtualBox/ui/VBoxGlobalSettingsDlg.ui.h (modified) (3 diffs)
• Main/ConsoleImpl.cpp (modified) (1 diff)
• Main/MachineImpl.cpp (modified) (15 diffs)
• Main/SessionImpl.cpp (modified) (1 diff)
• Main/VirtualBoxErrorInfoImpl.cpp (modified) (3 diffs)
• Main/VirtualBoxImpl.cpp (modified) (7 diffs)
• Main/idl/VirtualBox.xidl (modified) (24 diffs)
• Main/include/ConsoleImpl.h (modified) (1 diff)
• Main/include/DisplayImpl.h (modified) (1 diff)
• Main/include/MachineImpl.h (modified) (2 diffs)
• Main/include/SessionImpl.h (modified) (1 diff)
• Main/include/VirtualBoxErrorInfoImpl.h (modified) (2 diffs)
• Main/include/VirtualBoxImpl.h (modified) (1 diff)

trunk/src/VBox/Frontends/VBoxSDL/VBoxSDL.cpp

@@ -264 +264 @@
 
     STDMETHOD(OnExtraDataCanChange)(INPTR GUIDPARAM machineId, INPTR BSTR key, INPTR BSTR value,
-                                    BOOL *changeAllowed)
+                                    BSTR *error, BOOL *changeAllowed)
     {
         /* we never disagree */
         if (!changeAllowed)
             return E_INVALIDARG;
-        *changeAllowed = true;
+        *changeAllowed = TRUE;
         return S_OK;
     }
@@ -500 +500 @@
                      fPaused ? "The VM was paused. Continue with HostKey + P after you solved the problem.\n" : "");
         return S_OK;
+    }
+
+    STDMETHOD(OnCanShowWindow)(BOOL *canShow)
+    {
+        if (!canShow)
+            return E_POINTER;
+        /* @todo return TRUE if gConsole is not NULL */
+        *canShow = FALSE;
+        return S_OK;
+    }
+
+    STDMETHOD(OnShowWindow)()
+    {
+        /* @todo implement */
+        return E_NOTIMPL;
     }
 

trunk/src/VBox/Frontends/VirtualBox/src/VBoxConsoleView.cpp

@@ -367 +367 @@
                                          QString::fromUcs2 (message)));
         return S_OK;
+    }
+
+    STDMETHOD(OnCanShowWindow)(BOOL *canShow)
+    {
+        if (!canShow)
+            return E_POINTER;
+        /* @todo return TRUE... */
+        *canShow = FALSE;
+        return S_OK;
+    }
+
+    STDMETHOD(OnShowWindow)()
+    {
+        /* @todo implement */
+        return E_NOTIMPL;
     }
 

trunk/src/VBox/Frontends/VirtualBox/src/VBoxGlobal.cpp

@@ -174 +174 @@
     STDMETHOD(OnExtraDataCanChange)(IN_GUIDPARAM id,
                                     IN_BSTRPARAM key, IN_BSTRPARAM value,
-                                    BOOL *allowChange)
-    {
-        if (!allowChange)
+                                    BSTR *error, BOOL *allowChange)
+    {
+        if (!error || !allowChange)
             return E_INVALIDARG;
 
         if (COMBase::toQUuid (id).isNull())
         {
-            // it's a global extra data key someone wants to change
+            /* it's a global extra data key someone wants to change */
             QString sKey = QString::fromUcs2 (key);
             QString sVal = QString::fromUcs2 (value);
             if (sKey.startsWith ("GUI/"))
             {
-                // try to set the global setting to check its syntax
+                /* try to set the global setting to check its syntax */
                 VBoxGlobalSettings gs (false /* non-null */);
                 if (gs.setPublicProperty (sKey, sVal))
                 {
-                    /// @todo (dmik)
-                    //  report the error message to the server using
-                    //  IVurtualBoxError
-                    *allowChange = !!gs; // allow only when no error
+                    /* this is a known GUI property key */
+                    if (!gs)
+                    {
+                        /* disallow the change when there is an error*/
+                        *error = SysAllocString ((const OLECHAR *)
+                                                 gs.lastError().ucs2());
+                        *allowChange = FALSE;
+                    }
+                    else
+                        *allowChange = TRUE;
                     return S_OK;
                 }
@@ -199 +205 @@
         }
 
-        // not interested in this key -- never disagree
+        /* not interested in this key -- never disagree */
         *allowChange = TRUE;
         return S_OK;

trunk/src/VBox/Frontends/VirtualBox/src/VBoxGlobalSettings.cpp

@@ -197 +197 @@
 
 /**
- *  Sets a value of the property with the given public name.
- *  Returns false if such property is not found, and true otherwise.
+ *  Sets a value of a property with the given public name.
+ *  Returns false if the specified property is not found, and true otherwise.
  *
  *  This method (as opposed to #setProperty (const char *name, const QVariant& value))
@@ -204 +204 @@
  *
  *  If an error occures while setting the value of the property, #operator !()
- *  will return false after this method returns, and #lastError() will contain
+ *  will return false after this method returns true, and #lastError() will contain
  *  the error message.
  *

trunk/src/VBox/Frontends/VirtualBox/ui/VBoxGlobalSettingsDlg.ui.h

@@ -656 +656 @@
      */
     CHost host = vboxGlobal().virtualBox().GetHost();
-    CHostUSBDeviceFilter removedFilter;
     if (mUSBFilterListModified)
-        for (ulong count = host.GetUSBDeviceFilters().GetCount(); count; -- count)
-            host.RemoveUSBDeviceFilter (0, removedFilter);
+        for (ulong cnt = host.GetUSBDeviceFilters().GetCount(); cnt; -- cnt)
+            host.RemoveUSBDeviceFilter (0);
 
     /* then add all new filters */
@@ -877 +876 @@
     }
 
-    /* creating new usb filter */
-    CHostUSBDeviceFilter hostFilter;
-    vboxGlobal().virtualBox().GetHost().CreateUSBDeviceFilter (
-        usbFilterName.arg (maxFilterIndex + 1), hostFilter);
+    /* create a new usb filter */
+    CHost host = vboxGlobal().virtualBox().GetHost();
+    CHostUSBDeviceFilter hostFilter = host
+        .CreateUSBDeviceFilter (usbFilterName.arg (maxFilterIndex + 1));
     hostFilter.SetAction (CEnums::USBDeviceFilterHold);
 
@@ -904 +903 @@
 
     CHost host = vboxGlobal().virtualBox().GetHost();
-    CHostUSBDeviceFilter hostFilter;
-    host.CreateUSBDeviceFilter (vboxGlobal().details (usb), hostFilter);
+    CHostUSBDeviceFilter hostFilter = host
+        .CreateUSBDeviceFilter (vboxGlobal().details (usb));
     hostFilter.SetAction (CEnums::USBDeviceFilterHold);
 

trunk/src/VBox/Main/ConsoleImpl.cpp

@@ -3502 +3502 @@
     while (it != mCallbacks.end())
         (*it++)->OnRuntimeError (aFatal, aErrorID, aMessage);
+}
+
+/**
+ *  @note Locks this object for reading.
+ */
+HRESULT Console::onShowWindow (BOOL aCheck, BOOL *aCanShow)
+{
+    AssertReturn (aCanShow, E_POINTER);
+
+    *aCanShow = FALSE;
+
+    AutoCaller autoCaller (this);
+    AssertComRCReturnRC (autoCaller.rc());
+
+    AutoReaderLock alock (this);
+
+    HRESULT rc = S_OK;
+    CallbackList::iterator it = mCallbacks.begin();
+
+    if (aCheck)
+    {
+        while (it != mCallbacks.end())
+        {
+            BOOL canShow = FALSE;
+            rc = (*it++)->OnCanShowWindow (&canShow);
+            AssertComRC (rc);
+            if (FAILED (rc) || !canShow)
+                return rc;
+        }
+        *aCanShow = TRUE;
+    }
+    else
+    {
+        while (it != mCallbacks.end())
+        {
+            rc = (*it++)->OnShowWindow();
+            if (FAILED (rc))
+                return rc;
+        }
+    }
+
+    return S_OK;
 }
 

trunk/src/VBox/Main/MachineImpl.cpp

@@ -1791 +1791 @@
 }
 
-/**
- * Returns the extra data key name following the given key. If the key
- * is not found, an error is returned. If NULL is supplied, the first
- * key will be returned. If key is the last item, NULL will be returned.
- *
- * @returns COM status code
- * @param key       extra data key name
- * @param nextKey   name of the key following "key". NULL if "key" is the last.
- * @param nextValue value of the key following "key". Optional parameter.
- */
-STDMETHODIMP Machine::GetNextExtraDataKey(INPTR BSTR key, BSTR *nextKey, BSTR *nextValue)
-{
-    if (!nextKey)
+STDMETHODIMP Machine::GetNextExtraDataKey (INPTR BSTR aKey, BSTR *aNextKey, BSTR *aNextValue)
+{
+    if (!aNextKey)
         return E_POINTER;
 
@@ -1812 +1802 @@
 
     /* start with nothing found */
-    *nextKey = NULL;
+    *aNextKey = NULL;
 
     /*
@@ -1848 +1838 @@
 
             /* if we're supposed to return the first one */
-            if (key == NULL)
+            if (aKey == NULL)
             {
-                name.cloneTo(nextKey);
-                if (nextValue)
-                    CFGLDRQueryBSTR(extraDataItemNode, "value", nextValue);
+                name.cloneTo(aNextKey);
+                if (aNextValue)
+                    CFGLDRQueryBSTR(extraDataItemNode, "value", aNextValue);
                 found = true;
             }
             /* did we find the key we're looking for? */
-            else if (name == key)
+            else if (name == aKey)
             {
                 found = true;
@@ -1864 +1854 @@
                     CFGLDRGetChildNode(extraDataNode, "ExtraDataItem", i + 1, &extraDataItemNode);
                     CFGLDRQueryBSTR(extraDataItemNode, "name", name.asOutParam());
-                    name.cloneTo(nextKey);
-                    if (nextValue)
-                        CFGLDRQueryBSTR(extraDataItemNode, "value", nextValue);
+                    name.cloneTo(aNextKey);
+                    if (aNextValue)
+                        CFGLDRQueryBSTR(extraDataItemNode, "value", aNextValue);
                     found = true;
                 }
@@ -1872 +1862 @@
                 {
                     /* it's the last one */
-                    *nextKey = NULL;
+                    *aNextKey = NULL;
                 }
             }
@@ -1891 +1881 @@
 }
 
-/**
- * Returns associated extra data from the configuration. If the key does
- * not exist, NULL will be stored in the output pointer.
- *
- * @returns COM status code
- * @param key    extra data key
- * @param value  address of result pointer
- */
-STDMETHODIMP Machine::GetExtraData(INPTR BSTR key, BSTR *value)
-{
-    if (!key)
+STDMETHODIMP Machine::GetExtraData (INPTR BSTR aKey, BSTR *aValue)
+{
+    if (!aKey)
         return E_INVALIDARG;
-    if (!value)
+    if (!aValue)
         return E_POINTER;
 
@@ -1912 +1894 @@
 
     /* start with nothing found */
-    *value = NULL;
+    *aValue = NULL;
 
     /*
@@ -1946 +1928 @@
             CFGLDRGetChildNode(extraDataNode, "ExtraDataItem", i, &extraDataItemNode);
             CFGLDRQueryBSTR(extraDataItemNode, "name", name.asOutParam());
-            if (name == key)
+            if (name == aKey)
             {
                 found = true;
-                CFGLDRQueryBSTR(extraDataItemNode, "value", value);
+                CFGLDRQueryBSTR(extraDataItemNode, "value", aValue);
             }
             CFGLDRReleaseNode(extraDataItemNode);
@@ -1964 +1946 @@
 
 /**
- *  Stores associated extra data in the configuration. If the data value is NULL
- *  then the corresponding extra data item is deleted. This method can be called
- *  outside a session and therefore belongs to the non protected machine data.
- *
- *  @param key    extra data key
- *  @param value  extra data value
- *
  *  @note Locks mParent for reading + this object for writing.
  */
-STDMETHODIMP Machine::SetExtraData (INPTR BSTR key, INPTR BSTR value)
-{
-    if (!key)
+STDMETHODIMP Machine::SetExtraData (INPTR BSTR aKey, INPTR BSTR aValue)
+{
+    if (!aKey)
         return E_INVALIDARG;
 
@@ -2015 +1990 @@
 
     vrc = CFGLDRGetChildNode (machineNode, "ExtraData", 0, &extraDataNode);
-    if (VBOX_FAILURE (vrc) && value)
+    if (VBOX_FAILURE (vrc) && aValue)
         vrc = CFGLDRCreateChildNode (machineNode, "ExtraData", &extraDataNode);
 
@@ -2031 +2006 @@
             Bstr name;
             CFGLDRQueryBSTR (extraDataItemNode, "name", name.asOutParam());
-            if (name == key)
+            if (name == aKey)
             {
                 CFGLDRQueryBSTR (extraDataItemNode, "value", oldVal.asOutParam());
@@ -2044 +2019 @@
          *  Note:
          *  1. when oldVal is null, |oldVal == (BSTR) NULL| is true
-         *  2. we cannot do |oldVal != value| because it will compare
+         *  2. we cannot do |oldVal != aValue| because it will compare
          *  BSTR pointers instead of strings (due to type conversion ops)
          */
-        changed = !(oldVal == value);
+        changed = !(oldVal == aValue);
 
         if (changed)
         {
             /* ask for permission from all listeners */
-            if (!mParent->onExtraDataCanChange (mData->mUuid, key, value))
+            Bstr error;
+            if (!mParent->onExtraDataCanChange (mData->mUuid, aKey, aValue, error))
             {
-                LogWarningFunc (("Someone vetoed! Change refused!\n"));
+                const char *sep = error.isEmpty() ? "" : ": ";
+                const BSTR err = error.isNull() ? (const BSTR) L"" : error.raw();
+                LogWarningFunc (("Someone vetoed! Change refused%s%ls\n",
+                                 sep, err));
                 rc = setError (E_ACCESSDENIED,
                     tr ("Could not set extra data because someone refused "
-                        "the requested change of '%ls' to '%ls'"), key, value);
+                        "the requested change of '%ls' to '%ls'%s%ls"),
+                    aKey, aValue, sep, err);
             }
             else
             {
-                if (value)
+                if (aValue)
                 {
                     if (!extraDataItemNode)
@@ -2068 +2048 @@
                         CFGLDRAppendChildNode (extraDataNode, "ExtraDataItem",
                                                &extraDataItemNode);
-                        CFGLDRSetBSTR (extraDataItemNode, "name", key);
+                        CFGLDRSetBSTR (extraDataItemNode, "name", aKey);
                     }
-                    CFGLDRSetBSTR (extraDataItemNode, "value", value);
+                    CFGLDRSetBSTR (extraDataItemNode, "value", aValue);
                 }
                 else
@@ -2097 +2077 @@
     if (SUCCEEDED (rc) && changed)
     {
-        mParent->onExtraDataChange (mData->mUuid, key, value);
+        mParent->onExtraDataChange (mData->mUuid, aKey, aValue);
     }
 
@@ -2313 +2293 @@
 
     return S_OK;
+}
+
+STDMETHODIMP Machine::CanShowConsoleWindow (BOOL *aCanShow)
+{
+    if (!aCanShow)
+        return E_POINTER;
+
+    /* start with No */
+    aCanShow = FALSE;
+
+    AutoCaller autoCaller (this);
+    AssertComRCReturn (autoCaller.rc(), autoCaller.rc());
+
+    ComPtr <IInternalSessionControl> directControl;
+    {
+        AutoReaderLock alock (this);
+
+        if (mData->mSession.mState != SessionState_SessionOpen)
+            return setError (E_FAIL,
+                tr ("Machine session is not open (session state: %d)"),
+                mData->mSession.mState);
+
+        directControl = mData->mSession.mDirectControl;
+    }
+
+    /* ignore calls made after #OnSessionEnd() is called */
+    if (!directControl)
+        return S_OK;
+
+    return directControl->OnShowWindow (TRUE /* aCheck */, aCanShow);
+}
+
+STDMETHODIMP Machine::ShowConsoleWindow()
+{
+    AutoCaller autoCaller (this);
+    AssertComRCReturn (autoCaller.rc(), autoCaller.rc());
+
+    ComPtr <IInternalSessionControl> directControl;
+    {
+        AutoReaderLock alock (this);
+
+        if (mData->mSession.mState != SessionState_SessionOpen)
+            return setError (E_FAIL,
+                tr ("Machine session is not open (session state: %d)"),
+                mData->mSession.mState);
+
+        directControl = mData->mSession.mDirectControl;
+    }
+
+    /* ignore calls made after #OnSessionEnd() is called */
+    if (!directControl)
+        return S_OK;
+
+    BOOL dummy;
+    return directControl->OnShowWindow (FALSE /* aCheck */, &dummy);
 }
 

trunk/src/VBox/Main/SessionImpl.cpp

@@ -588 +588 @@
 
     return mConsole->onUSBDeviceDetach (aId);
+}
+
+STDMETHODIMP Session::OnShowWindow (BOOL aCheck, BOOL *aCanShow)
+{
+    AutoCaller autoCaller (this);
+    AssertComRCReturn (autoCaller.rc(), autoCaller.rc());
+
+    AutoReaderLock alock (this);
+    AssertReturn (mState == SessionState_SessionOpen &&
+                  mType == SessionType_DirectSession, E_FAIL);
+
+    return mConsole->onShowWindow (aCheck, aCanShow);
 }
 

trunk/src/VBox/Main/VirtualBoxErrorInfoImpl.cpp

@@ -26 +26 @@
 ////////////////////////////////////////////////////////////////////////////////
 
-void VirtualBoxErrorInfo::init (HRESULT resultCode, const GUID &iid,
-                                const BSTR component, const BSTR text)
+void VirtualBoxErrorInfo::init (HRESULT aResultCode, const GUID &aIID,
+                                const BSTR aComponent, const BSTR aText,
+                                IVirtualBoxErrorInfo *aNext)
 {
-    mResultCode = resultCode;
-    mIID = iid;
-    mComponent = component;
-    mText = text;
+    mResultCode = aResultCode;
+    mIID = aIID;
+    mComponent = aComponent;
+    mText = aText;
+    mNext = aNext;
 }
 
@@ -38 +40 @@
 ////////////////////////////////////////////////////////////////////////////////
 
-STDMETHODIMP VirtualBoxErrorInfo::COMGETTER(ResultCode) (HRESULT *resultCode)
+STDMETHODIMP VirtualBoxErrorInfo::COMGETTER(ResultCode) (HRESULT *aResultCode)
 {
-    if (!resultCode)
+    if (!aResultCode)
         return E_POINTER;
 
-    *resultCode = mResultCode;
+    *aResultCode = mResultCode;
     return S_OK;
 }
 
-STDMETHODIMP VirtualBoxErrorInfo::COMGETTER(InterfaceID) (GUIDPARAMOUT iid)
+STDMETHODIMP VirtualBoxErrorInfo::COMGETTER(InterfaceID) (GUIDPARAMOUT aIID)
 {
-    if (!iid)
+    if (!aIID)
         return E_POINTER;
 
-    mIID.cloneTo (iid);
+    mIID.cloneTo (aIID);
     return S_OK;
 }
 
-STDMETHODIMP VirtualBoxErrorInfo::COMGETTER(Component) (BSTR *component)
+STDMETHODIMP VirtualBoxErrorInfo::COMGETTER(Component) (BSTR *aComponent)
 {
-    if (!component)
+    if (!aComponent)
         return E_POINTER;
 
-    mComponent.cloneTo (component);
+    mComponent.cloneTo (aComponent);
     return S_OK;
 }
 
-STDMETHODIMP VirtualBoxErrorInfo::COMGETTER(Text) (BSTR *text)
+STDMETHODIMP VirtualBoxErrorInfo::COMGETTER(Text) (BSTR *aText)
 {
-    if (!text)
+    if (!aText)
         return E_POINTER;
 
-    mText.cloneTo (text);
+    mText.cloneTo (aText);
     return S_OK;
+}
+
+STDMETHODIMP VirtualBoxErrorInfo::COMGETTER(Next) (IVirtualBoxErrorInfo **aNext)
+{
+    if (!aNext)
+        return E_POINTER;
+
+    /* this will set aNext to NULL if mNext is null */
+    return mNext.queryInterfaceTo (aNext);
 }
 
@@ -158 +169 @@
 NS_IMETHODIMP VirtualBoxErrorInfo::GetInner (nsIException **aInner)
 {
-    return NS_ERROR_NOT_IMPLEMENTED;
+    ComPtr <IVirtualBoxErrorInfo> info;
+    nsresult rv = COMGETTER(Next) (info.asOutParam());
+    CheckComRCReturnRC (rv);
+    return info.queryInterfaceTo (aInner);
 }
 

trunk/src/VBox/Main/VirtualBoxImpl.cpp

@@ -1812 +1812 @@
         {
             /* ask for permission from all listeners */
-            if (!onExtraDataCanChange (emptyGuid, aKey, aValue))
+            Bstr error;
+            if (!onExtraDataCanChange (emptyGuid, aKey, aValue, error))
             {
-                Log (("VirtualBox::SetExtraData(): Someone vetoed! Change refused\n"));
+                const char *sep = error.isEmpty() ? "" : ": ";
+                const BSTR err = error.isNull() ? (const BSTR) L"" : error.raw();
+                LogWarningFunc (("Someone vetoed! Change refused%s%ls\n",
+                                 sep, err));
                 rc = setError (E_ACCESSDENIED,
                     tr ("Could not set extra data because someone refused "
-                        "the requested change of '%ls' to '%ls'"), aKey, aValue);
+                        "the requested change of '%ls' to '%ls'%s%ls"),
+                    aKey, aValue, sep, err);
             }
             else
@@ -2490 +2495 @@
  *  @note Doesn't lock any object.
  */
-void VirtualBox::onMachineStateChange (const Guid &id, MachineState_T state)
-{
-    postEvent (new MachineEvent (this, id, state));
+void VirtualBox::onMachineStateChange (const Guid &aId, MachineState_T aState)
+{
+    postEvent (new MachineEvent (this, aId, aState));
 }
 
@@ -2498 +2503 @@
  *  @note Doesn't lock any object.
  */
-void VirtualBox::onMachineDataChange (const Guid &id)
-{
-    postEvent (new MachineEvent (this, id));
+void VirtualBox::onMachineDataChange (const Guid &aId)
+{
+    postEvent (new MachineEvent (this, aId));
 }
 
@@ -2506 +2511 @@
  *  @note Locks this object for reading.
  */
-BOOL VirtualBox::onExtraDataCanChange(const Guid &id, INPTR BSTR key, INPTR BSTR value)
-{
-    LogFlowThisFunc(("machine={%s} key={%ls} val={%ls}\n",
-                     id.toString().raw(), key, value));
+BOOL VirtualBox::onExtraDataCanChange (const Guid &aId, INPTR BSTR aKey, INPTR BSTR aValue,
+                                       Bstr &aError)
+{
+    LogFlowThisFunc (("machine={%s} aKey={%ls} aValue={%ls}\n",
+                      aId.toString().raw(), aKey, aValue));
+
+    AutoCaller autoCaller (this);
+    AssertComRCReturn (autoCaller.rc(), autoCaller.rc());
 
     CallbackList list;
@@ -2517 +2526 @@
     }
 
-    BOOL allowChange = true;
+    BOOL allowChange = TRUE;
     CallbackList::iterator it = list.begin();
     while ((it != list.end()) && allowChange)
     {
-        HRESULT rc = (*it++)->OnExtraDataCanChange(id, key, value, &allowChange);
+        HRESULT rc = (*it++)->OnExtraDataCanChange (aId, aKey, aValue,
+                                                    aError.asOutParam(), &allowChange);
         if (FAILED (rc))
         {
-            /*
-             *  if a call to this method fails for some reason (for ex., because
-             *  the other side is dead), we ensure allowChange stays true
-             *  (MS COM RPC implementation seems to zero all output vars before
-             *  issuing an IPC call or after a failure, so it's essential there)
-             */
-            allowChange = true;
-        }
-    }
-
-    LogFlowThisFunc (("allowChange=%d\n", allowChange));
+            /* if a call to this method fails for some reason (for ex., because
+             * the other side is dead), we ensure allowChange stays true
+             * (MS COM RPC implementation seems to zero all output vars before
+             * issuing an IPC call or after a failure, so it's essential
+             * there) */
+            allowChange = TRUE;
+        }
+    }
+
+    LogFlowThisFunc (("allowChange=%RTbool\n", allowChange));
     return allowChange;
 }
@@ -2561 +2570 @@
  *  @note Doesn't lock any object.
  */
-void VirtualBox::onExtraDataChange (const Guid &id, INPTR BSTR key, INPTR BSTR value)
-{
-    postEvent (new ExtraDataEvent (this, id, key, value));
+void VirtualBox::onExtraDataChange (const Guid &aId, INPTR BSTR aKey, INPTR BSTR aValue)
+{
+    postEvent (new ExtraDataEvent (this, aId, aKey, aValue));
 }
 
@@ -2595 +2604 @@
  *  @note Doesn't lock any object.
  */
-void VirtualBox::onSessionStateChange (const Guid &id, SessionState_T state)
-{
-    postEvent (new SessionEvent (this, id, state));
+void VirtualBox::onSessionStateChange (const Guid &aId, SessionState_T aState)
+{
+    postEvent (new SessionEvent (this, aId, aState));
 }
 

trunk/src/VBox/Main/idl/VirtualBox.xidl

@@ -349 +349 @@
     <interface
         name="IVirtualBoxErrorInfo" extends="$errorinfo"
-        uuid="37EDE76D-6E16-4CE4-9D48-2C5A87AFFEA2"
+        uuid="e98b5376-8eb4-4eea-812a-3964bf3bb26f"
         supportsErrorInfo="no"
         wsmap="struct"
@@ -360 +360 @@
             In MS COM, this interface extends the IErrorInfo interface,
             in XPCOM, it extends the nsIException interface. In both cases,
-            it provides a set of common attributes to retrieve error information.
+            it provides a set of common attributes to retrieve error
+            information.
+
+            Sometimes invocation of some component's method may involve
+            methods of other components that may also fail (independently of
+            this method's failure), or a series of non-fatal errors may precede
+            a fatal error that causes method failure. In cases like that, it
+            may be desirable to preserve information about all errors happened
+            during method invocation and deliver it to the caller. The <link
+            to="#next"/> attribute is intended specifically for this purpose
+            and allows to represent a chain of errors through a single
+            IVirtualBoxErrorInfo instance set after method invocation.
         </desc>
 
@@ -374 +385 @@
                 <note>
                     In MS COM, there is no equivalent.
-                    In XPCOM, it is the same as to nsIException::result.
+                    In XPCOM, it is the same as nsIException::result.
                 </note>
             </desc>
@@ -383 +394 @@
                 UUID of the interface that defined the error.
                 <note>
-                    In MS COM, it is the same as  to IErrorInfo::GetGUID.
+                    In MS COM, it is the same as IErrorInfo::GetGUID.
                     In XPCOM, there is no equivalent.
                 </note>
@@ -393 +404 @@
                 Name of the component that generated the error.
                 <note>
-                    In MS COM, it is the same as to IErrorInfo::GetSource.
+                    In MS COM, it is the same as IErrorInfo::GetSource.
                     In XPCOM, there is no eqiuvalent.
                 </note>
@@ -404 +415 @@
                 <note>
                     In MS COM, it is the same as IErrorInfo::GetDescription.
-                    In XPCOM, it is the same as to nsIException::message.
+                    In XPCOM, it is the same as nsIException::message.
+                </note>
+            </desc>
+        </attribute>
+
+        <attribute name="next" type="IVirtualBoxErrorInfo" readonly="yes">
+            <desc>
+                Next error object if there is any, or @c null otherwise.
+                <note>
+                    In MS COM, there is no equivalent.
+                    In XPCOM, it is the same as nsIException::inner.
                 </note>
             </desc>
@@ -419 +440 @@
     <interface
         name="IVirtualBoxCallback" extends="$unknown"
-        uuid="1293842f-0380-47cf-80b5-e4f821861b26"
+        uuid="ee95ffc2-b6c6-4ce8-9e9e-ceadbb5019fe"
         wsmap="suppress"
     >
@@ -452 +473 @@
             <param name="machineId" type="uuid" dir="in">
                 <desc>
-                    ID of the machine this event relates to.
-                    Nul for global extra data change requests.
+                    ID of the machine this event relates to
+                    (null ID for global extra data change requests).
                 </desc>
             </param>
@@ -466 +487 @@
                 </desc>
             </param>
+            <param name="error" type="wstring" dir="out">
+                <desc>
+                    Optional error message describing the reason of the
+                    veto (ignored if this notification returns @c true).
+                </desc>
+            </param>
             <param name="allowChange" type="boolean" dir="return">
                 <desc>
-                    Flag to indicate whether the callee agrees (true)
-                    or vetoes against the change (false).
+                    Flag to indicate whether the callee agrees (@ true)
+                    or vetoes against the change (@ false).
                 </desc>
             </param>
@@ -972 +999 @@
                 until <link to="#registerHardDisk()"/> is called.
 
-                @deprecated Use <link to="#openHardDisk()"/> instead.
+                @deprecated Use <link to="IVirtualBox::openHardDisk()"/> instead.
 
                 <note>Opening differencing images is not supported.</note>
@@ -1056 +1083 @@
                 Returns a registered hard disk that uses the given image file.
 
-                @deprecated Use <link to="#findHardDisk()"/> instead.
+                @deprecated Use <link to="IVirtualBox::findHardDisk()"/> instead.
 
                 <note>The specified file path can be absolute (full path) or
@@ -1362 +1389 @@
                 Returns the extra data key name following the supplied key.
                 An error is returned if the supplied key does not exist.
-                NULL is returned if the supplied key is the last key.
-                When supplying NULL for the key, the first item is returned.
-                NextValue is an optional parameter and if supplied, the next
-                key's value is returned as well.
-            </desc>
-            <param name="key" type="wstring" dir="in"/>
-            <param name="nextKey" type="wstring" dir="out"/>
-            <param name="nextValue" type="wstring" dir="out"/>
+                @c NULL is returned if the supplied key is the last key.
+                When supplying @c NULL for the key, the first item is returned.
+                @a nextValue is an optional parameter and if supplied, the next
+                key's value is returned in it.
+            </desc>
+            <param name="key" type="wstring" dir="in">
+                <desc>Name of the data key to follow.</desc>
+            </param>
+            <param name="nextKey" type="wstring" dir="out">
+                <desc>Name of the next data key.</desc>
+            </param>
+            <param name="nextValue" type="wstring" dir="out">
+                <desc>Value of the next data key.</desc>
+            </param>
         </method>
 
         <method name="getExtraData">
-            <desc>Returns associated extra data.</desc>
-            <param name="key" type="wstring" dir="in"/>
-            <param name="value" type="wstring" dir="return"/>
+            <desc>
+                Returns associated extra data.
+                If the reuqested key does not exist, this function will
+                succeed and return @c null in the @a value argument.
+            </desc>
+            <param name="key" type="wstring" dir="in">
+                <desc>Name of the data key to get.</desc>
+            </param>
+            <param name="value" type="wstring" dir="return">
+                <desc>Value of the requested data key.</desc>
+            </param>
         </method>
 
         <method name="setExtraData">
-            <desc>Sets associated extra data.</desc>
-            <param name="key" type="wstring" dir="in"/>
-            <param name="value" type="wstring" dir="in"/>
+            <desc>
+                Sets associated extra data.
+                If you pass @c NULL as a key @a vaule, the given key will be
+                deleted.
+                <note>
+                    This method can be called outside a machine session and
+                    therefore it's a caller's responsibility to handle race
+                    condition when several clients change the same key at the
+                    same time.
+                </note>
+            </desc>
+            <param name="key" type="wstring" dir="in">
+                <desc>Name of the data key to set.</desc>
+            </param>
+            <param name="value" type="wstring" dir="in">
+                <desc>Value to assign to the key.</desc>
+            </param>
         </method>
 
@@ -1825 +1880 @@
     <interface
         name="IMachine" extends="$unknown"
-        uuid="50fa9181-d2d4-45ca-bf0e-742677b9c707"
+        uuid="f0ad6688-2216-4654-a375-10afc5b88dcd"
         wsmap="uuid"
     >
@@ -2510 +2565 @@
         </method>
 
+        <method name="canShowConsoleWindow">
+            <desc>
+                Returns @c true if the VM console process can activate the
+                console window and bring it to foreground on the desktop of
+                the host PC.
+                <note>
+                    This method will fail if a session for this machine is not
+                    currently open.
+                </note>
+            </desc>
+            <param name="canShow" type="boolean" dir="return">
+                <desc>
+                    @c true if the console window can be shown and @c
+                    false otherwise.
+                </desc>
+            </param>
+        </method>
+
+        <method name="showConsoleWindow">
+            <desc>
+                Returns @c true if the VM console process can activate the
+                console window and bring it to foreground on the desktop of
+                the host PC.
+                <note>
+                    This method will fail if a session for this machine is not
+                    currently open.
+                </note>
+            </desc>
+        </method>
+
     </interface>
 
@@ -2519 +2604 @@
     <interface
         name="IConsoleCallback" extends="$unknown"
-        uuid="05D3DD3F-0550-4953-BB3C-4ECB3EBF7C2E"
+        uuid="a56eff10-6db9-4985-a12a-039b604b491b"
         wsmap="suppress"
     >
@@ -2673 +2758 @@
 
                 <note>
-                    This notification is not designed to be implemented by more
-                    than one callback at a time. If you have multiple
+                    This notification is not designed to be implemented by
+                    more than one callback at a time. If you have multiple
                     IConsoleCallback instances registered on the given
-                    IConsole object, make sure you just return S_OK from all but
-                    one of them that does actual user notification and performs
-                    necessary actions.
+                    IConsole object, make sure you simply do nothing but
+                    return @c S_OK from all but one of them that does actual
+                    user notification and performs necessary actions.
                 </note>
 
@@ -2691 +2776 @@
                 <desc>Optional error message</desc>
             </param>
+        </method>
+
+        <method name="onCanShowWindow">
+            <desc>
+                Notification when a call to
+                <link to="IMachine::canShowConsoleWindow()"/> is made by a
+                front-end to check if a subsequent call to
+                <link to="IMachine::showConsoleWindow()"/> can succeed.
+
+                The callee should give an answer appropriate to the current
+                machine state in the @a canShow argument. This answer must
+                remain valid at least until the next
+                <link to="IConsole::state">machine state</link> change.
+
+                <note>
+                    This notification is not designed to be implemented by
+                    more than one callback at a time. If you have multiple
+                    IConsoleCallback instances registered on the given
+                    IConsole object, make sure you simply do nothing but
+                    return @c true and @c S_OK from all but one of them that
+                    actually manages console window activation.
+                </note>
+            </desc>
+            <param name="canShow" type="boolean" dir="return">
+                <desc>
+                    @c true if the console window can be shown and @c
+                    false otherwise.
+                </desc>
+            </param>
+        </method>
+
+        <method name="onShowWindow">
+            <desc>
+                Notification when a call to
+                <link to="IMachine::showConsoleWindow()"/>
+                requests the console window to be activated and brought to
+                foreground on the desktop of the host PC.
+
+                This notification should cause the VM console process to
+                perform the requested action as described above. If it is
+                impossible to do it at a time of this notification, this
+                method should return a failure.
+
+                <note>
+                    This notification is not designed to be implemented by
+                    more than one callback at a time. If you have multiple
+                    IConsoleCallback instances registered on the given
+                    IConsole object, make sure you simply do nothing but
+                    return@c S_OK from all but one of them that actually
+                    manages console window activation.
+                </note>
+            </desc>
         </method>
 
@@ -3427 +3564 @@
     <interface
         name="IHost" extends="$unknown"
-        uuid="FD443EC1-000B-4F5B-9282-D72760A66916"
+        uuid="81729c26-1aec-46f5-b7c0-cc7364738fdb"
         wsmap="global"
     >
@@ -3561 +3698 @@
                 </desc>
             </param>
-            <param name="filter" type="IHostUSBDeviceFilter" dir="out">
+            <param name="filter" type="IHostUSBDeviceFilter" dir="return">
                 <desc>Created filter object.</desc>
             </param>
@@ -3605 +3742 @@
                 <desc>Position to remove the filter from.</desc>
             </param>
-            <param name="filter" type="IHostUSBDeviceFilter" dir="out">
+            <param name="filter" type="IHostUSBDeviceFilter" dir="return">
                 <desc>Removed USB device filter.</desc>
             </param>
@@ -5878 +6015 @@
                 the @a vram parameter of this method.
 
-                For non linear modes (such as text and standard VGA), the
-                @vram parameter is NULL and must not be used. When it's not
+                For non linear modes (such as text and standard VGA), the @a
+                vram parameter is @c NULL and must not be used. When it's not
                 NULL, it is recommended to use it to access the guest video
                 memory instead of creating a separate buffer as it will at
@@ -5898 +6035 @@
                 <desc>Pointer to the guest VRAM (NULL for non linear modes)</desc>
             </param>
-            <param name="lineSize" type="unsigned long" dir="in"/>
-            <param name="width" type="unsigned long" dir="in"/>
-            <param name="height" type="unsigned long" dir="in"/>
-            <param name="finished" type="boolean" dir="return"/>
+            <param name="lineSize" type="unsigned long" dir="in">
+                <desc>Size of one scan line, in bytes.</desc>
+            </param>
+            <param name="width" type="unsigned long" dir="in">
+                <desc>Width of the guest display, in pixels.</desc>
+            </param>
+            <param name="height" type="unsigned long" dir="in">
+                <desc>Height of the guest display, in pixels.</desc>
+            </param>
+            <param name="finished" type="boolean" dir="return">
+                <desc>
+                    Can the VM start using the new framebuffer immediately
+                    after this method returns or it should wait for
+                    <link to="IDisplay::resizeCompleted()"/>.
+                </desc>
+            </param>
         </method>
 
@@ -7146 +7295 @@
     <interface
         name="IInternalSessionControl" extends="$unknown"
-        uuid="A99D5EB3-02DE-48e4-B059-91A8A41B4DA1"
+        uuid="9c6bec01-4135-40a0-b9d3-ab119a9c5412"
         internal="yes"
         wsmap="suppress"
@@ -7249 +7398 @@
         </method>
 
+        <method name="onShowWindow">
+            <desc>
+                Called by <link to="IMachine::canShowConsoleWindow()"/> and by
+                <link to="IMachine::showConsoleWindow()"/> in order to notify
+                console callbacks
+                <link to="IConsoleCallback::onCanShowWindow()"/>
+                and <link to="IConsoleCallback::onShowWindow()"/>.
+            </desc>
+            <param name="check" type="boolean" dir="in"/>
+            <param name="canShow" type="boolean" dir="out"/>
+        </method>
+
     </interface>
 

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

@@ -199 +199 @@
     void onKeyboardLedsChange (bool fNumLock, bool fCapsLock, bool fScrollLock);
     void onRuntimeError (BOOL aFatal, INPTR BSTR aErrorID, INPTR BSTR aMessage);
+    HRESULT onShowWindow (BOOL aCheck, BOOL *aCanShow);
 
     static const PDMDRVREG DrvStatusReg;

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

@@ -108 +108 @@
     }
 
+    STDMETHOD(OnCanShowWindow)(BOOL *canShow)
+    {
+        if (canShow)
+            *canShow = TRUE;
+        return S_OK;
+    }
+
+    STDMETHOD(OnShowWindow)()
+    {
+        return S_OK;
+    }
+
     // IDisplay properties
     STDMETHOD(COMGETTER(Width)) (ULONG *width);

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

@@ -355 +355 @@
     STDMETHOD(DetachHardDisk) (DiskControllerType_T aCtl, LONG aDev);
     STDMETHOD(GetNetworkAdapter) (ULONG slot, INetworkAdapter **adapter);
-    STDMETHOD(GetNextExtraDataKey)(INPTR BSTR key, BSTR *nextKey, BSTR *nextValue);
-    STDMETHOD(GetExtraData)(INPTR BSTR key, BSTR *value);
-    STDMETHOD(SetExtraData)(INPTR BSTR key, INPTR BSTR value);
+    STDMETHOD(GetNextExtraDataKey)(INPTR BSTR aKey, BSTR *aNextKey, BSTR *aNextValue);
+    STDMETHOD(GetExtraData)(INPTR BSTR aKey, BSTR *aValue);
+    STDMETHOD(SetExtraData)(INPTR BSTR aKey, INPTR BSTR aValue);
     STDMETHOD(SaveSettings)();
     STDMETHOD(DiscardSettings)();
@@ -364 +364 @@
     STDMETHOD(FindSnapshot) (INPTR BSTR aName, ISnapshot **aSnapshot);
     STDMETHOD(SetCurrentSnapshot) (INPTR GUIDPARAM aId);
-    STDMETHOD(CreateSharedFolder)(INPTR BSTR aName, INPTR BSTR aHostPath);
-    STDMETHOD(RemoveSharedFolder)(INPTR BSTR aName);
+    STDMETHOD(CreateSharedFolder) (INPTR BSTR aName, INPTR BSTR aHostPath);
+    STDMETHOD(RemoveSharedFolder) (INPTR BSTR aName);
+    STDMETHOD(CanShowConsoleWindow) (BOOL *aCanShow);
+    STDMETHOD(ShowConsoleWindow)();
 
     // public methods only for internal purposes

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

@@ -102 +102 @@
     STDMETHOD(OnUSBDeviceAttach) (IUSBDevice *aDevice);
     STDMETHOD(OnUSBDeviceDetach) (INPTR GUIDPARAM aId);
+    STDMETHOD(OnShowWindow) (BOOL aCheck, BOOL *aCanShow);
 
     // for VirtualBoxSupportErrorInfoImpl

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

@@ -61 +61 @@
 
     // public initializer/uninitializer for internal purposes only
-    void init (HRESULT resultCode, const GUID &iid,
-               const BSTR component, const BSTR text);
+    void init (HRESULT aResultCode, const GUID &aIID,
+               const BSTR aComponent, const BSTR aText,
+               IVirtualBoxErrorInfo *aNext = NULL);
 
     // IVirtualBoxErrorInfo properties
-    STDMETHOD(COMGETTER(ResultCode)) (HRESULT *resultCode);
-    STDMETHOD(COMGETTER(InterfaceID)) (GUIDPARAMOUT iid);
-    STDMETHOD(COMGETTER(Component)) (BSTR *component);
-    STDMETHOD(COMGETTER(Text)) (BSTR *text);
+    STDMETHOD(COMGETTER(ResultCode)) (HRESULT *aResultCode);
+    STDMETHOD(COMGETTER(InterfaceID)) (GUIDPARAMOUT aIID);
+    STDMETHOD(COMGETTER(Component)) (BSTR *aComponent);
+    STDMETHOD(COMGETTER(Text)) (BSTR *aText);
+    STDMETHOD(COMGETTER(Next)) (IVirtualBoxErrorInfo **aNext);
 
 private:
@@ -76 +78 @@
     Guid mIID;
     Bstr mComponent;
+    ComPtr <IVirtualBoxErrorInfo> mNext;
 };
 

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

@@ -197 +197 @@
     void updateClientWatcher();
 
-    void onMachineStateChange (const Guid &id, MachineState_T state);
-    void onMachineDataChange (const Guid &id);
-    BOOL onExtraDataCanChange(const Guid &id, INPTR BSTR key, INPTR BSTR value);
-    void onExtraDataChange(const Guid &id, INPTR BSTR key, INPTR BSTR value);
+    void onMachineStateChange (const Guid &aId, MachineState_T aState);
+    void onMachineDataChange (const Guid &aId);
+    BOOL onExtraDataCanChange(const Guid &aId, INPTR BSTR aKey, INPTR BSTR aValue,
+                              Bstr &aError);
+    void onExtraDataChange(const Guid &aId, INPTR BSTR aKey, INPTR BSTR aValue);
     void onMachineRegistered (const Guid &aId, BOOL aRegistered);
-    void onSessionStateChange (const Guid &id, SessionState_T state);
+    void onSessionStateChange (const Guid &aId, SessionState_T aState);
 
     void onSnapshotTaken (const Guid &aMachineId, const Guid &aSnapshotId);