clang-tools  3.8.0
Namespaces | Functions | Variables
ClangTidyMain.cpp File Reference
#include "../ClangTidy.h"
#include "clang/Tooling/CommonOptionsParser.h"
#include "llvm/Support/Process.h"
Include dependency graph for ClangTidyMain.cpp:

Go to the source code of this file.

Namespaces

 clang
 
 clang::tidy
 

Functions

static cl::OptionCategory ClangTidyCategory ("clang-tidy options")
 
static cl::extrahelp CommonHelp (CommonOptionsParser::HelpMessage)
 
static cl::extrahelp ClangTidyHelp ("Configuration files:\n"" clang-tidy attempts to read configuration for each source file from a\n"" .clang-tidy file located in the closest parent directory of the source\n"" file. If any configuration options have a corresponding command-line\n"" option, command-line option takes precedence. The effective\n"" configuration can be inspected using -dump-config:\n""\n"" $ clang-tidy -dump-config - --\n"" ---\n"" Checks: '-*,some-check'\n"" HeaderFilterRegex: ''\n"" AnalyzeTemporaryDtors: false\n"" User: user\n"" CheckOptions: \n"" - key: some-check.SomeOption\n"" value: 'some value'\n"" ...\n""\n\n")
 
static cl::opt< std::string > Checks ("checks", cl::desc("Comma-separated list of globs with optional '-'\n""prefix. Globs are processed in order of appearance\n""in the list. Globs without '-' prefix add checks\n""with matching names to the set, globs with the '-'\n""prefix remove checks with matching names from the\n""set of enabled checks.\n""This option's value is appended to the value read\n""from a .clang-tidy file, if any."), cl::init(""), cl::cat(ClangTidyCategory))
 
static cl::opt< std::string > HeaderFilter ("header-filter", cl::desc("Regular expression matching the names of the\n""headers to output diagnostics from. Diagnostics\n""from the main file of each translation unit are\n""always displayed.\n""Can be used together with -line-filter.\n""This option overrides the value read from a\n"".clang-tidy file."), cl::init(""), cl::cat(ClangTidyCategory))
 
static cl::opt< bool > SystemHeaders ("system-headers", cl::desc("Display the errors from system headers."), cl::init(false), cl::cat(ClangTidyCategory))
 
static cl::opt< std::string > LineFilter ("line-filter", cl::desc("List of files with line ranges to filter the\n""warnings. Can be used together with\n""-header-filter. The format of the list is a JSON\n""array of objects:\n"" [\n"" {\"name\":\"file1.cpp\",\"lines\":[[1,3],[5,7]]},\n"" {\"name\":\"file2.h\"}\n"" ]"), cl::init(""), cl::cat(ClangTidyCategory))
 
static cl::opt< bool > Fix ("fix", cl::desc("Apply suggested fixes. Without -fix-errors\n""clang-tidy will bail out if any compilation\n""errors were found."), cl::init(false), cl::cat(ClangTidyCategory))
 
static cl::opt< bool > FixErrors ("fix-errors", cl::desc("Apply suggested fixes even if compilation errors\n""were found. If compiler errors have attached\n""fix-its, clang-tidy will apply them as well."), cl::init(false), cl::cat(ClangTidyCategory))
 
static cl::opt< bool > ListChecks ("list-checks", cl::desc("List all enabled checks and exit. Use with\n""-checks=* to list all available checks."), cl::init(false), cl::cat(ClangTidyCategory))
 
static cl::opt< std::string > Config ("config", cl::desc("Specifies a configuration in YAML/JSON format:\n"" -config=\"{Checks: '*', CheckOptions: [{key: x, value: y}]}\"\n""When the value is empty, clang-tidy will attempt to find\n""a file named .clang-tidy for each source file in its parent\n""directories."), cl::init(""), cl::cat(ClangTidyCategory))
 
