Clarified wxPropertyGrid::HitTest() docs

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

diff --git a/include/wx/object.h b/include/wx/object.h
index 17e4682d6d3b5c31c86225441b5c013229a44c55..b5f34262d63739fc241dd31fb733da926f880de0 100644 (file)
--- a/include/wx/object.h
+++ b/include/wx/object.h
@@ -17,15 +17,46 @@
 // headers
 // ----------------------------------------------------------------------------
 
 // headers
 // ----------------------------------------------------------------------------
 

-#include "wx/defs.h"

 #include "wx/memory.h"
 
 #include "wx/memory.h"
 

-class WXDLLIMPEXP_BASE wxObject;
+class WXDLLIMPEXP_FWD_BASE wxObject;
+class WXDLLIMPEXP_FWD_BASE wxString;

 
 #ifndef wxUSE_EXTENDED_RTTI
 #define wxUSE_EXTENDED_RTTI 0
 #endif
 
 
 #ifndef wxUSE_EXTENDED_RTTI
 #define wxUSE_EXTENDED_RTTI 0
 #endif
 

+#define DECLARE_CLASS_INFO_ITERATORS()                                       \
+    class WXDLLIMPEXP_BASE const_iterator                                    \
+    {                                                                        \
+        typedef wxHashTable_Node Node;                                       \
+    public:                                                                  \
+        typedef const wxClassInfo* value_type;                               \
+        typedef const value_type& const_reference;                           \
+        typedef const_iterator itor;                                         \
+        typedef value_type* ptr_type;                                        \
+                                                                             \
+        Node* m_node;                                                        \
+        wxHashTable* m_table;                                                \
+    public:                                                                  \
+        typedef const_reference reference_type;                              \
+        typedef ptr_type pointer_type;                                       \
+                                                                             \
+        const_iterator(Node* node, wxHashTable* table)                       \
+            : m_node(node), m_table(table) { }                               \
+        const_iterator() : m_node(NULL), m_table(NULL) { }                   \
+        value_type operator*() const;                                        \
+        itor& operator++();                                                  \
+        const itor operator++(int);                                          \
+        bool operator!=(const itor& it) const                                \
+            { return it.m_node != m_node; }                                  \
+        bool operator==(const itor& it) const                                \
+            { return it.m_node == m_node; }                                  \
+    };                                                                       \
+                                                                             \
+    static const_iterator begin_classinfo();                                 \
+    static const_iterator end_classinfo();
+

 #if wxUSE_EXTENDED_RTTI
 #include "wx/xti.h"
 #else
 #if wxUSE_EXTENDED_RTTI
 #include "wx/xti.h"
 #else


@@ -34,9 +65,12 @@ class WXDLLIMPEXP_BASE wxObject;
 // conditional compilation
 // ----------------------------------------------------------------------------
 
 // conditional compilation
 // ----------------------------------------------------------------------------
 

-class WXDLLIMPEXP_BASE wxClassInfo;
-class WXDLLIMPEXP_BASE wxHashTable;
-class WXDLLIMPEXP_BASE wxObjectRefData;
+class WXDLLIMPEXP_FWD_BASE wxClassInfo;
+class WXDLLIMPEXP_FWD_BASE wxHashTable;
+class WXDLLIMPEXP_FWD_BASE wxObject;
+class WXDLLIMPEXP_FWD_BASE wxPluginLibrary;
+class WXDLLIMPEXP_FWD_BASE wxObjectRefData;
+class WXDLLIMPEXP_FWD_BASE wxHashTable_Node;

 
 // ----------------------------------------------------------------------------
 // wxClassInfo
 
 // ----------------------------------------------------------------------------
 // wxClassInfo


