[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_

#ifdef __GNUG__
#pragma interface "variant.h"
#endif

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

#if wxUSE_TIMEDATE
    #include "wx/time.h"
    #include "wx/date.h"
#endif // time/date

#include "wx/datetime.h"

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

#include "wx/ioswrap.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 WXDLLEXPORT 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;
};

/*
 * 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 WXDLLEXPORT 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
// For some reason, Watcom C++ can't link variant.cpp with time/date classes compiled
#if wxUSE_TIMEDATE && !defined(__WATCOMC__)
    wxVariant(const wxTime& val, const wxString& name = wxEmptyString); // Time
    wxVariant(const wxDate& val, const wxString& name = wxEmptyString); // Date
#endif
    wxVariant(void* ptr, const wxString& name = wxEmptyString); // void* (general purpose)
    wxVariant(wxVariantData* data, const wxString& name = wxEmptyString); // User-defined data
//TODO: Need to document
    wxVariant(const wxDateTime& val, const wxString& name = wxEmptyString); // Date
    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
    bool operator== (const wxDateTime& value) const;
    bool operator!= (const wxDateTime& value) const;
    void operator= (const wxDateTime& value) ;

    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) ;
// For some reason, Watcom C++ can't link variant.cpp with time/date classes compiled
#if wxUSE_TIMEDATE && !defined(__WATCOMC__)
    bool operator== (const wxTime& value) const;
    bool operator!= (const wxTime& value) const;
    void operator= (const wxTime& value) ;
    bool operator== (const wxDate& value) const;
    bool operator!= (const wxDate& value) const;
    void operator= (const wxDate& value) ;
#endif
    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(); }
// For some reason, Watcom C++ can't link variant.cpp with time/date classes compiled
#if wxUSE_TIMEDATE && !defined(__WATCOMC__)
    inline operator wxTime () const {  return GetTime(); }
    inline operator wxDate () const {  return GetDate(); }
#endif
    inline operator void* () const {  return GetVoidPtr(); }
//TODO: Need to document
    inline operator wxDateTime () const { return GetDateTime(); }
//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;

    // 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 ;

// For some reason, Watcom C++ can't link variant.cpp with time/date classes compiled
#if wxUSE_TIMEDATE && !defined(__WATCOMC__)
    wxTime GetTime() const ;
    wxDate GetDate() const ;
#endif
    void* GetVoidPtr() const ;
//TODO: Need to document
    wxDateTime GetDateTime() const ;
    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;
// For some reason, Watcom C++ can't link variant.cpp with time/date classes compiled
#if wxUSE_TIMEDATE && !defined(__WATCOMC__)
    bool Convert(wxTime* value) const;
    bool Convert(wxDate* value) const;
#endif
//TODO: Need to document
    bool Convert(wxDateTime* value) const;
//TODO: End of Need to document

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

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