Prendre le binaire RPM (ctags i386.rpm) pour Redhat ou Mandrake. Prendre les sources (ctags tar.gz) pour les autres distributions.

Transcription

1 CTAGS Ctags est un outil d indexation (ou de råfårence croisåe) pour les langages de programmation (C, C++, Lisp, Python, Perl, ). C est un outils trés important pour les programmeurs. OÄ le tålåcharger? Comment l installer? A quoi cela sert-il? Prendre le binaire RPM (ctags i386.rpm) pour Redhat ou Mandrake Prendre les sources (ctags tar.gz) pour les autres distributions. Il existe Ägalement une version pour Windows (ec554w32.zip) Pour Redhat ou mandrake : $ rpm iv ctags i386.rpm Pour les autres distributions : $ tar zxvf ctags tar.gz $ cd ctags-5.5.4/ $./configure $ make && make install // il faut Åtre root Pour Windows : DÄ-zipper ec554w32.zip et double-cliquer sur l exäcutable. Ctags gänére un fichier d index des objets (variables, fonctions, maccros) des langages connus. Cet index, qui räpertorie les informations sur divers objets trouväs dans une särie de fichiers Äcrits dans les langages connus par ctags : Comment l utiliser? Permettra aux Äditeurs de textes (GNU/Emacs, Vi, Nedit, ) de localiser plus aisäment les ÄlÄments indexäs. Peut Åtre affichä sur la sortie standard, sous un format comprähensible pour l Homme. $ ctags [options] [fichier(s)] cela va cräer un fichier nommä Ö tags Ü.

2 Pour plus d informations : Les options Le manuel : $ man ctags Le built-in du shell : $ help ctags ou $ ctags --help Pour les options suivantes, ctags ne cräe pas de fichier Ö tags Ü, il utilise la sortie standard comme fichier. --list-languages Affiche la liste des langages de programmation supportäs par ctags. $ ctags --list-languages Asm Asp Awk C C++ Cobol --list-maps=x Affiche la liste des extensions possibles pour un langage x. x peut prendre les valeurs suivantes : C, C++, Lisp, Python, ou all pour afficher les extensions de tous les langages supportäs. -x Affiche une räfärence croisäe sur la sortie standard dans un format agräable pour un Åtre humain (formatä comme l option l de la commande ls). L affichage se fait avec une ligne de 5 colonnes par objet indexä. Colonne 1 : nom de l objet indexä. Colonne 2 : type de l objet (variable, fonctions, maccros, ). Colonne 3 : ligne ou cet objet est däfinit. Colonne 4 : fichier ou est däfinit l objet. Colonne 5 : däclarations ou prototypes de l objet. $ ctags x *.c *.h Cf. Capture 5 pour le räsultat de cette commande - x --c-kinds = t Affiche sur la sortie standard les objets indexäs de type t uniquement. t peut prendre les valeurs suivantes : v pour afficher seulement les variables indexäs. f pour les fonctions. d pour les maccro. m pour les structures / classes. t pour les typedefs. Pour connañtre les valeurs possibles de t (et leurs significations) pour les langages connus par ctags, utiliser la commande ctags list-kinds $ ctags x c-kinds=f *.c Cf. Capture 2 pour le räsultat de cette commande

