X-Git-Url: http://git.tdb.fi/?a=blobdiff_plain;f=source%2Ftarget.h;h=edfd60cebe7f8f655a5c8011512d05b80b481d9b;hb=05a2b9dabd01414e9e9a91f9d69babaca4ccb32d;hp=605b328badef68faaca64c0c6f2b84c61f9de98d;hpb=7aeaa4ba965f596edad438c02e345a8843f7469a;p=builder.git diff --git a/source/target.h b/source/target.h index 605b328..edfd60c 100644 --- a/source/target.h +++ b/source/target.h @@ -1,7 +1,7 @@ /* $Id$ This file is part of builder -Copyright © 2006-2007 Mikko Rasa, Mikkosoft Productions +Copyright © 2006-2010 Mikko Rasa, Mikkosoft Productions Distributed under the LGPL */ @@ -9,6 +9,8 @@ Distributed under the LGPL #define TARGET_H_ #include +#include +#include #include #include @@ -21,57 +23,92 @@ typedef std::list 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 { +protected: + Builder &builder; + const Package *package; + std::string name; + + bool buildable; + bool building; + bool rebuild; + std::string rebuild_reason; + + TargetList depends; + bool deps_ready; + + bool preparing; + bool prepared; + + Target(Builder &, const Package *, const std::string &); 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(); + virtual ~Target() { } + + virtual const char *get_type() const = 0; + const std::string &get_name() const { return name; } + const Package *get_package() const { return package; } /** - Creates and returns an Action suitable for building this target. + 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 Action *build()=0; + Target *get_buildable_target(); - void reset_count() { counted=false; } - virtual unsigned count_rebuild(); - void touch(); - virtual ~Target() { } -protected: - Builder &builder; - const Package *package; - std::string name; - Msp::Time::TimeStamp mtime; + /** + If this target is a proxy for another (such as Install or Symlink), return + that target. Otherwise, return the target itself. - bool buildable; - bool building; - bool rebuild; - std::string rebuild_reason; + Implementors should call the function recursively to find the final target. + */ + virtual Target *get_real_target() { return this; } - TargetList depends; - TargetList rdepends; - bool deps_ready; + bool is_buildable() const { return buildable; } + bool get_rebuild() const { return rebuild; } + const std::string &get_rebuild_reason() const { return rebuild_reason; } + void add_depend(Target *); + const TargetList &get_depends() const { return depends; } + bool get_depends_ready() const { return deps_ready; } - bool prepared; - bool counted; + /** + 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; } - Target(Builder &, const Package *, const std::string &); - void mark_rebuild(const std::string &); - virtual void check_rebuild(); - Action *build(Action *); + /** + Prepares the target by recursively preparing dependencies, then checking + whether rebuilding is needed. A flag is used to prevent unnecessary + executions. + */ + virtual void prepare(); + + /** + Starts building the target. Returns the Action used for building. + */ + Action *build(); +protected: + void mark_rebuild(const std::string &); + + /** + Checks if the target needs to be rebuilt and why. + */ + virtual void check_rebuild() = 0; + + /** + Creates and returns an Action suitable for building this target. + */ + virtual Action *create_action() =0; + + /** + Handler for the build_done signal of Action. + */ virtual void build_done(); }; +typedef std::map TargetMap; + #endif