Return-Path: 
 <ant-dev-return-18054-apmail-jakarta-ant-dev-archive=jakarta.apache.org@jakarta.apache.org>
Delivered-To: apmail-jakarta-ant-dev-archive@jakarta.apache.org
Received: (qmail 27115 invoked by uid 500); 29 Sep 2001 05:09:29 -0000
Mailing-List: contact ant-dev-help@jakarta.apache.org; run by ezmlm
Precedence: bulk
Reply-To: ant-dev@jakarta.apache.org
list-help: <mailto:ant-dev-help@jakarta.apache.org>
list-unsubscribe: <mailto:ant-dev-unsubscribe@jakarta.apache.org>
list-post: <mailto:ant-dev@jakarta.apache.org>
Delivered-To: mailing list ant-dev@jakarta.apache.org
Received: (qmail 27106 invoked from network); 29 Sep 2001 05:09:29 -0000
Message-ID: <008201c148a5$209abca0$6501a8c0@GILAMONSTER>
From: "Erik Hatcher" <jakarta-ant@ehatchersolutions.com>
To: <ant-dev@jakarta.apache.org>
References: <3.0.32.20010927141649.00cf87e0@zbl6c008.corpeast.baynetworks.com>
 <20010928151522.SDDD13193.mss.rdc2.nsw.optushome.com.au@there>
 <002701c14833$68b0be30$6501a8c0@GILAMONSTER>
 <20010928234140.ZZKH13193.mss.rdc2.nsw.optushome.com.au@there>
Subject: Re: [PATCH] Script enhancement to standardize the "project" object
 exposed
Date: Fri, 28 Sep 2001 22:10:57 -0700
MIME-Version: 1.0
Content-Type: multipart/mixed;
	boundary="----=_NextPart_000_007F_01C1486A.72EA3750"
X-Priority: 3
X-MSMail-Priority: Normal
X-Mailer: Microsoft Outlook Express 5.00.3018.1300
X-MimeOLE: Produced By Microsoft MimeOLE V5.00.3018.1300
X-Spam-Rating: daedalus.apache.org 1.6.2 0/1000/N

This is a multi-part message in MIME format.

------=_NextPart_000_007F_01C1486A.72EA3750
Content-Type: text/plain;
	charset="utf-8"
Content-Transfer-Encoding: 7bit

> On Sat, 29 Sep 2001 01:36, Erik Hatcher wrote:
> > The reason would be so that <script> can be used to write "ad hoc" Tasks
> > more easily and get directly at its Task instance rather than going
through
> > a roundabout way of hardcoding in an arbitrary reference name.
>
> You still haven't answered my question ;) What advantage is it to give
access
> to this object. What features does this add to script writers arsenal?
What
> methods/data does it give access to that you need and otherwise would want
to
> be available?

Peter -
The advantage is that it allows <script> code to work more seamlessly like a
real Task does.   It more cleanly has access to "itself" without having to
go through a level of indirection by knowing its own 'id' value.

> Tighter coupling makes it more difficult for the ant core to evolve in
> future. It also adds more complexity than is needed - especially as I
don't
> know what possible advantage allowing such access gives ;)

The advantage is cleanliness and just seems like the right thing to do.
Here is a concrete example of the differences between having 'self' and not
having it.

<project name="TestProj" default="test1">
  <property name="xyz" value="123"/>
  <property name="dotted.property" value="???"/>
  <target name="test1">
    <script language="javascript"> <![CDATA[
      self.log(self.owningTarget.getName());
    ]]> </script>
  </target>

  <target name="test2">
    <script language="javascript" id="scriptTask"> <![CDATA[
      scriptTask.log(scriptTask.owningTarget.getName());
      scriptTask.log("xyz = " + xyz);
      //scriptTask.log("dotted.property = " + dotted.property);
      scriptTask.log(project.getName());
      for (i in this) {
        scriptTask.log(i + " = " + this[i]);
      }
      scriptTask.log("dotted.property = " +
project.getProperty("dotted.property"));
    ]]> </script>
  </target>
</project>


Target "test1" takes advantage of the "self" modification [beans.add("self",
this)].  Target "test2" does it the old-fashioned way, where it has to know
its own "id" in order to access itself as a Task.   I mainly view <script>
as a way to prototype tasks or do them in a more ad hoc way than writing a
Java class.   There are other questionable uses like having it control other
tasks and targets which I don't really see much need for personally.   In
target "test2", the "project" object is used - just for demonstration
purposes.   Also, an Ant property is displayed, followed by all the objects
exposed to the script, and then an example of getting properties that get
skipped by addBeans.  Here is the output of running both targets:

