Créer un jeu de couleurs pour gEdit

Cette page indique comment créer un jeu de couleurs pour gEdit.

Lorsque vous écrivez un code source, vous avez plusieurs styles de texte : les variables, les types de fonction/variable… gEdit peut colorer ces styles de texte, pour le plus grand plaisir de nos yeux délicats. Un jeu de couleur prend la forme d'un fichier xml, attribuant des effets de texte à un style de texte déjà défini.

Un programme existe, badschemer, pour créer des deux de couleurs de façon plus confortable. Il est aussi possible d'y aller à la main pour faire quelque chose de plus personnalisé, et c'est ce que nous allons voir.

Voici un exemple de contenu d'un jeu de couleurs vide :

<?xml version="1.0" encoding="UTF-8"?>
<style-scheme id="exemple" _name="Exemple" version="1.0">

  <author>Auteur</author>
  <_description>Mettez une description du thème (ce qu'il évoque, l'origine d'un tel thème...).</_description>

  <!-- On place ici les différentes informations sur le style -->

</style-scheme>

Quelques explications sur les balises utilisées :

<?xml version="1.0" encoding="UTF-8"?>

Cette ligne est la première ligne de quasiment tous les fichiers en xml. Il indique qu'on utilise la version 1.0 du xml avec un encodage de caractères en utf-8.

<style-scheme id="exemple" _name="Exemple" version="1.0">

• id est un identifiant pour le jeu de couleurs, qu'il est conseillé de mettre en minuscule.
• _name est le nom du jeu de couleurs que gEdit affichera dans l'onglet Police et Couleurs, dans les Préférences.
• version est la version des styles de texte que vous utilisez. Pour l'instant on n'a qu'une seule version, la 1.0, donc autant la laisser telle quelle.

<author>Auteur</author>

• C'est assez clair, non ?

<_description>Mettez une description du jeu de couleurs (ce qu'il évoque, l'origine d'un tel thème...).</_description>

• Une courte description du jeu de couleurs que vous créez/modifiez est affichée dans l'onglet Police et Couleurs, dans les Préférences. C'est ici qu'il faut l'indiquer.

<!-- On place ici les différentes informations sur le style -->

• Le texte situé entre <!– –> est un commentaire, c'est-à-dire que vous pouvez écrire ce que vous voulez sans que cela ne soit pris en compte. Histoire de vous y retrouvez dans ce que vous écrivez, usez-en !

Pour éviter de faire des fichiers deux fois plus lourds que nécessaire, n'en abusez pas non plus, sauf si vous débutez.

Toutes vos prochaines balises seront à placer entre </_description> et </style-scheme>.

Vous pouvez appliquer différents effets à du texte, notamment le colorer. Lorsqu'un paramètre vous demande une couleur, vous pouvez seulement indiquer une valeur hexadécimale, par exemple :

foreground="#FFFFFF"

Mais il faudra alors rentrer manuellement chacune des couleurs. Et si vous comptez appliquer la même couleur à plusieurs styles ? Et si vous voulez changer d'un coup la couleur de ces mêmes styles ? Une méthode plus rapide, et aussi plus claire, est de donner des noms à des couleurs.

Par convention on met ces indications de couleur tout de suite après la balise </_description>.

Voici un exemple de couleurs que vous pouvez définir :

<color name="gris" value="#bbbbbb"/>
<color name="blanc" value="#eeeeee"/>
<color name="jaune" value="#fce94f"/>
<color name="kaki" value="#617200"/>

Ainsi vous définissez vos propres valeurs de gris, de blanc, et ainsi de suite. Si vous trouvez qu'une certaine valeur de jaune est mal appropriée par rapport aux autres couleurs, vous avez juste à la modifier Ça tombe bien, gEdit possède un greffon pour sélectionner une couleur et l'insérer dans le document. Voir la section des greffons de gEdit.

Voila le plus intéressant : les styles ! Ce que vous allez colorer, afficher en gras… selon vos envies. Un style se définit comme tel :

<style name="nomdustyle" parametre="valeur" autreparametre="autrevaleur"/>

La liste des styles personnalisables est longue et aucune documentation claire n'existe à ce jour. Vous trouverez donc ci-dessous une liste non-exhaustive des styles utilisables.

Voici la liste des paramètres disponibles :

• bold : afficher du texte en gras.
• italic : afficher du texte en italique.
• underline : afficher du texte en souligné.
• strikethrough : barrer du texte.

Pour ces quatre paramètres, il faut donner une valeur booléenne : true pour afficher cet effet, false dans le cas contraire. Par définition, ces paramètres sont réglés sur false. Cependant, il se peut que deux styles se chevauchent, et qu'un texte s'affiche en gras alors que vous le voulez sans l'effet de gras quoi qu'il arrive. Dans ce cas-là, annoncez explicitement le paramètre en false.

• use-style : utiliser un style déjà défini. Voir plus bas la liste de style définissables.
• foreground : définir la couleur du texte du style.
• background : définir la couleur de fond du style.
• line-background : Si le texte du style que vous désignez occupe au moins le premier caractère d'une ligne, alors line-background colorera le fond de tout ce qui se trouve sur la ligne à droite du style en question. Dans ce cas, et si un autre style doit s'appliquer sur la ligne sur la droite, la propriété background prendra le dessus sur la line-background à cet endroit-là. Ce paramètre est difficile à bien placer, il peut être utilisé pour les commentaires par exemple ou pour le style bracket-match (voir plus bas).

Ces trois derniers paramètres demandent une couleur. Vous pouvez indiquer une valeur hexadécimale : #000000 , ou bien un nom donné à une couleur (voir ci-dessus la balise couleur).

Un style est défini au paramètre name. Cette partie liste tous les styles communs.

• text : Désigne le texte en général.
• selection : Désigne le texte sélectioné (surligué avec le curseur)
• selection-unfocused : Lorsque vous quittez la fenêtre de gEdit où vous avez sélectionné un texte, vous pouvez appliquer des effets à la sélection de sorte à voir ce que vous aviez sélectionner avant de regarder ailleurs. Sinon, les valeurs adoptées seront celles de selection.
• current-line : gEdit propose de mettre en valeur la ligne où se trouve le curseur (voir Préférences). current-line définit les effets appliqués sur cette ligne.
• line-number : gEdit propose d'afficher une colonne indiquant les numéros de ligne (voir Préférences). line-number définit les effets appliqués à cette colonne. Les effets de texte tels bold ou underline ne fonctionnent pas.
• cursor : Définit les propriétés du curseur. Les effets de texte tels bold ou underline ne fonctionnent pas.
• secondary-cursor : Il semblerait que cette fonctionnalité soit utilisée pour certaines langues, par exemple pour écrire en chinois une zone de préédition apparait en créant un deuxième curseur. Vous pouvez colorer secondary-cursor d'une couleur différente de cursor, les propriétés des deux styles étant les mêmes.
• bracket-match : gEdit propose, lorsque vous avez un duo de parenthèse et que vous mettez votre curseur sur une des parenthèses, de mettre en valeur l'autre parenthèse.
• bracket-mismatch : Cette fonctionnalité n'a pas encore été implanté dans gEdit. Le principe étant de montrer les erreurs de parenthésage, par exemple (] où le crochet prend la place d'une parenthèse fermée.
• search-match : Lors d'une recherche, plusieurs termes sont colorées : un qui est sélectionné, les autres qui ne le sont pas. search-match vous permet d'appliquer des effets sur ces termes.

Dans gEdit, chaque langage possède son propre fichier de spécification, ce qui est tant mieux pour savoir quels sont les mots à considérer comme étant un commentaire, une variable, etc. Le système actuel sur lequel fonctionne ces fichiers est voué à changer dans la prochaine version de gtk, la version actuelle de gtk étant la 2.6 . De ce fait, cet article contiendra une courte liste résumant les styles applicables pour tous les langages de programmation, et il vous faudra explorer un peu pour plus d'effets.

gEdit peut appliquer à un même style plusieurs effets différents selon le langage utilisé. Si vous ne pensez pas utiliser d'effets différents à un style, vous pouvez définir les effets liés à un style comme suit :

<style name="text" foreground="noir" background="blanc" />

le style text sera le même pour tous. Cependant, pour indiquer un style différent pour un langage en particulier, il suffit d'indiquer dans le nom les initiales du langage utilisé suivi du style, par exemple pour le langage C :

<style name="c:variable" foreground="rose"/>

Lorsque vous ouvrirez un fichier contenant du code écrit en C, les variables prendront une couleur "rose" (si vous l'avez définie). Pour les autres langages, on utilise le mot-clé def :

<style name="def:variable" foreground="jaune"/>

Si vous avez défini une couleur "jaune", les variables dans n'importe quel langage s'afficheront en "jaune".

Pour savoir s'il faut utiliser le mot-clé def: ou pas : def: s'applique à beaucoup de styles propres aux langages de programmation. Vous pouvez regarder dans le fichier def.lang situé en /usr/share/gtksourceview-2.0/language-specs/def.lang tous les styles définis dans les lignes :

<style id="unstyle" .../>

Pour colorer le style unstyle, vous devez écrire def:unstyle .

Dans le même dossier, vous pouvez voir différents fichiers .lang, par exemple c.lang. Au niveau de :

<styles>
        <style id="comment"           _name="Comment"             map-to="def:comment"/>
        <style id="error"             _name="Error"               map-to="def:error"/>
        <style id="string"            _name="String"              map-to="def:string"/>
               
           ...
        
        <style id="printf"            _name="printf Conversion"   map-to="def:special-char"/>
        
           ...
        
    </styles>

Le contenu qui nous intéresse est l'id. Ou bien vous voulez choisir précisément le style printf, ce qui donnera ça :

<style name="c:printf" foreground="#rose" background="#violet" />

Ou bien vous ne choisissez pas ce style et le style en question prendra une valeur par défaut. Le fichier .lang vous indique au passage le style par défaut qui sera appliqué, c'est le paramètre map-to. Si ce style par défaut n'est pas défini, ce sera le style du texte qui sera appliqué. Et si le style text n'est pas défini dans votre jeu de couleurs, votre texte sera écrit noir sur blanc.

À ce niveau, attention à ne pas mélanger ce que vous faites entre le fichier .lang et votre jeu de couleurs .xml : c'est le deuxième qui contient les couleurs et tout le bazar.

Si vous ne comptez pas appliquer d'effets à certains styles spécifiques à un langage, autrement dit si vous voulez y aller simple, alors on va se contenter des styles par défaut. :) Certains styles sont imbriquées dans d'autre : soit vous vous contentez du style parent, soit vous indiquez à tous les styles fils les effets de texte que vous voulez. Tous les styles ci-dessous sont déjà précédés par def: pour ceux qui liraient cette doc à toute vitesse.

• def:comment : Pour désigner les commentaires.
  • def:shebang : Dans les fichiers de shell, on indique le shell à utiliser en début de fichier avec un shebang, par exemple : #! /bin/bash .
  • def:doc-comment : Pour les commentaires destinés à la documentation qui sera générée à la compilation.
  • def:doc-comment-element : Utilisé pour les textes du style doc-comment, permet de mettre en valeur certains éléments comme @author.

• def:special-char : Pour désigner des "caractères spéciaux" : par exemple en C, on peut utiliser dans les chaines des caractères comme %s ou \n.
• def:constant : Pour désigner des valeurs constantes.
  • def:character : Lorsque vous saisissez un caractère, par exemple 'c' que vous voulez stocker dans une variable de type char
  • def:string : Pour les chaines de caractère cette fois.
  • def:number : Pour les valeurs de nombre.
    • def:floating-point : Pour les valeurs flottantes, par exemple 2.3e10 .
    • def:decimal : Pour des valeurs décimales classiques, comme 1234.
    • def:base-n-integer : Pour des nombres de base-N. Par exemple la valeur hexadécimale d'une couleur comme vous allez en utiliser pour faire un jeu de couleurs : #00abd3.
    • def:complex : Pour des nombres complexes.
  • def:special-constant : Pour des constantes spéciales, par exemple en C la constante NULL.
    • def:boolean : pour les valeurs booléennes, true et false.

• def:identifier : pour des identifiants de variable.
  • def:function : pour les identifiants de fonction.
  • def:builtin : Pour les identifiants de fonction de type Built-in, par exemple abs en Python.

• def:statement : Le terme général pour désigner les deux styles qui suivent.
  • def:operator : Pour désigner les opérateurs : +, *, etc.
  • def:keyword : pour les mots-clés comme if, else, switch, etc.

• def:type : Pour les types de données : int, double, char…

• def:preprocessor : Pour les directives de préprocesseur, par exemple en C.
• def:error : Pour des erreurs d'écriture
  • def:reserved : Certains mots sont "réservés", par exemple en Java : const, goto…
• def:note : Des notes destinées au programmeur, par exemple TODO…
• def:underlined : Tout ce qui doit être souligné, par exemple en HTML les liens, ou les adresses mail.

• Documentation pour créer un fichier lang (en)
• Un tutoriel pour créer un fichier lang (en)

Contributeurs : Zarmakuizz.