第055回_EntityDecl_前回の補足_置換テキストの構築_定義済み実体

-EntityValueの処理
2.一般実体の参照を認識したとき
2-1.実体名をキーに一般実体テーブルを検索する
2-2.実体名がテーブルに無い場合
　仕様なし
2-3.実体名がテーブルに有る場合
2-3-1.実体が内部・解析対象・一般実体または、外部・解析対象・一般実体の場合
2-3-1-1.バイパスする(何もしない)
2-3-2.その他(外部・解析対象外・一般実体)の場合
　エラーとする

2.一般実体参照を認識したとき
2-1.参照名を参照チェックテーブルに登録する
2-2.バイパスする(何もしない)

1.参照チェックテーブルの実体名を一般実体テーブルから取得する
2.取得した一般実体が未定義の場合
2-1.何もしない(参照が呼び出されたときにエラーになる、もし呼び出しがなければエラーにはならない)
3.取得した一般実体が定義済みの場合
3-1.取得した一般実体が外部・解析対象外・一般実体の場合
3-1-1.エラー(4.4.9に対応、呼び出しがなくてもエラーにする)
3-2.取得した一般実体が外部・解析対象外・一般実体でない場合
3-2-1.何もしない

4.5 Construction of Entity Replacement Text

In discussing the treatment of entities, it is useful to distinguish two forms of the entity's value. [Definition: For an internal entity, the literal entity value is the quoted string actually present in the entity declaration, corresponding to the non-terminal EntityValue.] [Definition: For an external entity, the literal entity value is the exact text contained in the entity.] [Definition: For an internal entity, the replacement text is the content of the entity, after replacement of character references and parameter-entity references.] [Definition: For an external entity, the replacement text is the content of the entity, after stripping the text declaration (leaving any surrounding white space) if there is one but without any replacement of character references or parameter-entity references.]

The literal entity value as given in an internal entity declaration (EntityValue) may contain character, parameter-entity, and general-entity references. Such references must be contained entirely within the literal entity value. The actual replacement text that is included (or included in literal) as described above must contain the replacement text of any parameter entities referred to, and must contain the character referred to, in place of any character references in the literal entity value; however, general-entity references must be left as-is, unexpanded. For example, given the following declarations:

<!ENTITY % pub "Éditions Gallimard" >
<!ENTITY 　rights "All rights reserved" >
<!ENTITY 　book "La Peste: Albert Camus,
© 1947 %pub;. &rights;" >

then the replacement text for the entity "book" is:

La Peste: Albert Camus,
© 1947 Éditions Gallimard. &rights;

The general-entity reference "&rights;" would be expanded should the reference "&book;" appear in the document's content or an attribute value.

These simple rules may have complex interactions; for a detailed discussion of a difficult example, see C Expansion of Entity and Character References.

4.5 実体の置換テキストの構築

実体の取り扱いについて論じる際、 実体値の2つの形態を区別すると便利である。
定義: 内部実体について
リテラル実体値は実体宣言中に実際に存在する引用符で囲われた文字列とする。
リテラル実体値は(内部実体の)非終端EntityValueに対応したものとする。

定義: 外部実体について、リテラル実体値は実体が含んだテキストそのものとする。
定義: 内部実体について、置換テキストは文字参照とパラメータ実体参照を置換した後のその実体の内容である。
定義: 外部実体について、置換テキストはテキスト宣言を取り去った後の実体の内容である。
(両端のホワイトスペースはそのまま残す。)
もし文字参照やパラメータ実体参照が置換テキスト中にあってもそのままにする。

内部実体宣言中のリテラル実体値(EntityValue)は、文字参照、パラメータ実体、一般実体参照を含むことができる。それらの参照は、リテラル実体値の中に完全に含まれる必要がある。インクルードした、(もしくはリテラルの中でインクルードした)実際の置換テキストは、上記で説明したように、すべてのパラメータ実体の参照した置換テキストを含む。リテラル実体値中の文字参照に参照した文字を含む。しかしながら、一般実体参照は展開されないままにしておかなければならない。例えば、次のような宣言があるとする。

<!ENTITY % pub "Éditions Gallimard" >
<!ENTITY 　rights "All rights reserved" >
<!ENTITY 　book "La Peste: Albert Camus,
© 1947 %pub;. &rights;" >

この時、実体"book"の置換テキストは;

La Peste: Albert Camus,
© 1947 Éditions Gallimard. &rights;

一般実体参照の "&rights;" を展開するのは "&book;"の参照が文書の内容または属性値として現れた場合となる。

