From e0db7b0d2f777361c8194c5820bb2f6e44c55204 Mon Sep 17 00:00:00 2001 From: brain Date: Thu, 15 Dec 2005 11:15:09 +0000 Subject: Added documentation for CullItem and CullList git-svn-id: http://svn.inspircd.org/repository/trunk/inspircd@2466 e03df62e-2008-0410-955e-edbf42e46eb7 --- docs/module-doc/classConfigReader.html | 286 ++++++++++++++++----------------- 1 file changed, 143 insertions(+), 143 deletions(-) (limited to 'docs/module-doc/classConfigReader.html') diff --git a/docs/module-doc/classConfigReader.html b/docs/module-doc/classConfigReader.html index 706de5241..88ea934ac 100644 --- a/docs/module-doc/classConfigReader.html +++ b/docs/module-doc/classConfigReader.html @@ -73,7 +73,7 @@ It may either be instantiated with one parameter or none. Constructing the class

-Definition at line 1529 of file modules.h.

Constructor & Destructor Documentation

+Definition at line 1532 of file modules.h.

Constructor & Destructor Documentation

@@ -102,16 +102,16 @@ Default constructor.

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

-Definition at line 731 of file modules.cpp. +Definition at line 736 of file modules.cpp.

-References cache, ServerConfig::ClearStack(), CONF_FILE_NOT_FOUND, error, errorlog, ServerConfig::LoadConf(), and readerror.

00732 {
-00733         Config->ClearStack();
-00734         this->cache = new std::stringstream(std::stringstream::in | std::stringstream::out);
-00735         this->errorlog = new std::stringstream(std::stringstream::in | std::stringstream::out);
-00736         this->readerror = Config->LoadConf(CONFIG_FILE,this->cache,this->errorlog);
-00737         if (!this->readerror)
-00738                 this->error = CONF_FILE_NOT_FOUND;
-00739 }
+References cache, ServerConfig::ClearStack(), CONF_FILE_NOT_FOUND, error, errorlog, ServerConfig::LoadConf(), and readerror.
00737 {
+00738         Config->ClearStack();
+00739         this->cache = new std::stringstream(std::stringstream::in | std::stringstream::out);
+00740         this->errorlog = new std::stringstream(std::stringstream::in | std::stringstream::out);
+00741         this->readerror = Config->LoadConf(CONFIG_FILE,this->cache,this->errorlog);
+00742         if (!this->readerror)
+00743                 this->error = CONF_FILE_NOT_FOUND;
+00744 }
 

 

     
@@ -146,16 +146,16 @@ Overloaded constructor.
 

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

-Definition at line 751 of file modules.cpp.
+Definition at line 756 of file modules.cpp.
 

-References cache, ServerConfig::ClearStack(), CONF_FILE_NOT_FOUND, error, errorlog, ServerConfig::LoadConf(), and readerror.
00752 {
-00753         Config->ClearStack();
-00754         this->cache = new std::stringstream(std::stringstream::in | std::stringstream::out);
-00755         this->errorlog = new std::stringstream(std::stringstream::in | std::stringstream::out);
-00756         this->readerror = Config->LoadConf(filename.c_str(),this->cache,this->errorlog);
-00757         if (!this->readerror)
-00758                 this->error = CONF_FILE_NOT_FOUND;
-00759 };
+References cache, ServerConfig::ClearStack(), CONF_FILE_NOT_FOUND, error, errorlog, ServerConfig::LoadConf(), and readerror.
00757 {
+00758         Config->ClearStack();
+00759         this->cache = new std::stringstream(std::stringstream::in | std::stringstream::out);
+00760         this->errorlog = new std::stringstream(std::stringstream::in | std::stringstream::out);
+00761         this->readerror = Config->LoadConf(filename.c_str(),this->cache,this->errorlog);
+00762         if (!this->readerror)
+00763                 this->error = CONF_FILE_NOT_FOUND;
+00764 };
 

 

     
@@ -189,14 +189,14 @@ Default destructor.
 

 This method destroys the ConfigReader class.
 

-Definition at line 742 of file modules.cpp.
+Definition at line 747 of file modules.cpp.
 

-References cache, and errorlog.
00743 {
-00744         if (this->cache)
-00745                 delete this->cache;
-00746         if (this->errorlog)
-00747                 delete this->errorlog;
-00748 }
+References cache, and errorlog.
00748 {
+00749         if (this->cache)
+00750                 delete this->cache;
+00751         if (this->errorlog)
+00752                 delete this->errorlog;
+00753 }
 

 

     
@@ -241,38 +241,38 @@ 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 830 of file modules.cpp.
+Definition at line 835 of file modules.cpp.
 

