clang  19.0.0git
FileIndexRecord.cpp
Go to the documentation of this file.
1 //===--- FileIndexRecord.cpp - Index data per file --------------*- C++ -*-===//
2 //
3 // Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions.
4 // See https://llvm.org/LICENSE.txt for license information.
5 // SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
6 //
7 //===----------------------------------------------------------------------===//
8 
9 #include "FileIndexRecord.h"
10 #include "clang/AST/ASTContext.h"
11 #include "clang/AST/DeclTemplate.h"
13 #include "llvm/ADT/SmallString.h"
14 #include "llvm/Support/Path.h"
15 
16 using namespace clang;
17 using namespace clang::index;
18 
21  if (!IsSorted) {
22  llvm::stable_sort(Decls,
23  [](const DeclOccurrence &A, const DeclOccurrence &B) {
24  return A.Offset < B.Offset;
25  });
26  IsSorted = true;
27  }
28  return Decls;
29 }
30 
32  const Decl *D,
33  ArrayRef<SymbolRelation> Relations) {
34  assert(D->isCanonicalDecl() &&
35  "Occurrences should be associated with their canonical decl");
36  IsSorted = false;
37  Decls.emplace_back(Roles, Offset, D, Relations);
38 }
39 
41  const IdentifierInfo *Name,
42  const MacroInfo *MI) {
43  IsSorted = false;
44  Decls.emplace_back(Roles, Offset, Name, MI);
45 }
46 
48  llvm::erase_if(Decls, [](const DeclOccurrence &D) {
49  if (const auto *MI = D.DeclOrMacro.dyn_cast<const MacroInfo *>())
50  return MI->isUsedForHeaderGuard();
51  return false;
52  });
53 }
54 
55 void FileIndexRecord::print(llvm::raw_ostream &OS, SourceManager &SM) const {
56  OS << "DECLS BEGIN ---\n";
57  for (auto &DclInfo : Decls) {
58  if (const auto *D = DclInfo.DeclOrMacro.dyn_cast<const Decl *>()) {
59  SourceLocation Loc = SM.getFileLoc(D->getLocation());
60  PresumedLoc PLoc = SM.getPresumedLoc(Loc);
61  OS << llvm::sys::path::filename(PLoc.getFilename()) << ':'
62  << PLoc.getLine() << ':' << PLoc.getColumn();
63 
64  if (const auto *ND = dyn_cast<NamedDecl>(D)) {
65  OS << ' ' << ND->getDeclName();
66  }
67  } else {
68  const auto *MI = DclInfo.DeclOrMacro.get<const MacroInfo *>();
69  SourceLocation Loc = SM.getFileLoc(MI->getDefinitionLoc());
70  PresumedLoc PLoc = SM.getPresumedLoc(Loc);
71  OS << llvm::sys::path::filename(PLoc.getFilename()) << ':'
72  << PLoc.getLine() << ':' << PLoc.getColumn();
73  OS << ' ' << DclInfo.MacroName->getName();
74  }
75 
76  OS << '\n';
77  }
78  OS << "DECLS END ---\n";
79 }
Defines the clang::ASTContext interface.
#define SM(sm)
Definition: Cuda.cpp:83
Defines the C++ template declaration subclasses.
unsigned Offset
Definition: Format.cpp:2978
SourceLocation Loc
Definition: SemaObjC.cpp:755
Defines the SourceManager interface.
Decl - This represents one declaration (or definition), e.g.
Definition: DeclBase.h:86
bool isCanonicalDecl() const
Whether this particular Decl is a canonical one.
Definition: DeclBase.h:974
One of these records is kept for each identifier that is lexed.
Encapsulates the data about a macro definition (e.g.
Definition: MacroInfo.h:39
Represents an unpacked "presumed" location which can be presented to the user.
unsigned getColumn() const
Return the presumed column number of this location.
const char * getFilename() const
Return the presumed filename of this location.
unsigned getLine() const
Return the presumed line number of this location.
Encodes a location in the source.
This class handles loading and caching of source files into memory.
void print(llvm::raw_ostream &OS, SourceManager &SM) const
ArrayRef< DeclOccurrence > getDeclOccurrencesSortedByOffset() const
void addMacroOccurence(SymbolRoleSet Roles, unsigned Offset, const IdentifierInfo *Name, const MacroInfo *MI)
Adds an occurrence of the given macro at the supplied Offset.
void addDeclOccurence(SymbolRoleSet Roles, unsigned Offset, const Decl *D, ArrayRef< SymbolRelation > Relations)
Adds an occurrence of the canonical declaration D at the supplied Offset.
void removeHeaderGuardMacros()
Remove any macro occurrences for header guards.
The JSON file list parser is used to communicate input to InstallAPI.
llvm::PointerUnion< const Decl *, const MacroInfo * > DeclOrMacro