/* -*- Mode: IDL; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- * * ***** 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): * John Bandhauer * * 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 ***** */ /* The long avoided variant support for xpcom. */ #include "nsIVariant.h" #include "nsStringFwd.h" #include "xpt_struct.h" /** * 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 { PRInt8 mInt8Value; PRInt16 mInt16Value; PRInt32 mInt32Value; PRInt64 mInt64Value; PRUint8 mUint8Value; PRUint16 mUint16Value; PRUint32 mUint32Value; PRUint64 mUint64Value; float mFloatValue; double mDoubleValue; PRBool mBoolValue; char mCharValue; PRUnichar mWCharValue; nsIID mIDValue; nsAString* mAStringValue; nsAUTF8String* mUTF8StringValue; nsACString* mCStringValue; struct { nsISupports* mInterfaceValue; nsIID mInterfaceID; } iface; struct { nsIID mArrayInterfaceID; void* mArrayValue; PRUint32 mArrayCount; PRUint16 mArrayType; } array; struct { char* mStringValue; PRUint32 mStringLength; } str; struct { PRUnichar* mWStringValue; PRUint32 mWStringLength; } wstr; } u; PRUint16 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 NS_COM nsVariant : public nsIWritableVariant { public: NS_DECL_ISUPPORTS NS_DECL_NSIVARIANT NS_DECL_NSIWRITABLEVARIANT nsVariant(); static nsresult Initialize(nsDiscriminatedUnion* data); static nsresult Cleanup(nsDiscriminatedUnion* data); static nsresult ConvertToInt8(const nsDiscriminatedUnion& data, PRUint8 *_retval); static nsresult ConvertToInt16(const nsDiscriminatedUnion& data, PRInt16 *_retval); static nsresult ConvertToInt32(const nsDiscriminatedUnion& data, PRInt32 *_retval); static nsresult ConvertToInt64(const nsDiscriminatedUnion& data, PRInt64 *_retval); static nsresult ConvertToUint8(const nsDiscriminatedUnion& data, PRUint8 *_retval); static nsresult ConvertToUint16(const nsDiscriminatedUnion& data, PRUint16 *_retval); static nsresult ConvertToUint32(const nsDiscriminatedUnion& data, PRUint32 *_retval); static nsresult ConvertToUint64(const nsDiscriminatedUnion& data, PRUint64 *_retval); static nsresult ConvertToFloat(const nsDiscriminatedUnion& data, float *_retval); static nsresult ConvertToDouble(const nsDiscriminatedUnion& data, double *_retval); static nsresult ConvertToBool(const nsDiscriminatedUnion& data, PRBool *_retval); static nsresult ConvertToChar(const nsDiscriminatedUnion& data, char *_retval); static nsresult ConvertToWChar(const nsDiscriminatedUnion& data, PRUnichar *_retval); static nsresult ConvertToID(const nsDiscriminatedUnion& data, nsID * _retval); static nsresult ConvertToAString(const nsDiscriminatedUnion& data, nsAString & _retval); static nsresult ConvertToAUTF8String(const nsDiscriminatedUnion& data, nsAUTF8String & _retval); static nsresult ConvertToACString(const nsDiscriminatedUnion& data, nsACString & _retval); static nsresult ConvertToString(const nsDiscriminatedUnion& data, char **_retval); static nsresult ConvertToWString(const nsDiscriminatedUnion& data, PRUnichar **_retval); static nsresult ConvertToISupports(const nsDiscriminatedUnion& data, nsISupports **_retval); static nsresult ConvertToInterface(const nsDiscriminatedUnion& data, nsIID * *iid, void * *iface); static nsresult ConvertToArray(const nsDiscriminatedUnion& data, PRUint16 *type, nsIID* iid, PRUint32 *count, void * *ptr); static nsresult ConvertToStringWithSize(const nsDiscriminatedUnion& data, PRUint32 *size, char **str); static nsresult ConvertToWStringWithSize(const nsDiscriminatedUnion& data, PRUint32 *size, PRUnichar **str); static nsresult SetFromVariant(nsDiscriminatedUnion* data, nsIVariant* aValue); static nsresult SetFromInt8(nsDiscriminatedUnion* data, PRUint8 aValue); static nsresult SetFromInt16(nsDiscriminatedUnion* data, PRInt16 aValue); static nsresult SetFromInt32(nsDiscriminatedUnion* data, PRInt32 aValue); static nsresult SetFromInt64(nsDiscriminatedUnion* data, PRInt64 aValue); static nsresult SetFromUint8(nsDiscriminatedUnion* data, PRUint8 aValue); static nsresult SetFromUint16(nsDiscriminatedUnion* data, PRUint16 aValue); static nsresult SetFromUint32(nsDiscriminatedUnion* data, PRUint32 aValue); static nsresult SetFromUint64(nsDiscriminatedUnion* data, PRUint64 aValue); static nsresult SetFromFloat(nsDiscriminatedUnion* data, float aValue); static nsresult SetFromDouble(nsDiscriminatedUnion* data, double aValue); static nsresult SetFromBool(nsDiscriminatedUnion* data, PRBool aValue); static nsresult SetFromChar(nsDiscriminatedUnion* data, char aValue); static nsresult SetFromWChar(nsDiscriminatedUnion* data, PRUnichar aValue); static nsresult SetFromID(nsDiscriminatedUnion* data, const nsID & aValue); static nsresult SetFromAString(nsDiscriminatedUnion* data, const nsAString & aValue); static nsresult SetFromAUTF8String(nsDiscriminatedUnion* data, const nsAUTF8String & aValue); static nsresult SetFromACString(nsDiscriminatedUnion* data, const nsACString & aValue); static nsresult SetFromString(nsDiscriminatedUnion* data, const char *aValue); static nsresult SetFromWString(nsDiscriminatedUnion* data, const PRUnichar *aValue); static nsresult SetFromISupports(nsDiscriminatedUnion* data, nsISupports *aValue); static nsresult SetFromInterface(nsDiscriminatedUnion* data, const nsIID& iid, nsISupports *aValue); static nsresult SetFromArray(nsDiscriminatedUnion* data, PRUint16 type, const nsIID* iid, PRUint32 count, void * aValue); static nsresult SetFromStringWithSize(nsDiscriminatedUnion* data, PRUint32 size, const char *aValue); static nsresult SetFromWStringWithSize(nsDiscriminatedUnion* data, PRUint32 size, const PRUnichar *aValue); static nsresult SetToVoid(nsDiscriminatedUnion* data); static nsresult SetToEmpty(nsDiscriminatedUnion* data); static nsresult SetToEmptyArray(nsDiscriminatedUnion* data); private: ~nsVariant(); protected: nsDiscriminatedUnion mData; PRBool 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}} #define NS_VARIANT_CLASSNAME "Variant"