Trying to hide evidence of my negative programming skills...

[wxWidgets.git] / include / wx / object.h

diff --git a/include/wx/object.h b/include/wx/object.h
index ea3b030deb8e077ba5ab03b1e2b1455ec4a160c5..f09a795b6ba1a64df85375cf0143e86818cb148b 100644 (file)
--- a/include/wx/object.h
+++ b/include/wx/object.h
@@ -6,32 +6,43 @@
 // Created:     01/02/97
 // RCS-ID:      $Id$
 // Copyright:   (c) Julian Smart and Markus Holzem
 // Created:     01/02/97
 // RCS-ID:      $Id$
 // Copyright:   (c) Julian Smart and Markus Holzem

-// Licence:    wxWindows licence
+// Licence:     wxWindows licence

 /////////////////////////////////////////////////////////////////////////////
 
 /////////////////////////////////////////////////////////////////////////////
 

-#ifndef __OBJECTH__
-#define __OBJECTH__
+#ifndef _WX_OBJECTH__
+#define _WX_OBJECTH__

 
 #ifdef __GNUG__
 #pragma interface "object.h"
 #endif
 
 #include "wx/defs.h"
 
 #ifdef __GNUG__
 #pragma interface "object.h"
 #endif
 
 #include "wx/defs.h"

+#include "wx/memory.h"

 
 class WXDLLEXPORT wxObject;
 
 
 class WXDLLEXPORT wxObject;
 

-#if USE_DYNAMIC_CLASSES
+#if wxUSE_DYNAMIC_CLASSES

 
 

-#ifdef __GNUWIN32__
+// #ifdef __GNUWIN32__

 #ifdef GetClassName
 #undef GetClassName
 #endif
 #ifdef GetClassName
 #undef GetClassName
 #endif

+#ifdef GetClassInfo
+#undef GetClassInfo

 #endif
 #endif

+// #endif

 
 class WXDLLEXPORT wxClassInfo;
 
 class WXDLLEXPORT wxClassInfo;

