Add comments

[builder.git] / source / component.h

diff --git a/source/component.h b/source/component.h
index af2fc2fae380a3accd0294c25239b268c6c67c1c..663132ad3f7ede8c6fc994f6112c77c83c531ee9 100644 (file)
--- a/source/component.h
+++ b/source/component.h
@@ -6,12 +6,20 @@
 #include <msp/path/path.h>
 #include "buildinfo.h"
 #include "misc.h"
+#include "packageref.h"
 
 class Package;
 
+/**
+Components specify things to be built.  Each component may build one binary (it
+may also build none), as well as install a bunch of headers.  Components inherit
+dependencies and build info from the package they belong to, and may also add
+their own.
+*/
 class Component
 {
 public:
+       /// Loads a Component from file.  Used from Package::Loader.
        class Loader: public Msp::Parser::Loader
        {
        public:
@@ -21,6 +29,8 @@ public:
                Component &comp;
 
                void source(const std::string &);
+               void require(const std::string &);
+               void build_info();
        };
        
        enum Type
@@ -39,6 +49,7 @@ public:
        const BuildInfo   &get_build_info() const      { return build_info; }
        bool              get_install() const          { return install; }
        const std::string &get_install_headers() const { return install_headers; }
+       void              resolve_refs();
        void              create_build_info();
 protected:
        Package     &pkg;
@@ -48,6 +59,7 @@ protected:
        bool        install;
        std::string install_headers;
        BuildInfo   build_info;
+       PkgRefList  requires;
 };
 typedef std::list<Component> ComponentList;