Changeset 32718 in vbox for trunk/include/VBox

Timestamp:

Sep 23, 2010 12:57:52 PM (14 years ago)

Author:

vboxsync

Message:

com/string: Remove bool conversion operator and other convenience error operators. They are hiding programming errors (like incorrect empty string checks, and in one case a free of the wrong pointer).

Location:

trunk/include/VBox/com

Files:

• ErrorInfo.h (modified) (8 diffs)
• string.h (modified) (6 diffs)

trunk/include/VBox/com/ErrorInfo.h

@@ -5 +5 @@
 
 /*
- * Copyright (C) 2006-2007 Oracle Corporation
+ * Copyright (C) 2006-2010 Oracle Corporation
  *
  * This file is part of VirtualBox Open Source Edition (OSE), as
@@ -55 +55 @@
  *      ...
  *      HRESULT rc = foo->SomeMethod();
- *      if (FAILED (rc)) {
- *          ErrorInfo info (foo);
+ *      if (FAILED(rc)) {
+ *          ErrorInfo info(foo);
  *          if (info.isFullAvailable()) {
- *              printf ("error message = %ls\n", info.getText().raw());
+ *              printf("error message = %ls\n", info.getText().raw());
  *          }
  *      }
@@ -227 +227 @@
      *
      *  This method returns a non-null IID only if the instance was created
-     *  using #template <class I> ErrorInfo (I *i) or
-     *  template <class I> ErrorInfo (const ComPtr <I> &i) constructor.
+     *  using #template <class I> ErrorInfo(I *i) or
+     *  template <class I> ErrorInfo(const ComPtr<I> &i) constructor.
      */
     const Guid& getCalleeIID() const
@@ -239 +239 @@
      *
      *  This method returns a non-null name only if the instance was created
-     *  using #template <class I> ErrorInfo (I *i) or
-     *  template <class I> ErrorInfo (const ComPtr <I> &i) constructor.
+     *  using #template <class I> ErrorInfo(I *i) or
+     *  template <class I> ErrorInfo(const ComPtr<I> &i) constructor.
      */
     const Bstr& getCalleeName() const
@@ -248 +248 @@
 
     /**
-     *  Resets all collected error information. #isNull() will
-     *  return @c true after this method is called.
+     *  Resets all collected error information. #isBasicAvailable() and
+     *  #isFullAvailable will return @c true after this method is called.
      */
     void setNull()
@@ -327 +327 @@
  *  <code>
  *      rc = foo->method();
- *      if (FAILED (rc))
+ *      if (FAILED(rc))
  *      {
  *           ErrorInfoKeeper eik;
@@ -353 +353 @@
      *                  the instance uninitialized.
      */
-    ErrorInfoKeeper (bool aIsNull = false)
-        : ErrorInfo (false), mForgot (aIsNull)
+    ErrorInfoKeeper(bool aIsNull = false)
+        : ErrorInfo(false), mForgot(aIsNull)
     {
         if (!aIsNull)
-            init (true /* aKeepObj */);
+            init(true /* aKeepObj */);
     }
 
@@ -399 +399 @@
      *  stored error info object to the caller.
      */
-    ComPtr <IUnknown> takeError() { mForgot = true; return mErrorInfo; }
+    ComPtr<IUnknown> takeError() { mForgot = true; return mErrorInfo; }
 
 private:

trunk/include/VBox/com/string.h

@@ -179 +179 @@
     }
 
-    int compare(BSTR str) const
-    {
-        return compare((CBSTR)str);
+    int compare(BSTR str, CaseSensitivity cs = CaseSensitive) const
+    {
+        return compare((CBSTR)str, cs);
+    }
+
+    int compare(const Bstr &that, CaseSensitivity cs = CaseSensitive) const
+    {
+        return compare(that.m_bstr, cs);
     }
 
@@ -201 +206 @@
      * @note Always use this method to check if an instance is empty. Do not
      * use length() because that may need to run through the entire string
-     * (Bstr does not cache string lengths). Also do not use operator bool();
-     * for one, MSVC is really annoying with its thinking that that is ambiguous,
-     * and even though operator bool() is protected with Bstr, at least gcc uses
-     * operator CBSTR() when a construct like "if (string)" is encountered, which
-     * is always true now since it raw() never returns an empty string. Again,
-     * always use isEmpty() even though if (string) may compile!
+     * (Bstr does not cache string lengths).
      */
     bool isEmpty() const { return m_bstr == NULL || *m_bstr == 0; }
 
     size_t length() const { return isEmpty() ? 0 : ::RTUtf16Len((PRTUTF16)m_bstr); }
-
-    /**
-     * Returns true if the member string is not empty. I'd like to make this
-     * private but since we require operator BSTR() it's futile anyway because
-     * the compiler will then (wrongly) use that one instead. Also if this is
-     * private the odd WORKAROUND_MSVC7_ERROR_C2593_FOR_BOOL_OP macro below
-     * will fail on Windows.
-     */
-    operator bool() const
-    {
-        return m_bstr != NULL;
-    }
 
     /**
@@ -236 +224 @@
         return g_bstrEmpty;
     }
-
-    /**
-     * Convenience operator so that Bstr's can be passed to CBSTR input parameters
-     * of COM methods.
-     */
-    operator CBSTR() const { return raw(); }
-
-    /**
-     * Convenience operator so that Bstr's can be passed to CBSTR input parameters
-     * of COM methods. Unfortunately this is required for Windows since with
-     * MSCOM, input BSTR parameters of interface methods are not const.
-     */
-    operator BSTR() { return (BSTR)raw(); }
 
     /**
@@ -397 +372 @@
 inline bool operator!=(BSTR l, const Bstr &r) { return r.operator!=(l); }
 
-// work around error C2593 of the stupid MSVC 7.x ambiguity resolver
-WORKAROUND_MSVC7_ERROR_C2593_FOR_BOOL_OP(Bstr)
 
 ////////////////////////////////////////////////////////////////////////////////
@@ -431 +404 @@
     Utf8Str(const Bstr &that)
     {
+        copyFrom(that.raw());
+    }
+
+    Utf8Str(CBSTR that)
+    {
         copyFrom(that);
     }
 
-    Utf8Str(CBSTR that)
-    {
-        copyFrom(that);
-    }
-
     Utf8Str& operator=(const MiniString &that)
     {
@@ -454 +427 @@
     {
         cleanup();
-        copyFrom(that);
+        copyFrom(that.raw());
         return *this;
     }