From f326e475e311bf0fa211ccd052ba38d8235efa12 Mon Sep 17 00:00:00 2001 From: brain Date: Fri, 1 Apr 2005 17:07:42 +0000 Subject: Updated documentation (html) git-svn-id: http://svn.inspircd.org/repository/trunk/inspircd@937 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 3519d1aa8..7d1753f74 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 641 of file modules.h.


Constructor & Destructor Documentation

+Definition at line 669 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 566 of file modules.cpp. +Definition at line 576 of file modules.cpp.

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

-

00567 {
-00568         this->cache = new std::stringstream(std::stringstream::in | std::stringstream::out);
-00569         this->errorlog = new std::stringstream(std::stringstream::in | std::stringstream::out);
-00570         this->readerror = LoadConf(CONFIG_FILE,this->cache,this->errorlog);
-00571         if (!this->readerror)
-00572                 this->error = CONF_FILE_NOT_FOUND;
-00573 }
+
00577 {
+00578         this->cache = new std::stringstream(std::stringstream::in | std::stringstream::out);
+00579         this->errorlog = new std::stringstream(std::stringstream::in | std::stringstream::out);
+00580         this->readerror = LoadConf(CONFIG_FILE,this->cache,this->errorlog);
+00581         if (!this->readerror)
+00582                 this->error = CONF_FILE_NOT_FOUND;
+00583 }
 
@@ -141,17 +141,17 @@ Overloaded constructor.

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

-Definition at line 585 of file modules.cpp. +Definition at line 595 of file modules.cpp.

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

-

00586 {
-00587         this->cache = new std::stringstream(std::stringstream::in | std::stringstream::out);
-00588         this->errorlog = new std::stringstream(std::stringstream::in | std::stringstream::out);
-00589         this->readerror = LoadConf(filename.c_str(),this->cache,this->errorlog);
-00590         if (!this->readerror)
-00591                 this->error = CONF_FILE_NOT_FOUND;
-00592 };
+
00596 {
+00597         this->cache = new std::stringstream(std::stringstream::in | std::stringstream::out);
+00598         this->errorlog = new std::stringstream(std::stringstream::in | std::stringstream::out);
+00599         this->readerror = LoadConf(filename.c_str(),this->cache,this->errorlog);
+00600         if (!this->readerror)
+00601                 this->error = CONF_FILE_NOT_FOUND;
+00602 };
 
@@ -184,16 +184,16 @@ Default destructor.

This method destroys the ConfigReader class.

-Definition at line 576 of file modules.cpp. +Definition at line 586 of file modules.cpp.

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

-

00577 {
-00578         if (this->cache)
-00579                 delete this->cache;
-00580         if (this->errorlog)
-00581                 delete this->errorlog;
-00582 }
+
00587 {
+00588         if (this->cache)
+00589                 delete this->cache;
+00590         if (this->errorlog)
+00591                 delete this->errorlog;
+00592 }
 
@@ -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 663 of file modules.cpp. -

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

-

00664 {
-00665         if (bail)
-00666         {
-00667                 printf("There were errors in your configuration:\n%s",errorlog->str().c_str());
-00668                 exit(0);
-00669         }
-00670         else
-00671         {
-00672                 char dataline[1024];
-00673                 if (user)
-00674                 {
-00675                         WriteServ(user->fd,"NOTICE %s :There were errors in the configuration file:",user->nick);
-00676                         while (!errorlog->eof())
-00677                         {
-00678                                 errorlog->getline(dataline,1024);
-00679                                 WriteServ(user->fd,"NOTICE %s :%s",user->nick,dataline);
-00680                         }
-00681                 }
-00682                 else
-00683                 {
-00684                         WriteOpers("There were errors in the configuration file:",user->nick);
-00685                         while (!errorlog->eof())
-00686                         {
-00687                                 errorlog->getline(dataline,1024);
-00688                                 WriteOpers(dataline);
-00689                         }
-00690                 }
-00691                 return;
-00692         }
-00693 }
+Definition at line 673 of file modules.cpp.
+

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

