Changeset 74040 in vbox for trunk/include/iprt

Timestamp:

Sep 3, 2018 12:25:52 PM (6 years ago)

Author:

vboxsync

Message:

IPRT/rest: Hacked up string <-> enum translation. bugref:9167

File:

• trunk/include/iprt/cpp/restbase.h (modified) (10 diffs)

trunk/include/iprt/cpp/restbase.h

@@ -369 +369 @@
         kTypeClass_Object,              /**< Object (any kind of data model object). */
         kTypeClass_Array,               /**< Array (containing any kind of object). */
-        kTypeClass_StringMap            /**< String map (containing any kind of object). */
+        kTypeClass_StringMap,           /**< String map (containing any kind of object). */
+        kTypeClass_StringEnum           /**< String enum. */
     } kTypeClass;
 
@@ -389 +390 @@
     /** Pointer to factory method. */
     typedef FNCREATEINSTANCE *PFNCREATEINSTANCE;
-
 
 protected:
@@ -409 +409 @@
 {
 public:
-    /** Default destructor. */
+    /** Default constructor. */
     RTCRestBool();
     /** Copy constructor. */
@@ -449 +449 @@
 {
 public:
-    /** Default destructor. */
+    /** Default constructor. */
     RTCRestInt64();
     /** Copy constructor. */
@@ -489 +489 @@
 {
 public:
-    /** Default destructor. */
+    /** Default constructor. */
     RTCRestInt32();
     /** Copy constructor. */
@@ -529 +529 @@
 {
 public:
-    /** Default destructor. */
+    /** Default constructor. */
     RTCRestInt16();
     /** Copy constructor. */
@@ -569 +569 @@
 {
 public:
-    /** Default destructor. */
+    /** Default constructor. */
     RTCRestDouble();
     /** Copy constructor. */
@@ -609 +609 @@
 {
 public:
-    /** Default destructor. */
+    /** Default constructor. */
     RTCRestString();
     /** Destructor. */
@@ -644 +644 @@
 
 /**
+ * String enum base class.
+ */
+class RT_DECL_CLASS RTCRestStringEnumBase : public RTCRestObjectBase
+{
+public:
+    /** Enum map entry. */
+    typedef struct ENUMMAPENTRY
+    {
+        const char *pszName;
+        uint32_t    cchName;
+        int32_t     iValue;
+    } ENUMMAPENTRY;
+
+    /** Default constructor. */
+    RTCRestStringEnumBase();
+    /** Destructor. */
+    virtual ~RTCRestStringEnumBase();
+
+    /** Copy constructor. */
+    RTCRestStringEnumBase(RTCRestStringEnumBase const &a_rThat);
+    /** Copy assignment operator. */
+    RTCRestStringEnumBase &operator=(RTCRestStringEnumBase const &a_rThat);
+
+    /** Safe copy assignment method. */
+    int assignCopy(RTCRestStringEnumBase const &a_rThat);
+    /** Safe copy assignment method. */
+    int assignCopy(RTCString const &a_rThat)    { return setByString(a_rThat); }
+    /** Safe copy assignment method. */
+    int assignCopy(const char *a_pszThat)       { return setByString(a_pszThat); }
+
+    /* Overridden methods: */
+    virtual int resetToDefault() RT_OVERRIDE;
+    virtual RTCRestOutputBase &serializeAsJson(RTCRestOutputBase &a_rDst) const RT_OVERRIDE;
+    virtual int deserializeFromJson(RTCRestJsonCursor const &a_rCursor) RT_OVERRIDE;
+    virtual int toString(RTCString *a_pDst, uint32_t a_fFlags = kCollectionFormat_Unspecified) const RT_OVERRIDE;
+    virtual int fromString(RTCString const &a_rValue, const char *a_pszName, PRTERRINFO a_pErrInfo = NULL,
+                           uint32_t a_fFlags = kCollectionFormat_Unspecified) RT_OVERRIDE;
+    virtual kTypeClass typeClass(void) const RT_OVERRIDE;
+
+    /**
+     * Sets the value given a C-string value.
+     *
+     * @retval VINF_SUCCESS on success.
+     * @retval VWRN_NOT_FOUND if not mappable to enum value.
+     * @retval VERR_NO_STR_MEMORY if not mappable and we're out of memory.
+     * @param   a_pszValue      The string value.
+     * @param   a_cchValue      The string value length.  Optional.
+     */
+    int setByString(const char *a_pszValue, size_t a_cchValue = RTSTR_MAX);
+
+    /**
+     * Sets the value given a string value.
+     *
+     * @retval VINF_SUCCESS on success.
+     * @retval VWRN_NOT_FOUND if not mappable to enum value.
+     * @retval VERR_NO_STR_MEMORY if not mappable and we're out of memory.
+     * @param   a_pszValue      The string value.
+     */
+    int setByString(RTCString const &a_rValue);
+
+    /**
+     * Gets the string value.
+     */
+    const char *getString() const;
+
+    /** Maps the given string value to an enum. */
+    int stringToEnum(const char *a_pszValue, size_t a_cchValue = RTSTR_MAX);
+    /** Maps the given string value to an enum. */
+    int stringToEnum(RTCString const &a_rStrValue);
+    /** Maps the given string value to an enum. */
+    const char *enumToString(int a_iEnumValue, size_t *a_pcchString);
+
+
+protected:
+    /** The enum value. */
+    int                 m_iEnumValue;
+    /** The string value if not a match. */
+    RTCString           m_strValue;
+
+    /**
+     * Worker for setting the object to the given enum value.
+     *
+     * @retval  true on success.
+     * @retval  false if a_iEnumValue can't be translated.
+     * @param   a_iEnumValue    The enum value to set.
+     */
+    bool                setWorker(int a_iEnumValue);
+
+    /**
+     * Gets the mapping table.
+     *
+     * @returns Pointer to the translation table.
+     * @param   pcEntries   Where to return the translation table size.
+     */
+    virtual ENUMMAPENTRY const *getMappingTable(size_t *pcEntries) const = 0;
+};
+
+
+/**
  * Dynamic REST object.
  *
@@ -652 +751 @@
 {
 public:
-    /** Default destructor. */
+    /** Default constructor. */
     RTCRestObject();
     /** Destructor. */