Suport technique et veille technologique

LinuxFr.org : les journaux  -  travailler sur de nombreux fichiers avec Vim et NeoVim, sur une seule vue

 -  Décembre 2023 - 

Sommaire

• la préparation
  • alias
  • fichiers
  • conventions
• les arguments
  • navigation standard
  • navigation avancée
  • liste manipulable
• les tampons
  • navigation renouvelée
  • tampons variés
    • définitions et précisions
    • des listes différentes
    • dans divers états
    • courant et alternatif
  • modifiable aussi
• les positions
  • positions remarquables
    • des marques locales
    • des marques globales
    • des marques exclusives
  • historiques associées
    • lignes de commandes
    • sauts et changements

Ce premier journal, d’une série de trois, fait suite à ma réponse à une interrogation de martoni dans le forum.

L’objectif est de répondre, à travers des exemples pratiques, à la question de savoir comment on travaille avec plusieurs fichiers ; dans un premier temps dans une seule fenêtre…

Comme prérequis, il est demandé de :

• avoir installé Vim ou Neovim ;
• savoir utiliser une implémentation de vi pour un usage basique ;
• savoir, optionnellement, utiliser un peu la ligne de commandes.
  (pas de panique, c’est surtout parce-que je n’ai pas testé en interface graphique.)

C’est parti ! 🏴‍☠️

la préparation

Avant d’entrer dans le vif du sujet, nous devons préparer le terrain.

alias

Afin d’éviter des commentaires de type « ça marche pas chez moi » ou « je n’obtiens pas la même chose » d’une part, et pour se focaliser sur le comportement par défaut d’autre part, on va lancer l’éditeur avec les options qui désactive toute personnalisation. Comme je privilégie une certain niveau de fainéantise et le fait de ne pas se répéter, on va se créer un alias au doux nom de dv pour « Default (Neo)Vim » tout simplement.

Non vérifié, mais je pense que ça marche aussi si on lance l’implémentation GUI avec la même option --clean (sinon, pour Vim, il faut aussi ajouter l’option -U NONE.)

fichiers

On aura besoin de fichiers exemples. Créons un répertoire pour les accueillir (et pouvoir virer facilement l’ensemble quand on a fini.)

On va se positionner dans ce répertoire (nommé ici zt comme « Zen Tests » par exemple, mais on peut choisir le nom de son choix) pour la suite.

Dans ce répertoire, créer un sous-répertoire d (comme « Directory » tout simplement) comme précédemment.
Ensuite, on va créer les fichiers suivants par les moyens de son choix :¹

Sixth green yielding herb all form gathering him without given living a
cattle saying dry one rule female divide image seed darkness said in a
unto morning can't under saying.

fichier zt/bleu.txt

Great you'll winged cattle seas she'd, forth male saying under saying
stars abundantly days. Can't fowl under gathering moved spirit. Own
shall tree itself there appear. Creepeth meat life fly.

fichier zt/cyan.txt

You're darkness creepeth. A upon heaven. Bring he, years of male.
Moving female said morning us beast fruit two evening divide light
tree give evening it rule morning herb be.

fichier zt/jaune.txt

Whose whales bring moved female beginning fifth. Behold firmament rule
itself. Life. Wherein. Was. It thing upon bearing it abundantly tree
that. Them brought likeness multiply fifth us set. Fly.

fichier zt/magenta.txt

Made seasons is evening which. Their herb creeping have divided spirit
second is unto to set fifth light of after fruit made meat of fruitful
is whales lesser every. Lights.

fichier zt/rouge.txt

He gathering all all image whose midst Beast they're moving. Face god sea.
Fruitful. So fruit which he fruitful they're Beast.  Can't the fish,
night set. Form hath life divided.

fichier zt/vert.txt

Said life also give from beast god two good every that fifth that
called own lesser fowl won't she'd. Beast unto creepeth. Third
morning called. Sea rule great he firmament.

fichier zt/d/nb.txt

conventions

Pour la suite, je parlerai souvent de « commande Ex ». Pas de panique, il s’agit des genres de commandes que l’on saisie en « ligne de commandes » après avoir tapé « : » et en terminant par « ||↵|| » ou « ||⌅|| » …implicite. Dans ce contexte, on aura juste à saisir les commandes sans préfixer par les deux-points, c’est tout.

