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