Windowsのテストマシンをドイツの地域設定に切り替え、ページへスケールとシフトの行列を前置きするルーチンを実行し、コンテンツストリームをダンプしてみてください。0.5 0 0 0.25 0.00001 12.75 cmの代わりに0,5 0 0 0,25 1E-5 12,75 cmが出てきます。コンテンツパーサーはこれを、数値0、次に認識できないトークン,5、その後、cmが期待する6オペランドともう一致しない数値の連なりとして読みます。ページは、あなたが頼んだことのないtransformで描画されます。機械がパースする数値には、書き込み側と読み取り側の両方で、固定のドット、指数なし、そしてFormatSettingsへの一切の依存がなければなりません
なぜカンマ小数点のロケールはPDF数値を壊すのか?
カンマ小数点のロケールがPDF数値を壊すのは、Delphiの既定の浮動小数点整形がデスクトップに従う一方、PDFの数値構文は固定だからです。FloatToStrはFormatSettings.DecimalSeparatorを使うため、de-DE、fr-FR、pt-BRのマシンではすべての小数がカンマ付きで出てきます。ISO 32000-1 §7.3.3が数値に許すのは、数字、1つのピリオド、先頭の符号。それだけです。したがってカンマは1つの数値を、有効な整数とジャンクに分裂させ、結果は、描画はするのに、ただ間違っているページになります
1つ目の罠の後ろには2つ目の罠があり、それはUSのマシンでも牙を剥きます。FloatToStrはffGeneral形式を使い、これは大きさが1E-4を下回ると指数表記へ切り替えるため、微小なオフセットは1E-5と書かれます。同じ§7.3.3は、PDFが指数形式をサポートしないと言っています。描画結果のどちらの問題もトレースするのは悲惨です。ずれた行列は、自分のコードのレイアウトバグにそっくりで、ページのどこにも地域設定を指すものがないからです
PDFlibPas、losLabのDelphi向けPDF Developer Libraryは、AddPageMatrixのオペランドを、小数点以下6桁のPLDoubleToStrConst経由で書き込み、あなたの代わりにページコンテンツを生成する呼び出し箇所も同じ規則に従います。私たちの知る最も安上がりのリグレッションテストは、プロセス内でセパレーターをカンマへ切り替え、APIを呼び、結果をカンマと指数について走査するものです
uses
System.SysUtils, PDFlibrary;
// 自分自身のチェック、ライブラリの一部ではない。意図的に粗くしてある:
// (Hello, world) Tj のようなテキスト文字列もカンマを含むため、
// 図形だけを描くテストページに対して実行すること
function HasLocaleDamage(const Content: AnsiString): Boolean;
var
I: Integer;
begin
Result := False;
for I := 1 to Length(Content) do
begin
if Content[I] = ',' then
Exit(True);
if (Content[I] in ['E', 'e']) and (I > 1) and (I < Length(Content)) and
(Content[I - 1] in ['0'..'9']) and (Content[I + 1] in ['0'..'9', '-', '+']) then
Exit(True);
end;
end;
var
Lib: TPDFlib;
OldSeparator: Char;
Content: AnsiString;
begin
Lib := TPDFlib.Create;
try
Lib.SetPageDimensions(300, 200);
Lib.DrawBox(10, 10, 20, 20, 1);
OldSeparator := FormatSettings.DecimalSeparator;
try
FormatSettings.DecimalSeparator := ','; // de-DE のデスクトップのように振る舞う
Lib.AddPageMatrix(0.5, 0.25, 1E-5, 12.75);
Content := Lib.GetPageContentToString;
// 期待値:0.5 0 0 0.25 0.00001 12.75 cm
// FloatToStr ならこうなっていた:0,5 0 0 0,25 1E-5 12,75 cm
Writeln(Content);
if HasLocaleDamage(Content) then
Writeln('Locale leaked into the content stream');
finally
FormatSettings.DecimalSeparator := OldSeparator;
end;
finally
Lib.Free;
end;
end;
プロセス内でFormatSettings.DecimalSeparatorを変えるのは近道です。OSから独自にTFormatSettingsを組み立てるコードは演習されません。あなたのアプリケーションがそうしているなら、本当にドイツの地域設定が入ったCIエージェントのほうが誠実なテストです
2種類の数値、2つのヘルパー族
PDFlibPasは数値ヘルパーを対象者で分けます。人に見せるテキストはロケールに従ってもよく、機械のために書かれるものは決して従いません。PDFlibExtra.pasのPLFloatToStrとPLStrToFloatは、FloatToStrとStrToFloatの薄いラッパーで、宣言のコメントは人間が読むテキスト専用だと述べています。マシン出力(PDF、FDF、XFDF、JSON、XML、CSV)は、代わりに不変の族を通ります。書くためのPLDoubleToStrConst、読むためのPLTryStrToFloatInvariant、そして自分のTryStrToFloat呼び出しのためにドット小数のTFormatSettingsレコードが必要なときはPLInvariantFormatSettingsです
精度はグローバルではなく仕事ごとに選ばれます。行列は6桁、座標とTJの調整は4桁、色とFDFの矩形は3桁です。マシン向けの側は、API表面が示すより多くの場所をカバーします
- 既存のページコンテンツに
cmを前置きするAddPageMatrix、ScalePage、DeskewPage - ページ要素の生成時に書かれる
Tmのリセット、TJの進み、cmのtransform - テキストをパスへ変換するときに作られるグリフ配置行列とアウトライン点
RedactRegionが前置きする黒の塗りbox、FDF出力の/Rect値、再着色が書く色オペランド
PLDoubleToStrConstは手書きのフォーマッターで、固定のTFormatSettingsでFloatToStrFを包むやり方より、これが正しい選択だったと私たちは考えています。ffFixedは整数部が精度を超えると科学技術表記へフォールバックしますし、0.5で短くて同一なのに0.500000を残します。独自ルーチンは常にピリオドを書き、末尾ゼロを剥ぎ、有限の入力に指数を決して書きません。さらに、要求された精度より小さい非ゼロ値の有効数字を保持します。PLDoubleToStrConst(1E-9, 6)は0.000000001を返し、およそ5E-16より下の値だけが0になります。微小なスケール係数をゼロへ丸めると、有効な行列が特異行列に変わります。それは、ずれた小数点のどんな失敗よりも悪い
フォーマッターに対してユニットテストを書くなら、サンプル値は2進浮動小数点を念頭に選んでください。「有効数字4桁」の自明な選択は0.000012345ですが、1E8を掛けたそのdoubleは1234.4999…になるため、結果は0.00001234で、アサーションはロケールと無関係な理由で失敗します。中点から明確に離れた値、たとえば0.000012346なら、この議論ごと避けられます
uses
PDFlibExtra;
// Assert 呼び出しは自分のテストプロジェクトに追加するチェック
procedure CheckNumberHelpers;
var
V: Double;
begin
// マシン出力:ドット小数、指数なし、末尾ゼロを剥ぐ
Assert(PLDoubleToStrConst(1E-5, 6) = '0.00001');
Assert(PLDoubleToStrConst(-0.5, 6) = '-0.5');
Assert(PLDoubleToStrConst(0.000012346, 4) = '0.00001235'); // 有効数字4桁を保持
Assert(PLDoubleToStrConst(12345.25, 4) = '12345.25');
// マシン入力:EConvertError の代わりに False
Assert(PLTryStrToFloatInvariant('0.5', V) and (V = 0.5));
Assert(PLTryStrToFloatInvariant(' 12.75 ', V) and (V = 12.75)); // 入力はトリムされる
Assert(not PLTryStrToFloatInvariant('0,5', V)); // コンテンツの数値は決してカンマを使わない
end;
なぜ解析側は書き込み側より危険なのか?
解析側のほうが危険なのは、ロケールに縛られたパーサーは、わずかに間違った数値を作るのではなく、上げてしまうからです。StrToFloatは、テキストがシステムのセパレーターと一致しないときはいつでもEConvertErrorを投げます。それを基盤にした再着色パスは、カンマ小数点のマシンで普通の0.5 g演算子に届いた瞬間に中断します。つまり実質的にすべての実ページで失敗します。"10.5,20.5,50.5,40.5"のようなクリップ文字列は丸ごと拒否され、SVGの長さ、SVGの色、注釈の頂点リスト、出力インテントの値は、拒否されるか、静かに既定値へ置き換えられるかします。開発マシンではすべてのテストを通し、ミュンヘンの最初の顧客のところで失敗する、偶然動くDelphiコードの記事のケースと同族の問題です
ライブラリ内のすべてのStrToFloat系の呼び出しは、入力の出どころで並べ替えられています。コンテンツストリームのオペランド、SVG属性、ペインターの色文字列、カンマ区切りのクリップリストと頂点リストは、いずれも固定のドット構文を持つため、PLTryStrToFloatInvariantを通ります。このヘルパーはテキストをトリムし、PLInvariantFormatSettingsでパースし、空、不正形、NaN、無限の入力にはFalse(値は0に設定)を返します。カンマ区切りのリストは議論の余地すらありませんでした。カンマはリスト区切りと小数点を同時に務められないので、互換のために残すレガシー形式が存在しないのです
PDFを1つの色空間へ変換するガイドで述べた再着色パイプラインでは、その結果として、RecolorPageとRecolorDocumentがどのロケールでもページコンテンツを同一にパースします。呼び出し側がCheckDocumentPolicyに入力するルール値は、寛容な道を取る唯一の解析ケースです。その文字列を打ち込んだのは人で、ローカルの小数点記号を普通に使っているかもしれないからです
文字列で中継される数値には両端の合意が要る
数値が、コードの一部によって文字列へ書かれ、別の部分によってパースし戻されるとき、書き手と読み手は同じ慣習に従わなければならず、片方だけ変えると往復が壊れます。タグ付きPDFの構造属性はまさにこの形で動きます。SetStructElemBBoxは4つの値を1つの文字列へ整形し、AddTagAttribute経由で保存します。/A属性辞書が書かれるとき、その文字列は、数値になるか、配列になるか、名前になるかを決めるために再度パースされます
両端がシステムのロケールに従うなら、往復はドイツのマシン上で自己整合的です。問題が始まるのは、ドキュメントに従って"0.5"をAddTagAttributeへ渡す呼び出し側です。ロケールに縛られた読み手はこれをパースできず、PDF名/0.5を出力します。PDF/VCRプレースホルダーはその鏡像に当たります。GTS_BBoxはドット付きで生成され、保存前のロケールに縛られた検証ステップがこれを拒否するからです。そして書き手だけをドットへ切り替えると状況は悪化します。すべてのSetStructElem*の値が、カンマ小数点システム上で名前へ変わってしまうからです
そこで書き手はPLDoubleToStrConst(v, 6)を、読み手はPLTryStrToFloatLenientを使います。こちらはドット形式を先に試し、システムロケールへフォールバックします。カンマロケールの呼び出し側が"1,25"を渡せば、数値1.25を得られます。コストはありますが、私たちはそれを分かった上で受け入れました。ドイツのシステムでは"1.500"は千五百ではなく1.5として読まれます。ドット形式が勝つからです。APIはドットをセパレーターとして文書化しているので、属性文字列の中のドイツ式の桁区切りは、諦めることを選んだ入力です。リテラルのNANとINF文字列は数値として扱われません
uses
System.SysUtils, PDFlibrary;
var
Lib: TPDFlib;
begin
FormatSettings.DecimalSeparator := ','; // カンマ小数点の呼び出し側
Lib := TPDFlib.Create;
try
Lib.BeginTag('Figure', 'Sales chart', '');
Lib.SetStructElemBBox(10.5, 20.25, 200.5, 100.75); // /BBox [ 10.5 20.25 200.5 100.75 ]
Lib.AddTagAttribute('Layout', 'SpaceAfter', '0.5'); // /SpaceAfter 0.5 となり /0.5 にはならない
Lib.AddTagAttribute('Layout', 'StartIndent', '1,25'); // ロケールフォールバック経由で /StartIndent 1.25
Lib.DrawText(20, 20, 'figure');
Lib.EndTag;
Lib.SaveToFile('tagged.pdf');
finally
Lib.Free;
end;
end;
あなた自身のコードへの私たちの推奨は、ドット小数の文字列をAddTagAttributeへ渡し、カンマのフォールバックは、古い設定ファイルから読み込んだ文字列のような、制御できない値のために取っておくことです。これらの属性の周囲の構造ツリーがどう組み立てられるかは、タグ付きPDF構造ガイドが扱います
NaNと無限大はどこで止められるのか
AddPageMatrix、ScalePage、RedactRegionは、NaNと無限の引数を前もって拒否し、0を返します。どちらもPDF数値で表現できないからです。このチェックは明示的でなければなりません。NaNは<= 0のテストをすり抜けるため、スケール係数だけの範囲チェックでは、NaNのスケールがフォーマッターまで旅を続けてしまいます。そしてWin32では、x87ユニットが既定で無効演算をマスクしないため、NaNへのRound呼び出しはEInvalidOpを上げます。PLDoubleToStrConstは最後の防衛線としてNaNに0を書きますが、行列の中のゼロは特異なtransformです。ページを実際に守るのはAPIレベルのチェックのほうです。自分のコードでは、戻り値をテストしてください。計算した係数に対してScalePageが0を返したら、何より先にその係数を印字してください。上流のどこかの0/0が、まさにこのNaNを作っているのですから
2つの境界は意図的なものです。メタファイルの状態文字列は、単一プロセスの中でロケール付きで書かれ、読まれ、ファイルへ届くことはないため、ロケールに縛られたままです。そしてページ生成の経路を通して小さな値をテストするなら、呼び出しの直後にコンテンツを読んでください。後からページコンテンツを文書の座標精度で再出力する操作は、1E-5を正当に0へ変えます。それは丸めであって、ロケールの漏れではありません
採用する価値のある習慣は短いです。アプリケーションのPDF生成経路をカンマセパレーターで1回走らせ、出力をカンマと指数について走査し、パーサーが読むものすべてからFloatToStrを遠ざけてください。既存ファイルから読む数値は、関連する規則に従います。保存の後も正確なソーステキストが生き残るという話は、パース済み小数精度を保持する記事で扱っています。トライアルビルド、APIリファレンス、ライセンスの詳細は、PDFlibPas Delphi PDFライブラリ製品ページにあります