]> git.saurik.com Git - wxWidgets.git/blobdiff - include/wx/object.h
2 step creation for wxDocMDIChildFrame (patch 661657)
[wxWidgets.git] / include / wx / object.h
index 3384b88562ad541255d33dc8acc17d0b321e0250..92f759609d9341fcb536b509a89d0fd4c592ea5e 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(__APPLE__)
 #pragma interface "object.h"
 #endif
 
@@ -24,7 +24,7 @@
 #include "wx/defs.h"
 #include "wx/memory.h"
 
-class WXDLLEXPORT wxObject;
+class WXDLLIMPEXP_BASE wxObject;
 
 #if wxUSE_DYNAMIC_CLASSES
 
@@ -32,6 +32,8 @@ class WXDLLEXPORT wxObject;
 // 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 +41,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,14 +51,14 @@ class WXDLLEXPORT wxHashTable;
 
 typedef wxObject *(*wxObjectConstructorFn)(void);
 
-class WXDLLEXPORT wxClassInfo
+class WXDLLIMPEXP_BASE wxClassInfo
 {
 public:
-    wxClassInfo::wxClassInfo(const wxChar *className,
-                             const wxChar *baseName1,
-                             const wxChar *baseName2,
-                             int size,
-                             wxObjectConstructorFn ctor)
+    wxClassInfoconst wxChar *className,
+                 const wxChar *baseName1,
+                 const wxChar *baseName2,
+                 int size,
+                 wxObjectConstructorFn ctor )
         : m_className(className)
         , m_baseClassName1(baseName1)
         , m_baseClassName2(baseName2)
@@ -69,7 +67,9 @@ public:
         , m_baseInfo1(0)
         , m_baseInfo2(0)
         , m_next(sm_first)
-    { sm_first = this; }
+        { sm_first = this; }
+
+    ~wxClassInfo();
 
     wxObject *CreateObject() { return m_objectConstructor ? (*m_objectConstructor)() : 0; }
 
@@ -84,7 +84,7 @@ public:
     static const wxClassInfo  *GetFirst() { return sm_first; }
     const wxClassInfo         *GetNext() const { return m_next; }
     static wxClassInfo        *FindClass(const wxChar *className);
-    
+
         // Climb upwards through inheritance hierarchy.
         // Dual inheritance is catered for.
 
@@ -122,11 +122,18 @@ 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;
-};
 
-WXDLLEXPORT wxObject *wxCreateDynamicObject(const wxChar *name);
+private:
+    // InitializeClasses() helper
+    static wxClassInfo *GetBaseByName(const wxChar *name);
+
+    DECLARE_NO_COPY_CLASS(wxClassInfo)
+};
 
+WXDLLIMPEXP_BASE wxObject *wxCreateDynamicObject(const wxChar *name);
 
 // ----------------------------------------------------------------------------
 // Dynamic class macros
@@ -148,7 +155,7 @@ WXDLLEXPORT wxObject *wxCreateDynamicObject(const wxChar *name);
     // Single inheritance with one base class
 
 #define IMPLEMENT_DYNAMIC_CLASS(name, basename)                 \
- wxObject* WXDLLEXPORT_CTORFN wxConstructorFor##name()          \
+ wxObject* wxConstructorFor##name()                             \
   { return new name; }                                          \
  wxClassInfo name::sm_class##name(wxT(#name), wxT(#basename),   \
             0, (int) sizeof(name),                              \
@@ -157,7 +164,7 @@ WXDLLEXPORT wxObject *wxCreateDynamicObject(const wxChar *name);
     // Multiple inheritance with two base classes
 
 #define IMPLEMENT_DYNAMIC_CLASS2(name, basename1, basename2)    \
- wxObject* WXDLLEXPORT_CTORFN wxConstructorFor##name()          \
+ wxObject* wxConstructorFor##name()                             \
   { return new name; }                                          \
  wxClassInfo name::sm_class##name(wxT(#name), wxT(#basename1),  \
             wxT(#basename2), (int) sizeof(name),                \
@@ -195,32 +202,25 @@ WXDLLEXPORT wxObject *wxCreateDynamicObject(const wxChar *name);
 
 #if wxUSE_NESTED_CLASSES
 
-#if 0
-#define _DECLARE_DL_SENTINEL(name)         \
- wxPluginSentinel m_pluginsentinel;
-
-#else
-
-#define _DECLARE_DL_SENTINEL(name)          \
-class  name##PluginSentinel {               \
-private:                                    \
-    static const wxString sm_className;     \
-public:                                     \
-    name##PluginSentinel();                 \
-    ~##name##PluginSentinel();              \
-};                                          \
+#define _DECLARE_DL_SENTINEL(name, exportdecl)  \
+class exportdecl name##PluginSentinel {         \
+private:                                        \
+    static const wxString sm_className;         \
+public:                                         \
+    name##PluginSentinel();                     \
+    ~name##PluginSentinel();                    \
+};                                              \
 name##PluginSentinel  m_pluginsentinel;
-#endif
 
 #define _IMPLEMENT_DL_SENTINEL(name)                                \
  const wxString name::name##PluginSentinel::sm_className(#name);    \
  name::name##PluginSentinel::name##PluginSentinel() {               \
