[clangd] Implement fold range for #pragma region #168177
Open
+90
−3
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Member
|
@llvm/pr-subscribers-clangd Author: Haojian Wu (hokein) ChangesThe implementation is based on the directive tree. Fixes clangd/clangd#1623 Full diff: https://github.com/llvm/llvm-project/pull/168177.diff 2 Files Affected:
diff --git a/clang-tools-extra/clangd/SemanticSelection.cpp b/clang-tools-extra/clangd/SemanticSelection.cpp
index 3353121a01825..a6a385cd0571d 100644
--- a/clang-tools-extra/clangd/SemanticSelection.cpp
+++ b/clang-tools-extra/clangd/SemanticSelection.cpp
@@ -11,9 +11,13 @@
#include "Protocol.h"
#include "Selection.h"
#include "SourceCode.h"
+#include "support/Bracket.h"
+#include "support/DirectiveTree.h"
+#include "support/Token.h"
#include "clang/AST/DeclBase.h"
#include "clang/Basic/SourceLocation.h"
#include "clang/Basic/SourceManager.h"
+#include "clang/Basic/TokenKinds.h"
#include "clang/Tooling/Syntax/BuildTree.h"
#include "clang/Tooling/Syntax/Nodes.h"
#include "clang/Tooling/Syntax/TokenBufferTokenManager.h"
@@ -22,9 +26,6 @@
#include "llvm/ADT/StringRef.h"
#include "llvm/Support/Casting.h"
#include "llvm/Support/Error.h"
-#include "support/Bracket.h"
-#include "support/DirectiveTree.h"
-#include "support/Token.h"
#include <optional>
#include <queue>
#include <vector>
@@ -163,6 +164,66 @@ llvm::Expected<SelectionRange> getSemanticRanges(ParsedAST &AST, Position Pos) {
return std::move(Head);
}
+class PragmaRegionFinder {
+ // Record the token range of a region:
+ //
+ // #pragma region [[name
+ // ...
+ // ]]#pragma region
+ std::vector<Token::Range> &Ranges;
+ const TokenStream &Code;
+ // Stack of starting token (the name of the region) indices for nested #pragma
+ // region.
+ std::vector<unsigned> Stack;
+
+public:
+ PragmaRegionFinder(std::vector<Token::Range> &Ranges, const TokenStream &Code)
+ : Ranges(Ranges), Code(Code) {}
+
+ void walk(const DirectiveTree &T) {
+ for (const auto &C : T.Chunks)
+ std::visit(*this, C);
+ }
+
+ void operator()(const DirectiveTree::Code &C) {}
+
+ void operator()(const DirectiveTree::Directive &D) {
+ // Get the tokens that make up this directive.
+ auto Tokens = Code.tokens(D.Tokens);
+ if (Tokens.empty())
+ return;
+ const Token &HashToken = Tokens.front();
+ assert(HashToken.Kind == tok::hash);
+ const Token &Pragma = HashToken.nextNC();
+ if (Pragma.text() != "pragma")
+ return;
+ const Token &Value = Pragma.nextNC();
+
+ // Handle "#pragma region name"
+ if (Value.text() == "region") {
+ // Record the name token.
+ if (&Value < Tokens.end())
+ Stack.push_back((&Value + 1)->OriginalIndex);
+ return;
+ }
+
+ // Handle "#pragma endregion"
+ if (Value.text() == "endregion") {
+ if (Stack.empty())
+ return; // unmatched end region; ignore.
+
+ unsigned StartIdx = Stack.back();
+ Stack.pop_back();
+ Ranges.push_back(Token::Range{StartIdx, HashToken.OriginalIndex});
+ }
+ }
+
+ void operator()(const DirectiveTree::Conditional &C) {
+ for (const auto &[_, SubTree] : C.Branches)
+ walk(SubTree);
+ }
+};
+
// FIXME(kirillbobyrev): Collect comments, PP conditional regions, includes and
// other code regions (e.g. public/private/protected sections of classes,
// control flow statement bodies).
@@ -286,6 +347,17 @@ getFoldingRanges(const std::string &Code, bool LineFoldingOnly) {
}
AddFoldingRange(Start, End, FoldingRange::COMMENT_KIND);
}
+
+ // #pragma region
+ std::vector<Token::Range> Ranges;
+ PragmaRegionFinder(Ranges, OrigStream).walk(DirectiveStructure);
+ auto Ts = OrigStream.tokens();
+ for (const auto &R : Ranges) {
+ auto End = StartPosition(Ts[R.End]);
+ if (LineFoldingOnly)
+ End.line--;
+ AddFoldingRange(EndPosition(Ts[R.Begin]), End, FoldingRange::REGION_KIND);
+ }
return Result;
}
diff --git a/clang-tools-extra/clangd/unittests/SemanticSelectionTests.cpp b/clang-tools-extra/clangd/unittests/SemanticSelectionTests.cpp
index 4efae25dcd077..08cc8a651adc8 100644
--- a/clang-tools-extra/clangd/unittests/SemanticSelectionTests.cpp
+++ b/clang-tools-extra/clangd/unittests/SemanticSelectionTests.cpp
@@ -410,6 +410,15 @@ TEST(FoldingRanges, PseudoParserWithoutLineFoldings) {
Variable = 3;
#
)cpp",
+ R"cpp(
+ #pragma region R1[[
+
+ #pragma region R2[[
+ constexpr int a = 2;
+ ]]#pragma endregion
+
+ ]]#pragma endregion
+ )cpp",
};
for (const char *Test : Tests) {
auto T = Annotations(Test);
@@ -470,6 +479,12 @@ TEST(FoldingRanges, PseudoParserLineFoldingsOnly) {
//[[ foo
/* bar */]]
)cpp",
+ R"cpp(
+ #pragma region abc[[
+ constexpr int a = 2;
+ ]]
+ #pragma endregion
+ )cpp",
// FIXME: Support folding template arguments.
// R"cpp(
// template <[[typename foo, class bar]]> struct baz {};
|
Member
|
@llvm/pr-subscribers-clang-tools-extra Author: Haojian Wu (hokein) ChangesThe implementation is based on the directive tree. Fixes clangd/clangd#1623 Full diff: https://github.com/llvm/llvm-project/pull/168177.diff 2 Files Affected:
diff --git a/clang-tools-extra/clangd/SemanticSelection.cpp b/clang-tools-extra/clangd/SemanticSelection.cpp
index 3353121a01825..a6a385cd0571d 100644
--- a/clang-tools-extra/clangd/SemanticSelection.cpp
+++ b/clang-tools-extra/clangd/SemanticSelection.cpp
@@ -11,9 +11,13 @@
#include "Protocol.h"
#include "Selection.h"
#include "SourceCode.h"
+#include "support/Bracket.h"
+#include "support/DirectiveTree.h"
+#include "support/Token.h"
#include "clang/AST/DeclBase.h"
#include "clang/Basic/SourceLocation.h"
#include "clang/Basic/SourceManager.h"
+#include "clang/Basic/TokenKinds.h"
#include "clang/Tooling/Syntax/BuildTree.h"
#include "clang/Tooling/Syntax/Nodes.h"
#include "clang/Tooling/Syntax/TokenBufferTokenManager.h"
@@ -22,9 +26,6 @@
#include "llvm/ADT/StringRef.h"
#include "llvm/Support/Casting.h"
#include "llvm/Support/Error.h"
-#include "support/Bracket.h"
-#include "support/DirectiveTree.h"
-#include "support/Token.h"
#include <optional>
#include <queue>
#include <vector>
@@ -163,6 +164,66 @@ llvm::Expected<SelectionRange> getSemanticRanges(ParsedAST &AST, Position Pos) {
return std::move(Head);
}
+class PragmaRegionFinder {
+ // Record the token range of a region:
+ //
+ // #pragma region [[name
+ // ...
+ // ]]#pragma region
+ std::vector<Token::Range> &Ranges;
+ const TokenStream &Code;
+ // Stack of starting token (the name of the region) indices for nested #pragma
+ // region.
+ std::vector<unsigned> Stack;
+
+public:
+ PragmaRegionFinder(std::vector<Token::Range> &Ranges, const TokenStream &Code)
+ : Ranges(Ranges), Code(Code) {}
+
+ void walk(const DirectiveTree &T) {
+ for (const auto &C : T.Chunks)
+ std::visit(*this, C);
+ }
+
+ void operator()(const DirectiveTree::Code &C) {}
+
+ void operator()(const DirectiveTree::Directive &D) {
+ // Get the tokens that make up this directive.
+ auto Tokens = Code.tokens(D.Tokens);
+ if (Tokens.empty())
+ return;
+ const Token &HashToken = Tokens.front();
+ assert(HashToken.Kind == tok::hash);
+ const Token &Pragma = HashToken.nextNC();
+ if (Pragma.text() != "pragma")
+ return;
+ const Token &Value = Pragma.nextNC();
+
+ // Handle "#pragma region name"
+ if (Value.text() == "region") {
+ // Record the name token.
+ if (&Value < Tokens.end())
+ Stack.push_back((&Value + 1)->OriginalIndex);
+ return;
+ }
+
+ // Handle "#pragma endregion"
+ if (Value.text() == "endregion") {
+ if (Stack.empty())
+ return; // unmatched end region; ignore.
+
+ unsigned StartIdx = Stack.back();
+ Stack.pop_back();
+ Ranges.push_back(Token::Range{StartIdx, HashToken.OriginalIndex});
+ }
+ }
+
+ void operator()(const DirectiveTree::Conditional &C) {
+ for (const auto &[_, SubTree] : C.Branches)
+ walk(SubTree);
+ }
+};
+
// FIXME(kirillbobyrev): Collect comments, PP conditional regions, includes and
// other code regions (e.g. public/private/protected sections of classes,
// control flow statement bodies).
@@ -286,6 +347,17 @@ getFoldingRanges(const std::string &Code, bool LineFoldingOnly) {
}
AddFoldingRange(Start, End, FoldingRange::COMMENT_KIND);
}
+
+ // #pragma region
+ std::vector<Token::Range> Ranges;
+ PragmaRegionFinder(Ranges, OrigStream).walk(DirectiveStructure);
+ auto Ts = OrigStream.tokens();
+ for (const auto &R : Ranges) {
+ auto End = StartPosition(Ts[R.End]);
+ if (LineFoldingOnly)
+ End.line--;
+ AddFoldingRange(EndPosition(Ts[R.Begin]), End, FoldingRange::REGION_KIND);
+ }
return Result;
}
diff --git a/clang-tools-extra/clangd/unittests/SemanticSelectionTests.cpp b/clang-tools-extra/clangd/unittests/SemanticSelectionTests.cpp
index 4efae25dcd077..08cc8a651adc8 100644
--- a/clang-tools-extra/clangd/unittests/SemanticSelectionTests.cpp
+++ b/clang-tools-extra/clangd/unittests/SemanticSelectionTests.cpp
@@ -410,6 +410,15 @@ TEST(FoldingRanges, PseudoParserWithoutLineFoldings) {
Variable = 3;
#
)cpp",
+ R"cpp(
+ #pragma region R1[[
+
+ #pragma region R2[[
+ constexpr int a = 2;
+ ]]#pragma endregion
+
+ ]]#pragma endregion
+ )cpp",
};
for (const char *Test : Tests) {
auto T = Annotations(Test);
@@ -470,6 +479,12 @@ TEST(FoldingRanges, PseudoParserLineFoldingsOnly) {
//[[ foo
/* bar */]]
)cpp",
+ R"cpp(
+ #pragma region abc[[
+ constexpr int a = 2;
+ ]]
+ #pragma endregion
+ )cpp",
// FIXME: Support folding template arguments.
// R"cpp(
// template <[[typename foo, class bar]]> struct baz {};
|
| // | ||
| // #pragma region [[name | ||
| // ... | ||
| // ]]#pragma region |
| const Token &Pragma = HashToken.nextNC(); | ||
| if (Pragma.text() != "pragma") | ||
| return; | ||
| const Token &Value = Pragma.nextNC(); |
Collaborator
There was a problem hiding this comment.
If there can be a comment between pragma and region...
| if (Value.text() == "region") { | ||
| // Record the name token. | ||
| if (&Value < Tokens.end()) | ||
| Stack.push_back((&Value + 1)->OriginalIndex); |
Collaborator
There was a problem hiding this comment.
... there could also be one between region and the name?
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
The implementation is based on the directive tree.
Fixes clangd/clangd#1623