[clang-doc] Precommit concept tests #144160
Open
+150
−0
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
This stack of pull requests is managed by Graphite. Learn more about stacking. |
|
@llvm/pr-subscribers-clang-tools-extra Author: Erick Velez (evelez7) ChangesFull diff: https://github.com/llvm/llvm-project/pull/144160.diff 3 Files Affected:
diff --git a/clang-tools-extra/test/clang-doc/json/class-requires.cpp b/clang-tools-extra/test/clang-doc/json/class-requires.cpp
new file mode 100644
index 0000000000000..022ce94d8c5af
--- /dev/null
+++ b/clang-tools-extra/test/clang-doc/json/class-requires.cpp
@@ -0,0 +1,29 @@
+// RUN: rm -rf %t && mkdir -p %t
+// RUN: clang-doc --extra-arg -std=c++20 --output=%t --format=json --executor=standalone %s
+// RUN: FileCheck %s < %t/GlobalNamespace/MyClass.json
+
+template<typename T>
+concept Addable = requires(T a, T b) {
+ { a + b };
+};
+
+template<typename T>
+requires Addable<T>
+struct MyClass {
+};
+
+// CHECK: "Name": "MyClass",
+// CHECK-NEXT: "Namespace": [
+// CHECK-NEXT: "GlobalNamespace"
+// CHECK-NEXT: ],
+// CHECK-NEXT: "Path": "GlobalNamespace",
+// CHECK-NEXT: "TagType": "struct",
+// CHECK-NEXT: "Template": {
+// CHECK-NOT: "Constraints": [
+// CHECK-NOT: "Addable<T>"
+// CHECK-NOT: ],
+// CHECK-NEXT: "Parameters": [
+// CHECK-NEXT: "typename T"
+// CHECK-NEXT: ]
+// CHECK-NEXT: },
+// CHECK-NEXT: "USR": "{{[A-F0-9]*}}"
diff --git a/clang-tools-extra/test/clang-doc/json/concept.cpp b/clang-tools-extra/test/clang-doc/json/concept.cpp
new file mode 100644
index 0000000000000..78be607d1f2f1
--- /dev/null
+++ b/clang-tools-extra/test/clang-doc/json/concept.cpp
@@ -0,0 +1,37 @@
+// RUN: rm -rf %t && mkdir -p %t
+// RUN: clang-doc --extra-arg -std=c++20 --output=%t --format=json --executor=standalone %s
+
+// Requires that T suports post and pre-incrementing.
+template<typename T>
+concept Incrementable = requires(T x) {
+ ++x;
+ x++;
+};
+
+// CHECK: {
+// CHECK-NOT: "Concepts": [
+// CHECK-NOT: {
+// CHECK-NOT: "ConstraintExpression": "requires (T x) { ++x; x++; }",
+// CHECK-NOT: "Description": [
+// CHECK-NOT: {
+// CHECK-NOT: "FullComment": {
+// CHECK-NOT: "Children": [
+// CHECK-NOT: {
+// CHECK-NOT: "ParagraphComment": {
+// CHECK-NOT: "Children": [
+// CHECK-NOT: {
+// CHECK-NOT: "TextComment": " Requires that T suports post and pre-incrementing."
+// CHECK-NOT: },
+// CHECK-NOT: "IsType": true,
+// CHECK-NOT: "Name": "Incrementable",
+// CHECK-NOT: "Template": {
+// CHECK-NOT: "Parameters": [
+// CHECK-NOT: "typename T"
+// CHECK-NOT: ]
+// CHECK-NOT: },
+// CHECK-NOT: "USR": "{{[0-9A-F]*}}"
+// CHECK-NOT: }
+// CHECK-NOT: ],
+// CHECK: "Name": "",
+// CHECK: "USR": "0000000000000000000000000000000000000000"
+// CHECK: }
diff --git a/clang-tools-extra/test/clang-doc/json/function-requires.cpp b/clang-tools-extra/test/clang-doc/json/function-requires.cpp
new file mode 100644
index 0000000000000..4436ecb879306
--- /dev/null
+++ b/clang-tools-extra/test/clang-doc/json/function-requires.cpp
@@ -0,0 +1,46 @@
+// RUN: rm -rf %t && mkdir -p %t
+// RUN: clang-doc --extra-arg -std=c++20 --output=%t --format=json --executor=standalone %s
+// RUN: FileCheck %s < %t/GlobalNamespace/index.json
+
+template<typename T>
+concept Incrementable = requires(T x) {
+ ++x;
+ x++;
+};
+
+template<typename T> void increment(T t) requires Incrementable<T> {
+ ++t;
+ t++;
+}
+
+// CHECK: "Functions": [
+// CHECK-NEXT: {
+// CHECK-NEXT: "IsStatic": false,
+// CHECK-NEXT: "Location": {
+// CHECK-NEXT: "Filename": "{{.*}}function-requires.cpp",
+// CHECK-NEXT: "LineNumber": 11
+// CHECK-NEXT: },
+// CHECK-NEXT: "Name": "increment",
+// CHECK-NEXT: "Params": [
+// CHECK-NEXT: {
+// CHECK-NEXT: "Name": "t",
+// CHECK-NEXT: "Type": "T"
+// CHECK-NEXT: }
+// CHECK-NEXT: ],
+// CHECK-NEXT: "ReturnType": {
+// CHECK-NEXT: "IsBuiltIn": false,
+// CHECK-NEXT: "IsTemplate": false,
+// CHECK-NEXT: "Name": "void",
+// CHECK-NEXT: "QualName": "void",
+// CHECK-NEXT: "USR": "0000000000000000000000000000000000000000"
+// CHECK-NEXT: },
+// CHECK-NEXT: "Template": {
+// CHECK-NOT: "Constraints": [
+// CHECK-NOT: "Incrementable<T>"
+// CHECK-NOT: ],
+// CHECK-NEXT: "Parameters": [
+// CHECK-NEXT: "typename T"
+// CHECK-NEXT: ]
+// CHECK-NEXT: },
+// CHECK-NEXT: "USR": "{{[0-9A-F]*}}"
+// CHECK-NEXT: }
|
evelez7
commented
Jun 13, 2025
| // CHECK-NEXT: "TagType": "struct", | ||
| // CHECK-NEXT: "Template": { | ||
| // CHECK-NOT: "Constraints": [ | ||
| // CHECK-NOT: "Addable<T>" |
There was a problem hiding this comment.
Interesting thing about Constraints in the context of Clang-Doc is that we don't get back any Decls AFAIK, so I can't construct this as a Reference like BaseRecords. Which is unfortunate in terms of linking. Might be able to find a way to do this but I don't know much about how Expr works.
There was a problem hiding this comment.
Thanks for pointing this out. As discussed offline, let’s ask clang maintainers on discord or discourse about how to handle this. For this patch things are fine though since it’s just documenting the current behavior.
There was a problem hiding this comment.
I changed the tests so that the constraints are now arrays of Infos. Implementation is up the stack.
evelez7
commented
Jun 13, 2025
| @@ -0,0 +1,37 @@ | |||
| // RUN: rm -rf %t && mkdir -p %t | |||
| // RUN: clang-doc --extra-arg -std=c++20 --output=%t --format=json --executor=standalone %s | |||
There was a problem hiding this comment.
FileCheck is omitted here because since nothing is mapped, no file is created.
There was a problem hiding this comment.
Let’s try to mark it fail with filecheck. If that’s doesn’t work, I’m ok with this.
ilovepi
approved these changes
Jun 14, 2025
| @@ -0,0 +1,37 @@ | |||
| // RUN: rm -rf %t && mkdir -p %t | |||
| // RUN: clang-doc --extra-arg -std=c++20 --output=%t --format=json --executor=standalone %s | |||
There was a problem hiding this comment.
Let’s try to mark it fail with filecheck. If that’s doesn’t work, I’m ok with this.
| // CHECK-NEXT: "TagType": "struct", | ||
| // CHECK-NEXT: "Template": { | ||
| // CHECK-NOT: "Constraints": [ | ||
| // CHECK-NOT: "Addable<T>" |
There was a problem hiding this comment.
Thanks for pointing this out. As discussed offline, let’s ask clang maintainers on discord or discourse about how to handle this. For this patch things are fine though since it’s just documenting the current behavior.
evelez7
force-pushed
the
users/evelez7/clang-doc-precommit-concept-tests
branch
from
ad20a26 to
8d8b900
Compare
evelez7
force-pushed
the
users/evelez7/clang-doc-precommit-concept-tests
branch
from
8d8b900 to
b602047
Compare
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
No description provided.