clang-tools  9.0.0
GoogleTidyModule.cpp
Go to the documentation of this file.
1 //===--- GoogleTidyModule.cpp - 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 #include "../ClangTidy.h"
10 #include "../ClangTidyModule.h"
11 #include "../ClangTidyModuleRegistry.h"
12 #include "../readability/BracesAroundStatementsCheck.h"
13 #include "../readability/FunctionSizeCheck.h"
14 #include "../readability/NamespaceCommentCheck.h"
15 #include "AvoidCStyleCastsCheck.h"
16 #include "AvoidNSObjectNewCheck.h"
19 #include "DefaultArgumentsCheck.h"
21 #include "ExplicitMakePairCheck.h"
22 #include "FunctionNamingCheck.h"
25 #include "IntegerTypesCheck.h"
26 #include "NonConstReferences.h"
28 #include "TodoCommentCheck.h"
31 
32 using namespace clang::ast_matchers;
33 
34 namespace clang {
35 namespace tidy {
36 namespace google {
37 
38 class GoogleModule : public ClangTidyModule {
39  public:
40  void addCheckFactories(ClangTidyCheckFactories &CheckFactories) override {
42  "google-build-explicit-make-pair");
44  "google-build-namespaces");
46  "google-build-using-namespace");
47  CheckFactories.registerCheck<DefaultArgumentsCheck>(
48  "google-default-arguments");
50  "google-explicit-constructor");
52  "google-global-names-in-headers");
54  "google-objc-avoid-nsobject-new");
56  "google-objc-avoid-throwing-exception");
58  "google-objc-function-naming");
60  "google-objc-global-variable-declaration");
62  "google-runtime-int");
64  "google-runtime-operator");
66  "google-runtime-references");
67  CheckFactories
69  "google-readability-avoid-underscore-in-googletest-name");
71  "google-readability-casting");
73  "google-readability-todo");
74  CheckFactories
76  "google-readability-braces-around-statements");
78  "google-readability-function-size");
79  CheckFactories
81  "google-readability-namespace-comments");
82  }
83 
85  ClangTidyOptions Options;
86  auto &Opts = Options.CheckOptions;
87  Opts["google-readability-braces-around-statements.ShortStatementLines"] =
88  "1";
89  Opts["google-readability-function-size.StatementThreshold"] = "800";
90  Opts["google-readability-namespace-comments.ShortNamespaceLines"] = "10";
91  Opts["google-readability-namespace-comments.SpacesBeforeComments"] = "2";
92  return Options;
93  }
94 };
95 
96 // Register the GoogleTidyModule using this statically initialized variable.
97 static ClangTidyModuleRegistry::Add<GoogleModule> X("google-module",
98  "Adds Google lint checks.");
99 
100 } // namespace google
101 
102 // This anchor is used to force the linker to link in the generated object file
103 // and thus register the GoogleModule.
104 volatile int GoogleModuleAnchorSource = 0;
105 
106 } // namespace tidy
107 } // namespace clang
volatile int GoogleModuleAnchorSource
This check finds Objective-C code that uses +new to create object instances, or overrides +new in cla...
void registerCheck(StringRef CheckName)
Registers the CheckType with the name Name.
Flag global namespace pollution in header files.
Checks that default parameters are not given for virtual methods.
Contains options for clang-tidy.
Checks the usage of non-constant references in function parameters.
Finds function names that do not conform to the recommendations of the Google Objective-C Style Guide...
Check that make_pair&#39;s template arguments are deduced.
A collection of ClangTidyCheckFactory instances.
OptionMap CheckOptions
Key-value mapping used to store check-specific options.
static ClangTidyModuleRegistry::Add< GoogleModule > X("google-module", "Adds Google lint checks.")
Checks for large functions based on various metrics.
A clang-tidy module groups a number of ClangTidyChecks and gives them a prefixed name.
ClangTidyOptions getModuleOptions() override
Gets default options for checks defined in this module.
Finds uses of short, long and long long and suggest replacing them with u?intXX(_t)?.
void addCheckFactories(ClangTidyCheckFactories &CheckFactories) override
Implement this function in order to register all CheckFactories belonging to this module...
Finds TODO comments without a username or bug number.
Checks that long namespaces have a closing comment.
===– Representation.cpp - ClangDoc Representation --------—*- C++ -*-===//
Checks that bodies of if statements and loops (for, range-for, do-while, and while) are inside braces...
The check for Objective-C global variables and constants naming convention.
Checks that all single-argument constructors are explicit.