include/wx/object.h

   1 /////////////////////////////////////////////////////////////////////////////
   2 // Name:        object.h
   3 // Purpose:     wxObject class, plus run-time type information macros
   4 // Author:      Julian Smart
   5 // Modified by:
   6 // Created:     01/02/97
   7 // RCS-ID:      $Id$
   8 // Copyright:   (c) Julian Smart and Markus Holzem
   9 // Licence:     wxWindows licence
  10 /////////////////////////////////////////////////////////////////////////////
  11
  12 #ifndef _WX_OBJECTH__
  13 #define _WX_OBJECTH__
  14
  15 #ifdef __GNUG__
  16 #pragma interface "object.h"
  17 #endif
  18
  19 #include "wx/defs.h"
  20 #include "wx/memory.h"
  21
  22 class WXDLLEXPORT wxObject;
  23
  24 #if wxUSE_DYNAMIC_CLASSES
  25
  26 // #ifdef __GNUWIN32__
  27 #ifdef GetClassName
  28 #undef GetClassName
  29 #endif
  30 #ifdef GetClassInfo
  31 #undef GetClassInfo
  32 #endif
  33 // #endif
  34
  35 class WXDLLEXPORT wxClassInfo;
  36 class WXDLLEXPORT wxInputStream;
  37 class WXDLLEXPORT wxOutputStream;
  38 class WXDLLEXPORT wxObjectInputStream;
  39 class WXDLLEXPORT wxObjectOutputStream;
  40 class WXDLLEXPORT wxHashTable;
  41 class WXDLLEXPORT wxObject_Serialize;
  42
  43 #if wxUSE_STD_IOSTREAM && (defined(__WXDEBUG__) || wxUSE_DEBUG_CONTEXT)
  44   #include "wx/ioswrap.h"
  45 #endif
  46
  47 /*
  48  * Dynamic object system declarations
  49  */
  50
  51 typedef wxObject * (*wxObjectConstructorFn) (void);
  52
  53 class WXDLLEXPORT wxClassInfo
  54 {
  55  public:
  56    wxClassInfo(wxChar *cName, wxChar *baseName1, wxChar *baseName2, int sz, wxObjectConstructorFn fn);
  57
  58    wxObject *CreateObject(void);
  59
  60    inline wxChar *GetClassName(void) const { return m_className; }
  61    inline wxChar *GetBaseClassName1(void) const { return m_baseClassName1; }
  62    inline wxChar *GetBaseClassName2(void) const { return m_baseClassName2; }
  63    inline wxClassInfo* GetBaseClass1() const { return m_baseInfo1; }
  64    inline wxClassInfo* GetBaseClass2() const { return m_baseInfo2; }
  65    inline int GetSize(void) const { return m_objectSize; }
  66    inline wxObjectConstructorFn GetConstructor() const { return m_objectConstructor; }
  67    static inline wxClassInfo* GetFirst() { return sm_first; }
  68    inline wxClassInfo* GetNext() const { return m_next; }
  69    bool IsKindOf(wxClassInfo *info) const;
  70
  71    static wxClassInfo *FindClass(wxChar *c);
  72
  73    // Initializes parent pointers and hash table for fast searching.
  74    static void InitializeClasses(void);
  75
  76    // Cleans up hash table used for fast searching.
  77    static void CleanUpClasses(void);
  78
  79 public:
  80    wxChar*                  m_className;
  81    wxChar*                  m_baseClassName1;
  82    wxChar*                  m_baseClassName2;
  83    int                      m_objectSize;
  84    wxObjectConstructorFn    m_objectConstructor;
  85
  86    // Pointers to base wxClassInfos: set in InitializeClasses
  87    // called from wx_main.cc
  88    wxClassInfo*             m_baseInfo1;
  89    wxClassInfo*             m_baseInfo2;
  90
  91    static wxClassInfo*      sm_first;
  92    wxClassInfo*             m_next;
  93
  94    static wxHashTable*      sm_classTable;
  95 };
  96
  97 WXDLLEXPORT wxObject* wxCreateDynamicObject(const wxChar *name);
  98
  99 #if wxUSE_SERIAL
 100 WXDLLEXPORT wxObject* wxCreateStoredObject( wxInputStream& stream );
 101 #endif
 102
 103 #define DECLARE_DYNAMIC_CLASS(name) \
 104  public:\
 105   static wxClassInfo sm_class##name;\
 106   wxClassInfo *GetClassInfo() const \
 107    { return &name::sm_class##name; }
 108
 109 #define DECLARE_ABSTRACT_CLASS(name) DECLARE_DYNAMIC_CLASS(name)
 110 #define DECLARE_CLASS(name) DECLARE_DYNAMIC_CLASS(name)
 111
 112 //////
 113 ////// for concrete classes
 114 //////
 115
 116 // Single inheritance with one base class
 117 #define IMPLEMENT_DYNAMIC_CLASS(name, basename) \
 118 wxObject* WXDLLEXPORT_CTORFN wxConstructorFor##name(void) \
 119    { return new name; }\
 120  wxClassInfo name::sm_class##name((wxChar *) wxT(#name), (wxChar *) wxT(#basename), (wxChar *) NULL, (int) sizeof(name), (wxObjectConstructorFn) wxConstructorFor##name);
 121
 122 // Multiple inheritance with two base classes
 123 #define IMPLEMENT_DYNAMIC_CLASS2(name, basename1, basename2) \
 124 wxObject* WXDLLEXPORT_CTORFN wxConstructorFor##name(void) \
 125    { return new name; }\
 126  wxClassInfo name::sm_class##name((wxChar *) wxT(#name), (wxChar *) wxT(#basename1), (wxChar *) wxT(#basename2), (int) sizeof(name), (wxObjectConstructorFn) wxConstructorFor##name);
 127
 128 //////
 129 ////// for abstract classes
 130 //////
 131
 132 // Single inheritance with one base class
 133 #define IMPLEMENT_ABSTRACT_CLASS(name, basename) \
 134  wxClassInfo name::sm_class##name((wxChar *) wxT(#name), (wxChar *) wxT(#basename), \
 135          (wxChar *) NULL, (int) sizeof(name), (wxObjectConstructorFn) NULL);
 136
 137 // Multiple inheritance with two base classes
 138 #define IMPLEMENT_ABSTRACT_CLASS2(name, basename1, basename2) \
 139  wxClassInfo name::sm_class##name((wxChar *) wxT(#name), (wxChar *) wxT(#basename1), \
 140          (wxChar *) wxT(#basename2), (int) sizeof(name), (wxObjectConstructorFn) NULL);
 141
 142 #define IMPLEMENT_CLASS IMPLEMENT_ABSTRACT_CLASS
 143 #define IMPLEMENT_CLASS2 IMPLEMENT_ABSTRACT_CLASS2
 144
 145 #define CLASSINFO(name) (&name::sm_class##name)
 146
 147 #else // !wxUSE_DYNAMIC_CLASSES
 148
 149 // No dynamic class system: so stub out the macros
 150 #define DECLARE_DYNAMIC_CLASS(name)
 151 #define DECLARE_ABSTRACT_CLASS(name)
 152 #define DECLARE_CLASS(name)
 153 #define IMPLEMENT_DYNAMIC_CLASS(name, basename)
 154 #define IMPLEMENT_DYNAMIC_CLASS2(name, basename1, basename2)
 155 #define IMPLEMENT_ABSTRACT_CLASS(name, basename)
 156 #define IMPLEMENT_ABSTRACT_CLASS2(name, basename1, basename2)
 157 #define IMPLEMENT_CLASS IMPLEMENT_ABSTRACT_CLASS
 158 #define IMPLEMENT_CLASS2 IMPLEMENT_ABSTRACT_CLASS2
 159
 160 #endif // wxUSE_DYNAMIC_CLASSES/!wxUSE_DYNAMIC_CLASSES
 161
 162 #define wxIS_KIND_OF(obj, className) obj->IsKindOf(&className::sm_class##className)
 163
 164 // Just seems a bit nicer-looking (pretend it's not a macro)
 165 #define wxIsKindOf(obj, className) obj->IsKindOf(&className::sm_class##className)
 166
 167 // to be replaced by dynamic_cast<> in the future
 168 #define wxDynamicCast(obj, className) \
 169         ((obj) && ((obj)->IsKindOf(&className::sm_class##className)) \
 170         ? (className *)(obj) \
 171         : (className *)0)
 172
 173 #define wxConstCast(obj, className) ((className *)(obj))
 174
 175 #ifdef __WXDEBUG__
 176     inline void wxCheckCast(void *ptr)
 177     {
 178         wxASSERT_MSG( ptr, _T("wxStaticCast() used incorrectly") );
 179     }
 180
 181     #define wxStaticCast(obj, className) \
 182         (wxCheckCast(wxDynamicCast(obj, className)), ((className *)(obj)))
 183
 184 #else // !Debug
 185     #define wxStaticCast(obj, className) ((className *)(obj))
 186 #endif // Debug/!Debug
 187
 188 // Unfortunately Borland seems to need this include.
 189 #ifdef __BORLANDC__
 190     #if wxUSE_IOSTREAMH
 191         #include <iostream.h>
 192     #else
 193         #include <iostream>
 194     #endif
 195 #endif
 196
 197 class WXDLLEXPORT wxObjectRefData;
 198
 199 class WXDLLEXPORT wxObject
 200 {
 201  public:
 202
 203   // This is equivalent to using the macro DECLARE_ABSTRACT_CLASS
 204   static wxClassInfo sm_classwxObject;
 205
 206   wxObject(void);
 207   virtual ~wxObject(void);
 208
 209   virtual wxClassInfo *GetClassInfo(void) const { return &sm_classwxObject; }
 210   wxObject *Clone(void) const;
 211   virtual void CopyObject(wxObject& object_dest) const;
 212
 213   bool IsKindOf(wxClassInfo *info) const;
 214
 215 #if defined(__WXDEBUG__) && wxUSE_MEMORY_TRACING
 216   void * operator new (size_t size, wxChar * fileName = NULL, int lineNum = 0);
 217   void operator delete (void * buf);
 218
 219 // VC++ 6.0
 220 #if defined(__VISUALC__) && (__VISUALC__ >= 1200)
 221   void operator delete(void *buf, wxChar*, int);
 222 #endif
 223
 224     // Causes problems for VC++
 225 #if wxUSE_ARRAY_MEMORY_OPERATORS && !defined(__VISUALC__) && !defined( __MWERKS__)
 226   void * operator new[] (size_t size, wxChar * fileName = NULL, int lineNum = 0);
 227   void operator delete[] (void * buf);
 228 #endif
 229
 230 #ifdef __MWERKS__
 231   void * operator new[] (size_t size, wxChar * fileName , int lineNum = 0);
 232   void * operator new[] (size_t size) { return operator new[] ( size , NULL , 0 ) ; }
 233   void operator delete[] (void * buf);
 234 #endif
 235
 236 #endif // Debug & memory tracing
 237
 238 #if wxUSE_STD_IOSTREAM && (defined(__WXDEBUG__) || wxUSE_DEBUG_CONTEXT)
 239   virtual void Dump(ostream& str);
 240 #endif
 241
 242 #if wxUSE_SERIAL
 243   virtual void StoreObject( wxObjectOutputStream &stream );
 244   virtual void LoadObject( wxObjectInputStream &stream );
 245 #endif
 246
 247   // make a 'clone' of the object
 248   void Ref(const wxObject& clone);
 249
 250   // destroy a reference
 251   void UnRef(void);
 252
 253   inline wxObjectRefData *GetRefData(void) const { return m_refData; }
 254   inline void SetRefData(wxObjectRefData *data) { m_refData = data; }
 255
 256 protected:
 257   wxObjectRefData*      m_refData;
 258 #if wxUSE_SERIAL
 259   wxObject_Serialize*   m_serialObj;
 260 #endif
 261 };
 262
 263 /*
 264  * wxObjectData
 265  */
 266
 267 class WXDLLEXPORT wxObjectRefData {
 268
 269     friend class wxObject;
 270
 271 public:
 272     wxObjectRefData(void);
 273     virtual ~wxObjectRefData(void);
 274
 275     inline int GetRefCount(void) const { return m_count; }
 276 private:
 277     int m_count;
 278 };
 279
 280 #ifdef __WXDEBUG__
 281 #ifndef WXDEBUG_NEW
 282 #define WXDEBUG_NEW new(__TFILE__,__LINE__)
 283 #endif
 284 #else
 285 #define WXDEBUG_NEW new
 286 #endif
 287
 288 // Redefine new to be the debugging version. This doesn't
 289 // work with all compilers, in which case you need to
 290 // use WXDEBUG_NEW explicitly if you wish to use the debugging version.
 291
 292 #if defined(__WXDEBUG__) && wxUSE_GLOBAL_MEMORY_OPERATORS && wxUSE_DEBUG_NEW_ALWAYS
 293 #define new new(__TFILE__,__LINE__)
 294 #endif
 295
 296 #endif
 297     // _WX_OBJECTH__
 298
 299