1998-12-17 22:12:45 +03:00
|
|
|
/* -*- 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.
|
|
|
|
*/
|
|
|
|
|
|
|
|
#ifndef nsCOMPtr_h___
|
|
|
|
#define nsCOMPtr_h___
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
// Wrapping includes can speed up compiles (see "Large Scale C++ Software Design")
|
|
|
|
#ifndef nsDebug_h___
|
|
|
|
#include "nsDebug.h"
|
|
|
|
// for |NS_PRECONDITION|
|
|
|
|
#endif
|
|
|
|
|
|
|
|
#ifndef nsISupports_h___
|
|
|
|
#include "nsISupports.h"
|
1998-12-22 02:26:39 +03:00
|
|
|
// for |nsresult|, |NS_ADDREF|, et al
|
1998-12-17 22:12:45 +03:00
|
|
|
#endif
|
|
|
|
|
|
|
|
|
1999-02-11 04:34:07 +03:00
|
|
|
/*
|
1999-02-17 04:58:25 +03:00
|
|
|
TO DO...
|
|
|
|
|
|
|
|
+ make alternative function for |getter_AddRefs| (or something)
|
|
|
|
+ make constructor for |nsQueryInterface| explicit (suddenly construct/assign from raw pointer becomes illegal)
|
1999-02-11 04:34:07 +03:00
|
|
|
+ Improve internal documentation
|
|
|
|
+ mention *&
|
1999-02-17 04:58:25 +03:00
|
|
|
+ alternatives for comparison
|
|
|
|
+ do_QueryInterface
|
1999-02-11 04:34:07 +03:00
|
|
|
*/
|
|
|
|
|
|
|
|
|
1998-12-17 22:12:45 +03:00
|
|
|
|
|
|
|
/* USER MANUAL
|
|
|
|
|
1998-12-18 06:45:44 +03:00
|
|
|
See also:
|
|
|
|
<http://www.meer.net/ScottCollins/doc/nsCOMPtr.html>, or
|
1999-01-06 00:07:57 +03:00
|
|
|
<http://www.mozilla.org/projects/xpcom/nsCOMPtr.html>
|
1998-12-18 06:45:44 +03:00
|
|
|
|
1998-12-17 22:12:45 +03:00
|
|
|
What is |nsCOMPtr|?
|
|
|
|
|
|
|
|
|nsCOMPtr| is a `smart-pointer'. It is a template class that acts, syntactically,
|
|
|
|
just like an ordinary pointer in C or C++, i.e., you can apply |*| or |->| to it to
|
|
|
|
`get to' what it points at. |nsCOMPtr| is smart in that, unlike a raw COM
|
|
|
|
interface pointer, |nsCOMPtr| manages |AddRef|, |Release|, and |QueryInterface|
|
|
|
|
_for_ you.
|
|
|
|
|
|
|
|
For instance, here is a typical snippet of code (at its most compact) where you assign
|
|
|
|
a COM interface pointer into a member variable:
|
|
|
|
|
|
|
|
NS_IF_RELEASE(mFoop); // If I have one already, I must release it before over-writing it.
|
|
|
|
if ( mFooP = aPtr ) // Now it's safe to assign it in, and, if it's not NULL
|
|
|
|
mFooP->AddRef(); // I must |AddRef| it, since I'll be holding on to it.
|
|
|
|
|
|
|
|
If our member variable |mFooP| were a |nsCOMPtr|, however, the snippet above
|
|
|
|
would look like this:
|
|
|
|
|
|
|
|
mFoop = aPtr; // Note: automatically |Release|s the old and |AddRef|s the new
|
|
|
|
|
|
|
|
|nsCOMPtr| helps you write code that is leak-proof, exception safe, and significantly
|
|
|
|
less verbose than you would with raw COM interface pointers. With |nsCOMPtr|, you
|
|
|
|
may never have to call |AddRef|, |Release|, or |QueryInterface| by hand.
|
|
|
|
|
|
|
|
|
|
|
|
You still have to understand COM. You still have to know which functions return
|
|
|
|
interface pointers that have already been |AddRef|ed and which don't. You still
|
|
|
|
have to ensure your program logic doesn't produce circularly referencing garbage.
|
|
|
|
|nsCOMPtr| is not a panacea. It is, however, helpful, easy to use, well-tested,
|
|
|
|
and polite. It doesn't require that a function author cooperate with you, nor does
|
|
|
|
your use force others to use it.
|
|
|
|
|
|
|
|
|
|
|
|
Where should I use |nsCOMPtr|?
|
|
|
|
|
|
|
|
...
|
|
|
|
|
|
|
|
|
|
|
|
Where _shouldn't_ I use |nsCOMPtr|?
|
|
|
|
|
1998-12-18 06:45:44 +03:00
|
|
|
In public interfaces... [[others]]
|
1998-12-17 22:12:45 +03:00
|
|
|
|
|
|
|
|
|
|
|
How does a |nsCOMPtr| differ from a raw pointer?
|
|
|
|
|
|
|
|
A |nsCOMPtr| differs, syntactically, from a raw COM interface pointer in three
|
|
|
|
ways:
|
|
|
|
|
|
|
|
+ It's declared differently, e.g.,
|
|
|
|
|
|
|
|
// instead of saying // you say
|
|
|
|
IFoo* fooP; nsCOMPtr<IFoo> fooP;
|
|
|
|
|
|
|
|
|
|
|
|
+ You can't call |AddRef| or |Release| through it,
|
|
|
|
|
|
|
|
fooP->AddRef(); // OK fooP->AddRef(); // Error: no permission
|
|
|
|
fooP->Release(); // OK fooP->Release(); // Error: no permission
|
|
|
|
|
|
|
|
|
|
|
|
+ You can't just apply an |&| to it to pass it to the typical `getter' function
|
|
|
|
|
|
|
|
AcquireFoo(&fooP); AcquireFoo( getter_AddRefs(fooP) );
|
|
|
|
GetFoo(&fooP); GetFoo( getter_doesnt_AddRef(fooP) );
|
|
|
|
|
|
|
|
|
|
|
|
How do I use |nsCOMPtr|?
|
|
|
|
|
|
|
|
Typically, you can use a |nsCOMPtr| exactly as you would a standard COM
|
|
|
|
interface pointer:
|
|
|
|
|
|
|
|
IFoo* fooP; nsCOMPtr<IFoo> fooP;
|
|
|
|
// ... // ...
|
|
|
|
fooP->SomeFunction(x, y, z); fooP->SomeFunction(x, y, z);
|
|
|
|
AnotherFunction(fooP); AnotherFunction(fooP);
|
|
|
|
|
|
|
|
if ( fooP ) if ( fooP )
|
|
|
|
// ... // ...
|
|
|
|
|
|
|
|
if ( fooP == barP ) if ( fooP == barP )
|
|
|
|
// ... // ...
|
|
|
|
|
|
|
|
There are some differences, though. In particular, you can't call |AddRef| or |Release|
|
|
|
|
through a |nsCOMPtr| directly, nor would you need to. |AddRef| is called for you
|
|
|
|
whenever you assign a COM interface pointer _into_ a |nsCOMPtr|. |Release| is
|
|
|
|
called on the old value, and also when the |nsCOMPtr| goes out of scope. Trying
|
|
|
|
to call |AddRef| or |Release| yourself will generate a compile-time error.
|
|
|
|
|
|
|
|
fooP->AddRef(); // fooP->AddRef(); // ERROR: no permission
|
|
|
|
fooP->Release(); // fooP->Release(); // ERROR: no permission
|
|
|
|
|
|
|
|
The final difference is that a bare |nsCOMPtr| (or rather a pointer to it) can't
|
|
|
|
be supplied as an argument to a function that `fills in' a COM interface pointer.
|
|
|
|
Rather it must be wrapped with a utility call that says whether the function calls
|
|
|
|
|AddRef| before returning, e.g.,
|
|
|
|
|
1998-12-18 06:45:44 +03:00
|
|
|
...->QueryInterface(riid, &fooP) ...->QueryInterface(riid, getter_AddRefs(fooP))
|
1998-12-17 22:12:45 +03:00
|
|
|
|
|
|
|
LookupFoo(&fooP); LookupFoo( getter_doesnt_AddRef(fooP) );
|
|
|
|
|
|
|
|
Don't worry. It's a compile-time error if you forget to wrap it.
|
|
|
|
|
1999-02-17 04:58:25 +03:00
|
|
|
Compare the raw-pointer way...
|
1998-12-17 22:12:45 +03:00
|
|
|
|
|
|
|
IFoo* foo = 0;
|
|
|
|
nsresult status = CreateIFoo(&foo);
|
|
|
|
if ( NS_SUCCEEDED(status) )
|
|
|
|
{
|
|
|
|
IBar* bar = 0;
|
|
|
|
if ( NS_SUCCEEDED(status = foo->QueryInterface(riid, &bar)) )
|
|
|
|
{
|
|
|
|
IFooBar* foobar = 0;
|
|
|
|
if ( NS_SUCCEEDED(status = CreateIFooBar(foo, bar, &foobar)) )
|
|
|
|
{
|
|
|
|
foobar->DoTheReallyHardThing();
|
|
|
|
foobar->Release();
|
|
|
|
}
|
|
|
|
bar->Release();
|
|
|
|
}
|
|
|
|
foo->Release();
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
|
|
|
1999-02-17 04:58:25 +03:00
|
|
|
To the smart-pointer way...
|
1998-12-17 22:12:45 +03:00
|
|
|
|
1999-02-17 04:58:25 +03:00
|
|
|
nsCOMPtr<IFoo> fooP;
|
|
|
|
nsresult status = CreateIFoo( getter_AddRefs(fooP) );
|
|
|
|
if ( NS_SUCCEEDED(status) )
|
|
|
|
if ( nsCOMPtr<IBar> barP( fooP ) )
|
|
|
|
{
|
|
|
|
nsCOMPtr<IFooBar> fooBarP;
|
|
|
|
if ( NS_SUCCEEDED(status = CreateIFooBar(fooP, barP, getter_AddRefs(fooBarP))) )
|
|
|
|
fooBarP->DoTheReallyHardThing();
|
|
|
|
}
|
1998-12-17 22:12:45 +03:00
|
|
|
|
|
|
|
|
|
|
|
Is there an easy way to convert my current code?
|
|
|
|
|
|
|
|
...
|
|
|
|
|
|
|
|
|
|
|
|
What do I have to beware of?
|
|
|
|
|
1998-12-18 06:45:44 +03:00
|
|
|
VC++ < 6.0 _can't_ handle the following situation
|
|
|
|
|
|
|
|
class nsIFoo; // forward declare some class
|
|
|
|
// ...
|
|
|
|
nsCOMPtr<nsIFoo> bar; // ERROR: incomplete type nsIFoo, etc.
|
|
|
|
|
|
|
|
Instead, you must make sure that you actually defined the underlying interface class, e.g.,
|
|
|
|
|
|
|
|
#include "nsIFoo.h" // fully defines |class nsIFoo|
|
|
|
|
// ...
|
|
|
|
nsCOMPtr<nsIFoo> bar; // no problem
|
|
|
|
|
|
|
|
Why is this? It's because VC++ tries to instantiate every member of the template
|
|
|
|
as soon as it sees the template declarations. Bad compiler. No cookie!
|
|
|
|
[[Thanks to mjudge, waterson, and pinkerton on this one.]]
|
|
|
|
|
|
|
|
|
|
|
|
Why does |getter_AddRefs| have such a funny name? I.e., why doesn't it follow our
|
|
|
|
naming conventions?
|
|
|
|
|
|
|
|
|getter_AddRefs| and |getter_doesnt_AddRef| use underscores for the same
|
|
|
|
reason our special macros do, quoting from our coding conventions "...to make them
|
|
|
|
stick out like a sore thumb". Note also that since |AddRef| is one word,
|
|
|
|
|getter_AddRefs| and |getter_doesnt_AddRef| couldn't have the right spacing if only inter-
|
|
|
|
caps were used.
|
1998-12-17 22:12:45 +03:00
|
|
|
*/
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
1998-12-18 06:45:44 +03:00
|
|
|
/*
|
|
|
|
WARNING:
|
|
|
|
This file defines several macros for internal use only. These macros begin with the
|
|
|
|
prefix |NSCAP_|. Do not use these macros in your own code. They are for internal use
|
|
|
|
only for cross-platform compatibility, and are subject to change without notice.
|
|
|
|
*/
|
|
|
|
|
|
|
|
|
1998-12-17 22:12:45 +03:00
|
|
|
/*
|
1998-12-18 06:45:44 +03:00
|
|
|
Set up some |#define|s to turn off a couple of troublesome C++ features.
|
1998-12-17 22:12:45 +03:00
|
|
|
Interestingly, none of the compilers barf on template stuff.
|
|
|
|
|
|
|
|
Ideally, we would want declarations like these in a configuration file
|
1998-12-18 06:45:44 +03:00
|
|
|
that everybody would get. Deciding exactly how to do that should
|
1998-12-17 22:12:45 +03:00
|
|
|
be part of the process of moving from experimental to production.
|
1999-01-06 00:07:57 +03:00
|
|
|
|
|
|
|
Update: ramiro is working on getting these into the configuration system.
|
1998-12-17 22:12:45 +03:00
|
|
|
*/
|
|
|
|
|
1999-03-01 13:13:18 +03:00
|
|
|
#ifndef HAVE_CPP_EXPLICIT
|
|
|
|
#define NSCAP_NO_EXPLICIT
|
|
|
|
#endif
|
|
|
|
|
|
|
|
#ifndef HAVE_CPP_USING
|
|
|
|
#define NSCAP_NO_MEMBER_USING_DECLARATIONS
|
|
|
|
#endif
|
|
|
|
|
|
|
|
/* HAVE_CPP_NEW_CASTS test is not strict enough yet. scc? */
|
|
|
|
#if 0
|
|
|
|
#ifndef HAVE_CPP_NEW_CASTS
|
|
|
|
#define NSCAP_NO_NEW_CASTS
|
|
|
|
#endif
|
|
|
|
#endif
|
|
|
|
|
|
|
|
#ifdef NEED_CPP_UNUSED_IMPLEMENTATIONS
|
|
|
|
#define NSCAP_NEED_UNUSED_VIRTUAL_IMPLEMENTATIONS
|
|
|
|
#endif
|
|
|
|
|
1999-01-18 23:32:41 +03:00
|
|
|
#if defined(__GNUG__) && (__GNUC_MINOR__ <= 90) && !defined(SOLARIS)
|
1998-12-17 22:12:45 +03:00
|
|
|
#define NSCAP_NO_MEMBER_USING_DECLARATIONS
|
1999-01-06 00:07:57 +03:00
|
|
|
|
1999-01-18 21:32:33 +03:00
|
|
|
#if (defined(LINUX) || defined(__bsdi__)) && (__GNUC_MINOR__ <= 7)
|
1999-01-06 00:07:57 +03:00
|
|
|
#define NSCAP_NEED_UNUSED_VIRTUAL_IMPLEMENTATIONS
|
|
|
|
#endif
|
1998-12-17 22:12:45 +03:00
|
|
|
#endif
|
|
|
|
|
1999-02-19 01:34:15 +03:00
|
|
|
#if defined(SOLARIS) && !defined(__GNUG__)
|
|
|
|
#define NSCAP_NO_EXPLICIT
|
|
|
|
#define NSCAP_NO_NEW_CASTS
|
|
|
|
#define NSCAP_NO_MEMBER_USING_DECLARATIONS
|
|
|
|
#endif
|
|
|
|
|
1999-02-27 02:43:40 +03:00
|
|
|
#if defined(_MSC_VER)
|
|
|
|
#if (_MSC_VER<1100)
|
|
|
|
// before 5.0, VC++ couldn't handle explicit
|
|
|
|
#define NSCAP_NO_EXPLICIT
|
|
|
|
#elif (_MSC_VER==1100)
|
|
|
|
// VC++5.0 has an internal compiler error (sometimes) without this
|
|
|
|
#define NSCAP_NO_MEMBER_USING_DECLARATIONS
|
|
|
|
#endif
|
1998-12-17 22:12:45 +03:00
|
|
|
#endif
|
|
|
|
|
1999-03-01 09:29:14 +03:00
|
|
|
#if defined(IRIX) || defined(AIX)
|
1998-12-17 22:12:45 +03:00
|
|
|
#define NSCAP_NO_MEMBER_USING_DECLARATIONS
|
|
|
|
#define NSCAP_NO_EXPLICIT
|
|
|
|
#define NSCAP_NO_NEW_CASTS
|
|
|
|
#endif
|
|
|
|
|
1999-02-25 20:47:54 +03:00
|
|
|
#if defined(HPUX)
|
|
|
|
#define NSCAP_NO_MEMBER_USING_DECLARATIONS
|
|
|
|
#define NSCAP_NO_NEW_CASTS
|
|
|
|
#endif
|
1998-12-17 22:12:45 +03:00
|
|
|
|
1999-02-26 21:58:08 +03:00
|
|
|
#if defined(AIX)
|
1999-02-27 02:43:40 +03:00
|
|
|
#define NSCAP_NO_EXPLICIT
|
1999-02-26 21:58:08 +03:00
|
|
|
#define NSCAP_NO_NEW_CASTS
|
1999-02-27 02:43:40 +03:00
|
|
|
#define NSCAP_NO_MEMBER_USING_DECLARATIONS
|
1999-02-26 21:58:08 +03:00
|
|
|
#endif
|
|
|
|
|
1998-12-17 22:12:45 +03:00
|
|
|
#ifdef NSCAP_NO_EXPLICIT
|
|
|
|
#define explicit
|
|
|
|
#endif
|
|
|
|
|
|
|
|
#ifndef NSCAP_NO_NEW_CASTS
|
|
|
|
#define NSCAP_REINTERPRET_CAST(T,x) reinterpret_cast<T>(x)
|
|
|
|
#else
|
|
|
|
#define NSCAP_REINTERPRET_CAST(T,x) ((T)(x))
|
|
|
|
#endif
|
|
|
|
|
1998-12-22 02:26:39 +03:00
|
|
|
#ifdef NSCAP_FEATURE_DEBUG_MACROS
|
1999-02-17 04:58:25 +03:00
|
|
|
#define NSCAP_ADDREF(ptr) NS_ADDREF(ptr)
|
|
|
|
#define NSCAP_RELEASE(ptr) NS_RELEASE(ptr)
|
1998-12-22 02:26:39 +03:00
|
|
|
#else
|
1999-02-17 04:58:25 +03:00
|
|
|
#define NSCAP_ADDREF(ptr) (ptr)->AddRef()
|
|
|
|
#define NSCAP_RELEASE(ptr) (ptr)->Release()
|
1998-12-22 02:26:39 +03:00
|
|
|
#endif
|
|
|
|
|
1999-02-17 04:58:25 +03:00
|
|
|
/*
|
|
|
|
WARNING:
|
|
|
|
VC++4.2 is very picky. To compile under VC++4.2, the classes must be defined
|
|
|
|
in an order that satisfies:
|
|
|
|
|
|
|
|
nsDerivedSafe < nsCOMPtr
|
|
|
|
nsDontAddRef < nsCOMPtr
|
|
|
|
nsCOMPtr < nsGetterAddRefs
|
1998-12-18 06:45:44 +03:00
|
|
|
|
1999-02-17 04:58:25 +03:00
|
|
|
The other compilers probably won't complain, so please don't reorder these
|
|
|
|
classes, on pain of breaking 4.2 compatibility.
|
|
|
|
*/
|
1998-12-18 06:45:44 +03:00
|
|
|
|
1998-12-17 22:12:45 +03:00
|
|
|
|
|
|
|
template <class T>
|
|
|
|
class nsDerivedSafe : public T
|
|
|
|
/*
|
|
|
|
No client should ever see or have to type the name of this class. It is the
|
|
|
|
artifact that makes it a compile-time error to call |AddRef| and |Release|
|
|
|
|
on a |nsCOMPtr|.
|
|
|
|
|
|
|
|
See |nsCOMPtr::operator->|, |nsCOMPtr::operator*|, et al.
|
|
|
|
*/
|
|
|
|
{
|
|
|
|
private:
|
|
|
|
#ifndef NSCAP_NO_MEMBER_USING_DECLARATIONS
|
|
|
|
using T::AddRef;
|
|
|
|
using T::Release;
|
|
|
|
#else
|
1999-02-27 02:43:40 +03:00
|
|
|
NS_IMETHOD_(nsrefcnt) AddRef(void);
|
|
|
|
NS_IMETHOD_(nsrefcnt) Release(void);
|
1998-12-17 22:12:45 +03:00
|
|
|
#endif
|
|
|
|
|
1999-02-17 04:58:25 +03:00
|
|
|
void operator delete( void* ); // NOT TO BE IMPLEMENTED
|
|
|
|
// declaring |operator delete| private makes calling delete on an interface pointer a compile error
|
1998-12-18 06:45:44 +03:00
|
|
|
|
1999-02-27 02:43:40 +03:00
|
|
|
nsDerivedSafe<T>& operator=( const nsDerivedSafe<T>& ); // NOT TO BE IMPLEMENTED
|
1999-02-17 04:58:25 +03:00
|
|
|
// you may not call |operator=()| through a dereferenced |nsCOMPtr|, because you'd get the wrong one
|
1998-12-17 22:12:45 +03:00
|
|
|
};
|
|
|
|
|
|
|
|
#if defined(NSCAP_NO_MEMBER_USING_DECLARATIONS) && defined(NSCAP_NEED_UNUSED_VIRTUAL_IMPLEMENTATIONS)
|
|
|
|
template <class T>
|
|
|
|
nsrefcnt
|
|
|
|
nsDerivedSafe<T>::AddRef()
|
|
|
|
{
|
|
|
|
return 0;
|
|
|
|
}
|
|
|
|
|
|
|
|
template <class T>
|
|
|
|
nsrefcnt
|
|
|
|
nsDerivedSafe<T>::Release()
|
|
|
|
{
|
|
|
|
return 0;
|
|
|
|
}
|
|
|
|
|
|
|
|
#endif
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
1999-02-17 04:58:25 +03:00
|
|
|
template <class T>
|
|
|
|
struct nsDontQueryInterface
|
|
|
|
/*
|
|
|
|
...
|
|
|
|
*/
|
|
|
|
{
|
|
|
|
explicit
|
|
|
|
nsDontQueryInterface( T* aRawPtr )
|
|
|
|
: mRawPtr(aRawPtr)
|
|
|
|
{
|
|
|
|
// nothing else to do here
|
|
|
|
}
|
|
|
|
|
|
|
|
T* mRawPtr;
|
|
|
|
};
|
|
|
|
|
|
|
|
template <class T>
|
|
|
|
inline
|
|
|
|
nsDontQueryInterface<T>
|
|
|
|
dont_QueryInterface( T* aRawPtr )
|
|
|
|
{
|
|
|
|
return nsDontQueryInterface<T>(aRawPtr);
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
struct nsQueryInterface
|
|
|
|
{
|
|
|
|
// explicit
|
|
|
|
nsQueryInterface( nsISupports* aRawPtr, nsresult* error = 0 )
|
|
|
|
: mRawPtr(aRawPtr),
|
|
|
|
mErrorPtr(error)
|
|
|
|
{
|
|
|
|
// nothing else to do here
|
|
|
|
}
|
|
|
|
|
|
|
|
nsISupports* mRawPtr;
|
|
|
|
nsresult* mErrorPtr;
|
|
|
|
};
|
|
|
|
|
|
|
|
inline
|
|
|
|
nsQueryInterface
|
|
|
|
do_QueryInterface( nsISupports* aRawPtr, nsresult* error = 0 )
|
|
|
|
{
|
|
|
|
return nsQueryInterface(aRawPtr, error);
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
1998-12-17 22:12:45 +03:00
|
|
|
template <class T>
|
|
|
|
struct nsDontAddRef
|
|
|
|
/*
|
|
|
|
...cooperates with |nsCOMPtr| to allow you to assign in a pointer _without_
|
|
|
|
|AddRef|ing it. You would rarely use this directly, but rather through the
|
|
|
|
machinery of |getter_AddRefs| in the argument list to functions that |AddRef|
|
|
|
|
their results before returning them to the caller.
|
|
|
|
|
|
|
|
See also |getter_AddRefs()| and |class nsGetterAddRefs|.
|
|
|
|
*/
|
|
|
|
{
|
|
|
|
explicit
|
|
|
|
nsDontAddRef( T* aRawPtr )
|
|
|
|
: mRawPtr(aRawPtr)
|
|
|
|
{
|
|
|
|
// nothing else to do here
|
|
|
|
}
|
|
|
|
|
|
|
|
T* mRawPtr;
|
|
|
|
};
|
|
|
|
|
1999-02-26 22:50:46 +03:00
|
|
|
// This call is now deprecated. Use |getter_AddRefs()| instead.
|
1998-12-17 22:12:45 +03:00
|
|
|
template <class T>
|
1998-12-22 02:26:39 +03:00
|
|
|
inline
|
1998-12-17 22:12:45 +03:00
|
|
|
nsDontAddRef<T>
|
|
|
|
dont_AddRef( T* aRawPtr )
|
|
|
|
/*
|
|
|
|
...makes typing easier, because it deduces the template type, e.g.,
|
|
|
|
you write |dont_AddRef(fooP)| instead of |nsDontAddRef<IFoo>(fooP)|.
|
|
|
|
*/
|
|
|
|
{
|
|
|
|
return nsDontAddRef<T>(aRawPtr);
|
|
|
|
}
|
|
|
|
|
1999-02-26 22:50:46 +03:00
|
|
|
template <class T>
|
|
|
|
inline
|
|
|
|
nsDontAddRef<T>
|
|
|
|
getter_AddRefs( T* aRawPtr )
|
|
|
|
{
|
|
|
|
return nsDontAddRef<T>(aRawPtr);
|
|
|
|
}
|
|
|
|
|
1998-12-17 22:12:45 +03:00
|
|
|
|
|
|
|
|
1999-02-17 04:58:25 +03:00
|
|
|
class nsCOMPtr_base
|
|
|
|
{
|
|
|
|
public:
|
1998-12-17 22:12:45 +03:00
|
|
|
|
1999-02-17 04:58:25 +03:00
|
|
|
nsCOMPtr_base( nsISupports* rawPtr = 0 )
|
|
|
|
: mRawPtr(rawPtr)
|
|
|
|
{
|
|
|
|
// nothing else to do here
|
|
|
|
}
|
1998-12-22 02:26:39 +03:00
|
|
|
|
1999-02-17 04:58:25 +03:00
|
|
|
~nsCOMPtr_base()
|
|
|
|
{
|
|
|
|
if ( mRawPtr )
|
|
|
|
NSCAP_RELEASE(mRawPtr);
|
|
|
|
}
|
|
|
|
|
|
|
|
NS_EXPORT void assign_with_AddRef( nsISupports* );
|
|
|
|
NS_EXPORT void assign_with_QueryInterface( nsISupports*, const nsIID&, nsresult* );
|
|
|
|
NS_EXPORT void** begin_assignment();
|
|
|
|
|
|
|
|
protected:
|
|
|
|
nsISupports* mRawPtr;
|
|
|
|
};
|
1998-12-22 02:26:39 +03:00
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
1998-12-17 22:12:45 +03:00
|
|
|
template <class T>
|
1999-02-17 04:58:25 +03:00
|
|
|
class nsCOMPtr : private nsCOMPtr_base
|
1998-12-17 22:12:45 +03:00
|
|
|
/*
|
|
|
|
...
|
|
|
|
*/
|
|
|
|
{
|
|
|
|
public:
|
|
|
|
typedef T element_type;
|
|
|
|
|
1999-02-17 04:58:25 +03:00
|
|
|
nsCOMPtr()
|
|
|
|
// : nsCOMPtr_base(0)
|
|
|
|
{
|
|
|
|
// nothing else to do here
|
|
|
|
}
|
|
|
|
|
|
|
|
nsCOMPtr( const nsQueryInterface& aSmartPtr )
|
|
|
|
// : nsCOMPtr_base(0)
|
|
|
|
{
|
|
|
|
assign_with_QueryInterface(aSmartPtr.mRawPtr, T::IID(), aSmartPtr.mErrorPtr);
|
|
|
|
}
|
1998-12-17 22:12:45 +03:00
|
|
|
|
|
|
|
nsCOMPtr( const nsDontAddRef<T>& aSmartPtr )
|
1999-02-17 04:58:25 +03:00
|
|
|
: nsCOMPtr_base(aSmartPtr.mRawPtr)
|
1998-12-17 22:12:45 +03:00
|
|
|
{
|
|
|
|
// nothing else to do here
|
|
|
|
}
|
|
|
|
|
1999-02-17 04:58:25 +03:00
|
|
|
nsCOMPtr( const nsDontQueryInterface<T>& aSmartPtr )
|
|
|
|
: nsCOMPtr_base(aSmartPtr.mRawPtr)
|
|
|
|
{
|
|
|
|
if ( mRawPtr )
|
|
|
|
NSCAP_ADDREF(mRawPtr);
|
|
|
|
}
|
1998-12-22 02:26:39 +03:00
|
|
|
|
1998-12-17 22:12:45 +03:00
|
|
|
nsCOMPtr( const nsCOMPtr<T>& aSmartPtr )
|
1999-02-17 04:58:25 +03:00
|
|
|
: nsCOMPtr_base(aSmartPtr.mRawPtr)
|
1998-12-17 22:12:45 +03:00
|
|
|
{
|
|
|
|
if ( mRawPtr )
|
1999-02-17 04:58:25 +03:00
|
|
|
NSCAP_ADDREF(mRawPtr);
|
1998-12-17 22:12:45 +03:00
|
|
|
}
|
|
|
|
|
1999-02-17 04:58:25 +03:00
|
|
|
nsCOMPtr<T>&
|
|
|
|
operator=( const nsQueryInterface& rhs )
|
1998-12-17 22:12:45 +03:00
|
|
|
{
|
1999-02-17 04:58:25 +03:00
|
|
|
assign_with_QueryInterface(rhs.mRawPtr, T::IID(), rhs.mErrorPtr);
|
|
|
|
return *this;
|
1998-12-17 22:12:45 +03:00
|
|
|
}
|
|
|
|
|
1999-02-17 04:58:25 +03:00
|
|
|
nsCOMPtr<T>&
|
1998-12-17 22:12:45 +03:00
|
|
|
operator=( const nsDontAddRef<T>& rhs )
|
|
|
|
{
|
1999-02-17 04:58:25 +03:00
|
|
|
if ( mRawPtr )
|
|
|
|
NSCAP_RELEASE(mRawPtr);
|
1998-12-17 22:12:45 +03:00
|
|
|
mRawPtr = rhs.mRawPtr;
|
|
|
|
return *this;
|
|
|
|
}
|
|
|
|
|
1999-02-17 04:58:25 +03:00
|
|
|
nsCOMPtr<T>&
|
|
|
|
operator=( const nsDontQueryInterface<T>& rhs )
|
|
|
|
{
|
|
|
|
assign_with_AddRef(rhs.mRawPtr);
|
|
|
|
return *this;
|
|
|
|
}
|
|
|
|
|
|
|
|
nsCOMPtr<T>&
|
1999-02-27 02:43:40 +03:00
|
|
|
operator=( const nsCOMPtr<T>& rhs )
|
1999-02-17 04:58:25 +03:00
|
|
|
{
|
|
|
|
assign_with_AddRef(rhs.mRawPtr);
|
|
|
|
return *this;
|
|
|
|
}
|
|
|
|
|
|
|
|
nsDerivedSafe<T>*
|
|
|
|
get() const
|
|
|
|
// returns a |nsDerivedSafe<T>*| to deny clients the use of |AddRef| and |Release|
|
|
|
|
{
|
|
|
|
return NSCAP_REINTERPRET_CAST(nsDerivedSafe<T>*, mRawPtr);
|
|
|
|
}
|
1998-12-17 22:12:45 +03:00
|
|
|
|
|
|
|
nsDerivedSafe<T>*
|
|
|
|
operator->() const
|
|
|
|
// returns a |nsDerivedSafe<T>*| to deny clients the use of |AddRef| and |Release|
|
|
|
|
{
|
|
|
|
NS_PRECONDITION(mRawPtr != 0, "You can't dereference a NULL nsCOMPtr with operator->().");
|
|
|
|
return get();
|
|
|
|
}
|
|
|
|
|
|
|
|
nsDerivedSafe<T>&
|
|
|
|
operator*() const
|
|
|
|
// returns a |nsDerivedSafe<T>*| to deny clients the use of |AddRef| and |Release|
|
|
|
|
{
|
|
|
|
NS_PRECONDITION(mRawPtr != 0, "You can't dereference a NULL nsCOMPtr with operator*().");
|
|
|
|
return *get();
|
|
|
|
}
|
|
|
|
|
|
|
|
operator nsDerivedSafe<T>*() const
|
|
|
|
{
|
|
|
|
return get();
|
|
|
|
}
|
|
|
|
|
|
|
|
#if 0
|
|
|
|
private:
|
|
|
|
friend class nsGetterAddRefs<T>;
|
|
|
|
|
|
|
|
/*
|
1999-02-17 04:58:25 +03:00
|
|
|
In a perfect world, the following member function, |StartAssignment|, would be private.
|
|
|
|
It is and should be only accessed by the closely related class |nsGetterAddRefs<T>|.
|
1998-12-17 22:12:45 +03:00
|
|
|
|
|
|
|
Unfortunately, some compilers---most notably VC++5.0---fail to grok the
|
1999-02-17 04:58:25 +03:00
|
|
|
friend declaration above or in any alternate acceptable form. So, physically
|
|
|
|
it will be public (until our compilers get smarter); but it is not to be
|
1998-12-17 22:12:45 +03:00
|
|
|
considered part of the logical public interface.
|
|
|
|
*/
|
|
|
|
#endif
|
|
|
|
|
|
|
|
T**
|
1999-02-17 04:58:25 +03:00
|
|
|
StartAssignment()
|
1998-12-17 22:12:45 +03:00
|
|
|
{
|
1999-02-17 04:58:25 +03:00
|
|
|
return NSCAP_REINTERPRET_CAST(T**, begin_assignment());
|
1998-12-17 22:12:45 +03:00
|
|
|
}
|
|
|
|
};
|
|
|
|
|
|
|
|
|
|
|
|
template <class T>
|
|
|
|
class nsGetterAddRefs
|
|
|
|
/*
|
|
|
|
...
|
|
|
|
|
|
|
|
This class is designed to be used for anonymous temporary objects in the
|
|
|
|
argument list of calls that return COM interface pointers, e.g.,
|
|
|
|
|
|
|
|
nsCOMPtr<IFoo> fooP;
|
|
|
|
...->QueryInterface(iid, nsGetterAddRefs<IFoo>(fooP))
|
|
|
|
...->QueryInterface(iid, getter_AddRefs(fooP))
|
|
|
|
|
|
|
|
When initialized with a |nsCOMPtr|, as in the example above, it returns
|
|
|
|
a |void**| (or |T**| if needed) that the outer call (|QueryInterface| in this
|
1999-02-26 22:50:46 +03:00
|
|
|
case) can fill in.
|
1998-12-17 22:12:45 +03:00
|
|
|
*/
|
|
|
|
{
|
|
|
|
public:
|
|
|
|
explicit
|
|
|
|
nsGetterAddRefs( nsCOMPtr<T>& aSmartPtr )
|
1999-02-17 04:58:25 +03:00
|
|
|
: mTargetSmartPtr(aSmartPtr)
|
1998-12-17 22:12:45 +03:00
|
|
|
{
|
|
|
|
// nothing else to do
|
|
|
|
}
|
|
|
|
|
|
|
|
operator void**()
|
|
|
|
{
|
1999-02-17 04:58:25 +03:00
|
|
|
// NS_PRECONDITION(mTargetSmartPtr != 0, "getter_AddRefs into no destination");
|
|
|
|
return NSCAP_REINTERPRET_CAST(void**, mTargetSmartPtr.StartAssignment());
|
1998-12-17 22:12:45 +03:00
|
|
|
}
|
|
|
|
|
|
|
|
T*&
|
|
|
|
operator*()
|
|
|
|
{
|
1999-02-17 04:58:25 +03:00
|
|
|
// NS_PRECONDITION(mTargetSmartPtr != 0, "getter_AddRefs into no destination");
|
|
|
|
return *(mTargetSmartPtr.StartAssignment());
|
1998-12-17 22:12:45 +03:00
|
|
|
}
|
|
|
|
|
|
|
|
operator T**()
|
|
|
|
{
|
1999-02-17 04:58:25 +03:00
|
|
|
// NS_PRECONDITION(mTargetSmartPtr != 0, "getter_AddRefs into no destination");
|
|
|
|
return mTargetSmartPtr.StartAssignment();
|
1998-12-17 22:12:45 +03:00
|
|
|
}
|
|
|
|
|
|
|
|
private:
|
1999-02-17 04:58:25 +03:00
|
|
|
nsCOMPtr<T>& mTargetSmartPtr;
|
1998-12-17 22:12:45 +03:00
|
|
|
};
|
|
|
|
|
|
|
|
template <class T>
|
|
|
|
inline
|
|
|
|
nsGetterAddRefs<T>
|
|
|
|
getter_AddRefs( nsCOMPtr<T>& aSmartPtr )
|
|
|
|
/*
|
|
|
|
Used around a |nsCOMPtr| when
|
|
|
|
...makes the class |nsGetterAddRefs<T>| invisible.
|
|
|
|
*/
|
|
|
|
{
|
|
|
|
return nsGetterAddRefs<T>(aSmartPtr);
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
#endif // !defined(nsCOMPtr_h___)
|