From 66f0cd6469d2643858c2fcd14726d362696bd68d Mon Sep 17 00:00:00 2001 From: brain Date: Tue, 24 May 2005 02:34:33 +0000 Subject: New methods, new docs git-svn-id: http://svn.inspircd.org/repository/trunk/inspircd@1484 e03df62e-2008-0410-955e-edbf42e46eb7 --- docs/module-doc/classConfigReader.html | 278 ++++++++++++++++----------------- 1 file changed, 139 insertions(+), 139 deletions(-) (limited to 'docs/module-doc/classConfigReader.html') diff --git a/docs/module-doc/classConfigReader.html b/docs/module-doc/classConfigReader.html index be9363d30..12a432ec7 100644 --- a/docs/module-doc/classConfigReader.html +++ b/docs/module-doc/classConfigReader.html @@ -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 799 of file modules.cpp. +Definition at line 819 of file modules.cpp.

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

-

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 }
+
00820 {
+00821         this->cache = new std::stringstream(std::stringstream::in | std::stringstream::out);
+00822         this->errorlog = new std::stringstream(std::stringstream::in | std::stringstream::out);
+00823         this->readerror = LoadConf(CONFIG_FILE,this->cache,this->errorlog);
+00824         if (!this->readerror)
+00825                 this->error = CONF_FILE_NOT_FOUND;
+00826 }
 
    
   
 
@@ -147,17 +147,17 @@ Overloaded constructor.
 

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

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

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

-
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 };
+
00839 {
+00840         this->cache = new std::stringstream(std::stringstream::in | std::stringstream::out);
+00841         this->errorlog = new std::stringstream(std::stringstream::in | std::stringstream::out);
+00842         this->readerror = LoadConf(filename.c_str(),this->cache,this->errorlog);
+00843         if (!this->readerror)
+00844                 this->error = CONF_FILE_NOT_FOUND;
+00845 };
 
    
   
 
@@ -190,16 +190,16 @@ Default destructor.
 

 This method destroys the ConfigReader class.
 

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

 References cache, and errorlog.
 

-
00810 {
-00811         if (this->cache)
-00812                 delete this->cache;
-00813         if (this->errorlog)
-00814                 delete this->errorlog;
-00815 }
+
00830 {
+00831         if (this->cache)
+00832                 delete this->cache;
+00833         if (this->errorlog)
+00834                 delete this->errorlog;
+00835 }
 
    
   
 
@@ -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 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 }
+Definition at line 916 of file modules.cpp.
+

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

+
00917 {
+00918         if (bail)
+00919         {
+00920                 printf("There were errors in your configuration:\n%s",errorlog->str().c_str());
+00921                 exit(0);
+00922         }
+00923         else
+00924         {
+00925                 char dataline[1024];
+00926                 if (user)
+00927                 {
+00928                         WriteServ(user->fd,"NOTICE %s :There were errors in the configuration file:",user->nick);
+00929                         while (!errorlog->eof())
+00930                         {
+00931                                 errorlog->getline(dataline,1024);
+00932                                 WriteServ(user->fd,"NOTICE %s :%s",user->nick,dataline);
+00933                         }
+00934                 }
+00935                 else
+00936                 {
+00937                         WriteOpers("There were errors in the configuration file:",user->nick);
+00938                         while (!errorlog->eof())
+00939                         {
+00940                                 errorlog->getline(dataline,1024);
+00941                                 WriteOpers(dataline);
+00942                         }
+00943                 }
+00944                 return;
+00945         }
+00946 }
 
    
   
 
@@ -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 929 of file modules.cpp.
+Definition at line 949 of file modules.cpp.
 

 References cache.
 

-
00930 {
-00931         return EnumConf(cache,tag.c_str());
-00932 }
+
00950 {
+00951         return EnumConf(cache,tag.c_str());
+00952 }
 
    
   
 
@@ -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 934 of file modules.cpp.
+Definition at line 954 of file modules.cpp.
 

 References cache.
 

