Debian Codegraph @

texmf-dist/source/latex/gmdoc-enhance/gmdoc-enhance.dtx

raw
1 % \iffalse meta-comment
2 %
3 %<*package>
4 %% (C) 2009 Paul Ebermann
5 %%
6 %% Package gmdoc-enhance - Verbesserungen für gmdoc.
7 %%
8 %% Die Datei gmdoc-enhance.dtx sowie die dazugehörige
9 %% gmdoc-enhance.ins sowie die damit generierte
10 %% gmdoc-enhance.sty stehen unter der
11 %% "LaTeX Project Public License" (LPPL, zu finden
12 %% unter http://www.latex-project.org/lppl/, sowie
13 %% auch in den meisten TeX-Distributionen in
14 %% texmf/docs/latex/base/lppl*.txt), Version 1.3b oder
15 %% später (nach Wahl des Verwenders).
16 %%
17 %% Der 'maintenance-status' ist (zur Zeit) 'author-maintained'.
18 %%
19 %% Das heißt u.a., die Dateien dürfen frei vertrieben werden,
20 %% bei Änderungen (durch andere Personen als Paul Ebermann)
21 %% ist aber der Name der Datei zu ändern.
22 %</package>
23 % \fi
24 %
25 % \iffalse
26 % ---------------------------------------------
27 %<package>\NeedsTeXFormat{LaTeX2e}[2003/12/01]%
28 % ----------------------------________________-----------------
29 %<package>\ProvidesPackage{gmdoc-enhance}[2009/02/20 v0.2 Verbesserungen fuer gmdoc.]%
30 % ----------------------------________________-----------------
31 % \fi
32 %
33 % \iffalse
34 % \fi
35 %
36 % \CheckSum{0}
37 %
38 % \GetFileInfo{gmdoc-enhance.sty}
39 %
40 %
41 % \title{Das \pk{gmdoc-enhance}-Paket -- Verbesserungen für \pk{gmdoc}. \
42 % \thanks{ Diese Dokumentation gehört zu \
43 % \pk{gmdoc-enhance}~\fileversion, de~\filedate.}}
44 % \author{Paul Ebermann\thanks{\texttt{[email protected]}}}
45 %
46 % \maketitle
47 %
48 % \begin{abstract}
49 % Dieses Package basiert auf \pk{gmdoc} von Grzegorz
50 % \textquoteleft Natror\textquoteright
51 % Murzynowski zur Dokumentation von \LaTeXpar-Paketen und fügt ein
52 % paar weitere nützliche Funktionen hinzu, wie Markierung der
53 % inline-Kommentare als solche auch in Folgezeilen, sichtbare
54 % Kommentare (auskommentierter Code), und die Möglichkeit, andere
55 % \LaTeX-Dateien im normalen Modus einzubinden (anstatt im
56 % \pk{gmdoc}-Modus).
57 % \end{abstract}
58 %
59 % \tableofcontents
60 %
61 % \section{Nutzer-Doku}
62 %
63 % ^^A etwas tricky ... wir wollen, dass beim
64 % ^^A reinen LaTeX-Durchlauf der Beispiel-Abschnitt
65 % ^^A übersprungen wird, also muss ein '\iffalse' da
66 % ^^A stehen. Beim Doku-Lauf soll dieser Trick nicht
67 % ^^A auftauchen, also können wir nicht den normalen
68 % ^^A verbatim-Modus nehmen ... wir brauchen also ein
69 % ^^A '\iffalse' drumrum. Jetzt wird aber auch das innere
70 % ^^A '\iffalse' interpretiert, wodurch wir dahinter zwei
71 % ^^A '\fi' brauchen. Am Ende des Beispiel-Abschnitts dann
72 % ^^A entsprechend zwei '\iffalse'. (Hmm, und jetzt soll bitte
73 % ^^A niemand versuchen, diesen '^^A'-Abschnitt hier mit '\iffalse'
74 % ^^A auszukommentieren ...)
75 % \iffalse
76 %<*beispiel>
77 \iffalse
78 % \fi\fi
79 %
80 % Das Paket sollte -- wie üblich -- mit '\usepackage' geladen werden:
81 % \begin{quote}
82 % '\usepackage'\arg[optionen]'{gmdoc-enhance}'
83 % \end{quote}
84 % Es lädt selbst das \pk{gmdoc}-Paket, falls dieses nicht schon geladen
85 % ist. Falls man Optionen an dieses übergeben will, sollte man es vorher
86 % selbst laden. Ein vollständiges Beispiel gibt es in Abschnitt \ref{driver}.
87 %
88 % \subsection{Inline-Kommentare mit \%}
89 % Diese Funktion erfordert (im Vergleich zum normalen \pk{gmdoc}) keine
90 % Änderung der zu kommentierenden Datei
91 % \normalInlineComments (nur das Aktivieren), sondern ändert nur das Aussehen.
92 \beispiel\zeile% Bei \pk{gmdoc} kann jede Code-Zeile von
93 % einem Inline-Kommentar gefolgt werden, der dann normal gesetzt
94 % wird, mit hängendem Einzug. Zu diesem Inline-Kommentar gehören auch
95 % direkt anschließende Kommentarzeilen. (Hier ein solches Beispiel.)
96 %
97 % Dieses Paket ändert das Aussehen eines solchen
98 % \InlineCommentsWithPercent Absatzes:
99 \beispiel\zeile% Jetzt wird der Inline-Kommentar mit etwas mehr Abstand
100 % gesetzt, und das '%'-Zeichen grau (falls \pk{color} geladen wurde).
101 % Wichtiger aber, in den Folge-Zeilen erscheint jeweils zu Beginn der
102 % Zeile eine Kommentar-Markierung, so dass man ihn nicht mit einer
103 % neuen Code-Zeile verwechseln kann.
104 %
105 %
106 % Aktivieren kann man die Funktion mit \TextUsage{\InlineCommentsWithPercent},
107 % welches ab der entsprechenden Stelle gilt (es wurde oben zwischen den beiden
108 % Code-Zeilen im Beispiel verwendet.
109 % Mit \TextUsage{\normalInlineComments} wird wieder auf den Normal-Modus
110 % zurückgeschaltet.
111 %
112 % Global aktivieren kann man diesen Modus mit der Paket-Option
113 % \TextUsage*{inline}.
114 %
115 % \subsection{Sichtbare Kommentare}
116 %
117 % Dieses Paket bietet die Möglichkeit, Teile des
118 % Quelltextes auszukommentieren, und diese dann auch so zu setzen (anstatt
119 % dass der auskommentierte Quelltext als Teil der Dokumentation aufgefasst
120 % wird).
121 % Dazu verwendet man im Quelltext:
122 %\begin{verbatim}
123 %%! \nicht\gebraucht% Und jetzt $e^{i\pi}=-1$.
124 %\end{verbatim}
125 % Dies ergibt etwas wie dies:
126 %! \nicht\gebraucht% Und jetzt $e^{i\pi}=-1$.
127 %
128 % Dieser Modus hat zwei Parameter:
129 % Mit \meta{marker} (ein einzelnes Zeichen, wahrscheinlich muss es
130 % Kategorie \catother (other) haben) markiert man im Quelltext das
131 % Auskommentieren, direkt nach dem '%'\footnote{oder ^^B
132 % was auch immer gerade der durch \cs{CodeDelim} festgelegte ^^B
133 % Markierer ist.}.
134 % Der Defaultwert (und im obigen Beispiel verwendet) ist '!'.
135 %
136 % \meta{Farbe} ist ein Parameter (oder zwei) für
137 % \TextUsage{\color}\footnote{ aus dem \pk{color}-Paket},
138 % um eine farbliche Markierung des auskommentierten Codes zu aktivieren.
139 % (Default ist keine farbliche Markierung.)
140 %
141 % Die Paket-Option \TextUsage*{visible} aktiviert den Modus und legt
142 % \meta{Farbe} auf '{blue}' fest, was meine bevorzugte Einstellung ist.
143 %
144 % Falls diese Einstellungen nicht zusagen, kann man (statt oder zusätzlich zur
145 % Option) die folgenden Makros verwenden:
146 %
147 % \TextUsage{\activateVisibleComments} aktiviert den Modus, ohne etwas an
148 % \meta{marker} oder \meta{Farbe} zu ändern.
149 %
150 % \TextUsage{\setVisibleCommentChar}\arg{marker} legt \meta{marker} fest.
151 %
152 % \TextUsage{\setVisibleCommentColor}\meta{Farbe} legt \meta{Farbe} fest.
153 % \meta{Farbe} ist entweder von der Form \arg[model]\arg{farbe} (für eine
154 % Farbe in einem der von \pk{color} bereitgestellten Farbmodelle) oder
155 % \arg{farbname} für einen der vordefinieren Farbnamen. Beides wird einfach
156 % an der geeigneten Stelle an 'color' weitergegeben.
157 %
158 % Falls eine Farbe festgelegt wird, sollten auskommentierte Code-Stellen
159 % unbedingt mit einem '%' (und eventuell einem inline-Kommentar danach) beendet
160 % werden, weil die Farbmarkierung sich sonst fälschlicherweise in die
161 % nächste Zeile fortsetzt, sogar inklusive der Zeilennummer:
162 %
163 %! \auskommentiert
164 \nicht\auskommentiert
165 %
166 % Das ist offenbar nicht so gedacht, aber ich habe keinen (einfachen) Weg
167 % gefunden, das abzuschalten.
168 %
169 % \subsection{Input im normalen Modus}
170 %
171 % Wenn man innerhalb eines \pk{gmdoc}-Dokumentes eine andere
172 % Datei lädt, welche die normalen \LaTeX-Konventionen für '%' und Zeilenenden
173 % verwendet, gibt es Chaos \dots
174 %
175 % \TextUsage{\normalInput}\arg{dateiname} stellt die üblichen
176 % \LaTeX-Konventionen wieder her, lädt \meta{dateiname} (falls existent),
177 % und stellt wieder auf den \pk{gmdoc}-Modus zurück.
178 %
179 % Dies ist etwa nützlich, falls man eine Beispiel-Datei einlesen möchte,
180 % um deren Ausgabe zu zeigen.
181 %
182 % Die Datei wird innerhalb einer Gruppe geladen -- alle nicht-globalen
183 % Zuweisungen darin gehen also verloren.
184 %
185 % ^^A ------------------------------
186 %
187 % \iffalse\iffalse
188 \fi
189 %</beispiel>
190 % \fi
191 %
192 % \section{Der Doku-Treiber für dieses Paket}
193 % \label{driver}
194 %
195 % Der Dokumentations-Treiber dient gleichzeitig als Beispiel für
196 % die Anwendung (und die Ausgabe) dieses Paketes.
197 %<*driver>
198 % Die Dokumentenklasse, mit 'draft'-Option, um zu lange Zeilen
199 % zu markieren. (Nicht als globale Option, weil sonst \pk{hyperref}
200 % seine Arbeit verweigert.)
201 \PassOptionsToClass{draft}{scrartcl}
202 \documentclass[idxtotoc]{scrartcl}
203
204 %
205 % Die Standard-Pakete ...
206 \usepackage[utf8x]{inputenc}
207 \usepackage[ngerman]{babel}
208 \usepackage{lmodern}
209 \usepackage[T1]{fontenc}
210
211
212
213 \let\orgshow\show% Irgendjemand oder etwas definiert '\show' um -- das ist
214 % normalerweise ein \TeX-primitiv, und ich benutze es gelegentlich zum
215 % Debuggen meiner Pakete. Daher machen wir uns eine Kopie davon.
216
217 \usepackage[countalllines, withmarginpar, codespacesgrey]{gmdoc}% Wir laden
218 % \pk{gmdoc} mit ein paar Optionen: es sollen alle Zeilen gezählt werden,
219 % nicht nur Code-Linien (das heißt, man kann schnell die passende
220 % Quelltext-Stelle finden), im Rand sollen verwendete Makros angezeigt
221 % werden, und Leerzeichen im Code sollen grau markiert werden.
222 \usepackage[visible, inline]{gmdoc-enhance}% unser eigenes Paket, mit allen
223 % vorhandenen Optionen.
224 \renewcommand*{\EOFMark}{}% Das Zeichen \meta{eof} am
225 % Ende der Datei ist überflüssig, weg damit.
226
227
228 %! \def\marginpartt{\normalfont\fontseries{lc}\ttfamily}% Abgeschrieben aus
229 % \pk{gmdocc}, aber die Schrift ist bei mir offenbar nicht da. Schade.
230
231 \RecordChanges% Wir wollen eine Liste der Änderungen generieren.
232 \setcounter{IndexColumns}{2} % wir haben ein paar ziemlich lange Makronamen,
233 % die in dreispaltigem Modus nicht passen.
234
235 \begin{document}
236
237 %! \catcode`\^=7% In einigen Sprachen wurde '^' von \pk{Babel} aktiviert,
238 % was für die \pk{gmdoc}-Verwendung etwas störend ist, da wir es für '^^A'
239 % und '^^B' benötigen. Also schalten wir es wieder auf die
240 % Normalbedeutung (Superscript bzw. doppelt Escape) zurück. Für \pk{ngerman}
241 % macht Babel das nicht, daher auskommentiert.
242
243 \MakeShortVerb*\'% Wir wollen \verb+'+ im Kommentar als
244 % verbatim-Markierungs-Zeichen verwenden, mit sichtbaren Leerzeichen.
245 \DocInput{\jobname.dtx}% Jetzt laden wir uns selbst im Doku-Modus.
246
247 \end{document}
248 %</driver>
249
250 %
251 % \StopEventually{\PrintChanges\PrintIndex}
252 %
253 % \section{Implementation}
254 %
255 %<*package>
256 %
257 % \subsection{Benötigte Pakete}
258 %
259 % Da dieses Paket \pk{gmdoc} erweitert, müssen wir natürlich sicherstellen,
260 % das es geladen wurde. Zum übergeben von Optionen sollte man es aber vorher
261 % selbst laden.
262 \RequirePackage{gmdoc}[2008/10/04]%
263
264 % \subsection[Schönere Inline-Kommentare]{Inline-Kommentare \
265 % mit \%-Markierung in den Fortsetzungs-Zeilen}
266 %
267 %
268 % Hier das Nutzer-Makro dieses Abschnittes.
269 \newcommand*{\InlineCommentsWithPercent}{%
270 \let\gmde@org@ifilrr = \ifilrr% Wir merken uns dir Original-Einstellung
271 % für Block- oder Flattersatz.
272 \ilrrtrue% Wir schalten auf Flatter- statt Blocksatz für die
273 % Inline-Kommentare. Unsere aktiven Leerzeichen sind ja nicht variabel
274 % in der Länge (wirklich?), und wir wollen auch keine Zeilenumbrüche
275 % außerhalb von Leerzeichen (etwa durch Silbentrennung).
276 \let\gmd@percenthack\gmde@percenthack% Außerdem verwenden wir unsere
277 % gepatchte Variante von '\gmd@percenthack'.
278 }%
279 %
280 % Der Zurückschalter.
281 \newcommand*{\normalInlineComments}{%
282 \let\ifilrr = \gmde@org@ifilrr% Wir setzen die Block/Flattersatz-Einstellung
283 % zurück auf den Wert, der beim letzten '\InlineCommentsWithPercent' galt.
284 \let\gmd@percenthack \gmde@org@percenthack% Dies setzen wir auf aufs
285 % Original zurück.
286 }%
287 %
288 % Wir merken uns die Original-Version von '\gmd@percenthack', damit
289 % wir wieder zurückschalten können.
290 \let \gmde@org@percenthack = \gmd@percenthack%
291 %
292 % Das ist unsere Variante von '\gmd@percenthack'.
293 \def\gmde@percenthack{%
294 \ifprevhmode%
295 % Bis hier was es auch im Original schon so.
296 \aftergroup\gmde@specialSpaces% Diese Zeile ist neu -- wir schalten
297 % um auf unsere neu definierten aktiven Leerzeichen.
298 \aftergroup\gmde@kommentarStart% Das Original war hier
299 % '\code@delim\aftergroup~'.
300 %
301 % Der Rest ist wieder wie im Original.
302 \else%
303 \aftergroup\gmd@narrcheckifds@ne%
304 \fi%
305 }%
306 %
307 %
308 %
309
310 % Zunächst ^^A \showthe\font
311 % \the\hyphenchar\font
312 % ^^A \expandafter\orgshow\csname gmde@hyphenreset\endcsname
313 % besorgen wir uns ein aktives Leerzeichen. Dafür schalten
314 % wir kurzfristig die Kategorie von ' ' um.
315 \catcode`\ =\active%
316 \def\gmde@activeSpace{ }%
317 \catcode`\ =10%
318
319 % '\gmde@specialSpaces' macht die Leerzeichen für den entsprechenden
320 % Paragraphen aktiv und legt auch ihre Bedeutung fest.
321 \def\gmde@specialSpaces{%
322 \catcode`\ =\active% Aktives Leerzeichen.
323 \@xa\let\gmde@activeSpace=\gmde@discrSpace% Und es soll die
324 % (unten definierte) Leerzeichenfunktion aufrufen.
325 \exhyphenpenalty=0% Das setzt die Strafen für Umbrüche an diesen
326 % Leerzeichen (und ähnlichen '\discretionary's mit leerem
327 %"`Pre-break"'-Inhalt) auf 0.
328 \hyphenpenalty=1000% Dafür stellen wir die Strafen für normale
329 % Silbentrennung hoch -- allerdings schalten wir auch den Bindestrich
330 % ab, so dass das eigentlich irrelevant sein sollte. Es beeinflusst auch
331 % andere '\discretionary's mit nichtleerem "`pre-break"'-Text, die
332 % vielleicht irgendjemand verwendet.
333 %
334 \let\@codetonarrskip\gmde@codetonarrskip% Wir sorgen dafür, dass mit
335 % dem nächsten Paragraphen das alles wieder abgeschaltet wird --
336 % '\gmde@codenarrskip' ruft (nach der normalen Aktion von '\@codetonarrskip')
337 % '\gmde@normalSpaces' auf.
338 %
339 % Wir merken uns den alten '\hyphenchar', damit wir
340 % ihn später zurücksetzen können.
341 \def\@tempa{gmde@hyphenchar-%
342 \@xa\string\the\font}% der Name für unsere zu definierende
343 % Kontrollsequenz. Er enthält den internen Namen der Schrift.
344 \@ifundefined{\@tempa}{%
345 % Die Nummer des '\hyphenchar's merken wir uns jetzt in dieser
346 % Kontrollsequenz.
347 \@xa\edef\csname \@tempa\endcsname{%
348 \the\hyphenchar\font }%
349 }{% Wenn wir es schon vorher definiert haben,
350 % definieren wir es nicht noch einmal, denn dann ist jetzt vielleicht
351 % schon der Code $-1$, wogegen der Original-Code (meist 45) noch dort
352 % gespeichert ist.
353 }%
354 \edef\gmde@hyphenreset{%
355 \hyphenchar\font=%
356 \@xa\noexpand%
357 \csname \@tempa\endcsname%
358 }%
359 % Und jetzt setzen wir für diesen Absatz den '\hyphenchar' der aktuellen
360 % Schrift auf $-1$, um damit Trennungen an -, -- und --- sowie
361 % Silbentrennungen auszuschließen.
362 \hyphenchar\font=-1 % Das ist
363 % aber trotzdem noch ein Hack, denn
364 % natürlich kann man \textsl{einfach -- zwischendurch -- in eine andere^^B
365 % Schriftart -- das ist jetzt ein Beispiel mit Hyphenchar ^^B
366 % \expandafter$\the\hyphenchar\font$ -- schalten}, die dann doch wieder einen
367 % echten '\hyphenchar' hat. (Nachher wieder
368 % \expandafter$\the\hyphenchar\font$.) Hmm,
369 % bessere Vorschläge?
370 }%
371
372 % noch ein Vorgabewert für dieses Kommando ... es wird regelmäßig
373 % neu definiert, aber eventuell wird es vor der ersten solchen Definition
374 % noch geändert.
375 \def\gmde@hyphenreset{}%
376
377 % Das ist eine Sicherheitskopie von '\@codetonarrskip' aus \pk{gmdoc}.
378 \let\gmde@org@codetonarrskip = \@codetonarrskip%
379 %
380 % Und jetzt unsere Variante, mit einem Aufruf der Rücksetzfunktion.
381 \let\gmde@codetonarrskip = \@codetonarrskip
382 \g@addto@macro\gmde@codetonarrskip{\gmde@normalSpaces}%
383 %
384
385 % Dieses Makro enthält eine Box, die am Start jeder Kommentarzeile
386 % gesetzt wird.
387 \def\gmde@kommentarStart{%
388 % Hmm, wir könnten auch eine save-Box dafür reservieren,
389 % anstatt es immer neu zu bauen ... aber so passt es sich wenigstens
390 % an Änderungen des von '\code@delim' an.
391 \hbox{{%
392 \@ifpackageloaded{color}{\color{gray}}{}% Falls das \pk{color}-Paket
393 % geladen ist, zeigen wir das '%'-Zeichen in grau statt dem normalen
394 % schwarz. Damit sticht es nicht ganz so sehr ins Auge.
395 \ttfamily\code@delim\quad}}%
396 }%
397
398
399 %
400 % Hier die Definition unseres merkwürdigen aktiven Leerzeichens.
401 %
402 % \dots Ein paar Zahlen: '\hyphenpenalty':
403 % \expandafter$\the\hyphenpenalty$, '\exhyphenpenalty': \expandafter$\the\exhyphenpenalty$
404 \def\gmde@discrSpace{%
405 \ifx\protect\@typeset@protect%
406 \ifinner%
407 \space% Wenn wir in einer inneren Box sind, soll das aktive
408 % Leerzeichen wie ein normales Leerzeichen funktionieren, da es ja
409 % hier sowieso keinen Zeilenumbruch gibt. Oder? Egal, unsere
410 % Code-Kommentare sollten nie im inneren Modus auftauchen.
411 \else%
412 \ifhmode%
413 \unskip% Hmm, ich bin mir nicht ganz sicher, warum dieser
414 % Befehl hier notwendig ist. Ohne gibt es jedenfalls gelegentlich
415 % Zeilenumbrüche, die nicht an einen dieser '\discretionary's
416 % fallen (und entsprechend kein '%' in der nächsten Zeile haben.)
417 %
418 \discretionary{% Die "`Expansion"' dieses '\discretionary'-Objektes
419 % falls es hier einen Zeilenumbruch gibt, ist am Ende der Zeile
420 % leer.
421 }{\gmde@kommentarStart% Dafür taucht am Ende der vorherigen Zeile
422 % die Box auf, die durch '\gmd@kommentarStart' gesetzt wird.
423 }{% Falls kein Umbruch an dieser Stelle erfolgte, ist es
424 % ebenfalls leer.
425 }%
426 ~% Jetzt setzen wir noch ein nicht-umbrechbares Leerzeichen. Falls
427 % es einen Umbruch gab, war der ja davor.
428 \else%
429 \space% Außerhalb des horizontalen Modus (d.h. im Mathe- und im
430 % vertikalen Modus) hat unsere Spezialfunktion auch nichts
431 % zu suchen.
432 \fi%
433 \fi%
434 \afterfi{%
435 \gmde@gobbleActiveSpaces}% Am Ende fressen wir alle weiteren
436 % direkt folgenden derartigen aktiven Leerzeichen auf, damit es nicht
437 % mehrere auf einmal gibt.
438 %
439 % Eigentlich sorgt das obige '\unskip' ja schon dafür, dass mehrere
440 % aufeinanderfolgende aktive Leerzeichen (die ja prinzipiell ein '~'
441 % als skip einfügen), keine Probleme bereiten, nur das letzte bleibt übrig.
442 % Damit ist das '\gmd@gobbleActiveSpaces' eigentlich nicht mehr
443 % nötig. Aber wir entlasten damit den Zeilenumbruch-Algorithmus
444 % etwas, wenn nicht mehrere '\discretionary's hintereinander kommen.
445 \else%
446 \space% Falls wir nicht im Typeset-Modus sind, sondern etwa in eine Datei
447 % oder auf den Bildschirm schreiben, soll unser ' ' auch wie ein normales
448 % Leerzeichen wirken. Schließlich findet da kein Zeilenumbruch statt.
449 \fi%
450 }%
451 %
452 % Hier die Definition unseres Space-Fressers.
453 \def\gmde@gobbleActiveSpaces{%
454 \@xa\@ifnextchar\gmde@activeSpace% Wir überprüfen, ob das
455 % nächste Token ein aktives Leerzeichen ist.
456 {% Falls ja, \dots
457 \@xa\gmde@gobbleActiveSpaces\@gobble% entsorgen wir es
458 % mit '\@gobble' und rufen uns dann selbst rekursiv auf.
459 }{}% Im anderen Fall machen wir gar nichts, womit die Rekursion
460 % beendet ist.
461 }%
462 %
463 % Dieses Makro setzt alles wieder aufs normale zurück.
464 \def\gmde@normalSpaces{%
465 \gmde@hyphenreset% Wir rufen das Makro auf, welches den '\hyphenchar' auf
466 % seinen Original-Wert zurücksetzt.
467 \exhyphenpenalty=50 \hyphenpenalty=50 % Die Strafen erhalten auch ihren normalen Wert.
468 \@xa\let\gmde@activeSpace = \space% Das aktive Leerzeichen wird ein normales,
469 \catcode`\ = 10% und Leerzeichen sind ab jetzt nicht mehr
470 % aktiv.
471 \let\@codetonarrskip = \gmde@org@codetonarrskip% Wir setzen auch dieses
472 % Makro auf seine Original-Bedeutung zurück.
473 }%
474 %
475
476 %
477 % \subsection{Auskommentierter Quelltext}
478 %
479 %
480 % Aktiviert den Sichtbar-Kommentar-Modus.
481 \newcommand*{\activateVisibleComments}{%
482 \let \gmd@narrcheckifds = \gmde@narrcheckifds%
483 \let \gmd@narrcheckifds@ne = \gmde@narrcheckifds@ne%
484 \let \gmd@eatlspace = \gmde@eatlspace%
485 }
486 %
487 % Dieses Kommando legt das Zeichen zur sichtbaren Auskommentierung von
488 % Quelltext fest.
489 \newcommand*{\setVisibleCommentChar}[1]{%
490 \let \gmde@visibleCommentChar = #1%
491 }%
492
493 % Hier ein Default-Wert für das Kommentar-Markierungs-Zeichen.
494 \setVisibleCommentChar{!}%
495
496 %
497 % Legt die Farbe, in der sichtbare Kommentare gesetzt
498 % werden sollen, fest.
499 %
500 \newcommand*{\setVisibleCommentColor}{%
501 % Wir unterscheiden, ob ein optionales Argument gegeben
502 % wurde, und rufen entsprechend die passende Funktion auf.
503 \@ifnextchar[\gmde@setVCColor@Opt%
504 \gmde@setVCColor@%
505 }%
506 % Nur, falls \pk{color} geladen wurde, macht der Farbumschalter
507 % etwas.
508 \def\gmde@setVCColor@#1{%
509 \def\gmde@visibleCommentColor{\@ifpackageloaded{color}{\color{#1}}{}}%
510 }%
511 \def\gmde@setVCColor@Opt[#1]#2{%
512 \def\gmde@visibleCommentColor{\@ifpackageloaded{color}{\color[#1]{#2}}}%
513 }%
514
515 % Der Default-Wert ist leer, also ohne Farbwechsel.
516 \let\gmde@visibleCommentColor\@empty
517
518 % Wir machen eine Sicherheitskopie der Original-Version
519 % von '\gmd@narrcheckifds'. Das ist ein Befehl, der nach
520 % einem '%' überprüft, ob das nächste Zeichen ein '<' ist,
521 % und dann eine Docstrip-Direktive setzt, andernfalls den
522 % normalen Erzählungs-Modus startet. Es gibt zwei Varianten
523 % davon, die mit '@ne' nimmt einen Parameter (der im
524 % "`Nicht-'<'-Fall"' ausgeführt wird), die andere nicht.
525 %
526 % Die beiden Makros werden aufgerufen, nachdem ein '%' am Anfang
527 % einer Zeile verarbeitet wurde - eines davon, wenn es vorher
528 % eine Code-Zeile gab, das andere nach einer Kommentarzeile.
529 \let\gmde@org@narrcheckifds = \gmd@narrcheckifds
530 \let\gmde@org@narrcheckifds@ne = \gmd@narrcheckifds@ne
531
532 % Eine neue Version von '\gmd@narrcheckifds'. Wir rufen einfach die Variante
533 % mit Parameter auf, wobei wir '\ignorespaces' übergeben. (Das ist beim
534 % Original ähnlich, allerdings dort einzeln analog implementiert.)
535 \def\gmde@narrcheckifds{%
536 \gmde@narrcheckifds@ne{\ignorespaces}%
537 }%
538 % Die ein-Parameter-Version.
539 \def\gmde@narrcheckifds@ne#1{%
540 \@ifnextchar\gmde@visibleCommentChar% Falls das nächste Zeichen
541 % unser Kommentarzeichen ist,
542 \gmde@deactivatedCode% setzen wir den Rest als deaktivierten Code.
543 {\gmde@org@narrcheckifds@ne{#1}}% Ansonsten rufen wir den
544 % Original-'<'-Test auf.
545 }%
546
547
548 % Das ist (zusammen mit dem nächsten Makro) der Kern von
549 % '\gmd@codstripdirective', den wir hier brauchen.
550 \def\gmde@deactivatedCode{%
551 \gmd@textEOL% Wir tun so, als wäre das eine neue Zeile.
552 \gmde@deactivatedcodePrefix% Das wird als erstes Token an '\gmd@textEOL'
553 % übergeben. Dadurch, dass es nur eines ist, wird es nicht als '%'
554 % erkannt, sondern (nachdem wieder in den Verbatim-Modus gewechselt wurde)
555 % ausgegeben.
556 }
557 %
558 % Was machen wir mit deaktiviertem Code (am Zeilenanfang)?
559 \def\gmde@deactivatedcodePrefix{%
560 \gmde@visibleCommentColor%
561 \code@delim% Zunächst geben wir ein '%'-Zeichen aus.
562 \@afternarrgfalse\@aftercodegtrue\@codeskipputgtrue% Diese boolean-Werte
563 % setzen wir, damit \TeX nachher weiß, wo es ist.
564 \@firstoftwo% Und jetzt entsorgen wir das zweite
565 % folgende Token -- das ist das '!'-Zeichen. Das erste ist wohl
566 % irgendein Makro, welches wichtige Dinge anstellt - wenn wir das
567 % auch entsorgen, hört die Code-Formatierung nicht am nächsten '%'
568 % auf. Keine Ahnung, was das ist.
569 }%
570
571 %
572 %
573 % Hier eine leicht geänderte Version von '\gmd@eatlspace'.
574 % ('%' und '!' bezeichnen im Kommentar nicht unbedingt das entsprechende
575 % Zeichen, sondern das, was gerade als Code-Delimiter bzw.
576 % Visible-Comment-Marker festgelegt wurde (mit '%' und '!'
577 % als Default.)
578 %
579 \def\gmde@eatlspace#1{%
580 \ifx\gmd@texcodespace#1% Wenn das nächste Zeichen ein Leerzeichen, so \dots
581 \advance\gmd@ldspaceswd by \gmd@spacewd% erhöhen wir die Einrückung,
582 % und \dots
583 \afteriffifi{\gmde@eatlspace}% \dots wiederholen das ganze.
584 \else%
585 \if\code@delim\@nx#1% Wenn das nächste Zeichen '%' ist \dots
586 \afterfifi{%
587 \@ifnextchar\gmde@visibleCommentChar{% \dots und das folgende Zeichen
588 % ein '!', dann haben wir es mit einem sichtbaren Kommentar zu tun.
589 \let\gmd@charbychar=\gmde@charbychar% Wir merken uns also, dass
590 % dessen Präfix gezeigt werden muss, \dots
591 \gmd@typesettexcode% \dots und rufen die normale Code-Formatierungs-Funktion auf, wobei das '!' dabei weggeworfen wird.
592 }{%
593 % Ist das folgende Zeichen kein '!', so geht jetzt der Kommentar
594 % der letzten Zeile weiter (das kann entweder ein inline-Kommentar oder ein
595 % normaler sein).
596 \gmd@ldspaceswd=\z@%
597 \gmd@continuenarration#1%
598 }%
599 }%
600 \else%
601 % Ist das nächste Zeichen weder ' ' noch '%', so fängt hier der
602 % Quelltext an.
603 \afterfifi{\gmd@typesettexcode#1}%
604 \fi%
605 \fi%
606 }%
607
608 % Noch eine Sicherheitskopie: '\gmd@charbychar' geht zeichenweise
609 % durch den Code durch, mit Sonderbehandlung für '%', '\', das
610 % Dateiende sowie ein Zeilenende.
611 \let\gmde@org@charbychar\gmd@charbychar%
612
613 % Unsere Variante davon, die gesetzt wird, wenn die Zeile
614 % mit einem '%!' beginnt,
615 \def\gmde@charbychar{%
616 \let\gmd@charbychar=\gmde@org@charbychar
617 \gmde@deactivatedcodePrefix
618 \gmd@charbychar%
619 }%
620
621 %
622 % \subsubsection{Etwas Test-Code}
623 %
624 %<*test>
625
626 bla
627 %<text>bedingter Text % mit Kommentar.
628 % mehr text % und Kommentar
629
630 % Komentar
631 %! das gleiche mit! % und Kommentar
632 %! das gleiche mit! % und Kommentar
633 %! das gleiche mit! % und Kommentar
634 %
635 % Kommentar.
636 %</test>
637
638
639 % \subsection{Weitere Makros}
640
641
642 \AtBeginDocument{\QueerCharOne}% \pk{inputenc} mit \pk{utf8x} definiert
643 % '^^A' um, so dass es Fehlermeldungen gibt. Also stellen wir die
644 % \pk{gmdoc}-Variante wieder her.
645
646
647
648 %
649 % Dieses Makro liest eine Datei im normalen \LaTeX-Modus ein, ohne komische
650 % EOL-Zeichen oder kaputte '%'.
651 \newcommand*{\normalInput}[1]{%
652 % Wir packen alles in eine Gruppe, dann ist das Wiederherstellen der
653 % Einstellungen nicht so schwer.
654 \begin{StraightEOL}%
655 \gmde@normalSpaces%
656 \catcode`\%=14%
657 \InputIfFileExists{#1}{}{}%
658 \end{StraightEOL}%
659 }%
660 %
661
662 %
663 % \subsection{Verbatim-docstrip-Modus}
664 %
665 % Es wurde wohl vergessen, diese Variable zu initialisieren.
666 \let\gmd@docstripshook\@empty%
667 %
668 %<*test>
669 % Hier ein Test dafür:
670 %<<verbatim-modus
671 Irgenwas hier
672 %! auskommentiert % wirklich!
673 Noch mehr Muell % Hört das hier auf?
674 %
675 %verbatim-modus
676 %
677 % Hmm, das alleine reicht aber noch nicht, denke ich. Eigentlich sollte
678 % jetzt alles (bis zum erneuten auftauchen des Textes, der zwischen '<<' und
679 % dem Zeilenende stand) wörtlich ausgegeben werden, ohne Formatierungen.
680 %
681 % Naja, das baue ich vielleicht in einer späteren Version ein.
682 %</test>
683
684 % \subsection{Optionen des Paketes}
685 %
686 % Die Optionen rufen einfach die passenden Deklarationen auf.
687 %
688 \DeclareOption{visible}{%
689 \setVisibleCommentColor{blue}%
690 \activateVisibleComments%
691 }%
692 %
693 \DeclareOption{inline}{%
694 \InlineCommentsWithPercent%
695 }%
696 % Jetzt veraarbeiten wir alle Optionen in der Reihenfolge, in
697 % der sie angegeben wurden. (Nicht, dass die Reihenfolge einen
698 % Unterschied machen sollte ...)
699 %
700 \ProcessOptions*\relax%
701 %
702 % Und damit sind wir fertig.
703 \endinput
704 %</package>
705 %
706 % \Finale
707 %\endinput
708
709
710 %%% Folgendes ist nur für meinen Editor.
711 %%%
712 %%% Local Variables:
713 %%% mode: latex
714 %%% TeX-master: t
715 %%% End: