X-Git-Url: https://git.netwichtig.de/gitweb/?a=blobdiff_plain;f=include%2Fbase.h;h=daff74e5663468be7a092b931978dccf5591f9e1;hb=ff3eef491aa9e107d09d9dd9560ef7715b37b3b3;hp=f41ea07d2b4ee47bebdbbef3a65c10f4d62da3bc;hpb=3dc81ee1331d1b37ee85be9bf0d843e3b6827a2d;p=user%2Fhenk%2Fcode%2Finspircd.git diff --git a/include/base.h b/include/base.h index f41ea07d2..daff74e56 100644 --- a/include/base.h +++ b/include/base.h @@ -18,11 +18,17 @@ #include #include -/** The base class for all inspircd classes. - * Wherever possible, all classes you create should inherit from this, - * giving them the ability to be passed to various core functions - * as 'anonymous' classes. -*/ +/** Dummy class to help enforce culls being parent-called up to classbase */ +class CullResult +{ + CullResult(); + friend class classbase; +}; + +/** The base class for all inspircd classes with a well-defined lifetime. + * Classes that inherit from this may be destroyed through GlobalCulls, + * and may rely on cull() being called prior to their deletion. + */ class CoreExport classbase { public: @@ -33,40 +39,73 @@ class CoreExport classbase * * @return true to allow the delete, or false to halt the delete */ - virtual bool cull(); + virtual CullResult cull(); virtual ~classbase(); + private: + // uncopyable + classbase(const classbase&); + void operator=(const classbase&); +}; + +/** The base class for inspircd classes that provide a wrapping interface, and + * should only exist while being used. Prevents heap allocation. + */ +class CoreExport interfacebase +{ + public: + interfacebase() {} + private: + interfacebase(const interfacebase&); + void operator=(const interfacebase&); + void* operator new(size_t); + void operator delete(void*); }; /** The base class for inspircd classes that support reference counting. * Any objects that do not have a well-defined lifetime should inherit from - * this + * this, and should be assigned to a reference object to establish their + * lifetime. + * + * Reference objects should not hold circular references back to themselves, + * even indirectly; this will cause a memory leak because the count will never + * drop to zero. + * + * Using a normal pointer for the object is recommended if you can assure that + * at least one reference<> will remain as long as that pointer is used; this + * will avoid the slight overhead of changing the reference count. */ -class CoreExport refcountbase : public classbase +class CoreExport refcountbase { - unsigned int refcount; + mutable unsigned int refcount; public: refcountbase(); - virtual bool cull(); virtual ~refcountbase(); inline unsigned int GetReferenceCount() const { return refcount; } friend class reference_base; + void* operator new(size_t); + void operator delete(void*); + private: + // uncopyable + refcountbase(const refcountbase&); + void operator=(const refcountbase&); }; class CoreExport reference_base { protected: - static inline unsigned int inc(refcountbase* v) { return ++(v->refcount); } - static inline unsigned int dec(refcountbase* v) { return --(v->refcount); } + template static inline unsigned int inc(T* v) { return ++(v->refcount); } + template static inline unsigned int dec(T* v) { return --(v->refcount); } + }; template -class CoreExport reference : public reference_base +class reference : public reference_base { T* value; public: reference() : value(0) { } reference(T* v) : value(v) { if (value) inc(value); } - reference(const reference& v) : value(v.value) { if (value) inc(value); } + reference(const reference& v) : value(v.value) { if (value) inc(value); } reference& operator=(const reference& other) { if (other.value) @@ -81,16 +120,21 @@ class CoreExport reference : public reference_base if (value) { int rc = dec(value); - if (rc == 0 && value->cull()) + if (rc == 0) delete value; } } - inline const T* operator->() const { return value; } - inline const T& operator*() const { return *value; } - inline T* operator->() { return value; } - inline T& operator*() { return *value; } - operator bool() const { return value; } - operator T*() const { return value; } + inline operator bool() const { return value; } + inline operator T*() const { return value; } + inline T* operator->() const { return value; } + inline T& operator*() const { return *value; } + inline bool operator<(const reference& other) const { return value < other.value; } + inline bool operator>(const reference& other) const { return value > other.value; } + inline bool operator==(const reference& other) const { return value == other.value; } + inline bool operator!=(const reference& other) const { return value != other.value; } + private: + void* operator new(size_t); + void operator delete(void*); }; /** This class can be used on its own to represent an exception, or derived to represent a module-specific exception. @@ -138,21 +182,32 @@ class CoreExport CoreException : public std::exception } }; +class Module; + class CoreExport ModuleException : public CoreException { public: - /** Default constructor, just uses the error mesage 'Module threw an exception'. - */ - ModuleException() : CoreException("Module threw an exception", "A Module") {} - /** This constructor can be used to specify an error message before throwing. */ - ModuleException(const std::string &message) : CoreException(message, "A Module") {} - /** This destructor solves world hunger, cancels the world debt, and causes the world to end. - * Actually no, it does nothing. Never mind. - * @throws Nothing! - */ - virtual ~ModuleException() throw() {}; + ModuleException(const std::string &message, Module* me = NULL); +}; + +/** Module reference, similar to reference + */ +class CoreExport ModuleRef : public reference_base +{ + Module* const value; + public: + ModuleRef(Module* v); + ~ModuleRef(); + inline operator Module*() const { return value; } + inline Module* operator->() const { return value; } + inline Module& operator*() const { return *value; } + private: + ModuleRef(const ModuleRef&); + void operator=(const ModuleRef&); + void* operator new(size_t); + void operator delete(void*); }; #endif