]> git.tdb.fi Git - builder.git/blobdiff - source/target.h
Make install_location a path
[builder.git] / source / target.h
index 21135b03970aa96a7b0641e096b4cba6b513860a..885ef4b567f00d69d9f04921cd5fca9c46c06568 100644 (file)
 #define TARGET_H_
 
 #include <list>
+#include <map>
+#include <set>
 #include <string>
+#include <sigc++/signal.h>
 #include <msp/time/timestamp.h>
 
 class Builder;
-class Package;
-class Target;
+class Component;
+class SourcePackage;
+class Task;
+class Tool;
 
-class TargetRef
+/**
+Targets make up the build graph.  This class is a base for all target types and
+handles many common tasks.  See also FileTarget and VirtualTarget.
+*/
+class Target
 {
 public:
-       TargetRef(Builder &b, const std::string &n): builder(b), name(n) { }
-       Target *get_target();
-private:
+       typedef std::list<Target *> Dependencies;
+
+protected:
+       enum State
+       {
+               INIT,
+               PREPARING,
+               REBUILD,
+               BUILDING,
+               UPTODATE
+       };
+
+public:
+       sigc::signal<void> signal_bubble_rebuild;
+
+protected:
        Builder &builder;
+       const SourcePackage *package;
+       const Component *component;
        std::string name;
-       Target *target;
-};
 
-class Target
-{
+       const Tool *tool;
+       State state;
+       std::string rebuild_reason;
+       Msp::FS::Path install_location;
+
+       Dependencies depends;
+
+       Target(Builder &, const std::string &);
 public:
+       virtual ~Target() { }
+
+       virtual const char *get_type() const = 0;
        const std::string &get_name() const { return name; }
-       Target *get_buildable_target();
-       bool   get_rebuild() const { return rebuild; }
+       const SourcePackage *get_package() const { return package; }
+       const Component *get_component() const { return component; }
+
+       /** Tries to locate a target that will help getting this target built.  If
+       all dependencies are up-to-date, returns this target.  If there are no
+       targets ready to be built (maybe because they are being built right now),
+       returns 0. */
+       virtual Target *get_buildable_target();
+
+       /** If this target is a proxy for another (such as Install), return that
+       target.  Otherwise, return the target itself.
+
+       Implementors should call the function recursively to find the final target. */
+       virtual Target *get_real_target() { return this; }
+
+       void set_tool(const Tool &);
+       const Tool *get_tool() const { return tool; }
+
+       /** Indicates if it's possible to build this target. */
+       bool is_buildable() const { return tool!=0; }
+
+       /** Indicates if this target needs rebuilding.  Only makes sense after the
+       target has been prepared. */
+       bool needs_rebuild() const { return state>PREPARING && state<UPTODATE; }
+
+       /** Returns the reason for rebuilding this target.  Only makes sense after
+       the target has been prepared. */
        const std::string &get_rebuild_reason() const { return rebuild_reason; }
-       virtual void find_depends()=0;
-       void   add_depend(Target *);
-       virtual const char *get_type() const=0;
-       virtual ~Target() { }
-protected:
-       Builder     &builder;
-       const Package *package;
-       std::string name;
-       bool        building;
-       bool        rebuild;
-       std::string rebuild_reason;
-       Msp::Time::TimeStamp mtime;
-       std::list<Target *> depends;
-       std::list<Target *> rdepends;
-       bool        ready_for_build;
 
-       Target(Builder &, const Package *, const std::string &);
+       /** Forces rebuild of the target. */
+       void force_rebuild();
+
+       bool is_installable() const { return !install_location.empty(); }
+       const Msp::FS::Path &get_install_location() const { return install_location; }
+       void add_depend(Target *);
+       const Dependencies &get_depends() const { return depends; }
+
+       /** Finds dependencies for the target. */
+       virtual void find_depends() { }
+
+       /** Prepares the target by finding dependencies, recursively preparing them
+       and then checking whether rebuilding is needed. */
+       virtual void prepare();
+
+       /** Starts building the target.  Returns the Action used for building. */
+       Task *build();
+protected:
        void mark_rebuild(const std::string &);
+
+       /** Checks if the target needs to be rebuilt and why. */
+       virtual void check_rebuild() = 0;
+
+       /** Handler for Task::signal_finished. */
+       virtual void build_finished(bool);
 };
 
 #endif