|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object | +--org.apache.tools.ant.ProjectComponent | +--org.apache.tools.ant.Task | +--org.apache.tools.ant.taskdefs.MatchingTask | +--org.apache.tools.ant.taskdefs.FixCRLF
Task to convert text source files to local OS formatting conventions, as well as repair text files damaged by misconfigured or misguided editors or file transfer programs.
This task can take the following arguments:
When this task executes, it will scan the srcdir based on the include and exclude properties.
This version generalises the handling of EOL characters, and allows for CR-only line endings (which I suspect is the standard on Macs.) Tab handling has also been generalised to accommodate any tabwidth from 2 to 80, inclusive. Importantly, it will leave untouched any literal TAB characters embedded within string or character constants.
Warning: do not run on binary files. Caution: run with care on carefully formatted files. This may sound obvious, but if you don't specify asis, presume that your files are going to be modified. If "tabs" is "add" or "remove", whitespace characters may be added or removed as necessary. Similarly, for CR's - in fact "eol"="crlf" or cr="add" can result in cr characters being removed in one special case accommodated, i.e., CRCRLF is regarded as a single EOL to handle cases where other programs have converted CRLF into CRCRLF.
Inner Class Summary | |
static class |
FixCRLF.AddAsisRemove
Enumerated attribute with the values "asis", "add" and "remove". |
static class |
FixCRLF.CrLf
Enumerated attribute with the values "asis", "cr", "lf" and "crlf". |
Fields inherited from class org.apache.tools.ant.taskdefs.MatchingTask |
fileset, useDefaultExcludes |
Fields inherited from class org.apache.tools.ant.Task |
description, location, target, taskName, taskType, wrapper |
Fields inherited from class org.apache.tools.ant.ProjectComponent |
project |
Constructor Summary | |
FixCRLF()
Defaults the properties based on the system type. |
Method Summary | |
void |
execute()
Executes the task. |
void |
setCr(FixCRLF.AddAsisRemove attr)
Deprecated. use setEol instead. |
void |
setDestdir(java.io.File destDir)
Set the destination where the fixed files should be placed. |
void |
setEof(FixCRLF.AddAsisRemove attr)
Specify how DOS EOF (control-z) charaters are to be handled |
void |
setEol(FixCRLF.CrLf attr)
Specify how EndOfLine characters are to be handled |
void |
setJavafiles(boolean javafiles)
Fixing Java source files? |
void |
setSrcdir(java.io.File srcDir)
Set the source dir to find the source text files. |
void |
setTab(FixCRLF.AddAsisRemove attr)
Specify how tab characters are to be handled |
void |
setTablength(int tlength)
Specify tab length in characters |
Methods inherited from class org.apache.tools.ant.taskdefs.MatchingTask |
createExclude, createExcludesFile, createInclude, createIncludesFile, createPatternSet, getDirectoryScanner, setDefaultexcludes, setExcludes, setExcludesfile, setIncludes, setIncludesfile, XsetIgnore, XsetItems |
Methods inherited from class org.apache.tools.ant.Task |
getDescription, getLocation, getOwningTarget, getRuntimeConfigurableWrapper, getTaskName, handleErrorOutput, handleOutput, init, log, log, maybeConfigure, perform, setDescription, setLocation, setOwningTarget, setRuntimeConfigurableWrapper, setTaskName |
Methods inherited from class org.apache.tools.ant.ProjectComponent |
getProject, setProject |
Methods inherited from class java.lang.Object |
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Constructor Detail |
public FixCRLF()
Method Detail |
public void setSrcdir(java.io.File srcDir)
public void setDestdir(java.io.File destDir)
public void setJavafiles(boolean javafiles)
public void setEol(FixCRLF.CrLf attr)
option
- valid values:
public void setCr(FixCRLF.AddAsisRemove attr)
setEol
instead.
option
- valid values:
public void setTab(FixCRLF.AddAsisRemove attr)
option
- valid values:
public void setTablength(int tlength) throws BuildException
tlength
- specify the length of tab in spaces,public void setEof(FixCRLF.AddAsisRemove attr)
option
- valid values:
public void execute() throws BuildException
execute
in class Task
org.apache.tools.ant.Task
BuildException
- if someting goes wrong with the build
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |