Changeset 26046 in vbox for trunk/src/VBox/Main/include/MachineImpl.h

Timestamp:

Jan 26, 2010 2:06:05 PM (15 years ago)

Author:

vboxsync

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

56959

Message:

Main: move Auto*StateDependency templates out of MachineImpl.h

File:

• trunk/src/VBox/Main/include/MachineImpl.h (modified) (2 diffs)

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

@@ -94 +94 @@
 
     enum InitMode { Init_New, Init_Import, Init_Registered };
+
+    enum StateDependency
+    {
+        AnyStateDep = 0, MutableStateDep, MutableOrSavedStateDep
+    };
 
     /**
@@ -334 +339 @@
         AttachmentList mAttachments;
     };
-
-    enum StateDependency
-    {
-        AnyStateDep = 0, MutableStateDep, MutableOrSavedStateDep
-    };
-
-    /**
-     *  Helper class that safely manages the machine state dependency by
-     *  calling Machine::addStateDependency() on construction and
-     *  Machine::releaseStateDependency() on destruction. Intended for Machine
-     *  children. The usage pattern is:
-     *
-     *  @code
-     *      AutoCaller autoCaller(this);
-     *      if (FAILED(autoCaller.rc())) return autoCaller.rc();
-     *
-     *      Machine::AutoStateDependency<MutableStateDep> adep(mParent);
-     *      if (FAILED(stateDep.rc())) return stateDep.rc();
-     *      ...
-     *      // code that depends on the particular machine state
-     *      ...
-     *  @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.
-     */
-    template <StateDependency taDepType = AnyStateDep>
-    class AutoStateDependency
-    {
-    public:
-
-        AutoStateDependency(Machine *aThat)
-            : mThat(aThat), mRC(S_OK)
-            , mMachineState(MachineState_Null)
-            , mRegistered(FALSE)
-        {
-            Assert(aThat);
-            mRC = aThat->addStateDependency(taDepType, &mMachineState,
-                                            &mRegistered);
-        }
-        ~AutoStateDependency()
-        {
-            if (SUCCEEDED(mRC))
-                mThat->releaseStateDependency();
-        }
-
-        /** Decreases the number of dependencies before the instance is
-         *  destroyed. Note that will reset #rc() to E_FAIL. */
-        void release()
-        {
-            AssertReturnVoid(SUCCEEDED(mRC));
-            mThat->releaseStateDependency();
-            mRC = E_FAIL;
-        }
-
-        /** Restores the number of callers after by #release(). #rc() will be
-         *  reset to the result of calling addStateDependency() and must be
-         *  rechecked to ensure the operation succeeded. */
-        void add()
-        {
-            AssertReturnVoid(!SUCCEEDED(mRC));
-            mRC = mThat->addStateDependency(taDepType, &mMachineState,
-                                            &mRegistered);
-        }
-
-        /** Returns the result of Machine::addStateDependency(). */
-        HRESULT rc() const { return mRC; }
-
-        /** Shortcut to SUCCEEDED(rc()). */
-        bool isOk() const { return SUCCEEDED(mRC); }
-
-        /** Returns the machine state value as returned by
-         *  Machine::addStateDependency(). */
-        MachineState_T machineState() const { return mMachineState; }
-
-        /** Returns the machine state value as returned by
-         *  Machine::addStateDependency(). */
-        BOOL machineRegistered() const { return mRegistered; }
-
-    protected:
-
-        Machine *mThat;
-        HRESULT mRC;
-        MachineState_T mMachineState;
-        BOOL mRegistered;
-
-    private:
-
-        DECLARE_CLS_COPY_CTOR_ASSIGN_NOOP(AutoStateDependency)
-        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)