3 #include <msp/progress.h>
4 #include <msp/strconv.h>
5 #include <msp/strutils.h>
6 #include <msp/core/error.h>
7 #include <msp/getopt++/getopt++.h>
8 #include <msp/parser/parser.h>
9 #include <msp/path/utils.h>
10 #include <msp/time/units.h>
11 #include <msp/time/utils.h>
15 #include "executable.h"
19 #include "objectfile.h"
21 #include "sharedlibrary.h"
22 #include "staticlibrary.h"
23 #include "systemlibrary.h"
24 #include "virtualtarget.h"
29 Builder::Builder(int argc, char **argv):
38 getopt.add_option(GetOpt::Option('a', "analyze", GetOpt::REQUIRED));
39 getopt.add_option(GetOpt::Option('b', "build", GetOpt::NONE));
40 getopt.add_option(GetOpt::Option('c', "clean", GetOpt::NONE));
41 getopt.add_option(GetOpt::Option('f', "file", GetOpt::REQUIRED, "Build"));
42 getopt.add_option(GetOpt::Option('h', "help", GetOpt::NONE));
43 getopt.add_option(GetOpt::Option('j', "jobs", GetOpt::REQUIRED, "1"));
44 getopt.add_option(GetOpt::Option('n', "dry-run", GetOpt::NONE));
45 getopt.add_option(GetOpt::Option('v', "verbose", GetOpt::NONE));
46 getopt.add_option(GetOpt::Option('A', "conf-all", GetOpt::NONE));
47 getopt.add_option(GetOpt::Option('B', "build-all", GetOpt::NONE));
48 getopt.add_option(GetOpt::Option('C', "chdir", GetOpt::REQUIRED));
49 getopt.add_option(GetOpt::Option('W', "what-if", GetOpt::REQUIRED));
50 getopt.add_option(GetOpt::Option("chrome", GetOpt::NONE));
51 getopt.add_option(GetOpt::Option("full-paths", GetOpt::NONE));
52 getopt.add_option(GetOpt::Option("max-depth", GetOpt::REQUIRED));
53 int index=getopt(argc, argv);
55 verbose+=getopt['v'].count();
59 analyzer=new Analyzer(*this);
61 string mode=getopt['a'].arg();
63 analyzer->set_mode(Analyzer::DEPS);
64 else if(mode=="alldeps")
65 analyzer->set_mode(Analyzer::ALLDEPS);
66 else if(mode=="rebuild")
67 analyzer->set_mode(Analyzer::REBUILD);
68 else if(mode=="rdeps")
69 analyzer->set_mode(Analyzer::RDEPS);
71 throw UsageError("Invalid analysis mode");
73 if(getopt["max-depth"])
74 analyzer->set_max_depth(strtol(getopt["max-depth"].arg()));
75 analyzer->set_full_paths(getopt["full-paths"]);
82 jobs=max(strtol(getopt['j'].arg()), 1L);
83 chrome=getopt["chrome"];
85 build_file=getopt['f'].arg();
86 build_all=getopt['B'];
90 chdir(getopt['C'].arg().c_str());
92 for(int i=index; i<argc; ++i)
95 unsigned equal=v.find('=');
96 if(equal!=string::npos)
97 cmdline_options.insert(RawOptionMap::value_type(v.substr(0, equal), v.substr(equal+1)));
99 cmdline_targets.push_back(argv[i]);
102 if(cmdline_targets.empty())
103 cmdline_targets.push_back("default");
106 what_if.push_back(getopt['W'].arg());
112 Gets a package with the specified name, possibly creating it.
114 @param n Package name
116 @return Pointer to the package, or 0 if the package could not be located
118 Package *Builder::get_package(const string &n)
120 PackageMap::iterator i=packages.find(n);
121 if(i!=packages.end())
124 // Try to get source directory with pkgconfig
126 argv.push_back("pkg-config");
127 argv.push_back("--variable=source");
129 string srcdir=strip(run_command(argv));
133 dirs.push_back(srcdir);
135 // Make some other guesses about the source directory
137 if(!dirname.compare(0, 3, "msp"))
139 dirs.push_back(cwd/dirname);
140 dirs.push_back(cwd/".."/dirname);
142 // Go through the candidate directories and look for a Build file
143 for(PathList::iterator j=dirs.begin(); j!=dirs.end(); ++j)
144 if(!load_build_file(*j/"Build"))
147 if(i!=packages.end())
152 // Package source not found - create a binary package
153 Package *pkg=Package::create(*this, n);
154 packages.insert(PackageMap::value_type(n, pkg));
156 new_pkgs.push_back(pkg);
162 Returns the target with the given name, or 0 if no such target exists.
164 Target *Builder::get_target(const string &n)
166 TargetMap::iterator i=targets.find(n);
173 Tries to locate a header included from a given location and with a given include
174 path. Considers known targets as well as existing files. If a matching target
175 is not found but a file exists, a new SystemHeader target will be created and
178 Target *Builder::get_header(const string &include, const string &from, const list<string> &path)
181 update_hash(hash, from);
182 for(list<string>::const_iterator i=path.begin(); i!=path.end(); ++i)
183 update_hash(hash, *i);
185 string id=hash+include;
186 TargetMap::iterator i=includes.find(id);
187 if(i!=includes.end())
190 string fn=include.substr(1);
192 if(include[0]=='"' && (tgt=check_header(Path::Path(from)/fn)))
194 if((tgt=check_header(Path::Path("/usr/include")/fn)))
196 //XXX Determine the C++ header location dynamically
197 if((tgt=check_header(Path::Path("/usr/include/c++/4.1.2")/fn)))
199 for(list<string>::const_iterator j=path.begin(); j!=path.end(); ++j)
200 if((tgt=check_header(cwd/ *j/fn)))
207 Tries to locate a library with the given library path. Considers known targets
208 as well as existing files. If a matching target is not found but a file exists,
209 a new SystemLibrary target will be created and returned.
211 Target *Builder::get_library(const string &lib, const list<string> &path)
214 for(list<string>::const_iterator i=path.begin(); i!=path.end(); ++i)
215 update_hash(hash, *i);
218 TargetMap::iterator i=libraries.find(id);
219 if(i!=libraries.end())
222 string basename="lib"+lib+".so";
223 for(list<string>::const_iterator j=path.begin(); j!=path.end(); ++j)
225 string full=(cwd/ *j/basename).str();
226 Target *tgt=get_target(full);
229 if(Path::exists(full))
231 add_target(tgt=new SystemLibrary(*this, full));
241 if(load_build_file(cwd/build_file))
243 cerr<<"No build info here.\n";
247 default_pkg=packages.begin()->second;
249 while(!new_pkgs.empty())
251 Package *pkg=new_pkgs.front();
252 if(pkg==default_pkg || conf_all)
253 pkg->process_options(cmdline_options);
254 new_pkgs.erase(new_pkgs.begin());
260 usage("builder", false);
267 for(PackageMap::iterator i=packages.begin(); i!=packages.end(); ++i)
269 missing.push_back(i->first);
274 cerr<<"The following packages were not found on the system:\n";
275 for(list<string>::iterator i=missing.begin(); i!=missing.end(); ++i)
277 cerr<<"Please install them and try again.\n";
281 default_pkg->create_build_info();
286 cout<<packages.size()<<" packages, "<<targets.size()<<" targets\n";
289 for(PackageMap::iterator i=packages.begin(); i!=packages.end(); ++i)
291 cout<<' '<<i->second->get_name();
292 if(i->second->get_buildable())
295 unsigned ood_count=0;
296 for(TargetMap::iterator j=targets.begin(); j!=targets.end(); ++j)
297 if(j->second->get_package()==i->second)
300 if(j->second->get_rebuild())
305 cout<<" ("<<count<<" targets";
307 cout<<", "<<ood_count<<" out-of-date";
325 for(PackageMap::iterator i=packages.begin(); i!=packages.end(); ++i)
327 for(TargetMap::iterator i=targets.begin(); i!=targets.end(); ++i)
332 void Builder::usage(const char *argv0, bool brief)
335 cerr<<"Usage: "<<argv0<<" [-a|--analyze MODE] [-b|--build] [-c|--clean] [-f|--file FILE] [-h|--help] [-j|--jobs NUM] [-n||--dry-run] [-v|--verbose] [-A|--conf-all] [-B|--build-all] [-C|--chdir DIRECTORY] [-W|--what-if FILE] [--chrome] [--full-paths] [--max-depth NUM] [<target> ...]";
339 "Usage: "<<argv0<<" [options] [<target> ...]\n"
342 " -a, --analyze MODE Perform analysis. MODE can be deps, alldeps or rebuild.\n"
343 " -b, --build Perform build even if doing analysis.\n"
344 " -c, --clean Clean buildable targets.\n"
345 " -f, --file FILE Read info from FILE instead of Build.\n"
346 " -h, --help Print this message.\n"
347 " -j, --jobs NUM Run NUM commands at once, whenever possible.\n"
348 " -n, --dry-run Don't actually do anything, only show what would be done.\n"
349 " -v, --verbose Print more information about what's going on.\n"
350 " -A, --conf-all Apply configuration to all packages.\n"
351 " -B, --build-all Build all targets unconditionally.\n"
352 " -C, --chdir DIR Change to DIR before doing anything else.\n"
353 " -W, --what-if FILE Pretend that FILE has changed.\n"
354 " --chrome Use extra chrome to print status.\n"
355 " --full-paths Output full paths in analysis.\n"
356 " --max-depth NUM Maximum depth to show in analysis.\n";
361 Loads the given build file.
363 @param fn Path to the file
365 @return 0 on success, -1 if the file could not be opened
367 int Builder::load_build_file(const Path::Path &fn)
369 ifstream in(fn.str().c_str());
373 Parser::Parser parser(in, fn.str());
374 Loader loader(*this, fn.subpath(0, fn.size()-1));
381 Creates targets for all packages and prepares them for building.
383 @return 0 if everything went ok, -1 if something bad happened and a build
384 shouldn't be attempted
386 int Builder::create_targets()
388 Target *world=new VirtualTarget(*this, "world");
391 Target *def_tgt=new VirtualTarget(*this, "default");
393 world->add_depend(def_tgt);
395 Target *install=new VirtualTarget(*this, "install");
397 world->add_depend(install);
399 for(PackageMap::iterator i=packages.begin(); i!=packages.end(); ++i)
403 if(!i->second->get_buildable())
406 Path::Path inst_base;
407 if(i->second->get_config().is_option("prefix"))
408 inst_base=i->second->get_config().get_option("prefix").value;
410 const ComponentList &components=i->second->get_components();
411 for(ComponentList::const_iterator j=components.begin(); j!=components.end(); ++j)
413 // Collect all files belonging to the component
415 const PathList &sources=j->get_sources();
416 for(PathList::const_iterator k=sources.begin(); k!=sources.end(); ++k)
420 if(S_ISDIR(st.st_mode))
422 list<string> sfiles=list_files(*k);
423 for(list<string>::iterator l=sfiles.begin(); l!=sfiles.end(); ++l)
424 files.push_back(*k / *l);
430 bool build_exe=j->get_type()!=Component::HEADERS;
432 list<ObjectFile *> objs;
433 for(PathList::iterator k=files.begin(); k!=files.end(); ++k)
435 string basename=(*k)[-1];
436 string ext=Path::splitext(basename).ext;
437 if((ext==".cpp" || ext==".c") && build_exe)
439 SourceFile *src=new SourceFile(*this, &*j, k->str());
443 ObjectFile *obj=new ObjectFile(*this, *j, *src);
449 Target *hdr=get_target(k->str());
452 hdr=new Header(*this, &*j, k->str());
456 // Install headers if requested
457 if(!j->get_install_headers().empty())
459 Path::Path inst_path=inst_base/"include"/j->get_install_headers()/basename;
460 Install *inst=new Install(*this, *i->second, *hdr, inst_path.str());
462 install->add_depend(inst);
470 StaticLibrary *slib=0;
471 if(j->get_type()==Component::LIBRARY)
473 exe=new SharedLibrary(*this, *j, objs);
474 slib=new StaticLibrary(*this, *j, objs);
478 exe=new Executable(*this, *j, objs);
481 if(i->second==default_pkg)
483 def_tgt->add_depend(exe);
484 if(slib) def_tgt->add_depend(slib);
488 world->add_depend(exe);
489 if(slib) world->add_depend(slib);
495 if(j->get_type()==Component::PROGRAM)
497 else if(j->get_type()==Component::LIBRARY)
499 if(!inst_dir.empty())
501 Install *inst=new Install(*this, *i->second, *exe, (inst_base/inst_dir/Path::basename(exe->get_name())).str());
503 install->add_depend(inst);
507 inst=new Install(*this, *i->second, *slib, (inst_base/inst_dir/Path::basename(slib->get_name())).str());
509 install->add_depend(inst);
517 // Find dependencies until no new targets are created
518 while(!new_tgts.empty())
520 Target *tgt=new_tgts.front();
521 new_tgts.erase(new_tgts.begin());
523 if(!tgt->get_depends_ready())
524 new_tgts.push_back(tgt);
528 for(StringList::iterator i=what_if.begin(); i!=what_if.end(); ++i)
530 Target *tgt=get_target((cwd/ *i).str());
533 cerr<<"Unknown what-if target "<<*i<<'\n';
539 // Make the cmdline target depend on all targets mentioned on the command line
540 Target *cmdline=new VirtualTarget(*this, "cmdline");
542 world->add_depend(cmdline);
543 for(list<string>::iterator i=cmdline_targets.begin(); i!=cmdline_targets.end(); ++i)
545 Target *tgt=get_target(*i);
547 tgt=get_target((cwd/ *i).str());
550 cerr<<"I don't know anything about "<<*i<<'\n';
553 cmdline->add_depend(tgt);
562 Check if a header exists, either as a target or a file. Either an existing
563 target or a new SystemHeader target will be returned.
565 Target *Builder::check_header(const Msp::Path::Path &fn)
567 Target *tgt=get_target(fn.str());
572 add_target(tgt=new SystemHeader(*this, fn.str()));
579 Adds a target to both the target map and the new target queue.
581 void Builder::add_target(Target *t)
583 targets.insert(TargetMap::value_type(t->get_name(), t));
584 new_tgts.push_back(t);
588 Updates a hash with a string. This is used from get_header and get_library.
590 void Builder::update_hash(string &hash, const string &value)
592 for(unsigned i=0; i<value.size(); ++i)
593 hash[i%hash.size()]^=value[i];
597 This function supervises the build process, starting new actions when slots
602 Target *cmdline=get_target("cmdline");
604 unsigned total=cmdline->count_rebuild();
607 cout<<"Already up to date\n";
610 cout<<"Will build "<<total<<" target(s)\n";
612 vector<Action *> actions;
615 cout<<"0 targets built\n";
623 if(actions.size()<jobs && !fail)
625 Target *tgt=cmdline->get_buildable_target();
628 Action *action=tgt->build();
630 actions.push_back(action);
632 else if(actions.empty())
636 Time::sleep(10*Time::msec);
638 for(unsigned i=0; i<actions.size();)
640 int status=actions[i]->check();
646 cout<<"\e["<<actions.size()+1<<'A';
647 cout<<count<<" targets built\n";
651 if(i<actions.size()-1)
652 cout<<"\e["<<actions.size()-i-1<<"B";
656 actions.erase(actions.begin()+i);
659 if(actions.empty() && fail)
671 Prints out information about the default package.
673 void Builder::package_help()
675 const Config &config=default_pkg->get_config();
676 const Config::OptionMap &options=config.get_options();
678 cout<<"Required packages:\n ";
679 const PkgRefList &requires=default_pkg->get_requires();
680 for(PkgRefList::const_iterator i=requires.begin(); i!=requires.end(); ++i)
682 if(i!=requires.begin())
687 cout<<"Package configuration:\n";
688 for(Config::OptionMap::const_iterator i=options.begin(); i!=options.end(); ++i)
690 const Config::Option &opt=i->second;
691 cout<<" "<<opt.name<<": "<<opt.descr<<" ("<<opt.value<<") ["<<opt.defv<<"]\n";
695 Application::RegApp<Builder> Builder::reg;
697 Builder::Loader::Loader(Builder &b, const Path::Path &s):
701 add("package", &Loader::package);
704 void Builder::Loader::package(const string &n)
706 Package *pkg=new Package(bld, n, src);
708 bld.packages.insert(PackageMap::value_type(n, pkg));
709 bld.new_pkgs.push_back(pkg);