Tutoriel : construire un éditeur Turbo pour votre propre langage

  1
  2
  3
  4
  5
  6
  7
  8
  9
 10
 11
 12
 13
 14
 15
 16
 17
 18
 19
 20
 21
 22
 23
 24
 25
 26
 27
 28
 29
 30
 31
 32
 33
 34
 35
 36
 37
 38
 39
 40
 41
 42
 43
 44
 45
 46
 47
 48
 49
 50
 51
 52
 53
 54
 55
 56
 57
 58
 59
 60
 61
 62
 63
 64
 65
 66
 67
 68
 69
 70
 71
 72
 73
 74
 75
 76
 77
 78
 79
 80
 81
 82
 83
 84
 85
 86
 87
 88
 89
 90
 91
 92
 93
 94
 95
 96
 97
 98
 99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293

# Tutoriel : construire un éditeur Turbo pour votre propre langage

À la fin de ce tutoriel, vous disposerez d'un IDE de terminal en plein écran — barre de menus, fenêtres déplaçables, souris, thèmes, arborescence de projet, fenêtres de terminal et coloration syntaxique — pour le langage de votre choix. Nous en construirons un pour **Zig**, et il fera environ quatre-vingts lignes de Go.

Aucune connaissance de turbo-core n'est requise. Il vous faut Go 1.26 ou plus récent, et un terminal.

## Prérequis

- Go 1.26 ou plus récent dans votre PATH.
- Une copie de turbo-core à côté de l'endroit où vous allez travailler. Si vous n'en avez pas :

```bash
git clone ssh://git@rickub.com/turbo-editors/turbo-core.git
```

## Étape 1 — Créer le module

À côté de votre copie de turbo-core, tapez :

```bash
mkdir turbo-zig && cd turbo-zig
go mod init example.com/turbo-zig
```

Vous devriez voir :

```
go: creating new go.mod: module example.com/turbo-zig
```

Nous avons maintenant un module vide. Nous allons le brancher sur la bibliothèque.

## Étape 2 — Dépendre de turbo-core

Tapez :

```bash
go mod edit -require=rickub.com/turbo-editors/turbo-core@v0.1.0
go mod edit -replace=rickub.com/turbo-editors/turbo-core=../turbo-core
```

Rien ne s'affiche. Regardez `go.mod` :

```bash
cat go.mod
```

Vous devriez voir une ligne `require` et une ligne `replace` nommant turbo-core. C'est le `replace` qui fait que la copie posée à côté de vous est celle qui sera utilisée.

## Étape 3 — Dire quel éditeur c'est

Créez `profile.go` :

```go
package main

import "rickub.com/turbo-editors/turbo-core/profile"

// zig est l'éditeur que nous construisons.
func zig() profile.Profile {
	return profile.Profile{
		Name:        "Turbo Zig",
		Slug:        "turbo-zig",
		Language:    "Zig",
		ToolsMenu:   "~Z~ig",
		RootMarkers: []string{"build.zig"},
		Server: profile.Server{
			Command:     "zls",
			InstallHint: "voir https://github.com/zigtools/zls",
		},
		Templates: profile.Templates{
			Settings: settingsTemplate,
			Snippets: snippetsTemplate,
			Tools:    toolsTemplate,
		},
	}
}
```

Voilà la totalité de ce qui distingue cet éditeur de Turbo Go. Nous n'avons pas encore écrit les modèles — c'est l'étape suivante.

## Étape 4 — Écrire les trois fichiers de départ

Créez `templates.go` :

```go
package main

const settingsTemplate = `# turbo-zig project settings.

[editor]

theme = %q
autosave = false
autosave_delay = %q
`

const snippetsTemplate = `# turbo-zig snippets.
#
# Un extrait sans groupe va dans %s.
# Les vôtres vivent dans :
#   %s

[[snippet]]
name = "TODO"
body = "TODO: "
`

const toolsTemplate = `# turbo-zig tools.

[[tool]]
name = "~B~uild"
command = "zig build"
output = "popup"

[[tool]]
name = "~T~est"
command = "zig build test"
output = "popup"

[[tool]]
name = "~R~un"
command = "zig build run"
output = "terminal"
`
```

Les trous comptent : `settingsTemplate` prend le nom du thème puis le délai de sauvegarde automatique, `snippetsTemplate` prend le nom du groupe sans nom puis le chemin des extraits de l'utilisateur. La [référence Profile](../reference/profile.md) les donne exactement.

## Étape 5 — Écrire la commande

Créez `main.go` :

