]> git.tdb.fi Git - builder.git/blobdiff - source/builder.cpp
Support building modular programs
[builder.git] / source / builder.cpp
index 274b153e70c566a2fa2dff2147918cc2d2474a37..f23e85af8c06d17c1056734a0bb2ce3995d82425 100644 (file)
@@ -1,12 +1,11 @@
 #include <fstream>
 #include <iostream>
 #include <msp/progress.h>
-#include <msp/strconv.h>
-#include <msp/strutils.h>
 #include <msp/core/error.h>
 #include <msp/getopt++/getopt++.h>
 #include <msp/parser/parser.h>
 #include <msp/path/utils.h>
+#include <msp/strings/utils.h>
 #include <msp/time/units.h>
 #include <msp/time/utils.h>
 #include "action.h"
@@ -18,6 +17,9 @@
 #include "misc.h"
 #include "objectfile.h"
 #include "package.h"
+#include "pkgconfig.h"
+#include "sharedlibrary.h"
+#include "staticlibrary.h"
 #include "systemlibrary.h"
 #include "virtualtarget.h"
 
@@ -25,83 +27,79 @@ using namespace std;
 using namespace Msp;
 
 Builder::Builder(int argc, char **argv):
+       analyzer(0),
+       do_build(false),
        verbose(1),
-       cwd(Path::getcwd()),
+       chrome(false),
        build_file("Build"),
