From bab9f4b4bc0f6aa0e1377745fd216ef9874b3f27 Mon Sep 17 00:00:00 2001 From: brain Date: Fri, 9 Dec 2005 20:21:39 +0000 Subject: Added new module docs git-svn-id: http://svn.inspircd.org/repository/trunk/inspircd@2301 e03df62e-2008-0410-955e-edbf42e46eb7 --- docs/module-doc/classConfigReader.html | 292 ++++++++++++++++----------------- 1 file changed, 146 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 331390141..6a8a95db9 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 1121 of file modules.h.

Constructor & Destructor Documentation

+Definition at line 1510 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 796 of file modules.cpp. +Definition at line 834 of file modules.cpp.

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

00797 {
-00798         include_stack.clear();
-00799         this->cache = new std::stringstream(std::stringstream::in | std::stringstream::out);
-00800         this->errorlog = new std::stringstream(std::stringstream::in | std::stringstream::out);
-00801         this->readerror = LoadConf(CONFIG_FILE,this->cache,this->errorlog);
-00802         if (!this->readerror)
-00803                 this->error = CONF_FILE_NOT_FOUND;
-00804 }
+References cache, CONF_FILE_NOT_FOUND, error, errorlog, include_stack, and readerror.
00835 {
+00836         include_stack.clear();
+00837         this->cache = new std::stringstream(std::stringstream::in | std::stringstream::out);
+00838         this->errorlog = new std::stringstream(std::stringstream::in | std::stringstream::out);
+00839         this->readerror = LoadConf(CONFIG_FILE,this->cache,this->errorlog);
+00840         if (!this->readerror)
+00841                 this->error = CONF_FILE_NOT_FOUND;
+00842 }
 

 

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

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

-Definition at line 816 of file modules.cpp.
+Definition at line 854 of file modules.cpp.
 

-References cache, CONF_FILE_NOT_FOUND, error, errorlog, and readerror.
00817 {
-00818         this->cache = new std::stringstream(std::stringstream::in | std::stringstream::out);
-00819         this->errorlog = new std::stringstream(std::stringstream::in | std::stringstream::out);
-00820         this->readerror = LoadConf(filename.c_str(),this->cache,this->errorlog);
-00821         if (!this->readerror)
-00822                 this->error = CONF_FILE_NOT_FOUND;
-00823 };
+References cache, CONF_FILE_NOT_FOUND, error, errorlog, and readerror.
00855 {
+00856         this->cache = new std::stringstream(std::stringstream::in | std::stringstream::out);
+00857         this->errorlog = new std::stringstream(std::stringstream::in | std::stringstream::out);
+00858         this->readerror = LoadConf(filename.c_str(),this->cache,this->errorlog);
+00859         if (!this->readerror)
+00860                 this->error = CONF_FILE_NOT_FOUND;
+00861 };
 

 

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

 This method destroys the ConfigReader class.
 

-Definition at line 807 of file modules.cpp.
+Definition at line 845 of file modules.cpp.
 

-References cache, and errorlog.
00808 {
-00809         if (this->cache)
-00810                 delete this->cache;
-00811         if (this->errorlog)
-00812                 delete this->errorlog;
-00813 }
+References cache, and errorlog.
00846 {
+00847         if (this->cache)
+00848                 delete this->cache;
+00849         if (this->errorlog)
+00850                 delete this->errorlog;
+00851 }
 

 

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

-References errorlog, connection::fd, and userrec::nick.
00895 {
-00896         if (bail)
-00897         {
-00898                 printf("There were errors in your configuration:\n%s",errorlog->str().c_str());
-00899                 exit(0);
-00900         }
-00901         else
-00902         {
-00903                 char dataline[1024];
-00904                 if (user)
-00905                 {
-00906                         WriteServ(user->fd,"NOTICE %s :There were errors in the configuration file:",user->nick);
-00907                         while (!errorlog->eof())
-00908                         {
-00909                                 errorlog->getline(dataline,1024);
-00910                                 WriteServ(user->fd,"NOTICE %s :%s",user->nick,dataline);
-00911                         }
-00912                 }
-00913                 else
-00914                 {
-00915                         WriteOpers("There were errors in the configuration file:",user->nick);
-00916                         while (!errorlog->eof())
-00917                         {
-00918                                 errorlog->getline(dataline,1024);
-00919                                 WriteOpers(dataline);
-00920                         }
-00921                 }
-00922                 return;
-00923         }
-00924 }
+Definition at line 932 of file modules.cpp.
+

+References errorlog, connection::fd, and userrec::nick.
00933 {
+00934         if (bail)
+00935         {
+00936                 printf("There were errors in your configuration:\n%s",errorlog->str().c_str());
+00937                 exit(0);
+00938         }
+00939         else
+00940         {
+00941                 char dataline[1024];
+00942                 if (user)
+00943                 {
+00944                         WriteServ(user->fd,"NOTICE %s :There were errors in the configuration file:",user->nick);
+00945                         while (!errorlog->eof())
+00946                         {
+00947                                 errorlog->getline(dataline,1024);
+00948                                 WriteServ(user->fd,"NOTICE %s :%s",user->nick,dataline);
+00949                         }
+00950                 }
+00951                 else
+00952                 {
+00953                         WriteOpers("There were errors in the configuration file:",user->nick);
+00954                         while (!errorlog->eof())
+00955                         {
+00956                                 errorlog->getline(dataline,1024);
+00957                                 WriteOpers(dataline);
+00958                         }
+00959                 }
+00960                 return;
+00961         }
+00962 }
 

 

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

-References cache.
00928 {
-00929         return EnumConf(cache,tag.c_str());
-00930 }
+References cache.
00966 {
+00967         return EnumConf(cache,tag.c_str());
+00968 }
 

 

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

