clang-tools  14.0.0git
Modularize.cpp
Go to the documentation of this file.
1 //===- extra/modularize/Modularize.cpp - Check modularized headers --------===//
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 // Introduction
10 //
11 // This file implements a tool that checks whether a set of headers provides
12 // the consistent definitions required to use modules. It can also check an
13 // existing module map for full coverage of the headers in a directory tree.
14 //
15 // For example, in examining headers, it detects whether the same entity
16 // (say, a NULL macro or size_t typedef) is defined in multiple headers
17 // or whether a header produces different definitions under
18 // different circumstances. These conditions cause modules built from the
19 // headers to behave poorly, and should be fixed before introducing a module
20 // map.
21 //
22 // Modularize takes as input either one or more module maps (by default,
23 // "module.modulemap") or one or more text files containing lists of headers
24 // to check.
25 //
26 // In the case of a module map, the module map must be well-formed in
27 // terms of syntax. Modularize will extract the header file names
28 // from the map. Only normal headers are checked, assuming headers
29 // marked "private", "textual", or "exclude" are not to be checked
30 // as a top-level include, assuming they either are included by
31 // other headers which are checked, or they are not suitable for
32 // modules.
33 //
34 // In the case of a file list, the list is a newline-separated list of headers
35 // to check with respect to each other.
36 // Lines beginning with '#' and empty lines are ignored.
37 // Header file names followed by a colon and other space-separated
38 // file names will include those extra files as dependencies.
39 // The file names can be relative or full paths, but must be on the
40 // same line.
41 //
42 // Modularize also accepts regular clang front-end arguments.
43 //
44 // Usage: modularize [(modularize options)]
45 // [(include-files_list)|(module map)]+ [(front-end-options) ...]
46 //
47 // Options:
48 // -prefix=(optional header path prefix)
49 // Note that unless a "-prefix (header path)" option is specified,
50 // non-absolute file paths in the header list file will be relative
51 // to the header list file directory. Use -prefix to specify a
52 // different directory.
53 // -module-map-path=(module map)
54 // Skip the checks, and instead act as a module.map generation
55 // assistant, generating a module map file based on the header list.
56 // An optional "-root-module=(rootName)" argument can specify a root
57 // module to be created in the generated module.map file. Note that
58 // you will likely need to edit this file to suit the needs of your
59 // headers.
60 // -problem-files-list=(problem files list file name)
61 // For use only with module map assistant. Input list of files that
62 // have problems with respect to modules. These will still be
63 // included in the generated module map, but will be marked as
64 // "excluded" headers.
65 // -root-module=(root module name)
66 // Specifies a root module to be created in the generated module.map
67 // file.
68 // -block-check-header-list-only
69 // Only warn if #include directives are inside extern or namespace
70 // blocks if the included header is in the header list.
71 // -no-coverage-check
72 // Don't do the coverage check.
73 // -coverage-check-only
74 // Only do the coverage check.
75 // -display-file-lists
76 // Display lists of good files (no compile errors), problem files,
77 // and a combined list with problem files preceded by a '#'.
78 // This can be used to quickly determine which files have problems.
79 // The latter combined list might be useful in starting to modularize
80 // a set of headers. You can start with a full list of headers,
81 // use -display-file-lists option, and then use the combined list as
82 // your intermediate list, uncommenting-out headers as you fix them.
83 //
84 // Note that by default, the modularize assumes .h files contain C++ source.
85 // If your .h files in the file list contain another language, you should
86 // append an appropriate -x option to your command line, i.e.: -x c
87 //
88 // Modularization Issue Checks
89 //
90 // In the process of checking headers for modularization issues, modularize
91 // will do normal parsing, reporting normal errors and warnings,
92 // but will also report special error messages like the following:
93 //
94 // error: '(symbol)' defined at multiple locations:
95 // (file):(row):(column)
96 // (file):(row):(column)
97 //
98 // error: header '(file)' has different contents depending on how it was
99 // included
100 //
101 // The latter might be followed by messages like the following:
102 //
103 // note: '(symbol)' in (file) at (row):(column) not always provided
104 //
105 // Checks will also be performed for macro expansions, defined(macro)
106 // expressions, and preprocessor conditional directives that evaluate
107 // inconsistently, and can produce error messages like the following:
108 //
109 // (...)/SubHeader.h:11:5:
110 // #if SYMBOL == 1
111 // ^
112 // error: Macro instance 'SYMBOL' has different values in this header,
113 // depending on how it was included.
114 // 'SYMBOL' expanded to: '1' with respect to these inclusion paths:
115 // (...)/Header1.h
116 // (...)/SubHeader.h
117 // (...)/SubHeader.h:3:9:
118 // #define SYMBOL 1
119 // ^
120 // Macro defined here.
121 // 'SYMBOL' expanded to: '2' with respect to these inclusion paths:
122 // (...)/Header2.h
123 // (...)/SubHeader.h
124 // (...)/SubHeader.h:7:9:
125 // #define SYMBOL 2
126 // ^
127 // Macro defined here.
128 //
129 // Checks will also be performed for '#include' directives that are
130 // nested inside 'extern "C/C++" {}' or 'namespace (name) {}' blocks,
131 // and can produce error message like the following:
132 //
133 // IncludeInExtern.h:2:3
134 // #include "Empty.h"
135 // ^
136 // error: Include directive within extern "C" {}.
137 // IncludeInExtern.h:1:1
138 // extern "C" {
139 // ^
140 // The "extern "C" {}" block is here.
141 //
142 // See PreprocessorTracker.cpp for additional details.
143 //
144 // Module Map Coverage Check
145 //
146 // The coverage check uses the Clang ModuleMap class to read and parse the
147 // module map file. Starting at the module map file directory, or just the
148 // include paths, if specified, it will collect the names of all the files it
149 // considers headers (no extension, .h, or .inc--if you need more, modify the
150 // isHeader function). It then compares the headers against those referenced
151 // in the module map, either explicitly named, or implicitly named via an
152 // umbrella directory or umbrella file, as parsed by the ModuleMap object.
153 // If headers are found which are not referenced or covered by an umbrella
154 // directory or file, warning messages will be produced, and this program
155 // will return an error code of 1. Other errors result in an error code of 2.
156 // If no problems are found, an error code of 0 is returned.
157 //
158 // Note that in the case of umbrella headers, this tool invokes the compiler
159 // to preprocess the file, and uses a callback to collect the header files
160 // included by the umbrella header or any of its nested includes. If any
161 // front end options are needed for these compiler invocations, these
162 // can be included on the command line after the module map file argument.
163 //
164 // Warning message have the form:
165 //
166 // warning: module.modulemap does not account for file: Level3A.h
167 //
168 // Note that for the case of the module map referencing a file that does
169 // not exist, the module map parser in Clang will (at the time of this
170 // writing) display an error message.
171 //
172 // Module Map Assistant - Module Map Generation
173 //
174 // Modularize also has an option ("-module-map-path=module.modulemap") that will
175 // skip the checks, and instead act as a module.modulemap generation assistant,
176 // generating a module map file based on the header list. An optional
177 // "-root-module=(rootName)" argument can specify a root module to be
178 // created in the generated module.modulemap file. Note that you will likely
179 // need to edit this file to suit the needs of your headers.
180 //
181 // An example command line for generating a module.modulemap file:
182 //
183 // modularize -module-map-path=module.modulemap -root-module=myroot \
184 // headerlist.txt
185 //
186 // Note that if the headers in the header list have partial paths, sub-modules
187 // will be created for the subdirectories involved, assuming that the
188 // subdirectories contain headers to be grouped into a module, but still with
189 // individual modules for the headers in the subdirectory.
190 //
191 // See the ModuleAssistant.cpp file comments for additional details about the
192 // implementation of the assistant mode.
193 //
194 // Future directions:
195 //
196 // Basically, we want to add new checks for whatever we can check with respect
197 // to checking headers for module'ability.
198 //
199 // Some ideas:
200 //
201 // 1. Omit duplicate "not always provided" messages
202 //
203 // 2. Add options to disable any of the checks, in case
204 // there is some problem with them, or the messages get too verbose.
205 //
206 // 3. Try to figure out the preprocessor conditional directives that
207 // contribute to problems and tie them to the inconsistent definitions.
208 //
209 // 4. There are some legitimate uses of preprocessor macros that
210 // modularize will flag as errors, such as repeatedly #include'ing
211 // a file and using interleaving defined/undefined macros
212 // to change declarations in the included file. Is there a way
213 // to address this? Maybe have modularize accept a list of macros
214 // to ignore. Otherwise you can just exclude the file, after checking
215 // for legitimate errors.
216 //
217 // 5. What else?
218 //
219 // General clean-up and refactoring:
220 //
221 // 1. The Location class seems to be something that we might
222 // want to design to be applicable to a wider range of tools, and stick it
223 // somewhere into Tooling/ in mainline
224 //
225 //===----------------------------------------------------------------------===//
226 
227 #include "Modularize.h"
228 #include "ModularizeUtilities.h"
229 #include "PreprocessorTracker.h"
230 #include "clang/AST/ASTConsumer.h"
231 #include "clang/AST/ASTContext.h"
232 #include "clang/AST/RecursiveASTVisitor.h"
233 #include "clang/Basic/SourceManager.h"
234 #include "clang/Driver/Options.h"
235 #include "clang/Frontend/CompilerInstance.h"
236 #include "clang/Frontend/FrontendAction.h"
237 #include "clang/Frontend/FrontendActions.h"
238 #include "clang/Lex/Preprocessor.h"
239 #include "clang/Tooling/CompilationDatabase.h"
240 #include "clang/Tooling/Tooling.h"
241 #include "llvm/Option/Arg.h"
242 #include "llvm/Option/ArgList.h"
243 #include "llvm/Option/OptTable.h"
244 #include "llvm/Option/Option.h"
245 #include "llvm/Support/CommandLine.h"
246 #include "llvm/Support/FileSystem.h"
247 #include "llvm/Support/MemoryBuffer.h"
248 #include "llvm/Support/Path.h"
249 #include <algorithm>
250 #include <iterator>
251 #include <string>
252 #include <vector>
253 
254 using namespace clang;
255 using namespace clang::driver;
256 using namespace clang::driver::options;
257 using namespace clang::tooling;
258 using namespace llvm;
259 using namespace llvm::opt;
260 using namespace Modularize;
261 
262 // Option to specify a file name for a list of header files to check.
263 static cl::list<std::string>
264  ListFileNames(cl::Positional, cl::value_desc("list"),
265  cl::desc("<list of one or more header list files>"),
266  cl::CommaSeparated);
267 
268 // Collect all other arguments, which will be passed to the front end.
269 static cl::list<std::string>
270  CC1Arguments(cl::ConsumeAfter,
271  cl::desc("<arguments to be passed to front end>..."));
272 
273 // Option to specify a prefix to be prepended to the header names.
274 static cl::opt<std::string> HeaderPrefix(
275  "prefix", cl::init(""),
276  cl::desc(
277  "Prepend header file paths with this prefix."
278  " If not specified,"
279  " the files are considered to be relative to the header list file."));
280 
281 // Option for assistant mode, telling modularize to output a module map
282 // based on the headers list, and where to put it.
283 static cl::opt<std::string> ModuleMapPath(
284  "module-map-path", cl::init(""),
285  cl::desc("Turn on module map output and specify output path or file name."
286  " If no path is specified and if prefix option is specified,"
287  " use prefix for file path."));
288 
289 // Option to specify list of problem files for assistant.
290 // This will cause assistant to exclude these files.
291 static cl::opt<std::string> ProblemFilesList(
292  "problem-files-list", cl::init(""),
293  cl::desc(
294  "List of files with compilation or modularization problems for"
295  " assistant mode. This will be excluded."));
296 
297 // Option for assistant mode, telling modularize the name of the root module.
298 static cl::opt<std::string>
299 RootModule("root-module", cl::init(""),
300  cl::desc("Specify the name of the root module."));
301 
302 // Option for limiting the #include-inside-extern-or-namespace-block
303 // check to only those headers explicitly listed in the header list.
304 // This is a work-around for private includes that purposefully get
305 // included inside blocks.
306 static cl::opt<bool>
307 BlockCheckHeaderListOnly("block-check-header-list-only", cl::init(false),
308 cl::desc("Only warn if #include directives are inside extern or namespace"
309  " blocks if the included header is in the header list."));
310 
311 // Option for include paths for coverage check.
312 static cl::list<std::string>
313 IncludePaths("I", cl::desc("Include path for coverage check."),
314 cl::ZeroOrMore, cl::value_desc("path"));
315 
316 // Option for disabling the coverage check.
317 static cl::opt<bool>
318 NoCoverageCheck("no-coverage-check", cl::init(false),
319 cl::desc("Don't do the coverage check."));
320 
321 // Option for just doing the coverage check.
322 static cl::opt<bool>
323 CoverageCheckOnly("coverage-check-only", cl::init(false),
324 cl::desc("Only do the coverage check."));
325 
326 // Option for displaying lists of good, bad, and mixed files.
327 static cl::opt<bool>
328 DisplayFileLists("display-file-lists", cl::init(false),
329 cl::desc("Display lists of good files (no compile errors), problem files,"
330  " and a combined list with problem files preceded by a '#'."));
331 
332 // Save the program name for error messages.
333 const char *Argv0;
334 // Save the command line for comments.
335 std::string CommandLine;
336 
337 // Helper function for finding the input file in an arguments list.
338 static std::string findInputFile(const CommandLineArguments &CLArgs) {
339  const unsigned IncludedFlagsBitmask = options::CC1Option;
340  unsigned MissingArgIndex, MissingArgCount;
341  SmallVector<const char *, 256> Argv;
342  for (auto I = CLArgs.begin(), E = CLArgs.end(); I != E; ++I)
343  Argv.push_back(I->c_str());
344  InputArgList Args = getDriverOptTable().ParseArgs(
345  Argv, MissingArgIndex, MissingArgCount, IncludedFlagsBitmask);
346  std::vector<std::string> Inputs = Args.getAllArgValues(OPT_INPUT);
348 }
349 
350 // This arguments adjuster inserts "-include (file)" arguments for header
351 // dependencies. It also inserts a "-w" option and a "-x c++",
352 // if no other "-x" option is present.
353 static ArgumentsAdjuster
355  return [&Dependencies](const CommandLineArguments &Args,
356  StringRef /*unused*/) {
357  std::string InputFile = findInputFile(Args);
358  DependentsVector &FileDependents = Dependencies[InputFile];
359  CommandLineArguments NewArgs(Args);
360  if (int Count = FileDependents.size()) {
361  for (int Index = 0; Index < Count; ++Index) {
362  NewArgs.push_back("-include");
363  std::string File(std::string("\"") + FileDependents[Index] +
364  std::string("\""));
365  NewArgs.push_back(FileDependents[Index]);
366  }
367  }
368  // Ignore warnings. (Insert after "clang_tool" at beginning.)
369  NewArgs.insert(NewArgs.begin() + 1, "-w");
370  // Since we are compiling .h files, assume C++ unless given a -x option.
371  if (!llvm::is_contained(NewArgs, "-x")) {
372  NewArgs.insert(NewArgs.begin() + 2, "-x");
373  NewArgs.insert(NewArgs.begin() + 3, "c++");
374  }
375  return NewArgs;
376  };
377 }
378 
379 // FIXME: The Location class seems to be something that we might
380 // want to design to be applicable to a wider range of tools, and stick it
381 // somewhere into Tooling/ in mainline
382 struct Location {
383  const FileEntry *File;
384  unsigned Line, Column;
385 
386  Location() : File(), Line(), Column() {}
387 
388  Location(SourceManager &SM, SourceLocation Loc) : File(), Line(), Column() {
389  Loc = SM.getExpansionLoc(Loc);
390  if (Loc.isInvalid())
391  return;
392 
393  std::pair<FileID, unsigned> Decomposed = SM.getDecomposedLoc(Loc);
394  File = SM.getFileEntryForID(Decomposed.first);
395  if (!File)
396  return;
397 
398  Line = SM.getLineNumber(Decomposed.first, Decomposed.second);
399  Column = SM.getColumnNumber(Decomposed.first, Decomposed.second);
400  }
401 
402  operator bool() const { return File != nullptr; }
403 
404  friend bool operator==(const Location &X, const Location &Y) {
405  return X.File == Y.File && X.Line == Y.Line && X.Column == Y.Column;
406  }
407 
408  friend bool operator!=(const Location &X, const Location &Y) {
409  return !(X == Y);
410  }
411 
412  friend bool operator<(const Location &X, const Location &Y) {
413  if (X.File != Y.File)
414  return X.File < Y.File;
415  if (X.Line != Y.Line)
416  return X.Line < Y.Line;
417  return X.Column < Y.Column;
418  }
419  friend bool operator>(const Location &X, const Location &Y) { return Y < X; }
420  friend bool operator<=(const Location &X, const Location &Y) {
421  return !(Y < X);
422  }
423  friend bool operator>=(const Location &X, const Location &Y) {
424  return !(X < Y);
425  }
426 };
427 
428 struct Entry {
429  enum EntryKind {
433 
434  EK_NumberOfKinds
435  } Kind;
436 
438 
439  StringRef getKindName() { return getKindName(Kind); }
440  static StringRef getKindName(EntryKind kind);
441 };
442 
443 // Return a string representing the given kind.
445  switch (kind) {
446  case EK_Tag:
447  return "tag";
448  case EK_Value:
449  return "value";
450  case EK_Macro:
451  return "macro";
452  case EK_NumberOfKinds:
453  break;
454  }
455  llvm_unreachable("invalid Entry kind");
456 }
457 
458 struct HeaderEntry {
459  std::string Name;
461 
462  friend bool operator==(const HeaderEntry &X, const HeaderEntry &Y) {
463  return X.Loc == Y.Loc && X.Name == Y.Name;
464  }
465  friend bool operator!=(const HeaderEntry &X, const HeaderEntry &Y) {
466  return !(X == Y);
467  }
468  friend bool operator<(const HeaderEntry &X, const HeaderEntry &Y) {
469  return X.Loc < Y.Loc || (X.Loc == Y.Loc && X.Name < Y.Name);
470  }
471  friend bool operator>(const HeaderEntry &X, const HeaderEntry &Y) {
472  return Y < X;
473  }
474  friend bool operator<=(const HeaderEntry &X, const HeaderEntry &Y) {
475  return !(Y < X);
476  }
477  friend bool operator>=(const HeaderEntry &X, const HeaderEntry &Y) {
478  return !(X < Y);
479  }
480 };
481 
482 typedef std::vector<HeaderEntry> HeaderContents;
483 
484 class EntityMap : public StringMap<SmallVector<Entry, 2> > {
485 public:
486  DenseMap<const FileEntry *, HeaderContents> HeaderContentMismatches;
487 
488  void add(const std::string &Name, enum Entry::EntryKind Kind, Location Loc) {
489  // Record this entity in its header.
490  HeaderEntry HE = { Name, Loc };
491  CurHeaderContents[Loc.File].push_back(HE);
492 
493  // Check whether we've seen this entry before.
494  SmallVector<Entry, 2> &Entries = (*this)[Name];
495  for (unsigned I = 0, N = Entries.size(); I != N; ++I) {
496  if (Entries[I].Kind == Kind && Entries[I].Loc == Loc)
497  return;
498  }
499 
500  // We have not seen this entry before; record it.
501  Entry E = { Kind, Loc };
502  Entries.push_back(E);
503  }
504 
506  for (DenseMap<const FileEntry *, HeaderContents>::iterator
507  H = CurHeaderContents.begin(),
508  HEnd = CurHeaderContents.end();
509  H != HEnd; ++H) {
510  // Sort contents.
511  llvm::sort(H->second);
512 
513  // Check whether we've seen this header before.
514  DenseMap<const FileEntry *, HeaderContents>::iterator KnownH =
515  AllHeaderContents.find(H->first);
516  if (KnownH == AllHeaderContents.end()) {
517  // We haven't seen this header before; record its contents.
518  AllHeaderContents.insert(*H);
519  continue;
520  }
521 
522  // If the header contents are the same, we're done.
523  if (H->second == KnownH->second)
524  continue;
525 
526  // Determine what changed.
527  std::set_symmetric_difference(
528  H->second.begin(), H->second.end(), KnownH->second.begin(),
529  KnownH->second.end(),
530  std::back_inserter(HeaderContentMismatches[H->first]));
531  }
532 
533  CurHeaderContents.clear();
534  }
535 
536 private:
537  DenseMap<const FileEntry *, HeaderContents> CurHeaderContents;
538  DenseMap<const FileEntry *, HeaderContents> AllHeaderContents;
539 };
540 
542  : public RecursiveASTVisitor<CollectEntitiesVisitor> {
543 public:
544  CollectEntitiesVisitor(SourceManager &SM, EntityMap &Entities,
545  Preprocessor &PP, PreprocessorTracker &PPTracker,
546  int &HadErrors)
547  : SM(SM), Entities(Entities), PP(PP), PPTracker(PPTracker),
548  HadErrors(HadErrors) {}
549 
550  bool TraverseStmt(Stmt *S) { return true; }
551  bool TraverseType(QualType T) { return true; }
552  bool TraverseTypeLoc(TypeLoc TL) { return true; }
553  bool TraverseNestedNameSpecifier(NestedNameSpecifier *NNS) { return true; }
554  bool TraverseNestedNameSpecifierLoc(NestedNameSpecifierLoc NNS) {
555  return true;
556  }
557  bool TraverseDeclarationNameInfo(DeclarationNameInfo NameInfo) {
558  return true;
559  }
560  bool TraverseTemplateName(TemplateName Template) { return true; }
561  bool TraverseTemplateArgument(const TemplateArgument &Arg) { return true; }
562  bool TraverseTemplateArgumentLoc(const TemplateArgumentLoc &ArgLoc) {
563  return true;
564  }
565  bool TraverseTemplateArguments(const TemplateArgument *Args,
566  unsigned NumArgs) {
567  return true;
568  }
569  bool TraverseConstructorInitializer(CXXCtorInitializer *Init) { return true; }
570  bool TraverseLambdaCapture(LambdaExpr *LE, const LambdaCapture *C,
571  Expr *Init) {
572  return true;
573  }
574 
575  // Check 'extern "*" {}' block for #include directives.
576  bool VisitLinkageSpecDecl(LinkageSpecDecl *D) {
577  // Bail if not a block.
578  if (!D->hasBraces())
579  return true;
580  SourceRange BlockRange = D->getSourceRange();
581  const char *LinkageLabel;
582  switch (D->getLanguage()) {
583  case LinkageSpecDecl::lang_c:
584  LinkageLabel = "extern \"C\" {}";
585  break;
586  case LinkageSpecDecl::lang_cxx:
587  LinkageLabel = "extern \"C++\" {}";
588  break;
589  }
590  if (!PPTracker.checkForIncludesInBlock(PP, BlockRange, LinkageLabel,
591  errs()))
592  HadErrors = 1;
593  return true;
594  }
595 
596  // Check 'namespace (name) {}' block for #include directives.
597  bool VisitNamespaceDecl(const NamespaceDecl *D) {
598  SourceRange BlockRange = D->getSourceRange();
599  std::string Label("namespace ");
600  Label += D->getName();
601  Label += " {}";
602  if (!PPTracker.checkForIncludesInBlock(PP, BlockRange, Label.c_str(),
603  errs()))
604  HadErrors = 1;
605  return true;
606  }
607 
608  // Collect definition entities.
609  bool VisitNamedDecl(NamedDecl *ND) {
610  // We only care about file-context variables.
611  if (!ND->getDeclContext()->isFileContext())
612  return true;
613 
614  // Skip declarations that tend to be properly multiply-declared.
615  if (isa<NamespaceDecl>(ND) || isa<UsingDirectiveDecl>(ND) ||
616  isa<NamespaceAliasDecl>(ND) ||
617  isa<ClassTemplateSpecializationDecl>(ND) || isa<UsingDecl>(ND) ||
618  isa<ClassTemplateDecl>(ND) || isa<TemplateTypeParmDecl>(ND) ||
619  isa<TypeAliasTemplateDecl>(ND) || isa<UsingShadowDecl>(ND) ||
620  isa<FunctionDecl>(ND) || isa<FunctionTemplateDecl>(ND) ||
621  (isa<TagDecl>(ND) &&
622  !cast<TagDecl>(ND)->isThisDeclarationADefinition()))
623  return true;
624 
625  // Skip anonymous declarations.
626  if (!ND->getDeclName())
627  return true;
628 
629  // Get the qualified name.
630  std::string Name;
631  llvm::raw_string_ostream OS(Name);
632  ND->printQualifiedName(OS);
633  OS.flush();
634  if (Name.empty())
635  return true;
636 
637  Location Loc(SM, ND->getLocation());
638  if (!Loc)
639  return true;
640 
641  Entities.add(Name, isa<TagDecl>(ND) ? Entry::EK_Tag : Entry::EK_Value, Loc);
642  return true;
643  }
644 
645 private:
646  SourceManager &SM;
647  EntityMap &Entities;
648  Preprocessor &PP;
649  PreprocessorTracker &PPTracker;
650  int &HadErrors;
651 };
652 
654 public:
656  PreprocessorTracker &preprocessorTracker,
657  Preprocessor &PP, StringRef InFile, int &HadErrors)
658  : Entities(Entities), PPTracker(preprocessorTracker), PP(PP),
659  HadErrors(HadErrors) {
660  PPTracker.handlePreprocessorEntry(PP, InFile);
661  }
662 
663  ~CollectEntitiesConsumer() override { PPTracker.handlePreprocessorExit(); }
664 
665  void HandleTranslationUnit(ASTContext &Ctx) override {
666  SourceManager &SM = Ctx.getSourceManager();
667 
668  // Collect declared entities.
669  CollectEntitiesVisitor(SM, Entities, PP, PPTracker, HadErrors)
670  .TraverseDecl(Ctx.getTranslationUnitDecl());
671 
672  // Collect macro definitions.
673  for (Preprocessor::macro_iterator M = PP.macro_begin(),
674  MEnd = PP.macro_end();
675  M != MEnd; ++M) {
676  Location Loc(SM, M->second.getLatest()->getLocation());
677  if (!Loc)
678  continue;
679 
680  Entities.add(M->first->getName().str(), Entry::EK_Macro, Loc);
681  }
682 
683  // Merge header contents.
684  Entities.mergeCurHeaderContents();
685  }
686 
687 private:
688  EntityMap &Entities;
689  PreprocessorTracker &PPTracker;
690  Preprocessor &PP;
691  int &HadErrors;
692 };
693 
695 public:
697  PreprocessorTracker &preprocessorTracker,
698  int &HadErrors)
699  : Entities(Entities), PPTracker(preprocessorTracker),
700  HadErrors(HadErrors) {}
701 
702 protected:
703  std::unique_ptr<clang::ASTConsumer>
704  CreateASTConsumer(CompilerInstance &CI, StringRef InFile) override {
705  return std::make_unique<CollectEntitiesConsumer>(
706  Entities, PPTracker, CI.getPreprocessor(), InFile, HadErrors);
707  }
708 
709 private:
710  EntityMap &Entities;
711  PreprocessorTracker &PPTracker;
712  int &HadErrors;
713 };
714 
716 public:
718  PreprocessorTracker &preprocessorTracker,
719  int &HadErrors)
720  : Entities(Entities), PPTracker(preprocessorTracker),
721  HadErrors(HadErrors) {}
722 
723  std::unique_ptr<FrontendAction> create() override {
724  return std::make_unique<CollectEntitiesAction>(Entities, PPTracker,
725  HadErrors);
726  }
727 
728 private:
729  EntityMap &Entities;
730  PreprocessorTracker &PPTracker;
731  int &HadErrors;
732 };
733 
735  : public RecursiveASTVisitor<CompileCheckVisitor> {
736 public:
738 
739  bool TraverseStmt(Stmt *S) { return true; }
740  bool TraverseType(QualType T) { return true; }
741  bool TraverseTypeLoc(TypeLoc TL) { return true; }
742  bool TraverseNestedNameSpecifier(NestedNameSpecifier *NNS) { return true; }
743  bool TraverseNestedNameSpecifierLoc(NestedNameSpecifierLoc NNS) {
744  return true;
745  }
746  bool TraverseDeclarationNameInfo(DeclarationNameInfo NameInfo) {
747  return true;
748  }
749  bool TraverseTemplateName(TemplateName Template) { return true; }
750  bool TraverseTemplateArgument(const TemplateArgument &Arg) { return true; }
751  bool TraverseTemplateArgumentLoc(const TemplateArgumentLoc &ArgLoc) {
752  return true;
753  }
754  bool TraverseTemplateArguments(const TemplateArgument *Args,
755  unsigned NumArgs) {
756  return true;
757  }
758  bool TraverseConstructorInitializer(CXXCtorInitializer *Init) { return true; }
759  bool TraverseLambdaCapture(LambdaExpr *LE, const LambdaCapture *C,
760  Expr *Init) {
761  return true;
762  }
763 
764  // Check 'extern "*" {}' block for #include directives.
765  bool VisitLinkageSpecDecl(LinkageSpecDecl *D) {
766  return true;
767  }
768 
769  // Check 'namespace (name) {}' block for #include directives.
770  bool VisitNamespaceDecl(const NamespaceDecl *D) {
771  return true;
772  }
773 
774  // Collect definition entities.
775  bool VisitNamedDecl(NamedDecl *ND) {
776  return true;
777  }
778 };
779 
781 public:
783 
784  void HandleTranslationUnit(ASTContext &Ctx) override {
785  CompileCheckVisitor().TraverseDecl(Ctx.getTranslationUnitDecl());
786  }
787 };
788 
790 public:
792 
793 protected:
794  std::unique_ptr<clang::ASTConsumer>
795  CreateASTConsumer(CompilerInstance &CI, StringRef InFile) override {
796  return std::make_unique<CompileCheckConsumer>();
797  }
798 };
799 
800 class CompileCheckFrontendActionFactory : public FrontendActionFactory {
801 public:
803 
804  std::unique_ptr<FrontendAction> create() override {
805  return std::make_unique<CompileCheckAction>();
806  }
807 };
808 
809 int main(int Argc, const char **Argv) {
810 
811  // Save program name for error messages.
812  Argv0 = Argv[0];
813 
814  // Save program arguments for use in module.modulemap comment.
815  CommandLine = std::string(sys::path::stem(sys::path::filename(Argv0)));
816  for (int ArgIndex = 1; ArgIndex < Argc; ArgIndex++) {
817  CommandLine.append(" ");
818  CommandLine.append(Argv[ArgIndex]);
819  }
820 
821  // This causes options to be parsed.
822  cl::ParseCommandLineOptions(Argc, Argv, "modularize.\n");
823 
824  // No go if we have no header list file.
825  if (ListFileNames.size() == 0) {
826  cl::PrintHelpMessage();
827  return 1;
828  }
829 
830  std::unique_ptr<ModularizeUtilities> ModUtil;
831  int HadErrors = 0;
832 
833  ModUtil.reset(
834  ModularizeUtilities::createModularizeUtilities(
836 
837  // Get header file names and dependencies.
838  if (ModUtil->loadAllHeaderListsAndDependencies())
839  HadErrors = 1;
840 
841  // If we are in assistant mode, output the module map and quit.
842  if (ModuleMapPath.length() != 0) {
843  if (!createModuleMap(ModuleMapPath, ModUtil->HeaderFileNames,
844  ModUtil->ProblemFileNames,
845  ModUtil->Dependencies, HeaderPrefix, RootModule))
846  return 1; // Failed.
847  return 0; // Success - Skip checks in assistant mode.
848  }
849 
850  // If we're doing module maps.
851  if (!NoCoverageCheck && ModUtil->HasModuleMap) {
852  // Do coverage check.
853  if (ModUtil->doCoverageCheck(IncludePaths, CommandLine))
854  HadErrors = 1;
855  }
856 
857  // Bail early if only doing the coverage check.
858  if (CoverageCheckOnly)
859  return HadErrors;
860 
861  // Create the compilation database.
862  SmallString<256> PathBuf;
863  sys::fs::current_path(PathBuf);
864  std::unique_ptr<CompilationDatabase> Compilations;
865  Compilations.reset(
866  new FixedCompilationDatabase(Twine(PathBuf), CC1Arguments));
867 
868  // Create preprocessor tracker, to watch for macro and conditional problems.
869  std::unique_ptr<PreprocessorTracker> PPTracker(
870  PreprocessorTracker::create(ModUtil->HeaderFileNames,
872 
873  // Coolect entities here.
874  EntityMap Entities;
875 
876  // Because we can't easily determine which files failed
877  // during the tool run, if we're collecting the file lists
878  // for display, we do a first compile pass on individual
879  // files to find which ones don't compile stand-alone.
880  if (DisplayFileLists) {
881  // First, make a pass to just get compile errors.
882  for (auto &CompileCheckFile : ModUtil->HeaderFileNames) {
883  llvm::SmallVector<std::string, 32> CompileCheckFileArray;
884  CompileCheckFileArray.push_back(CompileCheckFile);
885  ClangTool CompileCheckTool(*Compilations, CompileCheckFileArray);
886  CompileCheckTool.appendArgumentsAdjuster(
887  getModularizeArgumentsAdjuster(ModUtil->Dependencies));
888  int CompileCheckFileErrors = 0;
889  // FIXME: use newFrontendActionFactory.
890  CompileCheckFrontendActionFactory CompileCheckFactory;
891  CompileCheckFileErrors |= CompileCheckTool.run(&CompileCheckFactory);
892  if (CompileCheckFileErrors != 0) {
893  ModUtil->addUniqueProblemFile(CompileCheckFile); // Save problem file.
894  HadErrors |= 1;
895  }
896  else
897  ModUtil->addNoCompileErrorsFile(CompileCheckFile); // Save good file.
898  }
899  }
900 
901  // Then we make another pass on the good files to do the rest of the work.
902  ClangTool Tool(*Compilations,
903  (DisplayFileLists ? ModUtil->GoodFileNames : ModUtil->HeaderFileNames));
904  Tool.appendArgumentsAdjuster(
905  getModularizeArgumentsAdjuster(ModUtil->Dependencies));
906  ModularizeFrontendActionFactory Factory(Entities, *PPTracker, HadErrors);
907  HadErrors |= Tool.run(&Factory);
908 
909  // Create a place to save duplicate entity locations, separate bins per kind.
910  typedef SmallVector<Location, 8> LocationArray;
911  typedef SmallVector<LocationArray, Entry::EK_NumberOfKinds> EntryBinArray;
912  EntryBinArray EntryBins;
913  int KindIndex;
914  for (KindIndex = 0; KindIndex < Entry::EK_NumberOfKinds; ++KindIndex) {
915  LocationArray Array;
916  EntryBins.push_back(Array);
917  }
918 
919  // Check for the same entity being defined in multiple places.
920  for (EntityMap::iterator E = Entities.begin(), EEnd = Entities.end();
921  E != EEnd; ++E) {
922  // If only one occurrence, exit early.
923  if (E->second.size() == 1)
924  continue;
925  // Clear entity locations.
926  for (EntryBinArray::iterator CI = EntryBins.begin(), CE = EntryBins.end();
927  CI != CE; ++CI) {
928  CI->clear();
929  }
930  // Walk the entities of a single name, collecting the locations,
931  // separated into separate bins.
932  for (unsigned I = 0, N = E->second.size(); I != N; ++I) {
933  EntryBins[E->second[I].Kind].push_back(E->second[I].Loc);
934  }
935  // Report any duplicate entity definition errors.
936  int KindIndex = 0;
937  for (EntryBinArray::iterator DI = EntryBins.begin(), DE = EntryBins.end();
938  DI != DE; ++DI, ++KindIndex) {
939  int ECount = DI->size();
940  // If only 1 occurrence of this entity, skip it, we only report duplicates.
941  if (ECount <= 1)
942  continue;
943  LocationArray::iterator FI = DI->begin();
944  StringRef kindName = Entry::getKindName((Entry::EntryKind)KindIndex);
945  errs() << "error: " << kindName << " '" << E->first()
946  << "' defined at multiple locations:\n";
947  for (LocationArray::iterator FE = DI->end(); FI != FE; ++FI) {
948  errs() << " " << FI->File->getName() << ":" << FI->Line << ":"
949  << FI->Column << "\n";
950  ModUtil->addUniqueProblemFile(std::string(FI->File->getName()));
951  }
952  HadErrors = 1;
953  }
954  }
955 
956  // Complain about macro instance in header files that differ based on how
957  // they are included.
958  if (PPTracker->reportInconsistentMacros(errs()))
959  HadErrors = 1;
960 
961  // Complain about preprocessor conditional directives in header files that
962  // differ based on how they are included.
963  if (PPTracker->reportInconsistentConditionals(errs()))
964  HadErrors = 1;
965 
966  // Complain about any headers that have contents that differ based on how
967  // they are included.
968  // FIXME: Could we provide information about which preprocessor conditionals
969  // are involved?
970  for (DenseMap<const FileEntry *, HeaderContents>::iterator
971  H = Entities.HeaderContentMismatches.begin(),
972  HEnd = Entities.HeaderContentMismatches.end();
973  H != HEnd; ++H) {
974  if (H->second.empty()) {
975  errs() << "internal error: phantom header content mismatch\n";
976  continue;
977  }
978 
979  HadErrors = 1;
980  ModUtil->addUniqueProblemFile(std::string(H->first->getName()));
981  errs() << "error: header '" << H->first->getName()
982  << "' has different contents depending on how it was included.\n";
983  for (unsigned I = 0, N = H->second.size(); I != N; ++I) {
984  errs() << "note: '" << H->second[I].Name << "' in "
985  << H->second[I].Loc.File->getName() << " at "
986  << H->second[I].Loc.Line << ":" << H->second[I].Loc.Column
987  << " not always provided\n";
988  }
989  }
990 
991  if (DisplayFileLists) {
992  ModUtil->displayProblemFiles();
993  ModUtil->displayGoodFiles();
994  ModUtil->displayCombinedFiles();
995  }
996 
997  return HadErrors;
998 }
CollectEntitiesVisitor::TraverseTypeLoc
bool TraverseTypeLoc(TypeLoc TL)
Definition: Modularize.cpp:552
Loc
SourceLocation Loc
Definition: KernelNameRestrictionCheck.cpp:45
SyntaxOnlyAction
main
int main(int Argc, const char **Argv)
Definition: Modularize.cpp:809
CompileCheckVisitor::TraverseTemplateArguments
bool TraverseTemplateArguments(const TemplateArgument *Args, unsigned NumArgs)
Definition: Modularize.cpp:754
llvm
Some operations such as code completion produce a set of candidates.
Definition: YAMLGenerator.cpp:28
HeaderEntry::Loc
Location Loc
Definition: Modularize.cpp:460
CompileCheckFrontendActionFactory::create
std::unique_ptr< FrontendAction > create() override
Definition: Modularize.cpp:804
CompileCheckVisitor::TraverseNestedNameSpecifierLoc
bool TraverseNestedNameSpecifierLoc(NestedNameSpecifierLoc NNS)
Definition: Modularize.cpp:743
Location::File
const FileEntry * File
Definition: Modularize.cpp:383
RecursiveASTVisitor
Location::operator>=
friend bool operator>=(const Location &X, const Location &Y)
Definition: Modularize.cpp:423
CollectEntitiesVisitor::TraverseNestedNameSpecifier
bool TraverseNestedNameSpecifier(NestedNameSpecifier *NNS)
Definition: Modularize.cpp:553
Label
std::string Label
Definition: InlayHintTests.cpp:38
E
const Expr * E
Definition: AvoidBindCheck.cpp:88
CollectEntitiesVisitor::TraverseStmt
bool TraverseStmt(Stmt *S)
Definition: Modularize.cpp:550
DependentsVector
llvm::SmallVector< std::string, 4 > DependentsVector
Definition: Modularize.h:31
Location::Line
unsigned Line
Definition: Modularize.cpp:384
CompileCheckVisitor
Definition: Modularize.cpp:734
ModularizeFrontendActionFactory::ModularizeFrontendActionFactory
ModularizeFrontendActionFactory(EntityMap &Entities, PreprocessorTracker &preprocessorTracker, int &HadErrors)
Definition: Modularize.cpp:717
Location
Definition: Modularize.cpp:382
NoCoverageCheck
static cl::opt< bool > NoCoverageCheck("no-coverage-check", cl::init(false), cl::desc("Don't do the coverage check."))
CompileCheckVisitor::VisitNamedDecl
bool VisitNamedDecl(NamedDecl *ND)
Definition: Modularize.cpp:775
CollectEntitiesVisitor
Definition: Modularize.cpp:541
EntityMap
Definition: Modularize.cpp:484
PreprocessorTracker.h
CollectEntitiesAction::CollectEntitiesAction
CollectEntitiesAction(EntityMap &Entities, PreprocessorTracker &preprocessorTracker, int &HadErrors)
Definition: Modularize.cpp:696
CompileCheckVisitor::CompileCheckVisitor
CompileCheckVisitor()
Definition: Modularize.cpp:737
IncludePaths
static cl::list< std::string > IncludePaths("I", cl::desc("Include path for coverage check."), cl::ZeroOrMore, cl::value_desc("path"))
CollectEntitiesConsumer::CollectEntitiesConsumer
CollectEntitiesConsumer(EntityMap &Entities, PreprocessorTracker &preprocessorTracker, Preprocessor &PP, StringRef InFile, int &HadErrors)
Definition: Modularize.cpp:655
CompileCheckVisitor::VisitNamespaceDecl
bool VisitNamespaceDecl(const NamespaceDecl *D)
Definition: Modularize.cpp:770
CI
std::unique_ptr< CompilerInvocation > CI
Definition: TUScheduler.cpp:450
CommandLine
std::string CommandLine
Definition: Modularize.cpp:335
Kind
BindArgumentKind Kind
Definition: AvoidBindCheck.cpp:59
CollectEntitiesVisitor::VisitLinkageSpecDecl
bool VisitLinkageSpecDecl(LinkageSpecDecl *D)
Definition: Modularize.cpp:576
CollectEntitiesConsumer
Definition: Modularize.cpp:653
ModularizeFrontendActionFactory
Definition: Modularize.cpp:715
CompileCheckVisitor::TraverseTypeLoc
bool TraverseTypeLoc(TypeLoc TL)
Definition: Modularize.cpp:741
Ctx
Context Ctx
Definition: TUScheduler.cpp:454
CompileCheckFrontendActionFactory::CompileCheckFrontendActionFactory
CompileCheckFrontendActionFactory()
Definition: Modularize.cpp:802
CollectEntitiesVisitor::TraverseType
bool TraverseType(QualType T)
Definition: Modularize.cpp:551
CollectEntitiesVisitor::VisitNamedDecl
bool VisitNamedDecl(NamedDecl *ND)
Definition: Modularize.cpp:609
RootModule
static cl::opt< std::string > RootModule("root-module", cl::init(""), cl::desc("Specify the name of the root module."))
ModularizeFrontendActionFactory::create
std::unique_ptr< FrontendAction > create() override
Definition: Modularize.cpp:723
CollectEntitiesVisitor::TraverseTemplateName
bool TraverseTemplateName(TemplateName Template)
Definition: Modularize.cpp:560
CompileCheckVisitor::TraverseNestedNameSpecifier
bool TraverseNestedNameSpecifier(NestedNameSpecifier *NNS)
Definition: Modularize.cpp:742
ProblemFilesList
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."))
HeaderContents
std::vector< HeaderEntry > HeaderContents
Definition: Modularize.cpp:482
Location::operator>
friend bool operator>(const Location &X, const Location &Y)
Definition: Modularize.cpp:419
EntityMap::HeaderContentMismatches
DenseMap< const FileEntry *, HeaderContents > HeaderContentMismatches
Definition: Modularize.cpp:486
M
const google::protobuf::Message & M
Definition: Server.cpp:309
CollectEntitiesConsumer::~CollectEntitiesConsumer
~CollectEntitiesConsumer() override
Definition: Modularize.cpp:663
CompileCheckVisitor::TraverseType
bool TraverseType(QualType T)
Definition: Modularize.cpp:740
Inputs
ParseInputs Inputs
Definition: TUScheduler.cpp:451
CollectEntitiesVisitor::TraverseTemplateArguments
bool TraverseTemplateArguments(const TemplateArgument *Args, unsigned NumArgs)
Definition: Modularize.cpp:565
StringMap
X
int X
Definition: LSPBinderTests.cpp:25
ns1::ns2::D
@ D
Definition: CategoricalFeature.h:3
Location::operator<=
friend bool operator<=(const Location &X, const Location &Y)
Definition: Modularize.cpp:420
CollectEntitiesVisitor::TraverseTemplateArgumentLoc
bool TraverseTemplateArgumentLoc(const TemplateArgumentLoc &ArgLoc)
Definition: Modularize.cpp:562
Entry::getKindName
StringRef getKindName()
Definition: Modularize.cpp:439
CompileCheckAction
Definition: Modularize.cpp:789
Modularize.h
Line
int Line
Definition: PreprocessorTracker.cpp:514
clang::tooling
Definition: ClangTidy.h:25
clang::clangd::getCanonicalPath
llvm::Optional< std::string > getCanonicalPath(const FileEntry *F, const SourceManager &SourceMgr)
Get the canonical path of F.
Definition: SourceCode.cpp:507
CompileCheckAction::CompileCheckAction
CompileCheckAction()
Definition: Modularize.cpp:791
CollectEntitiesAction
Definition: Modularize.cpp:694
ModularizeUtilities.h
CollectEntitiesVisitor::TraverseNestedNameSpecifierLoc
bool TraverseNestedNameSpecifierLoc(NestedNameSpecifierLoc NNS)
Definition: Modularize.cpp:554
CollectEntitiesVisitor::TraverseDeclarationNameInfo
bool TraverseDeclarationNameInfo(DeclarationNameInfo NameInfo)
Definition: Modularize.cpp:557
Args
llvm::json::Object Args
Definition: Trace.cpp:139
HeaderEntry::operator>=
friend bool operator>=(const HeaderEntry &X, const HeaderEntry &Y)
Definition: Modularize.cpp:477
Name
static constexpr llvm::StringLiteral Name
Definition: UppercaseLiteralSuffixCheck.cpp:27
Location::operator==
friend bool operator==(const Location &X, const Location &Y)
Definition: Modularize.cpp:404
CC1Arguments
static cl::list< std::string > CC1Arguments(cl::ConsumeAfter, cl::desc("<arguments to be passed to front end>..."))
EntityMap::add
void add(const std::string &Name, enum Entry::EntryKind Kind, Location Loc)
Definition: Modularize.cpp:488
CollectEntitiesVisitor::TraverseTemplateArgument
bool TraverseTemplateArgument(const TemplateArgument &Arg)
Definition: Modularize.cpp:561
HeaderEntry::operator<
friend bool operator<(const HeaderEntry &X, const HeaderEntry &Y)
Definition: Modularize.cpp:468
CollectEntitiesVisitor::CollectEntitiesVisitor
CollectEntitiesVisitor(SourceManager &SM, EntityMap &Entities, Preprocessor &PP, PreprocessorTracker &PPTracker, int &HadErrors)
Definition: Modularize.cpp:544
DependencyMap
llvm::StringMap< DependentsVector > DependencyMap
Definition: Modularize.h:32
DisplayFileLists
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 '#'."))
CollectEntitiesVisitor::TraverseConstructorInitializer
bool TraverseConstructorInitializer(CXXCtorInitializer *Init)
Definition: Modularize.cpp:569
Location::Location
Location(SourceManager &SM, SourceLocation Loc)
Definition: Modularize.cpp:388
createModuleMap
bool createModuleMap(llvm::StringRef ModuleMapPath, llvm::ArrayRef< std::string > HeaderFileNames, llvm::ArrayRef< std::string > ProblemFileNames, DependencyMap &Dependencies, llvm::StringRef HeaderPrefix, llvm::StringRef RootModuleName)
Create the module map file.
Definition: ModuleAssistant.cpp:298
HeaderEntry::operator==
friend bool operator==(const HeaderEntry &X, const HeaderEntry &Y)
Definition: Modularize.cpp:462
Argv0
const char * Argv0
Definition: Modularize.cpp:333
CompileCheckConsumer
Definition: Modularize.cpp:780
Entry::EK_NumberOfKinds
@ EK_NumberOfKinds
Definition: Modularize.cpp:434
clang::tidy::bugprone::PP
static Preprocessor * PP
Definition: BadSignalToKillThreadCheck.cpp:29
HeaderEntry::operator>
friend bool operator>(const HeaderEntry &X, const HeaderEntry &Y)
Definition: Modularize.cpp:471
CoverageCheckOnly
static cl::opt< bool > CoverageCheckOnly("coverage-check-only", cl::init(false), cl::desc("Only do the coverage check."))
CompileCheckVisitor::TraverseTemplateArgument
bool TraverseTemplateArgument(const TemplateArgument &Arg)
Definition: Modularize.cpp:750
HeaderEntry::operator!=
friend bool operator!=(const HeaderEntry &X, const HeaderEntry &Y)
Definition: Modularize.cpp:465
Entry
Definition: Modularize.cpp:428
CompileCheckAction::CreateASTConsumer
std::unique_ptr< clang::ASTConsumer > CreateASTConsumer(CompilerInstance &CI, StringRef InFile) override
Definition: Modularize.cpp:795
Index
const SymbolIndex * Index
Definition: Dexp.cpp:99
Entry::EK_Value
@ EK_Value
Definition: Modularize.cpp:431
CompileCheckVisitor::TraverseTemplateName
bool TraverseTemplateName(TemplateName Template)
Definition: Modularize.cpp:749
CompileCheckConsumer::HandleTranslationUnit
void HandleTranslationUnit(ASTContext &Ctx) override
Definition: Modularize.cpp:784
CE
CaptureExpr CE
Definition: AvoidBindCheck.cpp:67
CompileCheckFrontendActionFactory
Definition: Modularize.cpp:800
Location::Location
Location()
Definition: Modularize.cpp:386
ASTConsumer
ModuleMapPath
static cl::opt< std::string > ModuleMapPath("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."))
CollectEntitiesVisitor::TraverseLambdaCapture
bool TraverseLambdaCapture(LambdaExpr *LE, const LambdaCapture *C, Expr *Init)
Definition: Modularize.cpp:570
FrontendActionFactory
Column
int Column
Definition: PreprocessorTracker.cpp:515
C
const Criteria C
Definition: FunctionCognitiveComplexityCheck.cpp:93
Entry::Loc
Location Loc
Definition: Modularize.cpp:437
HeaderPrefix
static cl::opt< std::string > HeaderPrefix("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."))
Location::operator<
friend bool operator<(const Location &X, const Location &Y)
Definition: Modularize.cpp:412
CompileCheckConsumer::CompileCheckConsumer
CompileCheckConsumer()
Definition: Modularize.cpp:782
clang
===– Representation.cpp - ClangDoc Representation --------—*- C++ -*-===//
Definition: ApplyReplacements.h:27
OS
llvm::raw_string_ostream OS
Definition: TraceTests.cpp:163
HeaderEntry::operator<=
friend bool operator<=(const HeaderEntry &X, const HeaderEntry &Y)
Definition: Modularize.cpp:474
CompileCheckVisitor::TraverseDeclarationNameInfo
bool TraverseDeclarationNameInfo(DeclarationNameInfo NameInfo)
Definition: Modularize.cpp:746
Modularize
Definition: CoverageChecker.h:32
CompileCheckVisitor::TraverseConstructorInitializer
bool TraverseConstructorInitializer(CXXCtorInitializer *Init)
Definition: Modularize.cpp:758
HeaderEntry
Definition: Modularize.cpp:458
getModularizeArgumentsAdjuster
static ArgumentsAdjuster getModularizeArgumentsAdjuster(DependencyMap &Dependencies)
Definition: Modularize.cpp:354
Location::operator!=
friend bool operator!=(const Location &X, const Location &Y)
Definition: Modularize.cpp:408
ListFileNames
static cl::list< std::string > ListFileNames(cl::Positional, cl::value_desc("list"), cl::desc("<list of one or more header list files>"), cl::CommaSeparated)
Entry::EK_Macro
@ EK_Macro
Definition: Modularize.cpp:432
CompileCheckVisitor::TraverseTemplateArgumentLoc
bool TraverseTemplateArgumentLoc(const TemplateArgumentLoc &ArgLoc)
Definition: Modularize.cpp:751
EntityMap::mergeCurHeaderContents
void mergeCurHeaderContents()
Definition: Modularize.cpp:505
Entry::EK_Tag
@ EK_Tag
Definition: Modularize.cpp:430
Entry::EntryKind
EntryKind
Definition: Modularize.cpp:429
Modularize::PreprocessorTracker
Preprocessor tracker for modularize.
Definition: PreprocessorTracker.h:41
CollectEntitiesConsumer::HandleTranslationUnit
void HandleTranslationUnit(ASTContext &Ctx) override
Definition: Modularize.cpp:665
CompileCheckVisitor::TraverseStmt
bool TraverseStmt(Stmt *S)
Definition: Modularize.cpp:739
CompileCheckVisitor::VisitLinkageSpecDecl
bool VisitLinkageSpecDecl(LinkageSpecDecl *D)
Definition: Modularize.cpp:765
HeaderEntry::Name
std::string Name
Definition: Modularize.cpp:459
Location::Column
unsigned Column
Definition: Modularize.cpp:384
BlockCheckHeaderListOnly
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."))
CollectEntitiesVisitor::VisitNamespaceDecl
bool VisitNamespaceDecl(const NamespaceDecl *D)
Definition: Modularize.cpp:597
findInputFile
static std::string findInputFile(const CommandLineArguments &CLArgs)
Definition: Modularize.cpp:338
CollectEntitiesAction::CreateASTConsumer
std::unique_ptr< clang::ASTConsumer > CreateASTConsumer(CompilerInstance &CI, StringRef InFile) override
Definition: Modularize.cpp:704
CompileCheckVisitor::TraverseLambdaCapture
bool TraverseLambdaCapture(LambdaExpr *LE, const LambdaCapture *C, Expr *Init)
Definition: Modularize.cpp:759