FixCRLF

Description

説明

Adjusts a text file to local conventions.

テキストファイルをローカルの慣例に合わせて調整します。

The set of files to be adjusted can be refined with the includes, includesfile, excludes, excludesfile and defaultexcludes attributes. Patterns provided through the includes or includesfile attributes specify files to be included. Patterns provided through the exclude or excludesfile attribute specify files to be excluded. Additionally, default exclusions can be specified with the defaultexcludes attribute. See the section on directory based tasks, for details of file inclusion/exclusion patterns and their usage.

調整されるファイルのセットは includesincludesfileexcludesexcludesfile そして defaultexcludes 属性によって改善されます。 includesincludesfile 属性で与えられたパターンで、含まれるファイルを指定します。 excludeexcludesfile 属性で与えられたパターンで、除かれるファイルを指定します。 加えて、デフォルト除外集合は defaultexcludes 属性で指定することができます。 ファイルの包含/排除パターンとその使い方の詳細は directory based tasks を参照して下さい。

This task forms an implicit FileSet and supports all attributes of <fileset> (dir becomes srcdir) as well as the nested <include>, <exclude> and <patternset> elements.

このタスクは暗黙の FileSet を作成し、 <fileset>dirsrcdir になります) の全ての属性はもちろん、 ネストされた <include><exclude><patternset> 要素をサポートします。

The output file is only written if it is a new file, or if it differs from the existing file. This prevents spurious rebuilds based on unchanged files which have been regenerated by this task.

出力ファイルはそれが新しいファイルか、存在しているファイルと異なる場合に書き込まれます。 これは、このタスクによって再生成された、未変更のファイルによるいいかげんなリビルドを防ぎます。

Parameters

パラメータ

Attribute Description Required
srcDir Where to find the files to be fixed up. Yes
destDir Where to place the corrected files. Defaults to srcDir (replacing the original file) No
includes comma- or space-separated list of patterns of files that must be included. All files are included when omitted. No
includesfile the name of a file. Each line of this file is taken to be an include pattern No
excludes comma- or space-separated list of patterns of files that must be excluded. No files (except default excludes) are excluded when omitted. No
excludesfile the name of a file. Each line of this file is taken to be an exclude pattern No
defaultexcludes indicates whether default excludes should be used or not ("yes"/"no"). Default excludes are used when omitted. No
eol Specifies how end-of-line (EOL) characters are to be handled. The EOL characters are CR, LF and the pair CRLF. Valid values for this property are:
  • asis: leave EOL characters alone
  • cr: convert all EOLs to a single CR
  • lf: convert all EOLs to a single LF
  • crlf: convert all EOLs to the pair CRLF
Default is based on the platform on which you are running this task. For Unix platforms, the default is "lf". For DOS based systems (including Windows), the default is "crlf". For Mac OS, the default is "cr".

This is the preferred method for specifying EOL. The "cr" attribute (see below) is now deprecated.

N.B.: One special case is recognized. The three characters CR-CR-LF are regarded as a single EOL. Unless this property is specified as "asis", this sequence will be converted into the specified EOL type.

No
cr Deprecated. Specifies how CR characters are to be handled at end-of-line (EOL). Valid values for this property are:
  • asis: leave EOL characters alone.
  • add: add a CR before any single LF characters. The intent is to convert all EOLs to the pair CRLF.
  • remove: remove all CRs from the file. The intent is to convert all EOLs to a single LF.
Default is based on the platform on which you are running this task. For Unix platforms, the default is "remove". For DOS based systems (including Windows), the default is "add".

N.B.: One special case is recognized. The three characters CR-CR-LF are regarded as a single EOL. Unless this property is specified as "asis", this sequence will be converted into the specified EOL type.

No
javafiles Used only in association with the "tab" attribute (see below), this boolean attribute indicates whether the fileset is a set of java source files ("yes"/"no"). Defaults to "no". See notes in section on "tab". No
tab Specifies how tab characters are to be handled. Valid values for this property are:
  • add: convert sequences of spaces which span a tab stop to tabs
  • asis: leave tab and space characters alone
  • remove: convert tabs to spaces
Default for this parameter is "asis".

N.B.: When the attribute "javafiles" (see above) is "true", literal TAB characters occurring within Java string or character constants are never modified. This functionality also requires the recognition of Java-style comments.

