Discussion :

[Zombee]

Bonjour Messieurs,

J'ai pour objectif de créer un extension point dans un plugin (disons P1). Cette extension sera par la suite étendue par d'autre plugin (disons p2, p3, ...) mais dont je ne sais rien, hormis qu'ils implémentent l'interface créée lors de la mise en place de mon extension point.

Lorsque P1 démarre, j'aimerai récupérer plusieurs infos simple (mettons des Strings) et créer une Map (HashMap<String, List<String>>) avec ces infos pour l'utiliser plus tard.

Pour commencer j'ai suivis le tuto de notre ami Lars Vogel 'Eclipse Extension Points and Extensions - Tutorial'.

Premier problème, je ne comprend pas comment fonctionne EvaluateContributionHandler (càd comment est-elle lancée? d'où viens le registry passé en argument? ...)

Et je souhaite savoir s'il existe d'autre moyen d'y arriver ?

Merci

[joel.drigo]

Salut,

tout d'abord je ne comprends pas quand tu dis "Cette extension sera par la suite étendue par d'autre plugin" : tu veux simplement dire que ton extension sera utilisée pour paramétrer ce que tu propose de configurer par cette extension, ou que ton extension est faite pour être utilisée comme sous partie d'une autre extension créée dans un autre plugin (comme par exemple quand tu importes schema://org.eclipse.core.expressions/schema/expressionLanguage.exsd dans ton extension) ?

Ensuite, la classe EvaluateContributionHandler est juste un exemple pour montrer comment on lit les informations paramétrées par une extension dans les différents plugins. Le point d'entrée est effectivement une instance de IExtensionRegistry.

Il y a 2 manières de procéder, selon que tu sois dans Eclipse 3, ou Eclipse 4.

Dans eclipse 3, tu peux obtenir l'instance de registry par

Code :

Sélectionner tout - Visualiser dans une fenêtre à part

1
2
IExtensionRegistry registry = Platform.getExtensionRegistry().
  getConfigurationElementsFor( <ici tu met l'identifiant de ton extension");

Tu l'appelles quand tu as besoin de l'appeler. Il vaut mieux t'arranger pour l'appeler une seule fois Et il faut le faire quand tes plugins sont démarrés.

Par exemple, dans mon appli j'ai fait une extension qui permet de hooker des traitements (donc d'ajouter des comportements que je n'ai pas implémentés, mais que j'ai prévu qu'on puisse implémenter).

Par exemple, dans un éditeur, à la sauvegarde, je permets d'intervenir sur le procéssus de sauvegarde : dans la méthode doSave(IProgressMonitor monitor) de ma classe d'editeur (IEditorPart), je fais un truc dans le genre :

Code :

Sélectionner tout - Visualiser dans une fenêtre à part

1
2
3
4
5
6
7
8
9
10
11
public void doSave(IProgressMonitor monitor) {
 
   EditorSaveHookParameters hookParameters = new EditorSaveHookParameters(getSite().getid(),getEditorInput());
 
   HookManager.before(EDITOR_SAVE_HOOK_ID,hookParameters);
 
   ... traitement effectif de la sauvegarde ...
 
   HookManager.after(EDITOR_SAVE_HOOK_ID,hookParameters);
 
}

Ce qui permet d'ajouter un traitement avant la sauvegarde (par exemple une historisation), et un après (par exemple un envoi de mail de notification).

J'ai fait mon HookManager sous forme de singleton, lazy (qui se crée donc la première fois qu'on l'appelle) et dans son constructeur je demande la registry comme indiquée ci-dessus et j'appelle un code similaire à celui de la classe EvaluateContributionHandler , pour créer les différents handlers de hooks paramétrés par l'extension que j'ai créée. Dans l'extension, l'intégrateur indique l'id de hook, et une classe qui implémente une interface imposée, avec des méthodes before et after qui seront invoquées avec les paramètres adéquates (ici EditorSaveHookParameters), qui lui permetront de réagir de la façon qu'il désire, en fonction de l'identifiant d'éditeur, et de ce qui est édité (IEditorInput).

Dans Eclipse 4, il y a un mécanisme d'injection qui permet de récupérer l'instance de IExtensionRegistry. N'ayant jamais travailler sous eclipse 4, je ne peux te donner de détails. Voici une doc qui t'en diras plus.

[Zombee]

Merci pour la réponse,

Tout d'abord, je suis aussi Eclipse 3.

Ensuite j'ai une erreur pour ce code :

Code :

Sélectionner tout - Visualiser dans une fenêtre à part

1
2
IExtensionRegistry registry = Platform.getExtensionRegistry().
  getConfigurationElementsFor( <ici tu met l'identifiant de ton extension");

En effet 'getConfigurationElementFor(...)' retourne un IConfigurationElement[] et on ne peut le placer dans un IExetensionRegistry.

Je ne pense pas pouvoir le caster. Comment fais-je?

Merci.

[Mickael_Istria]

En effet 'getConfigurationElementFor(...)' retourne un IConfigurationElement[] et on ne peut le placer dans un IExetensionRegistry.

Tu n'as pas à le placer, ces IConfigurationElement ce sont tes extensions. Tu peux faire des requêtes dessus. C'est le plugin qui fournit le point d'extension qui est censé lire les IConfigurationElement et les traiter comme bon lui semble (ajouter à une liste par exemple)

Je ne pense pas pouvoir le caster. Comment fais-je?

Tu demandes à ton extension (IConfigurationElement) d'instancier l'objet:
http://help.eclipse.org/indigo/index...onElement.html

[joel.drigo]

Ah oui excuses moi, un copier coller un peu rapide c'était un peu avant d'aller me coucher, je devais être un peu endormi déjà

il fallait lire :

Code :

Sélectionner tout - Visualiser dans une fenêtre à part

IExtensionRegistry registry = Platform.getExtensionRegistry();

[Zombee]

Rebonjour cher developpeurs,

Une dernière question (avant la prochaine) me turlupine.

Je pense avoir réalisé ce que je souhaite (notez l'assurance dans ma voie) mais impossible de le tester, en effet j'ai créée un plugin (PI2) qui est une extension du plugin précédent. Mais lorsque que je passe par

Code :

Sélectionner tout - Visualiser dans une fenêtre à part

1
2
IConfigurationElement[] configs = registry
				.getConfigurationElementsFor("myExtension");

configs est null, j'en déduis que mon plugin PI2 n'est pas chargé.

Avez-vous des axes de réflections pour m'aider ?
Comment puis-je faire pour debuguer ces deux plugins ?

Merci

[joel.drigo]

Salut,

c'est le plugin qui utilise l'extension, soit PI2 que tu dois tester, pas le plugin qui la définit.

Si tu lances seulement le plugin avec l'extension, forcément il n'y aura aucune configuration, sauf si tu en as fait une dans le plugin lui-même.
Par contre, il me semblait que dans ce cas on obtenait un tableau vide, et pas null : faut que je revois ça pour être sur.

[Zombee]

Je vais essayer d'être plus clair sur ce que je fais car j'ai désormais un gros doute.

J'ai deux plugins PI1 et PI2. PI1 possède un extension point lié à une interface.
PI2 possède un extension de PI1 et implémente l'interface susdite.

Dans PI1 j'appelle une méthode qui cherche toutes les extensions liées à son extension point, que j'essai de récupérer en faisant :

Code :

Sélectionner tout - Visualiser dans une fenêtre à part

1
2
3
4
IExtensionRegistry registry = Platform.getExtensionRegistry();
		System.out.println(registry.toString());
		IConfigurationElement[] configs = registry
				.getConfigurationElementsFor("PI1 extension point");

Par la suite je teste si ce sont bien des extensions qui implemente l'interface créée par PI1.

Pour le code si dessus, en effet ce qui m'est retourné pour configs est un tableau vide (et non 'null').

Est-ce la bonne manière de faire ?

[joel.drigo]

Mais dans PI2, tu as bien configuré l'extension pour renseigner l'implémentation de l'interface ?

[Mickael_Istria]

Dans ton code pour récupérer les extensions, tu utilises bien le nom complet du point d'extension?
Si tu crées un point d'extension "lol" dans ton plugin "org.myproject.myplugin", son id est en fait "org.myproject.myplugin.lol".

[Zombee]

Oui dans PI2 je créée une extension qui s'appelle org.myproject.pi1.extensionpoint à laquelle j'ajoute un élément 'class' de type java qui est une classe implémentant l'interface associé dans l'extension point.

Dans le code j'utilise donc

Code :

Sélectionner tout - Visualiser dans une fenêtre à part

1
2
IConfigurationElement[] configs = registry
				.getConfigurationElementsFor("org.myproject.pi1.extensionpoint");

et pourtant configs[] reste vide.

[joel.drigo]

Hum, tu procèdes bien comme ça :

1) Dans ton plugin de base (pi1 ?), tu crées un Extension Point, qui définit la structure de configuration (sous la forme d'un fichier .exsd) : c'est à dire un element, avec un attribut de type java, et qui est configuré dans l'onglet Extension Points de ton plugin.xml.

Le fichier exsd contient (entre autres) quelque chose comme ça :

Code :

Sélectionner tout - Visualiser dans une fenêtre à part

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
<element name="composant">
      <annotation>
         <documentation>
            La classe du composant
         </documentation>
      </annotation>
      <complexType>
         <attribute name="class" type="string" use="required">
            <annotation>
               <documentation>
                  L&apos;implémentation de la classe
               </documentation>
               <appInfo>
                  <meta.attribute kind="java" basedOn=":truc.machin.MyInterface"/>
               </appInfo>
            </annotation>
         </attribute>
      </complexType>
   </element>

2) Dans ce plugin, tu as le code qui interprète la configuration de ce point d'extension (le code qui fait IConfigurationElement[] configs = registry .getConfigurationElementsFor("org.myproject.pi1.extensionpoint"); et le reste (lecture des éléments, attributs..., avec à un moment un configElement.createExecutableExtension("class"))

Tu as également, dans ce plugin, l'interface truc.machin.MyInterface, et son package est exporté.

3) Dans ton plugin PI2, qui a une dépendance sur ton plugin de base, tu configures l'extension, dans l'onglet Extensions. Dans ton fichier plugin.xml tu auras quelque chose comme ça :

Code :

Sélectionner tout - Visualiser dans une fenêtre à part

1
2
3
4
<extension
         point="org.myproject.pi1.extensionpoint">
<composant class="truc.bidule.MyInferfaceImpl"/>
</extension>

ou truc.bidule.MyInferfaceImpl est une classe du plugin PI2 qui implémente truc.machin.MyInterface.

[Zombee]

Exactement et pourtant quand je tente de lancer un débug avec ces deux plugins (+Required plugins) je n'obtiens rien dans mon plugin principal (PI1).

[joel.drigo]

Bizarre Je ne vois pas pourquoi ça ne fonctionne pas. Éventuellement, regardes s'il n'y a pas de messages dans le .log.

Personnellement, je n'ai jamais testé comme ça : j'ai un product pour tester et je n'ai jamais eu de problème. Essayes peut être de faire un product pour voir si ça fonctionne mieux.

[Zombee]

Alors j'ai créé pour le plugin principal (PI1) un product ce qui me donne un répertoire avec Eclipse.exe, un dossier configuration, ....

Jusque là tout va bien, si je le lance avec des paramètres je les récupères comme il faut.

Ensuite j'ai créé un feature avec le second plugin (PI2) que j'ai exporté en générant un P2 repository.
Mais comment je rajoute le PI2 ? comme je n'ai pas d'interface graphique...

Merci et désolé pour toutes ces questions pas fifolles

[joel.drigo]

Je parlais juste de créer un product, en y mettant tes 2 plugins directement, pour tester, donc pas besoin de faire de feature. Et pas besoin de builder, tu peux l'exécuter directement dans Eclipse.