-       do_build(true),
-       analyzer(0),
-       jobs(1),
-       chrome(false)
+       jobs(1)
 {
+       string   analyze_mode;
+       string   work_dir;
+       bool     full_paths=false;
+       unsigned max_depth=5;
+       
        GetOpt getopt;
-       getopt.add_option(GetOpt::Option('v', "verbose", GetOpt::NONE));
-       getopt.add_option(GetOpt::Option('a', "analyze", GetOpt::REQUIRED));
-       getopt.add_option(GetOpt::Option('b', "build", GetOpt::NONE));
-       getopt.add_option(GetOpt::Option("max-depth", GetOpt::REQUIRED));
-       getopt.add_option(GetOpt::Option('n', "dry-run", GetOpt::NONE));
-       getopt.add_option(GetOpt::Option('W', "what-if", GetOpt::REQUIRED));
-       getopt.add_option(GetOpt::Option('B', "build-all", GetOpt::NONE));
-       getopt.add_option(GetOpt::Option('C', "chdir", GetOpt::REQUIRED));
-       getopt.add_option(GetOpt::Option('j', "jobs", GetOpt::REQUIRED, "1"));
-       getopt.add_option(GetOpt::Option('h', "help", GetOpt::NONE));
-       getopt.add_option(GetOpt::Option('c', "clean", GetOpt::NONE));
-       getopt.add_option(GetOpt::Option('f', "file", GetOpt::REQUIRED, "Build"));
-       getopt.add_option(GetOpt::Option("chrome", GetOpt::NONE));
-       getopt.add_option(GetOpt::Option("full-paths", GetOpt::NONE));
-       getopt.add_option(GetOpt::Option('A', "conf-all", GetOpt::NONE));
-       int index=getopt(argc, argv);
-
-       verbose+=getopt['v'].count();
-
-       if(getopt['a'])
+       getopt.add_option('a', "analyze",    analyze_mode, GetOpt::REQUIRED_ARG);
+       getopt.add_option('b', "build",      do_build,     GetOpt::NO_ARG);
+//     getopt.add_option('c', "clean",      clean,        GetOpt::NO_ARG);
+       getopt.add_option('f', "file",       build_file,   GetOpt::REQUIRED_ARG);
+       getopt.add_option('h', "help",       help,         GetOpt::NO_ARG);
+       getopt.add_option('j', "jobs",       jobs,         GetOpt::REQUIRED_ARG);
+       getopt.add_option('n', "dry-run",    dry_run,      GetOpt::NO_ARG);
+       getopt.add_option('v', "verbose",    verbose,      GetOpt::NO_ARG);
+       getopt.add_option('A', "conf-all",   conf_all,     GetOpt::NO_ARG);
+       getopt.add_option('B', "build-all",  build_all,    GetOpt::NO_ARG);
+       getopt.add_option('C', "chdir",      work_dir,     GetOpt::REQUIRED_ARG);
+       getopt.add_option('W', "what-if",    what_if,      GetOpt::REQUIRED_ARG);
+       getopt.add_option(     "chrome",     chrome,       GetOpt::NO_ARG);
+       getopt.add_option(     "conf-only",  conf_only,    GetOpt::NO_ARG);
+       getopt.add_option(     "full-paths", full_paths,   GetOpt::NO_ARG);
+       getopt.add_option(     "max-depth",  max_depth,    GetOpt::REQUIRED_ARG);
+       getopt(argc, argv);
+
+       if(!analyze_mode.empty())
        {
                analyzer=new Analyzer(*this);
 
-               string mode=getopt['a'].arg();
-               if(mode=="deps")
+               if(analyze_mode=="deps")
                        analyzer->set_mode(Analyzer::DEPS);
-               else if(mode=="alldeps")
+               else if(analyze_mode=="alldeps")
                        analyzer->set_mode(Analyzer::ALLDEPS);
-               else if(mode=="rebuild")
+               else if(analyze_mode=="rebuild")
                        analyzer->set_mode(Analyzer::REBUILD);
-               else if(mode=="rdeps")
+               else if(analyze_mode=="rdeps")
                        analyzer->set_mode(Analyzer::RDEPS);
                else
-                       throw UsageError("Invalid analysis mode");
-
-               if(getopt["max-depth"])
-                       analyzer->set_max_depth(strtol(getopt["max-depth"].arg()));
-               analyzer->set_full_paths(getopt["full-paths"]);
+                       throw UsageError("Invalid analyze mode");
 
-               if(!getopt['b'])
-                       do_build=false;
+               analyzer->set_max_depth(max_depth);
+               analyzer->set_full_paths(full_paths);
        }
+       else
+               do_build=true;
 
-       dry_run=getopt['n'];
-       jobs=max(strtol(getopt['j'].arg()), 1L);
-       chrome=getopt["chrome"];
-       conf_all=getopt['A'];
-       build_file=getopt['f'].arg();
-       build_all=getopt['B'];
-
-       if(getopt['C'])
-               chdir(getopt['C'].arg().c_str());
-
-       for(int i=index; i<argc; ++i)
+       const list<string> &args=getopt.get_args();
+       for(list<string>::const_iterator i=args.begin(); i!=args.end(); ++i)
        {
-               string v(argv[i]);
-               unsigned equal=v.find('=');
+               unsigned equal=i->find('=');
                if(equal!=string::npos)
-                       cmdline_options.insert(RawOptionMap::value_type(v.substr(0, equal), v.substr(equal+1)));
+                       cmdline_options.insert(RawOptionMap::value_type(i->substr(0, equal), i->substr(equal+1)));
                else
-                       cmdline_targets.push_back(argv[i]);
+                       cmdline_targets.push_back(*i);
        }
 
        if(cmdline_targets.empty())
                cmdline_targets.push_back("default");
 
-       if(getopt['W'])
-               what_if.push_back(getopt['W'].arg());
+       if(!work_dir.empty())
+               chdir(work_dir.c_str());
+
+       cwd=Path::getcwd();
+
+       archs.insert(StringMap::value_type("native", ""));
+       archs.insert(StringMap::value_type("arm", "arm-linux-gnu-"));
+       archs.insert(StringMap::value_type("win32", "i586-mingw32msvc-"));
 }
 
 /**
@@ -167,7 +165,9 @@ Target *Builder::get_target(const string &n)
 
 /**
 Tries to locate a header included from a given location and with a given include
-path.  Considers known targets as well as existing files.
+path.  Considers known targets as well as existing files.  If a matching target
+is not found but a file exists, a new SystemHeader target will be created and
+returned.
 */
 Target *Builder::get_header(const string &include, const string &from, const list<string> &path)
 {
@@ -183,46 +183,70 @@ Target *Builder::get_header(const string &include, const string &from, const lis
 
        string fn=include.substr(1);
        Target *tgt=0;
-       if(include[0]=='"' && (tgt=check_header(Path::Path(from)/fn)))
-               return tgt;
-       if((tgt=check_header(Path::Path("/usr/include")/fn)))
-               return tgt;
+       if(include[0]=='"' && (tgt=get_header(Path::Path(from)/fn)))
+               ;
+       else if((tgt=get_header(Path::Path("/usr/include")/fn)))
+               ;
        //XXX Determine the C++ header location dynamically
-       if((tgt=check_header(Path::Path("/usr/include/c++/4.1.2")/fn)))
-               return tgt;
-       for(list<string>::const_iterator j=path.begin(); j!=path.end(); ++j)
-               if((tgt=check_header(Path::getcwd()/ *j/fn)))
-                       return tgt;
+       else if((tgt=get_header(Path::Path("/usr/include/c++/4.1.2")/fn)))
+               ;
+       else
+       {
+               for(list<string>::const_iterator j=path.begin(); (j!=path.end() && !tgt); ++j)
+                       tgt=get_header(cwd/ *j/fn);
+       }
+
+       includes.insert(TargetMap::value_type(id, tgt));
        
-       return 0;
+       return tgt;
 }
 
-Target *Builder::get_library(const string &lib, const list<string> &path)
+/**
+Tries to locate a library with the given library path.  Considers known targets
+as well as existing files.  If a matching target is not found but a file exists,
+a new SystemLibrary target will be created and returned.
+
+@param   lib   Name of the library to get (without "lib" prefix or extension)
+@param   path  List of paths to search for the library
+@param   mode  Shared / static mode
+
+@return  Some kind of library target, if a match was found
+*/
+Target *Builder::get_library(const string &lib, const list<string> &path, LibMode mode)
 {
        string hash(8, 0);
        for(list<string>::const_iterator i=path.begin(); i!=path.end(); ++i)
                update_hash(hash, *i);
 
+       //XXX Incorporate mode into id
        string id=hash+lib;
        TargetMap::iterator i=libraries.find(id);
        if(i!=libraries.end())
                return i->second;
 
-       string basename="lib"+lib+".so";
-       for(list<string>::const_iterator j=path.begin(); j!=path.end(); ++j)
+       Target *tgt=0;
+       if((tgt=get_library(lib, "/lib", mode)))
+               ;
+       else if((tgt=get_library(lib, "/usr/lib", mode)))
+               ;
+       else
        {
-               string full=(Path::getcwd()/ *j/basename).str();
-               Target *tgt=get_target(full);
-               if(tgt) return tgt;
-               
-               if(Path::exists(full))
-               {
-                       add_target(tgt=new SystemLibrary(*this, full));
-                       return tgt;
-               }
+               for(list<string>::const_iterator j=path.begin(); (j!=path.end() && !tgt); ++j)
+                       tgt=get_library(lib, cwd/ *j, mode);
        }
 
-       return 0;
+       libraries.insert(TargetMap::value_type(id, tgt));
+
+       return tgt;
+}
+
+const string &Builder::get_arch_prefix(const string &arch) const
+{
+       StringMap::const_iterator i=archs.find(arch);
+       if(i==archs.end())
+               throw InvalidParameterValue("Unknown architecture");
+
+       return i->second;
 }
 
 int Builder::main()
@@ -238,28 +262,43 @@ int Builder::main()
        while(!new_pkgs.empty())
        {
                Package *pkg=new_pkgs.front();
-               if(pkg==default_pkg || conf_all)
-                       pkg->process_options(cmdline_options);
                new_pkgs.erase(new_pkgs.begin());
                pkg->resolve_refs();
        }
 
-       std::list<std::string> missing;
+       default_pkg->configure(cmdline_options, conf_all?2:1);
+
+       if(help)
+       {
+               usage(0, "builder", false);
+               cout<<'\n';
+               package_help();
+               return 0;
+       }
+
+       StringMap problems;
        for(PackageMap::iterator i=packages.begin(); i!=packages.end(); ++i)
+       {
+               string prob;
                if(!i->second)
-                       missing.push_back(i->first);
+                       prob="missing";
+               else if(i->second->get_buildable() && i->second->get_arch()!=default_pkg->get_arch())
+                       prob="wrong architecture ("+i->second->get_arch()+")";
+               if(!prob.empty())
+                       problems.insert(StringMap::value_type(i->first, prob));
+       }
 
-       if(!missing.empty())
+       if(!problems.empty())
        {
-               missing.sort();
-               cerr<<"The following packages were not found on the system:\n";
-               for(list<string>::iterator i=missing.begin(); i!=missing.end(); ++i)
-                       cerr<<"  "<<*i<<'\n';
-               cerr<<"Please install them and try again.\n";
+               cerr<<"The following problems were detected:\n";
+               for(StringMap::iterator i=problems.begin(); i!=problems.end(); ++i)
+                       cerr<<"  "<<i->first<<": "<<i->second<<'\n';
+               cerr<<"Please fix them and try again.\n";
                return 1;
        }
 
-       default_pkg->create_build_info();
+       if(conf_only)
+               return 0;
 
        if(create_targets())
                return 1;
@@ -286,8 +325,9 @@ int Builder::main()
                                cout<<" ("<<count<<" targets";
                                if(ood_count)
                                        cout<<", "<<ood_count<<" out-of-date";
-                               cout<<")\n";
+                               cout<<')';
                        }