Je présenterai aussi, tout au long, des tableaux de synthèse des commandes en trois colonnes. La seconde, s’appellera « v.v » pour « version Vim » et comportera la version d’apparition de la commande sous cette forme.

Il y aura également des tableaux d’exercices en quatre colonnes dont la première, « exo », est la référence pour chaque ligne. On pourra utiliser ces références (un chiffre par sous-section, un point, un lettre minuscule) peuvent servir en commentaire pour pointer la ligne en question. La dernière et quatrième colonne indique un point de contrôle à réaliser obligatoirement.

Enfin, et surtout vers la fin, j’évoque des touches modificatrices et à un moment des touches directionnelles. Dans ce cas, j’utilise les symboles ISO/IEC 9995-7 & ISO 7000.²

On va maintenant pouvoir plonger au cœur de la préoccupation de ce journal. :)

— Pub non sponsorisée : Ces textes, auxquels il ne faut pas chercher de signification, ont été créé en utilisant le site Dummy Text Generator avec comme paramètres : texte anglais, 30 mots, 1 paragraphe.

— Note d’humour à l’adresse des plus geeks : Il est bien sûr possible d’utiliser cat (sous Unix-like) ou set-content (sous les dernières versions de Windows) pour créer les fichiers, ou juste avec l’éditeur que l’on va utiliser (cela aurait pu faire partir de l’exercice remarque…)

les arguments

Pour commencer, lançons l’éditeur, comme convenu, avec les couleurs primaires (en synthèse multiplicative) et leur fusion.

$ dv cyan.txt jaune.txt magenta.txt d/nb.txt

Les quatre fichiers sont chargés par l’éditeur, le premier est affiché, mais où sont les autres ?

navigation standard

Contrairement aux apparences, il est prévu de pouvoir travailler avec plusieurs fichiers.
Étrangement, c’est une fonctionnalité native de toute implémentation vi conforme POSIX, mais que peu de gens connaissent. Les commandes Ex prévues par le standard, pour naviguer entre les fichiers passés en argument, ne manqueront pas de faire penser aux lecteurs médias… dont l’interface perpétue l’héritage des enregistreurs à ruban…

Voici la courte liste de ces commandes :

Excepté :file, ces commandes sont affectées par les options autowrite et writeany de base…⁴ Tout comme :write, elles peuvent être suffixées de !.
Maintenant, sans entrer dans ces détails, voyons les à l’œuvre :

Jusqu’ici, heureusement, rien de nouveau quand on vient d’une autre implémentation.

navigation avancée

Vim a rajouté d’autres commandes pour compléter le tableau.

Plutôt que de longs discours, voyons cela en pratique :

C’est un peu laborieux de se poser sur n’importe quel fichier dès que la liste est un peu longue… Sur une liste de dix fichiers par exemple, pouvoir passer de la deuxième à la neuvième nécessitait de faire « :n⏎ » sept fois ! Ici, on peut faire « :la⏎ :N⏎ » ; ce qui déjà un gain appréciable. Mais sur une liste de vingt fichiers, passer facilement de la troisième à la douzième reste un défi…

(Neo)Vim et d’autres implémentations ont également la possibilité d’ajouter un décompte…, et c’est bien pratique pour répondre à la problématique.

Le décompte « 𝓝 » est optionnel, et quand c’est omis c’est la valeur par défaut qui est utilisée. Hormis :argument dont la valeur par défaut est la position du fichier courant, c’est « 1 » pour les autres, ce qui nous ramène aux cas déjà vu.

C’est sympa et j’apprécie personnellement ces petites attentions. Mais ce n’est pas tout…

liste manipulable

Pour permettre de remplacer nos couleurs primaires par leurs complémentaires (synthèse multiplicative), :args a été étendu pour accepter une nouvelle liste à la place de la liste courante. Dans un premier temps, on charge nos nouveaux fichiers dans l’ordre alphabétique. Ensuite, on change d’avis et on préfère l’ordre RVB et non BRV : la punition est toujours :args avec la liste dans le bon ordre. Idem si on décide de revenir à nos couleurs primaires.

