X-Git-Url: https://git.netwichtig.de/gitweb/?a=blobdiff_plain;f=include%2Fbase.h;h=7926779ebd0ea21508ccc7d339da130cc2200eb7;hb=511c11b8da024363fe2711a5ea9d600326073c8c;hp=2bc0e4a6a4d305f5f80850d71f3c698c9ccb0c44;hpb=4ab15e865571f78cd8ea22c47a1a3b7d3372a786;p=user%2Fhenk%2Fcode%2Finspircd.git diff --git a/include/base.h b/include/base.h index 2bc0e4a6a..7926779eb 100644 --- a/include/base.h +++ b/include/base.h @@ -2,7 +2,7 @@ * | Inspire Internet Relay Chat Daemon | * +------------------------------------+ * - * InspIRCd: (C) 2002-2009 InspIRCd Development Team + * InspIRCd: (C) 2002-2010 InspIRCd Development Team * See: http://wiki.inspircd.org/Credits * * This program is free but copyrighted software; see @@ -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: @@ -30,47 +36,93 @@ class CoreExport classbase /** * Called just prior to destruction via cull list. - * - * @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() {} + static inline void* operator new(size_t, void* m) { return m; } + private: + interfacebase(const interfacebase&); + void operator=(const interfacebase&); + static void* operator new(size_t); + static 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; + static inline void* operator new(size_t, void* m) { return m; } + static void* operator new(size_t); + static void operator delete(void*); + inline void refcount_inc() const { refcount++; } + inline bool refcount_dec() const { refcount--; return !refcount; } + private: + // uncopyable + refcountbase(const refcountbase&); + void operator=(const refcountbase&); }; -class CoreExport reference_base +/** Base class for use count tracking. Uses reference<>, but does not + * cause object deletion when the last user is removed. + * + * Safe for use as a second parent class; will not add a second vtable. + */ +class CoreExport usecountbase { - protected: - static inline unsigned int inc(refcountbase* v) { return ++(v->refcount); } - static inline unsigned int dec(refcountbase* v) { return --(v->refcount); } + mutable unsigned int usecount; + public: + usecountbase() : usecount(0) { } + ~usecountbase(); + inline unsigned int GetUseCount() const { return usecount; } + inline void refcount_inc() const { usecount++; } + inline bool refcount_dec() const { usecount--; return false; } + private: + // uncopyable + usecountbase(const usecountbase&); + void operator=(const usecountbase&); }; template -class CoreExport reference : public reference_base +class reference { 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(T* v) : value(v) { if (value) value->refcount_inc(); } + reference(const reference& v) : value(v.value) { if (value) value->refcount_inc(); } reference& operator=(const reference& other) { if (other.value) - inc(other.value); + other.value->refcount_inc(); this->reference::~reference(); value = other.value; return *this; @@ -78,19 +130,19 @@ class CoreExport reference : public reference_base ~reference() { - if (value) - { - int rc = dec(value); - if (rc == 0 && value->cull()) - delete value; - } + if (value && value->refcount_dec()) + 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; } 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; } + static inline void* operator new(size_t, void* m) { return m; } + private: + static void* operator new(size_t); + static void operator delete(void*); }; /** This class can be used on its own to represent an exception, or derived to represent a module-specific exception. @@ -101,14 +153,13 @@ class CoreExport reference : public reference_base */ class CoreExport CoreException : public std::exception { - protected: + public: /** Holds the error message to be displayed */ const std::string err; /** Source of the exception */ const std::string source; - public: /** Default constructor, just uses the error mesage 'Core threw an exception'. */ CoreException() : err("Core threw an exception"), source("The core") {} @@ -141,18 +192,40 @@ class CoreExport CoreException : public std::exception 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); }; +typedef const reference ModuleRef; + +enum ServiceType { + /** is a Command */ + SERVICE_COMMAND, + /** is a ModeHandler */ + SERVICE_MODE, + /** is a metadata descriptor */ + SERVICE_METADATA, + /** is a data processing provider (MD5, SQL) */ + SERVICE_DATA, + /** is an I/O hook provider (SSL) */ + SERVICE_IOHOOK +}; + +/** A structure defining something that a module can provide */ +class CoreExport ServiceProvider : public classbase +{ + public: + /** Module that is providing this service */ + ModuleRef creator; + /** Name of the service being provided */ + const std::string name; + /** Type of service (must match object type) */ + const ServiceType service; + ServiceProvider(Module* Creator, const std::string& Name, ServiceType Type) + : creator(Creator), name(Name), service(Type) {} + virtual ~ServiceProvider(); +}; + + #endif