From a753fb1bc711e10794e939e424f3cdd703116d82 Mon Sep 17 00:00:00 2001 From: brain Date: Fri, 2 Apr 2004 12:38:41 +0000 Subject: Added support for modules to create commands - this needs a proof-of-concept module yet, do not use unless you like to live dangerously. git-svn-id: http://svn.inspircd.org/repository/trunk/inspircd@351 e03df62e-2008-0410-955e-edbf42e46eb7 --- docs/module-doc/classFileReader.html | 151 +++++++++++++++++++++++------------ 1 file changed, 98 insertions(+), 53 deletions(-) (limited to 'docs/module-doc/classFileReader.html') diff --git a/docs/module-doc/classFileReader.html b/docs/module-doc/classFileReader.html index b60532125..d2ba2399b 100644 --- a/docs/module-doc/classFileReader.html +++ b/docs/module-doc/classFileReader.html @@ -24,18 +24,19 @@ Inheritance diagram for FileReader:

FileReader ()  Default constructor.

- FileReader (string filename) + FileReader (std::string filename)  Secondary constructor.

 ~FileReader ()  Default destructor.

-void LoadFile (string filename) +void LoadFile (std::string filename)  Used to load a file.

-string GetLine (int x) +bool Exists ()  Retrieve one line from the file.

-int FileSize () - Returns the size of the file in lines.

+std::string GetLine (int x) +int FileSize () + Returns the size of the file in lines.


Private Attributes

-file_cache fc +file_cache fc

Detailed Description

Caches a text file into memory and can be used to retrieve lines from it. @@ -44,7 +45,7 @@ This class contains methods for read-only manipulation of a text file in memory.

-Definition at line 297 of file modules.h.

Constructor & Destructor Documentation

+Definition at line 347 of file modules.h.

Constructor & Destructor Documentation

@@ -74,10 +75,10 @@ Default constructor.

This method does not load any file into memory, you must use the LoadFile method after constructing the class this way.

-Definition at line 193 of file modules.cpp. +Definition at line 265 of file modules.cpp.

-

00194 {
-00195 }
+
00266 {
+00267 }
@@ -89,7 +90,7 @@ Definition at line 193 FileReader::FileReader (  - string  + std::string    filename )  @@ -109,17 +110,17 @@ Definition at line 193

Secondary constructor.

-This method initialises the class with a file loaded into it ready for GetLine and and other methods to be called. If the file could not be loaded, FileReader::FileSize returns 0. +This method initialises the class with a file loaded into it ready for GetLine and and other methods to be called. If the file could not be loaded, FileReader::FileSize returns 0.

-Definition at line 186 of file modules.cpp. +Definition at line 258 of file modules.cpp.

-References fc, and file_cache. +References fc, and file_cache.

-

00187 {
-00188         file_cache c;
-00189         readfile(c,filename.c_str());
-00190         this->fc = c;
-00191 }
+
00259 {
+00260         file_cache c;
+00261         readfile(c,filename.c_str());
+00262         this->fc = c;
+00263 }
 
    
   
 
@@ -152,15 +153,61 @@ Default destructor.
 

 This deletes the memory allocated to the file.
 

-Definition at line 204 of file modules.cpp.
+Definition at line 277 of file modules.cpp.
 

-
00205 {
-00206 }
+
00278 {
+00279 }
 
    
   
 
 
Member Function Documentation

-

+

+
+  
+    
+  
+

+      
+        
+          
+          
+          
+          
+          
+        
+
+      
 bool FileReader::Exists (            ) 

+    

+
+  
+    
+    
+  
+

+       
+    
+
+

+Retrieve one line from the file.
+

+This method retrieves one line from the text file. If an empty non-NULL string is returned, the index was out of bounds, or the line had no data on it.
+

+Definition at line 281 of file modules.cpp.
+

+References fc.
+

+
00282 {
+00283         if (fc.size() == 0)
+00284         {
+00285                 return(false);
+00286         }
+00287         else
+00288         {
+00289                 return(true);
+00290         }
+00291 }
+
    

+

 

   

     
@@ -189,23 +236,23 @@ Returns the size of the file in lines.
 

 This method returns the number of lines in the read file. If it is 0, no lines have been read into memory, either because the file is empty or it does not exist, or cannot be opened due to permission problems.
 

-Definition at line 215 of file modules.cpp.
+Definition at line 300 of file modules.cpp.
 

-References fc.
+References fc.
 

-
00216 {
-00217         return fc.size();
-00218 }
+
00301 {
+00302         return fc.size();
+00303 }
 
    

   

 

-

+

 
-          
+          
@@ -269,17 +314,17 @@ References fc.
 

 Used to load a file.
 

-This method loads a file into the class ready for GetLine and and other methods to be called. If the file could not be loaded, FileReader::FileSize returns 0.
+This method loads a file into the class ready for GetLine and and other methods to be called. If the file could not be loaded, FileReader::FileSize returns 0.
 

-Definition at line 197 of file modules.cpp.
+Definition at line 269 of file modules.cpp.
 

-References fc, and file_cache.
+References fc, and file_cache.
 

-
00198 {
-00199         file_cache c;
-00200         readfile(c,filename.c_str());
-00201         this->fc = c;
-00202 }
+
00270 {
+00271         file_cache c;
+00272         readfile(c,filename.c_str());
+00273         this->fc = c;
+00274 }
 
    
   

   

     
       
-          
+          
@@ -225,19 +272,17 @@ References fc.
     

         
 string FileReader::GetLine  std::string FileReader::GetLine 
           ( 
           int 
             x          
 
 

-Retrieve one line from the file.
-

-This method retrieves one line from the text file. If an empty non-NULL string is returned, the index was out of bounds, or the line had no data on it.
+
 

-Definition at line 208 of file modules.cpp.
+Definition at line 293 of file modules.cpp.
 

-References fc.
+References fc.
 

-
00209 {
-00210         if ((x<0) || (x>fc.size()))
-00211                 return "";
-00212         return fc[x];
-00213 }
+
00294 {
+00295         if ((x<0) || (x>fc.size()))
+00296                 return "";
+00297         return fc[x];
+00298 }
 
    

   

 

@@ -249,7 +294,7 @@ References fc.
         

            void FileReader::LoadFile 
           ( string std::string 
             filename          
           ) 
           

 

@@ -290,7 +335,7 @@ References fc, and 
       
-          

         
 file_cache FileReader::fc [private]
+           file_cache FileReader::fc [private]
       

     
   
@@ -305,14 +350,14 @@ References fc, and 
 
 

-Definition at line 299 of file modules.h.
+Definition at line 349 of file modules.h.
 

-Referenced by FileReader(), FileSize(), GetLine(), and LoadFile().    
+Referenced by Exists(), FileReader(), FileSize(), GetLine(), and LoadFile().    
   
 
 
The documentation for this class was generated from the following files:
-
Generated on Sun Mar 30 19:36:00 2003 for InspIRCd by
+
Generated on Fri Apr 2 13:37:39 2004 for InspIRCd by
 
 doxygen1.3-rc3 

-- 
cgit v1.3.1-10-gc9f91