-References cache.
00933 {
-00934         return EnumValues(cache, tag.c_str(), index);
-00935 }
+References cache.
00971 {
+00972         return EnumValues(cache, tag.c_str(), index);
+00973 }
 

 

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

-References error.
00888 {
-00889         long olderr = this->error;
-00890         this->error = 0;
-00891         return olderr;
-00892 }
+References error.
00926 {
+00927         long olderr = this->error;
+00928         this->error = 0;
+00929         return olderr;
+00930 }
 

 

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

-References cache, CONF_VALUE_NOT_FOUND, and error.
00842 {
-00843         char val[MAXBUF];
-00844         char t[MAXBUF];
-00845         char n[MAXBUF];
-00846         strlcpy(t,tag.c_str(),MAXBUF);
-00847         strlcpy(n,name.c_str(),MAXBUF);
-00848         int res = ReadConf(cache,t,n,index,val);
-00849         if (!res)
-00850         {
-00851                 this->error = CONF_VALUE_NOT_FOUND;
-00852                 return false;
-00853         }
-00854         std::string s = val;
-00855         return ((s == "yes") || (s == "YES") || (s == "true") || (s == "TRUE") || (s == "1"));
-00856 }
+Definition at line 879 of file modules.cpp.
+

+References cache, CONF_VALUE_NOT_FOUND, and error.
00880 {
+00881         char val[MAXBUF];
+00882         char t[MAXBUF];
+00883         char n[MAXBUF];
+00884         strlcpy(t,tag.c_str(),MAXBUF);
+00885         strlcpy(n,name.c_str(),MAXBUF);
+00886         int res = ReadConf(cache,t,n,index,val);
+00887         if (!res)
+00888         {
+00889                 this->error = CONF_VALUE_NOT_FOUND;
+00890                 return false;
+00891         }
+00892         std::string s = val;
+00893         return ((s == "yes") || (s == "YES") || (s == "true") || (s == "TRUE") || (s == "1"));
+00894 }
 

 

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

-References cache, CONF_NOT_A_NUMBER, CONF_NOT_UNSIGNED, CONF_VALUE_NOT_FOUND, and error.
00859 {
-00860         char val[MAXBUF];
-00861         char t[MAXBUF];
-00862         char n[MAXBUF];
-00863         strlcpy(t,tag.c_str(),MAXBUF);
-00864         strlcpy(n,name.c_str(),MAXBUF);
-00865         int res = ReadConf(cache,t,n,index,val);
-00866         if (!res)
-00867         {
-00868                 this->error = CONF_VALUE_NOT_FOUND;
-00869                 return 0;
-00870         }
-00871         for (unsigned int i = 0; i < strlen(val); i++)
-00872         {
-00873                 if (!isdigit(val[i]))
-00874                 {
-00875                         this->error = CONF_NOT_A_NUMBER;
-00876                         return 0;
-00877                 }
-00878         }
-00879         if ((needs_unsigned) && (atoi(val)<0))
-00880         {
-00881                 this->error = CONF_NOT_UNSIGNED;
-00882                 return 0;
-00883         }
-00884         return atoi(val);
-00885 }
+Definition at line 896 of file modules.cpp.
+

+References cache, CONF_NOT_A_NUMBER, CONF_NOT_UNSIGNED, CONF_VALUE_NOT_FOUND, and error.
00897 {
+00898         char val[MAXBUF];
+00899         char t[MAXBUF];
+00900         char n[MAXBUF];
+00901         strlcpy(t,tag.c_str(),MAXBUF);
+00902         strlcpy(n,name.c_str(),MAXBUF);
+00903         int res = ReadConf(cache,t,n,index,val);
+00904         if (!res)
+00905         {
+00906                 this->error = CONF_VALUE_NOT_FOUND;
+00907                 return 0;
+00908         }
+00909         for (unsigned int i = 0; i < strlen(val); i++)
+00910         {
+00911                 if (!isdigit(val[i]))
+00912                 {
+00913                         this->error = CONF_NOT_A_NUMBER;
+00914                         return 0;
+00915                 }
+00916         }
+00917         if ((needs_unsigned) && (atoi(val)<0))
+00918         {
+00919                 this->error = CONF_NOT_UNSIGNED;
+00920                 return 0;
+00921         }
+00922         return atoi(val);
+00923 }
 

 

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

-References cache, CONF_VALUE_NOT_FOUND, and error.
00826 {
-00827         char val[MAXBUF];
-00828         char t[MAXBUF];
-00829         char n[MAXBUF];
-00830         strlcpy(t,tag.c_str(),MAXBUF);
-00831         strlcpy(n,name.c_str(),MAXBUF);
-00832         int res = ReadConf(cache,t,n,index,val);
-00833         if (!res)
-00834         {
-00835                 this->error = CONF_VALUE_NOT_FOUND;
-00836                 return "";
-00837         }
-00838         return val;
-00839 }
+Definition at line 863 of file modules.cpp.
+

+References cache, CONF_VALUE_NOT_FOUND, and error.
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 "";
+00875         }
+00876         return val;
+00877 }
 

 

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

-References readerror.
00938 {
-00939         return this->readerror;
-00940 }
+References readerror.
00976 {
+00977         return this->readerror;
+00978 }
 

 

     
@@ -682,9 +682,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 1129 of file modules.h.
+Definition at line 1518 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 +709,9 @@ Referenced by ConfigReader(

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

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

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

-Definition at line 1130 of file modules.h. +Definition at line 1519 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 1133 of file modules.h. +Definition at line 1522 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 Nov 27 01:43:25 2005 for InspIRCd by  +
Generated on Fri Dec 9 20:20:11 2005 for InspIRCd by  doxygen 1.4.4-20050815
-- cgit v1.2.3