This is an archive of the discontinued LLVM Phabricator instance.

Differential D123259

[clang][ExtractAPI] Fix appendSpace in DeclarationFragments
ClosedPublic

Authored by zixuw on Apr 6 2022, 2:46 PM.

Details

Reviewers
dang
ributzka
QuietMisdreavus
Commits
rGfe2c77a0065c: [clang][ExtractAPI] Fix appendSpace in DeclarationFragments
Summary

There is a bug in DeclarationFragments::appendSpace where the space
character is added to a local copy of the last fragment.

Diff Detail

Event Timeline

zixuw created this revision.Apr 6 2022, 2:46 PM
Herald added a reviewer: dang. · View Herald TranscriptApr 6 2022, 2:46 PM
Herald added a project: Restricted Project. · View Herald Transcript
zixuw requested review of this revision.Apr 6 2022, 2:46 PM
Herald added a project: Restricted Project. · View Herald TranscriptApr 6 2022, 2:46 PM
Herald added a subscriber: cfe-commits. · View Herald Transcript
zixuw added reviewers: ributzka, QuietMisdreavus.Apr 6 2022, 2:47 PM
zixuw added a child revision: D123261: [clang][ExtractAPI] Fix declaration fragments for ObjC methods.Apr 6 2022, 2:58 PM
QuietMisdreavus accepted this revision.Apr 6 2022, 3:33 PM

LGTM

This revision is now accepted and ready to land.Apr 6 2022, 3:33 PM
Harbormaster completed remote builds in B158345: Diff 421018.Apr 6 2022, 4:30 PM
dang accepted this revision.Apr 7 2022, 2:08 AM

LGTM thanks for spotting this!

This revision was landed with ongoing or failed builds.Apr 7 2022, 9:17 AM
Closed by commit rGfe2c77a0065c: [clang][ExtractAPI] Fix appendSpace in DeclarationFragments (authored by zixuw). · Explain Why
This revision was automatically updated to reflect the committed changes.
zixuw added a commit: rGfe2c77a0065c: [clang][ExtractAPI] Fix appendSpace in DeclarationFragments.

Revision Contents

PathSize
clang/
lib/
ExtractAPI/
4 lines
test/
ExtractAPI/
4 lines
4 lines
4 lines
6 lines
8 lines

Diff 421240

clang/lib/ExtractAPI/DeclarationFragments.cpp