3 Pour les options suivantes, ctags va cräer un fichier nommä Ö tags Ü par däfaut. C est ce fichier qui sera utilisä par les Äditeurs de texte. -a Ajoute les index dans un fichier t Ö tags Ü existant (sans Äcrasement). -e Le fichier d index se nommera Ö TAGS Ü et non Ö tags Ü. Pour qu Emacs puisse l utiliser. àquivalent â l outil etags (ctags späcialement conäu pour Emacs). $ ctags e *.c *.h Cette commande va cråe un fichier d index de tous les fichiers se terminant par.c ou par.h, dans le råpertoire ou elle a ÅtÅ lancåe ; Cela implique que l utilisateur qui lance cette commande doit avoir les droits d Åcriture dans le råpertoire d oö il se trouve. -f filename Le fichier d index s appellera filename au lieu de Ö tags Ü. àquivalent â l option o filename. $ ctags f mestags *.c *.h va cråer un fichier d index nommå Ü mestags á. Cf. Capture 3. -R Pour lancå ctags råcursivement au niveau des råpertoires. Le fichier de råfårence sera cråe dans le råpertoire oö la commande a ÅtÅ tapå. --totals=yes affiche le nombre de fichier indexå, le nombre d objet indexå, les temps mis pour construire l index et pour le trier par ordre alphabåtique. Cf. Capture 3 Pour les autres options consulter le man ou le built-in du shell. Comment l utiliser avec l Åditeur gvim et Vi? $ ctags *.c *.h $ gvim -t plus Ceci Äditera le fichier programme C qui contient la fonction plus() et placera directement le curseur sur la premiére ligne de la fonction plus(). $ gvim -t main De måme, cette commande vous placera sur la ligne contenant la däfinition de la fonction main(). Dans l'äditeur Vi, vous pouvez sauter â une fonction en tapant : (double point) tag nom_de_la_fonction comme ci dessous :

4 : tag nom_fonction : tag div () Ceci placera le curseur sur la premiére ligne de fonction (). Si vous voulez sauter dans la fonction â partir de la ligne du fichier contenant le nom de la fonction, placez le curseur juste avant le nom de la fonction et tapez CTRL+] (tapez la touche de contrãle et le crochet gauche simultanäment). int main () { printf( %d\n, div(un,deux)) ^ Placez le curseur ici (juste avant div()) et tapez CTRL+] Ceci vous emménera â la däfinition de la fonction "div()" (måme s il est dans un autre fichier). Pour revenir â cette ligne tapez CTRL+t (la touche CTRL et la lettre t simultanåment). Continuez â appuyer sur CTRL+t pour inverser et revenir â la premiére ligne oö vous avez commencå la navigation. C'est-â-dire que vous pouvez conserver pressåes CTRL+] et ensuite taper CTRL+t pour revenir. Vous pouvez refaire ceci aussi souvent que vous le dåsirez pour avoir une navigation compléte au travers de toutes les fonctions C ou C++. Comment l utiliser avec GNU/Emacs? Par dåfaut, Emacs va essayer de charger un fichier d index nommå Ü TAGS á dans le råpertoire courant ; c est pour cette raison que l on utilise l option e qui cråe ce fichier. Une fois, le fichier d indexation cråå, on peut exåcuter les commandes suivantes : M-x visit-tags-table <RET> filname <RET> (par däfaut, filename = TAGS). Cette commande permet de sälectionner et de charger le fichier d index â utiliser par Emacs. M-. [TAG] <RET> Trouve le premier objet indexä. Par däfaut, c est l objet (fonction ou variables) sous le curseur. M-* C est l Åquivalent du CTRL+t dans Vi. (cf. le paragraphe pråcådent). On peut Ågalement utiliser l interface graphique de Emacs : Edit / Go to / Set Tags File Name pour charger le fichier d index. Edit / Go to / Find Tag Äqivalent â M-. [TAG] <RET> Autres Le fichier d index ainsi cråe peut aussi servir â d autres Åditeurs ou autres programme, notamment dans des script shell. Cf. Capture 4 pour voir le contenu d un fichier d index cråer par ctags.

5 Les sources et captures d Åcran pour les exemples: Les fichiers sont placäs dans un räpertoire nommä Capture 1 : les fichiers du räpertoire Exemple/ Capture 2 : l option x c-kinds=f

6 Capture 3 : l option f et --totals=yes Capture 4 : le contenu du fichier d index (mestags).

7 Capture 5 : l option x Remarques Les options peuvent Åtre mis par däfaut dans le fichier /etc/ctags.conf ou ~/ctags.conf1 En gänäral dans les derniéres versions, il faut cräer soit måme ce fichier. Voici â quoi cela ressemble : /etc/ctags.conf --verbose=yes --totals=yes --recurse --langmap=asm: --langdef=splus --langmap=splus:.s.s.r.r.q --regex-splus=/^[ \t]+"?([.a-za-z][.a-za-z0-9]*)"?[ \t]*(<- _)[ \t]*function/\1/ Ressources --regex-splus=/^"?([.a-za-z][.a-za-z0-9]*)"?[ \t]*(<- _)/\1/ Internet (ctags.sourceforge.net) Le manpage et le help du shel.

