Make the lstlistings inside a node work again

[AlMa1r]

Brief outline of the bug

Somewhere between the final TeX Live 2023 and the final TeX Live 2024, we can no longer place a program listing (the lstlisting environment) into a node. Discussion: https://tex.stackexchange.com/questions/751789/what-changed-between-the-final-texlive-2023-and-the-final-texlive-2024-concernin . LaTeX evolved, but TikZ (apparently and in this specific regard) did not. We kindly ask to restore the functionality (program listings inside nodes) without workarounds.

Minimal non-working example (MnWE)

\documentclass{article}% compile with latex or pdflatex from the final TeX Live 2024 or later
\usepackage{listings}
\usepackage{tikz}% 2023-01-15 v3.1.10 (3.1.10)
\begin{document}
\begin{tikzpicture}
\node {\begin{lstlisting}
\end{lstlisting}};
\end{tikzpicture}
\end{document}

Known workarounds (thx to @jlab, @cfr, and @ulrike-fischer)

\documentclass{article}
\usepackage{listings}
\usepackage{tikz}
\begin{document}
\begin{tikzpicture}
\node {\hbox{\begin{lstlisting}
\end{lstlisting}}};
\end{tikzpicture}
\end{document}

and

\documentclass{article}
\usepackage{listings}
\usepackage{tikz}
\begin{document}
\begin{tikzpicture}
\node {\begin{lstlisting}
\end{lstlisting}\par};
\end{tikzpicture}
\end{document}

and

\documentclass{article}
\usepackage{listings}
\usepackage{tikz}
\begin{document}
\begin{tikzpicture}
\node {\begin{lstlisting}
\end{lstlisting}

};
\end{tikzpicture}
\end{document}

and

\documentclass{article}
\usepackage{listings}
\usepackage{tikz}
\makeatletter
\AddToHook{env/lstlisting/after}{\@endpefalse}
\makeatother
\begin{document}
\begin{tikzpicture}
\node {\begin{lstlisting}
\end{lstlisting}};
\end{tikzpicture}
\end{document}

[hmenke]

I just tried with TeX Live 2025 and PGF 3.1.9a from May 15, 2021 and the error still occurs, so it's not PGF/TikZ that broke this.

[hmenke]

This is essentially a duplicate of #968.

Any lstlisting environment adds a call to \lst@doendpe in the end part¹ which expands \@doendpe -> \@endpetrue -> \aftergroup \propagate@doendpe and then \propagate@doendpe ends up on the path which TikZ finally chokes on.

This snippet makes it work (LaTeX only)

diff --git a/tex/generic/pgf/frontendlayer/tikz/tikz.code.tex b/tex/generic/pgf/frontendlayer/tikz/tikz.code.tex
index 8868d5d7..baab6c70 100644
--- a/tex/generic/pgf/frontendlayer/tikz/tikz.code.tex
+++ b/tex/generic/pgf/frontendlayer/tikz/tikz.code.tex
@@ -3918,7 +3918,10 @@
 \def\tikz@fig@collectresetcolor{%
   % Hacks for special packages that mess with \aftergroup
   \pgfutil@ifnextchar\reset@color% hack for color package
-  {\reset@color\afterassignment\tikz@fig@collectresetcolor\let\tikz@temp=}\tikz@fig@boxdone%
+    {\reset@color\afterassignment\tikz@fig@collectresetcolor\let\tikz@temp=}%
+    {\pgfutil@ifnextchar\propagate@doendpe% hack for \@doendpe
+      {\propagate@doendpe\afterassignment\tikz@fig@collectresetcolor\let\tikz@temp=}%
+      \tikz@fig@boxdone}%
 }%
 \def\tikz@fig@boxdone{%
             \tikz@atend@node%

Footnotes

1. https://svn.tug.org:8369/texlive/trunk/Master/texmf-dist/tex/latex/listings/listings.sty?revision=72361&view=markup#l2220 ↩

[muzimuzhi]

PS: The "culprit" \aftergroup\propagate@doendpe in \@endpetrue was added to LaTeX by

latex3/latex2e@5614e4cc8 (Tagging97 (new @endpe mechanism) (#1391), 2024-07-10)

Somewhere between the final TeX Live 2023 and the final TeX Live 2023

@AlMa1r Therefore the second "final TeX Live 2023" should be "2024". I've edit the content.

[AlMa1r]

@hmenke Though we suspect/know (depending on whom you ask) already that it was a change in LaTeX that triggered the error, thank you for confirming this. Whether you view it as breaking or an change in the interface, is up to you and the author of the changes (probably Frank Mittelbach). Anyway, if you believe that your snippet is fine, please feel free to push it (and add a dependency on the LaTeX version if necessary). Gratefully!

@muzimuzhi Thank you for finding the "culprit" and finding and repairing my typo!