Si pendant longtemps les vimistes s’en sont contenté-e-s, ça reste pénible quand on plusieurs fichiers et que l’on souhaite en ajouter ou en retirer quelques uns car il faut ressaisir toute la liste. Avec la sixième version majeur, de nouvelles commandes vont simplifier la vie des usagers de l’éditeur sans pareil.⁶

Au chapitre des nouvelles fonctionnalités, il y a la redoutable :argdo qui est peu connu…
Pour illustrer son fonctionnement, supposer que nous cherchons toutes les lignes contenant l’appostrephe (droite/dactylographique ici) suivie d’une lettre. La démarche, fastidieuse, qui fonctionne avec n’importe quelle implémentation est :

:" 3.l commencer par vert.txt
:rewind
:" 3.m y faire la recherche
:global/'[a-z]/#

  1 He gathering all all image whose mids Beast they're moving. Face god sea.
  2 Fruitful. So fruit which he fruitful they're Beast. Can't the fish,
Press ENTER or type command to continue

:" 3.n passer au fichier bleu.txt
:next
:" 3.o et faire la recherche ici
:global/'[a-z]/#

  3 unto morning can't under saying.
Press ENTER or type command to continue

:" 3.p passer au fichier cyan.txt
:n
:" 3.q et faire la recherche ici
:g/'[a-z]/#

  1 Great you'll winged cattle seas she'd, forth male saying under saying
  2 stars abundantly days. Can't fowl under gathering moved spirit. Own
Press ENTER or type command to continue

:" 3.r passer au fichier magenta.txt
:n
:" 3.s y faire la recherche aussi
:g/'[a-z]/#

Pattern not found: '[a-z]

Je vous laisse imaginer si on a une dizaine comme ça… Et là, arrive notre Circé :

:" 3.t depuis cyan.txt
:argument 3
:" 3.u faire la recherche partout
:argdo g/'[a-z]/#

"vert.txt" 3 lines, 179 bytes
  1 He gathering all all image whose mids Beast they're moving. Face god sea.
  2 Fruitful. So fruit which he fruitful they're Beast. Can't the fish,
"bleu.txt" 3 lines, 176 bytes
  3 unto morning can't under saying.
"cyan.txt" 3 lines, 194 bytes
  1 Great you'll winged cattle seas she'd, forth male saying under saying
  2 stars abundantly days. Can't fowl under gathering moved spirit. Own
"magenta.txt" 3 lines, 196 bytes
Pattern not found: '[a-z]
Press ENTER or type command to continue

Avec les implémentations autres que (Neo)Vim et ce :argdo, il aurait fallu demander à l’interpréteur de commandes du système avec le bon utilitaire et en lui ressaisissant la liste des arguments…

Mais toutes les opérations ne sont pas toujours réalisables ainsi, sans devoir scripter.

Au fait, :argdo et :argdelete utilisent aussi bien une plage (i.e. deux entiers « début,fin » dans l’ordre) qu’une position (i.e. un seul entier). Par défaut, c’est respectivement toute la liste et le fichier courant.

:" 3.v rechercher seulement dans bleu et cyan
:3,2argdo g/'[a-z]/#

Backwards range given, OK to swap (y/n)?y
"bleu.txt" 3 lines, 176 bytes
  3 unto morning can't under saying.
"cyan.txt" 3 lines, 194 bytes
  1 Great you'll winged cattle seas she'd, forth male saying under saying
  2 stars abundantly days. Can't fowl under gathering moved spirit. Own
Press ENTER or type command to continue

Pour en tirer pleinement profit, il faut connaître et pratiquer les commandes Ex. J’en profite pour glisser une réclame : le dernier « Atelier Vi » vous permettra de maîtriser pleinement cet aspect de cette famille d’éditeurs.
Mais avant, voici la synthèse des commandes que nous venons d’explorer :

Quand (Neo)Vim se lance, la liste des fichiers en argument est récupérée et mise à disposition. Mais les usagers sont libres de redéfinir cette liste, et cette particularité est présente dans toute implémentation respectant le standard : il faut juste utiliser :next comme mentionné…

Si un ou plusieurs fichiers sont indiqués :

