add assertEquals(int,unsigned short) overload to resolve the ambiguity resulting...

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

diff --git a/include/wx/variant.h b/include/wx/variant.h
index 5d971dbba763a115691ea56ce1a33987873ab215..89cb6c437d73444f1e307e751efd4796007227d1 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,13 +55,11 @@
  * 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;


@@ -82,6 +77,10 @@ public:
     // If it based on wxObject return the ClassInfo.
     virtual wxClassInfo* GetValueClassInfo() { return NULL; }
 
     // 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,6 +105,10 @@ 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:
 class WXDLLIMPEXP_BASE wxVariant: public wxObject
 {
 public:


@@ -146,6 +146,9 @@ 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();
 


@@ -195,47 +198,69 @@ public:
     // wxDateTime
 #if wxUSE_DATETIME
     wxVariant(const wxDateTime& val, const wxString& name = wxEmptyString);
     // 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

     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 +268,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,26 +279,18 @@ 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;


@@ -302,7 +319,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


@@ -316,21 +335,15 @@ private:
     DECLARE_DYNAMIC_CLASS(wxVariant)
 };
 
     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) \
 expdecl classname& operator << ( classname &object, const wxVariant &variant ); \
 expdecl wxVariant& operator << ( wxVariant &variant, const classname &object );
 
 #define IMPLEMENT_VARIANT_OBJECT(classname) \
 
 #define DECLARE_VARIANT_OBJECT_EXPORTED(classname,expdecl) \
 expdecl classname& operator << ( classname &object, const wxVariant &variant ); \
 expdecl wxVariant& operator << ( wxVariant &variant, const classname &object );
 
 #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_NO_EQ(classname,expdecl) \
 class classname##VariantData: public wxVariantData \
 
 #define IMPLEMENT_VARIANT_OBJECT_EXPORTED_NO_EQ(classname,expdecl) \
 class classname##VariantData: public wxVariantData \


@@ -345,16 +358,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)\
-\

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


@@ -367,7 +377,7 @@ wxClassInfo* classname##VariantData::GetValueClassInfo()\
 \
 expdecl classname& 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();\
     \
     classname##VariantData *data = (classname##VariantData*) variant.GetData();\
     value = data->GetValue();\


@@ -381,14 +391,14 @@ expdecl wxVariant& operator << ( wxVariant &variant, const classname &value )\
     return variant;\
 }
 
     return variant;\
 }
 

-// implements a wxVariantData-derived class using for the Eq() method the operator==
-// which must have been provided by "classname"
+// 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) \
 #define IMPLEMENT_VARIANT_OBJECT_EXPORTED(classname,expdecl) \

-IMPLEMENT_VARIANT_OBJECT_EXPORTED_NO_EQ(classname,expdecl) \
+IMPLEMENT_VARIANT_OBJECT_EXPORTED_NO_EQ(classname,wxEMPTY_PARAMETER_VALUE expdecl) \

 \
 bool classname##VariantData::Eq(wxVariantData& data) const \
 {\
 \
 bool classname##VariantData::Eq(wxVariantData& data) const \
 {\

-    wxASSERT( wxIsKindOf((&data), classname##VariantData) );\
+    wxASSERT( GetType() == data.GetType() );\

 \
     classname##VariantData & otherData = (classname##VariantData &) data;\
 \
 \
     classname##VariantData & otherData = (classname##VariantData &) data;\
 \


@@ -398,12 +408,14 @@ bool classname##VariantData::Eq(wxVariantData& data) const \
 
 // implements a wxVariantData-derived class using for the Eq() method a shallow
 // comparison (through wxObject::IsSameAs function)
 
 // 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) \
 #define IMPLEMENT_VARIANT_OBJECT_EXPORTED_SHALLOWCMP(classname,expdecl) \

-IMPLEMENT_VARIANT_OBJECT_EXPORTED_NO_EQ(classname,expdecl) \
+IMPLEMENT_VARIANT_OBJECT_EXPORTED_NO_EQ(classname,wxEMPTY_PARAMETER_VALUE expdecl) \

 \
 bool classname##VariantData::Eq(wxVariantData& data) const \
 {\
 \
 bool classname##VariantData::Eq(wxVariantData& data) const \
 {\

-    wxASSERT( wxIsKindOf((&data), classname##VariantData) );\
+    wxASSERT( GetType() == data.GetType() );\

 \
     classname##VariantData & otherData = (classname##VariantData &) data;\
 \
 \
     classname##VariantData & otherData = (classname##VariantData &) data;\
 \


@@ -419,6 +431,9 @@ bool classname##VariantData::Eq(wxVariantData& data) const \
     ((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