8 CTAGS Ctags est un outil d indexation (ou de råfårence croisåe) pour les langages de programmation (C, C++, Lisp, Python, Perl, ). C est un outils trés important pour les programmeurs. OÄ le tålåcharger? Comment l installer? A quoi cela sert-il? Prendre le binaire RPM (ctags i386.rpm) pour Redhat ou Mandrake Prendre les sources (ctags tar.gz) pour les autres distributions. Il existe Ägalement une version pour Windows (ec554w32.zip) Pour Redhat ou mandrake : $ rpm iv ctags i386.rpm Pour les autres distributions : $ tar zxvf ctags tar.gz $ cd ctags-5.5.4/ $./configure $ make && make install // il faut Åtre root Pour Windows : DÄ-zipper ec554w32.zip et double-cliquer sur l exäcutable. Ctags gänére un fichier d index des objets (variables, fonctions, maccros) des langages connus. Cet index, qui räpertorie les informations sur divers objets trouväs dans une särie de fichiers Äcrits dans les langages connus par ctags : Comment l utiliser? Permettra aux Äditeurs de textes (GNU/Emacs, Vi, Nedit, ) de localiser plus aisäment les ÄlÄments indexäs. Peut Åtre affichä sur la sortie standard, sous un format comprähensible pour l Homme. $ ctags [options] [fichier(s)] cela va cräer un fichier nommä Ö tags Ü.

9 Pour plus d informations : Les options Le manuel : $ man ctags Le built-in du shell : $ help ctags ou $ ctags --help Pour les options suivantes, ctags ne cräe pas de fichier Ö tags Ü, il utilise la sortie standard comme fichier. --list-languages Affiche la liste des langages de programmation supportäs par ctags. $ ctags --list-languages Asm Asp Awk C C++ Cobol --list-maps=x Affiche la liste des extensions possibles pour un langage x. x peut prendre les valeurs suivantes : C, C++, Lisp, Python, ou all pour afficher les extensions de tous les langages supportäs. -x Affiche une räfärence croisäe sur la sortie standard dans un format agräable pour un Åtre humain (formatä comme l option l de la commande ls). L affichage se fait avec une ligne de 5 colonnes par objet indexä. Colonne 1 : nom de l objet indexä. Colonne 2 : type de l objet (variable, fonctions, maccros, ). Colonne 3 : ligne ou cet objet est däfinit. Colonne 4 : fichier ou est däfinit l objet. Colonne 5 : däclarations ou prototypes de l objet. $ ctags x *.c *.h Cf. Capture 5 pour le räsultat de cette commande - x --c-kinds = t Affiche sur la sortie standard les objets indexäs de type t uniquement. t peut prendre les valeurs suivantes : v pour afficher seulement les variables indexäs. f pour les fonctions. d pour les maccro. m pour les structures / classes. t pour les typedefs. Pour connañtre les valeurs possibles de t (et leurs significations) pour les langages connus par ctags, utiliser la commande ctags list-kinds $ ctags x c-kinds=f *.c Cf. Capture 2 pour le räsultat de cette commande

10 Pour les options suivantes, ctags va cräer un fichier nommä Ö tags Ü par däfaut. C est ce fichier qui sera utilisä par les Äditeurs de texte. -a Ajoute les index dans un fichier t Ö tags Ü existant (sans Äcrasement). -e Le fichier d index se nommera Ö TAGS Ü et non Ö tags Ü. Pour qu Emacs puisse l utiliser. àquivalent â l outil etags (ctags späcialement conäu pour Emacs). $ ctags e *.c *.h Cette commande va cråe un fichier d index de tous les fichiers se terminant par.c ou par.h, dans le råpertoire ou elle a ÅtÅ lancåe ; Cela implique que l utilisateur qui lance cette commande doit avoir les droits d Åcriture dans le råpertoire d oö il se trouve. -f filename Le fichier d index s appellera filename au lieu de Ö tags Ü. àquivalent â l option o filename. $ ctags f mestags *.c *.h va cråer un fichier d index nommå Ü mestags á. Cf. Capture 3. -R Pour lancå ctags råcursivement au niveau des råpertoires. Le fichier de råfårence sera cråe dans le råpertoire oö la commande a ÅtÅ tapå. --totals=yes affiche le nombre de fichier indexå, le nombre d objet indexå, les temps mis pour construire l index et pour le trier par ordre alphabåtique. Cf. Capture 3 Pour les autres options consulter le man ou le built-in du shell. Comment l utiliser avec l Åditeur gvim et Vi? $ ctags *.c *.h $ gvim -t plus Ceci Äditera le fichier programme C qui contient la fonction plus() et placera directement le curseur sur la premiére ligne de la fonction plus(). $ gvim -t main De måme, cette commande vous placera sur la ligne contenant la däfinition de la fonction main(). Dans l'äditeur Vi, vous pouvez sauter â une fonction en tapant : (double point) tag nom_de_la_fonction comme ci dessous :

