Changeset 73895 in vbox for trunk/include/iprt/cpp

Timestamp:

Aug 26, 2018 3:47:58 PM (7 years ago)

Author:

vboxsync

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

124612

Message:

IPRT/rest: Wrap primitive types to unify serializing, deserializing, formatting, array, maps, and whatnot. bugref:9167

File:

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

trunk/include/iprt/cpp/restbase.h

@@ -126 +126 @@
     virtual ~RTCRestOutputToString();
 
-    size_t vprintf(const char *pszFormat, va_list va);
+    virtual size_t vprintf(const char *pszFormat, va_list va) RT_OVERRIDE;
 
     /**
@@ -257 +257 @@
 {
 public:
-    RTCRestObjectBase() {}
-    virtual ~RTCRestObjectBase() {}
+    RTCRestObjectBase();
+    virtual ~RTCRestObjectBase();
 
     /** @todo Add some kind of state? */
@@ -265 +265 @@
      * Resets the object to all default values.
      */
-    virtual void resetToDefaults() = 0;
+    virtual void resetToDefault() = 0;
 
     /**
@@ -283 +283 @@
     virtual int deserializeFromJson(RTCRestJsonCursor const &a_rCursor) = 0;
 
-    /** @name Helpers for deserializing primitive types and strings.
-     * @{ */
-    static int deserialize_RTCString_FromJson(RTCRestJsonCursor const &a_rCursor, RTCString *a_pDst);
-    static int deserialize_int64_t_FromJson(RTCRestJsonCursor const &a_rCursor, int64_t *a_piDst);
-    static int deserialize_int32_t_FromJson(RTCRestJsonCursor const &a_rCursor, int32_t *a_piDst);
-    static int deserialize_int16_t_FromJson(RTCRestJsonCursor const &a_rCursor, int16_t *a_piDst);
-    static int deserialize_bool_FromJson(RTCRestJsonCursor const &a_rCursor, bool *a_pfDst);
-    static int deserialize_double_FromJson(RTCRestJsonCursor const &a_rCursor, double *a_prdDst);
-    /** @} */
-
-    /** @name Helpers for serializing floating point types.
-     * @{ */
-    static RTCRestOutputBase &serialize_double_AsJson(RTCRestOutputBase &a_rDst, double const *a_prdValue);
-    /** @} */
+    /**
+     * String conversion.
+     *
+     * The default implementation of is a wrapper around serializeAsJson().
+     *
+     * @returns IPRT status code.
+     * @param   a_pDst      Pointer to the destionation string.
+     * @param   a_fFlags    For future tricks, MBZ.
+     */
+    virtual int toString(RTCString *a_pDst, uint32_t fFlags = 0);
+
+    /**
+     * String convertsion, naive variant.
+     *
+     * @returns String represenation.
+     */
+    RTCString toString();
+
+    /**
+     * Returns the object type name.
+     */
+    virtual const char *getType(void) = 0;
+};
+
+
+/**
+ * Class wrapping 'bool'.
+ */
+class RTCRestBool : public RTCRestObjectBase
+{
+public:
+    /** Default destructor. */
+    RTCRestBool();
+    /** Copy constructor. */
+    RTCRestBool(RTCRestBool const &a_rThat);
+    /** From value constructor. */
+    RTCRestBool(bool fValue);
+    /** Destructor. */
+    virtual ~RTCRestBool();
+    /** Copy assignment operator. */
+    RTCRestBool &operator=(RTCRestBool const &a_rThat);
+
+    /* Overridden methods: */
+    virtual void resetToDefault() RT_OVERRIDE;
+    virtual RTCRestOutputBase &serializeAsJson(RTCRestOutputBase &a_rDst) RT_OVERRIDE;
+    virtual int deserializeFromJson(RTCRestJsonCursor const &a_rCursor) RT_OVERRIDE;
+    virtual int toString(RTCString *a_pDst, uint32_t fFlags = 0) RT_OVERRIDE;
+    virtual const char *getType(void) RT_OVERRIDE;
+
+public:
+    /** The value. */
+    bool    m_fValue;
+};
+
+
+/**
+ * Class wrapping 'int64_t'.
+ */
+class RTCRestInt64 : public RTCRestObjectBase
+{
+public:
+    /** Default destructor. */
+    RTCRestInt64();
+    /** Copy constructor. */
+    RTCRestInt64(RTCRestInt64 const &a_rThat);
+    /** From value constructor. */
+    RTCRestInt64(int64_t iValue);
+    /** Destructor. */
+    virtual ~RTCRestInt64();
+    /** Copy assignment operator. */
+    RTCRestInt64 &operator=(RTCRestInt64 const &a_rThat);
+
+        /* Overridden methods: */
+    virtual void resetToDefault() RT_OVERRIDE;
+    virtual RTCRestOutputBase &serializeAsJson(RTCRestOutputBase &a_rDst) RT_OVERRIDE;
+    virtual int deserializeFromJson(RTCRestJsonCursor const &a_rCursor) RT_OVERRIDE;
+    virtual int toString(RTCString *a_pDst, uint32_t fFlags = 0) RT_OVERRIDE;
+    virtual const char *getType(void) RT_OVERRIDE;
+
+public:
+    /** The value. */
+    int64_t m_iValue;
+};
+
+
+/**
+ * Class wrapping 'int32_t'.
+ */
+class RTCRestInt32 : public RTCRestObjectBase
+{
+public:
+    /** Default destructor. */
+    RTCRestInt32();
+    /** Copy constructor. */
+    RTCRestInt32(RTCRestInt32 const &a_rThat);
+    /** From value constructor. */
+    RTCRestInt32(int32_t iValue);
+    /** Destructor. */
+    virtual ~RTCRestInt32();
+    /** Copy assignment operator. */
+    RTCRestInt32 &operator=(RTCRestInt32 const &a_rThat);
+
+    /* Overridden methods: */
+    virtual void resetToDefault() RT_OVERRIDE;
+    virtual RTCRestOutputBase &serializeAsJson(RTCRestOutputBase &a_rDst) RT_OVERRIDE;
+    virtual int deserializeFromJson(RTCRestJsonCursor const &a_rCursor) RT_OVERRIDE;
+    virtual int toString(RTCString *a_pDst, uint32_t fFlags = 0) RT_OVERRIDE;
+    virtual const char *getType(void) RT_OVERRIDE;
+
+public:
+    /** The value. */
+    int32_t m_iValue;
+};
+
+
+/**
+ * Class wrapping 'int16_t'.
+ */
+class RTCRestInt16 : public RTCRestObjectBase
+{
+public:
+    /** Default destructor. */
+    RTCRestInt16();
+    /** Copy constructor. */
+    RTCRestInt16(RTCRestInt16 const &a_rThat);
+    /** From value constructor. */
+    RTCRestInt16(int16_t iValue);
+    /** Destructor. */
+    virtual ~RTCRestInt16();
+    /** Copy assignment operator. */
+    RTCRestInt16 &operator=(RTCRestInt16 const &a_rThat);
+
+    /* Overridden methods: */
+    virtual void resetToDefault() RT_OVERRIDE;
+    virtual RTCRestOutputBase &serializeAsJson(RTCRestOutputBase &a_rDst) RT_OVERRIDE;
+    virtual int deserializeFromJson(RTCRestJsonCursor const &a_rCursor) RT_OVERRIDE;
+    virtual int toString(RTCString *a_pDst, uint32_t fFlags = 0) RT_OVERRIDE;
+    virtual const char *getType(void) RT_OVERRIDE;
+
+public:
+    /** The value. */
+    int16_t m_iValue;
+};
+
+
+/**
+ * Class wrapping 'double'.
+ */
+class RTCRestDouble : public RTCRestObjectBase
+{
+public:
+    /** Default destructor. */
+    RTCRestDouble();
+    /** Copy constructor. */
+    RTCRestDouble(RTCRestDouble const &a_rThat);
+    /** From value constructor. */
+    RTCRestDouble(double rdValue);
+    /** Destructor. */
+    virtual ~RTCRestDouble();
+    /** Copy assignment operator. */
+    RTCRestDouble &operator=(RTCRestDouble const &a_rThat);
+
+    /* Overridden methods: */
+    virtual void resetToDefault() RT_OVERRIDE;
+    virtual RTCRestOutputBase &serializeAsJson(RTCRestOutputBase &a_rDst) RT_OVERRIDE;
+    virtual int deserializeFromJson(RTCRestJsonCursor const &a_rCursor) RT_OVERRIDE;
+    virtual int toString(RTCString *a_pDst, uint32_t fFlags = 0) RT_OVERRIDE;
+    virtual const char *getType(void) RT_OVERRIDE;
+
+public:
+    /** The value. */
+    double m_rdValue;
+};
+
+
+/**
+ * Class wrapping 'RTCString'.
+ */
+class RTCRestString : public RTCString, public RTCRestObjectBase
+{
+public:
+    /** Default destructor. */
+    RTCRestString();
+    /** Copy constructor. */
+    RTCRestString(RTCRestString const &a_rThat);
+    /** From value constructor. */
+    RTCRestString(RTCString const &a_rThat);
+    /** From value constructor. */
+    RTCRestString(const char *a_pszSrc);
+    /** Destructor. */
+    virtual ~RTCRestString();
+
+    /* Overridden methods: */
+    virtual void resetToDefault() RT_OVERRIDE;
+    virtual RTCRestOutputBase &serializeAsJson(RTCRestOutputBase &a_rDst) RT_OVERRIDE;
+    virtual int deserializeFromJson(RTCRestJsonCursor const &a_rCursor) RT_OVERRIDE;
+    virtual int toString(RTCString *a_pDst, uint32_t fFlags = 0) RT_OVERRIDE;
+    virtual const char *getType(void) RT_OVERRIDE;
 };
 
