source/target.h

   1 #ifndef TARGET_H_
   2 #define TARGET_H_
   3
   4 #include <list>
   5 #include <map>
   6 #include <set>
   7 #include <string>
   8 #include <sigc++/signal.h>
   9 #include <msp/time/timestamp.h>
  10
  11 class Builder;
  12 class Component;
  13 class SourcePackage;
  14 class Task;
  15 class Tool;
  16
  17 /**
  18 Targets make up the build graph.  This class is a base for all target types and
  19 handles many common tasks.  See also FileTarget and VirtualTarget.
  20 */
  21 class Target
  22 {
  23 public:
  24         typedef std::list<Target *> Dependencies;
  25
  26 protected:
  27         enum State
  28         {
  29                 INIT,
  30                 PREPARING,
  31                 REBUILD,
  32                 BUILDING,
  33                 UPTODATE
  34         };
  35
  36 public:
  37         sigc::signal<void> signal_bubble_rebuild;
  38
  39 protected:
  40         Builder &builder;
  41         const SourcePackage *package;
  42         const Component *component;
  43         std::string name;
  44
  45         Tool *tool;
  46         State state;
  47         std::string rebuild_reason;
  48
  49         Dependencies depends;
  50         Dependencies side_effects;
  51         Target *primary_target;
  52
  53         Target(Builder &, const std::string &);
  54 public:
  55         virtual ~Target() { }
  56
  57         virtual const char *get_type() const = 0;
  58         const std::string &get_name() const { return name; }
  59         const SourcePackage *get_package() const { return package; }
  60         const Component *get_component() const { return component; }
  61
  62         /** Adds a dependency for the target.  Order is preseved and is important
  63         for some target types.  It is an error to create dependency cycles, although
  64         this won't be detected until the targets are prepared. */
  65         void add_dependency(Target &);
  66
  67         /** Adds a side effect for the target.  Side effects are not built on their
  68         own, but together with their primary target. */
  69         void add_side_effect(Target &);
  70
  71 protected:
  72         /** Finds dependencies for the target.  Called during preparation.  If the
  73         target needs to recursively inspect its dependencies, it should prepare its
  74         direct dependencies first. */
  75         virtual void find_dependencies() { }
  76
  77 public:
  78         /// Returns the dependencies of the target, in the order they were added.
  79         const Dependencies &get_dependencies() const { return depends; }
  80
  81         /// Returns the side effects of the target.
  82         const Dependencies &get_side_effects() const { return side_effects; }
  83
  84         /// Returns the primary target associated with a side effect target.
  85         Target *get_primary_target() const { return primary_target; }
  86
  87         /** Tries to locate a target that will help getting this target built.  If
  88         all dependencies are up-to-date, returns this target.  If there are no
  89         targets ready to be built (maybe because they are being built right now),
  90         returns 0. */
  91         virtual Target *get_buildable_target();
  92
  93         /** If this target is a proxy for another (such as InstalledFile), return
  94         that target.  Otherwise, return the target itself.  Implementors should call
  95         the function recursively to find the final target. */
  96         virtual Target *get_real_target() { return this; }
  97
  98         void set_tool(Tool &);
  99
 100         /** Returns the tool used to build the target.  To actually build it, call
 101         the build() function. */
 102         const Tool *get_tool() const { return tool; }
 103
 104         /** Indicates if it's possible to build this target. */
 105         bool is_buildable() const { return tool!=0; }
 106
 107         /** Indicates if this target needs rebuilding.  Only makes sense after the
 108         target has been prepared. */
 109         bool needs_rebuild() const { return state>PREPARING && state<UPTODATE; }
 110
 111         /** Returns the reason for rebuilding this target.  Only makes sense after
 112         the target has been prepared. */
 113         const std::string &get_rebuild_reason() const { return rebuild_reason; }
 114
 115         /** Forces rebuild of the target. */
 116         void force_rebuild();
 117
 118 protected:
 119         /** Marks the target to be rebuilt and specified a reason for it. */
 120         void mark_rebuild(const std::string &);
 121
 122         /** Checks if the target needs to be rebuilt and why. */
 123         virtual void check_rebuild() = 0;
 124
 125 public:
 126         /** Prepares the target by finding dependencies, recursively preparing them
 127         and then checking whether rebuilding is needed. */
 128         void prepare();
 129
 130         /** Invokes the associated Tool to build the target and returns the
 131         resulting Task.  The task must be started by the caller. */
 132         virtual Task *build();
 133
 134 protected:
 135         /** Handler for Task::signal_finished. */
 136         virtual void build_finished(bool);
 137
 138         virtual void modified() { }
 139
 140 public:
 141         /** Removes any results of building the target. */
 142         virtual void clean() { }
 143 };
 144
 145 #endif