Better encapsulation of config inside Package

[builder.git] / source / target.cpp

diff --git a/source/target.cpp b/source/target.cpp
index d55202289dfd026fb1893a3c83abd8f1cd34f670..e8ed647477fcf82823f06195cfa8a7e43edf7441 100644 (file)
--- a/source/target.cpp
+++ b/source/target.cpp
@@ -8,10 +8,18 @@
 using namespace std;
 using namespace Msp;
 
+/**
+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 *Target::get_buildable_target()
 {
-       bool self_ok=true;
-       for(list<Target *>::iterator i=depends.begin(); i!=depends.end(); ++i)
+       if(!rebuild)
+               return 0;
+
+       bool self_ok=!building;
+       for(TargetList::iterator i=depends.begin(); i!=depends.end(); ++i)
        {
                Target *tgt=(*i)->get_buildable_target();
                if(tgt)
@@ -20,7 +28,7 @@ Target *Target::get_buildable_target()
                        self_ok=false;
        }
 
-       if(self_ok && rebuild && !building)
+       if(self_ok)
                return this;
 
        return 0;
@@ -32,17 +40,28 @@ void Target::add_depend(Target *dep)
        dep->rdepends.push_back(this);
 }
 
+/**
+Prepares the target by recursively preparing dependencies, then checking
+whether rebuilding is needed.  A flag is used to prevent unnecessary
+executions.
+*/
 void Target::prepare()
 {
        if(prepared)
                return;
 
-       for(list<Target *>::iterator i=depends.begin(); i!=depends.end(); ++i)
+       prepared=true;
+       for(TargetList::iterator i=depends.begin(); i!=depends.end(); ++i)
                (*i)->prepare();
 
        check_rebuild();
+
 }
 
+/**
+Returns the number of targets that need to be rebuilt in order to get this
+target up-to-date.
+*/
 unsigned Target::count_rebuild()
 {
        if(counted)
@@ -50,11 +69,14 @@ unsigned Target::count_rebuild()
 
        counted=true;
        unsigned count=rebuild;
-       for(list<Target *>::iterator i=depends.begin(); i!=depends.end(); ++i)
+       for(TargetList::iterator i=depends.begin(); i!=depends.end(); ++i)
                count+=(*i)->count_rebuild();
        return count;
 }
 
+/**
+Changes the mtime of the target to the current time.
+*/
 void Target::touch()
 {
        mtime=Time::now();
@@ -64,11 +86,11 @@ Target::Target(Builder &b, const Package *p, const string &n):
        builder(b),
        package(p),
        name(n),
+       buildable(false),
        building(false),
        rebuild(false),
        deps_ready(false),
        prepared(false),
-       buildable(false),
        counted(false)
 {
        struct stat st;
@@ -82,6 +104,9 @@ void Target::mark_rebuild(const std::string &reason)
        rebuild_reason=reason;
 }
 
+/**
+Checks if this target needs to be rebuilt and why.
+*/
 void Target::check_rebuild()
 {
        if(!buildable)
@@ -93,7 +118,7 @@ void Target::check_rebuild()
                mark_rebuild("Does not exist");
        else
        {
-               for(list<Target *>::iterator i=depends.begin(); (i!=depends.end() && !rebuild); ++i)
+               for(TargetList::iterator i=depends.begin(); (i!=depends.end() && !rebuild); ++i)
                {
                        if((*i)->get_mtime()>mtime)
                                mark_rebuild(Path::basename((*i)->get_name())+" has changed");
@@ -105,6 +130,10 @@ void Target::check_rebuild()
                mark_rebuild("Package options changed");
 }
 
+/**
+Hooks the target up with the given action, then returns it.  This should be
+called from the public build() function of buildable targets.
+*/
 Action *Target::build(Action *action)
 {
        building=true;
@@ -112,6 +141,9 @@ Action *Target::build(Action *action)
        return action;
 }
 
+/**
+Handles for the build_done signal of Action.
+*/
 void Target::build_done()
 {
        building=false;