Comment updates

[builder.git] / source / target.h

diff --git a/source/target.h b/source/target.h
index 605b328badef68faaca64c0c6f2b84c61f9de98d..03b87557873e111a2b0eb986b90fb97b1cbe959a 100644 (file)
--- a/source/target.h
+++ b/source/target.h
@@ -1,77 +1,100 @@
-/* $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 <set>
 #include <string>
 #include <msp/time/timestamp.h>
 
-class Action;
 class Builder;
+class Component;
 class Package;
+class Task;
+class Tool;
 
 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.
+handles many common tasks.  See also FileTarget and VirtualTarget.
 */
 class Target
 {
 public:
-       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 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       find_depends()              { deps_ready=true; }
-       virtual void       prepare();
-
-       /**
-       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() { }
+       typedef std::list<Target *> Dependencies;
+
 protected:
-       Builder       &builder;
+       enum State
+       {
+               INIT,
+               PREPARING,
+               REBUILD,
+               BUILDING,
+               UPTODATE
+       };
+
+       Builder &builder;
        const Package *package;
-       std::string   name;
-       Msp::Time::TimeStamp mtime;
-
-       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 &);
-       virtual void check_rebuild();
-       Action       *build(Action *);
-       virtual void build_done();
+       const Component *component;
+       std::string name;
+
+       const Tool *tool;
+       State state;
+       std::string rebuild_reason;
+       std::string 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; }
+       const Package *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; }
+
+       bool is_buildable() const { return tool!=0; }
+       bool needs_rebuild() const { return state>PREPARING && state<UPTODATE; }
+       const std::string &get_rebuild_reason() const { return rebuild_reason; }
+       bool is_installable() const { return !install_location.empty(); }
+       const std::string &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