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 e751dde6c1467b9f9c42490678accf7312af3995..61186b5f2002899c87a6b63080bafa254b514ad1 100644 (file)
--- a/include/wx/variant.h
+++ b/include/wx/variant.h
@@ -1,25 +1,26 @@
 /////////////////////////////////////////////////////////////////////////////
 /////////////////////////////////////////////////////////////////////////////

-// Name:        variant.h
+// Name:        wx/variant.h

 // Purpose:     wxVariant class, container for any type
 // Author:      Julian Smart
 // Modified by:
 // Created:     10/09/98
 // RCS-ID:      $Id$
 // Purpose:     wxVariant class, container for any type
 // Author:      Julian Smart
 // Modified by:
 // Created:     10/09/98
 // RCS-ID:      $Id$

-// Copyright:   (c)
+// Copyright:   (c) Julian Smart

 // Licence:     wxWindows licence
 /////////////////////////////////////////////////////////////////////////////
 
 #ifndef _WX_VARIANT_H_
 #define _WX_VARIANT_H_
 
 // 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/defs.h"

+
+#if wxUSE_VARIANT
+

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

+#include "wx/arrstr.h"

 #include "wx/list.h"
 #include "wx/list.h"

+#include "wx/cpp.h"

 
 #if wxUSE_DATETIME
     #include "wx/datetime.h"
 
 #if wxUSE_DATETIME
     #include "wx/datetime.h"


@@ -36,6 +37,19 @@
  * to allow it to store any type of data.
  * Derive from this to provide custom data handling.
  *
  * to allow it to store any type of data.
  * Derive from this to provide custom data handling.
  *

+ * NB: To prevent addition of extra vtbl pointer to wxVariantData,
+ *     we don't multiple-inherit from wxObjectRefData. Instead,
+ *     we simply replicate the wxObject ref-counting scheme.
+ *
+ * NB: When you construct a wxVariantData, it will have refcount
+ *     of one. Refcount will not be further increased when
+ *     it is passed to wxVariant. This simulates old common
+ *     scenario where wxVariant took ownership of wxVariantData
+ *     passed to it.
+ *     If you create wxVariantData for other reasons than passing
+ *     it to wxVariant, technically you are not required to call
+ *     DecRef() before deleting it.
+ *

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


@@ -45,190 +59,217 @@
  * overloading wxVariant with unnecessary functionality.
  */
 
  * overloading wxVariant with unnecessary functionality.
  */
 

