added macros to avoid code repetition when defining comparison operators; use them...

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

diff --git a/include/wx/variant.h b/include/wx/variant.h
index 8f3648547404faed3d187d39d4ff37915b32bcca..61186b5f2002899c87a6b63080bafa254b514ad1 100644 (file)
--- a/include/wx/variant.h
+++ b/include/wx/variant.h
@@ -20,6 +20,7 @@
 #include "wx/string.h"
 #include "wx/arrstr.h"
 #include "wx/list.h"
+#include "wx/cpp.h"
 
 #if wxUSE_DATETIME
     #include "wx/datetime.h"
@@ -68,15 +69,15 @@ public:
 
     // Override these to provide common functionality
     virtual bool Eq(wxVariantData& data) const = 0;
-    
+
 #if wxUSE_STD_IOSTREAM
-    virtual bool Write(wxSTD ostream& str) const { return false; }
+    virtual bool Write(wxSTD ostream& WXUNUSED(str)) const { return false; }
 #endif
-    virtual bool Write(wxString& str) const { return false; }
+    virtual bool Write(wxString& WXUNUSED(str)) const { return false; }
 #if wxUSE_STD_IOSTREAM
-    virtual bool Read(wxSTD istream& str) { return false; }
+    virtual bool Read(wxSTD istream& WXUNUSED(str)) { return false; }
 #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.
@@ -99,7 +100,7 @@ protected:
 
 private:
     int     m_count;
-    
+
 private:
     DECLARE_ABSTRACT_CLASS(wxVariantData)
 };
@@ -113,7 +114,7 @@ class WXDLLIMPEXP_BASE wxVariant: public wxObject
 {
 public:
     wxVariant();
-    
+
     wxVariant(const wxVariant& variant);
     wxVariant(wxVariantData* data, const wxString& name = wxEmptyString);
     virtual ~wxVariant();
@@ -124,7 +125,7 @@ public:
     // 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;
 
@@ -133,7 +134,7 @@ public:
     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.
@@ -148,10 +149,10 @@ public:
 
     // Make NULL (i.e. delete the data)
     void MakeNull();
-    
+
     // 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;
@@ -159,9 +160,9 @@ public:
     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;
-    
+
     // double
     wxVariant(double val, const wxString& name = wxEmptyString);
     bool operator== (double value) const;
@@ -170,7 +171,7 @@ public:
     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);
@@ -181,8 +182,8 @@ public:
     inline operator long () const {  return GetLong(); }
     inline long GetInteger() const { return GetLong(); }
     long GetLong() const;
-    
-    // bool    
+
+    // bool
 #ifdef HAVE_BOOL
     wxVariant(bool val, const wxString& name = wxEmptyString);
     bool operator== (bool value) const;
@@ -194,7 +195,7 @@ public:
 
     // wxDateTime
 #if wxUSE_DATETIME
-    wxVariant(const wxDateTime& val, const wxString& name = wxEmptyString); 
+    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);
@@ -229,7 +230,7 @@ public:
     void operator= (wxChar value) ;
     inline operator wxChar () const { return GetChar(); }
     wxChar GetChar() const ;
-    
+
     // wxArrayString
     wxVariant(const wxArrayString& val, const wxString& name = wxEmptyString);
     bool operator== (const wxArrayString& value) const;
@@ -254,14 +255,6 @@ public:
     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
     // ------------------------------
@@ -277,7 +270,7 @@ public:
 
     // Return the number of elements in a list
     size_t GetCount() const;
-    
+
     // Make empty list
     void NullList();
 
@@ -302,7 +295,7 @@ public:
     bool Convert(bool* value) const;
     bool Convert(double* value) const;
     bool Convert(wxString* value) const;
-    bool Convert(char* value) const;
+    bool Convert(wxChar* value) const;
 #if wxUSE_DATETIME
     bool Convert(wxDateTime* value) const;
 #endif // wxUSE_DATETIME
@@ -311,17 +304,22 @@ public:
 protected:
     wxVariantData*  m_data;
     wxString        m_name;
-    
+
 private:
     DECLARE_DYNAMIC_CLASS(wxVariant)
 };
 
-
 #define DECLARE_VARIANT_OBJECT(classname) \
-classname& operator << ( classname &object, const wxVariant &variant ); \
-wxVariant& operator << ( wxVariant &variant, const classname &object );
+    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) \
+    IMPLEMENT_VARIANT_OBJECT_EXPORTED(classname, wxEMPTY_PARAMETER_VALUE)
+
+#define IMPLEMENT_VARIANT_OBJECT_EXPORTED_NO_EQ(classname,expdecl) \
 class classname##VariantData: public wxVariantData \
 { \
 public:\
@@ -344,15 +342,6 @@ private: \
 \
 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();\
@@ -363,7 +352,7 @@ wxClassInfo* classname##VariantData::GetValueClassInfo()\
     return m_value.GetClassInfo();\
 }\
 \
-classname& operator << ( classname &value, const wxVariant &variant )\
+expdecl classname& operator << ( classname &value, const wxVariant &variant )\
 {\
     wxASSERT( wxIsKindOf( variant.GetData(), classname##VariantData ) );\
     \
@@ -372,26 +361,44 @@ classname& operator << ( classname &value, const wxVariant &variant )\
     return value;\
 }\
 \
-wxVariant& 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;\
 }
 
-#include "wx/colour.h"
-#include "wx/pen.h"
-#include "wx/brush.h"
-#include "wx/image.h"
-#include "wx/icon.h"
-#include "wx/bitmap.h"
-
-DECLARE_VARIANT_OBJECT(wxColour)
-DECLARE_VARIANT_OBJECT(wxPen)
-DECLARE_VARIANT_OBJECT(wxBrush)
-DECLARE_VARIANT_OBJECT(wxImage)
-DECLARE_VARIANT_OBJECT(wxIcon)
-DECLARE_VARIANT_OBJECT(wxBitmap)
+// 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( wxIsKindOf((&data), classname##VariantData) );\
+\
+    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( wxIsKindOf((&data), classname##VariantData) );\
+\
+    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