From 88dd74fc84b574f17673338c6d42123570f464da Mon Sep 17 00:00:00 2001 From: brain Date: Thu, 12 May 2005 23:06:51 +0000 Subject: Added docs for new smaller memory footprint classes git-svn-id: http://svn.inspircd.org/repository/trunk/inspircd@1371 e03df62e-2008-0410-955e-edbf42e46eb7 --- docs/module-doc/classConfigReader.html | 272 ++++++++++++++++----------------- 1 file changed, 136 insertions(+), 136 deletions(-) (limited to 'docs/module-doc/classConfigReader.html') diff --git a/docs/module-doc/classConfigReader.html b/docs/module-doc/classConfigReader.html index d47e96452..c37020080 100644 --- a/docs/module-doc/classConfigReader.html +++ b/docs/module-doc/classConfigReader.html @@ -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 869 of file modules.cpp. +Definition at line 870 of file modules.cpp.

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

-

00870 {
-00871         this->cache = new std::stringstream(std::stringstream::in | std::stringstream::out);
-00872         this->errorlog = new std::stringstream(std::stringstream::in | std::stringstream::out);
-00873         this->readerror = LoadConf(CONFIG_FILE,this->cache,this->errorlog);
-00874         if (!this->readerror)
-00875                 this->error = CONF_FILE_NOT_FOUND;
-00876 }
+
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 }
 
    
   
 
@@ -141,17 +141,17 @@ Overloaded constructor.
 

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

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

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

-
00889 {
-00890         this->cache = new std::stringstream(std::stringstream::in | std::stringstream::out);
-00891         this->errorlog = new std::stringstream(std::stringstream::in | std::stringstream::out);
-00892         this->readerror = LoadConf(filename.c_str(),this->cache,this->errorlog);
-00893         if (!this->readerror)
-00894                 this->error = CONF_FILE_NOT_FOUND;
-00895 };
+
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 };
 
    
   
 
@@ -184,16 +184,16 @@ Default destructor.
 

 This method destroys the ConfigReader class.
 

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

 References cache, and errorlog.
 

-
00880 {
-00881         if (this->cache)
-00882                 delete this->cache;
-00883         if (this->errorlog)
-00884                 delete this->errorlog;
-00885 }
+
00881 {
+00882         if (this->cache)
+00883                 delete this->cache;
+00884         if (this->errorlog)
+00885                 delete this->errorlog;
+00886 }
 
    
   
 
@@ -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 966 of file modules.cpp.
+Definition at line 967 of file modules.cpp.
 

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

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

 References cache.
 

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

 References cache.
 

-
01005 {
-01006         return EnumValues(cache, tag.c_str(), index);
-01007 }
+
01006 {
+01007         return EnumValues(cache, tag.c_str(), index);
+01008 }
 
    
   
 
@@ -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 959 of file modules.cpp.
+Definition at line 960 of file modules.cpp.
 

 References error.
 

-
00960 {
-00961         long olderr = this->error;
-00962         this->error = 0;
-00963         return olderr;
-00964 }
+
00961 {
+00962         long olderr = this->error;
+00963         this->error = 0;
+00964         return olderr;
+00965 }
 
    
   
 
@@ -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 913 of file modules.cpp.
+Definition at line 914 of file modules.cpp.
 

 References cache, CONF_VALUE_NOT_FOUND, and error.
 

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

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

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

 References cache, CONF_VALUE_NOT_FOUND, and error.
 

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

 References readerror.
 

-
01010 {
-01011         return this->readerror;
-01012 }
+
01011 {
+01012         return this->readerror;
+01013 }
 
    
   
 
@@ -687,7 +687,7 @@ It will contain a pointer to the configuration file data with unneeded data (suc
 

 Definition at line 1155 of file modules.h.
 

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

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

 Definition at line 1160 of file modules.h.
 

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

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

 Definition at line 1156 of file modules.h.
 

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

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

 Definition at line 1159 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 Thu May 12 02:25:19 2005 for InspIRCd by
+
Generated on Thu May 12 22:59:02 2005 for InspIRCd by
 
 doxygen 
 1.3.3 

-- 
cgit v1.2.3