-
-class WXDLLIMPORT istream;
-class WXDLLIMPORT ostream;
+class WXDLLEXPORT wxInputStream;
+class WXDLLEXPORT wxOutputStream;
+class WXDLLEXPORT wxObjectInputStream;
+class WXDLLEXPORT wxObjectOutputStream;
+class WXDLLEXPORT wxHashTable;
+class WXDLLEXPORT wxObject_Serialize;
+
+#if wxUSE_STD_IOSTREAM && (defined(__WXDEBUG__) || wxUSE_DEBUG_CONTEXT)
+  #include "wx/ioswrap.h"
+#endif

 
 /*
  * Dynamic object system declarations
 
 /*
  * Dynamic object system declarations


@@ -39,74 +50,70 @@ class WXDLLIMPORT ostream;
 
 typedef wxObject * (*wxObjectConstructorFn) (void);
 
 
 typedef wxObject * (*wxObjectConstructorFn) (void);
 

-#ifdef USE_STORABLE_CLASSES
-typedef wxObject* (*wxStorableConstructorFn) ( istream &stream, char *data );
-#endif
-

 class WXDLLEXPORT wxClassInfo
 {
 class WXDLLEXPORT wxClassInfo
 {

- public:
-   char *className;
-   char *baseClassName1;
-   char *baseClassName2;
-   int objectSize;
-   wxObjectConstructorFn objectConstructor;
-   
-#ifdef USE_STORABLE_CLASSES
-  wxStorableConstructorFn storableConstructor;
-#endif
+public:
+   wxClassInfo(const wxChar *cName,
+               const wxChar *baseName1,
+               const wxChar *baseName2,
+               int sz,
+               wxObjectConstructorFn fn);

 
 

-   // Pointers to base wxClassInfos: set in InitializeClasses
-   // called from wx_main.cc
-   wxClassInfo *baseInfo1;
-   wxClassInfo *baseInfo2;
+   wxObject *CreateObject(void);

 
 

-   static wxClassInfo *first;
-   wxClassInfo *next;
+   const wxChar *GetClassName() const { return m_className; }
+   const wxChar *GetBaseClassName1() const { return m_baseClassName1; }
+   const wxChar *GetBaseClassName2() const { return m_baseClassName2; }
+   const wxClassInfo* GetBaseClass1() const { return m_baseInfo1; }
+   const wxClassInfo* GetBaseClass2() const { return m_baseInfo2; }
+   int GetSize() const { return m_objectSize; }
+   wxObjectConstructorFn GetConstructor() const { return m_objectConstructor; }
+   static const wxClassInfo* GetFirst() { return sm_first; }
+   const wxClassInfo* GetNext() const { return m_next; }
+   bool IsKindOf(const wxClassInfo *info) const;

 
 

-#ifdef USE_STORABLE_CLASSES
-   wxClassInfo(char *cName, char *baseName1, char *baseName2, int sz, wxObjectConstructorFn fn,
-     wxStorableConstructorFn stoFn = NULL );
-#else
-   wxClassInfo(char *cName, char *baseName1, char *baseName2, int sz, wxObjectConstructorFn fn);
-#endif
+   static wxClassInfo *FindClass(const wxChar *c);

 
 

-   wxObject *CreateObject(void);
-   
-#ifdef USE_STORABLE_CLASSES
-   wxObject* CreateObject( istream &stream, char *data );
-#endif
+   // Initializes parent pointers and hash table for fast searching.
+   static void InitializeClasses();

 
 

-   inline char *GetClassName(void) const { return className; }
-   inline char *GetBaseClassName1(void) const { return baseClassName1; }
-   inline char *GetBaseClassName2(void) const { return baseClassName2; }
-   inline int GetSize(void) const { return objectSize; }
-   bool IsKindOf(wxClassInfo *info);
+   // Cleans up hash table used for fast searching.
+   static void CleanUpClasses();

 
 

-   static wxClassInfo *FindClass(char *c);
-   // Initializes parent pointers for fast searching.
-   static void InitializeClasses(void);
+public:
+   const wxChar*            m_className;
+   const wxChar*            m_baseClassName1;
+   const wxChar*            m_baseClassName2;
+   int                      m_objectSize;
+   wxObjectConstructorFn    m_objectConstructor;
+
+   // Pointers to base wxClassInfos: set in InitializeClasses
+   const wxClassInfo*       m_baseInfo1;
+   const wxClassInfo*       m_baseInfo2;
+
+   // class info object live in a linked list: pointers to its head and the
+   // next element in it
+   static wxClassInfo*      sm_first;
+   wxClassInfo*             m_next;
+
+   static wxHashTable*      sm_classTable;

 };
 
 };
 

-wxObject* WXDLLEXPORT wxCreateDynamicObject(char *name);
+WXDLLEXPORT wxObject* wxCreateDynamicObject(const wxChar *name);

 
 

-#ifdef USE_STORABLE_CLASSES
-wxObject* WXDLLEXPORT wxCreateStoredObject( char *name, istream &stream, char *data );
+#if wxUSE_SERIAL
+WXDLLEXPORT wxObject* wxCreateStoredObject( wxInputStream& stream );

 #endif
 
 #define DECLARE_DYNAMIC_CLASS(name) \
  public:\
 #endif
 
 #define DECLARE_DYNAMIC_CLASS(name) \
  public:\

-  static wxClassInfo class##name;\
-  wxClassInfo *GetClassInfo() \
-   { return &name::class##name; }
+  static wxClassInfo sm_class##name;\
+  wxClassInfo *GetClassInfo() const \
+   { return &name::sm_class##name; }

 
 #define DECLARE_ABSTRACT_CLASS(name) DECLARE_DYNAMIC_CLASS(name)
 #define DECLARE_CLASS(name) DECLARE_DYNAMIC_CLASS(name)
 
 
 #define DECLARE_ABSTRACT_CLASS(name) DECLARE_DYNAMIC_CLASS(name)
 #define DECLARE_CLASS(name) DECLARE_DYNAMIC_CLASS(name)
 

-#ifdef USE_STORABLE_CLASSES
-#define DECLARE_STORABLECLASS(name) DECLARE_DYNAMIC_CLASS(name)
-#endif
-

 //////
 ////// for concrete classes
 //////
 //////
 ////// for concrete classes
 //////


@@ -115,56 +122,34 @@ wxObject* WXDLLEXPORT wxCreateStoredObject( char *name, istream &stream, char *d
 #define IMPLEMENT_DYNAMIC_CLASS(name, basename) \
 wxObject* WXDLLEXPORT_CTORFN wxConstructorFor##name(void) \
    { return new name; }\
 #define IMPLEMENT_DYNAMIC_CLASS(name, basename) \
 wxObject* WXDLLEXPORT_CTORFN wxConstructorFor##name(void) \
    { return new name; }\

- wxClassInfo name::class##name(#name, #basename, NULL, sizeof(name), wxConstructorFor##name);
+ wxClassInfo name::sm_class##name((wxChar *) wxT(#name), (wxChar *) wxT(#basename), (wxChar *) NULL, (int) sizeof(name), (wxObjectConstructorFn) wxConstructorFor##name);

 
 // Multiple inheritance with two base classes
 #define IMPLEMENT_DYNAMIC_CLASS2(name, basename1, basename2) \
 wxObject* WXDLLEXPORT_CTORFN wxConstructorFor##name(void) \
    { return new name; }\
 
 // Multiple inheritance with two base classes
 #define IMPLEMENT_DYNAMIC_CLASS2(name, basename1, basename2) \
 wxObject* WXDLLEXPORT_CTORFN wxConstructorFor##name(void) \
    { return new name; }\

- wxClassInfo name::class##name(#name, #basename1, #basename2, sizeof(name), wxConstructorFor##name);
-
-//////
-////// for storable classes
-//////
-
-#ifdef USE_STORABLE_CLASSES
-
-#define IMPLEMENT_STORABLE_CLASS(name, basename) \
-wxObject* WXDLLEXPORT_CTORFN wxStorableConstructorFor##name( istream* stream, char* data )\
-       { return new name( stream, data ); }\
-wxObject* WXDLLEXPORT_CTORFN wxConstructorFor##name(void)\
-   { return new name; }\
- wxClassInfo name::class##name(#name, #basename, NULL, sizeof(name), wxConstructorFor##name,\
-   wxStorableConstructorFor##name );
-
-#define IMPLEMENT_STORABLE_CLASS2(name, basename1, basename2) \
-wxObject* WXDLLEXPORT_CTORFN wxStorableConstructorFor##name( istream* stream, char* data )\
-       { return new name( stream, data ); }\
-wxObject* WXDLLEXPORT_CTORFN wxConstructorFor##name(void)\
-   { return new name; }\
- wxClassInfo name::class##name(#name, #basename1, basename2, sizeof(name), wxConstructorFor##name,\
-   wxStorableConstructorFor##name );
+ wxClassInfo name::sm_class##name((wxChar *) wxT(#name), (wxChar *) wxT(#basename1), (wxChar *) wxT(#basename2), (int) sizeof(name), (wxObjectConstructorFn) wxConstructorFor##name);

 
 

-#endif
- 

 //////
 ////// for abstract classes
 //////
 
 // Single inheritance with one base class
 #define IMPLEMENT_ABSTRACT_CLASS(name, basename) \
 //////
 ////// for abstract classes
 //////
 
 // Single inheritance with one base class
 #define IMPLEMENT_ABSTRACT_CLASS(name, basename) \

- wxClassInfo name::class##name(#name, #basename, NULL, sizeof(name), NULL);
+ wxClassInfo name::sm_class##name((wxChar *) wxT(#name), (wxChar *) wxT(#basename), \
+         (wxChar *) NULL, (int) sizeof(name), (wxObjectConstructorFn) NULL);

 
 // Multiple inheritance with two base classes
 #define IMPLEMENT_ABSTRACT_CLASS2(name, basename1, basename2) \
 
 // Multiple inheritance with two base classes
 #define IMPLEMENT_ABSTRACT_CLASS2(name, basename1, basename2) \

- wxClassInfo name::class##name(#name, #basename1, #basename2, sizeof(name), NULL);
+ wxClassInfo name::sm_class##name((wxChar *) wxT(#name), (wxChar *) wxT(#basename1), \
+         (wxChar *) wxT(#basename2), (int) sizeof(name), (wxObjectConstructorFn) NULL);

 
 #define IMPLEMENT_CLASS IMPLEMENT_ABSTRACT_CLASS
 #define IMPLEMENT_CLASS2 IMPLEMENT_ABSTRACT_CLASS2
 
 
 #define IMPLEMENT_CLASS IMPLEMENT_ABSTRACT_CLASS
 #define IMPLEMENT_CLASS2 IMPLEMENT_ABSTRACT_CLASS2
 

-#define CLASSINFO(name) (&name::class##name)
+#define CLASSINFO(name) (&name::sm_class##name)

 
 

-#else
+#else // !wxUSE_DYNAMIC_CLASSES

 
 // No dynamic class system: so stub out the macros
 #define DECLARE_DYNAMIC_CLASS(name)
 
 // No dynamic class system: so stub out the macros
 #define DECLARE_DYNAMIC_CLASS(name)


@@ -177,16 +162,49 @@ wxObject* WXDLLEXPORT_CTORFN wxConstructorFor##name(void)\
 #define IMPLEMENT_CLASS IMPLEMENT_ABSTRACT_CLASS
 #define IMPLEMENT_CLASS2 IMPLEMENT_ABSTRACT_CLASS2
 
 #define IMPLEMENT_CLASS IMPLEMENT_ABSTRACT_CLASS
 #define IMPLEMENT_CLASS2 IMPLEMENT_ABSTRACT_CLASS2
 

-#endif
+#endif // wxUSE_DYNAMIC_CLASSES/!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)
+#define wxIsKindOf(obj, className) obj->IsKindOf(&className::sm_class##className)
+
+// to be replaced by dynamic_cast<> in the future
+#define wxDynamicCast(obj, className) \
+        ((obj) && ((obj)->IsKindOf(&className::sm_class##className)) \
+        ? (className *)(obj) \
+        : (className *)0)
+
+// The 'this' pointer is always true, so use this version to cast the this
+// pointer and avoid compiler warnings.
+#define wxDynamicThisCast(obj, className) \
+        (((obj)->IsKindOf(&className::sm_class##className)) \
+        ? (className *)(obj) \
+        : (className *)0)
+
+#define wxConstCast(obj, className) ((className *)(obj))
+
+#ifdef __WXDEBUG__
+    inline void wxCheckCast(void *ptr)
+    {
+        wxASSERT_MSG( ptr, _T("wxStaticCast() used incorrectly") );
+    }
+
+    #define wxStaticCast(obj, className) \
+        (wxCheckCast(wxDynamicCast(obj, className)), ((className *)(obj)))

 
 

-#define IS_KIND_OF(obj, className) obj->IsKindOf(&className::class##name)
+#else // !Debug
+    #define wxStaticCast(obj, className) ((className *)(obj))
+#endif // Debug/!Debug

 
 // Unfortunately Borland seems to need this include.
 
 // Unfortunately Borland seems to need this include.

+#if wxUSE_STD_IOSTREAM && (defined(__WXDEBUG__) || wxUSE_DEBUG_CONTEXT)

 #ifdef __BORLANDC__
 #ifdef __BORLANDC__

-#if USE_IOSTREAMH
-#include <iostream.h>
-#else
-#include <iostream>
+    #if wxUSE_IOSTREAMH
+        #include <iostream.h>
+    #else
+        #include <iostream>
+    #endif

 #endif
 #endif
 
 #endif
 #endif
 


@@ -197,33 +215,53 @@ class WXDLLEXPORT wxObject
  public:
 
   // This is equivalent to using the macro DECLARE_ABSTRACT_CLASS
  public:
 
   // This is equivalent to using the macro DECLARE_ABSTRACT_CLASS

-  static wxClassInfo classwxObject;
+  static wxClassInfo sm_classwxObject;

 
   wxObject(void);
   virtual ~wxObject(void);
 
 
   wxObject(void);
   virtual ~wxObject(void);
 

-  virtual wxClassInfo *GetClassInfo(void) { return &classwxObject; }
-
-  bool IsKindOf(wxClassInfo *info);
-
-#if DEBUG && USE_MEMORY_TRACING
-  void * operator new (size_t size, char * fileName = NULL, int lineNum = 0);
-  void operator delete (void * buf);
-  
-  // Cause problems for VC++
-#ifndef _MSC_VER
-  void * operator new[] (size_t size, char * fileName = NULL, int lineNum = 0);
-  void operator delete[] (void * buf);
-#endif
-
-#endif
-
-#if DEBUG || USE_DEBUG_CONTEXT
-  virtual void Dump(ostream& str);
+  virtual wxClassInfo *GetClassInfo(void) const { return &sm_classwxObject; }
+  wxObject *Clone(void) const;
+  virtual void CopyObject(wxObject& object_dest) const;
+
+  bool IsKindOf(wxClassInfo *info) const;
+
+#if defined(__WXDEBUG__) && wxUSE_MEMORY_TRACING
+  void * operator new (size_t size, wxChar * fileName = NULL, int lineNum = 0);
+#  if defined(__VISAGECPP__)
+#    if __DEBUG_ALLOC__
+       void operator delete (void * buf,const char * _fname, size_t _line);
+#    endif  //__DEBUG_ALLOC__
+#  else // Everybody else
+    void operator delete (void * buf);
+#  endif // end of VISAGECPP
+
+// VC++ 6.0
+#  if defined(__VISUALC__) && (__VISUALC__ >= 1200)
+    void operator delete(void *buf, wxChar*, int);
+#  endif
+
+    // Causes problems for VC++
+#  if wxUSE_ARRAY_MEMORY_OPERATORS && !defined(__VISUALC__) && !defined( __MWERKS__)
+    void * operator new[] (size_t size, wxChar * fileName = NULL, int lineNum = 0);
+    void operator delete[] (void * buf);
+#  endif
+
+#  ifdef __MWERKS__
+    void * operator new[] (size_t size, wxChar * fileName , int lineNum = 0);
+    void * operator new[] (size_t size) { return operator new[] ( size , NULL , 0 ) ; }
+    void operator delete[] (void * buf);
+#  endif
+
+#endif // Debug & memory tracing
+
+#if wxUSE_STD_IOSTREAM && (defined(__WXDEBUG__) || wxUSE_DEBUG_CONTEXT)
+  virtual void Dump(wxSTD ostream& str);

 #endif
 
 #endif
 

-#ifdef USE_STORABLE_CLASSES
-  virtual void StoreObject( ostream &WXUNUSED(stream) ) {};
+#if wxUSE_SERIAL
+  virtual void StoreObject( wxObjectOutputStream &stream );
+  virtual void LoadObject( wxObjectInputStream &stream );

 #endif
 
   // make a 'clone' of the object
 #endif
 
   // make a 'clone' of the object


@@ -236,7 +274,10 @@ class WXDLLEXPORT wxObject
   inline void SetRefData(wxObjectRefData *data) { m_refData = data; }
 
 protected:
   inline void SetRefData(wxObjectRefData *data) { m_refData = data; }
 
 protected:

-  wxObjectRefData *m_refData;
+  wxObjectRefData*      m_refData;
+#if wxUSE_SERIAL
+  wxObject_Serialize*   m_serialObj;
+#endif

 };
 
 /*
 };
 
 /*


@@ -256,14 +297,23 @@ private:
     int m_count;
 };
 
     int m_count;
 };
 

-#if DEBUG && USE_GLOBAL_MEMORY_OPERATORS
+#ifdef __WXDEBUG__

 #ifndef WXDEBUG_NEW
 #ifndef WXDEBUG_NEW

-#define WXDEBUG_NEW new(__FILE__,__LINE__)
+#define WXDEBUG_NEW new(__TFILE__,__LINE__)
+#endif
+#else
+#define WXDEBUG_NEW new

 #endif
 #endif

-#define new WXDEBUG_NEW
+
+// 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
 #endif
 
 #endif

-    // __OBJECTH__
+    // _WX_OBJECTH__