static cl::opt< bool > DumpConfig ("dump-config", cl::desc("Dumps configuration in the YAML format to stdout. This option\n""can be used along with a file name (and '--' if the file is\n""outside of a project with configured compilation database). The\n""configuration used for this file will be printed.\n""Use along with -checks=* to include configuration of all\n""checks.\n"), cl::init(false), cl::cat(ClangTidyCategory))
 
static cl::opt< bool > EnableCheckProfile ("enable-check-profile", cl::desc("Enable per-check timing profiles, and print a report to stderr."), cl::init(false), cl::cat(ClangTidyCategory))
 
static cl::opt< bool > AnalyzeTemporaryDtors ("analyze-temporary-dtors", cl::desc("Enable temporary destructor-aware analysis in\n""clang-analyzer- checks.\n""This option overrides the value read from a\n"".clang-tidy file."), cl::init(false), cl::cat(ClangTidyCategory))
 
static cl::opt< std::string > ExportFixes ("export-fixes", cl::desc("YAML file to store suggested fixes in. The\n""stored fixes can be applied to the input source\n""code with clang-apply-replacements."), cl::value_desc("filename"), cl::cat(ClangTidyCategory))
 
static void clang::tidy::printStats (const ClangTidyStats &Stats)
 
static void clang::tidy::printProfileData (const ProfileData &Profile, llvm::raw_ostream &OS)
 
static std::unique_ptr
< ClangTidyOptionsProvider > 
clang::tidy::createOptionsProvider ()
 
static int clang::tidy::clangTidyMain (int argc, const char **argv)
 
int main (int argc, const char **argv)
 

Variables

const char DefaultChecks []
 
static int LLVM_ATTRIBUTE_UNUSED clang::tidy::CERTModuleAnchorDestination
 
static int LLVM_ATTRIBUTE_UNUSED clang::tidy::LLVMModuleAnchorDestination
 
static int LLVM_ATTRIBUTE_UNUSED clang::tidy::CppCoreGuidelinesModuleAnchorDestination
 
static int LLVM_ATTRIBUTE_UNUSED clang::tidy::GoogleModuleAnchorDestination
 
static int LLVM_ATTRIBUTE_UNUSED clang::tidy::MiscModuleAnchorDestination
 
static int LLVM_ATTRIBUTE_UNUSED clang::tidy::ModernizeModuleAnchorDestination
 
static int LLVM_ATTRIBUTE_UNUSED clang::tidy::PerformanceModuleAnchorDestination
 
static int LLVM_ATTRIBUTE_UNUSED clang::tidy::ReadabilityModuleAnchorDestination
 

Function Documentation

