﻿RC_Main 自然言語仕様

【この文書の目的】
この自然言語仕様に従い、Windowsのデスクトップ版Wordで動くVBAの標準モジュールを作成する。対象モジュール名はこの文書の先頭に示す。関数名、引数の順序、辞書キーを変更しない。変数宣言を必須にし、手動で標準モジュールへ貼り付ける形式で作成する。属性行やThisDocument用のイベントは不要。
他モジュールの公開処理を呼び出す部分は、その処理の存在を前提とする。同じ公開関数を各モジュールへ重複実装しない。不明な会社書式は確認してから記入し、勝手に推測しない。

【ツール全体の契約】
・旧規程と新規程を読み取り専用で解析し、新欄が左、旧欄が右の編集可能なWord表を別ファイルへ保存する。入力を上書きしない。
・外部AI、外部通信、追加ソフト、外部テンプレートを実行時に使わない。Wordの標準オブジェクトと、遅延バインディングによるScripting.Dictionary、Scripting.FileSystemObject、VBScript.RegExpを使う。追加の参照設定を要求しない。
・通常の成功時はdocxだけを出力する。確認レポート、対応表TSV、手動対応を読み込んで再生成する機能は作らない。RC_Reportモジュールも作らない。
・issuesは処理中だけの内部診断。致命的な失敗時の画面表示と実行失敗TXTは残す。RC_Testsを明示実行した場合のテストTXTは別扱い。
・フォントや余白の変更は本文の変更とみなさない。原文の数字、否定語、句読点、空白、タブを言い換えたり削除したりしない。照合専用の正規化を原文や下線位置へ適用しない。
・Office、Wordのマクロ設定、OSのセキュリティ設定は変更しない。自分が開いた入力や作成した文書だけを閉じる。

【共通データ構造】
以下のキーは大文字小文字を含めて統一する。辞書中のオブジェクトはオブジェクトとして格納・差し替えし、文字列化しない。存在しない片側ノードは空文字ではなくNothingとする。Collectionの添字と文字位置は1始まり。

1. 解析文書：sourceは入力パスまたは識別文字列、titleは文書名、articlesは条ノードのCollection、historyは末尾履歴ノードのCollection、extrasは条に属さない保全ノードのCollection。
2. ノード：id、kind、prefix、gap、body、raw、heading、line、children。
  idは解析順ID。条はA001等、項はA001.P001等、号はA001.P001.I001等、履歴はH001等、未知段落はUに元段落番号を続ける。
  kindはarticle、paragraph、item、history、unknownのいずれか。prefixは元の番号文字列、gapは番号と本文の間の元の空白等、bodyは番号を除く本文、rawはprefix・gap・bodyをそのまま連結したもの。headingは条の直前の括弧見出し、lineは元入力の段落位置、childrenは子ノードのCollection。
  条ノード自身のbodyは空文字。その条の先頭本文は第1項ノードP001へ入れる。P001のprefixには元の第n条の番号を入れ、項番号「1」を新たに補わない。条ノードのrawは元番号とgapだけとなる。条にはheadingLineも加え、見出しの元段落位置を記録する。
3. 対応ペア：newとoldは新旧ノードまたはNothing、scoreはDoubleの類似度、statusはauto、review、new、deletedのいずれか、childrenは子対応ペアのCollection。
4. 内部診断：kind、location、reason、rawの4文字列を持つ辞書をissuesのCollectionへ追加する。利用者向けの確認レポートへ書き出さない。
5. 差分結果：newとoldは各側の下線区間Collection、fallbackは長文の代替計算を使ったBoolean。区間はstartという1始まり文字位置とlengthという文字数を持つ辞書。改行や空白を含む原文字列上の位置を使う。
6. 出力行：newTextとoldText、newHeadingとoldHeading、newHeadingBlankとoldHeadingBlank、newPrefixとoldPrefix、newArticleとoldArticle、newNoteとoldNote、historyGap、newSpansとoldSpans。
  TextとNoteは文字列。HeadingとPrefixは文字数のLong。HeadingBlank、Article、historyGapはBoolean。Spansは上記の下線区間Collection。初期値は文字列が空、文字数が0、BooleanがFalse、Collectionは空。

