path: root/Master/texmf-dist/doc/latex/pstool/pstool.tex

%% PSTOOL.TEX
%
% This work may be distributed and/or modified under the
% conditions of the LaTeX Project Public License, either
% version 1.3c or (at your option) any later version.
% The latest version of this license is in:
%   <http://www.latex-project.org/lppl.txt>
%
% This work has the LPPL maintenance status `maintained'.
%
% The Current Maintainer of this work is Will Robertson.


\makeatletter
\documentclass{ltxdoc}
\usepackage[rm,medium]{titlesec}

\usepackage{xcolor}
\usepackage[colorlinks,linktocpage]{hyperref}
\usepackage{expl3,l3regex}

\usepackage{enumitem}
\setlist{noitemsep}

\usepackage{tocloft,varwidth}
\setcounter{tocdepth}{1}
\def\tocwidthA{0.45}
\def\tocwidthB{0.45}
\def\cftpartfont{\scshape}
\def\cftsecfont{\small}
\cftbeforesecskip=0pt
\def\cftpartleader{}
\def\cftpartafterpnum{\cftparfillskip}
\def\cftsecleader{}
\def\cftsecafterpnum{\cftparfillskip}

\let\pkg\textsf
\def\pkgopt#1{\texttt{[#1]}}

\def\PDF{\textsc{pdf}}
\def\PS{\textsc{ps}}
\def\DVI{\textsc{dvi}}
\def\EPS{\textsc{eps}}

\usepackage{pstool}
\usepackage[T1]{fontenc}
\usepackage{microtype}
\usepackage{lmodern}
\usepackage[sc,osf]{mathpazo}
\linespread{1.1}
\frenchspacing

\def\partname{Part}

\GetFileInfo{pstool.sty}
\begin{document}
{\addtocontents{toc}{\protect\begin{varwidth}[t]{\tocwidthA\linewidth}}}

\title{The \pkg{pstool} package}
\author{
  \normalsize Concept by Zebb Prime\\
  \normalsize Package by Will Robertson\footnote{\texttt{wspr81@gmail.com}}}
\date{\fileversion\qquad\filedate}

\maketitle

\begin{abstract}
This package defines the \cmd\psfragfig\ user command for including \EPS\ files that use \pkg{psfrag} features in a pdf\/\LaTeX\ document. The command \cmd\pstool\ can be used to define other commands with similar behaviour.
\end{abstract}

\tableofcontents

\part{User documentation}

\section{Introduction}

While directly producing \PDF\ output with pdf\/\LaTeX\ is a great improvement in many ways over the `old method' of \DVI$\to$\PS$\to$\PDF, it loses the ability to interface with a generic PostScript workflow, used to great effect in numerous packages, most notably \pkg{PSTricks} and \pkg{psfrag}.

Until now, the best way to use these packages while running pdf\/\LaTeX\ has been to use the \pkg{pst-pdf} package, which processes the entire document through a filter, sending the relevant PostScript environments (only) through a single pass of \LaTeX\ producing \DVI$\to$\PS$\to$\PDF. The resulting \PDF\ versions of each graphic are then included into the pdf\/\LaTeX\ document in a subsequent compilation. The \pkg{auto-pst-pdf} package provides a wrapper to perform all of this automatically.

The disadvantage with this method is that for every document compilation, \emph{every} graphic must be re-processed. The \pkg{pstool} package uses a different approach to allow each graphic to be processed only as needed, speeding up and simplifying the typesetting of the main document.

At present this package is designed solely as a replacement for \pkg{pst-pdf} in the r\^ole of supporting the \pkg{psfrag} package (which it loads) in pdf\/\LaTeX. 

More flexible usage to provide a complete replacement for \pkg{pst-pdf} (e.g., supporting the \cs{begin\{postscript\}} environment) is not planned at this stage.
If you simply need to automatically convert plain \EPS\ files to \PDF, I recommend using the \pkg{epstopdf} package with the \pkgopt{update,prepend} package options (\pkg{epstopdf} and \pkg{pstool} are compatible, but \textbf{only} if \pkg{epstopdf} is loaded first).

