mirror of
https://github.com/carbon-language/carbon-lang.git
synced 2026-10-05 18:31:08 +01:00
Jon Ross-Perkins
6b5eb1a101
High level, replacing `Id::Invalid` with `Id::None` and `Id::is_valid` with `Id::has_value` for clarity, as discussed [here](https://discord.com/channels/655572317891461132/655578254970716160/1331664574545395794). The `IntId` refactoring is needed together with `AnyIdBase` because it's also used with `ValueStore`. Note, trying to be careful not to rewrite `EnumBase::InvalidIndex`, or `is_valid` in general (e.g., `IdKind::is_valid`). I've tried to sequence commits here: 1. Automatic replacements: - `((?:Id|Index)(?: |::|\(|Base(?:\(|::)))Invalid((?:Index)?\W)` -> `$1None$2` - `<invalid>` -> `<none>` - `InvalidNodeId` -> `NoneNodeId` - `/\*invalid\*/` -> `/*none*/` - `id((?:_|\(\))(?:\.|->))is_valid` -> `id$1has_value` 2. Manual edits: - In `int.h` and `int_test.cpp` - `IntT` has `is_value`, which I'm renaming to `is_embedded_value`. - Manual edits to comments in this file. - `AnyIdBase` and `IdBase` - Declaration of `is_valid` -> `has_value`, `InvalidIndex` -> `NoneIndex`. - In `ids.h` and `ids.cpp` - `is_valid` -> `has_value` - `// An explicitly invalid ID.` -> `// An ID with no value.`; similar for index - Various math on `InvalidIndex` -> `NoneIndex` - Various mentions of "valid" in comments - In `value_store.h`, for `IdT::Invalid`, plus one comment - In `impl.h` and `tokenized_buffer.h`, we had different initialization of `::None` values (versus `ids.h` syntax) that I fixed manually. - Spot checks to compile - Particularly where `is_valid` replacements didn't catch spots due to different naming. 3. Autoupdate tests 4. verbose.carbon (NOAUTOUPDATE) 5. Comment spot checks Note there are probably other mentions of "Invalid" that should be swept up, but I'd like to argue for merging and separating out remaining cleanup since this is so sweeping (and likely to hit merge conflicts from churn). We'll probably have lingering mentions of "invalid" for a bit regardless, just because there are uses of "invalid" in non-Id APIs.
61 lines
2.3 KiB
C++
61 lines
2.3 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 CARBON_TOOLCHAIN_LEX_TOKEN_INDEX_H_
|
|
#define CARBON_TOOLCHAIN_LEX_TOKEN_INDEX_H_
|
|
|
|
#include "toolchain/base/index_base.h"
|
|
#include "toolchain/lex/token_kind.h"
|
|
|
|
namespace Carbon::Lex {
|
|
|
|
// A lightweight handle to a lexed token in a `TokenizedBuffer`.
|
|
//
|
|
// `TokenIndex` objects are designed to be passed by value, not reference or
|
|
// pointer. They are also designed to be small and efficient to store in data
|
|
// structures.
|
|
//
|
|
// `TokenIndex` objects from the same `TokenizedBuffer` can be compared with
|
|
// each other, both for being the same token within the buffer, and to establish
|
|
// relative position within the token stream that has been lexed out of the
|
|
// buffer. `TokenIndex` objects from different `TokenizedBuffer`s cannot be
|
|
// meaningfully compared.
|
|
//
|
|
// All other APIs to query a `TokenIndex` are on the `TokenizedBuffer`.
|
|
struct TokenIndex : public IndexBase<TokenIndex> {
|
|
// The number of bits which must be allotted for `TokenIndex`.
|
|
static constexpr int Bits = 23;
|
|
// The maximum number of tokens that can be stored, including the FileStart
|
|
// and FileEnd tokens.
|
|
static constexpr int Max = 1 << Bits;
|
|
|
|
static constexpr llvm::StringLiteral Label = "token";
|
|
static const TokenIndex None;
|
|
// Comments aren't tokenized, so this is the first token after FileStart.
|
|
static const TokenIndex FirstNonCommentToken;
|
|
using IndexBase::IndexBase;
|
|
};
|
|
|
|
constexpr TokenIndex TokenIndex::None(TokenIndex::NoneIndex);
|
|
constexpr TokenIndex TokenIndex::FirstNonCommentToken(1);
|
|
|
|
// A lightweight handle to a lexed token in a `TokenizedBuffer` whose kind is
|
|
// known to be `Kind`.
|
|
template <const TokenKind& K>
|
|
struct TokenIndexForKind : public TokenIndex {
|
|
// NOLINTNEXTLINE(readability-identifier-naming)
|
|
static const TokenKind& Kind;
|
|
constexpr explicit TokenIndexForKind(TokenIndex index) : TokenIndex(index) {}
|
|
};
|
|
template <const TokenKind& K>
|
|
const TokenKind& TokenIndexForKind<K>::Kind = K;
|
|
|
|
#define CARBON_TOKEN(TokenName) \
|
|
using TokenName##TokenIndex = TokenIndexForKind<TokenKind::TokenName>;
|
|
#include "toolchain/lex/token_kind.def"
|
|
|
|
} // namespace Carbon::Lex
|
|
|
|
#endif // CARBON_TOOLCHAIN_LEX_TOKEN_INDEX_H_
|