[clang][ExtractAPI] Serialize platform specific unavailable attribute in symbol graphs #89277
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
… in symbol graphs rdar://125622225
|
@llvm/pr-subscribers-clang Author: Daniel Grumberg (daniel-grumberg) Changesrdar://125622225 Full diff: https://github.com/llvm/llvm-project/pull/89277.diff 2 Files Affected:
diff --git a/clang/lib/ExtractAPI/Serialization/SymbolGraphSerializer.cpp b/clang/lib/ExtractAPI/Serialization/SymbolGraphSerializer.cpp
index 57f966c8b2be35..8b1dcb4a4144f4 100644
--- a/clang/lib/ExtractAPI/Serialization/SymbolGraphSerializer.cpp
+++ b/clang/lib/ExtractAPI/Serialization/SymbolGraphSerializer.cpp
@@ -164,27 +164,29 @@ std::optional<Array> serializeAvailability(const AvailabilityInfo &Avail) {
if (Avail.isDefault())
return std::nullopt;
- Object Availability;
Array AvailabilityArray;
- Availability["domain"] = Avail.Domain;
- serializeObject(Availability, "introduced",
- serializeSemanticVersion(Avail.Introduced));
- serializeObject(Availability, "deprecated",
- serializeSemanticVersion(Avail.Deprecated));
- serializeObject(Availability, "obsoleted",
- serializeSemanticVersion(Avail.Obsoleted));
+
if (Avail.isUnconditionallyDeprecated()) {
Object UnconditionallyDeprecated;
UnconditionallyDeprecated["domain"] = "*";
UnconditionallyDeprecated["isUnconditionallyDeprecated"] = true;
AvailabilityArray.emplace_back(std::move(UnconditionallyDeprecated));
}
- if (Avail.isUnconditionallyUnavailable()) {
- Object UnconditionallyUnavailable;
- UnconditionallyUnavailable["domain"] = "*";
- UnconditionallyUnavailable["isUnconditionallyUnavailable"] = true;
- AvailabilityArray.emplace_back(std::move(UnconditionallyUnavailable));
+ Object Availability;
+
+ Availability["domain"] = Avail.Domain;
+
+ if (Avail.isUnavailable()) {
+ Availability["isUnconditionallyUnavailable"] = true;
+ } else {
+ serializeObject(Availability, "introduced",
+ serializeSemanticVersion(Avail.Introduced));
+ serializeObject(Availability, "deprecated",
+ serializeSemanticVersion(Avail.Deprecated));
+ serializeObject(Availability, "obsoleted",
+ serializeSemanticVersion(Avail.Obsoleted));
}
+
AvailabilityArray.emplace_back(std::move(Availability));
return AvailabilityArray;
}
diff --git a/clang/test/ExtractAPI/availability.c b/clang/test/ExtractAPI/availability.c
index 12ac73f0d4295a..237b2ffa55d7dc 100644
--- a/clang/test/ExtractAPI/availability.c
+++ b/clang/test/ExtractAPI/availability.c
@@ -1,446 +1,101 @@
// RUN: rm -rf %t
-// RUN: split-file %s %t
-// RUN: sed -e "s@INPUT_DIR@%{/t:regex_replacement}@g" \
-// RUN: %t/reference.output.json.in >> %t/reference.output.json
-// RUN: %clang_cc1 -extract-api --pretty-sgf --product-name=Availability -triple arm64-apple-macosx -x c-header %t/input.h -o %t/output.json -verify
+// RUN: %clang_cc1 -extract-api --pretty-sgf --emit-sgf-symbol-labels-for-testing -triple arm64-apple-macosx \
+// RUN: -x c-header %s -o %t/output.symbols.json -verify
-// Generator version is not consistent across test runs, normalize it.
-// RUN: sed -e "s@\"generator\": \".*\"@\"generator\": \"?\"@g" \
-// RUN: %t/output.json >> %t/output-normalized.json
-// RUN: diff %t/reference.output.json %t/output-normalized.json
+// RUN: FileCheck %s --input-file %t/output.symbols.json --check-prefix A
+void a(void) __attribute__((availability(macos, introduced=12.0)));
+// A-LABEL: "!testLabel": "c:@F@a"
+// A: "availability": [
+// A-NEXT: {
+// A-NEXT: "domain": "macos",
+// A-NEXT: "introduced": {
+// A-NEXT: "major": 12,
+// A-NEXT: "minor": 0,
+// A-NEXT: "patch": 0
+// A-NEXT: }
+// A-NEXT: }
+// A-NEXT: ]
-// CHECK-NOT: error:
-// CHECK-NOT: warning:
+// RUN: FileCheck %s --input-file %t/output.symbols.json --check-prefix B
+void b(void) __attribute__((availability(macos, introduced=11.0, deprecated=12.0, obsoleted=20.0)));
+// B-LABEL: "!testLabel": "c:@F@b"
+// B: "availability": [
+// B-NEXT: {
+// B-NEXT: "deprecated": {
+// B-NEXT: "major": 12,
+// B-NEXT: "minor": 0,
+// B-NEXT: "patch": 0
+// B-NEXT: },
+// B-NEXT: "domain": "macos",
+// B-NEXT: "introduced": {
+// B-NEXT: "major": 11,
+// B-NEXT: "minor": 0,
+// B-NEXT: "patch": 0
+// B-NEXT: },
+// B-NEXT: "obsoleted": {
+// B-NEXT: "major": 20,
+// B-NEXT: "minor": 0,
+// B-NEXT: "patch": 0
+// B-NEXT: }
+// B-NEXT: }
+// B-NEXT: ]
-//--- input.h
-void a(void);
+// RUN: FileCheck %s --input-file %t/output.symbols.json --check-prefix E
+void c(void) __attribute__((availability(macos, introduced=11.0, deprecated=12.0, obsoleted=20.0))) __attribute__((availability(ios, introduced=13.0)));
+// C-LABEL: "!testLabel": "c:@F@c"
+// C: "availability": [
+// C-NEXT: {
+// C-NEXT: "deprecated": {
+// C-NEXT: "major": 12,
+// C-NEXT: "minor": 0,
+// C-NEXT: "patch": 0
+// C-NEXT: },
+// C-NEXT: "domain": "macos",
+// C-NEXT: "introduced": {
+// C-NEXT: "major": 11,
+// C-NEXT: "minor": 0,
+// C-NEXT: "patch": 0
+// C-NEXT: },
+// C-NEXT: "obsoleted": {
+// C-NEXT: "major": 20,
+// C-NEXT: "minor": 0,
+// C-NEXT: "patch": 0
+// C-NEXT: }
+// C-NEXT: }
+// C-NEXT: ]
-void b(void) __attribute__((availability(macos, introduced=12.0)));
+// RUN: FileCheck %s --input-file %t/output.symbols.json --check-prefix D
+void d(void) __attribute__((deprecated)) __attribute__((availability(macos, introduced=11.0)));
+// D-LABEL: "!testLabel": "c:@F@d"
+// D: "availability": [
+// D-NEXT: {
+// D-NEXT: "domain": "*",
+// D-NEXT: "isUnconditionallyDeprecated": true
+// D-NEXT: },
+// D-NEXT: {
+// D-NEXT: "domain": "macos",
+// D-NEXT: "introduced": {
+// D-NEXT: "major": 11,
+// D-NEXT: "minor": 0,
+// D-NEXT: "patch": 0
+// D-NEXT: }
+// D-NEXT: }
+// D-NEXT: ]
-void c(void) __attribute__((availability(macos, introduced=11.0, deprecated=12.0, obsoleted=20.0)));
+// This symbol should be dropped as it's unconditionally unavailable
+// RUN: FileCheck %s --input-file %t/output.symbols.json --check-prefix E
+void e(void) __attribute__((unavailable)) __attribute__((availability(macos, introduced=11.0)));
+// E-NOT: "!testLabel": "c:@F@e"
-void d(void) __attribute__((availability(macos, introduced=11.0, deprecated=12.0, obsoleted=20.0))) __attribute__((availability(ios, introduced=13.0)));
+// RUN: FileCheck %s --input-file %t/output.symbols.json --check-prefix F
+void f(void) __attribute__((availability(macos, unavailable)));
+// F-LABEL: "!testLabel": "c:@F@f"
+// F: "availability": [
+// F-NEXT: {
+// F-NEXT: "domain": "macos",
+// F-NEXT: "isUnconditionallyUnavailable": true
+// F-NEXT: }
+// F-NEXT: ]
-void e(void) __attribute__((deprecated)) __attribute__((availability(macos, introduced=11.0)));
+// expected-no-diagnostics
-void f(void) __attribute__((unavailable)) __attribute__((availability(macos, introduced=11.0)));
-
-void d(void) __attribute__((availability(tvos, introduced=15.0)));
-
-void e(void) __attribute__((availability(tvos, unavailable)));
-
-///expected-no-diagnostics
-
-//--- reference.output.json.in
-{
- "metadata": {
- "formatVersion": {
- "major": 0,
- "minor": 5,
- "patch": 3
- },
- "generator": "?"
- },
- "module": {
- "name": "Availability",
- "platform": {
- "architecture": "arm64",
- "operatingSystem": {
- "minimumVersion": {
- "major": 11,
- "minor": 0,
- "patch": 0
- },
- "name": "macosx"
- },
- "vendor": "apple"
- }
- },
- "relationships": [],
- "symbols": [
- {
- "accessLevel": "public",
- "declarationFragments": [
- {
- "kind": "typeIdentifier",
- "preciseIdentifier": "c:v",
- "spelling": "void"
- },
- {
- "kind": "text",
- "spelling": " "
- },
- {
- "kind": "identifier",
- "spelling": "a"
- },
- {
- "kind": "text",
- "spelling": "();"
- }
- ],
- "functionSignature": {
- "returns": [
- {
- "kind": "typeIdentifier",
- "preciseIdentifier": "c:v",
- "spelling": "void"
- }
- ]
- },
- "identifier": {
- "interfaceLanguage": "c",
- "precise": "c:@F@a"
- },
- "kind": {
- "displayName": "Function",
- "identifier": "c.func"
- },
- "location": {
- "position": {
- "character": 5,
- "line": 0
- },
- "uri": "file://INPUT_DIR/input.h"
- },
- "names": {
- "navigator": [
- {
- "kind": "identifier",
- "spelling": "a"
- }
- ],
- "subHeading": [
- {
- "kind": "identifier",
- "spelling": "a"
- }
- ],
- "title": "a"
- },
- "pathComponents": [
- "a"
- ]
- },
- {
- "accessLevel": "public",
- "availability": [
- {
- "domain": "macos",
- "introduced": {
- "major": 12,
- "minor": 0,
- "patch": 0
- }
- }
- ],
- "declarationFragments": [
- {
- "kind": "typeIdentifier",
- "preciseIdentifier": "c:v",
- "spelling": "void"
- },
- {
- "kind": "text",
- "spelling": " "
- },
- {
- "kind": "identifier",
- "spelling": "b"
- },
- {
- "kind": "text",
- "spelling": "();"
- }
- ],
- "functionSignature": {
- "returns": [
- {
- "kind": "typeIdentifier",
- "preciseIdentifier": "c:v",
- "spelling": "void"
- }
- ]
- },
- "identifier": {
- "interfaceLanguage": "c",
- "precise": "c:@F@b"
- },
- "kind": {
- "displayName": "Function",
- "identifier": "c.func"
- },
- "location": {
- "position": {
- "character": 5,
- "line": 2
- },
- "uri": "file://INPUT_DIR/input.h"
- },
- "names": {
- "navigator": [
- {
- "kind": "identifier",
- "spelling": "b"
- }
- ],
- "subHeading": [
- {
- "kind": "identifier",
- "spelling": "b"
- }
- ],
- "title": "b"
- },
- "pathComponents": [
- "b"
- ]
- },
- {
- "accessLevel": "public",
- "availability": [
- {
- "deprecated": {
- "major": 12,
- "minor": 0,
- "patch": 0
- },
- "domain": "macos",
- "introduced": {
- "major": 11,
- "minor": 0,
- "patch": 0
- },
- "obsoleted": {
- "major": 20,
- "minor": 0,
- "patch": 0
- }
- }
- ],
- "declarationFragments": [
- {
- "kind": "typeIdentifier",
- "preciseIdentifier": "c:v",
- "spelling": "void"
- },
- {
- "kind": "text",
- "spelling": " "
- },
- {
- "kind": "identifier",
- "spelling": "c"
- },
- {
- "kind": "text",
- "spelling": "();"
- }
- ],
- "functionSignature": {
- "returns": [
- {
- "kind": "typeIdentifier",
- "preciseIdentifier": "c:v",
- "spelling": "void"
- }
- ]
- },
- "identifier": {
- "interfaceLanguage": "c",
- "precise": "c:@F@c"
- },
- "kind": {
- "displayName": "Function",
- "identifier": "c.func"
- },
- "location": {
- "position": {
- "character": 5,
- "line": 4
- },
- "uri": "file://INPUT_DIR/input.h"
- },
- "names": {
- "navigator": [
- {
- "kind": "identifier",
- "spelling": "c"
- }
- ],
- "subHeading": [
- {
- "kind": "identifier",
- "spelling": "c"
- }
- ],
- "title": "c"
- },
- "pathComponents": [
- "c"
- ]
- },
- {
- "accessLevel": "public",
- "availability": [
- {
- "deprecated": {
- "major": 12,
- "minor": 0,
- "patch": 0
- },
- "domain": "macos",
- "introduced": {
- "major": 11,
- "minor": 0,
- "patch": 0
- },
- "obsoleted": {
- "major": 20,
- "minor": 0,
- "patch": 0
- }
- }
- ],
- "declarationFragments": [
- {
- "kind": "typeIdentifier",
- "preciseIdentifier": "c:v",
- "spelling": "void"
- },
- {
- "kind": "text",
- "spelling": " "
- },
- {
- "kind": "identifier",
- "spelling": "d"
- },
- {
- "kind": "text",
- "spelling": "();"
- }
- ],
- "functionSignature": {
- "returns": [
- {
- "kind": "typeIdentifier",
- "preciseIdentifier": "c:v",
- "spelling": "void"
- }
- ]
- },
- "identifier": {
- "interfaceLanguage": "c",
- "precise": "c:@F@d"
- },
- "kind": {
- "displayName": "Function",
- "identifier": "c.func"
- },
- "location": {
- "position": {
- "character": 5,
- "line": 6
- },
- "uri": "file://INPUT_DIR/input.h"
- },
- "names": {
- "navigator": [
- {
- "kind": "identifier",
- "spelling": "d"
- }
- ],
- "subHeading": [
- {
- "kind": "identifier",
- "spelling": "d"
- }
- ],
- "title": "d"
- },
- "pathComponents": [
- "d"
- ]
- },
- {
- "accessLevel": "public",
- "availability": [
- {
- "domain": "*",
- "isUnconditionallyDeprecated": true
- },
- {
- "domain": "macos",
- "introduced": {
- "major": 11,
- "minor": 0,
- "patch": 0
- }
- }
- ],
- "declarationFragments": [
- {
- "kind": "typeIdentifier",
- "preciseIdentifier": "c:v",
- "spelling": "void"
- },
- {
- "kind": "text",
- "spelling": " "
- },
- {
- "kind": "identifier",
- "spelling": "e"
- },
- {
- "kind": "text",
- "spelling": "();"
- }
- ],
- "functionSignature": {
- "returns": [
- {
- "kind": "typeIdentifier",
- "preciseIdentifier": "c:v",
- "spelling": "void"
- }
- ]
- },
- "identifier": {
- "interfaceLanguage": "c",
- "precise": "c:@F@e"
- },
- "kind": {
- "displayName": "Function",
- "identifier": "c.func"
- },
- "location": {
- "position": {
- "character": 5,
- "line": 8
- },
- "uri": "file://INPUT_DIR/input.h"
- },
- "names": {
- "navigator": [
- {
- "kind": "identifier",
- "spelling": "e"
- }
- ],
- "subHeading": [
- {
- "kind": "identifier",
- "spelling": "e"
- }
- ],
- "title": "e"
- },
- "pathComponents": [
- "e"
- ]
- }
- ]
-}
|
QuietMisdreavus
approved these changes
Apr 22, 2024
daniel-grumberg
added a commit
to daniel-grumberg/llvm-project
that referenced
this pull request
Apr 24, 2024
… in symbol graphs (llvm#89277) rdar://125622225
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.
rdar://125622225