|
|
@@ -78,7 +78,6 @@ struct File;
|
|
|
class Tree : public Printable<Tree> {
|
|
|
public:
|
|
|
class PostorderIterator;
|
|
|
- class SiblingIterator;
|
|
|
|
|
|
// Names in packaging, whether the file's packaging or an import. Links back
|
|
|
// to the node for diagnostics.
|
|
|
@@ -114,20 +113,6 @@ class Tree : public Printable<Tree> {
|
|
|
// postorder.
|
|
|
auto postorder() const -> llvm::iterator_range<PostorderIterator>;
|
|
|
|
|
|
- // Returns an iterable range over the parse tree node and all of its
|
|
|
- // descendants in depth-first postorder.
|
|
|
- auto postorder(NodeId n) const -> llvm::iterator_range<PostorderIterator>;
|
|
|
-
|
|
|
- // Returns an iterable range over the direct children of a node in the parse
|
|
|
- // tree. This is a forward range, but is constant time to increment. The order
|
|
|
- // of children is the same as would be found in a reverse postorder traversal.
|
|
|
- auto children(NodeId n) const -> llvm::iterator_range<SiblingIterator>;
|
|
|
-
|
|
|
- // Returns an iterable range over the roots of the parse tree. This is a
|
|
|
- // forward range, but is constant time to increment. The order of roots is the
|
|
|
- // same as would be found in a reverse postorder traversal.
|
|
|
- auto roots() const -> llvm::iterator_range<SiblingIterator>;
|
|
|
-
|
|
|
// Tests whether a particular node contains an error and may not match the
|
|
|
// full expected structure of the grammar.
|
|
|
auto node_has_error(NodeId n) const -> bool;
|
|
|
@@ -183,96 +168,19 @@ class Tree : public Printable<Tree> {
|
|
|
return deferred_definitions_;
|
|
|
}
|
|
|
|
|
|
- // See the other Print comments.
|
|
|
+ // Builds TreeAndSubtrees to print the tree.
|
|
|
auto Print(llvm::raw_ostream& output) const -> void;
|
|
|
|
|
|
- // Prints a description of the parse tree to the provided `raw_ostream`.
|
|
|
- //
|
|
|
- // The tree may be printed in either preorder or postorder. Output represents
|
|
|
- // each node as a YAML record; in preorder, children are nested.
|
|
|
- //
|
|
|
- // In both, a node is formatted as:
|
|
|
- // ```
|
|
|
- // {kind: 'foo', text: '...'}
|
|
|
- // ```
|
|
|
- //
|
|
|
- // The top level is formatted as an array of these nodes.
|
|
|
- // ```
|
|
|
- // [
|
|
|
- // {kind: 'foo', text: '...'},
|
|
|
- // {kind: 'foo', text: '...'},
|
|
|
- // ...
|
|
|
- // ]
|
|
|
- // ```
|
|
|
- //
|
|
|
- // In postorder, nodes are indented in order to indicate depth. For example, a
|
|
|
- // node with two children, one of them with an error:
|
|
|
- // ```
|
|
|
- // {kind: 'bar', text: '...', has_error: yes},
|
|
|
- // {kind: 'baz', text: '...'}
|
|
|
- // {kind: 'foo', text: '...', subtree_size: 2}
|
|
|
- // ```
|
|
|
- //
|
|
|
- // In preorder, nodes are marked as children with postorder (storage) index.
|
|
|
- // For example, a node with two children, one of them with an error:
|
|
|
- // ```
|
|
|
- // {node_index: 2, kind: 'foo', text: '...', subtree_size: 2, children: [
|
|
|
- // {node_index: 0, kind: 'bar', text: '...', has_error: yes},
|
|
|
- // {node_index: 1, kind: 'baz', text: '...'}]}
|
|
|
- // ```
|
|
|
- //
|
|
|
- // This can be parsed as YAML using tools like `python-yq` combined with `jq`
|
|
|
- // on the command line. The format is also reasonably amenable to other
|
|
|
- // line-oriented shell tools from `grep` to `awk`.
|
|
|
- auto Print(llvm::raw_ostream& output, bool preorder) const -> void;
|
|
|
-
|
|
|
// Collects memory usage of members.
|
|
|
auto CollectMemUsage(MemUsage& mem_usage, llvm::StringRef label) const
|
|
|
-> void;
|
|
|
|
|
|
- // The following `Extract*` function provide an alternative way of accessing
|
|
|
- // the nodes of a tree. It is intended to be more convenient and type-safe,
|
|
|
- // but slower and can't be used on nodes that are marked as having an error.
|
|
|
- // It is appropriate for uses that are less performance sensitive, like
|
|
|
- // diagnostics. Example usage:
|
|
|
- // ```
|
|
|
- // auto file = tree->ExtractFile();
|
|
|
- // for (AnyDeclId decl_id : file.decls) {
|
|
|
- // // `decl_id` is convertible to a `NodeId`.
|
|
|
- // if (std::optional<FunctionDecl> fn_decl =
|
|
|
- // tree->ExtractAs<FunctionDecl>(decl_id)) {
|
|
|
- // // fn_decl->params is a `TuplePatternId` (which extends `NodeId`)
|
|
|
- // // that is guaranteed to reference a `TuplePattern`.
|
|
|
- // std::optional<TuplePattern> params = tree->Extract(fn_decl->params);
|
|
|
- // // `params` has a value unless there was an error in that node.
|
|
|
- // } else if (auto class_def = tree->ExtractAs<ClassDefinition>(decl_id)) {
|
|
|
- // // ...
|
|
|
- // }
|
|
|
- // }
|
|
|
- // ```
|
|
|
-
|
|
|
- // Extract a `File` object representing the parse tree for the whole file.
|
|
|
- // #include "toolchain/parse/typed_nodes.h" to get the definition of `File`
|
|
|
- // and the types representing its children nodes. This is implemented in
|
|
|
- // extract.cpp.
|
|
|
- auto ExtractFile() const -> File;
|
|
|
-
|
|
|
- // Converts this node_id to a typed node of a specified type, if it is a valid
|
|
|
- // node of that kind.
|
|
|
- template <typename T>
|
|
|
- auto ExtractAs(NodeId node_id) const -> std::optional<T>;
|
|
|
-
|
|
|
- // Converts to a typed node, if it is not an error.
|
|
|
- template <typename IdT>
|
|
|
- auto Extract(IdT id) const
|
|
|
- -> std::optional<typename NodeForId<IdT>::TypedNode>;
|
|
|
-
|
|
|
// Verifies the parse tree structure. Checks invariants of the parse tree
|
|
|
// structure and returns verification errors.
|
|
|
//
|
|
|
- // This is fairly slow, and is primarily intended to be used as a debugging
|
|
|
- // aid. This routine doesn't directly CHECK so that it can be used within a
|
|
|
- // debugger.
|
|
|
+ // In opt builds, this does some minimal checking. In debug builds, it'll
|
|
|
+ // build a TreeAndSubtrees and run further verification. This doesn't directly
|
|
|
+ // CHECK so that it can be used within a debugger.
|
|
|
auto Verify() const -> ErrorOr<Success>;
|
|
|
|
|
|
private:
|
|
|
@@ -285,12 +193,8 @@ class Tree : public Printable<Tree> {
|
|
|
// The in-memory representation of data used for a particular node in the
|
|
|
// tree.
|
|
|
struct NodeImpl {
|
|
|
- explicit NodeImpl(NodeKind kind, bool has_error, Lex::TokenIndex token,
|
|
|
- int subtree_size)
|
|
|
- : kind(kind),
|
|
|
- has_error(has_error),
|
|
|
- token(token),
|
|
|
- subtree_size(subtree_size) {}
|
|
|
+ explicit NodeImpl(NodeKind kind, bool has_error, Lex::TokenIndex token)
|
|
|
+ : kind(kind), has_error(has_error), token(token) {}
|
|
|
|
|
|
// The kind of this node. Note that this is only a single byte.
|
|
|
NodeKind kind;
|
|
|
@@ -315,38 +219,11 @@ class Tree : public Printable<Tree> {
|
|
|
|
|
|
// The token root of this node.
|
|
|
Lex::TokenIndex token;
|
|
|
-
|
|
|
- // The size of this node's subtree of the parse tree. This is the number of
|
|
|
- // nodes (and thus tokens) that are covered by this node (and its
|
|
|
- // descendents) in the parse tree.
|
|
|
- //
|
|
|
- // During a *reverse* postorder (RPO) traversal of the parse tree, this can
|
|
|
- // also be thought of as the offset to the next non-descendant node. When
|
|
|
- // this node is not the first child of its parent (which is the last child
|
|
|
- // visited in RPO), that is the offset to the next sibling. When this node
|
|
|
- // *is* the first child of its parent, this will be an offset to the node's
|
|
|
- // parent's next sibling, or if it the parent is also a first child, the
|
|
|
- // grandparent's next sibling, and so on.
|
|
|
- //
|
|
|
- // This field should always be a positive integer as at least this node is
|
|
|
- // part of its subtree.
|
|
|
- int32_t subtree_size;
|
|
|
};
|
|
|
|
|
|
- static_assert(sizeof(NodeImpl) == 12,
|
|
|
+ static_assert(sizeof(NodeImpl) == 8,
|
|
|
"Unexpected size of node implementation!");
|
|
|
|
|
|
- // Like ExtractAs(), but malformed tree errors are not fatal. Should only be
|
|
|
- // used by `Verify()` or by tests.
|
|
|
- template <typename T>
|
|
|
- auto VerifyExtractAs(NodeId node_id, ErrorBuilder* trace) const
|
|
|
- -> std::optional<T>;
|
|
|
-
|
|
|
- // Wrapper around `VerifyExtractAs` to dispatch based on a runtime node kind.
|
|
|
- // Returns true if extraction was successful.
|
|
|
- auto VerifyExtract(NodeId node_id, NodeKind kind, ErrorBuilder* trace) const
|
|
|
- -> bool;
|
|
|
-
|
|
|
// Sets the kind of a node. This is intended to allow putting the tree into a
|
|
|
// state where verification can fail, in order to make the failure path of
|
|
|
// `Verify` testable.
|
|
|
@@ -354,26 +231,6 @@ class Tree : public Printable<Tree> {
|
|
|
node_impls_[node_id.index].kind = kind;
|
|
|
}
|
|
|
|
|
|
- // Prints a single node for Print(). Returns true when preorder and there are
|
|
|
- // children.
|
|
|
- auto PrintNode(llvm::raw_ostream& output, NodeId n, int depth,
|
|
|
- bool preorder) const -> bool;
|
|
|
-
|
|
|
- // Extract a node of type `T` from a sibling range. This is expected to
|
|
|
- // consume the complete sibling range. Malformed tree errors are written
|
|
|
- // to `*trace`, if `trace != nullptr`. This is implemented in extract.cpp.
|
|
|
- template <typename T>
|
|
|
- auto TryExtractNodeFromChildren(
|
|
|
- NodeId node_id, llvm::iterator_range<Tree::SiblingIterator> children,
|
|
|
- ErrorBuilder* trace) const -> std::optional<T>;
|
|
|
-
|
|
|
- // Extract a node of type `T` from a sibling range. This is expected to
|
|
|
- // consume the complete sibling range. Malformed tree errors are fatal.
|
|
|
- template <typename T>
|
|
|
- auto ExtractNodeFromChildren(
|
|
|
- NodeId node_id,
|
|
|
- llvm::iterator_range<Tree::SiblingIterator> children) const -> T;
|
|
|
-
|
|
|
// Depth-first postorder sequence of node implementation data.
|
|
|
llvm::SmallVector<NodeImpl> node_impls_;
|
|
|
|
|
|
@@ -449,102 +306,6 @@ class Tree::PostorderIterator
|
|
|
NodeId node_;
|
|
|
};
|
|
|
|
|
|
-// A forward iterator across the siblings at a particular level in the parse
|
|
|
-// tree. It produces `Tree::NodeId` objects which are opaque handles and must
|
|
|
-// be used in conjunction with the `Tree` itself.
|
|
|
-//
|
|
|
-// While this is a forward iterator and may not have good locality within the
|
|
|
-// `Tree` data structure, it is still constant time to increment and
|
|
|
-// suitable for algorithms relying on that property.
|
|
|
-//
|
|
|
-// The siblings are discovered through a reverse postorder (RPO) tree traversal
|
|
|
-// (which is made constant time through cached distance information), and so the
|
|
|
-// relative order of siblings matches their RPO order.
|
|
|
-class Tree::SiblingIterator
|
|
|
- : public llvm::iterator_facade_base<SiblingIterator,
|
|
|
- std::forward_iterator_tag, NodeId, int,
|
|
|
- const NodeId*, NodeId>,
|
|
|
- public Printable<Tree::SiblingIterator> {
|
|
|
- public:
|
|
|
- explicit SiblingIterator() = delete;
|
|
|
-
|
|
|
- auto operator==(const SiblingIterator& rhs) const -> bool {
|
|
|
- return node_ == rhs.node_;
|
|
|
- }
|
|
|
-
|
|
|
- auto operator*() const -> NodeId { return node_; }
|
|
|
-
|
|
|
- using iterator_facade_base::operator++;
|
|
|
- auto operator++() -> SiblingIterator& {
|
|
|
- node_.index -= std::abs(tree_->node_impls_[node_.index].subtree_size);
|
|
|
- return *this;
|
|
|
- }
|
|
|
-
|
|
|
- // Prints the underlying node index.
|
|
|
- auto Print(llvm::raw_ostream& output) const -> void;
|
|
|
-
|
|
|
- private:
|
|
|
- friend class Tree;
|
|
|
-
|
|
|
- explicit SiblingIterator(const Tree& tree_arg, NodeId n)
|
|
|
- : tree_(&tree_arg), node_(n) {}
|
|
|
-
|
|
|
- const Tree* tree_;
|
|
|
-
|
|
|
- NodeId node_;
|
|
|
-};
|
|
|
-
|
|
|
-template <typename T>
|
|
|
-auto Tree::ExtractNodeFromChildren(
|
|
|
- NodeId node_id, llvm::iterator_range<Tree::SiblingIterator> children) const
|
|
|
- -> T {
|
|
|
- auto result = TryExtractNodeFromChildren<T>(node_id, children, nullptr);
|
|
|
- if (!result.has_value()) {
|
|
|
- // On error try again, this time capturing a trace.
|
|
|
- ErrorBuilder trace;
|
|
|
- TryExtractNodeFromChildren<T>(node_id, children, &trace);
|
|
|
- CARBON_FATAL() << "Malformed parse node:\n"
|
|
|
- << static_cast<Error>(trace).message();
|
|
|
- }
|
|
|
- return *result;
|
|
|
-}
|
|
|
-
|
|
|
-template <typename T>
|
|
|
-auto Tree::ExtractAs(NodeId node_id) const -> std::optional<T> {
|
|
|
- static_assert(HasKindMember<T>, "Not a parse node type");
|
|
|
- if (!IsValid<T>(node_id)) {
|
|
|
- return std::nullopt;
|
|
|
- }
|
|
|
-
|
|
|
- return ExtractNodeFromChildren<T>(node_id, children(node_id));
|
|
|
-}
|
|
|
-
|
|
|
-template <typename T>
|
|
|
-auto Tree::VerifyExtractAs(NodeId node_id, ErrorBuilder* trace) const
|
|
|
- -> std::optional<T> {
|
|
|
- static_assert(HasKindMember<T>, "Not a parse node type");
|
|
|
- if (!IsValid<T>(node_id)) {
|
|
|
- if (trace) {
|
|
|
- *trace << "VerifyExtractAs error: wrong kind " << node_kind(node_id)
|
|
|
- << ", expected " << T::Kind << "\n";
|
|
|
- }
|
|
|
- return std::nullopt;
|
|
|
- }
|
|
|
-
|
|
|
- return TryExtractNodeFromChildren<T>(node_id, children(node_id), trace);
|
|
|
-}
|
|
|
-
|
|
|
-template <typename IdT>
|
|
|
-auto Tree::Extract(IdT id) const
|
|
|
- -> std::optional<typename NodeForId<IdT>::TypedNode> {
|
|
|
- if (!IsValid(id)) {
|
|
|
- return std::nullopt;
|
|
|
- }
|
|
|
-
|
|
|
- using T = typename NodeForId<IdT>::TypedNode;
|
|
|
- return ExtractNodeFromChildren<T>(id, children(id));
|
|
|
-}
|
|
|
-
|
|
|
template <const NodeKind& K>
|
|
|
struct Tree::ConvertTo<NodeIdForKind<K>> {
|
|
|
static auto AllowedFor(NodeKind kind) -> bool { return kind == K; }
|