From 654ff4ae2f06704de2beb1050021c8196f693cb5 Mon Sep 17 00:00:00 2001 From: brain Date: Wed, 13 Apr 2005 13:42:08 +0000 Subject: Updated to support OnSendList git-svn-id: http://svn.inspircd.org/repository/trunk/inspircd@1073 e03df62e-2008-0410-955e-edbf42e46eb7 --- docs/module-doc/classConfigReader.html | 320 ++++++++++++++++----------------- 1 file changed, 160 insertions(+), 160 deletions(-) (limited to 'docs/module-doc/classConfigReader.html') diff --git a/docs/module-doc/classConfigReader.html b/docs/module-doc/classConfigReader.html index 76cdeb810..1e81811f5 100644 --- a/docs/module-doc/classConfigReader.html +++ b/docs/module-doc/classConfigReader.html @@ -67,7 +67,7 @@ It may either be instantiated with one parameter or none. Constructing the class

-Definition at line 780 of file modules.h.

Constructor & Destructor Documentation

+Definition at line 790 of file modules.h.

Constructor & Destructor Documentation

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

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

-Definition at line 674 of file modules.cpp. +Definition at line 675 of file modules.cpp.

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

-

00675 {
-00676         this->cache = new std::stringstream(std::stringstream::in | std::stringstream::out);
-00677         this->errorlog = new std::stringstream(std::stringstream::in | std::stringstream::out);
-00678         this->readerror = LoadConf(CONFIG_FILE,this->cache,this->errorlog);
-00679         if (!this->readerror)
-00680                 this->error = CONF_FILE_NOT_FOUND;
-00681 }
+
00676 {
+00677         this->cache = new std::stringstream(std::stringstream::in | std::stringstream::out);
+00678         this->errorlog = new std::stringstream(std::stringstream::in | std::stringstream::out);
+00679         this->readerror = LoadConf(CONFIG_FILE,this->cache,this->errorlog);
+00680         if (!this->readerror)
+00681                 this->error = CONF_FILE_NOT_FOUND;
+00682 }
@@ -141,17 +141,17 @@ Overloaded constructor.

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

-Definition at line 693 of file modules.cpp. +Definition at line 694 of file modules.cpp.

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

-

00694 {
-00695         this->cache = new std::stringstream(std::stringstream::in | std::stringstream::out);
-00696         this->errorlog = new std::stringstream(std::stringstream::in | std::stringstream::out);
-00697         this->readerror = LoadConf(filename.c_str(),this->cache,this->errorlog);
-00698         if (!this->readerror)
-00699                 this->error = CONF_FILE_NOT_FOUND;
-00700 };
+
00695 {
+00696         this->cache = new std::stringstream(std::stringstream::in | std::stringstream::out);
+00697         this->errorlog = new std::stringstream(std::stringstream::in | std::stringstream::out);
+00698         this->readerror = LoadConf(filename.c_str(),this->cache,this->errorlog);
+00699         if (!this->readerror)
+00700                 this->error = CONF_FILE_NOT_FOUND;
+00701 };
 
    
   
 
@@ -184,16 +184,16 @@ Default destructor.
 

 This method destroys the ConfigReader class.
 

-Definition at line 684 of file modules.cpp.
+Definition at line 685 of file modules.cpp.
 

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

-
00685 {
-00686         if (this->cache)
-00687                 delete this->cache;
-00688         if (this->errorlog)
-00689                 delete this->errorlog;
-00690 }
+
00686 {
+00687         if (this->cache)
+00688                 delete this->cache;
+00689         if (this->errorlog)
+00690                 delete this->errorlog;
+00691 }
 
    
   
 
@@ -237,40 +237,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 771 of file modules.cpp.
-

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

-
00772 {
-00773         if (bail)
-00774         {
-00775                 printf("There were errors in your configuration:\n%s",errorlog->str().c_str());
-00776                 exit(0);
-00777         }
-00778         else
-00779         {
-00780                 char dataline[1024];
-00781                 if (user)
-00782                 {
-00783                         WriteServ(user->fd,"NOTICE %s :There were errors in the configuration file:",user->nick);
-00784                         while (!errorlog->eof())
-00785                         {
-00786                                 errorlog->getline(dataline,1024);
-00787                                 WriteServ(user->fd,"NOTICE %s :%s",user->nick,dataline);
-00788                         }
-00789                 }
-00790                 else
-00791                 {
-00792                         WriteOpers("There were errors in the configuration file:",user->nick);
-00793                         while (!errorlog->eof())
-00794                         {
-00795                                 errorlog->getline(dataline,1024);
-00796                                 WriteOpers(dataline);
-00797                         }
-00798                 }
-00799                 return;
-00800         }
-00801 }
+Definition at line 772 of file modules.cpp.
+

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

