This is an archive of the discontinued LLVM Phabricator instance.

Differential D123391

[clang][extract-api] Emit "navigator" property of "name" in SymbolGraph
ClosedPublic

Authored by dang on Apr 8 2022, 7:59 AM.

Details

Reviewers
zixuw
QuietMisdreavus
Commits
rG80ae36659292: [clang][extract-api] Emit "navigator" property of "name" in SymbolGraph

Diff Detail

Event Timeline

dang created this revision.Apr 8 2022, 7:59 AM
Herald added a project: Restricted Project. · View Herald TranscriptApr 8 2022, 7:59 AM
dang requested review of this revision.Apr 8 2022, 7:59 AM
Herald added a project: Restricted Project. · View Herald TranscriptApr 8 2022, 7:59 AM
Herald added a subscriber: cfe-commits. · View Herald Transcript
QuietMisdreavus added a comment.Apr 8 2022, 8:20 AM

This looks good! Just one question.

clang/test/ExtractAPI/objc_interface.m
204

I'm curious: Does this properly handle Objective-C methods with multiple arguments? i.e. if there were a method setProperty:andOtherProperty:, would that be the navigator name?

Harbormaster completed remote builds in B158699: Diff 421526.Apr 8 2022, 8:35 AM
dang updated this revision to Diff 421537.Apr 8 2022, 8:44 AM

Add test to check that ObjC methods with multiple external parameters get the
correct name in subHeadings and navigator.

QuietMisdreavus accepted this revision.Apr 8 2022, 8:46 AM

Looks great, thanks!

This revision is now accepted and ready to land.Apr 8 2022, 8:46 AM
This revision was landed with ongoing or failed builds.Apr 8 2022, 9:29 AM
Closed by commit rG80ae36659292: [clang][extract-api] Emit "navigator" property of "name" in SymbolGraph (authored by dang). · Explain Why
This revision was automatically updated to reflect the committed changes.
dang added a commit: rG80ae36659292: [clang][extract-api] Emit "navigator" property of "name" in SymbolGraph.
Harbormaster completed remote builds in B158707: Diff 421537.Apr 8 2022, 9:39 AM

Revision Contents

PathSize
clang/
lib/
ExtractAPI/
Serialization/
7 lines
test/
ExtractAPI/
66 lines
12 lines
12 lines
6 lines
12 lines
12 lines
18 lines
36 lines
24 lines
154 lines
12 lines
30 lines
6 lines
18 lines
18 lines

Diff 421554

clang/lib/ExtractAPI/Serialization/SymbolGraphSerializer.cpp

//===- ExtractAPI/Serialization/SymbolGraphSerializer.cpp -------*- C++ -*-===// //===- ExtractAPI/Serialization/SymbolGraphSerializer.cpp -------*- C++ -*-===//
// //
// Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions. // Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions.
// See https://llvm.org/LICENSE.txt for license information. // See https://llvm.org/LICENSE.txt for license information.
// SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception // SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
// //
//===----------------------------------------------------------------------===// //===----------------------------------------------------------------------===//
/// ///
/// \file /// \file
/// This file implements the SymbolGraphSerializer. /// This file implements the SymbolGraphSerializer.
/// ///
//===----------------------------------------------------------------------===// //===----------------------------------------------------------------------===//
#include "clang/ExtractAPI/Serialization/SymbolGraphSerializer.h" #include "clang/ExtractAPI/Serialization/SymbolGraphSerializer.h"
#include "clang/Basic/Version.h" #include "clang/Basic/Version.h"
#include "clang/ExtractAPI/API.h" #include "clang/ExtractAPI/API.h"
#include "clang/ExtractAPI/DeclarationFragments.h"
#include "llvm/Support/JSON.h" #include "llvm/Support/JSON.h"
#include "llvm/Support/Path.h" #include "llvm/Support/Path.h"
#include "llvm/Support/VersionTuple.h" #include "llvm/Support/VersionTuple.h"
using namespace clang; using namespace clang;
using namespace clang::extractapi; using namespace clang::extractapi;
using namespace llvm; using namespace llvm;
using namespace llvm::json; using namespace llvm::json;
▲ Show 20 Lines • Show All 301 Lines • ▼ Show 20 Lines
/// - \c subHeading : An array of declaration fragments that provides tags, /// - \c subHeading : An array of declaration fragments that provides tags,
/// and potentially more tokens (for example the \c +/- symbol for /// and potentially more tokens (for example the \c +/- symbol for
/// Objective-C methods). Can be used as sub-headings for documentation. /// Objective-C methods). Can be used as sub-headings for documentation.
Object serializeNames(const APIRecord &Record) { Object serializeNames(const APIRecord &Record) {
Object Names; Object Names;
Names["title"] = Record.Name; Names["title"] = Record.Name;
serializeArray(Names, "subHeading", serializeArray(Names, "subHeading",
serializeDeclarationFragments(Record.SubHeading)); serializeDeclarationFragments(Record.SubHeading));
DeclarationFragments NavigatorFragments;
NavigatorFragments.append(Record.Name,
DeclarationFragments::FragmentKind::Identifier,
/*PreciseIdentifier*/ "");
serializeArray(Names, "navigator",
serializeDeclarationFragments(NavigatorFragments));
return Names; return Names;
} }
/// Serialize the symbol kind information. /// Serialize the symbol kind information.
/// ///
/// The Symbol Graph symbol kind property contains a shorthand \c identifier /// The Symbol Graph symbol kind property contains a shorthand \c identifier
/// which is prefixed by the source language name, useful for tooling to parse /// which is prefixed by the source language name, useful for tooling to parse
▲ Show 20 Lines • Show All 333 Lines • Show Last 20 Lines

clang/test/ExtractAPI/enum.c

