Changeset 16325 in vbox for trunk/src/VBox

Timestamp:

Jan 28, 2009 6:24:17 PM (16 years ago)

Author:

vboxsync

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

42160

Message:

OVF: make com::xml and IAppliance use Utf8Str instead of std::string

Location:

trunk/src/VBox/Main

Files:

• ApplianceImpl.cpp (modified) (31 diffs)
• include/ApplianceImpl.h (modified) (4 diffs)
• xml/xml.cpp (modified) (7 diffs)

trunk/src/VBox/Main/ApplianceImpl.cpp

@@ -44 +44 @@
 struct DiskImage
 {
-    string strDiskId;               // value from DiskSection/Disk/@diskId
+    Utf8Str strDiskId;              // value from DiskSection/Disk/@diskId
     int64_t iCapacity;              // value from DiskSection/Disk/@capacity;
                                     // (maximum size for dynamic images, I guess; we always translate this to bytes)
@@ -50 +50 @@
                                     // (actual used size of disk, always in bytes; can be an estimate of used disk
                                     // space, but cannot be larger than iCapacity)
-    string strFormat;               // value from DiskSection/Disk/@format
+    Utf8Str strFormat;              // value from DiskSection/Disk/@format
                 // typically http://www.vmware.com/specifications/vmdk.html#sparse
 
     // fields from /References/File; the spec says the file reference from disk can be empty,
     // so in that case, strFilename will be empty, then a new disk should be created
-    string strHref;                 // value from /References/File/@href (filename); if empty, then the remaining fields are ignored
+    Utf8Str strHref;                // value from /References/File/@href (filename); if empty, then the remaining fields are ignored
     int64_t iSize;                  // value from /References/File/@size (optional according to spec; then we set -1 here)
     int64_t iChunkSize;             // value from /References/File/@chunkSize (optional, unsupported)
-    string strCompression;          // value from /References/File/@compression (optional, can be "gzip" according to spec)
+    Utf8Str strCompression;         // value from /References/File/@compression (optional, can be "gzip" according to spec)
 };
 
 struct Network
 {
-    string strNetworkName;          // value from NetworkSection/Network/@name
+    Utf8Str strNetworkName;         // value from NetworkSection/Network/@name
             // unfortunately the OVF spec is unspecific about how networks should be specified further
 };
@@ -69 +69 @@
 struct VirtualHardwareItem
 {
-    string strDescription;
-    string strCaption;
-    string strElementName;
+    Utf8Str strDescription;
+    Utf8Str strCaption;
+    Utf8Str strElementName;
 
     uint32_t ulInstanceID;
@@ -77 +77 @@
 
     OVFResourceType_T resourceType;
-    string strOtherResourceType;
-    string strResourceSubType;
-
-    string strHostResource;             // "Abstractly specifies how a device shall connect to a resource on the deployment platform.
+    Utf8Str strOtherResourceType;
+    Utf8Str strResourceSubType;
+
+    Utf8Str strHostResource;            // "Abstractly specifies how a device shall connect to a resource on the deployment platform.
                                         // Not all devices need a backing." Used with disk items, for which this references a virtual
                                         // disk from the Disks section.
     bool fAutomaticAllocation;
     bool fAutomaticDeallocation;
-    string strConnection;               // "All Ethernet adapters that specify the same abstract network connection name within an OVF
+    Utf8Str strConnection;              // "All Ethernet adapters that specify the same abstract network connection name within an OVF
                                         // package shall be deployed on the same network. The abstract network connection name shall be
                                         // listed in the NetworkSection at the outermost envelope level."
-    string strAddress;                  // "Device-specific. For an Ethernet adapter, this specifies the MAC address."
-    string strAddressOnParent;          // "For a device, this specifies its location on the controller."
-    string strAllocationUnits;          // "Specifies the units of allocation used. For example, “byte * 2^20”."
+    Utf8Str strAddress;                 // "Device-specific. For an Ethernet adapter, this specifies the MAC address."
+    Utf8Str strAddressOnParent;         // "For a device, this specifies its location on the controller."
+    Utf8Str strAllocationUnits;         // "Specifies the units of allocation used. For example, “byte * 2^20”."
     uint64_t ullVirtualQuantity;        // "Specifies the quantity of resources presented. For example, “256”."
     uint64_t ullReservation;            // "Specifies the minimum quantity of resources guaranteed to be available."
@@ -96 +96 @@
     uint64_t ullWeight;                 // "Specifies a relative priority for this allocation in relation to other allocations."
 
-    string strConsumerVisibility;
-    string strMappingBehavior;
-    string strPoolID;
+    Utf8Str strConsumerVisibility;
+    Utf8Str strMappingBehavior;
+    Utf8Str strPoolID;
     uint32_t ulBusNumber;               // seen with IDE controllers, but not listed in OVF spec
 
@@ -108 +108 @@
 };
 
