Integrering af Vim med ctags

Ctags er et værktøj, der bruges til at navigere i kildekodeindekseringsmetoder, klasser, identifikatorer og variabler. Ctags gemmer indekset over programmeringskoden i en separat tagsfil. I tags-filen indeholder hver linje et enkelt tag. Du kan få mange detaljer fra dette indeks. Ctags understøtter 41 programmeringskodesprog og gør det lettere at søge efter metoder eller funktionsblokke i store projekter, især når du ikke kender kodelinjernes funktion. For eksempel ved du måske nogle gange ikke, hvordan den bestemte metode skal kaldes, når du programmerer. Med ctags-værktøjet kan du straks springe til metodedefinitionen.

Denne artikel viser dig, hvordan du installerer ctags på din Ubuntu 20.04 Linux-system og hvordan man integrerer Vim med ctags til kildekodenavigation.

Installation af ctags på Ubuntu 20.04

Ctags er ikke installeret som standard på Ubuntu 20.04. Brug følgende kommando til at installere ctags på Ubuntu 20.04:

$ sudo apt installere ctags

Vælg programmeringskildekodens projektmappe for at afgøre, om ctags fungerer korrekt. Denne artikel vil bruge et par eksempler til at teste, hvordan ctags fungerer med Python-projekter.

Naviger til den angivne mappe, hvor du vil implementere ctags. Brug følgende kommando til at flytte til Python-mappen og listefiler.

$ cd pythoncode
$ ls

Integrering af ctags med Vim

Alle oplysninger relateret til ctags er gemt i en tags-fil. Så du bliver nødt til at indstille mappestien i ~ /.vimrc-fil, før du bruger ctags.

Åbn ~ /.vimrc-fil i vim-editor med rodrettigheder ved hjælp af terminalen.

$ sudo vim ~ /.vimrc

Skriv følgende sæt kommandoer i .vimrc-fil og gem den.

: syntaks til
sæt tags + = $ HOME / home / kbuzdar / pythoncode /

I ovenstående billede er '/ home / kbuzdar / pythoncode /' den mappesti, hvor tagsfilen gemmes.

Arbejde med ctags

Naviger til den angivne mappe gennem terminalen, og brug følgende kommando til at oprette ctags af de programmeringskildekodefiler, der findes i denne mappe.

$ ctags -R *
$ ls

Efter at have udført ovenstående kommando, vil du bemærke, at der er oprettet en fil med navnet 'tags' i denne mappe.

Åbn tagsfilen på vim-editoren. Koderfilen indeholder alle kendetegnene for programmeringskodefiler, der findes i den aktuelle mappe.

$ vim tags

Find tags ved hjælp af søgemønster

Du kan søge tag ved hjælp af et søgemønster i Vim. For at gøre det skal du åbne python-kodefilen med navnet even_odd.py i Vim. Søg derefter efter 'if' tag ved at skrive ': / if' som følger:

$ vim leapyear.py
: / hvis

Følgende output vises, når du rammer Gå ind nøgle. Tagget 'hvis' fremhæves, hvis det findes i Python-kildekodefilen.

Søg efter tags ved hjælp af tagkommando

Du kan bruge tagkommandoen i Vim til at søge efter et tag i den fil, der findes i tagsfilen. Brug følgende kommando til at søge efter et tag i en fil:

: tag

F.eks. Findes der i følgende output tagget 'num' i tagsfilen.

: kodenummer

Hvis en fil indeholder det samme tag mange gange i en fil, giver ctag-kommandoen dig mulighed for at flytte til det næste tag af samme type i taglisten. Brug følgende kommando til at flytte markøren til det næste mærke af samme type:

: næste

Kommandoen ctag giver dig også mulighed for at flytte til det forrige tag af samme type i taglisten. Brug følgende kommando til at flytte markøren til det forrige tag af samme type:

: tprev

Du kan også flytte til det sidste og det første tag af den samme type tag, der er søgt på listen. For at flytte til det sidste tag af samme type som det søgte tag skal du indtaste følgende kommando:

: tlast

For at flytte til det første tag af samme type som det søgte tag skal du indtaste følgende kommando:

: første

For at vælge et bestemt tag fra en liste over tags efter åbning af kildekodefilen skal du bruge følgende kommando:

: vælg

Du kan vise de aktuelle tagoplysninger ved hjælp af følgende kommando:

: tags

Ctags er nyttige til kildekodenavigation i en fil. Ved hjælp af tagsfilen kan du søge i det relevante tag i kildekodefilen. Husk at hvis du ændrer kildekodefilen, skal du hver gang du foretager disse ændringer integrere og konfigurere ctags med ændringerne. Dette skyldes, at ctags-filen ikke automatisk opdateres med kildekodefilen.  For at løse dette problem kan du bruge nogle nyttige auto-plugins, der holder din kildekode og tags-fil ajour.