11 : tag nom_fonction : tag div () Ceci placera le curseur sur la premiére ligne de fonction (). Si vous voulez sauter dans la fonction â partir de la ligne du fichier contenant le nom de la fonction, placez le curseur juste avant le nom de la fonction et tapez CTRL+] (tapez la touche de contrãle et le crochet gauche simultanäment). int main () { printf( %d\n, div(un,deux)) ^ Placez le curseur ici (juste avant div()) et tapez CTRL+] Ceci vous emménera â la däfinition de la fonction "div()" (måme s il est dans un autre fichier). Pour revenir â cette ligne tapez CTRL+t (la touche CTRL et la lettre t simultanåment). Continuez â appuyer sur CTRL+t pour inverser et revenir â la premiére ligne oö vous avez commencå la navigation. C'est-â-dire que vous pouvez conserver pressåes CTRL+] et ensuite taper CTRL+t pour revenir. Vous pouvez refaire ceci aussi souvent que vous le dåsirez pour avoir une navigation compléte au travers de toutes les fonctions C ou C++. Comment l utiliser avec GNU/Emacs? Par dåfaut, Emacs va essayer de charger un fichier d index nommå Ü TAGS á dans le råpertoire courant ; c est pour cette raison que l on utilise l option e qui cråe ce fichier. Une fois, le fichier d indexation cråå, on peut exåcuter les commandes suivantes : M-x visit-tags-table <RET> filname <RET> (par däfaut, filename = TAGS). Cette commande permet de sälectionner et de charger le fichier d index â utiliser par Emacs. M-. [TAG] <RET> Trouve le premier objet indexä. Par däfaut, c est l objet (fonction ou variables) sous le curseur. M-* C est l Åquivalent du CTRL+t dans Vi. (cf. le paragraphe pråcådent). On peut Ågalement utiliser l interface graphique de Emacs : Edit / Go to / Set Tags File Name pour charger le fichier d index. Edit / Go to / Find Tag Äqivalent â M-. [TAG] <RET> Autres Le fichier d index ainsi cråe peut aussi servir â d autres Åditeurs ou autres programme, notamment dans des script shell. Cf. Capture 4 pour voir le contenu d un fichier d index cråer par ctags.

12 Les sources et captures d Åcran pour les exemples: Les fichiers sont placäs dans un räpertoire nommä Capture 1 : les fichiers du räpertoire Exemple/ Capture 2 : l option x c-kinds=f

13 Capture 3 : l option f et --totals=yes Capture 4 : le contenu du fichier d index (mestags).

14 Capture 5 : l option x Remarques Les options peuvent Åtre mis par däfaut dans le fichier /etc/ctags.conf ou ~/ctags.conf1 En gänäral dans les derniéres versions, il faut cräer soit måme ce fichier. Voici â quoi cela ressemble : /etc/ctags.conf --verbose=yes --totals=yes --recurse --langmap=asm: --langdef=splus --langmap=splus:.s.s.r.r.q --regex-splus=/^[ \t]+"?([.a-za-z][.a-za-z0-9]*)"?[ \t]*(<- _)[ \t]*function/\1/ Ressources --regex-splus=/^"?([.a-za-z][.a-za-z0-9]*)"?[ \t]*(<- _)/\1/ Internet (ctags.sourceforge.net) Le manpage et le help du shell.