Changeset 39119 in vbox for trunk/src

Timestamp:

Oct 26, 2011 1:07:47 PM (13 years ago)

Author:

vboxsync

Message:

VBoxManage: added a list sub-command to snapshot: snapshot myvm list

Location:

trunk/src/VBox/Frontends/VBoxManage

Files:

• VBoxManage.h (modified) (1 diff)
• VBoxManageHelp.cpp (modified) (1 diff)
• VBoxManageInfo.cpp (modified) (3 diffs)
• VBoxManageSnapshot.cpp (modified) (6 diffs)

trunk/src/VBox/Frontends/VBoxManage/VBoxManage.h

@@ -189 +189 @@
 
 /* VBoxManageVMInfo.cpp */
-void showSnapshots(ComPtr<ISnapshot> &rootSnapshot,
-                   ComPtr<ISnapshot> &currentSnapshot,
-                   VMINFO_DETAILS details,
-                   const com::Bstr &prefix = "",
-                   int level = 0);
+HRESULT showSnapshots(ComPtr<ISnapshot> &rootSnapshot,
+                      ComPtr<ISnapshot> &currentSnapshot,
+                      VMINFO_DETAILS details,
+                      const com::Bstr &prefix = "",
+                      int level = 0);
 int handleShowVMInfo(HandlerArg *a);
 HRESULT showVMInfo(ComPtr<IVirtualBox> virtualBox,

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

@@ -446 +446 @@
                      "                                 [--name <name>]\n"
                      "                                 [--description <desc>] |\n"
+                     "                            list [--details|--machinereadable]\n"
                      "                            showvminfo <uuid>|<name>\n"
                      "\n");

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

@@ -48 +48 @@
 ///////////////////////////////////////////////////////////////////////////////
 
-void showSnapshots(ComPtr<ISnapshot> &rootSnapshot,
-                   ComPtr<ISnapshot> &currentSnapshot,
-                   VMINFO_DETAILS details,
-                   const Bstr &prefix /* = ""*/,
-                   int level /*= 0*/)
+HRESULT showSnapshots(ComPtr<ISnapshot> &rootSnapshot,
+                      ComPtr<ISnapshot> &currentSnapshot,
+                      VMINFO_DETAILS details,
+                      const Bstr &prefix /* = ""*/,
+                      int level /*= 0*/)
 {
     /* start with the root */
     Bstr name;
     Bstr uuid;
-    rootSnapshot->COMGETTER(Name)(name.asOutParam());
-    rootSnapshot->COMGETTER(Id)(uuid.asOutParam());
+    CHECK_ERROR2_RET(rootSnapshot,COMGETTER(Name)(name.asOutParam()), hrcCheck);
+    CHECK_ERROR2_RET(rootSnapshot,COMGETTER(Id)(uuid.asOutParam()), hrcCheck);
     if (details == VMINFO_MACHINEREADABLE)
     {
@@ -77 +77 @@
 
     /* get the children */
+    HRESULT hrc = S_OK;
     SafeIfaceArray <ISnapshot> coll;
-    rootSnapshot->COMGETTER(Children)(ComSafeArrayAsOutParam(coll));
+    CHECK_ERROR2_RET(rootSnapshot,COMGETTER(Children)(ComSafeArrayAsOutParam(coll)), hrcCheck);
     if (!coll.isNull())
     {
@@ -95 +96 @@
 
                 /* recursive call */
-                showSnapshots(snapshot, currentSnapshot, details, newPrefix, level + 1);
-            }
-        }
-    }
+                HRESULT hrc2 = showSnapshots(snapshot, currentSnapshot, details, newPrefix, level + 1);
+                if (FAILED(hrc2))
+                    hrc = hrc2;
+            }
+        }
+    }
+    return hrc;
 }
 

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

@@ -157 +157 @@
 }
 
