source/component.h

   1 #ifndef COMPONENT_H_
   2 #define COMPONENT_H_
   3
   4 #include <string>
   5 #include <msp/datafile/objectloader.h>
   6 #include <msp/fs/path.h>
   7 #include "buildinfo.h"
   8 #include "conditionalloader.h"
   9 #include "installmap.h"
  10 #include "package.h"
  11
  12 class SourcePackage;
  13
  14 /**
  15 Components specify things to be built.  Each component may build one binary (it
  16 may also build none), as well as install a bunch of headers.  Components inherit
  17 dependencies and build info from the package they belong to, and may also add
  18 their own.
  19 */
  20 class Component
  21 {
  22 public:
  23         class Loader: public Msp::DataFile::ObjectLoader<Component>, public ConditionalLoader
  24         {
  25         public:
  26                 Loader(Component &);
  27         private:
  28                 void build_info();
  29                 void install_map();
  30                 void overlay(const std::string &);
  31                 void require(const std::string &);
  32                 void source(const std::string &);
  33         };
  34
  35         typedef std::list<Msp::FS::Path> SourceList;
  36         typedef std::list<std::string> OverlayList;
  37
  38 protected:
  39         SourcePackage &package;
  40         std::string name;
  41         SourceList sources;
  42         OverlayList overlays;
  43         bool install;
  44         BuildInfo build_info;
  45         Package::Requirements requires;
  46         bool deflt;
  47         InstallMap install_map;
  48         std::list<std::string> problems;
  49
  50         Component(SourcePackage &, const std::string &);
  51 public:
  52         virtual ~Component() { }
  53
  54         const SourcePackage &get_package() const { return package; }
  55         const std::string &get_name() const { return name; }
  56
  57         /** Returns a list of sources for the component.  They may refer to
  58         directories or individual files. */
  59         const SourceList &get_sources() const { return sources; }
  60
  61         const OverlayList &get_overlays() const { return overlays; }
  62
  63 protected:
  64         /** Returns a list of all source files for the component. */
  65         SourceList collect_source_files() const;
  66
  67 public:
  68         bool get_install() const { return install; }
  69         const InstallMap &get_install_map() const { return install_map; }
  70         const Package::Requirements &get_required_packages() const { return requires; }
  71         bool is_default() const { return deflt; }
  72         const std::list<std::string> &get_problems() const { return problems; }
  73
  74         /** Prepares any required packages. */
  75         void prepare();
  76
  77         /** Prepares the build information for building.  Pulls build info from the
  78         parent and dependency packages, and adds any component-specific flags. */
  79         virtual void create_build_info();
  80
  81         virtual void update_exported_build_info(BuildInfo &) const { }
  82
  83         const BuildInfo &get_build_info() const { return build_info; }
  84
  85         BuildInfo get_build_info_for_path(const Msp::FS::Path &) const;
  86
  87         virtual void create_targets() const = 0;
  88 };
  89
  90 #endif