N.B.: There is an incompatibility between this and the previous version in the handling of white space at the end of lines. This version does not remove trailing whitespace on lines.

No
tablength TAB character interval. Valid values are between 2 and 80 inclusive. The default for this parameter is 8. No
eof Specifies how DOS end of file (control-Z) characters are to be handled. Valid values for this property are:
  • add: ensure that there is an EOF character at the end of the file
  • asis: leave EOF characters alone
  • remove: remove any EOF character found at the end
Default is based on the platform on which you are running this task. For Unix platforms, the default is remove. For DOS based systems (including Windows), the default is asis.
No
encoding The encoding of the files No - defaults to default JVM encoding
属性 説明 必須
srcDir 修正するファイルを見つける場所です。 Yes
destDir 修正したファイルを保存する場所です。 デフォルトは srcDir です(オリジナルファイルを置き換えます)。 No
includes 包含すべきファイルのパターンのカンマまたはスペースで区切られたリスト。 省略された場合、すべてのファイルが含まれます。 No
includesfile ファイル名です。このファイルの各行は包含パターンとして解釈されます。 No
excludes 除外すべきファイルのパターンのカンマまたはスペースで区切られたリスト。 省略された場合、除外されるファイルは(デフォルト除外集合以外は)ありません。 No
excludesfile ファイル名です。このファイルの各行は除外パターンとして解釈されます。 No
defaultexcludes デフォルト除外集合が使われるかどうか("yes"/"no")を示します。 省略した場合、デフォルト除外集合が使われます。 No
eol ラインの終了の文字 (EOL) がどのように扱われるか指定します。 EOL 文字とは CR、LF および CRLF のペアです。 このプロパティの有効な値は次の通りです :
  • asis: EOL 文字をそのままにしておきます。
  • cr: すべての EOL を単一の CR に変換します。
  • lf: すべての EOL を単一の LF に変換します。
  • crlf: すべての EOL を CRLF のペアに変換します。
デフォルトは、このタスクを実行しているプラットフォームに基づきます。 Unix プラットフォームでは、デフォルトは "lf" です。 DOS ベースのシステム( Windows を含む)では、デフォルトは "crlf" です。 Mac OS では、デフォルトは "cr" です。

これは EOL を指定する好ましい方法です。 "cr" 属性(以下を参照)は現在非推奨です。

注意 : 一つ特別なケースが認識されています。 3文字の CR-CR-LF は、単一の EOL と見なされます。 もしこのプロパティが "asis" に指定されなければ、 このシーケンスは指定された EOL タイプに変換されるでしょう。

No
cr 非推奨。 CR 文字が行の終わり (EOL) にどのように扱われるか指定します。 このプロパティの有効な値は次の通りです:
  • asis: EOL 文字をそのままにしておきます。
  • add: 任意の単一の LF 文字の前に CR を加えます。 この意図は EOL をすべて CRLF のペアに変換することです。
  • remove: ファイルからすべての CR を削除します。 この意図は EOL をすべて単一の LF に変換することです。
デフォルトは、このタスクを実行しているプラットフォームに基づきます。 Unix プラットフォームでは、デフォルトは "remove" です。 DOS ベースのシステム( Windows を含む)では、デフォルトは "add" です。

注意 : 一つ特別なケースが認識されてます。 3文字の CR-CR-LF は、単一の EOL と見なされます。 もしこのプロパティが "asis" として指定されなければ、 このシーケンスは指定された EOL タイプに変換されるでしょう。

No
javafiles "tab" 属性(以下を参照)の中でのみ使用されます。 このブールの属性は、ファイルセットが java ソースファイルのセットかどうか ("yes"/"no" で)示します。 デフォルトは "no" です。 "tab" のセクションで注意を参照して下さい。 No
tab タブ文字がどのよう扱われるか指定します。 このプロパティの有効な値は次のとおりです:
  • add: タブストップを展開した連続したスペースをタブに変換します。
  • asis: タブとスペース文字をそのままにしておきます。
  • remove: タブをスペースに変換します。
このパラメータのデフォルトは "asis" です。

注意: "javafiles" 属性(上記参照)が "true" の場合、Java の文字列か文字定数内のリテラルな TAB 文字は修正されません。 この機能性は、さらに Java スタイルコメントの認識を要求します。

