forked from OSchip/llvm-project
68 lines
3.0 KiB
C++
68 lines
3.0 KiB
C++
//===--- CodeCompletionStrings.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
|
|
//
|
|
//===----------------------------------------------------------------------===//
|
|
//
|
|
// Functions for retrieving code completion information from
|
|
// `CodeCompletionString`.
|
|
//
|
|
//===----------------------------------------------------------------------===//
|
|
|
|
#ifndef LLVM_CLANG_TOOLS_EXTRA_CLANGD_CODECOMPLETIONSTRINGS_H
|
|
#define LLVM_CLANG_TOOLS_EXTRA_CLANGD_CODECOMPLETIONSTRINGS_H
|
|
|
|
#include "clang/Sema/CodeCompleteConsumer.h"
|
|
|
|
namespace clang {
|
|
class ASTContext;
|
|
|
|
namespace clangd {
|
|
|
|
/// Gets a minimally formatted documentation comment of \p Result, with comment
|
|
/// markers stripped. See clang::RawComment::getFormattedText() for the detailed
|
|
/// explanation of how the comment text is transformed.
|
|
/// Returns empty string when no comment is available.
|
|
/// If \p CommentsFromHeaders parameter is set, only comments from the main
|
|
/// file will be returned. It is used to workaround crashes when parsing
|
|
/// comments in the stale headers, coming from completion preamble.
|
|
std::string getDocComment(const ASTContext &Ctx,
|
|
const CodeCompletionResult &Result,
|
|
bool CommentsFromHeaders);
|
|
|
|
/// Similar to getDocComment, but returns the comment for a NamedDecl.
|
|
std::string getDeclComment(const ASTContext &Ctx, const NamedDecl &D);
|
|
|
|
/// Formats the signature for an item, as a display string and snippet.
|
|
/// e.g. for const_reference std::vector<T>::at(size_type) const, this returns:
|
|
/// *Signature = "(size_type) const"
|
|
/// *Snippet = "(${1:size_type})"
|
|
/// If set, RequiredQualifiers is the text that must be typed before the name.
|
|
/// e.g "Base::" when calling a base class member function that's hidden.
|
|
///
|
|
/// When \p CompletingPattern is true, the last placeholder will be of the form
|
|
/// ${0:…}, indicating the cursor should stay there.
|
|
void getSignature(const CodeCompletionString &CCS, std::string *Signature,
|
|
std::string *Snippet,
|
|
std::string *RequiredQualifiers = nullptr,
|
|
bool CompletingPattern = false);
|
|
|
|
/// Assembles formatted documentation for a completion result. This includes
|
|
/// documentation comments and other relevant information like annotations.
|
|
///
|
|
/// \param DocComment is a documentation comment for the original declaration,
|
|
/// it should be obtained via getDocComment or getParameterDocComment.
|
|
std::string formatDocumentation(const CodeCompletionString &CCS,
|
|
llvm::StringRef DocComment);
|
|
|
|
/// Gets detail to be used as the detail field in an LSP completion item. This
|
|
/// is usually the return type of a function.
|
|
std::string getReturnType(const CodeCompletionString &CCS);
|
|
|
|
} // namespace clangd
|
|
} // namespace clang
|
|
|
|
#endif // LLVM_CLANG_TOOLS_EXTRA_CLANGD_CODECOMPLETIONSTRINGS_H
|