Quellcode-Anzeige in L A T E X: listings, lgrind

Transkript

1 Quellcode-Anzeige in L A T E X: listings, lgrind Christian Corona 27. Juli 2005 Inhaltsverzeichnis 0.1Einleitung 3 0.2listings Beschreibung Syntax lgrind Beschreibung Syntax Vergleich Quellen 14 1

2 1 Einleitung Einleitung Grundproblemstellung (einfaches) Einbinden von Sonderzeichen-intensiven Quelltexten in LATEX-Dokumente verbatim-umgebung zu primitiv fortgeschrittene Formatierungsoptionen benötigt Lösung Zusatzpakete für LATEX listings, lgrind werden im Folgenden vorgestellt Hauptaugenmerk liegt bei dem listings-paket, da es einfacher in der Handhabung ist 2

3 2 listings 2.1 Beschreibung Über listings Allgemeines reines LATEX-Paket wird noch aktiv weiterentwickelt (letztes Update 2004) groÿe Auswahl an vordenierten Programmiersprachen (über 80) neue Denitionen können eingebunden werden leicht zu erlernen und zu bedienen Benutzung von listings Grundlegender Arbeitsablauf 1. Paket bei Bedarf installieren und mit \usepackagelistings} im Dokument einbinden 2. globale Quelltextsprache und eventuell Ausgabe-Optionen mittels \lstset} kon- gurieren 3. über einen der 3 lst-befehle Quellcode im Dokument einfügen: a) \lstinline$code$ für kurze Code-Fragmente im Text b) \beginlstlisting}code\endlstlisting} für einzeln stehende Code-Blöcke c) \lstinputlistingdatei} wie vorheriger Befehl; Code wird aus externer Datei gelesen 2.2 Syntax Der lstset-befehl Allgemein nimmt eine Liste von Parameter = Wert Elementen auf bestimmt globale Einstellungen (Sprache, Formatierung, etc.) aller nachfolgenden lst-befehle in der aktuellen Umgebung 3

4 Hinweis: Die Argumente für \lstset können auch an die übrigen lst-befehle als optionale Argumente übergeben werden. Dann überschreiben sie die momentanen globalen Einstellungen. Syntax \lstseta=b, c=d,...} Die lstlisting-umgebung Allgemein Funktionsweise analog zu verbatim-umgebung aus Standard-LATEX gut für mehrzeilige Code-Fragmente und ganze Seiten viele Layout-Parameter (Rahmen, Zeilennummern, Farben,... ) als oat-objekt einsetzbar Syntax \ begin [...] lstlisting } Code \ end lstlisting } Einfaches Beispiel Quelltext \ lstset language =C ++} \ begin lstlisting } for ( int i = 2; i < ++ i; i - -) printf (" Noch %d Minuten ", i ); } // Kommentar \ end lstlisting } Ausgabe f o r ( i n t i = 2 ; i < ++i ; i ) p r i n t f ( "Noch %d Minuten", i ) ; } //Kommentar 4

5 Der lstinline-befehl Allgemein Funktionsweise analog zum \verb$code$-befehl aus Standard-LATEX kurze Code-Fragmente können nahtlos in den Text eingefügt werden. einige der Layout-Parameter funktionieren mit lstinline nicht (Zeilennummerierung, Rahmen,... ) Syntax \lstinline[...] Code kann durch (nahezu) beliebiges Zeichen ersetzt werden, das nicht im Code vorkommt. Der lstinputlisting-befehl Allgemein Funktionsweise identisch mit lstlisting Code wird aus externer Datei ausgelesen bei Bedarf kann auch nur ein Ausschnitt der Datei ausgelesen werden Syntax \lstinputlisting[...]datei} Optionale Argumente Allgemein Auf den folgenden Folien wird eine kleine Auswahl an optionalen Argumenten für die lst-befehle vorgestellt. Sie werden entweder \lstset...} als Primärargumente übergeben, oder den übrigen Befehlen als optionale Argumente in eckigen Klammern. Die Form ist immer schlüssel1=wert1, schlüssel2=wert2,... 5

6 Sprachen Schlüssel language=[dialekt]sprache Legt die Sprachdenition fest. Beispiele: \lstsetlanguage=[latex]tex} \lstsetlanguage=c++} alsolanguage=[dialekt]sprache Eine zweite Sprachdenition kann geladen werden, um beispielsweise Misch-Code aus C++ und Assembler einzulesen. Textformatierung Schlüssel basicstyle, keywordstyle, identierstyle, commentstyle, stringstyle Diese Schlüssel beeinussen die Textformatierung des Quellcodes. Das listings-paket unterscheidet grob zwischen keywords, identiers, comments und strings. Diese sind entspechend der Programmiersprache deniert. Hinweis: Die Formatierungen im basicstyle werden auf alle Elemente angewandt. Textformatierung Beispiel Quellcode \ lstinputlisting [ language =C ++, basicstyle =\ ttfamily \ color black }\ small, keywordstyle =\ bfseries \ color blue }, identifierstyle =\ underbar, commentstyle =\ color red }, stringstyle =\ itshape \ color green }] bsp 1. cpp } Ausgabe for ( int i = 2; i < ++ i; i - -) printf ( " Noch % d Minuten ", i ); } // Kommentar 6

7 Tabulatoren und Leerzeichen Schlüssel tabsize=(zeichenzahl) Setzt die Tabulatorgröÿe fest. showtabs=(true/false), showspaces=(true/false) Tabulatoren und Leerzeichen können sichtbar gemacht werden. showstringspaces=(true/false) Leerzeichen in Strings werden standardmäÿig angezeigt, dies kann jedoch mit diesem Schlüssel abgestellt werden. Tabulatoren und Leerzeichen Beispiel Quellcode \ lstinputlisting [ tabsize =2, showtabs = true, showspaces = true ] bsp 1. cpp } Ausgabe f o r ( i n t i = 2 ; i < ++i ; i ) p r i n t f ( "Noch %d Minuten", i ) ; } //Kommentar Zeilenweise Ausgabe Schlüssel rstline=(zeilennummer), lastline=(zeilennummer) Geben jeweils die erste und letzte Zeile an, die vom Quelltext ausgegeben werden soll. linerange=zeile1-zeile2, zeile3-zeile4,... } Gibt unzusammenhängende Zeilenbereiche aus. Hinweis: Diese Schlüssel funktionieren nicht mit lstinline. 7

8 Zeilennummerierung Schlüssel numbers=(none/left/right) Die Zeilen können links oder rechts durchnummeriert werden. stepnumber=(n) Jede n-te Zeile wird mit einer Nummer versehen. numberstyle=(formatierungsoptionen) Die Zeilennummern können formatiert werden. name=(name) listings mit dem selben Namen teilen sich einen Zeilen-Zähler. Hinweis: Diese Schlüssel funktionieren nicht mit lstinline. Zeilennummerierung Beispiel Quellcode \ lstset language =C ++, numbers = left, numberstyle =\ tiny \ color red }} \ lstinputlisting [ firstline =2, lastline =3] bsp 1. cpp } Ausgabe 2 3 p r i n t f ( "Noch %d Minuten", i ) ; Sonstiges Schlüssel caption=(name), title=(name) Versehen den Code-Block mit einer Überschrift. caption nummeriert die Blöcke zudem. label=(name) Setzt einen Ankerpunkt für den \reflabel}-befehl. breaklines, breakatwhitespace Aktivieren den Zeilenumbruch und beschränken ihn auf Leerzeichen. Hinweis: Diese Schlüssel funktionieren nicht mit lstinline. 8

9 Sonstiges Beispiel Quellcode \ lstset language =C ++, caption = Beispiel 1}} \ lstinputlisting bsp 1. cpp } Ausgabe f o r ( i n t i = 2 ; i < ++i ; i ) p r i n t f ( "Noch %d Minuten", i ) ; } //Kommentar Listing 1: Beispiel 1 Was fehlt listings bietet noch eine Reihe fortgeschrittener Funktionen an, auf die ich hier nicht weiter eingehen werde, darunter: eine Vielzahl an Rahmen mit einstellbarer Form und Farbe vollständige Kontrolle über Gröÿe und Ränder der Code-Box automatische Hervorhebung und Indizierung von bestimmten Schlüsselwörtern im Quelltext abspeichern und abrufen von vordenierten styles... 9

10 3 lgrind 3.1 Beschreibung Über lgrind Allgemeines LATEX-Paket + Kommandozeilenprogramm letztes Update Programmiersprachen vordeniert neue Denitionen können eingebunden werden Bedienung etwas un-intuitiv knappe Dokumentation weniger Layout-Optionen als listings, aber dafür einige, die in listings nicht vorhanden sind ansprechendes Standard-Layout lgrind-programm kann aus Quelltexten eigenständige LATEX-Dokumente erstellen Benutzung von lgrind Grundlegender Arbeitsablauf 1. Paket bei Bedarf installieren und mit \usepackage[...]lgrind} im Dokument einbinden 2. Optionen werden über die Argumente in den eckigen Klammern eingestellt 3. Quelldatei(en) mit lgrind bzw. lgrind.exe kompilieren 4. kompilierte Dateien mittels \lgrindfiledatei} oder \lagrinddatei} einfügen lgrind-programm Funktionen Erstellen einer eigenständigen TeX-Datei: lgrind datei > datei.tex Erstellen einer.lg-datei zum Einfügen mittels des lgrind-pakets: lgrind -i datei > datei.lg 10

11 Hinweise lgrind erkennt das Dateiformat an der Dateiendung über die Option -l <Sprache> kann eine bestimmte Sprache erzwungen werden Beispiel einer kompletten LATEX-Datei aus lgrind 82 Bytes 20:48 bsp2.cpp for (int j = 0; j < i; j += 0) printf("noch %d Sekunden", j); } //Kommentar for Syntax Paket-Optionen Auswahl von Optionen 11

12 for (int j = 0; j < i; j += 0) printf("noch %d Sekunden", j); } //Kommentar Abbildung 1: lagrind-beispiel procnames Prozedurnamen am Seitenrand nolineno keine Zeilennummerierung lineno5 jede 5. Zeile nummeriert (Standard: jede 10.) leftno Zeilen links nummeriert (Standard: rechts) lgrindfile-beispiel Quelltext \lgrindfilebsp2.cpp.lg} Ausgabe for (int j = 0; j < i; j += 0) printf("noch %d Sekunden", j); } //Kommentar lagrind-beispiel Quelltext \lagrindbsp2.cpp.lg}lagrind-beispiel}lagrindbsp} Ausgabe Alternativ-Methode: Quelltext direkt in LATEX-Quelldatei Der von lgrind zu formatierende Code kann auch direkt im Dokument eingebunden werden. Spezielle Kommentar-Befehle veranlassen LATEX dazu, fremde Quelltexte zu ignorieren. Die LATEX-Datei muss durch lgrind -e Datei1.tex > Datei2.tex bearbeitet werden, bevor sie mit LATEX kompiliert werden kann. 12

13 4 Vergleich Vergleich listings schnell und unkompliziert gebräuchliste Layout-Optionen gut einstellbar keine oensichtlichen Nachteile (?) lgrind etwas komplizierter in der Bedienung Zwischenschritt über externes Programm lästig für Power-User nahezu grenzenlose Layout-Optionen im Vergleich zu listings eher geeignet für sehr umfangreiche, professionelle Publikationen 13

14 5 Quellen Quellen listings, lgrind lgrind für Windows (nicht unter MiKTEX verfügbar) 14