Kreuzfahrt mit dem 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 de Viktor Horvath

AboutTheAuthor:[A small biography about the author]

Gerrit mochte Computer ï¿½berhaupt nicht, bis er es mit C und Linux versuchte.

Abstract:[Here you write a little summary]

Dieser Artikel stellt den snavigator vor, ein mï¿½chtiges Werkzeug fï¿½r Code-Analyse, Querverweise und Re-Engineering, das unverzichtbar ist, um der Komplexitï¿½t der Pflege von grï¿½ï¿½eren Softwareprodukten und -paketen effizient zu begegnen.

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

ArticleBody:[The main part of the article]

Motivation

Ein altes Sprichwort sagt, daï¿½ ein Buch nicht nach seinem Umschlag beurteilt werden sollte. Etwas ï¿½hnliches gilt fï¿½r Open Source-Code. Open Source ist jedoch nicht dasselbe wie Open Documentation, und das Lesen wird immer schwieriger mit der wachsenden Anzahl und Lï¿½nge der Quelldateien. Ich muï¿½te kï¿½rzlich mit einer Software programmieren, die mit einer halben HTML-Seite Dokumentation aufwartete sowie mit ï¿½ber 348.000 Zeilen Open Source Java-Code, verteilt auf mehr als 2.060 Dateien (siehe Graphik). Angesichts solcher Dimensionen werden Werkzeuge fï¿½r elektronische Orientierung, Reverse Engineering und Analyse unverzichtbar. Ein solches ist der Red Hat source code navigator, der in diesem Artikel vorgestellt wird.
Er automatisiert viele Aufgaben, die man normalerweise mit (c)tags, grep, search und replace erledigte, aber viel prï¿½ziser und bequemer, in einer einfach zu benutzenden graphischen Oberflï¿½che integriert, siehe die Screenshots unten.

Installation in Debian

Unter Debian kannst du das ganze Paket mit folgendem Einzeiler bekommen:

apt-get install sourcenav sourcenav-doc

Das besorgt gleichzeitig auch die Dokumentation. Der source navigator befindet sich dann in /usr/lib/sourcenav/, du kannst das Hauptprogramm mittels /usr/lib/sourcenav/bin/snavigator starten (siehe den Tip bezï¿½glich eines Symlinks unten). Die Dokumentation kann unter /usr/share/doc/sourcenav/html/ gefunden werden.

Installation aus den Quellen

Die Homepage von source navigator ist http://sourcenav.sourceforge.net/, die Downloads liegen hier (sourceforge.net/project/showfiles.php?group_id=51180). Hole den neuesten Tarball sourcenav-xx.xx.tar.gz. Wï¿½hrend des Downloads kannst du dich mit etwas anderem beschï¿½ftigen - die Quellen sind 55 Megabytes groï¿½. Das hat auch seine guten Seiten, das Paket braucht kaum etwas anderes. Obwohl es stark auf andere Bibliotheken wie Tcl/Tk, Tix und Berkeley DB zurï¿½ckgreift, sind deren richtige Versionen alle mitgeliefert. Um Konflikte mit anderen Versionen von Tcl/Tk auf deinem System zu vermeiden, ist es eine gute Idee, die Installation in einem separaten Verzeichnis vorzunehmen, z.B. /opt/sourcenav. Die Anweisungen empfehlen des weiteren die Benutzung eines separaten Kompilier-Verzeichnis (build directory), was wie folgt funktioniert. Im Verzeichnis, wo die entpackten Dateien liegen, mache dies:

mkdir snbuild; cd snbuild 
../sourcenav-*/configure --prefix=/opt/sourcenav 
make                               ## takes a while ...
make install                       ## might have to become root first

Die Option --prefix spezifiziert das Installations-Verzeichnis. Wï¿½hrend configure lï¿½uft, bekommt man bereits eine Vorstellung von den vielen Sprachen, mit denen snavigator umgehen kann. Es ist ebenfalls mï¿½glich, weitere Parser fï¿½r Sprachen deiner Wahl oder auch selbstgeschriebene hinzuzufï¿½gen. Ist die Installation via make install einmal beendet, ist der snavigator bereit zur Arbeit und kann als /opt/sourcenav/bin/snavigator aufgerufen werden. Anstatt die Umgebungsvariable PATH zu erweitern, schlage ich einen symbolischen Link vor, z.B. in /usr/local/bin.

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

Das Hauptprogramm ist ein Shellscript, das sein Verzeichnis kennen muï¿½. Daher wird es ï¿½ber einen Symlink-Aufruf verwirrt. Das kann mit der ï¿½nderung folgender Zeilen in /opt/sourcenav/bin/snavigator behoben werden: Ersetze

snbindir=`dirname $0`

durch

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

Die Option -f von readlink(1) erzeugt eine kanonische Darstellung des Pfades, d.h. es funktioniert sogar, wenn auf die Datei ï¿½ber einen sehr langen Pfad von verschachtelten Symlinks zugegriffen wird.

Benutzung des snavigator

Wird der snavigator zum ersten Mal aufgerufen, fragt er nach Verzeichnissen, die Quelldateien enthalten, wie der folgende Screenshot zeigt. Die unterstï¿½tzen Sprachen umfassen unter anderem Java, C, C++, Tcl, Fortran, COBOL und Assemblerprogramme. Wenn der Quellcode angegeben wurde, baut er selber eine Projekt-Datenbank, die Verweis-Informationen, Klassenhierarchien, Datei-Abhï¿½ngigkeiten und noch viel mehr umfaï¿½t. Je nach Grï¿½ï¿½e von deinem Projekt kann das ein biï¿½chen dauern. Anschlieï¿½end kannst du Anfragen an die Datenbank stellen und zusï¿½tzliche Informationen ï¿½ber den Code erfragen. Das Folgende prï¿½sentiert nur ein paar der Features, um dir eine Vorstellung zu geben. Eine illustrierte Einleitung und ein Referenzhandbuch befinden sich im Unterverzeichnis html deiner Installation.

