X-Git-Url: http://git.tdb.fi/?a=blobdiff_plain;f=source%2Ftarget.h;h=2881d42fcda00dc2409d57518eddaa48a357181b;hb=87ea54db19306434bac3e765c9bd3464fd53f390;hp=ab9134aff85c2b4e34ab4c9eacd719c4e8ccc06d;hpb=b0eb979b0dc79269cb3bb5bb2e67ef4e80689cfe;p=builder.git diff --git a/source/target.h b/source/target.h index ab9134a..2881d42 100644 --- a/source/target.h +++ b/source/target.h @@ -1,7 +1,16 @@ +/* $Id$ + +This file is part of builder +Copyright © 2006-2010 Mikko Rasa, Mikkosoft Productions +Distributed under the LGPL +*/ + #ifndef TARGET_H_ #define TARGET_H_ #include +#include +#include #include #include @@ -9,46 +18,97 @@ class Action; class Builder; class Package; +class Target; +typedef std::list TargetList; + +/** +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: - 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 Msp::Time::TimeStamp &get_mtime() const { return mtime; } - virtual const char *get_type() const=0; - const std::list &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(); - virtual ~Target() { } protected: - Builder &builder; + Builder &builder; const Package *package; std::string name; - bool building; - bool rebuild; + + bool buildable; + bool building; + bool rebuild; std::string rebuild_reason; - Msp::Time::TimeStamp mtime; - std::list depends; - std::list rdepends; - bool deps_ready; - bool prepared; - bool buildable; - bool counted; + + TargetList depends; + bool deps_ready; + + bool preparing; + bool prepared; Target(Builder &, const Package *, 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; } + + /** + 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 or Symlink), 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; } + + 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; } + + /** + 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; } + + /** + 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 &); - virtual void check_rebuild(); - Action *build(Action *); + + /** + 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