From cd9f9a8add02597a2998ba74b803ed3fbf81314c Mon Sep 17 00:00:00 2001 From: brain Date: Sun, 27 Nov 2005 01:44:46 +0000 Subject: Added new documentation git-svn-id: http://svn.inspircd.org/repository/trunk/inspircd@1966 e03df62e-2008-0410-955e-edbf42e46eb7 --- docs/module-doc/classConfigReader.html | 632 ++++++++++++++++----------------- 1 file changed, 312 insertions(+), 320 deletions(-) (limited to 'docs/module-doc/classConfigReader.html') diff --git a/docs/module-doc/classConfigReader.html b/docs/module-doc/classConfigReader.html index 8c0b0a5f1..331390141 100644 --- a/docs/module-doc/classConfigReader.html +++ b/docs/module-doc/classConfigReader.html @@ -1,97 +1,96 @@ - + -InspIRCd: ConfigReader class Reference +InspIRCd: ConfigReader Class Reference - -
Main Page | Namespace List | Class Hierarchy | Alphabetical List | Compound List | File List | Namespace Members | Compound Members | File Members
-

ConfigReader Class Reference

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. + +
Main Page | Namespace List | Class Hierarchy | Alphabetical List | Class List | Directories | File List | Namespace Members | Class Members | File Members
+

ConfigReader Class Reference

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...

#include <modules.h>

Inheritance diagram for ConfigReader:

Inheritance graph
- +
[legend]
Collaboration diagram for ConfigReader:

Collaboration graph
- + -
[legend]
List of all members. +
[legend]
List of all members.
- - + + - - + + - - + + - - + + - - + + - - + + - - + + - - + + - - + + - - + + - - + + - - - + + + - - + + - + - - + +

Public Member Functions

 ConfigReader ()

Public Member Functions

 ConfigReader ()
 Default constructor.

 ConfigReader (std::string filename)
 Default constructor.
 ConfigReader (std::string filename)
 Overloaded constructor.

 ~ConfigReader ()
 Overloaded constructor.
 ~ConfigReader ()
 Default destructor.

std::string ReadValue (std::string tag, std::string name, int index)
 Default destructor.
std::string ReadValue (std::string tag, std::string name, int index)
 Retrieves a value from the config file.

bool ReadFlag (std::string tag, std::string name, int index)
 Retrieves a value from the config file.
bool ReadFlag (std::string tag, std::string name, int index)
 Retrieves a boolean value from the config file.

long ReadInteger (std::string tag, std::string name, int index, bool needs_unsigned)
 Retrieves a boolean value from the config file.
long ReadInteger (std::string tag, std::string name, int index, bool needs_unsigned)
 Retrieves an integer value from the config file.

long GetError ()
 Retrieves an integer value from the config file.
long GetError ()
 Returns the last error to occur.

int Enumerate (std::string tag)
 Returns the last error to occur.
int Enumerate (std::string tag)
 Counts the number of times a given tag appears in the config file.

bool Verify ()
 Counts the number of times a given tag appears in the config file.
bool Verify ()
 Returns true if a config file is valid.

void DumpErrors (bool bail, userrec *user)
 Returns true if a config file is valid.
void DumpErrors (bool bail, userrec *user)
 Dumps the list of errors in a config file to an output location.

int EnumerateValues (std::string tag, int index)
 Dumps the list of errors in a config file to an output location.
int EnumerateValues (std::string tag, int index)
 Returns the number of items within a tag.


Protected Attributes

std::stringstream * cache
 Returns the number of items within a tag.

Protected Attributes

std::stringstream * cache
 The contents of the configuration file This protected member should never be accessed by a module (and cannot be accessed unless the core is changed).

std::stringstream * errorlog
 The contents of the configuration file This protected member should never be accessed by a module (and cannot be accessed unless the core is changed).
std::stringstream * errorlog
bool readerror
bool readerror
 Used to store errors.

long error
 Used to store errors.
long error

Detailed Description

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.

-It may either be instantiated with one parameter or none. Constructing the class using one parameter allows you to specify a path to your own configuration file, otherwise, inspircd.conf is read. +It may either be instantiated with one parameter or none. Constructing the class using one parameter allows you to specify a path to your own configuration file, otherwise, inspircd.conf is read.

-Definition at line 1150 of file modules.h.

Constructor & Destructor Documentation

-

- +Definition at line 1121 of file modules.h.

Constructor & Destructor Documentation

+

+

- + -
ConfigReader::ConfigReader ConfigReader::ConfigReader (   ) 
- +
+
  @@ -103,40 +102,39 @@ Default constructor.

This constructor initialises the ConfigReader class to read the inspircd.conf file as specified when running ./configure.

-Definition at line 821 of file modules.cpp. +Definition at line 796 of file modules.cpp.

-References cache, CONF_FILE_NOT_FOUND, error, errorlog, include_stack, and readerror. +References cache, CONF_FILE_NOT_FOUND, error, errorlog, include_stack, and readerror.

00797 {
+00798         include_stack.clear();
+00799         this->cache = new std::stringstream(std::stringstream::in | std::stringstream::out);
+00800         this->errorlog = new std::stringstream(std::stringstream::in | std::stringstream::out);
+00801         this->readerror = LoadConf(CONFIG_FILE,this->cache,this->errorlog);
+00802         if (!this->readerror)
+00803                 this->error = CONF_FILE_NOT_FOUND;
+00804 }
+

-

00822 {
-00823         include_stack.clear();
-00824         this->cache = new std::stringstream(std::stringstream::in | std::stringstream::out);
-00825         this->errorlog = new std::stringstream(std::stringstream::in | std::stringstream::out);
-00826         this->readerror = LoadConf(CONFIG_FILE,this->cache,this->errorlog);
-00827         if (!this->readerror)
-00828                 this->error = CONF_FILE_NOT_FOUND;
-00829 }
-
-

- +

+

- + - + -
ConfigReader::ConfigReader ConfigReader::ConfigReader ( std::string std::string  filename  ) 
- +
+
  @@ -148,38 +146,37 @@ Overloaded constructor.

This constructor initialises the ConfigReader class to read a user-specified config file

-Definition at line 841 of file modules.cpp. +Definition at line 816 of file modules.cpp.

-References cache, CONF_FILE_NOT_FOUND, error, errorlog, and readerror. +References cache, CONF_FILE_NOT_FOUND, error, errorlog, and readerror.

00817 {
+00818         this->cache = new std::stringstream(std::stringstream::in | std::stringstream::out);
+00819         this->errorlog = new std::stringstream(std::stringstream::in | std::stringstream::out);
+00820         this->readerror = LoadConf(filename.c_str(),this->cache,this->errorlog);
+00821         if (!this->readerror)
+00822                 this->error = CONF_FILE_NOT_FOUND;
+00823 };
+

-

00842 {
-00843         this->cache = new std::stringstream(std::stringstream::in | std::stringstream::out);
-00844         this->errorlog = new std::stringstream(std::stringstream::in | std::stringstream::out);
-00845         this->readerror = LoadConf(filename.c_str(),this->cache,this->errorlog);
-00846         if (!this->readerror)
-00847                 this->error = CONF_FILE_NOT_FOUND;
-00848 };
-
-

- +

+

- + -
ConfigReader::~ConfigReader ConfigReader::~ConfigReader (   ) 
- +
+
  @@ -191,48 +188,47 @@ Default destructor.

This method destroys the ConfigReader class.

-Definition at line 832 of file modules.cpp. +Definition at line 807 of file modules.cpp.

-References cache, and errorlog. +References cache, and errorlog.

00808 {
+00809         if (this->cache)
+00810                 delete this->cache;
+00811         if (this->errorlog)
+00812                 delete this->errorlog;
+00813 }
+

-