Show First 20 Lines • Show All 155 Lines • ▼ Show 20 Lines "symbols": [
"location": { "location": {
"position": { "position": {
"character": 6, "character": 6,
"line": 2 "line": 2
}, },
"uri": "file://INPUT_DIR/input.h" "uri": "file://INPUT_DIR/input.h"
}, },
"names": { "names": {
"navigator": [
{
"kind": "identifier",
"spelling": "Vehicle"
}
],
"subHeading": [ "subHeading": [
{ {
"kind": "identifier", "kind": "identifier",
"spelling": "Vehicle" "spelling": "Vehicle"
} }
], ],
"title": "Vehicle" "title": "Vehicle"
}, },
Show All 20 Lines "symbols": [
"location": { "location": {
"position": { "position": {
"character": 3, "character": 3,
"line": 3 "line": 3
}, },
"uri": "file://INPUT_DIR/input.h" "uri": "file://INPUT_DIR/input.h"
}, },
"names": { "names": {
"navigator": [
{
"kind": "identifier",
"spelling": "Bicycle"
}
],
"subHeading": [ "subHeading": [
{ {
"kind": "identifier", "kind": "identifier",
"spelling": "Bicycle" "spelling": "Bicycle"
} }
], ],
"title": "Bicycle" "title": "Bicycle"
}, },
Show All 21 Lines "symbols": [
"location": { "location": {
"position": { "position": {
"character": 3, "character": 3,
"line": 4 "line": 4
}, },
"uri": "file://INPUT_DIR/input.h" "uri": "file://INPUT_DIR/input.h"
}, },
"names": { "names": {
"navigator": [
{
"kind": "identifier",
"spelling": "Car"
}
],
"subHeading": [ "subHeading": [
{ {
"kind": "identifier", "kind": "identifier",
"spelling": "Car" "spelling": "Car"
} }
], ],
"title": "Car" "title": "Car"
}, },
Show All 38 Lines "symbols": [
"location": { "location": {
"position": { "position": {
"character": 3, "character": 3,
"line": 5 "line": 5
}, },
"uri": "file://INPUT_DIR/input.h" "uri": "file://INPUT_DIR/input.h"
}, },
"names": { "names": {
"navigator": [
{
"kind": "identifier",
"spelling": "Train"
}
],
"subHeading": [ "subHeading": [
{ {
"kind": "identifier", "kind": "identifier",
"spelling": "Train" "spelling": "Train"
} }
], ],
"title": "Train" "title": "Train"
}, },
Show All 21 Lines "symbols": [
"location": { "location": {
"position": { "position": {
"character": 3, "character": 3,
"line": 6 "line": 6
}, },
"uri": "file://INPUT_DIR/input.h" "uri": "file://INPUT_DIR/input.h"
}, },
"names": { "names": {
"navigator": [
{
"kind": "identifier",
"spelling": "Ship"
}
],
"subHeading": [ "subHeading": [
{ {
"kind": "identifier", "kind": "identifier",
"spelling": "Ship" "spelling": "Ship"
} }
], ],
"title": "Ship" "title": "Ship"
}, },
Show All 21 Lines "symbols": [
"location": { "location": {
"position": { "position": {
"character": 3, "character": 3,
"line": 7 "line": 7
}, },
"uri": "file://INPUT_DIR/input.h" "uri": "file://INPUT_DIR/input.h"
}, },
"names": { "names": {
"navigator": [
{
"kind": "identifier",
"spelling": "Airplane"
}
],
"subHeading": [ "subHeading": [
{ {
"kind": "identifier", "kind": "identifier",
"spelling": "Airplane" "spelling": "Airplane"
} }
], ],
"title": "Airplane" "title": "Airplane"
}, },
Show All 38 Lines "symbols": [
"location": { "location": {
"position": { "position": {
"character": 6, "character": 6,
"line": 10 "line": 10
}, },
"uri": "file://INPUT_DIR/input.h" "uri": "file://INPUT_DIR/input.h"
}, },
"names": { "names": {
"navigator": [
{
"kind": "identifier",
"spelling": "Direction"
}
],
"subHeading": [ "subHeading": [
{ {
"kind": "identifier", "kind": "identifier",
"spelling": "Direction" "spelling": "Direction"
} }
], ],
"title": "Direction" "title": "Direction"
}, },
Show All 20 Lines "symbols": [
"location": { "location": {
"position": { "position": {
"character": 3, "character": 3,
"line": 11 "line": 11
}, },
"uri": "file://INPUT_DIR/input.h" "uri": "file://INPUT_DIR/input.h"
}, },
"names": { "names": {
"navigator": [
{
"kind": "identifier",
"spelling": "North"
}
],
"subHeading": [ "subHeading": [
{ {
"kind": "identifier", "kind": "identifier",
"spelling": "North" "spelling": "North"
} }
], ],
"title": "North" "title": "North"
}, },
Show All 21 Lines "symbols": [
"location": { "location": {
"position": { "position": {
"character": 3, "character": 3,
"line": 12 "line": 12
}, },
"uri": "file://INPUT_DIR/input.h" "uri": "file://INPUT_DIR/input.h"
}, },
"names": { "names": {
"navigator": [
{
"kind": "identifier",
"spelling": "East"
}
],
"subHeading": [ "subHeading": [
{ {
"kind": "identifier", "kind": "identifier",
"spelling": "East" "spelling": "East"
} }
], ],
"title": "East" "title": "East"
}, },
Show All 21 Lines "symbols": [
"location": { "location": {
"position": { "position": {
"character": 3, "character": 3,
"line": 13 "line": 13
}, },
"uri": "file://INPUT_DIR/input.h" "uri": "file://INPUT_DIR/input.h"
}, },
"names": { "names": {
"navigator": [
{
"kind": "identifier",
"spelling": "South"
}
],
"subHeading": [ "subHeading": [
{ {
"kind": "identifier", "kind": "identifier",
"spelling": "South" "spelling": "South"
} }
], ],
"title": "South" "title": "South"
}, },
Show All 21 Lines "symbols": [
"location": { "location": {
"position": { "position": {
"character": 3, "character": 3,
"line": 14 "line": 14
}, },
"uri": "file://INPUT_DIR/input.h" "uri": "file://INPUT_DIR/input.h"
}, },
"names": { "names": {
"navigator": [
{
"kind": "identifier",
"spelling": "West"
}
],
"subHeading": [ "subHeading": [
{ {
"kind": "identifier", "kind": "identifier",
"spelling": "West" "spelling": "West"
} }
], ],
"title": "West" "title": "West"
}, },
"pathComponents": [ "pathComponents": [
"Direction", "Direction",
"West" "West"
] ]
} }
] ]
} }

clang/test/ExtractAPI/global_record.c

Show First 20 Lines • Show All 80 Lines • ▼ Show 20 Lines "symbols": [
"location": { "location": {
"position": { "position": {
"character": 5, "character": 5,
"line": 1 "line": 1
}, },
"uri": "file://INPUT_DIR/input.h" "uri": "file://INPUT_DIR/input.h"
}, },
"names": { "names": {
"navigator": [
{
"kind": "identifier",
"spelling": "num"
}
],
"subHeading": [ "subHeading": [
{ {
"kind": "identifier", "kind": "identifier",
"spelling": "num" "spelling": "num"
} }
], ],
"title": "num" "title": "num"
}, },
▲ Show 20 Lines • Show All 263 Lines • ▼ Show 20 Lines "symbols": [
"location": { "location": {
"position": { "position": {
"character": 6, "character": 6,
"line": 9 "line": 9
}, },
"uri": "file://INPUT_DIR/input.h" "uri": "file://INPUT_DIR/input.h"
}, },
"names": { "names": {
"navigator": [
{
"kind": "identifier",
"spelling": "add"
}
],
"subHeading": [ "subHeading": [
{ {
"kind": "identifier", "kind": "identifier",
"spelling": "add" "spelling": "add"
} }
], ],
"title": "add" "title": "add"
}, },
"pathComponents": [ "pathComponents": [
"add" "add"
] ]
} }
] ]
} }

clang/test/ExtractAPI/global_record_multifile.c

Show First 20 Lines • Show All 82 Lines • ▼ Show 20 Lines "symbols": [
"location": { "location": {
"position": { "position": {
"character": 5, "character": 5,
"line": 1 "line": 1
}, },
"uri": "file://INPUT_DIR/input1.h" "uri": "file://INPUT_DIR/input1.h"
}, },
"names": { "names": {
"navigator": [
{
"kind": "identifier",
"spelling": "num"
}
],
"subHeading": [ "subHeading": [
{ {
"kind": "identifier", "kind": "identifier",
"spelling": "num" "spelling": "num"
} }
], ],
"title": "num" "title": "num"
}, },
▲ Show 20 Lines • Show All 263 Lines • ▼ Show 20 Lines "symbols": [
"location": { "location": {
"position": { "position": {
"character": 6, "character": 6,
"line": 7 "line": 7
}, },
"uri": "file://INPUT_DIR/input2.h" "uri": "file://INPUT_DIR/input2.h"
}, },
"names": { "names": {
"navigator": [
{
"kind": "identifier",
"spelling": "add"
}
],
"subHeading": [ "subHeading": [
{ {
"kind": "identifier", "kind": "identifier",
"spelling": "add" "spelling": "add"
} }
], ],
"title": "add" "title": "add"
}, },
"pathComponents": [ "pathComponents": [
"add" "add"
] ]
} }
] ]
} }