-References errorlog, connection::fd, userrec::nick, WriteOpers(), and WriteServ().
00831 {
-00832         if (bail)
-00833         {
-00834                 printf("There were errors in your configuration:\n%s",errorlog->str().c_str());
-00835                 exit(0);
-00836         }
-00837         else
+References errorlog, connection::fd, userrec::nick, WriteOpers(), and WriteServ().
00836 {
+00837         if (bail)
 00838         {
-00839                 char dataline[1024];
-00840                 if (user)
-00841                 {
-00842                         WriteServ(user->fd,"NOTICE %s :There were errors in the configuration file:",user->nick);
-00843                         while (!errorlog->eof())
-00844                         {
-00845                                 errorlog->getline(dataline,1024);
-00846                                 WriteServ(user->fd,"NOTICE %s :%s",user->nick,dataline);
-00847                         }
-00848                 }
-00849                 else
-00850                 {
-00851                         WriteOpers("There were errors in the configuration file:",user->nick);
-00852                         while (!errorlog->eof())
-00853                         {
-00854                                 errorlog->getline(dataline,1024);
-00855                                 WriteOpers(dataline);
-00856                         }
-00857                 }
-00858                 return;
-00859         }
-00860 }
+00839                 printf("There were errors in your configuration:\n%s",errorlog->str().c_str());
+00840                 exit(0);
+00841         }
+00842         else
+00843         {
+00844                 char dataline[1024];
+00845                 if (user)
+00846                 {
+00847                         WriteServ(user->fd,"NOTICE %s :There were errors in the configuration file:",user->nick);
+00848                         while (!errorlog->eof())
+00849                         {
+00850                                 errorlog->getline(dataline,1024);
+00851                                 WriteServ(user->fd,"NOTICE %s :%s",user->nick,dataline);
+00852                         }
+00853                 }
+00854                 else
+00855                 {
+00856                         WriteOpers("There were errors in the configuration file:",user->nick);
+00857                         while (!errorlog->eof())
+00858                         {
+00859                                 errorlog->getline(dataline,1024);
+00860                                 WriteOpers(dataline);
+00861                         }
+00862                 }
+00863                 return;
+00864         }
+00865 }
 

 

     
@@ -307,11 +307,11 @@ 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 863 of file modules.cpp.
+Definition at line 868 of file modules.cpp.
 

-References cache, and ServerConfig::EnumConf().
00864 {
-00865         return Config->EnumConf(cache,tag.c_str());
-00866 }
+References cache, and ServerConfig::EnumConf().
00869 {
+00870         return Config->EnumConf(cache,tag.c_str());
+00871 }
 

 

     
@@ -355,11 +355,11 @@ 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 868 of file modules.cpp.
+Definition at line 873 of file modules.cpp.
 

-References cache, and ServerConfig::EnumValues().
00869 {
-00870         return Config->EnumValues(cache, tag.c_str(), index);
-00871 }
+References cache, and ServerConfig::EnumValues().
00874 {
+00875         return Config->EnumValues(cache, tag.c_str(), index);
+00876 }
 

 

     
@@ -393,13 +393,13 @@ 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 823 of file modules.cpp.
+Definition at line 828 of file modules.cpp.
 

-References error.
00824 {
-00825         long olderr = this->error;
-00826         this->error = 0;
-00827         return olderr;
-00828 }
+References error.
00829 {
+00830         long olderr = this->error;
+00831         this->error = 0;
+00832         return olderr;
+00833 }
 

 

     
@@ -449,23 +449,23 @@ 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 777 of file modules.cpp.
-

-References cache, CONF_VALUE_NOT_FOUND, error, and ServerConfig::ReadConf().
00778 {
-00779         char val[MAXBUF];
-00780         char t[MAXBUF];
-00781         char n[MAXBUF];
-00782         strlcpy(t,tag.c_str(),MAXBUF);
-00783         strlcpy(n,name.c_str(),MAXBUF);
-00784         int res = Config->ReadConf(cache,t,n,index,val);
-00785         if (!res)
-00786         {
-00787                 this->error = CONF_VALUE_NOT_FOUND;
-00788                 return false;
-00789         }
-00790         std::string s = val;
-00791         return ((s == "yes") || (s == "YES") || (s == "true") || (s == "TRUE") || (s == "1"));
-00792 }
+Definition at line 782 of file modules.cpp.
+

+References cache, CONF_VALUE_NOT_FOUND, error, and ServerConfig::ReadConf().
00783 {
+00784         char val[MAXBUF];
+00785         char t[MAXBUF];
+00786         char n[MAXBUF];
+00787         strlcpy(t,tag.c_str(),MAXBUF);
+00788         strlcpy(n,name.c_str(),MAXBUF);
+00789         int res = Config->ReadConf(cache,t,n,index,val);
+00790         if (!res)
+00791         {
+00792                 this->error = CONF_VALUE_NOT_FOUND;
+00793                 return false;
+00794         }
+00795         std::string s = val;
+00796         return ((s == "yes") || (s == "YES") || (s == "true") || (s == "TRUE") || (s == "1"));
+00797 }
 

 

     
@@ -521,35 +521,35 @@ 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 794 of file modules.cpp.
-

