Main Page   Namespace List   Class Hierarchy   Alphabetical List   Compound List   File List   Compound Members   File Members  

modules.h File Reference

#include "dynamic.h"
#include "base.h"
#include "ctables.h"
#include <string>
#include <deque>
#include <sstream>

Include dependency graph for modules.h:

Include dependency graph

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

Included by dependency graph

Go to the source code of this file.

Compounds

class  Admin
 Holds /ADMIN data This class contains the admin details of the local server. More...

class  ConfigReader
 Allows reading of values from configuration files This class allows a module to read from either the main configuration file (inspircd.conf) or from a module-specified configuration file. More...

class  FileReader
 Caches a text file into memory and can be used to retrieve lines from it. More...

class  Module
 Base class for all InspIRCd modules This class is the base class for InspIRCd modules. More...

class  ModuleFactory
 Instantiates classes inherited from Module This class creates a class inherited from type Module, using new. More...

class  Server
 Allows server output and query functions This class contains methods which allow a module to query the state of the irc server, and produce output to users and other servers. More...

class  Version
 Holds a module's Version information The four members (set by the constructor only) indicate details as to the version number of a module. More...


Defines

#define DEBUG   10
#define VERBOSE   20
#define DEFAULT   30
#define SPARSE   40
#define NONE   50
#define MT_CHANNEL   1
#define MT_CLIENT   2
#define MT_SERVER   3
#define ACR_DEFAULT   0
#define ACR_DENY   1
#define ACR_ALLOW   2
#define AC_KICK   0
#define AC_DEOP   1
#define AC_OP   2
#define AC_VOICE   3
#define AC_DEVOICE   4
#define AC_HALFOP   5
#define AC_DEHALFOP   6
#define AC_INVITE   7
#define AC_GENERAL_MODE   8
#define FOREACH_MOD   for (int i = 0; i <= MODCOUNT; i++) modules[i]->
#define FOREACH_RESULT(x)
#define CONF_NOT_A_NUMBER   0x000010
#define CONF_NOT_UNSIGNED   0x000080
#define CONF_VALUE_NOT_FOUND   0x000100
#define CONF_FILE_NOT_FOUND   0x000200

Typedefs

typedef std::deque< std::string > file_cache
 Low level definition of a FileReader classes file cache area.

typedef file_cache string_list
typedef std::deque< userrec * > chanuserlist
 Holds a list of users in a channel.

typedef DLLFactory< ModuleFactoryircd_module

Functions

void createcommand (char *cmd, handlerfunc f, char flags, int minparams)
void server_mode (char **parameters, int pcnt, userrec *user)


Define Documentation

#define AC_DEHALFOP   6
 

Definition at line 37 of file modules.h.

#define AC_DEOP   1
 

Definition at line 32 of file modules.h.

#define AC_DEVOICE   4
 

Definition at line 35 of file modules.h.

#define AC_GENERAL_MODE   8
 

Definition at line 39 of file modules.h.

#define AC_HALFOP   5
 

Definition at line 36 of file modules.h.

#define AC_INVITE   7
 

Definition at line 38 of file modules.h.

#define AC_KICK   0
 

Definition at line 31 of file modules.h.

#define AC_OP   2
 

Definition at line 33 of file modules.h.

#define AC_VOICE   3
 

Definition at line 34 of file modules.h.

#define ACR_ALLOW   2
 

Definition at line 29 of file modules.h.

#define ACR_DEFAULT   0
 

Definition at line 27 of file modules.h.

Referenced by Module::OnAccessCheck().

#define ACR_DENY   1
 

Definition at line 28 of file modules.h.

#define CONF_FILE_NOT_FOUND   0x000200
 

Definition at line 610 of file modules.h.

Referenced by ConfigReader::ConfigReader().

#define CONF_NOT_A_NUMBER   0x000010
 

Definition at line 607 of file modules.h.

Referenced by ConfigReader::ReadInteger().

#define CONF_NOT_UNSIGNED   0x000080
 

Definition at line 608 of file modules.h.

Referenced by ConfigReader::ReadInteger().

#define CONF_VALUE_NOT_FOUND   0x000100
 

Definition at line 609 of file modules.h.

Referenced by ConfigReader::ReadFlag(), ConfigReader::ReadInteger(), and ConfigReader::ReadValue().

#define DEBUG   10
 

Definition at line 13 of file modules.h.

#define DEFAULT   30
 

Definition at line 15 of file modules.h.

#define FOREACH_MOD   for (int i = 0; i <= MODCOUNT; i++) modules[i]->
 

Definition at line 62 of file modules.h.

#define FOREACH_RESULT  
 

Value:

{ MOD_RESULT = 0; \
                        for (int i = 0; i <= MODCOUNT; i++) { \
                        int res = modules[i]->x ; \
                        if (res != 0) { \
                                MOD_RESULT = res; \
                                break; \
                        } \
                } \
        }

Definition at line 70 of file modules.h.

#define MT_CHANNEL   1
 

Definition at line 21 of file modules.h.

Referenced by ModeMakeList().

#define MT_CLIENT   2
 

Definition at line 22 of file modules.h.

Referenced by Server::AddExtendedMode().

#define MT_SERVER   3
 

Definition at line 23 of file modules.h.

Referenced by Server::AddExtendedMode().

#define NONE   50
 

Definition at line 17 of file modules.h.

#define SPARSE   40
 

Definition at line 16 of file modules.h.

#define VERBOSE   20
 

Definition at line 14 of file modules.h.


Typedef Documentation

typedef std::deque<userrec*> chanuserlist
 

Holds a list of users in a channel.

Definition at line 55 of file modules.h.

Referenced by Server::GetUsers().

typedef std::deque<std::string> file_cache
 

Low level definition of a FileReader classes file cache area.

Definition at line 50 of file modules.h.

Referenced by FileReader::FileReader(), and FileReader::LoadFile().

typedef DLLFactory<ModuleFactory> ircd_module
 

Definition at line 767 of file modules.h.

typedef file_cache string_list
 

Definition at line 51 of file modules.h.

Referenced by Module::OnChannelSync(), and Module::OnUserSync().


Function Documentation

void createcommand char *    cmd,
handlerfunc    f,
char    flags,
int    minparams
 

Referenced by Server::AddCommand().

void server_mode char **    parameters,
int    pcnt,
userrec   user
 

Referenced by Server::SendMode().


Generated on Sun May 2 00:09:26 2004 for InspIRCd by doxygen1.3-rc3