| 🛟 Updated. 28d5985 k33g 21h ago | 1 | # Comment ajouter un langage |
| 2 | |
| 3 | Ce guide montre comment apprendre à un éditeur bâti sur turbo-core à colorer un langage. Il suppose que vous avez déjà un éditeur — sinon, [construisez-en un d'abord](../tutorials/build-an-editor.md). |
| 4 | |
| 5 | turbo-core colore lui-même TOML, YAML, Markdown, JavaScript, HTML, XML, les Dockerfiles et le shell. Le langage *pour lequel* votre éditeur existe, c'est à vous de l'enregistrer : c'est ce qui fait que Turbo Go colore Go et que Turbo Rust colore Rust. |
| 6 | |
| 7 | ## Étapes |
| 8 | |
| 9 | ### 1. Décider comment le langage est reconnu |
| 10 | |
| 11 | Un fichier est reconnu d'abord par son extension, et seulement à défaut par sa première ligne : |
| 12 | |
| 13 | ```go |
| 14 | syntax.Definition{ |
| 15 | Language: "zig", |
| 16 | Extensions: []string{".zig"}, // avec le point, en minuscules |
| 17 | Filenames: []string{"build.zig"}, // pour les fichiers sans extension utile |
| 18 | Shebangs: []string{"zig"}, // la plupart des langages n'en ont pas |
| 19 | Highlight: highlightZig, |
| 20 | } |
| 21 | ``` |
| 22 | |
| 23 | `Language` est le nom sous lequel le langage est connu partout ailleurs : c'est ce que renvoie `LanguageOf`, et ce qu'un utilisateur écrit dans la clé `languages` d'un fichier d'extraits. Gardez-le en minuscules, et gardez-le stable. |
| 24 | |
| 25 | **Un fichier est reconnu par son extension, puis par son nom, puis par sa première ligne.** `Filenames` sert aux fichiers sans extension exploitable — un `Dockerfile`, un `Makefile`. La correspondance se fait sur le nom entier **ou** sur la partie précédant le premier point, sans tenir compte de la casse : lister `"Dockerfile"` reconnaît donc aussi `Dockerfile.dev` sans avoir à nommer chaque variante qu'un projet pourrait inventer. |
| 26 | |
| 27 | ### 2. Écrire l'analyseur |
| 28 | |
| 29 | Un analyseur prend le document entier et renvoie une tranche de segments par ligne. `ScanLines` découpe les lignes et fait passer d'une ligne à l'autre ce qui traverse un saut de ligne : |
| 30 | |
| 31 | ```go |
| 32 | func highlightZig(src string) [][]syntax.Span { |
| 33 | return syntax.ScanLines(src, func(line []rune, inComment bool) ([]syntax.Span, bool) { |
| 34 | s := syntax.NewLineScanner(line) |
| 35 | // … colorer la ligne, en mettant inComment à jour au passage … |
| 36 | return s.Spans(), inComment |
| 37 | }) |
| 38 | } |
| 39 | ``` |
| 40 | |
| 41 | Dans la fonction, demandez à `s.Peek(0)` ce qui se trouve là et prenez-le : |
| 42 | |
| 43 | | Pour colorer | Appelez | |
| 44 | | --- | --- | |
| 45 | | un commentaire jusqu'à la fin de la ligne | `s.TakeRest(syntax.ClassComment)` | |
| 46 | | une chaîne entre guillemets se fermant sur cette ligne | `syntax.TakeQuoted(s, '"', syntax.ClassString)` | |
| 47 | | un commentaire de bloc qui s'ouvre ici | `syntax.OpenBlockComment(s, "/*", "*/", syntax.ClassComment)` | |
| 48 | | la suite d'un commentaire ouvert plus tôt | `syntax.FinishBlockComment(s, "*/", syntax.ClassComment)` | |
| 49 | | une suite de runes qui correspondent | `s.TakeWhile(syntax.ClassNumber, syntax.IsDigit)` | |
| 50 | | un nombre fixe de runes | `s.Take(2, syntax.ClassOperator)` | |
| 51 | | des espaces, sans les colorer | `s.SkipSpaces()` | |
| 52 | | n'importe quoi d'autre, sans le colorer | `s.Advance(1)` | |
| 53 | |
| 54 | La liste complète est dans la [référence syntaxique](../reference/syntax.md). |
| 55 | |
| 56 | ### 3. L'enregistrer |
| 57 | |
| 58 | ```go |
| 59 | func Register() { |
| 60 | syntax.Register(syntax.Definition{ /* … */ }) |
| 61 | } |
| 62 | ``` |
| 63 | |
| 64 | Appelez cela depuis le `main` de votre commande, avant qu'aucun fichier ne soit ouvert. Faites-le explicitement plutôt que depuis une fonction `init`, pour que « cet éditeur connaît Zig » soit une ligne que quelqu'un peut lire. |
| 65 | |
| 66 | ### 4. Le tester |
| 67 | |
| 68 | Pilotez l'analyseur par `syntax.Highlight`, qui est le chemin que prend l'éditeur : |
| 69 | |
| 70 | ```go |
| 71 | func TestKeywordsAreColoured(t *testing.T) { |
| 72 | Register() |
| 73 | |
| 74 | spans := syntax.Highlight("zig", "const x = 1;") |
| 75 | |
| 76 | if spans[0][0].Class != syntax.ClassKeyword { |
| 77 | t.Errorf("const est %v, on veut keyword", spans[0][0].Class) |
| 78 | } |
| 79 | } |
| 80 | ``` |
| 81 | |
| 82 | Trois choses méritent leur propre test, parce que chacune est un vrai bug déjà survenu ici : |
| 83 | |
| 84 | - **Une entrée par ligne.** L'éditeur indexe le résultat par numéro de ligne sans vérifier : un résultat trop court, c'est un dépassement d'indice au milieu d'un redessin. |
| 85 | - **Des segments ordonnés et sans recouvrement.** Ils sont dessinés dans l'ordre ; deux segments désordonnés se repeignent l'un sur l'autre. |
| 86 | - **Une source cassée reste colorée.** Le code sous le curseur est invalide la plupart du temps pendant qu'on le tape. |
| 87 | |
| 88 | ## Variantes |
| 89 | |
| 90 | ### Le langage a déjà un analyseur lexical |
| 91 | |
| 92 | Si votre langage fournit un lexeur — `go/scanner` pour Go, par exemple — utilisez-le et convertissez ses décalages en octets avec `LineIndex` au lieu d'écrire un analyseur ligne à ligne : |
| 93 | |
| 94 | ```go |
| 95 | func highlightGo(src string) [][]syntax.Span { |
| 96 | lines := syntax.NewLineIndex(src) |
| 97 | out := make([][]syntax.Span, lines.Count()) |
| 98 | |
| 99 | for _, token := range tokenise(src) { |
| 100 | lines.AppendSpans(out, token.start, token.end, classOf(token)) |
| 101 | } |
| 102 | return out |
| 103 | } |
| 104 | ``` |
| 105 | |
| 106 | `AppendSpans` découpe en un segment par ligne une plage qui traverse un saut de ligne — ce qu'un segment n'a jamais le droit de faire. |
| 107 | |
| 108 | ### Quelque chose traverse un saut de ligne |
| 109 | |
| 110 | Mettez-le dans l'état que `ScanLines` fait circuler. Utilisez une valeur, pas un drapeau, quand la construction s'imbrique : les commentaires de bloc de Rust s'imbriquent, donc Turbo Rust transporte une profondeur, et un `bool` fermerait un commentaire imbriqué un niveau trop tôt. |
| 111 | |
| 112 | ### Votre langage a besoin d'une couleur que rien d'autre n'utilise |
| 113 | |
| 114 | C'est probablement faux. Les classes sont fixées exprès, pour qu'un seul thème colore tous les langages qu'un éditeur apprendra jamais. Le balisage a réclamé cinq classes supplémentaires (`ClassHeading`, `ClassTag`, `ClassAttribute`, `ClassEmphasis`, `ClassLink`) parce qu'un titre n'est réellement pas un mot-clé ; servez-vous d'abord de celles-là avant d'en demander une sixième. |
| 115 | |
| 116 | ### Vous voulez remplacer un langage intégré |
| 117 | |
| 118 | Enregistrez votre propre définition avec le même `Language`. L'enregistrement le plus récent gagne, parce que c'est l'affirmation la plus précise des deux. |
| 119 | |
| 120 | ## Voir aussi |
| 121 | |
| 122 | - Tout ce qu'offre la boîte à outils : [référence syntaxique](../reference/syntax.md) |
| 123 | - Pourquoi la liste des classes est fermée : [ce qui appartient ici](../explanation/what-belongs-here.md) |