Iterates the text in a CodeDocument.
More...
List of all members.
Public Member Functions |
| | Iterator (CodeDocument *document) |
| | Iterator (const Iterator &other) |
| Iterator & | operator= (const Iterator &other) noexcept |
| | ~Iterator () noexcept |
| juce_wchar | nextChar () |
| | Reads the next character and returns it.
|
| juce_wchar | peekNextChar () const |
| | Reads the next character without advancing the current position.
|
| void | skip () |
| | Advances the position by one character.
|
| int | getPosition () const noexcept |
| | Returns the position of the next character as its position within the whole document.
|
| void | skipWhitespace () |
| | Skips over any whitespace characters until the next character is non-whitespace.
|
| void | skipToEndOfLine () |
| | Skips forward until the next character will be the first character on the next line.
|
| int | getLine () const noexcept |
| | Returns the line number of the next character.
|
| bool | isEOF () const noexcept |
| | Returns true if the iterator has reached the end of the document.
|
Detailed Description
Iterates the text in a CodeDocument.
This class lets you read characters from a CodeDocument. It's designed to be used by a SyntaxAnalyser object.
- See also:
- CodeDocument, SyntaxAnalyser
Constructor & Destructor Documentation
| CodeDocument::Iterator::Iterator |
( |
CodeDocument * |
document ) |
|
| CodeDocument::Iterator::Iterator |
( |
const Iterator & |
other ) |
|
| CodeDocument::Iterator::~Iterator |
( |
) |
|
Member Function Documentation
Reads the next character and returns it.
- See also:
- peekNextChar
| juce_wchar CodeDocument::Iterator::peekNextChar |
( |
) |
const |
Reads the next character without advancing the current position.
| void CodeDocument::Iterator::skip |
( |
) |
|
Advances the position by one character.
| int CodeDocument::Iterator::getPosition |
( |
) |
const |
Returns the position of the next character as its position within the whole document.
| void CodeDocument::Iterator::skipWhitespace |
( |
) |
|
Skips over any whitespace characters until the next character is non-whitespace.
| void CodeDocument::Iterator::skipToEndOfLine |
( |
) |
|
Skips forward until the next character will be the first character on the next line.
| int CodeDocument::Iterator::getLine |
( |
) |
const |
Returns the line number of the next character.
| bool CodeDocument::Iterator::isEOF |
( |
) |
const |
Returns true if the iterator has reached the end of the document.
The documentation for this class was generated from the following file:
