チュートリアル: 生成済みディレクティブプロセッサにホストを接続する

2025-06-12

テキストテンプレートを処理する独自のホストを作成できます。基本的なカスタムホストについては、「チュートリアル: カスタムテキストテンプレートホストの作成」で説明しています。このホストを拡張して、複数の出力ファイルを生成するなどの機能を追加することができます。

このチュートリアルでは、ディレクティブプロセッサを呼び出すテキストテンプレートをサポートするようにカスタムホストを拡張します。ドメイン固有言語を定義すると、ドメインモデルの "ディレクティブプロセッサ" が生成されます。ディレクティブプロセッサを使用すると、モデルにアクセスするテンプレートをユーザーが簡単に記述できるようになり、テンプレートにアセンブリディレクティブとインポートディレクティブを記述する必要性が減ります。

Note

このチュートリアルは、「チュートリアル: カスタムテキストテンプレートホストの作成」を基に構築されています。まず、このチュートリアルを実行します。

このチュートリアルでは、次のタスクについて説明します。

ドメイン固有言語ツールを使って、ドメインモデルに基づくディレクティブプロセッサを生成します。
生成されたディレクティブプロセッサにカスタムテキストテンプレートホストを接続します。
生成されたディレクティブプロセッサを使用してカスタムホストをテストします。

前提条件

DSL を定義するには、以下のコンポーネントをインストールしておく必要があります。

コンポーネント	Link
Visual Studio	http://go.microsoft.com/fwlink/?LinkId=185579
Visual Studio SDK	http://go.microsoft.com/fwlink/?LinkId=185580
Visual Studio Visualization and Modeling SDK

Note

テキストテンプレート変換コンポーネントは、Visual Studio 拡張機能の開発ワークロードの一部として自動的にインストールされます。また、 [SDK、ライブラリ、およびフレームワーク] カテゴリの下にある Visual Studio インストーラーの [個別のコンポーネント] タブからインストールすることもできます。 [個別のコンポーネント] タブから Modeling SDK コンポーネントをインストールします。

さらに、「チュートリアル: カスタムテキストテンプレートホストの作成」では、カスタムテキストテンプレート変換を作成する必要があります。

ドメイン固有言語ツールを使用してディレクティブプロセッサを生成する

このチュートリアルでは、ドメイン固有言語デザイナーウィザードを使用して、DSLMinimalTest ソリューション用のドメイン固有言語を作成します。

次の特性を持つドメイン固有言語ソリューションを作成します。
- 名前: DSLMinimalTest
- ソリューションテンプレート: 最小言語
- ファイル拡張子: min
- 会社名: Fabrikam
ドメイン固有言語ソリューションの作成の詳細については、「方法: ドメイン固有言語ソリューションを作成する」を参照してください。
[ビルド] メニューの [ソリューションのビルド] をクリックします。

重要

この手順では、ディレクティブプロセッサを生成し、そのキーをレジストリに追加します。
デバッグメニューで、デバッグの開始をクリックします。

Visual Studio の 2 つ目のインスタンスが開きます。
試験的ビルドで、ソリューションエクスプローラーのファイル sample.min をダブルクリックします。

デザイナーでファイルが開きます。モデルには、ExampleElement1 と ExampleElement2 という 2 つの要素と、それらの間のリンクがあります。
Visual Studio の第 2 インスタンスを閉じます。
ソリューションを保存し、ドメイン固有言語デザイナーを閉じます。

カスタムテキストテンプレートホストをディレクティブプロセッサに接続する

ディレクティブプロセッサを生成したら、「チュートリアル: カスタムテキストテンプレートホストの作成」で作成したディレクティブプロセッサとカスタムテキストテンプレートホストを接続します。

CustomHost ソリューションを開きます。
[プロジェクト] メニューの [参照の追加] をクリックします。

[参照の追加] ダイアログボックスが開き、[.NET] タブが表示されます。
次の参照を追加します:
- Microsoft.VisualStudio.Modeling.Sdk.11.0
- Microsoft.VisualStudio.Modeling.Sdk.Diagrams.11.0
- Microsoft.VisualStudio.TextTemplating.11.0
- Microsoft.VisualStudio.TextTemplating.Interfaces.11.0
- Microsoft.VisualStudio.TextTemplating.Modeling.11.0
- Microsoft.VisualStudio.TextTemplating.VSHost.11.0
Program.cs または Module1.vb の先頭に、次のコード行を追加します。
- C#
- VB
```
using Microsoft.Win32;
```
```
Imports Microsoft.Win32
```

StandardAssemblyReferences プロパティのコードを見つけて、次のコードに置き換えます。

Note

この手順では、ホストがサポートする、生成されたディレクティブプロセッサに必要なアセンブリへの参照を追加します。

