Changeset 3302 in vbox for trunk/src

Timestamp:

Jun 26, 2007 3:50:41 PM (18 years ago)

Author:

vboxsync

Message:

Main: More Machine children use the AutoStateDependency template.

Location:

trunk/src/VBox/Main

Files:

• BIOSSettingsImpl.cpp (modified) (8 diffs)
• USBControllerImpl.cpp (modified) (6 diffs)
• include/MachineImpl.h (modified) (3 diffs)

trunk/src/VBox/Main/BIOSSettingsImpl.cpp

@@ -171 +171 @@
     CheckComRCReturnRC (autoCaller.rc());
 
-    AutoLock alock (this);
-
-    CHECK_MACHINE_MUTABILITY (mParent);
+    /* the machine needs to be mutable */
+    Machine::AutoMutableStateDependency adep (mParent);
+    CheckComRCReturnRC (adep.rc());
+
+    AutoLock alock (this);
 
     mData.backup();
@@ -201 +203 @@
     CheckComRCReturnRC (autoCaller.rc());
 
-    AutoLock alock (this);
-
-    CHECK_MACHINE_MUTABILITY (mParent);
+    /* the machine needs to be mutable */
+    Machine::AutoMutableStateDependency adep (mParent);
+    CheckComRCReturnRC (adep.rc());
+
+    AutoLock alock (this);
 
     mData.backup();
@@ -231 +235 @@
     CheckComRCReturnRC (autoCaller.rc());
 
-    AutoLock alock (this);
-
-    CHECK_MACHINE_MUTABILITY (mParent);
+    /* the machine needs to be mutable */
+    Machine::AutoMutableStateDependency adep (mParent);
+    CheckComRCReturnRC (adep.rc());
+
+    AutoLock alock (this);
 
     mData.backup();
@@ -264 +270 @@
     CheckComRCReturnRC (autoCaller.rc());
 
-    AutoLock alock (this);
-
-    CHECK_MACHINE_MUTABILITY (mParent);
+    /* the machine needs to be mutable */
+    Machine::AutoMutableStateDependency adep (mParent);
+    CheckComRCReturnRC (adep.rc());
+
+    AutoLock alock (this);
 
     mData.backup();
@@ -293 +301 @@
     CheckComRCReturnRC (autoCaller.rc());
 
-    AutoLock alock (this);
-
-    CHECK_MACHINE_MUTABILITY (mParent);
+    /* the machine needs to be mutable */
+    Machine::AutoMutableStateDependency adep (mParent);
+    CheckComRCReturnRC (adep.rc());
+
+    AutoLock alock (this);
 
     mData.backup();
@@ -323 +333 @@
     CheckComRCReturnRC (autoCaller.rc());
 
-    AutoLock alock (this);
-
-    CHECK_MACHINE_MUTABILITY (mParent);
+    /* the machine needs to be mutable */
+    Machine::AutoMutableStateDependency adep (mParent);
+    CheckComRCReturnRC (adep.rc());
+
+    AutoLock alock (this);
 
     mData.backup();
@@ -353 +365 @@
     CheckComRCReturnRC (autoCaller.rc());
 
-    AutoLock alock (this);
-
-    CHECK_MACHINE_MUTABILITY (mParent);
+    /* the machine needs to be mutable */
+    Machine::AutoMutableStateDependency adep (mParent);
+    CheckComRCReturnRC (adep.rc());
+
+    AutoLock alock (this);
 
     mData.backup();
@@ -383 +397 @@
     CheckComRCReturnRC (autoCaller.rc());
 
-    AutoLock alock (this);
-
-    CHECK_MACHINE_MUTABILITY (mParent);
+    /* the machine needs to be mutable */
+    Machine::AutoMutableStateDependency adep (mParent);
+    CheckComRCReturnRC (adep.rc());
+
+    AutoLock alock (this);
 
     mData.backup();

trunk/src/VBox/Main/USBControllerImpl.cpp

@@ -227 +227 @@
     CheckComRCReturnRC (autoCaller.rc());
 
+    /* the machine needs to be mutable */
+    Machine::AutoMutableStateDependency adep (mParent);
+    CheckComRCReturnRC (adep.rc());
+
     AutoLock alock (this);
-
-    CHECK_MACHINE_MUTABILITY (mParent);
 
     if (mData->mEnabled != aEnabled)
@@ -295 +297 @@
     CheckComRCReturnRC (autoCaller.rc());
 
+    /* the machine needs to be mutable */
+    Machine::AutoMutableStateDependency adep (mParent);
+    CheckComRCReturnRC (adep.rc());
+
     AutoLock alock (this);
