Changeset 101180 in vbox for trunk/src/VBox

Timestamp:

Sep 19, 2023 5:18:37 PM (16 months ago)

Author:

vboxsync

Message:

Frontends/VBoxManage,Main/VirtualBox: Change the newly added IVirtualBox
method getGuestOSFamilies() to be an attribute instead as there are no
"in" arguments passed to this function. bugref:5936

Location:

trunk/src/VBox

Files:

• Frontends/VBoxManage/VBoxManageList.cpp (modified) (1 diff)
• Main/idl/VirtualBox.xidl (modified) (2 diffs)
• Main/include/VirtualBoxImpl.h (modified) (2 diffs)
• Main/src-server/VirtualBoxImpl.cpp (modified) (2 diffs)

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

@@ -2192 +2192 @@
         {
             com::SafeArray<BSTR> GuestOSFamilies;
-            CHECK_ERROR(pVirtualBox, GetGuestOSFamilies(ComSafeArrayAsOutParam(GuestOSFamilies)));
+            CHECK_ERROR(pVirtualBox, COMGETTER(GuestOSFamilies)(ComSafeArrayAsOutParam(GuestOSFamilies)));
             if (SUCCEEDED(hrc))
             {

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

@@ -2869 +2869 @@
     <attribute name="progressOperations" type="IProgress" readonly="yes" safearray="yes"/>
 
-    <attribute name="guestOSTypes" type="IGuestOSType" readonly="yes" safearray="yes"/>
+    <attribute name="guestOSTypes" type="IGuestOSType" readonly="yes" safearray="yes">
+      <desc>
+        Array of guest OS type objects known to this VirtualBox installation.
+      </desc>
+    </attribute>
+
+    <attribute name="guestOSFamilies" type="wstring" readonly="yes" safearray="yes">
+      <desc>
+        Array of guest OS family identifiers known to this VirtualBox installation.
+
+        The guest OS family identifier corrresponds to the <link to="IGuestOSType::familyId"/>
+        attribute.
+      </desc>
+    </attribute>
 
     <attribute name="sharedFolders" type="ISharedFolder" readonly="yes" safearray="yes">
@@ -3495 +3508 @@
       <param name="type" type="IGuestOSType" dir="return">
         <desc>Guest OS type object.</desc>
-      </param>
-    </method>
-
-    <method name="getGuestOSFamilies">
-      <rest request="get" path="/server/methods/"/>
-      <desc>
-        Returns a list of all known guest OS family IDs.
-
-        The <link to="IVirtualBox::guestOSTypes"/> collection contains all
-        available guest OS type objects. Each object has an
-        <link to="IGuestOSType::familyId"/> attribute which contains
-        the guest OS family identifier string that this object describes.
-
-      </desc>
-      <param name="guestOSFamilies" type="wstring" safearray="yes" dir="return">
-        <desc>Array of all known guest OS family IDs.</desc>
       </param>
     </method>

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

@@ -346 +346 @@
     HRESULT getFloppyImages(std::vector<ComPtr<IMedium> > &aFloppyImages);
     HRESULT getProgressOperations(std::vector<ComPtr<IProgress> > &aProgressOperations);
+    HRESULT getGuestOSFamilies(std::vector<com::Utf8Str> &aOSFamilies);
     HRESULT getGuestOSTypes(std::vector<ComPtr<IGuestOSType> > &aGuestOSTypes);
     HRESULT getSharedFolders(std::vector<ComPtr<ISharedFolder> > &aSharedFolders);
@@ -399 +400 @@
     HRESULT getGuestOSType(const com::Utf8Str &aId,
                            ComPtr<IGuestOSType> &aType);
-    HRESULT getGuestOSFamilies(std::vector<com::Utf8Str> &aOSFamilies);
     HRESULT getGuestOSVariantsByFamilyId(const Utf8Str &strOSFamily,
                                          std::vector<com::Utf8Str> &aOSVariants);

trunk/src/VBox/Main/src-server/VirtualBoxImpl.cpp

@@ -1947 +1947 @@
     return S_OK;
 }
+
+/**
+ * Walk the list of GuestOSType objects and return a list of all known guest
+ * OS families.
+ *
+ * @param aOSFamilies    Where to store the list of guest OS families.
+ *
+ * @note Locks the guest OS types list for reading.
+ */
+HRESULT VirtualBox::getGuestOSFamilies(std::vector<com::Utf8Str> &aOSFamilies)
+{
+    std::list<com::Utf8Str> allOSFamilies;
+
+    AutoReadLock alock(m->allGuestOSTypes.getLockHandle() COMMA_LOCKVAL_SRC_POS);
+
+    for (GuestOSTypesOList::const_iterator it = m->allGuestOSTypes.begin();
+         it != m->allGuestOSTypes.end(); ++it)
+    {
+        const Utf8Str &familyId = (*it)->i_familyId();
+        AssertMsg(!familyId.isEmpty(), ("familfyId must not be NULL"));
+        allOSFamilies.push_back(familyId);
+    }
+
+    /* throw out any duplicates */
+    allOSFamilies.sort();
+    allOSFamilies.unique();
+
+    aOSFamilies.resize(allOSFamilies.size());
+    size_t i = 0;
+    for (std::list<com::Utf8Str>::const_iterator it = allOSFamilies.begin();
+         it != allOSFamilies.end(); ++it, ++i)
+        aOSFamilies[i] = (*it);
+
+    return S_OK;
+}
+
 // Wrapped IVirtualBox methods
 /////////////////////////////////////////////////////////////////////////////
@@ -4431 +4467 @@
 
 /**
- * Walk the list of GuestOSType objects and return a list of all known guest
- * OS families.
- *
- * @param aOSFamilies    Where to store the list of guest OS families.
- *
- * @note Locks the guest OS types list for reading.
- */
-HRESULT VirtualBox::getGuestOSFamilies(std::vector<com::Utf8Str> &aOSFamilies)
-{
-    std::list<com::Utf8Str> allOSFamilies;
-
-    AutoReadLock alock(m->allGuestOSTypes.getLockHandle() COMMA_LOCKVAL_SRC_POS);
-
-    for (GuestOSTypesOList::const_iterator it = m->allGuestOSTypes.begin();
-         it != m->allGuestOSTypes.end(); ++it)
-    {
-        const Utf8Str &familyId = (*it)->i_familyId();
-        AssertMsg(!familyId.isEmpty(), ("familfyId must not be NULL"));
-        allOSFamilies.push_back(familyId);
-    }
-
-    /* throw out any duplicates */
-    allOSFamilies.sort();
-    allOSFamilies.unique();
-
-    aOSFamilies.resize(allOSFamilies.size());
-    size_t i = 0;
-    for (std::list<com::Utf8Str>::const_iterator it = allOSFamilies.begin();
-         it != allOSFamilies.end(); ++it, ++i)
-        aOSFamilies[i] = (*it);
-
-    return S_OK;
-}
-
-/**
  * Walk the list of GuestOSType objects and return a list of guest OS
  * variants which correspond to the supplied guest OS family ID.