在 VS 扩展中调用文本转换

项目
08/12/2011

更新：2011 年 3 月

如果要编写菜单命令或域特定语言等 Visual Studio 扩展，则可以使用文本模板化服务来转换文本模板。获取 STextTemplating 服务并将其转换为 ITextTemplating。

获取文本模板化服务

using Microsoft.VisualStudio.TextTemplating;
using Microsoft.VisualStudio.TextTemplating.VSHost;
...
// Get a service provider – how you do this depends on the context:
IServiceProvider serviceProvider = dte; 

// Get the text template service:
ITextTemplating t4 = serviceProvider.GetService(typeof(STextTemplating)) as ITextTemplating;

// Process a text template:
string result = t4.ProcessTemplate(filePath, System.IO.File.ReadAllText(filePath));

将参数传递给模板

可以将参数传递给模板。在模板内，可以使用 <#@parameter#> 指令获取参数值。

对于参数类型，必须使用可序列化的或可封送的类型。也就是说，必须使用 SerializableAttribute 声明该类型，或者它必须派生自 MarshalByRefObject。此限制是必要的，因为文本模板在单独的 AppDomain 中执行。所有内置类型（例如 System.String 和 System.Int32）都是可序列化的。

为传递参数值，调用代码可将值放在 Session 字典或 CallContext 中。

以下示例使用这两种方法来转换一个简短的测试模板：

using Microsoft.VisualStudio.TextTemplating;
using Microsoft.VisualStudio.TextTemplating.VSHost;
...
// Get a service provider – how you do this depends on the context:
IServiceProvider serviceProvider = dte; 

// Get the text template service:
ITextTemplating t4 = serviceProvider.GetService(typeof(STextTemplating)) as ITextTemplating;
ITextTemplatingSessionHost sessionHost = t4 as ITextTemplatingSessionHost;

// Create a Session in which to pass parameters:
sessionHost.Session = sessionHost.CreateSession();
sessionHost.Session["parameter1"] = "Hello";
sessionHost.Session["parameter2"] = DateTime.Now;

// Pass another value in CallContext:
System.Runtime.Remoting.Messaging.CallContext.LogicalSetData("parameter3", 42);

// Process a text template:
string result = t4.ProcessTemplate("",
   // This is the test template:
   "<#@parameter type=\"System.String\" name=\"parameter1\"#>"
 + "<#@parameter type=\"System.DateTime\" name=\"parameter2\"#>"
 + "<#@parameter type=\"System.Int32\" name=\"parameter3\"#>"
 + "Test: <#=parameter1#>    <#=parameter2#>    <#=parameter3#>");

// This test code yields a result similar to the following line:
//     Test: Hello    07/06/2010 12:37:45    42

错误报告和输出指令

处理过程中出现的任何错误都将显示在 Visual Studio 错误窗口中。另外，您还可以通过指定实现 ITextTemplatingCallback 的回调来获得错误通知。

如果要将结果字符串写入文件，您可能需要知道模板的 <#@output#> 指令中指定的文件扩展名和编码。此信息也将传递给您的回调。有关更多信息，请参见 T4 输出指令。

void ProcessMyTemplate(string MyTemplateFile)
{
  string templateContent = File.ReadAllText(MyTemplateFile);
  T4Callback cb = new T4Callback();
  // Process a text template:
  string result = t4.ProcessTemplate(MyTemplateFile, templateContent, cb);
  // If there was an output directive in the MyTemplateFile,
  // then cb.SetFileExtension() will have been called.
  // Determine the output file name:
  string resultFileName = 
    Path.Combine(Path.GetDirectoryName(MyTemplateFile), 
        Path.GetFileNameWithoutExtension(MyTemplateFile)) 
      + cb.fileExtension;
  // Write the processed output to file:
  File.WriteAllText(resultFileName, result, cb.outputEncoding);
  // Append any error messages:
  if (cb.errorMessages.Count > 0)
  {
    File.AppendAllLines(resultFileName, cb.errorMessages);
  }
}

class T4Callback : ITextTemplatingCallback
{
  public List<string> errorMessages = new List<string>();
  public string fileExtension = ".txt";
  public Encoding outputEncoding = Encoding.UTF8;

  public void ErrorCallback(bool warning, string message, int line, int column)
  { errorMessages.Add(message); }

  public void SetFileExtension(string extension)
  { fileExtension = extension; }

  public void SetOutputEncoding(Encoding encoding, bool fromOutputDirective)
  { outputEncoding = encoding; }
}

可以通过类似于下面的模板文件测试代码：

<#@output extension=".htm" encoding="ASCII"#>
<# int unused;  // Compiler warning "unused variable"
#>
Sample text.

编辑器警告将显示在 Visual Studio 错误窗口中，还将生成对 ErrorCallback 的调用。

引用参数

可以使用从 MarshalByRefObject 派生的参数类将值从文本模板传出。

修订记录

日期	修订记录	原因
2011 年 3 月	创建了主题	信息补充。

2011 年 3 月

创建了主题

信息补充。

通过