\section{Getting started}

Processing pdf\/\LaTeX\ documents with \pkg{pstool} requires the `shell escape' feature of pdf\/\TeX\ to be activated.
This allows execution of auxiliary commands from within \LaTeX, a feature which is often disabled by default for security reasons.
If shell escape is not enabled, a warning will be issued in console output when the package is loaded.
Depending how you compile your \LaTeX\ document, shell escape is enabled in different ways.%
\footnote{On the command line, use the \texttt{-shell-escape} switch. Otherwise, you're on your own.}

Load the package as usual; no package options are required by default, but there are a few useful options described later in section~\ref{pkgopt}.
Note that you do not need to load \pkg{psfrag} separately.
You also do not need to load \pkg{graphicx} separately, but if you do so, ensure that you do \emph{not} include driver information (such as |[pdftex]|); this will play havoc with \pkg{pstool}'s automatic processing stage.

\section{User commands}

The low-level generic command provided by this package is
\begin{description}
  \item[\cmd\pstool\ \meta{suffix} \oarg{options} \marg{filename} \marg{input definitions}]
\end{description}
It converts the graphic \meta{filename}|.eps| to \meta{filename}|.pdf| with \pkg{psfrag} macros in \meta{filename}|.tex| through a unique \DVI$\to$\PS$\to$\PDF\ process for each graphic, using the preamble of the main document.
The resulting graphic is then inserted into the document, with \meta{options} consisting of options for \pkg{graphicx} (e.g., \texttt{angle}, \texttt{scale}) or for \pkg{pstool} (as described later in Section~\ref{pkgopt}).
Note that these optional arguments take effect in the \emph{processing stage}; if you change the \meta{options}, you must manually re-process the figure.
The third argument to \cmd\pstool\ allows arbitrary \meta{input definitions} (such as \cmd\psfrag\ directives) to be inserted before the figure as it is processed.

By default, \cs{pstool} processes the graphic \meta{filename}|.eps| if \meta{filename}|.pdf| does not already exist, or if the \EPS\ file is \emph{newer} than the \PDF.
Additionally, if one or more macro files are associated with the graphic, they are also checked whether they have changed since the \PDF\ was generated.
The macro file(s) can be defined per-graphic as for the \cs{psfragfig} command (see below), and/or globally as for the \pkgopt{macro-file=...} package option described in Section~\ref{macrofile}.

The \cmd\pstool\ command can take an optional |*| or |!| suffix to change its behaviour:
\begin{description}
\item[\cs{pstool*}] Always process the figure;
\item[\cs{pstool!}] Never process the figure.
\end{description}
The behaviour in all three cases can be overridden globally by the package option \pkgopt{process} as described in section~\ref{process}.

\subsection{The main \cs{psfragfig} command}

It is useful to define higher-level commands based on \cmd\pstool\ for including specific types of \EPS\ graphics that take advantage of \pkg{psfrag}. The \pkg{pstool} package defines the following wrapper command \cmd\psfragfig, which also supports the |*| or |!| suffixes described above.
\begin{description}
\item[{\cmd\psfragfig\ \meta{suffix} \oarg{opts} \marg{filename}}] 
\end{description}
This catch-all macro is designed to support a wide range of graphics naming schemes. It inserts an \EPS\ file named either \meta{filename}|-psfrag.eps| or \meta{filename}|.eps| (in that order of preference), and uses \pkg{psfrag} definitions contained within either \meta{filename}|-psfrag.tex| or \meta{filename}|.tex|. 
The \cs{psfragfig} command can be used to insert figures produced by the \textsc{Mathematica} package \pkg{MathPSfrag} or the \textsc{Matlab} package \pkg{matlabfrag}. \cmd\psfragfig\ also accepts an optional braced argument:
\begin{description}
\item[{\cmd\psfragfig~\meta{suffix} \oarg{opts} \marg{filename} \marg{input definitions}}] 
\end{description}
The command behaves as above, but also inserts the arbitrary code \meta{input definitions} into the processing stage; this additional code will usually be used to define new or override existing \pkg{psfrag} commands.

\section{Package options}
\label{pkgopt}

Package options can be set or overridden at any time with \cmd\pstoolsetup\marg{pstool settings}.
As mentioned in the previous section, these options also may be set in the optional argument to \cmd\pstool\ and \cmd\psfragfig, in which case they apply to that figure alone.

\subsection{Macro file(s)}
\label{macrofile}

As mentioned above, macro files can be used to store commands for processing \pkg{psfrag} graphics.
If they change, these macro files can trigger a pre-compilation of the graphics.
While usually the macro files will be defined per-graphic (such as \texttt{foo.eps} having a \texttt{foo-psfrag.tex} file), \pkg{pstool} will also load a `master' macro file for each graphic if it exists using the \pkgopt{macro-file=...} option.

