JUCE  v5.4.1-191-g0ab5e696f
JUCE API
Looking for a senior C++ dev?
I'm looking for work. Hire me!
juce::CPlusPlusCodeTokeniser Class Reference

A simple lexical analyser for syntax colouring of C++ code. More...

#include <juce_CPlusPlusCodeTokeniser.h>

Inheritance diagram for juce::CPlusPlusCodeTokeniser:
Collaboration diagram for juce::CPlusPlusCodeTokeniser:

Public Types

enum  TokenType {
  tokenType_error = 0,
  tokenType_comment,
  tokenType_keyword,
  tokenType_operator,
  tokenType_identifier,
  tokenType_integer,
  tokenType_float,
  tokenType_string,
  tokenType_bracket,
  tokenType_punctuation,
  tokenType_preprocessor
}
 The token values returned by this tokeniser. More...
 

Public Member Functions

 CPlusPlusCodeTokeniser ()
 
 ~CPlusPlusCodeTokeniser () override
 
CodeEditorComponent::ColourScheme getDefaultColourScheme () override
 Returns a suggested syntax highlighting colour scheme. More...
 
int readNextToken (CodeDocument::Iterator &) override
 Reads the next token from the source and returns its token type. More...
 

Static Public Member Functions

static bool isReservedKeyword (const String &token) noexcept
 This is a handy method for checking whether a string is a c++ reserved keyword. More...
 

Detailed Description

A simple lexical analyser for syntax colouring of C++ code.

See also
CodeEditorComponent, CodeDocument

{GUI}

Member Enumeration Documentation

◆ TokenType

The token values returned by this tokeniser.

Enumerator
tokenType_error 
tokenType_comment 
tokenType_keyword 
tokenType_operator 
tokenType_identifier 
tokenType_integer 
tokenType_float 
tokenType_string 
tokenType_bracket 
tokenType_punctuation 
tokenType_preprocessor 

Constructor & Destructor Documentation

◆ CPlusPlusCodeTokeniser()

juce::CPlusPlusCodeTokeniser::CPlusPlusCodeTokeniser ( )

◆ ~CPlusPlusCodeTokeniser()

juce::CPlusPlusCodeTokeniser::~CPlusPlusCodeTokeniser ( )
override

Member Function Documentation

◆ getDefaultColourScheme()

CodeEditorComponent::ColourScheme juce::CPlusPlusCodeTokeniser::getDefaultColourScheme ( )
overridevirtual

Returns a suggested syntax highlighting colour scheme.

Implements juce::CodeTokeniser.

◆ isReservedKeyword()

static bool juce::CPlusPlusCodeTokeniser::isReservedKeyword ( const String token)
staticnoexcept

This is a handy method for checking whether a string is a c++ reserved keyword.

◆ readNextToken()

int juce::CPlusPlusCodeTokeniser::readNextToken ( CodeDocument::Iterator source)
overridevirtual

Reads the next token from the source and returns its token type.

This must leave the source pointing to the first character in the next token.

Implements juce::CodeTokeniser.


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