00833 {
-00834         if (this->cache)
-00835                 delete this->cache;
-00836         if (this->errorlog)
-00837                 delete this->errorlog;
-00838 }
-

Member Function Documentation

-

- +

+

- + - - + + - + -
void ConfigReader::DumpErrors void ConfigReader::DumpErrors (  bool  bail,
userrec *  user
) 
- +
+Definition at line 894 of file modules.cpp. +

+References errorlog, connection::fd, and userrec::nick.

00895 {
+00896         if (bail)
+00897         {
+00898                 printf("There were errors in your configuration:\n%s",errorlog->str().c_str());
+00899                 exit(0);
+00900         }
+00901         else
+00902         {
+00903                 char dataline[1024];
+00904                 if (user)
+00905                 {
+00906                         WriteServ(user->fd,"NOTICE %s :There were errors in the configuration file:",user->nick);
+00907                         while (!errorlog->eof())
+00908                         {
+00909                                 errorlog->getline(dataline,1024);
+00910                                 WriteServ(user->fd,"NOTICE %s :%s",user->nick,dataline);
+00911                         }
+00912                 }
+00913                 else
+00914                 {
+00915                         WriteOpers("There were errors in the configuration file:",user->nick);
+00916                         while (!errorlog->eof())
+00917                         {
+00918                                 errorlog->getline(dataline,1024);
+00919                                 WriteOpers(dataline);
+00920                         }
+00921                 }
+00922                 return;
+00923         }
+00924 }
+
+

+

  @@ -244,62 +240,61 @@ Dumps the list of errors in a config file to an output location.

If bail is true, then the program will abort. If bail is false and user points to a valid user record, the error report will be spooled to the given user by means of NOTICE. if bool is false AND user is false, the error report will be spooled to all opers by means of a NOTICE to all opers.

-Definition at line 919 of file modules.cpp. -

-References errorlog, connection::fd, and userrec::nick. -

-

00920 {
-00921         if (bail)
-00922         {
-00923                 printf("There were errors in your configuration:\n%s",errorlog->str().c_str());
-00924                 exit(0);
-00925         }
-00926         else
-00927         {
-00928                 char dataline[1024];
-00929                 if (user)
-00930                 {
-00931                         WriteServ(user->fd,"NOTICE %s :There were errors in the configuration file:",user->nick);
-00932                         while (!errorlog->eof())
-00933                         {
-00934                                 errorlog->getline(dataline,1024);
-00935                                 WriteServ(user->fd,"NOTICE %s :%s",user->nick,dataline);
-00936                         }
-00937                 }
-00938                 else
-00939                 {
-00940                         WriteOpers("There were errors in the configuration file:",user->nick);
-00941                         while (!errorlog->eof())
-00942                         {
-00943                                 errorlog->getline(dataline,1024);
-00944                                 WriteOpers(dataline);
-00945                         }
-00946                 }
-00947                 return;
-00948         }
-00949 }
-
-

- +

+

- + - + -
int ConfigReader::Enumerate int ConfigReader::Enumerate ( std::string std::string  tag  ) 
- +
+
  @@ -309,46 +304,45 @@ References errorlog, Counts the number of times a given tag appears in the config file.

-This method counts the number of times a tag appears in a config file, for use where there are several tags of the same kind, e.g. with opers and connect types. It can be used with the index value of ConfigReader::ReadValue to loop through all copies of a multiple instance tag. +This method counts the number of times a tag appears in a config file, for use where there are several tags of the same kind, e.g. with opers and connect types. It can be used with the index value of ConfigReader::ReadValue to loop through all copies of a multiple instance tag.

-Definition at line 952 of file modules.cpp. +Definition at line 927 of file modules.cpp.

-References cache. +References cache.

00928 {
+00929         return EnumConf(cache,tag.c_str());
+00930 }
+

-

00953 {
-00954         return EnumConf(cache,tag.c_str());
-00955 }
-
-

- +

+

