Tampons et fenêtres

Neovim sépare le contenu de l’affichage. Un tampon contient du texte en mémoire ; une fenêtre est une vue sur un tampon ; un onglet est une disposition de fenêtres.

Un même tampon peut apparaître dans plusieurs fenêtres. Les extensions manipulent ces identifiants, qui sont des entiers, au moyen des familles d’API nvim_buf_* et nvim_win_*.

nvim_buf_get_lines(buf, start, end_, strict) renvoie les lignes sous forme de liste. Les indices commencent à zéro et la borne de fin est exclue ; transmettez -1 comme fin pour atteindre la dernière ligne.

Définir strict_indexing sur false permet d’accepter les indices hors limites au lieu de générer une erreur.

nvim_buf_set_lines remplace une plage par un nouveau texte. Pour ajouter du contenu à la fin, définissez le début et la fin sur -1. Pour tout remplacer, utilisez 0, -1.

Le remplacement est une liste Lua de chaînes, une par ligne, sans caractères de saut de ligne finaux.

Créez un tampon non répertorié et jetable avec nvim_create_buf(listed, scratch). En transmettant false, true, vous obtenez un tampon temporaire idéal pour l’interface d’une extension.

Définissez bufhidden = 'wipe' afin qu’il disparaisse lorsque sa fenêtre se ferme et d’éviter les tampons résiduels.

Utilisez vim.bo[buf] pour définir les options propres au tampon correspondant à un identifiant précis. Les paramètres courants des extensions comprennent modifiable = false et buftype = 'nofile'.

Rendre un tampon d’affichage non modifiable empêche les utilisateurs de modifier accidentellement le contenu généré.

nvim_open_win(buf, enter, config) place un tampon dans une fenêtre flottante. La configuration définit relative, row, col, width, height et border.

Les fenêtres flottantes sont à la base des interfaces modernes comme la documentation au survol, les sélecteurs et les notifications.

Ajustez une fenêtre flottante ouverte avec nvim_win_set_config, notamment pour la redimensionner lors de VimResized. Lisez la disposition actuelle avec nvim_win_get_config.

Définissez les options propres à la fenêtre avec vim.wo[win], par exemple pour masquer la ligne du curseur ou désactiver les colonnes de numéros dans les panneaux d’interface.

Déplacez le curseur avec nvim_win_set_cursor(win, {row, col}). Notez que la ligne commence à un, tandis que la colonne commence à zéro : c’est une source fréquente d’erreurs de décalage d’une unité.

Relisez sa position avec nvim_win_get_cursor afin de mémoriser et de restaurer la position de l’utilisateur autour d’une opération.

Les identifiants peuvent devenir obsolètes. Vérifiez leur validité avec nvim_buf_is_valid et nvim_win_is_valid avant d’utiliser des identifiants conservés.

Fermez les fenêtres avec nvim_win_close(win, force) et supprimez les tampons avec nvim_buf_delete(buf, { force = true }). Vérifiez toujours la validité au préalable pour éviter les erreurs.

Les repères étendus associent des métadonnées à un texte qui se déplace au fil des modifications. Créez un espace de noms avec nvim_create_namespace, puis associez-lui du texte virtuel ou des surbrillances.

nvim_buf_set_extmark prend en charge virt_text, les colonnes de signes et les surbrillances en ligne : c’est le moteur des indications intégrées et des modules Git d’identification de l’auteur.

nvim_list_bufs et nvim_list_wins renvoient tous les identifiants actuels. Filtrez-les avec nvim_buf_is_loaded ou en vérifiant les options.

Le parcours permet à un module complémentaire d’agir sur toute la session, par exemple en fermant chaque fenêtre flottante ou en actualisant chaque tampon d’un type de fichier donné.

Vérifiez ce que vous avez appris sur les tampons et les fenêtres.

Les tampons contiennent du texte, les fenêtres l’affichent et les identifiants sont des entiers que vous devez valider avant de les utiliser. Vous pouvez lire et écrire des lignes, créer des tampons temporaires et définir des options locales au tampon.

Les fenêtres flottantes via nvim_open_win, le contrôle du curseur, les repères étendus et les API de listage vous fournissent tout le nécessaire pour créer des interfaces de modules complémentaires riches et avec état.