This is an archive of the discontinued LLVM Phabricator instance.

Differential D135804

[clang][ExtractAPI] Ignore fully anonymous RecordDecls
ClosedPublic

Authored by dang on Oct 12 2022, 11:55 AM.

Details

Reviewers
zixuw
ributzka
QuietMisdreavus
Commits
rGb6da16ffb9d5: [clang][ExtractAPI] Ignore fully anonymous RecordDecls
Summary

ExtractAPI was emitting a separate symbol for anonymous record declaration
that define the type of a member of another record declaration. Now
ExtractAPI ignores these declarations and just records the existence of
the actual member.

Diff Detail

Event Timeline

dang created this revision.Oct 12 2022, 11:55 AM
Herald added a project: Restricted Project. · View Herald TranscriptOct 12 2022, 11:55 AM
dang requested review of this revision.Oct 12 2022, 11:55 AM
Herald added a project: Restricted Project. · View Herald TranscriptOct 12 2022, 11:55 AM
Herald added a subscriber: cfe-commits. · View Herald Transcript
Harbormaster completed remote builds in B191792: Diff 467219.Oct 12 2022, 12:31 PM
QuietMisdreavus accepted this revision.Oct 12 2022, 3:33 PM

It would be ideal to be able to properly handle nested types like this, but for right now this is causing a crash in Swift-DocC, so this patch will at least get that working.

This revision is now accepted and ready to land.Oct 12 2022, 3:33 PM
Closed by commit rGb6da16ffb9d5: [clang][ExtractAPI] Ignore fully anonymous RecordDecls (authored by dang). · Explain WhyOct 13 2022, 3:54 AM
This revision was automatically updated to reflect the committed changes.
dang added a commit: rGb6da16ffb9d5: [clang][ExtractAPI] Ignore fully anonymous RecordDecls.

Revision Contents

PathSize
clang/
lib/
ExtractAPI/
3 lines
test/
ExtractAPI/
396 lines

Diff 467430

clang/lib/ExtractAPI/ExtractAPIConsumer.cpp

