JUCE  v5.1.1-3-g1a0b28c73
JUCE API
Classes | Static Public Member Functions | List of all members
CppTokeniserFunctions Struct Reference

Class containing some basic functions for simple tokenising of C++ code. More...

#include <juce_CPlusPlusCodeTokeniserFunctions.h>

Classes

struct  StringIterator
 A class that can be passed to the CppTokeniserFunctions functions in order to parse a String. More...
 

Static Public Member Functions

static String addEscapeChars (const String &s)
 Takes a string and returns a version of it where standard C++ escape sequences have been used to replace any non-ascii bytes. More...
 
static bool isDecimalDigit (const juce_wchar c) noexcept
 
static bool isHexDigit (const juce_wchar c) noexcept
 
static bool isIdentifierBody (const juce_wchar c) noexcept
 
static bool isIdentifierStart (const juce_wchar c) noexcept
 
static bool isOctalDigit (const juce_wchar c) noexcept
 
static bool isReservedKeyword (String::CharPointerType token, const int tokenLength) noexcept
 
template<typename Iterator >
static bool parseDecimalLiteral (Iterator &source) noexcept
 
template<typename Iterator >
static bool parseFloatLiteral (Iterator &source) noexcept
 
template<typename Iterator >
static bool parseHexLiteral (Iterator &source) noexcept
 
template<typename Iterator >
static int parseIdentifier (Iterator &source) noexcept
 
template<typename Iterator >
static int parseNumber (Iterator &source)
 
template<typename Iterator >
static bool parseOctalLiteral (Iterator &source) noexcept
 
template<typename Iterator >
static int readNextToken (Iterator &source)
 
template<typename Iterator >
static void skipComment (Iterator &source) noexcept
 
template<typename Iterator >
static void skipIfNextCharMatches (Iterator &source, const juce_wchar c) noexcept
 
template<typename Iterator >
static void skipIfNextCharMatches (Iterator &source, const juce_wchar c1, const juce_wchar c2) noexcept
 
template<typename Iterator >
static bool skipNumberSuffix (Iterator &source)
 
template<typename Iterator >
static void skipPreprocessorLine (Iterator &source) noexcept
 
template<typename Iterator >
static void skipQuotedString (Iterator &source) noexcept
 
static void writeEscapeChars (OutputStream &out, const char *utf8, const int numBytesToRead, const int maxCharsOnLine, const bool breakAtNewLines, const bool replaceSingleQuotes, const bool allowStringBreaks)
 Takes a UTF8 string and writes it to a stream using standard C++ escape sequences for any non-ascii bytes. More...
 

Detailed Description

Class containing some basic functions for simple tokenising of C++ code.

Member Function Documentation

◆ addEscapeChars()

static String CppTokeniserFunctions::addEscapeChars ( const String &  s)
inlinestatic

Takes a string and returns a version of it where standard C++ escape sequences have been used to replace any non-ascii bytes.

Although not strictly a tokenising function, this is still a function that often comes in handy when working with C++ code!

See also
writeEscapeChars

References String::toRawUTF8(), MemoryOutputStream::toString(), and writeEscapeChars().

◆ isDecimalDigit()

static bool CppTokeniserFunctions::isDecimalDigit ( const juce_wchar  c)
inlinestaticnoexcept

Referenced by parseDecimalLiteral(), and parseFloatLiteral().

◆ isHexDigit()

static bool CppTokeniserFunctions::isHexDigit ( const juce_wchar  c)
inlinestaticnoexcept

Referenced by parseHexLiteral().

◆ isIdentifierBody()

static bool CppTokeniserFunctions::isIdentifierBody ( const juce_wchar  c)
inlinestaticnoexcept

References CharacterFunctions::isLetterOrDigit().

Referenced by parseIdentifier().

◆ isIdentifierStart()

static bool CppTokeniserFunctions::isIdentifierStart ( const juce_wchar  c)
inlinestaticnoexcept

References CharacterFunctions::isLetter().

Referenced by readNextToken().

◆ isOctalDigit()

static bool CppTokeniserFunctions::isOctalDigit ( const juce_wchar  c)
inlinestaticnoexcept

Referenced by parseOctalLiteral().

◆ isReservedKeyword()

static bool CppTokeniserFunctions::isReservedKeyword ( String::CharPointerType  token,
const int  tokenLength 
)
inlinestaticnoexcept

Referenced by parseIdentifier().

◆ parseDecimalLiteral()

template<typename Iterator >
static bool CppTokeniserFunctions::parseDecimalLiteral ( Iterator &  source)
inlinestaticnoexcept

References isDecimalDigit(), and skipNumberSuffix().

Referenced by parseNumber().

