Estender a DSL usando MEF
Você pode estender sua linguagem específica do domínio (DSL) usando Managed Extensibility Framework (MEF). Você ou outros desenvolvedores poderão escrever extensões para a DSL sem alterar a definição de DSL e o código do programa. Essas extensões incluem comandos de menu, manipuladores de arrastar e soltar e validação. Os usuários poderão instalar sua DSL e, opcionalmente, instalar extensões para ela.
Além disso, quando você habilita o MEF em sua DSL, pode ser mais fácil para você escrever alguns dos recursos de sua DSL, mesmo que todos eles sejam criados junto com a DSL.
Para saber mais informações sobre o MEF, consulte Managed Extensibility Framework (MEF).
Para permitir que sua DSL seja estendida pelo MEF
Crie uma nova pasta chamada MefExtension dentro do projeto DslPackage. Adicione os arquivos a seguir:
Nome de arquivo:
CommandExtensionVSCT.ttImportante
Defina o GUID neste arquivo como o mesmo que o CommandSetId do GUID definido em DslPackage\GeneratedCode\Constants.tt
<#@ Dsl processor="DslDirectiveProcessor" requires="fileName='..\..\Dsl\DslDefinition.dsl'" #> <# // CmdSet Guid must be defined before master template is included // This Guid must be kept synchronized with the CommandSetId Guid in Constants.tt Guid guidCmdSet = new Guid ("00000000-0000-0000-0000-000000000000"); string menuidCommandsExtensionBaseId="0x4000"; #> <#@ include file="DslPackage\CommandExtensionVSCT.tt" #>Nome do arquivo:
CommandExtensionRegistrar.tt<#@ Dsl processor="DslDirectiveProcessor" requires="fileName='..\..\Dsl\DslDefinition.dsl'" #> <#@ include file="DslPackage\CommandExtensionRegistrar.tt" #>Nome do arquivo:
ValidationExtensionEnablement.tt<#@ Dsl processor="DslDirectiveProcessor" requires="fileName='..\..\Dsl\DslDefinition.dsl'" #> <#@ include file="DslPackage\ValidationExtensionEnablement.tt" #>Nome do arquivo:
ValidationExtensionRegistrar.ttSe você adicionar esse arquivo, deverá habilitar a validação em sua DSL usando pelo menos uma das opções no EditorValidation no Gerenciador de DSL.
<#@ Dsl processor="DslDirectiveProcessor" requires="fileName='..\..\Dsl\DslDefinition.dsl'" #> <#@ include file="DslPackage\ValidationExtensionRegistrar.tt" #>Nome do arquivo:
PackageExtensionEnablement.tt<#@ Dsl processor="DslDirectiveProcessor" requires="fileName='..\..\Dsl\DslDefinition.dsl'" #> <#@ include file="DslPackage\PackageExtensionEnablement.tt" #>Crie uma nova pasta chamada MefExtension dentro do projeto Dsl. Adicione os arquivos a seguir:
Nome do arquivo:
DesignerExtensionMetaDataAttribute.tt<#@ Dsl processor="DslDirectiveProcessor" requires="fileName='..\..\Dsl\DslDefinition.dsl'" #> <#@ include file="Dsl\DesignerExtensionMetadataAttribute.tt" #>Nome do arquivo:
GestureExtensionEnablement.tt<#@ Dsl processor="DslDirectiveProcessor" requires="fileName='..\..\Dsl\DslDefinition.dsl'" #> <#@ include file="Dsl\GestureExtensionEnablement.tt" #>Nome do arquivo:
GestureExtensionController.tt<#@ Dsl processor="DslDirectiveProcessor" requires="fileName='..\..\Dsl\DslDefinition.dsl'" #> <#@ include file="Dsl\GestureExtensionController.tt" #>Adicione a seguinte linha ao arquivo existente chamado DslPackage\Commands.vsct:
<Include href="MefExtension\CommandExtensionVSCT.vsct"/>Insira a linha após a diretiva existente
<Include>.Abra DslDefinition.dsl.
No Gerenciador DSL, selecione Editor\Validation.
No janela Propriedades, verifique se pelo menos uma das propriedades chamada Usos é
true.Na barra de ferramentas do Gerenciador de Soluções, clique em Transformar Todos os Modelos.
Os arquivos de subsidiária aparecem abaixo de cada um dos arquivos que você adicionou.
Compile e execute a solução para verificar se ela ainda está funcionando.
Sua DSL agora está habilitada para MEF. Você pode escrever comandos de menu, manipuladores de gestos e restrições de validação como extensões MEF. Você pode escrever essas extensões em sua solução DSL junto com outro código personalizado. Além disso, você ou outros desenvolvedores podem escrever extensões separadas do Visual Studio que estendem sua DSL.
Criar uma extensão para uma DSL habilitada para MEF
Se você tiver acesso a uma DSL habilitada para MEF criada por você ou por outra pessoa, poderá escrever extensões para ela. As extensões podem ser usadas para adicionar comandos de menu, manipuladores de gestos ou restrições de validação. Para criar essas extensões, use uma solução VSIX (extensão do Visual Studio). A solução tem duas partes: um projeto de biblioteca de classes que cria o assembly de código e um projeto VSIX que empacota o assembly.
Para criar uma extensão DSL VSIX
Crie um projeto de Biblioteca de Classes.
No novo projeto, adicione uma referência ao assembly da DSL.
Esse assembly geralmente tem um nome que termina com ".Dsl.dll".
Se você tiver acesso ao projeto DSL, poderá encontrar o arquivo de assembly no diretório Dsl\bin\*
Se você tiver acesso ao arquivo VSIX DSL, poderá encontrar o assembly alterando a extensão de nome de arquivo do arquivo VSIX para ".zip". Descompacte o arquivo .zip.
Adicione referências aos assemblies .NET a seguir:
Microsoft.VisualStudio.Modeling.Sdk.11.0.dll
Microsoft.VisualStudio.Modeling.Sdk.Diagrams.11.0.dll
Microsoft.VisualStudio.Modeling.Sdk.Shell.11.0.dll
System.ComponentModel.Composition.dll
System.Windows.Forms.dll
Criar um Projeto VSIX.
No Gerenciador de Soluções, clique com o botão direito do mouse no projeto do VSIX e selecione Definir como Projeto de Inicialização.
No novo projeto, abra source.extension.vsixmanifest.
Clique em Adicionar Conteúdo. Na caixa de diálogo, defina Tipo de Conteúdo como Componente MEF e Projeto de Origem como seu projeto de biblioteca de classes.
Adicione uma referência VSIX à DSL.
Em source.extension.vsixmanifest, clique em Adicionar Referência
Na caixa de diálogo, clique em Adicionar conteúdo e localize o arquivo VSIX da DSL. O arquivo VSIX é criado na solução DSL, em DslPackage\bin\*.
Isso permite que os usuários instalem a DSL e sua extensão ao mesmo tempo. Se o usuário já tiver instalado o DSL, somente a extensão será instalada.
Examine e atualize os outros campos de source.extension.vsixmanifest. Clique em Selecionar Edições e verifique se as edições corretas do Visual Studio estão definidas.
Adicione código ao projeto de biblioteca de classes. Use os exemplos na próxima seção como um guia.
Você pode adicionar qualquer número de classes de comando, gesto e validação.
Para testar a extensão, pressione F5. Na instância experimental do Visual Studio, crie ou abra um arquivo de exemplo da DSL.
Escrevendo extensões mef para DSLs
Você pode escrever extensões no projeto de código de assembly de uma solução de extensão DSL separada. Você também pode usar o MEF em seu projeto DslPackage, como uma maneira conveniente de escrever comandos, gestos e código de validação como parte da DSL.
Comandos de menu
Para escrever um comando de menu, defina uma classe que implementa ICommandExtension e prefixe a classe com o atributo definido em seu DSL, chamado YourDslCommandExtension. Você pode escrever mais de uma classe de comando de menu.
QueryStatus() é chamado sempre que o usuário clica com o botão direito do mouse no diagrama. Ele deve inspecionar a seleção atual e definir command.Enabled para indicar quando o comando é aplicável.
using System.ComponentModel.Composition;
using System.Linq;
using Company.MyDsl; // My DSL
using Company.MyDsl.ExtensionEnablement; // My DSL
using Microsoft.VisualStudio.Modeling; // Transactions
using Microsoft.VisualStudio.Modeling.Diagrams.ExtensionEnablement; // IVsSelectionContext
using Microsoft.VisualStudio.Modeling.ExtensionEnablement; // ICommandExtension
namespace MyMefExtension
{
// Defined in Dsl\MefExtension\DesignerExtensionMetaDataAttribute.cs:
[MyDslCommandExtension]
public class MyCommandClass : ICommandExtension
{
/// <summary>
/// Provides access to current document and selection.
/// </summary>
[Import]
IVsSelectionContext SelectionContext { get; set; }
/// <summary>
/// Called when the user selects this command.
/// </summary>
/// <param name="command"></param>
public void Execute(IMenuCommand command)
{
// Transaction is required if you want to update elements.
using (Transaction t = SelectionContext.CurrentStore
.TransactionManager.BeginTransaction("fix names"))
{
foreach (ExampleShape shape in SelectionContext.CurrentSelection)
{
ExampleElement element = shape.ModelElement as ExampleElement;
element.Name = element.Name + " !";
}
t.Commit();
}
}
/// <summary>
/// Called when the user right-clicks the diagram.
/// Determines whether the command should appear.
/// This method should set command.Enabled and command.Visible.
/// </summary>
/// <param name="command"></param>
public void QueryStatus(IMenuCommand command)
{
command.Enabled =
command.Visible = (SelectionContext.CurrentSelection.OfType<ExampleShape>().Count() > 0);
}
/// <summary>
/// Called when the user right-clicks the diagram.
/// Determines the text of the command in the menu.
/// </summary>
public string Text
{
get { return "My menu command"; }
}
}
}
Manipuladores de gestos
Um manipulador de gestos pode lidar com objetos arrastados para o diagrama de qualquer lugar, dentro ou fora do Visual Studio. O exemplo a seguir permite que o usuário arraste arquivos do Windows Explorer para o diagrama. Ele cria elementos que contêm os nomes de arquivo.
Você pode escrever manipuladores para lidar com arrastões de outros modelos DSL e modelos UML. Para obter mais informações, consulte Como adicionar um manipulador de arrastar e soltar.
using System.ComponentModel.Composition;
using System.Linq;
using Company.MyDsl;
using Company.MyDsl.ExtensionEnablement;
using Microsoft.VisualStudio.Modeling; // Transactions
using Microsoft.VisualStudio.Modeling.Diagrams;
using Microsoft.VisualStudio.Modeling.Diagrams.ExtensionEnablement;
using Microsoft.VisualStudio.Modeling.ExtensionEnablement;
namespace MefExtension
{
[MyDslGestureExtension]
class MyGestureExtension : IGestureExtension
{
public void OnDoubleClick(ShapeElement targetElement, DiagramPointEventArgs diagramPointEventArgs)
{
System.Windows.Forms.MessageBox.Show("double click!");
}
/// <summary>
/// Called when the user drags anything over the diagram.
/// Return true if the dragged object can be dropped on the current target.
/// </summary>
/// <param name="targetMergeElement">The shape or diagram that the mouse is currently over</param>
/// <param name="diagramDragEventArgs">Data about the dragged element.</param>
/// <returns></returns>
public bool CanDragDrop(ShapeElement targetMergeElement, DiagramDragEventArgs diagramDragEventArgs)
{
// This handler only allows items to be dropped onto the diagram:
return targetMergeElement is MefDsl2Diagram &&
// And only accepts files dragged from Windows Explorer:
diagramDragEventArgs.Data.GetFormats().Contains("FileNameW");
}
/// <summary>
/// Called when the user drops an item onto the diagram.
/// </summary>
/// <param name="targetDropElement"></param>
/// <param name="diagramDragEventArgs"></param>
public void OnDragDrop(ShapeElement targetDropElement, DiagramDragEventArgs diagramDragEventArgs)
{
MefDsl2Diagram diagram = targetDropElement as MefDsl2Diagram;
if (diagram == null) return;
// This handler only accepts files dragged from Windows Explorer:
string[] draggedFileNames = diagramDragEventArgs.Data.GetData("FileNameW") as string[];
if (draggedFileNames == null || draggedFileNames.Length == 0) return;
using (Transaction t = diagram.Store.TransactionManager.BeginTransaction("file names"))
{
// Create an element to represent each file:
foreach (string fileName in draggedFileNames)
{
ExampleElement element = new ExampleElement(diagram.ModelElement.Partition);
element.Name = fileName;
// This method of adding the new element allows the position
// of the shape to be specified:
ElementGroup group = new ElementGroup(element);
diagram.ElementOperations.MergeElementGroupPrototype(
diagram, group.CreatePrototype(), PointD.ToPointF(diagramDragEventArgs.MousePosition));
}
t.Commit();
}
}
}
}
Restrições de validação
Os métodos de validação são marcados pelo atributo ValidationExtension gerado pela DSL e também por ValidationMethodAttribute. O método pode aparecer em qualquer classe que não esteja marcada por um atributo.
Para obter mais informações, confira Validação em uma linguagem específica de domínio.
using Company.MyDsl;
using Company.MyDsl.ExtensionEnablement;
using Microsoft.VisualStudio.Modeling.Validation;
namespace MefExtension
{
class MyValidationExtension // Can be any class.
{
// SAMPLE VALIDATION METHOD.
// All validation methods have the following attributes.
// Specific to the extended DSL:
[MyDslValidationExtension]
// Determines when validation is applied:
[ValidationMethod(
ValidationCategories.Save
| ValidationCategories.Open
| ValidationCategories.Menu)]
/// <summary>
/// When validation is executed, this method is invoked
/// for every element in the model that is an instance
/// of the second parameter type.
/// </summary>
/// <param name="context">For reporting errors</param>
/// <param name="elementToValidate"></param>
private void ValidateClassNames
(ValidationContext context,
// Type determines to what elements this will be applied:
ExampleElement elementToValidate)
{
// Write code here to test values and links.
if (elementToValidate.Name.IndexOf(' ') >= 0)
{
// Log any unacceptable values:
context.LogError(
// Description:
"Name must not contain spaces"
// Error code unique to this type of error:
, "MyDsl001"
// Element to highlight when user double-clicks error:
, elementToValidate);
} } } }