DOSSIER DE SPECIFICATIONS

Transcription

1 Ed it e ur graphique d a r ch it e ct ure d e composan ts Fra ct al 1

2 TABLE DES MATIERES 1. Introduction But du document Contexte d utilisation Types d utilisateurs Contexte matériel Contexte logiciel Decription du produit Les éléments graphiques Les éléments textuels... 5 Ce sont les éléments accessibles uniquement à partir de la vue properties Représentation des éléments graphiques Représentation des éléments textuels Description des fonctionnalités Fonctionnalités Création d un nouveau fichier Fractal Charger un fichier Fractal existant Création d un élément graphique Suppression d un élément graphique Création/modification d un élément textuel Diagramme de cas d utilisation Traitement des erreurs Fichier d entrée Erreur d édition Evolutions prévues ou possibles : Annexe A Ed it e ur graphique d a r ch it e ct ure d e composan ts Fra ct al 2

3 1. INTRODUCTION 1.1. But du document Dans ce document, il s agit de décrire de façon claire et détaillée les différentes fonctions énumérées dans le cahier des charges Contexte d utilisation Types d utilisateurs Les utilisateurs de ce logiciel seront, dans un premier temps, les développeurs en composants de l équipe OSPM. Dans un second temps, au cas ou le logiciel serait rendu OPEN Source, il sera utilisé par n importe quelle personne. Néanmoins, il est à noter que le logiciel sera utilisé dans tous les cas par des connaisseurs du modèle de composant Fractal d une part, et de l IDE Eclipse d autre part, comme nous le verrons Contexte matériel Le produit à fournir sera entièrement développé en java. Il en héritera donc une propriété intéressante qui est la portabilité. De ce fait, le logiciel pourra être utilisé sur n importe quelle machine disposant d une JVM (Java Virtual Machine) Contexte logiciel Le logiciel sera développé en tant que plug-in Eclipse et il ne pourra s exécuter en mode standalone.toute personne souhaitant l utiliser doit au préalable se munir de l IDE Eclipse et installer ce plug-in. La dépendance avec les plug-ins GMF, EMF et GEF nécessite également leur installation. Ed it e ur graphique d a r ch it e ct ure d e composan ts Fra ct al 3

4 2. DECRIPTION DU PRODUIT Le produit à développer est un outil graphique permettant de définir une architecture de composants Fractal et servant de support à de nombreuses fonctionnalités additionnelles. L outil graphique devra donc fournir toutes les fonctionnalités d édition d une architecture de composants Fractal. Cette architecture est définie à partir des éléments appartenant à la spécification du langage ADL Fractal fournie en Annexe A. Ces éléments peuvent être classés dans deux catégories : Les éléments graphiques : Il s agit des éléments qui doivent avoir une représentation graphique dans l outil d édition. Chacun de ces éléments apparaît sous la forme d une figure qu on peut créer, supprimer, déplacer, agrandir... Les éléments textuels : Ces éléments ne sont associés à aucune figure, mais ils existent et on peut les créer ou les supprimer à partir de la vue properties 1 d Eclipse Les éléments graphiques Voici la liste des éléments du modèle qui auront une représentation graphique. Ils sont issus de la spécification de l ADL Fractal 2. Definition C est l élément racine de tout fichier fractal. Il peut contenir des instances de tous les autres éléments manipulés, en plus d un nom, des arguments sous forme de chaîne de caractères et un nom de fichier spécifiant éventuellement une autre définition qu elle étend. Un élément Definition peut être primitif ou composite : o Primitif : lorsqu il ne peut contenir qu un élément Content o o Composite : lorsqu elle ne contient pas d élément Content, elle peut alors contenir des composants. 1 Voir glossaire 2 Voir la spécification de l ADL Fractal en annexe A Ed it e ur graphique d a r ch it e ct ure d e composan ts Fra ct al 4

