Utilisation API eclipse (org.eclipse.*)

**nchal** · 02/07/2014, 16h20

Bonjour,

Je voudrais lancer le reformatage d'Eclipse (Source > Format, ou Ctrl+Shift+F) en ligne de code. Je me suis donc penser sur l'Api que fourni Eclipse mais je n'ai pas réussi à faire ce que je voulais. Il manque des exemples simples dans la doc pour me permettre de prendre en main l'outils et je n'ai trouvé aucun tutoriel, ni discussion de forum qui en parle (si, en fait une qui traite exactement de mon problème mais les gens n'ont pas été inspiré, et ça date de 2008 >ici< )

De ce que j'ai compris, je dois utiliser la classe FormatAllAction mais elle a besoin de IWorkbenchSite, et IWorkbenchSite a 2 implémentations (MultiPageEditorSite, PageSite),et celles-ci ont encore besoin d'encore d'autres classes, etc, etc.

Si jamais quelqu'un a un lien permettant d'y voir plus clair, ce serait avec plaisir. Et si ce même quelqu'un peut prendre quelques minutes pour m'expliquer le fonctionnement globale de cette Api, ce serait parfait.

Merci.

**Gueritarish** · 03/07/2014, 14h56

Salut,

Pour ce qui est de récupérer le IWorkbenchSite, il te suffit d'utiliser ce bout de code:

Code :

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

1
2
3
4
5
6
7
8
9
10
11
IWorkbench workbench = PlatformUI.getWorkbench();
IWorkbenchWindow activeWorkbenchWindow = workbench.getActiveWorkbenchWindow();
if (activeWorkbenchWindow != null) {
	IWorkbenchPage activePage = activeWorkbenchWindow.getActivePage();
	if (activePage != null) {
		IWorkbenchPart activePart = activePage.getActivePart();
		if (activePart != null) {
			FormatAllAction formatAllAction = new FormatAllAction(activePart.getSite());
		}
	}
}

Pour ce qui est de t'expliquer le fonctionnement global de l'API... disons qu'elle permet de gérer le cycle de vie de l'application.
C'est beaucoup trop vaste pour l'expliquer "en quelques minutes".

Voilà, à+
Gueritarish

**nchal** · 03/07/2014, 16h09

Salut,

Tout d'abord, merci d'avoir pris le temps de me répondre.

En essayant ton code, j'ai une erreur

Code :

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

1
2
3
Exception in thread "main" java.lang.IllegalStateException: Workbench has not been created yet.
	at org.eclipse.ui.PlatformUI.getWorkbench(PlatformUI.java:92)
	at core.Main.main(Main.java:94)

On dirait que je n'ai pas de workbench actif.
Pour en être sûr, j'ai essayé ceci

Code :

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

System.out.println(PlatformUI.isWorkbenchRunning());

et, comme prévu, il me sort false
Une idée ?

**Gueritarish** · 04/07/2014, 07h47

Salut,

Tu lances le formatage de tes classes dans un Eclipse en ligne de commande non?
Si c'est le cas, va pas plus loin. Cette classe n'a pas été prévue pour. Déjà, c'est une Action donc, c'est forcément graphique.
Sur le fond, je suis d'accord que tu devrais pouvoir l'utiliser en ligne de commande. Sur la forme, pas du tout.
Cette classe est dans un package UI et tu ne connais pas les dépendances qu'elle peut tirer en matière d'IHM.
Par contre, ce que tu peux faire, c'est voir les mécanismes qui sont utilisés (notamment avec l'utilisation des ICompilationUnit) pour te servir de la (des?) classe(s) les plus pertinentes.

Voilà, à+
Gueritarish

**nchal** · 04/07/2014, 09h26

Bonjour,

Ça aurait pu être une bonne piste mais j'utilise Eclipse Kepler SR1 ...
Je vais faire des recherches sur le web concernant ce nouveau problème mais je suis un peu dépité

**joel.drigo** · 04/07/2014, 12h17

Salut,

Envoyé par nchal

Bonjour,

Ça aurait pu être une bonne piste mais j'utilise Eclipse Kepler SR1 ...
Je vais faire des recherches sur le web concernant ce nouveau problème mais je suis un peu dépité

