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 "pkgconfig.h"
22 #include "sharedlibrary.h"
23 #include "staticlibrary.h"
24 #include "systemlibrary.h"
25 #include "virtualtarget.h"
30 Builder::Builder(int argc, char **argv):
39 getopt.add_option(GetOpt::Option('a', "analyze", GetOpt::REQUIRED));
40 getopt.add_option(GetOpt::Option('b', "build", GetOpt::NONE));
41 getopt.add_option(GetOpt::Option('c', "clean", GetOpt::NONE));
42 getopt.add_option(GetOpt::Option('f', "file", GetOpt::REQUIRED, "Build"));
43 getopt.add_option(GetOpt::Option('h', "help", GetOpt::NONE));
44 getopt.add_option(GetOpt::Option('j', "jobs", GetOpt::REQUIRED, "1"));
45 getopt.add_option(GetOpt::Option('n', "dry-run", GetOpt::NONE));
46 getopt.add_option(GetOpt::Option('v', "verbose", GetOpt::NONE));
47 getopt.add_option(GetOpt::Option('A', "conf-all", GetOpt::NONE));
48 getopt.add_option(GetOpt::Option('B', "build-all", GetOpt::NONE));
49 getopt.add_option(GetOpt::Option('C', "chdir", GetOpt::REQUIRED));
50 getopt.add_option(GetOpt::Option('W', "what-if", GetOpt::REQUIRED));
51 getopt.add_option(GetOpt::Option("chrome", GetOpt::NONE));
52 getopt.add_option(GetOpt::Option("conf-only", GetOpt::NONE));
53 getopt.add_option(GetOpt::Option("full-paths", GetOpt::NONE));
54 getopt.add_option(GetOpt::Option("max-depth", GetOpt::REQUIRED));
55 int index=getopt(argc, argv);
57 verbose+=getopt['v'].count();
61 analyzer=new Analyzer(*this);
63 string mode=getopt['a'].arg();
65 analyzer->set_mode(Analyzer::DEPS);
66 else if(mode=="alldeps")
67 analyzer->set_mode(Analyzer::ALLDEPS);
68 else if(mode=="rebuild")
69 analyzer->set_mode(Analyzer::REBUILD);
70 else if(mode=="rdeps")
71 analyzer->set_mode(Analyzer::RDEPS);
73 throw UsageError("Invalid analysis mode");
75 if(getopt["max-depth"])
76 analyzer->set_max_depth(strtol(getopt["max-depth"].arg()));
77 analyzer->set_full_paths(getopt["full-paths"]);
84 jobs=max(strtol(getopt['j'].arg()), 1L);
85 chrome=getopt["chrome"];
87 conf_only=getopt["conf-only"];
88 build_file=getopt['f'].arg();
89 build_all=getopt['B'];
93 chdir(getopt['C'].arg().c_str());
95 for(int i=index; i<argc; ++i)
98 unsigned equal=v.find('=');
99 if(equal!=string::npos)
100 cmdline_options.insert(RawOptionMap::value_type(v.substr(0, equal), v.substr(equal+1)));
102 cmdline_targets.push_back(argv[i]);
105 if(cmdline_targets.empty())
106 cmdline_targets.push_back("default");
109 what_if.push_back(getopt['W'].arg());
115 Gets a package with the specified name, possibly creating it.
117 @param n Package name
119 @return Pointer to the package, or 0 if the package could not be located
121 Package *Builder::get_package(const string &n)
123 PackageMap::iterator i=packages.find(n);
124 if(i!=packages.end())
127 // Try to get source directory with pkgconfig
129 argv.push_back("pkg-config");
130 argv.push_back("--variable=source");
132 string srcdir=strip(run_command(argv));
136 dirs.push_back(srcdir);
138 // Make some other guesses about the source directory
140 if(!dirname.compare(0, 3, "msp"))
142 dirs.push_back(cwd/dirname);
143 dirs.push_back(cwd/".."/dirname);
145 // Go through the candidate directories and look for a Build file
146 for(PathList::iterator j=dirs.begin(); j!=dirs.end(); ++j)
147 if(!load_build_file(*j/"Build"))
150 if(i!=packages.end())
155 // Package source not found - create a binary package
156 Package *pkg=Package::create(*this, n);
157 packages.insert(PackageMap::value_type(n, pkg));
159 new_pkgs.push_back(pkg);
165 Returns the target with the given name, or 0 if no such target exists.
167 Target *Builder::get_target(const string &n)
169 TargetMap::iterator i=targets.find(n);
176 Tries to locate a header included from a given location and with a given include
177 path. Considers known targets as well as existing files. If a matching target
178 is not found but a file exists, a new SystemHeader target will be created and
181 Target *Builder::get_header(const string &include, const string &from, const list<string> &path)
184 update_hash(hash, from);
185 for(list<string>::const_iterator i=path.begin(); i!=path.end(); ++i)
186 update_hash(hash, *i);
188 string id=hash+include;
189 TargetMap::iterator i=includes.find(id);
190 if(i!=includes.end())
193 string fn=include.substr(1);
195 if(include[0]=='"' && (tgt=get_header(Path::Path(from)/fn)))
197 else if((tgt=get_header(Path::Path("/usr/include")/fn)))
199 //XXX Determine the C++ header location dynamically
200 else if((tgt=get_header(Path::Path("/usr/include/c++/4.1.2")/fn)))
204 for(list<string>::const_iterator j=path.begin(); (j!=path.end() && !tgt); ++j)
205 tgt=get_header(cwd/ *j/fn);
208 includes.insert(TargetMap::value_type(id, tgt));
214 Tries to locate a library with the given library path. Considers known targets
215 as well as existing files. If a matching target is not found but a file exists,
216 a new SystemLibrary target will be created and returned.
218 @param lib Name of the library to get (without "lib" prefix or extension)
219 @param path List of paths to search for the library
220 @param mode Shared / shared mode - 0: always shared, 1: static for buildable
221 packages, otherwise shared, 2: always static
223 @return Some kind of library target, if a match was found
225 Target *Builder::get_library(const string &lib, const list<string> &path, unsigned mode)
228 for(list<string>::const_iterator i=path.begin(); i!=path.end(); ++i)
229 update_hash(hash, *i);
231 //XXX Incorporate mode into id
233 TargetMap::iterator i=libraries.find(id);
234 if(i!=libraries.end())
238 if((tgt=get_library(lib, "/lib", mode)))
240 else if((tgt=get_library(lib, "/usr/lib", mode)))
244 for(list<string>::const_iterator j=path.begin(); (j!=path.end() && !tgt); ++j)
245 tgt=get_library(lib, cwd/ *j, mode);
248 libraries.insert(TargetMap::value_type(id, tgt));
255 if(load_build_file(cwd/build_file))
257 cerr<<"No build info here.\n";
261 default_pkg=packages.begin()->second;
263 while(!new_pkgs.empty())
265 Package *pkg=new_pkgs.front();
266 new_pkgs.erase(new_pkgs.begin());
270 default_pkg->configure(cmdline_options, conf_all?2:1);
274 usage(0, "builder", false);
281 for(PackageMap::iterator i=packages.begin(); i!=packages.end(); ++i)
283 missing.push_back(i->first);
288 cerr<<"The following packages were not found on the system:\n";
289 for(list<string>::iterator i=missing.begin(); i!=missing.end(); ++i)
291 cerr<<"Please install them and try again.\n";
301 cout<<packages.size()<<" packages, "<<targets.size()<<" targets\n";
304 for(PackageMap::iterator i=packages.begin(); i!=packages.end(); ++i)
306 cout<<' '<<i->second->get_name();
307 if(i->second->get_buildable())
310 unsigned ood_count=0;
311 for(TargetMap::iterator j=targets.begin(); j!=targets.end(); ++j)
312 if(j->second->get_package()==i->second)
315 if(j->second->get_rebuild())
320 cout<<" ("<<count<<" targets";
322 cout<<", "<<ood_count<<" out-of-date";
340 for(PackageMap::iterator i=packages.begin(); i!=packages.end(); ++i)
342 for(TargetMap::iterator i=targets.begin(); i!=targets.end(); ++i)
347 void Builder::usage(const char *reason, const char *argv0, bool brief)
353 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] [--conf-only] [--full-paths] [--max-depth NUM] [<target> ...]";
357 "Usage: "<<argv0<<" [options] [<target> ...]\n"
360 " -a, --analyze MODE Perform analysis. MODE can be deps, alldeps or rebuild.\n"
361 " -b, --build Perform build even if doing analysis.\n"
362 " -c, --clean Clean buildable targets.\n"
363 " -f, --file FILE Read info from FILE instead of Build.\n"
364 " -h, --help Print this message.\n"
365 " -j, --jobs NUM Run NUM commands at once, whenever possible.\n"
366 " -n, --dry-run Don't actually do anything, only show what would be done.\n"
367 " -v, --verbose Print more information about what's going on.\n"
368 " -A, --conf-all Apply configuration to all packages.\n"
369 " -B, --build-all Build all targets unconditionally.\n"
370 " -C, --chdir DIR Change to DIR before doing anything else.\n"
371 " -W, --what-if FILE Pretend that FILE has changed.\n"
372 " --chrome Use extra chrome to print status.\n"
373 " --conf-only Stop after configuring packages.\n"
374 " --full-paths Output full paths in analysis.\n"
375 " --max-depth NUM Maximum depth to show in analysis.\n";
380 Loads the given build file.
382 @param fn Path to the file
384 @return 0 on success, -1 if the file could not be opened
386 int Builder::load_build_file(const Path::Path &fn)
388 ifstream in(fn.str().c_str());
392 Parser::Parser parser(in, fn.str());
393 Loader loader(*this, fn.subpath(0, fn.size()-1));
400 Creates targets for all packages and prepares them for building.
402 @return 0 if everything went ok, -1 if something bad happened and a build
403 shouldn't be attempted
405 int Builder::create_targets()
407 Target *world=new VirtualTarget(*this, "world");
410 Target *def_tgt=new VirtualTarget(*this, "default");
412 world->add_depend(def_tgt);
414 Target *install=new VirtualTarget(*this, "install");
416 world->add_depend(install);
418 for(PackageMap::iterator i=packages.begin(); i!=packages.end(); ++i)
422 if(!i->second->get_buildable())
425 Path::Path inst_base;
426 if(i->second->get_config().is_option("prefix"))
427 inst_base=i->second->get_config().get_option("prefix").value;
429 const ComponentList &components=i->second->get_components();
430 for(ComponentList::const_iterator j=components.begin(); j!=components.end(); ++j)
432 // Collect all files belonging to the component
434 const PathList &sources=j->get_sources();
435 for(PathList::const_iterator k=sources.begin(); k!=sources.end(); ++k)
439 if(S_ISDIR(st.st_mode))
441 list<string> sfiles=list_files(*k);
442 for(list<string>::iterator l=sfiles.begin(); l!=sfiles.end(); ++l)
443 files.push_back(*k / *l);
449 bool build_exe=j->get_type()!=Component::HEADERS;
451 list<ObjectFile *> objs;
452 for(PathList::iterator k=files.begin(); k!=files.end(); ++k)
454 string basename=(*k)[-1];
455 string ext=Path::splitext(basename).ext;
456 if((ext==".cpp" || ext==".c") && build_exe)
458 SourceFile *src=new SourceFile(*this, &*j, k->str());
462 ObjectFile *obj=new ObjectFile(*this, *j, *src);
468 Target *hdr=get_target(k->str());
471 hdr=new Header(*this, &*j, k->str());
475 // Install headers if requested
476 if(!j->get_install_headers().empty())
478 Path::Path inst_path=inst_base/"include"/j->get_install_headers()/basename;
479 Install *inst=new Install(*this, *i->second, *hdr, inst_path.str());
481 install->add_depend(inst);
489 StaticLibrary *slib=0;
490 if(j->get_type()==Component::LIBRARY)
492 exe=new SharedLibrary(*this, *j, objs);
493 slib=new StaticLibrary(*this, *j, objs);
497 exe=new Executable(*this, *j, objs);
500 if(i->second==default_pkg)
502 def_tgt->add_depend(exe);
503 if(slib) def_tgt->add_depend(slib);
507 world->add_depend(exe);
508 if(slib) world->add_depend(slib);
514 if(j->get_type()==Component::PROGRAM)
516 else if(j->get_type()==Component::LIBRARY)
518 if(!inst_dir.empty())
520 Install *inst=new Install(*this, *i->second, *exe, (inst_base/inst_dir/Path::basename(exe->get_name())).str());
522 install->add_depend(inst);
526 inst=new Install(*this, *i->second, *slib, (inst_base/inst_dir/Path::basename(slib->get_name())).str());
528 install->add_depend(inst);
535 if(i->second->get_install_flags()&(Package::LIB|Package::INCLUDE))
537 PkgConfig *pc=new PkgConfig(*this, *i->second);
539 Install *inst=new Install(*this, *i->second, *pc, (inst_base/"lib"/"pkgconfig"/Path::basename(pc->get_name())).str());
541 install->add_depend(inst);
545 // Find dependencies until no new targets are created
546 while(!new_tgts.empty())
548 Target *tgt=new_tgts.front();
549 new_tgts.erase(new_tgts.begin());
551 if(!tgt->get_depends_ready())
552 new_tgts.push_back(tgt);
556 for(StringList::iterator i=what_if.begin(); i!=what_if.end(); ++i)
558 Target *tgt=get_target((cwd/ *i).str());
561 cerr<<"Unknown what-if target "<<*i<<'\n';
567 // Make the cmdline target depend on all targets mentioned on the command line
568 Target *cmdline=new VirtualTarget(*this, "cmdline");
570 world->add_depend(cmdline);
571 for(list<string>::iterator i=cmdline_targets.begin(); i!=cmdline_targets.end(); ++i)
573 Target *tgt=get_target(*i);
575 tgt=get_target((cwd/ *i).str());
578 cerr<<"I don't know anything about "<<*i<<'\n';
581 cmdline->add_depend(tgt);
590 Check if a header exists, either as a target or a file. Either an existing
591 target or a new SystemHeader target will be returned.
593 Target *Builder::get_header(const Msp::Path::Path &fn)
595 Target *tgt=get_target(fn.str());
600 add_target(tgt=new SystemHeader(*this, fn.str()));
606 Target *Builder::get_library(const string &lib, const Path::Path &path, unsigned mode)
611 full=(path/("lib"+lib+".a")).str();
612 Target *tgt=get_target(full);
613 // Targets can only be associated with buildable packages (or no package at all)
614 if(tgt && (tgt->get_package() || mode==2)) return tgt;
618 full=(path/("lib"+lib+".so")).str();
619 Target *tgt=get_target(full);
623 if(Path::exists(full))
625 Target *tgt=new SystemLibrary(*this, full);
634 Adds a target to both the target map and the new target queue.
636 void Builder::add_target(Target *t)
638 targets.insert(TargetMap::value_type(t->get_name(), t));
639 new_tgts.push_back(t);
643 Updates a hash with a string. This is used from get_header and get_library.
645 void Builder::update_hash(string &hash, const string &value)
647 for(unsigned i=0; i<value.size(); ++i)
648 hash[i%hash.size()]^=value[i];
652 This function supervises the build process, starting new actions when slots
657 Target *cmdline=get_target("cmdline");
659 unsigned total=cmdline->count_rebuild();
662 cout<<"Already up to date\n";
665 cout<<"Will build "<<total<<" target(s)\n";
667 vector<Action *> actions;
670 cout<<"0 targets built\n";
678 if(actions.size()<jobs && !fail)
680 Target *tgt=cmdline->get_buildable_target();
683 Action *action=tgt->build();
685 actions.push_back(action);
687 else if(actions.empty())
691 Time::sleep(10*Time::msec);
693 for(unsigned i=0; i<actions.size();)
695 int status=actions[i]->check();
701 cout<<"\e["<<actions.size()+1<<'A';
702 cout<<count<<" targets built\n";
706 if(i<actions.size()-1)
707 cout<<"\e["<<actions.size()-i-1<<"B";
711 actions.erase(actions.begin()+i);
714 if(actions.empty() && fail)
726 Prints out information about the default package.
728 void Builder::package_help()
730 const Config &config=default_pkg->get_config();
731 const Config::OptionMap &options=config.get_options();
733 cout<<"Required packages:\n ";
734 const PkgRefList &requires=default_pkg->get_requires();
735 for(PkgRefList::const_iterator i=requires.begin(); i!=requires.end(); ++i)
737 if(i!=requires.begin())
742 cout<<"Package configuration:\n";
743 for(Config::OptionMap::const_iterator i=options.begin(); i!=options.end(); ++i)
745 const Config::Option &opt=i->second;
746 cout<<" "<<opt.name<<": "<<opt.descr<<" ("<<opt.value<<") ["<<opt.defv<<"]\n";
750 Application::RegApp<Builder> Builder::reg;
752 Builder::Loader::Loader(Builder &b, const Path::Path &s):
756 add("package", &Loader::package);
759 void Builder::Loader::package(const string &n)
761 Package *pkg=new Package(bld, n, src);
763 bld.packages.insert(PackageMap::value_type(n, pkg));
764 bld.new_pkgs.push_back(pkg);