5 Component C est l élément de cœur du modèle, il représente un composant. Excepté l élément Definition, il peut faire référence à tout autre type du modèle, ainsi qu à lui-même. On peut aussi définir un élément Component primitif ou composite de la même façon que les éléments Definition. Un élément Component doit avoir un nom, il peut avoir un lien vers un élément Definition. Interface Un élément Interface appartient à un élément Component ou Definition. Un élément Interface doit avoir un nom, un rôle et une signature. Elle peut aussi avoir un champ contingency, qui permet d exprimer si c est une interface obligatoire ou optionnelle, et un champ cardinality qui spécifie si c est une interface simple ou une interface de collection. Le champ role peut prendre l une des valeurs suivantes : Server : Il s agit alors d une interface qui fournit un service Client : L interface requiert alors un service Binding Un élément Binding représente le lien entre les éléments interface. Certaines contraintes s imposent concernant la compatibilité des interfaces liées Les éléments textuels Ce sont les éléments accessibles uniquement à partir de la vue properties. Content Spécifie le fichier d implémentation d un composant. Il doit définir le nom du fichier d implémentation sans extension ainsi que le langage en lequel il est écrit. Attributes Spécifie les différents attributs d un composant. Il contient plusieurs éléments attribute. Il doit spécifier la signature de la structure des attributs. Attribute Sert à spécifier la valeur initiale d un attribut. Il doit avoir un nom et une valeur. Controller Spécifie le générateur de contrôleur. Il doit avoir une description. Il peut spécifier un langage dans lequel ses interfaces doivent être implémentées. Par défaut, ce langage est le même que celui de l implémentation du contenu. Ed it e ur graphique d a r ch it e ct ure d e composan ts Fra ct al 5

6 Comment Un commentaire qui peut être attaché à tout autre type d éléments. Il peut spécifier un langage, comme il doit avoir du texte. Cflag C est un argument du compilateur. Il doit avoir une valeur en chaîne de caractères. Ldflag C est aussi un argument du compilateur. Il doit avoir une valeur en chaîne de caractères. Include Un fichier d implémentation additionnel à inclure. Son nom doit être fourni. Output Le format de sortie du résultat de compilation, qui peut être un exécutable, une DLL ou une archive. Ed it e ur graphique d a r ch it e ct ure d e composan ts Fra ct al 6

7 2.3. Représentation des éléments graphiques Une convention graphique a été adoptée en concertation avec nos maîtres de stage pour le choix des figures relatives à chaque élément. Definition et Component : La représentation d un élément Definition est la même que celle d un élément Component. Cependant, la nuance est faite entre les types primitif et composite. o Primitif Caractéristiques Le label représente la valeur de l attribut name de l élément. Cette figure ne peut contenir aucune autre. La couleur par défaut utilisée est le gris clair pour l intérieur et le gris foncé pour le contour. Ed it e ur graphique d a r ch it e ct ure d e composan ts Fra ct al 7

8 Composite Caractéristiques Le label représente la valeur de l attribut name de l élément. Cette figure peut contenir d autres figures de composants de même type ou de type primitif. La couleur par défaut utilisée est le blanc pour l intérieur et le gris foncé pour le contour. Ed it e ur graphique d a r ch it e ct ure d e composan ts Fra ct al 8

9 Interface o Client o Serveur : Caractéristiques La couleur par défaut utilisée est le vert pour l interface de rôle serveur et le rouge pour le client. Chaque interface est rattachée à une figure de composant ou définition. Ces figures seront toujours attachées à la figure du composant auquel elles appartiennent comme ci-dessous : Binding Le sens choisi est celui du client vers le serveur. Ed it e ur graphique d a r ch it e ct ure d e composan ts Fra ct al 9

10 Hiérarchie des composants et profondeur de l affichage 2.4. Représentation des éléments textuels Comme convenu, les éléments textuels pourront être édités dans la vue properties d Eclipse. Les voici : Content L élément Content est affiché comme une propriété de l élément Component ou Primitive Definition. Attributes Primitive L élément Atributes est affiché comme une liste contenant les propriétés des différents éléments Attribute. Cet élément sera affiché dans la vue des propriétés de l élément component correspondant. Ed it e ur graphique d a r ch it e ct ure d e composan ts Fra ct al 10

