this one should really work

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

diff --git a/include/wx/variant.h b/include/wx/variant.h
index 848c0a0261011aa72c782a9b590a9a29f3d3bff6..a491b6f2ad99a6563cd8279ab1b2145ee9da1831 100644 (file)
--- a/include/wx/variant.h
+++ b/include/wx/variant.h
@@ -20,15 +20,12 @@
 #include "wx/string.h"
 #include "wx/arrstr.h"
 #include "wx/list.h"
 #include "wx/string.h"
 #include "wx/arrstr.h"
 #include "wx/list.h"

+#include "wx/cpp.h"

 
 #if wxUSE_DATETIME
     #include "wx/datetime.h"
 #endif // wxUSE_DATETIME
 
 
 #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"
 
 /*
 #include "wx/iosfwrap.h"
 
 /*


@@ -58,30 +55,32 @@
  * overloading wxVariant with unnecessary functionality.
  */
 
  * overloading wxVariant with unnecessary functionality.
  */
 

-class WXDLLIMPEXP_BASE wxVariantData: public wxObject
+class WXDLLIMPEXP_BASE wxVariantData

 {
     friend class wxVariant;
 public:
 {
     friend class wxVariant;
 public:

-    wxVariantData()
-        : wxObject(), m_count(1)
-    { }
+    wxVariantData() : m_count(1) { }

 
     // Override these to provide common functionality
     virtual bool Eq(wxVariantData& data) const = 0;
 
     // Override these to provide common functionality
     virtual bool Eq(wxVariantData& data) const = 0;

-    
+

 #if wxUSE_STD_IOSTREAM
 #if wxUSE_STD_IOSTREAM

-    virtual bool Write(wxSTD ostream& str) const { return false; }
+    virtual bool Write(wxSTD ostream& WXUNUSED(str)) const { return false; }

 #endif
 #endif

-    virtual bool Write(wxString& str) const { return false; }
+    virtual bool Write(wxString& WXUNUSED(str)) const { return false; }

 #if wxUSE_STD_IOSTREAM
 #if wxUSE_STD_IOSTREAM

-    virtual bool Read(wxSTD istream& str) { return false; }
+    virtual bool Read(wxSTD istream& WXUNUSED(str)) { return false; }

 #endif
 #endif

-    virtual bool Read(wxString& str) { return false; }
+    virtual bool Read(wxString& WXUNUSED(str)) { return false; }

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

+    // Implement this to make wxVariant::AllocExcusive work. Returns
+    // a copy of the data.
+    virtual wxVariantData* Clone() const { return NULL; }
+

     void IncRef() { m_count++; }
     void DecRef()
     {
     void IncRef() { m_count++; }
     void DecRef()
     {


@@ -99,9 +98,6 @@ protected:
 
 private:
     int     m_count;
 
 private:
     int     m_count;

-    
-private:
-    DECLARE_ABSTRACT_CLASS(wxVariantData)

 };
 
 /*
 };
 
 /*


@@ -109,11 +105,15 @@ private:
  * built in.
  */
 
  * built in.
  */
 

+class WXDLLIMPEXP_FWD_BASE wxVariant;
+
+WX_DECLARE_LIST_WITH_DECL(wxVariant, wxVariantList, class WXDLLIMPEXP_BASE);
+

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

-    
+

     wxVariant(const wxVariant& variant);
     wxVariant(wxVariantData* data, const wxString& name = wxEmptyString);
     virtual ~wxVariant();
     wxVariant(const wxVariant& variant);
     wxVariant(wxVariantData* data, const wxString& name = wxEmptyString);
     virtual ~wxVariant();


@@ -124,7 +124,7 @@ public:
     // Assignment using data, e.g.
     // myVariant = new wxStringVariantData("hello");
     void operator= (wxVariantData* variantData);
     // 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;
 
     bool operator== (const wxVariant& variant) const;
     bool operator!= (const wxVariant& variant) const;
 


@@ -133,7 +133,7 @@ public:
     inline const wxString& GetName() const { return m_name; }
 
     // Tests whether there is data
     inline const wxString& GetName() const { return m_name; }
 
     // Tests whether there is data

-    bool IsNull() const; 
+    bool IsNull() const;

 
     // For compatibility with wxWidgets <= 2.6, this doesn't increase
     // reference count.
 
     // For compatibility with wxWidgets <= 2.6, this doesn't increase
     // reference count.


@@ -146,12 +146,15 @@ public:
     // destroy a reference
     void UnRef();
 
     // destroy a reference
     void UnRef();
 

+    // ensure that the data is exclusive to this variant, and not shared
+    bool Unshare();
+

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

-    
+

     // Delete data and name
     void Clear();
     // Delete data and name
     void Clear();

-    
+

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


@@ -159,9 +162,9 @@ public:
     bool IsType(const wxString& type) const;
     bool IsValueKindOf(const wxClassInfo* type) const;
 
     bool IsType(const wxString& type) const;
     bool IsValueKindOf(const wxClassInfo* type) const;
 

-    // write contents to a string (e.g. for debugging)    
+    // write contents to a string (e.g. for debugging)

     wxString MakeString() const;
     wxString MakeString() const;

-    
+

     // double
     wxVariant(double val, const wxString& name = wxEmptyString);
     bool operator== (double value) const;
     // double
     wxVariant(double val, const wxString& name = wxEmptyString);
     bool operator== (double value) const;


@@ -170,7 +173,7 @@ public:
     inline operator double () const {  return GetDouble(); }
     inline double GetReal() const { return GetDouble(); }
     double GetDouble() const;
     inline operator double () const {  return GetDouble(); }
     inline double GetReal() const { return GetDouble(); }
     double GetDouble() const;

-    
+

     // long
     wxVariant(long val, const wxString& name = wxEmptyString);
     wxVariant(int val, const wxString& name = wxEmptyString);
     // long
     wxVariant(long val, const wxString& name = wxEmptyString);
     wxVariant(int val, const wxString& name = wxEmptyString);


@@ -181,61 +184,81 @@ public:
     inline operator long () const {  return GetLong(); }
     inline long GetInteger() const { return GetLong(); }
     long GetLong() const;
     inline operator long () const {  return GetLong(); }
     inline long GetInteger() const { return GetLong(); }
     long GetLong() const;

-    
-    // bool    
-#ifdef HAVE_BOOL
+
+    // bool

     wxVariant(bool val, const wxString& name = wxEmptyString);
     bool operator== (bool value) const;
     bool operator!= (bool value) const;
     void operator= (bool value) ;
     inline operator bool () const {  return GetBool(); }
     bool GetBool() const ;
     wxVariant(bool val, const wxString& name = wxEmptyString);
     bool operator== (bool value) const;
     bool operator!= (bool value) const;
     void operator= (bool value) ;
     inline operator bool () const {  return GetBool(); }
     bool GetBool() const ;

-#endif

 
     // wxDateTime
 #if wxUSE_DATETIME
 
     // wxDateTime
 #if wxUSE_DATETIME

-    wxVariant(const wxDateTime& val, const wxString& name = wxEmptyString); 
-#if wxUSE_ODBC
-    wxVariant(const DATE_STRUCT* valptr, const wxString& name = wxEmptyString);
-    wxVariant(const TIME_STRUCT* valptr, const wxString& name = wxEmptyString);
-    wxVariant(const TIMESTAMP_STRUCT* valptr, const wxString& name = wxEmptyString);
-#endif
+    wxVariant(const wxDateTime& val, const wxString& name = wxEmptyString);

     bool operator== (const wxDateTime& value) const;
     bool operator!= (const wxDateTime& value) const;
     void operator= (const wxDateTime& value) ;
     bool operator== (const wxDateTime& value) const;
     bool operator!= (const wxDateTime& value) const;
     void operator= (const wxDateTime& value) ;

-#if wxUSE_ODBC
-    void operator= (const DATE_STRUCT* value) ;
-    void operator= (const TIME_STRUCT* value) ;
-    void operator= (const TIMESTAMP_STRUCT* value) ;
-#endif

     inline operator wxDateTime () const { return GetDateTime(); }
     wxDateTime GetDateTime() const;
 #endif
 
     // wxString
     wxVariant(const wxString& val, const wxString& name = wxEmptyString);
     inline operator wxDateTime () const { return GetDateTime(); }
     wxDateTime GetDateTime() const;
 #endif
 
     // wxString
     wxVariant(const wxString& val, const wxString& name = wxEmptyString);

-    wxVariant(const wxChar* val, const wxString& name = wxEmptyString); // Necessary or VC++ assumes bool!
+    // these overloads are necessary to prevent the compiler from using bool
+    // version instead of wxString one:
+    wxVariant(const char* val, const wxString& name = wxEmptyString);
+    wxVariant(const wchar_t* val, const wxString& name = wxEmptyString);
+    wxVariant(const wxCStrData& val, const wxString& name = wxEmptyString);
+    wxVariant(const wxCharBuffer& val, const wxString& name = wxEmptyString);
+    wxVariant(const wxWCharBuffer& val, const wxString& name = wxEmptyString);
+

     bool operator== (const wxString& value) const;
     bool operator!= (const wxString& value) const;
     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!
+    wxVariant& operator=(const wxString& value);
+    // these overloads are necessary to prevent the compiler from using bool
+    // version instead of wxString one:
+    wxVariant& operator=(const char* value)
+        { return *this = wxString(value); }
+    wxVariant& operator=(const wchar_t* value)
+        { return *this = wxString(value); }
+    wxVariant& operator=(const wxCStrData& value)
+        { return *this = value.AsString(); }
+    template<typename T>
+    wxVariant& operator=(const wxCharTypeBuffer<T>& value)
+        { return *this = value.data(); }
+

     inline operator wxString () const {  return MakeString(); }
     wxString GetString() const;
 
     inline operator wxString () const {  return MakeString(); }
     wxString GetString() const;
 

-    // wxChar
-    wxVariant(wxChar val, const wxString& name = wxEmptyString);
-    bool operator== (wxChar value) const;
-    bool operator!= (wxChar value) const;
-    void operator= (wxChar value) ;
-    inline operator wxChar () const { return GetChar(); }
-    wxChar GetChar() const ;
-    
+    // wxUniChar
+    wxVariant(const wxUniChar& val, const wxString& name = wxEmptyString);
+    wxVariant(const wxUniCharRef& val, const wxString& name = wxEmptyString);
+    wxVariant(char val, const wxString& name = wxEmptyString);
+    wxVariant(wchar_t val, const wxString& name = wxEmptyString);
+    bool operator==(const wxUniChar& value) const;
+    bool operator==(const wxUniCharRef& value) const { return *this == wxUniChar(value); }
+    bool operator==(char value) const { return *this == wxUniChar(value); }
+    bool operator==(wchar_t value) const { return *this == wxUniChar(value); }
+    bool operator!=(const wxUniChar& value) const { return !(*this == value); }
+    bool operator!=(const wxUniCharRef& value) const { return !(*this == value); }
+    bool operator!=(char value) const { return !(*this == value); }
+    bool operator!=(wchar_t value) const { return !(*this == value); }
+    wxVariant& operator=(const wxUniChar& value);
+    wxVariant& operator=(const wxUniCharRef& value) { return *this = wxUniChar(value); }
+    wxVariant& operator=(char value) { return *this = wxUniChar(value); }
+    wxVariant& operator=(wchar_t value) { return *this = wxUniChar(value); }
+    operator wxUniChar() const { return GetChar(); }
+    operator char() const { return GetChar(); }
+    operator wchar_t() const { return GetChar(); }
+    wxUniChar GetChar() const;
+

     // wxArrayString
     wxVariant(const wxArrayString& val, const wxString& name = wxEmptyString);
     bool operator== (const wxArrayString& value) const;
     bool operator!= (const wxArrayString& value) const;
     void operator= (const wxArrayString& value);
     // wxArrayString
     wxVariant(const wxArrayString& val, const wxString& name = wxEmptyString);
     bool operator== (const wxArrayString& value) const;
     bool operator!= (const wxArrayString& value) const;
     void operator= (const wxArrayString& value);

-    inline operator wxArrayString () const { return GetArrayString(); }
+    operator wxArrayString () const { return GetArrayString(); }

     wxArrayString GetArrayString() const;
 
     // void*
     wxArrayString GetArrayString() const;
 
     // void*


@@ -243,7 +266,7 @@ public:
     bool operator== (void* value) const;
     bool operator!= (void* value) const;
     void operator= (void* value);
     bool operator== (void* value) const;
     bool operator!= (void* value) const;
     void operator= (void* value);

-    inline operator void* () const {  return GetVoidPtr(); }
+    operator void* () const {  return GetVoidPtr(); }

     void* GetVoidPtr() const;
 
     // wxObject*
     void* GetVoidPtr() const;
 
     // wxObject*


@@ -254,30 +277,22 @@ public:
     wxObject* GetWxObjectPtr() const;
 
 
     wxObject* GetWxObjectPtr() const;
 
 

-#if WXWIN_COMPATIBILITY_2_4
-    wxDEPRECATED( wxVariant(const wxStringList& val, const wxString& name = wxEmptyString) );
-    wxDEPRECATED( bool operator== (const wxStringList& value) const );
-    wxDEPRECATED( bool operator!= (const wxStringList& value) const );
-    wxDEPRECATED( void operator= (const wxStringList& value) );
-    wxDEPRECATED( wxStringList& GetStringList() const );
-#endif
-

     // ------------------------------
     // list operations
     // ------------------------------
 
     // ------------------------------
     // list operations
     // ------------------------------
 

-    wxVariant(const wxList& val, const wxString& name = wxEmptyString); // List of variants
-    bool operator== (const wxList& value) const;
-    bool operator!= (const wxList& value) const;
-    void operator= (const wxList& value) ;
+    wxVariant(const wxVariantList& val, const wxString& name = wxEmptyString); // List of variants
+    bool operator== (const wxVariantList& value) const;
+    bool operator!= (const wxVariantList& value) const;
+    void operator= (const wxVariantList& value) ;

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

-    wxList& GetList() const ;
+    wxVariantList& GetList() const ;

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

-    
+

     // Make empty list
     void NullList();
 
     // Make empty list
     void NullList();
 


@@ -302,7 +317,9 @@ public:
     bool Convert(bool* value) const;
     bool Convert(double* value) const;
     bool Convert(wxString* value) const;
     bool Convert(bool* value) const;
     bool Convert(double* value) const;
     bool Convert(wxString* value) const;

-    bool Convert(wxChar* value) const;
+    bool Convert(wxUniChar* value) const;
+    bool Convert(char* value) const;
+    bool Convert(wchar_t* value) const;

 #if wxUSE_DATETIME
     bool Convert(wxDateTime* value) const;
 #endif // wxUSE_DATETIME
 #if wxUSE_DATETIME
     bool Convert(wxDateTime* value) const;
 #endif // wxUSE_DATETIME


@@ -311,28 +328,22 @@ public:
 protected:
     wxVariantData*  m_data;
     wxString        m_name;
 protected:
     wxVariantData*  m_data;
     wxString        m_name;

-    
+

 private:
     DECLARE_DYNAMIC_CLASS(wxVariant)
 };
 
 private:
     DECLARE_DYNAMIC_CLASS(wxVariant)
 };
 

-/* Fake macro parameter value */
-#ifdef EMPTY_PARAMETER_VALUE
-    #undef EMPTY_PARAMETER_VALUE
-#endif
-#define EMPTY_PARAMETER_VALUE 
-

 #define DECLARE_VARIANT_OBJECT(classname) \
 #define DECLARE_VARIANT_OBJECT(classname) \

-    DECLARE_VARIANT_OBJECT_EXPORTED(classname,EMPTY_PARAMETER_VALUE)
-    
+    DECLARE_VARIANT_OBJECT_EXPORTED(classname, wxEMPTY_PARAMETER_VALUE)
+

 #define DECLARE_VARIANT_OBJECT_EXPORTED(classname,expdecl) \
 #define DECLARE_VARIANT_OBJECT_EXPORTED(classname,expdecl) \

-classname& expdecl operator << ( classname &object, const wxVariant &variant ); \
-wxVariant& expdecl operator << ( wxVariant &variant, const classname &object );
+expdecl classname& operator << ( classname &object, const wxVariant &variant ); \
+expdecl wxVariant& operator << ( wxVariant &variant, const classname &object );

 
 #define IMPLEMENT_VARIANT_OBJECT(classname) \
 
 #define IMPLEMENT_VARIANT_OBJECT(classname) \

-    IMPLEMENT_VARIANT_OBJECT_EXPORTED(classname,EMPTY_PARAMETER_VALUE)
+    IMPLEMENT_VARIANT_OBJECT_EXPORTED(classname, wxEMPTY_PARAMETER_VALUE)

 
 

-#define IMPLEMENT_VARIANT_OBJECT_EXPORTED(classname,expdecl) \
+#define IMPLEMENT_VARIANT_OBJECT_EXPORTED_NO_EQ(classname,expdecl) \

 class classname##VariantData: public wxVariantData \
 { \
 public:\
 class classname##VariantData: public wxVariantData \
 { \
 public:\


@@ -345,25 +356,13 @@ public:\
 \
     virtual wxString GetType() const; \
     virtual wxClassInfo* GetValueClassInfo(); \
 \
     virtual wxString GetType() const; \
     virtual wxClassInfo* GetValueClassInfo(); \

+\
+    virtual wxVariantData* Clone() const { return new classname##VariantData(m_value); } \

 \
 protected:\
     classname m_value; \
 \
 protected:\
     classname m_value; \

-\
-private: \
-    DECLARE_CLASS(classname##VariantData) \

 };\
 \
 };\
 \

-IMPLEMENT_CLASS(classname##VariantData, wxVariantData)\
-\
-bool classname##VariantData::Eq(wxVariantData& data) const \
-{\
-    wxASSERT( wxIsKindOf((&data), classname##VariantData) );\
-\
-    classname##VariantData & otherData = (classname##VariantData &) data;\
-\
-    return (otherData.m_value == m_value);\
-}\
-\

 wxString classname##VariantData::GetType() const\
 {\
     return m_value.GetClassInfo()->GetClassName();\
 wxString classname##VariantData::GetType() const\
 {\
     return m_value.GetClassInfo()->GetClassName();\


@@ -374,22 +373,54 @@ wxClassInfo* classname##VariantData::GetValueClassInfo()\
     return m_value.GetClassInfo();\
 }\
 \
     return m_value.GetClassInfo();\
 }\
 \

-classname& expdecl operator << ( classname &value, const wxVariant &variant )\
+expdecl classname& operator << ( classname &value, const wxVariant &variant )\

 {\
 {\

-    wxASSERT( wxIsKindOf( variant.GetData(), classname##VariantData ) );\
+    wxASSERT( variant.GetType() == #classname );\

     \
     classname##VariantData *data = (classname##VariantData*) variant.GetData();\
     value = data->GetValue();\
     return value;\
 }\
 \
     \
     classname##VariantData *data = (classname##VariantData*) variant.GetData();\
     value = data->GetValue();\
     return value;\
 }\
 \

-wxVariant& expdecl operator << ( wxVariant &variant, const classname &value )\
+expdecl wxVariant& operator << ( wxVariant &variant, const classname &value )\

 {\
     classname##VariantData *data = new classname##VariantData( value );\
     variant.SetData( data );\
     return variant;\
 }
 
 {\
     classname##VariantData *data = new classname##VariantData( value );\
     variant.SetData( data );\
     return variant;\
 }
 

+// implements a wxVariantData-derived class using for the Eq() method the
+// operator== which must have been provided by "classname"
+#define IMPLEMENT_VARIANT_OBJECT_EXPORTED(classname,expdecl) \
+IMPLEMENT_VARIANT_OBJECT_EXPORTED_NO_EQ(classname,wxEMPTY_PARAMETER_VALUE expdecl) \
+\
+bool classname##VariantData::Eq(wxVariantData& data) const \
+{\
+    wxASSERT( GetType() == data.GetType() );\
+\
+    classname##VariantData & otherData = (classname##VariantData &) data;\
+\
+    return otherData.m_value == m_value;\
+}\
+
+
+// implements a wxVariantData-derived class using for the Eq() method a shallow
+// comparison (through wxObject::IsSameAs function)
+#define IMPLEMENT_VARIANT_OBJECT_SHALLOWCMP(classname) \
+    IMPLEMENT_VARIANT_OBJECT_EXPORTED_SHALLOWCMP(classname, wxEMPTY_PARAMETER_VALUE)
+#define IMPLEMENT_VARIANT_OBJECT_EXPORTED_SHALLOWCMP(classname,expdecl) \
+IMPLEMENT_VARIANT_OBJECT_EXPORTED_NO_EQ(classname,wxEMPTY_PARAMETER_VALUE expdecl) \
+\
+bool classname##VariantData::Eq(wxVariantData& data) const \
+{\
+    wxASSERT( GetType() == data.GetType() );\
+\
+    classname##VariantData & otherData = (classname##VariantData &) data;\
+\
+    return (otherData.m_value.IsSameAs(m_value));\
+}\
+
+

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


@@ -398,6 +429,9 @@ wxVariant& expdecl operator << ( wxVariant &variant, const classname &value )\
     ((classname*)(var.IsValueKindOf(&classname::ms_classInfo) ?\
                   var.GetWxObjectPtr() : NULL));
 
     ((classname*)(var.IsValueKindOf(&classname::ms_classInfo) ?\
                   var.GetWxObjectPtr() : NULL));
 

+// Replacement for using wxDynamicCast on a wxVariantData object
+#define wxDynamicCastVariantData(data, classname) dynamic_cast<classname*>(data)
+

 extern wxVariant WXDLLIMPEXP_BASE wxNullVariant;
 
 #endif // wxUSE_VARIANT
 extern wxVariant WXDLLIMPEXP_BASE wxNullVariant;
 
 #endif // wxUSE_VARIANT