]> git.netwichtig.de Git - user/henk/code/inspircd.git/blobdiff - include/base.h
Fix a bunch of really obvious unnecessary includes.
[user/henk/code/inspircd.git] / include / base.h
index e75b4029fe27903f56b03617a57ed264c1f37c0d..98ce20fd5485feee477181ddd2cb9b4f93e2c0d5 100644 (file)
@@ -1,21 +1,34 @@
-/*       +------------------------------------+
- *       | Inspire Internet Relay Chat Daemon |
- *       +------------------------------------+
+/*
+ * InspIRCd -- Internet Relay Chat Daemon
  *
- *  InspIRCd: (C) 2002-2010 InspIRCd Development Team
- * See: http://wiki.inspircd.org/Credits
+ *   Copyright (C) 2020 Matt Schatz <genius3000@g3k.solutions>
+ *   Copyright (C) 2013, 2015 Attila Molnar <attilamolnar@hush.com>
+ *   Copyright (C) 2012-2013, 2017, 2020 Sadie Powell <sadie@witchery.services>
+ *   Copyright (C) 2012 Robby <robby@chatbelgie.be>
+ *   Copyright (C) 2012 ChrisTX <xpipe@hotmail.de>
+ *   Copyright (C) 2011-2012 Adam <Adam@anope.org>
+ *   Copyright (C) 2009-2010 Daniel De Graaf <danieldg@inspircd.org>
+ *   Copyright (C) 2007 Oliver Lupton <om@inspircd.org>
+ *   Copyright (C) 2007 Dennis Friis <peavey@inspircd.org>
+ *   Copyright (C) 2006, 2010 Craig Edwards <brain@inspircd.org>
  *
- * 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 <http://www.gnu.org/licenses/>.
  */
 
-#ifndef __BASE_H__
-#define __BASE_H__
 
-#include <map>
-#include <deque>
+#pragma once
+
+#include "compat.h"
 #include <string>
 
 /** Dummy class to help enforce culls being parent-called up to classbase */
@@ -52,11 +65,12 @@ class CoreExport interfacebase
 {
  public:
        interfacebase() {}
+       static inline void* operator new(size_t, void* m) { return m; }
  private:
        interfacebase(const interfacebase&);
        void operator=(const interfacebase&);
-       void* operator new(size_t);
-       void operator delete(void*);
+       static void* operator new(size_t);
+       static void operator delete(void*);
 };
 
 /** The base class for inspircd classes that support reference counting.
@@ -79,8 +93,9 @@ class CoreExport refcountbase
        refcountbase();
        virtual ~refcountbase();
        inline unsigned int GetReferenceCount() const { return refcount; }
-       void* operator new(size_t);
-       void operator delete(void*);
+       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:
@@ -131,15 +146,33 @@ class reference
                if (value && value->refcount_dec())
                        delete value;
        }
-       inline operator bool() const { return value; }
+
+       inline reference<T>& 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<T>& other) const { return value < other.value; }
        inline bool operator>(const reference<T>& other) const { return value > other.value; }
+       static inline void* operator new(size_t, void* m) { return m; }
  private:
-       void* operator new(size_t);
-       void operator delete(void*);
+#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.
@@ -157,36 +190,35 @@ 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:
@@ -206,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 */
@@ -220,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();
+};