// Author: Julian Smart
// Modified by:
// Created: 10/09/98
-// RCS-ID: $Id$
// Copyright: (c) Julian Smart
// Licence: wxWindows licence
/////////////////////////////////////////////////////////////////////////////
#include "wx/string.h"
#include "wx/arrstr.h"
#include "wx/list.h"
+#include "wx/cpp.h"
+#include "wx/longlong.h"
#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"
+class wxAny;
+
/*
* 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.
*
- * 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
* overloading wxVariant with unnecessary functionality.
*/
-class WXDLLIMPEXP_BASE wxVariantData: public wxObject
+class WXDLLIMPEXP_BASE wxVariantData : public wxObjectRefData
{
friend class wxVariant;
public:
- wxVariantData()
- : wxObject(), m_count(1)
- { }
+ wxVariantData() { }
// 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.
virtual wxClassInfo* GetValueClassInfo() { return NULL; }
- void IncRef() { m_count++; }
- void DecRef()
- {
- if ( --m_count == 0 )
- delete this;
- }
+ // Implement this to make wxVariant::UnShare work. Returns
+ // a copy of the data.
+ virtual wxVariantData* Clone() const { return NULL; }
- int GetRefCount() const { return m_count; }
+#if wxUSE_ANY
+ // Converts value to wxAny, if possible. Return true if successful.
+ virtual bool GetAsAny(wxAny* WXUNUSED(any)) const { return false; }
+#endif
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)
};
/*
* 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();
-
+
wxVariant(const wxVariant& variant);
wxVariant(wxVariantData* data, const wxString& name = wxEmptyString);
+#if wxUSE_ANY
+ wxVariant(const wxAny& any);
+#endif
virtual ~wxVariant();
// generic assignment
// 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;
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.
- wxVariantData* GetData() const { return m_data; }
+ wxVariantData* GetData() const
+ {
+ return (wxVariantData*) m_refData;
+ }
void SetData(wxVariantData* data) ;
// make a 'clone' of the object
- void Ref(const wxVariant& clone);
+ void Ref(const wxVariant& clone) { wxObject::Ref(clone); }
- // 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();
-
+
// 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)
+ // write contents to a string (e.g. for debugging)
wxString MakeString() const;
-
+
+#if wxUSE_ANY
+ wxAny GetAny() const;
+#endif
+
// double
wxVariant(double val, const wxString& name = wxEmptyString);
bool operator== (double value) 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);
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 ;
-#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
+ 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) ;
-#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);
- 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 wxScopedCharBuffer& val, const wxString& name = wxEmptyString);
+ wxVariant(const wxScopedWCharBuffer& val, const wxString& name = wxEmptyString);
+
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 wxScopedCharTypeBuffer<T>& value)
+ { return *this = value.data(); }
+
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 ;
-
+#if wxUSE_STD_STRING
+ wxVariant(const std::string& val, const wxString& name = wxEmptyString);
+ bool operator==(const std::string& value) const
+ { return operator==(wxString(value)); }
+ bool operator!=(const std::string& value) const
+ { return operator!=(wxString(value)); }
+ wxVariant& operator=(const std::string& value)
+ { return operator=(wxString(value)); }
+ operator std::string() const { return (operator wxString()).ToStdString(); }
+
+ wxVariant(const wxStdWideString& val, const wxString& name = wxEmptyString);
+ bool operator==(const wxStdWideString& value) const
+ { return operator==(wxString(value)); }
+ bool operator!=(const wxStdWideString& value) const
+ { return operator!=(wxString(value)); }
+ wxVariant& operator=(const wxStdWideString& value)
+ { return operator=(wxString(value)); }
+ operator wxStdWideString() const { return (operator wxString()).ToStdWstring(); }
+#endif // wxUSE_STD_STRING
+
+ // 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);
- inline operator wxArrayString () const { return GetArrayString(); }
+ operator wxArrayString () const { return GetArrayString(); }
wxArrayString GetArrayString() const;
// void*
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 operator= (wxObject* value);
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 );
+#if wxUSE_LONGLONG
+ // wxLongLong
+ wxVariant(wxLongLong, const wxString& name = wxEmptyString);
+ bool operator==(wxLongLong value) const;
+ bool operator!=(wxLongLong value) const;
+ void operator=(wxLongLong value);
+ operator wxLongLong() const { return GetLongLong(); }
+ wxLongLong GetLongLong() const;
+
+ // wxULongLong
+ wxVariant(wxULongLong, const wxString& name = wxEmptyString);
+ bool operator==(wxULongLong value) const;
+ bool operator!=(wxULongLong value) const;
+ void operator=(wxULongLong value);
+ operator wxULongLong() const { return GetULongLong(); }
+ wxULongLong GetULongLong() const;
#endif
// ------------------------------
// 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) ;
- wxList& GetList() const ;
+ wxVariantList& GetList() const ;
// Return the number of elements in a list
size_t GetCount() const;
-
+
// Make empty list
void NullList();
bool Convert(bool* value) const;
bool Convert(double* value) const;
bool Convert(wxString* 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_LONGLONG
+ bool Convert(wxLongLong* value) const;
+ bool Convert(wxULongLong* value) const;
+ #ifdef wxLongLong_t
+ bool Convert(wxLongLong_t* value) const
+ {
+ wxLongLong temp;
+ if ( !Convert(&temp) )
+ return false;
+ *value = temp.GetValue();
+ return true;
+ }
+ bool Convert(wxULongLong_t* value) const
+ {
+ wxULongLong temp;
+ if ( !Convert(&temp) )
+ return false;
+ *value = temp.GetValue();
+ return true;
+ }
+ #endif // wxLongLong_t
+#endif // wxUSE_LONGLONG
// Attributes
protected:
- wxVariantData* m_data;
+ virtual wxObjectRefData *CreateRefData() const;
+ virtual wxObjectRefData *CloneRefData(const wxObjectRefData *data) const;
+
wxString m_name;
-
+
private:
DECLARE_DYNAMIC_CLASS(wxVariant)
};
+//
+// wxVariant <-> wxAny conversion code
+//
+#if wxUSE_ANY
+
+#include "wx/any.h"
+
+// In order to convert wxAny to wxVariant, we need to be able to associate
+// wxAnyValueType with a wxVariantData factory function.
+typedef wxVariantData* (*wxVariantDataFactory)(const wxAny& any);
+
+// Actual Any-to-Variant registration must be postponed to a time when all
+// global variables have been initialized. Hence this arrangement.
+// wxAnyToVariantRegistration instances are kept in global scope and
+// wxAnyValueTypeGlobals in any.cpp will use their data when the time is
+// right.
+class WXDLLIMPEXP_BASE wxAnyToVariantRegistration
+{
+public:
+ wxAnyToVariantRegistration(wxVariantDataFactory factory);
+ virtual ~wxAnyToVariantRegistration();
+
+ virtual wxAnyValueType* GetAssociatedType() = 0;
+ wxVariantDataFactory GetFactory() const { return m_factory; }
+private:
+ wxVariantDataFactory m_factory;
+};
+
+template<typename T>
+class wxAnyToVariantRegistrationImpl : public wxAnyToVariantRegistration
+{
+public:
+ wxAnyToVariantRegistrationImpl(wxVariantDataFactory factory)
+ : wxAnyToVariantRegistration(factory)
+ {
+ }
+
+ virtual wxAnyValueType* GetAssociatedType()
+ {
+ return wxAnyValueTypeImpl<T>::GetInstance();
+ }
+private:
+};
+
+#define DECLARE_WXANY_CONVERSION() \
+virtual bool GetAsAny(wxAny* any) const; \
+static wxVariantData* VariantDataFactory(const wxAny& any);
+
+#define _REGISTER_WXANY_CONVERSION(T, CLASSNAME, FUNC) \
+static wxAnyToVariantRegistrationImpl<T> \
+ gs_##CLASSNAME##AnyToVariantRegistration = \
+ wxAnyToVariantRegistrationImpl<T>(&FUNC);
+
+#define REGISTER_WXANY_CONVERSION(T, CLASSNAME) \
+_REGISTER_WXANY_CONVERSION(T, CLASSNAME, CLASSNAME::VariantDataFactory)
+
+#define IMPLEMENT_TRIVIAL_WXANY_CONVERSION(T, CLASSNAME) \
+bool CLASSNAME::GetAsAny(wxAny* any) const \
+{ \
+ *any = m_value; \
+ return true; \
+} \
+wxVariantData* CLASSNAME::VariantDataFactory(const wxAny& any) \
+{ \
+ return new CLASSNAME(wxANY_AS(any, T)); \
+} \
+REGISTER_WXANY_CONVERSION(T, CLASSNAME)
+
+#else // if !wxUSE_ANY
+
+#define DECLARE_WXANY_CONVERSION()
+#define REGISTER_WXANY_CONVERSION(T, CLASSNAME)
+#define IMPLEMENT_TRIVIAL_WXANY_CONVERSION(T, CLASSNAME)
+
+#endif // wxUSE_ANY/!wxUSE_ANY
+
+
#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:\
virtual wxString GetType() const; \
virtual wxClassInfo* GetValueClassInfo(); \
\
+ virtual wxVariantData* Clone() const { return new classname##VariantData(m_value); } \
+\
+ DECLARE_WXANY_CONVERSION() \
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();\
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 ) );\
+ wxASSERT( variant.GetType() == #classname );\
\
classname##VariantData *data = (classname##VariantData*) variant.GetData();\
value = data->GetValue();\
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)
+} \
+IMPLEMENT_TRIVIAL_WXANY_CONVERSION(classname, classname##VariantData)
+
+// 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
((classname*)(var.IsValueKindOf(&classname::ms_classInfo) ?\
var.GetWxObjectPtr() : NULL));
+// Replacement for using wxDynamicCast on a wxVariantData object
+#ifndef wxNO_RTTI
+ #define wxDynamicCastVariantData(data, classname) dynamic_cast<classname*>(data)
+#endif
+
+#define wxStaticCastVariantData(data, classname) static_cast<classname*>(data)
+
extern wxVariant WXDLLIMPEXP_BASE wxNullVariant;
#endif // wxUSE_VARIANT
projects / wxWidgets.git / blobdiff