注意: 行の終わりの余白の取り扱いで前のバージョンとの間に非互換性があります。 このバージョンは、行を引きずる余白を削除しません

No
tablength TAB 文字の間隔です。有効な値は先頭と終わりを含めた2と80の間です。 デフォルトのパラメータは8です。 No
eof DOS のファイル終端文字 (control-Z) がどのように扱われるかを指定します。 このプロパティの有効な値は次のとおりです:
  • add: EOF 文字がファイルの最後にあることを保証します。
  • asis: EOF 文字をそのままにしておきます。
  • remove: 終わりで見つけられたどんな EOF 文字も削除します。
デフォルトは、このタスクを実行しているプラットフォームに基づきます。 Unix プラットフォームでは、デフォルトは remove です。 DOS ベースのシステム(Windows を含む)では、デフォルトは asis です。
No
encoding ファイルのエンコーディングです。 No - デフォルトはデフォルト JVM のエンコードです。

Examples

  <fixcrlf srcdir="${src}"
       eol="lf" eof="remove"
       includes="**/*.sh"
  />

Replaces EOLs with LF characters and removes eof characters from the shell scripts. Tabs and spaces are left as is.

シェルスクリプトの EOL を LF 文字に置換して、 eof 文字を取り除きます。 タブとスペースはそのまま残されます。

  <fixcrlf srcdir="${src}"
       eol="crlf"
       includes="**/*.bat"
  />

Replaces all EOLs with cr-lf pairs in the batch files. Tabs and spaces are left as is. EOF characters are left alone if run on DOS systems, and are removed if run on Unix systems.

バッチファイル中のすべての EOL を、cr-lf に置換します。 タブとスペースはそのまま残されます。 DOS システム上で実行されれば、EOF 文字はそのままにしておかれ、Unix システム上で実行されれば削除されます。

  <fixcrlf srcdir="${src}"
       tabs="add"
       includes="**/Makefile"
  />

Sets EOLs according to local OS conventions, and converts sequences of spaces and tabs to the minimal set of spaces and tabs which will maintain spacing within the line. Tabs are set at 8 character intervals. EOF characters are left alone if run on DOS systems, and are removed if run on Unix systems. Many versions of make require tabs prior to commands.

ローカルの OS の慣例によって EOL をセットし、連続したスペースとタブを、行の間隔を維持するスペースおよびタブの最小のセットに変換します。 タブは8文字の間隔でセットされます。 DOS システム上で実行されれば、EOF 文字はそのまま残され、Unix システム上で実行されれば削除されます。 make の多くのバージョンが、コマンドよりタブを優先することを要求します。

  <fixcrlf srcdir="${src}"
       tabs="remove"
       tablength="3"
       eol="lf"
       javafiles="yes"
       includes="**/*.java"
  />

Converts all EOLs in the included java source files to a single LF. Replace all TAB characters except those in string or character constants with spaces, assuming a tab width of 3. If run on a unix system, any CTRL-Z EOF characters at the end of the file are removed. On DOS/Windows, any such EOF characters will be left untouched.

javaソースファイルに含まれたEOLをすべて単一のLFに変換します。 タブの幅を3と仮定して、文字列または文字定数中のもの以外の TAB 文字をすべてスペースに置換します。 もしunixシステム上で実行されれば、ファイルの終端のどんなCTRL-Z EOF文字も削除されます。 DOS/Windows においては、どんなEOF文字も手つかずで残されるでしょう。

  <fixcrlf srcdir="${src}"
       tabs="remove"
       includes="**/README*"
  />

Sets EOLs according to local OS conventions, and converts all tabs to spaces, assuming a tab width of 8. EOF characters are left alone if run on DOS systems, and are removed if run on Unix systems. You never know what editor a user will use to browse README's.

ローカルの OS の慣例によって EOL をセットし、タブ幅を8と仮定して、タブをすべてスペースに置換します。 DOS システム上で実行されれば、EOF 文字はそのまま残され、Unix システム上で実行されれば削除されます。 あなたはユーザがREADMEを閲覧するためにどんなエディタを使うか知りません。


Copyright © 2000-2002 Apache Software Foundation. All rights Reserved.

[訳注:これは高崎 俊史が翻訳しました。日本語訳に対するコメントがあれば report@jajakarta.orgに送ってください]