[wxWidgets.git] / include / wx / variant.h

/////////////////////////////////////////////////////////////////////////////
// Name:        wx/variant.h
// Purpose:     wxVariant class, container for any type
// Author:      Julian Smart
// Modified by:
// Created:     10/09/98
// RCS-ID:      $Id$
// Copyright:   (c) Julian Smart
// Licence:     wxWindows licence
/////////////////////////////////////////////////////////////////////////////

#ifndef _WX_VARIANT_H_
#define _WX_VARIANT_H_

#include "wx/defs.h"
#include "wx/object.h"
#include "wx/string.h"
#include "wx/arrstr.h"
#include "wx/list.h"

#if wxUSE_DATETIME
    #include "wx/datetime.h"
#endif // wxUSE_DATETIME

#if wxUSE_ODBC
    #include "wx/db.h"  // will #include sqltypes.h
#endif //ODBC

#include "wx/iosfwrap.h"

/*
 * wxVariantData stores the actual data in a wxVariant object,
 * to allow it to store any type of data.
 * Derive from this to provide custom data handling.
 *
 * TODO: in order to replace wxPropertyValue, we would need
 * to consider adding constructors that take pointers to C++ variables,
 * or removing that functionality from the wxProperty library.
 * Essentially wxPropertyValue takes on some of the wxValidator functionality
 * by storing pointers and not just actual values, allowing update of C++ data
 * to be handled automatically. Perhaps there's another way of doing this without
 * overloading wxVariant with unnecessary functionality.
 */

class WXDLLIMPEXP_BASE wxVariantData: public wxObject
{
DECLARE_ABSTRACT_CLASS(wxVariantData)
public:

// Construction & destruction
    wxVariantData() {}

// Override these to provide common functionality
    // Copy to data
    virtual void Copy(wxVariantData& data) = 0;
    virtual bool Eq(wxVariantData& data) const = 0;
#if wxUSE_STD_IOSTREAM
    virtual bool Write(wxSTD ostream& str) const = 0;
#endif
    virtual bool Write(wxString& str) const = 0;
#if wxUSE_STD_IOSTREAM
    virtual bool Read(wxSTD istream& str) = 0;
#endif
    virtual bool Read(wxString& str) = 0;
    // What type is it? Return a string name.
    virtual wxString GetType() const = 0;
    // If it based on wxObject return the ClassInfo.
    virtual wxClassInfo* GetValueClassInfo() { return NULL; }
};

/*
 * wxVariant can store any kind of data, but has some basic types
 * built in.
 * NOTE: this eventually should have a reference-counting implementation.
 * PLEASE, if you change it to ref-counting, make sure it doesn't involve bloating
 * this class too much.
 */

class WXDLLIMPEXP_BASE wxVariant: public wxObject
{
DECLARE_DYNAMIC_CLASS(wxVariant)
public:

// Construction & destruction
    wxVariant();
    wxVariant(double val, const wxString& name = wxEmptyString);
    wxVariant(long val, const wxString& name = wxEmptyString);
#ifdef HAVE_BOOL
    wxVariant(bool val, const wxString& name = wxEmptyString);
#endif
    wxVariant(char val, const wxString& name = wxEmptyString);
    wxVariant(const wxString& val, const wxString& name = wxEmptyString);
    wxVariant(const wxChar* val, const wxString& name = wxEmptyString); // Necessary or VC++ assumes bool!
#if WXWIN_COMPATIBILITY_2_4
    wxDEPRECATED( wxVariant(const wxStringList& val, const wxString& name = wxEmptyString) );
#endif
    wxVariant(const wxList& val, const wxString& name = wxEmptyString); // List of variants
    wxVariant(void* ptr, const wxString& name = wxEmptyString); // void* (general purpose)
    wxVariant(wxObject* ptr, const wxString& name = wxEmptyString); //wxObject
    wxVariant(wxVariantData* data, const wxString& name = wxEmptyString); // User-defined data
#if wxUSE_DATETIME
    wxVariant(const wxDateTime& val, const wxString& name = wxEmptyString); // Date
#endif // wxUSE_DATETIME
    wxVariant(const wxArrayString& val, const wxString& name = wxEmptyString); // String array
#if wxUSE_ODBC
    wxVariant(const DATE_STRUCT* valptr, const wxString& name = wxEmptyString); // DateTime
    wxVariant(const TIME_STRUCT* valptr, const wxString& name = wxEmptyString); // DateTime
    wxVariant(const TIMESTAMP_STRUCT* valptr, const wxString& name = wxEmptyString); // DateTime
#endif

