Main Page | Namespace List | Class Hierarchy | Alphabetical List | Class List | Directories | File List | Namespace Members | Class Members | File Members

home » brain » inspircd-cvs » 1_1_stable » include

configreader.h File Reference

#include <sstream>
#include <string>
#include <vector>
#include <map>
#include "inspircd.h"
#include "globals.h"
#include "modules.h"
#include "socketengine.h"
#include "socket.h"

Include dependency graph for configreader.h:

This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Classes
class	ValueItem
	Holds a config value, either string, integer or boolean. More...
class	ValueContainerBase
	The base class of the container 'ValueContainer' used internally by the core to hold core values. More...
class	ValueContainer< T >
	ValueContainer is used to contain pointers to different core values such as the server name, maximum number of clients etc. More...
struct	InitialConfig
	Holds a core configuration item and its callbacks. More...
struct	MultiConfig
	Holds a core configuration item and its callbacks where there may be more than one item. More...
class	ServerConfig
	This class holds the bulk of the runtime configuration for the ircd. More...
Defines
#define	CHANOPS_EXEMPT(s, m)   (s->Config->ExemptChanOps[(unsigned char)m])
	Determines if a channel op is exempt from given mode m, in config of server instance s.
Typedefs
typedef ValueContainer< bool * >	ValueContainerBool
	A specialization of ValueContainer to hold a pointer to a bool.
typedef ValueContainer< unsigned int * >	ValueContainerUInt
	A specialization of ValueContainer to hold a pointer to an unsigned int.
typedef ValueContainer< char * >	ValueContainerChar
	A specialization of ValueContainer to hold a pointer to a char array.
typedef ValueContainer< int * >	ValueContainerInt
	A specialization of ValueContainer to hold a pointer to an int.
typedef std::deque< ValueItem >	ValueList
	A set of ValueItems used by multi-value validator functions.
typedef bool(*	Validator )(ServerConfig *conf, const char *, const char *, ValueItem &)
	A callback for validating a single value.
typedef bool(*	MultiValidator )(ServerConfig *conf, const char *, char **, ValueList &, int *)
	A callback for validating multiple value entries.
typedef bool(*	MultiNotify )(ServerConfig *conf, const char *)
	A callback indicating the end of a group of entries.
typedef std::map< irc::string, char * >	opertype_t
	A set of oper types.
typedef std::map< irc::string, char * >	operclass_t
	A Set of oper classes.
Enumerations
enum	ConfigDataType {   DT_NOTHING = 0, DT_INTEGER = 1, DT_CHARPTR = 2, DT_BOOLEAN = 3,   DT_ALLOW_NEWLINE = 128 }
	Types of data in the core config. More...
Functions
CoreExport bool	InitializeDisabledCommands (const char *data, InspIRCd *ServerInstance)
	Initialize the disabled commands list.
bool	InitTypes (ServerConfig *conf, const char *tag)
	Initialize the oper types.
bool	InitClasses (ServerConfig *conf, const char *tag)
	Initialize the oper classes.
bool	DoType (ServerConfig *conf, const char *tag, char **entries, ValueList &values, int *types)
	Initialize an oper type.
bool	DoClass (ServerConfig *conf, const char *tag, char **entries, ValueList &values, int *types)
	Initialize an oper class.
bool	DoneClassesAndTypes (ServerConfig *conf, const char *tag)
	Finish initializing the oper types and classes.

---

Define Documentation

#define CHANOPS_EXEMPT (  s, m   )     (s->Config->ExemptChanOps[(unsigned char)m])

Determines if a channel op is exempt from given mode m, in config of server instance s. Definition at line 22 of file configreader.h. Referenced by ModuleStripColor::OnUserPreMessage(), ModuleBlockColour::OnUserPreMessage(), ModuleNoNickChange::OnUserPreNick(), ModuleNickFlood::OnUserPreNick(), ModuleMsgFlood::ProcessMessages(), and ModuleChanFilter::ProcessMessages().

---

Typedef Documentation

typedef bool(* MultiNotify)(ServerConfig *conf, const char *)

A callback indicating the end of a group of entries. Definition at line 157 of file configreader.h.

typedef bool(* MultiValidator)(ServerConfig *conf, const char *, char **, ValueList &, int *)

A callback for validating multiple value entries. Definition at line 154 of file configreader.h.

typedef std::map<irc::string,char*> operclass_t

A Set of oper classes. Definition at line 204 of file configreader.h.

typedef std::map<irc::string,char*> opertype_t