static cl::opt<bool> AnalyzeTemporaryDtors ( "analyze-temporary-dtors"  ,
cl::  desc"Enable temporary destructor-aware analysis in\n""clang-analyzer- checks.\n""This option overrides the value read from a\n"".clang-tidy file.",
cl::  initfalse,
cl::  catClangTidyCategory 
)
static
static cl::opt<std::string> Checks ( "checks"  ,
cl::  desc"Comma-separated list of globs with optional '-'\n""prefix. Globs are processed in order of appearance\n""in the list. Globs without '-' prefix add checks\n""with matching names to the set, globs with the '-'\n""prefix remove checks with matching names from the\n""set of enabled checks.\n""This option's value is appended to the value read\n""from a .clang-tidy file, if any.",
cl::  init"",
cl::  catClangTidyCategory 
)
static
static cl::OptionCategory ClangTidyCategory ( "clang-tidy options"  )
static
static cl::extrahelp ClangTidyHelp ( "Configuration files:\n"" clang-tidy attempts to read configuration for each source file from a\n"" .clang-tidy file located in the closest parent directory of the source\n"" file. If any configuration options have a corresponding command-line\n""  option,
command-line option takes precedence.The effective\n""configuration can be inspected using-dump-config:\n""\n""$clang-tidy-dump-config---\n""---\n""Checks: '-*  ,
some-check'\n""HeaderFilterRegex: ''\n""AnalyzeTemporaryDtors:false\n""User:user\n""CheckOptions:\n""-key:some-check.SomeOption\n""value: 'some value'\n""...\n""\n\n"   
)
static
static cl::extrahelp CommonHelp ( CommonOptionsParser::HelpMessage  )
static
static cl::opt<std::string> Config ( "config"  ,
cl::  desc"Specifies a configuration in YAML/JSON format:\n"" -config=\"{Checks: '*', CheckOptions: [{key: x, value: y}]}\"\n""When the value is empty, clang-tidy will attempt to find\n""a file named .clang-tidy for each source file in its parent\n""directories.",
cl::  init"",
cl::  catClangTidyCategory 
)
static
static cl::opt<bool> DumpConfig ( "dump-config"  ,
cl::  desc"Dumps configuration in the YAML format to stdout. This option\n""can be used along with a file name (and '--' if the file is\n""outside of a project with configured compilation database). The\n""configuration used for this file will be printed.\n""Use along with -checks=* to include configuration of all\n""checks.\n",
cl::  initfalse,
cl::  catClangTidyCategory 
)
static
static cl::opt<bool> EnableCheckProfile ( "enable-check-profile"  ,
cl::  desc"Enable per-check timing profiles, and print a report to stderr.",
cl::  initfalse,
cl::  catClangTidyCategory 
)
static
static cl::opt<std::string> ExportFixes ( "export-fixes"  ,
cl::  desc"YAML file to store suggested fixes in. The\n""stored fixes can be applied to the input source\n""code with clang-apply-replacements.",
cl::  value_desc"filename",
cl::  catClangTidyCategory 
)
static
static cl::opt<bool> Fix ( "fix"  ,
cl::  desc"Apply suggested fixes. Without -fix-errors\n""clang-tidy will bail out if any compilation\n""errors were found.",
cl::  initfalse,
cl::  catClangTidyCategory 
)
static
static cl::opt<bool> FixErrors ( "fix-errors"  ,
cl::  desc"Apply suggested fixes even if compilation errors\n""were found. If compiler errors have attached\n""fix-its, clang-tidy will apply them as well.",
cl::  initfalse,
cl::  catClangTidyCategory 
)
static
static cl::opt<std::string> HeaderFilter ( "header-filter"  ,
cl::  desc"Regular expression matching the names of the\n""headers to output diagnostics from. Diagnostics\n""from the main file of each translation unit are\n""always displayed.\n""Can be used together with -line-filter.\n""This option overrides the value read from a\n"".clang-tidy file.",
cl::  init"",
cl::  catClangTidyCategory 
)
static
static cl::opt<std::string> LineFilter ( "line-filter"  ,
cl::  desc"List of files with line ranges to filter the\n""warnings. Can be used together with\n""-header-filter. The format of the list is a JSON\n""array of objects:\n"" [\n"" {\"name\":\"file1.cpp\",\"lines\":[[1,3],[5,7]]},\n"" {\"name\":\"file2.h\"}\n"" ]",
cl::  init"",
cl::  catClangTidyCategory 
)
static
static cl::opt<bool> ListChecks ( "list-checks"  ,
cl::  desc"List all enabled checks and exit. Use with\n""-checks=* to list all available checks.",
cl::  initfalse,
cl::  catClangTidyCategory 
)
static
int main ( int  argc,
const char **  argv 
)

Definition at line 393 of file ClangTidyMain.cpp.

References clang::tidy::clangTidyMain().

static cl::opt<bool> SystemHeaders ( "system-headers"  ,
cl::  desc"Display the errors from system headers.",
cl::  initfalse,
cl::  catClangTidyCategory 
)
static

Variable Documentation

const char DefaultChecks[]
Initial value:
=
"clang-diagnostic-*,"
"clang-analyzer-*,"
"-clang-analyzer-alpha*"

Definition at line 50 of file ClangTidyMain.cpp.

Referenced by clang::tidy::createOptionsProvider().