From 0f2cf28d39404881b9719330ca86757c51b87bad Mon Sep 17 00:00:00 2001 From: brain Date: Sat, 1 May 2004 19:58:59 +0000 Subject: Added documentation of new ConfigReader methods suggested by Azhrarn for sanity git-svn-id: http://svn.inspircd.org/repository/trunk/inspircd@772 e03df62e-2008-0410-955e-edbf42e46eb7 --- docs/module-doc/classConfigReader.html | 351 +++++++++++++++++++++++++++------ 1 file changed, 294 insertions(+), 57 deletions(-) (limited to 'docs/module-doc/classConfigReader.html') diff --git a/docs/module-doc/classConfigReader.html b/docs/module-doc/classConfigReader.html index 648d7fd88..5ad5b9aed 100644 --- a/docs/module-doc/classConfigReader.html +++ b/docs/module-doc/classConfigReader.html @@ -30,17 +30,24 @@ Inheritance diagram for ConfigReader:



std::string ReadValue (std::string tag, std::string name, int index)  Retrieves a value from the config file.

-int Enumerate (std::string tag) - Counts the number of times a given tag appears in the config file.

-bool Verify () - Returns true if a config file is valid.

-int EnumerateValues (std::string tag, int index) - Returns the number of items within a tag.

+bool ReadFlag (std::string tag, std::string name, int index) + Retrieves a boolean value from the config file.

+long ReadInteger (std::string tag, std::string name, int index, bool needs_unsigned) + Retrieves an integer value from the config file.

+long GetError () + Returns the last error to occur.

+int Enumerate (std::string tag) + Counts the number of times a given tag appears in the config file.

+bool Verify () + Returns true if a config file is valid.

+int EnumerateValues (std::string tag, int index) + Returns the number of items within a tag.


Protected Attributes

std::stringstream * cache  The contents of the configuration file This protected member should never be accessed by a module (and cannot be accessed unless the core is changed).

-bool error +bool readerror  Used to store errors.

+long error

Detailed Description

Allows reading of values from configuration files This class allows a module to read from either the main configuration file (inspircd.conf) or from a module-specified configuration file. @@ -49,7 +56,7 @@ It may either be instantiated with one parameter or none. Constructing the class

-Definition at line 612 of file modules.h.

Constructor & Destructor Documentation

+Definition at line 617 of file modules.h.

Constructor & Destructor Documentation

@@ -81,12 +88,14 @@ This constructor initialises the ConfigReader class to read the inspircd.conf fi

Definition at line 553 of file modules.cpp.

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

00554 {
 00555         this->cache = new std::stringstream(std::stringstream::in | std::stringstream::out);
-00556         this->error = LoadConf(CONFIG_FILE,this->cache);
-00557 }
+00556         this->readerror = LoadConf(CONFIG_FILE,this->cache);
+00557         if (!this->readerror)
+00558                 this->error = CONF_FILE_NOT_FOUND;
+00559 }
@@ -120,14 +129,16 @@ Overloaded constructor.

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

-Definition at line 567 of file modules.cpp. +Definition at line 569 of file modules.cpp.

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

-

00568 {
-00569         this->cache = new std::stringstream(std::stringstream::in | std::stringstream::out);
-00570         this->error = LoadConf(filename.c_str(),this->cache);
-00571 };
+
00570 {
+00571         this->cache = new std::stringstream(std::stringstream::in | std::stringstream::out);
+00572         this->readerror = LoadConf(filename.c_str(),this->cache);
+00573         if (!this->readerror)
+00574                 this->error = CONF_FILE_NOT_FOUND;
+00575 };
 
    
   
 
@@ -160,19 +171,19 @@ Default destructor.
 

 This method destroys the ConfigReader class.
 

-Definition at line 560 of file modules.cpp.
+Definition at line 562 of file modules.cpp.
 

-References cache.
+References cache.
 

-
00561 {
-00562         if (this->cache)
-00563                 delete this->cache;
-00564 }
+
00563 {
+00564         if (this->cache)
+00565                 delete this->cache;
+00566 }
 
    
   
 
 
Member Function Documentation

-

+

 

   

     
@@ -202,15 +213,15 @@ 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 585 of file modules.cpp.
+Definition at line 647 of file modules.cpp.
 

-
00586 {
-00587         return EnumConf(cache,tag.c_str());
-00588 }
+
00648 {
+00649         return EnumConf(cache,tag.c_str());
+00650 }
 
    

   

 

-

+

 
+  
+

   

     
@@ -249,11 +260,204 @@ 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 590 of file modules.cpp.
+Definition at line 652 of file modules.cpp.
 

-
00591 {
-00592         return EnumValues(cache, tag.c_str(), index);
-00593 }
+
00653 {
+00654         return EnumValues(cache, tag.c_str(), index);
+00655 }
+
    

+

+
+  
+    
+  
+

+      
+        
+          
+          
+          
+          
+          
+        
+
+      
 long ConfigReader::GetError (            ) 

+    

+
+  
+    
+    
+  
+

+       
+    
+
+

+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 639 of file modules.cpp.
+