-
-    CHECK_MACHINE_MUTABILITY (mParent);
 
     ComObjPtr <USBDeviceFilter> filter;
@@ -319 +323 @@
 
     /* the machine needs to be mutable */
-    Machine::AutoStateDependency <Machine::MutableStateDep> adep (mParent);
+    Machine::AutoMutableStateDependency adep (mParent);
     CheckComRCReturnRC (adep.rc());
 
@@ -380 +384 @@
 
     /* the machine needs to be mutable */
-    Machine::AutoStateDependency <Machine::MutableStateDep> adep (mParent);
+    Machine::AutoMutableStateDependency adep (mParent);
     CheckComRCReturnRC (adep.rc());
 
@@ -677 +681 @@
 
     /* we need the machine state */
-    Machine::AutoStateDependency <Machine::MutableStateDep> adep (mParent);
+    Machine::AutoMutableStateDependency adep (mParent);
     AssertComRCReturn (adep.rc(), false);
 
@@ -950 +954 @@
 #else
     /* we need the machine state */
-    Machine::AutoStateDependency <Machine::MutableStateDep> adep (mParent);
+    Machine::AutoMutableStateDependency adep (mParent);
     AssertComRCReturnRC (adep.rc());
 

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

@@ -299 +299 @@
      *
      *  @code
+     *      AutoCaller autoCaller (this);
+     *      CheckComRCReturnRC (autoCaller.rc());
+     *
      *      Machine::AutoStateDependency <MutableStateDep> adep (mParent);
      *      CheckComRCReturnRC (stateDep.rc());
@@ -305 +308 @@
      *      ...
      *  @endcode
+     *
+     *  Note that it is more convenient to use the following individual
+     *  shortcut classes instead of using this template directly:
+     *  AutoAnyStateDependency, AutoMutableStateDependency and
+     *  AutoMutableOrSavedStateDependency. The usage pattern is exactly the
+     *  same as above except that there is no need to specify the template
+     *  argument because it is already done by the shortcut class.
      *
      *  @param taDepType    Dependecy type to manage.
@@ -373 +383 @@
         DECLARE_CLS_NEW_DELETE_NOOP (AutoStateDependency)
     };
+
+    /** 
+     *  Shortcut to AutoStateDependency <AnyStateDep>.
+     *  See AutoStateDependency to get the usage pattern.
+     *
+     *  Accepts any machine state and guarantees the state won't change before
+     *  this object is destroyed. If the machine state cannot be protected (as
+     *  a result of the state change currently in progress), this instance's
+     *  #rc() method will indicate a failure, and the caller is not allowed to
+     *  rely on any particular machine state and should return the failed
+     *  result code to the upper level.
+     */
+    typedef AutoStateDependency <AnyStateDep> AutoAnyStateDependency;
+
+    /** 
+     *  Shortcut to AutoStateDependency <MutableStateDep>.
+     *  See AutoStateDependency to get the usage pattern.
+     *
+     *  Succeeds only if the machine state is in one of the mutable states, and
+     *  guarantees the given mutable state won't change before this object is
+     *  destroyed. If the machine is not mutable, this instance's #rc() method
+     *  will indicate a failure, and the caller is not allowed to rely on any
+     *  particular machine state and should return the failed result code to
+     *  the upper level.
+     *
+     *  Intended to be used within all setter methods of IMachine
+     *  children objects (DVDDrive, NetworkAdapter, AudioAdapter, etc.) to
+     *  provide data protection and consistency.
+     */
+    typedef AutoStateDependency <MutableStateDep> AutoMutableStateDependency;
+
+    /** 
+     *  Shortcut to AutoStateDependency <MutableOrSavedStateDep>.
+     *  See AutoStateDependency to get the usage pattern.
+     *
+     *  Succeeds only if the machine state is in one of the mutable states, or
+     *  if the machine is in the Saved state, and guarantees the given mutable
+     *  state won't change before this object is destroyed. If the machine is
+     *  not mutable, this instance's #rc() method will indicate a failure, and
+     *  the caller is not allowed to rely on any particular machine state and
+     *  should return the failed result code to the upper level.
+     *
+     *  Intended to be used within setter methods of IMachine
+     *  children objects that may also operate on Saved machines.
+     */
+    typedef AutoStateDependency <MutableOrSavedStateDep> AutoMutableOrSavedStateDependency;
+
 
     VIRTUALBOXBASE_ADD_ERRORINFO_SUPPORT (Machine)