1. Définir la liste d’arguments suivant les noms de fichiers spécifiés.
2. Définir la position actuelle dans la liste d’arguments comme étant la première entrée de la liste d’arguments.
3. Définir le chemin d’accès actuel au premier nom de fichier spécifié.

Dans le cas contraire :

1. Il s’agit d’une erreur s’il n’y a plus de noms de fichiers dans la liste d’arguments après le nom de fichier actuellement référencé.
2. Fixer le nom de chemin actuel et la référence de la liste d’arguments actuelle au nom de fichier suivant le nom de fichier actuellement référencé dans la liste d’arguments.

Remplacer le contenu du tampon d’édition par le contenu du fichier nommé par le chemin d’accès actuel. Si, pour une raison quelconque, le contenu du fichier n’est pas accessible, le tampon d’édition sera vide.

Dit simplement, quand des chemins de fichiers sont indiqués, « :next𝓕 » a le même fonctionnement que « :args𝓕 »… Juste que le nom de commande peut prêter à confusion (en tout cas ça en piège beaucoup qui n’ont pas pris le temps de bien lire et comprendre cette partie.)
En général, ce que l’on cherche à faire est répondu par :argedit𝓕 …qui fait un :argadd𝓕 puis va basculer dessus.

Sur ce, on peut maintenant tout fermer.

:" 3.z
:quit

les tampons

Pour poursuivre, lançons l’éditeur, comme convenu, avec les fichiers dont le nom (sans extension) se termine par une voyelle.

$ # sur les Unix-like et autres on peut juste faire
$ # dv *[aoeuiy].txt # mais y a que "eau" ici
$ dv bleu.txt jaune.txt magenta.txt rouge.txt

Les quatre fichiers sont chargés par l’éditeur, le premier est affiché et les autres sont en quelque sorte derrière…

navigation renouvelée

Dans la session précédente, on avait vu que la liste de fichiers passés en argument est copié dans une liste d’arguments que nous pouvons manipuler à loisir. À partir de la version 2.4, Vim copie également la liste de fichiers passés en argument dans une nouvelle liste appelée liste des tampons… Cette nouvelle/seconde liste a ses commandes qui commencent par « b » comme « buffer », c’est à dire tampon.

Excepté pour le listing, les commandes de navigation sont affectées par les options autowrite et writeany entre autres… et peuvent être suffixées de ! Il ne faut pas se fier à la ressemble avec l’autre liste ; déjà celle-ci boucle… et ne marque pas les fichiers comme édités de la même façon… (à partir de 4.g, après avoir fait le tour, on peut quitter ; mais jusque là le message indique toujours qu’il y a trois autres fichiers en attente…)

Comme les tampons sont numérotés par ordre de création, et que cette numérotation ne changera pendant toute la session de travail, on peut s’aider de cette numérotation dans la navigation.

Certaines commandes nous sont déjà familières (cf. section précédente) ; les deux dernières seront élucidées plus loin. Ici aussi, l’indication du rang est optionnel et vaut celui du tampon actuel pour :buffer et l’unité pour les autres.

Voilà pour l’introduction rapide.

tampons variés

Il va falloir maintenant décortiquer un peu plus ce concept (de tampon) et l’utilisation de cette liste (de tampons).

définitions et précisions

Le tampon (ou buffer en anglais) représente le contenu en mémoire (comprendre en cours de manipulation et donc pas l’état réel du fichier tant que la mémoire n’est pas écrite dans le fichier.) C’est le mode de fonctionnement de tout éditeur de texte (et pratiquement tous les programmes) : on n’écrit et lit pas le fichier sur le disque à chaque action, ce serait peu performant et augmenterait les risques de corruption du fichier.

Il arrive que le fichier ne puisse pas tenir en mémoire (peu de gens connaissent cette situation aujourd’hui n’est-ce pas ?) La stratégie hérité du Vi historique est d’utiliser un fichier d’échange (ou swap file en anglais) pour garder le travail en cours (le fichier effectif n’est écrit que si l’on demande d’une façon —explicite— ou d’une autre —implicite par des options de configuration— de le faire) et de ne charger que la portion en cours d’édition. Cela peut se ressentir.

