Add support for VK_OEM_102 key under wxMSW.

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

diff --git a/include/wx/variant.h b/include/wx/variant.h
index d082a4f42b32e954eac3932fa617a26548fc566f..47922536296d8d1dd1aa55053c8ddcb193aa03e5 100644 (file)
--- a/include/wx/variant.h
+++ b/include/wx/variant.h
@@ -21,6 +21,7 @@
 #include "wx/arrstr.h"
 #include "wx/list.h"
 #include "wx/cpp.h"
 #include "wx/arrstr.h"
 #include "wx/list.h"
 #include "wx/cpp.h"

+#include "wx/longlong.h"

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


@@ -28,15 +29,13 @@
 
 #include "wx/iosfwrap.h"
 
 
 #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.
  *
 /*
  * 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
  * 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


@@ -77,10 +76,15 @@ 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
+    // Implement this to make wxVariant::UnShare work. Returns

     // a copy of the data.
     virtual wxVariantData* Clone() const { return NULL; }
 
     // a copy of the data.
     virtual wxVariantData* Clone() const { return NULL; }
 

+#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()
 protected:
     // Protected dtor should make some incompatible code
     // break more louder. That is, they should do data->DecRef()


@@ -104,6 +108,9 @@ public:
 
     wxVariant(const wxVariant& variant);
     wxVariant(wxVariantData* data, const wxString& name = wxEmptyString);
 
     wxVariant(const wxVariant& variant);
     wxVariant(wxVariantData* data, const wxString& name = wxEmptyString);

+#if wxUSE_ANY
+    wxVariant(const wxAny& any);
+#endif

     virtual ~wxVariant();
 
     // generic assignment
     virtual ~wxVariant();
 
     // generic assignment


@@ -125,14 +132,14 @@ public:
 
     // For compatibility with wxWidgets <= 2.6, this doesn't increase
     // reference count.
 
     // 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 SetData(wxVariantData* data) ;
 
     // make a 'clone' of the object

-    void Ref(const wxVariant& clone);
-
-    // destroy a reference
-    void UnRef();
+    void Ref(const wxVariant& clone) { wxObject::Ref(clone); }

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


@@ -153,6 +160,10 @@ public:
     // write contents to a string (e.g. for debugging)
     wxString MakeString() const;
 
     // 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;
     // double
     wxVariant(double val, const wxString& name = wxEmptyString);
     bool operator== (double value) const;


@@ -219,6 +230,26 @@ public:
     inline operator wxString () const {  return MakeString(); }
     wxString GetString() const;
 
     inline operator wxString () const {  return MakeString(); }
     wxString GetString() 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);
     // wxUniChar
     wxVariant(const wxUniChar& val, const wxString& name = wxEmptyString);
     wxVariant(const wxUniCharRef& val, const wxString& name = wxEmptyString);


@@ -264,6 +295,23 @@ public:
     void operator= (wxObject* value);
     wxObject* GetWxObjectPtr() const;
 
     void operator= (wxObject* value);
     wxObject* GetWxObjectPtr() 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
 
     // ------------------------------
     // list operations


@@ -311,16 +359,118 @@ public:
 #if wxUSE_DATETIME
     bool Convert(wxDateTime* value) const;
 #endif // wxUSE_DATETIME
 #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:
 
 // Attributes
 protected:

-    wxVariantData*  m_data;
+    virtual wxObjectRefData *CreateRefData() const;
+    virtual wxObjectRefData *CloneRefData(const wxObjectRefData *data) const;
+

     wxString        m_name;
 
 private:
     DECLARE_DYNAMIC_CLASS(wxVariant)
 };
 
     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) \
     DECLARE_VARIANT_OBJECT_EXPORTED(classname, wxEMPTY_PARAMETER_VALUE)
 
 #define DECLARE_VARIANT_OBJECT(classname) \
     DECLARE_VARIANT_OBJECT_EXPORTED(classname, wxEMPTY_PARAMETER_VALUE)
 


@@ -347,6 +497,7 @@ public:\
 \
     virtual wxVariantData* Clone() const { return new classname##VariantData(m_value); } \
 \
 \
     virtual wxVariantData* Clone() const { return new classname##VariantData(m_value); } \
 \

+    DECLARE_WXANY_CONVERSION() \

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


@@ -375,7 +526,8 @@ 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;\

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