Estendere il DSL mediante MEF
È possibile estendere il linguaggio specifico del dominio usando Managed Extensibility Framework (MEF). L'utente o altri sviluppatori potranno scrivere estensioni per il DSL senza modificare la definizione DSL e il codice del programma. Tali estensioni includono comandi di menu, gestori di trascinamento della selezione e convalida. Gli utenti potranno installare il linguaggio DSL e quindi, facoltativamente, installare le estensioni.
Inoltre, quando si abilita MEF nel DSL, può essere più semplice scrivere alcune delle funzionalità del dsl, anche se sono tutte compilate insieme al DSL.
Per altre informazioni su MEF, vedere Managed Extensibility Framework (MEF).
Per abilitare l'estensione DSL da parte di MEF
Creare una nuova cartella denominata MefExtension all'interno del progetto DslPackage . Aggiungere i file seguenti:
Nome file:
CommandExtensionVSCT.ttImportante
Impostare il GUID in questo file come il GUID CommandSetId definito in 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 file:
CommandExtensionRegistrar.tt<#@ Dsl processor="DslDirectiveProcessor" requires="fileName='..\..\Dsl\DslDefinition.dsl'" #> <#@ include file="DslPackage\CommandExtensionRegistrar.tt" #>Nome file:
ValidationExtensionEnablement.tt<#@ Dsl processor="DslDirectiveProcessor" requires="fileName='..\..\Dsl\DslDefinition.dsl'" #> <#@ include file="DslPackage\ValidationExtensionEnablement.tt" #>Nome file:
ValidationExtensionRegistrar.ttSe si aggiunge questo file, è necessario abilitare la convalida nel linguaggio DSL usando almeno una delle opzioni in EditorValidation in Esplora DSL.
<#@ Dsl processor="DslDirectiveProcessor" requires="fileName='..\..\Dsl\DslDefinition.dsl'" #> <#@ include file="DslPackage\ValidationExtensionRegistrar.tt" #>Nome file:
PackageExtensionEnablement.tt<#@ Dsl processor="DslDirectiveProcessor" requires="fileName='..\..\Dsl\DslDefinition.dsl'" #> <#@ include file="DslPackage\PackageExtensionEnablement.tt" #>Creare una nuova cartella denominata MefExtension all'interno del progetto Dsl . Aggiungere i file seguenti:
Nome file:
DesignerExtensionMetaDataAttribute.tt<#@ Dsl processor="DslDirectiveProcessor" requires="fileName='..\..\Dsl\DslDefinition.dsl'" #> <#@ include file="Dsl\DesignerExtensionMetadataAttribute.tt" #>Nome file:
GestureExtensionEnablement.tt<#@ Dsl processor="DslDirectiveProcessor" requires="fileName='..\..\Dsl\DslDefinition.dsl'" #> <#@ include file="Dsl\GestureExtensionEnablement.tt" #>Nome file:
GestureExtensionController.tt<#@ Dsl processor="DslDirectiveProcessor" requires="fileName='..\..\Dsl\DslDefinition.dsl'" #> <#@ include file="Dsl\GestureExtensionController.tt" #>Aggiungere la riga seguente al file esistente denominato DslPackage\Commands.vsct:
<Include href="MefExtension\CommandExtensionVSCT.vsct"/>Inserire la riga dopo la direttiva esistente
<Include>.Aprire DslDefinition.dsl.
In Esplora DSL selezionare Editor\Convalida.
Nella Finestra Proprietà assicurarsi che almeno una delle proprietà denominate Uses sia
true.Nella barra degli strumenti Esplora soluzioni fare clic su Trasforma tutti i modelli.
I file sussidiari vengono visualizzati sotto ogni file aggiunto.
Compilare ed eseguire la soluzione per verificare che funzioni ancora.
Il linguaggio DSL è ora abilitato per MEF. È possibile scrivere comandi di menu, gestori di movimenti e vincoli di convalida come estensioni MEF. È possibile scrivere queste estensioni nella soluzione DSL insieme ad altro codice personalizzato. Inoltre, l'utente o altri sviluppatori possono scrivere estensioni di Visual Studio separate che estendono il linguaggio DSL.
Creare un'estensione per un DSL abilitato per MEF
Se si ha accesso a un LINGUAGGIo DSL abilitato per MEF creato manualmente o da un altro utente, è possibile scrivere estensioni per esso. Le estensioni possono essere usate per aggiungere comandi di menu, gestori movimenti o vincoli di convalida. Per creare queste estensioni, usare una soluzione di estensione di Visual Studio (VSIX). La soluzione include due parti: un progetto di libreria di classi che compila l'assembly di codice e un progetto VSIX che crea un pacchetto dell'assembly.
Per creare un'estensione DSL VSIX
Creare un nuovo progetto Libreria di classi.
Nel nuovo progetto aggiungere un riferimento all'assembly del linguaggio DSL.
Questo assembly ha in genere un nome che termina con ". Dsl.dll".
Se si ha accesso al progetto DSL, è possibile trovare il file di assembly nella directory Dsl\bin\*
Se si ha accesso al file DSL VSIX, è possibile trovare l'assembly modificando l'estensione del file VSIX in ".zip". Decomprimere il file ZIP.
Aggiungere riferimenti agli assembly .NET seguenti:
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
Creare un nuovo progetto di progetto VSIX.
In Esplora soluzioni fare clic con il pulsante destro del mouse sul progetto VSIX e scegliere Imposta come progetto di avvio.
Nel nuovo progetto, open source.extension.vsixmanifest.
Fare clic su Aggiungi contenuto. Nella finestra di dialogo impostare Tipo di contenuto su Componente MEF e Progetto di origine sul progetto di libreria di classi.
Aggiungere un riferimento VSIX al linguaggio DSL.
In source.extension.vsixmanifest fare clic su Aggiungi riferimento
Nella finestra di dialogo fare clic su Aggiungi payload e quindi individuare il file VSIX del linguaggio DSL. Il file VSIX è compilato nella soluzione DSL, in DslPackage\bin\*.
In questo modo gli utenti possono installare il linguaggio DSL e l'estensione contemporaneamente. Se l'utente ha già installato il linguaggio DSL, verrà installata solo l'estensione.
Esaminare e aggiornare gli altri campi di source.extension.vsixmanifest. Fare clic su Seleziona edizioni e verificare che siano impostate le edizioni di Visual Studio corrette.
Aggiungere codice al progetto di libreria di classi. Usare gli esempi nella sezione successiva come guida.
È possibile aggiungere un numero qualsiasi di classi di comando, movimento e convalida.
Per testare l'estensione, premere F5. Nell'istanza sperimentale di Visual Studio creare o aprire un file di esempio del linguaggio DSL.
Scrittura di estensioni MEF per DSLs
È possibile scrivere estensioni nel progetto di codice assembly di una soluzione di estensione DSL separata. È anche possibile usare MEF nel progetto DslPackage, come modo pratico per scrivere comandi, movimenti e codice di convalida come parte del linguaggio DSL.
Comandi di menu
Per scrivere un comando di menu, definire una classe che implementa e anteporre ICommandExtension alla classe l'attributo definito nel linguaggio DSL, denominato YourDslCommandExtension. È possibile scrivere più classi di comandi di menu.
QueryStatus() viene chiamato ogni volta che l'utente fa clic con il pulsante destro del mouse sul diagramma. Deve esaminare la selezione corrente e impostare command.Enabled per indicare quando il comando è applicabile.
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"; }
}
}
}
Gestori movimenti
Un gestore movimenti può gestire gli oggetti trascinati nel diagramma da qualsiasi posizione, all'interno o all'esterno di Visual Studio. L'esempio seguente consente all'utente di trascinare i file da Esplora risorse nel diagramma. Crea elementi che contengono i nomi di file.
È possibile scrivere gestori per gestire i trascinamenti da altri modelli DSL e modelli UML. Per altre informazioni, vedere Procedura: Aggiungere un gestore di trascinamento della selezione.
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();
}
}
}
}
Vincoli di convalida
I metodi di convalida sono contrassegnati dall'attributo ValidationExtension generato dal linguaggio DSL e anche da ValidationMethodAttribute. Il metodo può essere visualizzato in qualsiasi classe non contrassegnata da un attributo.
Per altre informazioni, vedere Convalida in un linguaggio specifico del 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);
} } } }
Contenuto correlato
Commenti e suggerimenti
Presto disponibile: Nel corso del 2024 verranno gradualmente disattivati i problemi di GitHub come meccanismo di feedback per il contenuto e ciò verrà sostituito con un nuovo sistema di feedback. Per altre informazioni, vedere https://aka.ms/ContentUserFeedback.
Invia e visualizza il feedback per