Cómo: Definir lenguajes específicos de dominio
Para definir un lenguaje específico del dominio (DSL), se crea una solución de Visual Studio a partir de una plantilla. La parte clave de la solución es el diagrama DSL Definition (Definición de DSL), que se almacena en DslDefinition.dsl. DSL Definition (Definición de DSL) define las clases y las formas del DSL. Después de modificar y agregar estos elementos, puede agregar código de programa para personalizar el DSL con más detalle.
Si no tiene experiencia con los DSL, le recomendamos que trabaje en el DSL Tools Lab, que encontrará en este sitio: SDK de visualización y modelado
En este tema
Seleccionar una plantilla de solución
Patrones para definir un DSL
Clases de elemento de modelo
Formas del diagrama
Referencias y conectores
Formas que contienen listas: Formas de compartimiento
Puertos en los límites de otra forma
Calles
Tipos de propiedades
Personalizar el DSL
Solución de problemas
Seleccionar una plantilla de solución
Para definir un DSL, debe tener instalados los siguientes componentes:
Visual Studio |
|
Visual Studio SDK |
|
SDK de Visual Studio de visualización y modelado |
Para crear un nuevo lenguaje específico del dominio, cree una nueva solución de Visual Studio usando la plantilla de proyecto Domain-Specific Language (Lenguaje específico del dominio).
Para crear una solución de DSL
Cree una solución con la plantilla Domain-Specific Language (Lenguaje específico de dominio), que se encuentra en Otros tipos de proyecto/Extensibilidad, en el cuadro de diálogo Nuevo proyecto.
.png "Cuadro de diálogo para crear solución DSL")
Al hacer clic en Aceptar se abre el Domain-Specific Language Wizard (Asistente para lenguaje específico de dominio) y muestra una lista de plantillas de solución de DSL.
Haga clic en cada plantilla para ver una descripción. Elija la solución que más se parezca a lo que quiere crear.
Cada plantilla DSL define un DSL de trabajo básico. Editará este DSL para que se ajuste a sus requisitos.
Haga clic en cada muestra para obtener más información.
Seleccione Task Flow (Flujo de tareas) para crear un DSL que tenga calles. Las calles son particiones verticales u horizontales del diagrama.
Seleccione Component Models (Modelos de componentes) para crear un DSL que tenga puertos. Los puertos son pequeñas formas en el borde de una forma mayor.
Seleccione Class Diagrams (Diagramas de clases) para definir un DSL que tenga formas de compartimiento. Las formas de compartimiento contienen listas de elementos.
Seleccione Minimal Language (Lenguaje mínimo) en otros casos o si no está seguro.
Nota
Si quiere crear un diagrama de clases o un diagrama de componentes, considere la posibilidad de usar modelos UML.Las herramientas de modelado UML proporcionan un conjunto de diagramas que se integran alrededor de un único modelo.Son extensibles y se pueden integrar con su DSL mediante ModelBus.Para obtener más información, vea Desarrollar modelos para el diseño de software.
Seleccione Minimal WinForm Designer (Diseñador de WinForm mínimo) o Minimal WPF Designer (Diseñador de WPF mínimo) para crear un DSL que se muestre en una superficie de Windows Forms o WPF. Tendrá que escribir código para definir el editor. Para obtener más información, vea los temas siguientes:
Crear lenguajes específicos de dominio basados en Windows Forms
Escriba una extensión de nombre de archivo para su DSL en la página del asistente correspondiente. Esta es la extensión que usarán los archivos que contienen instancias de su DSL.
Elija una extensión de nombre de archivo que no esté asociada con ninguna aplicación en su equipo o en algún equipo donde quiera instalar el DSL. Por ejemplo, docx y htm no serían extensiones de nombre de archivo aceptables.
El asistente le advertirá en caso de que la extensión que haya especificado se esté usando como un DSL. Piense en usar una extensión de nombre de archivo diferente. También puede restablecer la instancia de Visual Studio SDK Experimental para borrar antiguos diseñadores experimentales. Haga clic en Inicio, en Todos los programas, en Microsoft Visual Studio 2010 SDK, en Tools y, después, en Reset the Microsoft Visual Studio 2010 Experimental instance (Restablecer la instancia experimental de Microsoft Visual Studio 2010).
Puede ajustar la configuración en las demás páginas o dejar los valores predeterminados.
Haga clic en Finalizar.
El asistente crea una solución que contiene dos o tres proyectos, y genera código a partir de la definición de DSL.
Ahora, la interfaz de usuario es similar a la imagen siguiente.
.png "diseñador dsl")
Esta solución define un lenguaje específico de dominio. Para obtener más información, vea Información general sobre la interfaz de usuario de las herramientas de los lenguajes específicos de dominio.
Probar la solución
La solución de plantilla proporciona un DSL de trabajo, que puede modificar o usar tal cual.
Para probar la solución, presione F5 o CTRL+F5. Se abre una nueva instancia de Visual Studio en modo experimental.
En la nueva instancia de Visual Studio, en el Explorador de soluciones, abra el archivo Sample. Se abre como un diagrama, con un cuadro de herramientas.
Si ejecuta una solución que ha creado con la plantilla Minimal Language (Lenguaje mínimo), la instancia experimental de Visual Studio se parecerá a la del ejemplo siguiente:
.png "DSL_min")
Experimente con las herramientas. Cree elementos y conéctelos.
Cierre la instancia experimental de Visual Studio.
Nota
Cuando haya modificado el DSL, ya no podrá ver las formas en el archivo de prueba Sample.Sin embargo, podrá crear nuevos elementos.
Modificar la plantilla de DSL
Cambie el nombre y conserve algunas o todas las clases de dominio y clases de forma en la plantilla de definición de DSL. Los nuevos nombres de clase deben ser nombres CLR válidos, sin espacios ni puntuación.
Conservar estas clases es especialmente útil:
La clase raíz aparece en la parte superior izquierda del diagrama DSL Definition (Definición de DSL), en Classes and Relationships (Clases y relaciones). Asígnele otro nombre según el DSL. Por ejemplo, un DSL llamado MusicLibrary podría tener una clase raíz llamada Music.
La clase de diagrama aparece en la parte inferior derecha del diagrama DSL Definition (Definición de DSL), en la columna Diagram Elements (Elementos de diagrama). Quizás tenga que desplazarse a la derecha para verlo. Normalmente se llama suDslDiagram.
Si usó la plantilla Task Flow (Flujo de tareas) y quiere crear diagramas con calles, guarde la clase de dominio Actor y la forma ActorSwimlane, y cámbieles el nombre.
Elimine o cambie el nombre de otras clases para que se ajusten a sus necesidades.
Patrones para definir un DSL
Le recomendamos que desarrolle un DSL agregando o ajustando una o dos características cada vez. Agregue una característica, ejecute el DSL y pruébelo y, después, agregue una o dos características más. Una característica típica de su DSL podría ser:
Una clase de dominio, la relación de incrustación que conecta el elemento con el modelo, la forma necesaria para mostrar elementos de esa clase en el diagrama y la herramienta de elemento que permite a los usuarios crear elementos.
Las propiedades de dominio de una clase de dominio y los elementos Decorator que los muestran en una forma.
Una relación de referencia y el conector que la muestra en el diagrama, y la herramienta de conector que permite a los usuarios crear vínculos.
Una personalización que requiere código de programa, como una restricción de validación o un comando de menú.
En las secciones siguientes se describe cómo construir los tipos de características DSL más útiles. Hay muchos otros patrones con los que se puede construir un DSL, pero estos son los que se usan con más frecuencia.
Nota
Después de agregar una característica, no olvide hacer clic en Transformar todas las plantillas en la barra de herramientas del Explorador de soluciones antes de compilar y ejecutar su DSL.
La figura siguiente muestra las clases y relaciones que forman parte del DSL y que se usan como ejemplo en este tema.
.png "Relaciones de incrustación y referencia")
La siguiente figura es un modelo de ejemplo de este DSL:
.png "Modelo de instancia de DSL generado")
Nota
Con "modelo" nos referimos a una instancia de su DSL que los usuarios crean y que normalmente se muestra como un diagrama.En este tema se explican tanto el diagrama DSL Definition (Definición de DSL) como los diagramas de modelo que aparecen cuando se usa su DSL.
Definir clases de dominio
Las clases de dominio representan los conceptos de su DSL. Las instancias son elementos de modelo. Por ejemplo, en un DSL MusicLibrary, quizás tenga las clases de dominio Album y Song.
Para crear una clase de dominio, puede arrastrar desde la herramienta Named Domain Class (Clase de dominio con nombre) al diagrama y, después, cambiar el nombre de la clase.
Para obtener más información, vea Propiedades de las clases de dominio.
Crear una relación incrustada para cada clase de dominio
Todas las clases de dominio, excepto la clase raíz, deben ser el destino de al menos una relación de incrustación, o deben heredar de una clase que sea el destino de una relación de incrustación.
En un modelo, todos los elementos de modelo son nodos de un único árbol de relaciones incrustadas. El origen y el destino de una relación de incrustación suelen denominarse clases primaria y secundaria.
La selección de una clase primaria para una clase de dominio depende de cómo quiere que la duración de sus elementos dependa de otros elementos. Si se elimina un nodo de un árbol, normalmente también se elimina su subárbol. Por lo tanto, las clases de elemento que tienen una existencia independiente se incrustan directamente debajo de la clase raíz.
Normalmente, si muestra un elemento dentro de otro elemento, quiere indicar una relación de propiedad. En ese caso, la clase primaria más apropiada es la clase del contenedor. La excepción es cuando el elemento que ve dentro del contendor es tan solo un vínculo de referencia a un elemento independiente. En ese caso, al eliminar el contenedor se elimina la referencia pero no el destino.
En los patrones de una definición de DSL que se describen en este tema, damos por hecho que los elementos que se muestran dentro de un contenedor se eliminarán cuando el contenedor se elimine. Se pueden lograr esquemas más complejos mediante la definición de reglas.
Cómo se muestra el elemento |
Clase primaria (incrustación) |
Ejemplo en la plantilla de solución de DSL |
|---|---|---|
Forma en el diagrama Calle. |
Clase raíz del DSL. |
Minimal Language. Task Flow: clase Actor. |
Forma en una calle. |
Clase de dominio de los elementos que se muestran como calles. |
Task Flow: clase Task. |
Elemento en una lista en una forma; el elemento se elimina si el contenedor se elimina. Puerto en el borde de una forma. |
Clase de dominio que se asigna a la forma del contenedor. |
Class diagram: clase Attribute. Component diagram: clase Port. |
Elemento en una lista; no se elimina si el contenedor se elimina. |
Clase raíz del DSL. La lista muestra vínculos de referencia. |
|
No se muestra directamente. |
Clase de la que forma parte. |
En el ejemplo de la biblioteca de música, los álbumes se muestran como rectángulos en los que se enumeran los títulos de las canciones. Por lo tanto, la clase primaria de Album es la clase raíz Music, y la clase primaria de Song es Album.
Para crear una clase de dominio y su incrustación al mismo tiempo, haga clic en la herramienta Embedding Relationship (Relación de incrustación), en la clase primaria y,después, en una parte en blanco del diagrama.
Normalmente no es necesario ajustar el nombre de la relación de incrustación y de sus roles, porque rastrearán los nombres de las clases automáticamente.
Para obtener más información, vea Propiedades de las relaciones de dominio y Propiedades de los roles de dominio.
Nota
Incrustación no es lo mismo que herencia.En una relación de incrustación, las clases secundarias no heredan las características de sus primarias.
Agregar propiedades de dominio a cada clase de dominio
Las propiedades de dominio almacenan valores. Algunos ejemplos son: Name, Title, Publication Date.
Haga clic en Domain Properties (Propiedades de dominio) en la clase, presione la tecla ENTRAR y, después, escriba el nombre de una propiedad. El tipo predeterminado de una propiedad de dominio es String. Si quiere cambiar el tipo, seleccione la propiedad de dominio y establezca el valor de Type (Tipo) en la ventana Properties (Propiedades). Si el tipo que quiere no está en la lista desplegable, vea Agregar tipos de propiedad.
Establezca una propiedad Element Name (Nombre de elemento). Seleccione una propiedad de dominio que se pueda usar para identificar los elementos en el explorador del lenguaje. Por ejemplo, en la clase de dominio Song que pueda seleccionar la propiedad de dominio Title (Título). En la ventana Properties (Propiedades), establezca Is Element Name (Es nombre de elemento) en true.
Crear clases de dominio derivadas
Si quiere que una clase de dominio tenga variantes que hereden sus propiedades y relaciones, cree clases que deriven de ella. Por ejemplo, Album podría tener las clases derivadas WMA y MP3.
Cree la clase derivada usando la herramienta Domain Class (Clase de dominio).
Haga clic en la herramienta Inheritance (Herencia), haga clic en la clase derivada y, después, haga clic en la clase base.
Considere la posibilidad de establecer el valor de Inheritance Modifier (Modificador de herencia) de la clase base en abstract (abstracto). Si cree que puede necesitar instancias de la clase base, considere la posibilidad de crear en su lugar una clase derivada diferente para ellas.
Las clases derivadas heredan las propiedades y los roles de sus clases base.
Ordenar el diagrama DSL Definition (Definición de DSL)
Cuando se agregan relaciones, algunas de las clases aparecen en más de un lugar. Para reducir el número de apariciones y ampliar el diagrama, haga clic con el botón secundario en la clase de destino de una relación y, después, haga clic en Bring Tree Here (Traer árbol aquí). Para lograr el efecto opuesto, haga clic con el botón secundario en la clase de destino de una relación y haga clic en Split Tree (Dividir árbol). Si no ve estos comandos del menú, asegúrese de que solo está seleccionada la clase de dominio.
Use CTRL+Flecha arriba y CTRL+Flecha abajo para mover las clases de dominio y las clases de forma.
Probar las clases de dominio
Para probar las nuevas clases de dominio
Haga clic en Transformar todas las plantillas en la barra de herramientas del Explorador de soluciones para generar el código del diseñador de DSL. Este paso se puede automatizar. Para obtener más información, vea Cómo: Transformar automáticamente todas las plantillas.
Compile y ejecute el DSL. Presione F5 o CTRL+F5 para ejecutar una nueva instancia de Visual Studio en modo experimental. En la instancia experimental de Visual Studio, abra o cree un archivo que tenga la extensión de nombre de archivo de su DSL.
Abra el explorador. Al lado del diagrama está la ventana del explorador del lenguaje, que normalmente se llama suLenguaje Explorer. Si no ve esta ventana, podría estar en una pestaña debajo del Explorador de soluciones. Si no lo encuentra, en el menú Ver, elija Otras ventanas y, después, haga clic en suLenguaje Explorer.
El explorador presenta una vista de árbol del modelo.
Crear nuevos elementos. Haga clic con el botón derecho en el nodo raíz, en la parte superior, y haga clic en Add New (Agregar nuevo) suClase.
En el explorador del lenguaje aparece una nueva instancia de su clase.
Cuando cree nuevas instancias, compruebe que cada instancia tenga un nombre diferente. Esto solo sucede si ha establecido la marca Is Element Name (Es nombre de elemento) en una propiedad de dominio.
Examine las propiedades de dominio. Con una instancia de la clase seleccionada, inspeccione la ventana Properties (Propiedades). Debe mostrar las propiedades de dominio que ha definido en esta clase de dominio.
Guarde el archivo, ciérrelo y vuelva a abrirlo. Después de expandir los nodos en el explorador, todas las instancias creadas deben ser visibles.
Definir formas en el diagrama
Puede definir clases de elementos que aparecen en un diagrama, como rectángulos, elipses o iconos.
Para definir una clase de elementos que aparecen como formas en un diagrama
Defina y pruebe una clase de dominio, tal y como se describe en Definir clases de dominio**.**
La clase primaria debería ser la clase raíz. Es decir, debería haber una relación de incrustación entre la clase raíz y la nueva clase de dominio.
Si el diagrama tiene calles, la clase primaria puede ser la clase de dominio que está asignada a una calle. Antes de continuar con este procedimiento, vea Definir un DSL que tiene calles.
Agregue una clase de forma para representar los elementos en el diagrama del modelo. Arrastre desde una de las siguientes herramientas al diagrama DSL Definition (Definición de DSL):
Geometry Shape (Forma geométrica) proporciona un rectángulo o una elipse.
Image Shape (Forma de imagen) muestra una imagen que proporcione.
Compartment Shape (Forma de compartimiento) es un rectángulo que contiene una o varias listas de elementos.
Cambie el nombre de la clase de forma, que aparecerá en el lado derecho del diagrama DSL Definition (Definición de DSL), en Shapes and Connectors (Formas y conectores).
Defina una imagen, si ha creado una forma de imagen.
Cree un archivo de imagen de cualquier tamaño. Se admiten los formatos BMP, JPEG, GIF y EMF.
En el Explorador de soluciones, agregue el archivo a la solución, en Dsl\Resources.
Vuelva al diagrama DSL Definition (Definición de DSL) y seleccione la nueva clase de forma de imagen.
En la ventana Properties (Propiedades), haga clic en la propiedad Image (Imagen).
En el cuadro de diálogo Select Image (Seleccionar imagen), haga clic en el menú desplegable File name (Nombre de archivo) y seleccione la imagen.
Agregar elementos Decorator de texto a la forma para mostrar las propiedades de dominio.
Para mostrar el nombre o el título del elemento de modelo, probablemente necesitará al menos un elemento Decorator de texto.
Haga clic con el botón secundario en el encabezado de la clase de forma, elija Add (Agregar) y haga clic en Text Decorator (Decorator de texto). Establezca el nombre del elemento Decorator y, en la ventana Properties (Propiedades), establezca su Position (Posición).
Use una asignación de elemento de diagrama para conectar cada forma con la clase de dominio que debe mostrar.
Haga clic en la herramienta Diagram Element Map (Asignación de elemento de diagrama), en la clase de dominio y en la clase de forma.
Asigne las propiedades a los elementos Decorator de texto.
Seleccione la línea gris entre la clase de dominio y la clase de forma que representa la asignación de elemento de diagrama.
En la ventana DSL Details (Detalles de DSL), haga clic en la pestaña Decorator Maps (Asignaciones de elementos Decorator). Si no ve la ventana DSL Details (Detalles de DSL), en el menú Ver, elija Otras ventanas y haga clic en DSL Details (Detalles de DSL). Normalmente es necesario levantar la parte superior de esta ventana para ver todo su contenido.
Seleccione el nombre de un elemento Decorator. En Display property (Mostrar propiedad), seleccione el nombre de una propiedad de la clase de dominio. Repita este paso para cada elemento Decorator.
Si quiere mostrar una propiedad de un elemento relacionado, haga clic en el navegador de árbol desplegable en Path to display property (Ruta para mostrar la propiedad).
Asegúrese de que hay una marca de verificación junto al nombre de cada elemento Decorator.
.png "Ventana de asignaciones de formas y detalles de DSL")
Cree un elemento de cuadro de herramientas para crear los elementos de la clase de dominio.
En DSL Explorer (Explorador de DSL), expanda el nodo Editor y todos sus subnodos.
Haga clic con el botón secundario en el nodo, en las Toolbox Tabs (Pestañas de cuadro de herramientas) que tengan el mismo nombre que su DSL, por ejemplo, MusicLibrary. Haga clic en Add Element Tool (Agregar herramienta de elemento).
Nota
Si hace clic con el botón secundario en el nodo Tools (Herramientas), no verá Add Element Tool (Agregar herramienta de elemento).En su lugar, haga clic en el nodo situado encima de él.
En la ventana Properties (Propiedades), con la nueva herramienta de elemento seleccionada, establezca Class (Clase) en la clase de dominio que ha agregado recientemente.
Establezca el valor de Caption (Título) y de Tooltip (Información sobre herramientas).
Establezca el valor de Toolbox Icon (Icono de cuadro de herramientas) en el icono que aparecerá en el cuadro de herramientas. Puede establecerlo en un icono nuevo o en un icono que ya se haya usado para otra herramienta.
Para crear un nuevo icono, abra Dsl\Resources en el Explorador de soluciones. Copie y pegue uno de los archivos BMP existentes de las herramientas de elemento. Cambie el nombre a la copia pegada y, después, haga doble clic en él para editarlo.
Vuelva al diagrama DSL Definition (Definición de DSL), seleccione la herramienta y, en la ventana Properties (Propiedades), haga clic en [...] en Toolbox Icon (Icono de cuadro de herramientas). En el cuadro de diálogo Select Bitmap (Seleccionar mapa de bits), seleccione el archivo .BMP en el menú desplegable.
Para obtener más información, vea Propiedades de las formas geométricas y Propiedades de las formas de imagen.
Para probar las formas
Haga clic en Transformar todas las plantillas en la barra de herramientas del Explorador de soluciones para generar el código del diseñador de DSL.
Compile y ejecute el DSL. Presione F5 o CTRL+F5 para ejecutar una nueva instancia de Visual Studio en modo experimental. En la instancia experimental de Visual Studio, abra o cree un archivo que tenga la extensión de nombre de archivo de su DSL.
Compruebe que las herramientas de elemento aparecen en el cuadro de herramientas.
Cree formas arrastrando desde una herramienta al diagrama del modelo.
Compruebe que aparecen todos los elementos Decorator de texto y que:
Puede editarlos, a menos que haya establecido la marca Is UI Read Only (Es IU de solo lectura) en la propiedad de dominio.
Cuando se edita la propiedad en la ventana Properties (Propiedades) o en el elemento Decorator, la otra vista se actualiza.
Después de probar una forma por primera vez, quizás quiera ajustar algunas de sus propiedades y agregar algunas características más avanzadas. Para obtener más información, vea Personalizar y ampliar lenguajes específicos de dominio.
Definir relaciones de referencia
Puede definir una relación de referencia entre cualquier clase de dominio de origen y cualquier clase de dominio de destino. Las relaciones de referencia suelen mostrarse en un diagrama como conectores, que son líneas entre formas.
Por ejemplo, si los álbumes y los artistas se muestran como formas en el diagrama, podría definir una relación llamada ArtistsAppearedOnAlbums que vincula los artistas con los álbumes en los que han trabajado. Vea el ejemplo en la figura.
Las relaciones de referencia también pueden vincular elementos del mismo tipo. Por ejemplo, en un DSL que representa un árbol genealógico, la relación entre los padres y los hijos es una relación de referencia de persona a persona.
Definir una relación de referencia
Haga clic en la herramienta Reference Relationship (Relación de referencia), haga clic en la clase de dominio de origen de la relación y, después, haga clic en la clase de dominio de destino. La clase de destino puede ser la misma que la clase de origen.
Cada relación tiene dos roles, representados por la línea a cada lado del cuadro de relación. Puede seleccionar cada rol y establecer sus propiedades en la ventana Properties (Propiedades).
Considere la posibilidad de cambiar el nombre de los roles. Por ejemplo, en una relación entre personas, quizás quiera cambiar los nombres predeterminados por Padres e Hijos, Director y Subordinados, Profesor y Estudiante, etc.
Ajuste las multiplicidades de cada rol, si es necesario. Si quiere que cada persona tenga al menos un director, establezca la multiplicidad que aparece debajo de la etiqueta Director en el diagrama a 0..1.
Agregue propiedades de dominio a la relación. En la figura, la relación Artist-Album tiene una propiedad de rol.
Establezca la propiedad Allows Duplicates (Permite duplicados) de la relación, si puede haber más de un vínculo de la misma clase entre el mismo par de elementos de modelo. Por ejemplo, podría permitir que un Profesor enseñe más de una Asignatura al mismo Estudiante.
.png "Asignaciones de formas para conectores")
Para obtener más información, vea Propiedades de las relaciones de dominio y Propiedades de los roles de dominio.
Definir un conector para mostrar la relación
Un conector muestra una línea entre dos formas en el diagrama del modelo.
Arrastre la herramienta Connector (Conector) al diagrama DSL Definition (Definición de DSL).
Agregue elementos Decorator de texto si quiere mostrar etiquetas en el conector. Establezca sus posiciones. Para que el usuario pueda mover un elemento Decorator de texto, establezca su propiedad Is Moveable (Es móvil).
Use la herramienta Diagram Element Map (Asignación de elemento de diagrama) para vincular el conector con la relación de referencia.
Con la asignación de elemento de diagrama seleccionada, abra la ventana DSL Details (Detalles de DSL) y abra la pestaña Decorator Maps (Asignaciones de elementos Decorator).
Seleccione cada elemento Decorator y establezca el valor de Display property (Mostrar propiedad) en la propiedad de dominio correcta.
Asegúrese de que haya una marca de verificación junto a cada elemento de la lista Decorators.
Definir una herramienta Connection Builder (Generador de conexiones)
En la ventana DSL Explorer (Explorador de DSL), expanda el nodo Editor y todos sus subnodos.
Haga clic con el botón secundario en el nodo que tenga el mismo nombre que su DSL y haga clic en Add New Connection Tool (Agregar nueva herramienta de conexión).
Con la nueva herramienta seleccionada, en la ventana Properties (Propiedades):
Establezca el valor de Caption (Título) y de Tooltip (Información sobre herramientas).
Haga clic en Connection Builder (Generador de conexiones) y seleccione el generador apropiado para la nueva relación.
Establezca el valor de Toolbox Icon (Icono de cuadro de herramientas) en el icono que quiere que aparezca en el cuadro de herramientas. Puede establecerlo en un icono nuevo o en un icono que ya se haya usado para otra herramienta.
Para crear un nuevo icono, abra Dsl\Resources en el Explorador de soluciones. Copie y pegue uno de los archivos BMP existentes de las herramientas de elemento. Cambie el nombre a la copia pegada y, después, haga doble clic en él para editarlo.
Vuelva al diagrama DSL Definition (Definición de DSL), seleccione la herramienta y, en la ventana Properties (Propiedades), haga clic en [...] en Toolbox Icon (Icono de cuadro de herramientas). En el cuadro de diálogo Select Bitmap (Seleccionar mapa de bits), seleccione el archivo .BMP en el menú desplegable.
Para probar una relación de referencia y un conector
Haga clic en Transformar todas las plantillas en la barra de herramientas del Explorador de soluciones para generar el código del diseñador de DSL.
Compile y ejecute el DSL. Presione F5 o CTRL+F5 para ejecutar una nueva instancia de Visual Studio en modo experimental. En la instancia experimental de Visual Studio, abra o cree un archivo que tenga la extensión de nombre de archivo de su DSL.
Compruebe que la herramienta de conexión aparece en el cuadro de herramientas.
Cree formas arrastrando desde una herramienta al diagrama del modelo.
Cree conexiones entre las formas. Haga clic en la herramienta de conector, en una forma y, después, en otra forma.
Compruebe que no puede crear conexiones entre clases inapropiadas. Por ejemplo, si su relación es entre Albums y Artists, compruebe que no puede vincular Artists con Artists.
Compruebe que las multiplicidades son correctas. Por ejemplo, compruebe que no puede conectar una persona a más de un director.
Compruebe que aparecen todos los elementos Decorator de texto y que:
Puede editarlos, a menos que haya establecido la marca Is UI Read Only (Es IU de solo lectura) en la propiedad de dominio.
Cuando se edita la propiedad en la ventana Properties (Propiedades) o en el elemento Decorator, la otra vista se actualiza.
Después de probar un conector por primera vez, quizás quiera ajustar algunas de sus propiedades y agregar algunas características más avanzadas. Para obtener más información, vea Personalizar y ampliar lenguajes específicos de dominio.
Definir formas que contienen listas: Formas de compartimiento
Una forma de compartimiento contiene una o varias listas de elementos. Por ejemplo, en un DSL de biblioteca de música, podría usar formas de compartimiento para representar álbumes de música. En cada álbum, hay una lista de canciones.
.png "Forma de compartimiento")
En el método más sencillo de lograr este efecto en una definición de DSL, se define una clase de dominio para el contenedor y una clase de dominio para cada lista. La clase de contenedor se asigna a la forma de compartimiento.
.png "Asignación de formas")
Para obtener más información, vea Propiedades de las formas de compartimiento.
Para definir una forma de compartimiento
Cree la clase de dominio de contenedor. Haga clic en la herramienta Embedding Relationship (Relación de incrustación), en la clase raíz del modelo y, después, en una parte en blanco del diagrama DSL Definition (Definición de DSL). Esto crea la clase de dominio llamada Album en la figura de ejemplo.
En lugar de incrustarlo en la clase raíz, también puede incrustar el contenedor en una clase de dominio que esté asignada a una calle.
Agregue a la clase una propiedad de dominio, como Name, y establezca su marca Is Element Name (Es nombre de elemento) en la ventana Properties (Propiedades).
Cree la clase de dominio de elemento de lista. Haga clic en la herramienta Embedding Relationship (Relación de incrustación), en la clase de contenedor (Album) y, después, en una parte en blanco del diagrama. Esto crea la clase de dominio llamada Song en la figura de ejemplo.
Agregue a la clase una propiedad de dominio, como Title, y establezca su marca Is Element Name (Es nombre de elemento).
Agregue otras propiedades de dominio.
Agregue otra clase de dominio de elemento de lista para cada lista que quiera mostrar.
Para mezclar varios tipos de elementos en la lista, cree clases que hereden de la clase de lista. Establezca el valor de Inheritance Modifier (Modificador de herencia) para que la clase de lista sea abstracta.
Por ejemplo, si quiere que la música clásica se ordene por compositor en lugar de por artista, podría crear dos subclases de Song, ClassicalSong y NonClassicalSong.
Cree la forma de compartimiento. Arrastre desde la herramienta Compartment Shape (Forma de compartimiento) al diagrama DSL Definition (Definición de DSL).
Agregue un elemento Decorator de texto y establezca su nombre.
Agregue un compartimiento y establezca su nombre.
Para que el usuario pueda ocultar los compartimientos de lista, haga clic con el botón secundario en la clase de forma de compartimiento, elija Add (Agregar) y haga clic en Expand/Collapse Decorator (Elemento Decorator de expansión/contracción). En la ventana Properties (Propiedades), establezca la posición del elemento Decorator.
Haga clic en la herramienta Diagram Element Map (Asignación de elemento de diagrama), en la clase de dominio de contenedor y en la clase de forma de compartimiento.
Seleccione el vínculo de la asignación de elemento de diagrama entre la clase de dominio y la forma. En la ventana DSL Details (Detalles de DSL):
Haga clic en la pestaña Decorators (Elementos Decorator). Haga clic en el nombre del elemento Decorator y seleccione el elemento correspondiente en Display Property (Mostrar propiedad). Asegúrese de que haya una marca de verificación junto al nombre del elemento Decorator.
Haga clic en la pestaña Compartment Maps (Asignaciones de compartimientos).
Haga clic en el nombre del compartimiento.
En Displayed elements collection path (Ruta de acceso a la colección de elementos mostrados), navegue hasta la clase de elemento de lista (Song). Haga clic en la flecha hacia abajo para usar la herramienta de navegador.
En Display Property (Mostrar propiedad), seleccione la propiedad que se debe mostrar en la lista. En el ejemplo, es Title.
Nota
Use los campos Path (Ruta de acceso) del Decorator Map (Asignación de elemento Decorator) y los campos de Compartment Maps (Asignaciones de compartimientos) para crear relaciones más complejas entre las clases de dominio y la forma de compartimiento.
Para definir una herramienta para crear la forma
Cree un elemento de cuadro de herramientas para crear los elementos de la clase de dominio.
En DSL Explorer (Explorador de DSL), expanda el nodo Editor y todos sus subnodos.
Haga clic con el botón secundario en el nodo, en las Toolbox Tabs (Pestañas de cuadro de herramientas) que tengan el mismo nombre que su DSL, por ejemplo, MusicLibrary. Haga clic en Add Element Tool (Agregar herramienta de elemento).
Nota
Si hace clic con el botón secundario en el nodo Tools (Herramientas), no verá Add Element Tool (Agregar herramienta de elemento).En su lugar, haga clic en el nodo situado encima de él.
En la ventana Properties (Propiedades), con la nueva herramienta de elemento seleccionada, establezca Class (Clase) en la clase de dominio que ha agregado recientemente.
Establezca el valor de Caption (Título) y de Tooltip (Información sobre herramientas).
Establezca el valor de Toolbox Icon (Icono de cuadro de herramientas) en el icono que aparecerá en el cuadro de herramientas. Puede establecerlo en un icono nuevo o en un icono que ya se haya usado para otra herramienta.
Para crear un nuevo icono, abra Dsl\Resources en el Explorador de soluciones. Copie y pegue uno de los archivos .BMP existentes de las herramientas de elemento. Cambie el nombre a la copia pegada y, después, haga doble clic en él para editarlo.
Vuelva al diagrama DSL Definition (Definición de DSL), seleccione la herramienta y, en la ventana Properties (Propiedades), haga clic en [...] en Toolbox Icon (Icono de cuadro de herramientas). En el cuadro de diálogo Select Bitmap (Seleccionar mapa de bits), seleccione el archivo BMP en el menú desplegable.
Para probar una forma de compartimiento
Haga clic en Transformar todas las plantillas en la barra de herramientas del Explorador de soluciones para generar el código del diseñador de DSL.
Compile y ejecute el DSL. Presione F5 o CTRL+F5 para ejecutar una nueva instancia de Visual Studio en modo experimental. En la instancia experimental de Visual Studio, abra o cree un archivo que tenga la extensión de nombre de archivo de su DSL.
Compruebe que la herramienta aparece en el cuadro de herramientas.
Arrastre la herramienta al diagrama del modelo. Se crea una forma.
Compruebe que el nombre del elemento aparece y se establece automáticamente en un valor predeterminado.
Haga clic con el botón secundario en el encabezado de la nueva forma y, después, haga clic en Add su elemento de lista (Agregar su elemento de lista). En el ejemplo, el comando es Add Song (Agregar canción).
Compruebe que aparece un elemento en la lista y que tiene un nombre nuevo.
Haga clic en uno de los elementos de lista y, después, examine la ventana Properties (Propiedades). Verá las propiedades de los elementos de lista.
Abra el explorador del lenguaje. Compruebe que puede ver los nodos de contenedor con los nodos de elemento de lista dentro.
.png "Explorador generado de DSL")
Después de probar una forma de compartimiento por primera vez, quizás quiera ajustar algunas de sus propiedades y agregar algunas características más avanzadas. Para obtener más información, vea Personalizar y ampliar lenguajes específicos de dominio.
Mostrar un vínculo de referencia en un compartimiento
Normalmente, un elemento que se muestra en un compartimiento es un elemento secundario del elemento que está representado por la forma de compartimiento. Pero a veces querrá mostrar un elemento que está vinculado a él con una relación de referencia.
Por ejemplo, podríamos agregar un segundo compartimiento a AlbumShape que muestra una lista de los artistas que están vinculados al álbum.
En este caso, el compartimiento debe mostrar el vínculo en lugar del elemento referenciado. El motivo es que quiere que, cuando el usuario seleccione el elemento en el compartimiento y presione Supr, se elimine el vínculo, no el elemento referenciado.
En cualquier caso, puede hacer que se muestre el nombre del elemento referenciado en el compartimiento.
En el procedimiento siguiente se da por hecho que ya ha creado la clase de dominio, la relación de referencia, la forma de compartimiento y la asignación de elemento de diagrama, tal y como se describió anteriormente en esta sección.
Para mostrar un vínculo de referencia en un compartimiento
Agregue un compartimiento a la forma de compartimiento. En el diagrama DSL Definition (Definición de DSL), haga clic con el botón secundario en la clase de forma de compartimiento, elija Add (Agregar) y haga clic en Compartment (Compartimiento).
Establezca Displayed elements collection path (Ruta de acceso a la colección de elementos mostrados) para navegar hasta el vínculo en lugar de al elemento de destino. Haga clic en el menú desplegable y use la vista de árbol para seleccionar la relación de referencia en lugar de su destino. En este ejemplo, la relación es ArtistAppearedOnAlbums.
Establezca Path to Display Property (Ruta para mostrar la propiedad) para navegar desde el vínculo al elemento de destino. En el ejemplo, es Artist.
Establezca Display Property (Mostrar propiedad) en la propiedad correspondiente del elemento de destino, por ejemplo, Name (Nombre).
Después de Transformar todas las plantillas, compile y ejecute el DSL, y abra un modelo de prueba.
En el diagrama del modelo, cree las clases de forma apropiadas, establezca sus nombres y cree un vínculo entre ellas. En la forma de compartimiento, deben aparecer los nombres de los elementos vinculados.
Seleccione el vínculo o el elemento en la forma de compartimiento. Deben desaparecer tanto el vínculo como el elemento.
Definir puertos en los límites de otra forma
Un puerto es una forma que está situada en los límites de otra forma.
Los puertos se pueden usar para proporcionar un punto de conexión fijo en otra forma al cual el usuario puede dibujar conectores. En este caso, puede hacer que la forma de puerto sea transparente.
Para ver un ejemplo donde se usan puertos, seleccione la plantilla Component Diagram (Diagrama de componentes) cuando cree una nueva solución de DSL. En este ejemplo se muestran los principales aspectos para tener en cuenta al definir puertos:
Hay una clase de dominio que representa el contenedor de los puertos, Component.
Hay una clase de dominio que representa los puertos. En el ejemplo, es ComponentPort.
Hay una relación de incrustación desde la clase de dominio de contendor a la clase de dominio de puerto. Para obtener más información, vea Definir clases de dominio.
Si quiere mezclar diferentes tipos de puerto en el mismo contenedor, puede crear subclases de la clase de dominio de puerto. En el ejemplo, InPort y OutPort heredan de ComponentPort.
La clase de dominio de contenedor se puede asignar a cualquier tipo de forma. En el ejemplo, es ComponentShape. Para obtener más información, vea Definir formas.
Las clases de dominio de puerto se asignan a formas de puerto. Puede asignar las clases derivadas a clases de forma de puerto diferentes, o asignar la clase base a una clase de forma de puerto.
En otros aspectos, las formas de puerto se comportan tal y como se describe en Definir formas.
Para obtener más información, vea Propiedades de las formas de puerto.
Definir un DSL que tiene calles
Las calles son una partición horizontal o vertical de un diagrama. Cada calle corresponde a un elemento de modelo. Su definición de DSL requiere una clase de dominio para los elementos de calle.
La mejor manera de crear un DSL con calles es crear una nueva solución de DSL y elegir la plantilla de solución Task Flow (Flujo de tareas). En la definición de DSL, la clase Actor es la clase de dominio asignada a la calle. Cambie el nombre de esta y otras clases para adaptarlas a su proyecto.
Para agregar una clase que se mostrará como una forma dentro de una calle, cree una relación de incrustación entre la clase de calle y la nueva clase. Los usuarios podrán arrastrar elementos desde una calle a otra, pero cada elemento siempre estará dentro de una calle determinada. En la plantilla de solución Task Flow (Flujo de tareas), FlowElement es una clase secundaria de la clase de calle.
Para agregar una clase que se mostrará como una forma independiente de las calles, cree una relación de incrustación entre la clase raíz y la nueva clase. Los usuarios podrán colocar estas formas en cualquier lugar del diagrama, incluso traspasando los límites de las calles y fuera de ellas. En la plantilla de solución Task Flow (Flujo de tareas), Comment es una clase secundaria de la clase raíz.
Para obtener más información, vea Propiedades de las calles.
Agregar tipos de propiedad
Literales y enumeradores de dominio
Una enumeración de dominio es un tipo con varios valores literales.
Para agregar una enumeración de dominio, haga clic con el botón secundario en la raíz del modelo, en DSL Explorer (Explorador de DSL), y haga clic en Add New Domain Enumeration (Agregar nueva enumeración de dominio). El elemento aparecerá en DSL Explorer (Explorador de DSL), en el nodo Domain Types (Tipos de dominio). Este elemento no aparece en el diagrama.
Para agregar literales de enumeración a la enumeración de dominio, haga clic con el botón secundario en DSL Explorer (Explorador de DSL) y, después, haga clic en Add New Enumeration Literal (Agregar nuevo literal de enumeración).
De forma predeterminada, una propiedad que tiene un tipo de enumeración solo se puede establecer en un valor de la enumeración al mismo tiempo. Si quiere que los usuarios y programadores puedan establecer cualquier combinación de valores (un "campo de bits"), establezca la propiedad IsFlags de la enumeración.
Tipos externos
Cuando se establece el tipo de una propiedad de dominio, si no encuentra el tipo que quiere en la lista desplegable Type (Tipo), puede agregar un tipo externo. Por ejemplo, podría agregar el tipo System.Drawing.Color a la lista.
Para agregar un tipo, haga clic con el botón secundario en la raíz del modelo, en DSL Explorer (Explorador de DSL), y haga clic en Add New External Type (Agregar nuevo tipo externo). En la ventana Properties (Propiedades), establezca el nombre en Color y el espacio de nombres en System.Drawing. Este tipo ahora aparece en DSL Explorer (Explorador de DSL), en Domain Types (Tipos de dominio). Puede elegirlo siempre que establezca el tipo de una propiedad de dominio.
Personalizar el DSL
Con las técnicas descritas en este tema, puede crear rápidamente un DSL con una notación en forma de diagrama, un formato XML legible, y las herramientas básicas que se necesitan para generar código y otros artefactos.
Hay dos métodos para extender la definición de DSL:
Ajuste el DSL usando más características de la definición de DSL. Por ejemplo, puede crear una sola herramienta de conector que pueda crear varios tipos de conector, y puede controlar las reglas por las que al eliminar un elemento también se eliminan los elementos relacionados. Estas técnicas se logran principalmente estableciendo valores en la definición de DSL, y algunas requieren unas cuantas líneas de código de programa.
Para obtener más información, vea Personalizar y ampliar lenguajes específicos de dominio.
Amplíe sus herramientas de modelado usando código de programa para lograr efectos más avanzados. Por ejemplo, puede crear comandos de menú que pueden cambiar el modelo, y puede crear herramientas que integren dos o más DSL. VMSDK está diseñado específicamente para facilitar la integración de las extensiones con el código que se genera a partir de la definición de DSL. Para obtener más información, vea Escribir código para personalizar lenguajes específicos de dominio.
Cambiar la definición de DSL
Cuando se crea un elemento en una definición de DSL, muchos valores predeterminados se establecen automáticamente. Una vez establecidos, puede cambiarlos. Esto simplifica el desarrollo de un DSL, al tiempo que permite realizar personalizaciones eficaces.
Por ejemplo, cuando se asigna una forma a un elemento, la ruta del elemento primario de la asignación se establece automáticamente de acuerdo con la relación de incrustación de la clase de dominio. Sin embargo, si más adelante cambia la relación de incrustación, la ruta del elemento primario no cambia automáticamente.
Por lo tanto, debe tener en cuenta que, cuando se cambian algunas relaciones en una definición de DSL, no es extraño que aparezcan errores al guardar la definición o al transformar todas las plantillas. La mayoría de estos errores son fáciles de corregir. Haga doble clic en el informe de error para ver la ubicación del error.
Vea también Cómo: Cambiar el espacio de nombres de los lenguajes específicos de dominio.
Solución de problemas
En la tabla siguiente se enumeran algunos de los problemas más comunes que se encuentran al diseñar un DSL, además de sugerencias para solucionarlos. Encontrará más consejos en el foro de extensibilidad de las herramientas de visualización.
Problema |
Sugerencia |
|---|---|
Los cambios que he hecho en el archivo de definición de DSL no surten efecto. |
Haga clic en Transformar todas las plantillas en la barra de herramientas situada encima del Explorador de soluciones, y vuelva a compilar la solución. |
Las formas muestran el nombre de un elemento Decorator en lugar del valor de la propiedad. |
Configure la asignación del elemento Decorator. En el diagrama DSL Definition (Definición de DSL), haga clic en la asignación de elemento de diagrama, que es la línea gris entre la clase de dominio y la clase de forma. Abra la ventana DSL Details (Detalles de DSL). Si no lo ve, en el menú Ver, elija Otras ventanas y, después, haga clic en DSL Details (Detalles de DSL). Haga clic en la pestaña Decorator Maps (Asignaciones de elementos Decorator). Seleccione el nombre del elemento Decorator. Asegúrese de que la casilla situada junto a él está activada. En Display property (Mostrar propiedad), seleccione el nombre de la propiedad de dominio. Para obtener más información, vea Formas del diagrama. |
En DSL Explorer (Explorador de DSL), no puedo agregar nada a una colección. Por ejemplo, al hacer clic con el botón secundario en Tools (Herramientas), no hay ningún comando "Add Tool" (Agregar herramienta) en el menú. En el explorador de mi DSL, no puedo agregar un elemento a una lista. |
Haga clic en el elemento situado encima del nodo que está intentando. Cuando quiera agregar algo a una lista, el comando Add (Agregar) no está en el nodo de lista, sino en su propietario. |
Creé una clase de dominio pero no puedo crear instancias en el explorador del lenguaje. |
Todas las clases de dominio, excepto la raíz, deben ser el destino de una relación de incrustación. |
En el explorador de mi DSL, los elementos se muestran solo con sus nombres de tipo. |
En la definición de DSL, seleccione una propiedad de dominio de la clase y, en la ventana Properties (Propiedades), establezca Is Element Name (Es nombre de elemento) en true. |
Mi DSL siempre se abre en el editor XML. |
El motivo puede ser que se produjo un error mientras se leía el archivo. Sin embargo, después de corregir ese error, debe restablecer explícitamente el editor para que sea su diseñador de DSL. Haga clic con el botón secundario en el elemento de proyecto, haga clic en Open With (Abrir con) y seleccione suLenguaje Designer (Default) [Diseñador de suLenguaje (Predeterminado)]. |
El cuadro de herramientas de mi DSL no aparece después de cambiar los nombres de ensamblado. |
Inspeccione y actualice DslPackage\GeneratedCode\Package.tt. Para obtener más información, vea Cómo: Cambiar el espacio de nombres de los lenguajes específicos de dominio. |
El cuadro de herramientas de mi DSL no aparece, pero no he cambiado el nombre del ensamblado. O bien, se muestra un cuadro de mensaje que indica un error al cargar una extensión. |
Restablezca la instancia experimental y vuelva a compilar la solución.
|
Vea también
Tareas
Crear lenguajes específicos de dominio basados en Windows Forms