Skip to content

Commit

Permalink
[clang][ExtractAPI] Remove extra pointer indirection from declaration…
Browse files Browse the repository at this point in the history 
… fragments for Obj-C lightweight generics on id

Fixes #61479

Reviewed By: dang

Differential Revision: https://reviews.llvm.org/D146866
  • Loading branch information
@chaitanyav
chaitanyav committed Mar 30, 2023
1 parent 3c787d5 commit a590d86
Show file tree
Hide file tree
Showing 2 changed files with 358 additions and 5 deletions.
22 changes: 17 additions & 5 deletions clang/lib/ExtractAPI/DeclarationFragments.cpp
View file
Expand Up @@ -160,14 +160,26 @@ DeclarationFragments DeclarationFragmentsBuilder::getFragmentsForType(
DeclarationFragments Fragments;

// Declaration fragments of a pointer type is the declaration fragments of
// the pointee type followed by a `*`, except for Objective-C `id` and `Class`
// pointers, where we do not spell out the `*`.
if (T->isPointerType() ||
(T->isObjCObjectPointerType() &&
!T->getAs<ObjCObjectPointerType>()->isObjCIdOrClassType())) {
// the pointee type followed by a `*`,
if (T->isPointerType())
return Fragments
.append(getFragmentsForType(T->getPointeeType(), Context, After))
.append(" *", DeclarationFragments::FragmentKind::Text);

// For Objective-C `id` and `Class` pointers
// we do not spell out the `*`.
if (T->isObjCObjectPointerType() &&
!T->getAs<ObjCObjectPointerType>()->isObjCIdOrClassType()) {

Fragments.append(getFragmentsForType(T->getPointeeType(), Context, After));

// id<protocol> is an qualified id type
// id<protocol>* is not an qualified id type
if (!T->getAs<ObjCObjectPointerType>()->isObjCQualifiedIdType()) {
Fragments.append(" *", DeclarationFragments::FragmentKind::Text);
}

return Fragments;
}

// Declaration fragments of a lvalue reference type is the declaration
Expand Down
341 changes: 341 additions & 0 deletions clang/test/ExtractAPI/objc_id_protocol.m
View file
@@ -0,0 +1,341 @@
// 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 -extract-api -x objective-c-header -target arm64-apple-macosx \
// RUN: %t/input.h -o %t/output.json | FileCheck -allow-empty %s

// 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

// CHECK-NOT: error:
// CHECK-NOT: warning:

//--- input.h
@protocol MyProtocol
@end

@interface MyInterface
@property(copy, readwrite) id<MyProtocol> obj1;
@property(readwrite) id<MyProtocol> *obj2;
@end
//--- 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)MyInterface(py)obj1",
"target": "c:objc(cs)MyInterface",
"targetFallback": "MyInterface"
},
{
"kind": "memberOf",
"source": "c:objc(cs)MyInterface(py)obj2",
"target": "c:objc(cs)MyInterface",
"targetFallback": "MyInterface"
}
],
"symbols": [
{
"accessLevel": "public",
"declarationFragments": [
{
"kind": "keyword",
"spelling": "@interface"
},
{
"kind": "text",
"spelling": " "
},
{
"kind": "identifier",
"spelling": "MyInterface"
}
],
"identifier": {
"interfaceLanguage": "objective-c",
"precise": "c:objc(cs)MyInterface"
},
"kind": {
"displayName": "Class",
"identifier": "objective-c.class"
},
"location": {
"position": {
"character": 12,
"line": 4
},
"uri": "file://INPUT_DIR/input.h"
},
"names": {
"navigator": [
{
"kind": "identifier",
"spelling": "MyInterface"
}
],
"subHeading": [
{
"kind": "identifier",
"spelling": "MyInterface"
}
],
"title": "MyInterface"
},
"pathComponents": [
"MyInterface"
]
},
{
"accessLevel": "public",
"declarationFragments": [
{
"kind": "keyword",
"spelling": "@property"
},
{
"kind": "text",
"spelling": " ("
},
{
"kind": "keyword",
"spelling": "atomic"
},
{
"kind": "text",
"spelling": ", "
},
{
"kind": "keyword",
"spelling": "copy"
},
{
"kind": "text",
"spelling": ", "
},
{
"kind": "keyword",
"spelling": "readwrite"
},
{
"kind": "text",
"spelling": ") "
},
{
"kind": "typeIdentifier",
"preciseIdentifier": "c:Qoobjc(pl)MyProtocol",
"spelling": "id<MyProtocol>"
},
{
"kind": "text",
"spelling": " "
},
{
"kind": "identifier",
"spelling": "obj1"
}
],
"identifier": {
"interfaceLanguage": "objective-c",
"precise": "c:objc(cs)MyInterface(py)obj1"
},
"kind": {
"displayName": "Instance Property",
"identifier": "objective-c.property"
},
"location": {
"position": {
"character": 43,
"line": 5
},
"uri": "file://INPUT_DIR/input.h"
},
"names": {
"navigator": [
{
"kind": "identifier",
"spelling": "obj1"
}
],
"subHeading": [
{
"kind": "identifier",
"spelling": "obj1"
}
],
"title": "obj1"
},
"pathComponents": [
"MyInterface",
"obj1"
]
},
{
"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:Qoobjc(pl)MyProtocol",
"spelling": "id<MyProtocol>"
},
{
"kind": "text",
"spelling": " * "
},
{
"kind": "identifier",
"spelling": "obj2"
}
],
"identifier": {
"interfaceLanguage": "objective-c",
"precise": "c:objc(cs)MyInterface(py)obj2"
},
"kind": {
"displayName": "Instance Property",
"identifier": "objective-c.property"
},
"location": {
"position": {
"character": 38,
"line": 6
},
"uri": "file://INPUT_DIR/input.h"
},
"names": {
"navigator": [
{
"kind": "identifier",
"spelling": "obj2"
}
],
"subHeading": [
{
"kind": "identifier",
"spelling": "obj2"
}
],
"title": "obj2"
},
"pathComponents": [
"MyInterface",
"obj2"
]
},
{
"accessLevel": "public",
"declarationFragments": [
{
"kind": "keyword",
"spelling": "@protocol"
},
{
"kind": "text",
"spelling": " "
},
{
"kind": "identifier",
"spelling": "MyProtocol"
}
],
"identifier": {
"interfaceLanguage": "objective-c",
"precise": "c:objc(pl)MyProtocol"
},
"kind": {
"displayName": "Protocol",
"identifier": "objective-c.protocol"
},
"location": {
"position": {
"character": 11,
"line": 1
},
"uri": "file://INPUT_DIR/input.h"
},
"names": {
"navigator": [
{
"kind": "identifier",
"spelling": "MyProtocol"
}
],
"subHeading": [
{
"kind": "identifier",
"spelling": "MyProtocol"
}
],
"title": "MyProtocol"
},
"pathComponents": [
"MyProtocol"
]
}
]
}

0 comments on commit a590d86

Please sign in to comment.