@@ -35,29 +35,29 @@ class QTextStream;
3535* for parsing each record. The following options are supported:
3636* - Basic whitespace parsing. Each line in the file is treated as a record.
3737* Extracts all contiguous sequences of non-whitespace
38- * characters. Leading and trailing whitespace are ignored.
39- * - Regular expression parsing. Each line in the file is treated as a record.
40- * The string is split into fields based on a regular expression.
41- * - Character delimited, based on a delimiter character set, a quote character, and
38+ * characters. Leading and trailing whitespace are ignored.
39+ * - Regular expression parsing. Each line in the file is treated as a record.
40+ * The string is split into fields based on a regular expression.
41+ * - Character delimited, based on a delimiter character set, a quote character, and
4242* an escape character. The escape treats the next character as a part of a field.
43- * Fields may start and end with quote characters, in which case any non-escaped
43+ * Fields may start and end with quote characters, in which case any non-escaped
4444* character within the field is treated literally, including end of line characters.
4545* The escape character within a string causes the next character to be read literally
46- * (this includes new line characters). If the escape and quote characters are the
47- * same, then only quote characters will be escaped (ie to include a quote in a
46+ * (this includes new line characters). If the escape and quote characters are the
47+ * same, then only quote characters will be escaped (ie to include a quote in a
4848* quoted field it is entered as two quotes. All other characters in quoted fields
4949* are treated literally, including newlines.
5050* - CSV format files - these are a special case of character delimited, in which the
5151* delimiter is a comma, and the quote and escape characters are double quotes (")
5252*
53- * The delimiters can be encode in and decoded from a QUrl as query items. The
53+ * The delimiters can be encode in and decoded from a QUrl as query items. The
5454* items used are:
55- * - delimiterType, one of plain (delimiter is any of a set of characters),
55+ * - delimiterType, one of plain (delimiter is any of a set of characters),
5656* regexp, csv, whitespace
5757* - delimiter, interpreted according to the type. For plain characters this is
5858* a sequence of characters. The string \t in the sequence is replaced by a tab.
59- * For regexp type delimiters this specifies the reqular expression.
60- * The field is ignored for csv and whitespace
59+ * For regexp type delimiters this specifies the reqular expression.
60+ * The field is ignored for csv and whitespace
6161* - quoteChar, optional, a single character used for quoting plain fields
6262* - escapeChar, optional, a single characer used for escaping (may be the same as quoteChar)
6363*/
@@ -66,10 +66,10 @@ class QTextStream;
6666// on an abstract base class in order to facilitate changing the type of the parser easily
6767// eg in the provider dialog
6868
69- class QgsDelimitedTextFile
69+ class QgsDelimitedTextFile
7070{
7171
72- public:
72+ public:
7373
7474 enum Status
7575 {
@@ -91,14 +91,16 @@ class QgsDelimitedTextFile
9191
9292 virtual ~QgsDelimitedTextFile ();
9393
94- /* * Set the filename
94+ /* * Set the filename
9595 * @param filename the name of the file
9696 */
9797 void setFileName ( QString filename );
98- /* * Return the filename
98+ /* * Return the filename
9999 * @return filename the name of the file
100100 */
101- QString fileName (){ return mFileName ; }
101+ QString fileName () {
102+ return mFileName ;
103+ }
102104
103105 /* * Decode the parser settings from a url as a string
104106 * @param url The url from which the delimiter and delimiterType items are read
@@ -125,7 +127,7 @@ class QgsDelimitedTextFile
125127 /* * Set the parser to use a character type delimiter.
126128 * @param delim The field delimiter character set
127129 * @param quote The quote character, used to define quoted fields
128- * @param escape The escape character used to escape quote or delim
130+ * @param escape The escape character used to escape quote or delim
129131 * characters.
130132 */
131133 void setTypeCSV ( QString delim=QString(" ," " \" " " \" "
@@ -136,11 +138,15 @@ class QgsDelimitedTextFile
136138 * return an unlimited number of fields
137139 * @param maxFields The maximum number of fields into which a record will be split
138140 */
139- void setMaxFields ( int maxFields ){ mMaxFields = maxFields; }
141+ void setMaxFields ( int maxFields ) {
142+ mMaxFields = maxFields;
143+ }
140144 /* Return the maximum number of fields to return
141- * @return maxFields The maximum number of fields to return
145+ * @return maxFields The maximum number of fields to return
142146 */
143- int maxFields (){ return mMaxFields ; }
147+ int maxFields () {
148+ return mMaxFields ;
149+ }
144150
145151 /* Set the number of header lines to skip
146152 * @param skiplines The maximum lines to skip
@@ -149,7 +155,9 @@ class QgsDelimitedTextFile
149155 /* Return the number of header lines to skip
150156 * @return skiplines The maximum lines to skip
151157 */
152- int skipLines (){ return mSkipLines ; }
158+ int skipLines () {
159+ return mSkipLines ;
160+ }
153161
154162 /* Set reading column names from the first record
155163 * @param useheaders Column names will be read if true
@@ -158,15 +166,17 @@ class QgsDelimitedTextFile
158166 /* Return the option for reading column names from the first record
159167 * @return useheaders Column names will be read if true
160168 */
161- bool useHeader (){ return mUseHeader ; }
169+ bool useHeader () {
170+ return mUseHeader ;
171+ }
162172
163173 /* * Return the column names read from the header, or default names
164174 * Col## if none defined. Will open and read the head of the file
165175 * if required, then reset..
166176 */
167177 QStringList &columnNames ();
168178
169- /* * Reads the next record from the stream splits into string fields.
179+ /* * Reads the next record from the stream splits into string fields.
170180 * @param fields The string list to populate with the fields
171181 * @return status The result of trying to parse a record. RecordOk
172182 * if read successfully, RecordEOF if reached the end of the
@@ -178,7 +188,9 @@ class QgsDelimitedTextFile
178188 /* * Return the line number of the start of the last record read
179189 * @return linenumber The line number of the start of the record
180190 */
181- int recordLineNumber (){ return mRecordLineNumber ; }
191+ int recordLineNumber () {
192+ return mRecordLineNumber ;
193+ }
182194
183195 /* * Reset the file to reread from the beginning
184196 */
@@ -192,15 +204,21 @@ class QgsDelimitedTextFile
192204 * or a string)
193205 * @return def The delimiter definition string
194206 */
195- QString delimiterDefinitionString (){ return mDelimDefinition ; }
207+ QString delimiterDefinitionString () {
208+ return mDelimDefinition ;
209+ }
196210 /* * Return the quote character
197211 * @return quote The quoet character
198212 */
199- QString quoteChar (){ return mQuoteChar ; }
213+ QString quoteChar () {
214+ return mQuoteChar ;
215+ }
200216 /* * Return the escape character
201217 * @return escape The escape character
202218 */
203- QString escapeChar (){ return mEscapeChar ; }
219+ QString escapeChar () {
220+ return mEscapeChar ;
221+ }
204222
205223 /* * Check that provider is valid (filename and definition valid)
206224 *
@@ -209,7 +227,7 @@ class QgsDelimitedTextFile
209227 bool isValid ();
210228
211229
212- private:
230+ private:
213231
214232 /* * Open the file
215233 *
@@ -243,7 +261,7 @@ class QgsDelimitedTextFile
243261 QString mFileName ;
244262 QFile *mFile ;
245263 QTextStream *mStream ;
246-
264+
247265 // Parameters common to parsers
248266 bool mDefinitionValid ;
249267 DelimiterType mType ;
@@ -260,6 +278,6 @@ class QgsDelimitedTextFile
260278
261279 // Information extracted from file
262280 QStringList mColumnNames ;
263- int mRecordLineNumber ;
264281 int mLineNumber ;
282+ int mRecordLineNumber ;
265283};
0 commit comments