sourcepp::parser::text Namespace Reference

Classes
class	syntax_error

Typedefs
using	EscapeSequenceMap = std::unordered_map<char, char>

Functions
const EscapeSequenceMap &	getDefaultEscapeSequences ()
const EscapeSequenceMap &	getDefaultEscapeSequencesOrNone (bool useEscapes)
bool	isNewLine (char c)
	If a char is a newline character.
bool	isNewLine (std::string_view str)
	If a string is entirely composed of newline characters.
bool	isWhitespace (char c)
	If a char is a whitespace character.
bool	isWhitespace (std::string_view str)
	If a string is entirely composed of whitespace characters.
bool	isNumber (char c)
	If a char is a numerical character (0-9).
bool	isNumber (std::string_view str)
	If a string is entirely composed of numerical characters (0-9).
std::string	convertSpecialCharsToEscapes (std::string_view str, const EscapeSequenceMap &escapeSequences)
	Convert special characters like \n to escaped special characters like \\n.
std::string	convertEscapesToSpecialChars (std::string_view str, const EscapeSequenceMap &escapeSequences)
	Convert escaped special characters like \\n to special characters like \n.
void	eatWhitespace (BufferStream &stream)
	Eat all whitespace after the current stream position.
void	eatSingleLineComment (BufferStream &stream)
	If a single line comment is detected, eat its contents.
void	eatMultiLineComment (BufferStream &stream, std::string_view multiLineCommentEnd=DEFAULT_MULTI_LINE_COMMENT_END)
	If a multi line comment is detected, eat its contents.
void	eatWhitespaceAndSingleLineComments (BufferStream &stream, std::string_view singleLineCommentStart=DEFAULT_SINGLE_LINE_COMMENT_START)
	Eat all whitespace and single line comments after the current stream position.
void	eatWhitespaceAndMultiLineComments (BufferStream &stream, std::string_view multiLineCommentStart=DEFAULT_MULTI_LINE_COMMENT_START)
	Eat all whitespace and multi line comments after the current stream position.
void	eatWhitespaceAndComments (BufferStream &stream, std::string_view singleLineCommentStart=DEFAULT_SINGLE_LINE_COMMENT_START, std::string_view multiLineCommentStart=DEFAULT_MULTI_LINE_COMMENT_START)
	Eat all whitespace and comments after the current stream position.
bool	tryToEatChar (BufferStream &stream, char c)
	If the given char exists at the current position, skip over it.
std::string	readString (BufferStream &stream, std::string_view start=DEFAULT_STRING_START, std::string_view end=DEFAULT_STRING_END, const EscapeSequenceMap &escapeSequences=getDefaultEscapeSequences())
	Read a string starting at the current stream position.
std::string_view	readStringToBuffer (BufferStream &stream, BufferStream &backing, std::string_view start=DEFAULT_STRING_START, std::string_view end=DEFAULT_STRING_END, const EscapeSequenceMap &escapeSequences=getDefaultEscapeSequences())
	Read a string starting at the current stream position.
std::string	readUnquotedString (BufferStream &stream, const EscapeSequenceMap &escapeSequences=getDefaultEscapeSequences())
	Read a string starting at the current stream position.
std::string_view	readUnquotedStringToBuffer (BufferStream &stream, BufferStream &backing, const EscapeSequenceMap &escapeSequences=getDefaultEscapeSequences())
	Read a string starting at the current stream position.
std::string	readUnquotedString (BufferStream &stream, std::string_view end, const EscapeSequenceMap &escapeSequences=getDefaultEscapeSequences())
	Read a string starting at the current stream position.
std::string_view	readUnquotedStringToBuffer (BufferStream &stream, BufferStream &backing, std::string_view end, const EscapeSequenceMap &escapeSequences=getDefaultEscapeSequences())
	Read a string starting at the current stream position.

Variables
constexpr std::string_view	DEFAULT_SINGLE_LINE_COMMENT_START = "//"
constexpr std::string_view	DEFAULT_MULTI_LINE_COMMENT_START = "/*"
constexpr std::string_view	DEFAULT_MULTI_LINE_COMMENT_END = "*/"
constexpr std::string_view	DEFAULT_STRING_START = "\""
constexpr std::string_view	DEFAULT_STRING_END = "\""

Typedef Documentation

EscapeSequenceMap

using sourcepp::parser::text::EscapeSequenceMap = std::unordered_map<char, char>

Definition at line 17 of file Text.h.

Function Documentation

convertEscapesToSpecialChars()

std::string sourcepp::parser::text::convertEscapesToSpecialChars ( std::string_view str, const EscapeSequenceMap & escapeSequences )

nodiscard

Convert escaped special characters like \\n to special characters like \n.

Parameters

str	The string to convert
escapeSequences	The escapes to convert

Returns

The string with special characters instead of escapes

Definition at line 75 of file Text.cpp.

convertSpecialCharsToEscapes()

std::string sourcepp::parser::text::convertSpecialCharsToEscapes ( std::string_view str, const EscapeSequenceMap & escapeSequences )

nodiscard

