initial commit

Signed-off-by: Peter Siegmund <mars3142@noreply.mars3142.dev>

libs/wxWidgets-3.3.1/include/wx/variant.h

@@ -0,0 +1,600 @@
+/////////////////////////////////////////////////////////////////////////////
+// Name:        wx/variant.h
+// Purpose:     wxVariant class, container for any type
+// Author:      Julian Smart
+// Created:     10/09/98
+// Copyright:   (c) Julian Smart
+// Licence:     wxWindows licence
+/////////////////////////////////////////////////////////////////////////////
+
+#ifndef _WX_VARIANT_H_
+#define _WX_VARIANT_H_
+
+#include "wx/defs.h"
+
+#if wxUSE_VARIANT
+
+#include "wx/object.h"
+#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
+
+#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: 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.
+ * Essentially wxPropertyValue takes on some of the wxValidator functionality
+ * by storing pointers and not just actual values, allowing update of C++ data
+ * to be handled automatically. Perhaps there's another way of doing this without
+ * overloading wxVariant with unnecessary functionality.
+ */
+
+class WXDLLIMPEXP_BASE wxVariantData : public wxObjectRefData
+{
+    friend class wxVariant;
+public:
+    wxVariantData() = default;
+
+    // Override these to provide common functionality
+    virtual bool Eq(wxVariantData& data) const = 0;
+
+#if wxUSE_STD_IOSTREAM
+    virtual bool Write(std::ostream& WXUNUSED(str)) const { return false; }
+#endif
+    virtual bool Write(wxString& WXUNUSED(str)) const { return false; }
+#if wxUSE_STD_IOSTREAM
+    virtual bool Read(std::istream& WXUNUSED(str)) { return false; }
+#endif
+    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 nullptr; }
+
+    // Implement this to make wxVariant::UnShare work. Returns
+    // a copy of the data.
+    wxNODISCARD virtual wxVariantData* Clone() const { return nullptr; }
+
+#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() = default;
+};
+
+/*
+ * wxVariant can store any kind of data, but has some basic types
+ * 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
+    void operator= (const wxVariant& variant);
+
+    // 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;
+
+    // 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 (wxVariantData*) m_refData;
+    }
+    void SetData(wxVariantData* data) ;
+
+    // make a 'clone' of the object
+    void Ref(const wxVariant& clone) { wxObject::Ref(clone); }
+
+    // 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)
+    wxString MakeString() const;
+
+#if wxUSE_ANY
+    wxAny GetAny() const;
+#endif
+
+    // double
+    wxVariant(double val, const wxString& name = wxEmptyString);
+    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) ;
+    inline operator long () const {  return GetLong(); }
+    inline long GetInteger() const { return GetLong(); }
+    long GetLong() const;
+
+    // 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 ;
+
+    // wxDateTime
+#if wxUSE_DATETIME
+    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) ;
+    inline operator wxDateTime () const { return GetDateTime(); }
+    wxDateTime GetDateTime() const;
+#endif
+
+    // wxString
+    wxVariant(const wxString& val, const wxString& name = wxEmptyString);
+    // 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;
+    wxVariant& operator=(const wxString& value);
+    // these overloads are necessary to prevent the compiler from using bool
+    // version instead of wxString one:
+#ifndef wxNO_IMPLICIT_WXSTRING_ENCODING
+    wxVariant& operator=(const char* value)
+        { return *this = wxString(value); }
+#endif // wxNO_IMPLICIT_WXSTRING_ENCODING
+    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;
+
+#ifndef wxNO_IMPLICIT_WXSTRING_ENCODING
+    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(); }
+#endif // wxNO_IMPLICIT_WXSTRING_ENCODING
+
+    wxVariant(const std::wstring& val, const wxString& name = wxEmptyString);
+    bool operator==(const std::wstring& value) const
+        { return operator==(wxString(value)); }
+    bool operator!=(const std::wstring& value) const
+        { return operator!=(wxString(value)); }
+    wxVariant& operator=(const std::wstring& value)
+        { return operator=(wxString(value)); }
+    operator std::wstring() const { return (operator wxString()).ToStdWstring(); }
+
+    // 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);
+    operator wxArrayString () const { return GetArrayString(); }
+    wxArrayString GetArrayString() const;
+
+    // void*
+    wxVariant(void* ptr, const wxString& name = wxEmptyString);
+    bool operator== (void* value) const;
+    bool operator!= (void* value) const;
+    void operator= (void* value);
+    operator void* () const {  return GetVoidPtr(); }
+    void* GetVoidPtr() const;
+
+    // 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;
+
+    // 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;
+
+    // ------------------------------
+    // list operations
+    // ------------------------------
+
+    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) ;
+    wxVariantList& GetList() const ;
+
+    // Return the number of elements in a list
+    size_t GetCount() const;
+
+    // Make empty list
+    void NullList();
+
+    // Append to list
+    void Append(const wxVariant& value);
+
+    // Insert at front of list
+    void Insert(const wxVariant& value);
+
+    // 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 Delete(size_t item);
+
+    // Clear list
+    void ClearList();
+
+public:
+    // Type conversion
+    bool Convert(long* value) const;
+    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
+    bool Convert(wxLongLong* value) const;
+    bool Convert(wxULongLong* value) const;
+    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;
+    }
+
+// Attributes
+protected:
+    virtual wxObjectRefData *CreateRefData() const override;
+    wxNODISCARD virtual wxObjectRefData *CloneRefData(const wxObjectRefData *data) const override;
+
+    wxString        m_name;
+
+private:
+    wxDECLARE_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() override
+    {
+        return wxAnyValueTypeImpl<T>::GetInstance();
+    }
+private:
+};
+
+#define DECLARE_WXANY_CONVERSION() \
+virtual bool GetAsAny(wxAny* any) const override; \
+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(any.As<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
+
+// Note: these macros must be used inside "classname" declaration.
+#define wxDECLARE_VARIANT_OBJECT(classname) \
+    wxDECLARE_VARIANT_OBJECT_EXPORTED(classname, wxEMPTY_PARAMETER_VALUE)
+
+#define wxDECLARE_VARIANT_OBJECT_EXPORTED(classname,expdecl) \
+    friend expdecl classname& operator<<(classname &object, const wxVariant &variant); \
+    friend expdecl wxVariant& operator<<(wxVariant &variant, const classname &object)
+
+// These macros are deprecated, consider using wxDECLARE_VARIANT_OBJECT() above
+// instead.
+#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 );
+
+// These macros use "wx" prefix and require a semicolon after them for
+// consistency with the rest of wx macros, but are otherwise the same as the
+// older IMPLEMENT_VARIANT_XXX macros.
+#define wxIMPLEMENT_VARIANT_OBJECT(classname) \
+    IMPLEMENT_VARIANT_OBJECT_EXPORTED(classname, wxEMPTY_PARAMETER_VALUE) \
+    struct wxDummyVariantStructFwdDecl /* to force a semicolon */
+
+#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() = default; \
+    classname##VariantData( const classname &value ) : m_value(value) { } \
+\
+    classname &GetValue() { return m_value; } \
+\
+    virtual bool Eq(wxVariantData& data) const override; \
+\
+    virtual wxString GetType() const override; \
+    virtual wxClassInfo* GetValueClassInfo() override; \
+\
+    wxNODISCARD virtual wxVariantData* Clone() const override { return new classname##VariantData(m_value); } \
+\
+    DECLARE_WXANY_CONVERSION() \
+protected:\
+    classname m_value; \
+};\
+\
+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( variant.GetType() == #classname );\
+    \
+    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;\
+} \
+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
+// a dynamic_cast /wxDynamicCast analogue.
+
+#define wxGetVariantCast(var,classname) \
+    ((classname*)(var.IsValueKindOf(&classname::ms_classInfo) ?\
+                  var.GetWxObjectPtr() : nullptr));
+
+// 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;
+
+#else // !wxUSE_VARIANT
+
+// Define these macros to allow using them without checking for wxUSE_VARIANT
+// and simply do nothing in them in this case.
+#define wxDECLARE_VARIANT_OBJECT(classname)
+#define wxDECLARE_VARIANT_OBJECT_EXPORTED(classname,expdecl)
+
+#endif // wxUSE_VARIANT/!wxUSE_VARIANT
+
+#endif // _WX_VARIANT_H_