    wxVariant(const wxVariant& variant);
    ~wxVariant();

// Generic operators
    // Assignment
    void operator= (const wxVariant& variant);

#if wxUSE_DATETIME
    bool operator== (const wxDateTime& value) const;
    bool operator!= (const wxDateTime& value) const;
    void operator= (const wxDateTime& value) ;
#endif // wxUSE_DATETIME

    bool operator== (const wxArrayString& value) const;
    bool operator!= (const wxArrayString& value) const;
    void operator= (const wxArrayString& value) ;
#if wxUSE_ODBC
    void operator= (const DATE_STRUCT* value) ;
    void operator= (const TIME_STRUCT* value) ;
    void operator= (const TIMESTAMP_STRUCT* value) ;
#endif

    // Assignment using data, e.g.
    // myVariant = new wxStringVariantData("hello");
    void operator= (wxVariantData* variantData);
    bool operator== (const wxVariant& variant) const;
    bool operator!= (const wxVariant& variant) const;

// Specific operators
    bool operator== (double value) const;
    bool operator!= (double value) const;
    void operator= (double value) ;
    bool operator== (long value) const;
    bool operator!= (long value) const;
    void operator= (long value) ;
    bool operator== (char value) const;
    bool operator!= (char value) const;
    void operator= (char value) ;
#ifdef HAVE_BOOL
    bool operator== (bool value) const;
    bool operator!= (bool value) const;
    void operator= (bool value) ;
#endif
    bool operator== (const wxString& value) const;
    bool operator!= (const wxString& value) const;
    void operator= (const wxString& value) ;
    void operator= (const wxChar* value) ; // Necessary or VC++ assumes bool!
#if WXWIN_COMPATIBILITY_2_4
    wxDEPRECATED( bool operator== (const wxStringList& value) const );
    wxDEPRECATED( bool operator!= (const wxStringList& value) const );
    wxDEPRECATED( void operator= (const wxStringList& value) );
#endif
    bool operator== (const wxList& value) const;
    bool operator!= (const wxList& value) const;
    void operator= (const wxList& value) ;
    bool operator== (void* value) const;
    bool operator!= (void* value) const;
    void operator= (void* value) ;

    // Treat a list variant as an array
    wxVariant operator[] (size_t idx) const;
    wxVariant& operator[] (size_t idx) ;

    // Implicit conversion to a wxString
    inline operator wxString () const {  return MakeString(); }
    wxString MakeString() const;

    // Other implicit conversions
    inline operator double () const {  return GetDouble(); }
    inline operator char () const {  return GetChar(); }
    inline operator long () const {  return GetLong(); }
    inline operator bool () const {  return GetBool(); }
    inline operator void* () const {  return GetVoidPtr(); }
    // No implicit conversion to wxObject, as that would really
    //  confuse people between conversion to our contained data
    //  and downcasting to see our base type.
#if wxUSE_DATETIME
    inline operator wxDateTime () const { return GetDateTime(); }
#endif // wxUSE_DATETIME

// Accessors
    // Sets/gets name
    inline void SetName(const wxString& name) { m_name = name; }
    inline const wxString& GetName() const { return m_name; }

    // Tests whether there is data
    inline bool IsNull() const { return (m_data == (wxVariantData*) NULL); }

    wxVariantData* GetData() const { return m_data; }
    void SetData(wxVariantData* data) ;

    // Returns a string representing the type of the variant,
    // e.g. "string", "bool", "stringlist", "list", "double", "long"
    wxString GetType() const;

