14 Piloter la plateforme par macros ou par scripts Groovy ou R
14.2 Utiliser des scripts Groovy
Les scripts servent à piloter la plateforme TXM pour :
-
appeler n'importe quelle commande TXM : lancer une recherche à partir d'une requête CQL, appliquer un modèle statistique, exporter et sauvegarder des résultats dans un fichier, etc.
-
utiliser des paramètres personnalisés pour chacune de ces commandes ;
-
enregistrer et lancer une séquence de commandes pour des recherches usuelles.
Leur usage permet à l'utilisateur d'étendre les fonctionnalités de la plateforme à l'aide de scripts58.
Les macros sont des scripts spécialisés offrant des services de saisie et de mémorisation de paramètres.
Les scripts et macros sont écrits en langage Groovy (König, 2007) (http://groovy.codehaus.org).
Vous trouverez une courte introduction à l'utilisation de ce langage à l'adresse : http://onjava.com/pub/a/onjava/2004/09/29/groovy.html
Trois livres de référence pourront vous donner plus d'informations :
Le texte des scripts à exécuter peut se trouver dans un fichier ou être simplement sélectionné dans une fenêtre (voir la section « Éditeur de texte »).
La meilleure manière de commencer à écrire vos propres script Groovy est de copier un des scripts exemples inclus dans la plateforme, dossier « C:\Documents and Settings\<identifiant de l'utilisateur>\TXM\scripts\groovy\samples »5960. Par exemple, le script « conc.groovy »61 calcule automatiquement une concordance du mot « je » dans le corpus DISCOURS puis exporte les résultats au format CSV dans un fichier nommé « conc.txt ».
Pour que vous puissiez exécuter vos propres scripts Groovy depuis TXM, ces derniers doivent se trouver dans le dossier « C:\Documents and Settings\<identifiant de l'utilisateur>\TXM\scripts\user ». La hiérarchie des packages Groovy commence à partir de ce répertoire.
Pour créer un script, déplacer un script dans ce dossier ou aller dans la vue « Fichier » (voir la section 3.2.1.1.2 La vue « Fichier » et « l'éditeur de texte »), clic-droit sur le dossier « user », puis sélectionner « créer un fichier », donner un nom. Par exemple « test.groovy ». Pour modifier le script, il faut double-cliquer sur son icone.
14.2.1 Exécuter un script
On peut exécuter un script Groovy par sept moyens différents :
-
depuis un éditeur de texte62:
-
menu contextuel « Groovy / Exécuter la sélection de texte » exécute le texte sélectionné dans l'éditeur ;
-
menu contextuel « Groovy / Exécuter le Script » exécute le script se trouvant dans l'éditeur ;
-
menu contextuel « Groovy / Exécuter un fichier Groovy » exécute un script se trouvant dans un fichier ;
-
raccourcis clavier « F11 » exécute le texte sélectionné dans l'éditeur ;
-
raccourcis clavier « Ctrl-F11 » exécute le script se trouvant dans l'éditeur ;
-
depuis la vue Fichier :
-
menu contextuel sur l'icone d'un fichier « / Exécuter le Script » exécute le script contenu dans le fichier ;
-
raccourcis clavier « F12 » exécute le dernier script exécuté.
14.2.2 Utilisation de librairies tierces (fichiers .jar ou .so)
Pour qu'une librairie tierce (fichier « .jar »63 ou « .so »64) soit accessible depuis un script Groovy, il suffit de la déposer dans le dossier « $HOME\TXM\scripts\lib ». Après avoir relancé TXM, les packages et fonctions correspondants sont importables depuis les scripts Groovy.
14.2.3 Comment utiliser les objets de TXM depuis Groovy
Groovy étant basé sur le langage Java (Arnold, Gosling, & Holmes, 2005) (Gosling, Joy, Steele, Bracha, & Buckley, 2014)65, il donne accès à tous les modules Java de TXM.
La façon d'appeler les commandes de TXM depuis Java et donc depuis Groovy est documentée dans la Javadoc de TXM située à l'adresse : http://txm.sourceforge.net/javadoc.
Par exemple, les paramètres de la commande Concordance sont décrits dans le package « org.txm.rcpapplication.editors.concordances », documenté à l'adresse http://txm.sourceforge.net/javadoc/TXM/RCP/org/txm/rcpapplication/editors/concordances/ConcordancesEditor.html.
Toutes les commande décrites dans cette documentation peuvent être exécutées dans un script Groovy.
58 À l'image de ce qui se fait dans MS Word au moyen des macros Visual Basic.
59 Aucune protection de sécurité lors de l'exécution de scripts n'a été intégrée à la plateforme TXM pour le moment, il faut donc être vigilant sur la provenance des scripts utilisés.
60 En Linux : /home/<identifiant de l'utilisateur>/TXM/scripts/user
61 Vous avez également accès à ce script en ligne, à l'adresse :
62 On ouvre un éditeur de texte en ouvrant un fichier de la vue Fichier ou par le menu principal “Fichier / Nouveau fichier” ou “Fichier / Ouvrir...”.
63 Les fichiers .jar contiennent des classes Java pré-compilées.
64 Les fichiers .so contiennent des fonctions natives du système d’exploitation hôte, par exemple les fonctions d’une librairie C.
65 Tout script Groovy est compilé en byte-code Java afin de pouvoir être exécuté.