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

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

#ifndef _WX_VARIANT_H_
#define _WX_VARIANT_H_

#if defined(__GNUG__) && !defined(__APPLE__)
#pragma interface "variant.h"
#endif

#include "wx/defs.h"
#include "wx/object.h"
#include "wx/string.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!
    wxVariant(const wxStringList& val, const wxString& name = wxEmptyString);
    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
//TODO: Need to document
#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
//TODO: End of Need to document
    
    wxVariant(const wxVariant& variant);
    ~wxVariant();

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

//TODO: Need to document
#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
//TODO: End of Need to document

    // 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!
    bool operator== (const wxStringList& value) const;
    bool operator!= (const wxStringList& value) const;
    void operator= (const wxStringList& value) ;
    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.
//TODO: Need to document
#if wxUSE_DATETIME
    inline operator wxDateTime () const { return GetDateTime(); }
#endif // wxUSE_DATETIME
//TODO: End of Need to document

// 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
    int 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 ;
    wxStringList& GetStringList() const ;

    void* GetVoidPtr() const ;
    wxObject* GetWxObjectPtr()  ;
//TODO: Need to document
#if wxUSE_DATETIME
    wxDateTime GetDateTime() const ;
#endif // wxUSE_DATETIME
    wxArrayString GetArrayString() const;
//TODO: End of Need to document

// 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(int 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;
//TODO: Need to document
#if wxUSE_DATETIME
    bool Convert(wxDateTime* value) const;
#endif // wxUSE_DATETIME
//TODO: End of Need to document

// 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::sm_class##classname) ?\
		      var.GetWxObjectPtr() : NULL));

extern wxVariant WXDLLIMPEXP_BASE wxNullVariant;

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