+
00773 {
+00774         if (bail)
+00775         {
+00776                 printf("There were errors in your configuration:\n%s",errorlog->str().c_str());
+00777                 exit(0);
+00778         }
+00779         else
+00780         {
+00781                 char dataline[1024];
+00782                 if (user)
+00783                 {
+00784                         WriteServ(user->fd,"NOTICE %s :There were errors in the configuration file:",user->nick);
+00785                         while (!errorlog->eof())
+00786                         {
+00787                                 errorlog->getline(dataline,1024);
+00788                                 WriteServ(user->fd,"NOTICE %s :%s",user->nick,dataline);
+00789                         }
+00790                 }
+00791                 else
+00792                 {
+00793                         WriteOpers("There were errors in the configuration file:",user->nick);
+00794                         while (!errorlog->eof())
+00795                         {
+00796                                 errorlog->getline(dataline,1024);
+00797                                 WriteOpers(dataline);
+00798                         }
+00799                 }
+00800                 return;
+00801         }
+00802 }
 
    
   
 
@@ -304,13 +304,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 804 of file modules.cpp.
+Definition at line 805 of file modules.cpp.
 

-References cache.
+References cache.
 

-
00805 {
-00806         return EnumConf(cache,tag.c_str());
-00807 }
+
00806 {
+00807         return EnumConf(cache,tag.c_str());
+00808 }
 
    
   
 
@@ -353,13 +353,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 809 of file modules.cpp.
+Definition at line 810 of file modules.cpp.
 

-References cache.
+References cache.
 

-
00810 {
-00811         return EnumValues(cache, tag.c_str(), index);
-00812 }
+
00811 {
+00812         return EnumValues(cache, tag.c_str(), index);
+00813 }
 
    
   
 
@@ -392,15 +392,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 764 of file modules.cpp.
+Definition at line 765 of file modules.cpp.
 

-References error.
+References error.
 

-
00765 {
-00766         long olderr = this->error;
-00767         this->error = 0;
-00768         return olderr;
-00769 }
+
00766 {
+00767         long olderr = this->error;
+00768         this->error = 0;
+00769         return olderr;
+00770 }
 
    
   
 
@@ -449,25 +449,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 718 of file modules.cpp.
-

-References cache, CONF_VALUE_NOT_FOUND, and error.
-

-
00719 {
-00720         char val[MAXBUF];
-00721         char t[MAXBUF];
-00722         char n[MAXBUF];
-00723         strlcpy(t,tag.c_str(),MAXBUF);
-00724         strlcpy(n,name.c_str(),MAXBUF);
-00725         int res = ReadConf(cache,t,n,index,val);
-00726         if (!res)
-00727         {
-00728                 this->error = CONF_VALUE_NOT_FOUND;
-00729                 return false;
-00730         }
-00731         std::string s = val;
-00732         return ((s == "yes") || (s == "YES") || (s == "true") || (s == "TRUE") || (s == "1"));
-00733 }
+Definition at line 719 of file modules.cpp.
+

+References cache, CONF_VALUE_NOT_FOUND, and error.
+

+
00720 {
+00721         char val[MAXBUF];
+00722         char t[MAXBUF];
+00723         char n[MAXBUF];
+00724         strlcpy(t,tag.c_str(),MAXBUF);
+00725         strlcpy(n,name.c_str(),MAXBUF);
+00726         int res = ReadConf(cache,t,n,index,val);
+00727         if (!res)
+00728         {
+00729                 this->error = CONF_VALUE_NOT_FOUND;
+00730                 return false;
+00731         }
+00732         std::string s = val;
+00733         return ((s == "yes") || (s == "YES") || (s == "true") || (s == "TRUE") || (s == "1"));
+00734 }
 
    
   
 
@@ -522,37 +522,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 735 of file modules.cpp.
-

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