+                       cout<<'\n';
                }
        }
 
@@ -309,6 +349,45 @@ Builder::~Builder()
        delete analyzer;
 }
 
+void Builder::usage(const char *reason, const char *argv0, bool brief)
+{
+       if(reason)
+               cerr<<reason<<'\n';
+       
+       if(brief)
+               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> ...]";
+       else
+       {
+               cerr<<
+                       "Usage: "<<argv0<<" [options] [<target> ...]\n"
+                       "\n"
+                       "Options:\n"
+                       "  -a, --analyze MODE  Perform analysis.  MODE can be deps, alldeps or rebuild.\n"
+                       "  -b, --build         Perform build even if doing analysis.\n"
+                       "  -c, --clean         Clean buildable targets.\n"
+                       "  -f, --file FILE     Read info from FILE instead of Build.\n"
+                       "  -h, --help          Print this message.\n"
+                       "  -j, --jobs NUM      Run NUM commands at once, whenever possible.\n"
+                       "  -n, --dry-run       Don't actually do anything, only show what would be done.\n"
+                       "  -v, --verbose       Print more information about what's going on.\n"
+                       "  -A, --conf-all      Apply configuration to all packages.\n"
+                       "  -B, --build-all     Build all targets unconditionally.\n"
+                       "  -C, --chdir DIR     Change to DIR before doing anything else.\n"
+                       "  -W, --what-if FILE  Pretend that FILE has changed.\n"
+                       "  --chrome            Use extra chrome to print status.\n"
+                       "  --conf-only         Stop after configuring packages.\n"
+                       "  --full-paths        Output full paths in analysis.\n"
+                       "  --max-depth NUM     Maximum depth to show in analysis.\n";
+       }
+}
+
+/**
+Loads the given build file.
+
+@param   fn  Path to the file
+
+@return  0 on success, -1 if the file could not be opened
+*/
 int Builder::load_build_file(const Path::Path &fn)
 {
        ifstream in(fn.str().c_str());
@@ -322,6 +401,12 @@ int Builder::load_build_file(const Path::Path &fn)
        return 0;
 }
 
