From 73b9d0c5cb02f0ea8350de28bc3687e0af70ea0f Mon Sep 17 00:00:00 2001 From: brain Date: Thu, 23 Jan 2003 19:45:57 +0000 Subject: Initial revision git-svn-id: http://svn.inspircd.org/repository/trunk/inspircd@132 e03df62e-2008-0410-955e-edbf42e46eb7 --- docs/module-doc/classFileReader.html | 312 +++++++++++++++++++++++++++++++++++ 1 file changed, 312 insertions(+) create mode 100644 docs/module-doc/classFileReader.html (limited to 'docs/module-doc/classFileReader.html') diff --git a/docs/module-doc/classFileReader.html b/docs/module-doc/classFileReader.html new file mode 100644 index 000000000..ee84a6d74 --- /dev/null +++ b/docs/module-doc/classFileReader.html @@ -0,0 +1,312 @@ + + +FileReader class Reference + + + + +Main Page 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> +

+List of all members. + + + + + + + + + + + + + + + + +

Public Methods
FileReader ()
Default constructor.

FileReader (string filename)
Secondary constructor.

~FileReader ()
Default destructor.

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

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 271 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 202 of file modules.cpp. +
+
00203 { +00204 } +

+

+ + + + +
+ + + + + + + + + + +
FileReader::FileReader ( 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 195 of file modules.cpp. +
+References fc, and file_cache. +
+
00196 { +00197 file_cache c; +00198 readfile(c,filename.c_str()); +00199 this->fc = c; +00200 } +

+

+ + + + +
+ + + + + + + + + +
FileReader::~FileReader ( )
+
+ + + + + +
+ + + +
+Default destructor. +
+This deletes the memory allocated to the file. +
+Definition at line 213 of file modules.cpp. +
+
00214 { +00215 } +

+

Member Function Documentation

+ + + + +
+ + + + + + + + + +
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 224 of file modules.cpp. +
+References fc. +
+
00225 { +00226 return fc.size(); +00227 } +

+

+ + + + +
+ + + + + + + + + + +
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 217 of file modules.cpp. +
+References fc. +
+
00218 { +00219 if ((x<0) || (x>fc.size())) +00220 return ""; +00221 return fc[x]; +00222 } +

+

+ + + + +
+ + + + + + + + + + +
void FileReader::LoadFile ( 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 206 of file modules.cpp. +
+References fc, and file_cache. +
+
00207 { +00208 file_cache c; +00209 readfile(c,filename.c_str()); +00210 this->fc = c; +00211 } +

+

Member Data Documentation

+ + + + +
+ + +
file_cache FileReader::fc [private] +
+
+ + + + + +
+ + + +
+ +
+Definition at line 273 of file modules.h. +
+Referenced by FileReader(), FileSize(), GetLine(), and LoadFile().
+

The documentation for this class was generated from the following files:

Generated on Wed Jan 22 20:56:48 2003 for InspIRCd by + +

1.3-rc2

+ + -- cgit v1.3.1-10-gc9f91


Public Methods
	FileReader ()
	Default constructor.
	FileReader (string filename)
	Secondary constructor.
	~FileReader ()
	Default destructor.
void	LoadFile (string filename)
	Used to load a file.
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