了解 DSL 代码

ConnectionBuilders.cs

连接生成器是用于创建关系的类。 它是位于连接工具后面的代码。 此文件包含一对用于每个连接工具的类。 它们的名称派生自域关系和连接工具的名称：RelationshipBuilder 和 ConnectorToolConnectAction。

（在组件解决方案示例中，其中一个连接生成器称为 ConnectionBuilder，这是一个巧合，因为域关系名为 Connection。）

关系在 RelationshipBuilder.Connect() 方法中创建。 默认版本将验证源和目标模型元素是否为可接受，然后实例化该关系。 例如：

CommentReferencesSubject(sourceAccepted, targetAccepted);

每个生成器类都生成自 DSL 资源管理器的“连接生成器”部分中的节点。 一个 Connect 方法可在一对或多对域类之间创建关系。 每一对都由链接连接指令定义，可在 DSL 资源管理器中的生成器节点下查找该指令。

例如，可以为示例 DSL 中三种类型关系的每一种添加一个连接生成器链接连接指令。 这将向用户提供单独的连接工具。 实例化的关系类型将依赖于由用户选择的源和目标元素的类型。 若要添加链接连接指令，请在 DSL 资源管理器中右键单击生成器。

若要编写在创建特定类型的域关系时运行的自定义代码，请在生成器节点下选择相应的链接连接指令。 在“属性”窗口中，设置“使用自定义连接”。 重新生成解决方案，然后提供代码以更正产生的错误。

若要编写每当用户使用此连接工具时运行的自定义代码，请设置连接生成器的“为自定义”属性。 可提供代码来确定是否允许源元素、是否允许特定的源和目标的组合，以及在进行连接时应对模型进行哪些更新。 例如，仅当连接不会在关系图中创建循环时才可允许连接。 可以在源和目标之间实例化多个相关元素的更复杂模式，而不是单一关系链接。

Diagram.cs

包含可定义关系图的类。 它派生自 Diagram。

若要使颜色和某些其他样式功能在运行时可变，请右键单击 DSL 定义关系图上的类并指向“公开添加”。

此外，此文件包含 FixupDiagram 规则，该规则将在新元素添加到模型时响应。 该规则将添加新的形状并将该形状链接到模型元素。

DomainClasses.cs

已定义的域类的实现，包括抽象类和模型根类。 它们派生自 ModelElement。

每个域类包含：

• 每个域属性的属性定义和嵌套处理程序类。 可重写 OnValueChanging() 和 OnValueChanged()。 有关详细信息，请参阅域属性值更改处理程序。

  在示例 DSL 中，Comment 类包含属性 Text 和处理程序类 TextPropertyHandler。

• 此域类参与的关系的访问器属性。 （没有用于角色属性的嵌套类。）

  在示例 DSL 中，Comment 类具有通过嵌入关系 ComponentModelHasComments 访问其父模型的访问器。

• 构造函数。 如果想要重写这些构造函数，则在域类上设置“具有自定义构造函数”。

• 元素组原型 (EGP) 处理程序方法。 如果用户可以将另一个元素合并（添加）到此类的实例上，则这些方法是必要的。 通常用户通过从元素工具或另一个形状进行拖动或通过粘贴来执行此操作。

  在示例 DSL 中，“输入端口”或“输出端口”可以合并到“组件”上。 此外，“组件”和“注释”可以合并到模型上。 此

  “组件”类中的 EGP 处理程序方法允许“组件”接受“端口”，但不接受“注释”。 根模型类中的 EGP 处理程序可接受“注释”和“组件”，但不接受“端口”。

DomainModelResx.resx

它包含了诸如域类和属性的说明、属性名称、工具箱标签、标准错误消息等字符串以及可以显示给用户的其他字符串。 它还包含工具图标和用于图像形状的图像。

此文件将绑定到生成的程序集中，并提供这些资源的默认值。 通过创建包含资源的本地化版本的附属程序集，可对 DSL 进行本地化。 当 DSL 安装在与本地化资源相匹配的区域性时，将使用该版本。 有关详细信息，请参阅部署域特定语言解决方案。

HelpKeywordHelper.cs

提供当用户按 F1 时使用的函数。

PropertiesGrid.cs

此文件仅在你已将自定义类型描述符附加到域属性时才包含代码。 有关详细信息，请参阅自定义“属性”窗口。

Serializer.cs

用于每个域类、关系、形状、连接符、关系图和模型的序列化程序类。

这些类的很多功能都可以由 DSL 资源管理器中的“Xml 序列化行为”下的设置控制。

ToolboxHelper.cs

通过将元素组原型安装到元素工具中来设置工具箱。 当用户运行该工具时，这些原型的副本将与目标元素合并。

可以重写 CreateElementPrototype() 来定义用于创建一组多个对象的工具箱项。 例如，你可以定义某个项来表示具有子组件的对象。 更改代码后，重置 Visual Studio 的实验实例来清除工具箱缓存。

Constants.cs

GUID。

DocView.cs

YourDslDocView 可管理将在其中显示关系图的窗口。 例如，可以将关系图嵌入在 Windows 窗体内：

将用户控件文件添加到 DslPackage 项目。 添加可在其中显示关系图的面板。 添加按钮和其他控件。 在窗体的代码视图中，添加以下代码，从而调整名称以适应你的 DSL：

using System;
using System.Collections.Generic;
using System.ComponentModel;
using System.Drawing;
using System.Data;
using System.Linq;
using System.Text;
using System.Windows.Forms;
using Microsoft.VisualStudio.Modeling;
using Microsoft.VisualStudio.Modeling.Shell;
namespace Company.EmbedInForm
{
  public partial class UserControl1 : UserControl
  {
    public UserControl1()
    {
      InitializeComponent();
    }
    
    private DiagramDocView docView;
    public UserControl1(DiagramDocView docView, Control content)
      : this()
    {
      this.docView = docView;
      panel1.Controls.Add(content);
    }
    private void button1_Click(object sender, EventArgs e)
    {
      ExampleModel modelRoot = this.docView.CurrentDiagram.ModelElement as ExampleModel;
      foreach (ExampleElement element in modelRoot.Elements)
      {
       listBox1.Items.Add(element.Name);
      }
    }
  }
  internal partial class EmbedInFormDocView
  {
    private ContainerControl container;
    /// <summary>
    /// Return a User Control instead of the DSL window. 
    /// The user control will contain the DSL window.
    /// </summary>
    public override System.Windows.Forms.IWin32Window Window
    {
      get
      {
        if (container == null)
        {
          // Put the normal DSL Window inside our control
          container = new UserControl1(this, (Control)base.Window);
        }
        return container;
      }
    }
  }
}

GeneratedVSCT.vsct

查找菜单（例如关系图上下文菜单、“编辑”菜单等等）上的标准菜单命令。 命令的代码是 CommandSet.cs。 可以重定位或修改标准命令，并可以添加自己的命令。 有关详细信息，请参阅编写用户命令和操作。

ModelExplorerToolWindow.cs

定义将在其中显示模型资源管理器的窗口。 处理资源管理器中的项的选择。

Source.extension.vsixmanifest

若要自定义此文件，请编辑 .tt 文件。

此文件控制将 DSL 打包到 Visual Studio 集成扩展 (VSIX) 中的方式。 有关详细信息，请参阅部署域特定语言解决方案。