]> git.saurik.com Git - wxWidgets.git/blobdiff - include/wx/object.h
Change GetC to return an int so that it can return wxEOF on error.
[wxWidgets.git] / include / wx / object.h
index e4faf7a05b1f614d49dfdfc3330a34d67cd35c3c..c268f677b4598cd7d6f45ba48c756168dea0c13c 100644 (file)
 #ifndef _WX_OBJECTH__
 #define _WX_OBJECTH__
 
-#if defined(__GNUG__) && !defined(NO_GCC_PRAGMA)
-#pragma interface "object.h"
-#endif
-
 // ----------------------------------------------------------------------------
 // headers
 // ----------------------------------------------------------------------------
 
-#include "wx/defs.h"
 #include "wx/memory.h"
 
 class WXDLLIMPEXP_BASE wxObject;
 
-#if wxUSE_DYNAMIC_CLASSES
-
 #ifndef wxUSE_EXTENDED_RTTI
 #define wxUSE_EXTENDED_RTTI 0
 #endif
@@ -40,15 +33,6 @@ class WXDLLIMPEXP_BASE 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
-#ifdef GetClassInfo
-#undef GetClassInfo
-#endif
-
 class WXDLLIMPEXP_BASE wxClassInfo;
 class WXDLLIMPEXP_BASE wxHashTable;
 class WXDLLIMPEXP_BASE wxObjectRefData;
@@ -73,14 +57,15 @@ public:
         , m_baseInfo1(baseInfo1)
         , m_baseInfo2(baseInfo2)
         , m_next(sm_first)
