Changeset 73933 in vbox for trunk/include/iprt

Timestamp:

Aug 28, 2018 8:57:23 PM (6 years ago)

Author:

vboxsync

Message:

IPRT/rest: Adding genric factor methods for every class and use it to generalize response header field parsing. bugref:9167

Location:

trunk/include/iprt

Files:

• cpp/restbase.h (modified) (16 diffs)
• err.h (modified) (1 diff)

trunk/include/iprt/cpp/restbase.h

@@ -295 +295 @@
         kCollectionFormat_ssv,              /**< Space-separated list. */
         kCollectionFormat_tsv,              /**< Tab-separated list. */
-        kCollectionFormat_pipes             /**< Pipe-separated list. */
+        kCollectionFormat_pipes,            /**< Pipe-separated list. */
+        kCollectionFormat_Mask = 7          /**< Collection type mask. */
     };
 
@@ -328 +329 @@
      */
     virtual int fromString(RTCString const &a_rValue, const char *a_pszName, PRTERRINFO a_pErrInfo = NULL,
-                                  uint32_t a_fFlags = kCollectionFormat_Unspecified);
+                           uint32_t a_fFlags = kCollectionFormat_Unspecified);
 
     /**
@@ -334 +335 @@
      */
     virtual const char *getType(void) = 0;
+
+    /**
+     * Factory method.
+     * @returns Pointer to new object on success, NULL if out of memory.
+     */
+    typedef DECLCALLBACK(RTCRestObjectBase *) FNCREATEINSTANCE(void);
+    /** Pointer to factory method. */
+    typedef FNCREATEINSTANCE *PFNCREATEINSTANCE;
 };
 
@@ -363 +372 @@
     virtual const char *getType(void) RT_OVERRIDE;
 
+    /** Factory method. */
+    static DECLCALLBACK(RTCRestObjectBase *) createInstance(void);
+
 public:
     /** The value. */
@@ -395 +407 @@
     virtual const char *getType(void) RT_OVERRIDE;
 
+    /** Factory method. */
+    static DECLCALLBACK(RTCRestObjectBase *) createInstance(void);
+
 public:
     /** The value. */
@@ -427 +442 @@
     virtual const char *getType(void) RT_OVERRIDE;
 
+    /** Factory method. */
+    static DECLCALLBACK(RTCRestObjectBase *) createInstance(void);
+
 public:
     /** The value. */
@@ -459 +477 @@
     virtual const char *getType(void) RT_OVERRIDE;
 
+    /** Factory method. */
+    static DECLCALLBACK(RTCRestObjectBase *) createInstance(void);
+
 public:
     /** The value. */
@@ -491 +512 @@
     virtual const char *getType(void) RT_OVERRIDE;
 
+    /** Factory method. */
+    static DECLCALLBACK(RTCRestObjectBase *) createInstance(void);
+
 public:
     /** The value. */
@@ -522 +546 @@
                            uint32_t a_fFlags = kCollectionFormat_Unspecified) RT_OVERRIDE;
     virtual const char *getType(void) RT_OVERRIDE;
+
+    /** Factory method. */
+    static DECLCALLBACK(RTCRestObjectBase *) createInstance(void);
 };
 
@@ -528 +555 @@
  * Limited array class.
  */
-template<class Type> class RTCRestArray : public RTCRestObjectBase
+template<class ElementType> class RTCRestArray : public RTCRestObjectBase
 {
 public:
@@ -535 +562 @@
 /** @todo more later. */
 
-    virtual void resetToDefault() RT_OVERRIDE;
-    virtual RTCRestOutputBase &serializeAsJson(RTCRestOutputBase &a_rDst) const RT_OVERRIDE;
+    virtual void resetToDefault() RT_OVERRIDE
+    {
+    }
+
+    virtual RTCRestOutputBase &serializeAsJson(RTCRestOutputBase &a_rDst) const RT_OVERRIDE
+    {
+        RT_NOREF(a_rDst);
+        return a_rDst;
+    }
+
     virtual int deserializeFromJson(RTCRestJsonCursor const &a_rCursor) RT_OVERRIDE
     {
@@ -542 +577 @@
         return VERR_NOT_IMPLEMENTED;
     }
+
     virtual int fromString(RTCString const &a_rValue, const char *a_pszName, PRTERRINFO a_pErrInfo = NULL,
-                           uint32_t a_fFlags = kCollectionFormat_Unspecified) RT_OVERRIDE;
-    virtual const char *getType(void) RT_OVERRIDE;
+                           uint32_t a_fFlags = kCollectionFormat_Unspecified) RT_OVERRIDE
+    {
+        RT_NOREF(a_rValue, a_pszName, a_pErrInfo, a_fFlags);
+        return VERR_NOT_IMPLEMENTED;
+    }
+
+    virtual const char *getType(void) RT_OVERRIDE
+    {
+        return "RTCRestArray<ElementType>";
+    }
+
+    /** Factory method. */
+    static DECLCALLBACK(RTCRestObjectBase *) createInstance(void)
+    {
+        return new RTCRestArray<ElementType>();
+    }
+
+    /** Factory method for elements. */
+    static DECLCALLBACK(RTCRestObjectBase *) createElementInstance(void)
+    {
+        return new ElementType();
+    }
 };
 
