| 🛟 Updated. 28d5985 k33g 19h ago | 1 | # Référence : le point d'extension syntaxique |
| 2 | |
| 📦 Turbo Core f3ade8d k33g 11h ago | 3 | > Description neutre et exhaustive de ce que `rickub.com/turbo-editors/turbo-core/syntax` offre à l'auteur d'un langage. |
| 🛟 Updated. 28d5985 k33g 19h ago | 4 | |
| 5 | ## Language |
| 6 | |
| 7 | ```go |
| 8 | type Language string |
| 9 | ``` |
| 10 | |
| 11 | Le nom sous lequel un langage est connu. C'est une chaîne parce qu'il est écrit hors du paquet : un fichier d'extraits se restreint avec `languages = ["go"]`, et un langage enregistré par un éditeur n'est pas quelque chose que la bibliothèque aurait pu numéroter d'avance. |
| 12 | |
| 13 | | Constante | Valeur | |
| 14 | | --- | --- | |
| 15 | | `LanguageNone` | `""` | |
| 16 | | `LanguageTOML` | `"toml"` | |
| 17 | | `LanguageYAML` | `"yaml"` | |
| 18 | | `LanguageMarkdown` | `"markdown"` | |
| 19 | | `LanguageJavaScript` | `"javascript"` | |
| 20 | | `LanguageHTML` | `"html"` | |
| 21 | | `LanguageXML` | `"xml"` | |
| 22 | | `LanguageDockerfile` | `"dockerfile"` | |
| 23 | | `LanguageBash` | `"bash"` | |
| 24 | |
| 25 | `Language.String()` renvoie le nom, et `"none"` pour `LanguageNone`. |
| 26 | |
| 27 | ## Definition |
| 28 | |
| 29 | | Champ | Type | Description | |
| 30 | | --- | --- | --- | |
| 31 | | `Language` | `Language` | Le nom ; la valeur que `LanguageOf` renvoie pour un fichier de cette sorte. | |
| 32 | | `Extensions` | `[]string` | Les extensions qui l'identifient, avec leur point, en minuscules. | |
| 33 | | `Filenames` | `[]string` | Des noms de fichiers entiers qui l'identifient, pour les fichiers sans extension utile : `"Dockerfile"`. Un fichier correspond par son nom entier **ou** par la partie précédant son premier point, sans tenir compte de la casse — `"Dockerfile"` répond donc aussi pour `Dockerfile.dev`. Un nom entièrement composé d'une extension, comme `.gitignore`, a un radical vide et ne correspond à rien. | |
| 34 | | `Shebangs` | `[]string` | Les noms d'interpréteurs qui identifient un fichier sans extension utile. | |
| 35 | | `Highlight` | `func(string) [][]Span` | Colore un document entier. Peut être nil, ce qui nomme un langage sans le colorer. | |
| 36 | |
| 37 | ## Fonctions du paquet |
| 38 | |
| 39 | | Fonction | Description | |
| 40 | | --- | --- | |
| 41 | | `Register(Definition)` | Ajoute un langage. En enregistrer un déjà connu le remplace. N'est pas sûr depuis deux goroutines à la fois. | |
| 42 | | `Registered() []Language` | Les langages colorables, triés par nom. | |
| 43 | | `LanguageOf(path, firstLine string) Language` | Le langage d'un fichier : **extension**, puis **nom**, puis **shebang**. `LanguageNone` si rien ne le revendique. | |
| 44 | | `Highlight(l Language, src string) [][]Span` | Une tranche de segments par ligne de `src`, toujours exactement autant d'entrées qu'il y a de lignes. | |
| 45 | |
| 46 | ## Span et Class |
| 47 | |
| 48 | ```go |
| 49 | type Span struct { |
| 50 | Start int // colonne en runes, incluse |
| 51 | End int // colonne en runes, exclue |
| 52 | Class Class |
| 53 | } |
| 54 | ``` |
| 55 | |
| 56 | Un segment ne peut jamais chevaucher un saut de ligne. Les segments d'une ligne doivent être ordonnés et ne pas se recouvrir. |
| 57 | |
| 58 | | Classe | Sert à | |
| 59 | | --- | --- | |
| 60 | | `ClassIdentifier` | la valeur nulle : le texte que rien d'autre ne revendique | |
| 61 | | `ClassKeyword` | un mot réservé | |
| 62 | | `ClassType` | un nom de type | |
| 63 | | `ClassBuiltin` | quelque chose que le langage lui-même fournit | |
| 64 | | `ClassConstant` | un littéral nommé par le langage | |
| 65 | | `ClassFunction` | un nom de fonction, déclaré ou appelé | |
| 66 | | `ClassString` | un littéral de chaîne | |
| 67 | | `ClassChar` | un littéral de caractère | |
| 68 | | `ClassNumber` | un littéral numérique | |
| 69 | | `ClassComment` | un commentaire | |
| 70 | | `ClassOperator` | un opérateur | |
| 71 | | `ClassPunctuation` | de la structure plutôt que du calcul | |
| 72 | | `ClassHeading` | un titre Markdown | |
| 73 | | `ClassTag` | un nom d'élément HTML | |
| 74 | | `ClassAttribute` | un nom d'attribut HTML, ou un attribut Rust | |
| 75 | | `ClassEmphasis` | du gras ou de l'italique Markdown | |
| 76 | | `ClassLink` | un lien ou une image Markdown | |
| 77 | |
| 78 | `Class.StyleKey()` renvoie la clé de thème qui la colore ; une classe hors bornes donne la clé identifiant. `Class.String()` renvoie le nom, et `"unknown"` hors bornes. |
| 79 | |
| 80 | L'ensemble est fermé. Un langage enregistré depuis l'extérieur se colore avec celles-ci et aucune autre. |
| 81 | |
| 82 | ## ScanLines |
| 83 | |
| 84 | ```go |
| 85 | func ScanLines[State any](src string, scan func(line []rune, carry State) ([]Span, State)) [][]Span |
| 86 | ``` |
| 87 | |
| 88 | Passe un analyseur ligne à ligne sur un document, en faisant circuler ce qui traverse un saut de ligne. `State` part de sa valeur nulle à la première ligne. Un `\r` final est retiré de chaque ligne, donc un fichier CRLF se colore comme un fichier LF. |
| 89 | |
| 90 | ## LineScanner |
| 91 | |
| 92 | ```go |
| 93 | func NewLineScanner(line []rune) *LineScanner |
| 94 | ``` |
| 95 | |
| 96 | | Méthode | Description | |
| 97 | | --- | --- | |
| 98 | | `Spans() []Span` | Les segments trouvés jusqu'ici. | |
| 99 | | `Len() int` | Le nombre de runes de la ligne. | |
| 100 | | `Pos() int` | La position courante, en runes. | |
| 101 | | `AtEnd() bool` | Si toute la ligne a été consommée. | |
| 102 | | `Peek(offset int) rune` | La rune à un décalage de la position, ou `0` au-delà de l'une ou l'autre extrémité. | |
| 103 | | `Advance(n int)` | Avance sans colorer, en s'arrêtant à la fin de la ligne. | |
| 104 | | `Emit(start, end int, class Class)` | Enregistre un segment. Les segments vides sont écartés. | |
| 105 | | `Take(n int, class Class)` | Consomme `n` runes et les colore. | |
| 106 | | `TakeWhile(class Class, matches func(rune) bool) bool` | Consomme tant que les runes correspondent ; dit s'il y en a eu. | |
| 107 | | `TakeRest(class Class)` | Consomme et colore tout ce qui reste sur la ligne. | |
| 108 | | `SkipSpaces()` | Franchit espaces et tabulations sans les colorer. | |
| 109 | | `HasPrefix(offset int, want string) bool` | Si la ligne lit `want` à un décalage de la position. | |
| 110 | |
| 111 | Comme `Emit` écarte les segments vides, un analyseur doit passer le début d'un segment en paramètre plutôt que le rapiécer après coup sur le dernier segment : le dernier n'est peut-être pas celui qu'il croit. |
| 112 | |
| 113 | ## Fonctions libres |
| 114 | |
| 115 | | Fonction | Description | |
| 116 | | --- | --- | |
| 117 | | `TakeQuoted(s, quote rune, class Class)` | Une chaîne entre guillemets se fermant sur cette ligne, échappements compris. Une chaîne non fermée est colorée jusqu'au bout de la ligne. | |
| 118 | | `OpenBlockComment(s, opener, closer string, class Class) bool` | Un commentaire de bloc commençant à la position ; dit s'il s'est aussi fermé sur cette ligne. | |
| 119 | | `FinishBlockComment(s, closer string, class Class) bool` | La suite d'un commentaire ouvert plus tôt ; dit s'il s'est fermé ici. | |
| 120 | | `IsOperatorRune(r rune) bool` | L'un de `+-*/%=<>!&\|^~?:` | |
| 121 | | `IsPunctuationRune(r rune) bool` | L'un de `()[]{},;.` | |
| 122 | | `IsDigit(r rune) bool` | Un chiffre ASCII. | |
| 123 | | `IsLetter(r rune) bool` | Une lettre ASCII. | |
| 124 | | `IsWordRune(r rune) bool` | Une lettre, un chiffre, ou un souligné. | |
| 125 | |
| 126 | ## LineIndex |
| 127 | |
| 128 | Pour un analyseur qui travaille en décalages d'octets plutôt que ligne à ligne. |
| 129 | |
| 130 | ```go |
| 131 | func NewLineIndex(src string) *LineIndex |
| 132 | ``` |
| 133 | |
| 134 | | Méthode | Description | |
| 135 | | --- | --- | |
| 136 | | `Count() int` | Le nombre de lignes, toujours au moins une. | |
| 137 | | `AppendSpans(out [][]Span, start, end int, class Class)` | Enregistre la plage d'octets `[start, end)` comme un segment par ligne traversée. `out` doit déjà avoir `Count()` entrées. | |
| 138 | |
| 139 | ### Exemple |
| 140 | |
| 141 | ```go |
| 142 | lines := syntax.NewLineIndex(src) |
| 143 | out := make([][]syntax.Span, lines.Count()) |
| 144 | lines.AppendSpans(out, token.Start, token.End, syntax.ClassKeyword) |
| 145 | ``` |
| 146 | |
| 147 | ## Cache |
| 148 | |
| 149 | Ce à partir de quoi l'éditeur dessine : il ne réanalyse que quand la révision du tampon a bougé. |
| 150 | |
| 151 | | Fonction ou méthode | Description | |
| 152 | | --- | --- | |
| 153 | | `NewCache(Language) *Cache` | Un cache pour un langage. `LanguageNone` en donne un désactivé. | |
| 154 | | `Language() Language` | Le langage en usage. | |
| 155 | | `SetLanguage(Language)` | Le change et jette ce qui avait été analysé. | |
| 156 | | `Enabled() bool` | Si le langage est autre chose que `LanguageNone`. | |
| 157 | | `Update(src string, revision int)` | Réanalyse quand la révision a bougé, ou au premier appel. | |
| 158 | | `Line(i int) []Span` | Les segments d'une ligne ; `nil` hors bornes. | |
| 159 | | `LineCount() int` | Combien de lignes ont été analysées. | |
| 160 | |
| 161 | ## Voir aussi |
| 162 | |
| 163 | - [Ajouter un langage](../how-to/add-a-language.md) |