Show All 15 Lines
#include "clang/Index/USRGeneration.h" #include "clang/Index/USRGeneration.h"
#include "llvm/ADT/StringSwitch.h" #include "llvm/ADT/StringSwitch.h"
using namespace clang::extractapi; using namespace clang::extractapi;
using namespace llvm; using namespace llvm;
DeclarationFragments &DeclarationFragments::appendSpace() { DeclarationFragments &DeclarationFragments::appendSpace() {
if (!Fragments.empty()) { if (!Fragments.empty()) {
Fragment Last = Fragments.back(); Fragment &Last = Fragments.back();
if (Last.Kind == FragmentKind::Text) { if (Last.Kind == FragmentKind::Text) {
// Merge the extra space into the last fragment if the last fragment is // Merge the extra space into the last fragment if the last fragment is
// also text. // also text.
if (Last.Spelling.back() != ' ') { // avoid extra trailing spaces. if (Last.Spelling.back() != ' ') { // avoid extra trailing spaces.
Last.Spelling.push_back(' '); Last.Spelling.push_back(' ');
} }
} else { } else {
append(" ", FragmentKind::Text); append(" ", FragmentKind::Text);
▲ Show 20 Lines • Show All 352 Lines • ▼ Show 20 Lines QualType T = Param->getTypeSourceInfo()
Param->getType()); Param->getType());
DeclarationFragments TypeFragments = DeclarationFragments TypeFragments =
getFragmentsForType(T, Param->getASTContext(), After); getFragmentsForType(T, Param->getASTContext(), After);
if (Param->isObjCMethodParameter()) if (Param->isObjCMethodParameter())
Fragments.append("(", DeclarationFragments::FragmentKind::Text) Fragments.append("(", DeclarationFragments::FragmentKind::Text)
.append(std::move(TypeFragments)) .append(std::move(TypeFragments))
.append(")", DeclarationFragments::FragmentKind::Text); .append(") ", DeclarationFragments::FragmentKind::Text);
else else
Fragments.append(std::move(TypeFragments)).appendSpace(); Fragments.append(std::move(TypeFragments)).appendSpace();
return Fragments return Fragments
.append(Param->getName(), .append(Param->getName(),
DeclarationFragments::FragmentKind::InternalParam) DeclarationFragments::FragmentKind::InternalParam)
.append(std::move(After)); .append(std::move(After));
} }
▲ Show 20 Lines • Show All 397 Lines • Show Last 20 Lines

clang/test/ExtractAPI/global_record.c

Show First 20 Lines • Show All 169 Lines • ▼ Show 20 Lines "symbols": [
}, },
{ {
"kind": "typeIdentifier", "kind": "typeIdentifier",
"preciseIdentifier": "c:I", "preciseIdentifier": "c:I",
"spelling": "int" "spelling": "int"
}, },
{ {
"kind": "text", "kind": "text",
"spelling": " *" "spelling": " * "
}, },
{ {
"kind": "internalParam", "kind": "internalParam",
"spelling": "res" "spelling": "res"
}, },
{ {
"kind": "text", "kind": "text",
"spelling": ")" "spelling": ")"
▲ Show 20 Lines • Show All 139 Lines • ▼ Show 20 Lines "symbols": [
"declarationFragments": [ "declarationFragments": [
{ {
"kind": "typeIdentifier", "kind": "typeIdentifier",
"preciseIdentifier": "c:I", "preciseIdentifier": "c:I",
"spelling": "int" "spelling": "int"
}, },
{ {
"kind": "text", "kind": "text",
"spelling": " *" "spelling": " * "
}, },
{ {
"kind": "internalParam", "kind": "internalParam",
"spelling": "res" "spelling": "res"
} }
], ],
"name": "res" "name": "res"
} }
Show All 39 Lines

clang/test/ExtractAPI/global_record_multifile.c

Show First 20 Lines • Show All 171 Lines • ▼ Show 20 Lines "symbols": [
}, },
{ {
"kind": "typeIdentifier", "kind": "typeIdentifier",
"preciseIdentifier": "c:I", "preciseIdentifier": "c:I",
"spelling": "int" "spelling": "int"
}, },
{ {
"kind": "text", "kind": "text",
"spelling": " *" "spelling": " * "
}, },
{ {
"kind": "internalParam", "kind": "internalParam",
"spelling": "res" "spelling": "res"
}, },
{ {
"kind": "text", "kind": "text",
"spelling": ")" "spelling": ")"
▲ Show 20 Lines • Show All 139 Lines • ▼ Show 20 Lines "symbols": [
"declarationFragments": [ "declarationFragments": [
{ {
"kind": "typeIdentifier", "kind": "typeIdentifier",
"preciseIdentifier": "c:I", "preciseIdentifier": "c:I",
"spelling": "int" "spelling": "int"
}, },
{ {
"kind": "text", "kind": "text",
"spelling": " *" "spelling": " * "
}, },
{ {
"kind": "internalParam", "kind": "internalParam",
"spelling": "res" "spelling": "res"
} }
], ],
"name": "res" "name": "res"
} }
Show All 39 Lines

clang/test/ExtractAPI/macro_undefined.c

Show First 20 Lines • Show All 136 Lines • ▼ Show 20 Lines "symbols": [
}, },
{ {
"kind": "typeIdentifier", "kind": "typeIdentifier",
"preciseIdentifier": "c:I", "preciseIdentifier": "c:I",
"spelling": "int" "spelling": "int"
}, },
{ {
"kind": "text", "kind": "text",
"spelling": " *" "spelling": " * "
}, },
{ {
"kind": "internalParam", "kind": "internalParam",
"spelling": "" "spelling": ""
}, },
{ {
"kind": "text", "kind": "text",
"spelling": ", " "spelling": ", "
Show All 30 Lines "symbols": [
}, },
{ {
"kind": "typeIdentifier", "kind": "typeIdentifier",
"preciseIdentifier": "c:I", "preciseIdentifier": "c:I",
"spelling": "int" "spelling": "int"
}, },
{ {
"kind": "text", "kind": "text",
"spelling": " *" "spelling": " * "
}, },
{ {
"kind": "internalParam", "kind": "internalParam",
"spelling": "" "spelling": ""
} }
], ],
"name": "" "name": ""
}, },
▲ Show 20 Lines • Show All 101 Lines • Show Last 20 Lines

clang/test/ExtractAPI/objc_category.m