-        { 
+        {
             sm_first = this;
             Register();
         }
 
     ~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
@@ -113,8 +98,7 @@ public:
     // Cleans up hash table used for fast searching.
     wxDEPRECATED( static void CleanUpClasses() );
 #endif
-    static void     CleanUp();
-    
+
 public:
     const wxChar            *m_className;
     int                      m_objectSize;
@@ -140,8 +124,8 @@ private:
     static wxClassInfo *GetBaseByName(const wxChar *name);
 
     DECLARE_NO_COPY_CLASS(wxClassInfo)
-   
-protected: 
+
+protected:
     // registers the class
     void Register();
     void Unregister();
@@ -158,48 +142,59 @@ inline void wxClassInfo::CleanUpClasses() {}
 // Dynamic class macros
 // ----------------------------------------------------------------------------
 
-#define DECLARE_DYNAMIC_CLASS(name)           \
- public:                                      \
-  static wxClassInfo ms_classInfo;            \
-  static wxObject* wxCreateObject();          \
-  virtual wxClassInfo *GetClassInfo() const   \
-   { return &name::ms_classInfo; }
+#define DECLARE_ABSTRACT_CLASS(name)                                          \
+    public:                                                                   \
+        static wxClassInfo ms_classInfo;                                      \
+        virtual wxClassInfo *GetClassInfo() const;
 
-#define DECLARE_DYNAMIC_CLASS_NO_ASSIGN(name)   \
-    DECLARE_NO_ASSIGN_CLASS(name)               \
+#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)               \
+#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_DYNAMIC_CLASS(name)                                           \
+    DECLARE_ABSTRACT_CLASS(name)                                              \
+    static wxObject* wxCreateObject();
+
 #define DECLARE_CLASS(name) DECLARE_DYNAMIC_CLASS(name)
 
+
+// common part of the macros below
+#define wxIMPLEMENT_CLASS_COMMON(name, basename, baseclsinfo2, func)          \
+    wxClassInfo name::ms_classInfo(wxT(#name),                                \
+            &basename::ms_classInfo,                                          \
+            baseclsinfo2,                                                     \
+            (int) sizeof(name),                                               \
+            (wxObjectConstructorFn) func);                                    \
+                                                                              \
+    wxClassInfo *name::GetClassInfo() const                                   \
+        { return &name::ms_classInfo; }
+
+#define wxIMPLEMENT_CLASS_COMMON1(name, basename, func)                       \
+    wxIMPLEMENT_CLASS_COMMON(name, basename, NULL, func)
+
+#define wxIMPLEMENT_CLASS_COMMON2(name, basename1, basename2, func)           \
+    wxIMPLEMENT_CLASS_COMMON(name, basename1, &basename2::ms_classInfo, func)
+
 // -----------------------------------
 // for concrete classes
 // -----------------------------------
 
     // Single inheritance with one base class
-
-#define IMPLEMENT_DYNAMIC_CLASS(name, basename)                 \
- wxObject* name::wxCreateObject()                             \
-  { return new name; }                                          \
- wxClassInfo name::ms_classInfo(wxT(#name),                     \
-            &basename::ms_classInfo, NULL,                      \
-            (int) sizeof(name),                                 \
-            (wxObjectConstructorFn) name::wxCreateObject);
+#define IMPLEMENT_DYNAMIC_CLASS(name, basename)                               \
+    wxIMPLEMENT_CLASS_COMMON1(name, basename, name::wxCreateObject)           \
+    wxObject* name::wxCreateObject()                                          \
+        { return new name; }
 
     // Multiple inheritance with two base classes
-
-#define IMPLEMENT_DYNAMIC_CLASS2(name, basename1, basename2)    \
- wxObject* name::wxCreateObject()                             \
-  { return new name; }                                          \
- wxClassInfo name::ms_classInfo(wxT(#name),                     \
-            &basename1::ms_classInfo,                           \
-            &basename2::ms_classInfo,                           \
-            wxT(#basename2), (int) sizeof(name),                \
-            (wxObjectConstructorFn) name::wxCreateObject);
+#define IMPLEMENT_DYNAMIC_CLASS2(name, basename1, basename2)                  \
+    wxIMPLEMENT_CLASS_COMMON2(name, basename1, basename2,                     \
+                              name::wxCreateObject)                           \
+    wxObject* name::wxCreateObject()                                          \
+        { return new name; }
 
 // -----------------------------------
 // for abstract classes
@@ -207,19 +202,13 @@ inline void wxClassInfo::CleanUpClasses() {}
 
     // Single inheritance with one base class
 
-#define IMPLEMENT_ABSTRACT_CLASS(name, basename)                \
- wxClassInfo name::ms_classInfo(wxT(#name),                     \
-            &basename::ms_classInfo, NULL,                      \
-            (int) sizeof(name), (wxObjectConstructorFn) 0);
+#define IMPLEMENT_ABSTRACT_CLASS(name, basename)                              \
+    wxIMPLEMENT_CLASS_COMMON1(name, basename, NULL)
 
     // Multiple inheritance with two base classes
 
-#define IMPLEMENT_ABSTRACT_CLASS2(name, basename1, basename2)   \
- wxClassInfo name::ms_classInfo(wxT(#name),                     \
-            &basename1::ms_classInfo,                           \
-            &basename2::ms_classInfo,                           \
-            (int) sizeof(name),                                 \
-            (wxObjectConstructorFn) 0);
+#define IMPLEMENT_ABSTRACT_CLASS2(name, basename1, basename2)                 \
+    wxIMPLEMENT_CLASS_COMMON2(name, basename1, basename2, NULL)
 
 #define IMPLEMENT_CLASS IMPLEMENT_ABSTRACT_CLASS
 #define IMPLEMENT_CLASS2 IMPLEMENT_ABSTRACT_CLASS2
@@ -296,67 +285,39 @@ name##PluginSentinel  m_pluginsentinel;
 
 #define CLASSINFO(name) (&name::ms_classInfo)
 
-#else // !wxUSE_DYNAMIC_CLASSES
-
-    // No dynamic class system: so stub out the macros
-
-#define DECLARE_DYNAMIC_CLASS(name)
-#define DECLARE_ABSTRACT_CLASS(name)
-#define DECLARE_CLASS(name)
-#define IMPLEMENT_DYNAMIC_CLASS(name, basename)
-#define IMPLEMENT_DYNAMIC_CLASS2(name, basename1, basename2)
-#define IMPLEMENT_ABSTRACT_CLASS(name, basename)
-#define IMPLEMENT_ABSTRACT_CLASS2(name, basename1, basename2)
-#define IMPLEMENT_CLASS IMPLEMENT_ABSTRACT_CLASS
-#define IMPLEMENT_CLASS2 IMPLEMENT_ABSTRACT_CLASS2
-
-#define DECLARE_PLUGGABLE_CLASS(name)
-#define DECLARE_ABSTRACT_PLUGGABLE_CLASS(name)
-#define IMPLEMENT_PLUGGABLE_CLASS(name, basename)
-#define IMPLEMENT_PLUGGABLE_CLASS2(name, basename1, basename2)
-#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::ms_classInfo)
 
 // 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
+// this cast does some more checks at compile time as it uses static_cast
+// internally
+//
+// note that it still has different semantics from dynamic_cast<> and so can't
+// be replaced by it as long as there are any compilers not supporting it
 #define wxDynamicCast(obj, className) \
- ((className *) wxCheckDynamicCast((wxObject*)(obj), &className::ms_classInfo))
+    ((className *) wxCheckDynamicCast( \
+        wx_const_cast(wxObject *, wx_static_cast(const wxObject *, \
+          wx_const_cast(className *, wx_static_cast(const className *, 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::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
-
+     (IsKindOf(&className::ms_classInfo) ? (className *)(this) : (className *)0)
 
 #ifdef __WXDEBUG__
-inline void wxCheckCast(void *ptr)
+inline void* wxCheckCast(void *ptr)
 {
     wxASSERT_MSG( ptr, _T("wxStaticCast() used incorrectly") );
+    return ptr;
 }
 #define wxStaticCast(obj, className) \
- (wxCheckCast(wxDynamicCast(obj, className)), ((className *)(obj)))
+ ((className *)wxCheckCast(wxDynamicCast(obj, className)))
 
 #else  // !__WXDEBUG__
-#define wxStaticCast(obj, className) ((className *)(obj))
+#define wxStaticCast(obj, className) \
+    wx_const_cast(className *, wx_static_cast(const className *, obj))
 
 #endif  // __WXDEBUG__
 
@@ -416,34 +377,50 @@ inline void wxCheckCast(void *ptr)
 
 #endif // wxUSE_ARRAY_MEMORY_OPERATORS
 
-#endif // WXDEBUG && wxUSE_MEMORY_TRACING
+#endif // __WXDEBUG__ && wxUSE_MEMORY_TRACING
 
 // ----------------------------------------------------------------------------
-// wxObject: the root class of wxWindows object hierarchy
+// wxObjectRefData: ref counted data meant to be stored in wxObject
 // ----------------------------------------------------------------------------
 
-class WXDLLIMPEXP_BASE wxObject
+class WXDLLIMPEXP_BASE wxObjectRefData
 {
-    DECLARE_ABSTRACT_CLASS(wxObject)
+    friend class WXDLLIMPEXP_BASE wxObject;
+
+public:
+    wxObjectRefData() : m_count(1) { }
+    virtual ~wxObjectRefData() { }
+
+    int GetRefCount() const { return m_count; }
 
 private:
-    void InitFrom(const wxObject& other);
+    int m_count;
+};
+
+// ----------------------------------------------------------------------------
+// wxObject: the root class of wxWidgets object hierarchy
+// ----------------------------------------------------------------------------
+
+class WXDLLIMPEXP_BASE wxObject
+{
+    DECLARE_ABSTRACT_CLASS(wxObject)
 
 public:
     wxObject() { m_refData = NULL; }
     virtual ~wxObject() { UnRef(); }
 
     wxObject(const wxObject& other)
-        {
-            InitFrom(other);
-        }
+    {
+         m_refData = other.m_refData;
+         if (m_refData)
+             m_refData->m_count++;
+    }
 
     wxObject& operator=(const wxObject& other)
     {
         if ( this != &other )
         {
-            UnRef();
-            InitFrom(other);
+            Ref(other);
         }
         return *this;
     }
@@ -493,13 +470,16 @@ public:
     // destroy a reference
     void UnRef();
 
+    // Make sure this object has only one reference
+    void UnShare() { AllocExclusive(); }
+
 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
+    // both methods must be implemented if AllocExclusive() is used, not pure virtual
     // only because of the backwards compatibility reasons
 
     // create a new m_refData
@@ -511,25 +491,6 @@ protected:
     wxObjectRefData *m_refData;
 };
 
-// ----------------------------------------------------------------------------
-// wxObjectRefData: ref counted data meant to be stored in wxObject
-// ----------------------------------------------------------------------------
-
-class WXDLLIMPEXP_BASE wxObjectRefData
-{
-    friend class WXDLLIMPEXP_BASE wxObject;
-
-public:
-    wxObjectRefData() : m_count(1) { }
-    virtual ~wxObjectRefData() { }
-
-    int GetRefCount() const { return m_count; }
-
-private:
-    int m_count;
-};
-
-
 inline wxObject *wxCheckDynamicCast(wxObject *obj, wxClassInfo *classInfo)
 {
     return obj && obj->GetClassInfo()->IsKindOf(classInfo) ? obj : NULL;
@@ -542,7 +503,7 @@ class WXDLLIMPEXP_BASE wxDynamicObject : public wxObject
 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 ;
@@ -550,7 +511,11 @@ public:
     // get the runtime identity of this object
     wxClassInfo *GetClassInfo() const
     {
-               return const_cast<wxClassInfo*>((const wxClassInfo*)m_classInfo);
+#ifdef _MSC_VER
+        return (wxClassInfo*) m_classInfo;
+#else
+        return wx_const_cast(wxClassInfo *, m_classInfo);
+#endif
     }
 
     wxObject* GetSuperClassInstance() const
@@ -575,21 +540,24 @@ private :
 // 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.
 
-#if defined(__WXDEBUG__) && wxUSE_GLOBAL_MEMORY_OPERATORS && wxUSE_DEBUG_NEW_ALWAYS
-    #define new new(__TFILE__,__LINE__)
-#endif
-
-#endif  // _WX_OBJECTH__
+#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__