Changeset 26587 in vbox for trunk/include/iprt

Timestamp:

Feb 16, 2010 4:57:09 PM (15 years ago)

Author:

vboxsync

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

57775

Message:

Main: Bstr makeover (second attempt) -- make Bstr(NULL) and Bstr() behave the same; resulting cleanup; make some more internal methods use Utf8Str instead of Bstr; fix a lot of CheckComArgNotNull?() usage

Location:

trunk/include/iprt

Files:

• cdefs.h (modified) (1 diff)
• cpp/ministring.h (modified) (13 diffs)

trunk/include/iprt/cdefs.h

@@ -1920 +1920 @@
 #if defined(_MSC_VER)
 # define WORKAROUND_MSVC7_ERROR_C2593_FOR_BOOL_OP(Cls) \
-    inline bool operator! (const Cls &that) { return !bool (that); } \
-    inline bool operator&& (const Cls &that, bool b) { return bool (that) && b; } \
-    inline bool operator|| (const Cls &that, bool b) { return bool (that) || b; } \
-    inline bool operator&& (bool b, const Cls &that) { return b && bool (that); } \
-    inline bool operator|| (bool b, const Cls &that) { return b || bool (that); }
+    inline bool operator! (const Cls &that) { return !bool(that); } \
+    inline bool operator&& (const Cls &that, bool b) { return bool(that) && b; } \
+    inline bool operator|| (const Cls &that, bool b) { return bool(that) || b; } \
+    inline bool operator&& (bool b, const Cls &that) { return b && bool(that); } \
+    inline bool operator|| (bool b, const Cls &that) { return b || bool(that); }
 #else
 # define WORKAROUND_MSVC7_ERROR_C2593_FOR_BOOL_OP(Cls)

trunk/include/iprt/cpp/ministring.h

@@ -45 +45 @@
  * else except IPRT memory management functions.  Semantics are like in
  * std::string, except it can do a lot less.
+ *
+ * Note that MiniString does not differentiate between NULL strings and
+ * empty strings. In other words, MiniString("") and MiniString(NULL)
+ * behave the same. In both cases, MiniString allocates no memory, reports
+ * a zero length and zero allocated bytes for both, and returns an empty
+ * C string from c_str().
  */
 #ifdef VBOX
@@ -71 +77 @@
      * Creates a copy of another MiniString.
      *
-     * This allocates s.length() + 1 bytes for the new instance.
+     * This allocates s.length() + 1 bytes for the new instance, unless s is empty.
      *
      * @param   s               The source string.
@@ -83 +89 @@
 
     /**
-     * Creates a copy of another MiniString.
-     *
-     * This allocates strlen(pcsz) + 1 bytes for the new instance.
+     * Creates a copy of a C string.
+     *
+     * This allocates strlen(pcsz) + 1 bytes for the new instance, unless s is empty.
      *
      * @param   pcsz            The source string.
@@ -123 +129 @@
      *
      * Returns the number of bytes allocated in the internal string buffer, which is
-     * at least length() + 1 if length() > 0.
+     * at least length() + 1 if length() > 0. Returns 0 for an empty string.
      *
      * @returns m_cbAllocated.
@@ -275 +281 @@
      * Returns the byte at the given index, or a null byte if the index is not
      * smaller than length().  This does _not_ count codepoints but simply points
-     * into the member C string.
+     * into the member C string; the result may not be a valid UTF-8 character.
      *
      * @param   i       The index into the string buffer.
@@ -289 +295 @@
     /**
      * Returns the contained string as a C-style const char* pointer.
+     * This never returns NULL; if the string is empty, returns a
+     * pointer to static null byte.
      *
      * @returns const pointer to C-style string.
@@ -294 +302 @@
     inline const char *c_str() const
     {
-        return m_psz;
+        return (m_psz) ? m_psz : "";
     }
 
     /**
      * Like c_str(), for compatibility with lots of VirtualBox Main code.
+     * This never returns NULL; if the string is empty, returns a
+     * pointer to static null byte.
      *
      * @returns const pointer to C-style string.
@@ -304 +314 @@
     inline const char *raw() const
     {
-        return m_psz;
-    }
-
-    /**
-     * Emptry string or not?
+        return (m_psz) ? m_psz : "";
+    }
+
+    /**
+     * Empty string or not?
      *
      * Returns true if the member string has no length.  This states nothing about
@@ -472 +482 @@
 
     /**
-     * Hide operator bool() to force people to use isEmpty() explicitly.
-     */
-    operator bool() const { return false; }
-
-    /**
      * Destructor implementation, also used to clean up in operator=() before
      * assigning a new string.
@@ -492 +497 @@
 
     /**
-     * Protected internal helper for copy a string that completely ignors the
-     * current object state.
+     * Protected internal helper to copy a string, ignoring the previous object state.
      *
      * copyFrom() unconditionally sets the members to a copy of the given other
@@ -501 +505 @@
      *
      * This variant copies from another MiniString and is fast since
-     * the length of source string is known.
+     * the length of the source string is known.
      *
      * @param   s               The source string.
@@ -533 +537 @@
 
     /**
-     * Protected internal helper for copy a string that completely ignors the
-     * current object state.
+     * Protected internal helper to copy a string, ignoring the previous object state.
      *
      * See copyFrom() above.
@@ -572 +575 @@
     }
 
+private:
+
+    /**
+     * Hide operator bool() to force people to use isEmpty() explicitly.
+     */
+    operator bool() const;
+
+protected:
+
     char    *m_psz;                     /**< The string buffer. */
     size_t  m_cbLength;                 /**< strlen(m_psz) - i.e. no terminator included. */