-class WXDLLEXPORT wxVariantData: public wxObject
+class WXDLLIMPEXP_BASE wxVariantData: public wxObject

 {
 {

-DECLARE_ABSTRACT_CLASS(wxVariantData)
+    friend class wxVariant;

 public:
 public:

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

 
 

-// Construction & destruction
-    wxVariantData() {};
-
-// Override these to provide common functionality
-    // Copy to data
-    virtual void Copy(wxVariantData& data) = 0;
+    // Override these to provide common functionality

     virtual bool Eq(wxVariantData& data) const = 0;
     virtual bool Eq(wxVariantData& data) const = 0;

+

 #if wxUSE_STD_IOSTREAM
 #if wxUSE_STD_IOSTREAM

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

 #endif
 #endif

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

 #if wxUSE_STD_IOSTREAM
 #if wxUSE_STD_IOSTREAM

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

 #endif
 #endif

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

     // What type is it? Return a string name.
     virtual wxString GetType() const = 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; }
+
+    void IncRef() { m_count++; }
+    void DecRef()
+    {
+        if ( --m_count == 0 )
+            delete this;
+    }
+
+    int GetRefCount() const { return m_count; }
+
+protected:
+    // Protected dtor should make some incompatible code
+    // break more louder. That is, they should do data->DecRef()
+    // instead of delete data.
+    virtual ~wxVariantData() { }
+
+private:
+    int     m_count;
+
+private:
+    DECLARE_ABSTRACT_CLASS(wxVariantData)

 };
 
 /*
  * wxVariant can store any kind of data, but has some basic types
  * built in.
 };
 
 /*
  * 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
+class WXDLLIMPEXP_BASE wxVariant: public wxObject

 {
 {

-DECLARE_DYNAMIC_CLASS(wxVariant)

 public:
 public:

-
-// Construction & destruction

     wxVariant();
     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(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(const wxVariant& variant);

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

 
 

-// Generic operators
-    // Assignment
+    // generic assignment

     void operator= (const wxVariant& variant);
 
     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);
     // 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;
 

-// Specific operators
+    // 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
+    bool IsNull() const;
+
+    // For compatibility with wxWidgets <= 2.6, this doesn't increase
+    // reference count.
+    wxVariantData* GetData() const { return m_data; }
+    void SetData(wxVariantData* data) ;
+
+    // make a 'clone' of the object
+    void Ref(const wxVariant& clone);
+
+    // destroy a reference
+    void UnRef();
+
+    // 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;
+
+    bool IsType(const wxString& type) const;
+    bool IsValueKindOf(const wxClassInfo* type) const;
+
+    // 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;
     bool operator!= (double value) const;
     void operator= (double value) ;
     bool operator== (double value) const;
     bool operator!= (double value) const;
     void operator= (double value) ;

+    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);
+    wxVariant(short val, const wxString& name = wxEmptyString);

     bool operator== (long value) const;
     bool operator!= (long value) const;
     void operator= (long 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) ;
+    inline operator long () const {  return GetLong(); }
+    inline long GetInteger() const { return GetLong(); }
+    long GetLong() const;
+
+    // bool

 #ifdef HAVE_BOOL
 #ifdef HAVE_BOOL

+    wxVariant(bool val, const wxString& name = wxEmptyString);

     bool operator== (bool value) const;
     bool operator!= (bool value) const;
     void operator= (bool value) ;
     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
+    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) ;
+#if wxUSE_ODBC
+    void operator= (const DATE_STRUCT* value) ;
+    void operator= (const TIME_STRUCT* value) ;
+    void operator= (const TIMESTAMP_STRUCT* value) ;

 #endif
 #endif

+    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!

     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 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(); }
     inline operator wxString () const {  return MakeString(); }

-    wxString MakeString() const;
+    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 ;
+
+    // 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(); }
+    wxArrayString GetArrayString() 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(); }
+    // void*
+    wxVariant(void* ptr, const wxString& name = wxEmptyString);
+    bool operator== (void* value) const;
+    bool operator!= (void* value) const;
+    void operator= (void* value);

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

-//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; }
+    void* GetVoidPtr() const;

 
 

-    // Tests whether there is data
-    inline bool IsNull() const { return (m_data == (wxVariantData*) NULL); }
+    // wxObject*
+    wxVariant(wxObject* ptr, const wxString& name = wxEmptyString);
+    bool operator== (wxObject* value) const;
+    bool operator!= (wxObject* value) const;
+    void operator= (wxObject* value);
+    wxObject* GetWxObjectPtr() const;

 
 

-    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;
+    // ------------------------------
+    // list operations
+    // ------------------------------

 
 

-    // 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 ;
+    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) ;
+    // Treat a list variant as an array
+    wxVariant operator[] (size_t idx) const;
+    wxVariant& operator[] (size_t idx) ;

     wxList& GetList() const ;
     wxList& GetList() const ;

-    wxStringList& GetStringList() const ;
-
-    void* GetVoidPtr() const ;
-//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();
+    // Return the number of elements in a list
+    size_t GetCount() const;

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


@@ -239,36 +280,136 @@ public:
     // Insert at front of list
     void Insert(const wxVariant& value);
 
     // Insert at front of list
     void Insert(const wxVariant& value);
 

-    // Returns TRUE if the variant is a member of the list
+    // 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 Member(const wxVariant& value) const;
 
     // Deletes the nth element of the list

-    bool Delete(int item);
+    bool Delete(size_t item);

 
     // Clear list
     void ClearList();
 
 
     // Clear list
     void ClearList();
 

-// Implementation

 public:
 public:

-// Type conversion
+    // Type conversion

     bool Convert(long* value) const;
     bool Convert(bool* value) const;
     bool Convert(double* value) const;
     bool Convert(wxString* value) const;
     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
+    bool Convert(wxChar* value) const;

 #if wxUSE_DATETIME
     bool Convert(wxDateTime* value) const;
 #endif // wxUSE_DATETIME
 #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;
 
 // Attributes
 protected:
     wxVariantData*  m_data;
     wxString        m_name;

-};

 
 

-extern wxVariant WXDLLEXPORT wxNullVariant;
+private:
+    DECLARE_DYNAMIC_CLASS(wxVariant)
+};

 
 

-#endif
-    // _WX_VARIANT_H_
+#define DECLARE_VARIANT_OBJECT(classname) \
+    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:\
+    classname##VariantData() {} \
+    classname##VariantData( const classname &value ) { m_value = value; } \
+\
+    classname &GetValue() { return m_value; } \
+\
+    virtual bool Eq(wxVariantData& data) const; \
+\
+    virtual wxString GetType() const; \
+    virtual wxClassInfo* GetValueClassInfo(); \
+\
+protected:\
+    classname m_value; \
+\
+private: \
+    DECLARE_CLASS(classname##VariantData) \
+};\
+\
+IMPLEMENT_CLASS(classname##VariantData, wxVariantData)\
+\
+wxString classname##VariantData::GetType() const\
+{\
+    return m_value.GetClassInfo()->GetClassName();\
+}\
+\
+wxClassInfo* classname##VariantData::GetValueClassInfo()\
+{\
+    return m_value.GetClassInfo();\
+}\
+\
+expdecl classname& operator << ( classname &value, const wxVariant &variant )\
+{\
+    wxASSERT( wxIsKindOf( variant.GetData(), classname##VariantData ) );\
+    \
+    classname##VariantData *data = (classname##VariantData*) variant.GetData();\
+    value = data->GetValue();\
+    return value;\
+}\
+\
+expdecl wxVariant& operator << ( wxVariant &variant, const classname &value )\
+{\
+    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( 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
+// a dynamic_cast /wxDynamicCast analogue.
+
+#define wxGetVariantCast(var,classname) \
+    ((classname*)(var.IsValueKindOf(&classname::ms_classInfo) ?\
+                  var.GetWxObjectPtr() : NULL));
+
+extern wxVariant WXDLLIMPEXP_BASE wxNullVariant;
+
+#endif // wxUSE_VARIANT
+
+#endif // _WX_VARIANT_H_