+/**
+Creates targets for all packages and prepares them for building.
+
+@return  0 if everything went ok, -1 if something bad happened and a build
+         shouldn't be attempted
+*/
 int Builder::create_targets()
 {
        Target *world=new VirtualTarget(*this, "world");
@@ -343,12 +428,13 @@ int Builder::create_targets()
                        continue;
 
                Path::Path inst_base;
-               if(i->second->get_config().is_option("prefix"))
-                       inst_base=i->second->get_config().get_option("prefix").value;
+               if(i->second->get_buildable() && i->second->get_install_flags())
+                       inst_base=i->second->get_prefix();
 
                const ComponentList &components=i->second->get_components();
                for(ComponentList::const_iterator j=components.begin(); j!=components.end(); ++j)
                {
+                       // Collect all files belonging to the component
                        PathList files;
                        const PathList &sources=j->get_sources();
                        for(PathList::const_iterator k=sources.begin(); k!=sources.end(); ++k)
@@ -372,17 +458,15 @@ int Builder::create_targets()
                        {
                                string basename=(*k)[-1];
                                string ext=Path::splitext(basename).ext;
-                               if(ext==".cpp" || ext==".c")
+                               if((ext==".cpp" || ext==".c") && build_exe)
                                {
-                                       if(build_exe)
-                                       {
-                                               SourceFile *src=new SourceFile(*this, &*j, k->str());
-                                               add_target(src);
-                                               
-                                               ObjectFile *obj=new ObjectFile(*this, *j, *src);
-                                               add_target(obj);
-                                               objs.push_back(obj);
-                                       }
+                                       SourceFile *src=new SourceFile(*this, &*j, k->str());
+                                       add_target(src);
+
+                                       // Compile sources
+                                       ObjectFile *obj=new ObjectFile(*this, *j, *src);
+                                       add_target(obj);
+                                       objs.push_back(obj);
                                }
                                else if(ext==".h")
                                {
@@ -392,6 +476,8 @@ int Builder::create_targets()
                                                hdr=new Header(*this, &*j, k->str());
                                                add_target(hdr);
                                        }
+
+                                       // Install headers if requested
                                        if(!j->get_install_headers().empty())
                                        {
                                                Path::Path inst_path=inst_base/"include"/j->get_install_headers()/basename;
@@ -404,12 +490,28 @@ int Builder::create_targets()
 
                        if(build_exe)
                        {
-                               Executable *exe=new Executable(*this, *j, objs);
+                               Executable    *exe=0;
+                               StaticLibrary *slib=0;
+                               if(j->get_type()==Component::LIBRARY)
+                               {
+                                       exe=new SharedLibrary(*this, *j, objs);
+                                       slib=new StaticLibrary(*this, *j, objs);
+                                       add_target(slib);
+                               }
+                               else
+                                       exe=new Executable(*this, *j, objs);
+                               
                                add_target(exe);
                                if(i->second==default_pkg)
+                               {
                                        def_tgt->add_depend(exe);
+                                       if(slib) def_tgt->add_depend(slib);
+                               }
                                else
+                               {
                                        world->add_depend(exe);
+                                       if(slib) world->add_depend(slib);
+                               }
 
                                if(j->get_install())
                                {
@@ -423,12 +525,29 @@ int Builder::create_targets()
                                                Install *inst=new Install(*this, *i->second, *exe, (inst_base/inst_dir/Path::basename(exe->get_name())).str());
                                                add_target(inst);
                                                install->add_depend(inst);
+
+                                               if(slib)
+                                               {
+                                                       inst=new Install(*this, *i->second, *slib, (inst_base/inst_dir/Path::basename(slib->get_name())).str());
+                                                       add_target(inst);
+                                                       install->add_depend(inst);
+                                               }
                                        }
                                }
                        }
                }
+
+               if(i->second->get_install_flags()&(Package::LIB|Package::INCLUDE))
+               {
+                       PkgConfig *pc=new PkgConfig(*this, *i->second);
+                       add_target(pc);
+                       Install *inst=new Install(*this, *i->second, *pc, (inst_base/"lib"/"pkgconfig"/Path::basename(pc->get_name())).str());
+                       add_target(inst);
+                       install->add_depend(inst);
+               }
        }
 
+       // Find dependencies until no new targets are created
        while(!new_tgts.empty())
        {
                Target *tgt=new_tgts.front();
@@ -438,7 +557,8 @@ int Builder::create_targets()
                        new_tgts.push_back(tgt);
        }
 
-       for(list<string>::iterator i=what_if.begin(); i!=what_if.end(); ++i)
+       // Apply what-ifs
+       for(StringList::iterator i=what_if.begin(); i!=what_if.end(); ++i)
        {
                Target *tgt=get_target((cwd/ *i).str());
                if(!tgt)
@@ -449,6 +569,7 @@ int Builder::create_targets()
                tgt->touch();
        }
 
+       // Make the cmdline target depend on all targets mentioned on the command line
        Target *cmdline=new VirtualTarget(*this, "cmdline");
        add_target(cmdline);
        world->add_depend(cmdline);
@@ -470,7 +591,11 @@ int Builder::create_targets()
        return 0;
 }
 