【モジュール間の公開処理】
RC_Configは設定定数、RC_Color、RC_Navy、RC_HeaderFill、RC_Regex、RC_TrimSpace、RC_MatchText、RC_NumberKeyを提供する。
RC_ParseはRC_Dict、RC_Node、RC_ParseText、RC_ReadDocument、RC_ParseLines、RC_NodeText、RC_AddIssueを提供する。
RC_MatchはRC_Similarity、RC_MatchScore、RC_NewPair、RC_Align、RC_PairChangedを提供する。
RC_CharDiffはRC_Diff、RC_AddSpanを提供する。
RC_OutputはRC_OutputDocumentを提供する。
RC_MainはCreateComparisonTable、RC_ShowOutput、RC_RunFiles、RC_UniqueBase、RC_WriteTextを提供する。
RC_Testsは任意の開発用RC_TestAllを提供する。通常の入口からテストを実行しない。
主な呼出し：MainがParseで旧・新を読み、Matchへ新articles・旧articles・issues・locationの順で渡し、Outputへpairs・新解析文書・旧解析文書・issuesの順で渡す。OutputがCharDiffを呼び、各処理がConfigとParseの共通処理を使う。

【他モジュールを呼ぶ際の引数契約】
次の一覧は呼出し互換性のために示す。この文書の対象以外のモジュールの実装を重複して作らない。
RC_Main
・CreateComparisonTable：公開。引数はなし。戻り値なし。
・RC_ShowOutput：公開。引数はoutput（String、値渡し）。戻り値なし。
・RC_RunFiles：公開。引数はoldPath（String、値渡し）、newPath（String、値渡し）、outputFolder（String、値渡し）。戻り値はString。
・RC_UniqueBase：公開。引数はfolder（String、値渡し）、stem（String、値渡し）。戻り値はString。
・RC_WriteText：公開。引数はpath（String、値渡し）、text（String、値渡し）。戻り値なし。
RC_Config
・RC_Color：公開。引数はhexRGB（String、値渡し）。戻り値はLong。
・RC_Navy：公開。引数はなし。戻り値はLong。
・RC_HeaderFill：公開。引数はなし。戻り値はLong。
・RC_Regex：公開。引数はpattern（String、値渡し）。戻り値はObject。
・RC_TrimSpace：公開。引数はtext（String、値渡し）。戻り値はString。
・RC_MatchText：公開。引数はtext（String、値渡し）。戻り値はString。
・RC_NumberKey：公開。引数はprefix（String、値渡し）。戻り値はString。
RC_Parse
・RC_Dict：公開。引数はなし。戻り値はObject。
・RC_Node：公開。引数はnodeId（String、値渡し）、kind（String、値渡し）、prefix（String、値渡し）、gap（String、値渡し）、body（String、値渡し）、line（Long、値渡し）。戻り値はObject。
・RC_ParseText：公開。引数はtext（String、値渡し）、source（String、値渡し）、issues（Collection、値渡し）。戻り値はObject。
・RC_ReadDocument：公開。引数はpath（String、値渡し）、issues（Collection、値渡し）。戻り値はObject。
・RC_ParseLines：公開。引数はlines（Variant、値渡し）、source（String、値渡し）、issues（Collection、値渡し）。戻り値はObject。
・RC_NodeText：公開。引数はn（Object、値渡し）、includePrefix（Boolean、値渡し、省略可能・既定値False）。戻り値はString。
・RC_AddIssue：公開。引数はissues（Collection、値渡し）、kind（String、値渡し）、location（String、値渡し）、reason（String、値渡し）、raw（String、値渡し）。戻り値なし。
RC_Match
・RC_Similarity：公開。引数はleftText（String、値渡し）、rightText（String、値渡し）。戻り値はDouble。
・RC_MatchScore：公開。引数はnn（Object、値渡し）、oo（Object、値渡し）、ni（Long、値渡し）、oi（Long、値渡し）、nc（Long、値渡し）、oc（Long、値渡し）。戻り値はDouble。
・RC_NewPair：公開。引数はnn（Object、値渡し）、oo（Object、値渡し）、score（Double、値渡し）、status（String、値渡し）。戻り値はObject。
・RC_Align：公開。引数はnews（Collection、値渡し）、olds（Collection、値渡し）、issues（Collection、値渡し）、location（String、値渡し）。戻り値はCollection。
・RC_PairChanged：公開。引数はpair（Object、値渡し）。戻り値はBoolean。
RC_CharDiff
・RC_Diff：公開。引数はnews（String、値渡し）、olds（String、値渡し）。戻り値はObject。
・RC_AddSpan：公開。引数はspans（Collection、値渡し）、first（Long、値渡し）、length（Long、値渡し）。戻り値なし。
RC_Output
・RC_OutputDocument：公開。引数はpairs（Collection、値渡し）、newDoc（Object、値渡し）、oldDoc（Object、値渡し）、issues（Collection、値渡し）。戻り値はDocument。
RC_Tests
・RC_TestAll：公開。引数はoutputFolder（String、値渡し）。戻り値はString。

