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 ()
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 522 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 366 of file modules.cpp. 

00367 {
00368 }

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

References fc, and file_cache. 

00360 {
00361         file_cache c;
00362         readfile(c,filename.c_str());
00363         this->fc = c;
00364 }

FileReader::~FileReader (    ) 
 

Default destructor.

This deletes the memory allocated to the file.

Definition at line 378 of file modules.cpp. 

00379 {
00380 }

Member Function Documentation

bool FileReader::Exists (    ) 
 

Definition at line 382 of file modules.cpp.

References fc. 

00383 {
00384         if (fc.size() == 0)
00385         {
00386                 return(false);
00387         }
00388         else
00389         {
00390                 return(true);
00391         }
00392 }

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

References fc. 

00402 {
00403         return fc.size();
00404 }

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

References fc. 

00395 {
00396         if ((x<0) || (x>fc.size()))
00397                 return "";
00398         return fc[x];
00399 }

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

References fc, and file_cache. 

00371 {
00372         file_cache c;
00373         readfile(c,filename.c_str());
00374         this->fc = c;
00375 }

Member Data Documentation

file_cache FileReader::fc [private]
 

Definition at line 524 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 Wed Apr 7 19:20:44 2004 for InspIRCd by doxygen1.3-rc3