Changeset 33300 in vbox

Timestamp:

Oct 21, 2010 11:28:06 AM (14 years ago)

Author:

vboxsync

Message:

Main: API change, merge IMachine::getSnapshot() with findSnapshot()

Location:

trunk

Files:

• doc/manual/en_US/SDKRef.xml (modified) (1 diff)
• src/VBox/Frontends/VBoxManage/VBoxManageInfo.cpp (modified) (1 diff)
• src/VBox/Frontends/VBoxManage/VBoxManageList.cpp (modified) (1 diff)
• src/VBox/Frontends/VBoxManage/VBoxManageSnapshot.cpp (modified) (4 diffs)
• src/VBox/Frontends/VirtualBox/src/VBoxMedium.cpp (modified) (1 diff)
• src/VBox/Frontends/VirtualBox/src/runtime/UIMachineLogic.cpp (modified) (1 diff)
• src/VBox/Frontends/VirtualBox/src/selector/VBoxSnapshotsWgt.cpp (modified) (4 diffs)
• src/VBox/Main/MachineImpl.cpp (modified) (7 diffs)
• src/VBox/Main/SnapshotImpl.cpp (modified) (1 diff)
• src/VBox/Main/idl/VirtualBox.xidl (modified) (4 diffs)
• src/VBox/Main/include/MachineImpl.h (modified) (2 diffs)

trunk/doc/manual/en_US/SDKRef.xml

@@ -3429 +3429 @@
           aforementioned changes, IVirtualBox::getMachine() has been merged
           with <xref linkend="IVirtualBox__findMachine"
-          xreflabel="IVirtualBox::findMachine()" />.</para>
+          xreflabel="IVirtualBox::findMachine()" />, and
+          IMachine::getSnapshot() has been merged with <xref
+          linkend="IMachine__findSnapshot"
+          xreflabel="IMachine::findSnapshot()" />.</para>
         </listitem>
 

trunk/src/VBox/Frontends/VBoxManage/VBoxManageInfo.cpp

@@ -2030 +2030 @@
      */
     ComPtr<ISnapshot> snapshot;
