org.apache.tools.ant.taskdefs

Class FixCRLF

Implemented Interfaces:
SelectorContainer

public class FixCRLF
extends MatchingTask

Converts 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:

Of these arguments, only sourcedir is required.

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.

Since:
Ant 1.1

Nested 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".

Field Summary

Fields inherited from class org.apache.tools.ant.taskdefs.MatchingTask

fileset

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(File destDir)
Set the destination where the fixed files should be placed.
void
setEncoding(String encoding)
Specifies the encoding Ant expects the files to be in - defaults to the platforms default encoding.
void
setEof(FixCRLF.AddAsisRemove attr)
Specify how DOS EOF (control-z) characters are to be handled.
void
setEol(FixCRLF.CrLf attr)
Specify how EndOfLine characters are to be handled.
void
setFixlast(boolean fixlast)
Specify whether a missing EOL will be added to the final line of a file.
void
setJavafiles(boolean javafiles)
Set to true if modifying Java source files.
void
setSrcdir(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

XsetIgnore, XsetItems, add, addAnd, addContains, addContainsRegexp, addCustom, addDate, addDepend, addDepth, addDifferent, addFilename, addMajority, addModified, addNone, addNot, addOr, addPresent, addSelector, addSize, addType, appendSelector, createExclude, createExcludesFile, createInclude, createIncludesFile, createPatternSet, getDirectoryScanner, getImplicitFileSet, getSelectors, hasSelectors, selectorCount, selectorElements, setCaseSensitive, setDefaultexcludes, setExcludes, setExcludesfile, setFollowSymlinks, setIncludes, setIncludesfile, setProject

Methods inherited from class org.apache.tools.ant.Task

execute, getDescription, getLocation, getOwningTarget, getRuntimeConfigurableWrapper, getTaskName, getTaskType, getWrapper, handleErrorFlush, handleErrorOutput, handleFlush, handleInput, handleOutput, init, isInvalid, log, log, maybeConfigure, perform, reconfigure, setDescription, setLocation, setOwningTarget, setRuntimeConfigurableWrapper, setTaskName, setTaskType

Methods inherited from class org.apache.tools.ant.ProjectComponent

getProject, log, log, setProject

Constructor Details

FixCRLF

public FixCRLF()
Defaults the properties based on the system type.
  • Unix: eol="LF" tab="asis" eof="remove"
  • Mac: eol="CR" tab="asis" eof="remove"
  • DOS: eol="CRLF" tab="asis" eof="asis"

Method Details

execute

public void execute()
            throws BuildException
Executes the task.
Overrides:
execute in interface Task

setCr

public void setCr(FixCRLF.AddAsisRemove attr)

Deprecated. use setEol instead.

Specify how carriage return (CR) characters are to be handled.
Parameters:
attr - valid values:
  • add: ensure that there is a CR before every LF
  • asis: leave CR characters alone
  • remove: remove all CR characters

setDestdir

public void setDestdir(File destDir)
Set the destination where the fixed files should be placed. Default is to replace the original file.

setEncoding

public void setEncoding(String encoding)
Specifies the encoding Ant expects the files to be in - defaults to the platforms default encoding.

setEof

public void setEof(FixCRLF.AddAsisRemove attr)
Specify how DOS EOF (control-z) characters are to be handled.
Parameters:
attr - valid values:
  • add: ensure that there is an eof at the end of the file
  • asis: leave eof characters alone
  • remove: remove any eof character found at the end

setEol

public void setEol(FixCRLF.CrLf attr)
Specify how EndOfLine characters are to be handled.
Parameters:
attr - valid values:
  • asis: leave line endings alone
  • cr: convert line endings to CR
  • lf: convert line endings to LF
  • crlf: convert line endings to CRLF

setFixlast

public void setFixlast(boolean fixlast)
Specify whether a missing EOL will be added to the final line of a file.

setJavafiles

public void setJavafiles(boolean javafiles)
Set to true if modifying Java source files.

setSrcdir

public void setSrcdir(File srcDir)
Set the source dir to find the source text files.

setTab

public void setTab(FixCRLF.AddAsisRemove attr)
Specify how tab characters are to be handled.
Parameters:
attr - valid values:
  • add: convert sequences of spaces which span a tab stop to tabs
  • asis: leave tab and space characters alone
  • remove: convert tabs to spaces

setTablength

public void setTablength(int tlength)
            throws BuildException
Specify tab length in characters.
Parameters:
tlength - specify the length of tab in spaces,

Copyright B) 2000-2008 Apache Software Foundation. All Rights Reserved.