Convert special characters like \n to escaped special characters like \\n.

Parameters

str	The string to convert
escapeSequences	The escapes to convert

Returns

The string without any special characters

Definition at line 56 of file Text.cpp.

eatMultiLineComment()

void sourcepp::parser::text::eatMultiLineComment	(	BufferStream &	stream,
		std::string_view	multiLineCommentEnd = DEFAULT_MULTI_LINE_COMMENT_END )

If a multi line comment is detected, eat its contents.

This function does not handle the detection of multi line comments!

Parameters

stream	The BufferStream to modify.
multiLineCommentEnd	The multi line comment ending to search for.

Definition at line 102 of file Text.cpp.

eatSingleLineComment()

void sourcepp::parser::text::eatSingleLineComment

(

BufferStream &

stream

)

If a single line comment is detected, eat its contents.

This function does not handle the detection of single line comments!

Parameters

stream

The BufferStream to modify.

Definition at line 98 of file Text.cpp.

eatWhitespace()

void sourcepp::parser::text::eatWhitespace

(

BufferStream &

stream

)

Eat all whitespace after the current stream position.

Parameters

stream

The BufferStream to modify.

Definition at line 93 of file Text.cpp.

eatWhitespaceAndComments()

void sourcepp::parser::text::eatWhitespaceAndComments	(	BufferStream &	stream,
		std::string_view	singleLineCommentStart = DEFAULT_SINGLE_LINE_COMMENT_START,
		std::string_view	multiLineCommentStart = DEFAULT_MULTI_LINE_COMMENT_START )

Eat all whitespace and comments after the current stream position.

Parameters

stream	The BufferStream to modify.
singleLineCommentStart	The single line comment start sequence. Leave empty to skip checking for single line comments.
multiLineCommentStart	The multi line comment start sequence. Leave empty to skip checking for multi line comments.

Definition at line 117 of file Text.cpp.

eatWhitespaceAndMultiLineComments()

void sourcepp::parser::text::eatWhitespaceAndMultiLineComments	(	BufferStream &	stream,
		std::string_view	multiLineCommentStart = DEFAULT_MULTI_LINE_COMMENT_START )

Eat all whitespace and multi line comments after the current stream position.

Parameters

stream	The BufferStream to modify.
multiLineCommentStart	The multi line comment start sequence. Leave empty to skip checking for multi line comments.

Definition at line 112 of file Text.cpp.

eatWhitespaceAndSingleLineComments()

void sourcepp::parser::text::eatWhitespaceAndSingleLineComments	(	BufferStream &	stream,
		std::string_view	singleLineCommentStart = DEFAULT_SINGLE_LINE_COMMENT_START )

Eat all whitespace and single line comments after the current stream position.

Parameters

stream	The BufferStream to modify.
singleLineCommentStart	The single line comment start sequence. Leave empty to skip checking for single line comments.

Definition at line 108 of file Text.cpp.

getDefaultEscapeSequences()

const parser::text::EscapeSequenceMap & sourcepp::parser::text::getDefaultEscapeSequences ( )

nodiscard

Definition at line 10 of file Text.cpp.

getDefaultEscapeSequencesOrNone()

const parser::text::EscapeSequenceMap & sourcepp::parser::text::getDefaultEscapeSequencesOrNone ( bool useEscapes )

nodiscard

Definition at line 27 of file Text.cpp.

isNewLine() [1/2]

bool sourcepp::parser::text::isNewLine ( char c )

nodiscard

If a char is a newline character.

Parameters

c

The char.

Returns

The char is a newline character.

Definition at line 32 of file Text.cpp.

isNewLine() [2/2]

bool sourcepp::parser::text::isNewLine ( std::string_view str )

nodiscard

If a string is entirely composed of newline characters.

Parameters

str	The string.

Returns

The string is entirely composed of newline characters.

Definition at line 36 of file Text.cpp.

isNumber() [1/2]

bool sourcepp::parser::text::isNumber ( char c )

nodiscard

If a char is a numerical character (0-9).

Parameters

c

The char.

Returns

The char is a numerical character.

Definition at line 48 of file Text.cpp.

isNumber() [2/2]

bool sourcepp::parser::text::isNumber ( std::string_view str )

nodiscard

If a string is entirely composed of numerical characters (0-9).

Parameters

str	The string.

Returns

The string is entirely composed of numerical characters.

Definition at line 52 of file Text.cpp.

isWhitespace() [1/2]

bool sourcepp::parser::text::isWhitespace ( char c )

nodiscard

If a char is a whitespace character.

Parameters

c

The char.

Returns

The char is a whitespace character.

Definition at line 40 of file Text.cpp.

isWhitespace() [2/2]

bool sourcepp::parser::text::isWhitespace ( std::string_view str )

nodiscard

If a string is entirely composed of whitespace characters.

Parameters

str	The string.

Returns

The string is entirely composed of whitespace characters.

Definition at line 44 of file Text.cpp.

readString()

std::string sourcepp::parser::text::readString ( BufferStream & stream, std::string_view start = DEFAULT_STRING_START, std::string_view end = DEFAULT_STRING_END, const EscapeSequenceMap & escapeSequences = getDefaultEscapeSequences() )

