Ampliar DSL mediante MEF
Puede ampliar el lenguaje específico del dominio (DSL) mediante Managed Extensibility Framework (MEF). Usted u otros desarrolladores podrán escribir extensiones para el DSL sin cambiar la definición de DSL y el código del programa. Estas extensiones incluyen comandos de menú, controladores de arrastrar y colocar y validar. Los usuarios podrán instalar su DSL y, opcionalmente, instalar extensiones para él.
Además, al habilitar MEF en su DSL, puede ser más fácil escribir algunas de las características de su DSL, incluso si todas se crean junto con el DSL.
Para más información sobre MEF, consulte Managed Extensibility Framework (MEF).
Para permitir que MEF amplíe su DSL
Cree una nueva carpeta denominada MefExtension dentro del proyecto DslPackage. Agregue los archivos siguientes a él:
Nombre de archivo:
CommandExtensionVSCT.ttImportante
Establezca el GUID en este archivo para que sea el mismo que el GUID CommandSetId que se define en 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" #>Nombre de archivo:
CommandExtensionRegistrar.tt<#@ Dsl processor="DslDirectiveProcessor" requires="fileName='..\..\Dsl\DslDefinition.dsl'" #> <#@ include file="DslPackage\CommandExtensionRegistrar.tt" #>Nombre de archivo:
ValidationExtensionEnablement.tt<#@ Dsl processor="DslDirectiveProcessor" requires="fileName='..\..\Dsl\DslDefinition.dsl'" #> <#@ include file="DslPackage\ValidationExtensionEnablement.tt" #>Nombre de archivo:
ValidationExtensionRegistrar.ttSi agrega este archivo, debe habilitar la validación en DSL mediante al menos uno de los modificadores de EditorValidation en el Explorador de DSL.
<#@ Dsl processor="DslDirectiveProcessor" requires="fileName='..\..\Dsl\DslDefinition.dsl'" #> <#@ include file="DslPackage\ValidationExtensionRegistrar.tt" #>Nombre de archivo:
PackageExtensionEnablement.tt<#@ Dsl processor="DslDirectiveProcessor" requires="fileName='..\..\Dsl\DslDefinition.dsl'" #> <#@ include file="DslPackage\PackageExtensionEnablement.tt" #>Cree una nueva carpeta denominada MefExtension dentro del proyecto Dsl. Agregue los archivos siguientes a él:
Nombre de archivo:
DesignerExtensionMetaDataAttribute.tt<#@ Dsl processor="DslDirectiveProcessor" requires="fileName='..\..\Dsl\DslDefinition.dsl'" #> <#@ include file="Dsl\DesignerExtensionMetadataAttribute.tt" #>Nombre de archivo:
GestureExtensionEnablement.tt<#@ Dsl processor="DslDirectiveProcessor" requires="fileName='..\..\Dsl\DslDefinition.dsl'" #> <#@ include file="Dsl\GestureExtensionEnablement.tt" #>Nombre de archivo:
GestureExtensionController.tt<#@ Dsl processor="DslDirectiveProcessor" requires="fileName='..\..\Dsl\DslDefinition.dsl'" #> <#@ include file="Dsl\GestureExtensionController.tt" #>Agregue la siguiente línea al archivo existente denominado DslPackage\Commands.vsct:
<Include href="MefExtension\CommandExtensionVSCT.vsct"/>Inserte la línea después de la directiva
<Include>existente.Abra DslDefinition.dsl.
En el Explorador de DSL, seleccione Editor\Validation.
En el ventana Propiedades, asegúrese de que al menos una de las propiedades denominadas Uses sea
true.En la barra de herramientas del Explorador de soluciones, haga clic en Transformar todas las plantillas.
Los archivos subsidiarios aparecen debajo de cada uno de los archivos que agregó.
Compile y ejecute la solución para comprobar que sigue funcionando.
Su DSL ahora está habilitado para MEF. Puede escribir comandos de menú, controladores de gestos y restricciones de validación como extensiones MEF. Puede escribir estas extensiones en la solución DSL junto con otro código personalizado. Además, usted u otros desarrolladores pueden escribir extensiones de Visual Studio independientes que extiendan su DSL.
Creación de una extensión para un DSL habilitado para MEF
Si tiene acceso a un DSL habilitado para MEF creado por usted mismo o por otra persona, puede escribir extensiones para él. Las extensiones se pueden usar para agregar comandos de menú, controladores de gestos o restricciones de validación. Para crear estas extensiones, use una solución de extensión de Visual Studio (VSIX). La solución tiene dos partes: un proyecto de biblioteca de clases que compila el ensamblado de código y un proyecto VSIX que empaqueta el ensamblado.
Para crear una extensión VSIX de DSL
Cree un proyecto de Biblioteca de clases.
En el nuevo proyecto, agregue una referencia al ensamblado del DSL.
Este ensamblado suele tener un nombre que termina con ".Dsl.dll".
Si tiene acceso al proyecto DSL, puede encontrar el archivo de ensamblado en el directorio Dsl\bin\*.
Si tiene acceso al archivo VSIX de DSL, puede encontrar el ensamblado cambiando la extensión de nombre de archivo del archivo VSIX a ".zip". Descomprima el archivo .zip.
Agregue referencias a los ensamblados siguientes:
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
Crear un nuevo proyecto Proyecto de VSIX.
En el Explorador de soluciones, haga clic con el botón derecho en el proyecto VSIX y elija Establecer como proyecto de inicio.
En el nuevo proyecto, abra source.extension.vsixmanifest.
Haga clic en Agregar contenido. En el cuadro de diálogo, establezca Tipo de contenido en Componente MEF y Proyecto de origen en el proyecto de biblioteca de clases.
Agregue una referencia VSIX al DSL.
En source.extension.vsixmanifest, haga clic en Agregar referencia.
En el cuadro de diálogo, haga clic en Agregar carga útil y busque el archivo VSIX del DSL. El archivo VSIX está integrado en la solución DSL, en DslPackage\bin\*.
Esto permite a los usuarios instalar el DSL y la extensión al mismo tiempo. Si el usuario ya ha instalado el DSL, solo se instalará la extensión.
Revise y actualice los demás campos de source.extension.vsixmanifest. Haga clic en Seleccionar ediciones y compruebe que estén establecidas las ediciones correctas de Visual Studio.
Agregue código al proyecto de biblioteca de clases. Use los ejemplos de la sección siguiente como guía.
Puede agregar cualquier número de clases de comando, gesto y validación.
Para probar la extensión, presione F5. En la instancia experimental de Visual Studio, cree o abra un archivo de ejemplo del DSL.
Escritura de extensiones MEF para DSL
Puede escribir extensiones en el proyecto de código de ensamblado de una solución de extensión DSL independiente. También puede usar MEF en el proyecto DslPackage, como una manera cómoda de escribir comandos, gestos y código de validación como parte del DSL.
Comandos de menú
Para escribir un comando de menú, defina una clase que implemente ICommandExtension y prefije la clase con el atributo definido en el DSL, denominado YourDslCommandExtension. Puede escribir más de una clase de comando de menú.
QueryStatus() se llama cada vez que el usuario hace clic con el botón derecho en el diagrama. Debe inspeccionar la selección actual y establecer command.Enabled para indicar cuándo se aplica el comando.
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"; }
}
}
}
Controladores de gestos
Un controlador de gestos puede tratar con objetos arrastrados al diagrama desde cualquier lugar, dentro o fuera de Visual Studio. En el ejemplo siguiente se permite al usuario arrastrar archivos desde el Explorador de Windows al diagrama. Crea elementos que contienen los nombres de archivo.
Puede escribir controladores para tratar con arrastres de otros modelos DSL y modelos UML. Para más información, consulte Procedimiento: Adición de un controlador de arrastrar y colocar.
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();
}
}
}
}
Restricciones de validación
Los métodos de validación se marcan mediante el atributo ValidationExtension generado por el DSL y también por ValidationMethodAttribute. El método puede aparecer en cualquier clase que no esté marcada por un atributo.
Para más información, consulte Validación en los lenguajes específicos de dominio.
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);
} } } }
Contenido relacionado
Comentarios
Próximamente: A lo largo de 2024 iremos eliminando gradualmente GitHub Issues como mecanismo de comentarios sobre el contenido y lo sustituiremos por un nuevo sistema de comentarios. Para más información, vea: https://aka.ms/ContentUserFeedback.
Enviar y ver comentarios de