This is an archive of the discontinued LLVM Phabricator instance.

Differential D136455

[clang][ExtractAPI] Add targetFallback to relationships in symbol graph
ClosedPublic

Authored by dang on Oct 21 2022, 7:38 AM.

Details

Reviewers
zixuw
QuietMisdreavus
ributzka
Commits
rG671709f0e7d4: [clang][ExtractAPI] Add targetFallback to relationships in symbol graph
Summary

Adds a 'targetFallback' field to relationships in symbol graph that
contains the plain name of the relationship target. This is useful for
clients when the relationship target symbol is not available.

Diff Detail

Event Timeline

dang created this revision.Oct 21 2022, 7:38 AM
Herald added a project: Restricted Project. · View Herald TranscriptOct 21 2022, 7:38 AM
Herald added a subscriber: yaxunl. · View Herald Transcript
dang requested review of this revision.Oct 21 2022, 7:38 AM
Herald added a project: Restricted Project. · View Herald TranscriptOct 21 2022, 7:38 AM
Herald added a subscriber: cfe-commits. · View Herald Transcript
Harbormaster completed remote builds in B193522: Diff 469609.Oct 21 2022, 8:34 AM
zixuw added a comment.Oct 24 2022, 9:56 AM

Is it easy to/worth checking if the target is actually outside of the current module to keep the output smaller and concise?

dang added a comment.Oct 24 2022, 10:47 AM
In D136455#3879849, @zixuw wrote:

Is it easy to/worth checking if the target is actually outside of the current module to keep the output smaller and concise?

I think it can be done, since we ignore symbols that don't come from the headers provided on the command line, we could just check if the target symbol is something that is known to the APISet.

dang added a comment.Oct 25 2022, 2:33 AM

However, I am not sure it's worthwhile and we might run into edge cases doing it this way with explicitly ignored symbols.

zixuw accepted this revision.Oct 25 2022, 10:14 AM
This revision is now accepted and ready to land.Oct 25 2022, 10:14 AM
Closed by commit rG671709f0e7d4: [clang][ExtractAPI] Add targetFallback to relationships in symbol graph (authored by dang). · Explain WhyNov 7 2022, 5:12 AM
This revision was automatically updated to reflect the committed changes.
dang added a commit: rG671709f0e7d4: [clang][ExtractAPI] Add targetFallback to relationships in symbol graph.

Revision Contents

PathSize
clang/
lib/
ExtractAPI/
Serialization/
1 line
test/
ExtractAPI/
12 lines
33 lines
12 lines
21 lines
21 lines
3 lines
12 lines
3 lines

Diff 469609

clang/lib/ExtractAPI/Serialization/SymbolGraphSerializer.cpp

