forked from OSchip/llvm-project
44 lines
1.8 KiB
C++
44 lines
1.8 KiB
C++
//===--- FindSymbols.h --------------------------------------*- C++-*------===//
|
|
//
|
|
// 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
|
|
//
|
|
//===----------------------------------------------------------------------===//
|
|
//
|
|
// Queries that provide a list of symbols matching a string.
|
|
//
|
|
//===----------------------------------------------------------------------===//
|
|
#ifndef LLVM_CLANG_TOOLS_EXTRA_CLANGD_FINDSYMBOLS_H
|
|
#define LLVM_CLANG_TOOLS_EXTRA_CLANGD_FINDSYMBOLS_H
|
|
|
|
#include "Protocol.h"
|
|
#include "llvm/ADT/StringRef.h"
|
|
|
|
namespace clang {
|
|
namespace clangd {
|
|
class ParsedAST;
|
|
class SymbolIndex;
|
|
|
|
/// Searches for the symbols matching \p Query. The syntax of \p Query can be
|
|
/// the non-qualified name or fully qualified of a symbol. For example, "vector"
|
|
/// will match the symbol std::vector and "std::vector" would also match it.
|
|
/// Direct children of scopes (namepaces, etc) can be listed with a trailing
|
|
/// "::". For example, "std::" will list all children of the std namespace and
|
|
/// "::" alone will list all children of the global namespace.
|
|
/// \p Limit limits the number of results returned (0 means no limit).
|
|
/// \p HintPath This is used when resolving URIs. If empty, URI resolution can
|
|
/// fail if a hint path is required for the scheme of a specific URI.
|
|
llvm::Expected<std::vector<SymbolInformation>>
|
|
getWorkspaceSymbols(llvm::StringRef Query, int Limit,
|
|
const SymbolIndex *const Index, llvm::StringRef HintPath);
|
|
|
|
/// Retrieves the symbols contained in the "main file" section of an AST in the
|
|
/// same order that they appear.
|
|
llvm::Expected<std::vector<DocumentSymbol>> getDocumentSymbols(ParsedAST &AST);
|
|
|
|
} // namespace clangd
|
|
} // namespace clang
|
|
|
|
#endif
|