Naviguer avec snavigator

ArticleCategory: [Choose a category, translators: do not translate this, see list below for available categories]

SoftwareDevelopment

AuthorImage:[Here we need a little image from you]

TranslationInfo:[Author + translation history. mailto: or http://homepage]

original in en Gerrit Renker

en to fr Laurent Richard

AboutTheAuthor:[A small biography about the author]

Gerrit avait horreur des ordinateurs avant qu'il ne connaisse le C et Linux.

Abstract:[Here you write a little summary]

Cet article va vous prï¿½senter snavigator, un puissant outil d'analyse de code, de rï¿½fï¿½rencement croisï¿½ et de re-engineering qui se trouve ï¿½tre vraiment indispensable pour gï¿½rer la complexitï¿½ de la maintenance de logiciels d'une certaine taille ainsi que la gestion des paquets d'une maniï¿½re efficace.

ArticleIllustration:[One image that will end up at the top of the article]

ArticleBody:[The main part of the article]

Motivation

Un vieux proverbe dit qu'il ne faut pas juger un livre ï¿½ sa couverture. Un parallï¿½le peut ï¿½tre fait avec le code ouvert. Nï¿½anmoins, on ne peut pas comparer du code ouvert ï¿½ de la documentation libre. La lecture devient de plus en plus complexe ï¿½ mesure que la taille des fichiers sources s'agrandissent. J'ai rï¿½cemment dï¿½ programmer ï¿½ l'aide d'un programme qui avait une demi page html en guise de documentation. En comparaison au plus de 348.000 lignes de code ouvert ï¿½crit en Java et divisï¿½ en pas moins de 2060 fichiers (voir figure). Quand on arrive ï¿½ de telles chiffres, l'orientation ï¿½lectronique, le reverse engineering et les outils d'analyse deviennent indispensable comme le navigateur de code source Red Hat prï¿½sentï¿½ dans cet article.
Cet outil automatise beaucoup de tï¿½ches que l'on devrait rï¿½aliser en utilisant des (c)tags, grep, search ou replace. Mais il rï¿½alisera cela de maniï¿½re plus prï¿½cise et plus conviviale dans une interface graphique facile d'utilisation. Jetez un coup d'oeil aux captures d'ï¿½cran pour vous en convaincre.

Installation sous Debian

Sous Debian, vous pouvez obtenir le tout via un simple

apt-get install sourcenav sourcenav-doc

Cela rï¿½cupï¿½rera en mï¿½me temps la documentation. Le navigateur de sources rï¿½sidera dans /usr/lib/sourcenav/. Vous pouvez appeler le programme principal via /usr/lib/sourcenav/bin/snavigator (voir l'astuce ï¿½ propos des liens symboliques ci-dessous). La documentation peut ï¿½tre trouvï¿½e dans /usr/share/doc/sourcenav/html/.

Installation ï¿½ partir des sources

L'URL de la page d'accueil du navigateur de source est http://sourcenav.sourceforge.net/, les tï¿½lï¿½chargements se font en fait depuis ici (sourceforge.net/project/showfiles.php?group_id=51180). Obtenez le dernier tarball sourcenav-xx.xx.tar.gz. Lors du tï¿½lï¿½chargement, essayez de faire autre chose, en attendant, vu que les sources font environs 55 Mo. Cela a quand mï¿½me un cotï¿½ positif car aprï¿½s cela, le paquet n'a besoin de rien d'autre pour ï¿½tre utilisï¿½. Mï¿½me s'il fait un grand usage d'autres bibliothï¿½ques comme Tcl/Tk, Tix et Berkeley DB, les versions correctes de ces paquets sont ï¿½galement incluses. Afin d'ï¿½viter des conflits avec d'autres versions de Tcl/Tk, etc. sur votre systï¿½me, cela me semble une bonne idï¿½e de faire l'installation dans un rï¿½pertoire sï¿½parï¿½, par ex. /opt/sourcenav. Les instructions suggï¿½rent en plus d'utiliser un rï¿½pertoire de construction sï¿½parï¿½; cela se dï¿½roule comme suit. Aprï¿½s avoir dï¿½compressï¿½, exï¿½cutez les commandes suivantes dans le rï¿½pertoire contenant les sources dï¿½compressï¿½es :

mkdir snbuild; cd snbuild 
../sourcenav-*/configure --prefix=/opt/sourcenav 
make                               ## cela prend un peu de temps ...
make install                       ## vous devez devenir surper-utilisateur d'abord

L'option --prefix est lï¿½ pour spï¿½cifier le rï¿½pertoire d'installation. Lorsque le ï¿½ configure ï¿½ tourne, on a dï¿½jï¿½ une idï¿½e sur l'ï¿½tendue des langages que snavigator peut gï¿½rer. Il est ï¿½galement possible d'ajouter des parsers supplï¿½mentaires pour les langages de votre choix ou d'en crï¿½er. Une fois que l'installation est terminï¿½ via make install, snavigator est prï¿½t ï¿½ focntionner et il peut ï¿½tre lancï¿½ par /opt/sourcenav/bin/snavigator. Au lieu d'ï¿½tendre votre PATH ï¿½ ce nouveau rï¿½pertoire, vous pouvez comme je vous le suggï¿½re plutï¿½t de crï¿½er un lien symbolique, par ex. vers /usr/local/bin.

ln -s /opt/sourcenav/bin/snavigator    /usr/local/bin

L'exï¿½cutable principal est un script shell qui a besoin de connaï¿½tre son rï¿½pertoire. Donc, il est un peu perdu si on l'appelle via un lien symbolique. Cela peut ï¿½tre rï¿½solu en changeant les lignes suivantes dans /opt/sourcenav/bin/snavigator; au lieu de

snbindir=`dirname $0

utilisez

prog=`readlink -f $0`
snbindir=`dirname $prog`

L'option -f de readlink(1) crï¿½e une reprï¿½sentation du nom de chemin canonique. Cela signifie que cela va fonctionner mï¿½me si on accï¿½de au fichier via une longue suite de liens symboliques consï¿½cutifs.

Utiliser snavigator

La premiï¿½re fois que snavigator est lancï¿½, il va demander ï¿½ connaï¿½tre les rï¿½pertoires contenant les fichiers sources comme le montre la capture d'ï¿½cran suivante.

Les langages qui sont inclus mais qui ne sont pas limitatifs sont Java, C, C++, Tcl, Fortran, COBOL et l'assembleur. Une fois les dï¿½tails sur la localisation du code source donnï¿½, il va construire, indï¿½pendamment, une base de donnï¿½e du projet en incluant l'information de rï¿½fï¿½rencement, les hiï¿½rarchies de classes, les inter-dï¿½pendances entre les fichier et bien plus encore. La construction prend un certain temps dï¿½pendant bien sï¿½r de la taille de votre projet. Une fois rï¿½alisï¿½, la base de donnï¿½e peut ï¿½tre consultï¿½e et des informations supplï¿½mentaires peuvent ï¿½tre demandï¿½es ï¿½ propos du code. Je ne fais que mettre en avant quelques possibilitï¿½s du programme pour vous donner une idï¿½e globale. Un guide de l'utilisateur illustrï¿½ de mï¿½me qu'un manuel de rï¿½fï¿½rence sont inclus dans le rï¿½pertoire html de l'installation.

Gestion du projet

Une partie du programme est un ï¿½diteur avec colorisation de la syntaxe pouvant ï¿½tre aussi utilisï¿½ pour des fichiers ï¿½ imprimer. La capture d'ï¿½cran suivante montre la fenï¿½tre principale de l'ï¿½diteur. Elle ressemble vraiment ï¿½ un environnement de dï¿½veloppement et fournit des outils comme une usine ï¿½ dï¿½boguer, des commandes de construction de projet, un contrï¿½le de version et ainsi de suite.

Voici la fenêtre principale de l'éditeur. Il y a des tabulations qui redirigent vers les sous-fonctions comme le module grep.

En particulier, les grandes flï¿½ches vertes sur le menu fonctionnent de la mï¿½me maniï¿½re qu'un navigateur web. L'ï¿½diteur de projet permet de contrï¿½ler l'information de la base de donnï¿½es. Par ex : si un fichier vient d'ï¿½tre mis-ï¿½-jour, l'ajout ou la suppression de fichiers de la liste ainsi que d'autres tï¿½ches de gestion. Tous les fichier sont traitï¿½s comme un grand projet. Dï¿½s lors, si des modifications sont effectuï¿½es, vous pouvez mettre ï¿½ jour l'information de la base de donnï¿½es via Refresh Project ou Reparse Project.
Lorsque la fenï¿½tre de l'ï¿½diteur met en ï¿½vidence quelque chose comme le nom d'une fonction comme celle qui est reprï¿½sentï¿½e ici en jaune, vous pouvez faire un clic-droit avec votre souris afin de pouvoir choisir de faire une dï¿½claration de ce qui a ï¿½tï¿½ mis en ï¿½vidence (comme un fichier d'en-tï¿½te), d'implï¿½menter le symbole mis en ï¿½vidence (ex : un fichier .cpp) ainsi que quelques autres options utiles.

Navigateur de symboles

Voici la premiï¿½re fenï¿½tre qui s'ouvre aprï¿½s avoir constituï¿½ la base de donnï¿½es du projet. Gï¿½nï¿½ralement, elle contient les noms de fichiers mais peut ï¿½galement afficher les mï¿½thodes de classe, les symboles de fonctions et ainsi de suite. Lorsque on clique sur un nom de fichier, l'ï¿½diteur sera ouvert avec ce fichier.

La fenï¿½tre grep

Cela ouvre, comme le dit si bien le titre, une interface graphique conviviale pour ï¿½ï¿½grepperï¿½ï¿½ dans l'ensemble des fichiers de code source concernï¿½s. Les entrï¿½es correspondantes seront mises en ï¿½vidences et cliquables. Le code source peut dï¿½s lors faire l'objet d'une navigation comme si vous ï¿½tiez sur une page web. Comme le montre la capture d'ï¿½cran, le fichier ainsi que sa localisation respective peuvent ï¿½tre sï¿½lectionnï¿½s et par simple clic, vous entrez dans l'ï¿½diteur qui sera positionnï¿½ ï¿½ l'endroit exact dans le code. (Cette recherche sur la base d'un terme a donnï¿½ des rï¿½sultats positifs dans beaucoup de fichiers Java :)

Fenï¿½tre Xref

Ici, nous avons une liste de rï¿½fï¿½rences croisï¿½es de tous les symboles. En particulier, on peut constater quelles mï¿½thodes lisent (r), ï¿½crivent (w), ... et sur quelles donnï¿½es et voir les relations entre les symboles reprï¿½sentï¿½es de maniï¿½re hiï¿½rarchique. Les entrï¿½es sont cliquables. xref

Fenï¿½tre Class

Cette interface regroupe toutes les informations utiles que l'on dï¿½sire connaï¿½tre sur les classes dans un langage orientï¿½ objet. En particulier, les super- et les sous-classes sont affichï¿½es ainsi que les noms des attributs et des mï¿½thodes accompagnï¿½es de leurs paramï¿½tres. Pour changer, la fenï¿½tre en dessous montre une classe ClientSocket en C++ qui hï¿½rite de Socket et qui a quelques mï¿½thodes. Encore une fois, en cliquant sur une des entrï¿½es, vous pouvez ouvrir une fenï¿½tre d'ï¿½dition positionnï¿½e ï¿½ l'endroit adï¿½quat.

La fenêtre class concentre l'information à propos d'une classe particulière comme par exemple les superclasses, les méthodes ou les paramètres.

Autres alternatives

cscope est un navigateur interactif, basï¿½ sur la console de code source C (il peut faire ï¿½galement du C++). Il a certaines fonctionnalitï¿½s de snavigator. Une capture d'ï¿½cran se trouve ici. En fait, il est beaucoup plus vieux et a ï¿½tï¿½ utilisï¿½ dans pas mal de trï¿½s gros projets. Sa page d'accueil est http://cscope.sourceforge.net/. Mais vous n'avez pas besoin de vous y rendre car il est incorporï¿½ directement dans vim et peut ï¿½tre utilisï¿½ de la mï¿½me maniï¿½re que (g)vim en combinaison avec les tags. Tapez simplement

:help cscope

dans votre session vim pour vï¿½rifier les options disponibles. Il existe certains dï¿½rivï¿½s de cscope. Freescope est un clï¿½ne de cscope qui a quelques fonctionnalitï¿½s supplï¿½mentaires telles que la complï¿½tion de symboles. Il y a maintenant ï¿½galement une interface graphique sous KDE pour cscope qui s'appelle kscope et qui peut ï¿½tre trouvï¿½e sur http://kscope.sourceforge.net/.

Conclusions

Pour quiconque impliquï¿½ au moins en partie dans du re-engineering ou de l'intï¿½gration de code source, snavigator est un outil puissant et trï¿½s utile. J'avais avant une vieille application Qt qui ne fonctionne malheureusement plus avec la version actuelle de la bibliothï¿½que Qt. En regardant les messages d'erreurs et en naviguant un peu avec snavigator, j'ai trouvï¿½ rapidement que seule la liste de paramï¿½tre d'une des fonctions devait ï¿½tre changï¿½es. En utilisant la fonctionnalitï¿½ de localisation par clic, il fut possible de rendre le logiciel complet ï¿½ jour en ï¿½ peine quelques minutes.