1 #include <msp/core/getopt.h>
2 #include <msp/fs/dir.h>
3 #include <msp/fs/stat.h>
4 #include <msp/io/print.h>
5 #include <msp/strings/format.h>
6 #include <msp/strings/utils.h>
8 #include "buildercli.h"
9 #include "filetarget.h"
10 #include "sourcepackage.h"
12 #include "toolchain.h"
17 BuilderCLI::BuilderCLI(int argc, char **argv):
18 RegisteredApplication<BuilderCLI>("builder")
22 bool full_paths = false;
23 unsigned max_depth = 4;
27 bool no_externals = false;
30 vector<string> log_channels;
34 getopt.add_option('a', "analyze", analyze_mode, GetOpt::REQUIRED_ARG).set_help("Perform dependency analysis.", "MODE");
35 getopt.add_option('b', "build", build, GetOpt::NO_ARG).set_help("Perform build even if also doing something else.");
36 getopt.add_option('c', "clean", clean, GetOpt::NO_ARG).set_help("Clean buildable targets.");
37 getopt.add_option('f', "file", build_file, GetOpt::REQUIRED_ARG).set_help("Read build instructions from FILE.", "FILE");
38 getopt.add_option('h', "help", help, GetOpt::NO_ARG).set_help("Print this message.");
39 getopt.add_option('j', "jobs", jobs, GetOpt::REQUIRED_ARG).set_help("Run up to NUM tasks in parallel.", "NUM");
40 getopt.add_option('l', "log", log_channels, GetOpt::REQUIRED_ARG).set_help("Enable listed log channels.", "LIST");
41 getopt.add_option('n', "dry-run", dry_run, GetOpt::NO_ARG).set_help("Show what would be done without actually doing it.");
42 getopt.add_option('s', "silent", silent, GetOpt::NO_ARG).set_help("Don't print any messages other than errors.");
43 getopt.add_option('t', "build-type", build_type, GetOpt::REQUIRED_ARG).set_help("Set build type.", "TYPE");
44 getopt.add_option('v', "verbose", verbose, GetOpt::NO_ARG).set_help("Print more information about what's going on.");
45 getopt.add_option('x', "no-externals",no_externals, GetOpt::NO_ARG).set_help("Do not load external source packages.");
46 getopt.add_option('A', "conf-all", conf_all, GetOpt::NO_ARG).set_help("Apply configuration to all packages.");
47 getopt.add_option('B', "build-all", build_all, GetOpt::NO_ARG).set_help("Build all targets unconditionally.");
48 getopt.add_option('C', "chdir", work_dir, GetOpt::REQUIRED_ARG).set_help("Change to DIR before doing anything else.", "DIR");
49 getopt.add_option('P', "progress", show_progress, GetOpt::NO_ARG).set_help("Display progress while building.");
50 getopt.add_option('W', "what-if", what_if, GetOpt::REQUIRED_ARG).set_help("Pretend that FILE has changed.", "FILE");
51 getopt.add_option( "arch", arch, GetOpt::REQUIRED_ARG).set_help("Build for architecture ARCH.", "ARCH");
52 getopt.add_option( "conf-only", conf_only, GetOpt::NO_ARG).set_help("Stop after configuring packages.");
53 getopt.add_option( "full-paths", full_paths, GetOpt::NO_ARG).set_help("Output full paths in analysis.");
54 getopt.add_option( "max-depth", max_depth, GetOpt::REQUIRED_ARG).set_help("Show up to NUM levels in analysis.", "NUM");
55 getopt.add_option( "prefix", prefix, GetOpt::REQUIRED_ARG).set_help("Install things to DIR.", "DIR");
56 getopt.add_option( "tempdir", tempdir, GetOpt::REQUIRED_ARG).set_help("Store temporary files in DIR.", "DIR");
57 getopt.add_argument("target", cmdline_targets, GetOpt::OPTIONAL_ARG).set_help("Target(s) to build");
62 helpmsg = "Usage:\n ";
63 helpmsg += getopt.generate_usage(argv[0], true);
65 helpmsg += getopt.generate_help();
72 logger.enable_channel("summary");
73 logger.enable_channel("tasks");
77 logger.enable_channel("environment");
78 logger.enable_channel("packages");
79 logger.enable_channel("commands");
83 logger.enable_channel("files");
84 logger.enable_channel("auxcommands");
86 for(const string &c: log_channels)
87 for(const string &p: split(c, ','))
88 logger.enable_channel(p);
89 builder.set_logger(&logger);
91 if(!analyze_mode.empty())
93 analyzer = new Analyzer(builder);
95 if(analyze_mode=="deps")
96 analyzer->set_mode(Analyzer::DEPS);
97 else if(analyze_mode=="alldeps")
98 analyzer->set_mode(Analyzer::ALLDEPS);
99 else if(analyze_mode=="rebuild")
100 analyzer->set_mode(Analyzer::REBUILD);
101 else if(analyze_mode=="rdeps")
102 analyzer->set_mode(Analyzer::RDEPS);
104 throw usage_error("Invalid analyze mode");
106 analyzer->set_max_depth(max_depth);
107 analyzer->set_full_paths(full_paths);
109 else if(!clean && !create_makefile)
112 if(!work_dir.empty())
117 PackageManager &package_manager = builder.get_package_manager();
119 package_manager.append_package_path(cwd);
120 package_manager.append_package_path(cwd/"..");
121 package_manager.append_binary_package_path(FS::get_sys_data_dir()/"packages");
123 package_manager.set_no_externals(no_externals);
125 builder.set_architecture(tolower(arch));
127 vector<FS::Path> start_files;
128 start_files.push_back(FS::get_sys_data_dir()/"builderrc");
129 start_files.push_back(FS::get_user_data_dir()/"rc");
130 for(const FS::Path &f: start_files)
132 builder.load_build_file(f);
135 builder.set_prefix(cwd/prefix);
138 builder.set_temp_directory(tempdir);
140 if(!build_type.empty())
141 builder.set_build_type(build_type);
143 builder.add_default_tools();
145 const Toolchain &toolchain = builder.get_toolchain();
146 for(auto i=cmdline_targets.begin(); i!=cmdline_targets.end(); )
148 string::size_type equal = i->find('=');
149 if(equal!=string::npos)
151 string key = i->substr(0, equal);
152 string value = i->substr(equal+1);
153 if(toolchain.has_tool(key))
154 toolchain.get_tool(key).set_command(value);
156 cmdline_options.insert({ key, value });
157 i = cmdline_targets.erase(i);
164 BuilderCLI::~BuilderCLI()
169 int BuilderCLI::main()
171 FS::Path main_file = cwd/build_file;
172 if(FS::exists(main_file))
174 builder.load_build_file(main_file, &cmdline_options, conf_all);
175 if(!dry_run && !cmdline_options.empty())
176 builder.save_caches();
180 IO::print(IO::cerr, "The file %s does not exist.\n", main_file);
186 IO::print("Builder 3.0\n"
187 "Copyright © 2006-2022 Mikkosoft Productions, Mikko Rasa\n"
188 "Licensed under the GPL\n\n"
194 const Architecture &native_arch = builder.get_native_arch();
195 const Architecture ¤t_arch = builder.get_current_arch();
196 logger.log("environment", "Building on %s, for %s%s", native_arch.get_name(),
197 current_arch.get_name(), (current_arch.is_native() ? " (native)" : ""));
198 logger.log("environment", "Prefix is %s", builder.get_prefix());
199 const FS::Path &tempdir = builder.get_temp_directory();
200 if(tempdir.is_absolute())
201 logger.log("environment", "Temporary directory is %s", tempdir);
203 logger.log("environment", "Using per-package temporary directory %s", tempdir);
204 const BuildType &build_type = builder.get_build_type();
205 logger.log("environment", "Build type is %s", build_type.get_name());
213 BuildGraph &build_graph = builder.get_build_graph();
214 PackageManager &package_manager = builder.get_package_manager();
215 vector<string> package_details;
216 for(const auto &kvp: package_manager.get_packages())
218 if(!kvp.second->is_prepared())
221 string line = kvp.second->get_name();
222 if(dynamic_cast<SourcePackage *>(kvp.second))
227 unsigned to_be_built = 0;
228 for(const auto &kvp2: build_graph.get_targets())
229 if(kvp2.second->get_package()==kvp.second)
232 if(kvp2.second->needs_rebuild())
237 line += format(" (%d targets", count);
239 line += format(", %d to be built", to_be_built);
244 package_details.push_back(line);
247 logger.log("summary", "%d active packages, %d targets", package_details.size(), build_graph.get_targets().size());
248 for(const string &d: package_details)
249 logger.log("packages", d);
254 if(build_graph.get_goals().is_broken())
256 vector<string> problems = builder.collect_problems();
257 IO::print(IO::cerr, "The following problems were detected:\n");
258 for(const string &p: problems)
259 IO::print(IO::cerr, " %s\n", p);
261 IO::print(IO::cerr, "Please fix them and try again.\n");
266 exit_code = builder.clean(clean>=2, dry_run);
268 exit_code = builder.build(jobs, dry_run, show_progress);
271 builder.save_caches();
276 bool BuilderCLI::prepare_build()
278 /* XXX This is ugly; using the Builder class should not be this convoluted.
279 But the command line targets and what ifs need to be set at certain points
280 during preparation. */
281 BuildGraph &build_graph = builder.get_build_graph();
282 PackageManager &package_manager = builder.get_package_manager();
284 package_manager.get_main_package().prepare();
286 // Add targets from command line as goals
287 for(const string &t: cmdline_targets)
289 Target *tgt = resolve_target(t);
292 IO::print("I don't know anything about %s\n", t);
296 build_graph.add_goal(*tgt);
299 build_graph.prepare();
302 for(const string &w: what_if)
304 FileTarget *tgt = dynamic_cast<FileTarget *>(resolve_target(w));
307 IO::print(IO::cerr, "Unknown what-if target %s\n", w);
314 build_graph.force_full_rebuild();
317 package_manager.save_all_caches();
322 Target *BuilderCLI::resolve_target(const string &name)
324 Target *tgt = builder.get_build_graph().get_target(name);
326 tgt = builder.get_vfs().get_target(cwd/name);
330 void BuilderCLI::package_help()
332 PackageManager &package_manager = builder.get_package_manager();
333 if(package_manager.get_packages().empty())
336 SourcePackage &main_pkg = dynamic_cast<SourcePackage &>(package_manager.get_main_package());
337 const Config &config = main_pkg.get_config();
338 const auto &options = config.get_options();
339 const Package::Requirements &requires = main_pkg.get_required_packages();
341 if(!requires.empty() || !options.empty())
342 IO::print("\nHelp for package %s:\n", main_pkg.get_name());
344 if(!requires.empty())
346 IO::print("\nRequired packages:\n ");
347 for(auto i=requires.begin(); i!=requires.end(); ++i)
349 if(i!=requires.begin())
351 IO::print((*i)->get_name());
358 IO::print("\nPackage configuration:\n");
359 for(const auto &kvp: options)
361 const Config::Option &opt = kvp.second;
362 string line = format(" %s: %s (%s)", opt.name, opt.description, opt.value);
363 if(!opt.choices.empty())
366 line += join(opt.choices.begin(), opt.choices.end(), " ");
369 else if(opt.value!=opt.default_value)
370 line += format(" [%s]", opt.default_value);
371 IO::print("%s\n", line);