X-Git-Url: https://git.netwichtig.de/gitweb/?a=blobdiff_plain;f=include%2Fbase.h;h=dcbb2e5c7858c7727e2237cf8b8e1b8db7222b22;hb=3ccf0065d43db80f31c6404aeac4d65551481508;hp=594e5bfe48dc3b8d2927beba0820ac81483a6c0c;hpb=bab14f0dd2345c9d7dcbc47c918563709e1ac094;p=user%2Fhenk%2Fcode%2Finspircd.git diff --git a/include/base.h b/include/base.h index 594e5bfe4..dcbb2e5c7 100644 --- a/include/base.h +++ b/include/base.h @@ -1 +1,257 @@ -/* +------------------------------------+ * | Inspire Internet Relay Chat Daemon | * +------------------------------------+ * * InspIRCd: (C) 2002-2007 InspIRCd Development Team * See: http://www.inspircd.org/wiki/index.php/Credits * * This program is free but copyrighted software; see * the file COPYING for details. * * --------------------------------------------------- */ #ifndef __BASE_H__ #define __BASE_H__ #include "inspircd_config.h" #include #include #include #include /** Do we use this? -- Brain */ typedef void* VoidPointer; /** A private data store for an Extensible class */ typedef std::map ExtensibleStore; /** Needed */ class InspIRCd; /** 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. */ class CoreExport classbase { public: /** Time that the object was instantiated (used for TS calculation etc) */ time_t age; /** Constructor. * Sets the object's time */ classbase(); /** Destructor. * Does sweet FA. */ ~classbase() { } }; /** class Extensible is the parent class of many classes such as userrec and chanrec. * class Extensible implements a system which allows modules to 'extend' the class by attaching data within * a map associated with the object. In this way modules can store their own custom information within user * objects, channel objects and server objects, without breaking other modules (this is more sensible than using * a flags variable, and each module defining bits within the flag as 'theirs' as it is less prone to conflict and * supports arbitary data storage). */ class CoreExport Extensible : public classbase { /** Private data store. * Holds all extensible metadata for the class. */ ExtensibleStore Extension_Items; public: /** Extend an Extensible class. * * @param key The key parameter is an arbitary string which identifies the extension data * @param p This parameter is a pointer to any data you wish to associate with the object * * You must provide a key to store the data as via the parameter 'key' and store the data * in the templated parameter 'p'. * The data will be inserted into the map. If the data already exists, you may not insert it * twice, Extensible::Extend will return false in this case. * * @return Returns true on success, false if otherwise */ template bool Extend(const std::string &key, T* p) { /* This will only add an item if it doesnt already exist, * the return value is a std::pair of an iterator to the * element, and a bool saying if it was actually inserted. */ return this->Extension_Items.insert(std::make_pair(key, (char*)p)).second; } /** Extend an Extensible class. * * @param key The key parameter is an arbitary string which identifies the extension data * * You must provide a key to store the data as via the parameter 'key', this single-parameter * version takes no 'data' parameter, this is used purely for boolean values. * The key will be inserted into the map with a NULL 'data' pointer. If the key already exists * then you may not insert it twice, Extensible::Extend will return false in this case. * * @return Returns true on success, false if otherwise */ bool Extend(const std::string &key) { /* This will only add an item if it doesnt already exist, * the return value is a std::pair of an iterator to the * element, and a bool saying if it was actually inserted. */ return this->Extension_Items.insert(std::make_pair(key, (char*)NULL)).second; } /** Shrink an Extensible class. * * @param key The key parameter is an arbitary string which identifies the extension data * * You must provide a key name. The given key name will be removed from the classes data. If * you provide a nonexistent key (case is important) then the function will return false. * @return Returns true on success. */ bool Shrink(const std::string &key); /** Get an extension item. * * @param key The key parameter is an arbitary string which identifies the extension data * @param p If you provide a non-existent key, this value will be NULL. Otherwise a pointer to the item you requested will be placed in this templated parameter. * @return Returns true if the item was found and false if it was nor, regardless of wether 'p' is NULL. This allows you to store NULL values in Extensible. */ template bool GetExt(const std::string &key, T* &p) { ExtensibleStore::iterator iter = this->Extension_Items.find(key); /* Find the item */ if(iter != this->Extension_Items.end()) { p = (T*)iter->second; /* Item found */ return true; } else { p = NULL; /* Item not found */ return false; } } /** Get an extension item. * * @param key The key parameter is an arbitary string which identifies the extension data * @return Returns true if the item was found and false if it was not. * * This single-parameter version only checks if the key exists, it does nothing with * the 'data' field and is probably only useful in conjunction with the single-parameter * version of Extend(). */ bool GetExt(const std::string &key) { return (this->Extension_Items.find(key) != this->Extension_Items.end()); } /** Get a list of all extension items names. * @param list A deque of strings to receive the list * @return This function writes a list of all extension items stored in this object by name into the given deque and returns void. */ void GetExtList(std::deque &list); }; /** BoolSet is a utility class designed to hold eight bools in a bitmask. * Use BoolSet::Set and BoolSet::Get to set and get bools in the bitmask, * and Unset and Invert for special operations upon them. */ class CoreExport BoolSet : public classbase { /** Actual bit values */ char bits; public: /** The default constructor initializes the BoolSet to all values unset. */ BoolSet(); /** This constructor copies the default bitmask from a char */ BoolSet(char bitmask); /** The Set method sets one bool in the set. * * @param number The number of the item to set. This must be between 0 and 7. */ void Set(int number); /** The Get method returns the value of one bool in the set * * @param number The number of the item to retrieve. This must be between 0 and 7. * * @return True if the item is set, false if it is unset. */ bool Get(int number); /** The Unset method unsets one value in the set * * @param number The number of the item to set. This must be between 0 and 7. */ void Unset(int number); /** The Unset method inverts (flips) one value in the set * * @param number The number of the item to invert. This must be between 0 and 7. */ void Invert(int number); /** Compare two BoolSets */ bool operator==(BoolSet other); /** OR two BoolSets together */ BoolSet operator|(BoolSet other); /** AND two BoolSets together */ BoolSet operator&(BoolSet other); /** Assign one BoolSet to another */ bool operator=(BoolSet other); }; #endif \ No newline at end of file +/* + * InspIRCd -- Internet Relay Chat Daemon + * + * Copyright (C) 2009 Daniel De Graaf + * Copyright (C) 2006-2007 Oliver Lupton + * Copyright (C) 2007 Dennis Friis + * Copyright (C) 2003-2005, 2007 Craig Edwards + * + * This file is part of InspIRCd. InspIRCd is free software: you can + * redistribute it and/or modify it under the terms of the GNU General Public + * License as published by the Free Software Foundation, version 2. + * + * This program is distributed in the hope that it will be useful, but WITHOUT + * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS + * FOR A PARTICULAR PURPOSE. See the GNU General Public License for more + * details. + * + * You should have received a copy of the GNU General Public License + * along with this program. If not, see . + */ + + +#pragma once + +#include +#include +#include +#include + +/** 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: + classbase(); + + /** + * Called just prior to destruction via cull list. + */ + 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, 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; } + 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&); +}; + +/** 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 +{ + 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 reference +{ + T* value; + public: + reference() : value(0) { } + 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) + other.value->refcount_inc(); + this->reference::~reference(); + value = other.value; + return *this; + } + + ~reference() + { + if (value && value->refcount_dec()) + delete value; + } + + inline reference& operator=(T* other) + { + if (value != other) + { + if (value && value->refcount_dec()) + delete value; + value = other; + if (value) + value->refcount_inc(); + } + + return *this; + } + + inline operator bool() const { return (value != NULL); } + 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: +#ifndef _WIN32 + static void* operator new(size_t); + static void operator delete(void*); +#endif +}; + +/** 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: + /** This constructor can be used to specify an error message before throwing. + * @param message Human readable error message + */ + 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. + * @param message Human readable error message + * @param src 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. + * @return Human readable description of the error + */ + const std::string& GetReason() const { return err; } + + /** Returns the source of the exception + * @return Source of the exception + */ + const std::string& GetSource() const { return source; } +}; + +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); +}; + +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); + virtual ~ServiceProvider(); + + /** If called, this ServiceProvider won't be registered automatically + */ + void DisableAutoRegister(); +};