@@ -551 +607 @@
  * Limited map class.
  */
-template<class Type> class RTCRestStringMap : public RTCRestObjectBase
+template<class ElementType> class RTCRestStringMap : public RTCRestObjectBase
 {
 public:
@@ -558 +614 @@
 /** @todo more later. */
 
-    virtual void resetToDefault() RT_OVERRIDE;
-    virtual RTCRestOutputBase &serializeAsJson(RTCRestOutputBase &a_rDst) const RT_OVERRIDE;
+    virtual void resetToDefault() RT_OVERRIDE
+    {
+    }
+
+    virtual RTCRestOutputBase &serializeAsJson(RTCRestOutputBase &a_rDst) const RT_OVERRIDE
+    {
+        RT_NOREF(a_rDst);
+        return a_rDst;
+    }
+
     virtual int deserializeFromJson(RTCRestJsonCursor const &a_rCursor) RT_OVERRIDE
     {
@@ -565 +629 @@
         return VERR_NOT_IMPLEMENTED;
     }
+
     virtual int fromString(RTCString const &a_rValue, const char *a_pszName, PRTERRINFO a_pErrInfo = NULL,
-                           uint32_t a_fFlags = kCollectionFormat_Unspecified) RT_OVERRIDE;
-    virtual const char *getType(void) RT_OVERRIDE;
+                           uint32_t a_fFlags = kCollectionFormat_Unspecified) RT_OVERRIDE
+    {
+        RT_NOREF(a_rValue, a_pszName, a_pErrInfo, a_fFlags);
+        return VERR_NOT_IMPLEMENTED;
+    }
+
+    virtual const char *getType(void) RT_OVERRIDE
+    {
+        return "RTCRestStringMap<ElementType>";
+    }
+
+    /** Factory method. */
+    static DECLCALLBACK(RTCRestObjectBase *) createInstance(void)
+    {
+        return new RTCRestStringMap<ElementType>();
+    }
+
+    /** Factory method for elements. */
+    static DECLCALLBACK(RTCRestObjectBase *) createElementInstance(void)
+    {
+        return new ElementType();
+    }
 };
 
@@ -743 +828 @@
      * @param   ...         Message arguments.
      */
-    int         addError(int a_rc, const char *a_pszFormat, ...);
+    int addError(int a_rc, const char *a_pszFormat, ...);
+
+    /** Field flags. */
+    enum
+    {
+        /** Collection map, name is a prefix followed by '*'. */
+        kHdrField_MapCollection   = RT_BIT_32(24),
+        /** Array collection, i.e. the heade field may appear more than once. */
+        kHdrField_ArrayCollection = RT_BIT_32(25),
+    };
+
+    /** Header field descriptor. */
+    typedef struct
+    {
+        /** The header field name. */
+        const char *pszName;
+        /** The length of the field name.*/
+        uint32_t    cchName;
+        /** Flags, TBD. */
+        uint32_t    fFlags;
+        /** Object factory. */
+        RTCRestObjectBase::PFNCREATEINSTANCE pfnCreateInstance;
+    } HEADERFIELDDESC;
+
+    /**
+     * Helper that extracts fields from the HTTP headers.
+     *
+     * @param   a_paFieldsDesc      Pointer to an array of field descriptors.
+     * @param   a_pappFieldValues   Pointer to a parallel array of value pointer pointers.
+     * @param   a_cFields           Number of field descriptors..
+     * @param   a_pchData           The header blob to search.
+     * @param   a_cbData            The size of the header blob to search.
+     */
+    void extracHeaderFieldsFromBlob(HEADERFIELDDESC const *a_paFieldDescs, RTCRestObjectBase ***a_pappFieldValues,
+                                    size_t a_cFields, const char *a_pchData, size_t a_cbData);
 
     /**

trunk/include/iprt/err.h

@@ -3214 +3214 @@
 /** Server response contains embedded zero character(s). */
 #define VERR_REST_RESPONSE_EMBEDDED_ZERO_CHAR           (-25702)
+/** Server response contains unexpected repetitive header field. */
+#define VERR_REST_RESPONSE_REPEAT_HEADER_FIELD          (-25703)
 /** @} */