Changeset 30521 in vbox

Timestamp:

Jun 30, 2010 8:24:32 AM (15 years ago)

Author:

vboxsync

Message:

Main: veto event class, more events

Location:

trunk/src/VBox/Main

Files:

• EventImpl.cpp (modified) (4 diffs)
• idl/VirtualBox.xidl (modified) (6 diffs)
• idl/comimpl.xsl (modified) (4 diffs)
• include/EventImpl.h (modified) (2 diffs)

trunk/src/VBox/Main/EventImpl.cpp

@@ -207 +207 @@
 
     return S_OK;
+}
+
+typedef std::list<Bstr> VetoList;
+struct VBoxVetoEvent::Data
+{
+    Data()
+        :
+        mVetoed(FALSE)
+    {}
+    BOOL                    mVetoed;
+    VetoList                mVetoList;
+};
+
+HRESULT VBoxVetoEvent::FinalConstruct()
+{
+    VBoxEvent::FinalConstruct();
+    m = new Data;
+    return S_OK;
+}
+
+void VBoxVetoEvent::FinalRelease()
+{
+    if (m)
+    {
+        uninit();
+        delete m;
+        m = 0;
+    }
+    VBoxEvent::FinalRelease();
+}
+
+
+HRESULT VBoxVetoEvent::init(IEventSource *aSource, VBoxEventType_T aType)
+{
+    HRESULT rc = S_OK;
+    // all veto events are waitable
+    rc = VBoxEvent::init(aSource, aType, TRUE);
+    if (FAILED(rc)) return rc;
+
+    m->mVetoed = FALSE;
+    m->mVetoList.clear();
+
+    return rc;
+}
+
+void VBoxVetoEvent::uninit()
+{
+    VBoxEvent::uninit();
+    if (!m)
+        return;
+    m->mVetoed = FALSE;
+}
+
+STDMETHODIMP VBoxVetoEvent::AddVeto(IN_BSTR aVeto)
+{
+    AutoCaller autoCaller(this);
+    if (FAILED(autoCaller.rc())) return autoCaller.rc();
+
+    AutoWriteLock alock(this COMMA_LOCKVAL_SRC_POS);
+
+    if (aVeto)
+        m->mVetoList.push_back(aVeto);
+
+    m->mVetoed = TRUE;
+
+    return S_OK;
+}
+
+STDMETHODIMP VBoxVetoEvent::IsVetoed(BOOL * aResult)
+{
+    CheckComArgOutPointerValid(aResult);
+
+    AutoCaller autoCaller(this);
+    if (FAILED(autoCaller.rc())) return autoCaller.rc();
+
+    AutoReadLock alock(this COMMA_LOCKVAL_SRC_POS);
+
+    *aResult = m->mVetoed;
+
+    return S_OK;
+}
+
+STDMETHODIMP  VBoxVetoEvent::GetVetos(ComSafeArrayOut(BSTR, aVetos))
+{
+    if (ComSafeArrayOutIsNull(aVetos))
+        return E_POINTER;
+
+    AutoCaller autoCaller(this);
+    if (FAILED(autoCaller.rc())) return autoCaller.rc();
+
+    AutoReadLock alock(this COMMA_LOCKVAL_SRC_POS);
+    com::SafeArray<BSTR> vetos(m->mVetoList.size());
+    int i = 0;
+    for (VetoList::const_iterator it = m->mVetoList.begin();
+         it != m->mVetoList.end();
+         ++it, ++i)
+    {
+        const Bstr &str = *it;
+        str.cloneTo(&vetos[i]);
+    }
+    vetos.detachTo(ComSafeArrayOutArg(aVetos));
+
+    return S_OK;
+
 }
 
@@ -397 +501 @@
 }
 
