X-Git-Url: http://git.tdb.fi/?a=blobdiff_plain;f=source%2Ftarget.h;h=5deb2344b3c00ed72d6253ad0d294d502ba25a89;hb=242c55b17e6608b29a77ca17a5b677e202a3ca90;hp=04a360dab57394ec23c305b69825a80135edcee9;hpb=77461a8c0e2b5686b04cf15f3a9333b215813992;p=builder.git

diff --git a/source/target.h b/source/target.h
index 04a360d..5deb234 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-2009  Mikko Rasa, Mikkosoft Productions
 Distributed under the LGPL
 */
 
@@ -26,57 +26,93 @@ handles many common tasks.  Most targets are associated with a file.
 */
 class Target
 {
+protected:
+	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 &);
 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 ~Target() { }
+
 	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       prepare();
+	const std::string &get_name() const { return name; }
+	const Package *get_package() const { return package; }
+	const Msp::Time::TimeStamp &get_mtime() const { return mtime; }
+
+	/**
+	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.
+	*/
+	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; }
+	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; }
+	virtual void find_depends() { deps_ready=true; }
 
 	/**
-	Creates and returns an Action suitable for building this target.
+	Prepares the target by recursively preparing dependencies, then checking
+	whether rebuilding is needed.  A flag is used to prevent unnecessary
+	executions.
 	*/
-	Action             *build();
+	virtual void prepare();
 
-	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;
+	/**
+	Starts building the target.  Returns the Action used for building.
+	*/
+	Action *build();
 
-	bool          buildable;
-	bool          building;
-	bool          rebuild;
-	std::string   rebuild_reason;
+	void reset_count() { counted=false; }
 
-	TargetList    depends;
-	TargetList    rdepends;
-	bool          deps_ready;
+	/**
+	Returns the number of targets that need to be rebuilt in order to get this
+	target up-to-date.
+	*/
+	virtual unsigned count_rebuild();
 
-	bool          prepared;
-	bool          counted;
+	/**
+	Changes the mtime of the target to the current time.
+	*/
+	void touch();
+protected:
+	void mark_rebuild(const std::string &);
 
-	Target(Builder &, const Package *, const std::string &);
-	void         mark_rebuild(const std::string &);
+	/**
+	Checks if the target needs to be rebuilt and why.
+	*/
 	virtual void check_rebuild();
+
+	/**
+	Creates and returns an Action suitable for building this target.
+	*/
 	virtual Action *create_action() =0;
+
+	/**
+	Handles for the build_done signal of Action.
+	*/
 	virtual void build_done();
 };