S-JIS[2009-01-31/2009-02-21] 変更履歴

htlexタスク

HtHtmlLexerを使った、HTMLファイルを操作（検索・置換）するAntタスクです。 （アーカイブ→HtHtmlLexerのhtlexer.jarの中に含まれている）

使用方法

「<meta http-equiv="Content-Type" content="〜">」というタグを持つHTMLファイルをUTF-8に変換する例です。

build.xml：

<?xml version="1.0" encoding="Shift_JIS"?>
<project name="HtHtmlLexer sample" basedir=".">
	<typedef resource="htlex.typedef.properties" classpath="htlexer.jar" />

	<property name="html"  location="C:\temp\lexer\from" />
	<property name="todir" location="C:\temp\lexer\to" />

	<target name="change_utf8">
		<htlex todir="${todir}">
			<fileset dir="${html}">
				<include name="**/*.html" />
			</fileset>
			<htconv encoding="MS932" outputEncoding="UTF-8" logWriteFile="info">
				<ctag name="meta">
					<cattr name="http-equiv" value="Content-Type" />
					<newtag>
						<repattr name="content" newValue="text/html;charset=utf-8" />
					</newtag>
				</ctag>
			</htconv>
		</htlex>
	</target>
</project>

まず、htlex用タグを使う為に、typedefによってタグ名を定義する必要があります。
htlexer.jarはJDK1.6でコンパイルしている為、JRE1.6以降でないと動きません。（アーカイブ→htlexer.jar）
なお、動作確認はAnt1.7で行っています。

htlexタグにはファイル出力先のディレクトリーを指定します。省略時は読み込んだファイルに上書きします。
読み込むファイルはfilesetによって指定します。

htconvタグには文字コード（エンコーディング）・ログ出力の設定を行います。

ctagタグには、条件判断・変換を行うタグを指定します。
cattrタグには、条件判断を行う属性を指定します。
これらの条件に一致した場合、newtagタグによる置換が行われます。

newtagタグは、置換する値を指定する印です。
repattrタグは、属性を置換する指定です。

上記の例では、ctagタグにname="meta"とあるので、タグ名が「meta」であるタグが判断対象（および変更対象）となります。
そしてcattrタグにname="http-equiv"とvalue="Content-Type"の指定があるので、「http-equiv="Content-Type"」という属性を持っている場合だけ変更対象となります。
この条件判断はデフォルトでは大文字小文字を無視します。

条件が合致した場合、newtagタグによる変換を行います。
repattrタグにname="content"とあるので、属性名がcontent、すなわち「content="〜"」という属性が実際に置換される属性です。
newValueの指定があるので、contentの属性値がnewValueの値に置き換わります。

htconvデータタイプが実際のファイル出力を行います。デフォルトでは、（newtagタグ等によって）何らかの変更が無い場合は出力しません。
上記の例ではoutputEncodingを指定しているので文字コードを変換して出力しますが、
「<meta http-equiv="Content-Type" content="〜">」というタグが書かれていなかったHTMLファイルは 置換が行われないので、出力対象になりません。
forceをtrueにすれば、変更有無に関わらず常に出力されます。

htlexの説明

HtHtmlLexerを使った、HTMLファイルを操作（検索・置換）するタスクです。
（対象ファイル一覧の生成を担当しています）

パラメータ

ネストする要素として指定されるパラメータ

• fileset … 読み込むHTMLファイル
• htconv … 変換条件や変換値を指定する

htconvの説明

HTMLファイルの変換方法を指定するデータタイプです。
（実際のファイル読み込み・HtHtmlLexer呼び出し・ファイル書き込みを行います）

パラメータ

ネストする要素として指定されるパラメータ

• ctag … タグの検索条件・変換内容の指定
• ctext … テキストの検索条件・変換内容の指定

ctagの説明

タグの検索条件を指定するデータタイプです。

パラメータ

マッチ条件を一つも指定しない場合は、タグに関しては常にマッチした扱いになります。（全ての開始タグ・終了タグにマッチする）
name以外のマッチ条件は、equals（完全一致）で比較されます。
→ctagの使用例

ネストする要素として指定されるパラメータ

• cattr … 属性のマッチ条件
• and,or,not … cattrを内包するCondition
• newtag … 変換内容の指定