-Target *Builder::check_header(const Msp::Path::Path &fn)
+/**
+Check if a header exists, either as a target or a file.  Either an existing
+target or a new SystemHeader target will be returned.
+*/
+Target *Builder::get_header(const Msp::Path::Path &fn)
 {
        Target *tgt=get_target(fn.str());
        if(tgt) return tgt;
@@ -483,12 +608,45 @@ Target *Builder::check_header(const Msp::Path::Path &fn)
        return 0;
 }
 
+Target *Builder::get_library(const string &lib, const Path::Path &path, LibMode mode)
+{
+       string full;
+       if(mode!=DYNAMIC)
+       {
+               full=(path/("lib"+lib+".a")).str();
+               Target *tgt=get_target(full);
+               // Targets can only be associated with buildable packages (or no package at all)
+               if(tgt && (tgt->get_package() || mode==ALL_STATIC)) return tgt;
+       }
+       if(mode!=ALL_STATIC)
+       {
+               full=(path/("lib"+lib+".so")).str();
+               Target *tgt=get_target(full);
+               if(tgt) return tgt;
+       }
+
+       if(Path::exists(full))
+       {
+               Target *tgt=new SystemLibrary(*this, full);
+               add_target(tgt);
+               return tgt;
+       }
+
+       return 0;
+}
+
+/**
+Adds a target to both the target map and the new target queue.
+*/
 void Builder::add_target(Target *t)
 {
        targets.insert(TargetMap::value_type(t->get_name(), t));
        new_tgts.push_back(t);
 }
 