@@ -46,6 +80,8 @@ typedef wxObject *(*wxObjectConstructorFn)(void);
 
 class WXDLLIMPEXP_BASE wxClassInfo
 {
 
 class WXDLLIMPEXP_BASE wxClassInfo
 {

+    friend class WXDLLIMPEXP_FWD_BASE wxObject;
+    friend WXDLLIMPEXP_BASE wxObject *wxCreateDynamicObject(const wxString& name);

 public:
     wxClassInfo( const wxChar *className,
                  const wxClassInfo *baseInfo1,
 public:
     wxClassInfo( const wxChar *className,
                  const wxClassInfo *baseInfo1,


@@ -65,7 +101,9 @@ public:
 
     ~wxClassInfo();
 
 
     ~wxClassInfo();
 

-    wxObject *CreateObject() { return m_objectConstructor ? (*m_objectConstructor)() : 0; }
+    wxObject *CreateObject() const
+        { return m_objectConstructor ? (*m_objectConstructor)() : 0; }
+    bool IsDynamic() const { return (NULL != m_objectConstructor); }

 
     const wxChar       *GetClassName() const { return m_className; }
     const wxChar       *GetBaseClassName1() const
 
     const wxChar       *GetClassName() const { return m_className; }
     const wxChar       *GetBaseClassName1() const


@@ -76,10 +114,11 @@ public:
     const wxClassInfo  *GetBaseClass2() const { return m_baseInfo2; }
     int                 GetSize() const { return m_objectSize; }
 
     const wxClassInfo  *GetBaseClass2() const { return m_baseInfo2; }
     int                 GetSize() const { return m_objectSize; }
 

-    wxObjectConstructorFn      GetConstructor() const { return m_objectConstructor; }
+    wxObjectConstructorFn      GetConstructor() const
+        { return m_objectConstructor; }

     static const wxClassInfo  *GetFirst() { return sm_first; }
     const wxClassInfo         *GetNext() const { return m_next; }
     static const wxClassInfo  *GetFirst() { return sm_first; }
     const wxClassInfo         *GetNext() const { return m_next; }

-    static wxClassInfo        *FindClass(const wxChar *className);
+    static wxClassInfo        *FindClass(const wxString& className);

 
         // Climb upwards through inheritance hierarchy.
         // Dual inheritance is catered for.
 
         // Climb upwards through inheritance hierarchy.
         // Dual inheritance is catered for.


@@ -92,20 +131,13 @@ public:
                  ( m_baseInfo2 && m_baseInfo2->IsKindOf(info) ) );
     }
 
                  ( m_baseInfo2 && m_baseInfo2->IsKindOf(info) ) );
     }
 

-#if WXWIN_COMPATIBILITY_2_4
-    // Initializes parent pointers and hash table for fast searching.
-    wxDEPRECATED( static void InitializeClasses() );
-    // Cleans up hash table used for fast searching.
-    wxDEPRECATED( static void CleanUpClasses() );
-#endif
-    static void     CleanUp();
-
-public:
+    DECLARE_CLASS_INFO_ITERATORS()
+private:

     const wxChar            *m_className;
     int                      m_objectSize;
     wxObjectConstructorFn    m_objectConstructor;
 
     const wxChar            *m_className;
     int                      m_objectSize;
     wxObjectConstructorFn    m_objectConstructor;
 

-        // Pointers to base wxClassInfos: set in InitializeClasses
+        // Pointers to base wxClassInfos

 
     const wxClassInfo       *m_baseInfo1;
     const wxClassInfo       *m_baseInfo2;
 
     const wxClassInfo       *m_baseInfo1;
     const wxClassInfo       *m_baseInfo2;


@@ -116,28 +148,17 @@ public:
     static wxClassInfo      *sm_first;
     wxClassInfo             *m_next;
 
     static wxClassInfo      *sm_first;
     wxClassInfo             *m_next;
 

-    // FIXME: this should be private (currently used directly by way too
-    //        many clients)

     static wxHashTable      *sm_classTable;
 
     static wxHashTable      *sm_classTable;
 

-private:
-    // InitializeClasses() helper
-    static wxClassInfo *GetBaseByName(const wxChar *name);
-
-    DECLARE_NO_COPY_CLASS(wxClassInfo)
-

 protected:
     // registers the class
     void Register();
     void Unregister();
 protected:
     // registers the class
     void Register();
     void Unregister();

-};

 
 

-WXDLLIMPEXP_BASE wxObject *wxCreateDynamicObject(const wxChar *name);
+    wxDECLARE_NO_COPY_CLASS(wxClassInfo);
+};

 
 

-#if WXWIN_COMPATIBILITY_2_4
-inline void wxClassInfo::InitializeClasses() {}
-inline void wxClassInfo::CleanUpClasses() {}
-#endif
+WXDLLIMPEXP_BASE wxObject *wxCreateDynamicObject(const wxString& name);

 
 // ----------------------------------------------------------------------------
 // Dynamic class macros
 
 // ----------------------------------------------------------------------------
 // Dynamic class macros