    bool IsType(const wxString& type) const;
    bool IsValueKindOf(const wxClassInfo* type) const;

    // Return the number of elements in a list
    size_t GetCount() const;

// Value accessors
    double GetReal() const ;
    inline double GetDouble() const { return GetReal(); };
    long GetInteger() const ;
    inline long GetLong() const { return GetInteger(); };
    char GetChar() const ;
    bool GetBool() const ;
    wxString GetString() const ;
    wxList& GetList() const ;
#if WXWIN_COMPATIBILITY_2_4
    wxDEPRECATED( wxStringList& GetStringList() const );
#endif
    void* GetVoidPtr() const ;
    wxObject* GetWxObjectPtr()  ;
#if wxUSE_DATETIME
    wxDateTime GetDateTime() const ;
#endif // wxUSE_DATETIME
    wxArrayString GetArrayString() const;

// Operations
    // Make NULL (i.e. delete the data)
    void MakeNull();

    // Make empty list
    void NullList();

    // Append to list
    void Append(const wxVariant& value);

    // Insert at front of list
    void Insert(const wxVariant& value);

    // Returns true if the variant is a member of the list
    bool Member(const wxVariant& value) const;

    // Deletes the nth element of the list
    bool Delete(size_t item);

    // Clear list
    void ClearList();

// Implementation
public:
// Type conversion
    bool Convert(long* value) const;
    bool Convert(bool* value) const;
    bool Convert(double* value) const;
    bool Convert(wxString* value) const;
    bool Convert(char* value) const;
#if wxUSE_DATETIME
    bool Convert(wxDateTime* value) const;
#endif // wxUSE_DATETIME

// Attributes
protected:
    wxVariantData*  m_data;
    wxString        m_name;
};

//Since we want type safety wxVariant we need to fetch and dynamic_cast
//in a seemingly safe way so the compiler can check, so we define
//a dynamic_cast /wxDynamicCast analogue.

#define wxGetVariantCast(var,classname) \
    ((classname*)(var.IsValueKindOf(&classname::ms_classInfo) ?\
                  var.GetWxObjectPtr() : NULL));

extern wxVariant WXDLLIMPEXP_BASE wxNullVariant;

#endif
    // _WX_VARIANT_H_
Commit	Line	Data
8cb50e4b	1	/////////////////////////////////////////////////////////////////////////////
43f06cfd	2	// Name: wx/variant.h
8cb50e4b JS	3	// Purpose: wxVariant class, container for any type
	4	// Author: Julian Smart
	5	// Modified by:
	6	// Created: 10/09/98
	7	// RCS-ID: $Id$
99d80019	8	// Copyright: (c) Julian Smart
65571936	9	// Licence: wxWindows licence
8cb50e4b JS	10	/////////////////////////////////////////////////////////////////////////////
	11
	12	#ifndef _WX_VARIANT_H_
	13	#define _WX_VARIANT_H_
	14
8cb50e4b JS	15	#include "wx/defs.h"
	16	#include "wx/object.h"
	17	#include "wx/string.h"
4c3ebca9	18	#include "wx/arrstr.h"
8cb50e4b JS	19	#include "wx/list.h"
8cb50e4b JS	20
e2b87f38 VZ	21	#if wxUSE_DATETIME
	22	#include "wx/datetime.h"
	23	#endif // wxUSE_DATETIME
edca7a82 GT	24
	25	#if wxUSE_ODBC
	26	#include "wx/db.h" // will #include sqltypes.h
	27	#endif //ODBC
	28
65f19af1	29	#include "wx/iosfwrap.h"
8cb50e4b JS	30
	31	/*
	32	* wxVariantData stores the actual data in a wxVariant object,
	33	* to allow it to store any type of data.
	34	* Derive from this to provide custom data handling.
	35	*
	36	* TODO: in order to replace wxPropertyValue, we would need
	37	* to consider adding constructors that take pointers to C++ variables,
	38	* or removing that functionality from the wxProperty library.
	39	* Essentially wxPropertyValue takes on some of the wxValidator functionality
	40	* by storing pointers and not just actual values, allowing update of C++ data
	41	* to be handled automatically. Perhaps there's another way of doing this without
	42	* overloading wxVariant with unnecessary functionality.
	43	*/
	44