nodiscard

Read a string starting at the current stream position.

Parameters

stream	The BufferStream to modify.
start	The starting string chars. If any processed char is in this string, the string will be treated as "quoted" and will include spaces.
end	The ending string chars. If any processed char is in this string, and a starting char is detected, the string will terminate.
escapeSequences	Characters that will be escaped if a backslash is present before them. To disable escapes, pass an empty map.

Returns

The read string.

Definition at line 147 of file Text.cpp.

readStringToBuffer()

std::string_view sourcepp::parser::text::readStringToBuffer	(	BufferStream &	stream,
		BufferStream &	backing,
		std::string_view	start = DEFAULT_STRING_START,
		std::string_view	end = DEFAULT_STRING_END,
		const EscapeSequenceMap &	escapeSequences = getDefaultEscapeSequences() )

Read a string starting at the current stream position.

Parameters

stream	The BufferStream to modify.
backing	The BufferStream to store the string data in.
start	The starting string chars. If any processed char is in this string, the string will be treated as "quoted" and will include spaces.
end	The ending string chars. If any processed char is in this string, and a starting char is detected, the string will terminate.
escapeSequences	Characters that will be escaped if a backslash is present before them. To disable escapes, pass an empty map.

Returns

A view over the string written to the backing stream.

Definition at line 180 of file Text.cpp.

readUnquotedString() [1/2]

std::string sourcepp::parser::text::readUnquotedString ( BufferStream & stream, const EscapeSequenceMap & escapeSequences = getDefaultEscapeSequences() )

nodiscard

Read a string starting at the current stream position.

Parameters

stream	The BufferStream to modify.
escapeSequences	Characters that will be escaped if a backslash is present before them. To disable escapes, pass an empty map.

Returns

The read string.

Definition at line 213 of file Text.cpp.

readUnquotedString() [2/2]

std::string sourcepp::parser::text::readUnquotedString ( BufferStream & stream, std::string_view end, const EscapeSequenceMap & escapeSequences = getDefaultEscapeSequences() )

nodiscard

Read a string starting at the current stream position.

Parameters

stream	The BufferStream to modify.
end	The ending string chars. If any processed char is in this string, the string will terminate.
escapeSequences	Characters that will be escaped if a backslash is present before them. To disable escapes, pass an empty map.

Returns

The read string.

Definition at line 221 of file Text.cpp.

readUnquotedStringToBuffer() [1/2]

std::string_view sourcepp::parser::text::readUnquotedStringToBuffer	(	BufferStream &	stream,
		BufferStream &	backing,
		const EscapeSequenceMap &	escapeSequences = getDefaultEscapeSequences() )

Read a string starting at the current stream position.

Parameters

stream	The BufferStream to modify.
backing	The BufferStream to store the string data in.
escapeSequences	Characters that will be escaped if a backslash is present before them. To disable escapes, pass an empty map.

Returns

A view over the string written to the backing stream.

Definition at line 217 of file Text.cpp.

readUnquotedStringToBuffer() [2/2]

std::string_view sourcepp::parser::text::readUnquotedStringToBuffer	(	BufferStream &	stream,
		BufferStream &	backing,
		std::string_view	end,
		const EscapeSequenceMap &	escapeSequences = getDefaultEscapeSequences() )

Read a string starting at the current stream position.

Parameters

stream	The BufferStream to modify.
backing	The BufferStream to store the string data in.
end	The ending string chars. If any processed char is in this string, the string will terminate.
escapeSequences	Characters that will be escaped if a backslash is present before them. To disable escapes, pass an empty map.

Returns

A view over the string written to the backing stream.

Definition at line 243 of file Text.cpp.

tryToEatChar()

bool sourcepp::parser::text::tryToEatChar ( BufferStream & stream, char c )

nodiscard

If the given char exists at the current position, skip over it.

Parameters

stream	The BufferStream to modify
c	The char to compare

Returns

If the char exists at the current position

Definition at line 139 of file Text.cpp.

Variable Documentation

DEFAULT_MULTI_LINE_COMMENT_END

std::string_view sourcepp::parser::text::DEFAULT_MULTI_LINE_COMMENT_END = "*/"

constexpr

Definition at line 13 of file Text.h.

DEFAULT_MULTI_LINE_COMMENT_START

std::string_view sourcepp::parser::text::DEFAULT_MULTI_LINE_COMMENT_START = "/*"

constexpr

Definition at line 12 of file Text.h.

DEFAULT_SINGLE_LINE_COMMENT_START

std::string_view sourcepp::parser::text::DEFAULT_SINGLE_LINE_COMMENT_START = "//"

constexpr

Definition at line 11 of file Text.h.

DEFAULT_STRING_END

std::string_view sourcepp::parser::text::DEFAULT_STRING_END = "\""

constexpr

Definition at line 15 of file Text.h.

DEFAULT_STRING_START

std::string_view sourcepp::parser::text::DEFAULT_STRING_START = "\""

constexpr

Definition at line 14 of file Text.h.