Changeset 74181 in vbox for trunk/include/iprt

Timestamp:

Sep 10, 2018 12:43:30 PM (6 years ago)

Author:

vboxsync

Message:

IPRT/rest: Wrote unit tests for RTCRestDate. Addressed some issues found. Marked methods implemented in headers with 'inline'. bugref:9167

Location:

trunk/include/iprt/cpp

Files:

• restarray.h (modified) (18 diffs)
• restbase.h (modified) (8 diffs)
• restclient.h (modified) (9 diffs)
• reststringmap.h (modified) (12 diffs)

trunk/include/iprt/cpp/restarray.h

@@ -66 +66 @@
      * @return   True if there is more than zero items, false otherwise.
      */
-    bool isEmpty() const
+    inline bool isEmpty() const
     {
         return m_cElements == 0;
@@ -74 +74 @@
      * Gets the number of entries in the map.
      */
-    size_t size() const
+    inline size_t size() const
     {
         return m_cElements;
@@ -85 +85 @@
      * @param   a_idx           The array index.
      */
-    RTCRestObjectBase *atBase(size_t a_idx)
+    inline RTCRestObjectBase *atBase(size_t a_idx)
     {
         if (a_idx < m_cElements)
@@ -98 +98 @@
      * @param   a_idx           The array index.
      */
-    RTCRestObjectBase const *atBase(size_t a_idx) const
+    inline RTCRestObjectBase const *atBase(size_t a_idx) const
     {
         if (a_idx < m_cElements)
@@ -247 +247 @@
      * @param   a_pThat         The object to insert.  The array takes ownership of the object on success.
      */
-    int insert(size_t a_idx, ElementType *a_pThat)
+    inline int insert(size_t a_idx, ElementType *a_pThat)
     {
         return insertWorker(a_idx, a_pThat, false /*a_fReplace*/);
@@ -260 +260 @@
      * @param   a_rThat         The object to insert a copy of.
      */
-    int insertCopy(size_t a_idx, ElementType const &a_rThat)
+    inline int insertCopy(size_t a_idx, ElementType const &a_rThat)
     {
         return insertCopyWorker(a_idx, a_rThat, false /*a_fReplace*/);
@@ -272 +272 @@
      * @param   a_pThat         The object to insert.  The array takes ownership of the object on success.
      */
-    int append(ElementType *a_pThat)
+    inline int append(ElementType *a_pThat)
     {
         return insertWorker(~(size_t)0, a_pThat, false /*a_fReplace*/);
@@ -284 +284 @@
      * @param   a_rThat         The object to insert a copy of.
      */
-    int appendCopy(ElementType const &a_rThat)
+    inline int appendCopy(ElementType const &a_rThat)
     {
         return insertCopyWorker(~(size_t)0, a_rThat, false /*a_fReplace*/);
@@ -296 +296 @@
      * @param   a_pThat         The object to insert.  The array takes ownership of the object on success.
      */
-    int prepend(ElementType *a_pThat)
+    inline int prepend(ElementType *a_pThat)
     {
         return insertWorker(0, a_pThat, false /*a_fReplace*/);
@@ -308 +308 @@
      * @param   a_rThat         The object to insert a copy of.
      */
-    int prependCopy(ElementType const &a_rThat)
+    inline int prependCopy(ElementType const &a_rThat)
     {
         return insertCopyWorker(0, a_rThat, false /*a_fReplace*/);
@@ -321 +321 @@
      * @param   a_pThat         The replacement object.  The array takes ownership of the object on success.
      */
-    int replace(size_t a_idx, ElementType *a_pThat)
+    inline int replace(size_t a_idx, ElementType *a_pThat)
     {
         return insertWorker(a_idx, a_pThat, true /*a_fReplace*/);
@@ -334 +334 @@
      * @param   a_rThat         The object to insert a copy of.
      */
-    int replaceCopy(size_t a_idx, ElementType const &a_rThat)
+    inline int replaceCopy(size_t a_idx, ElementType const &a_rThat)
     {
         return insertCopyWorker(a_idx, a_rThat, true /*a_fReplace*/);
@@ -345 +345 @@
      * @param   a_idx           The array index.
      */
-    ElementType *at(size_t a_idx)
+    inline ElementType *at(size_t a_idx)
     {
         if (a_idx < m_cElements)
@@ -358 +358 @@
      * @param   a_idx           The array index.
      */
-    ElementType const *at(size_t a_idx) const
+    inline ElementType const *at(size_t a_idx) const
     {
         if (a_idx < m_cElements)
@@ -369 +369 @@
      * @returns The first object, NULL if empty.
      */
-    ElementType *first()
+    inline ElementType *first()
     {
         return at(0);
@@ -378 +378 @@
      * @returns The first object, NULL if empty.
      */
-    ElementType const *first() const
+    inline ElementType const *first() const
     {
         return at(0);
@@ -387 +387 @@
      * @returns The last object, NULL if empty.
      */
-    ElementType *last()
+    inline ElementType *last()
     {
         return at(m_cElements - 1);
@@ -396 +396 @@
      * @returns The last object, NULL if empty.
      */
-    ElementType const *last() const
+    inline ElementType const *last() const
     {
         return at(m_cElements - 1);

trunk/include/iprt/cpp/restbase.h

@@ -85 +85 @@
      * @param   uIndent     The indentation level.
      */
-    unsigned setIndent(unsigned uIndent)
+    inline unsigned setIndent(unsigned uIndent)
     {
         unsigned const uRet = m_uIndent;
@@ -97 +97 @@
      * @returns Previous indentation level.
      */
-    unsigned incrementIndent()
+    inline unsigned incrementIndent()
     {
         unsigned const uRet = m_uIndent;
@@ -267 +267 @@
      * @returns true if null, false if not.
      */
-    bool isNull(void) const { return m_fNullIndicator; };
+    inline bool isNull(void) const { return m_fNullIndicator; };
 
     /**
@@ -730 +730 @@
      */
     int assignValue(PCRTTIMESPEC a_pTimeSpec, kFormat a_enmFormat);
-    int assignValueRfc2822(PCRTTIMESPEC a_pTimeSpec); /**< Convenience method. */
-    int assignValueRfc7131(PCRTTIMESPEC a_pTimeSpec); /**< Convenience method. */
-    int assignValueRfc3339(PCRTTIMESPEC a_pTimeSpec); /**< Convenience method. */
+    int assignValueRfc2822(PCRTTIMESPEC a_pTimeSpec); /**< Convenience method for email/whatnot. */
+    int assignValueRfc7131(PCRTTIMESPEC a_pTimeSpec); /**< Convenience method for HTTP date. */
+    int assignValueRfc3339(PCRTTIMESPEC a_pTimeSpec); /**< Convenience method for ISO-8601 timstamp. */
 
     /**
@@ -742 +742 @@
      */
     int assignNow(kFormat a_enmFormat);
-    int assignNowRfc2822(); /**< Convenience method. */
-    int assignNowRfc7131(); /**< Convenience method. */
-    int assignNowRfc3339(); /**< Convenience method. */
+    int assignNowRfc2822(); /**< Convenience method for email/whatnot. */
+    int assignNowRfc7131(); /**< Convenience method for HTTP date. */
+    int assignNowRfc3339(); /**< Convenience method for ISO-8601 timstamp. */
 
     /**
@@ -756 +756 @@
 
     /** Check if the value is okay (m_TimeSpec & m_Exploded). */
-    bool              isOkay() const        { return m_fTimeSpecOkay; }
+    inline bool              isOkay() const             { return m_fTimeSpecOkay; }
     /** Get the timespec value. */
-    RTTIMESPEC const &getTimeSpec() const   { return m_TimeSpec; }
+    inline RTTIMESPEC const &getTimeSpec() const        { return m_TimeSpec; }
     /** Get the exploded time. */
-    RTTIME const     &getExploded() const   { return m_Exploded; }
+    inline RTTIME const     &getExploded() const        { return m_Exploded; }
+    /** Gets the format. */
+    inline kFormat           getFormat() const          { return m_enmFormat; }
     /** Get the formatted/raw string value. */
-    RTCString const  &getString() const     { return m_strFormatted; }
+    inline RTCString const  &getString() const          { return m_strFormatted; }
+
+    /** Get nanoseconds since unix epoch. */
+    inline int64_t           getEpochNano() const       { return RTTimeSpecGetNano(&m_TimeSpec); }
+    /** Get seconds since unix epoch. */
+    inline int64_t           getEpochSeconds() const    { return RTTimeSpecGetSeconds(&m_TimeSpec); }
+    /** Checks if UTC time. */
+    inline bool              isUtc() const              { return (m_Exploded.fFlags & RTTIME_FLAGS_TYPE_MASK) != RTTIME_FLAGS_TYPE_LOCAL; }
+    /** Checks if local time. */
+    inline bool              isLocal() const            { return (m_Exploded.fFlags & RTTIME_FLAGS_TYPE_MASK) == RTTIME_FLAGS_TYPE_LOCAL; }
 
 protected:
@@ -841 +852 @@
     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); }
+    inline int assignCopy(RTCString const &a_rThat)    { return setByString(a_rThat); }
+    /** Safe copy assignment method. */
+    inline int assignCopy(const char *a_pszThat)       { return setByString(a_pszThat); }
 
     /* Overridden methods: */
@@ -940 +951 @@
 
     /** Returns a pointer to the data blob. */
-    const uint8_t  *getPtr()  const { return m_pbData; }
+    inline const uint8_t  *getPtr()  const { return m_pbData; }
     /** Gets the size of the data. */
-    size_t          getSize() const { return m_cbData; }
+    inline size_t          getSize() const { return m_cbData; }
 
     /* Overridden methods: */

trunk/include/iprt/cpp/restclient.h

@@ -75 +75 @@
      * Retrieves the callback data.
      */
-    void *getCallbackData() const  { return m_pvCallbackData; }
+    inline void *getCallbackData() const  { return m_pvCallbackData; }
 
     /**
@@ -89 +89 @@
      * Gets the content type that was set.
      */
-    RTCString const &getContentType() const { return m_strContentType; }
+    inline RTCString const &getContentType() const { return m_strContentType; }
 
     /**
@@ -199 +199 @@
      * Retrieves the callback data.
      */
-    void *getCallbackData() const  { return m_pvCallbackData; }
+    inline void *getCallbackData() const  { return m_pvCallbackData; }
 
     /**
@@ -216 +216 @@
      * Gets the content-length value (UINT64_MAX if not available).
      */
-    uint64_t getContentLength() const { return m_cbContentLength; }
+    inline uint64_t getContentLength() const { return m_cbContentLength; }
 
     /**
@@ -340 +340 @@
      * Checks if there are were any assignment errors.
      */
-    bool hasAssignmentErrors() const { return m_fErrorSet != 0; }
+    inline bool hasAssignmentErrors() const { return m_fErrorSet != 0; }
 
 protected:
@@ -498 +498 @@
      * @returns Negative numbers are IPRT errors, positive are HTTP status codes.
      */
-    int getStatus() { return m_rcStatus; }
+    inline int getStatus() { return m_rcStatus; }
 
     /**
@@ -504 +504 @@
      * @returns HTTP status code or VERR_NOT_AVAILABLE.
      */
-    int getHttpStatus() { return m_rcHttp; }
+    inline int getHttpStatus() { return m_rcHttp; }
 
     /**
      * Getter for m_pErrInfo.
      */
-    PCRTERRINFO getErrInfo(void) const { return m_pErrInfo; }
+    inline PCRTERRINFO getErrInfo(void) const { return m_pErrInfo; }
 
     /**
      * Getter for m_strContentType.
      */
-    RTCString const &getContentType(void) const { return m_strContentType; }
+    inline RTCString const &getContentType(void) const { return m_strContentType; }
 
 
@@ -632 +632 @@
      * @returns Base URL string.  If empty, we'll be using the default one.
      */
-    RTCString const &getBasePath(void) const
+    inline RTCString const &getBasePath(void) const
     {
         return m_strBasePath;
@@ -661 +661 @@
      * @note    Defers to the C-string variant.
      */
-    void setBasePath(RTCString const &a_strPath) { setBasePath(a_strPath.c_str()); }
+    inline void setBasePath(RTCString const &a_strPath) { setBasePath(a_strPath.c_str()); }
 
     /**

trunk/include/iprt/cpp/reststringmap.h

@@ -160 +160 @@
 
         /** Gets the key string. */
-        RTCString const         &getKey()   { return m_pCur->strKey; }
+        inline RTCString const         &getKey()   { return m_pCur->strKey; }
         /** Gets poitner to the value object. */
-        RTCRestObjectBase const *getValue() { return m_pCur->pValue; }
+        inline RTCRestObjectBase const *getValue() { return m_pCur->pValue; }
 
         /** Advance to the next map entry. */
-        ConstIterator &operator++()
+        inline ConstIterator &operator++()
         {
             m_pCur = RTListNodeGetNextCpp(&m_pCur->ListEntry, MapEntry, ListEntry);
@@ -172 +172 @@
 
         /** Advance to the previous map entry. */
-        ConstIterator &operator--()
+        inline ConstIterator &operator--()
         {
             m_pCur = RTListNodeGetPrevCpp(&m_pCur->ListEntry, MapEntry, ListEntry);
@@ -179 +179 @@
 
         /** Compare equal. */
-        bool operator==(ConstIterator const &a_rThat) { return m_pCur == a_rThat.m_pCur; }
+        inline bool operator==(ConstIterator const &a_rThat) { return m_pCur == a_rThat.m_pCur; }
         /** Compare not equal. */
-        bool operator!=(ConstIterator const &a_rThat) { return m_pCur != a_rThat.m_pCur; }
+        inline bool operator!=(ConstIterator const &a_rThat) { return m_pCur != a_rThat.m_pCur; }
 
         /* Map class must be friend so it can use the MapEntry constructor. */
@@ -188 +188 @@
 
     /** Returns iterator for the first map entry (unless it's empty and it's also the end). */
-    ConstIterator begin() const { return ConstIterator(RTListGetFirstCpp(&m_ListHead, MapEntry, ListEntry)); }
+    inline ConstIterator begin() const { return ConstIterator(RTListGetFirstCpp(&m_ListHead, MapEntry, ListEntry)); }
     /** Returns iterator for the last map entry (unless it's empty and it's also the end). */
-    ConstIterator last() const  { return ConstIterator(RTListGetLastCpp(&m_ListHead, MapEntry, ListEntry)); }
+    inline ConstIterator last() const  { return ConstIterator(RTListGetLastCpp(&m_ListHead, MapEntry, ListEntry)); }
     /** Returns the end iterator.  This does not ever refer to an actual map entry. */
-    ConstIterator end() const   { return ConstIterator(RT_FROM_CPP_MEMBER(&m_ListHead, MapEntry, ListEntry)); }
+    inline ConstIterator end() const   { return ConstIterator(RT_FROM_CPP_MEMBER(&m_ListHead, MapEntry, ListEntry)); }
     /** @} */
 
@@ -327 +327 @@
      * @param   a_fReplace      Whether to replace existing key-value pair with matching key.
      */
-    int put(const char *a_pszKey, ValueType *a_pValue, bool a_fReplace = false)
+    inline int put(const char *a_pszKey, ValueType *a_pValue, bool a_fReplace = false)
     {
         return putWorker(a_pszKey, a_pValue, a_fReplace);
@@ -341 +341 @@
      * @param   a_fReplace      Whether to replace existing key-value pair with matching key.
      */
-    int put(RTCString const &a_rStrKey, ValueType *a_pValue, bool a_fReplace = false)
+    inline int put(RTCString const &a_rStrKey, ValueType *a_pValue, bool a_fReplace = false)
     {
         return putWorker(a_rStrKey.c_str(), a_pValue, a_fReplace, a_rStrKey.length());
@@ -355 +355 @@
      * @param   a_fReplace      Whether to replace existing key-value pair with matching key.
      */
-    int putCopy(const char *a_pszKey, const ValueType &a_rValue, bool a_fReplace = false)
+    inline int putCopy(const char *a_pszKey, const ValueType &a_rValue, bool a_fReplace = false)
     {
         return putCopyWorker(a_pszKey, a_rValue, a_fReplace);
@@ -369 +369 @@
      * @param   a_fReplace      Whether to replace existing key-value pair with matching key.
      */
-    int putCopy(RTCString const &a_rStrKey, const ValueType &a_rValue, bool a_fReplace = false)
+    inline int putCopy(RTCString const &a_rStrKey, const ValueType &a_rValue, bool a_fReplace = false)
     {
         return putCopyWorker(a_rStrKey.c_str(), a_rValue, a_fReplace, a_rStrKey.length());
@@ -380 +380 @@
      * @param   a_pszKey        The key which value to look up.
      */
-    ValueType *get(const char *a_pszKey)
+    inline ValueType *get(const char *a_pszKey)
     {
         return (ValueType *)getWorker(a_pszKey);
@@ -391 +391 @@
      * @param   a_rStrKey       The key which value to look up.
      */
-    ValueType *get(RTCString const &a_rStrKey)
+    inline ValueType *get(RTCString const &a_rStrKey)
     {
         return (ValueType *)getWorker(a_rStrKey.c_str());
@@ -402 +402 @@
      * @param   a_pszKey        The key which value to look up.
      */
-    ValueType const *get(const char *a_pszKey) const
+    inline ValueType const *get(const char *a_pszKey) const
     {
         return (ValueType const *)getWorker(a_pszKey);
@@ -413 +413 @@
      * @param   a_rStrKey       The key which value to look up.
      */
-    ValueType const *get(RTCString const &a_rStrKey) const
+    inline ValueType const *get(RTCString const &a_rStrKey) const
     {
         return (ValueType const *)getWorker(a_rStrKey.c_str());