From 4d5a17380bc71cabe544b41c7c8a26a292384f3d Mon Sep 17 00:00:00 2001 From: brain Date: Sun, 15 May 2005 17:05:15 +0000 Subject: Added docs for hashcomp git-svn-id: http://svn.inspircd.org/repository/trunk/inspircd@1396 e03df62e-2008-0410-955e-edbf42e46eb7 --- docs/module-doc/classConfigReader.html | 322 ++++++++++++++++----------------- 1 file changed, 161 insertions(+), 161 deletions(-) (limited to 'docs/module-doc/classConfigReader.html') diff --git a/docs/module-doc/classConfigReader.html b/docs/module-doc/classConfigReader.html index cb2e2e0f5..166aab65b 100644 --- a/docs/module-doc/classConfigReader.html +++ b/docs/module-doc/classConfigReader.html @@ -4,7 +4,7 @@ -
Main Page | Namespace List | Class Hierarchy | Alphabetical List | Compound List | File List | Compound Members | File Members
+
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. More...

@@ -73,7 +73,7 @@ It may either be instantiated with one parameter or none. Constructing the class

-Definition at line 1147 of file modules.h.


Constructor & Destructor Documentation

+Definition at line 1150 of file modules.h.

Constructor & Destructor Documentation

@@ -103,17 +103,17 @@ Default constructor.

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

-Definition at line 870 of file modules.cpp. +Definition at line 799 of file modules.cpp.

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

-

00871 {
-00872         this->cache = new std::stringstream(std::stringstream::in | std::stringstream::out);
-00873         this->errorlog = new std::stringstream(std::stringstream::in | std::stringstream::out);
-00874         this->readerror = LoadConf(CONFIG_FILE,this->cache,this->errorlog);
-00875         if (!this->readerror)
-00876                 this->error = CONF_FILE_NOT_FOUND;
-00877 }
+
00800 {
+00801         this->cache = new std::stringstream(std::stringstream::in | std::stringstream::out);
+00802         this->errorlog = new std::stringstream(std::stringstream::in | std::stringstream::out);
+00803         this->readerror = LoadConf(CONFIG_FILE,this->cache,this->errorlog);
+00804         if (!this->readerror)
+00805                 this->error = CONF_FILE_NOT_FOUND;
+00806 }
 
@@ -147,17 +147,17 @@ Overloaded constructor.

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

-Definition at line 889 of file modules.cpp. +Definition at line 818 of file modules.cpp.

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

-

00890 {
-00891         this->cache = new std::stringstream(std::stringstream::in | std::stringstream::out);
-00892         this->errorlog = new std::stringstream(std::stringstream::in | std::stringstream::out);
-00893         this->readerror = LoadConf(filename.c_str(),this->cache,this->errorlog);
-00894         if (!this->readerror)
-00895                 this->error = CONF_FILE_NOT_FOUND;
-00896 };
+
00819 {
+00820         this->cache = new std::stringstream(std::stringstream::in | std::stringstream::out);
+00821         this->errorlog = new std::stringstream(std::stringstream::in | std::stringstream::out);
+00822         this->readerror = LoadConf(filename.c_str(),this->cache,this->errorlog);
+00823         if (!this->readerror)
+00824                 this->error = CONF_FILE_NOT_FOUND;
+00825 };
 
@@ -190,16 +190,16 @@ Default destructor.

This method destroys the ConfigReader class.

-Definition at line 880 of file modules.cpp. +Definition at line 809 of file modules.cpp.

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

-

00881 {
-00882         if (this->cache)
-00883                 delete this->cache;
-00884         if (this->errorlog)
-00885                 delete this->errorlog;
-00886 }
+
00810 {
+00811         if (this->cache)
+00812                 delete this->cache;
+00813         if (this->errorlog)
+00814                 delete this->errorlog;
+00815 }
 
@@ -243,40 +243,40 @@ 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 967 of file modules.cpp. -

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

-