bddd7a8d	45	class WXDLLIMPEXP_BASE wxVariantData: public wxObject
8cb50e4b JS	46	{
	47	DECLARE_ABSTRACT_CLASS(wxVariantData)
	48	public:
	49
	50	// Construction & destruction
6fb99eb3	51	wxVariantData() {}
8cb50e4b JS	52
	53	// Override these to provide common functionality
	54	// Copy to data
	55	virtual void Copy(wxVariantData& data) = 0;
	56	virtual bool Eq(wxVariantData& data) const = 0;
38830220	57	#if wxUSE_STD_IOSTREAM
dd107c50	58	virtual bool Write(wxSTD ostream& str) const = 0;
38830220	59	#endif
8cb50e4b	60	virtual bool Write(wxString& str) const = 0;
38830220	61	#if wxUSE_STD_IOSTREAM
dd107c50	62	virtual bool Read(wxSTD istream& str) = 0;
38830220	63	#endif
8cb50e4b JS	64	virtual bool Read(wxString& str) = 0;
	65	// What type is it? Return a string name.
	66	virtual wxString GetType() const = 0;
cf6ae290 RG	67	// If it based on wxObject return the ClassInfo.
cf6ae290 RG	68	virtual wxClassInfo* GetValueClassInfo() { return NULL; }
8cb50e4b JS	69	};
	70
	71	/*
	72	* wxVariant can store any kind of data, but has some basic types
	73	* built in.
	74	* NOTE: this eventually should have a reference-counting implementation.
	75	* PLEASE, if you change it to ref-counting, make sure it doesn't involve bloating
	76	* this class too much.
	77	*/
	78
