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

00871 {
00872 }

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

References fc, and file_cache. 

00864 {
00865         file_cache c;
00866         readfile(c,filename.c_str());
00867         this->fc = c;
00868 }

FileReader::~FileReader (   ) 
 

Default destructor.

This deletes the memory allocated to the file.

Definition at line 882 of file modules.cpp. 

00883 {
00884 }

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

References fc. 

00887 {
00888         if (fc.size() == 0)
00889         {
00890                 return(false);
00891         }
00892         else
00893         {
00894                 return(true);
00895         }
00896 }

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

References fc. 

00906 {
00907         return fc.size();
00908 }

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

References fc. 

00899 {
00900         if ((x<0) || (x>fc.size()))
00901                 return "";
00902         return fc[x];
00903 }

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

References fc, and file_cache. 

00875 {
00876         file_cache c;
00877         readfile(c,filename.c_str());
00878         this->fc = c;
00879 }

Member Data Documentation

file_cache FileReader::fc [private]
 

Definition at line 982 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 16 14:49:51 2005 for InspIRCd by doxygen 1.3.3