source/builder.h

   1 #ifndef BUILDER_H_
   2 #define BUILDER_H_
   3
   4 #include <list>
   5 #include <map>
   6 #include <string>
   7 #include <msp/core/application.h>
   8 #include <msp/datafile/loader.h>
   9 #include <msp/fs/path.h>
  10 #include "architecture.h"
  11 #include "config.h"
  12 #include "misc.h"
  13 #include "problem.h"
  14 #include "target.h"
  15
  16 class Analyzer;
  17 class Config;
  18 class FileTarget;
  19 class Package;
  20 class SourcePackage;
  21 class VirtualTarget;
  22
  23 /**
  24 The main application class.  Controls and owns everything.  Rules the world.
  25 */
  26 class Builder: public Msp::RegisteredApplication<Builder>
  27 {
  28 private:
  29         class Loader: public Msp::DataFile::Loader
  30         {
  31         private:
  32                 Builder &bld;
  33                 Msp::FS::Path src;
  34
  35         public:
  36                 Loader(Builder &, const Msp::FS::Path &);
  37         private:
  38                 void binpkg(const std::string &);
  39                 void cross_prefix(const std::string &, const std::string &);
  40                 void profile(const std::string &);
  41                 void package(const std::string &);
  42         };
  43
  44         class ProfileLoader: public Msp::DataFile::Loader
  45         {
  46         private:
  47                 StringMap &profile;
  48
  49         public:
  50                 ProfileLoader(StringMap &);
  51         private:
  52                 void option(const std::string &, const std::string &);
  53         };
  54
  55 public:
  56         typedef std::map<std::string, Target *> TargetMap;
  57
  58 private:
  59         typedef std::list<Package *> PackageList;
  60         typedef std::map<std::string, Package *> PackageMap;
  61         typedef std::map<std::string, StringMap> ProfileTemplateMap;
  62
  63         StringList cmdline_targets;
  64         StringMap cmdline_options;
  65         Msp::FS::Path cwd;
  66
  67         PackageMap packages;
  68         SourcePackage *main_pkg;
  69         PathList pkg_path;
  70         PathList pkg_dirs;
  71         bool no_externals;
  72
  73         TargetMap targets;
  74         TargetMap targets_by_path;
  75         TargetList new_tgts;
  76         TargetMap includes;
  77         TargetMap libraries;
  78
  79         Architecture native_arch;
  80         Architecture *current_arch;
  81         StringMap cross_prefixes;
  82         ProfileTemplateMap profile_tmpl;
  83
  84         ProblemList problems;
  85         Analyzer *analyzer;
  86         bool build;
  87         unsigned clean;
  88         bool dry_run;
  89         bool help;
  90         unsigned verbose;
  91         bool show_progress;
  92         std::string build_file;
  93         unsigned jobs;
  94         StringList what_if;
  95         bool conf_all;
  96         bool conf_only;
  97         bool build_all;
  98         bool create_makefile;
  99         Msp::FS::Path prefix;
 100         StringList warnings;
 101
 102         static std::string usagemsg;
 103         static std::string helpmsg;
 104
 105 public:
 106         Builder(int, char **);
 107         ~Builder();
 108
 109         int main();
 110         unsigned get_verbose() const { return verbose; }
 111         bool get_dry_run() const { return dry_run; }
 112         bool get_build_all() const { return build_all; }
 113
 114         /** Gets a package by name, possibly creating it.  Returns 0 if the package
 115         could not be located. */
 116         Package *get_package(const std::string &);
 117
 118         SourcePackage *get_main_package() const { return main_pkg; }
 119
 120         std::string run_pkgconfig(const std::string &, const std::string &);
 121
 122         /** Looks up a target by name.  Returns 0 if no such target exists. */
 123         Target *get_target(const std::string &) const;
 124
 125         FileTarget *get_target_by_path(const Msp::FS::Path &) const;
 126
 127         const TargetMap &get_targets() const { return targets; }
 128
 129         /** Tries to locate a header based on location of including file and include
 130         path.  Considers known targets as well as existing files.  If a matching
 131         target is not found but a file exists, a new SystemHeader target will be
 132         created and returned. */
 133         Target *get_header(const std::string &, const Msp::FS::Path &, const StringList &);
 134
 135         /** Tries to locate a library in a library path.  The library name should be
 136         the same as would be given to the linker with -l, i.e. without the "lib"
 137         prefix or extension.  Considers known targets as well as existing files.  If
 138         a matching target is not found but a file exists, a new SystemLibrary target
 139         will be created and returned. */
 140         Target *get_library(const std::string &, const StringList &, LibMode);
 141
 142         const Msp::FS::Path &get_cwd() const { return cwd; }
 143         const Architecture &get_current_arch() const { return *current_arch; }
 144         const Architecture &get_native_arch() const { return native_arch; }
 145         const Msp::FS::Path &get_prefix() const { return prefix; }
 146         const StringList &get_warnings() const { return warnings; }
 147         void apply_profile_template(Config &, const std::string &) const;
 148
 149         /** Adds a target to both the target map and the new target queue.  Called
 150         from Target constructor. */
 151         void add_target(Target *);
 152         void register_path(const Msp::FS::Path &, FileTarget *);
 153
 154         void problem(const std::string &, const std::string &);
 155
 156         static void usage(const char *, const char *, bool);
 157
 158 private:
 159         /** Determines the source directory of a package.  Pkg-config is consulted
 160         first, and if it fails, the package path is searched for matches. */
 161         Msp::FS::Path get_package_location(const std::string &);
 162
 163         /** Loads a build file.  Returns 0 on success or -1 if the file could not be
 164         opened. */
 165         int load_build_file(const Msp::FS::Path &);
 166
 167         /** Creates targets for all packages and prepares them for building.
 168         Returns 0 if everything went ok, -1 if something bad happened and a build
 169         shouldn't be attempted. */
 170         int create_targets();
 171
 172         /**
 173         Check if a header exists, either as a target or a file.  Returns an existing
 174         target of one was found, or a new SystemHeader target if there was no known
 175         target but the file exists.
 176         */
 177         Target *get_header(const Msp::FS::Path &);
 178
 179         Target *get_library(const std::string &, const Msp::FS::Path &, LibMode);
 180
 181         /** Supervises the build process, starting new actions when slots become
 182         available. */
 183         int do_build();
 184
 185         /** Cleans buildable targets.  If clean is 1, cleans only the default
 186         package.  If clean is 2 or greater, cleans all buildable packages.
 187         */
 188         int do_clean();
 189
 190         int do_create_makefile();
 191
 192         /** Prints out information about the default package. */
 193         void package_help();
 194 };
 195
 196 #endif