1 /* +------------------------------------+
\r * | Inspire Internet Relay Chat Daemon |
\r * +------------------------------------+
\r *
\r * InspIRCd: (C) 2002-2007 InspIRCd Development Team
\r * See: http://www.inspircd.org/wiki/index.php/Credits
\r *
\r * This program is free but copyrighted software; see
\r * the file COPYING for details.
\r *
\r * ---------------------------------------------------
\r */
\r\r#ifndef __BASE_H__
\r#define __BASE_H__
\r\r#include "inspircd_config.h"
\r#include <time.h>
\r#include <map>
\r#include <deque>
\r#include <string>
\r\r/** Do we use this? -- Brain */
\rtypedef void* VoidPointer;
\r\r/** A private data store for an Extensible class */
\rtypedef std::map<std::string,char*> ExtensibleStore;
\r\r/** Needed */
\rclass InspIRCd;
\r\r/** The base class for all inspircd classes.
\r * Wherever possible, all classes you create should inherit from this,
\r * giving them the ability to be passed to various core functions
\r * as 'anonymous' classes.
\r*/
\rclass CoreExport classbase
\r{
\r public:
\r /** Time that the object was instantiated (used for TS calculation etc)
\r */
\r time_t age;
\r\r /** Constructor.
\r * Sets the object's time
\r */
\r classbase();
\r\r /** Destructor.
\r * Does sweet FA.
\r */
\r ~classbase() { }
\r};
\r\r/** class Extensible is the parent class of many classes such as userrec and chanrec.
\r * class Extensible implements a system which allows modules to 'extend' the class by attaching data within
\r * a map associated with the object. In this way modules can store their own custom information within user
\r * objects, channel objects and server objects, without breaking other modules (this is more sensible than using
\r * a flags variable, and each module defining bits within the flag as 'theirs' as it is less prone to conflict and
\r * supports arbitary data storage).
\r */
\rclass CoreExport Extensible : public classbase
\r{
\r /** Private data store.
\r * Holds all extensible metadata for the class.
\r */
\r ExtensibleStore Extension_Items;
\r \rpublic:
\r\r /** Extend an Extensible class.
\r *
\r * @param key The key parameter is an arbitary string which identifies the extension data
\r * @param p This parameter is a pointer to any data you wish to associate with the object
\r *
\r * You must provide a key to store the data as via the parameter 'key' and store the data
\r * in the templated parameter 'p'.
\r * The data will be inserted into the map. If the data already exists, you may not insert it
\r * twice, Extensible::Extend will return false in this case.
\r *
\r * @return Returns true on success, false if otherwise
\r */
\r template<typename T> bool Extend(const std::string &key, T* p)
\r {
\r /* This will only add an item if it doesnt already exist,
\r * the return value is a std::pair of an iterator to the
\r * element, and a bool saying if it was actually inserted.
\r */
\r return this->Extension_Items.insert(std::make_pair(key, (char*)p)).second;
\r }
\r\r /** Extend an Extensible class.
\r *
\r * @param key The key parameter is an arbitary string which identifies the extension data
\r *
\r * You must provide a key to store the data as via the parameter 'key', this single-parameter
\r * version takes no 'data' parameter, this is used purely for boolean values.
\r * The key will be inserted into the map with a NULL 'data' pointer. If the key already exists
\r * then you may not insert it twice, Extensible::Extend will return false in this case.
\r *
\r * @return Returns true on success, false if otherwise
\r */
\r bool Extend(const std::string &key)
\r {
\r /* This will only add an item if it doesnt already exist,
\r * the return value is a std::pair of an iterator to the
\r * element, and a bool saying if it was actually inserted.
\r */
\r return this->Extension_Items.insert(std::make_pair(key, (char*)NULL)).second;
\r }
\r\r /** Shrink an Extensible class.
\r *
\r * @param key The key parameter is an arbitary string which identifies the extension data
\r *
\r * You must provide a key name. The given key name will be removed from the classes data. If
\r * you provide a nonexistent key (case is important) then the function will return false.
\r * @return Returns true on success.
\r */
\r bool Shrink(const std::string &key);
\r \r /** Get an extension item.
\r *
\r * @param key The key parameter is an arbitary string which identifies the extension data
\r * @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.
\r * @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.
\r */
\r template<typename T> bool GetExt(const std::string &key, T* &p)
\r {
\r ExtensibleStore::iterator iter = this->Extension_Items.find(key); /* Find the item */
\r if(iter != this->Extension_Items.end())
\r {
\r p = (T*)iter->second; /* Item found */
\r return true;
\r }
\r else
\r {
\r p = NULL; /* Item not found */
\r return false;
\r }
\r }
\r \r /** Get an extension item.
\r *
\r * @param key The key parameter is an arbitary string which identifies the extension data
\r * @return Returns true if the item was found and false if it was not.
\r *
\r * This single-parameter version only checks if the key exists, it does nothing with
\r * the 'data' field and is probably only useful in conjunction with the single-parameter
\r * version of Extend().
\r */
\r bool GetExt(const std::string &key)
\r {
\r return (this->Extension_Items.find(key) != this->Extension_Items.end());
\r }
\r\r /** Get a list of all extension items names.
\r * @param list A deque of strings to receive the list
\r * @return This function writes a list of all extension items stored in this object by name into the given deque and returns void.
\r */
\r void GetExtList(std::deque<std::string> &list);
\r};
\r\r/** BoolSet is a utility class designed to hold eight bools in a bitmask.
\r * Use BoolSet::Set and BoolSet::Get to set and get bools in the bitmask,
\r * and Unset and Invert for special operations upon them.
\r */
\rclass CoreExport BoolSet : public classbase
\r{
\r /** Actual bit values */
\r char bits;
\r\r public:
\r\r /** The default constructor initializes the BoolSet to all values unset.
\r */
\r BoolSet();
\r\r /** This constructor copies the default bitmask from a char
\r */
\r BoolSet(char bitmask);
\r\r /** The Set method sets one bool in the set.
\r *
\r * @param number The number of the item to set. This must be between 0 and 7.
\r */
\r void Set(int number);
\r\r /** The Get method returns the value of one bool in the set
\r *
\r * @param number The number of the item to retrieve. This must be between 0 and 7.
\r *
\r * @return True if the item is set, false if it is unset.
\r */
\r bool Get(int number);
\r\r /** The Unset method unsets one value in the set
\r *
\r * @param number The number of the item to set. This must be between 0 and 7.
\r */
\r void Unset(int number);
\r\r /** The Unset method inverts (flips) one value in the set
\r *
\r * @param number The number of the item to invert. This must be between 0 and 7.
\r */
\r void Invert(int number);
\r\r /** Compare two BoolSets
\r */
\r bool operator==(BoolSet other);
\r\r /** OR two BoolSets together
\r */
\r BoolSet operator|(BoolSet other);
\r \r /** AND two BoolSets together
\r */
\r BoolSet operator&(BoolSet other);
\r\r /** Assign one BoolSet to another
\r */
\r bool operator=(BoolSet other);
\r};
\r\r\r#endif
\r\r
projects / user / henk / code / inspircd.git / blob