Show First 20 Lines • Show All 395 Lines • ▼ Show 20 Lines bool VisitRecordDecl(const RecordDecl *Decl) {
if (!LCF.isLocationInKnownFile(Decl->getLocation())) if (!LCF.isLocationInKnownFile(Decl->getLocation()))
return true; return true;
// Collect symbol information. // Collect symbol information.
StringRef Name = Decl->getName(); StringRef Name = Decl->getName();
if (Name.empty()) if (Name.empty())
Name = getTypedefName(Decl); Name = getTypedefName(Decl);
if (Name.empty())
return true;
StringRef USR = API.recordUSR(Decl); StringRef USR = API.recordUSR(Decl);
PresumedLoc Loc = PresumedLoc Loc =
Context.getSourceManager().getPresumedLoc(Decl->getLocation()); Context.getSourceManager().getPresumedLoc(Decl->getLocation());
DocComment Comment; DocComment Comment;
if (auto *RawComment = Context.getRawCommentForDeclNoCache(Decl)) if (auto *RawComment = Context.getRawCommentForDeclNoCache(Decl))
Comment = RawComment->getFormattedLines(Context.getSourceManager(), Comment = RawComment->getFormattedLines(Context.getSourceManager(),
Context.getDiagnostics()); Context.getDiagnostics());
▲ Show 20 Lines • Show All 528 Lines • Show Last 20 Lines

clang/test/ExtractAPI/anonymous_record_no_typedef.c

  • 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 \
// RUN: -x 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
/// A Vehicle
struct Vehicle {
/// The type of vehicle.
enum {
Bicycle,
Car
} type;
/// The information about the vehicle.
struct {
int wheels;
char *name;
} information;
};
// 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:@S@Vehicle@E@input.h@64@Bicycle",
"target": "c:@S@Vehicle@E@input.h@64"
},
{
"kind": "memberOf",
"source": "c:@S@Vehicle@E@input.h@64@Car",
"target": "c:@S@Vehicle@E@input.h@64"
},
{
"kind": "memberOf",
"source": "c:@S@Vehicle@FI@type",
"target": "c:@S@Vehicle"
},
{
"kind": "memberOf",
"source": "c:@S@Vehicle@FI@information",
"target": "c:@S@Vehicle"
}
],
"symbols": [
{
"accessLevel": "public",
"declarationFragments": [
{
"kind": "keyword",
"spelling": "enum"
},
{
"kind": "text",
"spelling": ": "
},
{
"kind": "typeIdentifier",
"preciseIdentifier": "c:i",
"spelling": "unsigned int"
}
],
"docComment": {
"lines": [
{
"range": {
"end": {
"character": 29,
"line": 3
},
"start": {
"character": 9,
"line": 3
}
},
"text": "The type of vehicle."
}
]
},
"identifier": {
"interfaceLanguage": "c",
"precise": "c:@S@Vehicle@E@input.h@64"
},
"kind": {
"displayName": "Enumeration",
"identifier": "c.enum"
},
"location": {
"position": {
"character": 5,
"line": 4
},
"uri": "file://INPUT_DIR/input.h"
},
"names": {
"navigator": [
{
"kind": "identifier",
"spelling": "Vehicle::(anonymous)"
}
],
"title": "Vehicle::(anonymous)"
},
"pathComponents": [
"Vehicle::(anonymous)"
]
},
{
"accessLevel": "public",
"declarationFragments": [
{
"kind": "identifier",
"spelling": "Bicycle"
}
],
"identifier": {
"interfaceLanguage": "c",
"precise": "c:@S@Vehicle@E@input.h@64@Bicycle"
},
"kind": {
"displayName": "Enumeration Case",
"identifier": "c.enum.case"
},
"location": {
"position": {
"character": 9,
"line": 5
},
"uri": "file://INPUT_DIR/input.h"
},
"names": {
"navigator": [
{
"kind": "identifier",
"spelling": "Bicycle"
}
],
"subHeading": [
{
"kind": "identifier",
"spelling": "Bicycle"
}
],
"title": "Bicycle"
},
"pathComponents": [
"Vehicle::(anonymous)",
"Bicycle"
]
},
{
"accessLevel": "public",
"declarationFragments": [
{
"kind": "identifier",
"spelling": "Car"
}
],
"identifier": {
"interfaceLanguage": "c",
"precise": "c:@S@Vehicle@E@input.h@64@Car"
},
"kind": {
"displayName": "Enumeration Case",
"identifier": "c.enum.case"
},
"location": {
"position": {
"character": 9,
"line": 6
},
"uri": "file://INPUT_DIR/input.h"
},
"names": {
"navigator": [
{
"kind": "identifier",
"spelling": "Car"
}
],
"subHeading": [
{
"kind": "identifier",
"spelling": "Car"
}
],
"title": "Car"
},
"pathComponents": [
"Vehicle::(anonymous)",
"Car"
]
},
{
"accessLevel": "public",
"declarationFragments": [
{
"kind": "keyword",
"spelling": "struct"
},
{
"kind": "text",
"spelling": " "
},
{
"kind": "identifier",
"spelling": "Vehicle"
}
],
"docComment": {
"lines": [
{
"range": {
"end": {
"character": 14,
"line": 1
},
"start": {
"character": 5,
"line": 1
}
},
"text": "A Vehicle"
}
]
},
"identifier": {
"interfaceLanguage": "c",
"precise": "c:@S@Vehicle"
},
"kind": {
"displayName": "Structure",
"identifier": "c.struct"
},
"location": {
"position": {
"character": 8,
"line": 2
},
"uri": "file://INPUT_DIR/input.h"
},
"names": {
"navigator": [
{
"kind": "identifier",
"spelling": "Vehicle"
}
],
"subHeading": [
{
"kind": "identifier",
"spelling": "Vehicle"
}
],
"title": "Vehicle"
},
"pathComponents": [
"Vehicle"
]
},
{
"accessLevel": "public",
"declarationFragments": [
{
"kind": "keyword",
"spelling": "enum"
},
{
"kind": "text",
"spelling": " "
},
{
"kind": "identifier",
"spelling": "type"
}
],
"identifier": {
"interfaceLanguage": "c",
"precise": "c:@S@Vehicle@FI@type"
},
"kind": {
"displayName": "Instance Property",
"identifier": "c.property"
},
"location": {
"position": {
"character": 7,
"line": 7
},
"uri": "file://INPUT_DIR/input.h"
},
"names": {
"navigator": [
{
"kind": "identifier",
"spelling": "type"
}
],
"subHeading": [
{
"kind": "identifier",
"spelling": "type"
}
],
"title": "type"
},
"pathComponents": [
"Vehicle",
"type"
]
},
{
"accessLevel": "public",
"declarationFragments": [
{
"kind": "keyword",
"spelling": "struct"
},
{
"kind": "text",
"spelling": " "
},
{
"kind": "identifier",
"spelling": "information"
}
],
"identifier": {
"interfaceLanguage": "c",
"precise": "c:@S@Vehicle@FI@information"
},
"kind": {
"displayName": "Instance Property",
"identifier": "c.property"
},
"location": {
"position": {
"character": 7,
"line": 13
},
"uri": "file://INPUT_DIR/input.h"
},
"names": {
"navigator": [
{
"kind": "identifier",
"spelling": "information"
}
],
"subHeading": [
{
"kind": "identifier",
"spelling": "information"
}
],
"title": "information"
},
"pathComponents": [
"Vehicle",
"information"
]
}
]
}