bddd7a8d	79	class WXDLLIMPEXP_BASE wxVariant: public wxObject
8cb50e4b JS	80	{
	81	DECLARE_DYNAMIC_CLASS(wxVariant)
	82	public:
	83
	84	// Construction & destruction
	85	wxVariant();
e90c1d2a VZ	86	wxVariant(double val, const wxString& name = wxEmptyString);
e90c1d2a VZ	87	wxVariant(long val, const wxString& name = wxEmptyString);
57493f9f	88	#ifdef HAVE_BOOL
e90c1d2a	89	wxVariant(bool val, const wxString& name = wxEmptyString);
57493f9f	90	#endif
e90c1d2a VZ	91	wxVariant(char val, const wxString& name = wxEmptyString);
	92	wxVariant(const wxString& val, const wxString& name = wxEmptyString);
	93	wxVariant(const wxChar* val, const wxString& name = wxEmptyString); // Necessary or VC++ assumes bool!
2c3a1064 RN	94	#if WXWIN_COMPATIBILITY_2_4
	95	wxDEPRECATED( wxVariant(const wxStringList& val, const wxString& name = wxEmptyString) );
	96	#endif
e90c1d2a	97	wxVariant(const wxList& val, const wxString& name = wxEmptyString); // List of variants
e90c1d2a	98	wxVariant(void* ptr, const wxString& name = wxEmptyString); // void* (general purpose)
cab1a605	99	wxVariant(wxObject* ptr, const wxString& name = wxEmptyString); //wxObject
e90c1d2a	100	wxVariant(wxVariantData* data, const wxString& name = wxEmptyString); // User-defined data
e2b87f38	101	#if wxUSE_DATETIME
edca7a82	102	wxVariant(const wxDateTime& val, const wxString& name = wxEmptyString); // Date
e2b87f38	103	#endif // wxUSE_DATETIME
fb42d7c3	104	wxVariant(const wxArrayString& val, const wxString& name = wxEmptyString); // String array
edca7a82 GT	105	#if wxUSE_ODBC
	106	wxVariant(const DATE_STRUCT* valptr, const wxString& name = wxEmptyString); // DateTime
	107	wxVariant(const TIME_STRUCT* valptr, const wxString& name = wxEmptyString); // DateTime
	108	wxVariant(const TIMESTAMP_STRUCT* valptr, const wxString& name = wxEmptyString); // DateTime
	109	#endif
cab1a605	110
8cb50e4b	111	wxVariant(const wxVariant& variant);
8cb50e4b JS	112	~wxVariant();
	113
	114	// Generic operators
	115	// Assignment
	116	void operator= (const wxVariant& variant);
	117
e2b87f38	118	#if wxUSE_DATETIME
edca7a82 GT	119	bool operator== (const wxDateTime& value) const;
	120	bool operator!= (const wxDateTime& value) const;
	121	void operator= (const wxDateTime& value) ;
e2b87f38	122	#endif // wxUSE_DATETIME
fb42d7c3 VZ	123
	124	bool operator== (const wxArrayString& value) const;
	125	bool operator!= (const wxArrayString& value) const;
	126	void operator= (const wxArrayString& value) ;
edca7a82 GT	127	#if wxUSE_ODBC
	128	void operator= (const DATE_STRUCT* value) ;
	129	void operator= (const TIME_STRUCT* value) ;
	130	void operator= (const TIMESTAMP_STRUCT* value) ;
	131	#endif
edca7a82	132
8cb50e4b JS	133	// Assignment using data, e.g.
	134	// myVariant = new wxStringVariantData("hello");
	135	void operator= (wxVariantData* variantData);
	136	bool operator== (const wxVariant& variant) const;
	137	bool operator!= (const wxVariant& variant) const;
	138
	139	// Specific operators
	140	bool operator== (double value) const;
	141	bool operator!= (double value) const;
	142	void operator= (double value) ;
	143	bool operator== (long value) const;
	144	bool operator!= (long value) const;
	145	void operator= (long value) ;
	146	bool operator== (char value) const;
	147	bool operator!= (char value) const;
	148	void operator= (char value) ;
57493f9f	149	#ifdef HAVE_BOOL
8cb50e4b JS	150	bool operator== (bool value) const;
	151	bool operator!= (bool value) const;
	152	void operator= (bool value) ;
57493f9f	153	#endif
8cb50e4b JS	154	bool operator== (const wxString& value) const;
	155	bool operator!= (const wxString& value) const;
	156	void operator= (const wxString& value) ;
2ed57eb7	157	void operator= (const wxChar* value) ; // Necessary or VC++ assumes bool!
2c3a1064 RN	158	#if WXWIN_COMPATIBILITY_2_4
	159	wxDEPRECATED( bool operator== (const wxStringList& value) const );
	160	wxDEPRECATED( bool operator!= (const wxStringList& value) const );
	161	wxDEPRECATED( void operator= (const wxStringList& value) );
	162	#endif
8cb50e4b JS	163	bool operator== (const wxList& value) const;
	164	bool operator!= (const wxList& value) const;
	165	void operator= (const wxList& value) ;
a0a302dc JS	166	bool operator== (void* value) const;
	167	bool operator!= (void* value) const;
	168	void operator= (void* value) ;
8cb50e4b JS	169
	170	// Treat a list variant as an array
	171	wxVariant operator[] (size_t idx) const;
	172	wxVariant& operator[] (size_t idx) ;
	173
	174	// Implicit conversion to a wxString
	175	inline operator wxString () const { return MakeString(); }
	176	wxString MakeString() const;
	177
	178	// Other implicit conversions
	179	inline operator double () const { return GetDouble(); }
a0a302dc	180	inline operator char () const { return GetChar(); }
8cb50e4b JS	181	inline operator long () const { return GetLong(); }
8cb50e4b JS	182	inline operator bool () const { return GetBool(); }
a0a302dc	183	inline operator void* () const { return GetVoidPtr(); }
cf6ae290 RG	184	// No implicit conversion to wxObject, as that would really
	185	// confuse people between conversion to our contained data
	186	// and downcasting to see our base type.
e2b87f38	187	#if wxUSE_DATETIME
edca7a82	188	inline operator wxDateTime () const { return GetDateTime(); }
e2b87f38	189	#endif // wxUSE_DATETIME
8cb50e4b JS	190
8cb50e4b JS	191	// Accessors
a0a302dc JS	192	// Sets/gets name
	193	inline void SetName(const wxString& name) { m_name = name; }
	194	inline const wxString& GetName() const { return m_name; }
	195
8cb50e4b JS	196	// Tests whether there is data
	197	inline bool IsNull() const { return (m_data == (wxVariantData*) NULL); }
	198
	199	wxVariantData* GetData() const { return m_data; }
	200	void SetData(wxVariantData* data) ;
	201
	202	// Returns a string representing the type of the variant,
	203	// e.g. "string", "bool", "stringlist", "list", "double", "long"
	204	wxString GetType() const;
	205
	206	bool IsType(const wxString& type) const;
cf6ae290	207	bool IsValueKindOf(const wxClassInfo* type) const;
8cb50e4b JS	208
8cb50e4b JS	209	// Return the number of elements in a list
43f06cfd	210	size_t GetCount() const;
8cb50e4b JS	211
	212	// Value accessors
	213	double GetReal() const ;
	214	inline double GetDouble() const { return GetReal(); };
	215	long GetInteger() const ;
	216	inline long GetLong() const { return GetInteger(); };
	217	char GetChar() const ;
	218	bool GetBool() const ;
	219	wxString GetString() const ;
	220	wxList& GetList() const ;
2c3a1064 RN	221	#if WXWIN_COMPATIBILITY_2_4
	222	wxDEPRECATED( wxStringList& GetStringList() const );
	223	#endif
a0a302dc	224	void* GetVoidPtr() const ;
cf6ae290	225	wxObject* GetWxObjectPtr() ;
e2b87f38	226	#if wxUSE_DATETIME
edca7a82	227	wxDateTime GetDateTime() const ;
e2b87f38	228	#endif // wxUSE_DATETIME
fb42d7c3	229	wxArrayString GetArrayString() const;
8cb50e4b JS	230
	231	// Operations
	232	// Make NULL (i.e. delete the data)
	233	void MakeNull();
	234
	235	// Make empty list
	236	void NullList();
	237
	238	// Append to list
	239	void Append(const wxVariant& value);
	240
	241	// Insert at front of list
	242	void Insert(const wxVariant& value);
	243
cab1a605	244	// Returns true if the variant is a member of the list
8cb50e4b JS	245	bool Member(const wxVariant& value) const;
	246
	247	// Deletes the nth element of the list
43f06cfd	248	bool Delete(size_t item);
8cb50e4b JS	249
	250	// Clear list
	251	void ClearList();
	252
a0a302dc	253	// Implementation
9708db20	254	public:
8cb50e4b JS	255	// Type conversion
	256	bool Convert(long* value) const;
	257	bool Convert(bool* value) const;
	258	bool Convert(double* value) const;
	259	bool Convert(wxString* value) const;
	260	bool Convert(char* value) const;
e2b87f38	261	#if wxUSE_DATETIME
edca7a82	262	bool Convert(wxDateTime* value) const;
e2b87f38	263	#endif // wxUSE_DATETIME
8cb50e4b JS	264
	265	// Attributes
	266	protected:
	267	wxVariantData* m_data;
a0a302dc	268	wxString m_name;
8cb50e4b JS	269	};
8cb50e4b JS	270
cf6ae290	271	//Since we want type safety wxVariant we need to fetch and dynamic_cast
cab1a605	272	//in a seemingly safe way so the compiler can check, so we define
cf6ae290 RG	273	//a dynamic_cast /wxDynamicCast analogue.
	274
	275	#define wxGetVariantCast(var,classname) \
cab1a605 WS	276	((classname*)(var.IsValueKindOf(&classname::ms_classInfo) ?\
cab1a605 WS	277	var.GetWxObjectPtr() : NULL));
cf6ae290	278
bddd7a8d	279	extern wxVariant WXDLLIMPEXP_BASE wxNullVariant;
a0a302dc	280
8cb50e4b JS	281	#endif
8cb50e4b JS	282	// _WX_VARIANT_H_