-typedef map<string, DiskImage> DiskImagesMap;
-typedef map<string, Network> NetworksMap;
+typedef map<Utf8Str, DiskImage> DiskImagesMap;
+typedef map<Utf8Str, Network> NetworksMap;
 
 struct VirtualSystem;
@@ -134 +134 @@
     uint32_t             idController;           // instance ID (Item/InstanceId); this gets referenced from HardDisk
     ControllerSystemType controllerSystem;       // one of IDE, SATA, SCSI
-    string               strControllerType;      // controllertype (Item/ResourceSubType); e.g. "LsiLogic"; can be empty (esp. for IDE)
-    string               strAddress;             // for IDE
+    Utf8Str              strControllerType;      // controllertype (Item/ResourceSubType); e.g. "LsiLogic"; can be empty (esp. for IDE)
+    Utf8Str              strAddress;             // for IDE
     uint32_t             ulBusNumber;            // for IDE
 
@@ -151 +151 @@
     uint32_t            idController;           // SCSI (or IDE) controller this disk is connected to;
                                                 // points into VirtualSystem.mapControllers
-    string              strDiskId;              // if the hard disk has an ovf:/disk/<id> reference,
+    Utf8Str             strDiskId;              // if the hard disk has an ovf:/disk/<id> reference,
                                                 // this receives the <id> component; points to one of the
                                                 // references in Appliance::Data.mapDisks
 };
 
