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("conf-only", GetOpt::NONE));
52 getopt.add_option(GetOpt::Option("full-paths", GetOpt::NONE));
53 getopt.add_option(GetOpt::Option("max-depth", GetOpt::REQUIRED));
54 int index=getopt(argc, argv);
56 verbose+=getopt['v'].count();
60 analyzer=new Analyzer(*this);
62 string mode=getopt['a'].arg();
64 analyzer->set_mode(Analyzer::DEPS);
65 else if(mode=="alldeps")
66 analyzer->set_mode(Analyzer::ALLDEPS);
67 else if(mode=="rebuild")
68 analyzer->set_mode(Analyzer::REBUILD);
69 else if(mode=="rdeps")
70 analyzer->set_mode(Analyzer::RDEPS);
72 throw UsageError("Invalid analysis mode");
74 if(getopt["max-depth"])
75 analyzer->set_max_depth(strtol(getopt["max-depth"].arg()));
76 analyzer->set_full_paths(getopt["full-paths"]);
83 jobs=max(strtol(getopt['j'].arg()), 1L);
84 chrome=getopt["chrome"];
86 conf_only=getopt["conf-only"];
87 build_file=getopt['f'].arg();
88 build_all=getopt['B'];
92 chdir(getopt['C'].arg().c_str());
94 for(int i=index; i<argc; ++i)
97 unsigned equal=v.find('=');
98 if(equal!=string::npos)
99 cmdline_options.insert(RawOptionMap::value_type(v.substr(0, equal), v.substr(equal+1)));
101 cmdline_targets.push_back(argv[i]);
104 if(cmdline_targets.empty())
105 cmdline_targets.push_back("default");
108 what_if.push_back(getopt['W'].arg());
114 Gets a package with the specified name, possibly creating it.
116 @param n Package name
118 @return Pointer to the package, or 0 if the package could not be located
120 Package *Builder::get_package(const string &n)
122 PackageMap::iterator i=packages.find(n);
123 if(i!=packages.end())
126 // Try to get source directory with pkgconfig
128 argv.push_back("pkg-config");
129 argv.push_back("--variable=source");
131 string srcdir=strip(run_command(argv));
135 dirs.push_back(srcdir);
137 // Make some other guesses about the source directory
139 if(!dirname.compare(0, 3, "msp"))
141 dirs.push_back(cwd/dirname);
142 dirs.push_back(cwd/".."/dirname);
144 // Go through the candidate directories and look for a Build file
145 for(PathList::iterator j=dirs.begin(); j!=dirs.end(); ++j)
146 if(!load_build_file(*j/"Build"))
149 if(i!=packages.end())
154 // Package source not found - create a binary package
155 Package *pkg=Package::create(*this, n);
156 packages.insert(PackageMap::value_type(n, pkg));
158 new_pkgs.push_back(pkg);
164 Returns the target with the given name, or 0 if no such target exists.
166 Target *Builder::get_target(const string &n)
168 TargetMap::iterator i=targets.find(n);
175 Tries to locate a header included from a given location and with a given include
176 path. Considers known targets as well as existing files. If a matching target
177 is not found but a file exists, a new SystemHeader target will be created and
180 Target *Builder::get_header(const string &include, const string &from, const list<string> &path)
183 update_hash(hash, from);
184 for(list<string>::const_iterator i=path.begin(); i!=path.end(); ++i)
185 update_hash(hash, *i);
187 string id=hash+include;
188 TargetMap::iterator i=includes.find(id);
189 if(i!=includes.end())
192 string fn=include.substr(1);
194 if(include[0]=='"' && (tgt=get_header(Path::Path(from)/fn)))
196 else if((tgt=get_header(Path::Path("/usr/include")/fn)))
198 //XXX Determine the C++ header location dynamically
199 else if((tgt=get_header(Path::Path("/usr/include/c++/4.1.2")/fn)))
203 for(list<string>::const_iterator j=path.begin(); (j!=path.end() && !tgt); ++j)
204 tgt=get_header(cwd/ *j/fn);
207 includes.insert(TargetMap::value_type(id, tgt));
213 Tries to locate a library with the given library path. Considers known targets
214 as well as existing files. If a matching target is not found but a file exists,
215 a new SystemLibrary target will be created and returned.
217 @param lib Name of the library to get (without "lib" prefix or extension)
218 @param path List of paths to search for the library
219 @param mode Shared / shared mode - 0: always shared, 1: static for buildable
220 packages, otherwise shared, 2: always static
222 @return Some kind of library target, if a match was found
224 Target *Builder::get_library(const string &lib, const list<string> &path, unsigned mode)
227 for(list<string>::const_iterator i=path.begin(); i!=path.end(); ++i)
228 update_hash(hash, *i);
230 //XXX Incorporate mode into id
232 TargetMap::iterator i=libraries.find(id);
233 if(i!=libraries.end())
237 if((tgt=get_library(lib, "/lib", mode)))
239 else if((tgt=get_library(lib, "/usr/lib", mode)))
243 for(list<string>::const_iterator j=path.begin(); (j!=path.end() && !tgt); ++j)
244 tgt=get_library(lib, cwd/ *j, mode);
247 libraries.insert(TargetMap::value_type(id, tgt));
254 if(load_build_file(cwd/build_file))
256 cerr<<"No build info here.\n";
260 default_pkg=packages.begin()->second;
262 while(!new_pkgs.empty())
264 Package *pkg=new_pkgs.front();
265 new_pkgs.erase(new_pkgs.begin());
269 default_pkg->configure(cmdline_options, conf_all?2:1);
273 usage("builder", false);
280 for(PackageMap::iterator i=packages.begin(); i!=packages.end(); ++i)
282 missing.push_back(i->first);
287 cerr<<"The following packages were not found on the system:\n";
288 for(list<string>::iterator i=missing.begin(); i!=missing.end(); ++i)
290 cerr<<"Please install them and try again.\n";
300 cout<<packages.size()<<" packages, "<<targets.size()<<" targets\n";
303 for(PackageMap::iterator i=packages.begin(); i!=packages.end(); ++i)
305 cout<<' '<<i->second->get_name();
306 if(i->second->get_buildable())
309 unsigned ood_count=0;
310 for(TargetMap::iterator j=targets.begin(); j!=targets.end(); ++j)
311 if(j->second->get_package()==i->second)
314 if(j->second->get_rebuild())
319 cout<<" ("<<count<<" targets";
321 cout<<", "<<ood_count<<" out-of-date";
339 for(PackageMap::iterator i=packages.begin(); i!=packages.end(); ++i)
341 for(TargetMap::iterator i=targets.begin(); i!=targets.end(); ++i)
346 void Builder::usage(const char *argv0, bool brief)
349 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> ...]";
353 "Usage: "<<argv0<<" [options] [<target> ...]\n"
356 " -a, --analyze MODE Perform analysis. MODE can be deps, alldeps or rebuild.\n"
357 " -b, --build Perform build even if doing analysis.\n"
358 " -c, --clean Clean buildable targets.\n"
359 " -f, --file FILE Read info from FILE instead of Build.\n"
360 " -h, --help Print this message.\n"
361 " -j, --jobs NUM Run NUM commands at once, whenever possible.\n"
362 " -n, --dry-run Don't actually do anything, only show what would be done.\n"
363 " -v, --verbose Print more information about what's going on.\n"
364 " -A, --conf-all Apply configuration to all packages.\n"
365 " -B, --build-all Build all targets unconditionally.\n"
366 " -C, --chdir DIR Change to DIR before doing anything else.\n"
367 " -W, --what-if FILE Pretend that FILE has changed.\n"
368 " --chrome Use extra chrome to print status.\n"
369 " --conf-only Stop after configuring packages.\n"
370 " --full-paths Output full paths in analysis.\n"
371 " --max-depth NUM Maximum depth to show in analysis.\n";
376 Loads the given build file.
378 @param fn Path to the file
380 @return 0 on success, -1 if the file could not be opened
382 int Builder::load_build_file(const Path::Path &fn)
384 ifstream in(fn.str().c_str());
388 Parser::Parser parser(in, fn.str());
389 Loader loader(*this, fn.subpath(0, fn.size()-1));
396 Creates targets for all packages and prepares them for building.
398 @return 0 if everything went ok, -1 if something bad happened and a build
399 shouldn't be attempted
401 int Builder::create_targets()
403 Target *world=new VirtualTarget(*this, "world");
406 Target *def_tgt=new VirtualTarget(*this, "default");
408 world->add_depend(def_tgt);
410 Target *install=new VirtualTarget(*this, "install");
412 world->add_depend(install);
414 for(PackageMap::iterator i=packages.begin(); i!=packages.end(); ++i)
418 if(!i->second->get_buildable())
421 Path::Path inst_base;
422 if(i->second->get_config().is_option("prefix"))
423 inst_base=i->second->get_config().get_option("prefix").value;
425 const ComponentList &components=i->second->get_components();
426 for(ComponentList::const_iterator j=components.begin(); j!=components.end(); ++j)
428 // Collect all files belonging to the component
430 const PathList &sources=j->get_sources();
431 for(PathList::const_iterator k=sources.begin(); k!=sources.end(); ++k)
435 if(S_ISDIR(st.st_mode))
437 list<string> sfiles=list_files(*k);
438 for(list<string>::iterator l=sfiles.begin(); l!=sfiles.end(); ++l)
439 files.push_back(*k / *l);
445 bool build_exe=j->get_type()!=Component::HEADERS;
447 list<ObjectFile *> objs;
448 for(PathList::iterator k=files.begin(); k!=files.end(); ++k)
450 string basename=(*k)[-1];
451 string ext=Path::splitext(basename).ext;
452 if((ext==".cpp" || ext==".c") && build_exe)
454 SourceFile *src=new SourceFile(*this, &*j, k->str());
458 ObjectFile *obj=new ObjectFile(*this, *j, *src);
464 Target *hdr=get_target(k->str());
467 hdr=new Header(*this, &*j, k->str());
471 // Install headers if requested
472 if(!j->get_install_headers().empty())
474 Path::Path inst_path=inst_base/"include"/j->get_install_headers()/basename;
475 Install *inst=new Install(*this, *i->second, *hdr, inst_path.str());
477 install->add_depend(inst);
485 StaticLibrary *slib=0;
486 if(j->get_type()==Component::LIBRARY)
488 exe=new SharedLibrary(*this, *j, objs);
489 slib=new StaticLibrary(*this, *j, objs);
493 exe=new Executable(*this, *j, objs);
496 if(i->second==default_pkg)
498 def_tgt->add_depend(exe);
499 if(slib) def_tgt->add_depend(slib);
503 world->add_depend(exe);
504 if(slib) world->add_depend(slib);
510 if(j->get_type()==Component::PROGRAM)
512 else if(j->get_type()==Component::LIBRARY)
514 if(!inst_dir.empty())
516 Install *inst=new Install(*this, *i->second, *exe, (inst_base/inst_dir/Path::basename(exe->get_name())).str());
518 install->add_depend(inst);
522 inst=new Install(*this, *i->second, *slib, (inst_base/inst_dir/Path::basename(slib->get_name())).str());
524 install->add_depend(inst);
532 // Find dependencies until no new targets are created
533 while(!new_tgts.empty())
535 Target *tgt=new_tgts.front();
536 new_tgts.erase(new_tgts.begin());
538 if(!tgt->get_depends_ready())
539 new_tgts.push_back(tgt);
543 for(StringList::iterator i=what_if.begin(); i!=what_if.end(); ++i)
545 Target *tgt=get_target((cwd/ *i).str());
548 cerr<<"Unknown what-if target "<<*i<<'\n';
554 // Make the cmdline target depend on all targets mentioned on the command line
555 Target *cmdline=new VirtualTarget(*this, "cmdline");
557 world->add_depend(cmdline);
558 for(list<string>::iterator i=cmdline_targets.begin(); i!=cmdline_targets.end(); ++i)
560 Target *tgt=get_target(*i);
562 tgt=get_target((cwd/ *i).str());
565 cerr<<"I don't know anything about "<<*i<<'\n';
568 cmdline->add_depend(tgt);
577 Check if a header exists, either as a target or a file. Either an existing
578 target or a new SystemHeader target will be returned.
580 Target *Builder::get_header(const Msp::Path::Path &fn)
582 Target *tgt=get_target(fn.str());
587 add_target(tgt=new SystemHeader(*this, fn.str()));
593 Target *Builder::get_library(const string &lib, const Path::Path &path, unsigned mode)
598 full=(path/("lib"+lib+".a")).str();
599 Target *tgt=get_target(full);
600 // Targets can only be associated with buildable packages (or no package at all)
601 if(tgt && (tgt->get_package() || mode==2)) return tgt;
605 full=(path/("lib"+lib+".so")).str();
606 Target *tgt=get_target(full);
610 if(Path::exists(full))
612 Target *tgt=new SystemLibrary(*this, full);
621 Adds a target to both the target map and the new target queue.
623 void Builder::add_target(Target *t)
625 targets.insert(TargetMap::value_type(t->get_name(), t));
626 new_tgts.push_back(t);
630 Updates a hash with a string. This is used from get_header and get_library.
632 void Builder::update_hash(string &hash, const string &value)
634 for(unsigned i=0; i<value.size(); ++i)
635 hash[i%hash.size()]^=value[i];
639 This function supervises the build process, starting new actions when slots
644 Target *cmdline=get_target("cmdline");
646 unsigned total=cmdline->count_rebuild();
649 cout<<"Already up to date\n";
652 cout<<"Will build "<<total<<" target(s)\n";
654 vector<Action *> actions;
657 cout<<"0 targets built\n";
665 if(actions.size()<jobs && !fail)
667 Target *tgt=cmdline->get_buildable_target();
670 Action *action=tgt->build();
672 actions.push_back(action);
674 else if(actions.empty())
678 Time::sleep(10*Time::msec);
680 for(unsigned i=0; i<actions.size();)
682 int status=actions[i]->check();
688 cout<<"\e["<<actions.size()+1<<'A';
689 cout<<count<<" targets built\n";
693 if(i<actions.size()-1)
694 cout<<"\e["<<actions.size()-i-1<<"B";
698 actions.erase(actions.begin()+i);
701 if(actions.empty() && fail)
713 Prints out information about the default package.
715 void Builder::package_help()
717 const Config &config=default_pkg->get_config();
718 const Config::OptionMap &options=config.get_options();
720 cout<<"Required packages:\n ";
721 const PkgRefList &requires=default_pkg->get_requires();
722 for(PkgRefList::const_iterator i=requires.begin(); i!=requires.end(); ++i)
724 if(i!=requires.begin())
729 cout<<"Package configuration:\n";
730 for(Config::OptionMap::const_iterator i=options.begin(); i!=options.end(); ++i)
732 const Config::Option &opt=i->second;
733 cout<<" "<<opt.name<<": "<<opt.descr<<" ("<<opt.value<<") ["<<opt.defv<<"]\n";
737 Application::RegApp<Builder> Builder::reg;
739 Builder::Loader::Loader(Builder &b, const Path::Path &s):
743 add("package", &Loader::package);
746 void Builder::Loader::package(const string &n)
748 Package *pkg=new Package(bld, n, src);
750 bld.packages.insert(PackageMap::value_type(n, pkg));
751 bld.new_pkgs.push_back(pkg);