@@ -310 +494 @@
 /** @todo more later. */
 
-    virtual void resetToDefaults();
-    virtual RTCRestOutputBase &serializeAsJson(RTCRestOutputBase &a_rDst);
-    virtual int deserializeFromJson(RTCRestJsonCursor const &a_rCursor)
+    virtual void resetToDefault() RT_OVERRIDE;
+    virtual RTCRestOutputBase &serializeAsJson(RTCRestOutputBase &a_rDst) RT_OVERRIDE;
+    virtual int deserializeFromJson(RTCRestJsonCursor const &a_rCursor) RT_OVERRIDE
     {
         RT_NOREF(a_rCursor);
         return VERR_NOT_IMPLEMENTED;
     }
+    virtual const char *getType(void) RT_OVERRIDE;
 };
 
@@ -330 +515 @@
 /** @todo more later. */
 
-    virtual void resetToDefaults();
-    virtual RTCRestOutputBase &serializeAsJson(RTCRestOutputBase &a_rDst);
-    virtual int deserializeFromJson(RTCRestJsonCursor const &a_rCursor)
+    virtual void resetToDefault() RT_OVERRIDE;
+    virtual RTCRestOutputBase &serializeAsJson(RTCRestOutputBase &a_rDst) RT_OVERRIDE;
+    virtual int deserializeFromJson(RTCRestJsonCursor const &a_rCursor) RT_OVERRIDE
     {
         RT_NOREF(a_rCursor);
         return VERR_NOT_IMPLEMENTED;
     }
+    virtual const char *getType(void) RT_OVERRIDE;
 };
 
@@ -352 +538 @@
      * Reset all members to default values.
      */
-    virtual void resetToDefaults() = 0;
+    virtual void resetToDefault() = 0;
 
     /**