The default is \pkgopt{macro-file=\meta{jobname}\texttt{-pstool.tex}}; if this file does not exist then no macro file is loaded.
That is, if your document is called \texttt{thesis.tex}, the master macro file will be loaded in each graphic as \texttt{thesis-pstool.tex}, if it exists.

This option is useful if you have macro definitions in a single file that are used by multiple graphics.
By updating the definitions file, the graphics in the document will be automatically updated.
(Note that this file can contain plain \LaTeX\ defintions; the \cs{psfrag} commands can still be located in the per-graphic \texttt{.tex} files.)

To suppress the loading of a master macro file in all cases, use an empty argument for the package option, as in \pkgopt{macro-file=\char`\{\char`\}}.


\subsection{Forcing/disabling graphics processing}
\label{process}

While the suffixes |*| and |!| can be used to force or disable (respectively) the processing of each individual graphic, sometimes we want to do this on a global level. The following package options override \emph{all} \pkg{pstool}  macros: 
\begin{description}
\item[\pkgopt{process=auto}] This is the default mode as described in the previous section, in which graphics without suffixes are only (re-)processed if the \EPS\ file is newer or the \PDF\ file does not exist;
\item[\pkgopt{process=all}] Suffixes are ignored and all \cmd\pstool\ graphics are processed;
\item[\pkgopt{process=none}] Suffixes are ignored and no \cmd\pstool\ graphics are processed.\footnote{If \pkg{pstool} is loaded in a \LaTeX\ document in \DVI\ mode, this is the option that is used since no external processing is required for these graphics.}
\end{description}


\subsection{Cropping graphics}
The default option \pkgopt{crop=preview} selects the \pkg{preview} package to crop graphics to the appropriate size for each auxiliary process.

