From 03be04a9a2d86a4568d09d5e1689dd7ef37c863a Mon Sep 17 00:00:00 2001 From: brain Date: Wed, 14 Dec 2005 14:52:12 +0000 Subject: Added extra docs for new config system git-svn-id: http://svn.inspircd.org/repository/trunk/inspircd@2417 e03df62e-2008-0410-955e-edbf42e46eb7 --- docs/module-doc/classConfigReader.html | 293 +++++++++++++++++---------------- 1 file changed, 147 insertions(+), 146 deletions(-) (limited to 'docs/module-doc/classConfigReader.html') diff --git a/docs/module-doc/classConfigReader.html b/docs/module-doc/classConfigReader.html index 5d160fbd8..f5da7b3a4 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 1510 of file modules.h.

Constructor & Destructor Documentation

+Definition at line 1525 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 807 of file modules.cpp. +Definition at line 734 of file modules.cpp.

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

00808 {
-00809         include_stack.clear();
-00810         this->cache = new std::stringstream(std::stringstream::in | std::stringstream::out);
-00811         this->errorlog = new std::stringstream(std::stringstream::in | std::stringstream::out);
-00812         this->readerror = LoadConf(CONFIG_FILE,this->cache,this->errorlog);
-00813         if (!this->readerror)
-00814                 this->error = CONF_FILE_NOT_FOUND;
-00815 }
+References cache, ServerConfig::ClearStack(), CONF_FILE_NOT_FOUND, error, errorlog, ServerConfig::LoadConf(), and readerror.
00735 {
+00736         Config->ClearStack();
+00737         this->cache = new std::stringstream(std::stringstream::in | std::stringstream::out);
+00738         this->errorlog = new std::stringstream(std::stringstream::in | std::stringstream::out);
+00739         this->readerror = Config->LoadConf(CONFIG_FILE,this->cache,this->errorlog);
+00740         if (!this->readerror)
+00741                 this->error = CONF_FILE_NOT_FOUND;
+00742 }
 

 

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

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

-Definition at line 827 of file modules.cpp.
+Definition at line 754 of file modules.cpp.
 

-References cache, CONF_FILE_NOT_FOUND, error, errorlog, and readerror.
00828 {
-00829         this->cache = new std::stringstream(std::stringstream::in | std::stringstream::out);
-00830         this->errorlog = new std::stringstream(std::stringstream::in | std::stringstream::out);
-00831         this->readerror = LoadConf(filename.c_str(),this->cache,this->errorlog);
-00832         if (!this->readerror)
-00833                 this->error = CONF_FILE_NOT_FOUND;
-00834 };
+References cache, ServerConfig::ClearStack(), CONF_FILE_NOT_FOUND, error, errorlog, ServerConfig::LoadConf(), and readerror.
00755 {
+00756         Config->ClearStack();
+00757         this->cache = new std::stringstream(std::stringstream::in | std::stringstream::out);
+00758         this->errorlog = new std::stringstream(std::stringstream::in | std::stringstream::out);
+00759         this->readerror = Config->LoadConf(filename.c_str(),this->cache,this->errorlog);
+00760         if (!this->readerror)
+00761                 this->error = CONF_FILE_NOT_FOUND;
+00762 };
 

 

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

 This method destroys the ConfigReader class.
 

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

-References cache, and errorlog.
00819 {
-00820         if (this->cache)
-00821                 delete this->cache;
-00822         if (this->errorlog)
-00823                 delete this->errorlog;
-00824 }
+References cache, and errorlog.
00746 {
+00747         if (this->cache)
+00748                 delete this->cache;
+00749         if (this->errorlog)
+00750                 delete this->errorlog;
+00751 }
 

 

     
@@ -240,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 905 of file modules.cpp.
-

-References errorlog, connection::fd, and userrec::nick.
00906 {
-00907         if (bail)
-00908         {
-00909                 printf("There were errors in your configuration:\n%s",errorlog->str().c_str());
-00910                 exit(0);
-00911         }
-00912         else
-00913         {
-00914                 char dataline[1024];
-00915                 if (user)
-00916                 {
-00917                         WriteServ(user->fd,"NOTICE %s :There were errors in the configuration file:",user->nick);
-00918                         while (!errorlog->eof())
-00919                         {
-00920                                 errorlog->getline(dataline,1024);
-00921                                 WriteServ(user->fd,"NOTICE %s :%s",user->nick,dataline);
-00922                         }
-00923                 }
-00924                 else
-00925                 {
-00926                         WriteOpers("There were errors in the configuration file:",user->nick);
-00927                         while (!errorlog->eof())
-00928                         {
-00929                                 errorlog->getline(dataline,1024);
-00930                                 WriteOpers(dataline);
-00931                         }
-00932                 }
-00933                 return;
-00934         }
-00935 }
+Definition at line 833 of file modules.cpp.
+

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

 

     
@@ -306,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 938 of file modules.cpp.
+Definition at line 866 of file modules.cpp.
 