```go
package main

import (
	"context"
	"fmt"
	"os"

	"github.com/gdamore/tcell/v2"

	"rickub.com/turbo-editors/turbo-core/app"
)

func main() {
	if err := run(); err != nil {
		fmt.Fprintln(os.Stderr, "turbo-zig:", err)
		os.Exit(1)
	}
}

func run() error {
	screen, err := tcell.NewScreen()
	if err != nil {
		return err
	}
	if err := screen.Init(); err != nil {
		return err
	}
	defer screen.Fini()
	screen.EnableMouse()
	screen.EnablePaste()

	p := zig()
	editor := app.New(screen, "turbo-classic", p)

	files := os.Args[1:]
	if len(files) == 0 {
		editor.NewFile()
	}
	for _, file := range files {
		editor.Open(file)
	}

	ctx, cancel := context.WithCancel(context.Background())
	defer cancel()
	editor.StartLanguageServer(ctx, app.ProjectRoot(p, files))
	defer editor.Language().Stop(context.Background())

	return editor.Run()
}
```

## Étape 6 — Le lancer

Tapez :

```bash
go mod tidy
go run . main.go
```

Votre terminal se remplit d'un bureau bleu. En haut, vous devriez lire :

```
 File  Edit  Search  Run  Options  Window  Snippets  Zig  Help
```

et une fenêtre au milieu montrant `main.go`. Appuyez sur **F10** pour ouvrir la barre de menus, les flèches pour vous y déplacer, et **Alt-X** pour sortir.

Nous avons un éditeur qui marche. Tout ce qui est sur cette barre fonctionne : **F3** ouvre un fichier, **F8** ouvre une fenêtre de terminal avec un vrai shell dedans, **F9** ouvre l'arborescence du projet, **Options ▸ Theme** propose onze thèmes de couleurs.

## Étape 7 — Colorer le langage

Les fichiers Zig ne sont pas encore colorés, parce que rien n'a dit à la bibliothèque ce qu'est Zig. Créez `syntax.go` :

```go
package main

import "rickub.com/turbo-editors/turbo-core/syntax"

// registerZig enseigne à la bibliothèque un tout petit peu de Zig : ses
// mots-clés, ses commentaires et ses chaînes.
func registerZig() {
	syntax.Register(syntax.Definition{
		Language:   "zig",
		Extensions: []string{".zig"},
		Highlight:  highlightZig,
	})
}

var zigKeywords = map[string]bool{
	"const": true, "var": true, "fn": true, "pub": true, "return": true,
	"if": true, "else": true, "while": true, "for": true, "struct": true,
	"try": true, "defer": true, "test": true, "comptime": true,
}

func highlightZig(src string) [][]syntax.Span {
	return syntax.ScanLines(src, func(line []rune, carry struct{}) ([]syntax.Span, struct{}) {
		s := syntax.NewLineScanner(line)
		for !s.AtEnd() {
			switch r := s.Peek(0); {
			case r == ' ' || r == '\t':
				s.SkipSpaces()
			case s.HasPrefix(0, "//"):
				s.TakeRest(syntax.ClassComment)
			case r == '"':
				syntax.TakeQuoted(s, '"', syntax.ClassString)
			case syntax.IsDigit(r):
				s.TakeWhile(syntax.ClassNumber, syntax.IsWordRune)
			case syntax.IsLetter(r) || r == '_':
				start := s.Pos()
				for !s.AtEnd() && syntax.IsWordRune(s.Peek(0)) {
					s.Advance(1)
				}
				class := syntax.ClassIdentifier
				if zigKeywords[string(line[start:s.Pos()])] {
					class = syntax.ClassKeyword
				}
				s.Emit(start, s.Pos(), class)
			default:
				s.Advance(1)
			}
		}
		return s.Spans(), carry
	})
}
```

Ajoutez une ligne à `run`, juste au-dessus de `p := zig()` :

```go
	registerZig()
```

## Étape 8 — Le voir coloré

Écrivez un fichier Zig et ouvrez-le :

```bash
cat > hello.zig <<'EOF'
// A greeting.
const std = @import("std");

pub fn main() void {
    std.debug.print("hello {d}\n", .{42});
}
EOF
go run . hello.zig
```

`const`, `pub`, `fn` sont dessinés dans la couleur des mots-clés, `// A greeting.` dans celle des commentaires, `"hello {d}\n"` dans celle des chaînes et `42` dans celle des nombres. Appuyez sur **Alt-X** pour sortir.

## Et maintenant ?

Vous avez un éditeur. Ce qui lui manque encore, c'est un vrai analyseur — celui ci-dessus connaît quatorze mots-clés et ignore tout des chaînes multilignes `\\` et des littéraux de caractère.

- Pour en écrire un correct → [Ajouter un langage](../how-to/add-a-language.md)
- Pour faire marcher la complétion → [Dialoguer avec un serveur de langage](../how-to/talk-to-a-language-server.md)
- Pour voir tous les champs que vous avez sautés → [Référence Profile](../reference/profile.md)
- Pour comprendre pourquoi la bibliothèque a cette forme → [Architecture](../explanation/architecture.md)