【共通の境界条件】
自動採番、複雑な表、画像、脚注、本文外の図形、変更履歴の解釈は全面対応しない。内部診断と入力原本を保全するが、抽出できないものを架空の条文へ変換しない。
分割・統合の意味を自動で確定しない。残った原文を新設・削除として保全する。一般的な1対多分割の検出を保証しない。条の順序逆転を見やすく示す改善も別課題であり、この再構築で勝手に照合方式を変えない。
この文書は現行処理を再実装するための仕様。AIが生成したVBAのコンパイル・動作・原文保全は、Wordで別途確認する。

【このモジュールの入口・引数・戻り値】
・CreateComparisonTable：公開。引数はなし。戻り値なし。
・RC_ShowOutput：公開。引数はoutput（String、値渡し）。戻り値なし。
・RC_PickFile：モジュール内専用。引数はtitle（String、値渡し）、pattern（String、値渡し、省略可能・既定値"*.docx;*.doc"）。戻り値はString。
・RC_RunFiles：公開。引数はoldPath（String、値渡し）、newPath（String、値渡し）、outputFolder（String、値渡し）。戻り値はString。
・RC_UniqueBase：公開。引数はfolder（String、値渡し）、stem（String、値渡し）。戻り値はString。
・RC_WriteText：公開。引数はpath（String、値渡し）、text（String、値渡し）。戻り値なし。

【担当範囲】
通常入口、入力選択、処理の順序管理、別名保存、出力表示、致命的エラーの記録を担当する。条文の解析・照合・下線計算・表の書式は他モジュールへ委ねる。

【CreateComparisonTableの順序】
1. エラー時の終了処理を用意する。旧規程のファイル選択、新規程のファイル選択、出力先フォルダー選択の順に表示する。いずれかをキャンセルしたら正常に何もせず終了する。
2. RC_RunFilesへ旧パス、新パス、出力フォルダーを渡す。返されたdocxをRC_ShowOutputで開く。
3. 全工程が成功した後だけ「作成しました」と出力パスを表示する。途中で失敗したら「正常完了していない」とエラー内容を表示する。

【RC_PickFile】
単一選択のWord FileDialogを使う。指定された題名と拡張子フィルターを適用する。標準フィルターはdocxとdoc。選択時はパス、キャンセル時は空文字を返す。

【RC_RunFilesの順序】
1. 画面更新状態を保存し、FileSystemObjectを作る。現在の工程名を「入力検証」とする。
2. 旧ファイル、新ファイル、出力フォルダーの存在を順に調べる。存在しなければ、それぞれを特定できる説明付きエラーにする。旧と新が同じパスでも比較を許す。
3. 画面更新を止め、空のissuesを作る。RC_ReadDocumentで旧規程を読み、次に新規程を読む。工程名も各読込み工程へ更新する。
4. 工程を対応付けにし、RC_Alignへ新articles、旧articles、issues、location「本則」を渡す。
5. 工程をWord生成にし、RC_OutputDocumentで新しいDocumentを受け取る。
6. 出力フォルダー内で「新旧対照表_」に年月日・時分秒を付けた基底名をRC_UniqueBaseから得る。工程をWord保存にする。
7. 別名のdocxとして保存する。形式はWordのXML文書、最近使ったファイルへの追加はしない。保存後、この作成文書だけを追加保存せず閉じ、画面更新状態を元へ戻し、docxの絶対パスを返す。
8. 通常成功時に別のTXTやTSVを保存する工程を追加しない。

【RC_RunFilesの失敗時】
元のエラー番号・説明と工程名を退避する。二次エラーを許容する片付け区間で、作成途中の自分のDocumentだけを保存せず閉じ、画面更新を元へ戻す。出力先が存在する場合だけ、重複しない「実行失敗_日時.txt」を作る。内容は正常完了していないこと、工程、理由、失敗した工程以降は未処理であること、保存済みdocxがある場合も不完全として扱うこと、旧・新パス。ログ保存が失敗しても元のエラーを失わない。片付け後、元のエラー番号でRC_RunFilesを発生源として再送出する。

【共通保存と表示】
RC_UniqueBaseはフォルダーと基底名を結合し、その名前のdocxまたはtxtが既にあれば末尾へ連番を増やして空いている名前を探す。既存ファイルに上書きしない。
RC_WriteTextはUnicode文字ファイルを新規作成して全文を書き、必ずストリームを閉じる。既存ファイルの上書きを許可しない。
RC_ShowOutputは指定された結果文書を開いてアクティブにし、そのウィンドウの表グリッド線、すべての編集記号、段落記号を非表示にする。Word環境全体のセキュリティ設定は変更しない。

【確認例】
キャンセル時に出力なし。同一入力でも最新履歴があればそれだけを含むdocxを保存。短時間に連続実行しても既存結果を上書きしない。入力不存在なら成功表示なし、画面更新復元、可能な場合だけ失敗TXT。開いているユーザー入力文書はParseで拒否し、その文書を閉じない。
