2013-03-28 02:34:38 +08:00
|
|
|
//===- extra/modularize/Modularize.cpp - Check modularized headers --------===//
|
2013-03-12 10:07:30 +08:00
|
|
|
//
|
2019-01-19 16:50:56 +08:00
|
|
|
// 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
|
2013-03-12 10:07:30 +08:00
|
|
|
//
|
|
|
|
//===----------------------------------------------------------------------===//
|
|
|
|
//
|
2015-02-20 00:47:27 +08:00
|
|
|
// Introduction
|
|
|
|
//
|
2013-03-12 10:07:30 +08:00
|
|
|
// This file implements a tool that checks whether a set of headers provides
|
2015-02-19 00:14:32 +08:00
|
|
|
// the consistent definitions required to use modules. It can also check an
|
|
|
|
// existing module map for full coverage of the headers in a directory tree.
|
|
|
|
//
|
|
|
|
// For example, in examining headers, it detects whether the same entity
|
|
|
|
// (say, a NULL macro or size_t typedef) is defined in multiple headers
|
|
|
|
// or whether a header produces different definitions under
|
2013-03-12 10:07:30 +08:00
|
|
|
// different circumstances. These conditions cause modules built from the
|
2013-03-27 09:02:46 +08:00
|
|
|
// headers to behave poorly, and should be fixed before introducing a module
|
2013-03-12 10:07:30 +08:00
|
|
|
// map.
|
|
|
|
//
|
2015-02-19 00:14:32 +08:00
|
|
|
// Modularize takes as input either one or more module maps (by default,
|
2020-01-04 23:28:41 +08:00
|
|
|
// "module.modulemap") or one or more text files containing lists of headers
|
2015-02-19 00:14:32 +08:00
|
|
|
// to check.
|
|
|
|
//
|
|
|
|
// In the case of a module map, the module map must be well-formed in
|
|
|
|
// terms of syntax. Modularize will extract the header file names
|
|
|
|
// from the map. Only normal headers are checked, assuming headers
|
|
|
|
// marked "private", "textual", or "exclude" are not to be checked
|
|
|
|
// as a top-level include, assuming they either are included by
|
|
|
|
// other headers which are checked, or they are not suitable for
|
|
|
|
// modules.
|
|
|
|
//
|
|
|
|
// In the case of a file list, the list is a newline-separated list of headers
|
|
|
|
// to check with respect to each other.
|
2013-03-27 09:02:46 +08:00
|
|
|
// Lines beginning with '#' and empty lines are ignored.
|
2013-09-05 04:46:24 +08:00
|
|
|
// Header file names followed by a colon and other space-separated
|
|
|
|
// file names will include those extra files as dependencies.
|
|
|
|
// The file names can be relative or full paths, but must be on the
|
|
|
|
// same line.
|
|
|
|
//
|
2015-02-19 00:14:32 +08:00
|
|
|
// Modularize also accepts regular clang front-end arguments.
|
2013-03-12 10:07:30 +08:00
|
|
|
//
|
2015-02-19 00:14:32 +08:00
|
|
|
// Usage: modularize [(modularize options)]
|
|
|
|
// [(include-files_list)|(module map)]+ [(front-end-options) ...]
|
2015-02-18 23:11:12 +08:00
|
|
|
//
|
|
|
|
// Options:
|
2015-06-04 09:10:19 +08:00
|
|
|
// -prefix=(optional header path prefix)
|
2015-02-18 23:11:12 +08:00
|
|
|
// Note that unless a "-prefix (header path)" option is specified,
|
|
|
|
// non-absolute file paths in the header list file will be relative
|
|
|
|
// to the header list file directory. Use -prefix to specify a
|
|
|
|
// different directory.
|
2015-06-04 09:10:19 +08:00
|
|
|
// -module-map-path=(module map)
|
2015-02-18 23:11:12 +08:00
|
|
|
// Skip the checks, and instead act as a module.map generation
|
|
|
|
// assistant, generating a module map file based on the header list.
|
|
|
|
// An optional "-root-module=(rootName)" argument can specify a root
|
|
|
|
// module to be created in the generated module.map file. Note that
|
|
|
|
// you will likely need to edit this file to suit the needs of your
|
|
|
|
// headers.
|
2015-07-10 08:37:25 +08:00
|
|
|
// -problem-files-list=(problem files list file name)
|
|
|
|
// For use only with module map assistant. Input list of files that
|
|
|
|
// have problems with respect to modules. These will still be
|
|
|
|
// included in the generated module map, but will be marked as
|
|
|
|
// "excluded" headers.
|
2015-06-04 09:10:19 +08:00
|
|
|
// -root-module=(root module name)
|
2015-02-18 23:11:12 +08:00
|
|
|
// Specifies a root module to be created in the generated module.map
|
|
|
|
// file.
|
|
|
|
// -block-check-header-list-only
|
|
|
|
// Only warn if #include directives are inside extern or namespace
|
|
|
|
// blocks if the included header is in the header list.
|
2015-02-20 00:47:27 +08:00
|
|
|
// -no-coverage-check
|
|
|
|
// Don't do the coverage check.
|
|
|
|
// -coverage-check-only
|
|
|
|
// Only do the coverage check.
|
2015-07-10 08:37:25 +08:00
|
|
|
// -display-file-lists
|
|
|
|
// Display lists of good files (no compile errors), problem files,
|
|
|
|
// and a combined list with problem files preceded by a '#'.
|
|
|
|
// This can be used to quickly determine which files have problems.
|
|
|
|
// The latter combined list might be useful in starting to modularize
|
|
|
|
// a set of headers. You can start with a full list of headers,
|
|
|
|
// use -display-file-lists option, and then use the combined list as
|
|
|
|
// your intermediate list, uncommenting-out headers as you fix them.
|
2013-03-26 09:17:48 +08:00
|
|
|
//
|
2015-05-07 02:43:01 +08:00
|
|
|
// Note that by default, the modularize assumes .h files contain C++ source.
|
|
|
|
// If your .h files in the file list contain another language, you should
|
|
|
|
// append an appropriate -x option to your command line, i.e.: -x c
|
2013-03-28 03:31:22 +08:00
|
|
|
//
|
2015-02-20 00:47:27 +08:00
|
|
|
// Modularization Issue Checks
|
|
|
|
//
|
|
|
|
// In the process of checking headers for modularization issues, modularize
|
|
|
|
// will do normal parsing, reporting normal errors and warnings,
|
2013-03-12 10:07:30 +08:00
|
|
|
// but will also report special error messages like the following:
|
|
|
|
//
|
2013-07-30 03:07:00 +08:00
|
|
|
// error: '(symbol)' defined at multiple locations:
|
|
|
|
// (file):(row):(column)
|
|
|
|
// (file):(row):(column)
|
2013-03-12 10:07:30 +08:00
|
|
|
//
|
2013-07-30 05:59:41 +08:00
|
|
|
// error: header '(file)' has different contents depending on how it was
|
2013-07-30 03:07:00 +08:00
|
|
|
// included
|
2013-03-12 10:07:30 +08:00
|
|
|
//
|
|
|
|
// The latter might be followed by messages like the following:
|
|
|
|
//
|
2013-07-30 03:07:00 +08:00
|
|
|
// note: '(symbol)' in (file) at (row):(column) not always provided
|
|
|
|
//
|
|
|
|
// Checks will also be performed for macro expansions, defined(macro)
|
|
|
|
// expressions, and preprocessor conditional directives that evaluate
|
|
|
|
// inconsistently, and can produce error messages like the following:
|
|
|
|
//
|
2013-08-12 19:43:36 +08:00
|
|
|
// (...)/SubHeader.h:11:5:
|
|
|
|
// #if SYMBOL == 1
|
|
|
|
// ^
|
|
|
|
// error: Macro instance 'SYMBOL' has different values in this header,
|
|
|
|
// depending on how it was included.
|
|
|
|
// 'SYMBOL' expanded to: '1' with respect to these inclusion paths:
|
|
|
|
// (...)/Header1.h
|
|
|
|
// (...)/SubHeader.h
|
|
|
|
// (...)/SubHeader.h:3:9:
|
|
|
|
// #define SYMBOL 1
|
|
|
|
// ^
|
|
|
|
// Macro defined here.
|
|
|
|
// 'SYMBOL' expanded to: '2' with respect to these inclusion paths:
|
|
|
|
// (...)/Header2.h
|
|
|
|
// (...)/SubHeader.h
|
|
|
|
// (...)/SubHeader.h:7:9:
|
|
|
|
// #define SYMBOL 2
|
|
|
|
// ^
|
|
|
|
// Macro defined here.
|
|
|
|
//
|
2013-09-19 02:19:43 +08:00
|
|
|
// Checks will also be performed for '#include' directives that are
|
|
|
|
// nested inside 'extern "C/C++" {}' or 'namespace (name) {}' blocks,
|
|
|
|
// and can produce error message like the following:
|
|
|
|
//
|
|
|
|
// IncludeInExtern.h:2:3
|
|
|
|
// #include "Empty.h"
|
|
|
|
// ^
|
|
|
|
// error: Include directive within extern "C" {}.
|
|
|
|
// IncludeInExtern.h:1:1
|
|
|
|
// extern "C" {
|
|
|
|
// ^
|
|
|
|
// The "extern "C" {}" block is here.
|
|
|
|
//
|
2013-08-09 08:19:03 +08:00
|
|
|
// See PreprocessorTracker.cpp for additional details.
|
2013-09-04 02:44:11 +08:00
|
|
|
//
|
2015-02-20 00:47:27 +08:00
|
|
|
// Module Map Coverage Check
|
|
|
|
//
|
|
|
|
// The coverage check uses the Clang ModuleMap class to read and parse the
|
|
|
|
// module map file. Starting at the module map file directory, or just the
|
|
|
|
// include paths, if specified, it will collect the names of all the files it
|
|
|
|
// considers headers (no extension, .h, or .inc--if you need more, modify the
|
|
|
|
// isHeader function). It then compares the headers against those referenced
|
|
|
|
// in the module map, either explicitly named, or implicitly named via an
|
|
|
|
// umbrella directory or umbrella file, as parsed by the ModuleMap object.
|
|
|
|
// If headers are found which are not referenced or covered by an umbrella
|
|
|
|
// directory or file, warning messages will be produced, and this program
|
|
|
|
// will return an error code of 1. Other errors result in an error code of 2.
|
|
|
|
// If no problems are found, an error code of 0 is returned.
|
|
|
|
//
|
|
|
|
// Note that in the case of umbrella headers, this tool invokes the compiler
|
|
|
|
// to preprocess the file, and uses a callback to collect the header files
|
|
|
|
// included by the umbrella header or any of its nested includes. If any
|
|
|
|
// front end options are needed for these compiler invocations, these
|
|
|
|
// can be included on the command line after the module map file argument.
|
|
|
|
//
|
|
|
|
// Warning message have the form:
|
|
|
|
//
|
|
|
|
// warning: module.modulemap does not account for file: Level3A.h
|
|
|
|
//
|
|
|
|
// Note that for the case of the module map referencing a file that does
|
|
|
|
// not exist, the module map parser in Clang will (at the time of this
|
|
|
|
// writing) display an error message.
|
|
|
|
//
|
|
|
|
// Module Map Assistant - Module Map Generation
|
|
|
|
//
|
2015-02-10 22:45:30 +08:00
|
|
|
// Modularize also has an option ("-module-map-path=module.modulemap") that will
|
|
|
|
// skip the checks, and instead act as a module.modulemap generation assistant,
|
2013-10-15 21:52:33 +08:00
|
|
|
// generating a module map file based on the header list. An optional
|
|
|
|
// "-root-module=(rootName)" argument can specify a root module to be
|
2015-02-10 22:45:30 +08:00
|
|
|
// created in the generated module.modulemap file. Note that you will likely
|
2013-10-15 21:52:33 +08:00
|
|
|
// need to edit this file to suit the needs of your headers.
|
|
|
|
//
|
2015-02-10 22:45:30 +08:00
|
|
|
// An example command line for generating a module.modulemap file:
|
2013-10-15 21:52:33 +08:00
|
|
|
//
|
2015-02-10 22:45:30 +08:00
|
|
|
// modularize -module-map-path=module.modulemap -root-module=myroot \
|
|
|
|
// headerlist.txt
|
2013-10-15 21:52:33 +08:00
|
|
|
//
|
|
|
|
// Note that if the headers in the header list have partial paths, sub-modules
|
2020-04-05 14:28:11 +08:00
|
|
|
// will be created for the subdirectories involved, assuming that the
|
2013-10-15 21:52:33 +08:00
|
|
|
// subdirectories contain headers to be grouped into a module, but still with
|
|
|
|
// individual modules for the headers in the subdirectory.
|
|
|
|
//
|
|
|
|
// See the ModuleAssistant.cpp file comments for additional details about the
|
|
|
|
// implementation of the assistant mode.
|
|
|
|
//
|
2013-09-04 02:48:43 +08:00
|
|
|
// Future directions:
|
|
|
|
//
|
|
|
|
// Basically, we want to add new checks for whatever we can check with respect
|
|
|
|
// to checking headers for module'ability.
|
|
|
|
//
|
|
|
|
// Some ideas:
|
|
|
|
//
|
2013-09-19 02:19:43 +08:00
|
|
|
// 1. Omit duplicate "not always provided" messages
|
2013-09-04 02:48:43 +08:00
|
|
|
//
|
2013-09-19 02:19:43 +08:00
|
|
|
// 2. Add options to disable any of the checks, in case
|
2013-09-05 02:29:36 +08:00
|
|
|
// there is some problem with them, or the messages get too verbose.
|
2013-09-04 02:48:43 +08:00
|
|
|
//
|
2013-09-19 02:19:43 +08:00
|
|
|
// 3. Try to figure out the preprocessor conditional directives that
|
2013-09-05 02:29:36 +08:00
|
|
|
// contribute to problems and tie them to the inconsistent definitions.
|
2013-09-05 00:48:28 +08:00
|
|
|
//
|
2013-09-19 02:19:43 +08:00
|
|
|
// 4. There are some legitimate uses of preprocessor macros that
|
2013-09-05 00:48:28 +08:00
|
|
|
// modularize will flag as errors, such as repeatedly #include'ing
|
|
|
|
// a file and using interleaving defined/undefined macros
|
|
|
|
// to change declarations in the included file. Is there a way
|
|
|
|
// to address this? Maybe have modularize accept a list of macros
|
|
|
|
// to ignore. Otherwise you can just exclude the file, after checking
|
|
|
|
// for legitimate errors.
|
|
|
|
//
|
2013-09-19 02:19:43 +08:00
|
|
|
// 5. What else?
|
2013-03-14 09:41:29 +08:00
|
|
|
//
|
|
|
|
// General clean-up and refactoring:
|
|
|
|
//
|
|
|
|
// 1. The Location class seems to be something that we might
|
|
|
|
// want to design to be applicable to a wider range of tools, and stick it
|
|
|
|
// somewhere into Tooling/ in mainline
|
|
|
|
//
|
2013-03-12 10:07:30 +08:00
|
|
|
//===----------------------------------------------------------------------===//
|
2013-03-27 09:02:46 +08:00
|
|
|
|
2014-01-08 04:05:01 +08:00
|
|
|
#include "Modularize.h"
|
2015-02-13 22:29:22 +08:00
|
|
|
#include "ModularizeUtilities.h"
|
2014-01-08 04:05:01 +08:00
|
|
|
#include "PreprocessorTracker.h"
|
2014-01-08 06:15:39 +08:00
|
|
|
#include "clang/AST/ASTConsumer.h"
|
2013-03-12 10:07:30 +08:00
|
|
|
#include "clang/AST/ASTContext.h"
|
|
|
|
#include "clang/AST/RecursiveASTVisitor.h"
|
2013-03-28 02:34:38 +08:00
|
|
|
#include "clang/Basic/SourceManager.h"
|
2013-09-05 04:46:24 +08:00
|
|
|
#include "clang/Driver/Options.h"
|
2013-03-12 10:07:30 +08:00
|
|
|
#include "clang/Frontend/CompilerInstance.h"
|
2019-08-30 00:38:36 +08:00
|
|
|
#include "clang/Frontend/FrontendAction.h"
|
2013-03-12 10:07:30 +08:00
|
|
|
#include "clang/Frontend/FrontendActions.h"
|
2013-03-28 02:34:38 +08:00
|
|
|
#include "clang/Lex/Preprocessor.h"
|
2013-03-12 10:07:30 +08:00
|
|
|
#include "clang/Tooling/CompilationDatabase.h"
|
|
|
|
#include "clang/Tooling/Tooling.h"
|
2013-09-05 04:46:24 +08:00
|
|
|
#include "llvm/Option/Arg.h"
|
|
|
|
#include "llvm/Option/ArgList.h"
|
|
|
|
#include "llvm/Option/OptTable.h"
|
|
|
|
#include "llvm/Option/Option.h"
|
2013-03-28 02:34:38 +08:00
|
|
|
#include "llvm/Support/CommandLine.h"
|
|
|
|
#include "llvm/Support/FileSystem.h"
|
|
|
|
#include "llvm/Support/MemoryBuffer.h"
|
|
|
|
#include "llvm/Support/Path.h"
|
2013-03-12 10:07:30 +08:00
|
|
|
#include <algorithm>
|
|
|
|
#include <iterator>
|
2013-03-28 02:34:38 +08:00
|
|
|
#include <string>
|
|
|
|
#include <vector>
|
2013-03-12 10:07:30 +08:00
|
|
|
|
2013-09-05 00:48:28 +08:00
|
|
|
using namespace clang;
|
2013-09-05 04:46:24 +08:00
|
|
|
using namespace clang::driver;
|
|
|
|
using namespace clang::driver::options;
|
|
|
|
using namespace clang::tooling;
|
2013-03-26 09:17:48 +08:00
|
|
|
using namespace llvm;
|
2013-09-05 04:46:24 +08:00
|
|
|
using namespace llvm::opt;
|
2013-07-27 07:56:42 +08:00
|
|
|
using namespace Modularize;
|
2013-03-12 10:07:30 +08:00
|
|
|
|
2013-03-28 05:23:21 +08:00
|
|
|
// Option to specify a file name for a list of header files to check.
|
2015-03-23 20:49:15 +08:00
|
|
|
static cl::list<std::string>
|
|
|
|
ListFileNames(cl::Positional, cl::value_desc("list"),
|
|
|
|
cl::desc("<list of one or more header list files>"),
|
|
|
|
cl::CommaSeparated);
|
2013-03-28 05:23:21 +08:00
|
|
|
|
|
|
|
// Collect all other arguments, which will be passed to the front end.
|
2015-03-23 20:49:15 +08:00
|
|
|
static cl::list<std::string>
|
|
|
|
CC1Arguments(cl::ConsumeAfter,
|
|
|
|
cl::desc("<arguments to be passed to front end>..."));
|
2013-03-28 05:23:21 +08:00
|
|
|
|
|
|
|
// Option to specify a prefix to be prepended to the header names.
|
2015-03-23 20:49:15 +08:00
|
|
|
static cl::opt<std::string> HeaderPrefix(
|
2013-03-28 05:23:21 +08:00
|
|
|
"prefix", cl::init(""),
|
|
|
|
cl::desc(
|
|
|
|
"Prepend header file paths with this prefix."
|
|
|
|
" If not specified,"
|
|
|
|
" the files are considered to be relative to the header list file."));
|
|
|
|
|
2013-10-15 21:52:33 +08:00
|
|
|
// Option for assistant mode, telling modularize to output a module map
|
|
|
|
// based on the headers list, and where to put it.
|
2015-03-23 20:49:15 +08:00
|
|
|
static cl::opt<std::string> ModuleMapPath(
|
2013-10-15 21:52:33 +08:00
|
|
|
"module-map-path", cl::init(""),
|
|
|
|
cl::desc("Turn on module map output and specify output path or file name."
|
|
|
|
" If no path is specified and if prefix option is specified,"
|
|
|
|
" use prefix for file path."));
|
|
|
|
|
2015-07-10 08:37:25 +08:00
|
|
|
// Option to specify list of problem files for assistant.
|
|
|
|
// This will cause assistant to exclude these files.
|
|
|
|
static cl::opt<std::string> ProblemFilesList(
|
|
|
|
"problem-files-list", cl::init(""),
|
|
|
|
cl::desc(
|
|
|
|
"List of files with compilation or modularization problems for"
|
|
|
|
" assistant mode. This will be excluded."));
|
|
|
|
|
|
|
|
// Option for assistant mode, telling modularize the name of the root module.
|
2015-03-23 20:49:15 +08:00
|
|
|
static cl::opt<std::string>
|
2013-10-15 21:52:33 +08:00
|
|
|
RootModule("root-module", cl::init(""),
|
|
|
|
cl::desc("Specify the name of the root module."));
|
|
|
|
|
2015-02-12 00:58:36 +08:00
|
|
|
// Option for limiting the #include-inside-extern-or-namespace-block
|
|
|
|
// check to only those headers explicitly listed in the header list.
|
|
|
|
// This is a work-around for private includes that purposefully get
|
|
|
|
// included inside blocks.
|
|
|
|
static cl::opt<bool>
|
|
|
|
BlockCheckHeaderListOnly("block-check-header-list-only", cl::init(false),
|
|
|
|
cl::desc("Only warn if #include directives are inside extern or namespace"
|
|
|
|
" blocks if the included header is in the header list."));
|
|
|
|
|
2015-02-20 00:47:27 +08:00
|
|
|
// Option for include paths for coverage check.
|
|
|
|
static cl::list<std::string>
|
2022-06-05 15:31:44 +08:00
|
|
|
IncludePaths("I", cl::desc("Include path for coverage check."),
|
|
|
|
cl::value_desc("path"));
|
2015-02-20 00:47:27 +08:00
|
|
|
|
2015-07-09 04:57:32 +08:00
|
|
|
// Option for disabling the coverage check.
|
2022-06-05 15:31:44 +08:00
|
|
|
static cl::opt<bool> NoCoverageCheck("no-coverage-check",
|
|
|
|
cl::desc("Don't do the coverage check."));
|
2015-02-20 00:47:27 +08:00
|
|
|
|
|
|
|
// Option for just doing the coverage check.
|
|
|
|
static cl::opt<bool>
|
|
|
|
CoverageCheckOnly("coverage-check-only", cl::init(false),
|
|
|
|
cl::desc("Only do the coverage check."));
|
|
|
|
|
2015-07-10 08:37:25 +08:00
|
|
|
// Option for displaying lists of good, bad, and mixed files.
|
|
|
|
static cl::opt<bool>
|
|
|
|
DisplayFileLists("display-file-lists", cl::init(false),
|
|
|
|
cl::desc("Display lists of good files (no compile errors), problem files,"
|
|
|
|
" and a combined list with problem files preceded by a '#'."));
|
|
|
|
|
2013-10-15 21:52:33 +08:00
|
|
|
// Save the program name for error messages.
|
|
|
|
const char *Argv0;
|
|
|
|
// Save the command line for comments.
|
|
|
|
std::string CommandLine;
|
2013-09-05 04:46:24 +08:00
|
|
|
|
|
|
|
// Helper function for finding the input file in an arguments list.
|
2015-03-23 20:49:15 +08:00
|
|
|
static std::string findInputFile(const CommandLineArguments &CLArgs) {
|
2013-09-05 04:46:24 +08:00
|
|
|
const unsigned IncludedFlagsBitmask = options::CC1Option;
|
|
|
|
unsigned MissingArgIndex, MissingArgCount;
|
|
|
|
SmallVector<const char *, 256> Argv;
|
2016-12-14 23:29:23 +08:00
|
|
|
for (auto I = CLArgs.begin(), E = CLArgs.end(); I != E; ++I)
|
2013-09-05 04:46:24 +08:00
|
|
|
Argv.push_back(I->c_str());
|
2019-09-04 22:26:28 +08:00
|
|
|
InputArgList Args = getDriverOptTable().ParseArgs(
|
|
|
|
Argv, MissingArgIndex, MissingArgCount, IncludedFlagsBitmask);
|
2015-06-23 06:06:58 +08:00
|
|
|
std::vector<std::string> Inputs = Args.getAllArgValues(OPT_INPUT);
|
2015-02-18 04:43:47 +08:00
|
|
|
return ModularizeUtilities::getCanonicalPath(Inputs.back());
|
2013-09-05 04:46:24 +08:00
|
|
|
}
|
|
|
|
|
2014-12-04 01:53:03 +08:00
|
|
|
// This arguments adjuster inserts "-include (file)" arguments for header
|
2015-07-09 05:05:57 +08:00
|
|
|
// dependencies. It also inserts a "-w" option and a "-x c++",
|
2015-05-07 02:43:01 +08:00
|
|
|
// if no other "-x" option is present.
|
2015-03-23 20:49:15 +08:00
|
|
|
static ArgumentsAdjuster
|
2015-06-04 09:10:19 +08:00
|
|
|
getModularizeArgumentsAdjuster(DependencyMap &Dependencies) {
|
2015-11-05 10:30:21 +08:00
|
|
|
return [&Dependencies](const CommandLineArguments &Args,
|
|
|
|
StringRef /*unused*/) {
|
2013-09-05 04:46:24 +08:00
|
|
|
std::string InputFile = findInputFile(Args);
|
|
|
|
DependentsVector &FileDependents = Dependencies[InputFile];
|
|
|
|
CommandLineArguments NewArgs(Args);
|
2014-12-04 01:53:03 +08:00
|
|
|
if (int Count = FileDependents.size()) {
|
|
|
|
for (int Index = 0; Index < Count; ++Index) {
|
|
|
|
NewArgs.push_back("-include");
|
|
|
|
std::string File(std::string("\"") + FileDependents[Index] +
|
|
|
|
std::string("\""));
|
|
|
|
NewArgs.push_back(FileDependents[Index]);
|
|
|
|
}
|
2013-09-05 04:46:24 +08:00
|
|
|
}
|
2015-05-07 02:43:01 +08:00
|
|
|
// Ignore warnings. (Insert after "clang_tool" at beginning.)
|
|
|
|
NewArgs.insert(NewArgs.begin() + 1, "-w");
|
|
|
|
// Since we are compiling .h files, assume C++ unless given a -x option.
|
2019-07-13 15:23:12 +08:00
|
|
|
if (!llvm::is_contained(NewArgs, "-x")) {
|
2015-05-07 02:43:01 +08:00
|
|
|
NewArgs.insert(NewArgs.begin() + 2, "-x");
|
|
|
|
NewArgs.insert(NewArgs.begin() + 3, "c++");
|
2015-09-14 19:13:39 +08:00
|
|
|
}
|
2013-09-05 04:46:24 +08:00
|
|
|
return NewArgs;
|
2014-12-04 01:53:03 +08:00
|
|
|
};
|
|
|
|
}
|
2013-09-05 04:46:24 +08:00
|
|
|
|
2013-03-14 09:41:29 +08:00
|
|
|
// FIXME: The Location class seems to be something that we might
|
|
|
|
// want to design to be applicable to a wider range of tools, and stick it
|
|
|
|
// somewhere into Tooling/ in mainline
|
2013-03-12 10:07:30 +08:00
|
|
|
struct Location {
|
|
|
|
const FileEntry *File;
|
|
|
|
unsigned Line, Column;
|
2013-03-27 09:02:46 +08:00
|
|
|
|
|
|
|
Location() : File(), Line(), Column() {}
|
|
|
|
|
2013-03-12 10:07:30 +08:00
|
|
|
Location(SourceManager &SM, SourceLocation Loc) : File(), Line(), Column() {
|
|
|
|
Loc = SM.getExpansionLoc(Loc);
|
|
|
|
if (Loc.isInvalid())
|
|
|
|
return;
|
2013-03-27 09:02:46 +08:00
|
|
|
|
2013-03-12 10:07:30 +08:00
|
|
|
std::pair<FileID, unsigned> Decomposed = SM.getDecomposedLoc(Loc);
|
|
|
|
File = SM.getFileEntryForID(Decomposed.first);
|
|
|
|
if (!File)
|
|
|
|
return;
|
2013-03-27 09:02:46 +08:00
|
|
|
|
2013-03-12 10:07:30 +08:00
|
|
|
Line = SM.getLineNumber(Decomposed.first, Decomposed.second);
|
|
|
|
Column = SM.getColumnNumber(Decomposed.first, Decomposed.second);
|
|
|
|
}
|
2013-03-27 09:02:46 +08:00
|
|
|
|
2014-06-09 10:03:06 +08:00
|
|
|
operator bool() const { return File != nullptr; }
|
2013-03-27 09:02:46 +08:00
|
|
|
|
2013-03-12 10:07:30 +08:00
|
|
|
friend bool operator==(const Location &X, const Location &Y) {
|
|
|
|
return X.File == Y.File && X.Line == Y.Line && X.Column == Y.Column;
|
|
|
|
}
|
|
|
|
|
|
|
|
friend bool operator!=(const Location &X, const Location &Y) {
|
|
|
|
return !(X == Y);
|
|
|
|
}
|
2013-03-27 09:02:46 +08:00
|
|
|
|
2013-03-12 10:07:30 +08:00
|
|
|
friend bool operator<(const Location &X, const Location &Y) {
|
|
|
|
if (X.File != Y.File)
|
|
|
|
return X.File < Y.File;
|
|
|
|
if (X.Line != Y.Line)
|
|
|
|
return X.Line < Y.Line;
|
|
|
|
return X.Column < Y.Column;
|
|
|
|
}
|
2013-03-27 09:02:46 +08:00
|
|
|
friend bool operator>(const Location &X, const Location &Y) { return Y < X; }
|
2013-03-12 10:07:30 +08:00
|
|
|
friend bool operator<=(const Location &X, const Location &Y) {
|
|
|
|
return !(Y < X);
|
|
|
|
}
|
|
|
|
friend bool operator>=(const Location &X, const Location &Y) {
|
|
|
|
return !(X < Y);
|
|
|
|
}
|
|
|
|
};
|
|
|
|
|
|
|
|
struct Entry {
|
2013-03-29 02:38:43 +08:00
|
|
|
enum EntryKind {
|
|
|
|
EK_Tag,
|
|
|
|
EK_Value,
|
|
|
|
EK_Macro,
|
|
|
|
|
|
|
|
EK_NumberOfKinds
|
2013-03-12 10:07:30 +08:00
|
|
|
} Kind;
|
2013-03-27 09:02:46 +08:00
|
|
|
|
2013-03-12 10:07:30 +08:00
|
|
|
Location Loc;
|
2013-03-28 09:20:19 +08:00
|
|
|
|
|
|
|
StringRef getKindName() { return getKindName(Kind); }
|
2013-03-29 02:38:43 +08:00
|
|
|
static StringRef getKindName(EntryKind kind);
|
2013-03-12 10:07:30 +08:00
|
|
|
};
|
|
|
|
|
2013-03-28 09:20:19 +08:00
|
|
|
// Return a string representing the given kind.
|
2013-03-29 02:38:43 +08:00
|
|
|
StringRef Entry::getKindName(Entry::EntryKind kind) {
|
2013-03-28 09:20:19 +08:00
|
|
|
switch (kind) {
|
2013-03-29 02:38:43 +08:00
|
|
|
case EK_Tag:
|
2013-03-28 09:20:19 +08:00
|
|
|
return "tag";
|
2013-03-29 02:38:43 +08:00
|
|
|
case EK_Value:
|
2013-03-28 09:20:19 +08:00
|
|
|
return "value";
|
2013-03-29 02:38:43 +08:00
|
|
|
case EK_Macro:
|
2013-03-28 09:20:19 +08:00
|
|
|
return "macro";
|
2013-03-29 02:38:43 +08:00
|
|
|
case EK_NumberOfKinds:
|
2013-03-28 09:20:19 +08:00
|
|
|
break;
|
|
|
|
}
|
2013-03-28 10:30:37 +08:00
|
|
|
llvm_unreachable("invalid Entry kind");
|
2013-03-28 09:20:19 +08:00
|
|
|
}
|
|
|
|
|
2013-03-12 10:07:30 +08:00
|
|
|
struct HeaderEntry {
|
|
|
|
std::string Name;
|
|
|
|
Location Loc;
|
2013-03-27 09:02:46 +08:00
|
|
|
|
2013-03-12 10:07:30 +08:00
|
|
|
friend bool operator==(const HeaderEntry &X, const HeaderEntry &Y) {
|
|
|
|
return X.Loc == Y.Loc && X.Name == Y.Name;
|
|
|
|
}
|
|
|
|
friend bool operator!=(const HeaderEntry &X, const HeaderEntry &Y) {
|
|
|
|
return !(X == Y);
|
|
|
|
}
|
|
|
|
friend bool operator<(const HeaderEntry &X, const HeaderEntry &Y) {
|
|
|
|
return X.Loc < Y.Loc || (X.Loc == Y.Loc && X.Name < Y.Name);
|
|
|
|
}
|
|
|
|
friend bool operator>(const HeaderEntry &X, const HeaderEntry &Y) {
|
|
|
|
return Y < X;
|
|
|
|
}
|
|
|
|
friend bool operator<=(const HeaderEntry &X, const HeaderEntry &Y) {
|
|
|
|
return !(Y < X);
|
|
|
|
}
|
|
|
|
friend bool operator>=(const HeaderEntry &X, const HeaderEntry &Y) {
|
|
|
|
return !(X < Y);
|
|
|
|
}
|
|
|
|
};
|
|
|
|
|
|
|
|
typedef std::vector<HeaderEntry> HeaderContents;
|
|
|
|
|
2013-03-27 09:02:46 +08:00
|
|
|
class EntityMap : public StringMap<SmallVector<Entry, 2> > {
|
2013-03-12 10:07:30 +08:00
|
|
|
public:
|
2013-03-27 09:02:46 +08:00
|
|
|
DenseMap<const FileEntry *, HeaderContents> HeaderContentMismatches;
|
|
|
|
|
2015-07-03 17:30:33 +08:00
|
|
|
void add(const std::string &Name, enum Entry::EntryKind Kind, Location Loc) {
|
2013-03-12 10:07:30 +08:00
|
|
|
// Record this entity in its header.
|
2015-07-03 17:30:33 +08:00
|
|
|
HeaderEntry HE = { Name, Loc };
|
2013-03-12 10:07:30 +08:00
|
|
|
CurHeaderContents[Loc.File].push_back(HE);
|
2013-03-27 09:02:46 +08:00
|
|
|
|
2013-03-12 10:07:30 +08:00
|
|
|
// Check whether we've seen this entry before.
|
2013-03-27 09:02:46 +08:00
|
|
|
SmallVector<Entry, 2> &Entries = (*this)[Name];
|
2013-03-12 10:07:30 +08:00
|
|
|
for (unsigned I = 0, N = Entries.size(); I != N; ++I) {
|
|
|
|
if (Entries[I].Kind == Kind && Entries[I].Loc == Loc)
|
|
|
|
return;
|
|
|
|
}
|
2013-03-27 09:02:46 +08:00
|
|
|
|
2013-03-12 10:07:30 +08:00
|
|
|
// We have not seen this entry before; record it.
|
|
|
|
Entry E = { Kind, Loc };
|
|
|
|
Entries.push_back(E);
|
|
|
|
}
|
2013-03-27 09:02:46 +08:00
|
|
|
|
2013-03-12 10:07:30 +08:00
|
|
|
void mergeCurHeaderContents() {
|
2013-03-27 09:02:46 +08:00
|
|
|
for (DenseMap<const FileEntry *, HeaderContents>::iterator
|
|
|
|
H = CurHeaderContents.begin(),
|
|
|
|
HEnd = CurHeaderContents.end();
|
2013-03-12 10:07:30 +08:00
|
|
|
H != HEnd; ++H) {
|
|
|
|
// Sort contents.
|
2020-03-29 02:19:55 +08:00
|
|
|
llvm::sort(H->second);
|
2013-03-12 10:07:30 +08:00
|
|
|
|
|
|
|
// Check whether we've seen this header before.
|
2013-03-27 09:02:46 +08:00
|
|
|
DenseMap<const FileEntry *, HeaderContents>::iterator KnownH =
|
|
|
|
AllHeaderContents.find(H->first);
|
2013-03-12 10:07:30 +08:00
|
|
|
if (KnownH == AllHeaderContents.end()) {
|
|
|
|
// We haven't seen this header before; record its contents.
|
|
|
|
AllHeaderContents.insert(*H);
|
|
|
|
continue;
|
|
|
|
}
|
2013-03-27 09:02:46 +08:00
|
|
|
|
2013-03-12 10:07:30 +08:00
|
|
|
// If the header contents are the same, we're done.
|
|
|
|
if (H->second == KnownH->second)
|
|
|
|
continue;
|
2013-03-27 09:02:46 +08:00
|
|
|
|
2013-03-12 10:07:30 +08:00
|
|
|
// Determine what changed.
|
2013-03-27 09:02:46 +08:00
|
|
|
std::set_symmetric_difference(
|
|
|
|
H->second.begin(), H->second.end(), KnownH->second.begin(),
|
|
|
|
KnownH->second.end(),
|
|
|
|
std::back_inserter(HeaderContentMismatches[H->first]));
|
2013-03-12 10:07:30 +08:00
|
|
|
}
|
2013-03-27 09:02:46 +08:00
|
|
|
|
2013-03-12 10:07:30 +08:00
|
|
|
CurHeaderContents.clear();
|
|
|
|
}
|
2013-06-28 02:52:23 +08:00
|
|
|
|
2013-03-13 02:51:47 +08:00
|
|
|
private:
|
2013-03-27 09:02:46 +08:00
|
|
|
DenseMap<const FileEntry *, HeaderContents> CurHeaderContents;
|
|
|
|
DenseMap<const FileEntry *, HeaderContents> AllHeaderContents;
|
2013-03-12 10:07:30 +08:00
|
|
|
};
|
|
|
|
|
2013-06-28 02:52:23 +08:00
|
|
|
class CollectEntitiesVisitor
|
|
|
|
: public RecursiveASTVisitor<CollectEntitiesVisitor> {
|
2013-03-12 10:07:30 +08:00
|
|
|
public:
|
2013-09-19 02:19:43 +08:00
|
|
|
CollectEntitiesVisitor(SourceManager &SM, EntityMap &Entities,
|
|
|
|
Preprocessor &PP, PreprocessorTracker &PPTracker,
|
|
|
|
int &HadErrors)
|
|
|
|
: SM(SM), Entities(Entities), PP(PP), PPTracker(PPTracker),
|
|
|
|
HadErrors(HadErrors) {}
|
2013-03-27 09:02:46 +08:00
|
|
|
|
2013-03-12 10:07:30 +08:00
|
|
|
bool TraverseStmt(Stmt *S) { return true; }
|
|
|
|
bool TraverseType(QualType T) { return true; }
|
|
|
|
bool TraverseTypeLoc(TypeLoc TL) { return true; }
|
|
|
|
bool TraverseNestedNameSpecifier(NestedNameSpecifier *NNS) { return true; }
|
2013-03-27 09:02:46 +08:00
|
|
|
bool TraverseNestedNameSpecifierLoc(NestedNameSpecifierLoc NNS) {
|
|
|
|
return true;
|
|
|
|
}
|
|
|
|
bool TraverseDeclarationNameInfo(DeclarationNameInfo NameInfo) {
|
|
|
|
return true;
|
|
|
|
}
|
2013-03-12 10:07:30 +08:00
|
|
|
bool TraverseTemplateName(TemplateName Template) { return true; }
|
|
|
|
bool TraverseTemplateArgument(const TemplateArgument &Arg) { return true; }
|
2013-03-27 09:02:46 +08:00
|
|
|
bool TraverseTemplateArgumentLoc(const TemplateArgumentLoc &ArgLoc) {
|
|
|
|
return true;
|
|
|
|
}
|
2013-03-12 10:07:30 +08:00
|
|
|
bool TraverseTemplateArguments(const TemplateArgument *Args,
|
2013-03-27 09:02:46 +08:00
|
|
|
unsigned NumArgs) {
|
|
|
|
return true;
|
|
|
|
}
|
2013-03-12 10:07:30 +08:00
|
|
|
bool TraverseConstructorInitializer(CXXCtorInitializer *Init) { return true; }
|
2016-08-17 23:00:22 +08:00
|
|
|
bool TraverseLambdaCapture(LambdaExpr *LE, const LambdaCapture *C,
|
|
|
|
Expr *Init) {
|
|
|
|
return true;
|
|
|
|
}
|
2013-03-27 09:02:46 +08:00
|
|
|
|
2013-09-19 02:19:43 +08:00
|
|
|
// Check 'extern "*" {}' block for #include directives.
|
|
|
|
bool VisitLinkageSpecDecl(LinkageSpecDecl *D) {
|
|
|
|
// Bail if not a block.
|
|
|
|
if (!D->hasBraces())
|
|
|
|
return true;
|
|
|
|
SourceRange BlockRange = D->getSourceRange();
|
|
|
|
const char *LinkageLabel;
|
|
|
|
switch (D->getLanguage()) {
|
|
|
|
case LinkageSpecDecl::lang_c:
|
|
|
|
LinkageLabel = "extern \"C\" {}";
|
|
|
|
break;
|
|
|
|
case LinkageSpecDecl::lang_cxx:
|
|
|
|
LinkageLabel = "extern \"C++\" {}";
|
|
|
|
break;
|
|
|
|
}
|
|
|
|
if (!PPTracker.checkForIncludesInBlock(PP, BlockRange, LinkageLabel,
|
|
|
|
errs()))
|
|
|
|
HadErrors = 1;
|
|
|
|
return true;
|
|
|
|
}
|
|
|
|
|
|
|
|
// Check 'namespace (name) {}' block for #include directives.
|
|
|
|
bool VisitNamespaceDecl(const NamespaceDecl *D) {
|
|
|
|
SourceRange BlockRange = D->getSourceRange();
|
|
|
|
std::string Label("namespace ");
|
|
|
|
Label += D->getName();
|
|
|
|
Label += " {}";
|
|
|
|
if (!PPTracker.checkForIncludesInBlock(PP, BlockRange, Label.c_str(),
|
|
|
|
errs()))
|
|
|
|
HadErrors = 1;
|
|
|
|
return true;
|
|
|
|
}
|
|
|
|
|
|
|
|
// Collect definition entities.
|
2013-03-12 10:07:30 +08:00
|
|
|
bool VisitNamedDecl(NamedDecl *ND) {
|
|
|
|
// We only care about file-context variables.
|
|
|
|
if (!ND->getDeclContext()->isFileContext())
|
|
|
|
return true;
|
2013-03-27 09:02:46 +08:00
|
|
|
|
2013-03-12 10:07:30 +08:00
|
|
|
// Skip declarations that tend to be properly multiply-declared.
|
|
|
|
if (isa<NamespaceDecl>(ND) || isa<UsingDirectiveDecl>(ND) ||
|
2013-03-27 09:02:46 +08:00
|
|
|
isa<NamespaceAliasDecl>(ND) ||
|
|
|
|
isa<ClassTemplateSpecializationDecl>(ND) || isa<UsingDecl>(ND) ||
|
2013-08-26 23:17:23 +08:00
|
|
|
isa<ClassTemplateDecl>(ND) || isa<TemplateTypeParmDecl>(ND) ||
|
2013-09-04 02:44:11 +08:00
|
|
|
isa<TypeAliasTemplateDecl>(ND) || isa<UsingShadowDecl>(ND) ||
|
|
|
|
isa<FunctionDecl>(ND) || isa<FunctionTemplateDecl>(ND) ||
|
2013-03-12 10:07:30 +08:00
|
|
|
(isa<TagDecl>(ND) &&
|
|
|
|
!cast<TagDecl>(ND)->isThisDeclarationADefinition()))
|
|
|
|
return true;
|
2013-03-27 09:02:46 +08:00
|
|
|
|
2013-08-26 23:17:23 +08:00
|
|
|
// Skip anonymous declarations.
|
|
|
|
if (!ND->getDeclName())
|
|
|
|
return true;
|
|
|
|
|
|
|
|
// Get the qualified name.
|
2013-09-04 02:44:11 +08:00
|
|
|
std::string Name;
|
|
|
|
llvm::raw_string_ostream OS(Name);
|
|
|
|
ND->printQualifiedName(OS);
|
|
|
|
OS.flush();
|
2013-03-12 10:07:30 +08:00
|
|
|
if (Name.empty())
|
|
|
|
return true;
|
2013-03-27 09:02:46 +08:00
|
|
|
|
2013-03-12 10:07:30 +08:00
|
|
|
Location Loc(SM, ND->getLocation());
|
|
|
|
if (!Loc)
|
|
|
|
return true;
|
2013-03-27 09:02:46 +08:00
|
|
|
|
2013-03-29 02:38:43 +08:00
|
|
|
Entities.add(Name, isa<TagDecl>(ND) ? Entry::EK_Tag : Entry::EK_Value, Loc);
|
2013-03-12 10:07:30 +08:00
|
|
|
return true;
|
|
|
|
}
|
2013-06-28 02:52:23 +08:00
|
|
|
|
2013-03-13 02:51:47 +08:00
|
|
|
private:
|
|
|
|
SourceManager &SM;
|
|
|
|
EntityMap &Entities;
|
2013-09-19 02:19:43 +08:00
|
|
|
Preprocessor &PP;
|
|
|
|
PreprocessorTracker &PPTracker;
|
|
|
|
int &HadErrors;
|
2013-03-12 10:07:30 +08:00
|
|
|
};
|
|
|
|
|
|
|
|
class CollectEntitiesConsumer : public ASTConsumer {
|
|
|
|
public:
|
2013-07-27 07:56:42 +08:00
|
|
|
CollectEntitiesConsumer(EntityMap &Entities,
|
|
|
|
PreprocessorTracker &preprocessorTracker,
|
2013-09-19 02:19:43 +08:00
|
|
|
Preprocessor &PP, StringRef InFile, int &HadErrors)
|
|
|
|
: Entities(Entities), PPTracker(preprocessorTracker), PP(PP),
|
|
|
|
HadErrors(HadErrors) {
|
2013-07-27 07:56:42 +08:00
|
|
|
PPTracker.handlePreprocessorEntry(PP, InFile);
|
|
|
|
}
|
|
|
|
|
2015-04-11 15:59:33 +08:00
|
|
|
~CollectEntitiesConsumer() override { PPTracker.handlePreprocessorExit(); }
|
2013-03-27 09:02:46 +08:00
|
|
|
|
2015-04-11 15:59:33 +08:00
|
|
|
void HandleTranslationUnit(ASTContext &Ctx) override {
|
2013-03-12 10:07:30 +08:00
|
|
|
SourceManager &SM = Ctx.getSourceManager();
|
2013-03-27 09:02:46 +08:00
|
|
|
|
2013-03-12 10:07:30 +08:00
|
|
|
// Collect declared entities.
|
2013-09-19 02:19:43 +08:00
|
|
|
CollectEntitiesVisitor(SM, Entities, PP, PPTracker, HadErrors)
|
2013-03-27 09:02:46 +08:00
|
|
|
.TraverseDecl(Ctx.getTranslationUnitDecl());
|
|
|
|
|
2013-03-12 10:07:30 +08:00
|
|
|
// Collect macro definitions.
|
|
|
|
for (Preprocessor::macro_iterator M = PP.macro_begin(),
|
2013-03-27 09:02:46 +08:00
|
|
|
MEnd = PP.macro_end();
|
2013-03-12 10:07:30 +08:00
|
|
|
M != MEnd; ++M) {
|
2015-04-24 04:38:48 +08:00
|
|
|
Location Loc(SM, M->second.getLatest()->getLocation());
|
2013-03-12 10:07:30 +08:00
|
|
|
if (!Loc)
|
|
|
|
continue;
|
|
|
|
|
2013-03-29 02:38:43 +08:00
|
|
|
Entities.add(M->first->getName().str(), Entry::EK_Macro, Loc);
|
2013-03-12 10:07:30 +08:00
|
|
|
}
|
2013-03-27 09:02:46 +08:00
|
|
|
|
2013-03-12 10:07:30 +08:00
|
|
|
// Merge header contents.
|
|
|
|
Entities.mergeCurHeaderContents();
|
|
|
|
}
|
2013-06-28 02:52:23 +08:00
|
|
|
|
2013-03-13 02:51:47 +08:00
|
|
|
private:
|
|
|
|
EntityMap &Entities;
|
2013-07-27 07:56:42 +08:00
|
|
|
PreprocessorTracker &PPTracker;
|
2013-03-13 02:51:47 +08:00
|
|
|
Preprocessor &PP;
|
2013-09-19 02:19:43 +08:00
|
|
|
int &HadErrors;
|
2013-03-12 10:07:30 +08:00
|
|
|
};
|
|
|
|
|
|
|
|
class CollectEntitiesAction : public SyntaxOnlyAction {
|
2013-03-13 02:51:47 +08:00
|
|
|
public:
|
2013-07-27 07:56:42 +08:00
|
|
|
CollectEntitiesAction(EntityMap &Entities,
|
2013-09-19 02:19:43 +08:00
|
|
|
PreprocessorTracker &preprocessorTracker,
|
|
|
|
int &HadErrors)
|
|
|
|
: Entities(Entities), PPTracker(preprocessorTracker),
|
|
|
|
HadErrors(HadErrors) {}
|
2013-06-28 02:52:23 +08:00
|
|
|
|
2013-03-12 10:07:30 +08:00
|
|
|
protected:
|
2014-08-11 03:56:59 +08:00
|
|
|
std::unique_ptr<clang::ASTConsumer>
|
|
|
|
CreateASTConsumer(CompilerInstance &CI, StringRef InFile) override {
|
2019-08-15 07:52:23 +08:00
|
|
|
return std::make_unique<CollectEntitiesConsumer>(
|
2014-08-11 03:56:59 +08:00
|
|
|
Entities, PPTracker, CI.getPreprocessor(), InFile, HadErrors);
|
2013-03-12 10:07:30 +08:00
|
|
|
}
|
2013-06-28 02:52:23 +08:00
|
|
|
|
2013-03-13 02:51:47 +08:00
|
|
|
private:
|
2013-03-27 09:02:46 +08:00
|
|
|
EntityMap &Entities;
|
2013-07-27 07:56:42 +08:00
|
|
|
PreprocessorTracker &PPTracker;
|
2013-09-19 02:19:43 +08:00
|
|
|
int &HadErrors;
|
2013-03-12 10:07:30 +08:00
|
|
|
};
|
|
|
|
|
|
|
|
class ModularizeFrontendActionFactory : public FrontendActionFactory {
|
|
|
|
public:
|
2013-07-27 07:56:42 +08:00
|
|
|
ModularizeFrontendActionFactory(EntityMap &Entities,
|
2013-09-19 02:19:43 +08:00
|
|
|
PreprocessorTracker &preprocessorTracker,
|
|
|
|
int &HadErrors)
|
|
|
|
: Entities(Entities), PPTracker(preprocessorTracker),
|
|
|
|
HadErrors(HadErrors) {}
|
2013-03-12 10:07:30 +08:00
|
|
|
|
2019-08-30 00:38:36 +08:00
|
|
|
std::unique_ptr<FrontendAction> create() override {
|
|
|
|
return std::make_unique<CollectEntitiesAction>(Entities, PPTracker,
|
|
|
|
HadErrors);
|
2013-03-12 10:07:30 +08:00
|
|
|
}
|
2013-06-28 02:52:23 +08:00
|
|
|
|
2013-03-13 02:51:47 +08:00
|
|
|
private:
|
2013-03-27 09:02:46 +08:00
|
|
|
EntityMap &Entities;
|
2013-07-27 07:56:42 +08:00
|
|
|
PreprocessorTracker &PPTracker;
|
2013-09-19 02:19:43 +08:00
|
|
|
int &HadErrors;
|
2013-03-12 10:07:30 +08:00
|
|
|
};
|
|
|
|
|
2015-07-10 08:37:25 +08:00
|
|
|
class CompileCheckVisitor
|
|
|
|
: public RecursiveASTVisitor<CompileCheckVisitor> {
|
|
|
|
public:
|
|
|
|
CompileCheckVisitor() {}
|
|
|
|
|
|
|
|
bool TraverseStmt(Stmt *S) { return true; }
|
|
|
|
bool TraverseType(QualType T) { return true; }
|
|
|
|
bool TraverseTypeLoc(TypeLoc TL) { return true; }
|
|
|
|
bool TraverseNestedNameSpecifier(NestedNameSpecifier *NNS) { return true; }
|
|
|
|
bool TraverseNestedNameSpecifierLoc(NestedNameSpecifierLoc NNS) {
|
|
|
|
return true;
|
|
|
|
}
|
|
|
|
bool TraverseDeclarationNameInfo(DeclarationNameInfo NameInfo) {
|
|
|
|
return true;
|
|
|
|
}
|
|
|
|
bool TraverseTemplateName(TemplateName Template) { return true; }
|
|
|
|
bool TraverseTemplateArgument(const TemplateArgument &Arg) { return true; }
|
|
|
|
bool TraverseTemplateArgumentLoc(const TemplateArgumentLoc &ArgLoc) {
|
|
|
|
return true;
|
|
|
|
}
|
|
|
|
bool TraverseTemplateArguments(const TemplateArgument *Args,
|
|
|
|
unsigned NumArgs) {
|
|
|
|
return true;
|
|
|
|
}
|
|
|
|
bool TraverseConstructorInitializer(CXXCtorInitializer *Init) { return true; }
|
2016-08-17 23:00:22 +08:00
|
|
|
bool TraverseLambdaCapture(LambdaExpr *LE, const LambdaCapture *C,
|
|
|
|
Expr *Init) {
|
|
|
|
return true;
|
|
|
|
}
|
2015-07-10 08:37:25 +08:00
|
|
|
|
|
|
|
// Check 'extern "*" {}' block for #include directives.
|
|
|
|
bool VisitLinkageSpecDecl(LinkageSpecDecl *D) {
|
|
|
|
return true;
|
|
|
|
}
|
|
|
|
|
|
|
|
// Check 'namespace (name) {}' block for #include directives.
|
|
|
|
bool VisitNamespaceDecl(const NamespaceDecl *D) {
|
|
|
|
return true;
|
|
|
|
}
|
|
|
|
|
|
|
|
// Collect definition entities.
|
|
|
|
bool VisitNamedDecl(NamedDecl *ND) {
|
|
|
|
return true;
|
|
|
|
}
|
|
|
|
};
|
|
|
|
|
|
|
|
class CompileCheckConsumer : public ASTConsumer {
|
|
|
|
public:
|
|
|
|
CompileCheckConsumer() {}
|
|
|
|
|
|
|
|
void HandleTranslationUnit(ASTContext &Ctx) override {
|
|
|
|
CompileCheckVisitor().TraverseDecl(Ctx.getTranslationUnitDecl());
|
|
|
|
}
|
|
|
|
};
|
|
|
|
|
|
|
|
class CompileCheckAction : public SyntaxOnlyAction {
|
|
|
|
public:
|
|
|
|
CompileCheckAction() {}
|
|
|
|
|
|
|
|
protected:
|
|
|
|
std::unique_ptr<clang::ASTConsumer>
|
|
|
|
CreateASTConsumer(CompilerInstance &CI, StringRef InFile) override {
|
2019-08-15 07:52:23 +08:00
|
|
|
return std::make_unique<CompileCheckConsumer>();
|
2015-07-10 08:37:25 +08:00
|
|
|
}
|
|
|
|
};
|
|
|
|
|
|
|
|
class CompileCheckFrontendActionFactory : public FrontendActionFactory {
|
|
|
|
public:
|
|
|
|
CompileCheckFrontendActionFactory() {}
|
|
|
|
|
2019-08-30 00:38:36 +08:00
|
|
|
std::unique_ptr<FrontendAction> create() override {
|
|
|
|
return std::make_unique<CompileCheckAction>();
|
2015-07-10 08:37:25 +08:00
|
|
|
}
|
|
|
|
};
|
|
|
|
|
2013-08-09 21:52:09 +08:00
|
|
|
int main(int Argc, const char **Argv) {
|
2013-03-26 09:17:48 +08:00
|
|
|
|
2013-10-15 21:52:33 +08:00
|
|
|
// Save program name for error messages.
|
|
|
|
Argv0 = Argv[0];
|
|
|
|
|
2015-02-10 22:45:30 +08:00
|
|
|
// Save program arguments for use in module.modulemap comment.
|
2020-01-29 03:23:46 +08:00
|
|
|
CommandLine = std::string(sys::path::stem(sys::path::filename(Argv0)));
|
2013-10-15 21:52:33 +08:00
|
|
|
for (int ArgIndex = 1; ArgIndex < Argc; ArgIndex++) {
|
|
|
|
CommandLine.append(" ");
|
|
|
|
CommandLine.append(Argv[ArgIndex]);
|
|
|
|
}
|
|
|
|
|
2013-03-26 09:17:48 +08:00
|
|
|
// This causes options to be parsed.
|
2013-08-09 21:52:09 +08:00
|
|
|
cl::ParseCommandLineOptions(Argc, Argv, "modularize.\n");
|
2013-03-26 09:17:48 +08:00
|
|
|
|
|
|
|
// No go if we have no header list file.
|
2015-02-13 00:22:09 +08:00
|
|
|
if (ListFileNames.size() == 0) {
|
2013-03-26 09:17:48 +08:00
|
|
|
cl::PrintHelpMessage();
|
2018-03-22 22:18:20 +08:00
|
|
|
return 1;
|
2013-03-12 10:07:30 +08:00
|
|
|
}
|
2013-03-26 09:17:48 +08:00
|
|
|
|
2015-02-13 22:29:22 +08:00
|
|
|
std::unique_ptr<ModularizeUtilities> ModUtil;
|
2015-02-20 00:47:27 +08:00
|
|
|
int HadErrors = 0;
|
|
|
|
|
2015-02-13 22:29:22 +08:00
|
|
|
ModUtil.reset(
|
|
|
|
ModularizeUtilities::createModularizeUtilities(
|
2015-07-10 08:37:25 +08:00
|
|
|
ListFileNames, HeaderPrefix, ProblemFilesList));
|
2015-02-13 22:29:22 +08:00
|
|
|
|
2013-09-05 04:46:24 +08:00
|
|
|
// Get header file names and dependencies.
|
2015-06-05 07:35:19 +08:00
|
|
|
if (ModUtil->loadAllHeaderListsAndDependencies())
|
|
|
|
HadErrors = 1;
|
2013-03-26 09:17:48 +08:00
|
|
|
|
2013-10-15 21:52:33 +08:00
|
|
|
// If we are in assistant mode, output the module map and quit.
|
2013-12-10 10:26:44 +08:00
|
|
|
if (ModuleMapPath.length() != 0) {
|
2015-02-13 22:29:22 +08:00
|
|
|
if (!createModuleMap(ModuleMapPath, ModUtil->HeaderFileNames,
|
2015-07-10 08:37:25 +08:00
|
|
|
ModUtil->ProblemFileNames,
|
2015-02-13 22:29:22 +08:00
|
|
|
ModUtil->Dependencies, HeaderPrefix, RootModule))
|
2013-10-15 21:52:33 +08:00
|
|
|
return 1; // Failed.
|
|
|
|
return 0; // Success - Skip checks in assistant mode.
|
|
|
|
}
|
|
|
|
|
2015-02-20 00:47:27 +08:00
|
|
|
// If we're doing module maps.
|
|
|
|
if (!NoCoverageCheck && ModUtil->HasModuleMap) {
|
|
|
|
// Do coverage check.
|
|
|
|
if (ModUtil->doCoverageCheck(IncludePaths, CommandLine))
|
|
|
|
HadErrors = 1;
|
|
|
|
}
|
|
|
|
|
|
|
|
// Bail early if only doing the coverage check.
|
|
|
|
if (CoverageCheckOnly)
|
|
|
|
return HadErrors;
|
|
|
|
|
2013-03-12 10:07:30 +08:00
|
|
|
// Create the compilation database.
|
2013-03-26 09:17:48 +08:00
|
|
|
SmallString<256> PathBuf;
|
2013-03-27 09:02:46 +08:00
|
|
|
sys::fs::current_path(PathBuf);
|
2014-03-09 17:24:40 +08:00
|
|
|
std::unique_ptr<CompilationDatabase> Compilations;
|
2013-03-27 09:02:46 +08:00
|
|
|
Compilations.reset(
|
|
|
|
new FixedCompilationDatabase(Twine(PathBuf), CC1Arguments));
|
2013-03-26 09:17:48 +08:00
|
|
|
|
2013-07-27 07:56:42 +08:00
|
|
|
// Create preprocessor tracker, to watch for macro and conditional problems.
|
2015-02-12 00:58:36 +08:00
|
|
|
std::unique_ptr<PreprocessorTracker> PPTracker(
|
2015-02-13 22:29:22 +08:00
|
|
|
PreprocessorTracker::create(ModUtil->HeaderFileNames,
|
|
|
|
BlockCheckHeaderListOnly));
|
2013-07-27 07:56:42 +08:00
|
|
|
|
2015-07-10 08:37:25 +08:00
|
|
|
// Coolect entities here.
|
2013-03-12 10:07:30 +08:00
|
|
|
EntityMap Entities;
|
2015-07-10 08:37:25 +08:00
|
|
|
|
|
|
|
// Because we can't easily determine which files failed
|
|
|
|
// during the tool run, if we're collecting the file lists
|
|
|
|
// for display, we do a first compile pass on individual
|
|
|
|
// files to find which ones don't compile stand-alone.
|
|
|
|
if (DisplayFileLists) {
|
|
|
|
// First, make a pass to just get compile errors.
|
|
|
|
for (auto &CompileCheckFile : ModUtil->HeaderFileNames) {
|
|
|
|
llvm::SmallVector<std::string, 32> CompileCheckFileArray;
|
|
|
|
CompileCheckFileArray.push_back(CompileCheckFile);
|
|
|
|
ClangTool CompileCheckTool(*Compilations, CompileCheckFileArray);
|
|
|
|
CompileCheckTool.appendArgumentsAdjuster(
|
|
|
|
getModularizeArgumentsAdjuster(ModUtil->Dependencies));
|
|
|
|
int CompileCheckFileErrors = 0;
|
2019-08-30 00:38:36 +08:00
|
|
|
// FIXME: use newFrontendActionFactory.
|
2015-07-10 08:37:25 +08:00
|
|
|
CompileCheckFrontendActionFactory CompileCheckFactory;
|
|
|
|
CompileCheckFileErrors |= CompileCheckTool.run(&CompileCheckFactory);
|
|
|
|
if (CompileCheckFileErrors != 0) {
|
|
|
|
ModUtil->addUniqueProblemFile(CompileCheckFile); // Save problem file.
|
|
|
|
HadErrors |= 1;
|
|
|
|
}
|
|
|
|
else
|
|
|
|
ModUtil->addNoCompileErrorsFile(CompileCheckFile); // Save good file.
|
|
|
|
}
|
|
|
|
}
|
|
|
|
|
|
|
|
// Then we make another pass on the good files to do the rest of the work.
|
|
|
|
ClangTool Tool(*Compilations,
|
|
|
|
(DisplayFileLists ? ModUtil->GoodFileNames : ModUtil->HeaderFileNames));
|
2015-06-04 09:10:19 +08:00
|
|
|
Tool.appendArgumentsAdjuster(
|
|
|
|
getModularizeArgumentsAdjuster(ModUtil->Dependencies));
|
2014-07-24 18:23:33 +08:00
|
|
|
ModularizeFrontendActionFactory Factory(Entities, *PPTracker, HadErrors);
|
|
|
|
HadErrors |= Tool.run(&Factory);
|
2013-03-14 09:41:29 +08:00
|
|
|
|
2013-03-28 09:20:19 +08:00
|
|
|
// Create a place to save duplicate entity locations, separate bins per kind.
|
|
|
|
typedef SmallVector<Location, 8> LocationArray;
|
2013-03-29 02:38:43 +08:00
|
|
|
typedef SmallVector<LocationArray, Entry::EK_NumberOfKinds> EntryBinArray;
|
2013-03-28 09:20:19 +08:00
|
|
|
EntryBinArray EntryBins;
|
2013-08-09 21:52:09 +08:00
|
|
|
int KindIndex;
|
|
|
|
for (KindIndex = 0; KindIndex < Entry::EK_NumberOfKinds; ++KindIndex) {
|
|
|
|
LocationArray Array;
|
|
|
|
EntryBins.push_back(Array);
|
2013-03-28 14:07:15 +08:00
|
|
|
}
|
2013-03-28 09:20:19 +08:00
|
|
|
|
2013-03-12 10:07:30 +08:00
|
|
|
// Check for the same entity being defined in multiple places.
|
|
|
|
for (EntityMap::iterator E = Entities.begin(), EEnd = Entities.end();
|
|
|
|
E != EEnd; ++E) {
|
2013-12-01 13:08:12 +08:00
|
|
|
// If only one occurrence, exit early.
|
2013-03-28 09:20:19 +08:00
|
|
|
if (E->second.size() == 1)
|
|
|
|
continue;
|
|
|
|
// Clear entity locations.
|
|
|
|
for (EntryBinArray::iterator CI = EntryBins.begin(), CE = EntryBins.end();
|
|
|
|
CI != CE; ++CI) {
|
2013-03-29 02:38:43 +08:00
|
|
|
CI->clear();
|
2013-03-28 09:20:19 +08:00
|
|
|
}
|
|
|
|
// Walk the entities of a single name, collecting the locations,
|
|
|
|
// separated into separate bins.
|
2013-03-12 10:07:30 +08:00
|
|
|
for (unsigned I = 0, N = E->second.size(); I != N; ++I) {
|
2013-03-29 02:38:43 +08:00
|
|
|
EntryBins[E->second[I].Kind].push_back(E->second[I].Loc);
|
2013-03-28 09:20:19 +08:00
|
|
|
}
|
|
|
|
// Report any duplicate entity definition errors.
|
2013-08-09 21:52:09 +08:00
|
|
|
int KindIndex = 0;
|
2013-03-28 09:20:19 +08:00
|
|
|
for (EntryBinArray::iterator DI = EntryBins.begin(), DE = EntryBins.end();
|
2013-08-09 21:52:09 +08:00
|
|
|
DI != DE; ++DI, ++KindIndex) {
|
|
|
|
int ECount = DI->size();
|
2015-02-20 00:47:27 +08:00
|
|
|
// If only 1 occurrence of this entity, skip it, we only report duplicates.
|
2013-08-09 21:52:09 +08:00
|
|
|
if (ECount <= 1)
|
2013-03-12 10:07:30 +08:00
|
|
|
continue;
|
2013-03-29 02:38:43 +08:00
|
|
|
LocationArray::iterator FI = DI->begin();
|
2013-08-09 21:52:09 +08:00
|
|
|
StringRef kindName = Entry::getKindName((Entry::EntryKind)KindIndex);
|
2013-03-28 09:20:19 +08:00
|
|
|
errs() << "error: " << kindName << " '" << E->first()
|
|
|
|
<< "' defined at multiple locations:\n";
|
2013-03-29 02:38:43 +08:00
|
|
|
for (LocationArray::iterator FE = DI->end(); FI != FE; ++FI) {
|
2013-03-28 09:20:19 +08:00
|
|
|
errs() << " " << FI->File->getName() << ":" << FI->Line << ":"
|
|
|
|
<< FI->Column << "\n";
|
2020-01-29 03:23:46 +08:00
|
|
|
ModUtil->addUniqueProblemFile(std::string(FI->File->getName()));
|
2013-03-12 10:07:30 +08:00
|
|
|
}
|
|
|
|
HadErrors = 1;
|
|
|
|
}
|
|
|
|
}
|
2013-03-27 09:02:46 +08:00
|
|
|
|
2013-07-27 07:56:42 +08:00
|
|
|
// Complain about macro instance in header files that differ based on how
|
|
|
|
// they are included.
|
|
|
|
if (PPTracker->reportInconsistentMacros(errs()))
|
|
|
|
HadErrors = 1;
|
|
|
|
|
|
|
|
// Complain about preprocessor conditional directives in header files that
|
|
|
|
// differ based on how they are included.
|
|
|
|
if (PPTracker->reportInconsistentConditionals(errs()))
|
|
|
|
HadErrors = 1;
|
|
|
|
|
2013-03-12 10:07:30 +08:00
|
|
|
// Complain about any headers that have contents that differ based on how
|
|
|
|
// they are included.
|
2013-03-14 09:41:29 +08:00
|
|
|
// FIXME: Could we provide information about which preprocessor conditionals
|
|
|
|
// are involved?
|
2013-03-27 09:02:46 +08:00
|
|
|
for (DenseMap<const FileEntry *, HeaderContents>::iterator
|
|
|
|
H = Entities.HeaderContentMismatches.begin(),
|
|
|
|
HEnd = Entities.HeaderContentMismatches.end();
|
2013-03-12 10:07:30 +08:00
|
|
|
H != HEnd; ++H) {
|
|
|
|
if (H->second.empty()) {
|
2013-03-27 09:02:46 +08:00
|
|
|
errs() << "internal error: phantom header content mismatch\n";
|
2013-03-12 10:07:30 +08:00
|
|
|
continue;
|
|
|
|
}
|
2013-03-27 09:02:46 +08:00
|
|
|
|
2013-03-12 10:07:30 +08:00
|
|
|
HadErrors = 1;
|
2020-01-29 03:23:46 +08:00
|
|
|
ModUtil->addUniqueProblemFile(std::string(H->first->getName()));
|
2013-03-27 09:02:46 +08:00
|
|
|
errs() << "error: header '" << H->first->getName()
|
2013-07-27 07:56:42 +08:00
|
|
|
<< "' has different contents depending on how it was included.\n";
|
2013-03-12 10:07:30 +08:00
|
|
|
for (unsigned I = 0, N = H->second.size(); I != N; ++I) {
|
2013-06-28 02:52:23 +08:00
|
|
|
errs() << "note: '" << H->second[I].Name << "' in "
|
|
|
|
<< H->second[I].Loc.File->getName() << " at "
|
|
|
|
<< H->second[I].Loc.Line << ":" << H->second[I].Loc.Column
|
|
|
|
<< " not always provided\n";
|
2013-03-12 10:07:30 +08:00
|
|
|
}
|
|
|
|
}
|
2013-03-27 09:02:46 +08:00
|
|
|
|
2015-07-10 08:37:25 +08:00
|
|
|
if (DisplayFileLists) {
|
|
|
|
ModUtil->displayProblemFiles();
|
|
|
|
ModUtil->displayGoodFiles();
|
|
|
|
ModUtil->displayCombinedFiles();
|
|
|
|
}
|
|
|
|
|
2013-03-12 10:07:30 +08:00
|
|
|
return HadErrors;
|
|
|
|
}
|