@@ -257,9 +278,9 @@ name##PluginSentinel  m_pluginsentinel;
 #endif  // wxUSE_NESTED_CLASSES
 
 #define DECLARE_PLUGGABLE_CLASS(name) \
 #endif  // wxUSE_NESTED_CLASSES
 
 #define DECLARE_PLUGGABLE_CLASS(name) \

- DECLARE_DYNAMIC_CLASS(name) _DECLARE_DL_SENTINEL(name, WXDLLEXPORT)
+ DECLARE_DYNAMIC_CLASS(name) _DECLARE_DL_SENTINEL(name, WXDLLIMPEXP_CORE)

 #define DECLARE_ABSTRACT_PLUGGABLE_CLASS(name)  \
 #define DECLARE_ABSTRACT_PLUGGABLE_CLASS(name)  \

- DECLARE_ABSTRACT_CLASS(name) _DECLARE_DL_SENTINEL(name, WXDLLEXPORT)
+ DECLARE_ABSTRACT_CLASS(name) _DECLARE_DL_SENTINEL(name, WXDLLIMPEXP_CORE)

 
 #define DECLARE_USER_EXPORTED_PLUGGABLE_CLASS(name, usergoo) \
  DECLARE_DYNAMIC_CLASS(name) _DECLARE_DL_SENTINEL(name, usergoo)
 
 #define DECLARE_USER_EXPORTED_PLUGGABLE_CLASS(name, usergoo) \
  DECLARE_DYNAMIC_CLASS(name) _DECLARE_DL_SENTINEL(name, usergoo)


@@ -298,8 +319,8 @@ name##PluginSentinel  m_pluginsentinel;
 // be replaced by it as long as there are any compilers not supporting it
 #define wxDynamicCast(obj, className) \
     ((className *) wxCheckDynamicCast( \
 // be replaced by it as long as there are any compilers not supporting it
 #define wxDynamicCast(obj, className) \
     ((className *) wxCheckDynamicCast( \

-        wx_const_cast(wxObject *, wx_static_cast(const wxObject *, \
-          wx_const_cast(className *, wx_static_cast(const className *, obj)))), \
+        const_cast<wxObject *>(static_cast<const wxObject *>(\
+          const_cast<className *>(static_cast<const className *>(obj)))), \

         &className::ms_classInfo))
 
 // The 'this' pointer is always true, so use this version
         &className::ms_classInfo))
 
 // The 'this' pointer is always true, so use this version


@@ -318,7 +339,7 @@ inline void* wxCheckCast(void *ptr)
 
 #else  // !__WXDEBUG__
 #define wxStaticCast(obj, className) \
 
 #else  // !__WXDEBUG__
 #define wxStaticCast(obj, className) \

-    wx_const_cast(className *, wx_static_cast(const className *, obj))
+    const_cast<className *>(static_cast<const className *>(obj))

 
 #endif  // __WXDEBUG__
 
 
 #endif  // __WXDEBUG__
 


@@ -353,8 +374,9 @@ inline void* wxCheckCast(void *ptr)
     #define _WX_WANT_DELETE_VOID_CONSTCHAR_SIZET
 #endif
 
     #define _WX_WANT_DELETE_VOID_CONSTCHAR_SIZET
 #endif
 

-// Only VC++ 6.0 and CodeWarrior compilers get overloaded delete that matches new
-#if ( defined(__VISUALC__) && (__VISUALC__ >= 1200) ) || (defined(__MWERKS__) && (__MWERKS__ >= 0x2400))
+// Only VC++ 6 and CodeWarrior get overloaded delete that matches new
+#if (defined(__VISUALC__) && (__VISUALC__ >= 1200)) || \
+        (defined(__MWERKS__) && (__MWERKS__ >= 0x2400))

     #define _WX_WANT_DELETE_VOID_WXCHAR_INT
 #endif
 
     #define _WX_WANT_DELETE_VOID_WXCHAR_INT
 #endif
 


@@ -386,18 +408,104 @@ inline void* wxCheckCast(void *ptr)
 
 class WXDLLIMPEXP_BASE wxObjectRefData
 {
 
 class WXDLLIMPEXP_BASE wxObjectRefData
 {

-    friend class WXDLLIMPEXP_BASE wxObject;
+    friend class WXDLLIMPEXP_FWD_BASE wxObject;

 
 public:
     wxObjectRefData() : m_count(1) { }
 
 public:
     wxObjectRefData() : m_count(1) { }

-    virtual ~wxObjectRefData() { }

 
     int GetRefCount() const { return m_count; }
 
 
     int GetRefCount() const { return m_count; }
 

+    void IncRef() { m_count++; }
+    void DecRef();
+
+protected:
+    // this object should never be destroyed directly but only as a
+    // result of a DecRef() call:
+    virtual ~wxObjectRefData() { }
+

 private:
 private:

+    // our refcount:

     int m_count;
 };
 
     int m_count;
 };
 

