forked from OSchip/llvm-project
60 lines
1.8 KiB
C++
60 lines
1.8 KiB
C++
//==-- SemanticHighlighting.h - Generating highlights from the AST-- 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
|
|
//
|
|
//===----------------------------------------------------------------------===//
|
|
//
|
|
// An implementation of semantic highlighting based on this proposal:
|
|
// https://github.com/microsoft/vscode-languageserver-node/pull/367 in clangd.
|
|
// Semantic highlightings are calculated for an AST by visiting every AST node
|
|
// and classifying nodes that are interesting to highlight (variables/function
|
|
// calls etc.).
|
|
//
|
|
//===----------------------------------------------------------------------===//
|
|
|
|
#ifndef LLVM_CLANG_TOOLS_EXTRA_CLANGD_SEMANTICHIGHLIGHTING_H
|
|
#define LLVM_CLANG_TOOLS_EXTRA_CLANGD_SEMANTICHIGHLIGHTING_H
|
|
|
|
#include "ClangdUnit.h"
|
|
#include "Protocol.h"
|
|
|
|
namespace clang {
|
|
namespace clangd {
|
|
|
|
enum class HighlightingKind {
|
|
Variable = 0,
|
|
Function,
|
|
Class,
|
|
Enum,
|
|
Namespace,
|
|
|
|
NumKinds,
|
|
};
|
|
|
|
// Contains all information needed for the highlighting a token.
|
|
struct HighlightingToken {
|
|
HighlightingKind Kind;
|
|
Range R;
|
|
};
|
|
|
|
bool operator==(const HighlightingToken &Lhs, const HighlightingToken &Rhs);
|
|
|
|
// Returns all HighlightingTokens from an AST. Only generates highlights for the
|
|
// main AST.
|
|
std::vector<HighlightingToken> getSemanticHighlightings(ParsedAST &AST);
|
|
|
|
/// Converts a HighlightingKind to a corresponding TextMate scope
|
|
/// (https://manual.macromates.com/en/language_grammars).
|
|
llvm::StringRef toTextMateScope(HighlightingKind Kind);
|
|
|
|
// Convert to LSP's semantic highlighting information.
|
|
std::vector<SemanticHighlightingInformation>
|
|
toSemanticHighlightingInformation(llvm::ArrayRef<HighlightingToken> Tokens);
|
|
|
|
} // namespace clangd
|
|
} // namespace clang
|
|
|
|
#endif
|