clang/test/ExtractAPI/known_files_only.c

Show First 20 Lines • Show All 78 Lines • ▼ Show 20 Lines "symbols": [
"location": { "location": {
"position": { "position": {
"character": 5, "character": 5,
"line": 1 "line": 1
}, },
"uri": "file://INPUT_DIR/input1.h" "uri": "file://INPUT_DIR/input1.h"
}, },
"names": { "names": {
"navigator": [
{
"kind": "identifier",
"spelling": "num"
}
],
"subHeading": [ "subHeading": [
{ {
"kind": "identifier", "kind": "identifier",
"spelling": "num" "spelling": "num"
} }
], ],
"title": "num" "title": "num"
}, },
"pathComponents": [ "pathComponents": [
"num" "num"
] ]
} }
] ]
} }

clang/test/ExtractAPI/known_files_only_hmap.c

Show First 20 Lines • Show All 97 Lines • ▼ Show 20 Lines "symbols": [
"location": { "location": {
"position": { "position": {
"character": 5, "character": 5,
"line": 1 "line": 1
}, },
"uri": "file://INPUT_DIR/subdir/subdir1/input.h" "uri": "file://INPUT_DIR/subdir/subdir1/input.h"
}, },
"names": { "names": {
"navigator": [
{
"kind": "identifier",
"spelling": "num"
}
],
"subHeading": [ "subHeading": [
{ {
"kind": "identifier", "kind": "identifier",
"spelling": "num" "spelling": "num"
} }
], ],
"title": "num" "title": "num"
}, },
Show All 29 Lines "symbols": [
"location": { "location": {
"position": { "position": {
"character": 5, "character": 5,
"line": 1 "line": 1
}, },
"uri": "file://INPUT_DIR/subdir/subdir2/known_file.h" "uri": "file://INPUT_DIR/subdir/subdir2/known_file.h"
}, },
"names": { "names": {
"navigator": [
{
"kind": "identifier",
"spelling": "known_num"
}
],
"subHeading": [ "subHeading": [
{ {
"kind": "identifier", "kind": "identifier",
"spelling": "known_num" "spelling": "known_num"
} }
], ],
"title": "known_num" "title": "known_num"
}, },
"pathComponents": [ "pathComponents": [
"known_num" "known_num"
] ]
} }
] ]
} }

clang/test/ExtractAPI/language.c

