Text.h

Go to the documentation of this file.

#pragma once
 
#include <stdexcept>
#include <string_view>
#include <unordered_map>
 
class BufferStream;
 
namespace sourcepp::parser::text {
 
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                = "\"";
 
using EscapeSequenceMap = std::unordered_map<char, char>;
 
[[nodiscard]] const EscapeSequenceMap& getDefaultEscapeSequences();
 
[[nodiscard]] const EscapeSequenceMap& getDefaultEscapeSequencesOrNone(bool useEscapes);
 
[[nodiscard]] bool isNewLine(char c);
 
[[nodiscard]] bool isNewLine(std::string_view str);
 
[[nodiscard]] bool isWhitespace(char c);
 
[[nodiscard]] bool isWhitespace(std::string_view str);
 
[[nodiscard]] bool isNumber(char c);
 
[[nodiscard]] bool isNumber(std::string_view str);
 
[[nodiscard]] std::string convertSpecialCharsToEscapes(std::string_view str, const EscapeSequenceMap& escapeSequences);
 
[[nodiscard]] std::string convertEscapesToSpecialChars(std::string_view str, const EscapeSequenceMap& escapeSequences);
 
void eatWhitespace(BufferStream& stream);
 
void eatSingleLineComment(BufferStream& stream);
 
void eatMultiLineComment(BufferStream& stream, std::string_view multiLineCommentEnd = DEFAULT_MULTI_LINE_COMMENT_END);
 
void eatWhitespaceAndSingleLineComments(BufferStream& stream, std::string_view singleLineCommentStart = DEFAULT_SINGLE_LINE_COMMENT_START);
 
void eatWhitespaceAndMultiLineComments(BufferStream& stream, std::string_view multiLineCommentStart = DEFAULT_MULTI_LINE_COMMENT_START);
 
void eatWhitespaceAndComments(BufferStream& stream, std::string_view singleLineCommentStart = DEFAULT_SINGLE_LINE_COMMENT_START, std::string_view multiLineCommentStart = DEFAULT_MULTI_LINE_COMMENT_START);
 
[[nodiscard]] bool tryToEatChar(BufferStream& stream, char c);
 
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());
 
std::string_view readUnquotedStringToBuffer(BufferStream& stream, BufferStream& backing, const EscapeSequenceMap& escapeSequences = getDefaultEscapeSequences());
 
std::string_view readUnquotedStringToBuffer(BufferStream& stream, BufferStream& backing, std::string_view end, const EscapeSequenceMap& escapeSequences = getDefaultEscapeSequences());
 
class syntax_error : public std::runtime_error {
public:
    using std::runtime_error::runtime_error;
};
 
} // namespace sourcepp::parser::text