+

00674 {
+00675         if (bail)
+00676         {
+00677                 printf("There were errors in your configuration:\n%s",errorlog->str().c_str());
+00678                 exit(0);
+00679         }
+00680         else
+00681         {
+00682                 char dataline[1024];
+00683                 if (user)
+00684                 {
+00685                         WriteServ(user->fd,"NOTICE %s :There were errors in the configuration file:",user->nick);
+00686                         while (!errorlog->eof())
+00687                         {
+00688                                 errorlog->getline(dataline,1024);
+00689                                 WriteServ(user->fd,"NOTICE %s :%s",user->nick,dataline);
+00690                         }
+00691                 }
+00692                 else
+00693                 {
+00694                         WriteOpers("There were errors in the configuration file:",user->nick);
+00695                         while (!errorlog->eof())
+00696                         {
+00697                                 errorlog->getline(dataline,1024);
+00698                                 WriteOpers(dataline);
+00699                         }
+00700                 }
+00701                 return;
+00702         }
+00703 }
 
@@ -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 696 of file modules.cpp. +Definition at line 706 of file modules.cpp.

-References cache. +References cache.

-

00697 {
-00698         return EnumConf(cache,tag.c_str());
-00699 }
+
00707 {
+00708         return EnumConf(cache,tag.c_str());
+00709 }
 
@@ -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 701 of file modules.cpp. +Definition at line 711 of file modules.cpp.

-References cache. +References cache.

-

00702 {
-00703         return EnumValues(cache, tag.c_str(), index);
-00704 }
+
00712 {
+00713         return EnumValues(cache, tag.c_str(), index);
+00714 }
 
@@ -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 656 of file modules.cpp. +Definition at line 666 of file modules.cpp.

-References error. +References error.

-

00657 {
-00658         long olderr = this->error;
-00659         this->error = 0;
-00660         return olderr;
-00661 }
+
00667 {
+00668         long olderr = this->error;
+00669         this->error = 0;
+00670         return olderr;
+00671 }
 
@@ -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 610 of file modules.cpp. -

-References cache, CONF_VALUE_NOT_FOUND, and error. -

-

00611 {
-00612         char val[MAXBUF];
-00613         char t[MAXBUF];
-00614         char n[MAXBUF];
-00615         strlcpy(t,tag.c_str(),MAXBUF);
-00616         strlcpy(n,name.c_str(),MAXBUF);
-00617         int res = ReadConf(cache,t,n,index,val);
-00618         if (!res)
-00619         {
-00620                 this->error = CONF_VALUE_NOT_FOUND;
-00621                 return false;
-00622         }
-00623         std::string s = val;
-00624         return ((s == "yes") || (s == "YES") || (s == "true") || (s == "TRUE") || (s == "1"));
-00625 }
+Definition at line 620 of file modules.cpp.
+

+References cache, CONF_VALUE_NOT_FOUND, and error. +

+

00621 {
+00622         char val[MAXBUF];
+00623         char t[MAXBUF];
+00624         char n[MAXBUF];
+00625         strlcpy(t,tag.c_str(),MAXBUF);
+00626         strlcpy(n,name.c_str(),MAXBUF);
+00627         int res = ReadConf(cache,t,n,index,val);
+00628         if (!res)
+00629         {
+00630                 this->error = CONF_VALUE_NOT_FOUND;
+00631                 return false;
+00632         }
+00633         std::string s = val;
+00634         return ((s == "yes") || (s == "YES") || (s == "true") || (s == "TRUE") || (s == "1"));
+00635 }
 
@@ -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 627 of file modules.cpp. -

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

-