Buildfile: test.xml

test1:
   [script] test1

test2:
Overriding previous definition of reference to scriptTask
   [script] test2
   [script] xyz = 123
   [script] TestProj
   [script] project = org.apache.tools.ant.Project@3753f8
   [script] scriptTask =
org.apache.tools.ant.taskdefs.optional.Script@63b895
   [script] TestProj = org.apache.tools.ant.Project@3753f8
   [script] xyz = 123
   [script] basedir = C:\jakarta\jakarta-ant
   [script] self = org.apache.tools.ant.taskdefs.optional.Script@63b895
   [script] bsf = com.ibm.bsf.util.BSFFunctions@31aa65
   [script] test1 = test1
   [script] test2 = test2
   [script] dotted.property = ???

BUILD SUCCESSFUL

Total time: 1 second

Its almost useless to have the the Ant properties added for direct access.
As you can see I had to comment out the line to get the dotted.property
directly because its illegal JavaScript syntax, and most of us use dotted
properties.   The addBeans method skips objects (references, properties, and
targets) that have illegal Java identifier names - so its really wisest to
use project.getProperty to get at properties.   I'm almost of the opinion
that the <script> task should *only* expose "self" and let the user navigate
to other objects (including "project") through methods and members defined
on Task.   That would seem to fit in better with your goals, wouldn't it
Peter?   I'm sure some folks use <script> to do some wild and crazy
flow-control and iterations over other targets and tasks.  But in the spirit
of backwards compatibility I'm fine with leaving it as-is with the addition
of "self".   Peter, I see you already committed the "project" patch, but I'd
like to also see the attached patch committed with the "self" addition - I
hope you can see it in your heart to allow this through!  :)   I don't quite
see what would be so bad about this change and how that too tightly couples
things.   <script> is a Task, I just want it to be able to work like one
easily.  :)   Suppose someone creates generic <script>'s in a common file
that gets entity-reference included in other build.xml's that all have
different project names?   That was the heart of the issue that brought on
this change.

Thanks,
    Erik


------=_NextPart_000_007F_01C1486A.72EA3750
Content-Type: text/plain;
	name="patchfile.txt"
Content-Transfer-Encoding: quoted-printable
Content-Disposition: attachment;
	filename="patchfile.txt"

cvs -q diff -u =
src/main/org/apache/tools/ant/taskdefs/optional/Script.java =
docs/manual/OptionalTasks/script.html=20
Index: src/main/org/apache/tools/ant/taskdefs/optional/Script.java
=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=
=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=
=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D
RCS file: =
/home/cvspublic/jakarta-ant/src/main/org/apache/tools/ant/taskdefs/option=
al/Script.java,v
retrieving revision 1.5
diff -u -r1.5 Script.java
--- src/main/org/apache/tools/ant/taskdefs/optional/Script.java	=
2001/01/03 14:18:35	1.5
+++ src/main/org/apache/tools/ant/taskdefs/optional/Script.java	=
2001/09/29 04:47:04
@@ -97,6 +97,9 @@
             addBeans(project.getTargets());
             addBeans(project.getReferences());
=20
+            beans.put("self", this);
+            beans.put("project", project);
+
             BSFManager manager =3D new BSFManager ();
=20
             for (Enumeration e =3D beans.keys() ; e.hasMoreElements() =
;) {
Index: docs/manual/OptionalTasks/script.html
=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=
=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=
=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D
RCS file: =
/home/cvspublic/jakarta-ant/docs/manual/OptionalTasks/script.html,v
retrieving revision 1.2.2.1
diff -u -r1.2.2.1 script.html
--- docs/manual/OptionalTasks/script.html	2001/08/28 21:50:54	1.2.2.1
+++ docs/manual/OptionalTasks/script.html	2001/09/29 04:47:05
@@ -15,7 +15,7 @@
 See <a href=3D"../install.html#librarydependencies">Library =
Dependencies</a> for more information.</p>
 <p>All items (tasks, targets, etc) of the running project are
 accessible from the script, using either their <code>name</code> or
-<code>id</code> attributes.</p>
+<code>id</code> attributes.  The name "project" is a pre-defined =
reference to the Project, which can be used instead of the project name. =
 "self" is a pre-defined reference to the current &lt;script&gt; Task =
object.</p>
 <p>Scripts can do almost anything a task written in Java could do.</p>
 <h3>Parameters</h3>
 <table border=3D"1" cellpadding=3D"2" cellspacing=3D"0">

------=_NextPart_000_007F_01C1486A.72EA3750--