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 #endif
  31
  32 class WXDLLEXPORT wxClassInfo;
  33 class WXDLLEXPORT wxInputStream;
  34 class WXDLLEXPORT wxObjectInputStream;
  35 class WXDLLEXPORT wxObjectOutputStream;
  36 class WXDLLEXPORT wxHashTable;
  37 class WXDLLEXPORT wxObject_Serialize;
  38
  39 #if wxUSE_IOSTREAMH
  40 // N.B. BC++ doesn't have istream.h, ostream.h
  41 #  include <iostream.h>
  42 #else
  43 #  include <ostream>
  44 #  ifdef _MSC_VER
  45       using namespace std;
  46 #  endif
  47 #endif
  48
  49 /*
  50  * Dynamic object system declarations
  51  */
  52
  53 typedef wxObject * (*wxObjectConstructorFn) (void);
  54
  55 class WXDLLEXPORT wxClassInfo
  56 {
  57  public:
  58    wxClassInfo(char *cName, char *baseName1, char *baseName2, int sz, wxObjectConstructorFn fn);
  59
  60    wxObject *CreateObject(void);
  61
  62    inline char *GetClassName(void) const { return m_className; }
  63    inline char *GetBaseClassName1(void) const { return m_baseClassName1; }
  64    inline char *GetBaseClassName2(void) const { return m_baseClassName2; }
  65    inline wxClassInfo* GetBaseClass1() const { return m_baseInfo1; }
  66    inline wxClassInfo* GetBaseClass2() const { return m_baseInfo2; }
  67    inline int GetSize(void) const { return m_objectSize; }
  68    inline wxObjectConstructorFn GetConstructor() const { return m_objectConstructor; }
  69    static inline wxClassInfo* GetFirst() { return sm_first; }
  70    inline wxClassInfo* GetNext() const { return m_next; }
  71    bool IsKindOf(wxClassInfo *info) const;
  72
  73    static wxClassInfo *FindClass(char *c);
  74
  75    // Initializes parent pointers and hash table for fast searching.
  76    static void InitializeClasses(void);
  77
  78    // Cleans up hash table used for fast searching.
  79    static void CleanUpClasses(void);
  80
  81 public:
  82    char*                    m_className;
  83    char*                    m_baseClassName1;
  84    char*                    m_baseClassName2;
  85    int                      m_objectSize;
  86    wxObjectConstructorFn    m_objectConstructor;
  87
  88    // Pointers to base wxClassInfos: set in InitializeClasses
  89    // called from wx_main.cc
  90    wxClassInfo*             m_baseInfo1;
  91    wxClassInfo*             m_baseInfo2;
  92
  93    static wxClassInfo*      sm_first;
  94    wxClassInfo*             m_next;
  95
  96    static wxHashTable*      sm_classTable;
  97 };
  98
  99 WXDLLEXPORT wxObject* wxCreateDynamicObject(const char *name);
 100
 101 #ifdef wxUSE_SERIAL
 102 WXDLLEXPORT wxObject* wxCreateStoredObject( wxInputStream& stream );
 103 #endif
 104
 105 #define DECLARE_DYNAMIC_CLASS(name) \
 106  public:\
 107   static wxClassInfo sm_class##name;\
 108   wxClassInfo *GetClassInfo() const \
 109    { return &name::sm_class##name; }
 110
 111 #define DECLARE_ABSTRACT_CLASS(name) DECLARE_DYNAMIC_CLASS(name)
 112 #define DECLARE_CLASS(name) DECLARE_DYNAMIC_CLASS(name)
 113
 114 //////
 115 ////// for concrete classes
 116 //////
 117
 118 // Single inheritance with one base class
 119 #define IMPLEMENT_DYNAMIC_CLASS(name, basename) \
 120 wxObject* WXDLLEXPORT_CTORFN wxConstructorFor##name(void) \
 121    { return new name; }\
 122  wxClassInfo name::sm_class##name((char *) #name, (char *) #basename, (char *) NULL, (int) sizeof(name), (wxObjectConstructorFn) wxConstructorFor##name);
 123
 124 // Multiple inheritance with two base classes
 125 #define IMPLEMENT_DYNAMIC_CLASS2(name, basename1, basename2) \
 126 wxObject* WXDLLEXPORT_CTORFN wxConstructorFor##name(void) \
 127    { return new name; }\
 128  wxClassInfo name::sm_class##name((char *) #name, (char *) #basename1, (char *) #basename2, (int) sizeof(name), (wxObjectConstructorFn) wxConstructorFor##name);
 129
 130 //////
 131 ////// for abstract classes
 132 //////
 133
 134 // Single inheritance with one base class
 135 #define IMPLEMENT_ABSTRACT_CLASS(name, basename) \
 136  wxClassInfo name::sm_class##name((char *) #name, (char *) #basename, \
 137                  (char *) NULL, (int) sizeof(name), (wxObjectConstructorFn) NULL);
 138
 139 // Multiple inheritance with two base classes
 140 #define IMPLEMENT_ABSTRACT_CLASS2(name, basename1, basename2) \
 141  wxClassInfo name::sm_class##name((char *) #name, (char *) #basename1, (char *) #basename2, (int) sizeof(name), (wxObjectConstructorFn) NULL);
 142
 143 #define IMPLEMENT_CLASS IMPLEMENT_ABSTRACT_CLASS
 144 #define IMPLEMENT_CLASS2 IMPLEMENT_ABSTRACT_CLASS2
 145
 146 #define CLASSINFO(name) (&name::sm_class##name)
 147
 148 #else
 149
 150 // No dynamic class system: so stub out the macros
 151 #define DECLARE_DYNAMIC_CLASS(name)
 152 #define DECLARE_ABSTRACT_CLASS(name)
 153 #define DECLARE_CLASS(name)
 154 #define IMPLEMENT_DYNAMIC_CLASS(name, basename)
 155 #define IMPLEMENT_DYNAMIC_CLASS2(name, basename1, basename2)
 156 #define IMPLEMENT_ABSTRACT_CLASS(name, basename)
 157 #define IMPLEMENT_ABSTRACT_CLASS2(name, basename1, basename2)
 158 #define IMPLEMENT_CLASS IMPLEMENT_ABSTRACT_CLASS
 159 #define IMPLEMENT_CLASS2 IMPLEMENT_ABSTRACT_CLASS2
 160
 161 #endif
 162
 163 #define wxIS_KIND_OF(obj, className) obj->IsKindOf(&className::sm_class##className)
 164
 165 // Just seems a bit nicer-looking (pretend it's not a macro)
 166 #define wxIsKindOf(obj, className) obj->IsKindOf(&className::sm_class##className)
 167
 168 // Unfortunately Borland seems to need this include.
 169 #ifdef __BORLANDC__
 170 #if wxUSE_IOSTREAMH
 171 #include <iostream.h>
 172 #else
 173 #include <iostream>
 174 #endif
 175 #endif
 176
 177 class WXDLLEXPORT wxObjectRefData;
 178
 179 class WXDLLEXPORT wxObject
 180 {
 181  public:
 182
 183   // This is equivalent to using the macro DECLARE_ABSTRACT_CLASS
 184   static wxClassInfo sm_classwxObject;
 185
 186   wxObject(void);
 187   virtual ~wxObject(void);
 188
 189   virtual wxClassInfo *GetClassInfo(void) const { return &sm_classwxObject; }
 190
 191   bool IsKindOf(wxClassInfo *info) const;
 192
 193 #if defined(__WXDEBUG__) && wxUSE_MEMORY_TRACING
 194   void * operator new (size_t size, char * fileName = NULL, int lineNum = 0);
 195   void operator delete (void * buf);
 196
 197 // VC++ 6.0
 198 #if _MSC_VER >= 1200
 199   void operator delete(void *buf, char*, int);
 200 #endif
 201
 202   // Cause problems for VC++
 203 // #ifndef _MSC_VER
 204 #if !defined(_MSC_VER) && wxUSE_ARRAY_MEMORY_OPERATORS
 205   void * operator new[] (size_t size, char * fileName = NULL, int lineNum = 0);
 206   void operator delete[] (void * buf);
 207 #endif
 208
 209 /*
 210 #ifdef __MWERKS__
 211   void * operator new[] (size_t size, char * fileName  , int lineNum = 0);
 212   void operator delete[] (void * buf);
 213 #endif
 214 */
 215
 216 #endif
 217
 218 #if defined(__WXDEBUG__) || wxUSE_DEBUG_CONTEXT
 219   virtual void Dump(ostream& str);
 220 #endif
 221
 222 #ifdef wxUSE_SERIAL
 223   virtual void StoreObject( wxObjectOutputStream &stream );
 224   virtual void LoadObject( wxObjectInputStream &stream );
 225 #endif
 226
 227   // make a 'clone' of the object
 228   void Ref(const wxObject& clone);
 229
 230   // destroy a reference
 231   void UnRef(void);
 232
 233   inline wxObjectRefData *GetRefData(void) const { return m_refData; }
 234   inline void SetRefData(wxObjectRefData *data) { m_refData = data; }
 235
 236 protected:
 237   wxObjectRefData*      m_refData;
 238 #ifdef wxUSE_SERIAL
 239   wxObject_Serialize*   m_serialObj;
 240 #endif
 241 };
 242
 243 /*
 244  * wxObjectData
 245  */
 246
 247 class WXDLLEXPORT wxObjectRefData {
 248
 249     friend class wxObject;
 250
 251 public:
 252     wxObjectRefData(void);
 253     virtual ~wxObjectRefData(void);
 254
 255     inline int GetRefCount(void) const { return m_count; }
 256 private:
 257     int m_count;
 258 };
 259
 260 #ifdef __WXDEBUG__
 261 #ifndef WXDEBUG_NEW
 262 #define WXDEBUG_NEW new(__FILE__,__LINE__)
 263 #endif
 264 #else
 265 #define WXDEBUG_NEW new
 266 #endif
 267
 268 // Redefine new to be the debugging version. This doesn't
 269 // work with all compilers, in which case you need to
 270 // use WXDEBUG_NEW explicitly if you wish to use the debugging version.
 271
 272 #if defined(__WXDEBUG__) && wxUSE_GLOBAL_MEMORY_OPERATORS && wxUSE_DEBUG_NEW_ALWAYS
 273 #define new new(__FILE__,__LINE__)
 274 #endif
 275
 276 #endif
 277     // _WX_OBJECTH__
 278
 279