+/* $Id$
+
+This file is part of builder
+Copyright © 2006-2009 Mikko Rasa, Mikkosoft Productions
+Distributed under the LGPL
+*/
+
#ifndef TARGET_H_
#define TARGET_H_
#include <list>
+#include <map>
#include <string>
#include <msp/time/timestamp.h>
*/
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 find_depends() { deps_ready=true; }
- 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; }
/**
- 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;
+ 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; }
- bool buildable;
- bool building;
- bool rebuild;
- std::string rebuild_reason;
+ /**
+ 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; }
- TargetList depends;
- TargetList rdepends;
- bool deps_ready;
+ /**
+ Prepares the target by recursively preparing dependencies, then checking
+ whether rebuilding is needed. A flag is used to prevent unnecessary
+ executions.
+ */
+ virtual void prepare();
- bool prepared;
- bool counted;
+ /**
+ Starts building the target. Returns the Action used for building.
+ */
+ Action *build();
- Target(Builder &, const Package *, const std::string &);
- void mark_rebuild(const std::string &);
+ void reset_count() { counted=false; }
+
+ /**
+ Returns the number of targets that need to be rebuilt in order to get this
+ target up-to-date.
+ */
+ virtual unsigned count_rebuild();
+
+ /**
+ Changes the mtime of the target to the current time.
+ */
+ void touch();
+protected:
+ void mark_rebuild(const std::string &);
+
+ /**
+ Checks if the target needs to be rebuilt and why.
+ */
virtual void check_rebuild();
- Action *build(Action *);
+
+ /**
+ 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();
};
+typedef std::map<std::string, Target *> TargetMap;
+
#endif