Skip to content

Commit

Permalink
[clang][ExtractAPI] Fix bool spelling coming from the macro definition.
Browse files Browse the repository at this point in the history
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++.

Reviewed By: dang

Differential Revision: https://reviews.llvm.org/D158474
  • Loading branch information
evelez7 committed Aug 22, 2023
1 parent 7822e5d commit e817445
Show file tree
Hide file tree
Showing 4 changed files with 415 additions and 0 deletions.
5 changes: 5 additions & 0 deletions clang/include/clang/ExtractAPI/DeclarationFragments.h
Original file line number Diff line number Diff line change
Expand Up @@ -170,6 +170,11 @@ class DeclarationFragments {
return *this;
}

DeclarationFragments &replace(std::string NewSpelling, unsigned Position) {
Fragments.at(Position).Spelling = NewSpelling;
return *this;
}

/// Append a text Fragment of a space character.
///
/// \returns a reference to the DeclarationFragments object itself after
Expand Down
3 changes: 3 additions & 0 deletions clang/lib/ExtractAPI/DeclarationFragments.cpp
Original file line number Diff line number Diff line change
Expand Up @@ -397,6 +397,9 @@ DeclarationFragments DeclarationFragmentsBuilder::getFragmentsForType(
DeclarationFragments QualsFragments = getFragmentsForQualifiers(SQT.Quals),
TypeFragments =
getFragmentsForType(SQT.Ty, Context, After);
if (QT.getAsString() == "_Bool")
TypeFragments.replace("bool", 0);

if (QualsFragments.getFragments().empty())
return TypeFragments;

Expand Down
204 changes: 204 additions & 0 deletions clang/test/ExtractAPI/bool.c
Original file line number Diff line number Diff line change
@@ -0,0 +1,204 @@
// 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>
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"
]
}
]
}

0 comments on commit e817445

Please sign in to comment.