「利用者:黄身」を編集中 (節単位)

==ComText.js==

キャレット行をマッチした情報から条件を満たすテンプレートを取得し、文字列を作成する。

===テンプレート===

<syntaxhighlight lang="javascript" style="word-wrap:break-word;">
{
  "entries": [
    {
      "name":"for",
      "template":"for(var {0:8-1,0:8}=0;{0:8-1,0:8}<{s}.length;{0:8-1,0:8}++){\n\t\n}",
      "indent":true,
      "modes":["JavaScript","C#","C++","Java"],
      "conditions":[
        {
          "type":14,
          "text":"for[ijk]$"
        }
      ],
      "range":"0"
    }
  ],
  "sub":{
    "name":"sub",
    "comment":"一致するものが無ければ単純に改行する",
    "template":"\n"
  }
}
</syntaxhighlight>

;entries
:entry（検索条件とテンプレートのセット）の配列。
;name
:entryの名前。
;template
:テンプレート。「{...}」で囲まれた部分にマッチ結果から文字列を埋め込む事ができる。
;indent
:文字列の挿入時にインデントするかどうか。
;modes
:entryを使用する編集モード
;conditions
:検索条件の配列。
;type
:検索方法（<code>ComText.SearchTypes</code>のいずれか）。
;text
:検索文字列。
;range
:文字列の挿入位置。
;sub
:代替entry。

====文字列の埋め込み====

テンプレートの「{<開始位置>,<終了位置>}」は元のテキストの範囲を表し、マッチ結果を利用してその範囲の文字列を埋め込む。
<開始位置>と<終了位置>は共に「<インデックス>:<位置><差分>」「<インデックス>:<位置>」「<位置><差分>」「<位置>」の形式を取る。
<インデックス>はマッチした''entry''の''conditions''のインデックスを表す。省略した場合は0。
<位置>はマッチした文字列中での位置を表す。<code>ComText.RangeTypes</code>のいずれかを指定する。
<差分>は<インデックス>と<位置>で特定された位置からの差分を「+<数値>」「-<数値>」の形式で表す。省略した場合は0。

「{<インデックス>}」の形式も使用できる。この場合はマッチ位置の全体を表す。

e.g.
<syntaxhighlight lang="javascript" style="word-wrap:break-word;">
{0:8-1,0:8}
</syntaxhighlight>

この場合、開始位置は0番目の''condition''（0）のマッチ終了位置（8）から1文字戻った（-1）位置を表す。
終了位置は0番目の''condition''（0）のマッチ終了位置（8）を表す。

''range''の範囲指定も同じ記法を用いる（「{...}」で囲む必要はない）。

===使用例===

ここでは上記のJSONを使うものとする。

<syntaxhighlight lang="javascript" style="word-wrap:break-word;">
let os=new ComText(path,option).match();
</syntaxhighlight>

# ComTextのコンストラクタはpathに指定したJSONファイルのentriesをリスト化し、現在の編集モードが''modes''にあればそのエントリーを検索に使用する。
# <code>ComText#match</code>で検索を実行する。検索範囲は現在の行に限る。引数に<code>true</code>を指定すると1つのエントリーがマッチした時点で強制終了する。
# ''conditions''の全ての条件にマッチした時のみ、そのエントリーがマッチしたとみなす。''type''が14なので「選択位置より前の文字列を正規表現検索」する。''text''は検索パターンになる。
# マッチが成功すれば、マッチ結果などがコンストラクタの引数<code>option</code>のインスタンスとして<code>ComText#options</code>に追加される。<code>option</code>には<code>ComText.Option</code>かそれを継承したオブジェクトを指定する。
# <code>option</code>のインスタンスは必要になった時にマッチ結果と''template''から文字列を作成する。「{0:8-1,0:8}」の部分には元のテキストの「0番目のconditionsのマッチ終了位置より1文字遡った位置から、conditionsの0番目のマッチ終了位置」までの文字列が埋め込まれる。
# どのエントリーもマッチしなかった場合は代わりに''sub''から<code>option</code>のインスタンスを作成する。''sub''が存在しなければ<code>ComText#options</code>は空になる。

デフォルトの<code>ComText.Option</code>は文字列の作成までしか行わないので、利用するには別の関数に渡したり、<code>ComText</code>や<code>ComText.Option</code>を継承したオブジェクトを作る必要がある。