clang-tools 17.0.0git
Go to the documentation of this file.
1//===--- Modularize.h - Common definitions for Modularize -*- C++ -*-----===//
3// Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions.
4// See for license information.
5// SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
9/// \file
10/// Common definitions for Modularize.
14#ifndef MODULARIZE_H
15#define MODULARIZE_H
17#include "llvm/ADT/ArrayRef.h"
18#include "llvm/ADT/SmallString.h"
19#include "llvm/ADT/SmallVector.h"
20#include "llvm/ADT/StringMap.h"
21#include "llvm/ADT/StringRef.h"
22#include <string>
23#include <vector>
25// Save the program name for error messages.
26extern const char *Argv0;
27// Save the command line for comments.
28extern std::string CommandLine;
30// Dependency types.
31typedef llvm::SmallVector<std::string, 4> DependentsVector;
32typedef llvm::StringMap<DependentsVector> DependencyMap;
34// Global function declarations.
36/// Create the module map file.
37/// \param ModuleMapPath The path to the module map file to be generated.
38/// \param HeaderFileNames The list of header files, absolute native paths.
39/// \param ProblemFileNames The list of problem header files.
40/// \param Dependencies Map of headers that depend on other headers.
41/// \param HeaderPrefix Tells the code where the headers are, if they
42/// aren's in the current directory, allowing the generator to strip
43/// the leading, non-relative beginning of the header paths.
44/// RootModuleName If not empty, specifies that a root module
45/// should be created with this name.
46/// \returns True if successful.
47bool createModuleMap(llvm::StringRef ModuleMapPath,
48 llvm::ArrayRef<std::string> HeaderFileNames,
49 llvm::ArrayRef<std::string> ProblemFileNames,
50 DependencyMap &Dependencies, llvm::StringRef HeaderPrefix,
51 llvm::StringRef RootModuleName);
53#endif // MODULARIZE_H
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."))
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."))
llvm::SmallVector< std::string, 4 > DependentsVector
Definition: Modularize.h:31
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.
const char * Argv0
Definition: Modularize.cpp:333
std::string CommandLine
llvm::StringMap< DependentsVector > DependencyMap
Definition: Modularize.h:32