-    rc = machine->GetSnapshot(Bstr().raw(), snapshot.asOutParam());
+    rc = machine->FindSnapshot(Bstr().raw(), snapshot.asOutParam());
     if (SUCCEEDED(rc) && snapshot)
     {

trunk/src/VBox/Frontends/VBoxManage/VBoxManageList.cpp

@@ -150 +150 @@
             {
                 ComPtr<ISnapshot> snapshot;
-                machine->GetSnapshot(snapshotIds[k], snapshot.asOutParam());
+                machine->FindSnapshot(snapshotIds[k], snapshot.asOutParam());
                 if (snapshot)
                 {

trunk/src/VBox/Frontends/VBoxManage/VBoxManageSnapshot.cpp

@@ -172 +172 @@
         // get root snapshot
         ComPtr<ISnapshot> pSnapshot;
-        CHECK_ERROR_BREAK(pMachine, GetSnapshot(Bstr("").raw(), pSnapshot.asOutParam()));
+        CHECK_ERROR_BREAK(pMachine, FindSnapshot(Bstr("").raw(), pSnapshot.asOutParam()));
 
         // get current snapshot
@@ -363 +363 @@
             {
                 // restore or delete snapshot: then resolve cmd line argument to snapshot instance
-                // assume it's a UUID
-                bstrSnapGuid = a->argv[2];
-                if (FAILED(pMachine->GetSnapshot(bstrSnapGuid.raw(),
-                                                 pSnapshot.asOutParam())))
-                {
-                    // then it must be a name
-                    CHECK_ERROR_BREAK(pMachine, FindSnapshot(Bstr(a->argv[2]).raw(),
-                                                             pSnapshot.asOutParam()));
-                    CHECK_ERROR_BREAK(pSnapshot, COMGETTER(Id)(bstrSnapGuid.asOutParam()));
-                }
+                CHECK_ERROR_BREAK(pMachine, FindSnapshot(Bstr(a->argv[2]).raw(),
+                                                         pSnapshot.asOutParam()));
+                Bstr bstrSnapGuid;
+                CHECK_ERROR_BREAK(pSnapshot, COMGETTER(Id)(bstrSnapGuid.asOutParam()));
             }
 
@@ -415 +409 @@
             else
             {
-                /* assume it's a UUID */
-                rc = pMachine->GetSnapshot(Bstr(a->argv[2]).raw(),
-                                           snapshot.asOutParam());
-                if (FAILED(rc) || !snapshot)
-                {
-                    /* then it must be a name */
-                    CHECK_ERROR_BREAK(pMachine, FindSnapshot(Bstr(a->argv[2]).raw(),
-                                                             snapshot.asOutParam()));
-                }
+                CHECK_ERROR_BREAK(pMachine, FindSnapshot(Bstr(a->argv[2]).raw(),
+                                                         snapshot.asOutParam()));
             }
 
@@ -476 +463 @@
             ComPtr<ISnapshot> snapshot;
 
-            /* assume it's a UUID */
-            rc = pMachine->GetSnapshot(Bstr(a->argv[2]).raw(),
-                                       snapshot.asOutParam());
-            if (FAILED(rc) || !snapshot)
-            {
-                /* then it must be a name */
-                CHECK_ERROR_BREAK(pMachine, FindSnapshot(Bstr(a->argv[2]).raw(),
-                                                         snapshot.asOutParam()));
-            }
+            CHECK_ERROR_BREAK(pMachine, FindSnapshot(Bstr(a->argv[2]).raw(),
+                                                     snapshot.asOutParam()));
 
             /* get the machine of the given snapshot */

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

@@ -208 +208 @@
                     }
 
-                    CSnapshot snapshot = machine.GetSnapshot (*jt);
+                    CSnapshot snapshot = machine.FindSnapshot(*jt);
                     if (!snapshot.isNull())           // can be NULL while takeSnaphot is in progress
                     {

trunk/src/VBox/Frontends/VirtualBox/src/runtime/UIMachineLogic.cpp

@@ -994 +994 @@
     /* Search for the max available filter index. */
     QString strNameTemplate = QApplication::translate("UIMachineLogic", "Snapshot %1");
-    int iMaxSnapshotIndex = searchMaxSnapshotIndex(machine, machine.GetSnapshot(QString()), strNameTemplate);
+    int iMaxSnapshotIndex = searchMaxSnapshotIndex(machine, machine.FindSnapshot(QString()), strNameTemplate);
     dlg.mLeName->setText(strNameTemplate.arg(++ iMaxSnapshotIndex));
 

trunk/src/VBox/Frontends/VirtualBox/src/selector/VBoxSnapshotsWgt.cpp

@@ -507 +507 @@
     if (item)
     {
-        CSnapshot snap = item->snapshotId().isNull() ? CSnapshot() : mMachine.GetSnapshot (item->snapshotId());
+        CSnapshot snap = item->snapshotId().isNull()    ? CSnapshot() : mMachine.FindSnapshot(item->snapshotId());
         if (!snap.isNull() && snap.isOk() && snap.GetName() != item->text (0))
             snap.SetName (item->text (0));
@@ -521 +521 @@
     QString snapId = item->snapshotId();
     AssertReturn (!snapId.isNull(), (void) 0);
-    CSnapshot snapshot = mMachine.GetSnapshot (snapId);
+    CSnapshot snapshot = mMachine.FindSnapshot(snapId);
 
     if (!vboxProblem().askAboutSnapshotRestoring (snapshot.GetName()))
@@ -556 +556 @@
     QString snapId = item->snapshotId();
     AssertReturn (!snapId.isNull(), (void) 0);
-    CSnapshot snapshot = mMachine.GetSnapshot (snapId);
+    CSnapshot snapshot = mMachine.FindSnapshot(snapId);
 
     if (!vboxProblem().askAboutSnapshotDeleting (snapshot.GetName()))
@@ -779 +779 @@
     if (mMachine.GetSnapshotCount() > 0)
     {
-        CSnapshot snapshot = mMachine.GetSnapshot (QString::null);
+        CSnapshot snapshot = mMachine.FindSnapshot(QString::null);
 
         populateSnapshots (snapshot, 0);

trunk/src/VBox/Main/MachineImpl.cpp

@@ -4557 +4557 @@
 }
 
-STDMETHODIMP Machine::GetSnapshot(IN_BSTR aId, ISnapshot **aSnapshot)
+STDMETHODIMP Machine::FindSnapshot(IN_BSTR aNameOrId, ISnapshot **aSnapshot)
 {
     CheckComArgOutPointerValid(aSnapshot);
@@ -4566 +4566 @@
     AutoReadLock alock(this COMMA_LOCKVAL_SRC_POS);
 
-    Guid uuid(aId);
-    /* Todo: fix this properly by perhaps introducing an isValid method for the Guid class */
-    if (    (aId)
-        &&  (*aId != '\0')      // an empty Bstr means "get root snapshot", so don't fail on that
-        &&  (uuid.isEmpty()))
-    {
-        RTUUID uuidTemp;
-        /* Either it's a null UUID or the conversion failed. (null uuid has a special meaning in findSnapshot) */
-        if (RT_FAILURE(RTUuidFromUtf16(&uuidTemp, aId)))
-            return setError(E_FAIL,
-                            tr("Could not find a snapshot with UUID {%ls}"),
-                            aId);
-    }
-
-    ComObjPtr<Snapshot> snapshot;
-
-    HRESULT rc = findSnapshot(uuid, snapshot, true /* aSetError */);
-    snapshot.queryInterfaceTo(aSnapshot);
+    ComObjPtr<Snapshot> pSnapshot;
+    HRESULT rc;
+
+    if (!aNameOrId || !*aNameOrId)
+        // null case (caller wants root snapshot): findSnapshotById() handles this
+        rc = findSnapshotById(Guid(), pSnapshot, true /* aSetError */);
+    else
+    {
+        Guid uuid(aNameOrId);
+        if (!uuid.isEmpty())
+            rc = findSnapshotById(uuid, pSnapshot, true /* aSetError */);
+        else
+            rc = findSnapshotByName(Utf8Str(aNameOrId), pSnapshot, true /* aSetError */);
+    }
+    pSnapshot.queryInterfaceTo(aSnapshot);
 
     return rc;
-}
-
-STDMETHODIMP Machine::FindSnapshot(IN_BSTR aName, ISnapshot **aSnapshot)
-{
-    CheckComArgStrNotEmptyOrNull(aName);
-    CheckComArgOutPointerValid(aSnapshot);
-
-    AutoCaller autoCaller(this);
-    if (FAILED(autoCaller.rc())) return autoCaller.rc();
-
-    AutoReadLock alock(this COMMA_LOCKVAL_SRC_POS);
-
-    ComObjPtr<Snapshot> snapshot;
-
-    HRESULT rc = findSnapshot(aName, snapshot, true /* aSetError */);
-    snapshot.queryInterfaceTo(aSnapshot);
-
-    return rc;
-}
-
-STDMETHODIMP Machine::SetCurrentSnapshot(IN_BSTR /* aId */)
-{
-    /// @todo (dmik) don't forget to set
-    //  mData->mCurrentStateModified to FALSE
-
-    return setError(E_NOTIMPL, "Not implemented");
 }
 
@@ -7533 +7504 @@
  *  @param aSetError    true to set extended error info on failure
  */
-HRESULT Machine::findSnapshot(const Guid &aId,
-                              ComObjPtr<Snapshot> &aSnapshot,
-                              bool aSetError /* = false */)
+HRESULT Machine::findSnapshotById(const Guid &aId,
+                                  ComObjPtr<Snapshot> &aSnapshot,
+                                  bool aSetError /* = false */)
 {
     AutoReadLock chlock(this COMMA_LOCKVAL_SRC_POS);
@@ -7542 +7513 @@
     {
         if (aSetError)
-            return setError(E_FAIL,
-                            tr("This machine does not have any snapshots"));
+            return setError(E_FAIL, tr("This machine does not have any snapshots"));
         return E_FAIL;
     }
@@ -7571 +7541 @@
  *  @param aSetError    true to set extended error info on failure
  */
-HRESULT Machine::findSnapshot(IN_BSTR aName,
-                              ComObjPtr<Snapshot> &aSnapshot,
-                              bool aSetError /* = false */)
-{
-    AssertReturn(aName, E_INVALIDARG);
+HRESULT Machine::findSnapshotByName(const Utf8Str &strName,
+                                    ComObjPtr<Snapshot> &aSnapshot,
+                                    bool aSetError /* = false */)
+{
+    AssertReturn(!strName.isEmpty(), E_INVALIDARG);
 
     AutoReadLock chlock(this COMMA_LOCKVAL_SRC_POS);
@@ -7587 +7557 @@
     }
 
-    aSnapshot = mData->mFirstSnapshot->findChildOrSelf(aName);
+    aSnapshot = mData->mFirstSnapshot->findChildOrSelf(strName);
 
     if (!aSnapshot)
@@ -7593 +7563 @@
         if (aSetError)
             return setError(VBOX_E_OBJECT_NOT_FOUND,
-                            tr("Could not find a snapshot named '%ls'"), aName);
+                            tr("Could not find a snapshot named '%s'"), strName.c_str());
         return VBOX_E_OBJECT_NOT_FOUND;
     }

trunk/src/VBox/Main/SnapshotImpl.cpp

@@ -2088 +2088 @@
 
     ComObjPtr<Snapshot> pSnapshot;
-    HRESULT rc = findSnapshot(id, pSnapshot, true /* aSetError */);
+    HRESULT rc = findSnapshotById(id, pSnapshot, true /* aSetError */);
     if (FAILED(rc)) return rc;
 

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

@@ -3346 +3346 @@
   <interface
      name="IMachine" extends="$unknown"
-     uuid="5c91359b-5bdb-4518-9bd1-5f2c50a3c129"
+     uuid="14136b33-438a-45de-884c-550e9eb34f23"
      wsmap="managed"
      >
@@ -3797 +3797 @@
             <link to="#settingsModified"/> returns @c false)
           </li>
-          <li><link to="IMachine::setCurrentSnapshot"/>
-          </li>
         </ul>
 
@@ -5068 +5066 @@
     </method >
 
-    <method name="getSnapshot">
-      <desc>
+    <method name="findSnapshot">
+      <desc>
+        Returns a snapshot of this machine with the given name or UUID.
+
         Returns a snapshot of this machine with the given UUID.
-        A @c null UUID can be used to obtain the first snapshot
+        A @c null argument can be used to obtain the first snapshot
         taken on this machine. This is useful if you want to traverse
         the whole tree of snapshots starting from the root.
@@ -5080 +5080 @@
 
       </desc>
-      <param name="id" type="uuid" mod="string" dir="in">
-        <desc>UUID of the snapshot to get</desc>
-      </param>
-      <param name="snapshot" type="ISnapshot" dir="return">
-        <desc>Snapshot object with the given UUID.</desc>
-      </param>
-    </method>
-
-    <method name="findSnapshot">
-      <desc>
-        Returns a snapshot of this machine with the given name.
-
-        <result name="VBOX_E_OBJECT_NOT_FOUND">
-          Virtual machine has no snapshots or snapshot not found.
-        </result>
-
-      </desc>
-      <param name="name" type="wstring" dir="in">
-        <desc>Name of the snapshot to find</desc>
+      <param name="nameOrId" type="wstring" dir="in">
+        <desc>What to search for. Name or UUID of the snapshot to find</desc>
       </param>
       <param name="snapshot" type="ISnapshot" dir="return">
         <desc>Snapshot object with the given name.</desc>
-      </param>
-    </method>
-
-    <method name="setCurrentSnapshot">
-      <desc>
-        Sets the current snapshot of this machine.
-        <note>
-          In the current implementation, this operation is not
-          implemented.
-        </note>
-      </desc>
-      <param name="id" type="uuid" mod="string" dir="in">
-        <desc>UUID of the snapshot to set as the current snapshot.</desc>
       </param>
     </method>

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

@@ -491 +491 @@
     STDMETHOD(Delete)(ComSafeArrayIn(IMedium*, aMedia), IProgress **aProgress);
     STDMETHOD(Export)(IAppliance *aAppliance, IVirtualSystemDescription **aDescription);
-    STDMETHOD(GetSnapshot)(IN_BSTR aId, ISnapshot **aSnapshot);
-    STDMETHOD(FindSnapshot)(IN_BSTR aName, ISnapshot **aSnapshot);
-    STDMETHOD(SetCurrentSnapshot)(IN_BSTR aId);
+    STDMETHOD(FindSnapshot)(IN_BSTR aNameOrId, ISnapshot **aSnapshot);
     STDMETHOD(CreateSharedFolder)(IN_BSTR aName, IN_BSTR aHostPath, BOOL aWritable, BOOL aAutoMount);
     STDMETHOD(RemoveSharedFolder)(IN_BSTR aName);
@@ -735 +733 @@
                                const Guid *puuidSnapshot);
 
-    HRESULT findSnapshot(const Guid &aId, ComObjPtr<Snapshot> &aSnapshot,
-                         bool aSetError = false);
-    HRESULT findSnapshot(IN_BSTR aName, ComObjPtr<Snapshot> &aSnapshot,
-                         bool aSetError = false);
+    HRESULT findSnapshotById(const Guid &aId,
+                             ComObjPtr<Snapshot> &aSnapshot,
+                             bool aSetError = false);
+    HRESULT findSnapshotByName(const Utf8Str &strName,
+                               ComObjPtr<Snapshot> &aSnapshot,
+                               bool aSetError = false);
 
     HRESULT getStorageControllerByName(const Utf8Str &aName,