//the host can provide standard assembly references
//the engine will use these references when compiling and
//executing the generated transformation class
//--------------------------------------------------------------
public IList<string> StandardAssemblyReferences
{
    get
    {
        return new string[]
        {
            //if this host searches standard paths and the GAC
            //we can specify the assembly name like this:
            //"System"
            //since this host only resolves assemblies from the
            //fully qualified path and name of the assembly
            //this is a quick way to get the code to give us the
            //fully qualified path and name of the System assembly
            //---------------------------------------------------------
            typeof(System.Uri).Assembly.Location,
                        typeof(System.Uri).Assembly.Location,
            typeof(Microsoft.VisualStudio.Modeling.ModelElement).Assembly.Location,
            typeof(Microsoft.VisualStudio.Modeling.Diagrams.BinaryLinkShape).Assembly.Location,
            typeof(Microsoft.VisualStudio.TextTemplating.VSHost.ITextTemplating).Assembly.Location,
            typeof(Microsoft.VisualStudio.TextTemplating.VSHost.ModelingTextTransformation).Assembly.Location

        };
    }
}

ResolveDirectiveProcessor 関数のコードを見つけて、次のコードに置き換えます。

重要

このコードには、接続先となる生成されたディレクティブプロセッサの名前に対して、ハードコーディングされた参照が含まれています。これを一般的にすることは簡単にできます。この場合、レジストリに列挙されているすべてのディレクティブプロセッサを参照して、一致するものが検索されます。そのような場合は、ホストは生成されたすべてのディレクティブプロセッサで動作します。

//the engine calls this method based on the directives the user has
        //specified it in the text template
        //this method can be called 0, 1, or more times
        //---------------------------------------------------------------------
        public Type ResolveDirectiveProcessor(string processorName)
        {
            //check the processor name, and if it is the name of the processor the
            //host wants to support, return the type of the processor
            //---------------------------------------------------------------------
            if (string.Compare(processorName, "DSLMinimalTestDirectiveProcessor", StringComparison.InvariantCultureIgnoreCase) == 0)
            {
                try
                {
                    string keyName = @"Software\Microsoft\VisualStudio\10.0Exp_Config\TextTemplating\DirectiveProcessors\DSLMinimalTestDirectiveProcessor";
                    using (RegistryKey specificKey = Registry.CurrentUser.OpenSubKey(keyName))
                    {
                        if (specificKey != null)
                        {
                            List<string> names = new List<String>(specificKey.GetValueNames());
                            string classValue = specificKey.GetValue("Class") as string;
                            if (!string.IsNullOrEmpty(classValue))
                            {
                                string loadValue = string.Empty;
                                System.Reflection.Assembly processorAssembly = null;
                                if (names.Contains("Assembly"))
                                {
                                    loadValue = specificKey.GetValue("Assembly") as string;
                                    if (!string.IsNullOrEmpty(loadValue))
                                    {
                                        //the assembly must be installed in the GAC
                                        processorAssembly = System.Reflection.Assembly.Load(loadValue);
                                    }
                                }
                                else if (names.Contains("CodeBase"))
                                {
                                    loadValue = specificKey.GetValue("CodeBase") as string;
                                    if (!string.IsNullOrEmpty(loadValue))
                                    {
                                        //loading local assembly
                                        processorAssembly = System.Reflection.Assembly.LoadFrom(loadValue);
                                    }
                                }
                                if (processorAssembly == null)
                                {
                                    throw new Exception("Directive Processor not found");
                                }
                                Type processorType = processorAssembly.GetType(classValue);
                                if (processorType == null)
                                {
                                    throw new Exception("Directive Processor not found");
                                }
                                return processorType;
                            }
                        }
                    }
                }
                catch (Exception e)
                {
                    //if the directive processor can not be found, throw an error
                    throw new Exception("Directive Processor not found");
                }
            }

            //if the directive processor is not one this host wants to support
            throw new Exception("Directive Processor not supported");
        }

[ファイル] メニューの [すべてを保存] をクリックします。
[ビルド] メニューの [ソリューションのビルド] をクリックします。

ディレクティブプロセッサを使用してカスタムホストをテストする

カスタムテキストテンプレートホストをテストするには、まず、生成されたディレクティブプロセッサを呼び出すテキストテンプレートを作成する必要があります。次に、カスタムホストを実行し、テキストテンプレートの名前を渡して、ディレクティブが正しく処理されていることを確認します。

テキストテンプレートを作成してカスタムホストをテストする

テキストファイルを作成し、TestTemplateWithDP.tt という名前を付けます。ファイルの作成には、メモ帳など、任意のテキストエディターを使用できます。

次の内容をテキストファイルに追加します。

Note

テキストテンプレートのプログラミング言語は、カスタムホストのプログラミング言語と同じでなくてもかまいません。

Text Template Host Test