-
00736 {
-00737         char val[MAXBUF];
-00738         char t[MAXBUF];
-00739         char n[MAXBUF];
-00740         strlcpy(t,tag.c_str(),MAXBUF);
-00741         strlcpy(n,name.c_str(),MAXBUF);
-00742         int res = ReadConf(cache,t,n,index,val);
-00743         if (!res)
-00744         {
-00745                 this->error = CONF_VALUE_NOT_FOUND;
-00746                 return 0;
-00747         }
-00748         for (int i = 0; i < strlen(val); i++)
-00749         {
-00750                 if (!isdigit(val[i]))
-00751                 {
-00752                         this->error = CONF_NOT_A_NUMBER;
-00753                         return 0;
-00754                 }
-00755         }
-00756         if ((needs_unsigned) && (atoi(val)<0))
-00757         {
-00758                 this->error = CONF_NOT_UNSIGNED;
-00759                 return 0;
-00760         }
-00761         return atoi(val);
-00762 }
+Definition at line 736 of file modules.cpp.
+

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

+
00737 {
+00738         char val[MAXBUF];
+00739         char t[MAXBUF];
+00740         char n[MAXBUF];
+00741         strlcpy(t,tag.c_str(),MAXBUF);
+00742         strlcpy(n,name.c_str(),MAXBUF);
+00743         int res = ReadConf(cache,t,n,index,val);
+00744         if (!res)
+00745         {
+00746                 this->error = CONF_VALUE_NOT_FOUND;
+00747                 return 0;
+00748         }
+00749         for (int i = 0; i < strlen(val); i++)
+00750         {
+00751                 if (!isdigit(val[i]))
+00752                 {
+00753                         this->error = CONF_NOT_A_NUMBER;
+00754                         return 0;
+00755                 }
+00756         }
+00757         if ((needs_unsigned) && (atoi(val)<0))
+00758         {
+00759                 this->error = CONF_NOT_UNSIGNED;
+00760                 return 0;
+00761         }
+00762         return atoi(val);
+00763 }
 
    
   
 
@@ -601,24 +601,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 702 of file modules.cpp.
-

-References cache, CONF_VALUE_NOT_FOUND, and error.
-

-
00703 {
-00704         char val[MAXBUF];
-00705         char t[MAXBUF];
-00706         char n[MAXBUF];
-00707         strlcpy(t,tag.c_str(),MAXBUF);
-00708         strlcpy(n,name.c_str(),MAXBUF);
-00709         int res = ReadConf(cache,t,n,index,val);
-00710         if (!res)
-00711         {
-00712                 this->error = CONF_VALUE_NOT_FOUND;
-00713                 return "";
-00714         }
-00715         return std::string(val);
-00716 }
+Definition at line 703 of file modules.cpp.
+

+References cache, CONF_VALUE_NOT_FOUND, and error.
+

+
00704 {
+00705         char val[MAXBUF];
+00706         char t[MAXBUF];
+00707         char n[MAXBUF];
+00708         strlcpy(t,tag.c_str(),MAXBUF);
+00709         strlcpy(n,name.c_str(),MAXBUF);
+00710         int res = ReadConf(cache,t,n,index,val);
+00711         if (!res)
+00712         {
+00713                 this->error = CONF_VALUE_NOT_FOUND;
+00714                 return "";
+00715         }
+00716         return std::string(val);
+00717 }
 
    
   
 
@@ -651,13 +651,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 814 of file modules.cpp.
+Definition at line 815 of file modules.cpp.
 

-References readerror.
+References readerror.
 

-
00815 {
-00816         return this->readerror;
-00817 }
+
00816 {
+00817         return this->readerror;
+00818 }
 
    
   
 
@@ -685,9 +685,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 788 of file modules.h.
+Definition at line 798 of file modules.h.
 

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

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

 
 

-Definition at line 793 of file modules.h.
+Definition at line 803 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 789 of file modules.h.
+Definition at line 799 of file modules.h.
 

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

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

 
 

-Definition at line 792 of file modules.h.
+Definition at line 802 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 Apr 13 12:32:23 2005 for InspIRCd by
+
Generated on Wed Apr 13 13:07:02 2005 for InspIRCd by
 
 doxygen 
 1.3.3 

-- 
cgit v1.2.3