/usr/include/thunderbird/nsVariant.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 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 | /* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*-
*
* 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/. */
/* The long avoided variant support for xpcom. */
#ifndef nsVariant_h
#define nsVariant_h
#include "nsIVariant.h"
#include "nsStringFwd.h"
#include "mozilla/Attributes.h"
class nsCycleCollectionTraversalCallback;
/**
* Map the nsAUTF8String, nsUTF8String classes to the nsACString and
* nsCString classes respectively for now. These defines need to be removed
* once Jag lands his nsUTF8String implementation.
*/
#define nsAUTF8String nsACString
#define nsUTF8String nsCString
#define PromiseFlatUTF8String PromiseFlatCString
/**
* nsDiscriminatedUnion is a type that nsIVariant implementors *may* use
* to hold underlying data. It has no methods. So, its use requires no linkage
* to the xpcom module.
*/
struct nsDiscriminatedUnion
{
union
{
int8_t mInt8Value;
int16_t mInt16Value;
int32_t mInt32Value;
int64_t mInt64Value;
uint8_t mUint8Value;
uint16_t mUint16Value;
uint32_t mUint32Value;
uint64_t mUint64Value;
float mFloatValue;
double mDoubleValue;
bool mBoolValue;
char mCharValue;
char16_t mWCharValue;
nsIID mIDValue;
nsAString* mAStringValue;
nsAUTF8String* mUTF8StringValue;
nsACString* mCStringValue;
struct
{
// This is an owning reference that cannot be an nsCOMPtr because
// nsDiscriminatedUnion needs to be POD. AddRef/Release are manually
// called on this.
nsISupports* MOZ_OWNING_REF mInterfaceValue;
nsIID mInterfaceID;
} iface;
struct
{
nsIID mArrayInterfaceID;
void* mArrayValue;
uint32_t mArrayCount;
uint16_t mArrayType;
} array;
struct
{
char* mStringValue;
uint32_t mStringLength;
} str;
struct
{
char16_t* mWStringValue;
uint32_t mWStringLength;
} wstr;
} u;
uint16_t mType;
};
/**
* nsVariant implements the generic variant support. The xpcom module registers
* a factory (see NS_VARIANT_CONTRACTID in nsIVariant.idl) that will create
* these objects. They are created 'empty' and 'writable'.
*
* nsIVariant users won't usually need to see this class.
*
* This class also has static helper methods that nsIVariant *implementors* can
* use to help them do all the 'standard' nsIVariant data conversions.
*/
class nsVariant final : public nsIWritableVariant
{
public:
NS_DECL_ISUPPORTS
NS_DECL_NSIVARIANT
NS_DECL_NSIWRITABLEVARIANT
nsVariant();
static nsresult Initialize(nsDiscriminatedUnion* aData);
static nsresult Cleanup(nsDiscriminatedUnion* aData);
static nsresult ConvertToInt8(const nsDiscriminatedUnion& aData,
uint8_t* aResult);
static nsresult ConvertToInt16(const nsDiscriminatedUnion& aData,
int16_t* aResult);
static nsresult ConvertToInt32(const nsDiscriminatedUnion& aData,
int32_t* aResult);
static nsresult ConvertToInt64(const nsDiscriminatedUnion& aData,
int64_t* aResult);
static nsresult ConvertToUint8(const nsDiscriminatedUnion& aData,
uint8_t* aResult);
static nsresult ConvertToUint16(const nsDiscriminatedUnion& aData,
uint16_t* aResult);
static nsresult ConvertToUint32(const nsDiscriminatedUnion& aData,
uint32_t* aResult);
static nsresult ConvertToUint64(const nsDiscriminatedUnion& aData,
uint64_t* aResult);
static nsresult ConvertToFloat(const nsDiscriminatedUnion& aData,
float* aResult);
static nsresult ConvertToDouble(const nsDiscriminatedUnion& aData,
double* aResult);
static nsresult ConvertToBool(const nsDiscriminatedUnion& aData,
bool* aResult);
static nsresult ConvertToChar(const nsDiscriminatedUnion& aData,
char* aResult);
static nsresult ConvertToWChar(const nsDiscriminatedUnion& aData,
char16_t* aResult);
static nsresult ConvertToID(const nsDiscriminatedUnion& aData,
nsID* aResult);
static nsresult ConvertToAString(const nsDiscriminatedUnion& aData,
nsAString& aResult);
static nsresult ConvertToAUTF8String(const nsDiscriminatedUnion& aData,
nsAUTF8String& aResult);
static nsresult ConvertToACString(const nsDiscriminatedUnion& aData,
nsACString& aResult);
static nsresult ConvertToString(const nsDiscriminatedUnion& aData,
char** aResult);
static nsresult ConvertToWString(const nsDiscriminatedUnion& aData,
char16_t** aResult);
static nsresult ConvertToISupports(const nsDiscriminatedUnion& aData,
nsISupports** aResult);
static nsresult ConvertToInterface(const nsDiscriminatedUnion& aData,
nsIID** aIID, void** aInterface);
static nsresult ConvertToArray(const nsDiscriminatedUnion& aData,
uint16_t* aType, nsIID* aIID,
uint32_t* aCount, void** aPtr);
static nsresult ConvertToStringWithSize(const nsDiscriminatedUnion& aData,
uint32_t* aSize, char** aStr);
static nsresult ConvertToWStringWithSize(const nsDiscriminatedUnion& aData,
uint32_t* aSize, char16_t** aStr);
static nsresult SetFromVariant(nsDiscriminatedUnion* aData,
nsIVariant* aValue);
static nsresult SetFromInt8(nsDiscriminatedUnion* aData, uint8_t aValue);
static nsresult SetFromInt16(nsDiscriminatedUnion* aData, int16_t aValue);
static nsresult SetFromInt32(nsDiscriminatedUnion* aData, int32_t aValue);
static nsresult SetFromInt64(nsDiscriminatedUnion* aData, int64_t aValue);
static nsresult SetFromUint8(nsDiscriminatedUnion* aData, uint8_t aValue);
static nsresult SetFromUint16(nsDiscriminatedUnion* aData, uint16_t aValue);
static nsresult SetFromUint32(nsDiscriminatedUnion* aData, uint32_t aValue);
static nsresult SetFromUint64(nsDiscriminatedUnion* aData, uint64_t aValue);
static nsresult SetFromFloat(nsDiscriminatedUnion* aData, float aValue);
static nsresult SetFromDouble(nsDiscriminatedUnion* aData, double aValue);
static nsresult SetFromBool(nsDiscriminatedUnion* aData, bool aValue);
static nsresult SetFromChar(nsDiscriminatedUnion* aData, char aValue);
static nsresult SetFromWChar(nsDiscriminatedUnion* aData, char16_t aValue);
static nsresult SetFromID(nsDiscriminatedUnion* aData, const nsID& aValue);
static nsresult SetFromAString(nsDiscriminatedUnion* aData,
const nsAString& aValue);
static nsresult SetFromAUTF8String(nsDiscriminatedUnion* aData,
const nsAUTF8String& aValue);
static nsresult SetFromACString(nsDiscriminatedUnion* aData,
const nsACString& aValue);
static nsresult SetFromString(nsDiscriminatedUnion* aData,
const char* aValue);
static nsresult SetFromWString(nsDiscriminatedUnion* aData,
const char16_t* aValue);
static nsresult SetFromISupports(nsDiscriminatedUnion* aData,
nsISupports* aValue);
static nsresult SetFromInterface(nsDiscriminatedUnion* aData,
const nsIID& aIID, nsISupports* aValue);
static nsresult SetFromArray(nsDiscriminatedUnion* aData, uint16_t aType,
const nsIID* aIID, uint32_t aCount,
void* aValue);
static nsresult SetFromStringWithSize(nsDiscriminatedUnion* aData,
uint32_t aSize, const char* aValue);
static nsresult SetFromWStringWithSize(nsDiscriminatedUnion* aData,
uint32_t aSize,
const char16_t* aValue);
// Like SetFromWStringWithSize, but leaves the string uninitialized. It does
// does write the null-terminator.
static nsresult AllocateWStringWithSize(nsDiscriminatedUnion* aData,
uint32_t aSize);
static nsresult SetToVoid(nsDiscriminatedUnion* aData);
static nsresult SetToEmpty(nsDiscriminatedUnion* aData);
static nsresult SetToEmptyArray(nsDiscriminatedUnion* aData);
static void Traverse(const nsDiscriminatedUnion& aData,
nsCycleCollectionTraversalCallback& aCb);
private:
~nsVariant();
protected:
nsDiscriminatedUnion mData;
bool mWritable;
};
/**
* Users of nsIVariant should be using the contractID and not this CID.
* - see NS_VARIANT_CONTRACTID in nsIVariant.idl.
*/
#define NS_VARIANT_CID \
{ /* 0D6EA1D0-879C-11d5-90EF-0010A4E73D9A */ \
0xd6ea1d0, \
0x879c, \
0x11d5, \
{0x90, 0xef, 0x0, 0x10, 0xa4, 0xe7, 0x3d, 0x9a}}
#endif // nsVariant_h
|