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"),
30 create_makefile(false)
34 bool full_paths = false;
35 unsigned max_depth = 4;
39 bool no_externals = false;
42 list<string> log_channels;
46 getopt.add_option('a', "analyze", analyze_mode, GetOpt::REQUIRED_ARG).set_help("Perform dependency analysis.", "MODE");
47 getopt.add_option('b', "build", build, GetOpt::NO_ARG).set_help("Perform build even if also doing something else.");
48 getopt.add_option('c', "clean", clean, GetOpt::NO_ARG).set_help("Clean buildable targets.");
49 getopt.add_option('f', "file", build_file, GetOpt::REQUIRED_ARG).set_help("Read build instructions from FILE.", "FILE");
50 getopt.add_option('h', "help", help, GetOpt::NO_ARG).set_help("Print this message.");
51 getopt.add_option('j', "jobs", jobs, GetOpt::REQUIRED_ARG).set_help("Run up to NUM tasks in parallel.", "NUM");
52 getopt.add_option('l', "log", log_channels, GetOpt::REQUIRED_ARG).set_help("Enable listed log channels.", "LIST");
53 getopt.add_option('n', "dry-run", dry_run, GetOpt::NO_ARG).set_help("Show what would be done without actually doing it.");
54 getopt.add_option('s', "silent", silent, GetOpt::NO_ARG).set_help("Don't print any messages other than errors.");
55 getopt.add_option('t', "build-type", build_type, GetOpt::REQUIRED_ARG).set_help("Set build type.", "TYPE");
56 getopt.add_option('v', "verbose", verbose, GetOpt::NO_ARG).set_help("Print more information about what's going on.");
57 getopt.add_option('x', "no-externals",no_externals, GetOpt::NO_ARG).set_help("Do not load external source packages.");
58 getopt.add_option('A', "conf-all", conf_all, GetOpt::NO_ARG).set_help("Apply configuration to all packages.");
59 getopt.add_option('B', "build-all", build_all, GetOpt::NO_ARG).set_help("Build all targets unconditionally.");
60 getopt.add_option('C', "chdir", work_dir, GetOpt::REQUIRED_ARG).set_help("Change to DIR before doing anything else.", "DIR");
61 getopt.add_option('P', "progress", show_progress, GetOpt::NO_ARG).set_help("Display progress while building.");
62 getopt.add_option('W', "what-if", what_if, GetOpt::REQUIRED_ARG).set_help("Pretend that FILE has changed.", "FILE");
63 getopt.add_option( "arch", arch, GetOpt::REQUIRED_ARG).set_help("Build for architecture ARCH.", "ARCH");
64 getopt.add_option( "conf-only", conf_only, GetOpt::NO_ARG).set_help("Stop after configuring packages.");
65 getopt.add_option( "full-paths", full_paths, GetOpt::NO_ARG).set_help("Output full paths in analysis.");
66 getopt.add_option( "max-depth", max_depth, GetOpt::REQUIRED_ARG).set_help("Show up to NUM levels in analysis.", "NUM");
67 getopt.add_option( "prefix", prefix, GetOpt::REQUIRED_ARG).set_help("Install things to DIR.", "DIR");
68 getopt.add_option( "tempdir", tempdir, GetOpt::REQUIRED_ARG).set_help("Store temporary files in DIR.", "DIR");
69 getopt.add_argument("target", cmdline_targets, GetOpt::OPTIONAL_ARG).set_help("Target(s) to build");
74 helpmsg = "Usage:\n ";
75 helpmsg += getopt.generate_usage(argv[0], true);
77 helpmsg += getopt.generate_help();
84 logger.enable_channel("summary");
85 logger.enable_channel("tasks");
89 logger.enable_channel("environment");
90 logger.enable_channel("packages");
91 logger.enable_channel("commands");
95 logger.enable_channel("files");
96 logger.enable_channel("auxcommands");
98 for(list<string>::const_iterator i=log_channels.begin(); i!=log_channels.end(); ++i)
100 vector<string> parts = split(*i, ',');
101 for(vector<string>::const_iterator j=parts.begin(); j!=parts.end(); ++j)
102 logger.enable_channel(*j);
104 builder.set_logger(&logger);
106 if(!analyze_mode.empty())
108 analyzer = new Analyzer(builder);
110 if(analyze_mode=="deps")
111 analyzer->set_mode(Analyzer::DEPS);
112 else if(analyze_mode=="alldeps")
113 analyzer->set_mode(Analyzer::ALLDEPS);
114 else if(analyze_mode=="rebuild")
115 analyzer->set_mode(Analyzer::REBUILD);
116 else if(analyze_mode=="rdeps")
117 analyzer->set_mode(Analyzer::RDEPS);
119 throw usage_error("Invalid analyze mode");
121 analyzer->set_max_depth(max_depth);
122 analyzer->set_full_paths(full_paths);
124 else if(!clean && !create_makefile)
127 for(NameList::iterator i=cmdline_targets.begin(); i!=cmdline_targets.end(); )
129 string::size_type equal = i->find('=');
130 if(equal!=string::npos)
132 cmdline_options.insert(Config::InputOptions::value_type(i->substr(0, equal), i->substr(equal+1)));
133 cmdline_targets.erase(i++);
139 if(!work_dir.empty())
144 PackageManager &package_manager = builder.get_package_manager();
146 package_manager.append_package_path(cwd);
147 package_manager.append_package_path(cwd/"..");
148 package_manager.append_binary_package_path(FS::get_sys_data_dir()/"packages");
150 package_manager.set_no_externals(no_externals);
152 builder.set_architecture(arch);
154 list<FS::Path> start_files;
155 start_files.push_back(FS::get_sys_data_dir()/"builderrc");
156 start_files.push_back(FS::get_user_data_dir()/"rc");
157 for(list<FS::Path>::const_iterator i=start_files.begin(); i!=start_files.end(); ++i)
159 builder.load_build_file(*i);
162 builder.set_prefix(cwd/prefix);
165 builder.set_temp_directory(tempdir);
167 if(!build_type.empty())
168 builder.set_build_type(build_type);
170 builder.add_default_tools();
172 const Toolchain &toolchain = builder.get_toolchain();
173 for(Config::InputOptions::iterator i=cmdline_options.begin(); i!=cmdline_options.end(); )
175 if(toolchain.has_tool(i->first))
177 toolchain.get_tool(i->first).set_command(i->second);
178 cmdline_options.erase(i++);
185 BuilderCLI::~BuilderCLI()
190 int BuilderCLI::main()
192 FS::Path main_file = cwd/build_file;
193 if(FS::exists(main_file))
194 builder.load_build_file(main_file, &cmdline_options, conf_all);
197 IO::print(IO::cerr, "The file %s does not exist.\n", main_file);
203 IO::print("Builder 1.0\n"
204 "Copyright © 2006-2013 Mikkosoft Productions, Mikko Rasa\n"
205 "Licensed under the GPL\n\n"
217 const Architecture &native_arch = builder.get_native_arch();
218 const Architecture ¤t_arch = builder.get_current_arch();
219 logger.log("environment", format("Building on %s, for %s%s", native_arch.get_name(),
220 current_arch.get_name(), (current_arch.is_native() ? " (native)" : "")));
221 logger.log("environment", format("Prefix is %s", builder.get_prefix()));
222 const FS::Path &tempdir = builder.get_temp_directory();
223 if(tempdir.is_absolute())
224 logger.log("environment", format("Temporary directory is %s", tempdir));
226 logger.log("environment", format("Using per-package temporary directory %s", tempdir));
227 const BuildType &build_type = builder.get_build_type();
228 logger.log("environment", format("Build type is %s", build_type.get_name()));
230 BuildGraph &build_graph = builder.get_build_graph();
231 PackageManager &package_manager = builder.get_package_manager();
232 const PackageManager::PackageMap &packages = package_manager.get_packages();
233 list<string> package_details;
234 for(PackageManager::PackageMap::const_iterator i=packages.begin(); i!=packages.end(); ++i)
236 if(!i->second->is_prepared())
239 string line = i->second->get_name();
240 if(dynamic_cast<SourcePackage *>(i->second))
245 unsigned to_be_built = 0;
246 const BuildGraph::TargetMap &targets = build_graph.get_targets();
247 for(BuildGraph::TargetMap::const_iterator j=targets.begin(); j!=targets.end(); ++j)
248 if(j->second->get_package()==i->second)
251 if(j->second->needs_rebuild())
256 line += format(" (%d targets", count);
258 line += format(", %d to be built", to_be_built);
263 package_details.push_back(line);
266 logger.log("summary", format("%d active packages, %d targets", package_details.size(), build_graph.get_targets().size()));
267 for(list<string>::const_iterator i=package_details.begin(); i!=package_details.end(); ++i)
268 logger.log("packages", *i);
273 if(build_graph.get_goals().is_broken())
275 list<string> problems = builder.collect_problems();
276 IO::print(IO::cerr, "The following problems were detected:\n");
277 for(list<string>::const_iterator i=problems.begin(); i!=problems.end(); ++i)
278 IO::print(IO::cerr, " %s\n", *i);
280 IO::print(IO::cerr, "Please fix them and try again.\n");
285 exit_code = builder.clean(clean>=2, dry_run);
287 exit_code = builder.build(jobs, dry_run, show_progress);
292 bool BuilderCLI::prepare_build()
294 /* XXX This is ugly; using the Builder class should not be this convoluted.
295 But the command line targets and what ifs need to be set at certain points
296 during preparation. */
297 BuildGraph &build_graph = builder.get_build_graph();
298 PackageManager &package_manager = builder.get_package_manager();
300 package_manager.get_main_package().prepare();
302 // Add targets from command line as goals
303 for(NameList::iterator i=cmdline_targets.begin(); i!=cmdline_targets.end(); ++i)
305 Target *tgt = resolve_target(*i);
308 IO::print("I don't know anything about %s\n", *i);
312 build_graph.add_goal(*tgt);
315 build_graph.prepare();
318 for(NameList::iterator i=what_if.begin(); i!=what_if.end(); ++i)
320 FileTarget *tgt = dynamic_cast<FileTarget *>(resolve_target(*i));
323 IO::print(IO::cerr, "Unknown what-if target %s\n", *i);
330 build_graph.force_full_rebuild();
333 package_manager.save_all_caches();
338 Target *BuilderCLI::resolve_target(const string &name)
340 Target *tgt = builder.get_build_graph().get_target(name);
342 tgt = builder.get_vfs().get_target(cwd/name);
346 void BuilderCLI::package_help()
348 PackageManager &package_manager = builder.get_package_manager();
349 if(package_manager.get_packages().empty())
352 SourcePackage &main_pkg = dynamic_cast<SourcePackage &>(package_manager.get_main_package());
353 const Config &config = main_pkg.get_config();
354 const Config::OptionMap &options = config.get_options();
356 IO::print("\nRequired packages:\n ");
357 const Package::Requirements &requires = main_pkg.get_required_packages();
358 for(Package::Requirements::const_iterator i=requires.begin(); i!=requires.end(); ++i)
360 if(i!=requires.begin())
362 IO::print((*i)->get_name());
368 IO::print("\nPackage configuration:\n");
369 for(Config::OptionMap::const_iterator i=options.begin(); i!=options.end(); ++i)
371 const Config::Option &opt = i->second;
372 string line = format(" %s: %s (%s)", opt.name, opt.description, opt.value);
373 if(!opt.choices.empty())
376 for(list<string>::const_iterator j=opt.choices.begin(); j!=opt.choices.end(); ++j)
378 if(j!=opt.choices.begin())
384 else if(opt.value!=opt.default_value)
385 line += format(" [%s]", opt.default_value);
386 IO::print("%s\n", line);