|
libFAUDES
Sections
Index
|
faudes::TokenReader Class ReferenceA TokenReader reads sequential tokens from a file or string. More...
Detailed DescriptionA TokenReader reads sequential tokens from a file or string. It can get or peek the next token and it will track line numbers for informative diagnosis output. The class also implements nested sections. That is, you may search for a (sub-)section within the current section and, hence, implement file formats that do not insist in a particular ordering of the sections (e.g. a Generator consists of states, transitions and events, no matter in which order). Convenience functions are provided to read a token of a particular type and throws faudes::Exception on token mismatch. You may catch the exception as follows: try { some tokenreader operations } catch (faudes::Exception& ex) { cerr << "Error reading file (details: " << ex.What() << ")" << endl; } Note that in addition to the documented execeptions all TokenReader functions do pass on faudes ios errors from the Token class. Definition at line 59 of file cfl_tokenreader.h. Member Enumeration DocumentationMode of operation: read from file, stdin or string. Definition at line 65 of file cfl_tokenreader.h. Constructor & Destructor Documentation
TokenReader constructor.
Definition at line 31 of file cfl_tokenreader.cpp.
Creates a TokenReader for reading complete file.
Definition at line 67 of file cfl_tokenreader.cpp.
Destruct. Definition at line 88 of file cfl_tokenreader.cpp. Member Function Documentation
Peek a token and check whether it ends the specified section. This function is meant for scanning a section with a while- construct.
Definition at line 358 of file cfl_tokenreader.cpp.
This function searches for the specified section on the current level, it skips any sections on levels below, and it will wrap to the begin of the current section. In the case of success, it returns true, else false. In contrast to other token i/o methodes, this method will not throw any execptions.
Definition at line 287 of file cfl_tokenreader.cpp.
Return "filename:line". Definition at line 446 of file cfl_tokenreader.cpp.
Get the filename. Return dummy values for console or string mode.
Definition at line 117 of file cfl_tokenreader.cpp.
Get next token. False indicates eof.
Definition at line 144 of file cfl_tokenreader.cpp.
Get state of TokenReader stream.
Return number of lines read.
Definition at line 441 of file cfl_tokenreader.cpp.
Operator for get. Definition at line 316 of file cfl_tokenreader.h.
Peek next token. False indicates eof.
Definition at line 122 of file cfl_tokenreader.cpp.
Open a section by specified label. This function searches for the section on this level, it skips any sections on levels below this level, and it will wrap to the begin of the current section. In the case of success, the matching begin token is the last token read. After processing the section, a matching ReadEnd(label) must be called.
Definition at line 237 of file cfl_tokenreader.cpp.
Read binary token. You can access the binary array via StringValue();
Definition at line 425 of file cfl_tokenreader.cpp.
Close the current section by matching the previous ReadBegin(). Reads all tokens up to and including end of current section.
Definition at line 332 of file cfl_tokenreader.cpp.
Read integer token.
Definition at line 374 of file cfl_tokenreader.cpp.
Rewind stream (must be a seekable stream).
Definition at line 93 of file cfl_tokenreader.cpp.
Open a section by specified label. This function searches for the section on this level and any descending level. However, this funtion will not rewind to the beginning of the current section (this may change in a future revision). In the case of success, the matching begin token is the last token read. After processing the section, a matching SeekEnd(label) must be called.
Definition at line 173 of file cfl_tokenreader.cpp.
Close the current section by matching the previous SeekBegin(). Reads all tokens up to the level when SeekBegin() was called.
Definition at line 209 of file cfl_tokenreader.cpp.
Member Data Documentation
Filename. Definition at line 347 of file cfl_tokenreader.h.
file position Definition at line 353 of file cfl_tokenreader.h.
actual stream object, file input Definition at line 341 of file cfl_tokenreader.h.
validity of peek buffer Definition at line 371 of file cfl_tokenreader.h.
recent string buffer Definition at line 368 of file cfl_tokenreader.h.
Level (of nested sections). Definition at line 356 of file cfl_tokenreader.h.
file line of sections Definition at line 362 of file cfl_tokenreader.h.
file positions of sections Definition at line 359 of file cfl_tokenreader.h.
Line counter. Definition at line 350 of file cfl_tokenreader.h.
input mode Definition at line 335 of file cfl_tokenreader.h.
peek buffer Definition at line 374 of file cfl_tokenreader.h.
actual stream object on heap, string input Definition at line 344 of file cfl_tokenreader.h.
istream object pointer Definition at line 338 of file cfl_tokenreader.h.
level of recent seek Definition at line 365 of file cfl_tokenreader.h. The documentation for this class was generated from the following files: |
libFAUDES 2.16b --- 2010-9-8 --- c++ source docu by doxygen 1.6.3