- + - + - - + + - + -
int ConfigReader::EnumerateValues int ConfigReader::EnumerateValues ( std::string std::string  tag,
int  index
) 
- +
+
  @@ -360,34 +354,33 @@ Returns the number of items within a tag.

For example if the tag was <test tag="blah" data="foo"> then this function would return 2. Spaces and newlines both qualify as valid seperators between values.

-Definition at line 957 of file modules.cpp. +Definition at line 932 of file modules.cpp.

-References cache. +References cache.

00933 {
+00934         return EnumValues(cache, tag.c_str(), index);
+00935 }
+

-

00958 {
-00959         return EnumValues(cache, tag.c_str(), index);
-00960 }
-
-

- +

+

- + -
long ConfigReader::GetError long ConfigReader::GetError (   ) 
- +
+
  @@ -397,54 +390,53 @@ References cache.

Returns the last error to occur.

-Valid errors can be found by looking in modules.h. Any nonzero value indicates an error condition. A call to GetError() resets the error flag back to 0. +Valid errors can be found by looking in modules.h. Any nonzero value indicates an error condition. A call to GetError() resets the error flag back to 0.

-Definition at line 912 of file modules.cpp. +Definition at line 887 of file modules.cpp.

-References error. +References error.

00888 {
+00889         long olderr = this->error;
+00890         this->error = 0;
+00891         return olderr;
+00892 }
+

-

00913 {
-00914         long olderr = this->error;
-00915         this->error = 0;
-00916         return olderr;
-00917 }
-
-

- +

+

- + - + - - - + + + - - + + - + -
bool ConfigReader::ReadFlag bool ConfigReader::ReadFlag ( std::string std::string  tag,
std::string std::string  name,
int  index
) 
- +
+Definition at line 841 of file modules.cpp. +

+References cache, CONF_VALUE_NOT_FOUND, and error.

00842 {
+00843         char val[MAXBUF];
+00844         char t[MAXBUF];
+00845         char n[MAXBUF];
+00846         strlcpy(t,tag.c_str(),MAXBUF);
+00847         strlcpy(n,name.c_str(),MAXBUF);
+00848         int res = ReadConf(cache,t,n,index,val);
+00849         if (!res)
+00850         {
+00851                 this->error = CONF_VALUE_NOT_FOUND;
+00852                 return false;
+00853         }
+00854         std::string s = val;
+00855         return ((s == "yes") || (s == "YES") || (s == "true") || (s == "TRUE") || (s == "1"));
+00856 }
+
+

+

  @@ -456,68 +448,67 @@ Retrieves a boolean value from the config file.

This method retrieves a boolean value from the config file. Where multiple copies of the tag exist in the config file, index indicates which of the values to retrieve. The values "1", "yes" and "true" in the config file count as true to ReadFlag, and any other value counts as false.

-Definition at line 866 of file modules.cpp. -

-References cache, CONF_VALUE_NOT_FOUND, and error. -

-

00867 {
-00868         char val[MAXBUF];
-00869         char t[MAXBUF];
-00870         char n[MAXBUF];
-00871         strlcpy(t,tag.c_str(),MAXBUF);
-00872         strlcpy(n,name.c_str(),MAXBUF);
-00873         int res = ReadConf(cache,t,n,index,val);
-00874         if (!res)
-00875         {
-00876                 this->error = CONF_VALUE_NOT_FOUND;
-00877                 return false;
-00878         }
-00879         std::string s = val;
-00880         return ((s == "yes") || (s == "YES") || (s == "true") || (s == "TRUE") || (s == "1"));
-00881 }
-
-

- +

+

- + - + - - - + + + - - + + - - + + - + -
long ConfigReader::ReadInteger long ConfigReader::ReadInteger ( std::string std::string  tag,
std::string std::string  name,
int  index,
bool  needs_unsigned
) 
- +
+This method retrieves an integer value from the config file. Where multiple copies of the tag exist in the config file, index indicates which of the values to retrieve. Any invalid integer values in the tag will cause the objects error value to be set, and any call to GetError() will return CONF_INVALID_NUMBER to be returned. needs_unsigned is set if the number must be unsigned. If a signed number is placed into a tag which is specified unsigned, 0 will be returned and GetError() will return CONF_NOT_UNSIGNED +