-
00935 {
-00936         return EnumValues(cache, tag.c_str(), index);
-00937 }
+
00955 {
+00956         return EnumValues(cache, tag.c_str(), index);
+00957 }
 
    
   
 
@@ -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 889 of file modules.cpp.
+Definition at line 909 of file modules.cpp.
 

 References error.
 

-
00890 {
-00891         long olderr = this->error;
-00892         this->error = 0;
-00893         return olderr;
-00894 }
+
00910 {
+00911         long olderr = this->error;
+00912         this->error = 0;
+00913         return olderr;
+00914 }
 
    
   
 
@@ -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 843 of file modules.cpp.
+Definition at line 863 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 }
+
00864 {
+00865         char val[MAXBUF];
+00866         char t[MAXBUF];
+00867         char n[MAXBUF];
+00868         strlcpy(t,tag.c_str(),MAXBUF);
+00869         strlcpy(n,name.c_str(),MAXBUF);
+00870         int res = ReadConf(cache,t,n,index,val);
+00871         if (!res)
+00872         {
+00873                 this->error = CONF_VALUE_NOT_FOUND;
+00874                 return false;
+00875         }
+00876         std::string s = val;
+00877         return ((s == "yes") || (s == "YES") || (s == "true") || (s == "TRUE") || (s == "1"));
+00878 }
 
    
   
 
@@ -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 860 of file modules.cpp.
+Definition at line 880 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 }
+
00881 {
+00882         char val[MAXBUF];
+00883         char t[MAXBUF];
+00884         char n[MAXBUF];
+00885         strlcpy(t,tag.c_str(),MAXBUF);
+00886         strlcpy(n,name.c_str(),MAXBUF);
+00887         int res = ReadConf(cache,t,n,index,val);
+00888         if (!res)
+00889         {
+00890                 this->error = CONF_VALUE_NOT_FOUND;
+00891                 return 0;
+00892         }
+00893         for (int i = 0; i < strlen(val); i++)
+00894         {
+00895                 if (!isdigit(val[i]))
+00896                 {
+00897                         this->error = CONF_NOT_A_NUMBER;
+00898                         return 0;
+00899                 }
+00900         }
+00901         if ((needs_unsigned) && (atoi(val)<0))
+00902         {
+00903                 this->error = CONF_NOT_UNSIGNED;
+00904                 return 0;
+00905         }
+00906         return atoi(val);
+00907 }
 
    
   
 
@@ -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 827 of file modules.cpp.
+Definition at line 847 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 }
+
00848 {
+00849         char val[MAXBUF];
+00850         char t[MAXBUF];
+00851         char n[MAXBUF];
+00852         strlcpy(t,tag.c_str(),MAXBUF);
+00853         strlcpy(n,name.c_str(),MAXBUF);
+00854         int res = ReadConf(cache,t,n,index,val);
+00855         if (!res)
+00856         {
+00857                 this->error = CONF_VALUE_NOT_FOUND;
+00858                 return "";
+00859         }
+00860         return val;
+00861 }
 
    
   
 
@@ -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 939 of file modules.cpp.
+Definition at line 959 of file modules.cpp.
 

 References readerror.
 

-
00940 {
-00941         return this->readerror;
-00942 }
+
00960 {
+00961         return this->readerror;
+00962 }
 
    
   
 
@@ -693,7 +693,7 @@ It will contain a pointer to the configuration file data with unneeded data (suc
 

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

@@ -719,7 +719,7 @@ Referenced by ConfigReader(
 

 Definition at line 1163 of file modules.h.
 

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

@@ -745,7 +745,7 @@ Referenced by ConfigReader(
 

 Definition at line 1159 of file modules.h.
 

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

@@ -773,12 +773,12 @@ Used to store errors.
 

 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 Sun May 15 18:37:55 2005 for InspIRCd by
+
Generated on Tue May 24 02:31:43 2005 for InspIRCd by
 
 doxygen 
 1.3.3 

-- 
cgit v1.3.1-10-gc9f91