summaryrefslogtreecommitdiffstats
path: root/clangd/XRefs.h
diff options
context:
space:
mode:
Diffstat (limited to 'clangd/XRefs.h')
-rw-r--r--clangd/XRefs.h38
1 files changed, 32 insertions, 6 deletions
diff --git a/clangd/XRefs.h b/clangd/XRefs.h
index 631879d6..008bba50 100644
--- a/clangd/XRefs.h
+++ b/clangd/XRefs.h
@@ -1,9 +1,8 @@
//===--- XRefs.h -------------------------------------------------*- C++-*-===//
//
-// The LLVM Compiler Infrastructure
-//
-// This file is distributed under the University of Illinois Open Source
-// License. See LICENSE.TXT for details.
+// Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions.
+// See https://llvm.org/LICENSE.txt for license information.
+// SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
//
//===----------------------------------------------------------------------===//
//
@@ -23,9 +22,25 @@
namespace clang {
namespace clangd {
+// Describes where a symbol is declared and defined (as far as clangd knows).
+// There are three cases:
+// - a declaration only, no definition is known (e.g. only header seen)
+// - a declaration and a distinct definition (e.g. function declared in header)
+// - a declaration and an equal definition (e.g. inline function, or class)
+// For some types of symbol, e.g. macros, definition == declaration always.
+struct LocatedSymbol {
+ // The (unqualified) name of the symbol.
+ std::string Name;
+ // The canonical or best declaration: where most users find its interface.
+ Location PreferredDeclaration;
+ // Where the symbol is defined, if known. May equal PreferredDeclaration.
+ llvm::Optional<Location> Definition;
+};
+llvm::raw_ostream &operator<<(llvm::raw_ostream &, const LocatedSymbol &);
/// Get definition of symbol at a specified \p Pos.
-std::vector<Location> findDefinitions(ParsedAST &AST, Position Pos,
- const SymbolIndex *Index = nullptr);
+/// Multiple locations may be returned, corresponding to distinct symbols.
+std::vector<LocatedSymbol> locateSymbolAt(ParsedAST &AST, Position Pos,
+ const SymbolIndex *Index = nullptr);
/// Returns highlights for all usages of a symbol at \p Pos.
std::vector<DocumentHighlight> findDocumentHighlights(ParsedAST &AST,
@@ -43,6 +58,17 @@ std::vector<Location> findReferences(ParsedAST &AST, Position Pos,
/// Get info about symbols at \p Pos.
std::vector<SymbolDetails> getSymbolInfo(ParsedAST &AST, Position Pos);
+/// Find the record type references at \p Pos.
+const CXXRecordDecl *findRecordTypeAt(ParsedAST &AST, Position Pos);
+
+/// Given a record type declaration, find its base (parent) types.
+std::vector<const CXXRecordDecl *> typeParents(const CXXRecordDecl *CXXRD);
+
+/// Get type hierarchy information at \p Pos.
+llvm::Optional<TypeHierarchyItem>
+getTypeHierarchy(ParsedAST &AST, Position Pos, int Resolve,
+ TypeHierarchyDirection Direction);
+
} // namespace clangd
} // namespace clang