clang-tools 10.0.0

SymbolInfo.h
Go to the documentation of this file.
1 //===-- SymbolInfo.h - Symbol Info ------------------------------*- 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_TOOLS_EXTRA_INCLUDE_FIXER_FIND_ALL_SYMBOLS_SYMBOLINFO_H
10 #define LLVM_CLANG_TOOLS_EXTRA_INCLUDE_FIXER_FIND_ALL_SYMBOLS_SYMBOLINFO_H
11
12 #include "llvm/ADT/Optional.h"
13 #include "llvm/ADT/StringRef.h"
14 #include "llvm/Support/YAMLTraits.h"
15 #include "llvm/Support/raw_ostream.h"
16 #include <set>
17 #include <string>
18 #include <vector>
19
20 namespace clang {
21 namespace find_all_symbols {
22 /// Describes a named symbol from a header.
23 /// Symbols with the same qualified name and type (e.g. function overloads)
24 /// that appear in the same header are represented by a single SymbolInfo.
25 ///
26 /// TODO: keep track of instances, e.g. overload locations and signatures.
27 class SymbolInfo {
28 public:
29 /// The SymbolInfo Type.
30 enum class SymbolKind {
31 Function,
32 Class,
33 Variable,
34 TypedefName,
35 EnumDecl,
36 EnumConstantDecl,
37 Macro,
38 Unknown,
39 };
40
41 /// The Context Type.
42 enum class ContextType {
43 Namespace, // Symbols declared in a namespace.
44 Record, // Symbols declared in a class.
45 EnumDecl, // Enum constants declared in a enum declaration.
46 };
47
48 /// A pair of <ContextType, ContextName>.
49 typedef std::pair<ContextType, std::string> Context;
50
51 // Signals are signals gathered by observing how a symbol is used.
52 // These are used to rank results.
53 struct Signals {
54 Signals() {}
55 Signals(unsigned Seen, unsigned Used) : Seen(Seen), Used(Used) {}
56
57 // Number of times this symbol was visible to a TU.
58 unsigned Seen = 0;
59
60 // Number of times this symbol was referenced a TU's main file.
61 unsigned Used = 0;
62
63 Signals &operator+=(const Signals &RHS);
64 Signals operator+(const Signals &RHS) const;
65 bool operator==(const Signals &RHS) const;
66 };
67
68 using SignalMap = std::map<SymbolInfo, Signals>;
69
70 // The default constructor is required by YAML traits in
71 // LLVM_YAML_IS_DOCUMENT_LIST_VECTOR.
72 SymbolInfo() : Type(SymbolKind::Unknown) {}
73
74 SymbolInfo(llvm::StringRef Name, SymbolKind Type, llvm::StringRef FilePath,
75 const std::vector<Context> &Contexts);
76
77 void SetFilePath(llvm::StringRef Path) { FilePath = Path; }
78
79 /// Get symbol name.
80 llvm::StringRef getName() const { return Name; }
81
82 /// Get the fully-qualified symbol name.
83 std::string getQualifiedName() const;
84
85 /// Get symbol type.
86 SymbolKind getSymbolKind() const { return Type; }
87
88 /// Get a relative file path where symbol comes from.
89 llvm::StringRef getFilePath() const { return FilePath; }
90
91 /// Get symbol contexts.
92 const std::vector<SymbolInfo::Context> &getContexts() const {
93 return Contexts;
94 }
95
96 bool operator<(const SymbolInfo &Symbol) const;
97
98 bool operator==(const SymbolInfo &Symbol) const;
99
100 private:
101 friend struct llvm::yaml::MappingTraits<struct SymbolAndSignals>;
102
103 /// Identifier name.
104 std::string Name;
105
106 /// Symbol type.
107 SymbolKind Type;
108
109 /// The file path where the symbol comes from. It's a relative file
110 /// path based on the build directory.
111 std::string FilePath;
112
113 /// Contains information about symbol contexts. Context information is
114 /// stored from the inner-most level to outer-most level.
115 ///
116 /// For example, if a symbol 'x' is declared as:
117 /// namespace na { namespace nb { class A { int x; } } }
118 /// The contexts would be { {RECORD, "A"}, {NAMESPACE, "nb"}, {NAMESPACE,
119 /// "na"} }.
120 /// The name of an anonymous namespace is "".
121 ///
122 /// If the symbol is declared in `TranslationUnitDecl`, it has no context.
123 std::vector<Context> Contexts;
124 };
125
126 struct SymbolAndSignals {
127 SymbolInfo Symbol;
128 SymbolInfo::Signals Signals;
129 bool operator==(const SymbolAndSignals& RHS) const;
130 };
131
132 /// Write SymbolInfos to a stream (YAML format).
133 bool WriteSymbolInfosToStream(llvm::raw_ostream &OS,
134 const SymbolInfo::SignalMap &Symbols);
135
136 /// Read SymbolInfos from a YAML document.
137 std::vector<SymbolAndSignals> ReadSymbolInfosFromYAML(llvm::StringRef Yaml);
138
139 } // namespace find_all_symbols
140 } // namespace clang
141
142 #endif // LLVM_CLANG_TOOLS_EXTRA_INCLUDE_FIXER_FIND_ALL_SYMBOLS_SYMBOLINFO_H
Name
llvm::StringRef Name
Definition: CodeComplete.cpp:156
clang::find_all_symbols::SymbolInfo::SymbolKind::Function
clang::find_all_symbols::SymbolInfo::operator<
bool operator<(const SymbolInfo &Symbol) const
Definition: SymbolInfo.cpp:83
clang::find_all_symbols::SymbolInfo::Signals::operator+=
Signals & operator+=(const Signals &RHS)
Definition: SymbolInfo.cpp:98
clang::find_all_symbols::SymbolInfo::SymbolKind::Class
clang::find_all_symbols::SymbolInfo::ContextType
ContextType
The Context Type.
Definition: SymbolInfo.h:42
clang::find_all_symbols::WriteSymbolInfosToStream
bool WriteSymbolInfosToStream(llvm::raw_ostream &OS, const SymbolInfo::SignalMap &Symbols)
Write SymbolInfos to a stream (YAML format).
Definition: SymbolInfo.cpp:118
clang::find_all_symbols::SymbolInfo::Signals::Seen
unsigned Seen
Definition: SymbolInfo.h:58
clang::find_all_symbols::SymbolInfo::SymbolKind::EnumConstantDecl
Path
std::vector< HeaderHandle > Path
Definition: PreprocessorTracker.cpp:537
clang::find_all_symbols::ReadSymbolInfosFromYAML
std::vector< SymbolAndSignals > ReadSymbolInfosFromYAML(llvm::StringRef Yaml)
Read SymbolInfos from a YAML document.
Definition: SymbolInfo.cpp:128
clang::find_all_symbols::SymbolInfo::getQualifiedName
std::string getQualifiedName() const
Get the fully-qualified symbol name.
Definition: SymbolInfo.cpp:88
clang::find_all_symbols::SymbolInfo::getContexts
const std::vector< SymbolInfo::Context > & getContexts() const
Get symbol contexts.
Definition: SymbolInfo.h:92
clang::find_all_symbols::SymbolInfo::Signals
Definition: SymbolInfo.h:53
clang::find_all_symbols::SymbolInfo::SetFilePath
void SetFilePath(llvm::StringRef Path)
Definition: SymbolInfo.h:77
clang::find_all_symbols::SymbolAndSignals::Signals
SymbolInfo::Signals Signals
Definition: SymbolInfo.h:128
clang::find_all_symbols::SymbolAndSignals
Definition: SymbolInfo.h:126
clang::find_all_symbols::SymbolInfo::SymbolKind::Variable
clang::find_all_symbols::SymbolInfo::SymbolKind::EnumDecl
Name
static constexpr llvm::StringLiteral Name
Definition: UppercaseLiteralSuffixCheck.cpp:27
clang::find_all_symbols::SymbolInfo::SymbolKind
SymbolKind
The SymbolInfo Type.
Definition: SymbolInfo.h:30
clang::find_all_symbols::SymbolInfo::ContextType::Namespace
Symbols
SymbolSlab Symbols
Definition: SymbolCollectorTests.cpp:295
clang::find_all_symbols::SymbolInfo::SymbolKind::TypedefName
clang::find_all_symbols::SymbolInfo::SymbolKind::Unknown
clang::find_all_symbols::SymbolAndSignals::Symbol
SymbolInfo Symbol
Definition: SymbolInfo.h:127
clang::find_all_symbols::SymbolInfo::Context
std::pair< ContextType, std::string > Context
A pair of <ContextType, ContextName>.
Definition: SymbolInfo.h:49
clang
===– Representation.cpp - ClangDoc Representation --------—*- C++ -*-===//
Definition: ApplyReplacements.h:27
clang::find_all_symbols::SymbolInfo::SymbolInfo
SymbolInfo()
Definition: SymbolInfo.h:72
clang::find_all_symbols::SymbolInfo::Signals::Signals
Signals(unsigned Seen, unsigned Used)
Definition: SymbolInfo.h:55
clang::find_all_symbols::SymbolInfo::getFilePath
llvm::StringRef getFilePath() const
Get a relative file path where symbol comes from.
Definition: SymbolInfo.h:89
clang::find_all_symbols::SymbolInfo::ContextType::Record
clang::find_all_symbols::SymbolInfo::getName
llvm::StringRef getName() const
Get symbol name.
Definition: SymbolInfo.h:80
clang::find_all_symbols::SymbolInfo::Signals::Signals
Signals()
Definition: SymbolInfo.h:54
clang::find_all_symbols::SymbolInfo::SignalMap
std::map< SymbolInfo, Signals > SignalMap
Definition: SymbolInfo.h:68
clang::find_all_symbols::SymbolInfo::Signals::operator+
Signals operator+(const Signals &RHS) const
Definition: SymbolInfo.cpp:104
clang::find_all_symbols::SymbolInfo::SymbolKind::Macro
clang::find_all_symbols::SymbolInfo
Describes a named symbol from a header.
Definition: SymbolInfo.h:27
clang::find_all_symbols::SymbolInfo::Signals::Used
unsigned Used
Definition: SymbolInfo.h:61
clang::find_all_symbols::SymbolInfo::ContextType::EnumDecl
Type
NodeType Type
Definition: HTMLGenerator.cpp:73
clang::find_all_symbols::SymbolInfo::getSymbolKind
SymbolKind getSymbolKind() const
Get symbol type.
Definition: SymbolInfo.h:86
clang::find_all_symbols::SymbolInfo::Signals::operator==
bool operator==(const Signals &RHS) const
Definition: SymbolInfo.cpp:110