X-Git-Url: https://git.netwichtig.de/gitweb/?a=blobdiff_plain;f=include%2Fbase.h;h=daff74e5663468be7a092b931978dccf5591f9e1;hb=ff3eef491aa9e107d09d9dd9560ef7715b37b3b3;hp=c347aedb30edc93b4318075a7adeb0341a15b3c7;hpb=8f282762b0a90458a808e13c4a52196ebd14534a;p=user%2Fhenk%2Fcode%2Finspircd.git diff --git a/include/base.h b/include/base.h index c347aedb3..daff74e56 100644 --- a/include/base.h +++ b/include/base.h @@ -1,22 +1,213 @@ -/* +/* +------------------------------------+ + * | Inspire Internet Relay Chat Daemon | + * +------------------------------------+ + * + * InspIRCd: (C) 2002-2009 InspIRCd Development Team + * See: http://wiki.inspircd.org/Credits + * + * This program is free but copyrighted software; see + * the file COPYING for details. + * + * --------------------------------------------------- + */ +#ifndef __BASE_H__ +#define __BASE_H__ -*/ +#include +#include +#include -#include "inspircd_config.h" -#include - -#ifndef __BASE_H__ -#define __BASE_H__ - -class classbase +/** 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: - time_t age; + classbase(); - classbase() { age = time(NULL); } - ~classbase() { } + /** + * Called just prior to destruction via cull list. + * + * @return true to allow the delete, or false to halt the delete + */ + virtual CullResult cull(); + virtual ~classbase(); + private: + // uncopyable + classbase(const classbase&); + void operator=(const classbase&); }; -#endif +/** 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, 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 +{ + mutable unsigned int refcount; + public: + refcountbase(); + 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: + template static inline unsigned int inc(T* v) { return ++(v->refcount); } + template static inline unsigned int dec(T* v) { return --(v->refcount); } + +}; + +template +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& operator=(const reference& other) + { + if (other.value) + inc(other.value); + this->reference::~reference(); + value = other.value; + return *this; + } + ~reference() + { + if (value) + { + int rc = dec(value); + if (rc == 0) + delete 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. + * When a module whishes to abort, e.g. within a constructor, it should throw an exception using ModuleException or + * a class derived from ModuleException. If a module throws an exception during its constructor, the module will not + * be loaded. If this happens, the error message returned by ModuleException::GetReason will be displayed to the user + * attempting to load the module, or dumped to the console if the ircd is currently loading for the first time. + */ +class CoreExport CoreException : public std::exception +{ + protected: + /** 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") {} + /** This constructor can be used to specify an error message before throwing. + */ + CoreException(const std::string &message) : err(message), source("The core") {} + /** This constructor can be used to specify an error message before throwing, + * and to specify the source of the exception. + */ + CoreException(const std::string &message, const std::string &src) : err(message), source(src) {} + /** 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 ~CoreException() throw() {}; + /** Returns the reason for the exception. + * The module should probably put something informative here as the user will see this upon failure. + */ + virtual const char* GetReason() + { + return err.c_str(); + } + + virtual const char* GetSource() + { + return source.c_str(); + } +}; + +class Module; + +class CoreExport ModuleException : public CoreException +{ + public: + /** This constructor can be used to specify an error message before throwing. + */ + 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