+// ----------------------------------------------------------------------------
+// wxObjectDataPtr: helper class to avoid memleaks because of missing calls
+//                  to wxObjectRefData::DecRef
+// ----------------------------------------------------------------------------
+
+template <class T>
+class wxObjectDataPtr
+{
+public:
+    typedef T element_type;
+
+    wxEXPLICIT wxObjectDataPtr(T *ptr = NULL) : m_ptr(ptr) {}
+
+    // copy ctor
+    wxObjectDataPtr(const wxObjectDataPtr<T> &tocopy)
+        : m_ptr(tocopy.m_ptr)
+    {
+        if (m_ptr)
+            m_ptr->IncRef();
+    }
+
+    ~wxObjectDataPtr()
+    {
+        if (m_ptr)
+            m_ptr->DecRef();
+    }
+
+    T *get() const { return m_ptr; }
+
+    // test for pointer validity: defining conversion to unspecified_bool_type
+    // and not more obvious bool to avoid implicit conversions to integer types
+    typedef T *(wxObjectDataPtr<T>::*unspecified_bool_type)() const;
+    operator unspecified_bool_type() const
+    {
+        return m_ptr ? &wxObjectDataPtr<T>::get : NULL;
+    }
+
+    T& operator*() const
+    {
+        wxASSERT(m_ptr != NULL);
+        return *(m_ptr);
+    }
+
+    T *operator->() const
+    {
+        wxASSERT(m_ptr != NULL);
+        return get();
+    }
+
+    void reset(T *ptr)
+    {
+        if (m_ptr)
+            m_ptr->DecRef();
+        m_ptr = ptr;
+    }
+
+    wxObjectDataPtr& operator=(const wxObjectDataPtr &tocopy)
+    {
+        if (m_ptr)
+            m_ptr->DecRef();
+        m_ptr = tocopy.m_ptr;
+        if (m_ptr)
+            m_ptr->IncRef();
+        return *this;
+    }
+
+    wxObjectDataPtr& operator=(T *ptr)
+    {
+        if (m_ptr)
+            m_ptr->DecRef();
+        m_ptr = ptr;
+        return *this;
+    }
+
+private:
+    T *m_ptr;
+};
+

 // ----------------------------------------------------------------------------
 // wxObject: the root class of wxWidgets object hierarchy
 // ----------------------------------------------------------------------------
 // ----------------------------------------------------------------------------
 // wxObject: the root class of wxWidgets object hierarchy
 // ----------------------------------------------------------------------------


@@ -426,7 +534,7 @@ public:
         return *this;
     }
 
         return *this;
     }
 

-    bool IsKindOf(wxClassInfo *info) const;
+    bool IsKindOf(const wxClassInfo *info) const;

 
 
     // Turn on the correct set of new and delete operators
 
 
     // Turn on the correct set of new and delete operators


@@ -471,17 +579,11 @@ public:
     // destroy a reference
     void UnRef();
 
     // destroy a reference
     void UnRef();
 

+    // Make sure this object has only one reference
+    void UnShare() { AllocExclusive(); }

 
 

-    // Reserved for future use
-    virtual void ReservedObjectFunc1() {}
-    virtual void ReservedObjectFunc2() {}
-    virtual void ReservedObjectFunc3() {}
-    virtual void ReservedObjectFunc4() {}
-    virtual void ReservedObjectFunc5() {}
-    virtual void ReservedObjectFunc6() {}
-    virtual void ReservedObjectFunc7() {}
-    virtual void ReservedObjectFunc8() {}
-    virtual void ReservedObjectFunc9() {}
+    // check if this object references the same data as the other one
+    bool IsSameAs(const wxObject& o) const { return m_refData == o.m_refData; }

 
 protected:
     // ensure that our data is not shared with anybody else: if we have no
 
 protected:
     // ensure that our data is not shared with anybody else: if we have no


@@ -489,8 +591,8 @@ protected:
     // it is copied using CloneRefData(), otherwise nothing is done
     void AllocExclusive();
 
     // it is copied using CloneRefData(), otherwise nothing is done
     void AllocExclusive();
 

