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 ()
 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 578 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 398 of file modules.cpp.

00399 {
00400 }

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

References fc, and file_cache.

00392 {
00393         file_cache c;
00394         readfile(c,filename.c_str());
00395         this->fc = c;
00396 }

FileReader::~FileReader  
 

Default destructor.

This deletes the memory allocated to the file.

Definition at line 410 of file modules.cpp.

00411 {
00412 }


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

References fc.

00415 {
00416         if (fc.size() == 0)
00417         {
00418                 return(false);
00419         }
00420         else
00421         {
00422                 return(true);
00423         }
00424 }

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

References fc.

00434 {
00435         return fc.size();
00436 }

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

References fc.

00427 {
00428         if ((x<0) || (x>fc.size()))
00429                 return "";
00430         return fc[x];
00431 }

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

References fc, and file_cache.

00403 {
00404         file_cache c;
00405         readfile(c,filename.c_str());
00406         this->fc = c;
00407 }


Member Data Documentation

file_cache FileReader::fc [private]
 

Definition at line 580 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 Fri Apr 30 13:23:32 2004 for InspIRCd by doxygen1.3-rc3