Show First 20 Lines • Show All 82 Lines • ▼ Show 20 Lines "symbols": [
"location": { "location": {
"position": { "position": {
"character": 6, "character": 6,
"line": 1 "line": 1
}, },
"uri": "file://INPUT_DIR/c.h" "uri": "file://INPUT_DIR/c.h"
}, },
"names": { "names": {
"navigator": [
{
"kind": "identifier",
"spelling": "c"
}
],
"subHeading": [ "subHeading": [
{ {
"kind": "identifier", "kind": "identifier",
"spelling": "c" "spelling": "c"
} }
], ],
"title": "c" "title": "c"
}, },
▲ Show 20 Lines • Show All 58 Lines • ▼ Show 20 Lines "symbols": [
"location": { "location": {
"position": { "position": {
"character": 6, "character": 6,
"line": 1 "line": 1
}, },
"uri": "file://INPUT_DIR/objc.h" "uri": "file://INPUT_DIR/objc.h"
}, },
"names": { "names": {
"navigator": [
{
"kind": "identifier",
"spelling": "objc"
}
],
"subHeading": [ "subHeading": [
{ {
"kind": "identifier", "kind": "identifier",
"spelling": "objc" "spelling": "objc"
} }
], ],
"title": "objc" "title": "objc"
}, },
"pathComponents": [ "pathComponents": [
"objc" "objc"
] ]
} }
] ]
} }

clang/test/ExtractAPI/macro_undefined.c

Show First 20 Lines • Show All 89 Lines • ▼ Show 20 Lines "symbols": [
"location": { "location": {
"position": { "position": {
"character": 1, "character": 1,
"line": 3 "line": 3
}, },
"uri": "file://INPUT_DIR/input.h" "uri": "file://INPUT_DIR/input.h"
}, },
"names": { "names": {
"navigator": [
{
"kind": "identifier",
"spelling": "foo"
}
],
"subHeading": [ "subHeading": [
{ {
"kind": "identifier", "kind": "identifier",
"spelling": "foo" "spelling": "foo"
} }
], ],
"title": "foo" "title": "foo"
}, },
▲ Show 20 Lines • Show All 130 Lines • ▼ Show 20 Lines "symbols": [
"location": { "location": {
"position": { "position": {
"character": 1, "character": 1,
"line": 4 "line": 4
}, },
"uri": "file://INPUT_DIR/input.h" "uri": "file://INPUT_DIR/input.h"
}, },
"names": { "names": {
"navigator": [
{
"kind": "identifier",
"spelling": "bar"
}
],
"subHeading": [ "subHeading": [
{ {
"kind": "identifier", "kind": "identifier",
"spelling": "bar" "spelling": "bar"
} }
], ],
"title": "bar" "title": "bar"
}, },
Show All 28 Lines "symbols": [
"location": { "location": {
"position": { "position": {
"character": 9, "character": 9,
"line": 1 "line": 1
}, },
"uri": "file://INPUT_DIR/input.h" "uri": "file://INPUT_DIR/input.h"
}, },
"names": { "names": {
"navigator": [
{
"kind": "identifier",
"spelling": "HELLO"
}
],
"subHeading": [ "subHeading": [
{ {
"kind": "identifier", "kind": "identifier",
"spelling": "HELLO" "spelling": "HELLO"
} }
], ],
"title": "HELLO" "title": "HELLO"
}, },
"pathComponents": [ "pathComponents": [
"HELLO" "HELLO"
] ]
} }
] ]
} }

clang/test/ExtractAPI/macros.c

Show First 20 Lines • Show All 74 Lines • ▼ Show 20 Lines "symbols": [
"location": { "location": {
"position": { "position": {
"character": 9, "character": 9,
"line": 1 "line": 1
}, },
"uri": "file://INPUT_DIR/input.h" "uri": "file://INPUT_DIR/input.h"
}, },
"names": { "names": {
"navigator": [
{
"kind": "identifier",
"spelling": "HELLO"
}
],
"subHeading": [ "subHeading": [
{ {
"kind": "identifier", "kind": "identifier",
"spelling": "HELLO" "spelling": "HELLO"
} }
], ],
"title": "HELLO" "title": "HELLO"
}, },
Show All 28 Lines "symbols": [
"location": { "location": {
"position": { "position": {
"character": 9, "character": 9,
"line": 2 "line": 2
}, },
"uri": "file://INPUT_DIR/input.h" "uri": "file://INPUT_DIR/input.h"
}, },
"names": { "names": {
"navigator": [
{
"kind": "identifier",
"spelling": "WORLD"
}
],
"subHeading": [ "subHeading": [
{ {
"kind": "identifier", "kind": "identifier",
"spelling": "WORLD" "spelling": "WORLD"
} }
], ],
"title": "WORLD" "title": "WORLD"
}, },
Show All 40 Lines "symbols": [
"location": { "location": {
"position": { "position": {
"character": 9, "character": 9,
"line": 3 "line": 3
}, },
"uri": "file://INPUT_DIR/input.h" "uri": "file://INPUT_DIR/input.h"
}, },
"names": { "names": {
"navigator": [
{
"kind": "identifier",
"spelling": "MACRO_FUN"
}
],
"subHeading": [ "subHeading": [
{ {
"kind": "identifier", "kind": "identifier",
"spelling": "MACRO_FUN" "spelling": "MACRO_FUN"
} }
], ],
"title": "MACRO_FUN" "title": "MACRO_FUN"
}, },
▲ Show 20 Lines • Show All 56 Lines • ▼ Show 20 Lines "symbols": [
"location": { "location": {
"position": { "position": {
"character": 9, "character": 9,
"line": 4 "line": 4
}, },
"uri": "file://INPUT_DIR/input.h" "uri": "file://INPUT_DIR/input.h"
}, },
"names": { "names": {
"navigator": [
{
"kind": "identifier",
"spelling": "FUN"
}
],
"subHeading": [ "subHeading": [
{ {
"kind": "identifier", "kind": "identifier",
"spelling": "FUN" "spelling": "FUN"
} }
], ],
"title": "FUN" "title": "FUN"
}, },
Show All 40 Lines "symbols": [
"location": { "location": {
"position": { "position": {
"character": 9, "character": 9,
"line": 5 "line": 5
}, },
"uri": "file://INPUT_DIR/input.h" "uri": "file://INPUT_DIR/input.h"
}, },
"names": { "names": {
"navigator": [
{
"kind": "identifier",
"spelling": "FUNC99"
}
],
"subHeading": [ "subHeading": [
{ {
"kind": "identifier", "kind": "identifier",
"spelling": "FUNC99" "spelling": "FUNC99"
} }
], ],
"title": "FUNC99" "title": "FUNC99"
}, },
Show All 40 Lines "symbols": [
"location": { "location": {
"position": { "position": {
"character": 9, "character": 9,
"line": 6 "line": 6
}, },
"uri": "file://INPUT_DIR/input.h" "uri": "file://INPUT_DIR/input.h"
}, },
"names": { "names": {
"navigator": [
{
"kind": "identifier",
"spelling": "FUNGNU"
}
],
"subHeading": [ "subHeading": [
{ {
"kind": "identifier", "kind": "identifier",
"spelling": "FUNGNU" "spelling": "FUNGNU"
} }
], ],
"title": "FUNGNU" "title": "FUNGNU"
}, },
"pathComponents": [ "pathComponents": [
"FUNGNU" "FUNGNU"
] ]
} }
] ]
} }