La version d'Eclipse n'a rien à voir : ce que te dit @Guetarish est que l'API de formatage de Eclipse est une API prévue pour fonctionner dans un environnement particulier : soit dans un plugin, soit dans une application RCP. Tu ne peux pas te servir de cette API sans démarrer un certain nombre de "services" dont le Workbench (une sorte de conteneur racine, sur lequel repose toute UI Eclipse) : on doit pouvoir démarrer le Workbench à la main, mais ça demande tellement d'efforts inutiles, qu'autant le faire de manière standard prévue (donc soit en faisant un plugin pour ton Eclipse IDE (Kepler en l’occurrence), soit en faisant une application Eclipse RCP).

Au vu du code, il ne va pas être simple d'extraire le code de formatage : il y a tellement de dépendances dans tous les sens, que ça risque d'être assez long.

Sinon il existe des API de formatage de code autonomes, mais je ne suis pas sûr qu'elles soient très maintenues, et surtout mise à jour par rapport aux évolutions syntaxiques de Java, en particulier Java8. Voir ce lien.

**Gueritarish** · 04/07/2014, 13h52

Euh, j'ai du mal à voir le rapport avec la version d'Eclipse...
Sinon, pour ton besoin, un peu de recherche dans le code source et je trouve la fonctionnalité de formatage des ICompilationUnit:

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
20
21
22
23
24
25
IProject project = ResourcesPlugin.getWorkspace().getRoot().getProject("MyProject");
IJavaProject javaProject = JavaCore.create(project);
if (javaProject != null) {
	try {
		IJavaElement compUnit = javaProject.findElement(new Path("net/developpez/MyClass.java"));
		Map<String, String> settings= new Hashtable<String, String>();
		settings.put(CleanUpConstants.FORMAT_SOURCE_CODE, CleanUpOptions.TRUE);
		CleanUpRefactoring refactoring= new CleanUpRefactoring();
		refactoring.addCompilationUnit((ICompilationUnit) compUnit);
		refactoring.addCleanUp(new CodeFormatCleanUp(settings));
		try {
			refactoring.checkAllConditions(new NullProgressMonitor());
			Change fChange = refactoring.createChange(new NullProgressMonitor());
			fChange.initializeValidationData(new NullProgressMonitor());
			PerformChangeOperation fPerformChangeOperation = new PerformChangeOperation(fChange);
			fPerformChangeOperation.run(new NullProgressMonitor());
		} catch (OperationCanceledException oce) {
			oce.printStackTrace();
		} catch (CoreException ce) {
			ce.printStackTrace();
		}
	} catch (JavaModelException jme) {
		jme.printStackTrace();
	}
}

Il faut ajouter des références vers les plug-ins: org.eclipse.core.resources, org.eclipse.ltk.core.refactoring, org.eclipse.jdt.core et org.eclipse.jdt.ui.
Ce bout de code récupère la classe net.developpez.MyClass dans le projet MyProject de ton workspace.
Pour l'utiliser en mode "headless" (en ligne de commande), il te faut au moins définir l'option -data (qui sert à indiquer le workspace).
Il est bien évident que tu ne peux utiliser l'environnement Eclipse sans Eclipse...

Voilà, à+
Gueritarish

[EDIT] Grillé par Joel

Sinon, autre subtilité, les classes utilisées sont toutes internes. Ce qui signifie qu'elles peuvent être soumises à modification dans des versions ultérieures d'Eclipse.

**nchal** · 04/07/2014, 14h01

Bonjour,

Merci pour ces précisions qui me permettent d'y voir plus clair.

Je souhaite reformater automatiquement des sources java que je génère. En gros, il faut simuler l'action "Save actions" qui va reformater le code selon la norme de l'entreprise et qui va tirer les imports tout seul.
J'ai trouvé 2 approches :

En passant par FormatAllAction et OrganizeImportAction; mais le problème de Workbench m'en empêche.
En utilisant la classe CodeFormatter; que j'ai essayé mais qui ne marche pas pour d'obscures raisons.

Avez-vous d'autres idées ? (J'ai vu ton lien joel.drigo, il y a quelques projets morts mais jalopy me semble pas mal, à approfondir)

En tout cas, merci pour vos réponses

[EDIT]
Merci pour ta réponse Gueritarish, je vais essayer cette solution et je reviendrais vers toi.

**nchal** · 04/07/2014, 16h40

Bonjour,

J'ai pu tester le code de Gueritarish, et j'ai une nouvelle erreur

Code :

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