+References error.
+

+
00640 {
+00641         long olderr = this->error;
+00642         this->error = 0;
+00643         return olderr;
+00644 }
+
    

+

+
+  
+    
+  
+

+      
+        
+          
+          
+          
+          
+        
+        
+          
+          
+          
+          
+        
+        
+          
+          
+          
+          
+        
+        
+          
+          
+          
+        
+
+      
 bool ConfigReader::ReadFlag ( std::string   tag, 
std::string   name, 
int   index
) 

+    

+
+  
+    
+    
+  
+

+       
+    
+
+

+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 593 of file modules.cpp.
+

+References CONF_VALUE_NOT_FOUND, and error.
+

+
00594 {
+00595         char val[MAXBUF];
+00596         char t[MAXBUF];
+00597         char n[MAXBUF];
+00598         strncpy(t,tag.c_str(),MAXBUF);
+00599         strncpy(n,name.c_str(),MAXBUF);
+00600         int res = ReadConf(cache,t,n,index,val);
+00601         if (!res)
+00602         {
+00603                 this->error = CONF_VALUE_NOT_FOUND;
+00604                 return false;
+00605         }
+00606         std::string s = val;
+00607         return ((s == "yes") || (s == "YES") || (s == "true") || (s == "TRUE") || (s == "1"));
+00608 }
+
    

+

+
+  
+    
+  
+

+      
+        
+          
+          
+          
+          
+        
+        
+          
+          
+          
+          
+        
+        
+          
+          
+          
+          
+        
+        
+          
+          
+          
+          
+        
+        
+          
+          
+          
+        
+
+      
 long ConfigReader::ReadInteger ( std::string   tag, 
std::string   name, 
int   index, 
bool   needs_unsigned
) 

+    

+
+  
+    
+    

+       
+    
+
+

+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 610 of file modules.cpp.
+

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

+
00611 {
+00612         char val[MAXBUF];
+00613         char t[MAXBUF];
+00614         char n[MAXBUF];
+00615         strncpy(t,tag.c_str(),MAXBUF);
+00616         strncpy(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 0;
+00622         }
+00623         for (int i = 0; i < strlen(val); i++)
+00624         {
+00625                 if (!isdigit(val[i]))
+00626                 {
+00627                         this->error = CONF_NOT_A_NUMBER;
+00628                         return 0;
+00629                 }
+00630         }
+00631         if ((needs_unsigned) && (atoi(val)<0))
+00632         {
+00633                 this->error = CONF_NOT_UNSIGNED;
+00634                 return 0;
+00635         }
+00636         return atoi(val);
+00637 }
 
    		
   

 

@@ -302,21 +506,28 @@ 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 573 of file modules.cpp.
-

-
00574 {
-00575         char val[MAXBUF];
-00576         char t[MAXBUF];
-00577         char n[MAXBUF];
-00578         strncpy(t,tag.c_str(),MAXBUF);
-00579         strncpy(n,name.c_str(),MAXBUF);
-00580         ReadConf(cache,t,n,index,val);
-00581         return std::string(val);
-00582 }
+Definition at line 577 of file modules.cpp.
+

+References CONF_VALUE_NOT_FOUND, and error.
+

+
00578 {
+00579         char val[MAXBUF];
+00580         char t[MAXBUF];
+00581         char n[MAXBUF];
+00582         strncpy(t,tag.c_str(),MAXBUF);
+00583         strncpy(n,name.c_str(),MAXBUF);
+00584         int res = ReadConf(cache,t,n,index,val);
+00585         if (!res)
+00586         {
+00587                 this->error = CONF_VALUE_NOT_FOUND;
+00588                 return "";
+00589         }
+00590         return std::string(val);
+00591 }
 
    
   
 
-

+

 

   

     
@@ -345,13 +556,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 595 of file modules.cpp.
+Definition at line 657 of file modules.cpp.
 

-References error.
+References readerror.
 

-
00596 {
-00597         return this->error;
-00598 }
+
00658 {
+00659         return this->readerror;
+00660 }
 
    

   

 

@@ -379,18 +590,44 @@ 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 620 of file modules.h.
+Definition at line 625 of file modules.h.
+

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

+
+  
+    
+  
+

+      
+        
+          
 long ConfigReader::error [protected]
+      

+    

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

+       
+    
+
+

+
+

+Definition at line 629 of file modules.h.
 

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

   

 

-

+

 
@@ -407,14 +644,14 @@ Used to store errors.
 

 
 

-Definition at line 623 of file modules.h.
+Definition at line 628 of file modules.h.
 

-Referenced by ConfigReader(), and Verify().    
+Referenced by ConfigReader(), and Verify().    
   
 

   

     
       
-          

         
 bool ConfigReader::error [protected]
+           bool ConfigReader::readerror [protected]
       

     		
   

 
The documentation for this class was generated from the following files:
-
Generated on Sat May 1 17:50:22 2004 for InspIRCd by
+
Generated on Sat May 1 20:58:02 2004 for InspIRCd by
 
 doxygen1.3-rc3 

-- 
cgit v1.2.3