summaryrefslogtreecommitdiffstats
path: root/src/libs/xpcom18a4/xpcom/tests/TestCOMPtr.cpp
diff options
context:
space:
mode:
Diffstat (limited to '')
-rw-r--r--src/libs/xpcom18a4/xpcom/tests/TestCOMPtr.cpp651
1 files changed, 651 insertions, 0 deletions
diff --git a/src/libs/xpcom18a4/xpcom/tests/TestCOMPtr.cpp b/src/libs/xpcom18a4/xpcom/tests/TestCOMPtr.cpp
new file mode 100644
index 00000000..c48219e2
--- /dev/null
+++ b/src/libs/xpcom18a4/xpcom/tests/TestCOMPtr.cpp
@@ -0,0 +1,651 @@
+/* -*- Mode: C++; tab-width: 2; indent-tabs-mode: nil; c-basic-offset: 2 -*- */
+/* ***** BEGIN LICENSE BLOCK *****
+ * Version: MPL 1.1/GPL 2.0/LGPL 2.1
+ *
+ * The contents of this file are subject to the Mozilla Public License Version
+ * 1.1 (the "License"); you may not use this file except in compliance with
+ * the License. You may obtain a copy of the License at
+ * http://www.mozilla.org/MPL/
+ *
+ * Software distributed under the License is distributed on an "AS IS" basis,
+ * WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License
+ * for the specific language governing rights and limitations under the
+ * License.
+ *
+ * The Original Code is mozilla.org code.
+ *
+ * The Initial Developer of the Original Code is
+ * Netscape Communications Corporation.
+ * Portions created by the Initial Developer are Copyright (C) 1998
+ * the Initial Developer. All Rights Reserved.
+ *
+ * Contributor(s):
+ * Pierre Phaneuf <pp@ludusdesign.com>
+ *
+ * Alternatively, the contents of this file may be used under the terms of
+ * either of the GNU General Public License Version 2 or later (the "GPL"),
+ * or the GNU Lesser General Public License Version 2.1 or later (the "LGPL"),
+ * in which case the provisions of the GPL or the LGPL are applicable instead
+ * of those above. If you wish to allow use of your version of this file only
+ * under the terms of either the GPL or the LGPL, and not to allow others to
+ * use your version of this file under the terms of the MPL, indicate your
+ * decision by deleting the provisions above and replace them with the notice
+ * and other provisions required by the GPL or the LGPL. If you do not delete
+ * the provisions above, a recipient may use your version of this file under
+ * the terms of any one of the MPL, the GPL or the LGPL.
+ *
+ * ***** END LICENSE BLOCK ***** */
+
+#include <assert.h>
+#include <stdio.h>
+#include "nsCOMPtr.h"
+#include "nsISupports.h"
+
+#ifdef HAVE_CPP_NEW_CASTS
+ #define STATIC_CAST(T,x) static_cast<T>(x)
+ #define REINTERPRET_CAST(T,x) reinterpret_cast<T>(x)
+#else
+ #define STATIC_CAST(T,x) ((T)(x))
+ #define REINTERPRET_CAST(T,x) ((T)(x))
+#endif
+
+
+#define NS_IFOO_IID \
+{ 0x6f7652e0, 0xee43, 0x11d1, \
+ { 0x9c, 0xc3, 0x00, 0x60, 0x08, 0x8c, 0xa6, 0xb3 } }
+
+class IFoo : public nsISupports
+ {
+ public:
+ NS_DEFINE_STATIC_IID_ACCESSOR(NS_IFOO_IID)
+
+ public:
+ IFoo();
+ // virtual dtor because IBar uses our Release()
+ virtual ~IFoo();
+
+ NS_IMETHOD_(nsrefcnt) AddRef();
+ NS_IMETHOD_(nsrefcnt) Release();
+ NS_IMETHOD QueryInterface( const nsIID&, void** );
+
+ static void print_totals();
+
+ private:
+ unsigned int refcount_;
+
+ static unsigned int total_constructions_;
+ static unsigned int total_destructions_;
+ };
+
+class IBar;
+
+ // some types I'll need
+typedef unsigned long NS_RESULT;
+
+ // some functions I'll need (and define below)
+ nsresult CreateIFoo( void** );
+ nsresult CreateIBar( void** result );
+ void AnIFooPtrPtrContext( IFoo** );
+ void AnISupportsPtrPtrContext( nsISupports** );
+ void AVoidPtrPtrContext( void** );
+ void set_a_IFoo( nsCOMPtr<IFoo>* result );
+nsCOMPtr<IFoo> return_a_IFoo();
+
+
+
+
+unsigned int IFoo::total_constructions_;
+unsigned int IFoo::total_destructions_;
+
+class test_message
+ {
+ public:
+ test_message()
+ {
+ printf("BEGIN unit tests for |nsCOMPtr|, compiled " __DATE__ "\n");
+ }
+
+ ~test_message()
+ {
+ IFoo::print_totals();
+ printf("END unit tests for |nsCOMPtr|.\n");
+ }
+ };
+
+test_message gTestMessage;
+
+
+ /*
+ ...
+ */
+
+void
+IFoo::print_totals()
+ {
+ printf("total constructions/destructions --> %d/%d\n",
+ total_constructions_, total_destructions_);
+ }
+
+IFoo::IFoo()
+ : refcount_(0)
+ {
+ ++total_constructions_;
+ printf(" new IFoo@%p [#%d]\n",
+ STATIC_CAST(void*, this), total_constructions_);
+ }
+
+IFoo::~IFoo()
+ {
+ ++total_destructions_;
+ printf("IFoo@%p::~IFoo() [#%d]\n",
+ STATIC_CAST(void*, this), total_destructions_);
+ }
+
+nsrefcnt
+IFoo::AddRef()
+ {
+ ++refcount_;
+ printf("IFoo@%p::AddRef(), refcount --> %d\n",
+ STATIC_CAST(void*, this), refcount_);
+ return refcount_;
+ }
+
+nsrefcnt
+IFoo::Release()
+ {
+ int wrap_message = (refcount_ == 1);
+ if ( wrap_message )
+ printf(">>");
+
+ nsrefcnt const newcount = --refcount_;
+ printf("IFoo@%p::Release(), refcount --> %d\n",
+ STATIC_CAST(void*, this), newcount);
+
+ if ( !newcount )
+ {
+ printf(" delete IFoo@%p\n", STATIC_CAST(void*, this));
+ delete this;
+ }
+
+ if ( wrap_message )
+ printf("<<IFoo@%p::Release()\n", STATIC_CAST(void*, this));
+
+ return newcount;
+ }
+
+nsresult
+IFoo::QueryInterface( const nsIID& aIID, void** aResult )
+ {
+ printf("IFoo@%p::QueryInterface()\n", STATIC_CAST(void*, this));
+ nsISupports* rawPtr = 0;
+ nsresult status = NS_OK;
+
+ if ( aIID.Equals(GetIID()) )
+ rawPtr = this;
+ else
+ {
+ nsID iid_of_ISupports = NS_ISUPPORTS_IID;
+ if ( aIID.Equals(iid_of_ISupports) )
+ rawPtr = STATIC_CAST(nsISupports*, this);
+ else
+ status = NS_ERROR_NO_INTERFACE;
+ }
+
+ NS_IF_ADDREF(rawPtr);
+ *aResult = rawPtr;
+
+ return status;
+ }
+
+nsresult
+CreateIFoo( void** result )
+ // a typical factory function (that calls AddRef)
+ {
+ printf(">>CreateIFoo() --> ");
+ IFoo* foop = new IFoo;
+ printf("IFoo@%p\n", STATIC_CAST(void*, foop));
+
+ foop->AddRef();
+ *result = foop;
+
+ printf("<<CreateIFoo()\n");
+ return 0;
+ }
+
+void
+set_a_IFoo( nsCOMPtr<IFoo>* result )
+ {
+ printf(">>set_a_IFoo()\n");
+ assert(result);
+
+ nsCOMPtr<IFoo> foop( do_QueryInterface(new IFoo) );
+ *result = foop;
+ printf("<<set_a_IFoo()\n");
+ }
+
+nsCOMPtr<IFoo>
+return_a_IFoo()
+ {
+ printf(">>return_a_IFoo()\n");
+ nsCOMPtr<IFoo> foop( do_QueryInterface(new IFoo) );
+ printf("<<return_a_IFoo()\n");
+ return foop;
+ }
+
+
+
+
+#define NS_IBAR_IID \
+{ 0x6f7652e1, 0xee43, 0x11d1, \
+ { 0x9c, 0xc3, 0x00, 0x60, 0x08, 0x8c, 0xa6, 0xb3 } }
+
+class IBar : public IFoo
+ {
+ public:
+ NS_DEFINE_STATIC_IID_ACCESSOR(NS_IBAR_IID)
+
+ public:
+ IBar();
+ virtual ~IBar();
+
+ NS_IMETHOD QueryInterface( const nsIID&, void** );
+ };
+
+IBar::IBar()
+ {
+ printf(" new IBar@%p\n", STATIC_CAST(void*, this));
+ }
+
+IBar::~IBar()
+ {
+ printf("IBar@%p::~IBar()\n", STATIC_CAST(void*, this));
+ }
+
+nsresult
+IBar::QueryInterface( const nsID& aIID, void** aResult )
+ {
+ printf("IBar@%p::QueryInterface()\n", STATIC_CAST(void*, this));
+ nsISupports* rawPtr = 0;
+ nsresult status = NS_OK;
+
+ if ( aIID.Equals(GetIID()) )
+ rawPtr = this;
+ else if ( aIID.Equals(NS_GET_IID(IFoo)) )
+ rawPtr = STATIC_CAST(IFoo*, this);
+ else
+ {
+ nsID iid_of_ISupports = NS_ISUPPORTS_IID;
+ if ( aIID.Equals(iid_of_ISupports) )
+ rawPtr = STATIC_CAST(nsISupports*, this);
+ else
+ status = NS_ERROR_NO_INTERFACE;
+ }
+
+ NS_IF_ADDREF(rawPtr);
+ *aResult = rawPtr;
+
+ return status;
+ }
+
+
+
+nsresult
+CreateIBar( void** result )
+ // a typical factory function (that calls AddRef)
+ {
+ printf(">>CreateIBar() --> ");
+ IBar* barp = new IBar;
+ printf("IBar@%p\n", STATIC_CAST(void*, barp));
+
+ barp->AddRef();
+ *result = barp;
+
+ printf("<<CreateIBar()\n");
+ return 0;
+ }
+
+void
+AnIFooPtrPtrContext( IFoo** )
+ {
+ }
+
+void
+AVoidPtrPtrContext( void** )
+ {
+ }
+
+void
+AnISupportsPtrPtrContext( nsISupports** )
+ {
+ }
+
+
+// Optimism
+#define TEST_EXCEPTIONS 1
+
+// HAVE_CPP_EXCEPTIONS is defined automagically on unix
+#if defined(XP_UNIX) || defined(XP_BEOS) || defined(XP_OS2)
+#if !defined(HAVE_CPP_EXCEPTIONS)
+#undef TEST_EXCEPTIONS
+#endif
+#endif
+
+#ifdef TEST_EXCEPTIONS
+static
+nsresult
+TestBloat_Raw()
+ {
+ IBar* barP = 0;
+ nsresult result = CreateIBar(REINTERPRET_CAST(void**, &barP));
+
+ if ( barP )
+ {
+ try
+ {
+ IFoo* fooP = 0;
+ if ( NS_SUCCEEDED( result = barP->QueryInterface(NS_GET_IID(IFoo), REINTERPRET_CAST(void**, &fooP)) ) )
+ {
+ try
+ {
+ fooP->print_totals();
+ }
+ catch( ... )
+ {
+ NS_RELEASE(fooP);
+ throw;
+ }
+
+ NS_RELEASE(fooP);
+ }
+ }
+ catch( ... )
+ {
+ NS_RELEASE(barP);
+ throw;
+ }
+
+ NS_RELEASE(barP);
+ }
+
+ return result;
+ }
+#endif // TEST_EXCEPTIONS
+
+static
+nsresult
+TestBloat_Raw_Unsafe()
+ {
+ IBar* barP = 0;
+ nsresult result = CreateIBar(REINTERPRET_CAST(void**, &barP));
+
+ if ( barP )
+ {
+ IFoo* fooP = 0;
+ if ( NS_SUCCEEDED( result = barP->QueryInterface(NS_GET_IID(IFoo), REINTERPRET_CAST(void**, &fooP)) ) )
+ {
+ fooP->print_totals();
+ NS_RELEASE(fooP);
+ }
+
+ NS_RELEASE(barP);
+ }
+
+ return result;
+ }
+
+
+static
+nsresult
+TestBloat_Smart()
+ {
+ nsCOMPtr<IBar> barP;
+ nsresult result = CreateIBar( getter_AddRefs(barP) );
+
+ nsCOMPtr<IFoo> fooP( do_QueryInterface(barP, &result) );
+
+ if ( fooP )
+ fooP->print_totals();
+
+ return result;
+ }
+
+
+
+
+nsCOMPtr<IFoo> gFoop;
+
+int
+main()
+ {
+ printf(">>main()\n");
+
+ printf("sizeof(nsCOMPtr<IFoo>) --> %zd\n", sizeof(nsCOMPtr<IFoo>));
+
+#ifdef TEST_EXCEPTIONS
+ TestBloat_Raw();
+#endif // TEST_EXCEPTIONS
+ TestBloat_Raw_Unsafe();
+ TestBloat_Smart();
+
+
+ {
+ printf("\n### Test 1: will a |nsCOMPtr| call |AddRef| on a pointer assigned into it?\n");
+ nsCOMPtr<IFoo> foop( do_QueryInterface(new IFoo) );
+
+ printf("\n### Test 2: will a |nsCOMPtr| |Release| its old pointer when a new one is assigned in?\n");
+ foop = do_QueryInterface(new IFoo);
+
+ // [Shouldn't compile] Is it a compile time error to try to |AddRef| by hand?
+ //foop->AddRef();
+
+ // [Shouldn't compile] Is it a compile time error to try to |Release| be hand?
+ //foop->Release();
+
+ // [Shouldn't compile] Is it a compile time error to try to |delete| an |nsCOMPtr|?
+ //delete foop;
+
+ printf("\n### Test 3: can you |AddRef| if you must?\n");
+ STATIC_CAST(IFoo*, foop)->AddRef();
+
+ printf("\n### Test 4: can you |Release| if you must?\n");
+ STATIC_CAST(IFoo*, foop)->Release();
+
+ printf("\n### Test 5: will a |nsCOMPtr| |Release| when it goes out of scope?\n");
+ }
+
+ {
+ printf("\n### Test 6: will a |nsCOMPtr| call the correct destructor?\n");
+ nsCOMPtr<IFoo> foop( do_QueryInterface(new IBar) );
+ }
+
+ {
+ printf("\n### Test 7: can you compare one |nsCOMPtr| with another [!=]?\n");
+
+ nsCOMPtr<IFoo> foo1p( do_QueryInterface(new IFoo) );
+
+ // [Shouldn't compile] Is it a compile time error to omit |getter_[doesnt_]AddRef[s]|?
+ //AnIFooPtrPtrContext(&foo1p);
+
+ // [Shouldn't compile] Is it a compile time error to omit |getter_[doesnt_]AddRef[s]|?
+ //AVoidPtrPtrContext(&foo1p);
+
+ nsCOMPtr<IFoo> foo2p( do_QueryInterface(new IFoo) );
+
+ if ( foo1p != foo2p )
+ printf("foo1p != foo2p\n");
+ else
+ printf("foo1p == foo2p\n");
+
+ printf("\n### Test 7.5: can you compare a |nsCOMPtr| with NULL, 0, nsnull [!=]?\n");
+ if ( foo1p != 0 )
+ printf("foo1p != 0\n");
+ if ( 0 != foo1p )
+ printf("0 != foo1p\n");
+ if ( foo1p == 0 )
+ printf("foo1p == 0\n");
+ if ( 0 == foo1p )
+ printf("0 == foo1p\n");
+
+
+ IFoo* raw_foo2p = foo2p.get();
+
+ printf("\n### Test 8: can you compare a |nsCOMPtr| with a raw interface pointer [!=]?\n");
+ if ( foo1p.get() != raw_foo2p )
+ printf("foo1p != raw_foo2p\n");
+ else
+ printf("foo1p == raw_foo2p\n");
+
+
+ printf("\n### Test 9: can you assign one |nsCOMPtr| into another?\n");
+ foo1p = foo2p;
+
+ printf("\n### Test 10: can you compare one |nsCOMPtr| with another [==]?\n");
+ if ( foo1p == foo2p )
+ printf("foo1p == foo2p\n");
+ else
+ printf("foo1p != foo2p\n");
+
+ printf("\n### Test 11: can you compare a |nsCOMPtr| with a raw interface pointer [==]?\n");
+ if ( raw_foo2p == foo2p.get() )
+ printf("raw_foo2p == foo2p\n");
+ else
+ printf("raw_foo2p != foo2p\n");
+
+#if 1
+ printf("\n### Test 11.5: can you compare a |nsCOMPtr| with a raw interface pointer [==]?\n");
+ if ( nsCOMPtr<IFoo>( raw_foo2p ) == foo2p )
+ printf("raw_foo2p == foo2p\n");
+ else
+ printf("raw_foo2p != foo2p\n");
+#endif
+
+ printf("\n### Test 12: bare pointer test?\n");
+ if ( foo1p )
+ printf("foo1p is not NULL\n");
+ else
+ printf("foo1p is NULL\n");
+
+ printf("\n### Test 13: numeric pointer test?\n");
+ if ( foo1p == 0 )
+ printf("foo1p is NULL\n");
+ else
+ printf("foo1p is not NULL\n");
+
+#if 0
+ if ( foo1p == 1 )
+ printf("foo1p allowed compare with in\n");
+#endif
+
+ printf("\n### Test 14: how about when two |nsCOMPtr|s referring to the same object go out of scope?\n");
+ }
+
+ {
+ printf("\n### Test 15,16 ...setup...\n");
+ IFoo* raw_foo1p = new IFoo;
+ raw_foo1p->AddRef();
+
+ IFoo* raw_foo2p = new IFoo;
+ raw_foo2p->AddRef();
+
+ printf("\n### Test 15: what if I don't want to |AddRef| when I construct?\n");
+ nsCOMPtr<IFoo> foo1p( dont_AddRef(raw_foo1p) );
+ //nsCOMPtr<IFoo> foo1p = dont_AddRef(raw_foo1p);
+
+ printf("\n### Test 16: what if I don't want to |AddRef| when I assign in?\n");
+ nsCOMPtr<IFoo> foo2p;
+ foo2p = dont_AddRef(raw_foo2p);
+ }
+
+
+
+
+
+
+
+ {
+ printf("\n### setup for Test 17\n");
+ nsCOMPtr<IFoo> foop;
+ printf("### Test 17: basic parameter behavior?\n");
+ CreateIFoo( nsGetterAddRefs<IFoo>(foop) );
+ }
+ printf("### End Test 17\n");
+
+
+ {
+ printf("\n### setup for Test 18\n");
+ nsCOMPtr<IFoo> foop;
+ printf("### Test 18: basic parameter behavior, using the short form?\n");
+ CreateIFoo( getter_AddRefs(foop) );
+ }
+ printf("### End Test 18\n");
+
+
+ {
+ printf("\n### setup for Test 19, 20\n");
+ nsCOMPtr<IFoo> foop;
+ printf("### Test 19: reference parameter behavior?\n");
+ set_a_IFoo(address_of(foop));
+
+ printf("### Test 20: return value behavior?\n");
+ foop = return_a_IFoo();
+ }
+ printf("### End Test 19, 20\n");
+
+ {
+ printf("\n### setup for Test 21\n");
+ nsCOMPtr<IFoo> fooP;
+
+ printf("### Test 21: is |QueryInterface| called on assigning in a raw pointer?\n");
+ fooP = do_QueryInterface(new IFoo);
+ }
+ printf("### End Test 21\n");
+
+ {
+ printf("\n### setup for Test 22\n");
+ nsCOMPtr<IFoo> fooP;
+ fooP = do_QueryInterface(new IFoo);
+
+ nsCOMPtr<IFoo> foo2P;
+
+ printf("### Test 22: is |QueryInterface| _not_ called when assigning in a smart-pointer of the same type?\n");
+ foo2P = fooP;
+ }
+ printf("### End Test 22\n");
+
+ {
+ printf("\n### setup for Test 23\n");
+ nsCOMPtr<IBar> barP( do_QueryInterface(new IBar) );
+
+ printf("### Test 23: is |QueryInterface| called when assigning in a smart-pointer of a different type?\n");
+
+ nsCOMPtr<IFoo> fooP( do_QueryInterface(barP) );
+ if ( fooP )
+ printf("an IBar* is an IFoo*\n");
+ }
+ printf("### End Test 23\n");
+
+
+ {
+ nsCOMPtr<IFoo> fooP;
+
+ AnIFooPtrPtrContext( getter_AddRefs(fooP) );
+ AVoidPtrPtrContext( getter_AddRefs(fooP) );
+ AnISupportsPtrPtrContext( getter_AddRefs(fooP) );
+ }
+
+
+ {
+ nsCOMPtr<nsISupports> supportsP;
+
+ AVoidPtrPtrContext( getter_AddRefs(supportsP) );
+ AnISupportsPtrPtrContext( getter_AddRefs(supportsP) );
+ }
+
+
+ printf("\n### Test 24: will a static |nsCOMPtr| |Release| before program termination?\n");
+ gFoop = do_QueryInterface(new IFoo);
+
+ printf("<<main()\n");
+ return 0;
+ }
+
generated by cgit v1.2.3 (git 2.39.1) at 2024-07-02 14:50:34 +0000