7#ifndef MAYAFLUX_REFLECT_RESOURCE_DIR
8#define MAYAFLUX_REFLECT_RESOURCE_DIR ""
16 std::vector<std::filesystem::path> roots;
17 std::vector<std::filesystem::path> headers;
18 std::filesystem::path build_path;
19 std::filesystem::path translation_unit;
20 std::string resource_dir;
21 std::vector<std::string> extra_args;
22 bool insert_includes {
true };
26int fail(
const std::string& message)
28 std::cerr << message <<
'\n';
32int generate(
const Config& config)
36 for (
const auto& header : config.headers) {
37 const auto canonical = std::filesystem::canonical(header, code);
39 return fail(
"cannot read header " + header.string());
41 headers.push_back(canonical);
43 std::ranges::sort(headers);
44 headers.erase(std::ranges::unique(headers).begin(), headers.end());
45 if (headers.empty()) {
46 return fail(
"no MF_DESCRIBE requests found; pass --root or header paths");
51 for (
const auto& header : headers) {
52 const std::filesystem::path sidecar =
sidecar_path(header);
54 if (!std::filesystem::exists(sidecar)) {
55 input.
stubs.push_back(sidecar.filename().string());
64 input.
roots = config.roots;
70 if (!
scan(input, collector, error)) {
73 if (!collector.
errors().empty()) {
74 for (
const auto& message : collector.
errors()) {
75 std::cerr << message <<
'\n';
80 return fail(
"no MF_DESCRIBE requests were recognised in the selected headers (marker aliases matched: "
81 + std::to_string(collector.
matched()) +
", skipped: " + std::to_string(collector.
skipped()) +
")");
87 for (
const auto& problem : problems) {
88 std::cerr << problem <<
'\n';
90 if (problems.empty()) {
91 std::cout <<
"All " << collector.
requests().size() <<
" sidecars are current\n";
94 std::cout << problems.size() <<
" problem(s) found\n";
99 std::size_t types = 0;
100 for (
const auto& header : headers) {
101 const auto found = collector.
requests().find(header);
102 if (found == collector.
requests().end()) {
103 std::cerr << header.string() <<
": contains MF_DESCRIBE text but produced no request\n";
110 types += found->second.records.size();
111 if (config.insert_includes) {
112 bool inserted =
false;
117 std::cout <<
"Inserted #include \"" <<
sidecar_path(header).filename().string() <<
"\" into " << header.string() <<
'\n';
121 std::cerr << *problem <<
'\n';
126 std::cout <<
"Generated " << types <<
" type descriptions in " << collector.
requests().size() <<
" sidecars\n";
127 return clean ? 0 : 1;
132int main(
int argc,
const char** argv)
134 llvm::cl::OptionCategory category(
"mayaflux-reflect options");
135 llvm::cl::list<std::string> roots(
"root",
136 llvm::cl::desc(
"Directory searched recursively for MF_DESCRIBE, or a single header "
137 "(default without headers: src/MayaFlux when it exists, else src)"),
138 llvm::cl::value_desc(
"path"), llvm::cl::cat(category));
139 llvm::cl::list<std::string> headers(llvm::cl::Positional,
140 llvm::cl::desc(
"<header>..."), llvm::cl::cat(category));
141 llvm::cl::opt<std::string> build_path(
"p",
142 llvm::cl::desc(
"Directory holding compile_commands.json"),
143 llvm::cl::value_desc(
"dir"), llvm::cl::init(
"build"), llvm::cl::cat(category));
144 llvm::cl::opt<std::string> translation_unit(
"translation-unit",
145 llvm::cl::desc(
"Source file whose compile command is borrowed for the scan"),
146 llvm::cl::value_desc(
"file"), llvm::cl::cat(category));
147 llvm::cl::opt<std::string> resource_dir(
"resource-dir",
148 llvm::cl::desc(
"Clang resource directory holding the builtin headers"),
150 llvm::cl::cat(category));
151 llvm::cl::list<std::string> extra_args(
"extra-arg",
152 llvm::cl::desc(
"Extra Clang argument added to the scan"),
153 llvm::cl::value_desc(
"argument"), llvm::cl::cat(category));
155 llvm::cl::opt<bool> no_insert_include(
"no-insert-include",
156 llvm::cl::desc(
"Report a missing sidecar include instead of inserting it"),
157 llvm::cl::cat(category));
159 llvm::cl::opt<bool> check(
"check",
160 llvm::cl::desc(
"Write nothing; exit 1 when a sidecar, its include or a marker is out of date"),
161 llvm::cl::cat(category));
163 llvm::cl::opt<bool> build(
"build",
164 llvm::cl::desc(
"Build step: describe the one header given, inserting its sidecar include when missing, "
165 "and write nothing else in the source tree. Needs --translation-unit or --compile-arg"),
166 llvm::cl::cat(category));
167 llvm::cl::list<std::string> compile_args(
"compile-arg",
168 llvm::cl::desc(
"With --build: one argument of the whole compile command, used instead of the database"),
169 llvm::cl::value_desc(
"argument"), llvm::cl::cat(category));
170 llvm::cl::opt<std::string> depfile(
"depfile",
171 llvm::cl::desc(
"With --build: write a depfile of the files the scan read"),
172 llvm::cl::value_desc(
"file"), llvm::cl::cat(category));
173 llvm::cl::opt<std::string> depfile_target(
"depfile-target",
174 llvm::cl::desc(
"With --build: the target named in the depfile (default: the sidecar path)"),
175 llvm::cl::value_desc(
"path"), llvm::cl::cat(category));
177 llvm::cl::HideUnrelatedOptions(category);
178 llvm::cl::ParseCommandLineOptions(argc, argv,
179 "Writes a Name.describe.hpp sidecar beside each header that holds MF_DESCRIBE requests.\n");
182 config.roots.assign(roots.begin(), roots.end());
183 config.headers.assign(headers.begin(), headers.end());
184 config.build_path = build_path.getValue();
185 config.translation_unit = translation_unit.getValue();
186 config.resource_dir = resource_dir.getValue();
187 config.extra_args.assign(extra_args.begin(), extra_args.end());
188 config.insert_includes = !no_insert_include;
189 config.check = check;
192 if (config.headers.size() != 1 || !config.roots.empty() || config.check) {
193 return fail(
"--build takes exactly one header, and neither --root nor --check");
196 options.
header = config.headers.front();
201 options.
compile_args.assign(compile_args.begin(), compile_args.end());
202 options.
depfile = depfile.getValue();
208 if (config.roots.empty() && config.headers.empty()) {
209 config.roots.emplace_back(std::filesystem::is_directory(
"src/MayaFlux") ?
"src/MayaFlux" :
"src");
212 for (
auto& root : config.roots) {
213 std::error_code code;
214 const auto canonical = std::filesystem::canonical(root, code);
216 return fail(
"cannot read root " + root.string());
220 return generate(config);
int main(int argc, const char **argv)
#define MAYAFLUX_REFLECT_RESOURCE_DIR
Cycle Behavior: The for_cycles(N) configuration controls how many times the capture operation execute...