Split class Package into SourcePackage and BinaryPackage

[builder.git] / source / target.cpp

diff --git a/source/target.cpp b/source/target.cpp
index e03428837838afdbd78447862075f4db66d082b6..fa63ac4e5154293050db87c91168d4c286690938 100644 (file)
--- a/source/target.cpp
+++ b/source/target.cpp
@@ -1,16 +1,32 @@
+/* $Id$
+
+This file is part of builder
+Copyright © 2006-2007 Mikko Rasa, Mikkosoft Productions
+Distributed under the LGPL
+*/
+
 #include <msp/path/utils.h>
 #include <msp/time/utils.h>
 #include "action.h"
 #include "builder.h"
 #include "package.h"
+#include "sourcepackage.h"
 #include "target.h"
 
 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;
+       if(!rebuild)
+               return 0;
+
+       bool self_ok=!building;
        for(TargetList::iterator i=depends.begin(); i!=depends.end(); ++i)
        {
                Target *tgt=(*i)->get_buildable_target();
@@ -20,7 +36,7 @@ Target *Target::get_buildable_target()
                        self_ok=false;
        }
 
-       if(self_ok && rebuild && !building)
+       if(self_ok)
                return this;
 
        return 0;
@@ -28,21 +44,34 @@ Target *Target::get_buildable_target()
 
 void Target::add_depend(Target *dep)
 {
+       if(dep==this)
+               throw InvalidParameterValue("A target can't depend on itself");
        depends.push_back(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;
 
+       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)
@@ -55,6 +84,9 @@ unsigned Target::count_rebuild()
        return count;
 }
 
+/**
+Changes the mtime of the target to the current time.
+*/
 void Target::touch()
 {
        mtime=Time::now();
@@ -71,6 +103,8 @@ Target::Target(Builder &b, const Package *p, const string &n):
        prepared(false),
        counted(false)
 {
+       builder.add_target(this);
+
        struct stat st;
        if(!Path::stat(name, st))
                mtime=Time::TimeStamp::from_unixtime(st.st_mtime);
@@ -82,6 +116,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)
@@ -101,10 +138,16 @@ void Target::check_rebuild()
                                mark_rebuild(Path::basename((*i)->get_name())+" needs rebuilding");
                }
        }
-       if(!rebuild && package && package->get_config().get_mtime()>mtime)
+
+       const SourcePackage *spkg=dynamic_cast<const SourcePackage *>(package);
+       if(!rebuild && spkg && spkg->get_config().get_mtime()>mtime)
                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 +155,9 @@ Action *Target::build(Action *action)
        return action;
 }
 
+/**
+Handles for the build_done signal of Action.
+*/
 void Target::build_done()
 {
        building=false;