@@ -67,11 +67,11 @@
/* build notes /* build notes
-The reference CD to listen to while editing this file is
nap: Underworld - Everything, Everything
-variable naming policy from Fowler's refactoring book.
-tested against the PDC pre-beta of csc.exe; future versions will
inevitably change things
-The reference CD to listen to while editing this file is
nap: Underworld - Everything, Everything
-variable naming policy from Fowler's refactoring book.
-tested against the PDC pre-beta of csc.exe; future versions will
inevitably change things
*/ */
// ==================================================================== // ====================================================================
@@ -93,157 +93,64 @@ import org.apache.tools.ant.taskdefs.*;
import org.apache.tools.ant.types.*; import org.apache.tools.ant.types.*;
/** /**
Task to assemble .net 'Intermediate Language' files.
The task will only work on win2K until other platforms support csc.exe or
an equivalent. ilasm.exe must be on the execute path too.
<p>
Task to assemble .net 'Intermediate Language' files.
The task will only work on win2K until other platforms support csc.exe or
an equivalent. ilasm.exe must be on the execute path too.
<p>
<p>
All parameters are optional: <il/> should suffice to produce a debug
build of all *.il files.
The option set is roughly compatible with the CSharp class;
even though the command line options are only vaguely
equivalent. [The low level commands take things like /OUT=file,
csc wants /out:file ... /verbose is used some places; /quiet here in
ildasm... etc.] It would be nice if someone made all the command line
tools consistent (and not as brittle as the java cmdline tools)
<p>
All parameters are optional: <il/> should suffice to produce a debug
build of all *.il files.
The option set is roughly compatible with the CSharp class;
even though the command line options are only vaguely
equivalent. [The low level commands take things like /OUT=file,
csc wants /out:file ... /verbose is used some places; /quiet here in
ildasm... etc.] It would be nice if someone made all the command line
tools consistent (and not as brittle as the java cmdline tools)
<p>
The task is a directory based task, so attributes like <b>includes="*.il"</b> and
<b>excludes="broken.il"</b> can be used to control the files pulled in.
Each file is built on its own, producing an appropriately named output file unless
manually specified with <b>outfile</b>
<p>
<table border="1" cellpadding="2" cellspacing="0">
<tr>
<td valign="top"><b>Attribute</b></td>
<td valign="top"><b>Description</b></td>
<td align="center" valign="top"><b>Example</b></td>
</tr>
<tr>
<tr>
<td valign="top">defaultexcludes</td>
<td valign="top">indicates whether default excludes should be used or not
("yes"/"no"). Default excludes are used when omitted.</td>
</tr>
<tr>
<td valign="top">debug
<td valign="top">include debug information
<td valign="top">true (default)
</tr>
<tr>
<tr>
<td valign="top">excludes</td>
<td valign="top">comma separated list of patterns of files that must be
excluded. No files (except default excludes) are excluded when omitted.</td>
</tr>
<tr>
<td valign="top">excludesfile</td>
<td valign="top">the name of a file. Each line of this file is
taken to be an exclude pattern</td>
</tr>
<tr>
<td valign="top">failOnError
<td valign="top">Should a failed compile halt the build?
<td valign="top">true(default)
</tr>
<tr>
<td valign="top">includes</td>
<td valign="top">comma separated list of patterns of files that must be
included. All files are included when omitted.</td>
</tr>
<tr>
<td valign="top">includesfile</td>
<td valign="top">the name of a file. Each line of this file is
taken to be an include pattern</td>
</tr>
<tr>
<td valign="top">listing
<td valign="top">Produce a listing (off by default)
<td valign="top">off (default)
</tr>
<tr>
<td valign="top">outputFile
<td valign="top">filename of output
<td valign="top">"example.exe"
</tr>
<tr>
<td valign="top">owner
<td valign="top">restrict disassembly by setting the 'owner' string
<td valign="top">"secret"
</tr>
<tr>
<td valign="top">resourceFile
<td valign="top">name of resource file to include
<td valign="top">"resources.res"
</tr>
<tr>
<td valign="top">srcDir
<td valign="top">source directory (default = project directory)
<td valign="top">
</tr>
<tr>
<td valign="top">targetType
<td valign="top">Type of target. library means DLL is output.
<td valign="top">"exe","library"
</tr>
<tr>
<td valign="top">verbose
<td valign="top">output progress messages
<td valign="top">off (default)
</tr>
</table>
<p>
The task is a directory based task, so attributes like <b>includes="*.il"</b> and
<b>excludes="broken.il"</b> can be used to control the files pulled in.
Each file is built on its own, producing an appropriately named output file unless
manually specified with <b>outfile</b>
@author Steve Loughran steve_l@iseran.com
@version 0.2
*/
@author Steve Loughran steve_l@iseran.com
@version 0.1
*/
// ====================================================================
public class Ilasm public class Ilasm
extends org.apache.tools.ant.taskdefs.MatchingTask { extends org.apache.tools.ant.taskdefs.MatchingTask {
//=============================================================================
/** constructor inits everything and set up the search pattern /** constructor inits everything and set up the search pattern
*/
*/
public Ilasm () { public Ilasm () {
Clear(); Clear();
setIncludes(file_pattern); setIncludes(file_pattern);
} }
//-----------------------------------------------------------------------------
/** name of the executable. the .exe suffix is deliberately not included /** name of the executable. the .exe suffix is deliberately not included
* in anticipation of the unix version * in anticipation of the unix version
*/ */
protected static final String exe_name="ilasm"; protected static final String exe_name="ilasm";
/** what is the file extension we search on? /** what is the file extension we search on?
*/ */
protected static final String file_ext="il"; protected static final String file_ext="il";
/** and now derive the search pattern from the extension /** and now derive the search pattern from the extension
*/ */
protected static final String file_pattern="*."+file_ext;
protected static final String file_pattern="**/*."+file_ext;
/** title of task for external presentation /** title of task for external presentation
*/ */
protected static final String exe_title="ilasm"; protected static final String exe_title="ilasm";
//=============================================================================
/** reset all contents. /** reset all contents.
*/
*/
public void Clear() { public void Clear() {
_targetType=null; _targetType=null;
_srcDir=null; _srcDir=null;
@@ -255,49 +162,56 @@ public class Ilasm
_failOnError=true; _failOnError=true;
_resourceFile=null; _resourceFile=null;
_owner=null; _owner=null;
_extraOptions=null;
} }
//=============================================================================
/** source directory upon which the search pattern is applied /** source directory upon which the search pattern is applied
*/ */
private File _srcDir; private File _srcDir;
/** /**
* Set the source dir to find the files to be compiled * Set the source dir to find the files to be compiled
* @param srcDirName The new SrcDir value
*/ */
public void setSrcDir(String srcDirName){ public void setSrcDir(String srcDirName){
_srcDir = project.resolveFile(srcDirName); _srcDir = project.resolveFile(srcDirName);
} }
//=============================================================================
/** type of target. Should be one of exe|library|module|winexe|(null) /** type of target. Should be one of exe|library|module|winexe|(null)
default is exe; the actual value (if not null) is fed to the command line.
<br>See /target
*/
default is exe; the actual value (if not null) is fed to the command line.
<br>See /target
*/
protected String _targetType; protected String _targetType;
/** define the target /** define the target
* param target.
* @throws BuildException if target is not one of exe|library|module|winexe
* @param targetType one of exe|library|
* @exception BuildException if target is not one of exe|library|module|winexe
*/ */
public void setTargetType(String targetType) public void setTargetType(String targetType)
throws BuildException { throws BuildException {
targetType=targetType.toLowerCase(); targetType=targetType.toLowerCase();
if(targetType.equals("exe") || targetType.equals("library")) { if(targetType.equals("exe") || targetType.equals("library")) {
_targetType=targetType;
_targetType=targetType;
} }
else else
throw new BuildException("targetType " +targetType+" is not a valid type"); throw new BuildException("targetType " +targetType+" is not a valid type");
} }
/**
* accessor method for target type
* @return the current target option
*/
public String getTargetType() { public String getTargetType() {
return _targetType; return _targetType;
}
/** get the argument or null for no argument needed
*/
}
/** g
* get the target type or null for no argument needed
*
* @return The TargetTypeParameter value
*/
protected String getTargetTypeParameter() { protected String getTargetTypeParameter() {
if(!notEmpty(_targetType)) if(!notEmpty(_targetType))
@@ -305,72 +219,96 @@ public class Ilasm
if (_targetType.equals("exe")) if (_targetType.equals("exe"))
return "/exe"; return "/exe";
else else
if (_targetType.equals("library"))
return "/dll";
else
return null;
}
if (_targetType.equals("library"))
return "/dll";
else
return null;
}
//=============================================================================
/** owner string is a slightly trivial barrier to disassembly /** owner string is a slightly trivial barrier to disassembly
*/
*/
protected String _owner; protected String _owner;
/**
* Sets the Owner attribute
*
* @param s The new Owner value
*/
public void setOwner(String s) { public void setOwner(String s) {
_owner=s; _owner=s;
}
}
/**
* Gets the Owner switch for ilasm
*
* @return The Owner string
*/
protected String getOwnerParameter() { protected String getOwnerParameter() {
if(notEmpty(_owner)) if(notEmpty(_owner))
return "/owner="+_owner; return "/owner="+_owner;
else else
return null; return null;
} }
//=============================================================================
/** test for a string containing something useful /** test for a string containing something useful
* @param string to test * @param string to test
* @returns true if the argument is not null or empty * @returns true if the argument is not null or empty
*/
*/
protected boolean notEmpty(String s) protected boolean notEmpty(String s)
{return s!=null && s.length()!=0;}
//=============================================================================
{return s!=null && s.length()!=0;}
/** verbose flag /** verbose flag
*/ */
protected boolean _verbose; protected boolean _verbose;
/**
* enable/disable verbose ILASM output
* @param b flag set to true for verbose on
*/
public void setVerbose(boolean b) { public void setVerbose(boolean b) {
_verbose=b; _verbose=b;
} }
/**
* turn the verbose flag into a parameter for ILASM
* @return null or the appropriate command line string
*/
protected String getVerboseParameter() { protected String getVerboseParameter() {
return _verbose?null:"/quiet"; return _verbose?null:"/quiet";
} }
//=============================================================================
/** listing flag /** listing flag
*/ */
protected boolean _listing; protected boolean _listing;
/**
* enable/disable listing
* @param b flag set to true for listing on
*/
public void setListing(boolean b) { public void setListing(boolean b) {
_listing=b; _listing=b;
} }
/**
* turn the listing flag into a parameter for ILASM
* @return the appropriate string from the state of the listing flag
*/
protected String getListingParameter() { protected String getListingParameter() {
return _listing?"/listing":"/nolisting"; return _listing?"/listing":"/nolisting";
} }
//=============================================================================
/** output file. If not supplied this is derived from the
/**
* output file. If not supplied this is derived from the
* source file * source file
*/ */
protected String _outputFile; protected String _outputFile;
/** /**
* Set the definitions * Set the definitions
* @param list of definitions split by ; or , or even : * @param list of definitions split by ; or , or even :
@@ -378,89 +316,119 @@ public class Ilasm
public void setOutputFile(String params) { public void setOutputFile(String params) {
_outputFile=params; _outputFile=params;
} }
/** get the argument or null for no argument needed
*/
/**
* get the output file
* @return the argument string or null for no argument
*/
protected String getOutputFileParameter() { protected String getOutputFileParameter() {
if (_outputFile==null || _outputFile.length()==0) if (_outputFile==null || _outputFile.length()==0)
return null; return null;
File f=project.resolveFile(_outputFile); File f=project.resolveFile(_outputFile);
return "/output="+f.toString(); return "/output="+f.toString();
} }
//=============================================================================
/** resource file (.res format) to include in the app. /** resource file (.res format) to include in the app.
*/ */
protected String _resourceFile;
public void setResourceFile(String s) {
_resourceFile=s;
}
protected File _resourceFile;
/**
* Set the resource file
* @param fileName path to the file. Can be relative, absolute, whatever.
*/public void setResourceFile(String fileName) {
_resourceFile = project.resolveFile(fileName);
}
protected String getResourceFileParameter() { protected String getResourceFileParameter() {
if(notEmpty(_resourceFile)) {
return "/resource="+_resourceFile;
if(_resourceFile!=null ) {
return "/resource="+_resourceFile.toString() ;
} }
else
else {
return null; return null;
}
} }
//=============================================================================
/** flag to control action on execution trouble /** flag to control action on execution trouble
*/
*/
protected boolean _failOnError; protected boolean _failOnError;
/**set fail on error flag /**set fail on error flag
*/
*/
public void setFailOnError(boolean b){ public void setFailOnError(boolean b){
_failOnError=b; _failOnError=b;
} }
/** query fail on error flag /** query fail on error flag
*/
*/
public boolean getFailFailOnError() { public boolean getFailFailOnError() {
return _failOnError; return _failOnError;
} }
//=============================================================================
/** debug flag. Controls generation of debug information. /** debug flag. Controls generation of debug information.
*/ */
protected boolean _debug; protected boolean _debug;
/** set the debug flag on or off /** set the debug flag on or off
* @param on/off flag
* @param f on/off flag
*/ */
public void setDebug(boolean f) public void setDebug(boolean f)
{_debug=f;}
{_debug=f;}
/** query the debug flag /** query the debug flag
* @return true if debug is turned on * @return true if debug is turned on
*/ */
public boolean getDebug() { public boolean getDebug() {
return _debug; return _debug;
} }
/** get the argument or null for no argument needed /** get the argument or null for no argument needed
*/
*/
protected String getDebugParameter() { protected String getDebugParameter() {
return _debug?"/debug":null; return _debug?"/debug":null;
}
//=============================================================================
}
/** any extra command options?
*/
protected String _extraOptions;
/**
* Sets the ExtraOptions attribute
*
* @param extraOptions The new ExtraOptions value
*/
public void setExtraOptions(String extraOptions)
{this._extraOptions=extraOptions;}
/**
* Gets the ExtraOptions attribute
*
* @return The ExtraOptions value
*/
public String getExtraOptions()
{return this._extraOptions;}
/**
* get any extra options or null for no argument needed
*
* @return The ExtraOptions Parameter to CSC
*/
protected String getExtraOptionsParameter() {
if (_extraOptions!=null && _extraOptions.length()!=0)
return _extraOptions;
else
return null;
}
/** This is the execution entry point. Build a list of files and /** This is the execution entry point. Build a list of files and
* call ilasm on each of them. * call ilasm on each of them.
* @throws BuildException if the assembly failed and FailOnError is true
*/ */
public void execute() public void execute()
throws BuildException { throws BuildException {
if (_srcDir == null) if (_srcDir == null)
_srcDir=project.resolveFile(".");
_srcDir=project.resolveFile(".");
//get dependencies list. //get dependencies list.
DirectoryScanner scanner = super.getDirectoryScanner(_srcDir); DirectoryScanner scanner = super.getDirectoryScanner(_srcDir);
String[] dependencies = scanner.getIncludedFiles(); String[] dependencies = scanner.getIncludedFiles();
@@ -472,13 +440,15 @@ public class Ilasm
targetFile=baseDir+File.separator+targetFile; targetFile=baseDir+File.separator+targetFile;
executeOneFile(targetFile); executeOneFile(targetFile);
} }
} // end execute } // end execute
//=============================================================================
/** do the work by building the command line and then calling it
/**
* do the work for one file by building the command line then calling it
* @param targetFile name of the the file to assemble
* @throws BuildException if the assembly failed and FailOnError is true
*/ */
public void executeOneFile(String targetFile) public void executeOneFile(String targetFile)
throws BuildException { throws BuildException {
NetCommand command=new NetCommand(this,exe_title,exe_name); NetCommand command=new NetCommand(this,exe_title,exe_name);
@@ -493,8 +463,9 @@ public class Ilasm
command.addArgument(getOwnerParameter()); command.addArgument(getOwnerParameter());
command.addArgument(getResourceFileParameter()); command.addArgument(getResourceFileParameter());
command.addArgument(getVerboseParameter()); command.addArgument(getVerboseParameter());
command.addArgument(getExtraOptionsParameter());
/* space for more argumentativeness /* space for more argumentativeness
command.addArgument(); command.addArgument();
command.addArgument(); command.addArgument();
Stefan Bodewig