Projekt-Management

Zum Paket gehï¿½rt ein Editor mit Syntax-Highlighting, der auch zum ansprechenden Drucken genutzt werden kann. Der folgende Screenshot bildet das Hauptfenster des Editors ab. Er ist fast wie eine Entwicklungsumgebung, denn er wartet mit Sachen wie einer Debug-Mï¿½glichkeit, Projekt-Kompilierbefehlen, Versionskontrolle und ï¿½hnlichem auf.

Das ist das Hauptfenster des
Editors. Es gibt Tabs, die in die Unterfunktionen führen wie das
Grepper-Modul.

Insbesondere die groï¿½en grï¿½nen Pfeile in der Toolbar funktionieren genau wie in einem Web-Browser. Der Projekt-Editor erlaubt einem, die Datenbankinformationen zu kontrollieren (z.B. falls eine Datei gerade verï¿½ndert wurde), Dateien von der Liste hinzuzufï¿½gen oder zu lï¿½schen und andere Verwaltungsaufgaben. Alle Dateien werden als ein groï¿½es Projekt behandelt. Wenn also Verï¿½nderungen geschehen, kannst du die Datenbankinformationen mit Refresh Project oder Reparse Project aktualisieren.
Im Editorfenster markiere etwas, etwa den Namen einer Funktion, so daï¿½ die markierte Region in gelb erscheint. Dann klicke mit der rechten Maustaste - du kannst entscheiden, ob du (a) die Deklaration von dem, was du markiert hast, sehen willst (z.B. eine Header-Datei) oder (b) die Implementation des markierten Symbols (z.B. eine .cpp-Datei) - und es gibt noch ein paar weitere nï¿½tzliche Optionen.

Der Symbolbrowser

Das ist das erste Fenster, das nach dem Fï¿½llen der Projektdatenbank erscheint. Normalerweise enthï¿½lt es Dateinamen, aber es kann auch Klassenmethoden, Funktionssymbole und ï¿½hnliches darstellen. Wenn auf einen Dateinamen geklickt wird, ï¿½ffnet sich der Editor mit dieser Datei.

Das grep-Fenster

Das tut, was der Name sagt: Es bietet eine komfortable GUI, um durch alle beteiligten Quelldateien zu greppen. Passende Eintrï¿½ge sind markiert und verlinkt, der Quellcode kann so wie ein Haufen Webseiten betrachtet werden. Wie der Screenshot zeigt, kann die entsprechende Datei ausgewï¿½hlt werden, und durch simples Klicken wird der Editor an der richtigen Stelle geï¿½ffnet. (Die gezeigte Suche erzeugt Treffer in vielen Java-Dateien :)

Das Xref-Fenster

Hier haben wir eine Liste mit Querverweisen zu allen Symbolen, insbesondere kann man sehen, welche Methoden lesen (r), schreiben (w), usw. auf welchen Daten, und man kann die Beziehungen zwischen Symbolen sehen, hierarchisch dargestellt. Auf die Eintrï¿½ge kann man klicken. xref

Das Klassenfenster

Dieses Interface sammelt alle nï¿½tzliche Informationen, die man ï¿½ber Klassen in einer objektorientierten Sprache wissen will. Vor allem werden die Super- und Subklassen gezeigt sowie Attribut- und Methodennamen mit ihren Parametern. Zur Abwechslung zeigt das Fenster unten eine C++-Klasse ClientSocket, die von Socket erbt und ziemlich viele Methoden aufweist. Wieder gilt, daï¿½ du per Klick auf einen Eintrag ein Editorfenster an der entsprechenden Position ï¿½ffnen kannst.

Alternativen

cscope ist ein interaktiver C-Quellcode-Browser fï¿½r die Kommandozeile (er kann auch mit C++ umgehen). Er hat einiges von der Funktionalitï¿½t des snavigator, ein Screenshot ist hier. Tatsï¿½chlich ist er viel ï¿½lter und ist in vielen sehr groï¿½en Projekten benutzt worden. Seine Homepage ist http://cscope.sourceforge.net. Aber du brauchst nicht einmal dorthin zu gehen - er ist in vim eingebaut und kann sehr ï¿½hnlich benutzt werden wie (g)vim in Kombination mit tags. Tippe einfach

:help cscope

in deiner vim-Sitzung, um die verfï¿½gbaren Optionen zu sehen. Es gibt noch ein paar von cscope abgeleitete Programme. Freescope ist ein cscope-Clone, dem etwas Funktionalitï¿½t wie Symbol-Vervollstï¿½ndigung hinzugefï¿½gt wurde. Es gibt jetzt auch ein KDE-Frontend zu cscope namens kscope, das unter http://kscope.sourceforge.net liegt.

Zusammenfassung

Fï¿½r jeden, der wenigstens zum Teil mit dem Re-Engineering oder der Integration von Quellcode beschï¿½ftigt ist, ist der snavigator ein sehr nï¿½tzliches und mï¿½chtiges Werkzeug. Ich hatte einmal eine ï¿½ltere Qt-Applikation, die leider nicht mit der aktuellen Version der Qt-Bibliothek lief. Indem ich die Fehlermeldungen las und ein biï¿½chen mit dem snavigator arbeitete, fand ich bald heraus, daï¿½ nur die Parameterliste einer Funktion geï¿½ndert werden muï¿½te. Mit der klick-und-finde-Funktionalitï¿½t (click-and-locate) war es mï¿½glich, das gesamte Softwarepaket in nur ein paar Minuten auf den aktuellen Stand zu bringen.