Add tarball building

[builder.git] / source / target.h

diff --git a/source/target.h b/source/target.h
index ab9134aff85c2b4e34ab4c9eacd719c4e8ccc06d..cf1d18651c9ed5f92c0ac0792b1ae6d75bf153a8 100644 (file)
--- a/source/target.h
+++ b/source/target.h
@@ -1,7 +1,15 @@
+/* $Id$
+
+This file is part of builder
+Copyright © 2006-2007 Mikko Rasa, Mikkosoft Productions
+Distributed under the LGPL
+*/
+
 #ifndef TARGET_H_
 #define TARGET_H_
 
 #include <list>
+#include <map>
 #include <string>
 #include <msp/time/timestamp.h>
 
@@ -9,46 +17,69 @@ class Action;
 class Builder;
 class Package;
 
+class Target;
+typedef std::list<Target *> TargetList;
+
+/**
+Targets make up the build graph.  This class is a base for all target types and
+handles many common tasks.  Most targets are associated with a file.
+*/
 class Target
 {
 public:
-       const std::string &get_name() const            { return name; }
-       Target            *get_buildable_target();
-       bool              get_rebuild() const          { return rebuild; }
-       const std::string &get_rebuild_reason() const  { return rebuild_reason; }
+       const std::string  &get_name() const           { return name; }
+       Target             *get_buildable_target();
+       bool               get_buildable() const       { return buildable; }
+       bool               get_rebuild() const         { return rebuild; }
+       const std::string  &get_rebuild_reason() const { return rebuild_reason; }
        const Msp::Time::TimeStamp &get_mtime() const  { return mtime; }
        virtual const char *get_type() const=0;
-       const std::list<Target *> &get_depends() const { return depends; }
-       const Package     *get_package() const         { return package; }
-       bool              get_depends_ready() const       { return deps_ready; }
-       void              add_depend(Target *);
-       virtual void      find_depends()               { deps_ready=true; }
-       virtual void      prepare();
-       virtual Action    *build()=0;
-       void              reset_count()                { counted=false; }
-       unsigned          count_rebuild();
-       void              touch();
+       const TargetList   &get_depends() const        { return depends; }
+       const Package      *get_package() const        { return package; }
+       bool               get_depends_ready() const   { return deps_ready; }
+       void               add_depend(Target *);
+       virtual void       prepare();
+
+       /**
+       Finds dependencies for the target.  When all dependencies have been found,
+       the function should set deps_ready to true.
+       */
+       virtual void       find_depends()              { deps_ready=true; }
+
+       /**
+       Creates and returns an Action suitable for building this target.
+       */
+       virtual Action     *build()=0;
+
+       void               reset_count()               { counted=false; }
+       virtual unsigned   count_rebuild();
+       void               touch();
        virtual ~Target() { }
 protected:
-       Builder     &builder;
+       Builder       &builder;
        const Package *package;
-       std::string name;
-       bool        building;
-       bool        rebuild;
-       std::string rebuild_reason;
+       std::string   name;
        Msp::Time::TimeStamp mtime;
-       std::list<Target *> depends;
-       std::list<Target *> rdepends;
-       bool        deps_ready;
-       bool        prepared;
-       bool        buildable;
-       bool        counted;
+
+       bool          buildable;
+       bool          building;
+       bool          rebuild;
+       std::string   rebuild_reason;
+
+       TargetList    depends;
+       TargetList    rdepends;
+       bool          deps_ready;
+
+       bool          prepared;
+       bool          counted;
 
        Target(Builder &, const Package *, const std::string &);
-       void mark_rebuild(const std::string &);
+       void         mark_rebuild(const std::string &);
        virtual void check_rebuild();
-       Action *build(Action *);
+       Action       *build(Action *);
        virtual void build_done();
 };
 
+typedef std::map<std::string, Target *> TargetMap;
+
 #endif