1//===--- FileIndexRecord.h - 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#ifndef LLVM_CLANG_LIB_INDEX_FILEINDEXRECORD_H
10#define LLVM_CLANG_LIB_INDEX_FILEINDEXRECORD_H
11
12#include "clang/Basic/SourceLocation.h"
13#include "clang/Index/DeclOccurrence.h"
14#include "clang/Index/IndexSymbol.h"
15#include "llvm/ADT/ArrayRef.h"
16#include "llvm/ADT/SmallVector.h"
17#include <vector>
18
19namespace clang {
20class IdentifierInfo;
21
22namespace index {
23
24/// Stores the declaration occurrences seen in a particular source or header
25/// file of a translation unit
26class FileIndexRecord {
27private:
28  FileID FID;
29  bool IsSystem;
30  std::vector<DeclOccurrence> Decls;
31
32public:
33  FileIndexRecord(FileID FID, bool IsSystem) : FID(FID), IsSystem(IsSystem) {}
34
35  ArrayRef<DeclOccurrence> getDeclOccurrencesSortedByOffset() const {
36    return Decls;
37  }
38
39  FileID getFileID() const { return FID; }
40  bool isSystem() const { return IsSystem; }
41
42  /// Adds an occurrence of the canonical declaration \c D at the supplied
43  /// \c Offset
44  ///
45  /// \param Roles the roles the occurrence fulfills in this position.
46  /// \param Offset the offset in the file of this occurrence.
47  /// \param D the canonical declaration this is an occurrence of.
48  /// \param Relations the set of symbols related to this occurrence.
49  void addDeclOccurence(SymbolRoleSet Roles, unsigned Offset, const Decl *D,
50                        ArrayRef<SymbolRelation> Relations);
51
52  /// Adds an occurrence of the given macro at the supplied \c Offset.
53  ///
54  /// \param Roles the roles the occurrence fulfills in this position.
55  /// \param Offset the offset in the file of this occurrence.
56  /// \param Name the name of the macro.
57  /// \param MI the canonical declaration this is an occurrence of.
58  void addMacroOccurence(SymbolRoleSet Roles, unsigned Offset,
59                         const IdentifierInfo *Name, const MacroInfo *MI);
60
61  /// Remove any macro occurrences for header guards. When preprocessing, this
62  /// will only be accurate after HandleEndOfFile.
63  void removeHeaderGuardMacros();
64
65  void print(llvm::raw_ostream &OS, SourceManager &SM) const;
66};
67
68} // end namespace index
69} // end namespace clang
70
71#endif // LLVM_CLANG_LIB_INDEX_FILEINDEXRECORD_H
72