1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
|
.TH "FileReader" 3 "13 Apr 2005" "InspIRCd" \" -*- nroff -*-
.ad l
.nh
.SH NAME
FileReader \- Caches a text file into memory and can be used to retrieve lines from it.
.PP
.SH SYNOPSIS
.br
.PP
\fC#include <modules.h>\fP
.PP
Inherits \fBclassbase\fP.
.PP
.SS "Public Member Functions"
.in +1c
.ti -1c
.RI "\fBFileReader\fP ()"
.br
.RI "\fIDefault constructor. \fP"
.ti -1c
.RI "\fBFileReader\fP (std::string filename)"
.br
.RI "\fISecondary constructor. \fP"
.ti -1c
.RI "\fB~FileReader\fP ()"
.br
.RI "\fIDefault destructor. \fP"
.ti -1c
.RI "void \fBLoadFile\fP (std::string filename)"
.br
.RI "\fIUsed to load a file. \fP"
.ti -1c
.RI "bool \fBExists\fP ()"
.br
.RI "\fIReturns true if the file exists This function will return false if the file could not be opened. \fP"
.ti -1c
.RI "std::string \fBGetLine\fP (int x)"
.br
.RI "\fIRetrieve one line from the file. \fP"
.ti -1c
.RI "int \fBFileSize\fP ()"
.br
.RI "\fIReturns the size of the file in lines. \fP"
.in -1c
.SS "Private Attributes"
.in +1c
.ti -1c
.RI "\fBfile_cache\fP \fBfc\fP"
.br
.in -1c
.SH "Detailed Description"
.PP
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 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 827 of file modules.cpp.
.PP
.nf
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 820 of file modules.cpp.
.PP
References fc, and file_cache.
.PP
.nf
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 839 of file modules.cpp.
.PP
.nf
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 843 of file modules.cpp.
.PP
References fc.
.PP
.nf
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 862 of file modules.cpp.
.PP
References fc.
.PP
.nf
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 855 of file modules.cpp.
.PP
References fc.
.PP
.nf
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 831 of file modules.cpp.
.PP
References fc, and file_cache.
.PP
.nf
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 871 of file modules.h.
.PP
Referenced by Exists(), FileReader(), FileSize(), GetLine(), and LoadFile().
.SH "Author"
.PP
Generated automatically by Doxygen for InspIRCd from the source code.
|