-    // both methods must be implemented if Unshare() is used, not pure virtual
-    // only because of the backwards compatibility reasons
+    // both methods must be implemented if AllocExclusive() is used, not pure
+    // virtual only because of the backwards compatibility reasons

 
     // create a new m_refData
     virtual wxObjectRefData *CreateRefData() const;
 
     // create a new m_refData
     virtual wxObjectRefData *CreateRefData() const;


@@ -509,11 +611,11 @@ inline wxObject *wxCheckDynamicCast(wxObject *obj, wxClassInfo *classInfo)
 #if wxUSE_EXTENDED_RTTI
 class WXDLLIMPEXP_BASE wxDynamicObject : public wxObject
 {
 #if wxUSE_EXTENDED_RTTI
 class WXDLLIMPEXP_BASE wxDynamicObject : public wxObject
 {

-    friend class WXDLLIMPEXP_BASE wxDynamicClassInfo ;
+    friend class WXDLLIMPEXP_FWD_BASE wxDynamicClassInfo ;

 public:
     // instantiates this object with an instance of its superclass
     wxDynamicObject(wxObject* superClassInstance, const wxDynamicClassInfo *info) ;
 public:
     // instantiates this object with an instance of its superclass
     wxDynamicObject(wxObject* superClassInstance, const wxDynamicClassInfo *info) ;

-    ~wxDynamicObject();
+    virtual ~wxDynamicObject();

 
     void SetProperty (const wxChar *propertyName, const wxxVariant &value);
     wxxVariant GetProperty (const wxChar *propertyName) const ;
 
     void SetProperty (const wxChar *propertyName, const wxxVariant &value);
     wxxVariant GetProperty (const wxChar *propertyName) const ;


@@ -524,7 +626,8 @@ public:
 #ifdef _MSC_VER
         return (wxClassInfo*) m_classInfo;
 #else
 #ifdef _MSC_VER
         return (wxClassInfo*) m_classInfo;
 #else

-        return wx_const_cast(wxClassInfo *, m_classInfo);
+        wxDynamicClassInfo *nonconst = const_cast<wxDynamicClassInfo *>(m_classInfo);
+        return static_cast<wxClassInfo *>(nonconst);

 #endif
     }
 
 #endif
     }
 


@@ -550,23 +653,24 @@ private :
 // more debugging macros
 // ----------------------------------------------------------------------------
 
 // more debugging macros
 // ----------------------------------------------------------------------------
 

-#ifdef __WXDEBUG__
-    #ifndef WXDEBUG_NEW
-        #define WXDEBUG_NEW new(__TFILE__,__LINE__)
-    #endif
-#else // !__WXDEBUG__
-    #define WXDEBUG_NEW new
-#endif
-

 // Redefine new to be the debugging version. This doesn't work with all
 // compilers, in which case you need to use WXDEBUG_NEW explicitly if you wish
 // to use the debugging version.
 
 // Redefine new to be the debugging version. This doesn't work with all
 // compilers, in which case you need to use WXDEBUG_NEW explicitly if you wish
 // to use the debugging version.
 

-#if defined(__WXDEBUG__) && wxUSE_GLOBAL_MEMORY_OPERATORS && wxUSE_DEBUG_NEW_ALWAYS
-    #define new new(__TFILE__,__LINE__)
-#elif (defined(__WXDEBUG__) && defined(__VISUALC__) && !wxUSE_GLOBAL_MEMORY_OPERATORS && wxUSE_DEBUG_NEW_ALWAYS)
-    // Including this file redefines new and allows leak reports to contain line numbers
-    #include "wx/msw/msvcrt.h"
-#endif
+#ifdef __WXDEBUG__
+    #define WXDEBUG_NEW new(__TFILE__,__LINE__)
+
+    #if wxUSE_DEBUG_NEW_ALWAYS
+        #if wxUSE_GLOBAL_MEMORY_OPERATORS
+            #define new WXDEBUG_NEW
+        #elif defined(__VISUALC__)
+            // Including this file redefines new and allows leak reports to
+            // contain line numbers
+            #include "wx/msw/msvcrt.h"
+        #endif
+    #endif // wxUSE_DEBUG_NEW_ALWAYS
+#else // !__WXDEBUG__
+    #define WXDEBUG_NEW new
+#endif // __WXDEBUG__/!__WXDEBUG__

 
 #endif // _WX_OBJECTH__
 
 #endif // _WX_OBJECTH__