forked from OSchip/llvm-project
53 lines
2.1 KiB
C
53 lines
2.1 KiB
C
|
//===--- IncludeCleaner.h - Unused/Missing Headers Analysis -----*- 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
|
||
|
|
//
|
||
|
|
//===----------------------------------------------------------------------===//
|
||
|
|
///
|
||
|
|
/// \file
|
||
|
|
/// Include Cleaner is clangd functionality for providing diagnostics for misuse
|
||
|
|
/// of transitive headers and unused includes. It is inspired by
|
||
|
|
/// Include-What-You-Use tool (https://include-what-you-use.org/). Our goal is
|
||
|
|
/// to provide useful warnings in most popular scenarios but not 1:1 exact
|
||
|
|
/// feature compatibility.
|
||
|
|
///
|
||
|
|
/// FIXME(kirillbobyrev): Add support for IWYU pragmas.
|
||
|
|
/// FIXME(kirillbobyrev): Add support for standard library headers.
|
||
|
|
///
|
||
|
|
//===----------------------------------------------------------------------===//
|
||
|
|
|
||
|
|
#ifndef LLVM_CLANG_TOOLS_EXTRA_CLANGD_INCLUDE_CLEANER_H
|
||
|
|
#define LLVM_CLANG_TOOLS_EXTRA_CLANGD_INCLUDE_CLEANER_H
|
||
|
|
|
||
|
|
#include "Headers.h"
|
||
|
|
#include "ParsedAST.h"
|
||
|
|
#include "clang/Basic/SourceLocation.h"
|
||
|
|
#include "llvm/ADT/DenseSet.h"
|
||
|
|
|
||
|
|
namespace clang {
|
||
|
|
namespace clangd {
|
||
|
|
|
||
|
|
using ReferencedLocations = llvm::DenseSet<SourceLocation>;
|
||
|
|
/// Finds locations of all symbols used in the main file.
|
||
|
|
///
|
||
|
|
/// Uses RecursiveASTVisitor to go through main file AST and computes all the
|
||
|
|
/// locations used symbols are coming from. Returned locations may be macro
|
||
|
|
/// expansions, and are not resolved to their spelling/expansion location. These
|
||
|
|
/// locations are later used to determine which headers should be marked as
|
||
|
|
/// "used" and "directly used".
|
||
|
|
///
|
||
|
|
/// We use this to compute unused headers, so we:
|
||
|
|
///
|
||
|
|
/// - cover the whole file in a single traversal for efficiency
|
||
|
|
/// - don't attempt to describe where symbols were referenced from in
|
||
|
|
/// ambiguous cases (e.g. implicitly used symbols, multiple declarations)
|
||
|
|
/// - err on the side of reporting all possible locations
|
||
|
|
ReferencedLocations findReferencedLocations(ParsedAST &AST);
|
||
|
|
|
||
|
|
} // namespace clangd
|
||
|
|
} // namespace clang
|
||
|
|
|
||
|
|
#endif // LLVM_CLANG_TOOLS_EXTRA_CLANGD_INCLUDE_CLEANER_H
|