+Definition at line 858 of file modules.cpp. +

+References cache, CONF_NOT_A_NUMBER, CONF_NOT_UNSIGNED, CONF_VALUE_NOT_FOUND, and error.

00859 {
+00860         char val[MAXBUF];
+00861         char t[MAXBUF];
+00862         char n[MAXBUF];
+00863         strlcpy(t,tag.c_str(),MAXBUF);
+00864         strlcpy(n,name.c_str(),MAXBUF);
+00865         int res = ReadConf(cache,t,n,index,val);
+00866         if (!res)
+00867         {
+00868                 this->error = CONF_VALUE_NOT_FOUND;
+00869                 return 0;
+00870         }
+00871         for (unsigned int i = 0; i < strlen(val); i++)
+00872         {
+00873                 if (!isdigit(val[i]))
+00874                 {
+00875                         this->error = CONF_NOT_A_NUMBER;
+00876                         return 0;
+00877                 }
+00878         }
+00879         if ((needs_unsigned) && (atoi(val)<0))
+00880         {
+00881                 this->error = CONF_NOT_UNSIGNED;
+00882                 return 0;
+00883         }
+00884         return atoi(val);
+00885 }
+
+

+

  @@ -527,76 +518,75 @@ References cache, Retrieves an integer value from the config file.

-This method retrieves an integer value from the config file. Where multiple copies of the tag exist in the config file, index indicates which of the values to retrieve. Any invalid integer values in the tag will cause the objects error value to be set, and any call to GetError() will return CONF_INVALID_NUMBER to be returned. needs_unsigned is set if the number must be unsigned. If a signed number is placed into a tag which is specified unsigned, 0 will be returned and GetError() will return CONF_NOT_UNSIGNED -

-Definition at line 883 of file modules.cpp. -

-References cache, CONF_NOT_A_NUMBER, CONF_NOT_UNSIGNED, CONF_VALUE_NOT_FOUND, and error. -

-

00884 {
-00885         char val[MAXBUF];
-00886         char t[MAXBUF];
-00887         char n[MAXBUF];
-00888         strlcpy(t,tag.c_str(),MAXBUF);
-00889         strlcpy(n,name.c_str(),MAXBUF);
-00890         int res = ReadConf(cache,t,n,index,val);
-00891         if (!res)
-00892         {
-00893                 this->error = CONF_VALUE_NOT_FOUND;
-00894                 return 0;
-00895         }
-00896         for (int i = 0; i < strlen(val); i++)
-00897         {
-00898                 if (!isdigit(val[i]))
-00899                 {
-00900                         this->error = CONF_NOT_A_NUMBER;
-00901                         return 0;
-00902                 }
-00903         }
-00904         if ((needs_unsigned) && (atoi(val)<0))
-00905         {
-00906                 this->error = CONF_NOT_UNSIGNED;
-00907                 return 0;
-00908         }
-00909         return atoi(val);
-00910 }
-
-

- +

+

- + - + - - - + + + - - + + - + -
std::string ConfigReader::ReadValue std::string ConfigReader::ReadValue ( std::string std::string  tag,
std::string std::string  name,
int  index
) 
- +
+Definition at line 825 of file modules.cpp. +

+References cache, CONF_VALUE_NOT_FOUND, and error.

00826 {
+00827         char val[MAXBUF];
+00828         char t[MAXBUF];
+00829         char n[MAXBUF];
+00830         strlcpy(t,tag.c_str(),MAXBUF);
+00831         strlcpy(n,name.c_str(),MAXBUF);
+00832         int res = ReadConf(cache,t,n,index,val);
+00833         if (!res)
+00834         {
+00835                 this->error = CONF_VALUE_NOT_FOUND;
+00836                 return "";
+00837         }
+00838         return val;
+00839 }
+
+