1
2
3
Exception in thread "main" java.lang.IllegalStateException: Workspace is closed.
	at org.eclipse.core.resources.ResourcesPlugin.getWorkspace(ResourcesPlugin.java:399)
	at core.Main.main(Main.java:110)

Mais si j'ai bien compris ce qu'a dit joel, je suis obligé de faire un plugin ou une RCP, pour ne plus avoir ces erreurs ...

**Gueritarish** · 07/07/2014, 09h28

Envoyé par Gueritarish

Il est bien évident que tu ne peux utiliser l'environnement Eclipse sans Eclipse...

Envoyé par nchal

Mais si j'ai bien compris ce qu'a dit joel, je suis obligé de faire un plugin ou une RCP, pour ne plus avoir ces erreurs ...

Je vois pas ce qui te fait dire ça

**nchal** · 07/07/2014, 10h02

Envoyé par Gueritarish

Je vois pas ce qui te fait dire ça

Bah du coup, je suis perdu ... je ne comprends plus rien

Pourquoi il n'y a rien qui marche alors ? Je suis dans Eclipse, j'utilise le code que tu me donnes et j'ai des erreurs.

Et quand joel me dit ça :

La version d'Eclipse n'a rien à voir : ce que te dit @Guetarish est que l'API de formatage de Eclipse est une API prévue pour fonctionner dans un environnement particulier : soit dans un plugin, soit dans une application RCP. Tu ne peux pas te servir de cette API sans démarrer un certain nombre de "services" dont le Workbench (une sorte de conteneur racine, sur lequel repose toute UI Eclipse) : on doit pouvoir démarrer le Workbench à la main, mais ça demande tellement d'efforts inutiles, qu'autant le faire de manière standard prévue (donc soit en faisant un plugin pour ton Eclipse IDE (Kepler en l’occurrence), soit en faisant une application Eclipse RCP).

J'en déduis que je dois faire un plugin ou une appli RCP.

Mais tu me dis que non

Suis-je idiot et ai-je loupé quelque chose ?
Éclairez moi, s'il vous plait

**Gueritarish** · 07/07/2014, 11h26

Envoyé par nchal

Mais tu me dis que non

Suis-je idiot et ai-je loupé quelque chose ?
Éclairez moi, s'il vous plait

Oui, t'as loupé l'ironie de ma réponse.
En fait, dans mon précédent post, je t'avais déjà indiqué qu'il te fallait un environnement Eclipse pour parvenir à tes fins...
D'où ma "surprise" quand tu dis que tu rencontres des problèmes parce que tu essaies d'utiliser ça... EN DEHORS D'ECLIPSE (je mets "surprise" pour rester poli hein...).
Donc, là, lis bien jusqu'au bout: TU NE PEUX PAS UTILISER CE CODE EN DEHORS D'UN ENVIRONNEMENT ECLIPSE.

Voilà, à+
Gueritarish

**nchal** · 07/07/2014, 13h47

D'accord, je commence à y voir plus clair, enfin me direz vous mais ce n'est pas évident non plus.
Lorsque vous parlez d’environnement Eclipse, ce n'est pas coder dans Eclipse pour du J2EE (par exemple) mais coder dans Eclipse pour Eclipse.
Donc, pour mon histoire de génération de code automatique, suivi de reformatage du code créé, il faut que je fasse un plugin qui va utiliser mes classes de génération, puis passer sur les classes générées avec le code que vous m'avez fourni.

Si j'ai bon, je met

et je vous remercie de votre patience, sinon on est reparti pour un tour

**Gueritarish** · 07/07/2014, 15h01

C'est tout bon.
En gros, tu crées un plug-in Eclipse pour pouvoir faire du formatage dans Eclipse.
Là où c'est moins bon, c'est que c'est déjà possible

Tout dépend de ton cas d'utilisation, mais si tu veux mon avis, c'est inutile de ré-inventer la roue...

Ce qui pourrait être intéressant, à la limite, c'est que ton plug-in soit accessible dans une version headless d'Eclipse, i.e. un Eclipse en ligne de commande.

Voilà, à+
Gueritarish

**nchal** · 07/07/2014, 15h17

Ok, c'est cool.
Mais comme je fais un POC, ça peut être sympa de faire le formatage à la mimine. Surtout que le plugin doit faire tout plein d'autres choses.
En tout cas, merci à vous deux et merci à toi Gueritarish pour ta patience.

A ++

Utilisation API eclipse (org.eclipse.*)

Eclipse Platform

Discussions similaires

Partager

Partager