This is an archive of the discontinued LLVM Phabricator instance.

Differential D158474

[clang][ExtractAPI] Fix bool spelling coming from the macro definition.
ClosedPublic

Authored by evelez7 on Aug 21 2023, 6:43 PM.

Details

Reviewers
dang
ributzka
Commits
rGe81744563a53: [clang][ExtractAPI] Fix bool spelling coming from the macro definition.
Summary

getFragmentsForType resulted in a bool typeIdentifier fragment to be spelled "_Bool".
This fixes the spelling to be "bool" and checks it in C and C++.

Diff Detail

Event Timeline

evelez7 created this revision.Aug 21 2023, 6:43 PM
Herald added a reviewer: ributzka. · View Herald TranscriptAug 21 2023, 6:43 PM
Herald added a project: Restricted Project. · View Herald Transcript
evelez7 requested review of this revision.Aug 21 2023, 6:43 PM
Herald added a project: Restricted Project. · View Herald TranscriptAug 21 2023, 6:43 PM
Herald added a subscriber: cfe-commits. · View Herald Transcript
Harbormaster completed remote builds in B253964: Diff 552182.Aug 21 2023, 7:15 PM
dang accepted this revision.Aug 22 2023, 2:27 AM

Nice!

This revision is now accepted and ready to land.Aug 22 2023, 2:27 AM
evelez7 updated this revision to Diff 552504.Aug 22 2023, 2:13 PM

Use clang instead of clang_cc1 like other C tests.

Harbormaster completed remote builds in B254194: Diff 552504.Aug 22 2023, 2:50 PM
This revision was landed with ongoing or failed builds.Aug 22 2023, 3:00 PM
Closed by commit rGe81744563a53: [clang][ExtractAPI] Fix bool spelling coming from the macro definition. (authored by evelez7). · Explain Why
This revision was automatically updated to reflect the committed changes.
evelez7 added a commit: rGe81744563a53: [clang][ExtractAPI] Fix bool spelling coming from the macro definition..
aeubanks added a subscriber: aeubanks.Sep 6 2023, 3:00 PM
aeubanks added inline comments.
clang/test/ExtractAPI/bool.c
14

clang tests should not be including system headers since that makes the tests non-hermetic (this test fails in our internal builds that provide more isolated test environments), could you make this not include <stdbool.h>?

aeubanks added inline comments.Sep 7 2023, 10:41 AM
clang/test/ExtractAPI/bool.c
14

ignore my previous comment, stdbool.h is provided by clang, sorry for the trouble

Revision Contents

PathSize
clang/
include/
clang/
ExtractAPI/
5 lines
lib/
ExtractAPI/
3 lines
test/
ExtractAPI/
204 lines
203 lines

Diff 552515

clang/include/clang/ExtractAPI/DeclarationFragments.h

Show First 20 Lines • Show All 164 Lines • ▼ Show 20 Lines DeclarationFragments &append(DeclarationFragments &&Other) {
return *this; return *this;
} }
DeclarationFragments &pop_back() { DeclarationFragments &pop_back() {
Fragments.pop_back(); Fragments.pop_back();
return *this; return *this;
} }
DeclarationFragments &replace(std::string NewSpelling, unsigned Position) {
Fragments.at(Position).Spelling = NewSpelling;
return *this;
}
/// Append a text Fragment of a space character. /// Append a text Fragment of a space character.
/// ///
/// \returns a reference to the DeclarationFragments object itself after /// \returns a reference to the DeclarationFragments object itself after
/// appending to chain up consecutive appends. /// appending to chain up consecutive appends.
DeclarationFragments &appendSpace(); DeclarationFragments &appendSpace();
/// Get the string description of a FragmentKind \p Kind. /// Get the string description of a FragmentKind \p Kind.
static StringRef getFragmentKindString(FragmentKind Kind); static StringRef getFragmentKindString(FragmentKind Kind);
▲ Show 20 Lines • Show All 262 Lines • Show Last 20 Lines

clang/lib/ExtractAPI/DeclarationFragments.cpp

Show First 20 Lines • Show All 391 Lines • ▼ Show 20 Lines if (const ParenType *PT = dyn_cast<ParenType>(QT)) {
return getFragmentsForType(PT->getInnerType(), Context, After) return getFragmentsForType(PT->getInnerType(), Context, After)
.append("(", DeclarationFragments::FragmentKind::Text); .append("(", DeclarationFragments::FragmentKind::Text);
} }
const SplitQualType SQT = QT.split(); const SplitQualType SQT = QT.split();
DeclarationFragments QualsFragments = getFragmentsForQualifiers(SQT.Quals), DeclarationFragments QualsFragments = getFragmentsForQualifiers(SQT.Quals),
TypeFragments = TypeFragments =
getFragmentsForType(SQT.Ty, Context, After); getFragmentsForType(SQT.Ty, Context, After);
if (QT.getAsString() == "_Bool")
TypeFragments.replace("bool", 0);
if (QualsFragments.getFragments().empty()) if (QualsFragments.getFragments().empty())
return TypeFragments; return TypeFragments;
// Use east qualifier for pointer types // Use east qualifier for pointer types
// For example: // For example:
// ``` // ```
// int * const // int * const
// ^---- ^---- // ^---- ^----
▲ Show 20 Lines • Show All 944 Lines • Show Last 20 Lines

clang/test/ExtractAPI/bool.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 -extract-api -target arm64-apple-macosx \
// RUN: %t/input.h -o %t/output.json
// 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
#include <stdbool.h>
aeubanksUnsubmitted
Not Done
ReplyInline Actions

clang tests should not be including system headers since that makes the tests non-hermetic (this test fails in our internal builds that provide more isolated test environments), could you make this not include <stdbool.h>?