Show First 20 Lines • Show All 548 Lines • ▼ Show 20 Lines
} }
void SymbolGraphSerializer::serializeRelationship(RelationshipKind Kind, void SymbolGraphSerializer::serializeRelationship(RelationshipKind Kind,
SymbolReference Source, SymbolReference Source,
SymbolReference Target) { SymbolReference Target) {
Object Relationship; Object Relationship;
Relationship["source"] = Source.USR; Relationship["source"] = Source.USR;
Relationship["target"] = Target.USR; Relationship["target"] = Target.USR;
Relationship["targetFallback"] = Target.Name;
Relationship["kind"] = getRelationshipString(Kind); Relationship["kind"] = getRelationshipString(Kind);
Relationships.emplace_back(std::move(Relationship)); Relationships.emplace_back(std::move(Relationship));
} }
void SymbolGraphSerializer::serializeGlobalFunctionRecord( void SymbolGraphSerializer::serializeGlobalFunctionRecord(
const GlobalFunctionRecord &Record) { const GlobalFunctionRecord &Record) {
auto GlobalPathComponentGuard = makePathComponentGuard(Record.Name); auto GlobalPathComponentGuard = makePathComponentGuard(Record.Name);
▲ Show 20 Lines • Show All 161 Lines • Show Last 20 Lines

clang/test/ExtractAPI/anonymous_record_no_typedef.c

Show First 20 Lines • Show All 50 Lines • ▼ Show 20 Lines "platform": {
}, },
"vendor": "apple" "vendor": "apple"
} }
}, },
"relationships": [ "relationships": [
{ {
"kind": "memberOf", "kind": "memberOf",
"source": "c:@S@Vehicle@E@input.h@64@Bicycle", "source": "c:@S@Vehicle@E@input.h@64@Bicycle",
"target": "c:@S@Vehicle@E@input.h@64" "target": "c:@S@Vehicle@E@input.h@64",
"targetFallback": "Vehicle::enum (unnamed)"
}, },
{ {
"kind": "memberOf", "kind": "memberOf",
"source": "c:@S@Vehicle@E@input.h@64@Car", "source": "c:@S@Vehicle@E@input.h@64@Car",
"target": "c:@S@Vehicle@E@input.h@64" "target": "c:@S@Vehicle@E@input.h@64",
"targetFallback": "Vehicle::enum (unnamed)"
}, },
{ {
"kind": "memberOf", "kind": "memberOf",
"source": "c:@S@Vehicle@FI@type", "source": "c:@S@Vehicle@FI@type",
"target": "c:@S@Vehicle" "target": "c:@S@Vehicle",
"targetFallback": "Vehicle"
}, },
{ {
"kind": "memberOf", "kind": "memberOf",
"source": "c:@S@Vehicle@FI@information", "source": "c:@S@Vehicle@FI@information",
"target": "c:@S@Vehicle" "target": "c:@S@Vehicle",
"targetFallback": "Vehicle"
} }
], ],
"symbols": [ "symbols": [
{ {
"accessLevel": "public", "accessLevel": "public",
"declarationFragments": [ "declarationFragments": [
{ {
"kind": "keyword", "kind": "keyword",
▲ Show 20 Lines • Show All 314 Lines • Show Last 20 Lines

clang/test/ExtractAPI/enum.c

Show First 20 Lines • Show All 59 Lines • ▼ Show 20 Lines "platform": {
}, },
"vendor": "apple" "vendor": "apple"
} }
}, },
"relationships": [ "relationships": [
{ {
"kind": "memberOf", "kind": "memberOf",
"source": "c:@E@Vehicle@Bicycle", "source": "c:@E@Vehicle@Bicycle",
"target": "c:@E@Vehicle" "target": "c:@E@Vehicle",
"targetFallback": "Vehicle"
}, },
{ {
"kind": "memberOf", "kind": "memberOf",
"source": "c:@E@Vehicle@Car", "source": "c:@E@Vehicle@Car",
"target": "c:@E@Vehicle" "target": "c:@E@Vehicle",
"targetFallback": "Vehicle"
}, },
{ {
"kind": "memberOf", "kind": "memberOf",
"source": "c:@E@Vehicle@Train", "source": "c:@E@Vehicle@Train",
"target": "c:@E@Vehicle" "target": "c:@E@Vehicle",
"targetFallback": "Vehicle"
}, },
{ {
"kind": "memberOf", "kind": "memberOf",
"source": "c:@E@Vehicle@Ship", "source": "c:@E@Vehicle@Ship",
"target": "c:@E@Vehicle" "target": "c:@E@Vehicle",
"targetFallback": "Vehicle"
}, },
{ {
"kind": "memberOf", "kind": "memberOf",
"source": "c:@E@Vehicle@Airplane", "source": "c:@E@Vehicle@Airplane",
"target": "c:@E@Vehicle" "target": "c:@E@Vehicle",
"targetFallback": "Vehicle"
}, },
{ {
"kind": "memberOf", "kind": "memberOf",
"source": "c:@E@Direction@North", "source": "c:@E@Direction@North",
"target": "c:@E@Direction" "target": "c:@E@Direction",
"targetFallback": "Direction"
}, },
{ {
"kind": "memberOf", "kind": "memberOf",
"source": "c:@E@Direction@East", "source": "c:@E@Direction@East",
"target": "c:@E@Direction" "target": "c:@E@Direction",
"targetFallback": "Direction"
}, },
{ {
"kind": "memberOf", "kind": "memberOf",
"source": "c:@E@Direction@South", "source": "c:@E@Direction@South",
"target": "c:@E@Direction" "target": "c:@E@Direction",
"targetFallback": "Direction"
}, },
{ {
"kind": "memberOf", "kind": "memberOf",
"source": "c:@E@Direction@West", "source": "c:@E@Direction@West",
"target": "c:@E@Direction" "target": "c:@E@Direction",
"targetFallback": "Direction"
}, },
{ {
"kind": "memberOf", "kind": "memberOf",
"source": "c:@Ea@Constant@Constant", "source": "c:@Ea@Constant@Constant",
"target": "c:@Ea@Constant" "target": "c:@Ea@Constant",
"targetFallback": "enum (unnamed)"
}, },
{ {
"kind": "memberOf", "kind": "memberOf",
"source": "c:@Ea@OtherConstant@OtherConstant", "source": "c:@Ea@OtherConstant@OtherConstant",
"target": "c:@Ea@OtherConstant" "target": "c:@Ea@OtherConstant",
"targetFallback": "enum (unnamed)"
} }
], ],
"symbols": [ "symbols": [
{ {
"accessLevel": "public", "accessLevel": "public",
"declarationFragments": [ "declarationFragments": [
{ {
"kind": "keyword", "kind": "keyword",
▲ Show 20 Lines • Show All 712 Lines • Show Last 20 Lines

clang/test/ExtractAPI/objc_category.m

Show First 20 Lines • Show All 48 Lines • ▼ Show 20 Lines "platform": {
}, },
"vendor": "apple" "vendor": "apple"
} }
}, },
"relationships": [ "relationships": [
{ {
"kind": "memberOf", "kind": "memberOf",
"source": "c:objc(cs)Interface(im)InstanceMethod", "source": "c:objc(cs)Interface(im)InstanceMethod",
"target": "c:objc(cs)Interface" "target": "c:objc(cs)Interface",
"targetFallback": "Interface"
}, },
{ {
"kind": "memberOf", "kind": "memberOf",
"source": "c:objc(cs)Interface(cm)ClassMethod", "source": "c:objc(cs)Interface(cm)ClassMethod",
"target": "c:objc(cs)Interface" "target": "c:objc(cs)Interface",
"targetFallback": "Interface"
}, },
{ {
"kind": "memberOf", "kind": "memberOf",
"source": "c:objc(cs)Interface(py)Property", "source": "c:objc(cs)Interface(py)Property",
"target": "c:objc(cs)Interface" "target": "c:objc(cs)Interface",
"targetFallback": "Interface"
}, },
{ {
"kind": "conformsTo", "kind": "conformsTo",
"source": "c:objc(cs)Interface", "source": "c:objc(cs)Interface",
"target": "c:objc(pl)Protocol" "target": "c:objc(pl)Protocol",
"targetFallback": "Protocol"
} }
], ],
"symbols": [ "symbols": [
{ {
"accessLevel": "public", "accessLevel": "public",
"declarationFragments": [ "declarationFragments": [
{ {
"kind": "keyword", "kind": "keyword",
▲ Show 20 Lines • Show All 285 Lines • Show Last 20 Lines

clang/test/ExtractAPI/objc_interface.m

Show First 20 Lines • Show All 51 Lines • ▼ Show 20 Lines "platform": {
}, },
"vendor": "apple" "vendor": "apple"
} }
}, },
"relationships": [ "relationships": [
{ {
"kind": "memberOf", "kind": "memberOf",
"source": "c:objc(cs)Super(cm)getWithProperty:", "source": "c:objc(cs)Super(cm)getWithProperty:",
"target": "c:objc(cs)Super" "target": "c:objc(cs)Super",
"targetFallback": "Super"
}, },
{ {
"kind": "memberOf", "kind": "memberOf",
"source": "c:objc(cs)Super(im)setProperty:andOtherThing:", "source": "c:objc(cs)Super(im)setProperty:andOtherThing:",
"target": "c:objc(cs)Super" "target": "c:objc(cs)Super",
"targetFallback": "Super"
}, },
{ {
"kind": "memberOf", "kind": "memberOf",
"source": "c:objc(cs)Super(py)Property", "source": "c:objc(cs)Super(py)Property",
"target": "c:objc(cs)Super" "target": "c:objc(cs)Super",
"targetFallback": "Super"
}, },
{ {
"kind": "conformsTo", "kind": "conformsTo",
"source": "c:objc(cs)Super", "source": "c:objc(cs)Super",
"target": "c:objc(pl)Protocol" "target": "c:objc(pl)Protocol",
"targetFallback": "Protocol"
}, },
{ {
"kind": "memberOf", "kind": "memberOf",
"source": "c:objc(cs)Derived@Ivar", "source": "c:objc(cs)Derived@Ivar",
"target": "c:objc(cs)Derived" "target": "c:objc(cs)Derived",
"targetFallback": "Derived"
}, },
{ {
"kind": "memberOf", "kind": "memberOf",
"source": "c:objc(cs)Derived(im)getIvar", "source": "c:objc(cs)Derived(im)getIvar",
"target": "c:objc(cs)Derived" "target": "c:objc(cs)Derived",
"targetFallback": "Derived"
}, },
{ {
"kind": "inheritsFrom", "kind": "inheritsFrom",
"source": "c:objc(cs)Derived", "source": "c:objc(cs)Derived",
"target": "c:objc(cs)Super" "target": "c:objc(cs)Super",
"targetFallback": "Super"
} }
], ],
"symbols": [ "symbols": [
{ {
"accessLevel": "public", "accessLevel": "public",
"declarationFragments": [ "declarationFragments": [
{ {
"kind": "keyword", "kind": "keyword",
▲ Show 20 Lines • Show All 596 Lines • Show Last 20 Lines

clang/test/ExtractAPI/objc_property.m

Show First 20 Lines • Show All 49 Lines • ▼ Show 20 Lines "platform": {
}, },
"vendor": "apple" "vendor": "apple"
} }
}, },
"relationships": [ "relationships": [
{ {
"kind": "memberOf", "kind": "memberOf",
"source": "c:objc(cs)Interface(cpy)myInterfaceTypeProp", "source": "c:objc(cs)Interface(cpy)myInterfaceTypeProp",
"target": "c:objc(cs)Interface" "target": "c:objc(cs)Interface",
"targetFallback": "Interface"
}, },
{ {
"kind": "memberOf", "kind": "memberOf",
"source": "c:objc(cs)Interface(py)myInterfaceInstanceProp", "source": "c:objc(cs)Interface(py)myInterfaceInstanceProp",
"target": "c:objc(cs)Interface" "target": "c:objc(cs)Interface",
"targetFallback": "Interface"
}, },
{ {
"kind": "memberOf", "kind": "memberOf",
"source": "c:objc(cs)Interface(cpy)myCategoryTypeProp", "source": "c:objc(cs)Interface(cpy)myCategoryTypeProp",
"target": "c:objc(cs)Interface" "target": "c:objc(cs)Interface",
"targetFallback": "Interface"
}, },
{ {
"kind": "memberOf", "kind": "memberOf",
"source": "c:objc(cs)Interface(py)myCategoryInstanceProp", "source": "c:objc(cs)Interface(py)myCategoryInstanceProp",
"target": "c:objc(cs)Interface" "target": "c:objc(cs)Interface",
"targetFallback": "Interface"
}, },
{ {
"kind": "conformsTo", "kind": "conformsTo",
"source": "c:objc(cs)Interface", "source": "c:objc(cs)Interface",
"target": "c:objc(pl)Protocol" "target": "c:objc(pl)Protocol",
"targetFallback": "Protocol"
}, },
{ {
"kind": "memberOf", "kind": "memberOf",
"source": "c:objc(pl)Protocol(cpy)myProtocolTypeProp", "source": "c:objc(pl)Protocol(cpy)myProtocolTypeProp",
"target": "c:objc(pl)Protocol" "target": "c:objc(pl)Protocol",
"targetFallback": "Protocol"
}, },
{ {
"kind": "memberOf", "kind": "memberOf",
"source": "c:objc(pl)Protocol(py)myProtocolInstanceProp", "source": "c:objc(pl)Protocol(py)myProtocolInstanceProp",
"target": "c:objc(pl)Protocol" "target": "c:objc(pl)Protocol",
"targetFallback": "Protocol"
} }
], ],
"symbols": [ "symbols": [
{ {
"accessLevel": "public", "accessLevel": "public",
"declarationFragments": [ "declarationFragments": [
{ {
"kind": "keyword", "kind": "keyword",
▲ Show 20 Lines • Show All 673 Lines • Show Last 20 Lines

clang/test/ExtractAPI/objc_protocol.m

Show First 20 Lines • Show All 43 Lines • ▼ Show 20 Lines "platform": {
}, },
"vendor": "apple" "vendor": "apple"
} }
}, },
"relationships": [ "relationships": [
{ {
"kind": "conformsTo", "kind": "conformsTo",
"source": "c:objc(pl)AnotherProtocol", "source": "c:objc(pl)AnotherProtocol",
"target": "c:objc(pl)Protocol" "target": "c:objc(pl)Protocol",
"targetFallback": "Protocol"
} }
], ],
"symbols": [ "symbols": [
{ {
"accessLevel": "public", "accessLevel": "public",
"declarationFragments": [ "declarationFragments": [
{ {
"kind": "keyword", "kind": "keyword",
▲ Show 20 Lines • Show All 110 Lines • Show Last 20 Lines

clang/test/ExtractAPI/struct.c

Show First 20 Lines • Show All 46 Lines • ▼ Show 20 Lines "platform": {
}, },
"vendor": "apple" "vendor": "apple"
} }
}, },
"relationships": [ "relationships": [
{ {
"kind": "memberOf", "kind": "memberOf",
"source": "c:@S@Color@FI@Red", "source": "c:@S@Color@FI@Red",
"target": "c:@S@Color" "target": "c:@S@Color",
"targetFallback": "Color"
}, },
{ {
"kind": "memberOf", "kind": "memberOf",
"source": "c:@S@Color@FI@Green", "source": "c:@S@Color@FI@Green",
"target": "c:@S@Color" "target": "c:@S@Color",
"targetFallback": "Color"
}, },
{ {
"kind": "memberOf", "kind": "memberOf",
"source": "c:@S@Color@FI@Blue", "source": "c:@S@Color@FI@Blue",
"target": "c:@S@Color" "target": "c:@S@Color",
"targetFallback": "Color"
}, },
{ {
"kind": "memberOf", "kind": "memberOf",
"source": "c:@S@Color@FI@Alpha", "source": "c:@S@Color@FI@Alpha",
"target": "c:@S@Color" "target": "c:@S@Color",
"targetFallback": "Color"
} }
], ],
"symbols": [ "symbols": [
{ {
"accessLevel": "public", "accessLevel": "public",
"declarationFragments": [ "declarationFragments": [
{ {
"kind": "keyword", "kind": "keyword",
▲ Show 20 Lines • Show All 289 Lines • Show Last 20 Lines

clang/test/ExtractAPI/underscored.c

Show First 20 Lines • Show All 59 Lines • ▼ Show 20 Lines "platform": {
}, },
"vendor": "apple" "vendor": "apple"
} }
}, },
"relationships": [ "relationships": [
{ {
"kind": "memberOf", "kind": "memberOf",
"source": "c:@S@ExposedRecord@FI@a", "source": "c:@S@ExposedRecord@FI@a",
"target": "c:@S@ExposedRecord" "target": "c:@S@ExposedRecord",
"targetFallback": "ExposedRecord"
} }
], ],
"symbols": [ "symbols": [
{ {
"accessLevel": "public", "accessLevel": "public",
"declarationFragments": [ "declarationFragments": [
{ {
"kind": "typeIdentifier", "kind": "typeIdentifier",
▲ Show 20 Lines • Show All 320 Lines • Show Last 20 Lines