However, when an inserted label protrudes from the natural bounding box of the figure, or when the original bounding box of the figure is wrong, the \pkg{preview} package will not always produce a good result (with parts of the graphic trimmed off the edge). A robust method to solve this problem is to use the \pkg{pdfcrop} program instead.%
\footnote{\pkg{pdfcrop} requires a Perl installation under Windows, freely available from \url{http://www.activestate.com/Products/activeperl/index.plex}} This can be activated in \pkg{pstool} with the \pkgopt{crop=pdfcrop} package option. 

\subsection{Temporary files \& cleanup}
Each figure that is processed spawns an auxiliary \LaTeX\ compilation through \DVI$\to$\PS$\to$\PDF. This process is named after the name of the figure with an appended string suffix; the default is \pkgopt{suffix=\{-pstool\}}. Most of these suffixed files are ``temporary'' in that they may be deleted once they are no longer needed.

As an example, if the figure is called |ex.eps|, the files that are created are |ex-pstool.tex|, |ex-pstool.dvi|, \dots. The \pkgopt{cleanup} package option declares via a list of filename suffixes which temporary files are to be deleted after processing.

The default is \pkgopt{cleanup=\{.tex,\,.dvi,\,.ps,\,.pdf,\,.log\}}. To delete none of the temporary files, choose \pkgopt{cleanup=\{\}} (useful for debugging).
Note that if you want cross-referencing to work correctly for labels in figures, etc., then you must not delete the |.aux| file (see Section~\ref{xref}).


\subsection{Interaction mode of the auxiliary processes}
Each graphic echoes the output of its auxiliary process to the console window; unless you are trying to debug errors there is little interest in seeing this information. The behaviour of these auxiliary processes are governed globally by the \pkgopt{mode} package option, which takes the following parameters:
\begin{description}
\item[\pkgopt{mode=batch}] hide almost all of the \LaTeX\ output (\emph{default});
\item[\pkgopt{mode=nonstop}] echo all \LaTeX\ output but continues right past any errors; and 
\item[\pkgopt{mode=errorstop}] prompt for user input when errors are encountered.
\end{description}
These three package options correspond to the \LaTeX\ command line options \texttt{-interaction=batchmode}, \texttt{=nonstopmode}, and \texttt{=errorstopmode}, respectively. When \pkgopt{mode=batch} is activated, then \pkg{dvips} is also run in `quiet mode'.


\subsection{Auxiliary processing command line options}
The command line options passed to each program of the auxiliary processing can be changed with the following package options:
\begin{description}
\item[\pkgopt{latex-options~~~= ...}]
\item[\pkgopt{dvips-options~~~= ...}]
\item[\pkgopt{ps2pdf-options~~= ...}] and,
\item[\pkgopt{pdfcrop-options~= ...}] (if applicable).
\end{description}
For the most part these will be unnecessary, although passing the correct options to |ps2pdf| can sometimes be a little obscure.\footnote{The manual is here: \url{http://pages.cs.wisc.edu/~ghost/doc/cvs/Ps2pdf.htm}} For example, I used the following for generating figures in my thesis:%
\par{\centering|ps2pdf-options={-dPDFSETTINGS=/prepress}|\par}
This forces the `base fourteen' fonts to be embedded within the individual figure files, without which some printers and \textsc{pdf} viewers have trouble with the textual labels. In fact, from v1.3 of \pkg{pstool}, this option is now the default.
Note that subsequent calls to \pkgopt{ps2pdf-options=...} will override the \pkg{pstool} default; use |ps2pdf-options={}| to erase |ps2pdf|'s defaults if necessary.

At some point in the past, the behaviour of |ps2pdf| has changed under Windows.
Previously, options to |ps2pdf| needed to be quoted and use |=| to assign its options.
Something about this changed, and it appears the best way to set |ps2pdf| options to use the |#| character instead. Therefore, \pkg{pstool} attempts to be clever and replaces all instances of |=| within a |ps2pdf| option into |#| (under Windows only).
No quotes are added.
Windows uses can therefore continue to use |=| to set |ps2pdf| options and allow \pkg{pstool} to make the substitution; their documents will still compile correctly on macOS or Linux platforms.


\subsection{Compression of bitmap data}
In the conversion using |ps2pdf|, bitmap images are stored using either lossy or lossless compression. The default behaviour for \pkg{pstool} is to force lossless compression, because we believe that to be the most commonly desired use case (you don't want scientific graphics rendered with possible compression artifacts). This behaviour can be adjusted using one of these options:\footnote{Technical details are given in section~\ref{sec:bitmapdetails}.}
\begin{description}
\item[\pkgopt{bitmap=auto}] :~ Do whatever |ps2pdf| does by default, which seems to be to use lossy compression most, if not all, of the time;
\item[\pkgopt{bitmap=lossy}]:~ Bitmap images are compressed like \textsc{jpg}; this is only really suitable for photographs;
\item[\pkgopt{bitmap=lossless}] (\emph{default}) : Bitmap images are compressed like \textsc{png}; this is suitable for screenshots and generated data such as a surface plot within Matlab.
\end{description}
These are just special cases of the \pkgopt{ps2pdf-options=...} option, but using \pkgopt{bitmap=...} is much more convenient since the |ps2pdf| options to effect this behaviour are quite verbose.
Note that the |auto| and |lossy| outputs differ in quality; |lossy| is lower quality than |auto| even when the latter uses a lossy compression scheme. Adjusting the quality for these options is only possible with relatively complex Ghostscript options.


\subsection{Cross-referencing}
To allow graphics that relied on cross-referencing of equation numbers, bibliographic citations, and so on, \pkg{pstool} attempts to transfer data to and from the |.aux| file for each processed graphic. See Section~\ref{xref} for more details.
This feature can be disabled for compatibility or performance reasons using the \pkgopt{crossref=false} option.
(Its converse, \pkgopt{crossref=true}, is the default in case you wish to set it explicitly.)

Enabling or disabling the cross-referencing feature can only be performed in the preamble of the document.

\section{Miscellaneous details}

\subsection{Conditional preamble or setup commands}

It can be necessary to use a slightly different preamble for the main document compared to the auxiliary file used to process each graphic individually.
To have preamble material be directed at only one or the other, use the \cs{ifpdf} command (automatically loaded from the \pkg{ifpdf} package) as follows:
\begin{list}{}\item{}
|  \ifpdf|\\
|    %| \emph{main preamble only}\\
|  \else|\\
|    %| \emph{graphics preamble only}\\
|  \fi|
\end{list}
For example, when using \pkg{beamer} and showing navigation symbols on each slide, you want to suppress these in the \pkg{pstool}-generated graphics (else they'll show up twice!).
In this case, the preamble snippet would look something like:
\begin{list}{}\item{}
|  \ifpdf\else|\\
|    \setbeamertemplate{navigation symbols}{}|\\
|  \fi|
\end{list}
It would be possible to provide specific \pkg{pstool} commands or environments to do this; let me know if the \cs{ifpdf} approach doesn't work for you.
For larger amount of preamble material that should be omitted for each graphic, the \cmd{\EndPreamble} command (see next) might also help.

\subsection{The \cmd\EndPreamble\ command}

The \pkg{pstool} package scans the beginning of the main document to insert its preamble into each graphic that is converted.
This feature hasn't been well-tested and there are certain cases in which it is known to fail.
(For example, if \verb|\begin{document}| doesn't appear on a line by itself.)
If you need to indicate the end of the preamble manually because this scanning has failed, place the command \cmd\EndPreamble\ where-ever you'd like the preamble in the auxiliary processing to end.
This is also handy to bypass anything in the preamble that will never be required for the figures but which will slow down or otherwise conflict with the auxiliary processing.

\subsection{Cross-referencing}
\label{xref}

\pkg{pstool} supports cross-referencing within graphics.
That is, you can use |\ref| and |\cite|, etc., within \pkg{psfrag} commands.
In fact, references to page numbers within an external figure should now resolve correctly; e.g., you can use |\thepage| within a \pkg{psfrag} command.
(I haven't really tested, but this should allow any package that writes information to the |.aux| file to work correctly.)

The implementation to achieve this is somewhat convoluted and difficult to extend, but the user interface should work just as you would expect, mostly.
The main gotcha to keep in mind is that when cross-referencing is used, the graphics will need multiple compilations to resolve all the cross-references properly.
Therefore, I recommend when setting such figures up in your document to use the |\psfragfig*| command, which forces graphics compilation every time, and remove the star only when you're sure the graphic is now correct.
Alternatively, don't worry about the resolving of the cross-references until the very end, and then load the package with the \pkgopt{process=all} option.

As the code for processing data through the |.aux| file can have unwanted interactions with other packages,
or just be a little slower, you can disable the cross-referencing feature by loading \pkg{pstool} with the \pkgopt{crossref=false} package option.

\subsection{A note on file paths}

The \pkg{pstool} package tries to ensure that you can put image files in subdirectories of the main document and the auxiliary processing will still function correctly. In order to ensure this,  the external |pdflatex| compilation uses the |-output-directory| feature of pdf\/\TeX. This command line option is definitely supported on all platforms from TeX~Live~2008 and MiKTeX~2.7 onwards, but earlier distributions may not be supported.

One problem that \pkg{pstool} does not solve on its own is the inclusion of images that do not exist in subdirectories of the main document. For example, |\pstool{../Figures/myfig}| can not process by default because pdf\/\TeX\ usually does not have permission to write into folders that are higher in the heirarchy than the main document. This can be worked around presently in two different ways: (although maybe only for Mac~OS~X and Linux)
\begin{enumerate}
\item Give |pdflatex| permission to write anywhere with the command:\\
|openout_any=a pdflatex ...|
\item Create a symbolic link in the working directory to a point higher in the path: |ln -s ../../PhD ./PhD|, for example, and then refer to the graphics through this symbolic link.
\end{enumerate}

\subsection{Technical details on \texttt{ps2pdf}'s bitmap options}
\label{sec:bitmapdetails}

The \pkgopt{bitmap=auto} \pkg{pstool} option does not set any |ps2pdf| options; use this if you wish to set the following |ps2pdf| options manually.

For both \pkgopt{bitmap=lossless} (default) and \pkgopt{bitmap=lossy}, the following |ps2pdf| options are set:
\begin{verbatim}
    -dAutoFilterColorImages=false
    -dAutoFilterGrayImages=false
\end{verbatim}
Then for lossless image encoding, the following options are set:
\begin{verbatim}
    -dColorImageFilter=/FlateEncode
    -dGrayImageFilter=/FlateEncode
\end{verbatim}
Instead for lossly encoding, these are the options used:
\begin{verbatim}
    -dColorImageFilter=/DCTEncode
    -dGrayImageFilter=/DCTEncode
\end{verbatim}
If there are more |ps2pdf| options that you frequently use, please let me know and it may be a good idea to add \pkg{pstool} wrappers to make them more convenient.

{\addtocontents{toc}{\protect\end{varwidth}\protect\hfill}}
{\addtocontents{toc}{\protect\begin{varwidth}[t]{\protect\tocwidthB\protect\linewidth}}}
\clearpage
\part{Implementation}

\section{Package information}
The most recent publicly released version of \pkg{pstool} is available at \textsc{ctan}: \url{http://tug.ctan.org/pkg/pstool/}. Historical and developmental versions are available at GitHub: \url{http://github.com/wspr/pstool/}. While general feedback via email is welcomed, specific bugs or feature requests should be reported through the issue tracker: \url{http://github.com/wspr/pstool/issues}.

\subsection{Licence}

This package is freely modifiable and distributable under the terms and conditions of the \LaTeX\ Project Public Licence, version 1.3c or greater (your choice).\footnote{\url{http://www.latex-project.org/lppl.txt}} This work consists of the files |pstool.tex| and the derived files |pstool.sty|, |pstool.ins|, and |pstool.pdf|. This work is maintained by \textsc{Will Robertson}.

\section{Code}

Note that the following code is typeset in a non-verbatim manner; indentation is controlled automatically by some hastily written macros (and will sometimes not indent as might be done manually). When in doubt, consult the source directly!

\parindent=0pt


\ExplSyntaxOn

\ior_new:N \pprint_doc_ior
\seq_new:N \l_pprint_line_seq
\tl_new:N \l_pprint_tl

\int_new:N \g_pprint_indent_int
\int_new:N \l_pprint_line_indent_int
\dim_new:N \l_pprint_dim

\errorcontextlines=999

\tl_set:Nx \g_pprint_comment_tl { \cs_to_str:N \% }
\definecolor{commentstrcolor}{rgb}{0,0.7,0}
\definecolor{numberscolor}{gray}{0.6}

\def\linecommentstyle{%
  \sffamily
  \color{commentstrcolor}%
}

\cs_new:Nn \pprint_scan_setup:
 {
  \char_set_catcode_space:N \ 
%    \char_set_catcode_other:N \\
%    \char_set_catcode_space:N \ % space
%    \char_set_catcode_letter:N \#
%    \char_set_catcode_letter:N \$
%    \char_set_catcode_letter:N \^
%    \char_set_catcode_letter:N \_
%    \char_set_catcode_letter:N \& 
 }

%%%%

\cs_new:Npn \PrettyPrint #1
 {
\int_new:N \g_pprint_docline_int
\ior_open:Nn \pprint_doc_ior {#1}

\cs_generate_variant:Nn \tl_if_eq:nnTF {x}

\cs_set_eq:NN \___tl_trim_spaces:n \tl_trim_spaces:n
\ior_str_map_inline:Nn \pprint_doc_ior
 {
  \int_gincr:N \g_pprint_docline_int

  % avoid space trimming inside \seq_set_split:n following:
  % (MAJOR SIDE-EFFECTS OF COURSE)
  \cs_set_eq:NN \tl_trim_spaces:n \use:n
  \exp_args:NNo \seq_set_split:Nnn \l_pprint_line_seq \g_pprint_comment_tl {##1}
  \cs_set_eq:NN \tl_trim_spaces:n \___tl_trim_spaces:n
  
  \seq_pop_left:NNT \l_pprint_line_seq \l_pprint_tl
   {
    \tl_if_empty:NTF \l_pprint_tl
     {
       \pprint_doc_line_comment:
     }
     {
       \pprint_doc_line_code: 
     }
   }
 }
 }

\cs_generate_variant:Nn \tl_if_eq:nnTF {o}
\cs_new:Nn \pprint_doc_line_comment:
 {
  \seq_pop_left:NNTF \l_pprint_line_seq \l_pprint_tl
   % Comment on a line of its own:
   {
    \seq_put_right:No \l_pprint_codelines_seq \l_pprint_tl
   }
   % A completely empty line:
   {
    \pprint_flush_codelines:
    \vspace{\baselineskip}
   }
 }

\cs_new:Nn \pprint_rescan_comment:n
 {
  \exp_args:Nno \tl_rescan:nn
   {
    \pprint_scan_setup:
   }
   { #1 }
 }

\cs_new:Nn \pprint_typeset_startcomment:
 {
  \group_begin:
    \bfseries
    \g_pprint_comment_tl
  \group_end:
 }

\cs_generate_variant:Nn \regex_extract_once:nnNTF {no}
\cs_generate_variant:Nn \tl_if_in:nnT {xx}
\seq_new:N \l_tmp_seq

\seq_new:N \l_pprint_codelines_seq

\int_new:N \g_pprint_brace_int
\cs_new:Nn \pprint_lbrace:
 {
  \peek_meaning_remove:NTF \pprint_rbrace:
   { \char`\{\char`\} }
   {
    \int_gincr:N \g_pprint_brace_int
    \char`\{\pprint_brace_sub:
   }
 }
\cs_new:Nn \pprint_rbrace:
 {
  \pprint_brace_sub:\char`\}
  \int_gdecr:N \g_pprint_brace_int
 }
\cs_new:Nn \pprint_brace_sub:
 {
  {${}\sb{\sb{ \color{red}\mathbf{\int_use:N \g_pprint_brace_int} }}$}
 }


\cs_new:Nn \pprint_doc_line_code:
 {
  \pprint_flush_codelines:

  \makebox[2em][l]{\tiny\color{numberscolor}\int_use:N \g_pprint_docline_int}
  \exp_args:NNx \tl_replace_all:Nnn \l_pprint_tl { \cs_to_str:N \{ } { \pprint_lbrace: }
  \exp_args:NNx \tl_replace_all:Nnn \l_pprint_tl { \cs_to_str:N \} } { \pprint_rbrace: }
  \makebox{\texttt{\l_pprint_tl}}
  
  \seq_pop_left:NNT \l_pprint_line_seq \l_pprint_tl
   {
    \makebox
     {%
      \linecommentstyle
      \pprint_typeset_startcomment:\space
      \pprint_rescan_comment:n { \l_pprint_tl }
     }
   }
  \par
 }

\cs_new:Nn \pprint_flush_codelines:
 {
  \seq_if_empty:NF \l_pprint_codelines_seq
   {
    \medskip
    \seq_map_inline:Nn \l_pprint_codelines_seq
     {
      \pprint_rescan_comment:n {##1}
      \space   
     }
    \seq_clear:N \l_pprint_codelines_seq
    \smallskip
    \par
   }
 }

\ExplSyntaxOff

\PrettyPrint {pstool.sty}


{\addtocontents{toc}{\protect\end{varwidth}}}
\end{document}