#include <deque>
#include <string>
-/** 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.
-*/
+/** 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 void cull();
+ /**
+ * 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&);
};
-/** 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() {}
+ private:
+ interfacebase(const interfacebase&);
+ void operator=(const interfacebase&);
+ void* operator new(size_t);
+ 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 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);
+/** 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<type> 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&);
+};
- /** Compare two BoolSets
- */
- bool operator==(BoolSet other);
+class CoreExport reference_base
+{
+ protected:
+ template<typename T> static inline unsigned int inc(T* v) { return ++(v->refcount); }
+ template<typename T> static inline unsigned int dec(T* v) { return --(v->refcount); }
- /** OR two BoolSets together
- */
- BoolSet operator|(BoolSet other);
+};
- /** AND two BoolSets together
- */
- BoolSet operator&(BoolSet other);
+template <typename T>
+class reference : public reference_base
+{
+ T* value;
+ public:
+ reference() : value(0) { }
+ reference(T* v) : value(v) { if (value) inc(value); }
+ reference(const reference<T>& v) : value(v.value) { if (value) inc(value); }
+ reference<T>& operator=(const reference<T>& other)
+ {
+ if (other.value)
+ inc(other.value);
+ this->reference::~reference();
+ value = other.value;
+ return *this;
+ }
- /** Assign one BoolSet to another
- */
- bool operator=(BoolSet other);
+ ~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<T>& other) const { return value < other.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; }
+ inline bool operator!=(const reference<T>& 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.
}
};
+class Module;
+
class CoreExport ModuleException : public CoreException
{
public:
- /** Default constructor, just uses the error mesage 'Module threw an exception'.
- */
- ModuleException() : CoreException("Module threw an exception", "A Module") {}
-
/** This constructor can be used to specify an error message before throwing.
*/
- 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 ~ModuleException() throw() {};
+ ModuleException(const std::string &message, Module* me = NULL);
+};
+
+/** Module reference, similar to reference<Module>
+ */
+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
projects / user / henk / code / inspircd.git / blobdiff