aeubanks: clang tests should not be including system headers since that makes the tests non-hermetic…
aeubanksUnsubmitted
Not Done
ReplyInline Actions

ignore my previous comment, stdbool.h is provided by clang, sorry for the trouble

aeubanks: ignore my previous comment, stdbool.h is provided by clang, sorry for the trouble
bool Foo;
bool IsFoo(bool Bar);
/// 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": [],
"symbols": [
{
"accessLevel": "public",
"declarationFragments": [
{
"kind": "typeIdentifier",
"preciseIdentifier": "c:b",
"spelling": "bool"
},
{
"kind": "text",
"spelling": " "
},
{
"kind": "identifier",
"spelling": "Foo"
},
{
"kind": "text",
"spelling": ";"
}
],
"identifier": {
"interfaceLanguage": "c",
"precise": "c:@Foo"
},
"kind": {
"displayName": "Global Variable",
"identifier": "c.var"
},
"location": {
"position": {
"character": 6,
"line": 2
},
"uri": "file://INPUT_DIR/input.h"
},
"names": {
"navigator": [
{
"kind": "identifier",
"spelling": "Foo"
}
],
"subHeading": [
{
"kind": "identifier",
"spelling": "Foo"
}
],
"title": "Foo"
},
"pathComponents": [
"Foo"
]
},
{
"accessLevel": "public",
"declarationFragments": [
{
"kind": "typeIdentifier",
"preciseIdentifier": "c:b",
"spelling": "bool"
},
{
"kind": "text",
"spelling": " "
},
{
"kind": "identifier",
"spelling": "IsFoo"
},
{
"kind": "text",
"spelling": "("
},
{
"kind": "typeIdentifier",
"preciseIdentifier": "c:b",
"spelling": "bool"
},
{
"kind": "text",
"spelling": " "
},
{
"kind": "internalParam",
"spelling": "Bar"
},
{
"kind": "text",
"spelling": ");"
}
],
"functionSignature": {
"parameters": [
{
"declarationFragments": [
{
"kind": "typeIdentifier",
"preciseIdentifier": "c:b",
"spelling": "bool"
},
{
"kind": "text",
"spelling": " "
},
{
"kind": "internalParam",
"spelling": "Bar"
}
],
"name": "Bar"
}
],
"returns": [
{
"kind": "typeIdentifier",
"preciseIdentifier": "c:b",
"spelling": "bool"
}
]
},
"identifier": {
"interfaceLanguage": "c",
"precise": "c:@F@IsFoo"
},
"kind": {
"displayName": "Function",
"identifier": "c.func"
},
"location": {
"position": {
"character": 6,
"line": 4
},
"uri": "file://INPUT_DIR/input.h"
},
"names": {
"navigator": [
{
"kind": "identifier",
"spelling": "IsFoo"
}
],
"subHeading": [
{
"kind": "identifier",
"spelling": "IsFoo"
}
],
"title": "IsFoo"
},
"pathComponents": [
"IsFoo"
]
}
]
}

clang/test/ExtractAPI/bool.cpp

  • 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
bool Foo;
bool IsFoo(bool Bar);
/// 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": [],
"symbols": [
{
"accessLevel": "public",
"declarationFragments": [
{
"kind": "typeIdentifier",
"preciseIdentifier": "c:b",
"spelling": "bool"
},
{
"kind": "text",
"spelling": " "
},
{
"kind": "identifier",
"spelling": "Foo"
},
{
"kind": "text",
"spelling": ";"
}
],
"identifier": {
"interfaceLanguage": "c++",
"precise": "c:@Foo"
},
"kind": {
"displayName": "Global Variable",
"identifier": "c++.var"
},
"location": {
"position": {
"character": 6,
"line": 1
},
"uri": "file://INPUT_DIR/input.h"
},
"names": {
"navigator": [
{
"kind": "identifier",
"spelling": "Foo"
}
],
"subHeading": [
{
"kind": "identifier",
"spelling": "Foo"
}
],
"title": "Foo"
},
"pathComponents": [
"Foo"
]
},
{
"accessLevel": "public",
"declarationFragments": [
{
"kind": "typeIdentifier",
"preciseIdentifier": "c:b",
"spelling": "bool"
},
{
"kind": "text",
"spelling": " "
},
{
"kind": "identifier",
"spelling": "IsFoo"
},
{
"kind": "text",
"spelling": "("
},
{
"kind": "typeIdentifier",
"preciseIdentifier": "c:b",
"spelling": "bool"
},
{
"kind": "text",
"spelling": " "
},
{
"kind": "internalParam",
"spelling": "Bar"
},
{
"kind": "text",
"spelling": ");"
}
],
"functionSignature": {
"parameters": [
{
"declarationFragments": [
{
"kind": "typeIdentifier",
"preciseIdentifier": "c:b",
"spelling": "bool"
},
{
"kind": "text",
"spelling": " "
},
{
"kind": "internalParam",
"spelling": "Bar"
}
],
"name": "Bar"
}
],
"returns": [
{
"kind": "typeIdentifier",
"preciseIdentifier": "c:b",
"spelling": "bool"
}
]
},
"identifier": {
"interfaceLanguage": "c++",
"precise": "c:@F@IsFoo#b#"
},
"kind": {
"displayName": "Function",
"identifier": "c++.func"
},
"location": {
"position": {
"character": 6,
"line": 3
},
"uri": "file://INPUT_DIR/input.h"
},
"names": {
"navigator": [
{
"kind": "identifier",
"spelling": "IsFoo"
}
],
"subHeading": [
{
"kind": "identifier",
"spelling": "IsFoo"
}
],
"title": "IsFoo"
},
"pathComponents": [
"IsFoo"
]
}
]
}