This is an archive of the discontinued LLVM Phabricator instance.

Differential D157783

[clang] Add rmissing fields to DeprecatedAttr and UnavailableAttr json AST dump
ClosedPublic

Authored by serge-sans-paille on Aug 12 2023, 8:25 AM.

Details

Reviewers
aaron.ballman
Commits
rG3dadc290b210: [clang] Add missing fields to DeprecatedAttr and Unavailable json AST dump

Diff Detail

Event Timeline

serge-sans-paille created this revision.Aug 12 2023, 8:25 AM
Herald added a project: Restricted Project. · View Herald TranscriptAug 12 2023, 8:25 AM
serge-sans-paille requested review of this revision.Aug 12 2023, 8:25 AM
Herald added a project: Restricted Project. · View Herald TranscriptAug 12 2023, 8:25 AM
Herald added a subscriber: cfe-commits. · View Herald Transcript
Harbormaster completed remote builds in B252112: Diff 549614.Aug 12 2023, 8:25 AM
serge-sans-paille updated this revision to Diff 549644.Aug 12 2023, 12:18 PM
serge-sans-paille retitled this revision from [clang] Add reason and replacement fields to DeprecatedAttr json AST dump to [clang] Add rmissing fields to DeprecatedAttr and UnavailableAttr json AST dump.

+ Unavailable attr

Harbormaster completed remote builds in B252137: Diff 549644.Aug 12 2023, 12:19 PM
serge-sans-paille updated this revision to Diff 549645.Aug 12 2023, 1:29 PM

+ test case

Harbormaster completed remote builds in B252138: Diff 549645.Aug 12 2023, 1:30 PM
aaron.ballman added inline comments.Aug 14 2023, 6:24 AM
clang/lib/AST/JSONNodeDumper.cpp
541–548

I think we should probably skip emitting the field if the field is empty. e.g., [[deprecated("")]] and [[deprecated]] should have the same output that doesn't have a message field; this keeps the JSON dumps somewhat more succinct for those cases. WDYT?

serge-sans-paille updated this revision to Diff 549929.Aug 14 2023, 7:45 AM

Only output extra fields if they are not empty

serge-sans-paille marked an inline comment as done.Aug 14 2023, 7:46 AM

Review taken into account. Thanks for handling this batch of patches o/

Harbormaster completed remote builds in B252348: Diff 549929.Aug 14 2023, 7:46 AM
aaron.ballman accepted this revision.Aug 14 2023, 8:11 AM

LGTM!

This revision is now accepted and ready to land.Aug 14 2023, 8:11 AM
This revision was landed with ongoing or failed builds.Aug 14 2023, 2:01 PM
Closed by commit rG3dadc290b210: [clang] Add missing fields to DeprecatedAttr and Unavailable json AST dump (authored by serge-sans-paille). · Explain Why
This revision was automatically updated to reflect the committed changes.
serge-sans-paille added a commit: rG3dadc290b210: [clang] Add missing fields to DeprecatedAttr and Unavailable json AST dump.

Revision Contents

PathSize
clang/
include/
clang/
AST/
2 lines
lib/
AST/
12 lines
test/
AST/
241 lines

Diff 550077

clang/include/clang/AST/JSONNodeDumper.h

