X-Git-Url: https://git.netwichtig.de/gitweb/?a=blobdiff_plain;f=include%2Fbase.h;h=98ce20fd5485feee477181ddd2cb9b4f93e2c0d5;hb=2ba32afa9a9aca7c82966b66bda16c3c3dbfbba5;hp=230ed1db4f81f02a35816c849aa07ac19015bd3d;hpb=c4a53990f0767b38f0c2454c9e10e4f85ad08093;p=user%2Fhenk%2Fcode%2Finspircd.git diff --git a/include/base.h b/include/base.h index 230ed1db4..98ce20fd5 100644 --- a/include/base.h +++ b/include/base.h @@ -1,10 +1,16 @@ /* * InspIRCd -- Internet Relay Chat Daemon * - * Copyright (C) 2009 Daniel De Graaf - * Copyright (C) 2006-2007 Oliver Lupton + * Copyright (C) 2020 Matt Schatz + * Copyright (C) 2013, 2015 Attila Molnar + * Copyright (C) 2012-2013, 2017, 2020 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) 2003-2005, 2007 Craig Edwards + * Copyright (C) 2006, 2010 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 @@ -20,11 +26,9 @@ */ -#ifndef BASE_H -#define BASE_H +#pragma once -#include -#include +#include "compat.h" #include /** Dummy class to help enforce culls being parent-called up to classbase */ @@ -121,7 +125,7 @@ class CoreExport usecountbase }; template -class CoreExport reference +class reference { T* value; public: @@ -157,7 +161,7 @@ class CoreExport reference return *this; } - inline operator bool() const { return value; } + 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; } @@ -165,7 +169,7 @@ class CoreExport reference 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 +#ifndef _WIN32 static void* operator new(size_t); static void operator delete(void*); #endif @@ -179,40 +183,39 @@ class CoreExport reference */ class CoreExport CoreException : public std::exception { - public: + protected: /** Holds the error message to be displayed */ const std::string err; /** Source of the exception */ const std::string source; - /** Default constructor, just uses the error mesage 'Core threw an exception'. - */ - CoreException() : err("Core threw an exception"), source("The core") {} + + 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() {}; + 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; @@ -235,8 +238,10 @@ enum ServiceType { SERVICE_METADATA, /** is a data processing provider (MD5, SQL) */ SERVICE_DATA, - /** is an I/O hook provider (SSL) */ - SERVICE_IOHOOK + /** is an I/O hook provider */ + SERVICE_IOHOOK, + /** Service managed by a module */ + SERVICE_CUSTOM }; /** A structure defining something that a module can provide */ @@ -249,10 +254,17 @@ class CoreExport ServiceProvider : public classbase 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) {} + 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; -#endif + /** Register this service in the appropriate registrar + */ + virtual void RegisterService(); + + /** If called, this ServiceProvider won't be registered automatically + */ + void DisableAutoRegister(); +};