Il n’y a que les éditeurs codés naïvement qui chargent tous les fichiers en mémoire. (Neo)Vim et d’autres vont, pour ne pas saturer la mémoire, travailler en pratique avec des listes chainée (ou linked lists en anglais). Il y en a plusieurs au cours de la session, et chacune a son jeu de commandes et son compteur…

des listes différentes

Chaque liste a ses références internes et son compteur, ce qui peut être source de confusion quand on ne comprend pas ce qu’on fait ou quand on manque de vigilance.

Bien que les deux listes semblent avoir les mêmes éléments ici, on se trouve sur le troisième élément de la liste des tampons, mais sur le premier élément de la liste d’arguments : les commandes qui manipulent chacune de ces listes ne sont pas interchangeables !
Pour nous prévenir, :file dans (Neo)Vim met l’argument courant entre parenthèses pour dire que ce n’est pas celui qui est affiché/actif.

Les deux listes n’ont plus les mêmes éléments… Et là, on a un indice de l’utilité d’avoir deux listes :

• Celui des tampons est, comme son nom l’indique, réservé aux documents “ouverts” dans l’éditeur ; tous.
• Celui des arguments est par contre une “sélection”, parmi ces documents, sur laquelle on travaille (ou on va agir avec :argdo par exemple.)

On peut ainsi avoir une sélection de fichiers que l’on édite activement, tout ayant une série de fichiers ouverts pour référence (utile notamment en développement logiciel où c’est un peu ce que font des environnement de développement en référençant le répertoire du projet.)

dans divers états

Revenons à nos tampons. Ils sont listés par les commandes synonymes :buffers, :ls et :files (avec “s” final) …qui affichent quatre colonnes dans l’ordre :

1. Le numéro du tampon, aligné à droite sur la troisième colonne.
2. Les différents états sur cinq colonnes (de la quatrième à la huitième incluse.)
3. Le nom du fichier, aligné à gauche, entre guillemets doubles droits (ce qui permet de distinguer ses espaces du reste.)
4. La ligne du curseur dans le fichier à partir de la quarantième colonne chez moi. line 0 (ou peut-être ligne 0 chez vous) indique alors un tampon pas encore visité.

Pour les différents états justement, nous en avons déjà croisé deux :

• actif quand le tampon (ou, pour simplifier, le fichier) est affiché à l’écran.
• caché (ou juste masqué) quand, à l’inverse, le tampon n’est pas visible.

Cet état d’affichage est indiqué par un caractère en sixième colonne (en tout, soit la troisième colonne indiquant les états)

• « a » pour indiquer que le fichier est chargé en mémoire et son tampon affiché (soit active en anglais.) Cette indication est apparue avec la version 6.0 de Vim.
• « h » pour indiquer que le fichier est chargé en mémoire mais que son tampon est caché (soit hidden en anglais.)
• «  » (espace) quand le fichier n’est pas chargé en mémoire, mais bien référencé dans la liste.

La colonne suivante (la quatrième ou septième), ajoutée à partir de la version 6.0 de Vim, donne le statut système du fichier. Actuellement, on a :

• pour un fichier normal
  • « - » indique que (Neo)Vim n’a pas le droit de le modifier —typiquement quand on lance l’éditeur en mode lecture seule par exemple
  • « = » indique que le (Neo)Vim ne peut pas le modifier —typiquement quand le fichier est en lecture seule au niveau système
  • «  » (espace) indique le cas normal, donc rien à signaler.
• pour un terminal
  • « ? » sans tâche (ou job en anglais) associée
  • « R » avec un tâche en cours (soit running en anglais)
  • « F » avec une tâche terminée (soit finished en anglais)

La dernière colonne, ajoutée à partir de la version 6.0 de Vim, va plus nous intéresser

• « + » indique que le tampon a été changé (aussi bien une modification d’édition qu’un changement d’encodage par exemple) mais pas encore enregistré dans le fichier…
• « x » indique que le tampon est en erreur de lecture (soit une corruption mémoire, soit une corruption de fichier)

C’est ici que :bmodified prend son sens. ;) Cette commande cycle dans une sous-liste (temporairement et automatiquement g

par Gil Cot ✔