This is an archive of the discontinued LLVM Phabricator instance.

Differential D130581

[clang][ExtractAPI] Ensure that class properties have a kind of "Type Property"
ClosedPublic

Authored by dang on Jul 26 2022, 8:36 AM.

Details

Reviewers
zixuw
QuietMisdreavus
ributzka
Commits
rGd3fc779e4295: [clang][ExtractAPI] Ensure that class properties have a kind of "Type Property"
Summary

Generated symbol graphs should distinguish between type properties and instance
properties.

Diff Detail

Event Timeline

dang created this revision.Jul 26 2022, 8:36 AM
Herald added a reviewer: ributzka. · View Herald TranscriptJul 26 2022, 8:36 AM
Herald added a project: Restricted Project. · View Herald Transcript
dang requested review of this revision.Jul 26 2022, 8:36 AM
Herald added a project: Restricted Project. · View Herald TranscriptJul 26 2022, 8:36 AM
Herald added a subscriber: cfe-commits. · View Herald Transcript
Harbormaster completed remote builds in B177635: Diff 447724.Jul 26 2022, 9:49 AM
zixuw accepted this revision.Jul 26 2022, 11:42 AM

LGTM. Thanks Daniel!

This revision is now accepted and ready to land.Jul 26 2022, 11:42 AM
This revision was landed with ongoing or failed builds.Jul 27 2022, 3:09 AM
Closed by commit rGd3fc779e4295: [clang][ExtractAPI] Ensure that class properties have a kind of "Type Property" (authored by dang). · Explain Why
This revision was automatically updated to reflect the committed changes.
dang added a commit: rGd3fc779e4295: [clang][ExtractAPI] Ensure that class properties have a kind of "Type Property".
Jake-Egan added a subscriber: Jake-Egan.Jul 27 2022, 8:05 AM

Hi, this new test is failing on AIX, could you take a look please?
https://lab.llvm.org/buildbot/#/builders/214/builds/2544/steps/6/logs/FAIL__Clang__objc_property_m

Revision Contents

PathSize
clang/
lib/
ExtractAPI/
Serialization/
11 lines
test/
ExtractAPI/
745 lines

Diff 447977

clang/lib/ExtractAPI/Serialization/SymbolGraphSerializer.cpp

