]> git.saurik.com Git - wxWidgets.git/blobdiff - include/wx/object.h
Patch #826420, and also adapted to new SWIG
[wxWidgets.git] / include / wx / object.h
index 8ea419a4be1c59bacb69009101ec879433c417d1..e4faf7a05b1f614d49dfdfc3330a34d67cd35c3c 100644 (file)
@@ -1,11 +1,11 @@
 /////////////////////////////////////////////////////////////////////////////
-// Name:        object.h
+// Name:        wx/object.h
 // Purpose:     wxObject class, plus run-time type information macros
 // Author:      Julian Smart
 // Modified by: Ron Lee
 // Created:     01/02/97
 // RCS-ID:      $Id$
-// Copyright:   (c) 1997 Julian Smart and Markus Holzem
+// Copyright:   (c) 1997 Julian Smart
 //              (c) 2001 Ron Lee <ron@debian.org>
 // Licence:     wxWindows licence
 /////////////////////////////////////////////////////////////////////////////
@@ -13,7 +13,7 @@
 #ifndef _WX_OBJECTH__
 #define _WX_OBJECTH__
 
-#ifdef __GNUG__
+#if defined(__GNUG__) && !defined(NO_GCC_PRAGMA)
 #pragma interface "object.h"
 #endif
 
 #include "wx/defs.h"
 #include "wx/memory.h"
 
-class WXDLLEXPORT wxObject;
+class WXDLLIMPEXP_BASE wxObject;
 
 #if wxUSE_DYNAMIC_CLASSES
 
+#ifndef wxUSE_EXTENDED_RTTI
+#define wxUSE_EXTENDED_RTTI 0
+#endif
+
+#if wxUSE_EXTENDED_RTTI
+#include "wx/xti.h"
+#else
+
 // ----------------------------------------------------------------------------
 // conditional compilation
 // ----------------------------------------------------------------------------
 
+// this shouldn't be needed any longer as <wx/msw/private.h> does it but it
+// doesn't hurt neither
 #ifdef GetClassName
 #undef GetClassName
 #endif
@@ -39,13 +49,9 @@ class WXDLLEXPORT wxObject;
 #undef GetClassInfo
 #endif
 
-class WXDLLEXPORT wxClassInfo;
-class WXDLLEXPORT wxHashTable;
-
-#if wxUSE_STD_IOSTREAM && (defined(__WXDEBUG__) || wxUSE_DEBUG_CONTEXT)
-#include "wx/ioswrap.h"
-#endif
-
+class WXDLLIMPEXP_BASE wxClassInfo;
+class WXDLLIMPEXP_BASE wxHashTable;
+class WXDLLIMPEXP_BASE wxObjectRefData;
 
 // ----------------------------------------------------------------------------
 // wxClassInfo
@@ -53,29 +59,34 @@ class WXDLLEXPORT wxHashTable;
 
 typedef wxObject *(*wxObjectConstructorFn)(void);
 
-class WXDLLEXPORT wxClassInfo
+class WXDLLIMPEXP_BASE wxClassInfo
 {
 public:
     wxClassInfo( const wxChar *className,
-                 const wxChar *baseName1,
-                 const wxChar *baseName2,
+                 const wxClassInfo *baseInfo1,
+                 const wxClassInfo *baseInfo2,
                  int size,
                  wxObjectConstructorFn ctor )
         : m_className(className)
-        , m_baseClassName1(baseName1)
-        , m_baseClassName2(baseName2)
         , m_objectSize(size)
         , m_objectConstructor(ctor)
-        , m_baseInfo1(0)
-        , m_baseInfo2(0)
+        , m_baseInfo1(baseInfo1)
+        , m_baseInfo2(baseInfo2)
         , m_next(sm_first)
-    { sm_first = this; }
+        { 
+            sm_first = this;
+            Register();
+        }
+
+    ~wxClassInfo();
 
     wxObject *CreateObject() { return m_objectConstructor ? (*m_objectConstructor)() : 0; }
 
     const wxChar       *GetClassName() const { return m_className; }
-    const wxChar       *GetBaseClassName1() const { return m_baseClassName1; }
-    const wxChar       *GetBaseClassName2() const { return m_baseClassName2; }
+    const wxChar       *GetBaseClassName1() const
+        { return m_baseInfo1 ? m_baseInfo1->GetClassName() : NULL; }
+    const wxChar       *GetBaseClassName2() const
+        { return m_baseInfo2 ? m_baseInfo2->GetClassName() : NULL; }
     const wxClassInfo  *GetBaseClass1() const { return m_baseInfo1; }
     const wxClassInfo  *GetBaseClass2() const { return m_baseInfo2; }
     int                 GetSize() const { return m_objectSize; }
@@ -96,18 +107,16 @@ public:
                  ( m_baseInfo2 && m_baseInfo2->IsKindOf(info) ) );
     }
 
