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
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
|
.TH "FileReader" 3 "9 Dec 2005" "Version 1.0Betareleases" "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 (\fBstd::string\fP filename)"
.br
.RI "\fISecondary constructor. \fP"
.ti -1c
.RI "\fB~FileReader\fP ()"
.br
.RI "\fIDefault destructor. \fP"
.ti -1c
.RI "void \fBLoadFile\fP (\fBstd::string\fP 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 "\fBstd::string\fP \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 1599 of file modules.h.
.SH "Constructor & Destructor Documentation"
.PP
.SS "FileReader::FileReader ()"
.PP
Default constructor.
.PP
This method does not load any file into memory, you must use the LoadFile method after constructing the class this way.
.PP
Definition at line 988 of file modules.cpp.
.PP
.nf
989 {
990 }
.fi
.PP
.SS "FileReader::FileReader (\fBstd::string\fP filename)"
.PP
Secondary constructor.
.PP
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.
.PP
Definition at line 981 of file modules.cpp.
.PP
References fc.
.PP
.nf
982 {
983 file_cache c;
984 readfile(c,filename.c_str());
985 this->fc = c;
986 }
.fi
.PP
.SS "FileReader::~FileReader ()"
.PP
Default destructor.
.PP
This deletes the memory allocated to the file.
.PP
Definition at line 1000 of file modules.cpp.
.PP
.nf
1001 {
1002 }
.fi
.PP
.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.
.PP
Definition at line 1004 of file modules.cpp.
.PP
References fc.
.PP
.nf
1005 {
1006 if (fc.size() == 0)
1007 {
1008 return(false);
1009 }
1010 else
1011 {
1012 return(true);
1013 }
1014 }
.fi
.PP
.SS "int FileReader::FileSize ()"
.PP
Returns the size of the file in lines.
.PP
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.
.PP
Definition at line 1023 of file modules.cpp.
.PP
References fc.
.PP
.nf
1024 {
1025 return fc.size();
1026 }
.fi
.PP
.SS "\fBstd::string\fP FileReader::GetLine (int x)"
.PP
Retrieve one line from the file.
.PP
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.
.PP
Definition at line 1016 of file modules.cpp.
.PP
References fc.
.PP
.nf
1017 {
1018 if ((x<0) || ((unsigned)x>fc.size()))
1019 return '';
1020 return fc[x];
1021 }
.fi
.PP
.SS "void FileReader::LoadFile (\fBstd::string\fP filename)"
.PP
Used to load a file.
.PP
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.
.PP
Definition at line 992 of file modules.cpp.
.PP
References fc.
.PP
.nf
993 {
994 file_cache c;
995 readfile(c,filename.c_str());
996 this->fc = c;
997 }
.fi
.PP
.SH "Member Data Documentation"
.PP
.SS "\fBfile_cache\fP \fBFileReader::fc\fP\fC [private]\fP"
.PP
Definition at line 1601 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.
|