00628 {
-00629         char val[MAXBUF];
-00630         char t[MAXBUF];
-00631         char n[MAXBUF];
-00632         strlcpy(t,tag.c_str(),MAXBUF);
-00633         strlcpy(n,name.c_str(),MAXBUF);
-00634         int res = ReadConf(cache,t,n,index,val);
-00635         if (!res)
-00636         {
-00637                 this->error = CONF_VALUE_NOT_FOUND;
-00638                 return 0;
-00639         }
-00640         for (int i = 0; i < strlen(val); i++)
-00641         {
-00642                 if (!isdigit(val[i]))
-00643                 {
-00644                         this->error = CONF_NOT_A_NUMBER;
-00645                         return 0;
-00646                 }
-00647         }
-00648         if ((needs_unsigned) && (atoi(val)<0))
-00649         {
-00650                 this->error = CONF_NOT_UNSIGNED;
-00651                 return 0;
-00652         }
-00653         return atoi(val);
-00654 }
+Definition at line 637 of file modules.cpp.
+

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

+

00638 {
+00639         char val[MAXBUF];
+00640         char t[MAXBUF];
+00641         char n[MAXBUF];
+00642         strlcpy(t,tag.c_str(),MAXBUF);
+00643         strlcpy(n,name.c_str(),MAXBUF);
+00644         int res = ReadConf(cache,t,n,index,val);
+00645         if (!res)
+00646         {
+00647                 this->error = CONF_VALUE_NOT_FOUND;
+00648                 return 0;
+00649         }
+00650         for (int i = 0; i < strlen(val); i++)
+00651         {
+00652                 if (!isdigit(val[i]))
+00653                 {
+00654                         this->error = CONF_NOT_A_NUMBER;
+00655                         return 0;
+00656                 }
+00657         }
+00658         if ((needs_unsigned) && (atoi(val)<0))
+00659         {
+00660                 this->error = CONF_NOT_UNSIGNED;
+00661                 return 0;
+00662         }
+00663         return atoi(val);
+00664 }
 
@@ -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 594 of file modules.cpp. -

-References cache, CONF_VALUE_NOT_FOUND, and error. -

-

00595 {
-00596         char val[MAXBUF];
-00597         char t[MAXBUF];
-00598         char n[MAXBUF];
-00599         strlcpy(t,tag.c_str(),MAXBUF);
-00600         strlcpy(n,name.c_str(),MAXBUF);
-00601         int res = ReadConf(cache,t,n,index,val);
-00602         if (!res)
-00603         {
-00604                 this->error = CONF_VALUE_NOT_FOUND;
-00605                 return "";
-00606         }
-00607         return std::string(val);
-00608 }
+Definition at line 604 of file modules.cpp.
+

+References cache, CONF_VALUE_NOT_FOUND, and error. +

+

00605 {
+00606         char val[MAXBUF];
+00607         char t[MAXBUF];
+00608         char n[MAXBUF];
+00609         strlcpy(t,tag.c_str(),MAXBUF);
+00610         strlcpy(n,name.c_str(),MAXBUF);
+00611         int res = ReadConf(cache,t,n,index,val);
+00612         if (!res)
+00613         {
+00614                 this->error = CONF_VALUE_NOT_FOUND;
+00615                 return "";
+00616         }
+00617         return std::string(val);
+00618 }
 
@@ -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 706 of file modules.cpp. +Definition at line 716 of file modules.cpp.

-References readerror. +References readerror.

-

00707 {
-00708         return this->readerror;
-00709 }
+
00717 {
+00718         return this->readerror;
+00719 }
 
@@ -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 649 of file modules.h. +Definition at line 677 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 654 of file modules.h. +Definition at line 682 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 650 of file modules.h. +Definition at line 678 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 653 of file modules.h. +Definition at line 681 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 Fri Mar 25 03:49:31 2005 for InspIRCd by +
Generated on Mon Mar 28 21:09:31 2005 for InspIRCd by doxygen 1.3.3
-- cgit v1.3.1-10-gc9f91