Show First 20 Lines • Show All 204 Lines • ▼ Show 20 Linespublic:
void Visit(const OMPClause *C); void Visit(const OMPClause *C);
void Visit(const BlockDecl::Capture &C); void Visit(const BlockDecl::Capture &C);
void Visit(const GenericSelectionExpr::ConstAssociation &A); void Visit(const GenericSelectionExpr::ConstAssociation &A);
void Visit(const concepts::Requirement *R); void Visit(const concepts::Requirement *R);
void Visit(const APValue &Value, QualType Ty); void Visit(const APValue &Value, QualType Ty);
void VisitAliasAttr(const AliasAttr *AA); void VisitAliasAttr(const AliasAttr *AA);
void VisitCleanupAttr(const CleanupAttr *CA); void VisitCleanupAttr(const CleanupAttr *CA);
void VisitDeprecatedAttr(const DeprecatedAttr *DA);
void VisitUnavailableAttr(const UnavailableAttr *UA);
void VisitTypedefType(const TypedefType *TT); void VisitTypedefType(const TypedefType *TT);
void VisitUsingType(const UsingType *TT); void VisitUsingType(const UsingType *TT);
void VisitFunctionType(const FunctionType *T); void VisitFunctionType(const FunctionType *T);
void VisitFunctionProtoType(const FunctionProtoType *T); void VisitFunctionProtoType(const FunctionProtoType *T);
void VisitRValueReferenceType(const ReferenceType *RT); void VisitRValueReferenceType(const ReferenceType *RT);
void VisitArrayType(const ArrayType *AT); void VisitArrayType(const ArrayType *AT);
void VisitConstantArrayType(const ConstantArrayType *CAT); void VisitConstantArrayType(const ConstantArrayType *CAT);
▲ Show 20 Lines • Show All 228 Lines • Show Last 20 Lines

clang/lib/AST/JSONNodeDumper.cpp