+

  @@ -608,45 +598,44 @@ Retrieves a value from the config file.

This method retrieves a value from the config file. Where multiple copies of the tag exist in the config file, index indicates which of the values to retrieve.

-Definition at line 850 of file modules.cpp. -

-References cache, CONF_VALUE_NOT_FOUND, and error. -

-

00851 {
-00852         char val[MAXBUF];
-00853         char t[MAXBUF];
-00854         char n[MAXBUF];
-00855         strlcpy(t,tag.c_str(),MAXBUF);
-00856         strlcpy(n,name.c_str(),MAXBUF);
-00857         int res = ReadConf(cache,t,n,index,val);
-00858         if (!res)
-00859         {
-00860                 this->error = CONF_VALUE_NOT_FOUND;
-00861                 return "";
-00862         }
-00863         return val;
-00864 }
-
-

- +

+

- + -
bool ConfigReader::Verify bool ConfigReader::Verify (   ) 
- +
+
  @@ -658,29 +647,30 @@ Returns true if a config file is valid.

This method is partially implemented and will only return false if the config file does not exist or could not be opened.

-Definition at line 962 of file modules.cpp. +Definition at line 937 of file modules.cpp.

-References readerror. +References readerror.

00938 {
+00939         return this->readerror;
+00940 }
+

-

00963 {
-00964         return this->readerror;
-00965 }
-

Member Data Documentation

-

- +

+

- +
std::stringstream* ConfigReader::cache [protected] + std::stringstream* ConfigReader::cache [protected]
- +
+Referenced by ConfigReader(), Enumerate(), EnumerateValues(), ReadFlag(), ReadInteger(), ReadValue(), and ~ConfigReader().
  @@ -692,23 +682,24 @@ The contents of the configuration file This protected member should never be acc

It will contain a pointer to the configuration file data with unneeded data (such as comments) stripped from it.

-Definition at line 1158 of file modules.h. +Definition at line 1129 of file modules.h.

-Referenced by ConfigReader(), Enumerate(), EnumerateValues(), ReadFlag(), ReadInteger(), ReadValue(), and ~ConfigReader().

-

- +

+

- +
long ConfigReader::error [protected] + long ConfigReader::error [protected]
- +
+Referenced by ConfigReader(), GetError(), ReadFlag(), ReadInteger(), and ReadValue().
  @@ -718,23 +709,24 @@ Referenced by ConfigReader(

-Definition at line 1163 of file modules.h. +Definition at line 1134 of file modules.h.

-Referenced by ConfigReader(), GetError(), ReadFlag(), ReadInteger(), and ReadValue().

-

- +

+

- +
std::stringstream* ConfigReader::errorlog [protected] + std::stringstream* ConfigReader::errorlog [protected]
- +
+Referenced by ConfigReader(), DumpErrors(), and ~ConfigReader().
  @@ -744,23 +736,24 @@ Referenced by ConfigReader(

-Definition at line 1159 of file modules.h. +Definition at line 1130 of file modules.h.

-Referenced by ConfigReader(), DumpErrors(), and ~ConfigReader().

-

- +

+

- +
bool ConfigReader::readerror [protected] + bool ConfigReader::readerror [protected]
- +
+Referenced by ConfigReader(), and Verify().
  @@ -772,16 +765,15 @@ Used to store errors.

-Definition at line 1162 of file modules.h. +Definition at line 1133 of file modules.h.

-Referenced by ConfigReader(), and Verify().

The documentation for this class was generated from the following files: -
Generated on Mon May 30 05:16:42 2005 for InspIRCd by +
Generated on Sun Nov 27 01:43:25 2005 for InspIRCd by  -doxygen -1.3.3
+doxygen 1.4.4-20050815
-- cgit v1.3.1-10-gc9f91