Return-Path: 
 <ant-dev-return-17662-apmail-jakarta-ant-dev-archive=jakarta.apache.org@jakarta.apache.org>
Delivered-To: apmail-jakarta-ant-dev-archive@jakarta.apache.org
Received: (qmail 51922 invoked by uid 500); 13 Sep 2001 14:46:37 -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 51895 invoked from network); 13 Sep 2001 14:46:36 -0000
Message-ID: <3BA0D4EC.8040807@yahoo.com>
Date: Thu, 13 Sep 2001 15:46:52 +0000
From: Paul Hammant <Paul_Hammant@yahoo.com>
User-Agent: Mozilla/5.0 (Windows; U; Windows NT 5.0; en-US;
 rv:0.9.3) Gecko/20010801
X-Accept-Language: en-us
MIME-Version: 1.0
To: ant-dev@jakarta.apache.org
Subject: Fwd: Re: <script> needs a classpath param
Content-Type: multipart/mixed;
 boundary="------------020506000808020007010201"
X-Spam-Rating: daedalus.apache.org 1.6.2 0/1000/N

This is a multi-part message in MIME format.
--------------020506000808020007010201
Content-Type: text/plain; charset=us-ascii; format=flowed
Content-Transfer-Encoding: 7bit

Committers,

Any chance of applying these diffs?  Clearly not to the 1.4.1 branch, 
but to the 1.5 trunk or the (take a deep breath) 2.0 refactoring.

Regards,

- Paul H

------

Folks,

Attached are diffs for Script.java and Script.html. In line with recent 
discussions, script now
has a classpath.  Coded are the ideas from a number of people...

Scenarios for use :

1) Not at all, scripts work like present design

2) Specify <classpath> in a taskdef for <script>, if you tinkered with 
the location of
optional.jar, bsf.jar and js.jar

3) Specify <classpath> on each <script>.  This only requires that 
bsf.jar and js.jar have changed
location

4) Combination of (2) and (3).

There is more blurb in the Script.html diff.


=====
Regards - Paul H
====
CVS -1, Perforce +1


--------------020506000808020007010201
Content-Type: text/html;
 name="Script.java.diff"
Content-Transfer-Encoding: 7bit
Content-Disposition: inline;
 filename="Script.java.diff"

