eduucaldas created this revision.
Herald added a project: clang.
Herald added a subscriber: cfe-commits.
eduucaldas requested review of this revision.
We defined a List construct to help with the implementation of list-like
grammar rules. This is a first implementation of this API.
Repository:
rG LLVM Github Monorepo
https://reviews.llvm.org/D85295
Files:
clang/include/clang/Tooling/Syntax/Nodes.h
clang/include/clang/Tooling/Syntax/Tree.h
clang/lib/Tooling/Syntax/Nodes.cpp
clang/lib/Tooling/Syntax/Tree.cpp
Index: clang/lib/Tooling/Syntax/Tree.cpp
===================================================================
--- clang/lib/Tooling/Syntax/Tree.cpp
+++ clang/lib/Tooling/Syntax/Tree.cpp
@@ -270,3 +270,104 @@
}
return nullptr;
}
+
+std::vector<syntax::List::ElementAndDelimiter<syntax::Node>>
+syntax::List::getElementsAsNodesAndDelimiters() {
+ if (!firstChild()) {
+ assert(canBeEmpty());
+ return {};
+ }
+ auto children = std::vector<syntax::List::ElementAndDelimiter<Node>>();
+ syntax::Node *elementWithoutDelimiter = nullptr;
+ for (auto *C = firstChild(); C; C = C->nextSibling()) {
+ switch (C->role()) {
+ case syntax::NodeRole::List_element: {
+ if (elementWithoutDelimiter) {
+ children.push_back({elementWithoutDelimiter, nullptr});
+ }
+ elementWithoutDelimiter = C;
+ break;
+ }
+ case syntax::NodeRole::List_delimiter: {
+ children.push_back(
+ {elementWithoutDelimiter, llvm::cast<syntax::Leaf>(C)});
+ elementWithoutDelimiter = nullptr;
+ break;
+ }
+ default:
+ llvm_unreachable("A list has only elements or delimiters.");
+ }
+ }
+
+ switch (getTerminationKind()) {
+ case syntax::TerminationKind::Separated: {
+ children.push_back({elementWithoutDelimiter, nullptr});
+ break;
+ }
+ case syntax::TerminationKind::Terminated:
+ case syntax::TerminationKind::MaybeTerminated: {
+ if (elementWithoutDelimiter) {
+ children.push_back({elementWithoutDelimiter, nullptr});
+ }
+ break;
+ }
+ }
+
+ return children;
+}
+
+// Almost the same implementation of `getElementsAsNodesAndDelimiters` but
+// ignoring delimiters
+std::vector<syntax::Node *> syntax::List::getElementsAsNodes() {
+ if (!firstChild()) {
+ assert(canBeEmpty());
+ return {};
+ }
+ auto children = std::vector<syntax::Node *>();
+ syntax::Node *elementWithoutDelimiter = nullptr;
+ for (auto *C = firstChild(); C; C = C->nextSibling()) {
+ switch (C->role()) {
+ case syntax::NodeRole::List_element: {
+ if (elementWithoutDelimiter) {
+ children.push_back(elementWithoutDelimiter);
+ }
+ elementWithoutDelimiter = C;
+ break;
+ }
+ case syntax::NodeRole::List_delimiter: {
+ children.push_back(elementWithoutDelimiter);
+ elementWithoutDelimiter = nullptr;
+ break;
+ }
+ default:
+ llvm_unreachable("A list has only elements or delimiters.");
+ }
+ }
+
+ switch (getTerminationKind()) {
+ case syntax::TerminationKind::Separated: {
+ children.push_back(elementWithoutDelimiter);
+ break;
+ }
+ case syntax::TerminationKind::Terminated:
+ case syntax::TerminationKind::MaybeTerminated: {
+ if (elementWithoutDelimiter) {
+ children.push_back(elementWithoutDelimiter);
+ }
+ break;
+ }
+ }
+
+ return children;
+}
+
+// The methods below can't be implemented without additional information we
+// have. Should we give them default permissive values?
+
+clang::tok::TokenKind syntax::List::getDelimiterTokenKind() {
+ return clang::tok::TokenKind::unknown;
+}
+syntax::TerminationKind syntax::List::getTerminationKind() {
+ return syntax::TerminationKind::MaybeTerminated;
+}
+bool syntax::List::canBeEmpty() { return true; }
Index: clang/lib/Tooling/Syntax/Nodes.cpp
===================================================================
--- clang/lib/Tooling/Syntax/Nodes.cpp
+++ clang/lib/Tooling/Syntax/Nodes.cpp
@@ -144,6 +144,10 @@
return OS << "ExternKeyword";
case syntax::NodeRole::BodyStatement:
return OS << "BodyStatement";
+ case syntax::NodeRole::List_element:
+ return OS << "List_element";
+ case syntax::NodeRole::List_delimiter:
+ return OS << "List_delimiter";
case syntax::NodeRole::CaseStatement_value:
return OS << "CaseStatement_value";
case syntax::NodeRole::IfStatement_thenStatement:
Index: clang/include/clang/Tooling/Syntax/Tree.h
===================================================================
--- clang/include/clang/Tooling/Syntax/Tree.h
+++ clang/include/clang/Tooling/Syntax/Tree.h
@@ -191,6 +191,47 @@
Node *FirstChild = nullptr;
};
+enum TerminationKind {
+ Terminated,
+ MaybeTerminated,
+ Separated,
+};
+
+class List : public Tree {
+ template <typename Element> struct ElementAndDelimiter {
+ Element *element;
+ Leaf *delimiter;
+ };
+
+ /// Returns the elements and corresponding delimiters. Missing elements
+ /// and delimiters are represented as null pointers.
+ ///
+ /// For example, in a separated list:
+ /// "a, b, c" <=> [("a", ","), ("b", ","), ("c", null)]
+ /// "a, , c" <=> [("a", ","), (null, ","), ("c", ",)]
+ /// "a, b," <=> [("a", ","), ("b", ","), (null, null)]
+ ///
+ /// In a terminated or maybe-terminated list:
+ /// "a, b," <=> [("a", ","), ("b", ",")]
+ std::vector<ElementAndDelimiter<Node>> getElementsAsNodesAndDelimiters();
+
+ /// Returns the elements of the list. Missing elements are represented
+ /// as null pointers in the same way as in the return value of
+ /// `getElementsAsNodesAndDelimiters()`.
+ std::vector<Node *> getElementsAsNodes();
+
+ // These can't be implemented with the information we have!
+
+ /// Returns the appropriate delimiter for this list.
+ ///
+ /// Useful for discovering the correct delimiter to use when adding
+ /// elements to empty or one-element lists.
+ clang::tok::TokenKind getDelimiterTokenKind();
+
+ TerminationKind getTerminationKind();
+ bool canBeEmpty();
+};
+
} // namespace syntax
} // namespace clang
Index: clang/include/clang/Tooling/Syntax/Nodes.h
===================================================================
--- clang/include/clang/Tooling/Syntax/Nodes.h
+++ clang/include/clang/Tooling/Syntax/Nodes.h
@@ -142,6 +142,8 @@
/// statement, e.g. loop body for while, for, etc; inner statement for case,
/// default, etc.
BodyStatement,
+ List_element,
+ List_delimiter,
// Roles specific to particular node kinds.
OperatorExpression_operatorToken,
_______________________________________________
cfe-commits mailing list
cfe-commits@lists.llvm.org
https://lists.llvm.org/cgi-bin/mailman/listinfo/cfe-commits
