mirror of
https://github.com/carbon-language/carbon-lang.git
synced 2026-11-21 17:36:38 +00:00
This is often a (much) better option for this code as we have many types that are just an integer, pointer, or enum of data that would be much more efficient as a by-value parameter. It is also a cleaner design in most cases. One place can't migrate in this way: iterators that use the LLVM CRTP library for filling out iterator methods. The CRTP dispatch expects operators to be actual members, and so those are left as-is in this patch.
96 lines
3.4 KiB
C++
96 lines
3.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 LEXER_TOKEN_KIND_H_
|
|
#define LEXER_TOKEN_KIND_H_
|
|
|
|
#include <cstdint>
|
|
#include <iterator>
|
|
|
|
#include "llvm/ADT/StringRef.h"
|
|
|
|
namespace Carbon {
|
|
|
|
class TokenKind {
|
|
// Note that this must be declared earlier in the class so that its type can
|
|
// be used, for example in the conversion operator.
|
|
enum class KindEnum : int8_t {
|
|
#define CARBON_TOKEN(TokenName) TokenName,
|
|
#include "lexer/token_registry.def"
|
|
};
|
|
|
|
public:
|
|
// The formatting for this macro is weird due to a `clang-format` bug. See
|
|
// https://bugs.llvm.org/show_bug.cgi?id=48320 for details.
|
|
#define CARBON_TOKEN(TokenName) \
|
|
static constexpr auto TokenName()->TokenKind { \
|
|
return TokenKind(KindEnum::TokenName); \
|
|
}
|
|
#include "lexer/token_registry.def"
|
|
|
|
// The default constructor is deleted as objects of this type should always be
|
|
// constructed using the above factory functions for each unique kind.
|
|
TokenKind() = delete;
|
|
|
|
friend auto operator==(TokenKind lhs, TokenKind rhs) -> bool {
|
|
return lhs.kind_value == rhs.kind_value;
|
|
}
|
|
friend auto operator!=(TokenKind lhs, TokenKind rhs) -> bool {
|
|
return lhs.kind_value != rhs.kind_value;
|
|
}
|
|
|
|
// Get a friendly name for the token for logging or debugging.
|
|
[[nodiscard]] auto Name() const -> llvm::StringRef;
|
|
|
|
// Test whether this kind of token is a simple symbol sequence (punctuation,
|
|
// not letters) that appears directly in the source text and can be
|
|
// unambiguously lexed with `starts_with` logic. While these may appear
|
|
// inside of other tokens, outside of the contents of other tokens they
|
|
// don't require any specific characters before or after to distinguish them
|
|
// in the source. Returns false otherwise.
|
|
[[nodiscard]] auto IsSymbol() const -> bool;
|
|
|
|
// Test whether this kind of token is a grouping symbol (part of an opening
|
|
// and closing pair that must always be matched in the token stream).
|
|
[[nodiscard]] auto IsGroupingSymbol() const -> bool;
|
|
|
|
// Test whether this kind of token is an opening symbol for a group.
|
|
[[nodiscard]] auto IsOpeningSymbol() const -> bool;
|
|
|
|
// Returns the associated closing symbol for an opening symbol.
|
|
//
|
|
// The token kind must be an opening symbol.
|
|
[[nodiscard]] auto GetClosingSymbol() const -> TokenKind;
|
|
|
|
// Test whether this kind of token is an closing symbol for a group.
|
|
[[nodiscard]] auto IsClosingSymbol() const -> bool;
|
|
|
|
// Returns the associated opening symbol for a closing symbol.
|
|
//
|
|
// The token kind must be an closing symbol.
|
|
[[nodiscard]] auto GetOpeningSymbol() const -> TokenKind;
|
|
|
|
// Test whether this kind of token is a keyword.
|
|
[[nodiscard]] auto IsKeyword() const -> bool;
|
|
|
|
// If this token kind has a fixed spelling when in source code, returns it.
|
|
// Otherwise returns an empty string.
|
|
[[nodiscard]] auto GetFixedSpelling() const -> llvm::StringRef;
|
|
|
|
// Enable conversion to our private enum, including in a `constexpr` context,
|
|
// to enable usage in `switch` and `case`. The enum remains private and
|
|
// nothing else should be using this.
|
|
// NOLINTNEXTLINE(google-explicit-constructor)
|
|
constexpr operator KindEnum() const { return kind_value; }
|
|
|
|
private:
|
|
constexpr explicit TokenKind(KindEnum kind_value) : kind_value(kind_value) {}
|
|
|
|
KindEnum kind_value;
|
|
};
|
|
|
|
} // namespace Carbon
|
|
|
|
#endif // LEXER_TOKEN_KIND_H_
|