-References cache.
00939 {
-00940         return EnumConf(cache,tag.c_str());
-00941 }
+References cache, and ServerConfig::EnumConf().
00867 {
+00868         return Config->EnumConf(cache,tag.c_str());
+00869 }
 

 

     
@@ -354,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 943 of file modules.cpp.
+Definition at line 871 of file modules.cpp.
 

-References cache.
00944 {
-00945         return EnumValues(cache, tag.c_str(), index);
-00946 }
+References cache, and ServerConfig::EnumValues().
00872 {
+00873         return Config->EnumValues(cache, tag.c_str(), index);
+00874 }
 

 

     
@@ -392,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 898 of file modules.cpp.
+Definition at line 826 of file modules.cpp.
 

-References error.
00899 {
-00900         long olderr = this->error;
-00901         this->error = 0;
-00902         return olderr;
-00903 }
+References error.
00827 {
+00828         long olderr = this->error;
+00829         this->error = 0;
+00830         return olderr;
+00831 }
 

 

     
@@ -448,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 852 of file modules.cpp.
-

-References cache, CONF_VALUE_NOT_FOUND, and error.
00853 {
-00854         char val[MAXBUF];
-00855         char t[MAXBUF];
-00856         char n[MAXBUF];
-00857         strlcpy(t,tag.c_str(),MAXBUF);
-00858         strlcpy(n,name.c_str(),MAXBUF);
-00859         int res = ReadConf(cache,t,n,index,val);
-00860         if (!res)
-00861         {
-00862                 this->error = CONF_VALUE_NOT_FOUND;
-00863                 return false;
-00864         }
-00865         std::string s = val;
-00866         return ((s == "yes") || (s == "YES") || (s == "true") || (s == "TRUE") || (s == "1"));
-00867 }
+Definition at line 780 of file modules.cpp.
+

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

 

     
@@ -520,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 869 of file modules.cpp.
-

-References cache, CONF_NOT_A_NUMBER, CONF_NOT_UNSIGNED, CONF_VALUE_NOT_FOUND, and error.
00870 {
-00871         char val[MAXBUF];
-00872         char t[MAXBUF];
-00873         char n[MAXBUF];
-00874         strlcpy(t,tag.c_str(),MAXBUF);
-00875         strlcpy(n,name.c_str(),MAXBUF);
-00876         int res = ReadConf(cache,t,n,index,val);
-00877         if (!res)
-00878         {
-00879                 this->error = CONF_VALUE_NOT_FOUND;
-00880                 return 0;
-00881         }
-00882         for (unsigned int i = 0; i < strlen(val); i++)
-00883         {
-00884                 if (!isdigit(val[i]))
-00885                 {
-00886                         this->error = CONF_NOT_A_NUMBER;
-00887                         return 0;
-00888                 }
-00889         }
-00890         if ((needs_unsigned) && (atoi(val)<0))
-00891         {
-00892                 this->error = CONF_NOT_UNSIGNED;
-00893                 return 0;
-00894         }
-00895         return atoi(val);
-00896 }
+Definition at line 797 of file modules.cpp.
+

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

 

     
@@ -598,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 836 of file modules.cpp.
-

-References cache, CONF_VALUE_NOT_FOUND, and error.
00837 {
-00838         char val[MAXBUF];
-00839         char t[MAXBUF];
-00840         char n[MAXBUF];
-00841         strlcpy(t,tag.c_str(),MAXBUF);
-00842         strlcpy(n,name.c_str(),MAXBUF);
-00843         int res = ReadConf(cache,t,n,index,val);
-00844         if (!res)
-00845         {
-00846                 this->error = CONF_VALUE_NOT_FOUND;
-00847                 return "";
-00848         }
-00849         return val;
-00850 }
+Definition at line 764 of file modules.cpp.
+

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

 

     
@@ -647,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 948 of file modules.cpp.
+Definition at line 876 of file modules.cpp.
 

-References readerror.
00949 {
-00950         return this->readerror;
-00951 }
+References readerror.
00877 {
+00878         return this->readerror;
+00879 }
 

 

     
@@ -682,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 1518 of file modules.h.
+Definition at line 1533 of file modules.h.
 

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

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

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

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

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

-Definition at line 1519 of file modules.h. +Definition at line 1534 of file modules.h.

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

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

-Definition at line 1522 of file modules.h. +Definition at line 1537 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 Mon Dec 12 18:31:02 2005 for InspIRCd by  +
Generated on Wed Dec 14 14:49:30 2005 for InspIRCd by  doxygen 1.4.4-20050815
-- cgit v1.2.3