-typedef map<string, VirtualDisk> VirtualDisksMap;
+typedef map<Utf8Str, VirtualDisk> VirtualDisksMap;
 
 struct VirtualSystem
 {
-    string              strName;                // copy of VirtualSystem/@id
+    Utf8Str             strName;                // copy of VirtualSystem/@id
 
     CIMOSType_T         cimos;
-    string              strVirtualSystemType;   // generic hardware description; OVF says this can be something like "vmx-4" or "xen";
+    Utf8Str             strVirtualSystemType;   // generic hardware description; OVF says this can be something like "vmx-4" or "xen";
                                                 // VMware Workstation 6.5 is "vmx-07"
 
@@ -171 +171 @@
     uint16_t            cCPUs;                  // no. of CPUs, copied from llHardwareItems; default = 1
 
-    list<string>        llNetworkNames;
+    list<Utf8Str>       llNetworkNames;
             // list of strings referring to network names
             // (one for each VirtualSystem/Item[@ResourceType=10]/Connection element)
@@ -186 +186 @@
     bool                fHasUsbController;      // true if there's a USB controller item in mapHardwareItems
 
-    string              strSoundCardType;       // if not empty, then the system wants a soundcard; this then specifies the hardware;
+    Utf8Str             strSoundCardType;       // if not empty, then the system wants a soundcard; this then specifies the hardware;
                                                 // VMware Workstation 6.5 uses "ensoniq1371" for example
 
-    string              strLicenceInfo;         // license info if any; receives contents of VirtualSystem/EulaSection/Info
-    string              strLicenceText;         // license info if any; receives contents of VirtualSystem/EulaSection/License
+    Utf8Str             strLicenceInfo;         // license info if any; receives contents of VirtualSystem/EulaSection/Info
+    Utf8Str             strLicenceText;         // license info if any; receives contents of VirtualSystem/EulaSection/License
 
     VirtualSystem()
@@ -201 +201 @@
 ////////////////////////////////////////////////////////////////////////////////
 
-template <class T> inline std::string toString(const T& val)
-{
+template <class T>
+inline
+com::Utf8Str toString(const T& val)
+{
+    // @todo optimize
     std::ostringstream ss;
     ss << val;
-    return ss.str();
+    return Utf8Str(ss.str().c_str());
 }
 
@@ -357 +360 @@
                 d.iPopulatedSize = -1;
 
-            string strFileRef;
+            Utf8Str strFileRef;
             if (pelmDisk->getAttributeValue("fileRef", strFileRef)) // optional
             {
@@ -1005 +1008 @@
         ComAssertComRCThrowRC(rc);
 
-        string osTypeVBox = SchemaDefs_OSTypeId_Other;
+        Utf8Str osTypeVBox = SchemaDefs_OSTypeId_Other;
         /* Guest OS type */
         switch (vs.cimos)
@@ -1194 +1197 @@
         /* If the there isn't any name specified create a default one out of
          * the OS type */
-        string nameVBox = vs.strName;
+        Utf8Str nameVBox = vs.strName;
         if (nameVBox == "")
             nameVBox = osTypeVBox;
@@ -1202 +1205 @@
         /* Now that we know the base system get our internal defaults based on that. */
         ComPtr<IGuestOSType> osType;
-        rc = mVirtualBox->GetGuestOSType(Bstr(Utf8Str(osTypeVBox.c_str())), osType.asOutParam());
+        rc = mVirtualBox->GetGuestOSType(Bstr(osTypeVBox), osType.asOutParam());
         ComAssertComRCThrowRC(rc);
 
@@ -1262 +1265 @@
                         // @todo: figure out the SCSI types
 # ifdef VBOX_WITH_LSILOGIC
-                        string hdcController = "LsiLogic";
+                        Utf8Str hdcController = "LsiLogic";
 # elif VBOX_WITH_BUSLOGIC
-                        string hdcController = "BusLogic";
+                        Utf8Str hdcController = "BusLogic";
 # else /* !VBOX_WITH_BUSLOGIC */
-                        string hdcController;
+                        Utf8Str hdcController;
 # endif
 # ifdef VBOX_WITH_LSILOGIC
@@ -1320 +1323 @@
                 {
                     /* Construct the path */
-                    string path = Utf8StrFmt("%ls%c%s", defaultHardDiskLocation, RTPATH_DELIMITER, di.strHref.c_str()).raw();
+                    Utf8Str path = Utf8StrFmt("%ls%c%s", defaultHardDiskLocation, RTPATH_DELIMITER, di.strHref.c_str());
                     /* Make the path unique to the VBox installation */
                     searchUniqueDiskImageFilePath(path);
@@ -1336 +1339 @@
             rc = osType->COMGETTER(AdapterType)(&nwAdapterVBox);
             ComAssertComRCThrowRC(rc);
-            list<string>::const_iterator nwIt;
+            list<Utf8Str>::const_iterator nwIt;
             /* Iterate through all abstract networks. We support 8 network
              * adapters at the maximum. (@todo: warn if it are more!) */
@@ -1344 +1347 @@
                  ++nwIt, ++a)
             {
-                // string nwController = *nwIt; // @todo: not used yet
+                // Utf8Str nwController = *nwIt; // @todo: not used yet
                 vsd->addEntry(VirtualSystemDescriptionType_NetworkAdapter, "", "", toString<ULONG>(nwAdapterVBox));
             }
@@ -1377 +1380 @@
         std::list<VirtualSystemDescriptionEntry*> vsdeOS = vsd->findByType(VirtualSystemDescriptionType_OS);
         Assert(vsdeOS.size() == 1);
-        string osTypeVBox = vsdeOS.front()->strFinalValue;
+        const Utf8Str &osTypeVBox = vsdeOS.front()->strFinalValue;
 
         /* Now that we know the base system get our internal defaults based on that. */
         ComPtr<IGuestOSType> osType;
-        rc = mVirtualBox->GetGuestOSType(Bstr(Utf8Str(osTypeVBox.c_str())), osType.asOutParam());
+        rc = mVirtualBox->GetGuestOSType(Bstr(osTypeVBox), osType.asOutParam());
         ComAssertComRCThrowRC(rc);
 
@@ -1388 +1391 @@
         std::list<VirtualSystemDescriptionEntry*> vsdeName = vsd->findByType(VirtualSystemDescriptionType_Name);
         Assert(vsdeName.size() == 1);
-        string nameVBox = vsdeName.front()->strFinalValue;
+        const Utf8Str &nameVBox = vsdeName.front()->strFinalValue;
         ComPtr<IMachine> newMachine;
         rc = mVirtualBox->CreateMachine(Bstr(nameVBox.c_str()), Bstr(osTypeVBox.c_str()),
@@ -1403 +1406 @@
         std::list<VirtualSystemDescriptionEntry*> vsdeRAM = vsd->findByType(VirtualSystemDescriptionType_Memory);
         Assert(vsdeRAM.size() == 1);
-        string memoryVBox = vsdeRAM.front()->strFinalValue;
+        const Utf8Str &memoryVBox = vsdeRAM.front()->strFinalValue;
         uint64_t tt = RTStrToUInt64(memoryVBox.c_str()) / _1M;
 
@@ -1440 +1443 @@
                  ++nwIt, ++a)
             {
-                string nwTypeVBox = (*nwIt)->strFinalValue;
+                const Utf8Str &nwTypeVBox = (*nwIt)->strFinalValue;
                 uint32_t tt1 = RTStrToUInt32(nwTypeVBox.c_str());
                 ComPtr<INetworkAdapter> nwVBox;
@@ -1474 +1477 @@
         if (vsdeHDCSATA.size() > 0)
         {
-            string hdcVBox = vsdeHDCIDE.front()->strFinalValue;
-            if (!RTStrCmp(hdcVBox.c_str(), "AHCI"))
+            const Utf8Str &hdcVBox = vsdeHDCIDE.front()->strFinalValue;
+            if (hdcVBox == "AHCI")
             {
                 /* For now we have just to enable the AHCI controller. */
@@ -1541 +1544 @@
 //                    continue;
                 }
-                const string &strRef = (*hdIt)->strRef;
+                const Utf8Str &strRef = (*hdIt)->strRef;
                 /* Get the associated disk image */
                 if (m->mapDisks.find(strRef) == m->mapDisks.end())
@@ -1547 +1550 @@
                     /* @todo: error: entry doesn't exists */
                 }
-                DiskImage di = m->mapDisks [strRef];
+                DiskImage di = m->mapDisks[strRef];
                 /* Construct the source file path */
                 char *srcFilePath;
@@ -1615 +1618 @@
 }
 
-HRESULT Appliance::searchUniqueVMName(std::string& aName) const
+HRESULT Appliance::searchUniqueVMName(Utf8Str& aName) const
 {
     IMachine *machine = NULL;
@@ -1633 +1636 @@
 }
 
-HRESULT Appliance::searchUniqueDiskImageFilePath(std::string& aName) const
+HRESULT Appliance::searchUniqueDiskImageFilePath(Utf8Str& aName) const
 {
     IHardDisk2 *harddisk = NULL;
@@ -1721 +1724 @@
          ++it, ++i)
     {
-        VirtualSystemDescriptionEntry vsde = (*it);
+        const VirtualSystemDescriptionEntry &vsde = (*it);
         /* Types */
         sfaTypes [i] = vsde.type;
         /* Original value */
-        Bstr bstr = Utf8Str(vsde.strOriginalValue.c_str());
-        bstr.cloneTo(&sfaOrigValues [i]);
+        Bstr bstr = vsde.strOriginalValue;
+        bstr.cloneTo(&sfaOrigValues[i]);
         /* Auto value */
-        bstr = Utf8Str(vsde.strAutoValue.c_str());
-        bstr.cloneTo(&sfaAutoValues [i]);
+        bstr = vsde.strAutoValue;
+        bstr.cloneTo(&sfaAutoValues[i]);
         /* Configuration */
-        bstr = Utf8Str(vsde.strConfiguration.c_str());
-        bstr.cloneTo(&sfaConfigurations [i]);
+        bstr = vsde.strConfiguration;
+        bstr.cloneTo(&sfaConfigurations[i]);
     }
 
@@ -1763 +1766 @@
     {
         VirtualSystemDescriptionEntry vsde = (*it);
-        vsde.strFinalValue = Utf8Str(values[i]).raw();
+        vsde.strFinalValue = values[i];
     }
 
@@ -1770 +1773 @@
 
 void VirtualSystemDescription::addEntry(VirtualSystemDescriptionType_T aType,
-                                        const std::string &aRef,
-                                        const std::string &aOrigValue,
-                                        const std::string &aAutoValue,
-                                        const std::string &aConfig /* = "" */)
+                                        const Utf8Str &aRef,
+                                        const Utf8Str &aOrigValue,
+                                        const Utf8Str &aAutoValue,
+                                        const Utf8Str &aConfig /* = "" */)
 {
     VirtualSystemDescriptionEntry vsde;

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

@@ -27 +27 @@
 #include "VirtualBoxBase.h"
 
-#include <string>
+// #include <string>
 
 class VirtualBox;
@@ -90 +90 @@
     HRESULT HandleVirtualSystemContent(const char *pcszPath, const xml::Node *pContentElem);
 
-    HRESULT searchUniqueVMName (std::string& aName) const;
-    HRESULT searchUniqueDiskImageFilePath(std::string& aName) const;
+    HRESULT searchUniqueVMName(Utf8Str& aName) const;
+    HRESULT searchUniqueDiskImageFilePath(Utf8Str& aName) const;
 };
 
@@ -97 +97 @@
 {
     VirtualSystemDescriptionType_T type; /* Of which type is this value */
-    std::string strRef; /* Reference value to the internal implementation */
-    std::string strOriginalValue; /* The original OVF value */
-    std::string strAutoValue; /* The value which VBox suggest */
-    std::string strFinalValue; /* The value the user select */
-    std::string strConfiguration; /* Additional configuration data for this type */
+    Utf8Str strRef; /* Reference value to the internal implementation */
+    Utf8Str strOriginalValue; /* The original OVF value */
+    Utf8Str strAutoValue; /* The value which VBox suggest */
+    Utf8Str strFinalValue; /* The value the user select */
+    Utf8Str strConfiguration; /* Additional configuration data for this type */
 };
 
@@ -151 +151 @@
 private:
     void addEntry(VirtualSystemDescriptionType_T aType,
-                  const std::string &aRef,
-                  const std::string &aOrigValue,
-                  const std::string &aAutoValue,
-                  const std::string &aConfig = "");
+                  const Utf8Str &aRef,
+                  const Utf8Str &aOrigValue,
+                  const Utf8Str &aAutoValue,
+                  const Utf8Str &aConfig = "");
 
     std::list<VirtualSystemDescriptionEntry*> findByType(VirtualSystemDescriptionType_T aType);

trunk/src/VBox/Main/xml/xml.cpp

@@ -21 +21 @@
 #include "Logging.h"
 
+#include <boost/shared_ptr.hpp>
+
 #include <iprt/err.h>
 #include <iprt/file.h>
@@ -35 +37 @@
 #include <libxml/xmlschemas.h>
 
-#include <string>
 #include <list>
 #include <map>
-
-#include "boost/shared_ptr.hpp"
 
 #include "VBox/xml.h"
@@ -685 +684 @@
  * @return TRUE if attribute was found and str was thus updated.
  */
-bool Node::getAttributeValue(const char *pcszMatch, std::string &str) const
+bool Node::getAttributeValue(const char *pcszMatch, com::Utf8Str &str) const
 {
     const Node* pAttr;
@@ -709 +708 @@
 bool Node::getAttributeValue(const char *pcszMatch, int64_t &i) const
 {
-    std::string str;
+    com::Utf8Str str;
     if (    (getAttributeValue(pcszMatch, str))
          && (VINF_SUCCESS == RTStrToInt64Ex(str.c_str(), NULL, 10, &i))
@@ -730 +729 @@
 bool Node::getAttributeValue(const char *pcszMatch, uint64_t &i) const
 {
-    std::string str;
+    com::Utf8Str str;
     if (    (getAttributeValue(pcszMatch, str))
          && (VINF_SUCCESS == RTStrToUInt64Ex(str.c_str(), NULL, 10, &i))
@@ -907 +906 @@
 {
     xmlParserCtxtPtr ctxt;
-    std::string strXmlFilename;
+    com::Utf8Str strXmlFilename;
 
     Data()
@@ -935 +934 @@
 {
     File file;
-    std::string error;
+    com::Utf8Str error;
 
     ReadContext(const char *pcszFilename)