First Checked In.
This commit is contained in:
scc@netscape.com
478
xpcom/tests/TestCOMPtr.cpp
Normal file
478
xpcom/tests/TestCOMPtr.cpp
Normal file
@@ -0,0 +1,478 @@
|
||||
/* -*- Mode: C++; tab-width: 2; indent-tabs-mode: nil; c-basic-offset: 2 -*- */
|
||||
/*
|
||||
* The contents of this file are subject to the Netscape Public License
|
||||
* Version 1.0 (the "NPL"); you may not use this file except in
|
||||
* compliance with the NPL. You may obtain a copy of the NPL at
|
||||
* http://www.mozilla.org/NPL/
|
||||
*
|
||||
* Software distributed under the NPL is distributed on an "AS IS" basis,
|
||||
* WITHOUT WARRANTY OF ANY KIND, either express or implied. See the NPL
|
||||
* for the specific language governing rights and limitations under the
|
||||
* NPL.
|
||||
*
|
||||
* The Initial Developer of this code under the NPL is Netscape
|
||||
* Communications Corporation. Portions created by Netscape are
|
||||
* Copyright (C) 1998 Netscape Communications Corporation. All Rights
|
||||
* Reserved.
|
||||
*/
|
||||
|
||||
#include <iostream.h>
|
||||
#include <assert.h>
|
||||
#include "nsCOMPtr.h"
|
||||
#include "nsISupports.h"
|
||||
|
||||
|
||||
|
||||
#ifndef NSCAP_NO_NEW_CASTS
|
||||
#define STATIC_CAST(T,x) static_cast<T>(x)
|
||||
#else
|
||||
#define STATIC_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:
|
||||
static const nsIID& IID() { static nsIID iid = NS_IFOO_IID; return iid; }
|
||||
|
||||
public:
|
||||
IFoo();
|
||||
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 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()
|
||||
{
|
||||
cout << "BEGIN unit tests for |nsCOMPtr|, compiled " __DATE__ << endl;
|
||||
}
|
||||
|
||||
~test_message()
|
||||
{
|
||||
IFoo::print_totals();
|
||||
cout << "END unit tests for |nsCOMPtr|." << endl;
|
||||
}
|
||||
};
|
||||
|
||||
test_message gTestMessage;
|
||||
|
||||
|
||||
/*
|
||||
...
|
||||
*/
|
||||
|
||||
void
|
||||
IFoo::print_totals()
|
||||
{
|
||||
cout << "total constructions/destructions --> " << total_constructions_ << "/" << total_destructions_ << endl;
|
||||
}
|
||||
|
||||
IFoo::IFoo()
|
||||
: refcount_(0)
|
||||
{
|
||||
++total_constructions_;
|
||||
cout << " new IFoo@" << STATIC_CAST(void*, this) << " [#" << total_constructions_ << "]" << endl;
|
||||
}
|
||||
|
||||
IFoo::~IFoo()
|
||||
{
|
||||
++total_destructions_;
|
||||
cout << "IFoo@" << STATIC_CAST(void*, this) << "::~IFoo()" << " [#" << total_destructions_ << "]" << endl;
|
||||
}
|
||||
|
||||
nsrefcnt
|
||||
IFoo::AddRef()
|
||||
{
|
||||
++refcount_;
|
||||
cout << "IFoo@" << STATIC_CAST(void*, this) << "::AddRef(), refcount --> " << refcount_ << endl;
|
||||
return refcount_;
|
||||
}
|
||||
|
||||
nsrefcnt
|
||||
IFoo::Release()
|
||||
{
|
||||
int wrap_message = (refcount_ == 1);
|
||||
if ( wrap_message )
|
||||
cout << ">>";
|
||||
|
||||
--refcount_;
|
||||
cout << "IFoo@" << STATIC_CAST(void*, this) << "::Release(), refcount --> " << refcount_ << endl;
|
||||
|
||||
if ( !refcount_ )
|
||||
{
|
||||
cout << " delete IFoo@" << STATIC_CAST(void*, this) << endl;
|
||||
delete this;
|
||||
}
|
||||
|
||||
if ( wrap_message )
|
||||
cout << "<<IFoo@" << STATIC_CAST(void*, this) << "::Release()" << endl;
|
||||
|
||||
return refcount_;
|
||||
}
|
||||
|
||||
nsresult
|
||||
IFoo::QueryInterface( const nsIID& aIID, void** aResult )
|
||||
{
|
||||
cout << "IFoo@" << STATIC_CAST(void*, this) << "::QueryInterface()" << endl;
|
||||
nsISupports* rawPtr = 0;
|
||||
nsresult status = NS_OK;
|
||||
|
||||
if ( aIID.Equals(IID()) )
|
||||
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)
|
||||
{
|
||||
cout << ">>CreateIFoo() --> ";
|
||||
IFoo* foop = new IFoo;
|
||||
cout << "IFoo@" << STATIC_CAST(void*, foop) << endl;
|
||||
|
||||
foop->AddRef();
|
||||
*result = foop;
|
||||
|
||||
cout << "<<CreateIFoo()" << endl;
|
||||
return 0;
|
||||
}
|
||||
|
||||
void
|
||||
set_a_IFoo( nsCOMPtr<IFoo>* result )
|
||||
{
|
||||
cout << ">>set_a_IFoo()" << endl;
|
||||
assert(result);
|
||||
|
||||
nsCOMPtr<IFoo> foop( new IFoo );
|
||||
*result = foop;
|
||||
cout << "<<set_a_IFoo()" << endl;
|
||||
}
|
||||
|
||||
nsCOMPtr<IFoo>
|
||||
return_a_IFoo()
|
||||
{
|
||||
cout << ">>return_a_IFoo()" << endl;
|
||||
nsCOMPtr<IFoo> foop( new IFoo );
|
||||
cout << "<<return_a_IFoo()" << endl;
|
||||
return foop;
|
||||
}
|
||||
|
||||
|
||||
|
||||
|
||||
#define NS_IBAR_IID \
|
||||
{ 0x6f7652e1, 0xee43, 0x11d1, \
|
||||
{ 0x9c, 0xc3, 0x00, 0x60, 0x08, 0x8c, 0xa6, 0xb3 } }
|
||||
|
||||
class IBar : public IFoo
|
||||
{
|
||||
public:
|
||||
static const nsIID& IID() { static nsIID iid = NS_IBAR_IID; return iid; }
|
||||
|
||||
public:
|
||||
IBar();
|
||||
virtual ~IBar();
|
||||
|
||||
NS_IMETHOD QueryInterface( const nsIID&, void** );
|
||||
};
|
||||
|
||||
IBar::IBar()
|
||||
{
|
||||
cout << " new IBar@" << STATIC_CAST(void*, this) << endl;
|
||||
}
|
||||
|
||||
IBar::~IBar()
|
||||
{
|
||||
cout << "IBar@" << STATIC_CAST(void*, this) << "::~IBar()" << endl;
|
||||
}
|
||||
|
||||
nsresult
|
||||
IBar::QueryInterface( const nsID& aIID, void** aResult )
|
||||
{
|
||||
cout << "IBar@" << STATIC_CAST(void*, this) << "::QueryInterface()" << endl;
|
||||
nsISupports* rawPtr = 0;
|
||||
nsresult status = NS_OK;
|
||||
|
||||
if ( aIID.Equals(IID()) )
|
||||
rawPtr = this;
|
||||
else if ( aIID.Equals(IFoo::IID()) )
|
||||
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)
|
||||
{
|
||||
cout << ">>CreateIBar() --> ";
|
||||
IBar* barp = new IBar;
|
||||
cout << "IBar@" << STATIC_CAST(void*, barp) << endl;
|
||||
|
||||
barp->AddRef();
|
||||
*result = barp;
|
||||
|
||||
cout << "<<CreateIBar()" << endl;
|
||||
return 0;
|
||||
}
|
||||
|
||||
void
|
||||
AnIFooPtrPtrContext( IFoo** )
|
||||
{
|
||||
}
|
||||
|
||||
void
|
||||
AVoidPtrPtrContext( void** )
|
||||
{
|
||||
}
|
||||
|
||||
|
||||
|
||||
nsCOMPtr<IFoo> gFoop;
|
||||
|
||||
int
|
||||
main()
|
||||
{
|
||||
cout << ">>main()" << endl;
|
||||
|
||||
|
||||
{
|
||||
cout << endl << "### Test 1: will a |nsCOMPtr| call |AddRef| on a pointer assigned into it?" << endl;
|
||||
nsCOMPtr<IFoo> foop( new IFoo );
|
||||
|
||||
cout << endl << "### Test 2: will a |nsCOMPtr| |Release| its old pointer when a new one is assigned in?" << endl;
|
||||
foop = 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();
|
||||
|
||||
cout << endl << "### Test 3: can you |AddRef| if you must?" << endl;
|
||||
STATIC_CAST(IFoo*, foop)->AddRef();
|
||||
|
||||
cout << endl << "### Test 4: can you |Release| if you must?" << endl;
|
||||
STATIC_CAST(IFoo*, foop)->Release();
|
||||
|
||||
cout << endl << "### Test 5: will a |nsCOMPtr| |Release| when it goes out of scope?" << endl;
|
||||
}
|
||||
|
||||
{
|
||||
cout << endl << "### Test 6: will a |nsCOMPtr| call the correct destructor?" << endl;
|
||||
nsCOMPtr<IFoo> foop( new IBar );
|
||||
}
|
||||
|
||||
{
|
||||
cout << endl << "### Test 7: can you compare one |nsCOMPtr| with another [!=]?" << endl;
|
||||
|
||||
nsCOMPtr<IFoo> foo1p( 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( new IFoo );
|
||||
|
||||
if ( foo1p != foo2p )
|
||||
cout << "foo1p != foo2p" << endl;
|
||||
else
|
||||
cout << "foo1p == foo2p" << endl;
|
||||
|
||||
IFoo* raw_foo2p = foo2p.get();
|
||||
|
||||
cout << endl << "### Test 8: can you compare a |nsCOMPtr| with a raw interface pointer [!=]?" << endl;
|
||||
if ( foo1p != raw_foo2p )
|
||||
cout << "foo1p != raw_foo2p" << endl;
|
||||
else
|
||||
cout << "foo1p == raw_foo2p" << endl;
|
||||
|
||||
|
||||
cout << endl << "### Test 9: can you assign one |nsCOMPtr| into another?" << endl;
|
||||
foo1p = foo2p;
|
||||
|
||||
cout << endl << "### Test 10: can you compare one |nsCOMPtr| with another [==]?" << endl;
|
||||
if ( foo1p == foo2p )
|
||||
cout << "foo1p == foo2p" << endl;
|
||||
else
|
||||
cout << "foo1p != foo2p" << endl;
|
||||
|
||||
cout << endl << "### Test 11: can you compare a |nsCOMPtr| with a raw interface pointer [==]?" << endl;
|
||||
if ( raw_foo2p == foo2p )
|
||||
cout << "raw_foo2p == foo2p" << endl;
|
||||
else
|
||||
cout << "raw_foo2p != foo2p" << endl;
|
||||
|
||||
cout << endl << "### Test 12: bare pointer test?" << endl;
|
||||
if ( foo1p )
|
||||
cout << "foo1p is not NULL" << endl;
|
||||
else
|
||||
cout << "foo1p is NULL" << endl;
|
||||
|
||||
cout << endl << "### Test 13: numeric pointer test?" << endl;
|
||||
if ( foo1p == 0 )
|
||||
cout << "foo1p is NULL" << endl;
|
||||
else
|
||||
cout << "foo1p is not NULL" << endl;
|
||||
|
||||
cout << endl << "### Test 14: how about when two |nsCOMPtr|s refering to the same object go out of scope?" << endl;
|
||||
}
|
||||
|
||||
{
|
||||
#ifdef NSCAP_FEATURE_DONT_ADDREF
|
||||
cout << endl << "### Test 15,16 ...setup..." << endl;
|
||||
IFoo* raw_foo1p = new IFoo;
|
||||
raw_foo1p->AddRef();
|
||||
|
||||
IFoo* raw_foo2p = new IFoo;
|
||||
raw_foo2p->AddRef();
|
||||
|
||||
cout << endl << "### Test 15: what if I don't want to |AddRef| when I construct?" << endl;
|
||||
nsCOMPtr<IFoo> foo1p( dont_AddRef(raw_foo1p) );
|
||||
//nsCOMPtr<IFoo> foo1p = dont_AddRef(raw_foo1p);
|
||||
|
||||
cout << endl << "### Test 16: what if I don't want to |AddRef| when I assign in?" << endl;
|
||||
nsCOMPtr<IFoo> foo2p;
|
||||
foo2p = dont_AddRef(raw_foo2p);
|
||||
#endif
|
||||
}
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
{
|
||||
cout << endl << "### setup for Test 17" << endl;
|
||||
nsCOMPtr<IFoo> foop;
|
||||
cout << "### Test 17: basic parameter behavior?" << endl;
|
||||
CreateIFoo( nsGetterAddRefs<IFoo>(foop) );
|
||||
}
|
||||
cout << "### End Test 17" << endl;
|
||||
|
||||
|
||||
{
|
||||
cout << endl << "### setup for Test 18" << endl;
|
||||
nsCOMPtr<IFoo> foop;
|
||||
cout << "### Test 18: basic parameter behavior, using the short form?" << endl;
|
||||
CreateIFoo( getter_AddRefs(foop) );
|
||||
}
|
||||
cout << "### End Test 18" << endl;
|
||||
|
||||
|
||||
{
|
||||
cout << endl << "### setup for Test 19, 20" << endl;
|
||||
nsCOMPtr<IFoo> foop;
|
||||
cout << "### Test 19: reference parameter behavior?" << endl;
|
||||
set_a_IFoo(&foop);
|
||||
|
||||
cout << "### Test 20: return value behavior?" << endl;
|
||||
foop = return_a_IFoo();
|
||||
}
|
||||
cout << "### End Test 19, 20" << endl;
|
||||
|
||||
{
|
||||
cout << endl << "### setup for Test 21" << endl;
|
||||
nsCOMPtr<IFoo> fooP;
|
||||
|
||||
cout << "### Test 21: is |QueryInterface| called on assigning in a raw pointer?" << endl;
|
||||
fooP = new IFoo;
|
||||
}
|
||||
cout << "### End Test 21" << endl;
|
||||
|
||||
{
|
||||
cout << endl << "### setup for Test 22" << endl;
|
||||
nsCOMPtr<IFoo> fooP;
|
||||
fooP = new IFoo;
|
||||
|
||||
nsCOMPtr<IFoo> foo2P;
|
||||
|
||||
cout << "### Test 22: is |QueryInterface| _not_ called when assigning in a smart-pointer of the same type?" << endl;
|
||||
foo2P = fooP;
|
||||
}
|
||||
cout << "### End Test 22" << endl;
|
||||
|
||||
{
|
||||
cout << endl << "### setup for Test 23" << endl;
|
||||
nsCOMPtr<IBar> barP( new IBar );
|
||||
|
||||
cout << "### Test 23: is |QueryInterface| called when assigning in a smart-pointer of a different type?" << endl;
|
||||
|
||||
nsCOMPtr<IFoo> fooP( barP );
|
||||
if ( fooP )
|
||||
cout << "an IBar* is an IFoo*" << endl;
|
||||
}
|
||||
cout << "### End Test 23" << endl;
|
||||
|
||||
|
||||
cout << endl << "### Test 24: will a static |nsCOMPtr| |Release| before program termination?" << endl;
|
||||
gFoop = new IFoo;
|
||||
|
||||
cout << "<<main()" << endl;
|
||||
return 0;
|
||||
}
|
||||
|
||||
Reference in New Issue
Block a user