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 0b9e07501..bcc5f2c28 100644 --- a/docs/man/man3/FileReader.3 +++ b/docs/man/man3/FileReader.3 @@ -1,4 +1,4 @@ -.TH "FileReader" 3 "9 Apr 2005" "InspIRCd" \" -*- nroff -*- +.TH "FileReader" 3 "13 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 772 of file modules.h. +Definition at line 869 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 732 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 827 of file modules.cpp. .PP .nf -733 { -734 } +828 { +829 } .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 725 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 820 of file modules.cpp. .PP References fc, and file_cache. .PP .nf -726 { -727 file_cache c; -728 readfile(c,filename.c_str()); -729 this->fc = c; -730 } +821 { +822 file_cache c; +823 readfile(c,filename.c_str()); +824 this->fc = c; +825 } .fi .SS "FileReader::~\fBFileReader\fP ()" .PP -Default destructor. This deletes the memory allocated to the file.Definition at line 744 of file modules.cpp. +Default destructor. This deletes the memory allocated to the file.Definition at line 839 of file modules.cpp. .PP .nf -745 { -746 } +840 { +841 } .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 748 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 843 of file modules.cpp. .PP References fc. .PP .nf -749 { -750 if (fc.size() == 0) -751 { -752 return(false); -753 } -754 else -755 { -756 return(true); -757 } -758 } +844 { +845 if (fc.size() == 0) +846 { +847 return(false); +848 } +849 else +850 { +851 return(true); +852 } +853 } .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 767 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 862 of file modules.cpp. .PP References fc. .PP .nf -768 { -769 return fc.size(); -770 } +863 { +864 return fc.size(); +865 } .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 760 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 855 of file modules.cpp. .PP References fc. .PP .nf -761 { -762 if ((x<0) || (x>fc.size())) -763 return ''; -764 return fc[x]; -765 } +856 { +857 if ((x<0) || (x>fc.size())) +858 return ''; +859 return fc[x]; +860 } .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 736 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 831 of file modules.cpp. .PP References fc, and file_cache. .PP .nf -737 { -738 file_cache c; -739 readfile(c,filename.c_str()); -740 this->fc = c; -741 } +832 { +833 file_cache c; +834 readfile(c,filename.c_str()); +835 this->fc = c; +836 } .fi .SH "Member Data Documentation" .PP .SS "\fBfile_cache\fP \fBFileReader::fc\fP\fC [private]\fP" .PP -Definition at line 774 of file modules.h. +Definition at line 871 of file modules.h. .PP Referenced by Exists(), FileReader(), FileSize(), GetLine(), and LoadFile(). |