Index: tools/clang/include/clang/Tooling/CommandLineClangTool.h =================================================================== --- tools/clang/include/clang/Tooling/CommandLineClangTool.h (revision 161861) +++ tools/clang/include/clang/Tooling/CommandLineClangTool.h (working copy) @@ -1,80 +0,0 @@ -//===- CommandLineClangTool.h - command-line clang tools driver -*- C++ -*-===// -// -// The LLVM Compiler Infrastructure -// -// This file is distributed under the University of Illinois Open Source -// License. See LICENSE.TXT for details. -// -//===----------------------------------------------------------------------===// -// -// This file implements the CommandLineClangTool class used to run clang -// tools as separate command-line applications with a consistent common -// interface for handling compilation database and input files. -// -// It provides a common subset of command-line options, common algorithm -// for locating a compilation database and source files, and help messages -// for the basic command-line interface. -// -// It creates a CompilationDatabase, initializes a ClangTool and runs a -// user-specified FrontendAction over all TUs in which the given files are -// compiled. -// -// This class uses the Clang Tooling infrastructure, see -// http://clang.llvm.org/docs/HowToSetupToolingForLLVM.html -// for details on setting it up with LLVM source tree. -// -//===----------------------------------------------------------------------===// - -#ifndef LLVM_TOOLS_CLANG_INCLUDE_CLANG_TOOLING_COMMANDLINECLANGTOOL_H -#define LLVM_TOOLS_CLANG_INCLUDE_CLANG_TOOLING_COMMANDLINECLANGTOOL_H - -#include "llvm/Support/CommandLine.h" -#include "clang/Tooling/CompilationDatabase.h" - -namespace clang { - -namespace tooling { - -class CompilationDatabase; -class FrontendActionFactory; - -/// \brief A common driver for command-line Clang tools. -/// -/// Parses a common subset of command-line arguments, locates and loads a -/// compilation commands database, runs a tool with user-specified action. It -/// also contains a help message for the common command-line options. -/// An example of usage: -/// @code -/// int main(int argc, const char **argv) { -/// CommandLineClangTool Tool; -/// cl::extrahelp MoreHelp("\nMore help text..."); -/// Tool.initialize(argc, argv); -/// return Tool.run(newFrontendActionFactory()); -/// } -/// @endcode -/// -class CommandLineClangTool { -public: - /// Sets up command-line options and help messages. - /// Add your own help messages after constructing this tool. - CommandLineClangTool(); - - /// Parses command-line, initializes a compilation database. - /// This method exits program in case of error. - void initialize(int argc, const char **argv); - - /// Runs a clang tool with an action created by \c ActionFactory. - int run(FrontendActionFactory *ActionFactory); - -private: - llvm::OwningPtr Compilations; - llvm::cl::opt BuildPath; - llvm::cl::list SourcePaths; - llvm::cl::extrahelp MoreHelp; -}; - -} // namespace tooling - -} // namespace clang - -#endif // LLVM_TOOLS_CLANG_INCLUDE_CLANG_TOOLING_COMMANDLINECLANGTOOL_H Index: tools/clang/include/clang/Tooling/ToolInit.h =================================================================== --- tools/clang/include/clang/Tooling/ToolInit.h (revision 0) +++ tools/clang/include/clang/Tooling/ToolInit.h (revision 0) @@ -0,0 +1,126 @@ +//===- ToolInit.h - command-line clang tools common initialization -*- C++ -*-// +// +// The LLVM Compiler Infrastructure +// +// This file is distributed under the University of Illinois Open Source +// License. See LICENSE.TXT for details. +// +//===----------------------------------------------------------------------===// +// +// This file implements the ToolInit class used to initialize clang tools +// so that they can be run as separate command-line applications with a +// consistent common interface for handling compilation database and input +// files. +// +// It provides a common subset of command-line options, common algorithm +// for locating a compilation database and source files, and help messages +// for the basic command-line interface. +// +// It creates a CompilationDatabase and reads common command-line options. +// +// This class uses the Clang Tooling infrastructure, see +// http://clang.llvm.org/docs/HowToSetupToolingForLLVM.html +// for details on setting it up with LLVM source tree. +// +//===----------------------------------------------------------------------===// + +#ifndef LLVM_TOOLS_CLANG_INCLUDE_CLANG_TOOLING_TOOLINIT_H +#define LLVM_TOOLS_CLANG_INCLUDE_CLANG_TOOLING_TOOLINIT_H + +#include "llvm/Support/CommandLine.h" +#include "clang/Tooling/CompilationDatabase.h" +#include "clang/Frontend/FrontendActions.h" +#include "clang/Tooling/Tooling.h" + +namespace clang { +namespace tooling { +using namespace llvm; + +extern cl::extrahelp MoreHelp; +extern cl::opt BuildPath; +extern cl::list SourcePaths; + +/// \brief A common initializer for command-line Clang tools. +/// +/// Parses a common subset of command-line arguments, locates and loads a +/// compilation commands database, runs a tool with user-specified action. It +/// also contains a help message for the common command-line options. +/// An example of usage: +/// @code +/// #include "clang/Tooling/CommandLine.h" +/// +/// DEFINE_COMMON_TOOL_OPTIONS; +/// +/// cl::extrahelp MoreHelp("\nMore help text..."); +/// cl:opt YourOwnOpt(...); +/// +/// int main(int argc, const char **argv) { +/// ToolInit Init(argc, argv); +/// ClangTool Tool(*Init.Compilations, Init.SourcePathList); +/// return Tool.run(newFrontendActionFactory()); +/// } +/// @endcode +class ToolInit { +public: + // Intentionally public. + llvm::OwningPtr Compilations; + std::vector SourcePathList; + + /// Parses command-line, initializes a compilation database. + /// This method can change argc and argv contents. + /// This method exits program in case of error. + ToolInit(int &argc, const char **argv) { + Compilations.reset(FixedCompilationDatabase::loadFromCommandLine(argc, + argv)); + cl::ParseCommandLineOptions(argc, argv); + SourcePathList = SourcePaths; + if (!Compilations) { + std::string ErrorMessage; + if (!BuildPath.empty()) { + Compilations.reset(CompilationDatabase::autoDetectFromDirectory( + BuildPath, ErrorMessage)); + } else { + Compilations.reset(CompilationDatabase::autoDetectFromSource( + SourcePaths[0], ErrorMessage)); + } + if (!Compilations) + llvm::report_fatal_error(ErrorMessage); + } + } +}; + +} // namespace tooling +} // namespace clang + +// Use DEFINE_COMMON_TOOL_OPTIONS; once per tool binary, before tool's own +// options. +#define DEFINE_COMMON_TOOL_OPTIONS \ +cl::extrahelp clang::tooling::MoreHelp( \ + "\n" \ + "-p is used to read a compile command database.\n" \ + "\n" \ + "\tFor example, it can be a CMake build directory in which a file named\n" \ + "\tcompile_commands.json exists (use -DCMAKE_EXPORT_COMPILE_COMMANDS=ON\n" \ + "\tCMake option to get this output). When no build path is specified,\n" \ + "\tclang-check will attempt to locate it automatically using all parent\n" \ + "\tpaths of the first input file. See:\n" \ + "\thttp://clang.llvm.org/docs/HowToSetupToolingForLLVM.html for an\n" \ + "\texample of setting up Clang Tooling on a source tree.\n" \ + "\n" \ + " ... specify the paths of source files. These paths are\n" \ + "\tlooked up in the compile command database. If the path of a file is\n" \ + "\tabsolute, it needs to point into CMake's source tree. If the path is\n" \ + "\trelative, the current working directory needs to be in the CMake\n" \ + "\tsource tree and the file must be in a subdirectory of the current\n" \ + "\tworking directory. \"./\" prefixes in the relative files will be\n" \ + "\tautomatically removed, but the rest of a relative path must be a\n" \ + "\tsuffix of a path in the compile command database.\n" \ + "\n" \ +); \ +cl::opt clang::tooling::BuildPath( \ + "p", cl::desc("Build path"), cl::Optional); \ +cl::list clang::tooling::SourcePaths( \ + cl::Positional, cl::desc(" [... ]"), cl::OneOrMore) + + +#endif // LLVM_TOOLS_CLANG_INCLUDE_CLANG_TOOLING_TOOLINIT_H Index: tools/clang/tools/clang-check/ClangCheck.cpp =================================================================== --- tools/clang/tools/clang-check/ClangCheck.cpp (revision 161861) +++ tools/clang/tools/clang-check/ClangCheck.cpp (working copy) @@ -16,20 +16,19 @@ // //===----------------------------------------------------------------------===// -#include "llvm/Support/CommandLine.h" #include "clang/AST/ASTConsumer.h" #include "clang/Driver/OptTable.h" #include "clang/Driver/Options.h" #include "clang/Frontend/ASTConsumers.h" -#include "clang/Frontend/FrontendActions.h" -#include "clang/Tooling/CommandLineClangTool.h" -#include "clang/Tooling/Tooling.h" +#include "clang/Tooling/ToolInit.h" using namespace clang::driver; using namespace clang::tooling; using namespace llvm; -static const char *MoreHelpText = +DEFINE_COMMON_TOOL_OPTIONS; + +static cl::extrahelp MoreHelp( "\tFor example, to run clang-check on all files in a subtree of the\n" "\tsource tree, use:\n" "\n" @@ -41,26 +40,26 @@ "\n" "\tNote, that path/in/subtree and current directory should follow the\n" "\trules described above.\n" - "\n"; + "\n" +); +static OwningPtr Options(createDriverOptTable()); +static cl::opt ASTDump( + "ast-dump", + cl::desc(Options->getOptionHelpText(options::OPT_ast_dump))); +static cl::opt ASTList( + "ast-list", + cl::desc(Options->getOptionHelpText(options::OPT_ast_list))); +static cl::opt ASTPrint( + "ast-print", + cl::desc(Options->getOptionHelpText(options::OPT_ast_print))); +static cl::opt ASTDumpFilter( + "ast-dump-filter", + cl::desc(Options->getOptionHelpText(options::OPT_ast_dump_filter))); + namespace { class ActionFactory { public: - ActionFactory() - : Options(createDriverOptTable()), - ASTDump( - "ast-dump", - cl::desc(Options->getOptionHelpText(options::OPT_ast_dump))), - ASTList( - "ast-list", - cl::desc(Options->getOptionHelpText(options::OPT_ast_list))), - ASTPrint( - "ast-print", - cl::desc(Options->getOptionHelpText(options::OPT_ast_print))), - ASTDumpFilter( - "ast-dump-filter", - cl::desc(Options->getOptionHelpText(options::OPT_ast_dump_filter))) {} - clang::ASTConsumer *newASTConsumer() { if (ASTList) return clang::CreateASTDeclNodeLister(); @@ -70,19 +69,12 @@ return clang::CreateASTPrinter(&llvm::outs(), ASTDumpFilter); return new clang::ASTConsumer(); } -private: - OwningPtr Options; - cl::opt ASTDump; - cl::opt ASTList; - cl::opt ASTPrint; - cl::opt ASTDumpFilter; }; } int main(int argc, const char **argv) { ActionFactory Factory; - CommandLineClangTool Tool; - cl::extrahelp MoreHelp(MoreHelpText); - Tool.initialize(argc, argv); + ToolInit Init(argc, argv); + ClangTool Tool(*Init.Compilations, Init.SourcePathList); return Tool.run(newFrontendActionFactory(&Factory)); } Index: tools/clang/lib/Tooling/CommandLineClangTool.cpp =================================================================== --- tools/clang/lib/Tooling/CommandLineClangTool.cpp (revision 161861) +++ tools/clang/lib/Tooling/CommandLineClangTool.cpp (working copy) @@ -1,80 +0,0 @@ -//===--- CommandLineClangTool.cpp - command-line clang tools driver -------===// -// -// The LLVM Compiler Infrastructure -// -// This file is distributed under the University of Illinois Open Source -// License. See LICENSE.TXT for details. -// -//===----------------------------------------------------------------------===// -// -// This file implements the CommandLineClangTool class used to run clang -// tools as separate command-line applications with a consistent common -// interface for handling compilation database and input files. -// -// It provides a common subset of command-line options, common algorithm -// for locating a compilation database and source files, and help messages -// for the basic command-line interface. -// -// It creates a CompilationDatabase, initializes a ClangTool and runs a -// user-specified FrontendAction over all TUs in which the given files are -// compiled. -// -//===----------------------------------------------------------------------===// - -#include "clang/Frontend/FrontendActions.h" -#include "clang/Tooling/CommandLineClangTool.h" -#include "clang/Tooling/Tooling.h" - -using namespace clang::tooling; -using namespace llvm; - -static const char *MoreHelpText = - "\n" - "-p is used to read a compile command database.\n" - "\n" - "\tFor example, it can be a CMake build directory in which a file named\n" - "\tcompile_commands.json exists (use -DCMAKE_EXPORT_COMPILE_COMMANDS=ON\n" - "\tCMake option to get this output). When no build path is specified,\n" - "\tclang-check will attempt to locate it automatically using all parent\n" - "\tpaths of the first input file. See:\n" - "\thttp://clang.llvm.org/docs/HowToSetupToolingForLLVM.html for an\n" - "\texample of setting up Clang Tooling on a source tree.\n" - "\n" - " ... specify the paths of source files. These paths are looked\n" - "\tup in the compile command database. If the path of a file is absolute,\n" - "\tit needs to point into CMake's source tree. If the path is relative,\n" - "\tthe current working directory needs to be in the CMake source tree and\n" - "\tthe file must be in a subdirectory of the current working directory.\n" - "\t\"./\" prefixes in the relative files will be automatically removed,\n" - "\tbut the rest of a relative path must be a suffix of a path in the\n" - "\tcompile command database.\n" - "\n"; - -CommandLineClangTool::CommandLineClangTool() : - BuildPath("p", cl::desc("Build path"), cl::Optional), - SourcePaths(cl::Positional, cl::desc(" [... ]"), - cl::OneOrMore), - MoreHelp(MoreHelpText) { -} - -void CommandLineClangTool::initialize(int argc, const char **argv) { - Compilations.reset(FixedCompilationDatabase::loadFromCommandLine(argc, argv)); - cl::ParseCommandLineOptions(argc, argv); - if (!Compilations) { - std::string ErrorMessage; - if (!BuildPath.empty()) { - Compilations.reset(CompilationDatabase::autoDetectFromDirectory( - BuildPath, ErrorMessage)); - } else { - Compilations.reset(CompilationDatabase::autoDetectFromSource( - SourcePaths[0], ErrorMessage)); - } - if (!Compilations) - llvm::report_fatal_error(ErrorMessage); - } -} - -int CommandLineClangTool::run(FrontendActionFactory *ActionFactory) { - ClangTool Tool(*Compilations, SourcePaths); - return Tool.run(ActionFactory); -} Index: tools/clang/lib/Tooling/CMakeLists.txt =================================================================== --- tools/clang/lib/Tooling/CMakeLists.txt (revision 161861) +++ tools/clang/lib/Tooling/CMakeLists.txt (working copy) @@ -2,7 +2,6 @@ add_clang_library(clangTooling ArgumentsAdjusters.cpp - CommandLineClangTool.cpp CompilationDatabase.cpp Refactoring.cpp RefactoringCallbacks.cpp