Show First 20 Lines • Show All 345 Lines • ▼ Show 20 Lines case APIRecord::RK_Struct:
Kind["identifier"] = AddLangPrefix("struct"); Kind["identifier"] = AddLangPrefix("struct");
Kind["displayName"] = "Structure"; Kind["displayName"] = "Structure";
break; break;
case APIRecord::RK_ObjCIvar: case APIRecord::RK_ObjCIvar:
Kind["identifier"] = AddLangPrefix("ivar"); Kind["identifier"] = AddLangPrefix("ivar");
Kind["displayName"] = "Instance Variable"; Kind["displayName"] = "Instance Variable";
break; break;
case APIRecord::RK_ObjCMethod: case APIRecord::RK_ObjCMethod:
if (dyn_cast<ObjCMethodRecord>(&Record)->IsInstanceMethod) { if (cast<ObjCMethodRecord>(&Record)->IsInstanceMethod) {
Kind["identifier"] = AddLangPrefix("method"); Kind["identifier"] = AddLangPrefix("method");
Kind["displayName"] = "Instance Method"; Kind["displayName"] = "Instance Method";
} else { } else {
Kind["identifier"] = AddLangPrefix("type.method"); Kind["identifier"] = AddLangPrefix("type.method");
Kind["displayName"] = "Type Method"; Kind["displayName"] = "Type Method";
} }
break; break;
case APIRecord::RK_ObjCProperty: case APIRecord::RK_ObjCProperty:
if (cast<ObjCPropertyRecord>(&Record)->isClassProperty()) {
Kind["identifier"] = AddLangPrefix("type.property");
Kind["displayName"] = "Type Property";
} else {
Kind["identifier"] = AddLangPrefix("property"); Kind["identifier"] = AddLangPrefix("property");
Kind["displayName"] = "Instance Property"; Kind["displayName"] = "Instance Property";
}
break; break;
case APIRecord::RK_ObjCInterface: case APIRecord::RK_ObjCInterface:
Kind["identifier"] = AddLangPrefix("class"); Kind["identifier"] = AddLangPrefix("class");
Kind["displayName"] = "Class"; Kind["displayName"] = "Class";
break; break;
case APIRecord::RK_ObjCCategory: case APIRecord::RK_ObjCCategory:
// We don't serialize out standalone Objective-C category symbols yet. // We don't serialize out standalone Objective-C category symbols yet.
llvm_unreachable("Serializing standalone Objective-C category symbols is " llvm_unreachable("Serializing standalone Objective-C category symbols is "
▲ Show 20 Lines • Show All 336 Lines • Show Last 20 Lines

clang/test/ExtractAPI/objc_property.m

  • This file was added.
// 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 -triple arm64-apple-macosx -x objective-c-header %t/input.h -o %t/output.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
//--- input.h
@protocol Protocol
@property(class) int myProtocolTypeProp;
@property int myProtocolInstanceProp;
@end
@interface Interface
@property(class) int myInterfaceTypeProp;
@property int myInterfaceInstanceProp;
@end
@interface Interface (Category) <Protocol>
@property(class) int myCategoryTypeProp;
@property int myCategoryInstanceProp;
@end
// expected-no-diagnostics
//--- reference.output.json.in
{
"metadata": {
"formatVersion": {
"major": 0,
"minor": 5,
"patch": 3
},
"generator": "?"
},
"module": {
"name": "",
"platform": {
"architecture": "arm64",
"operatingSystem": {
"minimumVersion": {
"major": 11,
"minor": 0,
"patch": 0
},
"name": "macosx"
},
"vendor": "apple"
}
},
"relationships": [
{
"kind": "memberOf",
"source": "c:objc(cs)Interface(cpy)myInterfaceTypeProp",
"target": "c:objc(cs)Interface"
},
{
"kind": "memberOf",
"source": "c:objc(cs)Interface(py)myInterfaceInstanceProp",
"target": "c:objc(cs)Interface"
},
{
"kind": "memberOf",
"source": "c:objc(cs)Interface(cpy)myCategoryTypeProp",
"target": "c:objc(cs)Interface"
},
{
"kind": "memberOf",
"source": "c:objc(cs)Interface(py)myCategoryInstanceProp",
"target": "c:objc(cs)Interface"
},
{
"kind": "conformsTo",
"source": "c:objc(cs)Interface",
"target": "c:objc(pl)Protocol"
},
{
"kind": "memberOf",
"source": "c:objc(pl)Protocol(cpy)myProtocolTypeProp",
"target": "c:objc(pl)Protocol"
},
{
"kind": "memberOf",
"source": "c:objc(pl)Protocol(py)myProtocolInstanceProp",
"target": "c:objc(pl)Protocol"
}
],
"symbols": [
{
"accessLevel": "public",
"declarationFragments": [
{
"kind": "keyword",
"spelling": "@interface"
},
{
"kind": "text",
"spelling": " "
},
{
"kind": "identifier",
"spelling": "Interface"
}
],
"identifier": {
"interfaceLanguage": "objective-c",
"precise": "c:objc(cs)Interface"
},
"kind": {
"displayName": "Class",
"identifier": "objective-c.class"
},
"location": {
"position": {
"character": 12,
"line": 6
},
"uri": "file://INPUT_DIR/input.h"
},
"names": {
"navigator": [
{
"kind": "identifier",
"spelling": "Interface"
}
],
"subHeading": [
{
"kind": "identifier",
"spelling": "Interface"
}
],
"title": "Interface"
},
"pathComponents": [
"Interface"
]
},
{
"accessLevel": "public",
"declarationFragments": [
{
"kind": "keyword",
"spelling": "@property"
},
{
"kind": "text",
"spelling": " ("
},
{
"kind": "keyword",
"spelling": "class"
},
{
"kind": "text",
"spelling": ", "
},
{
"kind": "keyword",
"spelling": "atomic"
},
{
"kind": "text",
"spelling": ", "
},
{
"kind": "keyword",
"spelling": "assign"
},
{
"kind": "text",
"spelling": ", "
},
{
"kind": "keyword",
"spelling": "unsafe_unretained"
},
{
"kind": "text",
"spelling": ", "
},
{
"kind": "keyword",
"spelling": "readwrite"
},
{
"kind": "text",
"spelling": ") "
},
{
"kind": "typeIdentifier",
"preciseIdentifier": "c:I",
"spelling": "int"
},
{
"kind": "identifier",
"spelling": "myInterfaceTypeProp"
}
],
"identifier": {
"interfaceLanguage": "objective-c",
"precise": "c:objc(cs)Interface(cpy)myInterfaceTypeProp"
},
"kind": {
"displayName": "Type Property",
"identifier": "objective-c.type.property"
},
"location": {
"position": {
"character": 22,
"line": 7
},
"uri": "file://INPUT_DIR/input.h"
},
"names": {
"navigator": [
{
"kind": "identifier",
"spelling": "myInterfaceTypeProp"
}
],
"subHeading": [
{
"kind": "identifier",
"spelling": "myInterfaceTypeProp"
}
],
"title": "myInterfaceTypeProp"
},
"pathComponents": [
"Interface",
"myInterfaceTypeProp"
]
},
{
"accessLevel": "public",
"declarationFragments": [
{
"kind": "keyword",
"spelling": "@property"
},
{
"kind": "text",
"spelling": " ("
},
{
"kind": "keyword",
"spelling": "atomic"
},
{
"kind": "text",
"spelling": ", "
},
{
"kind": "keyword",
"spelling": "assign"
},
{
"kind": "text",
"spelling": ", "
},
{
"kind": "keyword",
"spelling": "unsafe_unretained"
},
{
"kind": "text",
"spelling": ", "
},
{
"kind": "keyword",
"spelling": "readwrite"
},
{
"kind": "text",
"spelling": ") "
},
{
"kind": "typeIdentifier",
"preciseIdentifier": "c:I",
"spelling": "int"
},
{
"kind": "identifier",
"spelling": "myInterfaceInstanceProp"
}
],
"identifier": {
"interfaceLanguage": "objective-c",
"precise": "c:objc(cs)Interface(py)myInterfaceInstanceProp"
},
"kind": {
"displayName": "Instance Property",
"identifier": "objective-c.property"
},
"location": {
"position": {
"character": 15,
"line": 8
},
"uri": "file://INPUT_DIR/input.h"
},
"names": {
"navigator": [
{
"kind": "identifier",
"spelling": "myInterfaceInstanceProp"
}
],
"subHeading": [
{
"kind": "identifier",
"spelling": "myInterfaceInstanceProp"
}
],
"title": "myInterfaceInstanceProp"
},
"pathComponents": [
"Interface",
"myInterfaceInstanceProp"
]
},
{
"accessLevel": "public",
"declarationFragments": [
{
"kind": "keyword",
"spelling": "@property"
},
{
"kind": "text",
"spelling": " ("
},
{
"kind": "keyword",
"spelling": "class"
},
{
"kind": "text",
"spelling": ", "
},
{
"kind": "keyword",
"spelling": "atomic"
},
{
"kind": "text",
"spelling": ", "
},
{
"kind": "keyword",
"spelling": "assign"
},
{
"kind": "text",
"spelling": ", "
},
{
"kind": "keyword",
"spelling": "unsafe_unretained"
},
{
"kind": "text",
"spelling": ", "
},
{
"kind": "keyword",
"spelling": "readwrite"
},
{
"kind": "text",
"spelling": ") "
},
{
"kind": "typeIdentifier",
"preciseIdentifier": "c:I",
"spelling": "int"
},
{
"kind": "identifier",
"spelling": "myCategoryTypeProp"
}
],
"identifier": {
"interfaceLanguage": "objective-c",
"precise": "c:objc(cs)Interface(cpy)myCategoryTypeProp"
},
"kind": {
"displayName": "Type Property",
"identifier": "objective-c.type.property"
},
"location": {
"position": {
"character": 22,
"line": 12
},
"uri": "file://INPUT_DIR/input.h"
},
"names": {
"navigator": [
{
"kind": "identifier",
"spelling": "myCategoryTypeProp"
}
],
"subHeading": [
{
"kind": "identifier",
"spelling": "myCategoryTypeProp"
}
],
"title": "myCategoryTypeProp"
},
"pathComponents": [
"Interface",
"myCategoryTypeProp"
]
},
{
"accessLevel": "public",
"declarationFragments": [
{
"kind": "keyword",
"spelling": "@property"
},
{
"kind": "text",
"spelling": " ("
},
{
"kind": "keyword",
"spelling": "atomic"
},
{
"kind": "text",
"spelling": ", "
},
{
"kind": "keyword",
"spelling": "assign"
},
{
"kind": "text",
"spelling": ", "
},
{
"kind": "keyword",
"spelling": "unsafe_unretained"
},
{
"kind": "text",
"spelling": ", "
},
{
"kind": "keyword",
"spelling": "readwrite"
},
{
"kind": "text",
"spelling": ") "
},
{
"kind": "typeIdentifier",
"preciseIdentifier": "c:I",
"spelling": "int"
},
{
"kind": "identifier",
"spelling": "myCategoryInstanceProp"
}
],
"identifier": {
"interfaceLanguage": "objective-c",
"precise": "c:objc(cs)Interface(py)myCategoryInstanceProp"
},
"kind": {
"displayName": "Instance Property",
"identifier": "objective-c.property"
},
"location": {
"position": {
"character": 15,
"line": 13
},
"uri": "file://INPUT_DIR/input.h"
},
"names": {
"navigator": [
{
"kind": "identifier",
"spelling": "myCategoryInstanceProp"
}
],
"subHeading": [
{
"kind": "identifier",
"spelling": "myCategoryInstanceProp"
}
],
"title": "myCategoryInstanceProp"
},
"pathComponents": [
"Interface",
"myCategoryInstanceProp"
]
},
{
"accessLevel": "public",
"declarationFragments": [
{
"kind": "keyword",
"spelling": "@protocol"
},
{
"kind": "text",
"spelling": " "
},
{
"kind": "identifier",
"spelling": "Protocol"
}
],
"identifier": {
"interfaceLanguage": "objective-c",
"precise": "c:objc(pl)Protocol"
},
"kind": {
"displayName": "Protocol",
"identifier": "objective-c.protocol"
},
"location": {
"position": {
"character": 11,
"line": 1
},
"uri": "file://INPUT_DIR/input.h"
},
"names": {
"navigator": [
{
"kind": "identifier",
"spelling": "Protocol"
}
],
"subHeading": [
{
"kind": "identifier",
"spelling": "Protocol"
}
],
"title": "Protocol"
},
"pathComponents": [
"Protocol"
]
},
{
"accessLevel": "public",
"declarationFragments": [
{
"kind": "keyword",
"spelling": "@property"
},
{
"kind": "text",
"spelling": " ("
},
{
"kind": "keyword",
"spelling": "class"
},
{
"kind": "text",
"spelling": ", "
},
{
"kind": "keyword",
"spelling": "atomic"
},
{
"kind": "text",
"spelling": ", "
},
{
"kind": "keyword",
"spelling": "assign"
},
{
"kind": "text",
"spelling": ", "
},
{
"kind": "keyword",
"spelling": "unsafe_unretained"
},
{
"kind": "text",
"spelling": ", "
},
{
"kind": "keyword",
"spelling": "readwrite"
},
{
"kind": "text",
"spelling": ") "
},
{
"kind": "typeIdentifier",
"preciseIdentifier": "c:I",
"spelling": "int"
},
{
"kind": "identifier",
"spelling": "myProtocolTypeProp"
}
],
"identifier": {
"interfaceLanguage": "objective-c",
"precise": "c:objc(pl)Protocol(cpy)myProtocolTypeProp"
},
"kind": {
"displayName": "Type Property",
"identifier": "objective-c.type.property"
},
"location": {
"position": {
"character": 22,
"line": 2
},
"uri": "file://INPUT_DIR/input.h"
},
"names": {
"navigator": [
{
"kind": "identifier",
"spelling": "myProtocolTypeProp"
}
],
"subHeading": [
{
"kind": "identifier",
"spelling": "myProtocolTypeProp"
}
],
"title": "myProtocolTypeProp"
},
"pathComponents": [
"Protocol",
"myProtocolTypeProp"
]
},
{
"accessLevel": "public",
"declarationFragments": [
{
"kind": "keyword",
"spelling": "@property"
},
{
"kind": "text",
"spelling": " ("
},
{
"kind": "keyword",
"spelling": "atomic"
},
{
"kind": "text",
"spelling": ", "
},
{
"kind": "keyword",
"spelling": "assign"
},
{
"kind": "text",
"spelling": ", "
},
{
"kind": "keyword",
"spelling": "unsafe_unretained"
},
{
"kind": "text",
"spelling": ", "
},
{
"kind": "keyword",
"spelling": "readwrite"
},
{
"kind": "text",
"spelling": ") "
},
{
"kind": "typeIdentifier",
"preciseIdentifier": "c:I",
"spelling": "int"
},
{
"kind": "identifier",
"spelling": "myProtocolInstanceProp"
}
],
"identifier": {
"interfaceLanguage": "objective-c",
"precise": "c:objc(pl)Protocol(py)myProtocolInstanceProp"
},
"kind": {
"displayName": "Instance Property",
"identifier": "objective-c.property"
},
"location": {
"position": {
"character": 15,
"line": 3
},
"uri": "file://INPUT_DIR/input.h"
},
"names": {
"navigator": [
{
"kind": "identifier",
"spelling": "myProtocolInstanceProp"
}
],
"subHeading": [
{
"kind": "identifier",
"spelling": "myProtocolInstanceProp"
}
],
"title": "myProtocolInstanceProp"
},
"pathComponents": [
"Protocol",
"myProtocolInstanceProp"
]
}
]
}