6f23ba2555
We have a de-facto policy in clang-tidy to not qualify names unless absolutely necessary. We're *mostly* consistent about that (especially in new code), but a number of deviations have accumulated over the years. We even have cases where the same name is sometimes qualified and sometimes not *in the same file*. This makes it jarring to read the code, and, I imagine, more confusing for newcomers to contribute to the project (do I qualify X or not?). This PR tries to improve the situation and regularize the codebase.
137 lines
5.0 KiB
C++
137 lines
5.0 KiB
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_CLANG_TIDY_CLANGTIDY_H
|
|
#define LLVM_CLANG_TOOLS_EXTRA_CLANG_TIDY_CLANGTIDY_H
|
|
|
|
#include "ClangTidyDiagnosticConsumer.h"
|
|
#include "ClangTidyOptions.h"
|
|
#include "llvm/ADT/StringSet.h"
|
|
#include <memory>
|
|
#include <vector>
|
|
|
|
namespace llvm {
|
|
class raw_ostream;
|
|
} // namespace llvm
|
|
|
|
namespace clang {
|
|
|
|
class ASTConsumer;
|
|
class CompilerInstance;
|
|
namespace tooling {
|
|
class CompilationDatabase;
|
|
} // namespace tooling
|
|
|
|
namespace tidy {
|
|
|
|
class ClangTidyCheckFactories;
|
|
|
|
class ClangTidyASTConsumerFactory {
|
|
public:
|
|
ClangTidyASTConsumerFactory(
|
|
ClangTidyContext &Context,
|
|
IntrusiveRefCntPtr<llvm::vfs::OverlayFileSystem> OverlayFS = nullptr);
|
|
|
|
/// Returns an ASTConsumer that runs the specified clang-tidy checks.
|
|
std::unique_ptr<ASTConsumer> createASTConsumer(CompilerInstance &Compiler,
|
|
StringRef File);
|
|
|
|
/// Get the list of enabled checks.
|
|
std::vector<std::string> getCheckNames();
|
|
|
|
/// Get the union of options from all checks.
|
|
ClangTidyOptions::OptionMap getCheckOptions();
|
|
|
|
private:
|
|
ClangTidyContext &Context;
|
|
IntrusiveRefCntPtr<llvm::vfs::OverlayFileSystem> OverlayFS;
|
|
std::unique_ptr<ClangTidyCheckFactories> CheckFactories;
|
|
};
|
|
|
|
/// Fills the list of check names that are enabled when the provided
|
|
/// filters are applied.
|
|
std::vector<std::string> getCheckNames(const ClangTidyOptions &Options,
|
|
bool AllowEnablingAnalyzerAlphaCheckers,
|
|
bool ExperimentalCustomChecks);
|
|
|
|
struct ChecksAndOptions {
|
|
llvm::StringSet<> Checks;
|
|
llvm::StringSet<> Options;
|
|
};
|
|
|
|
ChecksAndOptions getAllChecksAndOptions(bool AllowEnablingAnalyzerAlphaCheckers,
|
|
bool ExperimentalCustomChecks);
|
|
|
|
/// Returns the effective check-specific options.
|
|
///
|
|
/// The method configures ClangTidy with the specified \p Options and collects
|
|
/// effective options from all created checks. The returned set of options
|
|
/// includes default check-specific options for all keys not overridden by \p
|
|
/// Options.
|
|
ClangTidyOptions::OptionMap
|
|
getCheckOptions(const ClangTidyOptions &Options,
|
|
bool AllowEnablingAnalyzerAlphaCheckers,
|
|
bool ExperimentalCustomChecks);
|
|
|
|
/// Filters CheckOptions in \p Options to only include options specified in
|
|
/// the \p EnabledChecks which is a sorted vector.
|
|
void filterCheckOptions(ClangTidyOptions &Options,
|
|
const std::vector<std::string> &EnabledChecks);
|
|
|
|
/// Run a set of clang-tidy checks on a set of files.
|
|
///
|
|
/// \param EnableCheckProfile If provided, it enables check profile collection
|
|
/// in MatchFinder, and will contain the result of the profile.
|
|
/// \param StoreCheckProfile If provided, and EnableCheckProfile is true,
|
|
/// the profile will not be output to stderr, but will instead be stored
|
|
/// as a JSON file in the specified directory.
|
|
std::vector<ClangTidyError>
|
|
runClangTidy(ClangTidyContext &Context,
|
|
const tooling::CompilationDatabase &Compilations,
|
|
ArrayRef<std::string> InputFiles,
|
|
llvm::IntrusiveRefCntPtr<llvm::vfs::OverlayFileSystem> BaseFS,
|
|
bool ApplyAnyFix, bool EnableCheckProfile = false,
|
|
StringRef StoreCheckProfile = {}, bool Quiet = false);
|
|
|
|
/// Controls what kind of fixes clang-tidy is allowed to apply.
|
|
enum FixBehaviour {
|
|
/// Don't try to apply any fix.
|
|
FB_NoFix,
|
|
/// Only apply fixes added to warnings.
|
|
FB_Fix,
|
|
/// Apply fixes found in notes.
|
|
FB_FixNotes
|
|
};
|
|
|
|
// FIXME: This interface will need to be significantly extended to be useful.
|
|
// FIXME: Implement confidence levels for displaying/fixing errors.
|
|
//
|
|
/// Displays the found \p Errors to the users. If \p Fix is \ref FB_Fix or \ref
|
|
/// FB_FixNotes, \p Errors containing fixes are automatically applied and
|
|
/// reformatted. If no clang-format configuration file is found, the given \P
|
|
/// FormatStyle is used.
|
|
void handleErrors(llvm::ArrayRef<ClangTidyError> Errors,
|
|
ClangTidyContext &Context, FixBehaviour Fix,
|
|
unsigned &WarningsAsErrorsCount,
|
|
llvm::IntrusiveRefCntPtr<llvm::vfs::FileSystem> BaseFS);
|
|
|
|
/// Serializes replacements into YAML and writes them to the specified
|
|
/// output stream.
|
|
void exportReplacements(StringRef MainFilePath,
|
|
const std::vector<ClangTidyError> &Errors,
|
|
raw_ostream &OS);
|
|
|
|
namespace custom {
|
|
extern void (*RegisterCustomChecks)(const ClangTidyOptions &O,
|
|
ClangTidyCheckFactories &Factories);
|
|
} // namespace custom
|
|
} // end namespace tidy
|
|
} // end namespace clang
|
|
|
|
#endif // LLVM_CLANG_TOOLS_EXTRA_CLANG_TIDY_CLANGTIDY_H
|