La coloration syntaxique avec Vim

CETTE page présente graphiquement la vingtaine de palettes de coloration syntaxique pour Vim 9.0. Il est aussi question de fabriquer soi-même une coloration syntaxique.

:syntax on et :colorscheme ··· doivent avoir été saisis en ligne d'exécution ou figurer dans le fichier .vimrc pour qu'un de ces schéma de coloration syntaxique puisse fonctionner. Il semble également qu'il faille que le fichier soit sauvegardé avec une extension de script ou de source.

1. Palettes fournies

colorscheme blue

colorscheme darkblue

colorscheme default

colorscheme delek

colorscheme desert

colorscheme elflord

colorscheme evening

colorscheme habamax

colorscheme industry

colorscheme koehler

colorscheme lunaperche

colorscheme morning

colorscheme murphy

colorscheme pablo

colorscheme peachpuff

colorscheme quiet

colorscheme ron

colorscheme shine

colorscheme slate

colorscheme torte

colorscheme zellner

1. Créer sa palette

Pour des catégories de mots, il est possible de définir, pour un terminal à 8, 16, ou 256 couleurs :

• ctermfg=255 couleur des caractères (gris très clair) pour un terminal ANSI-256 couleurs ; limité à ctermfg=7 ou ctermfg=15 selon la capacité du terminal.
• ctermbg=0 couleur du fond pour un terminal ANSI-256 couleurs
• cterm= permet italic, bold, underline

Pour une interface graphique ou un terminal acceptant les 16Mi couleurs :

• guifg=#d7d7d7 couleur du caractère
• guibg=#000000 couleur du fond
• gui= permet italic, bold, underline

Une première ligne précise les couleurs par défaut pour les caractères et le fond :

hi Normal guifg=#000000 guibg=#ffffff

Les parties d'un script ou d'un fichier source sont réparties en plusieurs catégories et sous catégories. Il est possible de ne définir que les catégories, les sous-catégories étant automatiquement concernées. Définir ces dernières permet de raffiner les distinctions.

• Comment tout commentaire
• Constant toute constante
  • String une chaine
  • Character une constante char, c, \n
  • Number un nombre entier : 234, 0xff
  • Boolean un booleéen : TRUE, false
  • Float un nombre décimal : 3.14, 1.3e-43
• Identifier pour les noms de variable, si distinguable ($var pour PHP)
  • Function pour les noms de fonction ou de méthode de classe
• Statement statement
  • Conditional les conditions if, then, else, endif, switch, etc.
  • Repeat les répétitions for, do, while, etc.
  • Label les étiquettes case, default, etc.
  • Operator les ppérateurs "sizeof", "+", "*", etc.
  • Keyword les autres keyword
  • Exception les exceptions try, catch, throw
• PreProc tout préprocesseur
  • Include préprocesseur #include
  • Define préprocesseur #define
  • Macro comme Define
  • PreCondit préprocesseur #if, #else, #endif, etc.
• Type int, long, char, etc.
  • StorageClass static, register, volatile, etc.
  • Structure struct, union, enum, etc.
  • Typedef A typedef
• Special les symboles spéciaux comme \t \n
  • SpecialChar un caractère spécial dans une constante
  • Tag you can use CTRL-] on this
  • Delimiter charactère qui nécessite une attention
  • SpecialComment quelque chose de spécial dans un commentaire
  • Debug debugging statements
• Underlined liens HTML
• Ignore laissé caché |hl-Ignore|
• Error construction erronée
• Todo ce qui nécessite une attention particulière, comme Note, TODO FIXME and XXX

Ces catégories sont insensibles à la casse. On ne peut pas utiliser les mots none, all, allbut, contains ou contained

D'autres directives permettent de colorer les à-côté du script :

• LineNr numéros de ligne
• CursorLineNr
• CursorLine

Il est possible d'interroger Vim sur la nature d'une expression en y positionnant le curseur et

:echo synIDattr(synID(line('.'), col('.'), 1), 'name')

qui fournit la catégorie du mot désigné.

" ~/.vim/colors/colorix.vim
hi clear
if exists("syntax_on")
 syntax reset
endif
let g:colors_name = "colorix"

if has('termguicolors')
 set termguicolors
endif

hi Normal ctermfg=255 ctermbg=0 guifg=#d7d7d7 guibg=#000000 " tout ce qui n'est pas ce qui suit
hi Comment ctermfg=8 cterm=italic guifg=#888a85 gui=italic  " commentaires
hi Constant ctermfg=214 guifg=#fcaf3e
hi String ctermfg=33 guifg=#0087ff      " chaines
hi Number ctermfg=160 guifg=#d70000     " nombres entier ou float
hi Identifier ctermfg=180 guifg=#e9b96e

hi Function ctermfg=71 guifg=#33bb44    " fonctions intégrées ou définies
hi Statement ctermfg=208 guifg=#f57900  " instructions
hi Keyword ctermfg=166 guifg=#d75f00
hi PreProc ctermfg=139 guifg=#ad7fa8
hi Type ctermfg=214 guifg=#fcaf3e
hi Special ctermfg=160 guifg=#ef2929    " caractères spéciaux \n, \t...
hi Todo ctermfg=0 ctermbg=11 guifg=#000000 guibg=#fcd94f
hi LineNr ctermfg=221 guifg=#d7d760    " numéros de ligne

hi CursorLineNr ctermfg=220 guifg=#ffff87
hi CursorLine ctermbg=235 guibg=#303030

hi! Float ctermfg=180 guifg=#d7af87    " voir plus bas

" Lien vers groupes syntaxiques courants
hi! link pythonFloat Float
hi! link pythonNumber Number
hi! link pythonString String

J'ai ajouté quelques commandes spécifiques à python :

" ~/.vim/after/syntax/python.vim

" Supprime les définitions existantes si besoin
syntax clear pythonFloat

" Redéfinit les float
syntax match pythonFloat /\<\d\+\.\d*\>/ " pas de chiffre obligatoire après le point
syntax match pythonFloat /\<\d*\.\d\+\>/ " pas de chiffre obligatoire avant le point
syntax match pythonFloat /\<\d\+\.\d\+e[+-]\=\d\+\>/ containedin=pythonNumber " exposant

" Applique la couleur liée au groupe Float
hi default link pythonFloat Float

syntax keyword pythonBoolean True False None  " les booléens et None ont une couleur propre
hi pythonBoolean ctermfg=129 guifg=#af5fff

Correspondance hexadécimale des 256 couleurs ANSI

Les nombres de 0 à 255 sont utilisables sur les consoles ANSI, les très anciens système ne connaissent que les seize, voire les huit premières. Ces nombres sont utilisé avec ctermfg pour la couleur des caractères, et ctermbg pour le fond.

Les codes hexadécimaux valent pour les éditeurs sous interface graphiques et les consoles si Vim a été compilé avec l'option termguicolor. Il est possible de s'en assurer avec :set termguicolors? : si la réponse est termguicolors, c'est que le terminal permet les nuances des 16Mi de couleurs.

Les seize teintes canoniques

Huit teintes figurent dans les deux parties du tableau : 0 et 16, 9 et 196, 10 et 46, 11 et 226, 12 et 21, 13 et 201, 14 et 51, ainsi que 15 et 231.

Les 240 suivantes