-        // Initializes parent pointers and hash table for fast searching.
-
-    static void     InitializeClasses();
-
-        // Cleans up hash table used for fast searching.
-
-    static void     CleanUpClasses();
-
+#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:
     const wxChar            *m_className;
-    const wxChar            *m_baseClassName1;
-    const wxChar            *m_baseClassName2;
     int                      m_objectSize;
     wxObjectConstructorFn    m_objectConstructor;
 
@@ -122,11 +131,28 @@ public:
     static wxClassInfo      *sm_first;
     wxClassInfo             *m_next;
 
+    // FIXME: this should be private (currently used directly by way too
+    //        many clients)
     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();
 };
 
-WXDLLEXPORT wxObject *wxCreateDynamicObject(const wxChar *name);
+WXDLLIMPEXP_BASE wxObject *wxCreateDynamicObject(const wxChar *name);
 
+#if WXWIN_COMPATIBILITY_2_4
+inline void wxClassInfo::InitializeClasses() {}
+inline void wxClassInfo::CleanUpClasses() {}
+#endif
 
 // ----------------------------------------------------------------------------
 // Dynamic class macros
@@ -134,9 +160,18 @@ WXDLLEXPORT wxObject *wxCreateDynamicObject(const wxChar *name);
 
 #define DECLARE_DYNAMIC_CLASS(name)           \
  public:                                      \
-  static wxClassInfo sm_class##name;          \
+  static wxClassInfo ms_classInfo;            \
+  static wxObject* wxCreateObject();          \
   virtual wxClassInfo *GetClassInfo() const   \
