71 lines · c
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-exception6//7//===----------------------------------------------------------------------===//8 9#ifndef LLVM_CLANG_LIB_INDEX_FILEINDEXRECORD_H10#define LLVM_CLANG_LIB_INDEX_FILEINDEXRECORD_H11 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 header25/// file of a translation unit26class FileIndexRecord {27private:28 FileID FID;29 bool IsSystem;30 mutable bool IsSorted = false;31 mutable std::vector<DeclOccurrence> Decls;32 33public:34 FileIndexRecord(FileID FID, bool IsSystem) : FID(FID), IsSystem(IsSystem) {}35 36 ArrayRef<DeclOccurrence> getDeclOccurrencesSortedByOffset() const;37 38 FileID getFileID() const { return FID; }39 bool isSystem() const { return IsSystem; }40 41 /// Adds an occurrence of the canonical declaration \c D at the supplied42 /// \c Offset43 ///44 /// \param Roles the roles the occurrence fulfills in this position.45 /// \param Offset the offset in the file of this occurrence.46 /// \param D the canonical declaration this is an occurrence of.47 /// \param Relations the set of symbols related to this occurrence.48 void addDeclOccurence(SymbolRoleSet Roles, unsigned Offset, const Decl *D,49 ArrayRef<SymbolRelation> Relations);50 51 /// Adds an occurrence of the given macro at the supplied \c Offset.52 ///53 /// \param Roles the roles the occurrence fulfills in this position.54 /// \param Offset the offset in the file of this occurrence.55 /// \param Name the name of the macro.56 /// \param MI the canonical declaration this is an occurrence of.57 void addMacroOccurence(SymbolRoleSet Roles, unsigned Offset,58 const IdentifierInfo *Name, const MacroInfo *MI);59 60 /// Remove any macro occurrences for header guards. When preprocessing, this61 /// will only be accurate after HandleEndOfFile.62 void removeHeaderGuardMacros();63 64 void print(llvm::raw_ostream &OS, SourceManager &SM) const;65};66 67} // end namespace index68} // end namespace clang69 70#endif // LLVM_CLANG_LIB_INDEX_FILEINDEXRECORD_H71