[80] | 1 | // |
---|
| 2 | // StreamTokenizer.h |
---|
| 3 | // |
---|
| 4 | // $Id: //poco/1.3/Foundation/include/Poco/StreamTokenizer.h#1 $ |
---|
| 5 | // |
---|
| 6 | // Library: Foundation |
---|
| 7 | // Package: Streams |
---|
| 8 | // Module: StreamTokenizer |
---|
| 9 | // |
---|
| 10 | // Definition of the StreamTokenizer class. |
---|
| 11 | // |
---|
| 12 | // Copyright (c) 2004-2006, Applied Informatics Software Engineering GmbH. |
---|
| 13 | // and Contributors. |
---|
| 14 | // |
---|
| 15 | // Permission is hereby granted, free of charge, to any person or organization |
---|
| 16 | // obtaining a copy of the software and accompanying documentation covered by |
---|
| 17 | // this license (the "Software") to use, reproduce, display, distribute, |
---|
| 18 | // execute, and transmit the Software, and to prepare derivative works of the |
---|
| 19 | // Software, and to permit third-parties to whom the Software is furnished to |
---|
| 20 | // do so, all subject to the following: |
---|
| 21 | // |
---|
| 22 | // The copyright notices in the Software and this entire statement, including |
---|
| 23 | // the above license grant, this restriction and the following disclaimer, |
---|
| 24 | // must be included in all copies of the Software, in whole or in part, and |
---|
| 25 | // all derivative works of the Software, unless such copies or derivative |
---|
| 26 | // works are solely in the form of machine-executable object code generated by |
---|
| 27 | // a source language processor. |
---|
| 28 | // |
---|
| 29 | // THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR |
---|
| 30 | // IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, |
---|
| 31 | // FITNESS FOR A PARTICULAR PURPOSE, TITLE AND NON-INFRINGEMENT. IN NO EVENT |
---|
| 32 | // SHALL THE COPYRIGHT HOLDERS OR ANYONE DISTRIBUTING THE SOFTWARE BE LIABLE |
---|
| 33 | // FOR ANY DAMAGES OR OTHER LIABILITY, WHETHER IN CONTRACT, TORT OR OTHERWISE, |
---|
| 34 | // ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER |
---|
| 35 | // DEALINGS IN THE SOFTWARE. |
---|
| 36 | // |
---|
| 37 | |
---|
| 38 | |
---|
| 39 | #ifndef Foundation_StreamTokenizer_INCLUDED |
---|
| 40 | #define Foundation_StreamTokenizer_INCLUDED |
---|
| 41 | |
---|
| 42 | |
---|
| 43 | #include "Poco/Foundation.h" |
---|
| 44 | #include "Poco/Token.h" |
---|
| 45 | #include <istream> |
---|
| 46 | #include <vector> |
---|
| 47 | |
---|
| 48 | |
---|
| 49 | namespace Poco { |
---|
| 50 | |
---|
| 51 | |
---|
| 52 | class Foundation_API StreamTokenizer |
---|
| 53 | /// A stream tokenizer splits an input stream |
---|
| 54 | /// into a sequence of tokens of different kinds. |
---|
| 55 | /// Various token kinds can be registered with |
---|
| 56 | /// the tokenizer. |
---|
| 57 | { |
---|
| 58 | public: |
---|
| 59 | StreamTokenizer(); |
---|
| 60 | /// Creates a StreamTokenizer with no attached stream. |
---|
| 61 | |
---|
| 62 | StreamTokenizer(std::istream& istr); |
---|
| 63 | /// Creates a StreamTokenizer with no attached stream. |
---|
| 64 | |
---|
| 65 | virtual ~StreamTokenizer(); |
---|
| 66 | /// Destroys the StreamTokenizer and deletes all |
---|
| 67 | /// registered tokens. |
---|
| 68 | |
---|
| 69 | void attachToStream(std::istream& istr); |
---|
| 70 | /// Attaches the tokenizer to an input stream. |
---|
| 71 | |
---|
| 72 | void addToken(Token* pToken); |
---|
| 73 | /// Adds a token class to the tokenizer. The |
---|
| 74 | /// tokenizer takes ownership of the token and |
---|
| 75 | /// deletes it when no longer needed. Comment |
---|
| 76 | /// and whitespace tokens will be marked as |
---|
| 77 | /// ignorable, which means that next() will not |
---|
| 78 | /// return them. |
---|
| 79 | |
---|
| 80 | void addToken(Token* pToken, bool ignore); |
---|
| 81 | /// Adds a token class to the tokenizer. The |
---|
| 82 | /// tokenizer takes ownership of the token and |
---|
| 83 | /// deletes it when no longer needed. |
---|
| 84 | /// If ignore is true, the token will be marked |
---|
| 85 | /// as ignorable, which means that next() will |
---|
| 86 | /// not return it. |
---|
| 87 | |
---|
| 88 | const Token* next(); |
---|
| 89 | /// Extracts the next token from the input stream. |
---|
| 90 | /// Returns a pointer to an EOFToken if there are |
---|
| 91 | /// no more characters to read. |
---|
| 92 | /// Returns a pointer to an InvalidToken if an |
---|
| 93 | /// invalid character is encountered. |
---|
| 94 | /// If a token is marked as ignorable, it will not |
---|
| 95 | /// be returned, and the next token will be |
---|
| 96 | /// examined. |
---|
| 97 | /// Never returns a NULL pointer. |
---|
| 98 | /// You must not delete the token returned by next(). |
---|
| 99 | |
---|
| 100 | private: |
---|
| 101 | struct TokenInfo |
---|
| 102 | { |
---|
| 103 | Token* pToken; |
---|
| 104 | bool ignore; |
---|
| 105 | }; |
---|
| 106 | |
---|
| 107 | typedef std::vector<TokenInfo> TokenVec; |
---|
| 108 | |
---|
| 109 | TokenVec _tokens; |
---|
| 110 | std::istream* _pIstr; |
---|
| 111 | InvalidToken _invalidToken; |
---|
| 112 | EOFToken _eofToken; |
---|
| 113 | }; |
---|
| 114 | |
---|
| 115 | |
---|
| 116 | } // namespace Poco |
---|
| 117 | |
---|
| 118 | |
---|
| 119 | #endif // Foundation_StreamTokenizer_INCLUDED |
---|