clang-tools  10.0.0svn
Index.h
Go to the documentation of this file.
1 //===--- Index.h -------------------------------------------------*- 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_CLANGD_INDEX_INDEX_H
10 #define LLVM_CLANG_TOOLS_EXTRA_CLANGD_INDEX_INDEX_H
11 
12 #include "Ref.h"
13 #include "Relation.h"
14 #include "Symbol.h"
15 #include "SymbolID.h"
16 #include "llvm/ADT/DenseSet.h"
17 #include "llvm/ADT/Optional.h"
18 #include "llvm/ADT/StringExtras.h"
19 #include "llvm/Support/JSON.h"
20 #include <mutex>
21 #include <string>
22 
23 namespace clang {
24 namespace clangd {
25 
27  /// A query string for the fuzzy find. This is matched against symbols'
28  /// un-qualified identifiers and should not contain qualifiers like "::".
29  std::string Query;
30  /// If this is non-empty, symbols must be in at least one of the scopes
31  /// (e.g. namespaces) excluding nested scopes. For example, if a scope "xyz::"
32  /// is provided, the matched symbols must be defined in namespace xyz but not
33  /// namespace xyz::abc.
34  ///
35  /// The global scope is "", a top level scope is "foo::", etc.
36  std::vector<std::string> Scopes;
37  /// If set to true, allow symbols from any scope. Scopes explicitly listed
38  /// above will be ranked higher.
39  bool AnyScope = false;
40  /// The number of top candidates to return. The index may choose to
41  /// return more than this, e.g. if it doesn't know which candidates are best.
42  llvm::Optional<uint32_t> Limit;
43  /// If set to true, only symbols for completion support will be considered.
45  /// Contextually relevant files (e.g. the file we're code-completing in).
46  /// Paths should be absolute.
47  std::vector<std::string> ProximityPaths;
48  /// Preferred types of symbols. These are raw representation of `OpaqueType`.
49  std::vector<std::string> PreferredTypes;
50 
51  bool operator==(const FuzzyFindRequest &Req) const {
52  return std::tie(Query, Scopes, Limit, RestrictForCodeCompletion,
53  ProximityPaths, PreferredTypes) ==
54  std::tie(Req.Query, Req.Scopes, Req.Limit,
56  Req.PreferredTypes);
57  }
58  bool operator!=(const FuzzyFindRequest &Req) const { return !(*this == Req); }
59 };
60 bool fromJSON(const llvm::json::Value &Value, FuzzyFindRequest &Request);
61 llvm::json::Value toJSON(const FuzzyFindRequest &Request);
62 
63 struct LookupRequest {
64  llvm::DenseSet<SymbolID> IDs;
65 };
66 
67 struct RefsRequest {
68  llvm::DenseSet<SymbolID> IDs;
70  /// If set, limit the number of refers returned from the index. The index may
71  /// choose to return less than this, e.g. it tries to avoid returning stale
72  /// results.
73  llvm::Optional<uint32_t> Limit;
74 };
75 
77  llvm::DenseSet<SymbolID> Subjects;
79  /// If set, limit the number of relations returned from the index.
80  llvm::Optional<uint32_t> Limit;
81 };
82 
83 /// Interface for symbol indexes that can be used for searching or
84 /// matching symbols among a set of symbols based on names or unique IDs.
85 class SymbolIndex {
86 public:
87  virtual ~SymbolIndex() = default;
88 
89  /// Matches symbols in the index fuzzily and applies \p Callback on
90  /// each matched symbol before returning.
91  /// If returned Symbols are used outside Callback, they must be deep-copied!
92  ///
93  /// Returns true if there may be more results (limited by Req.Limit).
94  virtual bool
95  fuzzyFind(const FuzzyFindRequest &Req,
96  llvm::function_ref<void(const Symbol &)> Callback) const = 0;
97 
98  /// Looks up symbols with any of the given symbol IDs and applies \p Callback
99  /// on each matched symbol.
100  /// The returned symbol must be deep-copied if it's used outside Callback.
101  virtual void
102  lookup(const LookupRequest &Req,
103  llvm::function_ref<void(const Symbol &)> Callback) const = 0;
104 
105  /// Finds all occurrences (e.g. references, declarations, definitions) of a
106  /// symbol and applies \p Callback on each result.
107  ///
108  /// Results should be returned in arbitrary order.
109  /// The returned result must be deep-copied if it's used outside Callback.
110  virtual void refs(const RefsRequest &Req,
111  llvm::function_ref<void(const Ref &)> Callback) const = 0;
112 
113  /// Finds all relations (S, P, O) stored in the index such that S is among
114  /// Req.Subjects and P is Req.Predicate, and invokes \p Callback for (S, O) in
115  /// each.
116  virtual void relations(
117  const RelationsRequest &Req,
118  llvm::function_ref<void(const SymbolID &Subject, const Symbol &Object)>
119  Callback) const = 0;
120 
121  /// Returns estimated size of index (in bytes).
122  virtual size_t estimateMemoryUsage() const = 0;
123 };
124 
125 // Delegating implementation of SymbolIndex whose delegate can be swapped out.
126 class SwapIndex : public SymbolIndex {
127 public:
128  // If an index is not provided, reset() must be called.
129  SwapIndex(std::unique_ptr<SymbolIndex> Index = nullptr)
130  : Index(std::move(Index)) {}
131  void reset(std::unique_ptr<SymbolIndex>);
132 
133  // SymbolIndex methods delegate to the current index, which is kept alive
134  // until the call returns (even if reset() is called).
135  bool fuzzyFind(const FuzzyFindRequest &,
136  llvm::function_ref<void(const Symbol &)>) const override;
137  void lookup(const LookupRequest &,
138  llvm::function_ref<void(const Symbol &)>) const override;
139  void refs(const RefsRequest &,
140  llvm::function_ref<void(const Ref &)>) const override;
141  void relations(const RelationsRequest &,
142  llvm::function_ref<void(const SymbolID &, const Symbol &)>)
143  const override;
144 
145  size_t estimateMemoryUsage() const override;
146 
147 private:
148  std::shared_ptr<SymbolIndex> snapshot() const;
149  mutable std::mutex Mutex;
150  std::shared_ptr<SymbolIndex> Index;
151 };
152 
153 } // namespace clangd
154 } // namespace clang
155 
156 #endif // LLVM_CLANG_TOOLS_EXTRA_CLANGD_INDEX_INDEX_H
llvm::DenseSet< SymbolID > IDs
Definition: Index.h:68
llvm::json::Value toJSON(const FuzzyFindRequest &Request)
Definition: Index.cpp:48
bool AnyScope
If set to true, allow symbols from any scope.
Definition: Index.h:39
SwapIndex(std::unique_ptr< SymbolIndex > Index=nullptr)
Definition: Index.h:129
bool RestrictForCodeCompletion
If set to true, only symbols for completion support will be considered.
Definition: Index.h:44
llvm::Optional< uint32_t > Limit
If set, limit the number of relations returned from the index.
Definition: Index.h:80
Interface for symbol indexes that can be used for searching or matching symbols among a set of symbol...
Definition: Index.h:85
llvm::DenseSet< SymbolID > IDs
Definition: Index.h:64
Represents a symbol occurrence in the source file.
Definition: Ref.h:52
llvm::unique_function< void(llvm::Expected< T >)> Callback
A Callback<T> is a void function that accepts Expected<T>.
Definition: Function.h:28
bool operator==(const FuzzyFindRequest &Req) const
Definition: Index.h:51
std::vector< std::string > PreferredTypes
Preferred types of symbols. These are raw representation of OpaqueType.
Definition: Index.h:49
std::vector< std::string > Scopes
If this is non-empty, symbols must be in at least one of the scopes (e.g.
Definition: Index.h:36
std::vector< std::string > lookup(const SymbolIndex &I, llvm::ArrayRef< SymbolID > IDs)
Definition: TestIndex.cpp:106
std::string Query
A query string for the fuzzy find.
Definition: Index.h:29
RefKind
Describes the kind of a cross-reference.
Definition: Ref.h:28
bool operator!=(const FuzzyFindRequest &Req) const
Definition: Index.h:58
llvm::DenseSet< SymbolID > Subjects
Definition: Index.h:77
bool fromJSON(const llvm::json::Value &Parameters, FuzzyFindRequest &Request)
Definition: Index.cpp:34
The class presents a C++ symbol, e.g.
Definition: Symbol.h:36
===– Representation.cpp - ClangDoc Representation --------—*- C++ -*-===//
std::vector< std::string > ProximityPaths
Contextually relevant files (e.g.
Definition: Index.h:47
llvm::Optional< uint32_t > Limit
If set, limit the number of refers returned from the index.
Definition: Index.h:73
llvm::Optional< uint32_t > Limit
The number of top candidates to return.
Definition: Index.h:42
const SymbolIndex * Index
Definition: Dexp.cpp:84