cattr（およびand,or,not）を複数書いた場合は、andタグで囲まれているものとして扱われます。
→and条件の使用例
→not条件の使用例

cattrの説明

属性の検索条件を指定するデータタイプです。

パラメータ

マッチ条件を一つも指定しない場合はエラーとなります。
name,value以外のマッチ条件は、equals（完全一致）で比較されます。
→cattrの使用例

ネストする要素として指定されるパラメータ

なし。

newtagの説明

タグの変換内容を指定するデータタイプです。

パラメータ

変換値・変換方法を一つも指定しない場合は、タグに関しては何も変更しません。
（newNameCase以外の）変換値は、その値全体を上書きします。
→newtagの使用例

ネストする要素として指定されるパラメータ

• addattr … 属性を追加する指定

• repattr … 属性を置換する指定

• delattr … 属性を削除する指定

addattrの説明

属性を追加するデータタイプです。

パラメータ

→addattrの使用例

ネストする要素として指定されるパラメータ

なし。

repattrの説明

属性を置換するデータタイプです。

パラメータ

→repattrの使用例

ネストする要素として指定されるパラメータ

なし。

delattrの説明

属性を削除するデータタイプです。

パラメータ

→delattrの使用例

ネストする要素として指定されるパラメータ

なし。

ctextの説明

テキストの検索条件・置換内容を指定するデータタイプです。

パラメータ

→ctextの使用例

ネストする要素として指定されるパラメータ

• text … ボディー部に、マッチ条件となる文字列を指定する。
• newtext … ボディー部に、置換先の文字列を指定する。

newText属性またはnewtext要素が指定された場合は、マッチしたテキストに対して置換を行います。

サンプル

変換内容を確認する例

変更前に内容確認（ログ出力）だけ行う例です。[2009-02-08]

	<target name="backup">
		<htlex>
			<fileset dir="C:\temp\lexer\from">
				<include name="**/*.html" />
			</fileset>
			<htconv encoding="MS932" logConvert="info" logWriteFile="warning" noWrite="true">
				<ctag name="b">
					<newtag newName="strong" />
				</ctag>
				<ctag name="i">
					<newtag newName="em" />
				</ctag>
			</htconv>
		</htlex>
	</target>

バックアップの例

変更前の内容をディレクトリー（名前に日付時刻を使用）にバックアップしつつ変換する例です。[2009-02-08]
（変換自体は読み込んだファイルに上書きされます）

	<target name="backup">
		<tstamp>
			<format property="bak.dir" pattern="yyyyMMdd_HHmmss" />
		</tstamp>

		<htlex backupdir="C:\temp\lexer\bak\${bak.dir}">
			<fileset dir="C:\temp\lexer\from">
				<include name="**/*.html" />
			</fileset>
			<htconv encoding="MS932" logConvert="info" logWriteFile="warning">
				<ctag name="b">
					<newtag newName="strong" />
				</ctag>
				<ctag name="i">
					<newtag newName="em" />
				</ctag>
			</htconv>
		</htlex>
	</target>

HtHtmlParserの例

HtHtmlParserを使って変換を出来るようになりました。[2009-02-21]
HtHtmlLexerのみの場合、タグ単独でしか条件を指定できませんが、HtHtmlParserでは開始タグと終了タグのペアを作るので、ペアに対して条件指定できます。

が、HtHtmlParserは万能には程遠いので(汗)、まずはHtHtmlParserで解釈し切れなかったタグを表示してみます。（解釈に失敗する可能性が一番高いのは、タグのペアがきちんと対応付けられていない場合だと思われるので）

	<target name="parse dumpNotFix">
		<htlex>
			<fileset dir="C:\temp\lexer\from">
				<include name="**/*.html" />
			</fileset>
			<htconv encoding="MS932" dumpParseNotFix="warn" />
		</htlex>
	</target>

HtHtmlParserの機能を使用する為には、useParser属性をtrueにする必要があります。
が、dumpParseNotFixの様にHtHtmlParserの機能を使用するオプションを指定すると、自動的にuseParser属性はtrueになります。

なお、dumpParseNotFixの場合、HtElementUtil#dumpNotFix()の結果を出力しているだけです。