11 Attribute Attribute est affiché comme un élément de la liste Attributes dans la vue des propriétés. Controller, Comment,Cflag, Ldflag, Include et Output : Tous ces éléments apparaîtront dans la vue properties de l élément Component ou Definition qui les contient. Ed it e ur graphique d a r ch it e ct ure d e composan ts Fra ct al 11

12 3. DESCRIPTION DES FONCTIONNALITES 3.1. Fonctionnalités Création d un nouveau fichier Fractal 1. L utilisateur clique sur le menu File/New/Other/Diagram d Eclipse, et un Wizard lui est proposé. 2. Ce Wizard lui propose de saisir un nom pour le fichier diagram (qui contiendra les informations pour la représentation graphique). 3. L utilisateur saisit un nom et clique directement sur le bouton de confirmation, ou bien sans effectuer de saisie, le nom du fichier diagram sera «default.fratal_diagram» suivi éventuellement d un numéro. 4. Ensuite le Wizard lui propose de saisir un nom pour le fichier Fractal ADL (qui contiendra le modèle). 5. L utilisateur saisit un nom et clique directement sur le bouton de confirmation, ou bien sans effectuer de saisie, le nom du fichier de modèle sera «default.fractal», suivi éventuellement d un numéro. 6. A chaque étape, l utilisateur a la possibilité d annuler son action en cliquant sur le bouton d annulation. 7. L éditeur s ouvre Charger un fichier Fractal existant Deux manières de charger un fichier Fractal : a) Soit à la création d un nouveau fichier Fractal : Lors de l étape (4), l utilisateur clique sur le bouton «Advanced >>», puis clique sur l option «Link to file in the file system», et choisit enfin un le fichier Fractal existant. Ensuite il valide. b) Soit dans un projet déjà créé : 1. L utilisateur ajoute un fichier fractal 2. Fait un clic droit sur le fichier, puis choisit ««Initialize fractal_diagram file». Le contenu du fichier Fractal est alors chargé dans l éditeur Création d un élément graphique Une palette d outils graphiquescorrespondant à chaque élément graphique est associée à l éditeur. 1. L utilisateur clique sur la figure de la palette qui correspond à l élément qu il veut créer. 2. Ensuite il vient cliquer dans l éditeur à l endroit où il veut placer l élément en question. Ed it e ur graphique d a r ch it e ct ure d e composan ts Fra ct al 12

13 Suppression d un élément graphique 1. L utilisateur sélectionne l élément à supprimer dans l éditeur. 2. Soit il utilise la touche du clavier «suppr», soit il ouvre un menu contextuel par un clic droit et clique sur «delete from model» Création/modification d un élément textuel 1. Dans l éditeur, l utilisateur clique sur l élément qu il veut modifier. 2. A partir de la vue properties, il accède aux propriétés de cet élément, qu il peut alors modifier ou créer Diagramme de cas d utilisation Ed it e ur graphique d a r ch it e ct ure d e composan ts Fra ct al 13

14 4. TRAITEMENT DES ERREURS 4.1 Fichier d entrée Le logiciel prend en général en entrée un fichier Fractal ADL valide.dans tous les cas, un parseur analyse le fichier et génère des messages d erreurs si celui-ci n est pas bien formé. 4.2 Erreur d édition L éditeur sera fourni avec la palette d outil nécessaire pour composer une architecture de composants Fractal.La composition de cette architecture repose sur le modèle de donnée défini, dont elle représente une instance. Ce modèle doit vérifier un certain nombre de contraintes. Lors de l édition, l utilisateur peut explicitement vérifier que les contraintes sont respectées en cliquant sur un bouton du menu contextuel «validate», ou bien le diagramme est validé à la sauvegarde du fichier Fractal. Si le modèle n est pas valide, un message d erreur explicite est renvoyé à l utilisateur. Les contraintes à respecter sont les suivantes : Un élément Definition doit automatiquement être crée à la création d un nouveau fichier. Il est composite par défaut. Un élément Component doit s afficher dans le cadre de son parent. Un élément Interface doit s afficher sur le bord des éléments Component. L élément rôle d un élément Interface ne doit pas être modifiable. La compatibilité entre éléments client et server d un élément Binding doit être assurée : o Les éléments signature doivent avoir la même valeur, o Deux éléments Component peuvent avoir un lien entre leurs éléments Interface si : Les éléments Component ont le même parent et leurs éléments Interface à lier sont de rôles opposés. L un des éléments Component est parent de l autre et leurs éléments Interface à lier ont le même rôle. Ed it e ur graphique d a r ch it e ct ure d e composan ts Fra ct al 14