-    wxDLManifestEntry *e = (wxDLManifestEntry*) wxDLManifestEntry::ms_classes.Get(#name);   \
-    if( e != 0 ) { e->Ref(); }                                      \
+    wxPluginLibrary *e = (wxPluginLibrary*) wxPluginLibrary::ms_classes.Get(#name);   \
+    if( e != 0 ) { e->RefObj(); }                                      \
  }                                                                  \
- name::name##PluginSentinel::~##name##PluginSentinel() {            \
-    wxDLManifestEntry *e = (wxDLManifestEntry*) wxDLManifestEntry::ms_classes.Get(#name);   \
-    if( e != 0 ) { wxCHECK_RET( !e->Unref(), _T("premature library unlinking") ); }         \
+ name::name##PluginSentinel::~name##PluginSentinel() {            \
+    wxPluginLibrary *e = (wxPluginLibrary*) wxPluginLibrary::ms_classes.Get(#name);   \
+    if( e != 0 ) { e->UnrefObj(); }                                 \
  }
 #else
 
@@ -230,21 +230,33 @@ name##PluginSentinel  m_pluginsentinel;
 #endif  // wxUSE_NESTED_CLASSES
 
 #define DECLARE_PLUGGABLE_CLASS(name) \
- DECLARE_DYNAMIC_CLASS(name) _DECLARE_DL_SENTINEL(name)
-
+ DECLARE_DYNAMIC_CLASS(name) _DECLARE_DL_SENTINEL(name, WXDLLEXPORT)
 #define DECLARE_ABSTRACT_PLUGGABLE_CLASS(name)  \
- DECLARE_ABSTRACT_CLASS(name) _DECLARE_DL_SENTINEL(name)
+ DECLARE_ABSTRACT_CLASS(name) _DECLARE_DL_SENTINEL(name, WXDLLEXPORT)
+
+#define DECLARE_USER_EXPORTED_PLUGGABLE_CLASS(name, usergoo) \
+ DECLARE_DYNAMIC_CLASS(name) _DECLARE_DL_SENTINEL(name, usergoo)
+#define DECLARE_USER_EXPORTED_ABSTRACT_PLUGGABLE_CLASS(name, usergoo)  \
+ DECLARE_ABSTRACT_CLASS(name) _DECLARE_DL_SENTINEL(name, usergoo)
 
 #define IMPLEMENT_PLUGGABLE_CLASS(name, basename) \
  IMPLEMENT_DYNAMIC_CLASS(name, basename) _IMPLEMENT_DL_SENTINEL(name)
 #define IMPLEMENT_PLUGGABLE_CLASS2(name, basename1, basename2)  \
  IMPLEMENT_DYNAMIC_CLASS2(name, basename1, basename2) _IMPLEMENT_DL_SENTINEL(name)
-
 #define IMPLEMENT_ABSTRACT_PLUGGABLE_CLASS(name, basename) \
  IMPLEMENT_ABSTRACT_CLASS(name, basename) _IMPLEMENT_DL_SENTINEL(name)
 #define IMPLEMENT_ABSTRACT_PLUGGABLE_CLASS2(name, basename1, basename2)  \
  IMPLEMENT_ABSTRACT_CLASS2(name, basename1, basename2) _IMPLEMENT_DL_SENTINEL(name)
 
+#define IMPLEMENT_USER_EXPORTED_PLUGGABLE_CLASS(name, basename) \
+ IMPLEMENT_PLUGGABLE_CLASS(name, basename)
+#define IMPLEMENT_USER_EXPORTED_PLUGGABLE_CLASS2(name, basename1, basename2)  \
+ IMPLEMENT_PLUGGABLE_CLASS2(name, basename1, basename2)
+#define IMPLEMENT_USER_EXPORTED_ABSTRACT_PLUGGABLE_CLASS(name, basename) \
+ IMPLEMENT_ABSTRACT_PLUGGABLE_CLASS(name, basename)
+#define IMPLEMENT_USER_EXPORTED_ABSTRACT_PLUGGABLE_CLASS2(name, basename1, basename2)  \
+ IMPLEMENT_ABSTRACT_PLUGGABLE_CLASS2(name, basename1, basename2)
+
 
 #define CLASSINFO(name) (&name::sm_class##name)
 
@@ -269,27 +281,35 @@ name##PluginSentinel  m_pluginsentinel;
 #define IMPLEMENT_ABSTRACT_PLUGGABLE_CLASS(name, basename)
 #define IMPLEMENT_ABSTRACT_PLUGGABLE_CLASS2(name, basename1, basename2)
 
+#define DECLARE_USER_EXPORTED_PLUGGABLE_CLASS(name, usergoo)
+#define DECLARE_USER_EXPORTED_ABSTRACT_PLUGGABLE_CLASS(name, usergoo)
+#define IMPLEMENT_USER_EXPORTED_PLUGGABLE_CLASS(name, basename)
+#define IMPLEMENT_USER_EXPORTED_PLUGGABLE_CLASS2(name, basename1, basename2)
+#define IMPLEMENT_USER_EXPORTED_ABSTRACT_PLUGGABLE_CLASS(name, basename)
+#define IMPLEMENT_USER_EXPORTED_ABSTRACT_PLUGGABLE_CLASS2(name, basename1, basename2)
+
 #endif // wxUSE_DYNAMIC_CLASSES
 
 
 #define wxIS_KIND_OF(obj, className) obj->IsKindOf(&className::sm_class##className)
 
-    // Just seems a bit nicer-looking (pretend it's not a macro)
-
+// 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
-
+// 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::sm_class##className))
 
+// 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)
 
+#ifdef HAVE_CONST_CAST
+#define wxConstCast(obj, className) const_cast<className *>(obj)
+#else
 #define wxConstCast(obj, className) ((className *)(obj))
+#endif
 
 
 #ifdef __WXDEBUG__
@@ -305,96 +325,181 @@ 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
+
+#if wxUSE_STD_IOSTREAM && (defined(__WXDEBUG__) || wxUSE_DEBUG_CONTEXT)
+// needed by wxObject::Dump
+#include "wx/iosfwrap.h"
+#endif
 
 // ----------------------------------------------------------------------------
-// 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(); }
+    
+    wxObject(const wxObject& other)
+        {
+            InitFrom(other);
+        }
+    
+    wxObject& operator=(const wxObject& other)
+    {
+        if ( this != &other )
+        {
+            UnRef();
+            InitFrom(other);
+        }
+        return *this;
+    }
 
     bool IsKindOf(wxClassInfo *info) const;
 
-#if defined(__WXDEBUG__) && wxUSE_MEMORY_TRACING
-    void *operator new (size_t size, wxChar *fileName = 0, int lineNum = 0);
 
-#ifndef __VISAGECPP__
-    void operator delete (void * buf);
-#elif __DEBUG_ALLOC__
-    void operator delete (void *buf, const char *_fname, size_t _line);
+    // Turn on the correct set of new and delete operators
+
+#ifdef _WX_WANT_NEW_SIZET_WXCHAR_INT
+    void *operator new ( size_t size, const wxChar *fileName = NULL, int lineNum = 0 );
 #endif
 
-    // VC++ 6.0
+#ifdef _WX_WANT_DELETE_VOID
+    void operator delete ( void * buf );
+#endif
 
-#if defined(__VISUALC__) && (__VISUALC__ >= 1200)
-    void operator delete(void *buf, wxChar*, int);
+#ifdef _WX_WANT_DELETE_VOID_CONSTCHAR_SIZET
+    void operator delete ( void *buf, const char *_fname, size_t _line );
 #endif
 
-    // Causes problems for VC++
+#ifdef _WX_WANT_DELETE_VOID_WXCHAR_INT
+    void operator delete ( void *buf, const wxChar*, int );
+#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_ARRAY_NEW_SIZET_WXCHAR_INT
+    void *operator new[] ( size_t size, const wxChar *fileName = NULL, int lineNum = 0 );
 #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_ARRAY_DELETE_VOID
+    void operator delete[] ( void *buf );
 #endif
 
-#endif // Debug & memory tracing
+#ifdef _WX_WANT_ARRAY_DELETE_VOID_WXCHAR_INT
+    void operator delete[] (void* buf, const wxChar*, int );
+#endif
 
 
 #if wxUSE_STD_IOSTREAM && (defined(__WXDEBUG__) || wxUSE_DEBUG_CONTEXT)
     virtual void Dump(wxSTD ostream& str);
 #endif
 
-        // make a 'clone' of the object
-  
+    // ref counted data handling methods
+
+    // get/set
+    wxObjectRefData *GetRefData() const { return m_refData; }
+    void SetRefData(wxObjectRefData *data) { m_refData = data; }
+
+    // make a 'clone' of the object
     void Ref(const wxObject& clone);
 
-        // destroy a reference
-  
+    // destroy a reference
     void UnRef();
 
-    inline wxObjectRefData *GetRefData() const { return m_refData; }
-    inline void SetRefData(wxObjectRefData *data) { m_refData = data; }
-
 protected:
+    // ensure that our data is not shared with anybody else: if we have no
+    // data, it is created using CreateRefData() below, if we have shared data
+    // 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
+
+    // create a new m_refData
+    virtual wxObjectRefData *CreateRefData() const;
+
+    // create a new m_refData initialized with the given one
+    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;
 };
@@ -402,25 +507,28 @@ private:
 
 inline wxObject *wxCheckDynamicCast(wxObject *obj, wxClassInfo *classInfo)
 {
-    return obj && obj->GetClassInfo()->IsKindOf(classInfo) ? obj : 0;
+    return obj && obj->GetClassInfo()->IsKindOf(classInfo) ? obj : NULL;
 }
 
+// ----------------------------------------------------------------------------
+// more debugging macros
+// ----------------------------------------------------------------------------
+
 #ifdef __WXDEBUG__
-#ifndef WXDEBUG_NEW
-#define WXDEBUG_NEW new(__TFILE__,__LINE__)
-#endif
-#else
-#define WXDEBUG_NEW new
+    #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