00968 {
-00969         if (bail)
-00970         {
-00971                 printf("There were errors in your configuration:\n%s",errorlog->str().c_str());
-00972                 exit(0);
-00973         }
-00974         else
-00975         {
-00976                 char dataline[1024];
-00977                 if (user)
-00978                 {
-00979                         WriteServ(user->fd,"NOTICE %s :There were errors in the configuration file:",user->nick);
-00980                         while (!errorlog->eof())
-00981                         {
-00982                                 errorlog->getline(dataline,1024);
-00983                                 WriteServ(user->fd,"NOTICE %s :%s",user->nick,dataline);
-00984                         }
-00985                 }
-00986                 else
-00987                 {
-00988                         WriteOpers("There were errors in the configuration file:",user->nick);
-00989                         while (!errorlog->eof())
-00990                         {
-00991                                 errorlog->getline(dataline,1024);
-00992                                 WriteOpers(dataline);
-00993                         }
-00994                 }
-00995                 return;
-00996         }
-00997 }
+Definition at line 896 of file modules.cpp.
+

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

+

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

-Definition at line 1000 of file modules.cpp. +Definition at line 929 of file modules.cpp.

-References cache. +References cache.

-

01001 {
-01002         return EnumConf(cache,tag.c_str());
-01003 }
+
00930 {
+00931         return EnumConf(cache,tag.c_str());
+00932 }
 
@@ -359,13 +359,13 @@ 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 1005 of file modules.cpp. +Definition at line 934 of file modules.cpp.

-References cache. +References cache.

-

01006 {
-01007         return EnumValues(cache, tag.c_str(), index);
-01008 }
+
00935 {
+00936         return EnumValues(cache, tag.c_str(), index);
+00937 }
 
@@ -398,15 +398,15 @@ 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.

-Definition at line 960 of file modules.cpp. +Definition at line 889 of file modules.cpp.

-References error. +References error.

-

00961 {
-00962         long olderr = this->error;
-00963         this->error = 0;
-00964         return olderr;
-00965 }
+
00890 {
+00891         long olderr = this->error;
+00892         this->error = 0;
+00893         return olderr;
+00894 }
 
@@ -455,25 +455,25 @@ 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 914 of file modules.cpp. -

-References cache, CONF_VALUE_NOT_FOUND, and error. -

-

00915 {
-00916         char val[MAXBUF];
-00917         char t[MAXBUF];
-00918         char n[MAXBUF];
-00919         strlcpy(t,tag.c_str(),MAXBUF);
-00920         strlcpy(n,name.c_str(),MAXBUF);
-00921         int res = ReadConf(cache,t,n,index,val);
-00922         if (!res)
-00923         {
-00924                 this->error = CONF_VALUE_NOT_FOUND;
-00925                 return false;
-00926         }
-00927         std::string s = val;
-00928         return ((s == "yes") || (s == "YES") || (s == "true") || (s == "TRUE") || (s == "1"));
-00929 }
+Definition at line 843 of file modules.cpp.
+

+References cache, CONF_VALUE_NOT_FOUND, and error. +

+

00844 {
+00845         char val[MAXBUF];
+00846         char t[MAXBUF];
+00847         char n[MAXBUF];
+00848         strlcpy(t,tag.c_str(),MAXBUF);
+00849         strlcpy(n,name.c_str(),MAXBUF);
+00850         int res = ReadConf(cache,t,n,index,val);
+00851         if (!res)
+00852         {
+00853                 this->error = CONF_VALUE_NOT_FOUND;
+00854                 return false;
+00855         }
+00856         std::string s = val;
+00857         return ((s == "yes") || (s == "YES") || (s == "true") || (s == "TRUE") || (s == "1"));
+00858 }
 
@@ -528,37 +528,37 @@ 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 931 of file modules.cpp. -

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

-