+/**
+Updates a hash with a string.  This is used from get_header and get_library.
+*/
 void Builder::update_hash(string &hash, const string &value)
 {
        for(unsigned i=0; i<value.size(); ++i)
@@ -566,9 +724,37 @@ int Builder::build()
                }
        }
 
+       if(fail)
+               cout<<"Build failed\n";
+
        return fail?-1:0;
 }
 
+/**
+Prints out information about the default package.
+*/
+void Builder::package_help()
+{
+       const Config &config=default_pkg->get_config();
+       const Config::OptionMap &options=config.get_options();
+
+       cout<<"Required packages:\n  ";
+       const PkgRefList &requires=default_pkg->get_requires();
+       for(PkgRefList::const_iterator i=requires.begin(); i!=requires.end(); ++i)
+       {
+               if(i!=requires.begin())
+                       cout<<", ";
+               cout<<i->get_name();
+       }
+       cout<<"\n\n";
+       cout<<"Package configuration:\n";
+       for(Config::OptionMap::const_iterator i=options.begin(); i!=options.end(); ++i)
+       {
+               const Config::Option &opt=i->second;
+               cout<<"  "<<opt.name<<": "<<opt.descr<<" ("<<opt.value<<") ["<<opt.defv<<"]\n";
+       }
+}
+
 Application::RegApp<Builder> Builder::reg;
 
 Builder::Loader::Loader(Builder &b, const Path::Path &s):