Show First 20 Lines • Show All 125 Lines • ▼ Show 20 Lines "symbols": [
}, },
{ {
"kind": "typeIdentifier", "kind": "typeIdentifier",
"preciseIdentifier": "c:v", "preciseIdentifier": "c:v",
"spelling": "void" "spelling": "void"
}, },
{ {
"kind": "text", "kind": "text",
"spelling": ")" "spelling": ") "
}, },
{ {
"kind": "identifier", "kind": "identifier",
"spelling": "InstanceMethod" "spelling": "InstanceMethod"
} }
], ],
"identifier": { "identifier": {
"interfaceLanguage": "objective-c", "interfaceLanguage": "objective-c",
Show All 37 Lines "symbols": [
}, },
{ {
"kind": "typeIdentifier", "kind": "typeIdentifier",
"preciseIdentifier": "c:v", "preciseIdentifier": "c:v",
"spelling": "void" "spelling": "void"
}, },
{ {
"kind": "text", "kind": "text",
"spelling": ")" "spelling": ") "
}, },
{ {
"kind": "identifier", "kind": "identifier",
"spelling": "ClassMethod" "spelling": "ClassMethod"
} }
], ],
"identifier": { "identifier": {
"interfaceLanguage": "objective-c", "interfaceLanguage": "objective-c",
▲ Show 20 Lines • Show All 64 Lines • ▼ Show 20 Lines "symbols": [
"spelling": ", " "spelling": ", "
}, },
{ {
"kind": "keyword", "kind": "keyword",
"spelling": "readwrite" "spelling": "readwrite"
}, },
{ {
"kind": "text", "kind": "text",
"spelling": ")" "spelling": ") "
}, },
{ {
"kind": "typeIdentifier", "kind": "typeIdentifier",
"preciseIdentifier": "c:I", "preciseIdentifier": "c:I",
"spelling": "int" "spelling": "int"
}, },
{ {
"kind": "identifier", "kind": "identifier",
Show All 34 Lines

clang/test/ExtractAPI/objc_interface.m

Show First 20 Lines • Show All 136 Lines • ▼ Show 20 Lines "symbols": [
"spelling": "+ (" "spelling": "+ ("
}, },
{ {
"kind": "keyword", "kind": "keyword",
"spelling": "id" "spelling": "id"
}, },
{ {
"kind": "text", "kind": "text",
"spelling": ")" "spelling": ") "
}, },
{ {
"kind": "identifier", "kind": "identifier",
"spelling": "getWithProperty" "spelling": "getWithProperty"
}, },
{ {
"kind": "text", "kind": "text",
"spelling": ":" "spelling": ":"
}, },
{ {
"kind": "text", "kind": "text",
"spelling": "(" "spelling": "("
}, },
{ {
"kind": "typeIdentifier", "kind": "typeIdentifier",
"preciseIdentifier": "c:i", "preciseIdentifier": "c:i",
"spelling": "unsigned int" "spelling": "unsigned int"
}, },
{ {
"kind": "text", "kind": "text",
"spelling": ")" "spelling": ") "
}, },
{ {
"kind": "internalParam", "kind": "internalParam",
"spelling": "Property" "spelling": "Property"
} }
], ],
"identifier": { "identifier": {
"interfaceLanguage": "objective-c", "interfaceLanguage": "objective-c",
▲ Show 20 Lines • Show All 64 Lines • ▼ Show 20 Lines "symbols": [
"spelling": "=" "spelling": "="
}, },
{ {
"kind": "identifier", "kind": "identifier",
"spelling": "getProperty" "spelling": "getProperty"
}, },
{ {
"kind": "text", "kind": "text",
"spelling": ")" "spelling": ") "
}, },
{ {
"kind": "typeIdentifier", "kind": "typeIdentifier",
"preciseIdentifier": "c:i", "preciseIdentifier": "c:i",
"spelling": "unsigned int" "spelling": "unsigned int"
}, },
{ {
"kind": "identifier", "kind": "identifier",
▲ Show 20 Lines • Show All 137 Lines • ▼ Show 20 Lines "symbols": [
}, },
{ {
"kind": "typeIdentifier", "kind": "typeIdentifier",
"preciseIdentifier": "c:C", "preciseIdentifier": "c:C",
"spelling": "char" "spelling": "char"
}, },
{ {
"kind": "text", "kind": "text",
"spelling": ")" "spelling": ") "
}, },
{ {
"kind": "identifier", "kind": "identifier",
"spelling": "getIvar" "spelling": "getIvar"
} }
], ],
"identifier": { "identifier": {
"interfaceLanguage": "objective-c", "interfaceLanguage": "objective-c",
Show All 33 Lines