Changeset 101593 in vbox for trunk/src/VBox/Main/src-server

Timestamp:

Oct 25, 2023 3:37:09 PM (16 months ago)

Author:

vboxsync

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

159677

Message:

doc/manual,Frontends/VBoxManage,Main/{Global,GuestOSType,VirtualBox.xidl}:
Revisit the OS guest OS changes which added a new 'variant' field to the
Global::sOSTypes[] table along with a new VBoxManage subcommand and
IVirtualBox methods for accessing the guest OS variant information
(r159137). After discussion with the documentation team the identifier
'variant' is being changed to the clearer 'subtype' which also doesn't
overlap with the 'variant' terminology used with medium management
(IMedium::variant(), the MediumVariant enum, etc.). bugref:5936

Location:

trunk/src/VBox/Main/src-server

Files:

• GuestOSTypeImpl.cpp (modified) (2 diffs)
• VirtualBoxImpl.cpp (modified) (4 diffs)

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

@@ -100 +100 @@
     unconst(mFamilyID)                  = ostype.familyId;
     unconst(mFamilyDescription)         = ostype.familyDescription;
-    unconst(mOSVariant)                 = ostype.variant;
+    unconst(mOSSubtype)                 = ostype.subtype;
     unconst(mID)                        = ostype.id;
     unconst(mDescription)               = ostype.description;
@@ -159 +159 @@
 
 
-HRESULT GuestOSType::getVariant(com::Utf8Str &aVariant)
-{
-    /* mOSVariant is constant during life time, no need to lock */
-    aVariant = mOSVariant;
+HRESULT GuestOSType::getSubtype(com::Utf8Str &aSubtype)
+{
+    /* mOSSubtype is constant during life time, no need to lock */
+    aSubtype = mOSSubtype;
 
     return S_OK;

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

@@ -4518 +4518 @@
 /**
  * Walk the list of GuestOSType objects and return a list of guest OS
- * variants which correspond to the supplied guest OS family ID.
+ * subtypes which correspond to the supplied guest OS family ID.
  *
  * @param strOSFamily    Guest OS family ID.
- * @param aOSVariants    Where to store the list of guest OS variants.
+ * @param aOSSubtypes    Where to store the list of guest OS subtypes.
  *
  * @note Locks the guest OS types list for reading.
  */
-HRESULT VirtualBox::getGuestOSVariantsByFamilyId(const Utf8Str &strOSFamily,
-                                                 std::vector<com::Utf8Str> &aOSVariants)
-{
-    std::list<com::Utf8Str> allOSVariants;
+HRESULT VirtualBox::getGuestOSSubtypesByFamilyId(const Utf8Str &strOSFamily,
+                                                 std::vector<com::Utf8Str> &aOSSubtypes)
+{
+    std::list<com::Utf8Str> allOSSubtypes;
 
     AutoReadLock alock(m->allGuestOSTypes.getLockHandle() COMMA_LOCKVAL_SRC_POS);
@@ -4556 +4556 @@
         if (familyId.compare(strOSFamily, Utf8Str::CaseInsensitive) == 0)
         {
-            const Utf8Str &strOSVariant = (*it)->i_variant();
-            if (!strOSVariant.isEmpty())
-                allOSVariants.push_back(strOSVariant);
+            const Utf8Str &strOSSubtype = (*it)->i_subtype();
+            if (!strOSSubtype.isEmpty())
+                allOSSubtypes.push_back(strOSSubtype);
         }
     }
 
     /* throw out any duplicates */
-    allOSVariants.sort();
-    allOSVariants.unique();
-
-    aOSVariants.resize(allOSVariants.size());
+    allOSSubtypes.sort();
+    allOSSubtypes.unique();
+
+    aOSSubtypes.resize(allOSSubtypes.size());
     size_t i = 0;
-    for (std::list<com::Utf8Str>::const_iterator it = allOSVariants.begin();
-         it != allOSVariants.end(); ++it, ++i)
-        aOSVariants[i] = (*it);
+    for (std::list<com::Utf8Str>::const_iterator it = allOSSubtypes.begin();
+         it != allOSSubtypes.end(); ++it, ++i)
+        aOSSubtypes[i] = (*it);
 
     return S_OK;
@@ -4577 +4577 @@
 /**
  * Walk the list of GuestOSType objects and return a list of guest OS
- * descriptions which correspond to the supplied guest OS variant.
- *
- * @param strOSVariant     Guest OS variant.
+ * descriptions which correspond to the supplied guest OS subtype.
+ *
+ * @param strOSSubtype     Guest OS subtype.
  * @param aGuestOSDescs    Where to store the list of guest OS descriptions..
  *
  * @note Locks the guest OS types list for reading.
  */
-HRESULT VirtualBox::getGuestOSDescsByVariant(const Utf8Str &strOSVariant,
+HRESULT VirtualBox::getGuestOSDescsBySubtype(const Utf8Str &strOSSubtype,
                                              std::vector<com::Utf8Str> &aGuestOSDescs)
 {
@@ -4591 +4591 @@
     AutoReadLock alock(m->allGuestOSTypes.getLockHandle() COMMA_LOCKVAL_SRC_POS);
 
-    bool fFoundGuestOSVariant = false;
+    bool fFoundGuestOSSubtype = false;
     for (GuestOSTypesOList::const_iterator it = m->allGuestOSTypes.begin();
          it != m->allGuestOSTypes.end(); ++it)
     {
-        const Utf8Str &guestOSVariant = (*it)->i_variant();
-        /* Only some guest OS types have a populated variant value. */
-        if (guestOSVariant.isNotEmpty() &&
-            guestOSVariant.compare(strOSVariant, Utf8Str::CaseInsensitive) == 0)
-        {
-            fFoundGuestOSVariant = true;
+        const Utf8Str &guestOSSubtype = (*it)->i_subtype();
+        /* Only some guest OS types have a populated subtype value. */
+        if (guestOSSubtype.isNotEmpty() &&
+            guestOSSubtype.compare(strOSSubtype, Utf8Str::CaseInsensitive) == 0)
+        {
+            fFoundGuestOSSubtype = true;
             break;
         }
     }
 
-    if (!fFoundGuestOSVariant)
+    if (!fFoundGuestOSSubtype)
        return setError(VBOX_E_OBJECT_NOT_FOUND,
-                       tr("'%s' is not a valid guest OS variant."), strOSVariant.c_str());
+                       tr("'%s' is not a valid guest OS subtype."), strOSSubtype.c_str());
 
     for (GuestOSTypesOList::const_iterator it = m->allGuestOSTypes.begin();
          it != m->allGuestOSTypes.end(); ++it)
     {
-        const Utf8Str &guestOSVariant = (*it)->i_variant();
-        /* Only some guest OS types have a populated variant value. */
-        if (guestOSVariant.isNotEmpty() &&
-            guestOSVariant.compare(strOSVariant, Utf8Str::CaseInsensitive) == 0)
+        const Utf8Str &guestOSSubtype = (*it)->i_subtype();
+        /* Only some guest OS types have a populated subtype value. */
+        if (guestOSSubtype.isNotEmpty() &&
+            guestOSSubtype.compare(strOSSubtype, Utf8Str::CaseInsensitive) == 0)
         {
             const Utf8Str &strOSDesc = (*it)->i_description();