-   { return &name::sm_class##name; }
+   { return &name::ms_classInfo; }
+
+#define DECLARE_DYNAMIC_CLASS_NO_ASSIGN(name)   \
+    DECLARE_NO_ASSIGN_CLASS(name)               \
+    DECLARE_DYNAMIC_CLASS(name)
+
+#define DECLARE_DYNAMIC_CLASS_NO_COPY(name)   \
+    DECLARE_NO_COPY_CLASS(name)               \
+    DECLARE_DYNAMIC_CLASS(name)
 
 #define DECLARE_ABSTRACT_CLASS(name) DECLARE_DYNAMIC_CLASS(name)
 #define DECLARE_CLASS(name) DECLARE_DYNAMIC_CLASS(name)
@@ -148,20 +183,23 @@ WXDLLEXPORT wxObject *wxCreateDynamicObject(const wxChar *name);
     // Single inheritance with one base class
 
 #define IMPLEMENT_DYNAMIC_CLASS(name, basename)                 \
- wxObject* WXDLLEXPORT_CTORFN wxConstructorFor##name()          \
+ wxObject* name::wxCreateObject()                             \
   { return new name; }                                          \
- wxClassInfo name::sm_class##name(wxT(#name), wxT(#basename),   \
-            0, (int) sizeof(name),                              \
-            (wxObjectConstructorFn) wxConstructorFor##name);
+ wxClassInfo name::ms_classInfo(wxT(#name),                     \
+            &basename::ms_classInfo, NULL,                      \
+            (int) sizeof(name),                                 \
+            (wxObjectConstructorFn) name::wxCreateObject);
 
     // Multiple inheritance with two base classes
 
 #define IMPLEMENT_DYNAMIC_CLASS2(name, basename1, basename2)    \
- wxObject* WXDLLEXPORT_CTORFN wxConstructorFor##name()          \
+ wxObject* name::wxCreateObject()                             \
   { return new name; }                                          \
- wxClassInfo name::sm_class##name(wxT(#name), wxT(#basename1),  \
+ wxClassInfo name::ms_classInfo(wxT(#name),                     \
+            &basename1::ms_classInfo,                           \
+            &basename2::ms_classInfo,                           \
             wxT(#basename2), (int) sizeof(name),                \
-            (wxObjectConstructorFn) wxConstructorFor##name);
+            (wxObjectConstructorFn) name::wxCreateObject);
 
 // -----------------------------------
 // for abstract classes
@@ -170,19 +208,25 @@ WXDLLEXPORT wxObject *wxCreateDynamicObject(const wxChar *name);
     // Single inheritance with one base class
 
 #define IMPLEMENT_ABSTRACT_CLASS(name, basename)                \
- wxClassInfo name::sm_class##name(wxT(#name), wxT(#basename),   \
-            0, (int) sizeof(name), (wxObjectConstructorFn) 0);
+ wxClassInfo name::ms_classInfo(wxT(#name),                     \
+            &basename::ms_classInfo, NULL,                      \
+            (int) sizeof(name), (wxObjectConstructorFn) 0);
 
     // Multiple inheritance with two base classes
 
 #define IMPLEMENT_ABSTRACT_CLASS2(name, basename1, basename2)   \
- wxClassInfo name::sm_class##name(wxT(#name), wxT(#basename1),  \
-            wxT(#basename2), (int) sizeof(name),                \
+ wxClassInfo name::ms_classInfo(wxT(#name),                     \
+            &basename1::ms_classInfo,                           \
+            &basename2::ms_classInfo,                           \
+            (int) sizeof(name),                                 \
             (wxObjectConstructorFn) 0);
 
 #define IMPLEMENT_CLASS IMPLEMENT_ABSTRACT_CLASS
 #define IMPLEMENT_CLASS2 IMPLEMENT_ABSTRACT_CLASS2
 
+#endif // !wxUSE_EXTENDED_RTTI
+
+
 // -----------------------------------
 // for pluggable classes
 // -----------------------------------
@@ -250,8 +294,7 @@ name##PluginSentinel  m_pluginsentinel;
 #define IMPLEMENT_USER_EXPORTED_ABSTRACT_PLUGGABLE_CLASS2(name, basename1, basename2)  \
  IMPLEMENT_ABSTRACT_PLUGGABLE_CLASS2(name, basename1, basename2)
 
-
-#define CLASSINFO(name) (&name::sm_class##name)
+#define CLASSINFO(name) (&name::ms_classInfo)
 
 #else // !wxUSE_DYNAMIC_CLASSES
 
@@ -283,25 +326,25 @@ name##PluginSentinel  m_pluginsentinel;
 
 #endif // wxUSE_DYNAMIC_CLASSES
 
+#define wxIS_KIND_OF(obj, className) obj->IsKindOf(&className::ms_classInfo)
 
-#define wxIS_KIND_OF(obj, className) obj->IsKindOf(&className::sm_class##className)
-
-    // Just seems a bit nicer-looking (pretend it's not a macro)
-
-#define wxIsKindOf(obj, className) obj->IsKindOf(&className::sm_class##className)
-
-    // to be replaced by dynamic_cast<> in the future
+// Just seems a bit nicer-looking (pretend it's not a macro)
+#define wxIsKindOf(obj, className) obj->IsKindOf(&className::ms_classInfo)
 
+// to be replaced by dynamic_cast<> in the future
 #define wxDynamicCast(obj, className) \
- (className *) wxCheckDynamicCast((wxObject*)(obj), &className::sm_class##className)
-
-    // The 'this' pointer is always true, so use this version
-    // to cast the this pointer and avoid compiler warnings.
+ ((className *) wxCheckDynamicCast((wxObject*)(obj), &className::ms_classInfo))
 
+// The 'this' pointer is always true, so use this version
+// to cast the this pointer and avoid compiler warnings.
 #define wxDynamicCastThis(className) \
- (IsKindOf(&className::sm_class##className) ? (className *)(this) : (className *)0)
+ (IsKindOf(&className::ms_classInfo) ? (className *)(this) : (className *)0)
 
+#ifdef HAVE_CONST_CAST
+#define wxConstCast(obj, className) const_cast<className *>(obj)
+#else
 #define wxConstCast(obj, className) ((className *)(obj))
+#endif
 
 
 #ifdef __WXDEBUG__
@@ -317,69 +360,125 @@ inline void wxCheckCast(void *ptr)
 
 #endif  // __WXDEBUG__
 
+// ----------------------------------------------------------------------------
+// set up memory debugging macros
+// ----------------------------------------------------------------------------
+
+/*
+    Which new/delete operator variants do we want?
 
-    // Unfortunately Borland seems to need this include.
+    _WX_WANT_NEW_SIZET_WXCHAR_INT             = void *operator new (size_t size, wxChar *fileName = 0, int lineNum = 0)
+    _WX_WANT_DELETE_VOID                      = void operator delete (void * buf)
+    _WX_WANT_DELETE_VOID_CONSTCHAR_SIZET      = void operator delete (void *buf, const char *_fname, size_t _line)
+    _WX_WANT_DELETE_VOID_WXCHAR_INT           = void operator delete(void *buf, wxChar*, int)
+    _WX_WANT_ARRAY_NEW_SIZET_WXCHAR_INT       = void *operator new[] (size_t size, wxChar *fileName , int lineNum = 0)
+    _WX_WANT_ARRAY_DELETE_VOID                = void operator delete[] (void *buf)
+    _WX_WANT_ARRAY_DELETE_VOID_WXCHAR_INT     = void operator delete[] (void* buf, wxChar*, int )
+*/
 
-#if wxUSE_STD_IOSTREAM                                \
-    && (defined(__WXDEBUG__) || wxUSE_DEBUG_CONTEXT)  \
-    && defined(__BORLANDC__)
-#if wxUSE_IOSTREAMH
-#include <iostream.h>
-#else
-#include <iostream>
+#if defined(__WXDEBUG__) && wxUSE_MEMORY_TRACING
+
+// All compilers get this one
+#define _WX_WANT_NEW_SIZET_WXCHAR_INT
+
+// Everyone except Visage gets the next one
+#ifndef __VISAGECPP__
+    #define _WX_WANT_DELETE_VOID
 #endif
+
+// Only visage gets this one under the correct circumstances
+#if defined(__VISAGECPP__) && __DEBUG_ALLOC__
+    #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))
+    #define _WX_WANT_DELETE_VOID_WXCHAR_INT
+#endif
+
+// Now see who (if anyone) gets the array memory operators
+#if wxUSE_ARRAY_MEMORY_OPERATORS
+
+    // Everyone except Visual C++ (cause problems for VC++ - crashes)
+    #if !defined(__VISUALC__)
+        #define _WX_WANT_ARRAY_NEW_SIZET_WXCHAR_INT
+    #endif
+
+    // Everyone except Visual C++ (cause problems for VC++ - crashes)
+    #if !defined(__VISUALC__)
+        #define _WX_WANT_ARRAY_DELETE_VOID
+    #endif
+
+    // Only CodeWarrior 6 or higher
+    #if defined(__MWERKS__) && (__MWERKS__ >= 0x2400)
+        #define _WX_WANT_ARRAY_DELETE_VOID_WXCHAR_INT
+    #endif
+
+#endif // wxUSE_ARRAY_MEMORY_OPERATORS
+
+#endif // WXDEBUG && wxUSE_MEMORY_TRACING
 
 // ----------------------------------------------------------------------------
-// wxObject
+// wxObject: the root class of wxWindows object hierarchy
 // ----------------------------------------------------------------------------
 
-class WXDLLEXPORT wxObjectRefData;
-
-class WXDLLEXPORT wxObject
+class WXDLLIMPEXP_BASE wxObject
 {
-DECLARE_ABSTRACT_CLASS(wxObject)
+    DECLARE_ABSTRACT_CLASS(wxObject)
+
+private:
+    void InitFrom(const wxObject& other);
 
 public:
-    wxObject() : m_refData(0) {}
+    wxObject() { m_refData = NULL; }
     virtual ~wxObject() { UnRef(); }
 
-    bool IsKindOf(wxClassInfo *info) const;
+    wxObject(const wxObject& other)
+        {
+            InitFrom(other);
+        }
 
-#if defined(__WXDEBUG__) && wxUSE_MEMORY_TRACING
-    void *operator new (size_t size, wxChar *fileName = 0, int lineNum = 0);
+    wxObject& operator=(const wxObject& other)
+    {
+        if ( this != &other )
+        {
+            UnRef();
+            InitFrom(other);
+        }
+        return *this;
+    }
+
+    bool IsKindOf(wxClassInfo *info) const;
 
-#ifndef __VISAGECPP__
-    void operator delete (void * buf);
-#elif __DEBUG_ALLOC__
-    void operator delete (void *buf, const char *_fname, size_t _line);
-#endif
 
-    // VC++ 6.0
+    // Turn on the correct set of new and delete operators
 
-#if defined(__VISUALC__) && (__VISUALC__ >= 1200)
-    void operator delete(void *buf, wxChar*, int);
+#ifdef _WX_WANT_NEW_SIZET_WXCHAR_INT
+    void *operator new ( size_t size, const wxChar *fileName = NULL, int lineNum = 0 );
 #endif
 
-    // Causes problems for VC++
+#ifdef _WX_WANT_DELETE_VOID
+    void operator delete ( void * buf );
+#endif
 
-#if wxUSE_ARRAY_MEMORY_OPERATORS && !defined(__VISUALC__) && !defined( __MWERKS__)
-    void *operator new[] (size_t size, wxChar *fileName = 0, int lineNum = 0);
-    void operator delete[] (void *buf);
+#ifdef _WX_WANT_DELETE_VOID_CONSTCHAR_SIZET
+    void operator delete ( void *buf, const char *_fname, size_t _line );
 #endif
 
-#ifdef __MWERKS__
-    void *operator new[] (size_t size, wxChar *fileName , int lineNum = 0);
-    void *operator new[] (size_t size) { return operator new[] ( size, 0, 0 ) ; }
-    void operator delete[] (void *buf);
+#ifdef _WX_WANT_DELETE_VOID_WXCHAR_INT
+    void operator delete ( void *buf, const wxChar*, int );
 #endif
 
-#endif // Debug & memory tracing
+#ifdef _WX_WANT_ARRAY_NEW_SIZET_WXCHAR_INT
+    void *operator new[] ( size_t size, const wxChar *fileName = NULL, int lineNum = 0 );
+#endif
 
+#ifdef _WX_WANT_ARRAY_DELETE_VOID
+    void operator delete[] ( void *buf );
+#endif
 
-#if wxUSE_STD_IOSTREAM && (defined(__WXDEBUG__) || wxUSE_DEBUG_CONTEXT)
-    virtual void Dump(wxSTD ostream& str);
+#ifdef _WX_WANT_ARRAY_DELETE_VOID_WXCHAR_INT
+    void operator delete[] (void* buf, const wxChar*, int );
 #endif
 
     // ref counted data handling methods
@@ -407,21 +506,25 @@ protected:
     virtual wxObjectRefData *CreateRefData() const;
 
     // create a new m_refData initialized with the given one
-    virtual wxObjectRefData *CloneRefData(wxObjectRefData *data) const;
+    virtual wxObjectRefData *CloneRefData(const wxObjectRefData *data) const;
 
     wxObjectRefData *m_refData;
 };
 
+// ----------------------------------------------------------------------------
+// wxObjectRefData: ref counted data meant to be stored in wxObject
+// ----------------------------------------------------------------------------
 
-class WXDLLEXPORT wxObjectRefData
+class WXDLLIMPEXP_BASE wxObjectRefData
 {
-    friend class wxObject;
+    friend class WXDLLIMPEXP_BASE wxObject;
 
 public:
-    wxObjectRefData() : m_count(1) {}
-    virtual ~wxObjectRefData() {}
+    wxObjectRefData() : m_count(1) { }
+    virtual ~wxObjectRefData() { }
+
+    int GetRefCount() const { return m_count; }
 
-    inline int GetRefCount() const { return m_count; }
 private:
     int m_count;
 };
@@ -429,25 +532,64 @@ private:
 
 inline wxObject *wxCheckDynamicCast(wxObject *obj, wxClassInfo *classInfo)
 {
-    return obj && obj->GetClassInfo()->IsKindOf(classInfo) ? obj : 0;
+    return obj && obj->GetClassInfo()->IsKindOf(classInfo) ? obj : NULL;
 }
 
-#ifdef __WXDEBUG__
-#ifndef WXDEBUG_NEW
-#define WXDEBUG_NEW new(__TFILE__,__LINE__)
+#if wxUSE_EXTENDED_RTTI
+class WXDLLIMPEXP_BASE wxDynamicObject : public wxObject
+{
+    friend class WXDLLIMPEXP_BASE wxDynamicClassInfo ;
+public:
+    // instantiates this object with an instance of its superclass
+    wxDynamicObject(wxObject* superClassInstance, const wxDynamicClassInfo *info) ;
+    ~wxDynamicObject();
+
+    void SetProperty (const wxChar *propertyName, const wxxVariant &value);
+    wxxVariant GetProperty (const wxChar *propertyName) const ;
+
+    // get the runtime identity of this object
+    wxClassInfo *GetClassInfo() const
+    {
+               return const_cast<wxClassInfo*>((const wxClassInfo*)m_classInfo);
+    }
+
+    wxObject* GetSuperClassInstance() const
+    {
+        return m_superClassInstance ;
+    }
+private :
+    // removes an existing runtime-property
+    void RemoveProperty( const wxChar *propertyName ) ;
+
+    // renames an existing runtime-property
+    void RenameProperty( const wxChar *oldPropertyName , const wxChar *newPropertyName ) ;
+
+    wxObject *m_superClassInstance ;
+    const wxDynamicClassInfo *m_classInfo;
+    struct wxDynamicObjectInternal;
+    wxDynamicObjectInternal *m_data;
+};
 #endif
-#else
-#define WXDEBUG_NEW new
+
+// ----------------------------------------------------------------------------
+// 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__)
+    #define new new(__TFILE__,__LINE__)
 #endif
 
 #endif  // _WX_OBJECTH__
 
-// vi:sts=4:sw=4:et