clang  6.0.0svn
SourceManagerInternals.h
Go to the documentation of this file.
1 //===--- SourceManagerInternals.h - SourceManager Internals -----*- C++ -*-===//
2 //
3 // The LLVM Compiler Infrastructure
4 //
5 // This file is distributed under the University of Illinois Open Source
6 // License. See LICENSE.TXT for details.
7 //
8 //===----------------------------------------------------------------------===//
9 ///
10 /// \file
11 /// \brief Defines implementation details of the clang::SourceManager class.
12 ///
13 //===----------------------------------------------------------------------===//
14 
15 #ifndef LLVM_CLANG_BASIC_SOURCEMANAGERINTERNALS_H
16 #define LLVM_CLANG_BASIC_SOURCEMANAGERINTERNALS_H
17 
20 #include "llvm/ADT/StringMap.h"
21 #include <map>
22 
23 namespace clang {
24 
25 //===----------------------------------------------------------------------===//
26 // Line Table Implementation
27 //===----------------------------------------------------------------------===//
28 
29 struct LineEntry {
30  /// \brief The offset in this file that the line entry occurs at.
31  unsigned FileOffset;
32 
33  /// \brief The presumed line number of this line entry: \#line 4.
34  unsigned LineNo;
35 
36  /// \brief The ID of the filename identified by this line entry:
37  /// \#line 4 "foo.c". This is -1 if not specified.
39 
40  /// \brief Set the 0 if no flags, 1 if a system header,
42 
43  /// \brief The offset of the virtual include stack location,
44  /// which is manipulated by GNU linemarker directives.
45  ///
46  /// If this is 0 then there is no virtual \#includer.
47  unsigned IncludeOffset;
48 
49  static LineEntry get(unsigned Offs, unsigned Line, int Filename,
51  unsigned IncludeOffset) {
52  LineEntry E;
53  E.FileOffset = Offs;
54  E.LineNo = Line;
55  E.FilenameID = Filename;
56  E.FileKind = FileKind;
58  return E;
59  }
60 };
61 
62 // needed for FindNearestLineEntry (upper_bound of LineEntry)
63 inline bool operator<(const LineEntry &lhs, const LineEntry &rhs) {
64  // FIXME: should check the other field?
65  return lhs.FileOffset < rhs.FileOffset;
66 }
67 
68 inline bool operator<(const LineEntry &E, unsigned Offset) {
69  return E.FileOffset < Offset;
70 }
71 
72 inline bool operator<(unsigned Offset, const LineEntry &E) {
73  return Offset < E.FileOffset;
74 }
75 
76 /// \brief Used to hold and unique data used to represent \#line information.
78  /// \brief Map used to assign unique IDs to filenames in \#line directives.
79  ///
80  /// This allows us to unique the filenames that
81  /// frequently reoccur and reference them with indices. FilenameIDs holds
82  /// the mapping from string -> ID, and FilenamesByID holds the mapping of ID
83  /// to string.
84  llvm::StringMap<unsigned, llvm::BumpPtrAllocator> FilenameIDs;
85  std::vector<llvm::StringMapEntry<unsigned>*> FilenamesByID;
86 
87  /// \brief Map from FileIDs to a list of line entries (sorted by the offset
88  /// at which they occur in the file).
89  std::map<FileID, std::vector<LineEntry> > LineEntries;
90 public:
91  void clear() {
92  FilenameIDs.clear();
93  FilenamesByID.clear();
94  LineEntries.clear();
95  }
96 
97  unsigned getLineTableFilenameID(StringRef Str);
98  StringRef getFilename(unsigned ID) const {
99  assert(ID < FilenamesByID.size() && "Invalid FilenameID");
100  return FilenamesByID[ID]->getKey();
101  }
102  unsigned getNumFilenames() const { return FilenamesByID.size(); }
103 
104  void AddLineNote(FileID FID, unsigned Offset,
105  unsigned LineNo, int FilenameID,
106  unsigned EntryExit, SrcMgr::CharacteristicKind FileKind);
107 
108 
109  /// \brief Find the line entry nearest to FID that is before it.
110  ///
111  /// If there is no line entry before \p Offset in \p FID, returns null.
112  const LineEntry *FindNearestLineEntry(FileID FID, unsigned Offset);
113 
114  // Low-level access
115  typedef std::map<FileID, std::vector<LineEntry> >::iterator iterator;
116  iterator begin() { return LineEntries.begin(); }
117  iterator end() { return LineEntries.end(); }
118 
119  /// \brief Add a new line entry that has already been encoded into
120  /// the internal representation of the line table.
121  void AddEntry(FileID FID, const std::vector<LineEntry> &Entries);
122 };
123 
124 } // end namespace clang
125 
126 #endif
unsigned IncludeOffset
The offset of the virtual include stack location, which is manipulated by GNU linemarker directives...
Defines the SourceManager interface.
int FilenameID
The ID of the filename identified by this line entry: #line 4 "foo.c".
CharacteristicKind
Indicates whether a file or directory holds normal user code, system code, or system code which is im...
Definition: SourceManager.h:82
Used to hold and unique data used to represent #line information.
std::map< FileID, std::vector< LineEntry > >::iterator iterator
unsigned FileOffset
The offset in this file that the line entry occurs at.
uint32_t Offset
Definition: CacheTokens.cpp:43
SrcMgr::CharacteristicKind FileKind
Set the 0 if no flags, 1 if a system header,.
StringRef Filename
Definition: Format.cpp:1316
const AnnotatedLine * Line
bool operator<(DeclarationName LHS, DeclarationName RHS)
Ordering on two declaration names.
An opaque identifier used by SourceManager which refers to a source file (MemoryBuffer) along with it...
Dataflow Directional Tag Classes.
StringRef getFilename(unsigned ID) const
unsigned LineNo
The presumed line number of this line entry: #line 4.
Defines the clang::SourceLocation class and associated facilities.
unsigned getNumFilenames() const