| 123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887888889890891892893894895896897898899900901902903904905906907908909910911912913914915916917918919920921922923924925926927928929930931932933934935936937938939940941942943944945946947948949950951952953954955956957958959960961962963964965966967968969970971972973974975976977978979980981982983984985986987988989990991992993994995996997998999100010011002100310041005100610071008100910101011101210131014101510161017101810191020102110221023102410251026102710281029103010311032103310341035103610371038103910401041104210431044104510461047104810491050105110521053105410551056105710581059106010611062106310641065106610671068106910701071107210731074107510761077107810791080108110821083108410851086108710881089109010911092109310941095109610971098109911001101110211031104110511061107110811091110111111121113111411151116111711181119112011211122112311241125112611271128112911301131113211331134113511361137113811391140114111421143114411451146114711481149115011511152115311541155115611571158115911601161116211631164116511661167116811691170117111721173117411751176117711781179118011811182118311841185118611871188118911901191119211931194119511961197119811991200120112021203120412051206120712081209121012111212121312141215121612171218121912201221122212231224122512261227122812291230123112321233123412351236123712381239124012411242124312441245124612471248124912501251125212531254125512561257125812591260126112621263126412651266126712681269127012711272127312741275127612771278127912801281128212831284128512861287128812891290129112921293129412951296129712981299130013011302130313041305130613071308130913101311131213131314131513161317131813191320132113221323132413251326132713281329133013311332133313341335133613371338133913401341134213431344134513461347134813491350135113521353135413551356135713581359136013611362136313641365136613671368136913701371137213731374137513761377137813791380138113821383138413851386138713881389139013911392139313941395139613971398139914001401140214031404140514061407140814091410141114121413141414151416141714181419142014211422142314241425142614271428142914301431143214331434143514361437143814391440144114421443144414451446144714481449145014511452145314541455145614571458145914601461146214631464146514661467146814691470147114721473147414751476147714781479148014811482148314841485148614871488148914901491149214931494149514961497149814991500150115021503150415051506150715081509151015111512151315141515151615171518151915201521152215231524152515261527152815291530153115321533153415351536153715381539154015411542154315441545154615471548154915501551155215531554155515561557155815591560156115621563156415651566156715681569157015711572157315741575157615771578157915801581158215831584158515861587158815891590159115921593159415951596159715981599160016011602160316041605160616071608160916101611161216131614161516161617 |
- // 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_PARSE_TYPED_NODES_H_
- #define CARBON_TOOLCHAIN_PARSE_TYPED_NODES_H_
- #include <optional>
- #include "toolchain/lex/token_index.h"
- #include "toolchain/parse/node_ids.h"
- #include "toolchain/parse/node_kind.h"
- namespace Carbon::Parse {
- // Helpers for defining different kinds of parse nodes.
- // ----------------------------------------------------
- // A pair of a list item and its optional following comma.
- template <typename Element, typename Comma>
- struct ListItem {
- Element value;
- std::optional<Comma> comma;
- };
- // A list of items, parameterized by the kind of the elements and comma.
- template <typename Element, typename Comma>
- using CommaSeparatedList = llvm::SmallVector<ListItem<Element, Comma>>;
- // This class provides a shorthand for defining parse node kinds for leaf nodes.
- template <const NodeKind& KindT, typename TokenKind,
- NodeCategory::RawEnumType Category = NodeCategory::None>
- struct LeafNode {
- static constexpr auto Kind =
- KindT.Define({.category = Category, .child_count = 0});
- TokenKind token;
- };
- // ----------------------------------------------------------------------------
- // Each node kind (in node_kind.def) should have a corresponding type defined
- // here which describes the expected child structure of that parse node.
- //
- // Each of these types should start with a `static constexpr Kind` member
- // initialized by calling `Define` on the corresponding `NodeKind`, and passing
- // in the `NodeCategory` of that kind. This will both associate the category
- // with the node kind and create the necessary kind object for the typed node.
- //
- // This should be followed by field declarations that describe the child nodes,
- // in order, that occur in the parse tree. The `Extract...` functions on the
- // parse tree use struct reflection on these fields to guide the extraction of
- // the child nodes from the tree into an object of this type with these fields
- // for convenient access.
- //
- // The types of these fields are special and describe the specific child node
- // structure of the parse node. Many of these types are defined in `node_ids.h`.
- //
- // Valid primitive types here are:
- // - `NodeId` to match any single child node
- // - `FooId` to require that child to have kind `NodeKind::Foo`
- // - `AnyCatId` to require that child to have a kind in category `Cat`
- // - `NodeIdOneOf<A, B>` to require the child to have kind `NodeKind::A` or
- // `NodeKind::B`
- // - `NodeIdNot<A>` to match any single child whose kind is not `NodeKind::A`
- //
- // There a few, restricted composite field types allowed that compose types in
- // various ways, where all of the `T`s and `U`s below are themselves valid field
- // types:
- // - `llvm::SmallVector<T>` to match any number of children matching `T`
- // - `std::optional<T>` to match 0 or 1 children matching `T`
- // - `std::tuple<T...>` to match children matching `T...`
- // - Any provided `Aggregate` type that is a simple aggregate type such as
- // `struct Aggregate { T x; U y; }`,
- // to match children with types `T` and `U`.
- //
- // In addition to the fields describing the child nodes, each parse node should
- // also have exactly one field that describes the token corresponding to the
- // parse node itself. This field should have the name `token`. The type of the
- // field should be `Lex::*TokenIndex`, describing the kind of the token, such as
- // `Lex::SemiTokenIndex` for a `;` token. If the parse node can correspond to
- // any kind of token, `Lex::TokenIndex` can be used instead, but should only be
- // used when the node kind is either not used in a finished tree, such as
- // `Placeholder`, or is always invalid, such as `InvalidParse`. The location of
- // the field relative to the child nodes indicates the location within the
- // corresponding grammar production where the token appears.
- // ----------------------------------------------------------------------------
- // Error nodes
- // -----------
- // An invalid parse. Used to balance the parse tree. This type is here only to
- // ensure we have a type for each parse node kind. This node kind always has an
- // error, so can never be extracted.
- using InvalidParse = LeafNode<NodeKind::InvalidParse, Lex::TokenIndex,
- NodeCategory::Decl | NodeCategory::Expr>;
- // An invalid subtree. Always has an error so can never be extracted.
- using InvalidParseStart =
- LeafNode<NodeKind::InvalidParseStart, Lex::TokenIndex>;
- struct InvalidParseSubtree {
- static constexpr auto Kind = NodeKind::InvalidParseSubtree.Define(
- {.category = NodeCategory::Decl,
- .bracketed_by = InvalidParseStart::Kind});
- InvalidParseStartId start;
- llvm::SmallVector<NodeIdNot<InvalidParseStart>> extra;
- Lex::TokenIndex token;
- };
- // A placeholder node to be replaced; it will never exist in a valid parse tree.
- // Its token kind is not enforced even when valid.
- using Placeholder = LeafNode<NodeKind::Placeholder, Lex::TokenIndex>;
- // File nodes
- // ----------
- // The start of the file.
- using FileStart = LeafNode<NodeKind::FileStart, Lex::FileStartTokenIndex>;
- // The end of the file.
- using FileEnd = LeafNode<NodeKind::FileEnd, Lex::FileEndTokenIndex>;
- // General-purpose nodes
- // ---------------------
- // An empty declaration, such as `;`.
- using EmptyDecl =
- LeafNode<NodeKind::EmptyDecl, Lex::SemiTokenIndex, NodeCategory::Decl>;
- // A name in a non-expression context, such as a declaration, that is known
- // to be followed by parameters.
- using IdentifierNameBeforeParams =
- LeafNode<NodeKind::IdentifierNameBeforeParams, Lex::IdentifierTokenIndex,
- NodeCategory::MemberName | NodeCategory::NonExprName>;
- // A name in a non-expression context, such as a declaration, that is known
- // to not be followed by parameters.
- using IdentifierNameNotBeforeParams =
- LeafNode<NodeKind::IdentifierNameNotBeforeParams, Lex::IdentifierTokenIndex,
- NodeCategory::MemberName | NodeCategory::NonExprName>;
- // A name in an expression context.
- using IdentifierNameExpr =
- LeafNode<NodeKind::IdentifierNameExpr, Lex::IdentifierTokenIndex,
- NodeCategory::Expr>;
- // The `self` value and `Self` type identifier keywords. Typically of the form
- // `self: Self`.
- using SelfValueName =
- LeafNode<NodeKind::SelfValueName, Lex::SelfValueIdentifierTokenIndex>;
- using SelfValueNameExpr =
- LeafNode<NodeKind::SelfValueNameExpr, Lex::SelfValueIdentifierTokenIndex,
- NodeCategory::Expr>;
- using SelfTypeNameExpr =
- LeafNode<NodeKind::SelfTypeNameExpr, Lex::SelfTypeIdentifierTokenIndex,
- NodeCategory::Expr>;
- // The `base` value keyword, introduced by `base: B`. Typically referenced in
- // an expression, as in `x.base` or `{.base = ...}`, but can also be used as a
- // declared name, as in `{.base: partial B}`.
- using BaseName =
- LeafNode<NodeKind::BaseName, Lex::BaseTokenIndex, NodeCategory::MemberName>;
- // The `_` token, when used in the name position of a binding pattern.
- using UnderscoreName =
- LeafNode<NodeKind::UnderscoreName, Lex::UnderscoreTokenIndex,
- NodeCategory::NonExprName>;
- // A name qualifier with parameters, such as `A(T:! type).` or `A[T:! type](N:!
- // T).`.
- struct IdentifierNameQualifierWithParams {
- static constexpr auto Kind =
- NodeKind::IdentifierNameQualifierWithParams.Define(
- {.bracketed_by = IdentifierNameBeforeParams::Kind});
- IdentifierNameBeforeParamsId name;
- std::optional<ImplicitParamListId> implicit_params;
- std::optional<ExplicitParamListId> params;
- Lex::PeriodTokenIndex token;
- };
- // A name qualifier without parameters, such as `A.`.
- struct IdentifierNameQualifierWithoutParams {
- static constexpr auto Kind =
- NodeKind::IdentifierNameQualifierWithoutParams.Define(
- {.bracketed_by = IdentifierNameNotBeforeParams::Kind});
- IdentifierNameNotBeforeParamsId name;
- Lex::PeriodTokenIndex token;
- };
- // A complete name in a declaration: `A.C(T:! type).F(n: i32)`.
- // Note that this includes the parameters of the entity itself.
- struct DeclName {
- llvm::SmallVector<NodeIdOneOf<IdentifierNameQualifierWithParams,
- IdentifierNameQualifierWithoutParams>>
- qualifiers;
- AnyNonExprNameId name;
- std::optional<ImplicitParamListId> implicit_params;
- std::optional<ExplicitParamListId> params;
- };
- // Library, package, import, export
- // --------------------------------
- // Various keywords in an expression.
- using CoreNameExpr =
- LeafNode<NodeKind::CoreNameExpr, Lex::CoreTokenIndex, NodeCategory::Expr>;
- using CppNameExpr =
- LeafNode<NodeKind::CppNameExpr, Lex::CppTokenIndex, NodeCategory::Expr>;
- using PackageExpr =
- LeafNode<NodeKind::PackageExpr, Lex::PackageTokenIndex, NodeCategory::Expr>;
- // The name of a package or library for `package`, `import`, and `library`.
- using IdentifierPackageName =
- LeafNode<NodeKind::IdentifierPackageName, Lex::IdentifierTokenIndex,
- NodeCategory::PackageName>;
- using CorePackageName = LeafNode<NodeKind::CorePackageName, Lex::CoreTokenIndex,
- NodeCategory::PackageName>;
- using CppPackageName = LeafNode<NodeKind::CppPackageName, Lex::CppTokenIndex,
- NodeCategory::PackageName>;
- using LibraryName =
- LeafNode<NodeKind::LibraryName, Lex::StringLiteralTokenIndex>;
- using DefaultLibrary =
- LeafNode<NodeKind::DefaultLibrary, Lex::DefaultTokenIndex>;
- using PackageIntroducer =
- LeafNode<NodeKind::PackageIntroducer, Lex::PackageTokenIndex>;
- // `library` in `package` or `import`.
- struct LibrarySpecifier {
- static constexpr auto Kind =
- NodeKind::LibrarySpecifier.Define({.child_count = 1});
- Lex::LibraryTokenIndex token;
- NodeIdOneOf<LibraryName, DefaultLibrary> name;
- };
- using InlineImportBody =
- LeafNode<NodeKind::InlineImportBody, Lex::StringLiteralTokenIndex>;
- // `inline` in `import`.
- struct InlineImportSpecifier {
- static constexpr auto Kind =
- NodeKind::InlineImportSpecifier.Define({.child_count = 1});
- Lex::InlineTokenIndex token;
- InlineImportBodyId body;
- };
- // First line of the file, such as:
- // `impl package MyPackage library "MyLibrary";`
- struct PackageDecl {
- static constexpr auto Kind =
- NodeKind::PackageDecl.Define({.category = NodeCategory::Decl,
- .bracketed_by = PackageIntroducer::Kind});
- PackageIntroducerId introducer;
- llvm::SmallVector<AnyModifierId> modifiers;
- AnyPackageNameId name;
- std::optional<LibrarySpecifierId> library;
- Lex::SemiTokenIndex token;
- };
- // `import [TheirPackage] [library "TheirLibrary" | inline "code"];`
- using ImportIntroducer =
- LeafNode<NodeKind::ImportIntroducer, Lex::ImportTokenIndex>;
- struct ImportDecl {
- static constexpr auto Kind = NodeKind::ImportDecl.Define(
- {.category = NodeCategory::Decl, .bracketed_by = ImportIntroducer::Kind});
- ImportIntroducerId introducer;
- llvm::SmallVector<AnyModifierId> modifiers;
- std::optional<AnyPackageNameId> name;
- std::optional<LibrarySpecifierId> library;
- std::optional<InlineImportSpecifierId> inline_specifier;
- Lex::SemiTokenIndex token;
- };
- // `library` as declaration.
- using LibraryIntroducer =
- LeafNode<NodeKind::LibraryIntroducer, Lex::LibraryTokenIndex>;
- struct LibraryDecl {
- static constexpr auto Kind =
- NodeKind::LibraryDecl.Define({.category = NodeCategory::Decl,
- .bracketed_by = LibraryIntroducer::Kind});
- LibraryIntroducerId introducer;
- llvm::SmallVector<AnyModifierId> modifiers;
- NodeIdOneOf<LibraryName, DefaultLibrary> library_name;
- Lex::SemiTokenIndex token;
- };
- // `export` as a declaration.
- using ExportIntroducer =
- LeafNode<NodeKind::ExportIntroducer, Lex::ExportTokenIndex>;
- struct ExportDecl {
- static constexpr auto Kind = NodeKind::ExportDecl.Define(
- {.category = NodeCategory::Decl, .bracketed_by = ExportIntroducer::Kind});
- ExportIntroducerId introducer;
- llvm::SmallVector<AnyModifierId> modifiers;
- DeclName name;
- Lex::SemiTokenIndex token;
- };
- // Namespace nodes
- // ---------------
- using NamespaceStart =
- LeafNode<NodeKind::NamespaceStart, Lex::NamespaceTokenIndex>;
- // A namespace: `namespace N;`.
- struct Namespace {
- static constexpr auto Kind = NodeKind::Namespace.Define(
- {.category = NodeCategory::Decl, .bracketed_by = NamespaceStart::Kind});
- NamespaceStartId introducer;
- llvm::SmallVector<AnyModifierId> modifiers;
- DeclName name;
- Lex::SemiTokenIndex token;
- };
- // Pattern nodes
- // -------------
- // A ref binding name: `ref name`.
- struct RefBindingName {
- static constexpr auto Kind =
- NodeKind::RefBindingName.Define({.child_count = 1});
- Lex::RefTokenIndex token;
- AnyRuntimeBindingPatternName name;
- };
- // A binding pattern, such as `name: Type`, that isn't inside a `var` pattern.
- struct LetBindingPattern {
- static constexpr auto Kind = NodeKind::LetBindingPattern.Define(
- {.category = NodeCategory::Pattern, .child_count = 2});
- // TODO: is there some way to reuse AnyRuntimeBindingPatternName here?
- NodeIdOneOf<IdentifierNameNotBeforeParams, SelfValueName, UnderscoreName,
- RefBindingName>
- name;
- Lex::ColonTokenIndex token;
- AnyExprId type;
- };
- // A binding pattern, such as `name: Type`, that is inside a `var` pattern.
- struct VarBindingPattern {
- static constexpr auto Kind = NodeKind::VarBindingPattern.Define(
- {.category = NodeCategory::Pattern, .child_count = 2});
- AnyRuntimeBindingPatternName name;
- Lex::ColonTokenIndex token;
- AnyExprId type;
- };
- // A template binding name: `template T`.
- struct TemplateBindingName {
- static constexpr auto Kind =
- NodeKind::TemplateBindingName.Define({.child_count = 1});
- Lex::TemplateTokenIndex token;
- AnyRuntimeBindingPatternName name;
- };
- struct CompileTimeBindingPatternStart {
- static constexpr auto Kind =
- NodeKind::CompileTimeBindingPatternStart.Define({.child_count = 1});
- // TODO: is there some way to reuse AnyRuntimeBindingPatternName here?
- NodeIdOneOf<IdentifierNameNotBeforeParams, SelfValueName, UnderscoreName,
- TemplateBindingName>
- name;
- // This is a virtual token. The `:!` token is owned by the
- // CompileTimeBindingPattern node.
- Lex::ColonExclaimTokenIndex token;
- };
- // `name:! Type`
- struct CompileTimeBindingPattern {
- static constexpr auto Kind = NodeKind::CompileTimeBindingPattern.Define(
- {.category = NodeCategory::Pattern, .child_count = 2});
- CompileTimeBindingPatternStartId introducer;
- Lex::ColonExclaimTokenIndex token;
- AnyExprId type;
- };
- using TuplePatternStart =
- LeafNode<NodeKind::TuplePatternStart, Lex::OpenParenTokenIndex>;
- using PatternListComma =
- LeafNode<NodeKind::PatternListComma, Lex::CommaTokenIndex>;
- // A tuple pattern that isn't an explicit parameter list: `(a: i32, b: i32)`.
- struct TuplePattern {
- static constexpr auto Kind =
- NodeKind::TuplePattern.Define({.category = NodeCategory::Pattern,
- .bracketed_by = TuplePatternStart::Kind});
- TuplePatternStartId left_paren;
- CommaSeparatedList<AnyPatternId, PatternListCommaId> params;
- Lex::CloseParenTokenIndex token;
- };
- using ExplicitParamListStart =
- LeafNode<NodeKind::ExplicitParamListStart, Lex::OpenParenTokenIndex>;
- // An explicit parameter list: `(a: i32, b: i32)`.
- struct ExplicitParamList {
- static constexpr auto Kind = NodeKind::ExplicitParamList.Define(
- {.bracketed_by = ExplicitParamListStart::Kind});
- ExplicitParamListStartId left_paren;
- CommaSeparatedList<AnyPatternId, PatternListCommaId> params;
- Lex::CloseParenTokenIndex token;
- };
- using ImplicitParamListStart = LeafNode<NodeKind::ImplicitParamListStart,
- Lex::OpenSquareBracketTokenIndex>;
- // An implicit parameter list: `[T:! type, self: Self]`.
- struct ImplicitParamList {
- static constexpr auto Kind = NodeKind::ImplicitParamList.Define(
- {.bracketed_by = ImplicitParamListStart::Kind});
- ImplicitParamListStartId left_square;
- CommaSeparatedList<AnyPatternId, PatternListCommaId> params;
- Lex::CloseSquareBracketTokenIndex token;
- };
- // Function nodes
- // --------------
- using FunctionIntroducer =
- LeafNode<NodeKind::FunctionIntroducer, Lex::FnTokenIndex>;
- // A return type: `-> i32`.
- struct ReturnType {
- static constexpr auto Kind = NodeKind::ReturnType.Define({.child_count = 1});
- Lex::MinusGreaterTokenIndex token;
- AnyExprId type;
- };
- // A function signature: `fn F() -> i32`.
- template <const NodeKind& KindT, typename TokenKind,
- NodeCategory::RawEnumType Category>
- struct FunctionSignature {
- static constexpr auto Kind = KindT.Define(
- {.category = Category, .bracketed_by = FunctionIntroducer::Kind});
- FunctionIntroducerId introducer;
- llvm::SmallVector<AnyModifierId> modifiers;
- DeclName name;
- std::optional<ReturnTypeId> return_type;
- TokenKind token;
- };
- using FunctionDecl = FunctionSignature<NodeKind::FunctionDecl,
- Lex::SemiTokenIndex, NodeCategory::Decl>;
- using FunctionDefinitionStart =
- FunctionSignature<NodeKind::FunctionDefinitionStart,
- Lex::OpenCurlyBraceTokenIndex, NodeCategory::None>;
- // A function definition: `fn F() -> i32 { ... }`.
- struct FunctionDefinition {
- static constexpr auto Kind = NodeKind::FunctionDefinition.Define(
- {.category = NodeCategory::Decl,
- .bracketed_by = FunctionDefinitionStart::Kind});
- FunctionDefinitionStartId signature;
- llvm::SmallVector<AnyStatementId> body;
- Lex::CloseCurlyBraceTokenIndex token;
- };
- using BuiltinFunctionDefinitionStart =
- FunctionSignature<NodeKind::BuiltinFunctionDefinitionStart,
- Lex::EqualTokenIndex, NodeCategory::None>;
- using BuiltinName =
- LeafNode<NodeKind::BuiltinName, Lex::StringLiteralTokenIndex>;
- // A builtin function definition: `fn F() -> i32 = "builtin name";`
- struct BuiltinFunctionDefinition {
- static constexpr auto Kind = NodeKind::BuiltinFunctionDefinition.Define(
- {.category = NodeCategory::Decl,
- .bracketed_by = BuiltinFunctionDefinitionStart::Kind});
- BuiltinFunctionDefinitionStartId signature;
- BuiltinNameId builtin_name;
- Lex::SemiTokenIndex token;
- };
- // `alias` nodes
- // -------------
- using AliasIntroducer =
- LeafNode<NodeKind::AliasIntroducer, Lex::AliasTokenIndex>;
- using AliasInitializer =
- LeafNode<NodeKind::AliasInitializer, Lex::EqualTokenIndex>;
- // An `alias` declaration: `alias a = b;`.
- struct Alias {
- static constexpr auto Kind = NodeKind::Alias.Define(
- {.category = NodeCategory::Decl, .bracketed_by = AliasIntroducer::Kind});
- AliasIntroducerId introducer;
- llvm::SmallVector<AnyModifierId> modifiers;
- DeclName name;
- AliasInitializerId equals;
- AnyExprId initializer;
- Lex::SemiTokenIndex token;
- };
- // `let` nodes
- // -----------
- using LetIntroducer = LeafNode<NodeKind::LetIntroducer, Lex::LetTokenIndex>;
- using LetInitializer = LeafNode<NodeKind::LetInitializer, Lex::EqualTokenIndex>;
- // A `let` declaration: `let a: i32 = 5;`.
- struct LetDecl {
- static constexpr auto Kind = NodeKind::LetDecl.Define(
- {.category = NodeCategory::Decl, .bracketed_by = LetIntroducer::Kind});
- LetIntroducerId introducer;
- llvm::SmallVector<AnyModifierId> modifiers;
- AnyPatternId pattern;
- struct Initializer {
- LetInitializerId equals;
- AnyExprId initializer;
- };
- std::optional<Initializer> initializer;
- Lex::SemiTokenIndex token;
- };
- // Associated constant nodes
- using AssociatedConstantIntroducer =
- LeafNode<NodeKind::AssociatedConstantIntroducer, Lex::LetTokenIndex>;
- using AssociatedConstantInitializer =
- LeafNode<NodeKind::AssociatedConstantInitializer, Lex::EqualTokenIndex>;
- struct AssociatedConstantNameAndType {
- static constexpr auto Kind = NodeKind::AssociatedConstantNameAndType.Define(
- {.category = NodeCategory::Pattern, .child_count = 2});
- AnyRuntimeBindingPatternName name;
- Lex::ColonExclaimTokenIndex token;
- AnyExprId type;
- };
- // An associated constant declaration: `let a:! i32;`.
- struct AssociatedConstantDecl {
- static constexpr auto Kind = NodeKind::AssociatedConstantDecl.Define(
- {.category = NodeCategory::Decl,
- .bracketed_by = AssociatedConstantIntroducer::Kind});
- AssociatedConstantIntroducerId introducer;
- llvm::SmallVector<AnyModifierId> modifiers;
- AssociatedConstantNameAndTypeId pattern;
- struct Initializer {
- AssociatedConstantInitializerId equals;
- AnyExprId initializer;
- };
- std::optional<Initializer> initializer;
- Lex::SemiTokenIndex token;
- };
- // `var` nodes
- // -----------
- using VariableIntroducer =
- LeafNode<NodeKind::VariableIntroducer, Lex::VarTokenIndex>;
- using ReturnedModifier =
- LeafNode<NodeKind::ReturnedModifier, Lex::ReturnedTokenIndex,
- NodeCategory::Modifier>;
- using VariableInitializer =
- LeafNode<NodeKind::VariableInitializer, Lex::EqualTokenIndex>;
- // A `var` declaration: `var a: i32;` or `var a: i32 = 5;`.
- struct VariableDecl {
- static constexpr auto Kind =
- NodeKind::VariableDecl.Define({.category = NodeCategory::Decl,
- .bracketed_by = VariableIntroducer::Kind});
- VariableIntroducerId introducer;
- llvm::SmallVector<AnyModifierId> modifiers;
- std::optional<ReturnedModifierId> returned;
- VariablePatternId pattern;
- struct Initializer {
- VariableInitializerId equals;
- AnyExprId value;
- };
- std::optional<Initializer> initializer;
- Lex::SemiTokenIndex token;
- };
- using FieldIntroducer = LeafNode<NodeKind::FieldIntroducer, Lex::VarTokenIndex>;
- using FieldInitializer =
- LeafNode<NodeKind::FieldInitializer, Lex::EqualTokenIndex>;
- struct FieldNameAndType {
- static constexpr auto Kind =
- NodeKind::FieldNameAndType.Define({.child_count = 2});
- IdentifierNameNotBeforeParamsId name;
- Lex::ColonTokenIndex token;
- AnyExprId type;
- };
- struct FieldDecl {
- static constexpr auto Kind = NodeKind::FieldDecl.Define(
- {.category = NodeCategory::Decl, .bracketed_by = FieldIntroducer::Kind});
- FieldIntroducerId introducer;
- llvm::SmallVector<AnyModifierId> modifiers;
- FieldNameAndTypeId name_and_type;
- struct Initializer {
- FieldInitializerId equals;
- AnyExprId value;
- };
- std::optional<Initializer> initializer;
- Lex::SemiTokenIndex token;
- };
- // A `var` pattern.
- struct VariablePattern {
- static constexpr auto Kind = NodeKind::VariablePattern.Define(
- {.category = NodeCategory::Pattern, .child_count = 1});
- Lex::VarTokenIndex token;
- AnyPatternId inner;
- };
- // Statement nodes
- // ---------------
- using CodeBlockStart =
- LeafNode<NodeKind::CodeBlockStart, Lex::OpenCurlyBraceTokenIndex>;
- // A code block: `{ statement; statement; ... }`.
- struct CodeBlock {
- static constexpr auto Kind =
- NodeKind::CodeBlock.Define({.bracketed_by = CodeBlockStart::Kind});
- CodeBlockStartId left_brace;
- llvm::SmallVector<AnyStatementId> statements;
- Lex::CloseCurlyBraceTokenIndex token;
- };
- // An expression statement: `F(x);`.
- struct ExprStatement {
- static constexpr auto Kind = NodeKind::ExprStatement.Define(
- {.category = NodeCategory::Statement, .child_count = 1});
- AnyExprId expr;
- Lex::SemiTokenIndex token;
- };
- using BreakStatementStart =
- LeafNode<NodeKind::BreakStatementStart, Lex::BreakTokenIndex>;
- // A break statement: `break;`.
- struct BreakStatement {
- static constexpr auto Kind = NodeKind::BreakStatement.Define(
- {.category = NodeCategory::Statement,
- .bracketed_by = BreakStatementStart::Kind,
- .child_count = 1});
- BreakStatementStartId introducer;
- Lex::SemiTokenIndex token;
- };
- using ContinueStatementStart =
- LeafNode<NodeKind::ContinueStatementStart, Lex::ContinueTokenIndex>;
- // A continue statement: `continue;`.
- struct ContinueStatement {
- static constexpr auto Kind = NodeKind::ContinueStatement.Define(
- {.category = NodeCategory::Statement,
- .bracketed_by = ContinueStatementStart::Kind,
- .child_count = 1});
- ContinueStatementStartId introducer;
- Lex::SemiTokenIndex token;
- };
- using ReturnStatementStart =
- LeafNode<NodeKind::ReturnStatementStart, Lex::ReturnTokenIndex>;
- using ReturnVarModifier = LeafNode<NodeKind::ReturnVarModifier,
- Lex::VarTokenIndex, NodeCategory::Modifier>;
- // A return statement: `return;` or `return expr;` or `return var;`.
- struct ReturnStatement {
- static constexpr auto Kind = NodeKind::ReturnStatement.Define(
- {.category = NodeCategory::Statement,
- .bracketed_by = ReturnStatementStart::Kind});
- ReturnStatementStartId introducer;
- // TODO: This should be optional<OneOf<AnyExprId, ReturnVarModifierId>>,
- // but we don't have support for OneOf between a node kind and a category.
- std::optional<AnyExprId> expr;
- std::optional<ReturnVarModifierId> var;
- Lex::SemiTokenIndex token;
- };
- using ForHeaderStart =
- LeafNode<NodeKind::ForHeaderStart, Lex::OpenParenTokenIndex>;
- // The `... in` portion of a `for` statement.
- struct ForIn {
- static constexpr auto Kind = NodeKind::ForIn.Define({.child_count = 1});
- AnyPatternId pattern;
- Lex::InTokenIndex token;
- };
- // The `(... in ...)` portion of a `for` statement.
- struct ForHeader {
- static constexpr auto Kind =
- NodeKind::ForHeader.Define({.bracketed_by = ForHeaderStart::Kind});
- ForHeaderStartId introducer;
- ForInId var;
- AnyExprId range;
- Lex::CloseParenTokenIndex token;
- };
- // A complete `for (...) { ... }` statement.
- struct ForStatement {
- static constexpr auto Kind =
- NodeKind::ForStatement.Define({.category = NodeCategory::Statement,
- .bracketed_by = ForHeader::Kind,
- .child_count = 2});
- Lex::ForTokenIndex token;
- ForHeaderId header;
- CodeBlockId body;
- };
- using IfConditionStart =
- LeafNode<NodeKind::IfConditionStart, Lex::OpenParenTokenIndex>;
- // The condition portion of an `if` statement: `(expr)`.
- struct IfCondition {
- static constexpr auto Kind = NodeKind::IfCondition.Define(
- {.bracketed_by = IfConditionStart::Kind, .child_count = 2});
- IfConditionStartId left_paren;
- AnyExprId condition;
- Lex::CloseParenTokenIndex token;
- };
- using IfStatementElse =
- LeafNode<NodeKind::IfStatementElse, Lex::ElseTokenIndex>;
- // An `if` statement: `if (expr) { ... } else { ... }`.
- struct IfStatement {
- static constexpr auto Kind = NodeKind::IfStatement.Define(
- {.category = NodeCategory::Statement, .bracketed_by = IfCondition::Kind});
- Lex::IfTokenIndex token;
- IfConditionId head;
- CodeBlockId then;
- struct Else {
- IfStatementElseId else_token;
- NodeIdOneOf<CodeBlock, IfStatement> body;
- };
- std::optional<Else> else_clause;
- };
- using WhileConditionStart =
- LeafNode<NodeKind::WhileConditionStart, Lex::OpenParenTokenIndex>;
- // The condition portion of a `while` statement: `(expr)`.
- struct WhileCondition {
- static constexpr auto Kind = NodeKind::WhileCondition.Define(
- {.bracketed_by = WhileConditionStart::Kind, .child_count = 2});
- WhileConditionStartId left_paren;
- AnyExprId condition;
- Lex::CloseParenTokenIndex token;
- };
- // A `while` statement: `while (expr) { ... }`.
- struct WhileStatement {
- static constexpr auto Kind =
- NodeKind::WhileStatement.Define({.category = NodeCategory::Statement,
- .bracketed_by = WhileCondition::Kind,
- .child_count = 2});
- Lex::WhileTokenIndex token;
- WhileConditionId head;
- CodeBlockId body;
- };
- using MatchConditionStart =
- LeafNode<NodeKind::MatchConditionStart, Lex::OpenParenTokenIndex>;
- struct MatchCondition {
- static constexpr auto Kind = NodeKind::MatchCondition.Define(
- {.bracketed_by = MatchConditionStart::Kind, .child_count = 2});
- MatchConditionStartId left_paren;
- AnyExprId condition;
- Lex::CloseParenTokenIndex token;
- };
- using MatchIntroducer =
- LeafNode<NodeKind::MatchIntroducer, Lex::MatchTokenIndex>;
- struct MatchStatementStart {
- static constexpr auto Kind = NodeKind::MatchStatementStart.Define(
- {.bracketed_by = MatchIntroducer::Kind, .child_count = 2});
- MatchIntroducerId introducer;
- MatchConditionId condition;
- Lex::OpenCurlyBraceTokenIndex token;
- };
- using MatchCaseIntroducer =
- LeafNode<NodeKind::MatchCaseIntroducer, Lex::CaseTokenIndex>;
- using MatchCaseGuardIntroducer =
- LeafNode<NodeKind::MatchCaseGuardIntroducer, Lex::IfTokenIndex>;
- using MatchCaseGuardStart =
- LeafNode<NodeKind::MatchCaseGuardStart, Lex::OpenParenTokenIndex>;
- struct MatchCaseGuard {
- static constexpr auto Kind = NodeKind::MatchCaseGuard.Define(
- {.bracketed_by = MatchCaseGuardIntroducer::Kind, .child_count = 3});
- MatchCaseGuardIntroducerId introducer;
- MatchCaseGuardStartId left_paren;
- AnyExprId condition;
- Lex::CloseParenTokenIndex token;
- };
- using MatchCaseEqualGreater =
- LeafNode<NodeKind::MatchCaseEqualGreater, Lex::EqualGreaterTokenIndex>;
- struct MatchCaseStart {
- static constexpr auto Kind = NodeKind::MatchCaseStart.Define(
- {.bracketed_by = MatchCaseIntroducer::Kind});
- MatchCaseIntroducerId introducer;
- AnyPatternId pattern;
- std::optional<MatchCaseGuardId> guard;
- MatchCaseEqualGreaterId equal_greater_token;
- Lex::OpenCurlyBraceTokenIndex token;
- };
- struct MatchCase {
- static constexpr auto Kind =
- NodeKind::MatchCase.Define({.bracketed_by = MatchCaseStart::Kind});
- MatchCaseStartId head;
- llvm::SmallVector<AnyStatementId> statements;
- Lex::CloseCurlyBraceTokenIndex token;
- };
- using MatchDefaultIntroducer =
- LeafNode<NodeKind::MatchDefaultIntroducer, Lex::DefaultTokenIndex>;
- using MatchDefaultEqualGreater =
- LeafNode<NodeKind::MatchDefaultEqualGreater, Lex::EqualGreaterTokenIndex>;
- struct MatchDefaultStart {
- static constexpr auto Kind = NodeKind::MatchDefaultStart.Define(
- {.bracketed_by = MatchDefaultIntroducer::Kind, .child_count = 2});
- MatchDefaultIntroducerId introducer;
- MatchDefaultEqualGreaterId equal_greater_token;
- Lex::OpenCurlyBraceTokenIndex token;
- };
- struct MatchDefault {
- static constexpr auto Kind =
- NodeKind::MatchDefault.Define({.bracketed_by = MatchDefaultStart::Kind});
- MatchDefaultStartId introducer;
- llvm::SmallVector<AnyStatementId> statements;
- Lex::CloseCurlyBraceTokenIndex token;
- };
- // A `match` statement: `match (expr) { case (...) => {...} default => {...}}`.
- struct MatchStatement {
- static constexpr auto Kind = NodeKind::MatchStatement.Define(
- {.category = NodeCategory::Statement,
- .bracketed_by = MatchStatementStart::Kind});
- MatchStatementStartId head;
- llvm::SmallVector<MatchCaseId> cases;
- std::optional<MatchDefaultId> default_case;
- Lex::CloseCurlyBraceTokenIndex token;
- };
- // Expression nodes
- // ----------------
- using ArrayExprKeyword =
- LeafNode<NodeKind::ArrayExprKeyword, Lex::ArrayTokenIndex>;
- using ArrayExprOpenParen =
- LeafNode<NodeKind::ArrayExprOpenParen, Lex::OpenParenTokenIndex>;
- using ArrayExprComma = LeafNode<NodeKind::ArrayExprComma, Lex::CommaTokenIndex>;
- // An array type, `array(T, N)`.
- struct ArrayExpr {
- static constexpr auto Kind = NodeKind::ArrayExpr.Define(
- {.category = NodeCategory::Expr, .child_count = 5});
- ArrayExprKeywordId keyword;
- ArrayExprOpenParenId start;
- AnyExprId type;
- ArrayExprCommaId comma;
- AnyExprId bound;
- Lex::CloseParenTokenIndex token;
- };
- // The opening portion of an indexing expression: `a[`.
- //
- // TODO: Consider flattening this into `IndexExpr`.
- struct IndexExprStart {
- static constexpr auto Kind =
- NodeKind::IndexExprStart.Define({.child_count = 1});
- AnyExprId sequence;
- Lex::OpenSquareBracketTokenIndex token;
- };
- // An indexing expression, such as `a[1]`.
- struct IndexExpr {
- static constexpr auto Kind =
- NodeKind::IndexExpr.Define({.category = NodeCategory::Expr,
- .bracketed_by = IndexExprStart::Kind,
- .child_count = 2});
- IndexExprStartId start;
- AnyExprId index;
- Lex::CloseSquareBracketTokenIndex token;
- };
- using ParenExprStart =
- LeafNode<NodeKind::ParenExprStart, Lex::OpenParenTokenIndex>;
- // A parenthesized expression: `(a)`.
- struct ParenExpr {
- static constexpr auto Kind = NodeKind::ParenExpr.Define(
- {.category = NodeCategory::Expr | NodeCategory::MemberExpr,
- .bracketed_by = ParenExprStart::Kind,
- .child_count = 2});
- ParenExprStartId start;
- AnyExprId expr;
- Lex::CloseParenTokenIndex token;
- };
- using TupleLiteralStart =
- LeafNode<NodeKind::TupleLiteralStart, Lex::OpenParenTokenIndex>;
- using TupleLiteralComma =
- LeafNode<NodeKind::TupleLiteralComma, Lex::CommaTokenIndex>;
- // A tuple literal: `()`, `(a, b, c)`, or `(a,)`.
- struct TupleLiteral {
- static constexpr auto Kind =
- NodeKind::TupleLiteral.Define({.category = NodeCategory::Expr,
- .bracketed_by = TupleLiteralStart::Kind});
- TupleLiteralStartId start;
- CommaSeparatedList<AnyExprId, TupleLiteralCommaId> elements;
- Lex::CloseParenTokenIndex token;
- };
- // The opening portion of a call expression: `F(`.
- //
- // TODO: Consider flattening this into `CallExpr`.
- struct CallExprStart {
- static constexpr auto Kind =
- NodeKind::CallExprStart.Define({.child_count = 1});
- AnyExprId callee;
- Lex::OpenParenTokenIndex token;
- };
- // A call expression: `F(a, b, c)`.
- struct CallExpr {
- static constexpr auto Kind = NodeKind::CallExpr.Define(
- {.category = NodeCategory::Expr, .bracketed_by = CallExprStart::Kind});
- CallExprStartId start;
- CommaSeparatedList<AnyExprId, TupleLiteralCommaId> arguments;
- Lex::CloseParenTokenIndex token;
- };
- // A callsite `ref` tag: `F(ref x)` or `F({.x = ref x})
- struct RefTag {
- static constexpr auto Kind = NodeKind::RefTag.Define(
- {.category = NodeCategory::Expr, .child_count = 1});
- Lex::RefTokenIndex token;
- AnyExprId tagged_expr;
- };
- // A member access expression: `a.b` or `a.(b)`.
- struct MemberAccessExpr {
- static constexpr auto Kind = NodeKind::MemberAccessExpr.Define(
- {.category = NodeCategory::Expr, .child_count = 2});
- AnyExprId lhs;
- Lex::PeriodTokenIndex token;
- AnyMemberAccessId rhs;
- };
- // An indirect member access expression: `a->b` or `a->(b)`.
- struct PointerMemberAccessExpr {
- static constexpr auto Kind = NodeKind::PointerMemberAccessExpr.Define(
- {.category = NodeCategory::Expr, .child_count = 2});
- AnyExprId lhs;
- Lex::MinusGreaterTokenIndex token;
- AnyMemberAccessId rhs;
- };
- // A prefix operator expression.
- template <const NodeKind& KindT, typename TokenKind>
- struct PrefixOperator {
- static constexpr auto Kind =
- KindT.Define({.category = NodeCategory::Expr, .child_count = 1});
- TokenKind token;
- AnyExprId operand;
- };
- // An infix operator expression.
- template <const NodeKind& KindT, typename TokenKind>
- struct InfixOperator {
- static constexpr auto Kind =
- KindT.Define({.category = NodeCategory::Expr, .child_count = 2});
- AnyExprId lhs;
- TokenKind token;
- AnyExprId rhs;
- };
- // A postfix operator expression.
- template <const NodeKind& KindT, typename TokenKind>
- struct PostfixOperator {
- static constexpr auto Kind =
- KindT.Define({.category = NodeCategory::Expr, .child_count = 1});
- AnyExprId operand;
- TokenKind token;
- };
- // An `unsafe` modifier: `a unsafe <operator> b`. This is modeled in the parse
- // tree as a postfix operator applied to `a`.
- struct UnsafeModifier {
- static constexpr auto Kind = NodeKind::UnsafeModifier.Define(
- {.category = NodeCategory::Expr, .child_count = 1});
- AnyExprId operand;
- Lex::UnsafeTokenIndex token;
- };
- // Literals, operators, and modifiers
- #define CARBON_PARSE_NODE_KIND(Name)
- #define CARBON_PARSE_NODE_KIND_TOKEN_LITERAL(Name, LexTokenKind) \
- using Name = LeafNode<NodeKind::Name, Lex::LexTokenKind##TokenIndex, \
- NodeCategory::Expr>;
- #define CARBON_PARSE_NODE_KIND_TOKEN_MODIFIER(Name) \
- using Name##Modifier = \
- LeafNode<NodeKind::Name##Modifier, Lex::Name##TokenIndex, \
- NodeCategory::Modifier>;
- #define CARBON_PARSE_NODE_KIND_PREFIX_OPERATOR(Name) \
- using PrefixOperator##Name = \
- PrefixOperator<NodeKind::PrefixOperator##Name, Lex::Name##TokenIndex>;
- #define CARBON_PARSE_NODE_KIND_INFIX_OPERATOR(Name) \
- using InfixOperator##Name = \
- InfixOperator<NodeKind::InfixOperator##Name, Lex::Name##TokenIndex>;
- #define CARBON_PARSE_NODE_KIND_POSTFIX_OPERATOR(Name) \
- using PostfixOperator##Name = \
- PostfixOperator<NodeKind::PostfixOperator##Name, Lex::Name##TokenIndex>;
- #include "toolchain/parse/node_kind.def"
- using IntLiteral = LeafNode<NodeKind::IntLiteral, Lex::IntLiteralTokenIndex,
- NodeCategory::Expr | NodeCategory::IntConst>;
- // `extern` as a standalone modifier.
- using ExternModifier = LeafNode<NodeKind::ExternModifier, Lex::ExternTokenIndex,
- NodeCategory::Modifier>;
- // `extern library <owning_library>` modifiers.
- struct ExternModifierWithLibrary {
- static constexpr auto Kind = NodeKind::ExternModifierWithLibrary.Define(
- {.category = NodeCategory::Modifier, .child_count = 1});
- Lex::ExternTokenIndex token;
- LibrarySpecifierId library;
- };
- // The first operand of a short-circuiting infix operator: `a and` or `a or`.
- // The complete operator expression will be an InfixOperator with this as the
- // `lhs`.
- // TODO: Make this be a template if we ever need to write generic code to cover
- // both cases at once, say in check.
- struct ShortCircuitOperandAnd {
- static constexpr auto Kind =
- NodeKind::ShortCircuitOperandAnd.Define({.child_count = 1});
- AnyExprId operand;
- // This is a virtual token. The `and` token is owned by the
- // ShortCircuitOperatorAnd node.
- Lex::AndTokenIndex token;
- };
- struct ShortCircuitOperandOr {
- static constexpr auto Kind =
- NodeKind::ShortCircuitOperandOr.Define({.child_count = 1});
- AnyExprId operand;
- // This is a virtual token. The `or` token is owned by the
- // ShortCircuitOperatorOr node.
- Lex::OrTokenIndex token;
- };
- struct ShortCircuitOperatorAnd {
- static constexpr auto Kind = NodeKind::ShortCircuitOperatorAnd.Define(
- {.category = NodeCategory::Expr,
- .bracketed_by = ShortCircuitOperandAnd::Kind,
- .child_count = 2});
- ShortCircuitOperandAndId lhs;
- Lex::AndTokenIndex token;
- AnyExprId rhs;
- };
- struct ShortCircuitOperatorOr {
- static constexpr auto Kind = NodeKind::ShortCircuitOperatorOr.Define(
- {.category = NodeCategory::Expr,
- .bracketed_by = ShortCircuitOperandOr::Kind,
- .child_count = 2});
- ShortCircuitOperandOrId lhs;
- Lex::OrTokenIndex token;
- AnyExprId rhs;
- };
- // The `if` portion of an `if` expression: `if expr`.
- struct IfExprIf {
- static constexpr auto Kind = NodeKind::IfExprIf.Define({.child_count = 1});
- Lex::IfTokenIndex token;
- AnyExprId condition;
- };
- // The `then` portion of an `if` expression: `then expr`.
- struct IfExprThen {
- static constexpr auto Kind = NodeKind::IfExprThen.Define({.child_count = 1});
- Lex::ThenTokenIndex token;
- AnyExprId result;
- };
- // A full `if` expression: `if expr then expr else expr`.
- struct IfExprElse {
- static constexpr auto Kind =
- NodeKind::IfExprElse.Define({.category = NodeCategory::Expr,
- .bracketed_by = IfExprIf::Kind,
- .child_count = 3});
- IfExprIfId start;
- IfExprThenId then;
- Lex::ElseTokenIndex token;
- AnyExprId else_result;
- };
- // A `where` expression (TODO: `require` and `observe` declarations)
- // The `Self` in a context where it is treated as a name rather than an
- // expression, such as `.Self`.
- using SelfTypeName =
- LeafNode<NodeKind::SelfTypeName, Lex::SelfTypeIdentifierTokenIndex>;
- // `.Member` or `.Self` in an expression context, used in `where` and `require`
- // clauses.
- // TODO: Do we want to support `.1`, a designator for accessing a tuple member?
- struct DesignatorExpr {
- static constexpr auto Kind = NodeKind::DesignatorExpr.Define(
- {.category = NodeCategory::Expr, .child_count = 1});
- Lex::PeriodTokenIndex token;
- NodeIdOneOf<IdentifierNameNotBeforeParams, SelfTypeName> name;
- };
- struct RequirementEqual {
- static constexpr auto Kind = NodeKind::RequirementEqual.Define(
- {.category = NodeCategory::Requirement, .child_count = 2});
- DesignatorExprId lhs;
- Lex::EqualTokenIndex token;
- AnyExprId rhs;
- };
- struct RequirementEqualEqual {
- static constexpr auto Kind = NodeKind::RequirementEqualEqual.Define(
- {.category = NodeCategory::Requirement, .child_count = 2});
- AnyExprId lhs;
- Lex::EqualEqualTokenIndex token;
- AnyExprId rhs;
- };
- struct RequirementImpls {
- static constexpr auto Kind = NodeKind::RequirementImpls.Define(
- {.category = NodeCategory::Requirement, .child_count = 2});
- AnyExprId lhs;
- Lex::ImplsTokenIndex token;
- AnyExprId rhs;
- };
- // An `and` token separating requirements in a `where` expression.
- using RequirementAnd = LeafNode<NodeKind::RequirementAnd, Lex::AndTokenIndex>;
- struct WhereOperand {
- static constexpr auto Kind =
- NodeKind::WhereOperand.Define({.child_count = 1});
- AnyExprId type;
- // This is a virtual token. The `where` token is owned by the
- // WhereExpr node.
- Lex::WhereTokenIndex token;
- };
- struct WhereExpr {
- static constexpr auto Kind = NodeKind::WhereExpr.Define(
- {.category = NodeCategory::Expr, .bracketed_by = WhereOperand::Kind});
- WhereOperandId introducer;
- Lex::WhereTokenIndex token;
- CommaSeparatedList<AnyRequirementId, RequirementAndId> requirements;
- };
- // Choice nodes
- // ------------
- using ChoiceIntroducer =
- LeafNode<NodeKind::ChoiceIntroducer, Lex::ChoiceTokenIndex>;
- struct ChoiceSignature {
- static constexpr auto Kind = NodeKind::ChoiceDefinitionStart.Define(
- {.category = NodeCategory::None, .bracketed_by = ChoiceIntroducer::Kind});
- ChoiceIntroducerId introducer;
- llvm::SmallVector<AnyModifierId> modifiers;
- DeclName name;
- Lex::OpenCurlyBraceTokenIndex token;
- };
- using ChoiceDefinitionStart = ChoiceSignature;
- using ChoiceAlternativeListComma =
- LeafNode<NodeKind::ChoiceAlternativeListComma, Lex::CommaTokenIndex>;
- struct ChoiceDefinition {
- static constexpr auto Kind = NodeKind::ChoiceDefinition.Define(
- {.category = NodeCategory::Decl,
- .bracketed_by = ChoiceDefinitionStart::Kind});
- ChoiceDefinitionStartId signature;
- struct Alternative {
- AnyNonExprNameId name;
- std::optional<ExplicitParamListId> parameters;
- };
- CommaSeparatedList<Alternative, ChoiceAlternativeListCommaId> alternatives;
- Lex::CloseCurlyBraceTokenIndex token;
- };
- // Struct type and value literals
- // ----------------------------------------
- // `{`
- using StructLiteralStart =
- LeafNode<NodeKind::StructLiteralStart, Lex::OpenCurlyBraceTokenIndex>;
- using StructTypeLiteralStart =
- LeafNode<NodeKind::StructTypeLiteralStart, Lex::OpenCurlyBraceTokenIndex>;
- // `,`
- using StructLiteralComma =
- LeafNode<NodeKind::StructLiteralComma, Lex::CommaTokenIndex>;
- using StructTypeLiteralComma =
- LeafNode<NodeKind::StructTypeLiteralComma, Lex::CommaTokenIndex>;
- // `.a`
- // This is shared for struct literals and type literals in order to reduce
- // lookahead for parse (the `=` versus `:` would require lookahead of 2).
- struct StructFieldDesignator {
- static constexpr auto Kind =
- NodeKind::StructFieldDesignator.Define({.child_count = 1});
- Lex::PeriodTokenIndex token;
- NodeIdOneOf<IdentifierNameNotBeforeParams, BaseName> name;
- };
- // `.a = 0`
- struct StructLiteralField {
- static constexpr auto Kind = NodeKind::StructLiteralField.Define(
- {.bracketed_by = StructFieldDesignator::Kind, .child_count = 2});
- StructFieldDesignatorId designator;
- Lex::EqualTokenIndex token;
- AnyExprId expr;
- };
- // `.a: i32`
- struct StructTypeLiteralField {
- static constexpr auto Kind = NodeKind::StructTypeLiteralField.Define(
- {.bracketed_by = StructFieldDesignator::Kind, .child_count = 2});
- StructFieldDesignatorId designator;
- Lex::ColonTokenIndex token;
- AnyExprId type_expr;
- };
- // Struct literals, such as `{.a = 0}`.
- struct StructLiteral {
- static constexpr auto Kind = NodeKind::StructLiteral.Define(
- {.category = NodeCategory::Expr,
- .bracketed_by = StructLiteralStart::Kind});
- StructLiteralStartId start;
- CommaSeparatedList<StructLiteralFieldId, StructLiteralCommaId> fields;
- Lex::CloseCurlyBraceTokenIndex token;
- };
- // Struct type literals, such as `{.a: i32}`.
- struct StructTypeLiteral {
- static constexpr auto Kind = NodeKind::StructTypeLiteral.Define(
- {.category = NodeCategory::Expr,
- .bracketed_by = StructTypeLiteralStart::Kind});
- StructTypeLiteralStartId start;
- CommaSeparatedList<StructTypeLiteralFieldId, StructTypeLiteralCommaId> fields;
- Lex::CloseCurlyBraceTokenIndex token;
- };
- // `class` declarations and definitions
- // ------------------------------------
- // `class`
- using ClassIntroducer =
- LeafNode<NodeKind::ClassIntroducer, Lex::ClassTokenIndex>;
- // A class signature `class C`
- template <const NodeKind& KindT, typename TokenKind,
- NodeCategory::RawEnumType Category>
- struct ClassSignature {
- static constexpr auto Kind = KindT.Define(
- {.category = Category, .bracketed_by = ClassIntroducer::Kind});
- ClassIntroducerId introducer;
- llvm::SmallVector<AnyModifierId> modifiers;
- DeclName name;
- TokenKind token;
- };
- // `class C;`
- using ClassDecl = ClassSignature<NodeKind::ClassDecl, Lex::SemiTokenIndex,
- NodeCategory::Decl>;
- // `class C {`
- using ClassDefinitionStart =
- ClassSignature<NodeKind::ClassDefinitionStart,
- Lex::OpenCurlyBraceTokenIndex, NodeCategory::None>;
- // `class C { ... }`
- struct ClassDefinition {
- static constexpr auto Kind = NodeKind::ClassDefinition.Define(
- {.category = NodeCategory::Decl,
- .bracketed_by = ClassDefinitionStart::Kind});
- ClassDefinitionStartId signature;
- llvm::SmallVector<AnyDeclId> members;
- Lex::CloseCurlyBraceTokenIndex token;
- };
- // Adapter declaration
- // -------------------
- // `adapt`
- using AdaptIntroducer =
- LeafNode<NodeKind::AdaptIntroducer, Lex::AdaptTokenIndex>;
- // `adapt SomeType;`
- struct AdaptDecl {
- static constexpr auto Kind = NodeKind::AdaptDecl.Define(
- {.category = NodeCategory::Decl, .bracketed_by = AdaptIntroducer::Kind});
- AdaptIntroducerId introducer;
- llvm::SmallVector<AnyModifierId> modifiers;
- AnyExprId adapted_type;
- Lex::SemiTokenIndex token;
- };
- // Base class declaration
- // ----------------------
- // `base`
- using BaseIntroducer = LeafNode<NodeKind::BaseIntroducer, Lex::BaseTokenIndex>;
- using BaseColon = LeafNode<NodeKind::BaseColon, Lex::ColonTokenIndex>;
- // `extend base: BaseClass;`
- struct BaseDecl {
- static constexpr auto Kind = NodeKind::BaseDecl.Define(
- {.category = NodeCategory::Decl, .bracketed_by = BaseIntroducer::Kind});
- BaseIntroducerId introducer;
- llvm::SmallVector<AnyModifierId> modifiers;
- BaseColonId colon;
- AnyExprId base_class;
- Lex::SemiTokenIndex token;
- };
- // Interface declarations and definitions
- // --------------------------------------
- // `interface`
- using InterfaceIntroducer =
- LeafNode<NodeKind::InterfaceIntroducer, Lex::InterfaceTokenIndex>;
- // `interface I`
- template <const NodeKind& KindT, typename TokenKind,
- NodeCategory::RawEnumType Category>
- struct InterfaceSignature {
- static constexpr auto Kind = KindT.Define(
- {.category = Category, .bracketed_by = InterfaceIntroducer::Kind});
- InterfaceIntroducerId introducer;
- llvm::SmallVector<AnyModifierId> modifiers;
- DeclName name;
- TokenKind token;
- };
- // `interface I;`
- using InterfaceDecl =
- InterfaceSignature<NodeKind::InterfaceDecl, Lex::SemiTokenIndex,
- NodeCategory::Decl>;
- // `interface I {`
- using InterfaceDefinitionStart =
- InterfaceSignature<NodeKind::InterfaceDefinitionStart,
- Lex::OpenCurlyBraceTokenIndex, NodeCategory::None>;
- // `interface I { ... }`
- struct InterfaceDefinition {
- static constexpr auto Kind = NodeKind::InterfaceDefinition.Define(
- {.category = NodeCategory::Decl,
- .bracketed_by = InterfaceDefinitionStart::Kind});
- InterfaceDefinitionStartId signature;
- llvm::SmallVector<AnyDeclId> members;
- Lex::CloseCurlyBraceTokenIndex token;
- };
- // `require`...`impls` statements
- // ------------------------------
- // `require`
- using RequireIntroducer =
- LeafNode<NodeKind::RequireIntroducer, Lex::RequireTokenIndex>;
- // `impls` with no type before it
- using RequireDefaultSelfImpls =
- LeafNode<NodeKind::RequireDefaultSelfImpls, Lex::ImplsTokenIndex,
- NodeCategory::RequireImpls>;
- // `<type> impls`.
- struct RequireTypeImpls {
- static constexpr auto Kind = NodeKind::RequireTypeImpls.Define(
- {.category = NodeCategory::RequireImpls, .child_count = 1});
- AnyExprId type_expr;
- Lex::ImplsTokenIndex token;
- };
- // `require T impls I where...`
- struct RequireDecl {
- static constexpr auto Kind =
- NodeKind::RequireDecl.Define({.category = NodeCategory::Decl,
- .bracketed_by = RequireIntroducer::Kind});
- RequireIntroducerId introducer;
- llvm::SmallVector<AnyModifierId> modifiers;
- AnyRequireImplsId impls;
- AnyExprId facet_type;
- Lex::SemiTokenIndex token;
- };
- // `impl`...`as` declarations and definitions
- // ------------------------------------------
- // `impl`
- using ImplIntroducer = LeafNode<NodeKind::ImplIntroducer, Lex::ImplTokenIndex>;
- // `forall`
- using Forall = LeafNode<NodeKind::Forall, Lex::ForallTokenIndex>;
- // `forall [...]`
- struct ImplForall {
- ForallId forall;
- ImplicitParamListId params;
- };
- // `as` with no type before it
- using ImplDefaultSelfAs = LeafNode<NodeKind::ImplDefaultSelfAs,
- Lex::AsTokenIndex, NodeCategory::ImplAs>;
- // `<type> as`
- struct ImplTypeAs {
- static constexpr auto Kind = NodeKind::ImplTypeAs.Define(
- {.category = NodeCategory::ImplAs, .child_count = 1});
- AnyExprId type_expr;
- Lex::AsTokenIndex token;
- };
- // `impl T as I`
- template <const NodeKind& KindT, typename TokenKind,
- NodeCategory::RawEnumType Category>
- struct ImplSignature {
- static constexpr auto Kind = KindT.Define(
- {.category = Category, .bracketed_by = ImplIntroducer::Kind});
- ImplIntroducerId introducer;
- llvm::SmallVector<AnyModifierId> modifiers;
- std::optional<ImplForall> forall;
- AnyImplAsId as;
- AnyExprId interface;
- TokenKind token;
- };
- // `impl T as I;`
- using ImplDecl =
- ImplSignature<NodeKind::ImplDecl, Lex::SemiTokenIndex, NodeCategory::Decl>;
- // `impl T as I {`
- using ImplDefinitionStart =
- ImplSignature<NodeKind::ImplDefinitionStart, Lex::OpenCurlyBraceTokenIndex,
- NodeCategory::None>;
- // `impl T as I { ... }`
- struct ImplDefinition {
- static constexpr auto Kind = NodeKind::ImplDefinition.Define(
- {.category = NodeCategory::Decl,
- .bracketed_by = ImplDefinitionStart::Kind});
- ImplDefinitionStartId signature;
- llvm::SmallVector<AnyDeclId> members;
- Lex::CloseCurlyBraceTokenIndex token;
- };
- // Named constraint declarations and definitions
- // ---------------------------------------------
- // `constraint`
- using NamedConstraintIntroducer =
- LeafNode<NodeKind::NamedConstraintIntroducer, Lex::ConstraintTokenIndex>;
- // `constraint NC`
- template <const NodeKind& KindT, typename TokenKind,
- NodeCategory::RawEnumType Category>
- struct NamedConstraintSignature {
- static constexpr auto Kind = KindT.Define(
- {.category = Category, .bracketed_by = NamedConstraintIntroducer::Kind});
- NamedConstraintIntroducerId introducer;
- llvm::SmallVector<AnyModifierId> modifiers;
- DeclName name;
- TokenKind token;
- };
- // `constraint NC;`
- using NamedConstraintDecl =
- NamedConstraintSignature<NodeKind::NamedConstraintDecl, Lex::SemiTokenIndex,
- NodeCategory::Decl>;
- // `constraint NC {`
- using NamedConstraintDefinitionStart =
- NamedConstraintSignature<NodeKind::NamedConstraintDefinitionStart,
- Lex::OpenCurlyBraceTokenIndex, NodeCategory::None>;
- // `constraint NC { ... }`
- struct NamedConstraintDefinition {
- static constexpr auto Kind = NodeKind::NamedConstraintDefinition.Define(
- {.category = NodeCategory::Decl,
- .bracketed_by = NamedConstraintDefinitionStart::Kind});
- NamedConstraintDefinitionStartId signature;
- llvm::SmallVector<AnyDeclId> members;
- Lex::CloseCurlyBraceTokenIndex token;
- };
- // ---------------------------------------------------------------------------
- // A complete source file. Note that there is no corresponding parse node for
- // the file. The file is instead the complete contents of the parse tree.
- struct File {
- FileStartId start;
- llvm::SmallVector<AnyDeclId> decls;
- FileEndId end;
- };
- // Define `Foo` as the node type for the ID type `FooId`.
- #define CARBON_PARSE_NODE_KIND(KindName) \
- template <> \
- struct NodeForId<KindName##Id> { \
- using TypedNode = KindName; \
- };
- #include "toolchain/parse/node_kind.def"
- } // namespace Carbon::Parse
- #endif // CARBON_TOOLCHAIN_PARSE_TYPED_NODES_H_
|