1 //===--- TidyProvider.h - create options for running clang-tidy------------===//
2 //
3 // Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions.
4 // See https://llvm.org/LICENSE.txt for license information.
5 // SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
6 //
7 //===----------------------------------------------------------------------===//
8 
9 #ifndef LLVM_CLANG_TOOLS_EXTRA_CLANGD_TIDYPROVIDER_H
10 #define LLVM_CLANG_TOOLS_EXTRA_CLANGD_TIDYPROVIDER_H
11 
12 #include "../clang-tidy/ClangTidyOptions.h"
13 #include "support/ThreadsafeFS.h"
14 #include "llvm/ADT/FunctionExtras.h"
15 #include "llvm/ADT/STLExtras.h"
16 
17 namespace clang {
18 namespace clangd {
19 
20 /// A factory to modify a \ref tidy::ClangTidyOptions.
21 using TidyProvider =
22     llvm::unique_function<void(tidy::ClangTidyOptions &,
23                                /*Filename=*/llvm::StringRef) const>;
24 
25 /// A factory to modify a \ref tidy::ClangTidyOptions that doesn't hold any
26 /// state.
27 using TidyProviderRef = llvm::function_ref<void(tidy::ClangTidyOptions &,
28                                                 /*Filename=*/llvm::StringRef)>;
29 
30 TidyProvider combine(std::vector<TidyProvider> Providers);
31 
32 /// Provider that just sets the defaults.
33 TidyProviderRef provideEnvironment();
34 
35 /// Provider that will enable a nice set of default checks if none are
36 /// specified.
37 TidyProviderRef provideDefaultChecks();
38 
39 /// Provider the enables a specific set of checks and warnings as errors.
40 TidyProvider addTidyChecks(llvm::StringRef Checks,
41                            llvm::StringRef WarningsAsErrors = {});
42 
43 /// Provider that will disable checks known to not work with clangd. \p
44 /// ExtraBadChecks specifies any other checks that should be always
45 /// disabled.
46 TidyProvider
47 disableUnusableChecks(llvm::ArrayRef<std::string> ExtraBadChecks = {});
48 
49 /// Provider that searches for .clang-tidy configuration files in the directory
50 /// tree.
51 TidyProvider provideClangTidyFiles(ThreadsafeFS &);
52 
53 // Provider that uses clangd configuration files.
54 TidyProviderRef provideClangdConfig();
55 
56 tidy::ClangTidyOptions getTidyOptionsForFile(TidyProviderRef Provider,
57                                              llvm::StringRef Filename);
58 
59 } // namespace clangd
60 } // namespace clang
61 
62 #endif // LLVM_CLANG_TOOLS_EXTRA_CLANGD_TIDYPROVIDER_H
63