/usr/include/thunderbird/nsISupportsUtils.h is in thunderbird-dev 1:38.6.0+build1-0ubuntu1.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 | /* -*- Mode: C++; tab-width: 8; indent-tabs-mode: nil; c-basic-offset: 2 -*- */
/* vim: set ts=8 sts=2 et sw=2 tw=80: */
/* This Source Code Form is subject to the terms of the Mozilla Public
* License, v. 2.0. If a copy of the MPL was not distributed with this
* file, You can obtain one at http://mozilla.org/MPL/2.0/. */
#ifndef nsISupportsUtils_h__
#define nsISupportsUtils_h__
#include "nscore.h"
#include "nsISupportsBase.h"
#include "nsError.h"
#include "nsDebug.h"
#include "nsISupportsImpl.h"
#include "mozilla/TypeTraits.h"
/**
* Macro for adding a reference to an interface.
* @param _ptr The interface pointer.
*/
#define NS_ADDREF(_ptr) \
(_ptr)->AddRef()
/**
* Macro for adding a reference to this. This macro should be used
* because NS_ADDREF (when tracing) may require an ambiguous cast
* from the pointers primary type to nsISupports. This macro sidesteps
* that entire problem.
*/
#define NS_ADDREF_THIS() \
AddRef()
extern "C++" {
// ...because some one is accidentally including this file inside
// an |extern "C"|
// Making this a |inline| |template| allows |aExpr| to be evaluated only once,
// yet still denies you the ability to |AddRef()| an |nsCOMPtr|.
template<class T>
inline void
ns_if_addref(T aExpr)
{
if (aExpr) {
aExpr->AddRef();
}
}
} /* extern "C++" */
/**
* Macro for adding a reference to an interface that checks for nullptr.
* @param _expr The interface pointer.
*/
#define NS_IF_ADDREF(_expr) ns_if_addref(_expr)
/*
* Given these declarations, it explicitly OK and efficient to end a `getter' with:
*
* NS_IF_ADDREF(*result = mThing);
*
* even if |mThing| is an |nsCOMPtr|. If |mThing| is an |nsCOMPtr|, however, it is still
* _illegal_ to say |NS_IF_ADDREF(mThing)|.
*/
/**
* Macro for releasing a reference to an interface.
* @param _ptr The interface pointer.
*/
#define NS_RELEASE(_ptr) \
do { \
(_ptr)->Release(); \
(_ptr) = 0; \
} while (0)
/**
* Macro for releasing a reference to this interface.
*/
#define NS_RELEASE_THIS() \
Release()
/**
* Macro for releasing a reference to an interface, except that this
* macro preserves the return value from the underlying Release call.
* The interface pointer argument will only be NULLed if the reference count
* goes to zero.
*
* @param _ptr The interface pointer.
* @param _rc The reference count.
*/
#define NS_RELEASE2(_ptr, _rc) \
do { \
_rc = (_ptr)->Release(); \
if (0 == (_rc)) (_ptr) = 0; \
} while (0)
/**
* Macro for releasing a reference to an interface that checks for nullptr;
* @param _ptr The interface pointer.
*/
#define NS_IF_RELEASE(_ptr) \
do { \
if (_ptr) { \
(_ptr)->Release(); \
(_ptr) = 0; \
} \
} while (0)
/*
* Often you have to cast an implementation pointer, e.g., |this|, to an
* |nsISupports*|, but because you have multiple inheritance, a simple cast
* is ambiguous. One could simply say, e.g., (given a base |nsIBase|),
* |static_cast<nsIBase*>(this)|; but that disguises the fact that what
* you are really doing is disambiguating the |nsISupports|. You could make
* that more obvious with a double cast, e.g., |static_cast<nsISupports*>
(* static_cast<nsIBase*>(this))|, but that is bulky and harder to read...
*
* The following macro is clean, short, and obvious. In the example above,
* you would use it like this: |NS_ISUPPORTS_CAST(nsIBase*, this)|.
*/
#define NS_ISUPPORTS_CAST(__unambiguousBase, __expr) \
static_cast<nsISupports*>(static_cast<__unambiguousBase>(__expr))
// a type-safe shortcut for calling the |QueryInterface()| member function
template<class T, class DestinationType>
inline nsresult
CallQueryInterface(T* aSource, DestinationType** aDestination)
{
// We permit nsISupports-to-nsISupports here so that one can still obtain
// the canonical nsISupports pointer with CallQueryInterface.
static_assert(!mozilla::IsSame<T, DestinationType>::value ||
mozilla::IsSame<DestinationType, nsISupports>::value,
"don't use CallQueryInterface for compile-time-determinable casts");
NS_PRECONDITION(aSource, "null parameter");
NS_PRECONDITION(aDestination, "null parameter");
return aSource->QueryInterface(NS_GET_TEMPLATE_IID(DestinationType),
reinterpret_cast<void**>(aDestination));
}
#endif /* __nsISupportsUtils_h */
|