mirror of
https://github.com/carbon-language/carbon-lang.git
synced 2026-09-24 20:20:10 +01:00
Jon Meow
3825f97e43
My intent is to add CARBON_ bas a prefix, and this makes that easier by creating a tool for auto-fixing guards in general. string_literal is a manual fix -- it had no guard and I didn't automate that (technically I think I could, especially by enforcing the file header/footer, but it didn't feel quite worth it to me).
66 lines
2.4 KiB
C++
66 lines
2.4 KiB
C++
// Part of the Carbon Language project, under the Apache License v2.0 with LLVM
|
|
// Exceptions. See /LICENSE for license information.
|
|
// SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
|
|
|
|
#ifndef TOOLCHAIN_LEXER_STRING_LITERAL_H_
|
|
#define TOOLCHAIN_LEXER_STRING_LITERAL_H_
|
|
|
|
#include <string>
|
|
|
|
#include "llvm/ADT/Optional.h"
|
|
#include "llvm/ADT/StringRef.h"
|
|
#include "toolchain/diagnostics/diagnostic_emitter.h"
|
|
|
|
namespace Carbon {
|
|
|
|
class LexedStringLiteral {
|
|
public:
|
|
// Extract a string literal token from the given text, if it has a suitable
|
|
// form. Returning llvm::None indicates no string literal was found; returning
|
|
// an invalid literal indicates a string prefix was found, but it's malformed
|
|
// and is returning a partial string literal to assist error construction.
|
|
static auto Lex(llvm::StringRef source_text)
|
|
-> llvm::Optional<LexedStringLiteral>;
|
|
|
|
// Expand any escape sequences in the given string literal and compute the
|
|
// resulting value. This handles error recovery internally and cannot fail.
|
|
auto ComputeValue(DiagnosticEmitter<const char*>& emitter) const
|
|
-> std::string;
|
|
|
|
// Get the text corresponding to this literal.
|
|
[[nodiscard]] auto text() const -> llvm::StringRef { return text_; }
|
|
|
|
// Determine whether this is a multi-line string literal.
|
|
[[nodiscard]] auto is_multi_line() const -> bool { return multi_line_; }
|
|
|
|
// Returns true if the string has a valid terminator.
|
|
[[nodiscard]] auto is_terminated() const -> bool { return is_terminated_; }
|
|
|
|
private:
|
|
LexedStringLiteral(llvm::StringRef text, llvm::StringRef content,
|
|
int hash_level, bool multi_line, bool is_terminated)
|
|
: text_(text),
|
|
content_(content),
|
|
hash_level_(hash_level),
|
|
multi_line_(multi_line),
|
|
is_terminated_(is_terminated) {}
|
|
|
|
// The complete text of the string literal.
|
|
llvm::StringRef text_;
|
|
// The content of the literal. For a multi-line literal, this begins
|
|
// immediately after the newline following the file type indicator, and ends
|
|
// at the start of the closing `"""`. Leading whitespace is not removed from
|
|
// either end.
|
|
llvm::StringRef content_;
|
|
// The number of `#`s preceding the opening `"` or `"""`.
|
|
int hash_level_;
|
|
// Whether this was a multi-line string literal.
|
|
bool multi_line_;
|
|
// Whether the literal is valid, or should only be used for errors.
|
|
bool is_terminated_;
|
|
};
|
|
|
|
} // namespace Carbon
|
|
|
|
#endif // TOOLCHAIN_LEXER_STRING_LITERAL_H_
|