clang-tools  14.0.0git
Hover.h
Go to the documentation of this file.
1 //===--- Hover.h - Information about code at the cursor location -*- 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_HOVER_H
10 #define LLVM_CLANG_TOOLS_EXTRA_CLANGD_HOVER_H
11 
12 #include "ParsedAST.h"
13 #include "Protocol.h"
14 #include "support/Markup.h"
15 #include "clang/Index/IndexSymbol.h"
16 
17 namespace clang {
18 namespace clangd {
19 
20 /// Contains detailed information about a Symbol. Especially useful when
21 /// generating hover responses. It can be rendered as a hover panel, or
22 /// embedding clients can use the structured information to provide their own
23 /// UI.
24 struct HoverInfo {
25  /// Represents parameters of a function, a template or a macro.
26  /// For example:
27  /// - void foo(ParamType Name = DefaultValue)
28  /// - #define FOO(Name)
29  /// - template <ParamType Name = DefaultType> class Foo {};
30  struct Param {
31  /// The pretty-printed parameter type, e.g. "int", or "typename" (in
32  /// TemplateParameters), might be None for macro parameters.
33  llvm::Optional<std::string> Type;
34  /// None for unnamed parameters.
35  llvm::Optional<std::string> Name;
36  /// None if no default is provided.
37  llvm::Optional<std::string> Default;
38  };
39 
40  /// For a variable named Bar, declared in clang::clangd::Foo::getFoo the
41  /// following fields will hold:
42  /// - NamespaceScope: clang::clangd::
43  /// - LocalScope: Foo::getFoo::
44  /// - Name: Bar
45 
46  /// Scopes might be None in cases where they don't make sense, e.g. macros and
47  /// auto/decltype.
48  /// Contains all of the enclosing namespaces, empty string means global
49  /// namespace.
50  llvm::Optional<std::string> NamespaceScope;
51  /// Remaining named contexts in symbol's qualified name, empty string means
52  /// symbol is not local.
53  std::string LocalScope;
54  /// Name of the symbol, does not contain any "::".
55  std::string Name;
56  llvm::Optional<Range> SymRange;
58  std::string Documentation;
59  /// Source code containing the definition of the symbol.
60  std::string Definition;
61  const char *DefinitionLanguage = "cpp";
62  /// Access specifier for declarations inside class/struct/unions, empty for
63  /// others.
64  std::string AccessSpecifier;
65  /// Pretty-printed variable type.
66  /// Set only for variables.
67  llvm::Optional<std::string> Type;
68  /// Set for functions and lambdas.
69  llvm::Optional<std::string> ReturnType;
70  /// Set for functions, lambdas and macros with parameters.
71  llvm::Optional<std::vector<Param>> Parameters;
72  /// Set for all templates(function, class, variable).
73  llvm::Optional<std::vector<Param>> TemplateParameters;
74  /// Contains the evaluated value of the symbol if available.
75  llvm::Optional<std::string> Value;
76  /// Contains the byte-size of fields and types where it's interesting.
77  llvm::Optional<uint64_t> Size;
78  /// Contains the offset of fields within the enclosing class.
79  llvm::Optional<uint64_t> Offset;
80  /// Contains the padding following a field within the enclosing class.
81  llvm::Optional<uint64_t> Padding;
82  // Set when symbol is inside function call. Contains information extracted
83  // from the callee definition about the argument this is passed as.
84  llvm::Optional<Param> CalleeArgInfo;
85  struct PassType {
86  // How the variable is passed to callee.
87  enum PassMode { Ref, ConstRef, Value };
89  // True if type conversion happened. This includes calls to implicit
90  // constructor, as well as built-in type conversions. Casting to base class
91  // is not considered conversion.
92  bool Converted = false;
93  };
94  // Set only if CalleeArgInfo is set.
95  llvm::Optional<PassType> CallPassType;
96 
97  /// Produce a user-readable information.
98  markup::Document present() const;
99 };
100 
101 inline bool operator==(const HoverInfo::PassType &LHS,
102  const HoverInfo::PassType &RHS) {
103  return std::tie(LHS.PassBy, LHS.Converted) ==
104  std::tie(RHS.PassBy, RHS.Converted);
105 }
106 
107 // Try to infer structure of a documentation comment (e.g. line breaks).
108 // FIXME: move to another file so CodeComplete doesn't depend on Hover.
109 void parseDocumentation(llvm::StringRef Input, markup::Document &Output);
110 
111 llvm::raw_ostream &operator<<(llvm::raw_ostream &, const HoverInfo::Param &);
112 inline bool operator==(const HoverInfo::Param &LHS,
113  const HoverInfo::Param &RHS) {
114  return std::tie(LHS.Type, LHS.Name, LHS.Default) ==
115  std::tie(RHS.Type, RHS.Name, RHS.Default);
116 }
117 
118 /// Get the hover information when hovering at \p Pos.
119 llvm::Optional<HoverInfo> getHover(ParsedAST &AST, Position Pos,
120  format::FormatStyle Style,
121  const SymbolIndex *Index);
122 
123 } // namespace clangd
124 } // namespace clang
125 
126 #endif
clang::clangd::HoverInfo::Offset
llvm::Optional< uint64_t > Offset
Contains the offset of fields within the enclosing class.
Definition: Hover.h:79
FormatStyle
static cl::opt< std::string > FormatStyle("format-style", cl::desc(R"( Style for formatting code around applied fixes: - 'none' (default) turns off formatting - 'file' (literally 'file', not a placeholder) uses .clang-format file in the closest parent directory - '{ <json> }' specifies options inline, e.g. -format-style='{BasedOnStyle: llvm, IndentWidth: 8}' - 'llvm', 'google', 'webkit', 'mozilla' See clang-format documentation for the up-to-date information about formatting styles and options. This option overrides the 'FormatStyle` option in .clang-tidy file, if any. )"), cl::init("none"), cl::cat(ClangTidyCategory))
clang::clangd::HoverInfo::Kind
index::SymbolKind Kind
Definition: Hover.h:57
clang::clangd::HoverInfo::CallPassType
llvm::Optional< PassType > CallPassType
Definition: Hover.h:95
clang::clangd::getHover
llvm::Optional< HoverInfo > getHover(ParsedAST &AST, Position Pos, format::FormatStyle Style, const SymbolIndex *Index)
Get the hover information when hovering at Pos.
Definition: Hover.cpp:919
clang::clangd::markup::Document
A format-agnostic representation for structured text.
Definition: Markup.h:94
clang::clangd::HoverInfo::PassType::Converted
bool Converted
Definition: Hover.h:92
clang::clangd::HoverInfo::Type
llvm::Optional< std::string > Type
Pretty-printed variable type.
Definition: Hover.h:67
clang::clangd::HoverInfo::Parameters
llvm::Optional< std::vector< Param > > Parameters
Set for functions, lambdas and macros with parameters.
Definition: Hover.h:71
Protocol.h
clang::clangd::HoverInfo::Size
llvm::Optional< uint64_t > Size
Contains the byte-size of fields and types where it's interesting.
Definition: Hover.h:77
clang::clangd::HoverInfo::Name
std::string Name
Name of the symbol, does not contain any "::".
Definition: Hover.h:55
clang::clangd::HoverInfo::Definition
std::string Definition
Source code containing the definition of the symbol.
Definition: Hover.h:60
clang::clangd::Unknown
@ Unknown
Definition: FuzzyMatch.h:56
clang::clangd::HoverInfo::Padding
llvm::Optional< uint64_t > Padding
Contains the padding following a field within the enclosing class.
Definition: Hover.h:81
Markup.h
clang::clangd::HoverInfo
Contains detailed information about a Symbol.
Definition: Hover.h:24
clang::clangd::HoverInfo::AccessSpecifier
std::string AccessSpecifier
Access specifier for declarations inside class/struct/unions, empty for others.
Definition: Hover.h:64
clang::clangd::HoverInfo::PassType::Ref
@ Ref
Definition: Hover.h:87
clang::clangd::HoverInfo::Param::Name
llvm::Optional< std::string > Name
None for unnamed parameters.
Definition: Hover.h:35
clang::clangd::HoverInfo::SymRange
llvm::Optional< Range > SymRange
Definition: Hover.h:56
clang::clangd::operator<<
llvm::raw_ostream & operator<<(llvm::raw_ostream &OS, const CodeCompletion &C)
Definition: CodeComplete.cpp:2126
clang::clangd::HoverInfo::NamespaceScope
llvm::Optional< std::string > NamespaceScope
For a variable named Bar, declared in clang::clangd::Foo::getFoo the following fields will hold:
Definition: Hover.h:50
clang::clangd::HoverInfo::Param::Type
llvm::Optional< std::string > Type
The pretty-printed parameter type, e.g.
Definition: Hover.h:33
clang::clangd::HoverInfo::Param::Default
llvm::Optional< std::string > Default
None if no default is provided.
Definition: Hover.h:37
Output
std::string Output
Definition: TraceTests.cpp:162
SymbolKind
clang::find_all_symbols::SymbolInfo::SymbolKind SymbolKind
Definition: SymbolInfo.cpp:21
clang::clangd::HoverInfo::TemplateParameters
llvm::Optional< std::vector< Param > > TemplateParameters
Set for all templates(function, class, variable).
Definition: Hover.h:73
Index
const SymbolIndex * Index
Definition: Dexp.cpp:99
clang::clangd::HoverInfo::ReturnType
llvm::Optional< std::string > ReturnType
Set for functions and lambdas.
Definition: Hover.h:69
clang::clangd::HoverInfo::PassType::PassBy
PassMode PassBy
Definition: Hover.h:88
clang::clangd::HoverInfo::LocalScope
std::string LocalScope
Remaining named contexts in symbol's qualified name, empty string means symbol is not local.
Definition: Hover.h:53
clang::clangd::HoverInfo::DefinitionLanguage
const char * DefinitionLanguage
Definition: Hover.h:61
clang::clangd::HoverInfo::present
markup::Document present() const
Produce a user-readable information.
Definition: Hover.cpp:1029
clang
===– Representation.cpp - ClangDoc Representation --------—*- C++ -*-===//
Definition: ApplyReplacements.h:27
clang::clangd::HoverInfo::CalleeArgInfo
llvm::Optional< Param > CalleeArgInfo
Definition: Hover.h:84
clang::clangd::HoverInfo::Value
llvm::Optional< std::string > Value
Contains the evaluated value of the symbol if available.
Definition: Hover.h:75
clang::clangd::HoverInfo::PassType::PassMode
PassMode
Definition: Hover.h:87
clang::clangd::parseDocumentation
void parseDocumentation(llvm::StringRef Input, markup::Document &Output)
Definition: Hover.cpp:1185
clang::clangd::operator==
bool operator==(const Inclusion &LHS, const Inclusion &RHS)
Definition: Headers.cpp:286
clang::clangd::HoverInfo::PassType::Value
@ Value
Definition: Hover.h:87
Pos
Position Pos
Definition: SourceCode.cpp:657
clang::clangd::HoverInfo::Param
Represents parameters of a function, a template or a macro.
Definition: Hover.h:30
clang::clangd::HoverInfo::PassType::ConstRef
@ ConstRef
Definition: Hover.h:87
clang::clangd::HoverInfo::Documentation
std::string Documentation
Definition: Hover.h:58
clang::clangd::HoverInfo::PassType
Definition: Hover.h:85
ParsedAST.h