ライブテンプレート

ライブテンプレートは再利用可能なスケルトンコード文です。コードエディタで Delphi および C++ 用の一連のライブテンプレートにアクセス可能です。

［テンプレート］ウィンドウでテンプレート名をダブルクリックすることで、これらの定義済みコードスケルトンの 1 つを作成中のコードに挿入できます。また、テンプレート名を入力し Tab キーを押すことでテンプレートを挿入することもできます。RAD Studio ライブテンプレートの XML ファイルは C:\Program Files (x86)\Embarcadero\Studio\21.0\ObjRepos\en\Code_Templates にあります。

［テンプレート］ウィンドウに独自のコードテンプレートを追加できます。ライブテンプレートの名前は、テンプレート内のコード（たとえば class など）を表すか、コードの最初の単語（たとえば try など）に一致することがあり、一部には、コードに入力する単語に近い（正確に一致するわけではない）テンプレート名（たとえば forr など）もあります。独自に作成したテンプレート（およびサードパーティ製アドインで提供されるテンプレート）は、デフォルトでは、C:\Users\<user>\Documents\Embarcadero\Studio\code_templates ディレクトリに保存されます。

ジャンプポイント

ジャンプポイントは、Tab キーや Shift+Tab キーを使ってテンプレート内の要素間を移動できるようになる、キー入力フィールドのプレースホルダです。

編集可能なジャンプポイントがテンプレートに 1 つ以上ある場合、そのテンプレートをコードに挿入すると、テンプレートは自動的に同期編集モードになります。Esc キーまたは Enter キーを押すか、最後のジャンプポイントで Tab キーを押すと、同期編集モードが終了し、コードエディタは通常の編集モードに戻ります。

たとえば、arrayd（Delphi 配列）テンプレートには 4 つのジャンプポイントがあり、それぞれ、name（TMyArray）、low（0）、high（10）、var（Integer）という名前が付いています（かっこ内はデフォルトテキスト）。下図のように、最初のジャンプポイントが強調教示され、アクティブになっています。

arrayd XML コードと arrayd ライブテンプレートそのものを比較するには、［テンプレート］ウィンドウを開き、arrayd テンプレートを選択して［コードテンプレートの編集］（）をクリックします。

例：Delphi 用および C++ 用の try テンプレート

このセクションでは、以下のような Delphi 用および C++ 用の try テンプレートを示します。

言語	テンプレート名	テンプレート概要
Delphi	try	try-finally (Create/Free あり)
C++	try	try-catch

Delphi 用 try テンプレート

下図は、［テンプレート］ウィンドウで Delphi 用 try テンプレートの上にマウスカーソルを合わせたときにコード概要ポップアップが表示されるところを示しています。縦棒（"|"）は特殊文字で、ここでは、テンプレート内のジャンプポイントを強調するために使用されています（$ もジャンプポイントを区切るのに使用できます）。

下図は、Delphi 用 try テンプレートをアクティブにしたときにコードエディタに挿入されるテンプレートを示します。強調表示またはアウトライン表示されたジャンプポイントが同期編集モードでアクティブになっているため、そのテンプレートに出現するすべてのジャンプポイントを同時に編集できます。

ここで、Delphi コードテンプレート try の XML ファイルを示します。［テンプレート］ウィンドウの［概要］列に表示される "try finally (Create/Free あり)" が記述されています。このテンプレートには、以下の記述が含まれています。

（variable、control、createparms という名前の）3 つのジャンプポイントの定義
コード補完と control ジャンプポイントを関連付けるスクリプト（script）コマンド

 <?xml version="1.0" encoding="utf-8" ?>
 
 <codetemplate	xmlns="http://schemas.borland.com/Delphi/2005/codetemplates"
 				version="1.0.0">
 	<template name="'''try'''" surround="'''true'''" invoke="'''auto'''">
 		<point name="'''variable'''">
 			<text>
 				'''MyClass'''
 			</text>
 			<hint>
 				'''変数名'''
 			</hint>
 		</point>
 		<point name="control">
 			<script language="'''Delphi'''">
 				'''InvokeCodeCompletion;'''
 			</script>
 			<text>
 				'''Component'''
 			</text>
 			<hint>
 				'''クラス名'''
 			</hint>
 		</point>
 		<point name="createparms">
 			<hint>
 				'''コンストラクタのパラメータ'''
 			</hint>
 						<text>
 							'''(Self)'''
 						</text>
 		</point>
 		<description>
 			'''try finally (Create/Free あり)'''
 		</description>
 		<author>
 			'''Embarcadero'''
 		</author>
 		<script language="'''Delphi'''" onenter="'''false'''" onleave="'''true'''">
 			'''DeclareVariable(|variable|);'''
 		</script>
 		<code language="'''Delphi'''" context="'''methodbody'''" delimiter="|"><![CDATA['''|variable| := T|control|.Create|createparms|;
 '''try
 '''|selected||*||end|
 '''finally
 '''|*||variable|.Free;
 '''end;'''
 ''']]>
 		</code>
 	</template>
 </codetemplate>

テンプレートのコードは、<code> 要素の <![CDATA[ ... ]]> 内に記述されています。上記テンプレートの先頭要素は、次のような variable というジャンプポイントです。

|variable|

コード内の行をインデントするための、次のような特殊文字も含まれています。

|*|

二重インデントの場合は、以下を使用します。

|*||*|

C++ 用 try テンプレート

下図は、［テンプレート］ウィンドウで C++ 用 try テンプレートの上にマウスカーソルを合わせたときにコード概要ポップアップが表示されるところを示しています。ドル記号（$）は、定義済みおよび組み込みのジャンプポイントを強調するのに使用される特殊文字です（| も使用できます）。

下図は、C++ 用 try テンプレート（［概要］は 'try-catch'）をアクティブにしたときにコードエディタに挿入されるライブテンプレートを示します。

C++ 用 try テンプレートの実際の XML は以下のようになっています。

 <?xml version="1.0" encoding="utf-8" ?>
 
 <codetemplate	xmlns="http://schemas.borland.com/Delphi/2005/codetemplates"
 				version="1.0.0">
 	<template name="'''try'''" surround="'''true'''" invoke="'''auto'''">
 		<point name="'''except'''">
 			<text>
 				...
 			</text>
 			<hint>
 				'''捕捉する例外クラス'''
 			</hint>
 		</point>
 		<description>
 			'''try-catch'''
 		</description>
 		<author>
 			'''Embarcadero'''
 		</author>
 		<code language="'''C'''" context="'''methodbody'''"><![CDATA['''try {
 '''$selected$$*$$end$
 '''} catch ($except$) {
 '''}'''
 ]]>
 		</code>
 	</template>
 </codetemplate>

テンプレートの実際のコードは、<code> 要素の <![CDATA[ ... ]]> 内に記述されています。

このテンプレートではドル記号（$）を区切り文字として使用しているのに対して、Delphi 用 try テンプレートでは縦棒（|）を区切り文字として使用しています。次の特殊文字はコード内の行をインデントするためのものです。

$*$

二重インデントの場合は、以下を使用します。

$*$$*$