Wofür verwendet man \romannumeral-Expansion?

Question

Immer wieder stößt man auf den „\romannumeral-Trick“: man nützt die Tatsache aus, dass \romannumeral auf der Suche nach einer Zahl alles expandiert, bis es auf einen nicht-expandierbaren Token stößt, aber selbst zu nichts expandiert, wenn die sich ergebende Zahl negativ ist:

\documentclass{article}
\begin{document}
\def\a{\b}\def\b{\c}\def\c{\d}\def\d{1}
\expandafter\show\romannumeral-`\0\a
\end{document}

zeigt im Log:

> the character 1.
<recently read> 1

l.4 \expandafter\show\romannumeral-`\0\a

Das funktioniert, weil \romannumeral nach -`\0 -- obwohl eigentlich eine komplette Zahl -- weiter nach einem Leerzeichen schaut. (Diese Art der Expansion heißt bei expl3 (der LaTeX3-Programmierumgebung) f-type-Expansion.)

Soweit so gut. Was mir allerdings nicht klar ist: wozu oder wann braucht man diese Art der Expansion? Was sind praktische Beispiele, wo sie eingesetzt wird oder sogar eingesetzt werden muss? (Es scheint ja eine Art „expandierbarer Expansion“ zu sein?)

Accepted Answer

2

Versuch einer Eigenantwort nach verschiedenen Recherchen (und inzwischen auch eigener Anwendung)...

Grundsätzlich scheint es für die \romannumeral-Expansion (oder f-Expansion) drei Einsätze zu geben:

Entfernen von führenden Leerzeichen.
Volles Expandieren (von links) auf expandierbare Art, d.h., in einem \edef o.ä. anwendbar. Auch von Nutzen, wenn man nicht weiß, wie viele Expansionen bötigt werden und wie lang eine expandafter-Kette sein müsste.
Bilden einer Schleife.

Punkte 2. und 3. scheinen häufiger eingesetzt zu werden als der erste Punkt.

Für Punkt 1. habe ich quasi keine Hinweise gefunden, dass es tatsächlich in der Praxis angewendet wird, abgesehen von dem einen oder anderen Post von Heiko Oberdiek auf TeX.sx. Das Prinzip ist einfach (hier steht · für eine beliebige Anzahl Leerzeichen):

Open in writeLaTeX

\romannumeral·<num>·\relax

und

Open in writeLaTeX

\romannumeral<num>\relax

sind äquivalent: nach Befehlssequenzen werden Leerzeichen sowieso ignoriert und das Leerzeichen nach <num> (mehrere Leerzeichen verhalten sich wie eines) wird von \romannumeral (wie auch von anderen TeX Primitiven, die nach Zahlen suchen) verwendet, um das Ende der Zahl festzustellen, und dann weggeworfen.

Beispiel:

Open in writeLaTeX

\documentclass{article}
\begin{document}
\makeatletter
\long\def\trim@left#1{\romannumeral-`\q#1}
\def\foo{      foo }

!\trim@left{\foo}!
\end{document}

Punkt 2. scheint öfter verwendet zu werden, um expandierbar Makros zu expandieren. Wenn man z.B. aufmerksam auf TeX.sx sucht, findet man dafür immer wieder Beispiele. Auch in Paketen wird es angewendet, etwa dem trimspaces-Paket. Im wesentlichen definiert es einen Befehl \trim@spaces wie folgt:

Open in writeLaTeX

\catcode`\Q=3
\newcommand\trim@spaces[1]{%
  \romannumeral-`\q\trim@trim@\noexpand#1Q Q%
}
\long\def\trim@trim@#1 Q{\trim@trim@@#1Q}
\long\def\trim@trim@@#1Q#2{#1}
\catcode`\Q=11

\romannumeral expandiert von links, d.h., wie wenn man eine genügende Menge \expandafters verwendet hätte. Es wird also zunächst \trim@trim@ expandiert, was rechts die Leerzeichen entfernt, dann wird \trim@trim@@ expandiert, was das zweite Q₃ entfernt, dann wird \noexpand expandiert, was schließlich linke Leerzeichen entfernt, da sie hinter \noexpand ignoriert werden¹. Da es reicht, \romannumeral zu expandieren, um den gesamten Mechanismus zu starten und zu Ende zu bringen, kann das Paket nun zum Beispiel recht einfach einen Befehl definieren, das die Leerzeichen entfernt, den Rest aber unexpandiert zurücklässt:

Open in writeLaTeX

\newcommand\trim@spaces@noexp[1]{%
  \unexpanded\expandafter\expandafter\expandafter{\trim@spaces{#1}}%
}

Punkt 3. wird zum Beispiel in den \xx_case: Funktionen von expl3 ausgenützt, Joseph Wright hat das hier ganz gut erklärt. Auch das Paket multiexpand nützt die gleiche Methode. Hier wird ausgenützt, dass \romannumeral auf der Suche nach einer Zahl und folgendem Leerzeichen weiterexpandiert, aber aufhört, wenn es das gefunden hat. Hier wird eine 0 mit folgendem Leerzeichen gefüttert, um aus der Schleife auszubrechen. Im folgenden Beispiel (der Definition von \MultiExpand aus eben genanntem Paket) macht das das Makro \ME@endroman. Gleichzeitig braucht der schleifende Befehl (kann man das so sagen?) selbst nur eine Expansion! Im Beispiel unten bedeutet das, dass zweifache Expansion von \MultiExpand (damit \romannumeral getriggert wird) die achtfache (!) Expansion von \a liefert:

Open in writeLaTeX

\documentclass{article}
\begin{document}
\makeatletter
\def\ME@use#1{#1}%
\def\MultiExpand{\romannumeral\multiexpand}%
\edef\ME@endroman#1{0\noexpand\expandafter\space}%
\long\def\multiexpand#1{%
  \ifnum#1<2
    \expandafter\ME@endroman
  \else
    \expandafter\ME@use
  \fi
  {%
    \expandafter\multiexpand
    \expandafter{\number\numexpr#1-1\expandafter}%
  }%
}%

\def\a{\b}
\def\b{\c}
\def\c{\d}
\def\d{\e}
\def\e{\f}
\def\f{\g}
\def\g{\h}
\def\h{\i}
\def\i{\j}
\def\j{k}

\expandafter\expandafter\expandafter\def
\expandafter\expandafter\expandafter\x
\expandafter\expandafter\expandafter{\MultiExpand{8}\a}
\show\x % ->\i .

\end{document}

Ich selber habe mir inzwischen angewöhnt, sie für Punkt 2., die expandierbare Expansion, einzusetzen.

Ich hoffe, diese Analyse ist korrekt. Auch hier bitte ich um eventuelle Berichtigung.

Permanenter link

beantwortet 04 Aug '13, 20:30

cgnieder
22.1k●25●34●63
Akzeptiert-Rate: 60%

bearbeitet 17 Mai '14, 18:40

Wofür verwendet man \romannumeral-Expansion?

Folgen dieser Frage

verwandte Fragen