<#@ template debug="true" inherits="Microsoft.VisualStudio.TextTemplating.VSHost.ModelingTextTransformation" #>
<# //this is the call to the examplemodel directive in the generated directive processor #>
<#@ DSLMinimalTest processor="DSLMinimalTestDirectiveProcessor" requires="fileName='<Your Path>\Sample.min'" provides="ExampleModel=ExampleModel" #>
<# //uncomment this line to test that the host allows the engine to set the extension #>
<# //@ output extension=".htm" #>

<# //uncomment this line if you want to see the generated transformation class #>
<# //System.Diagnostics.Debugger.Break(); #>
<# //this code uses the results of the examplemodel directive #>
<#
    foreach ( ExampleElement box in this.ExampleModel.Elements )
    {
        WriteLine("Box: {0}", box.Name);

        foreach (ExampleElement linkedTo in box.Targets)
        {
            WriteLine("Linked to: {0}", linkedTo.Name);
        }

        foreach (ExampleElement linkedFrom in box.Sources)
        {
            WriteLine("Linked from: {0}", linkedFrom.Name);
        }

        WriteLine("");
    }
#>

Text Template Host Test

<#@ template debug="true" language="VB" inherits="Microsoft.VisualStudio.TextTemplating.VSHost.ModelingTextTransformation" #>

<# 'this is the call to the examplemodel directive in the generated directive processor #>
<#@ DSLMinimalTest processor="DSLMinimalTestDirectiveProcessor" requires="fileName='<Your Path>\Sample.min'" provides="ExampleModel=ExampleModel" #>

<# 'Uncomment this line to test that the host allows the engine to set the extension. #>
<# '@ output extension=".htm" #>

<# 'Uncomment this line if you want to see the generated transformation class. #>
<# 'System.Diagnostics.Debugger.Break() #>

<# 'this code uses the results of the examplemodel directive #>

<#
   For Each box as ExampleElement In Me.ExampleModel.Elements

       WriteLine("Box: {0}", box.Name)

        For Each LinkedTo as ExampleElement In box.Targets
            WriteLine("Linked to: {0}", LinkedTo.Name)
        Next

        For Each LinkedFrom as ExampleElement In box.Sources
            WriteLine("Linked from: {0}", LinkedFrom.Name)
        Next

        WriteLine("")

   Next
#>

コードで、<YOUR PATH> を、最初の手順で作成したデザイン固有言語の Sample.min ファイルのパスに置き換えます。
ファイルを保存して閉じます。

カスタムホストをテストする

コマンドプロンプトウィンドウを開きます。
カスタムホストの実行可能ファイルのパスを入力します。ただし、Enter キーはまだ押さないでください。

たとえば、次のように入力します。

<YOUR PATH>CustomHost\bin\Debug\CustomHost.exe

Note

アドレスを入力する代わりに、Windows エクスプローラーで CustomHost.exe ファイルを参照し、コマンドプロンプトウィンドウにドラッグしてもかまいません。
空白を入力します。
テキストテンプレートファイルのパスを入力し、Enter キーを押します。

たとえば、次のように入力します。

<YOUR PATH>TestTemplateWithDP.txt

Note

アドレスを入力する代わりに、Windows エクスプローラーで TestTemplateWithDP.txt ファイルを参照し、コマンドプロンプトウィンドウにドラッグしてもかまいません。

カスタムホストアプリケーションが実行され、テキストテンプレート変換プロセスが開始されます。
Windows エクスプローラーで、TestTemplateWithDP.txt ファイルが格納されているフォルダーに移動します。

このフォルダーには、TestTemplateWithDP1.txt ファイルも含まれています。
このファイルを開き、テキストテンプレート変換の結果を確認します。

生成されたテキスト出力の結果が表示され、次のようになります。
```
Text Template Host Test

Box: ExampleElement1
Linked to: ExampleElement2

Box: ExampleElement2
Linked from: ExampleElement1
```

チュートリアル: カスタムテキストテンプレートホストの作成

次の方法で共有

チュートリアル: 生成済みディレクティブ プロセッサにホストを接続する

前提条件

ドメイン固有言語ツールを使用してディレクティブ プロセッサを生成する

カスタム テキスト テンプレート ホストをディレクティブ プロセッサに接続する

ディレクティブ プロセッサを使用してカスタム ホストをテストする

テキスト テンプレートを作成してカスタム ホストをテストする

カスタム ホストをテストする

関連するコンテンツ

フィードバック

その他のリソース

チュートリアル: 生成済みディレクティブプロセッサにホストを接続する

ドメイン固有言語ツールを使用してディレクティブプロセッサを生成する

カスタムテキストテンプレートホストをディレクティブプロセッサに接続する

ディレクティブプロセッサを使用してカスタムホストをテストする

テキストテンプレートを作成してカスタムホストをテストする

カスタムホストをテストする