Show First 20 Lines • Show All 532 Lines • ▼ Show 20 Lines
void JSONNodeDumper::VisitAliasAttr(const AliasAttr *AA) { void JSONNodeDumper::VisitAliasAttr(const AliasAttr *AA) {
JOS.attribute("aliasee", AA->getAliasee()); JOS.attribute("aliasee", AA->getAliasee());
} }
void JSONNodeDumper::VisitCleanupAttr(const CleanupAttr *CA) { void JSONNodeDumper::VisitCleanupAttr(const CleanupAttr *CA) {
JOS.attribute("cleanup_function", createBareDeclRef(CA->getFunctionDecl())); JOS.attribute("cleanup_function", createBareDeclRef(CA->getFunctionDecl()));
} }
void JSONNodeDumper::VisitDeprecatedAttr(const DeprecatedAttr *DA) {
if (!DA->getMessage().empty())
JOS.attribute("message", DA->getMessage());
if (!DA->getReplacement().empty())
JOS.attribute("replacement", DA->getReplacement());
}
void JSONNodeDumper::VisitUnavailableAttr(const UnavailableAttr *UA) {
aaron.ballmanUnsubmitted
Done
ReplyInline Actions

I think we should probably skip emitting the field if the field is empty. e.g., [[deprecated("")]] and [[deprecated]] should have the same output that doesn't have a message field; this keeps the JSON dumps somewhat more succinct for those cases. WDYT?

aaron.ballman: I think we should probably skip emitting the field if the field is empty. e.g., `[[deprecated…
if (!UA->getMessage().empty())
JOS.attribute("message", UA->getMessage());
}
void JSONNodeDumper::VisitTypedefType(const TypedefType *TT) { void JSONNodeDumper::VisitTypedefType(const TypedefType *TT) {
JOS.attribute("decl", createBareDeclRef(TT->getDecl())); JOS.attribute("decl", createBareDeclRef(TT->getDecl()));
if (!TT->typeMatchesDecl()) if (!TT->typeMatchesDecl())
JOS.attribute("type", createQualType(TT->desugar())); JOS.attribute("type", createQualType(TT->desugar()));
} }
void JSONNodeDumper::VisitUsingType(const UsingType *TT) { void JSONNodeDumper::VisitUsingType(const UsingType *TT) {
JOS.attribute("decl", createBareDeclRef(TT->getFoundDecl())); JOS.attribute("decl", createBareDeclRef(TT->getFoundDecl()));
▲ Show 20 Lines • Show All 1,214 Lines • Show Last 20 Lines

clang/test/AST/ast-dump-attr-json.cpp

// RUN: %clang_cc1 -Wdocumentation -ast-dump=json %s | FileCheck %s // RUN: %clang_cc1 -Wdocumentation -ast-dump=json %s | FileCheck %s
int global_decl; int global_decl;
extern __attribute__((alias("global_decl"))) int global_alias; extern __attribute__((alias("global_decl"))) int global_alias;
void cleanup_function(int*); void cleanup_function(int*);
void some() { void some() {
__attribute__((cleanup(cleanup_function))) int var; __attribute__((cleanup(cleanup_function))) int var;
} }
__attribute__((deprecated)) int deprecated_var0;
__attribute__((deprecated("reason"))) int deprecated_var1;
__attribute__((deprecated("reason", "replacement"))) int deprecated_var2;
__attribute__((unavailable)) int unavailable_var0;
__attribute__((unavailable("reason"))) int unavailable_var1;
// NOTE: CHECK lines have been autogenerated by gen_ast_dump_json_test.py // NOTE: CHECK lines have been autogenerated by gen_ast_dump_json_test.py
// using --filters=VarDecl // using --filters=VarDecl
// CHECK-NOT: {{^}}Dumping // CHECK-NOT: {{^}}Dumping
// CHECK: "kind": "VarDecl", // CHECK: "kind": "VarDecl",
// CHECK-NEXT: "loc": { // CHECK-NEXT: "loc": {
// CHECK-NEXT: "offset": 73, // CHECK-NEXT: "offset": 73,
▲ Show 20 Lines • Show All 115 Lines • ▼ Show 20 Lines
// CHECK-NEXT: "name": "cleanup_function", // CHECK-NEXT: "name": "cleanup_function",
// CHECK-NEXT: "type": { // CHECK-NEXT: "type": {
// CHECK-NEXT: "qualType": "void (int *)" // CHECK-NEXT: "qualType": "void (int *)"
// CHECK-NEXT: } // CHECK-NEXT: }
// CHECK-NEXT: } // CHECK-NEXT: }
// CHECK-NEXT: } // CHECK-NEXT: }
// CHECK-NEXT: ] // CHECK-NEXT: ]
// CHECK-NEXT: } // CHECK-NEXT: }
// CHECK-NOT: {{^}}Dumping
// CHECK: "kind": "VarDecl",
// CHECK-NEXT: "loc": {
// CHECK-NEXT: "offset": 282,
// CHECK-NEXT: "line": 11,
// CHECK-NEXT: "col": 33,
// CHECK-NEXT: "tokLen": 15
// CHECK-NEXT: },
// CHECK-NEXT: "range": {
// CHECK-NEXT: "begin": {
// CHECK-NEXT: "offset": 250,
// CHECK-NEXT: "col": 1,
// CHECK-NEXT: "tokLen": 13
// CHECK-NEXT: },
// CHECK-NEXT: "end": {
// CHECK-NEXT: "offset": 282,
// CHECK-NEXT: "col": 33,
// CHECK-NEXT: "tokLen": 15
// CHECK-NEXT: }
// CHECK-NEXT: },
// CHECK-NEXT: "name": "deprecated_var0",
// CHECK-NEXT: "mangledName": "deprecated_var0",
// CHECK-NEXT: "type": {
// CHECK-NEXT: "qualType": "int"
// CHECK-NEXT: },
// CHECK-NEXT: "inner": [
// CHECK-NEXT: {
// CHECK-NEXT: "id": "0x{{.*}}",
// CHECK-NEXT: "kind": "DeprecatedAttr",
// CHECK-NEXT: "range": {
// CHECK-NEXT: "begin": {
// CHECK-NEXT: "offset": 265,
// CHECK-NEXT: "col": 16,
// CHECK-NEXT: "tokLen": 10
// CHECK-NEXT: },
// CHECK-NEXT: "end": {
// CHECK-NEXT: "offset": 265,
// CHECK-NEXT: "col": 16,
// CHECK-NEXT: "tokLen": 10
// CHECK-NEXT: }
// CHECK-NEXT: }
// CHECK-NEXT: }
// CHECK-NEXT: ]
// CHECK-NEXT: }
// CHECK-NOT: {{^}}Dumping
// CHECK: "kind": "VarDecl",
// CHECK-NEXT: "loc": {
// CHECK-NEXT: "offset": 341,
// CHECK-NEXT: "line": 12,
// CHECK-NEXT: "col": 43,
// CHECK-NEXT: "tokLen": 15
// CHECK-NEXT: },
// CHECK-NEXT: "range": {
// CHECK-NEXT: "begin": {
// CHECK-NEXT: "offset": 299,
// CHECK-NEXT: "col": 1,
// CHECK-NEXT: "tokLen": 13
// CHECK-NEXT: },
// CHECK-NEXT: "end": {
// CHECK-NEXT: "offset": 341,
// CHECK-NEXT: "col": 43,
// CHECK-NEXT: "tokLen": 15
// CHECK-NEXT: }
// CHECK-NEXT: },
// CHECK-NEXT: "name": "deprecated_var1",
// CHECK-NEXT: "mangledName": "deprecated_var1",
// CHECK-NEXT: "type": {
// CHECK-NEXT: "qualType": "int"
// CHECK-NEXT: },
// CHECK-NEXT: "inner": [
// CHECK-NEXT: {
// CHECK-NEXT: "id": "0x{{.*}}",
// CHECK-NEXT: "kind": "DeprecatedAttr",
// CHECK-NEXT: "range": {
// CHECK-NEXT: "begin": {
// CHECK-NEXT: "offset": 314,
// CHECK-NEXT: "col": 16,
// CHECK-NEXT: "tokLen": 10
// CHECK-NEXT: },
// CHECK-NEXT: "end": {
// CHECK-NEXT: "offset": 333,
// CHECK-NEXT: "col": 35,
// CHECK-NEXT: "tokLen": 1
// CHECK-NEXT: }
// CHECK-NEXT: },
// CHECK-NEXT: "message": "reason"
// CHECK-NEXT: }
// CHECK-NEXT: ]
// CHECK-NEXT: }
// CHECK-NOT: {{^}}Dumping
// CHECK: "kind": "VarDecl",
// CHECK-NEXT: "loc": {
// CHECK-NEXT: "offset": 415,
// CHECK-NEXT: "line": 13,
// CHECK-NEXT: "col": 58,
// CHECK-NEXT: "tokLen": 15
// CHECK-NEXT: },
// CHECK-NEXT: "range": {
// CHECK-NEXT: "begin": {
// CHECK-NEXT: "offset": 358,
// CHECK-NEXT: "col": 1,
// CHECK-NEXT: "tokLen": 13
// CHECK-NEXT: },
// CHECK-NEXT: "end": {
// CHECK-NEXT: "offset": 415,
// CHECK-NEXT: "col": 58,
// CHECK-NEXT: "tokLen": 15
// CHECK-NEXT: }
// CHECK-NEXT: },
// CHECK-NEXT: "name": "deprecated_var2",
// CHECK-NEXT: "mangledName": "deprecated_var2",
// CHECK-NEXT: "type": {
// CHECK-NEXT: "qualType": "int"
// CHECK-NEXT: },
// CHECK-NEXT: "inner": [
// CHECK-NEXT: {
// CHECK-NEXT: "id": "0x{{.*}}",
// CHECK-NEXT: "kind": "DeprecatedAttr",
// CHECK-NEXT: "range": {
// CHECK-NEXT: "begin": {
// CHECK-NEXT: "offset": 373,
// CHECK-NEXT: "col": 16,
// CHECK-NEXT: "tokLen": 10
// CHECK-NEXT: },
// CHECK-NEXT: "end": {
// CHECK-NEXT: "offset": 407,
// CHECK-NEXT: "col": 50,
// CHECK-NEXT: "tokLen": 1
// CHECK-NEXT: }
// CHECK-NEXT: },
// CHECK-NEXT: "message": "reason",
// CHECK-NEXT: "replacement": "replacement"
// CHECK-NEXT: }
// CHECK-NEXT: ]
// CHECK-NEXT: }
// CHECK-NOT: {{^}}Dumping
// CHECK: "kind": "VarDecl",
// CHECK-NEXT: "loc": {
// CHECK-NEXT: "offset": 466,
// CHECK-NEXT: "line": 15,
// CHECK-NEXT: "col": 34,
// CHECK-NEXT: "tokLen": 16
// CHECK-NEXT: },
// CHECK-NEXT: "range": {
// CHECK-NEXT: "begin": {
// CHECK-NEXT: "offset": 433,
// CHECK-NEXT: "col": 1,
// CHECK-NEXT: "tokLen": 13
// CHECK-NEXT: },
// CHECK-NEXT: "end": {
// CHECK-NEXT: "offset": 466,
// CHECK-NEXT: "col": 34,
// CHECK-NEXT: "tokLen": 16
// CHECK-NEXT: }
// CHECK-NEXT: },
// CHECK-NEXT: "name": "unavailable_var0",
// CHECK-NEXT: "mangledName": "unavailable_var0",
// CHECK-NEXT: "type": {
// CHECK-NEXT: "qualType": "int"
// CHECK-NEXT: },
// CHECK-NEXT: "inner": [
// CHECK-NEXT: {
// CHECK-NEXT: "id": "0x{{.*}}",
// CHECK-NEXT: "kind": "UnavailableAttr",
// CHECK-NEXT: "range": {
// CHECK-NEXT: "begin": {
// CHECK-NEXT: "offset": 448,
// CHECK-NEXT: "col": 16,
// CHECK-NEXT: "tokLen": 11
// CHECK-NEXT: },
// CHECK-NEXT: "end": {
// CHECK-NEXT: "offset": 448,
// CHECK-NEXT: "col": 16,
// CHECK-NEXT: "tokLen": 11
// CHECK-NEXT: }
// CHECK-NEXT: }
// CHECK-NEXT: }
// CHECK-NEXT: ]
// CHECK-NEXT: }
// CHECK-NOT: {{^}}Dumping
// CHECK: "kind": "VarDecl",
// CHECK-NEXT: "loc": {
// CHECK-NEXT: "offset": 527,
// CHECK-NEXT: "line": 16,
// CHECK-NEXT: "col": 44,
// CHECK-NEXT: "tokLen": 16
// CHECK-NEXT: },
// CHECK-NEXT: "range": {
// CHECK-NEXT: "begin": {
// CHECK-NEXT: "offset": 484,
// CHECK-NEXT: "col": 1,
// CHECK-NEXT: "tokLen": 13
// CHECK-NEXT: },
// CHECK-NEXT: "end": {
// CHECK-NEXT: "offset": 527,
// CHECK-NEXT: "col": 44,
// CHECK-NEXT: "tokLen": 16
// CHECK-NEXT: }
// CHECK-NEXT: },
// CHECK-NEXT: "name": "unavailable_var1",
// CHECK-NEXT: "mangledName": "unavailable_var1",
// CHECK-NEXT: "type": {
// CHECK-NEXT: "qualType": "int"
// CHECK-NEXT: },
// CHECK-NEXT: "inner": [
// CHECK-NEXT: {
// CHECK-NEXT: "id": "0x{{.*}}",
// CHECK-NEXT: "kind": "UnavailableAttr",
// CHECK-NEXT: "range": {
// CHECK-NEXT: "begin": {
// CHECK-NEXT: "offset": 499,
// CHECK-NEXT: "col": 16,
// CHECK-NEXT: "tokLen": 11
// CHECK-NEXT: },
// CHECK-NEXT: "end": {
// CHECK-NEXT: "offset": 519,
// CHECK-NEXT: "col": 36,
// CHECK-NEXT: "tokLen": 1
// CHECK-NEXT: }
// CHECK-NEXT: },
// CHECK-NEXT: "message": "reason"
// CHECK-NEXT: }
// CHECK-NEXT: ]
// CHECK-NEXT: }