clang/test/ExtractAPI/objc_category.m

Show First 20 Lines • Show All 99 Lines • ▼ Show 20 Lines "symbols": [
"location": { "location": {
"position": { "position": {
"character": 12, "character": 12,
"line": 3 "line": 3
}, },
"uri": "file://INPUT_DIR/input.h" "uri": "file://INPUT_DIR/input.h"
}, },
"names": { "names": {
"navigator": [
{
"kind": "identifier",
"spelling": "Interface"
}
],
"subHeading": [ "subHeading": [
{ {
"kind": "identifier", "kind": "identifier",
"spelling": "Interface" "spelling": "Interface"
} }
], ],
"title": "Interface" "title": "Interface"
}, },
Show All 37 Lines "symbols": [
"location": { "location": {
"position": { "position": {
"character": 1, "character": 1,
"line": 8 "line": 8
}, },
"uri": "file://INPUT_DIR/input.h" "uri": "file://INPUT_DIR/input.h"
}, },
"names": { "names": {
"navigator": [
{
"kind": "identifier",
"spelling": "InstanceMethod"
}
],
"subHeading": [ "subHeading": [
{ {
"kind": "text", "kind": "text",
"spelling": "- " "spelling": "- "
}, },
{ {
"kind": "identifier", "kind": "identifier",
"spelling": "InstanceMethod" "spelling": "InstanceMethod"
▲ Show 20 Lines • Show All 42 Lines • ▼ Show 20 Lines "symbols": [
"location": { "location": {
"position": { "position": {
"character": 1, "character": 1,
"line": 9 "line": 9
}, },
"uri": "file://INPUT_DIR/input.h" "uri": "file://INPUT_DIR/input.h"
}, },
"names": { "names": {
"navigator": [
{
"kind": "identifier",
"spelling": "ClassMethod"
}
],
"subHeading": [ "subHeading": [
{ {
"kind": "text", "kind": "text",
"spelling": "+ " "spelling": "+ "
}, },
{ {
"kind": "identifier", "kind": "identifier",
"spelling": "ClassMethod" "spelling": "ClassMethod"
▲ Show 20 Lines • Show All 70 Lines • ▼ Show 20 Lines "symbols": [
"location": { "location": {
"position": { "position": {
"character": 15, "character": 15,
"line": 7 "line": 7
}, },
"uri": "file://INPUT_DIR/input.h" "uri": "file://INPUT_DIR/input.h"
}, },
"names": { "names": {
"navigator": [
{
"kind": "identifier",
"spelling": "Property"
}
],
"subHeading": [ "subHeading": [
{ {
"kind": "identifier", "kind": "identifier",
"spelling": "Property" "spelling": "Property"
} }
], ],
"title": "Property" "title": "Property"
}, },
"pathComponents": [ "pathComponents": [
"Interface", "Interface",
"Property" "Property"
] ]
} }
] ]
} }

clang/test/ExtractAPI/objc_interface.m

Show All 13 Lines
// CHECK-NOT: warning: // CHECK-NOT: warning:
//--- input.h //--- input.h
@protocol Protocol; @protocol Protocol;
@interface Super <Protocol> @interface Super <Protocol>
@property(readonly, getter=getProperty) unsigned Property; @property(readonly, getter=getProperty) unsigned Property;
+ (id)getWithProperty:(unsigned) Property; + (id)getWithProperty:(unsigned) Property;
- (void)setProperty:(unsigned) Property andOtherThing: (unsigned) Thing;
@end @end
@interface Derived : Super { @interface Derived : Super {
char Ivar; char Ivar;
} }
- (char)getIvar; - (char)getIvar;
@end @end
Show All 25 Lines//--- reference.output.json.in
"relationships": [ "relationships": [
{ {
"kind": "memberOf", "kind": "memberOf",
"source": "c:objc(cs)Super(cm)getWithProperty:", "source": "c:objc(cs)Super(cm)getWithProperty:",
"target": "c:objc(cs)Super" "target": "c:objc(cs)Super"
}, },
{ {
"kind": "memberOf", "kind": "memberOf",
"source": "c:objc(cs)Super(im)setProperty:andOtherThing:",
"target": "c:objc(cs)Super"
},
{
"kind": "memberOf",
"source": "c:objc(cs)Super(py)Property", "source": "c:objc(cs)Super(py)Property",
"target": "c:objc(cs)Super" "target": "c:objc(cs)Super"
}, },
{ {
"kind": "conformsTo", "kind": "conformsTo",
"source": "c:objc(cs)Super", "source": "c:objc(cs)Super",
"target": "c:objc(pl)Protocol" "target": "c:objc(pl)Protocol"
}, },
▲ Show 20 Lines • Show All 41 Lines • ▼ Show 20 Lines "symbols": [
"location": { "location": {
"position": { "position": {
"character": 12, "character": 12,
"line": 3 "line": 3
}, },
"uri": "file://INPUT_DIR/input.h" "uri": "file://INPUT_DIR/input.h"
}, },
"names": { "names": {
"navigator": [
{
"kind": "identifier",
"spelling": "Super"
}
],
"subHeading": [ "subHeading": [
{ {
"kind": "identifier", "kind": "identifier",
"spelling": "Super" "spelling": "Super"
} }
], ],
"title": "Super" "title": "Super"
}, },
▲ Show 20 Lines • Show All 53 Lines • ▼ Show 20 Lines "symbols": [
"location": { "location": {
"position": { "position": {
"character": 1, "character": 1,
"line": 5 "line": 5
}, },
"uri": "file://INPUT_DIR/input.h" "uri": "file://INPUT_DIR/input.h"
}, },
"names": { "names": {
"navigator": [
{
"kind": "identifier",
"spelling": "getWithProperty:"
QuietMisdreavusUnsubmitted
Not Done
ReplyInline Actions

I'm curious: Does this properly handle Objective-C methods with multiple arguments? i.e. if there were a method setProperty:andOtherProperty:, would that be the navigator name?

QuietMisdreavus: I'm curious: Does this properly handle Objective-C methods with multiple arguments? i.e. if…
}
],
"subHeading": [ "subHeading": [
{ {
"kind": "text", "kind": "text",
"spelling": "+ " "spelling": "+ "
}, },
{ {
"kind": "identifier", "kind": "identifier",
"spelling": "getWithProperty:" "spelling": "getWithProperty:"
} }
], ],
"title": "getWithProperty:" "title": "getWithProperty:"
}, },
"pathComponents": [ "pathComponents": [
"Super", "Super",
"getWithProperty:" "getWithProperty:"
] ]
}, },
{ {
"accessLevel": "public", "accessLevel": "public",
"declarationFragments": [ "declarationFragments": [
{ {
"kind": "text",
"spelling": "- ("
},
{
"kind": "typeIdentifier",
"preciseIdentifier": "c:v",
"spelling": "void"
},
{
"kind": "text",
"spelling": ") "
},
{
"kind": "identifier",
"spelling": "setProperty:"
},
{
"kind": "text",
"spelling": "("
},
{
"kind": "typeIdentifier",
"preciseIdentifier": "c:i",
"spelling": "unsigned int"
},
{
"kind": "text",
"spelling": ") "
},
{
"kind": "internalParam",
"spelling": "Property"
},
{
"kind": "text",
"spelling": " "
},
{
"kind": "identifier",
"spelling": "andOtherThing:"
},
{
"kind": "text",
"spelling": "("
},
{
"kind": "typeIdentifier",
"preciseIdentifier": "c:i",
"spelling": "unsigned int"
},
{
"kind": "text",
"spelling": ") "
},
{
"kind": "internalParam",
"spelling": "Thing"
},
{
"kind": "text",
"spelling": ";"
}
],
"identifier": {
"interfaceLanguage": "objective-c",
"precise": "c:objc(cs)Super(im)setProperty:andOtherThing:"
},
"kind": {
"displayName": "Instance Method",
"identifier": "objective-c.method"
},
"location": {
"position": {
"character": 1,
"line": 6
},
"uri": "file://INPUT_DIR/input.h"
},
"names": {
"navigator": [
{
"kind": "identifier",
"spelling": "setProperty:andOtherThing:"
}
],
"subHeading": [
{
"kind": "text",
"spelling": "- "
},
{
"kind": "identifier",
"spelling": "setProperty:andOtherThing:"
}
],
"title": "setProperty:andOtherThing:"
},
"pathComponents": [
"Super",
"setProperty:andOtherThing:"
]
},
{
"accessLevel": "public",
"declarationFragments": [
{
"kind": "keyword", "kind": "keyword",
"spelling": "@property" "spelling": "@property"
}, },
{ {
"kind": "text", "kind": "text",
"spelling": " (" "spelling": " ("
}, },
{ {
▲ Show 20 Lines • Show All 49 Lines • ▼ Show 20 Lines "symbols": [
"location": { "location": {
"position": { "position": {
"character": 50, "character": 50,
"line": 4 "line": 4
}, },
"uri": "file://INPUT_DIR/input.h" "uri": "file://INPUT_DIR/input.h"
}, },
"names": { "names": {
"navigator": [
{
"kind": "identifier",
"spelling": "Property"
}
],
"subHeading": [ "subHeading": [
{ {
"kind": "identifier", "kind": "identifier",
"spelling": "Property" "spelling": "Property"
} }
], ],
"title": "Property" "title": "Property"
}, },
Show All 33 Lines "symbols": [
}, },
"kind": { "kind": {
"displayName": "Class", "displayName": "Class",
"identifier": "objective-c.class" "identifier": "objective-c.class"
}, },
"location": { "location": {
"position": { "position": {
"character": 12, "character": 12,
"line": 8 "line": 9
}, },
"uri": "file://INPUT_DIR/input.h" "uri": "file://INPUT_DIR/input.h"
}, },
"names": { "names": {
"navigator": [
{
"kind": "identifier",
"spelling": "Derived"
}
],
"subHeading": [ "subHeading": [
{ {
"kind": "identifier", "kind": "identifier",
"spelling": "Derived" "spelling": "Derived"
} }
], ],
"title": "Derived" "title": "Derived"
}, },
Show All 24 Lines "symbols": [
}, },
"kind": { "kind": {
"displayName": "Instance Variable", "displayName": "Instance Variable",
"identifier": "objective-c.ivar" "identifier": "objective-c.ivar"
}, },
"location": { "location": {
"position": { "position": {
"character": 8, "character": 8,
"line": 9 "line": 10
}, },
"uri": "file://INPUT_DIR/input.h" "uri": "file://INPUT_DIR/input.h"
}, },
"names": { "names": {
"navigator": [
{
"kind": "identifier",
"spelling": "Ivar"
}
],
"subHeading": [ "subHeading": [
{ {
"kind": "identifier", "kind": "identifier",
"spelling": "Ivar" "spelling": "Ivar"
} }
], ],
"title": "Ivar" "title": "Ivar"
}, },
Show All 33 Lines "symbols": [
}, },
"kind": { "kind": {
"displayName": "Instance Method", "displayName": "Instance Method",
"identifier": "objective-c.method" "identifier": "objective-c.method"
}, },
"location": { "location": {
"position": { "position": {
"character": 1, "character": 1,
"line": 11 "line": 12
}, },
"uri": "file://INPUT_DIR/input.h" "uri": "file://INPUT_DIR/input.h"
}, },
"names": { "names": {
"navigator": [
{
"kind": "identifier",
"spelling": "getIvar"
}
],
"subHeading": [ "subHeading": [
{ {
"kind": "text", "kind": "text",
"spelling": "- " "spelling": "- "
}, },
{ {
"kind": "identifier", "kind": "identifier",
"spelling": "getIvar" "spelling": "getIvar"
Show All 11 Lines

clang/test/ExtractAPI/objc_protocol.m

Show First 20 Lines • Show All 79 Lines • ▼ Show 20 Lines "symbols": [
"location": { "location": {
"position": { "position": {
"character": 11, "character": 11,
"line": 1 "line": 1
}, },
"uri": "file://INPUT_DIR/input.h" "uri": "file://INPUT_DIR/input.h"
}, },
"names": { "names": {
"navigator": [
{
"kind": "identifier",
"spelling": "Protocol"
}
],
"subHeading": [ "subHeading": [
{ {
"kind": "identifier", "kind": "identifier",
"spelling": "Protocol" "spelling": "Protocol"
} }
], ],
"title": "Protocol" "title": "Protocol"
}, },
▲ Show 20 Lines • Show All 41 Lines • ▼ Show 20 Lines "symbols": [
"location": { "location": {
"position": { "position": {
"character": 11, "character": 11,
"line": 4 "line": 4
}, },
"uri": "file://INPUT_DIR/input.h" "uri": "file://INPUT_DIR/input.h"
}, },
"names": { "names": {
"navigator": [
{
"kind": "identifier",
"spelling": "AnotherProtocol"
}
],
"subHeading": [ "subHeading": [
{ {
"kind": "identifier", "kind": "identifier",
"spelling": "AnotherProtocol" "spelling": "AnotherProtocol"
} }
], ],
"title": "AnotherProtocol" "title": "AnotherProtocol"
}, },
"pathComponents": [ "pathComponents": [
"AnotherProtocol" "AnotherProtocol"
] ]
} }
] ]
} }

clang/test/ExtractAPI/struct.c

Show First 20 Lines • Show All 114 Lines • ▼ Show 20 Lines "symbols": [
"location": { "location": {
"position": { "position": {
"character": 8, "character": 8,
"line": 2 "line": 2
}, },
"uri": "file://INPUT_DIR/input.h" "uri": "file://INPUT_DIR/input.h"
}, },
"names": { "names": {
"navigator": [
{
"kind": "identifier",
"spelling": "Color"
}
],
"subHeading": [ "subHeading": [
{ {
"kind": "identifier", "kind": "identifier",
"spelling": "Color" "spelling": "Color"
} }
], ],
"title": "Color" "title": "Color"
}, },
Show All 29 Lines "symbols": [
"location": { "location": {
"position": { "position": {
"character": 12, "character": 12,
"line": 3 "line": 3
}, },
"uri": "file://INPUT_DIR/input.h" "uri": "file://INPUT_DIR/input.h"
}, },
"names": { "names": {
"navigator": [
{
"kind": "identifier",
"spelling": "Red"
}
],
"subHeading": [ "subHeading": [
{ {
"kind": "identifier", "kind": "identifier",
"spelling": "Red" "spelling": "Red"
} }
], ],
"title": "Red" "title": "Red"
}, },
Show All 30 Lines "symbols": [
"location": { "location": {
"position": { "position": {
"character": 12, "character": 12,
"line": 4 "line": 4
}, },
"uri": "file://INPUT_DIR/input.h" "uri": "file://INPUT_DIR/input.h"
}, },
"names": { "names": {
"navigator": [
{
"kind": "identifier",
"spelling": "Green"
}
],
"subHeading": [ "subHeading": [
{ {
"kind": "identifier", "kind": "identifier",
"spelling": "Green" "spelling": "Green"
} }
], ],
"title": "Green" "title": "Green"
}, },
Show All 30 Lines "symbols": [
"location": { "location": {
"position": { "position": {
"character": 12, "character": 12,
"line": 5 "line": 5
}, },
"uri": "file://INPUT_DIR/input.h" "uri": "file://INPUT_DIR/input.h"
}, },
"names": { "names": {
"navigator": [
{
"kind": "identifier",
"spelling": "Blue"
}
],
"subHeading": [ "subHeading": [
{ {
"kind": "identifier", "kind": "identifier",
"spelling": "Blue" "spelling": "Blue"
} }
], ],
"title": "Blue" "title": "Blue"
}, },
▲ Show 20 Lines • Show All 47 Lines • ▼ Show 20 Lines "symbols": [
"location": { "location": {
"position": { "position": {
"character": 12, "character": 12,
"line": 7 "line": 7
}, },
"uri": "file://INPUT_DIR/input.h" "uri": "file://INPUT_DIR/input.h"
}, },
"names": { "names": {
"navigator": [
{
"kind": "identifier",
"spelling": "Alpha"
}
],
"subHeading": [ "subHeading": [
{ {
"kind": "identifier", "kind": "identifier",
"spelling": "Alpha" "spelling": "Alpha"
} }
], ],
"title": "Alpha" "title": "Alpha"
}, },
"pathComponents": [ "pathComponents": [
"Color", "Color",
"Alpha" "Alpha"
] ]
} }
] ]
} }

clang/test/ExtractAPI/typedef.c

Show First 20 Lines • Show All 78 Lines • ▼ Show 20 Lines "symbols": [
"location": { "location": {
"position": { "position": {
"character": 13, "character": 13,
"line": 1 "line": 1
}, },
"uri": "file://INPUT_DIR/input.h" "uri": "file://INPUT_DIR/input.h"
}, },
"names": { "names": {
"navigator": [
{
"kind": "identifier",
"spelling": "MyInt"
}
],
"subHeading": [ "subHeading": [
{ {
"kind": "identifier", "kind": "identifier",
"spelling": "MyInt" "spelling": "MyInt"
} }
], ],
"title": "MyInt" "title": "MyInt"
}, },
"pathComponents": [ "pathComponents": [
"MyInt" "MyInt"
], ],
"type": "c:I" "type": "c:I"
} }
] ]
} }

clang/test/ExtractAPI/typedef_anonymous_record.c

Show First 20 Lines • Show All 79 Lines • ▼ Show 20 Lines "symbols": [
"location": { "location": {
"position": { "position": {
"character": 9, "character": 9,
"line": 1 "line": 1
}, },
"uri": "file://INPUT_DIR/input.h" "uri": "file://INPUT_DIR/input.h"
}, },
"names": { "names": {
"navigator": [
{
"kind": "identifier",
"spelling": "MyStruct"
}
],
"title": "MyStruct" "title": "MyStruct"
}, },
"pathComponents": [ "pathComponents": [
"MyStruct" "MyStruct"
] ]
}, },
{ {
"accessLevel": "public", "accessLevel": "public",
Show All 31 Lines "symbols": [
"location": { "location": {
"position": { "position": {
"character": 18, "character": 18,
"line": 2 "line": 2
}, },
"uri": "file://INPUT_DIR/input.h" "uri": "file://INPUT_DIR/input.h"
}, },
"names": { "names": {
"navigator": [
{
"kind": "identifier",
"spelling": "MyStructStruct"
}
],
"subHeading": [ "subHeading": [
{ {
"kind": "identifier", "kind": "identifier",
"spelling": "MyStructStruct" "spelling": "MyStructStruct"
} }
], ],
"title": "MyStructStruct" "title": "MyStructStruct"
}, },
Show All 38 Lines "symbols": [
"location": { "location": {
"position": { "position": {
"character": 24, "character": 24,
"line": 3 "line": 3
}, },
"uri": "file://INPUT_DIR/input.h" "uri": "file://INPUT_DIR/input.h"
}, },
"names": { "names": {
"navigator": [
{
"kind": "identifier",
"spelling": "MyStructStructStruct"
}
],
"subHeading": [ "subHeading": [
{ {
"kind": "identifier", "kind": "identifier",
"spelling": "MyStructStructStruct" "spelling": "MyStructStructStruct"
} }
], ],
"title": "MyStructStructStruct" "title": "MyStructStructStruct"
}, },
"pathComponents": [ "pathComponents": [
"MyStructStructStruct" "MyStructStructStruct"
], ],
"type": "c:input.h@T@MyStructStruct" "type": "c:input.h@T@MyStructStruct"
} }
] ]
} }

clang/test/ExtractAPI/typedef_chain.c

Show First 20 Lines • Show All 80 Lines • ▼ Show 20 Lines "symbols": [
"location": { "location": {
"position": { "position": {
"character": 13, "character": 13,
"line": 1 "line": 1
}, },
"uri": "file://INPUT_DIR/input.h" "uri": "file://INPUT_DIR/input.h"
}, },
"names": { "names": {
"navigator": [
{
"kind": "identifier",
"spelling": "MyInt"
}
],
"subHeading": [ "subHeading": [
{ {
"kind": "identifier", "kind": "identifier",
"spelling": "MyInt" "spelling": "MyInt"
} }
], ],
"title": "MyInt" "title": "MyInt"
}, },
Show All 38 Lines "symbols": [
"location": { "location": {
"position": { "position": {
"character": 15, "character": 15,
"line": 2 "line": 2
}, },
"uri": "file://INPUT_DIR/input.h" "uri": "file://INPUT_DIR/input.h"
}, },
"names": { "names": {
"navigator": [
{
"kind": "identifier",
"spelling": "MyIntInt"
}
],
"subHeading": [ "subHeading": [
{ {
"kind": "identifier", "kind": "identifier",
"spelling": "MyIntInt" "spelling": "MyIntInt"
} }
], ],
"title": "MyIntInt" "title": "MyIntInt"
}, },
Show All 38 Lines "symbols": [
"location": { "location": {
"position": { "position": {
"character": 18, "character": 18,
"line": 3 "line": 3
}, },
"uri": "file://INPUT_DIR/input.h" "uri": "file://INPUT_DIR/input.h"
}, },
"names": { "names": {
"navigator": [
{
"kind": "identifier",
"spelling": "MyIntIntInt"
}
],
"subHeading": [ "subHeading": [
{ {
"kind": "identifier", "kind": "identifier",
"spelling": "MyIntIntInt" "spelling": "MyIntIntInt"
} }
], ],
"title": "MyIntIntInt" "title": "MyIntIntInt"
}, },
"pathComponents": [ "pathComponents": [
"MyIntIntInt" "MyIntIntInt"
], ],
"type": "c:input.h@T@MyIntInt" "type": "c:input.h@T@MyIntInt"
} }
] ]
} }