15 5. EVOLUTIONS PREVUES OU POSSIBLES : L évolutivité du produit dépend profondément de l évolution des technologies qu il implémente. L évolution de Fractal devra être possible, ce qui est offert par l extensibilité d Eclipse et des technologies GMF, EMF et GEF. En effet, EMF permet l extension d un modèle en un autre : le nouveau est créé à partir de l ancien, et des extensions peuvent y être apportées. GEF, de son coté, permet l ajout de nouveaux composants au modèle graphique indépendamment de ce qu il contenait avant. La liaison entre modèle du domaine et modèle graphique via GMF ne cause pas de problèmes vu qu elle s effectue d une façon unitaire.c est-à-dire qu un ou plusieurs éléments du domaine est lié à un ou plusieurs éléments graphiques, et cela, indépendamment des autres. Ed it e ur graphique d a r ch it e ct ure d e composan ts Fra ct al 15

16 6. ANNEXE A ANNEXE A Spécification de l ADL FRACTAL definition Component architecture definition comment*,interface*,component*,binding*,content?, attributes?,controller?,template-controller?,logger?, virtual-node?,coordinates*,output? name :The name of the component definition. Arguments : Arguments that customize this definition. extends :Specifies the name of the extended component definition. component Component instance definition comment*, interface*,component*,binding*,content?, attributes?,controller?,template-controller?,logger?, virtual-node?,coordinates*,output? name : The name of the component instance. definition : Reference to a component definition. interface Component interface definition comment* name : The name of the interface role : The role of the interface [client server] signature : The signature name of the interface contingency : Indicates if the interface is mandatory or optional [mandatory optional]. Default value is mandatory. cardinality : Indicates whether the interface accepts multiple connections or not [singleton collection]. Default value os singleton. binding binding definition comment* client : The client end of the binding componentinterface server :The client end of the binding componentinterface Ed it e ur graphique d a r ch it e ct ure d e composan ts Fra ct al 16

17 attributes Component attribute set definition. This tag can contain multiple attribute elements for value assignments to attribute fields. comment*,attribute* signature : The signature name of the attribute structure. attribute Attribute assignment definition.. comment* name : The name of the attribute field. value : The value to be assigned to the field. controller Controller generator specification. If this tag is not used in a component definition, a default controller generator is used by the ADL compiler comment* desc : The descriptor of the controller generator. language : The language in which the controller interfaces must be implemented by the generator. By default, the language value is the same as the content implementation language. attribute Attribute assignment definition.. comment* name : The name of the attribute field. value : The value to be assigned to the field. Ed it e ur graphique d a r ch it e ct ure d e composan ts Fra ct al 17

18 content Primitive component implementation file specification.. comment*,directive* class : The implementation file name without its language indicator extension. language : Specifies the language of the implementation file. Currently supported languages are thinkc, macroc and cpp. comment A tag for including commentaries in ADL descriptions. language : Specifies the language of the comment. text : Comment text. directive Specification of compilation directives for primitive components. This tag accept many compiler and linker flags as sub elements. It also accepts a set of include tags specifying files to be included. include*,cflag*,ldflag* language : Indicates for which language these compilation directives are. cflag A compiler flag to be used. Value : A text indicating a compiler flag ldflag A linker flag to be used. Value : A text indicating a compiler flag include Additional implementation files to be included file : A file name Ed it e ur graphique d a r ch it e ct ure d e composan ts Fra ct al 18

19 output Output format of the compilation result format : The output format extension. Ed it e ur graphique d a r ch it e ct ure d e composan ts Fra ct al 19