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>

Inheritance diagram for FileReader:

Inheritance graph
[legend]
Collaboration diagram for FileReader:

Collaboration graph
[legend]
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 ()
 Retrieve one line from the file.

std::string GetLine (int x)
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 403 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 305 of file modules.cpp. 

00306 {
00307 }

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

References fc, and file_cache. 

00299 {
00300         file_cache c;
00301         readfile(c,filename.c_str());
00302         this->fc = c;
00303 }

FileReader::~FileReader (    ) 
 

Default destructor.

This deletes the memory allocated to the file.

Definition at line 317 of file modules.cpp. 

00318 {
00319 }

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

References fc. 

00322 {
00323         if (fc.size() == 0)
00324         {
00325                 return(false);
00326         }
00327         else
00328         {
00329                 return(true);
00330         }
00331 }

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

References fc. 

00341 {
00342         return fc.size();
00343 }

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

Definition at line 333 of file modules.cpp.

References fc. 

00334 {
00335         if ((x<0) || (x>fc.size()))
00336                 return "";
00337         return fc[x];
00338 }

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

References fc, and file_cache. 

00310 {
00311         file_cache c;
00312         readfile(c,filename.c_str());
00313         this->fc = c;
00314 }

Member Data Documentation

file_cache FileReader::fc [private]
 

Definition at line 405 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 Sun Apr 4 23:02:27 2004 for InspIRCd by doxygen1.3-rc3