a22eb2f5c3
git-svn-id: https://svn.wxwidgets.org/svn/wx/wxWidgets/trunk@12856 c3d73ce0-8a6f-49c7-b76d-6d57e0e08775
321 lines
9.5 KiB
C++
321 lines
9.5 KiB
C++
/////////////////////////////////////////////////////////////////////////////
|
|
// Name: object.h
|
|
// Purpose: wxObject class, plus run-time type information macros
|
|
// Author: Julian Smart
|
|
// Modified by:
|
|
// Created: 01/02/97
|
|
// RCS-ID: $Id$
|
|
// Copyright: (c) Julian Smart and Markus Holzem
|
|
// Licence: wxWindows licence
|
|
/////////////////////////////////////////////////////////////////////////////
|
|
|
|
#ifndef _WX_OBJECTH__
|
|
#define _WX_OBJECTH__
|
|
|
|
#ifdef __GNUG__
|
|
#pragma interface "object.h"
|
|
#endif
|
|
|
|
#include "wx/defs.h"
|
|
#include "wx/memory.h"
|
|
|
|
class WXDLLEXPORT wxObject;
|
|
|
|
#if wxUSE_DYNAMIC_CLASSES
|
|
|
|
// #ifdef __GNUWIN32__
|
|
#ifdef GetClassName
|
|
#undef GetClassName
|
|
#endif
|
|
#ifdef GetClassInfo
|
|
#undef GetClassInfo
|
|
#endif
|
|
// #endif
|
|
|
|
class WXDLLEXPORT wxClassInfo;
|
|
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
|
|
*/
|
|
|
|
typedef wxObject * (*wxObjectConstructorFn) (void);
|
|
|
|
class WXDLLEXPORT wxClassInfo
|
|
{
|
|
public:
|
|
wxClassInfo(const wxChar *cName,
|
|
const wxChar *baseName1,
|
|
const wxChar *baseName2,
|
|
int sz,
|
|
wxObjectConstructorFn fn);
|
|
|
|
wxObject *CreateObject(void);
|
|
|
|
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;
|
|
|
|
static wxClassInfo *FindClass(const wxChar *c);
|
|
|
|
// Initializes parent pointers and hash table for fast searching.
|
|
static void InitializeClasses();
|
|
|
|
// Cleans up hash table used for fast searching.
|
|
static void CleanUpClasses();
|
|
|
|
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;
|
|
};
|
|
|
|
WXDLLEXPORT wxObject* wxCreateDynamicObject(const wxChar *name);
|
|
|
|
#if wxUSE_SERIAL
|
|
WXDLLEXPORT wxObject* wxCreateStoredObject( wxInputStream& stream );
|
|
#endif
|
|
|
|
#define DECLARE_DYNAMIC_CLASS(name) \
|
|
public:\
|
|
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)
|
|
|
|
//////
|
|
////// for concrete classes
|
|
//////
|
|
|
|
// Single inheritance with one base class
|
|
#define IMPLEMENT_DYNAMIC_CLASS(name, basename) \
|
|
wxObject* WXDLLEXPORT_CTORFN wxConstructorFor##name(void) \
|
|
{ return new 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; }\
|
|
wxClassInfo name::sm_class##name((wxChar *) wxT(#name), (wxChar *) wxT(#basename1), (wxChar *) wxT(#basename2), (int) sizeof(name), (wxObjectConstructorFn) wxConstructorFor##name);
|
|
|
|
//////
|
|
////// for abstract classes
|
|
//////
|
|
|
|
// Single inheritance with one base class
|
|
#define IMPLEMENT_ABSTRACT_CLASS(name, basename) \
|
|
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) \
|
|
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 CLASSINFO(name) (&name::sm_class##name)
|
|
|
|
#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
|
|
|
|
#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) \
|
|
(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)
|
|
|
|
#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)))
|
|
|
|
#else // !Debug
|
|
#define wxStaticCast(obj, className) ((className *)(obj))
|
|
#endif // Debug/!Debug
|
|
|
|
// Unfortunately Borland seems to need this include.
|
|
#if wxUSE_STD_IOSTREAM && (defined(__WXDEBUG__) || wxUSE_DEBUG_CONTEXT)
|
|
#ifdef __BORLANDC__
|
|
#if wxUSE_IOSTREAMH
|
|
#include <iostream.h>
|
|
#else
|
|
#include <iostream>
|
|
#endif
|
|
#endif
|
|
#endif
|
|
|
|
class WXDLLEXPORT wxObjectRefData;
|
|
|
|
class WXDLLEXPORT wxObject
|
|
{
|
|
public:
|
|
|
|
// This is equivalent to using the macro DECLARE_ABSTRACT_CLASS
|
|
static wxClassInfo sm_classwxObject;
|
|
|
|
wxObject(void);
|
|
virtual ~wxObject(void);
|
|
|
|
virtual wxClassInfo *GetClassInfo(void) const { return &sm_classwxObject; }
|
|
|
|
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
|
|
|
|
#if wxUSE_SERIAL
|
|
virtual void StoreObject( wxObjectOutputStream &stream );
|
|
virtual void LoadObject( wxObjectInputStream &stream );
|
|
#endif
|
|
|
|
// make a 'clone' of the object
|
|
void Ref(const wxObject& clone);
|
|
|
|
// destroy a reference
|
|
void UnRef(void);
|
|
|
|
inline wxObjectRefData *GetRefData(void) const { return m_refData; }
|
|
inline void SetRefData(wxObjectRefData *data) { m_refData = data; }
|
|
|
|
protected:
|
|
wxObjectRefData* m_refData;
|
|
#if wxUSE_SERIAL
|
|
wxObject_Serialize* m_serialObj;
|
|
#endif
|
|
};
|
|
|
|
/*
|
|
* wxObjectData
|
|
*/
|
|
|
|
class WXDLLEXPORT wxObjectRefData {
|
|
|
|
friend class wxObject;
|
|
|
|
public:
|
|
wxObjectRefData(void);
|
|
virtual ~wxObjectRefData(void);
|
|
|
|
inline int GetRefCount(void) const { return m_count; }
|
|
private:
|
|
int m_count;
|
|
};
|
|
|
|
inline wxObject *wxCheckDynamicCast(wxObject *obj, wxClassInfo *classInfo)
|
|
{
|
|
return obj && obj->GetClassInfo()->IsKindOf(classInfo) ? obj : 0;
|
|
}
|
|
|
|
#ifdef __WXDEBUG__
|
|
#ifndef WXDEBUG_NEW
|
|
#define WXDEBUG_NEW new(__TFILE__,__LINE__)
|
|
#endif
|
|
#else
|
|
#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__
|
|
|
|
|