X-Git-Url: https://git.netwichtig.de/gitweb/?a=blobdiff_plain;f=include%2Fbase.h;h=b915d9ae490af33e643efd641b5fde71e455442b;hb=a601cf2f0d9754e4bb11a28ce8954a86ad4e367e;hp=b66051cafe7a365d0b718d07c0ae048696328c74;hpb=e2af2347fc035d702e45f12e772223a8d578410d;p=user%2Fhenk%2Fcode%2Finspircd.git diff --git a/include/base.h b/include/base.h index b66051caf..b915d9ae4 100644 --- a/include/base.h +++ b/include/base.h @@ -1,98 +1,180 @@ -/* +------------------------------------+ - * | Inspire Internet Relay Chat Daemon | - * +------------------------------------+ +/* + * InspIRCd -- Internet Relay Chat Daemon * - * InspIRCd: (C) 2002-2009 InspIRCd Development Team - * See: http://wiki.inspircd.org/Credits + * Copyright (C) 2020 Matt Schatz + * Copyright (C) 2013, 2015 Attila Molnar + * Copyright (C) 2012-2013, 2017 Sadie Powell + * Copyright (C) 2012 Robby + * Copyright (C) 2012 ChrisTX + * Copyright (C) 2011-2012 Adam + * Copyright (C) 2009-2010 Daniel De Graaf + * Copyright (C) 2007 Oliver Lupton + * Copyright (C) 2007 Dennis Friis + * Copyright (C) 2006, 2010 Craig Edwards * - * This program is free but copyrighted software; see - * the file COPYING for details. + * 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 . */ -#ifndef __BASE_H__ -#define __BASE_H__ + +#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. - * Wherever possible, all classes you create should inherit from this, - * giving them the ability to be passed to various core functions - * as 'anonymous' classes. -*/ +/** 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 void cull(); + /** + * Called just prior to destruction via cull list. + */ + virtual CullResult cull(); virtual ~classbase(); + private: + // uncopyable + classbase(const classbase&); + void operator=(const classbase&); }; -/** 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. +/** The base class for inspircd classes that provide a wrapping interface, and + * should only exist while being used. Prevents heap allocation. */ -class CoreExport BoolSet : public classbase +class CoreExport interfacebase { - /** Actual bit values */ - char bits; - 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 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 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&); +}; - /** 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); +/** 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&); +}; - /** 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); +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; + } - /** Compare two BoolSets - */ - bool operator==(BoolSet other); + ~reference() + { + if (value && value->refcount_dec()) + delete value; + } - /** OR two BoolSets together - */ - BoolSet operator|(BoolSet other); + inline reference& operator=(T* other) + { + if (value != other) + { + if (value && value->refcount_dec()) + delete value; + value = other; + if (value) + value->refcount_inc(); + } - /** AND two BoolSets together - */ - BoolSet operator&(BoolSet other); + return *this; + } - /** Assign one BoolSet to another - */ - bool operator=(BoolSet other); + 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. @@ -110,51 +192,81 @@ class CoreExport CoreException : public std::exception /** 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. + * @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() {}; + 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. + * @return Human readable description of the error */ - virtual const char* GetReason() - { - return err.c_str(); - } + const std::string& GetReason() const { return err; } - virtual const char* GetSource() - { - return source.c_str(); - } + /** 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: - /** Default constructor, just uses the error mesage 'Module threw an exception'. + /** This constructor can be used to specify an error message before throwing. */ - ModuleException() : CoreException("Module threw an exception", "A Module") {} + ModuleException(const std::string &message, Module* me = NULL); +}; - /** This constructor can be used to specify an error message before throwing. +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 */ + SERVICE_IOHOOK, + /** Service managed by a module */ + SERVICE_CUSTOM +}; + +/** 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(); + + /** Retrieves a string that represents the type of this service. */ + const char* GetTypeString() const; + + /** Register this service in the appropriate registrar */ - 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 void RegisterService(); + + /** If called, this ServiceProvider won't be registered automatically */ - virtual ~ModuleException() throw() {}; + void DisableAutoRegister(); }; - -#endif