Main Page | Namespace List | 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>

Inherits classbase.

List of all members.

Public Member Functions

 FileReader ()
 Default constructor.

 FileReader (std::string filename)
 Secondary constructor.

 ~FileReader ()
 Default destructor.

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

bool Exists ()
 Returns true if the file exists This function will return false if the file could not be opened.

std::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 772 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 732 of file modules.cpp. 

00733 {
00734 }

FileReader::FileReader (  std::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 725 of file modules.cpp.

References fc, and file_cache. 

00726 {
00727         file_cache c;
00728         readfile(c,filename.c_str());
00729         this->fc = c;
00730 }

FileReader::~FileReader (   ) 
 

Default destructor.

This deletes the memory allocated to the file.

Definition at line 744 of file modules.cpp. 

00745 {
00746 }

Member Function Documentation

bool FileReader::Exists (   ) 
 

Returns true if the file exists This function will return false if the file could not be opened.

Definition at line 748 of file modules.cpp.

References fc. 

00749 {
00750         if (fc.size() == 0)
00751         {
00752                 return(false);
00753         }
00754         else
00755         {
00756                 return(true);
00757         }
00758 }

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

References fc. 

00768 {
00769         return fc.size();
00770 }

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

References fc. 

00761 {
00762         if ((x<0) || (x>fc.size()))
00763                 return "";
00764         return fc[x];
00765 }

void FileReader::LoadFile (  std::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 736 of file modules.cpp.

References fc, and file_cache. 

00737 {
00738         file_cache c;
00739         readfile(c,filename.c_str());
00740         this->fc = c;
00741 }

Member Data Documentation

file_cache FileReader::fc [private]
 

Definition at line 774 of file modules.h.

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

The documentation for this class was generated from the following files:
Generated on Sat Apr 9 14:38:29 2005 for InspIRCd by doxygen 1.3.3