openshot-audio  0.1.6
Public Member Functions | List of all members
juce::CodeDocument::Iterator Class Reference

#include <juce_gui_extra.h>

Public Member Functions

 Iterator (const CodeDocument &document) noexcept
 
 Iterator (const Iterator &) noexcept
 
Iteratoroperator= (const Iterator &) noexcept
 
 ~Iterator () noexcept
 
juce_wchar nextChar () noexcept
 
juce_wchar peekNextChar () const noexcept
 
void skip () noexcept
 
int getPosition () const noexcept
 
void skipWhitespace () noexcept
 
void skipToEndOfLine () noexcept
 
int getLine () const noexcept
 
bool isEOF () const noexcept
 

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 CodeTokeniser object.

See also
CodeDocument

Constructor & Destructor Documentation

CodeDocument::Iterator::Iterator ( const CodeDocument document)
noexcept
CodeDocument::Iterator::Iterator ( const Iterator other)
noexcept
CodeDocument::Iterator::~Iterator ( )
noexcept

Member Function Documentation

int juce::CodeDocument::Iterator::getLine ( ) const
inlinenoexcept

Returns the line number of the next character.

int juce::CodeDocument::Iterator::getPosition ( ) const
inlinenoexcept

Returns the position as the number of characters from the start of the document.

bool CodeDocument::Iterator::isEOF ( ) const
noexcept

Returns true if the iterator has reached the end of the document.

juce_wchar CodeDocument::Iterator::nextChar ( )
noexcept

Reads the next character and returns it.

See also
peekNextChar
CodeDocument::Iterator & CodeDocument::Iterator::operator= ( const Iterator other)
noexcept
juce_wchar CodeDocument::Iterator::peekNextChar ( ) const
noexcept

Reads the next character without advancing the current position.

void CodeDocument::Iterator::skip ( )
noexcept

Advances the position by one character.

void CodeDocument::Iterator::skipToEndOfLine ( )
noexcept

Skips forward until the next character will be the first character on the next line

void CodeDocument::Iterator::skipWhitespace ( )
noexcept

Skips over any whitespace characters until the next character is non-whitespace.


The documentation for this class was generated from the following files: