Main Page   Class Hierarchy   Alphabetical List   Compound List   File List   Compound Members   File Members  

FileReader Class Reference

Caches a text file into memory and can be used to retrieve lines from it. More...

#include <modules.h>

List of all members.

Public Methods

 FileReader ()
 Default constructor.

 FileReader (string filename)
 Secondary constructor.

 ~FileReader ()
 Default destructor.

void LoadFile (string filename)
 Used to load a file.

string GetLine (int x)
 Retrieve one line from the file.

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


Private Attributes

file_cache fc

Detailed Description

Caches a text file into memory and can be used to retrieve lines from it.

This class contains methods for read-only manipulation of a text file in memory. Either use the constructor type with one parameter to load a file into memory at construction, or use the LoadFile method to load a file.

Definition at line 277 of file modules.h.

Constructor & Destructor Documentation

FileReader::FileReader (    ) 
 

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

00206 {
00207 }

FileReader::FileReader (  string    filename ) 
 

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.

Definition at line 198 of file modules.cpp.

References fc, and file_cache. 

00199 {
00200         file_cache c;
00201         readfile(c,filename.c_str());
00202         this->fc = c;
00203 }

FileReader::~FileReader (    ) 
 

Default destructor.

This deletes the memory allocated to the file.

Definition at line 216 of file modules.cpp. 

00217 {
00218 }

Member Function Documentation

int FileReader::FileSize (    ) 
 

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

References fc. 

00228 {
00229         return fc.size();
00230 }

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

References fc. 

00221 {
00222         if ((x<0) || (x>fc.size()))
00223                 return "";
00224         return fc[x];
00225 }

void FileReader::LoadFile (  string    filename ) 
 

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.

Definition at line 209 of file modules.cpp.

References fc, and file_cache. 

00210 {
00211         file_cache c;
00212         readfile(c,filename.c_str());
00213         this->fc = c;
00214 }

Member Data Documentation

file_cache FileReader::fc [private]
 

Definition at line 279 of file modules.h.

Referenced by FileReader(), FileSize(), GetLine(), and LoadFile().

The documentation for this class was generated from the following files:
Generated on Thu Jan 23 20:28:59 2003 for InspIRCd by doxygen1.3-rc2