A set of oper types. Definition at line 200 of file configreader.h.

typedef bool(* Validator)(ServerConfig *conf, const char *, const char *, ValueItem &)

A callback for validating a single value. Definition at line 151 of file configreader.h.

typedef ValueContainer<bool*> ValueContainerBool

A specialization of ValueContainer to hold a pointer to a bool. Definition at line 128 of file configreader.h.

typedef ValueContainer<char*> ValueContainerChar

A specialization of ValueContainer to hold a pointer to a char array. Definition at line 138 of file configreader.h.

typedef ValueContainer<int*> ValueContainerInt

A specialization of ValueContainer to hold a pointer to an int. Definition at line 143 of file configreader.h.

typedef ValueContainer<unsigned int*> ValueContainerUInt

A specialization of ValueContainer to hold a pointer to an unsigned int. Definition at line 133 of file configreader.h.

typedef std::deque<ValueItem> ValueList

A set of ValueItems used by multi-value validator functions. Definition at line 147 of file configreader.h.

---

Enumeration Type Documentation

enum ConfigDataType

Types of data in the core config. Enumerator: DT_NOTHING  DT_INTEGER  DT_CHARPTR  DT_BOOLEAN  DT_ALLOW_NEWLINE  Definition at line 41 of file configreader.h. { DT_NOTHING = 0, /* No data */ DT_INTEGER = 1, /* Integer */ DT_CHARPTR = 2, /* Char pointer */ DT_BOOLEAN = 3, /* Boolean */ DT_ALLOW_NEWLINE = 128 /* New line characters allowed */ };

---

Function Documentation

bool DoClass (  ServerConfig *  conf, const char *  tag, char **  entries, ValueList &  values, int *  types )

Initialize an oper class. Definition at line 68 of file users.cpp. References ServerConfig::operclass, and strnewdup(). Referenced by ServerConfig::Read(). { const char* ClassName = values[0].GetString(); const char* CommandList = values[1].GetString(); conf->operclass[ClassName] = strnewdup(CommandList); return true; }

bool DoneClassesAndTypes (  ServerConfig *  conf, const char *  tag )

Finish initializing the oper types and classes. Definition at line 77 of file users.cpp. Referenced by ServerConfig::Read(). { return true; }

bool DoType (  ServerConfig *  conf, const char *  tag, char **  entries, ValueList &  values, int *  types )

Initialize an oper type. Definition at line 59 of file users.cpp. References ServerConfig::opertypes, and strnewdup(). Referenced by ServerConfig::Read(). { const char* TypeName = values[0].GetString(); const char* Classes = values[1].GetString(); conf->opertypes[TypeName] = strnewdup(Classes); return true; }

bool InitClasses (  ServerConfig *  conf, const char *  tag )

Initialize the oper classes. Definition at line 44 of file users.cpp. References ServerConfig::operclass. Referenced by ServerConfig::Read(). { if (conf->operclass.size()) { for (operclass_t::iterator n = conf->operclass.begin(); n != conf->operclass.end(); n++) { if (n->second) delete[] n->second; } } conf->operclass.clear(); return true; }

CoreExport bool InitializeDisabledCommands (  const char *  data, InspIRCd *  ServerInstance )

Initialize the disabled commands list. Definition at line 199 of file configreader.cpp. References CommandParser::cmdlist, and InspIRCd::Parser. Referenced by cmd_rehash::Handle(), InspIRCd::InspIRCd(), ModuleSpanningTree::OnRehash(), and TreeSocket::RemoteRehash(). { std::stringstream dcmds(data); std::string thiscmd; /* Enable everything first */ for (command_table::iterator x = ServerInstance->Parser->cmdlist.begin(); x != ServerInstance->Parser->cmdlist.end(); x++) x->second->Disable(false); /* Now disable all the ones which the user wants disabled */ while (dcmds >> thiscmd) { command_table::iterator cm = ServerInstance->Parser->cmdlist.find(thiscmd); if (cm != ServerInstance->Parser->cmdlist.end()) { cm->second->Disable(true); } } return true; }

bool InitTypes (  ServerConfig *  conf, const char *  tag )

Initialize the oper types. Definition at line 29 of file users.cpp. References ServerConfig::opertypes. Referenced by ServerConfig::Read(). { if (conf->opertypes.size()) { for (opertype_t::iterator n = conf->opertypes.begin(); n != conf->opertypes.end(); n++) { if (n->second) delete[] n->second; } } conf->opertypes.clear(); return true; }