Add comments

[builder.git] / source / package.h

diff --git a/source/package.h b/source/package.h
index aafec0fc54cd2c58d0b63ef2f4758ab647f8ccdf..3d980f26ab19d501adf1486df69a25a6962a8943 100644 (file)
--- a/source/package.h
+++ b/source/package.h
@@ -7,26 +7,20 @@
 #include "buildinfo.h"
 #include "component.h"
 #include "config.h"
+#include "packageref.h"
 
 class Builder;
-class Package;
-
-class PackageRef
-{
-public:
-       PackageRef(Builder &, const std::string &);
-       const std::string &get_name() const { return name; }
-       Package *get_package() const { return package; }
-       Package *resolve();
-private:
-       Builder     &builder;
-       std::string name;
-       Package     *package;
-};
 
+/**
+A package is a distributable piece of software.  They consist of one or more
+Components and may depend on other packages.  Packages also have configuration
+to determine where files are installed and which features to include (features
+NYI).
+*/
 class Package
 {
 public:
+       /// Loads a package from a file.
        class Loader: public Msp::Parser::Loader
        {
        public:
@@ -39,18 +33,22 @@ public:
                void require(const std::string &);
                void program(const std::string &);
                void library(const std::string &);
+               void headers(const std::string &);
+               void build_info();
        };
 
        Package(Builder &, const std::string &, const Msp::Path::Path &);
-       Package(Builder &, const std::string &, const std::vector<std::string> &);
-       const std::string   &get_name() const       { return name; }
-       const Msp::Path::Path &get_source() const   { return source; }
-       const ComponentList &get_components() const { return components; }
-       bool                get_buildable() const   { return buildable; }
-       const Config        &get_config() const     { return config; }
-       const std::list<PackageRef> &get_requires() const { return requires; }
-       const BuildInfo     &get_build_info() const { return build_info; }
+       void                set_path(const Msp::Path::Path &);
+       const std::string   &get_name() const           { return name; }
+       const Msp::Path::Path &get_source() const       { return source; }
+       const ComponentList &get_components() const     { return components; }
+       bool                get_buildable() const       { return buildable; }
+       const Config        &get_config() const         { return config; }
+       const PkgRefList    &get_requires() const       { return requires; }
+       const BuildInfo     &get_build_info() const     { return build_info; }
        const BuildInfo     &get_exported_binfo() const { return export_binfo; }
+       Builder             &get_builder() const        { return builder; }
+       bool                get_need_path() const       { return need_path; }
        void                resolve_refs();
        void                create_build_info();
        void                process_options(const RawOptionMap &);
@@ -66,19 +64,25 @@ private:
        };
        
        Builder       &builder;
+       
        std::string   name;
        std::string   version;
        std::string   description;
-       std::list<PackageRef> requires;
+       
+       bool          buildable;
+       Msp::Path::Path source;
+       PkgRefList    requires;
        BuildInfo     build_info;
        BuildInfo     export_binfo;
-       Msp::Path::Path source;
-       bool          buildable;
        ComponentList components;
        Config        config;
        bool          build_info_ready;
 
-       void init_buildable();
+       bool          need_path;
+       Msp::Path::Path path;
+
+       Package(Builder &, const std::string &, const std::vector<std::string> &);
+       void    init_buildable();
        unsigned get_install_flags();
 };