diff options
Diffstat (limited to 'docs/man/man3/FileReader.3')
| -rw-r--r-- | docs/man/man3/FileReader.3 | 84 |
1 files changed, 42 insertions, 42 deletions
diff --git a/docs/man/man3/FileReader.3 b/docs/man/man3/FileReader.3 index 377933336..677e59b5d 100644 --- a/docs/man/man3/FileReader.3 +++ b/docs/man/man3/FileReader.3 @@ -1,4 +1,4 @@ -.TH "FileReader" 3 "4 Apr 2005" "InspIRCd" \" -*- nroff -*- +.TH "FileReader" 3 "7 Apr 2005" "InspIRCd" \" -*- nroff -*- .ad l .nh .SH NAME @@ -57,100 +57,100 @@ 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. .PP -Definition at line 764 of file modules.h. +Definition at line 774 of file modules.h. .SH "Constructor & Destructor Documentation" .PP .SS "FileReader::FileReader ()" .PP -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 730 of file modules.cpp. +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 732 of file modules.cpp. .PP .nf -731 { -732 } +733 { +734 } .fi .SS "FileReader::FileReader (std::string filename)" .PP -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, \fBFileReader::FileSize\fP returns 0.Definition at line 723 of file modules.cpp. +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, \fBFileReader::FileSize\fP returns 0.Definition at line 725 of file modules.cpp. .PP References fc, and file_cache. .PP .nf -724 { -725 file_cache c; -726 readfile(c,filename.c_str()); -727 this->fc = c; -728 } +726 { +727 file_cache c; +728 readfile(c,filename.c_str()); +729 this->fc = c; +730 } .fi .SS "FileReader::~\fBFileReader\fP ()" .PP -Default destructor. This deletes the memory allocated to the file.Definition at line 742 of file modules.cpp. +Default destructor. This deletes the memory allocated to the file.Definition at line 744 of file modules.cpp. .PP .nf -743 { -744 } +745 { +746 } .fi .SH "Member Function Documentation" .PP .SS "bool FileReader::Exists ()" .PP -Returns true if the file exists This function will return false if the file could not be opened. Definition at line 746 of file modules.cpp. +Returns true if the file exists This function will return false if the file could not be opened. Definition at line 748 of file modules.cpp. .PP References fc. .PP .nf -747 { -748 if (fc.size() == 0) -749 { -750 return(false); -751 } -752 else -753 { -754 return(true); -755 } -756 } +749 { +750 if (fc.size() == 0) +751 { +752 return(false); +753 } +754 else +755 { +756 return(true); +757 } +758 } .fi .SS "int FileReader::FileSize ()" .PP -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 765 of file modules.cpp. +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 767 of file modules.cpp. .PP References fc. .PP .nf -766 { -767 return fc.size(); -768 } +768 { +769 return fc.size(); +770 } .fi .SS "std::string FileReader::GetLine (int x)" .PP -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 758 of file modules.cpp. +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 760 of file modules.cpp. .PP References fc. .PP .nf -759 { -760 if ((x<0) || (x>fc.size())) -761 return ''; -762 return fc[x]; -763 } +761 { +762 if ((x<0) || (x>fc.size())) +763 return ''; +764 return fc[x]; +765 } .fi .SS "void FileReader::LoadFile (std::string filename)" .PP -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, \fBFileReader::FileSize\fP returns 0.Definition at line 734 of file modules.cpp. +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, \fBFileReader::FileSize\fP returns 0.Definition at line 736 of file modules.cpp. .PP References fc, and file_cache. .PP .nf -735 { -736 file_cache c; -737 readfile(c,filename.c_str()); -738 this->fc = c; -739 } +737 { +738 file_cache c; +739 readfile(c,filename.c_str()); +740 this->fc = c; +741 } .fi .SH "Member Data Documentation" .PP .SS "\fBfile_cache\fP \fBFileReader::fc\fP\fC [private]\fP" .PP -Definition at line 766 of file modules.h. +Definition at line 776 of file modules.h. .PP Referenced by Exists(), FileReader(), FileSize(), GetLine(), and LoadFile(). |