-References cache, CONF_NOT_A_NUMBER, CONF_NOT_UNSIGNED, CONF_VALUE_NOT_FOUND, error, and ServerConfig::ReadConf().
00795 {
-00796         char val[MAXBUF];
-00797         char t[MAXBUF];
-00798         char n[MAXBUF];
-00799         strlcpy(t,tag.c_str(),MAXBUF);
-00800         strlcpy(n,name.c_str(),MAXBUF);
-00801         int res = Config->ReadConf(cache,t,n,index,val);
-00802         if (!res)
-00803         {
-00804                 this->error = CONF_VALUE_NOT_FOUND;
-00805                 return 0;
-00806         }
-00807         for (unsigned int i = 0; i < strlen(val); i++)
+Definition at line 799 of file modules.cpp.
+

+References cache, CONF_NOT_A_NUMBER, CONF_NOT_UNSIGNED, CONF_VALUE_NOT_FOUND, error, and ServerConfig::ReadConf().
00800 {
+00801         char val[MAXBUF];
+00802         char t[MAXBUF];
+00803         char n[MAXBUF];
+00804         strlcpy(t,tag.c_str(),MAXBUF);
+00805         strlcpy(n,name.c_str(),MAXBUF);
+00806         int res = Config->ReadConf(cache,t,n,index,val);
+00807         if (!res)
 00808         {
-00809                 if (!isdigit(val[i]))
-00810                 {
-00811                         this->error = CONF_NOT_A_NUMBER;
-00812                         return 0;
-00813                 }
-00814         }
-00815         if ((needs_unsigned) && (atoi(val)<0))
-00816         {
-00817                 this->error = CONF_NOT_UNSIGNED;
-00818                 return 0;
+00809                 this->error = CONF_VALUE_NOT_FOUND;
+00810                 return 0;
+00811         }
+00812         for (unsigned int i = 0; i < strlen(val); i++)
+00813         {
+00814                 if (!isdigit(val[i]))
+00815                 {
+00816                         this->error = CONF_NOT_A_NUMBER;
+00817                         return 0;
+00818                 }
 00819         }
-00820         return atoi(val);
-00821 }
+00820         if ((needs_unsigned) && (atoi(val)<0))
+00821         {
+00822                 this->error = CONF_NOT_UNSIGNED;
+00823                 return 0;
+00824         }
+00825         return atoi(val);
+00826 }
 

 

     
@@ -599,22 +599,22 @@ 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 761 of file modules.cpp.
-

-References cache, CONF_VALUE_NOT_FOUND, error, and ServerConfig::ReadConf().
00762 {
-00763         char val[MAXBUF];
-00764         char t[MAXBUF];
-00765         char n[MAXBUF];
-00766         strlcpy(t,tag.c_str(),MAXBUF);
-00767         strlcpy(n,name.c_str(),MAXBUF);
-00768         int res = Config->ReadConf(cache,t,n,index,val);
-00769         if (!res)
-00770         {
-00771                 this->error = CONF_VALUE_NOT_FOUND;
-00772                 return "";
-00773         }
-00774         return val;
-00775 }
+Definition at line 766 of file modules.cpp.
+

+References cache, CONF_VALUE_NOT_FOUND, error, and ServerConfig::ReadConf().
00767 {
+00768         char val[MAXBUF];
+00769         char t[MAXBUF];
+00770         char n[MAXBUF];
+00771         strlcpy(t,tag.c_str(),MAXBUF);
+00772         strlcpy(n,name.c_str(),MAXBUF);
+00773         int res = Config->ReadConf(cache,t,n,index,val);
+00774         if (!res)
+00775         {
+00776                 this->error = CONF_VALUE_NOT_FOUND;
+00777                 return "";
+00778         }
+00779         return val;
+00780 }
 

 

     
@@ -648,11 +648,11 @@ 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 873 of file modules.cpp.
+Definition at line 878 of file modules.cpp.
 

-References readerror.
00874 {
-00875         return this->readerror;
-00876 }
+References readerror.
00879 {
+00880         return this->readerror;
+00881 }
 

 

     
@@ -683,9 +683,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 1537 of file modules.h.
+Definition at line 1540 of file modules.h.
 

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

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

-Definition at line 1542 of file modules.h. +Definition at line 1545 of file modules.h.

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

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

-Definition at line 1538 of file modules.h. +Definition at line 1541 of file modules.h.

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

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

-Definition at line 1541 of file modules.h. +Definition at line 1544 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 Wed Dec 14 19:16:26 2005 for InspIRCd by  +
Generated on Thu Dec 15 11:14:17 2005 for InspIRCd by  doxygen 1.4.4-20050815
-- cgit v1.2.3