llvm-capstone/clang-tools-extra/clangd/ASTSignals.h
David Goldman 042dd99484 [clangd] Full support for #import insertions
These are still disabled by default, but will work in ObjC code if you
enable the `-import-insertions` flag.

Completion requires ASTSignals to be available; before ASTSignals are
available, we will always use #include. Once they are available, the
behavior varies as follows:

- For source files, use #import if the ObjC language flag is enabled
- For header files:
  - If the ObjC language flag is disabled, use #include
  - If the header file contains any #imports, use #import
  - If the header file references any ObjC decls, use #import
  - Otherwise, use #include

IncludeFixer support is similar, but it does not rely upon ASTSignals,
instead it does the above checks excluding the scan for ObjC symbols.

Differential Revision: https://reviews.llvm.org/D139458
2023-01-09 09:48:30 -05:00

44 lines
1.6 KiB
C++

//===--- ASTSignals.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
//
//===----------------------------------------------------------------------===//
#ifndef LLVM_CLANG_TOOLS_EXTRA_CLANGD_ASTSIGNALS_H
#define LLVM_CLANG_TOOLS_EXTRA_CLANGD_ASTSIGNALS_H
#include "ParsedAST.h"
#include "index/Symbol.h"
#include "index/SymbolID.h"
#include "llvm/ADT/DenseMap.h"
#include "llvm/ADT/StringMap.h"
namespace clang {
namespace clangd {
/// Signals derived from a valid AST of a file.
/// Provides information that can only be extracted from the AST to actions that
/// can't access an AST. The signals are computed and updated asynchronously by
/// the ASTWorker and thus they are always stale and also can be absent.
/// Example usage: Information about the declarations used in a file affects
/// code-completion ranking in that file.
struct ASTSignals {
/// Number of occurrences of each symbol present in the file.
llvm::DenseMap<SymbolID, unsigned> ReferencedSymbols;
/// Namespaces whose symbols are used in the file, and the number of such
/// distinct symbols.
llvm::StringMap<unsigned> RelatedNamespaces;
/// Preferred preprocessor directive to use for inclusions by the file.
Symbol::IncludeDirective InsertionDirective =
Symbol::IncludeDirective::Include;
static ASTSignals derive(const ParsedAST &AST);
};
} // namespace clangd
} // namespace clang
#endif // LLVM_CLANG_TOOLS_EXTRA_CLANGD_ASTSIGNALS_H