-HRESULT ListenerRecord::process(IEvent*                     aEvent, 
-                                BOOL                        aWaitable, 
-                                PendingEventsMap::iterator& pit, 
+HRESULT ListenerRecord::process(IEvent*                     aEvent,
+                                BOOL                        aWaitable,
+                                PendingEventsMap::iterator& pit,
                                 AutoLockBase&               aAlock)
 {
@@ -437 +541 @@
 }
 
-HRESULT ListenerRecord::dequeue (IEvent*       *aEvent, 
-                                 LONG          aTimeout, 
+HRESULT ListenerRecord::dequeue (IEvent*       *aEvent,
+                                 LONG          aTimeout,
                                  AutoLockBase& aAlock)
 {
@@ -448 +552 @@
         // retain listener record
         ListenerRecordHolder holder(this);
-        ::RTCritSectLeave(&mcsQLock);        
+        ::RTCritSectLeave(&mcsQLock);
         // Speed up common case
         if (aTimeout == 0)

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

@@ -6422 +6422 @@
         issued by <link to="IConsole::attachUSBDevice"/> or
         <link to="IConsole::detachUSBDevice"/>.
-
         This notification is sent in case of both a succeeded and a
         failed request completion. When the request succeeds, the
@@ -14759 +14758 @@
       </desc>
     </const>
+    <const name="OnCPUChange" value="60">
+      <desc>
+        <see>IConsoleCallback::onCPUChange</see>
+      </desc>
+    </const>
+    <const name="OnRemoteDisplayInfoChange" value="61">
+      <desc>
+        <see>IConsoleCallback::onRemoteDisplayInfoChange</see>
+      </desc>
+    </const>
     <!-- Last event marker -->
-    <const name="Last" value="60">
+    <const name="Last" value="62">
       <desc>
         Must be last event, used for iterations and structures relying on numerical event values.
@@ -15198 +15207 @@
 
   <interface
+     name="IKeyboardLedsChangeEvent" extends="IEvent"
+     uuid="6DDEF35E-4737-457B-99FC-BC52C851A44F"
+     wsmap="managed" autogen="VBoxEvent" id="OnKeyboardLedsChange"
+     >
+    <desc>
+      Notification when the guest OS executes the KBD_CMD_SET_LEDS command
+      to alter the state of the keyboard LEDs.
+    </desc>
+    <attribute name="numLock" type="boolean" readonly="yes">
+      <desc>
+        NumLock status.
+      </desc>
+    </attribute>
+    <attribute name="capsLock" type="boolean" readonly="yes">
+      <desc>
+        CapsLock status.
+      </desc>
+    </attribute>
+    <attribute name="scrollLock" type="boolean" readonly="yes">
+      <desc>
+        ScrollLock status.
+      </desc>
+    </attribute>
+  </interface>
+
+  <interface
+     name="IStateChangeEvent" extends="IEvent"
+     uuid="4376693C-CF37-453B-9289-3B0F521CAF27"
+     wsmap="managed" autogen="VBoxEvent" id="OnStateChange"
+     >
+    <desc>
+      Notification when the execution state of the machine has changed.
+      The new state is given.
+    </desc>
+    <attribute name="state" type="MachineState" readonly="yes">
+      <desc>
+        New machine state.
+      </desc>
+    </attribute>
+  </interface>
+
+  <interface
+     name="IAdditionsChangeEvent" extends="IEvent"
+     uuid="D70F7915-DA7C-44C8-A7AC-9F173490446A"
+     wsmap="managed" autogen="VBoxEvent" id="OnAdditionsStateChange"
+     >
+    <desc>
+      Notification when a Guest Additions property changes.
+      Interested callees should query IGuest attributes to
+      find out what has changed.
+    </desc>
+  </interface>
+
+  <interface
+     name="INetworkAdapterChangeEvent" extends="IEvent"
+     uuid="4376693C-CF37-453B-9289-3B0F521CAF27"
+     wsmap="managed" autogen="VBoxEvent" id="OnNetworkAdapterChange"
+     >
+    <desc>
+      Notification when a property of one of the
+      virtual <link to="IMachine::getNetworkAdapter">network adapters</link>
+      changes.  Interested callees should use INetworkAdapter methods and
+      attributes to find out what has changed.
+    </desc>
+    <attribute name="networkAdapter" type="INetworkAdapter" readonly="yes">
+      <desc>
+        Network adapter that is subject to change.
+      </desc>
+    </attribute>
+  </interface>
+
+  <interface
+     name="ISerialPortChangeEvent" extends="IEvent"
+     uuid="3BA329DC-659C-488B-835C-4ECA7AE71C6C"
+     wsmap="managed" autogen="VBoxEvent" id="OnSerialPortChange"
+     >
+    <desc>
+      Notification when a property of one of the
+      virtual <link to="IMachine::getSerialPort">serial ports</link> changes.
+      Interested callees should use ISerialPort methods and attributes
+      to find out what has changed.
+    </desc>
+    <attribute name="serialPort" type="ISerialPort" readonly="yes">
+      <desc>
+        Serial port that is subject to change.
+      </desc>
+    </attribute>
+  </interface>
+
+  <interface
+     name="IParallelPortChangeEvent" extends="IEvent"
+     uuid="813C99FC-9849-4F47-813E-24A75DC85615"
+     wsmap="managed" autogen="VBoxEvent" id="OnParallelPortChange"
+     >
+    <desc>
+      Notification when a property of one of the
+      virtual <link to="IMachine::getParallelPort">parallel ports</link>
+      changes.  Interested callees should use ISerialPort methods and
+      attributes to find out what has changed.
+    </desc>
+    <attribute name="parallelPort" type="IParallelPort" readonly="yes">
+      <desc>
+        Parallel port that is subject to change.
+      </desc>
+    </attribute>
+  </interface>
+  
+  <interface
+     name="IStorageControllerChangeEvent" extends="IEvent"
+     uuid="715212BF-DA59-426E-8230-3831FAA52C56"
+     wsmap="managed" autogen="VBoxEvent" id="OnStorageControllerChange"
+     >
+    <desc>
+      Notification when a
+      <link to="IMachine::mediumAttachments">medium attachment</link>
+      changes.
+    </desc>
+  </interface>
+
+  <interface
+     name="IMediumChangeEvent" extends="IEvent"
+     uuid="0FE2DA40-5637-472A-9736-72019EABD7DE"
+     wsmap="managed" autogen="VBoxEvent" id="OnMediumChange"
+     >
+    <desc>
+      Notification when a
+      <link to="IMachine::mediumAttachments">medium attachment</link>
+      changes.
+    </desc>
+    <attribute name="mediumAttachment" type="IMediumAttachment" readonly="yes">
+      <desc>
+        Medium attachment that is subject to change.
+      </desc>
+    </attribute>
+  </interface>
+  
+   <interface
+     name="ICPUChangeEvent" extends="IEvent"
+     uuid="D0F0BECC-EE17-4D17-A8CC-383B0EB55E9D"
+     wsmap="managed" autogen="VBoxEvent" id="OnCPUChange"
+     >
+    <desc>
+      Notification when a CPU changes.
+    </desc>
+    <attribute name="cpu" type="unsigned long" readonly="yes">
+      <desc>
+        The CPU which changed.
+      </desc>
+    </attribute>
+    <attribute name="add" type="boolean" readonly="yes">
+      <desc>
+        Flag whether the CPU was added or removed.
+      </desc>
+    </attribute>
+  </interface>
+
+  <interface
+     name="IVRDPServerChangeEvent" extends="IEvent"
+     uuid="726038B6-6279-4A7A-8037-D041693D1915"
+     wsmap="managed" autogen="VBoxEvent" id="OnVRDPServerChange"
+     >
+    <desc>
+      Notification when a property of the
+      <link to="IMachine::VRDPServer">VRDP server</link> changes.
+      Interested callees should use IVRDPServer methods and attributes to
+      find out what has changed.
+    </desc>
+  </interface>
+
+   <interface
+     name="IRemoteDisplayInfoChangeEvent" extends="IEvent"
+     uuid="65B556C5-2A99-47D8-B311-FC177F0914CD"
+     wsmap="managed" autogen="VBoxEvent" id="OnRemoteDisplayInfoChange"
+     >
+    <desc>
+      Notification when the status of the VRDP server changes. Interested callees
+      should use <link to="IConsole::RemoteDisplayInfo">IRemoteDisplayInfo</link>
+      attributes to find out what is the current status.
+    </desc>
+  </interface>
+
+  <interface
+     name="IUSBControllerChangeEvent" extends="IEvent"
+     uuid="65B556C5-2A99-47D8-B311-FC177F0914CD"
+     wsmap="managed" autogen="VBoxEvent" id="OnUSBControllerChange"
+     >
+    <desc>
+      Notification when a property of the virtual
+      <link to="IMachine::USBController">USB controller</link> changes.
+      Interested callees should use IUSBController methods and attributes to
+      find out what has changed.
+    </desc>
+  </interface>
+
+  <interface
+     name="IUSBDevceStateChangeEvent" extends="IEvent"
+     uuid="65B556C5-2A99-47D8-B311-FC177F0914CD"
+     wsmap="managed" autogen="VBoxEvent" id="OnUSBDeviceStateChange"
+     >
+    <desc>
+      Notification when a USB device is attached to or detached from
+      the virtual USB controller.
+
+      This notification is sent as a result of the indirect
+      request to attach the device because it matches one of the
+      machine USB filters, or as a result of the direct request
+      issued by <link to="IConsole::attachUSBDevice"/> or
+      <link to="IConsole::detachUSBDevice"/>.
+
+      This notification is sent in case of both a succeeded and a
+      failed request completion. When the request succeeds, the
+      @a error parameter is @c null, and the given device has been
+      already added to (when @a attached is @c true) or removed from
+      (when @a attached is @c false) the collection represented by
+      <link to="IConsole::USBDevices"/>. On failure, the collection
+      doesn't change and the @a error parameter represents the error
+      message describing the failure.
+    </desc>
+    <attribute name="device" type="IUSBDevice" readonly="yes">
+      <desc>
+        Device that is subject to state change.
+      </desc>
+    </attribute>
+    <attribute name="attached" type="boolean" readonly="yes">
+      <desc>
+        @c true if the device was attached and @c false otherwise.
+      </desc>
+    </attribute>
+    <attribute name="error" type="IVirtualBoxErrorInfo" readonly="yes">
+      <desc>
+        @c null on success or an error message object on failure.
+      </desc>
+    </attribute>
+  </interface>
+
+   <interface
+     name="ISharedFolderChangeEvent" extends="IEvent"
+     uuid="B66349B5-3534-4239-B2DE-8E1535D94C0B"
+     wsmap="managed" autogen="VBoxEvent" id="OnSharedFolderChange"
+     >
+    <desc>
+      Notification when a shared folder is added or removed.
+      The @a scope argument defines one of three scopes:
+      <link to="IVirtualBox::sharedFolders">global shared folders</link>
+      (<link to="Scope_Global">Global</link>),
+      <link to="IMachine::sharedFolders">permanent shared folders</link> of
+      the machine (<link to="Scope_Machine">Machine</link>) or <link
+      to="IConsole::sharedFolders">transient shared folders</link> of the
+      machine (<link to="Scope_Session">Session</link>). Interested callees
+      should use query the corresponding collections to find out what has
+      changed.
+    </desc>
+    <attribute name="scope" type="Scope" readonly="yes">
+      <desc>
+        Scope of the notification.
+      </desc>
+    </attribute>
+  </interface>
+
+   <interface
+     name="IRuntimeErrorEvent" extends="IEvent"
+     uuid="883DD18B-0721-4CDE-867C-1A82ABAF914C"
+     wsmap="managed" autogen="VBoxEvent" id="OnRuntimeError"
+     >
+    <desc>
+      Notification when an error happens during the virtual
+      machine execution.
+
+      There are three kinds of runtime errors:
+      <ul>
+        <li><i>fatal</i></li>
+        <li><i>non-fatal with retry</i></li>
+        <li><i>non-fatal warnings</i></li>
+      </ul>
+
+      <b>Fatal</b> errors are indicated by the @a fatal parameter set
+      to @c true. In case of fatal errors, the virtual machine
+      execution is always paused before calling this notification, and
+      the notification handler is supposed either to immediately save
+      the virtual machine state using <link to="IConsole::saveState"/>
+      or power it off using <link to="IConsole::powerDown"/>.
+      Resuming the execution can lead to unpredictable results.
+
+      <b>Non-fatal</b> errors and warnings are indicated by the
+      @a fatal parameter set to @c false. If the virtual machine
+      is in the Paused state by the time the error notification is
+      received, it means that the user can <i>try to resume</i> the machine
+      execution after attempting to solve the problem that caused the
+      error. In this case, the notification handler is supposed
+      to show an appropriate message to the user (depending on the
+      value of the @a id parameter) that offers several actions such
+      as <i>Retry</i>, <i>Save</i> or <i>Power Off</i>. If the user
+      wants to retry, the notification handler should continue
+      the machine execution using the <link to="IConsole::resume"/>
+      call. If the machine execution is not Paused during this
+      notification, then it means this notification is a <i>warning</i>
+      (for example, about a fatal condition that can happen very soon);
+      no immediate action is required from the user, the machine
+      continues its normal execution.
+
+      Note that in either case the notification handler
+      <b>must not</b> perform any action directly on a thread
+      where this notification is called. Everything it is allowed to
+      do is to post a message to another thread that will then talk
+      to the user and take the corresponding action.
+
+      Currently, the following error identifiers are known:
+      <ul>
+        <li><tt>"HostMemoryLow"</tt></li>
+        <li><tt>"HostAudioNotResponding"</tt></li>
+        <li><tt>"VDIStorageFull"</tt></li>
+        <li><tt>"3DSupportIncompatibleAdditions"</tt></li>
+      </ul>
+    </desc>
+    <attribute name="fatal" type="boolean" readonly="yes">
+      <desc>
+        Whether the error is fatal or not.
+      </desc>
+    </attribute>
+    <attribute name="id" type="wstring" readonly="yes">
+      <desc>
+        Error identifier.
+      </desc>
+    </attribute>
+     <attribute name="message" type="wstring" readonly="yes">
+      <desc>
+        Optional error message.
+      </desc>
+    </attribute>
+  </interface>
+  
+  <interface
       name="IExtraDataChangeEvent" extends="IEvent"
       uuid="024F00CE-6E0B-492A-A8D0-968472A94DC7"
@@ -15237 +15578 @@
       <param name="reason" type="wstring" dir="in">
         <desc>
+          Reason for veto, could be null or empty string.
+        </desc>
+      </param>
+    </method>
+
+    <method name="isVetoed">
+      <desc>
+        If this event was vetoed.
+      </desc>
+      <param name="result" type="boolean" dir="return">
+        <desc>
           Reason for veto.
         </desc>
@@ -15242 +15594 @@
     </method>
 
-    <method name="isVetoed">
-      <desc>
-        If this event was vetoed.
-      </desc>
-      <param name="result" type="boolean" dir="return">
-        <desc>
-          Reason for veto.
-        </desc>
-      </param>
-    </method>
-
     <method name="getVetos">
       <desc>
-        Current veto list, if size is 0 - no veto.
+        Current veto reason list, if size is 0 - no veto.
       </desc>
       <param name="result" type="wstring" dir="return" safearray="yes">
         <desc>
-          Reason for veto.
+          Array of reasons for veto provided by different event handlers.
         </desc>
       </param>
@@ -15314 +15655 @@
   </interface>
 
+  <interface
+      name="IShowWindowEvent" extends="IEvent"
+      uuid="B0A0904D-2F05-4D28-855F-488F96BAD2B2"
+      wsmap="managed" autogen="VBoxEvent" id="OnShowWindow"
+      waitable="true"
+      >
+    <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 that many modern window managers on many platforms
+        implement some sort of focus stealing prevention logic, so
+        that it may be impossible to activate a window without the
+        help of the currently active application (which is supposedly
+        an initiator of this notification). In this case, this method
+        must return a non-zero identifier that represents the
+        top-level window of the VM console process. The caller, if it
+        represents a currently active process, is responsible to use
+        this identifier (in a platform-dependent manner) to perform
+        actual window activation.
+
+        This method must set @a winId to zero if it has performed all
+        actions necessary to complete the request and the console
+        window is now active and in foreground, to indicate that no
+        further action is required on the caller's side.
+    </desc>
+    <attribute name="winId" type="unsigned long long" readonly="yes">
+      <desc>
+         Platform-dependent identifier of the top-level VM console
+          window, or zero if this method has performed all actions
+          necessary to implement the <i>show window</i> semantics for
+          the given platform and/or this VirtualBox front-end.
+      </desc>
+    </attribute>
+  </interface>
+
   <module name="VBoxSVC" context="LocalServer">
     <class name="VirtualBox" uuid="B1A7A4F2-47B9-4A1E-82B2-07CCD5323C3F"

trunk/src/VBox/Main/idl/comimpl.xsl

@@ -101 +101 @@
       <xsl:value-of select="concat($type,'_T')"/>
     </xsl:when>
+    <xsl:when test="//interface[@name=$type]">
+      <xsl:choose>
+        <xsl:when test="$param='no'">
+          <xsl:value-of select="concat('ComPtr&lt;',$type,'&gt;')"/>
+        </xsl:when> 
+        <xsl:when test="$param='yes'">
+          <xsl:value-of select="concat($type,'*')"/>
+        </xsl:when> 
+      </xsl:choose>
+    </xsl:when>
     <xsl:when test="$type='boolean'">
       <xsl:value-of select="'BOOL'" />
@@ -109 +119 @@
     <xsl:when test="$type='long'">
       <xsl:value-of select="'LONG'" />
+    </xsl:when>
+    <xsl:when test="$type='unsigned long long'">
+      <xsl:value-of select="'ULONG64'" />
+    </xsl:when>
+    <xsl:when test="$type='long long'">
+      <xsl:value-of select="'LONG64'" />
     </xsl:when>
     <xsl:otherwise>
@@ -140 +156 @@
     <xsl:when test="($type='wstring') or ($type = 'uuid')">
       <xsl:value-of select="concat('         ', $member, '.cloneTo(', $param, ');&#10;')"/>
+    </xsl:when>
+    <xsl:when test="//interface[@name=$type]">
+       <xsl:value-of select="concat('         ', $member, '.queryInterfaceTo(', $param, ');&#10;')"/>
     </xsl:when>
     <xsl:otherwise>
@@ -429 +448 @@
   <xsl:text><![CDATA[
          default:
-            if (0) AssertFailed();
+            if (1) AssertFailed();
     }
     va_end(args);

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

@@ -61 +61 @@
     // for VirtualBoxSupportErrorInfoImpl
     static const wchar_t *getComponentName() { return L"Event"; }
+
+private:
+    struct Data;
+
+    Data* m;
+};
+
+class ATL_NO_VTABLE VBoxVetoEvent :
+    public VBoxEvent,
+    VBOX_SCRIPTABLE_IMPL(IVetoEvent)
+{
+public:
+    VIRTUALBOXBASE_ADD_ERRORINFO_SUPPORT(VBoxVetoEvent)
+
+    DECLARE_NOT_AGGREGATABLE(VBoxVetoEvent)
+
+    DECLARE_PROTECT_FINAL_CONSTRUCT()
+
+    BEGIN_COM_MAP(VBoxEvent)
+        COM_INTERFACE_ENTRY(ISupportErrorInfo)
+        COM_INTERFACE_ENTRY(IEvent)
+        COM_INTERFACE_ENTRY(IVetoEvent)
+        COM_INTERFACE_ENTRY(IDispatch)
+    END_COM_MAP()
+
+    VBoxVetoEvent() {}
+    virtual ~VBoxVetoEvent() {}
+
+    HRESULT FinalConstruct();
+    void FinalRelease();
+
+    // public initializer/uninitializer for internal purposes only
+    HRESULT init (IEventSource *aSource, VBoxEventType_T aType);
+    void uninit();
+
+     // IVetoEvent methods
+    STDMETHOD(AddVeto)(IN_BSTR aVeto);
+    STDMETHOD(IsVetoed)(BOOL *aResult);
+    STDMETHOD(GetVetos)(ComSafeArrayOut(BSTR, aVetos));
+
+    // for VirtualBoxSupportErrorInfoImpl
+    static const wchar_t *getComponentName() { return L"VetoEvent"; }
 
 private:
@@ -133 +175 @@
 
  /**
-  * This function to be used with some care, as arguments order must match attribute declaration order 
-  * event class and its superclasses up to IEvent. If unsure, consult implementation in 
+  * This function to be used with some care, as arguments order must match attribute declaration order
+  * event class and its superclasses up to IEvent. If unsure, consult implementation in
   * generated VBoxEvents.cpp.
   */