00932 {
-00933         char val[MAXBUF];
-00934         char t[MAXBUF];
-00935         char n[MAXBUF];
-00936         strlcpy(t,tag.c_str(),MAXBUF);
-00937         strlcpy(n,name.c_str(),MAXBUF);
-00938         int res = ReadConf(cache,t,n,index,val);
-00939         if (!res)
-00940         {
-00941                 this->error = CONF_VALUE_NOT_FOUND;
-00942                 return 0;
-00943         }
-00944         for (int i = 0; i < strlen(val); i++)
-00945         {
-00946                 if (!isdigit(val[i]))
-00947                 {
-00948                         this->error = CONF_NOT_A_NUMBER;
-00949                         return 0;
-00950                 }
-00951         }
-00952         if ((needs_unsigned) && (atoi(val)<0))
-00953         {
-00954                 this->error = CONF_NOT_UNSIGNED;
-00955                 return 0;
-00956         }
-00957         return atoi(val);
-00958 }
+Definition at line 860 of file modules.cpp.
+

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

+

00861 {
+00862         char val[MAXBUF];
+00863         char t[MAXBUF];
+00864         char n[MAXBUF];
+00865         strlcpy(t,tag.c_str(),MAXBUF);
+00866         strlcpy(n,name.c_str(),MAXBUF);
+00867         int res = ReadConf(cache,t,n,index,val);
+00868         if (!res)
+00869         {
+00870                 this->error = CONF_VALUE_NOT_FOUND;
+00871                 return 0;
+00872         }
+00873         for (int i = 0; i < strlen(val); i++)
+00874         {
+00875                 if (!isdigit(val[i]))
+00876                 {
+00877                         this->error = CONF_NOT_A_NUMBER;
+00878                         return 0;
+00879                 }
+00880         }
+00881         if ((needs_unsigned) && (atoi(val)<0))
+00882         {
+00883                 this->error = CONF_NOT_UNSIGNED;
+00884                 return 0;
+00885         }
+00886         return atoi(val);
+00887 }
 
@@ -607,24 +607,24 @@ 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 898 of file modules.cpp. -

-References cache, CONF_VALUE_NOT_FOUND, and error. -

-

00899 {
-00900         char val[MAXBUF];
-00901         char t[MAXBUF];
-00902         char n[MAXBUF];
-00903         strlcpy(t,tag.c_str(),MAXBUF);
-00904         strlcpy(n,name.c_str(),MAXBUF);
-00905         int res = ReadConf(cache,t,n,index,val);
-00906         if (!res)
-00907         {
-00908                 this->error = CONF_VALUE_NOT_FOUND;
-00909                 return "";
-00910         }
-00911         return val;
-00912 }
+Definition at line 827 of file modules.cpp.
+

+References cache, CONF_VALUE_NOT_FOUND, and error. +

+

00828 {
+00829         char val[MAXBUF];
+00830         char t[MAXBUF];
+00831         char n[MAXBUF];
+00832         strlcpy(t,tag.c_str(),MAXBUF);
+00833         strlcpy(n,name.c_str(),MAXBUF);
+00834         int res = ReadConf(cache,t,n,index,val);
+00835         if (!res)
+00836         {
+00837                 this->error = CONF_VALUE_NOT_FOUND;
+00838                 return "";
+00839         }
+00840         return val;
+00841 }
 
@@ -657,13 +657,13 @@ 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 1010 of file modules.cpp. +Definition at line 939 of file modules.cpp.

-References readerror. +References readerror.

-

01011 {
-01012         return this->readerror;
-01013 }
+
00940 {
+00941         return this->readerror;
+00942 }
 
@@ -691,9 +691,9 @@ 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 1155 of file modules.h. +Definition at line 1158 of file modules.h.

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

@@ -717,9 +717,9 @@ Referenced by ConfigReader(

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

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

@@ -743,9 +743,9 @@ Referenced by ConfigReader(

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

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

@@ -771,14 +771,14 @@ Used to store errors.

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

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


The documentation for this class was generated from the following files: -
Generated on Fri May 13 15:49:26 2005 for InspIRCd by +
Generated on Sun May 15 17:03:09 2005 for InspIRCd by doxygen 1.3.3
-- cgit v1.2.3