| blob | 497e13c591e92ca0c672eb7f81dd2e3b017e09e2 |
1 /*
2 * Copyright 2002-2009, Haiku Inc.
3 * Distributed under the terms of the MIT License.
4 *
5 * Authors:
6 * Tyler Dauwalder
7 */
12 #include <sniffer/Err.h>
13 #include <StorageDefs.h>
15 #include <stdio.h>
32 :
34 {
35 }
39 :
41 {
42 }
46 {
47 }
50 /*! \brief Reads the next string from the stream
52 - Strings are either unquoted or quoted strings on a single line.
53 - Whitespace is either spaces or tabs.
54 - Newlines separate lines and are never included in strings.
55 - Comments extend to the end of the line and must begin the line
56 with #. Technically speaking, any "string" that begins with #
57 will be treated as a comment that extends to the end of the line.
58 However, as all strings of interest are full pathnames, application
59 signatures, integers, or Recent{Doc,Folder,App}, this does not
60 currently pose a problem.
61 - Quotes are " or '
62 - An unquoted string begins with any character execept whitespace
63 or a quote and continues until a whitespace character, newline,
64 or comment is encountered. Whitespace may be included in the
65 unquoted string if each whitespace character is escaped with a
66 '\' character. Escaped characters are converted to the actual
67 characters they represent before being stored in the result.
68 If the string begins with an unescaped # character, it will be
69 treated as a comment that extends to the end of the line. #
70 characters may appear unescaped anywhere else in the string.
71 - A quoted string begins with a quote and continues until a matching
72 quote is encountered. If a newline is found before that point,
73 kEndOfLine is returned. If the end of the stream is found before
74 that point, kEndOfStream is returned.
76 \param result Pointer to a pre-allocated character string into which
77 the result is copied. Since all strings to be read from
78 the RosterSettings file are filenames, mime strings, or
79 fixed length strings, each string is assumed to be of
80 length \c B_PATH_NAME_LENGTH or less. If the string is
81 discovered to be longer, reading is aborted and an
82 error code is returned.
83 \return
84 */
85 status_t
87 {
95 rsssStart,
96 rsssUnquoted,
97 rsssQuoted,
98 rsssEscape,
99 };
112 // For NULL terminating
114 }
126 // Acceptable whitespace, so ignore it.
130 // Premature end of line
136 // Escape sequence
143 // Valid quote
149 // End-Of-Text
154 }
155 // else fall through...
158 // Valid unquoted character
162 }
169 // Terminating whitespace
174 // End of line
180 // Escape sequence
186 // End-Of-Text
191 }
192 // else fall through...
195 // comments must begin the string, thus
196 // this char also falls through...
199 // Valid unquoted character
202 }
207 // Terminating quote
212 // End of line
218 // Escape sequence
224 // End-Of-Text
229 }
230 // else fall through...
233 // Valid quoted character
236 }
237 }
243 // End of line cannot be escaped
249 // End-Of-Text
254 }
255 // else fall through...
258 // Valid unquoted character
262 }
269 }
270 }
272 // Read past any comments
274 // Read to the end of the line. If a valid read still occured,
275 // leave the newline in the stream for next time.
281 }
282 // Replace the newline if the comment was hit immediately
283 // preceding the unquoted string
287 }
288 // Clear an error if we hit a newline or end of text while reading an
289 // unquoted string
293 }
295 // NULL terminate regardless
301 }
304 /*! \brief Reads past any remaining characters on the current line.
306 If successful, the stream is left positioned at the beginning of
307 the next line.
309 \return
310 - \c B_OK: success
311 - kEndOfStream: The end of the stream was reached.
312 */
313 status_t
315 {
322 }
323 }