◆ parseFloatLiteral()

template<typename Iterator >
static bool CppTokeniserFunctions::parseFloatLiteral ( Iterator &  source)
inlinestaticnoexcept

References isDecimalDigit().

Referenced by parseNumber().

◆ parseHexLiteral()

template<typename Iterator >
static bool CppTokeniserFunctions::parseHexLiteral ( Iterator &  source)
inlinestaticnoexcept

References isHexDigit(), and skipNumberSuffix().

Referenced by parseNumber().

◆ parseIdentifier()

template<typename Iterator >
static int CppTokeniserFunctions::parseIdentifier ( Iterator &  source)
inlinestaticnoexcept

References isIdentifierBody(), isReservedKeyword(), CPlusPlusCodeTokeniser::tokenType_identifier, CPlusPlusCodeTokeniser::tokenType_keyword, CharPointer_UTF8::write(), and CharPointer_UTF8::writeNull().

Referenced by readNextToken().

◆ parseNumber()

template<typename Iterator >
static int CppTokeniserFunctions::parseNumber ( Iterator &  source)
inlinestatic

References parseDecimalLiteral(), parseFloatLiteral(), parseHexLiteral(), parseOctalLiteral(), CPlusPlusCodeTokeniser::tokenType_error, CPlusPlusCodeTokeniser::tokenType_float, and CPlusPlusCodeTokeniser::tokenType_integer.

Referenced by readNextToken().

◆ parseOctalLiteral()

template<typename Iterator >
static bool CppTokeniserFunctions::parseOctalLiteral ( Iterator &  source)
inlinestaticnoexcept

References isOctalDigit(), and skipNumberSuffix().

Referenced by parseNumber().

◆ readNextToken()

template<typename Iterator >
static int CppTokeniserFunctions::readNextToken ( Iterator &  source)
inlinestatic

References isIdentifierStart(), parseIdentifier(), parseNumber(), skipComment(), skipIfNextCharMatches(), skipPreprocessorLine(), skipQuotedString(), CPlusPlusCodeTokeniser::tokenType_bracket, CPlusPlusCodeTokeniser::tokenType_comment, CPlusPlusCodeTokeniser::tokenType_error, CPlusPlusCodeTokeniser::tokenType_operator, CPlusPlusCodeTokeniser::tokenType_preprocessor, CPlusPlusCodeTokeniser::tokenType_punctuation, and CPlusPlusCodeTokeniser::tokenType_string.

◆ skipComment()

template<typename Iterator >
static void CppTokeniserFunctions::skipComment ( Iterator &  source)
inlinestaticnoexcept

Referenced by readNextToken().

◆ skipIfNextCharMatches() [1/2]

template<typename Iterator >
static void CppTokeniserFunctions::skipIfNextCharMatches ( Iterator &  source,
const juce_wchar  c 
)
inlinestaticnoexcept

Referenced by readNextToken().

◆ skipIfNextCharMatches() [2/2]

template<typename Iterator >
static void CppTokeniserFunctions::skipIfNextCharMatches ( Iterator &  source,
const juce_wchar  c1,
const juce_wchar  c2 
)
inlinestaticnoexcept

◆ skipNumberSuffix()

template<typename Iterator >
static bool CppTokeniserFunctions::skipNumberSuffix ( Iterator &  source)
inlinestatic

References CharacterFunctions::isLetterOrDigit().

Referenced by parseDecimalLiteral(), parseHexLiteral(), and parseOctalLiteral().

◆ skipPreprocessorLine()

template<typename Iterator >
static void CppTokeniserFunctions::skipPreprocessorLine ( Iterator &  source)
inlinestaticnoexcept

References skipQuotedString().

Referenced by readNextToken().

◆ skipQuotedString()

template<typename Iterator >
static void CppTokeniserFunctions::skipQuotedString ( Iterator &  source)
inlinestaticnoexcept

Referenced by readNextToken(), and skipPreprocessorLine().

◆ writeEscapeChars()

static void CppTokeniserFunctions::writeEscapeChars ( OutputStream &  out,
const char *  utf8,
const int  numBytesToRead,
const int  maxCharsOnLine,
const bool  breakAtNewLines,
const bool  replaceSingleQuotes,
const bool  allowStringBreaks 
)
inlinestatic

Takes a UTF8 string and writes it to a stream using standard C++ escape sequences for any non-ascii bytes.

Although not strictly a tokenising function, this is still a function that often comes in handy when working with C++ code!

Note that addEscapeChars() is easier to use than this function if you're working with Strings.

See also
addEscapeChars

References CharacterFunctions::getHexDigitValue(), newLine, and String::toHexString().

Referenced by addEscapeChars().

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