C:/Apache-CVS/cvs.exe diff -r HEAD Script.java
Index: Script.java
===================================================================
RCS file: /home/cvspublic/jakarta-ant/src/main/org/apache/tools/ant/taskdefs/optional/Script.java,v
retrieving revision 1.5
diff -r1.5 Script.java
56d55
< import com.ibm.bsf.*;
58a58,60
> import java.lang.reflect.Method;
> import java.lang.reflect.InvocationTargetException;
> 
59a62,63
> import org.apache.tools.ant.types.Path;
> import org.apache.tools.ant.types.Reference;
64a69
>  * @author Paul Hammant <a href="mailto:Paul_Hammant@yahoo.com">Paul_Hammant@yahoo.com</a>
70c75,76
<     
---
>     private Path classpath;
> 
100c106,128
<             BSFManager manager = new BSFManager ();
---
>             /* 
>                 Use Reflection to invoke Bean Scripting Framework as the jar to be loaded may be
>                 one of those specified in the <classpath/> tags.  Those are entirely oprional.
>                 The user may configure their Ant to have bsf.jar (and it's dependant script jars
>                 like js.jar outsite the directory that contains ant.jar and optional.jar.  Why
>                 would they do this?  Well they may be requiring a scripting language to access
>                 instances from the built classes that some previous (depends="") target had 
>                 made.  There is no safe way to do this other than group, for the purposes of
>                 scripting bsf.jar, js.jar and build/classes (usually) in one separate classpath
>                 element and pass it to each script as it is executed.  See docs.
>             
>             */
>             
>             Object bsfManager = null;
>             try {
>                 bsfManager = this.loadClass("com.ibm.bsf.BSFManager").newInstance();
>             } catch (InstantiationException ie) {
>                 throw new BuildException("Unable to instantiate classes for Bean Scripting Framework, or some " + 
>                     "dependancy.  Please check your classpath(s) and refer to the stack trace for more info", ie);                 
>             } catch (IllegalAccessException iae) {
>                 throw new BuildException("Unable to instantiate classes for Bean Scripting Framework, or some " +
>                     "dependancy due to access issues  Please refer to the stack trace for more info", iae);                
>             }
101a130,132
>             Method declareBean = bsfManager.getClass().getDeclaredMethod("declareBean", 
>                 new Class[] {String.class, Object.class, Class.class} );
>             
105c136,138
<                 manager.declareBean(key, value, value.getClass());
---
>                 // Equivalent to : manager.declareBean(key, value, value.getClass());
>                 declareBean.invoke(bsfManager, new Object[] {key, value, value.getClass()} );
>                 
107c140
< 
---
>            
109,117c142,168
<             manager.exec(language, "<ANT>", 0, 0, script);
<         } catch (BSFException be) {
<             Throwable t = be;
<             Throwable te = be.getTargetException();
<             if (te != null) {
<                 if  (te instanceof BuildException) {
<                     throw (BuildException) te;
<                 } else {
<                     t = te;
---
>             // Equivalent to : manager.exec(language, "<ANT>", 0, 0, script);
>             Method exec = bsfManager.getClass().getDeclaredMethod("exec", 
>                 new Class[] {String.class, String.class, Integer.TYPE, Integer.TYPE, Object.class} );
>             exec.invoke(bsfManager, new Object[] {language, "<ANT>", new Integer(0), new Integer(0), script});            
>             
>         } catch (Exception e) {
>             e.printStackTrace();
>             Throwable t = e;
>             if (e.getClass().getName().equals("com.ibm.bsf.BSFException")) {
>                 Method getTargetException = null;
>                 Throwable te = null;
>                 try {
>                   getTargetException = e.getClass().getDeclaredMethod("getTargetException", new Class[] {} );
>                   te = (Throwable) getTargetException.invoke(e, new Object[] {});                    
>                 } catch (NoSuchMethodException nsme) {
>                     nsme.printStackTrace();
>                 } catch (IllegalAccessException iae) {
>                     iae.printStackTrace();
>                 } catch (InvocationTargetException ite) {
>                     ite.printStackTrace();
>                 }
>                 if (te != null) {
>                     if  (te instanceof BuildException) {
>                         throw (BuildException) te;
>                     } else {
>                         t = te;
>                     }
134c185
<      * Load the script from an external file 
---
>      * Load the script from an external file
140c191
<         if (!file.exists()) 
---
>         if (!file.exists())
153c204
<         
---
> 
164a216,266
> 
>     /**
>      * Set the classpath for loading the driver.
>      */
>     public void setClasspath(Path classpath) {
>         if (this.classpath == null) {
>             this.classpath = classpath;
>         } else {
>             this.classpath.append(classpath);
>         }
>     }
> 
>     /**
>      * Create the classpath for loading the driver.
>      */
>     public Path createClasspath() {
>         if (this.classpath == null) {
>             this.classpath = new Path(project);
>         }
>         return this.classpath.createPath();
>     }
> 
>     /**
>      * Set the classpath for loading the driver using the classpath reference.
>      */
>     public void setClasspathRef(Reference r) {
>         createClasspath().setRefid(r);
>     }
> 
>     /**
>      * Load named class either via the system classloader or a given
>      * custom classloader.
>      */
>     private Class loadClass(String classname) throws BuildException {
>         try {
>             if (classpath == null) {
>                 return Class.forName(classname);
>             } else {
>                 AntClassLoader al = new AntClassLoader(project, classpath);
>                 Class c = null;
>                 c = al.loadClass(classname);
>                 AntClassLoader.initializeClass(c);
>                 return c;
>             }
>         } catch (java.lang.ClassNotFoundException cnfe) {                
>             throw new BuildException("Unable to load classes for Bean Scripting Framework, or some dependancy. " +  
>                 "The most likely cause is that bsf.jar is not in your classpath", cnfe);
>         }            
>     }    
>     
>  
--------------020506000808020007010201
Content-Type: text/html;
 name="script.html.diff"
Content-Transfer-Encoding: 7bit
Content-Disposition: inline;
 filename="script.html.diff"

C:/Apache-CVS/cvs.exe diff -r HEAD script.html
Index: script.html
===================================================================
RCS file: /home/cvspublic/jakarta-ant/docs/manual/OptionalTasks/script.html,v
retrieving revision 1.2
diff -r1.2 script.html
36a37,78
> 
> <h3><a name="nested">Nested Elements</a></h3>
> 
> <p><code>script</code> supports a nested <code>&lt;classpath&gt;</code>
> element, that represents a <a href="../using.html#path">PATH like
> structure</a>.</p>
> 
> <h3><a name="user-of-classpath">Use of Classpath</a></h3>
> 
> <p>The script task uses Bean Scripting Framework from IBM.  This tool loads classes 
> from the relevent jar indicated by the language parameter and then invokes the 
> scripting language.  If the script you've written invokes Java from your project 
> compiled codebase, then you'll need to safely separate the project built classes 
> from the main ant classpath. If you have only the scripting language in the script 
> segment, then you do not need to use the classpath nested parameter.</p>
> 
> <p>Using classes from build/classes (common compilation directory) in the script :</p>
> <ol>
> <li>Don't put bsf.jar and js.jar (Rhino or your preferred scritping language) in the ant/lib 
> directory.  Put them in a separate directory, say ant/scriptlibs.</li>
> <li>Specify classpath elements as part of the script definition, that name bsf.jar, js.jar 
> in their new location as well as build/classes.</li>
> </ol>
> See the Classpath Example <a href="#cpe">below</a>
> 
> <p>Another scenario, if you had several scripts requiring the same runtime classpath, 
> would be also have optional.jar in out of the ant/lib directory.  A taskdef declaration 
> could be made in the top of the build.xml file and global classpath set .. </p>
> <blockquote><pre>
> &lt;taskdef name=&quot;script&quot; classname=&quot;org.apache.tools.ant.taskdefs.optional.Script&quot;&gt;
>   &lt;classpath&gt;
>      &lt;pathelement location=&quot;${optional.class.path}&quot; /&gt;
>      &lt;pathelement location=&quot;build/classes&quot; /&gt;
>    &lt;/classpath&gt;
> &lt;/taskdef&gt;
>  </pre></blockquote>
>  
>  <p>... this way the classpath could be omitted from the script definition in use (or the two could work together)</p>
>  
>  <p><b>It is important to note that for most scenarios, ant/lib is a good place to place all 
>  jars and classpath the element is not needed at all for scripts</b></p>
> 
37a80
> <h4>Basic Squares example</h4>
76a120
> <h4>References example</h4>
113a158,176
> <a name="cpe"><h4>Custom classpath example</h4>
> <p>Another example, this time showing a custom classpath setup</a>
> <blockquote><pre>
> &lt;target name=&quot;cpe&quot; depends=&quot;compile&quot;&gt;
>   &lt;script language=&quot;javascript&quot;&gt; 
>     &lt;classpath&gt;
>       &lt;pathelement location=&quot;tools/scriptlib/bsf.jar&quot; /&gt;
>       &lt;pathelement location=&quot;tools/scriptlib/js.jar&quot; /&gt;  
>       &lt;pathelement location=&quot;build/classes&quot; /&gt;
>     &lt;/classpath&gt; 
>     &lt;![CDATA[
>       importClass(Packages.mypackage.CrystalBall);
>       var cb = new CrystalBall();
>       cb.printNextSetOfWinningLotteryNumbers();
>     ]]&gt; 
>   &lt;/script&gt;
> &lt;/target&gt;
> </pre></blockquote>
>  
--------------020506000808020007010201--