これらの簡単な規則は、複雑な相互作用をもたらすことがある;
難しい例をつかった詳しい議論は、C 実体参照と文字参照の展開 を参照せよ。

EntityValueで示す文字列の両端の引用符を外したものをリテラル実体値と呼びます。
一般実体テーブルまたはパラメータ実体テーブルのKeyに対応する値は置換テキストと呼びます。
つまり、
となります。

4.6 Predefined Entities

[Definition: Entity and character references may both be used to escape the left angle bracket, ampersand, and other delimiters. A set of general entities (amp, lt, gt, apos, quot) is specified for this purpose. Numeric character references may also be used; they are expanded immediately when recognized and must be treated as character data, so the numeric character references "<" and "&" may be used to escape < and & when they occur in character data.]

All XML processors must recognize these entities whether they are declared or not. For interoperability, valid XML documents should declare these entities, like any others, before using them. If the entities lt or amp are declared, they must be declared as internal entities whose replacement text is a character reference to the respective character (less-than sign or ampersand) being escaped; the double escaping is required for these entities so that references to them produce a well-formed result. If the entities gt, apos, or quot are declared, they must be declared as internal entities whose replacement text is the single character being escaped (or a character reference to that character; the double escaping here is optional but harmless). For example:

<!ENTITY lt "&#38;#60;">
<!ENTITY gt "&#62;">
<!ENTITY amp "&#38;#38;">
<!ENTITY apos "&#39;">
<!ENTITY quot "&#34;">

4.6 定義済み実体

[定義: 実体参照と文字参照を始め山括弧(小なり)やアンパサンド、またその他の区切り子をエスケープするために
使うことができる。一般実体のセット(amp, lt, gt, apos, quot)はこの目的のために定められたものである。
数値文字参照を使うこともできる。数値文字参照は認識されたときに直ちに展開し、文字データとして扱わなければ
ならない。よって、"<" と "&" の文字参照は、<と&を文字データとして扱いたいときにエスケープするため
に使われる。]

すべてのXMLプロセッサは、これらが宣言してるかいないかに関わらず、その実体を認識しなければならない。相互運用性のために、妥当なXML文書はこれらの実体を他の実体と同じように、その参照を使う前に、宣言すべきである。もし、ltやampの実体を宣言した場合、置換テキストはエスケープされたそれぞれの文字(小なり記号やアンパサンド)への文字参照となる内部実体として宣言されなければいけない; それらへの参照が整形式の結果を得るために二重のエスケープが必要となる。もし、gtやaposやquotの実体を宣言した場合、置換テキストはエスケープされた1つの文字として宣言しなければならない。(もしくは、その文字への文字参照として宣言しなければならない。; 二重エスケープは任意であるが、無害である。)
次に例を示す。

<!ENTITY lt "&#38;#60;">
<!ENTITY gt "&#62;">
<!ENTITY amp "&#38;#38;">
<!ENTITY apos "&#39;">
<!ENTITY quot "&#34;">

---------------実体値テーブル---------------
---------------実体値テーブル---------------

---------------実体値テーブル---------------
---------------実体値テーブル---------------

定義済み実体を再定義する場合、「それぞれ該当の文字として定義しなければならない」とありますから、

とすればわかるように、置換テキストの値が上記でなければエラーにします。

4.2 実体宣言で述べたように、実体宣言で同じ名前の実体名を複数回宣言した場合は最初の実体宣言が有効になります。オプションで指定した場合は、2回目以降は重複宣言の警告を出しても良いとあります。これらの仕様は定義済み実体を実装するうえで影響があります。

4.2 実体宣言 にあるように、ユーザのオプションで同名の実体が重複宣言になった場合、警告を出しても良いとあります。

これを普通に実装しようとすると、

となります。

ここで、定義済み実体を先に実体テーブルに登録しておくと、
という問題があります。

一般実体の参照を処理するタイミングはDTDの作成後ですから、DTDをすべて処理したあとに定義済み実体を該当keyがない場合だけ登録するインタフェースを用意する方法です。

定義済み実体という名前に合わせて、テーブルのコンストラクタと同時に登録する方法です。
もし、登録時に定義済み実体と同名のkeyの場合は、
最初の一回：登録データが内部・解析対象一般実体の場合かつ正しい置換文字列の場合は、その値を置換文字列にする
登録データが内部・解析対象一般実体の場合かつ正しい置換文字列でない場合は、エラーとする
登録データが内部・解析対象一般実体でない場合は、エラーとする

2回目以降 ：他と同じ処理(オプションの場合だけ警告を出す)を行う