+
+/**
+ * Handles the 'snapshot myvm list' sub-command.
+ * @returns Exit code.
+ * @param   pArgs           The handler argument package.
+ * @param   rptrMachine     Reference to the VM (locked) we're operating on.
+ */
+static RTEXITCODE handleSnapshotList(HandlerArg *pArgs, ComPtr<IMachine> &rptrMachine)
+{
+    static const RTGETOPTDEF g_aOptions[] =
+    {
+        { "--details",          'D', RTGETOPT_REQ_NOTHING },
+        { "--machinereadable",  'M', RTGETOPT_REQ_NOTHING },
+    };
+
+    VMINFO_DETAILS enmDetails = VMINFO_STANDARD;
+
+    int c;
+    RTGETOPTUNION ValueUnion;
+    RTGETOPTSTATE GetState;
+    // start at 0 because main() has hacked both the argc and argv given to us
+    RTGetOptInit(&GetState, pArgs->argc, pArgs->argv, g_aOptions, RT_ELEMENTS(g_aOptions), 2 /*iArg*/, 0 /*fFlags*/);
+    while ((c = RTGetOpt(&GetState, &ValueUnion)))
+    {
+        switch (c)
+        {
+            case 'D':   enmDetails = VMINFO_FULL; break;
+            case 'M':   enmDetails = VMINFO_MACHINEREADABLE; break;
+            default:    return errorGetOpt(USAGE_SNAPSHOT, c, &ValueUnion);
+        }
+    }
+
+    /* See showVMInfo. */
+    ComPtr<ISnapshot> ptrSnapshot;
+    CHECK_ERROR2_RET(rptrMachine, FindSnapshot(Bstr().raw(), ptrSnapshot.asOutParam()), RTEXITCODE_FAILURE);
+    if (ptrSnapshot)
+    {
+        ComPtr<ISnapshot> ptrCurrentSnapshot;
+        CHECK_ERROR2_RET(rptrMachine,COMGETTER(CurrentSnapshot)(ptrCurrentSnapshot.asOutParam()), RTEXITCODE_FAILURE);
+        HRESULT hrc = showSnapshots(ptrSnapshot, ptrCurrentSnapshot, enmDetails);
+        if (FAILED(hrc))
+            return RTEXITCODE_FAILURE;
+    }
+    return RTEXITCODE_SUCCESS;
+}
+
 /**
  * Implementation for "VBoxManage snapshot ... dump". This goes thru the machine's
@@ -226 +272 @@
     /* the first argument must be the VM */
     Bstr bstrMachine(a->argv[0]);
-    ComPtr<IMachine> pMachine;
+    ComPtr<IMachine> ptrMachine;
     CHECK_ERROR(a->virtualBox, FindMachine(bstrMachine.raw(),
-                                           pMachine.asOutParam()));
-    if (!pMachine)
+                                           ptrMachine.asOutParam()));
+    if (!ptrMachine)
         return 1;
 
@@ -235 +281 @@
     {
         /* we have to open a session for this task (new or shared) */
-        rc = pMachine->LockMachine(a->session, LockType_Shared);
+        rc = ptrMachine->LockMachine(a->session, LockType_Shared);
         ComPtr<IConsole> console;
         CHECK_ERROR_BREAK(a->session, COMGETTER(Console)(console.asOutParam()));
@@ -350 +396 @@
             if (fRestoreCurrent)
             {
-                CHECK_ERROR_BREAK(pMachine, COMGETTER(CurrentSnapshot)(pSnapshot.asOutParam()));
+                CHECK_ERROR_BREAK(ptrMachine, COMGETTER(CurrentSnapshot)(pSnapshot.asOutParam()));
             }
             else
             {
                 // restore or delete snapshot: then resolve cmd line argument to snapshot instance
-                CHECK_ERROR_BREAK(pMachine, FindSnapshot(Bstr(a->argv[2]).raw(),
+                CHECK_ERROR_BREAK(ptrMachine, FindSnapshot(Bstr(a->argv[2]).raw(),
                                                          pSnapshot.asOutParam()));
             }
@@ -390 +436 @@
                 || !strcmp(a->argv[2], "-current"))
             {
-                CHECK_ERROR_BREAK(pMachine, COMGETTER(CurrentSnapshot)(snapshot.asOutParam()));
+                CHECK_ERROR_BREAK(ptrMachine, COMGETTER(CurrentSnapshot)(snapshot.asOutParam()));
             }
             else
             {
-                CHECK_ERROR_BREAK(pMachine, FindSnapshot(Bstr(a->argv[2]).raw(),
-                                                         snapshot.asOutParam()));
+                CHECK_ERROR_BREAK(ptrMachine, FindSnapshot(Bstr(a->argv[2]).raw(),
+                                                           snapshot.asOutParam()));
             }
 
@@ -448 +494 @@
             ComPtr<ISnapshot> snapshot;
 
-            CHECK_ERROR_BREAK(pMachine, FindSnapshot(Bstr(a->argv[2]).raw(),
-                                                     snapshot.asOutParam()));
+            CHECK_ERROR_BREAK(ptrMachine, FindSnapshot(Bstr(a->argv[2]).raw(),
+                                                       snapshot.asOutParam()));
 
             /* get the machine of the given snapshot */
-            ComPtr<IMachine> pMachine2;
-            snapshot->COMGETTER(Machine)(pMachine2.asOutParam());
-            showVMInfo(a->virtualBox, pMachine2, VMINFO_NONE, console);
-        }
+            ComPtr<IMachine> ptrMachine2;
+            snapshot->COMGETTER(Machine)(ptrMachine2.asOutParam());
+            showVMInfo(a->virtualBox, ptrMachine2, VMINFO_NONE, console);
+        }
+        else if (!strcmp(a->argv[1], "list"))
+            rc = handleSnapshotList(a, ptrMachine) == RTEXITCODE_SUCCESS ? S_OK : E_FAIL;
         else if (!strcmp(a->argv[1], "dump"))          // undocumented parameter to debug snapshot info
-            DumpSnapshot(pMachine);
+            DumpSnapshot(ptrMachine);
         else
         {