Exécution avec la fonction de trace

La plateforme fournit un mécanisme de suivi de l'activité d'exécution du plug-in sans débogage complet. Vous pouvez ainsi utiliser des indicateurs de trace afin d'afficher des informations de trace à la sortie standard (ou Vue de la console). Ces indicateurs, définis dans des fichiers ".options", ont la syntaxe suivante :

<plug-in Id>/debug = true/false  (commutateur principal)
<plug-in Id>/<indicateur de trace> = <valeur>

La première entrée représente le commutateur principal de trace du plug-in. Si vous appelez la méthode isDebugging dans votre classe de plug-in et que la variable de trace a pour valeur true, cette méthode retournera true. Vous pouvez définir d'autres indicateurs dont la valeur est obtenue à l'aide de

    Platform.getDebugOption(nomOption)";

La plupart des plug-ins de plateforme définissent des indicateurs de trace, en particulier l'API principale de la plateforme. Si vous débutez dans le développement de plug-ins, le groupe d'indicateurs de trace le plus intéressant concerne le chargement des classes, car ceux-ci permettent de détecter les problèmes de chargement des plug-ins. 

Pour prendre en charge la fonction de trace sans que vous ayez à éditer les fichiers .options, PDE propose la page de préférences "Traçage de l'exécution" permettant de définir les indicateurs de trace et les filtres de noms associés au chargement.

La fonction de trace du chargement de classes d'exécution subit un traitement spécial car elle est couramment utilisée par la plupart des développeurs de plug-ins. PDE fournit également une boîte de dialogue générique pour le contrôle d'autres indicateurs de trace.  La page de préférences Fonction de trace avancée affiche tous les plug-ins prenant en charge la fonction de trace.  Lorsqu'un plug-in est sélectionné, ses options de trace prises en charge apparaissent dans la feuille de propriétés. Vous pouvez modifiez les valeurs de ces options pour les plug-ins de l'espace de travail et les plug-ins externes.

Si vous ajoutez un support de trace au plug-in en cours de développement, les valeurs de trace apparaîtront dans cette page.

PDE offre une variante du programme de lancement "Plan de travail d'exécution" appelé "Plan de travail d'exécution avec trace". Il se charge de créer le fichier .options consolidé en fonction des paramètres de trace figurant dans les Préférences, puis le transmet à l'instance de la plateforme d'exécution. Toutes les informations générées par la trace s'affiche dans la vue de la console.

Exemple : Ajout du support de trace à votre plug-in

Pour permettre à d'autres développeurs de contrôler les indicateurs de trace de votre plug-in, vous devez rendre publiques ces options.  Pour cela, il suffit de placer un fichier .options dans le plug-in.  Le fichier dresse la liste de tous les indicateurs pris en charge ainsi que leurs valeurs par défaut. PDE détectera automatiquement ce fichier et le fera figurer dans la liste "Plug-ins de l'espace de travail" de la page des préférences de la fonction de trace avancée.

Nous allons à présent définir un modèle de fichier .options comportant quelques indicateurs de trace pour le nouveau plug-in.

Sélectionnez le projet com.example.xyz créé précédemment, puis créez un fichier .options. Dans l'éditeur de texte par défaut, ajoutez les lignes suivantes :

com.example.xyz/debug = true
com.example.xyz/debug/flag = true
com.example.xyz/debug/filter = *

Enregistrez ce fichier, puis ouvrez la page Préférences->Fonction de trace avancée. Le plug-in doit apparaître sous "Plug-ins de l'espace de travail". Lorsque vous le sélectionnez, il doit afficher les indicateurs que vous venez de définir ainsi que leurs valeurs par défaut.

Le fichier .options ne définit que les indicateurs de disponibilité, ce qui permet à d'autres développeurs de plug-ins de définir les valeurs des propriétés de trace.  Vous devrez vérifier ces valeurs dans le code de votre plug-in à l'aide de la fonction Platform.getDebugOption().