Я пытаюсь придумать способ сделать макрос, в котором я показываю вывод команды, а затем показываю команду через lstinlineкоманду. Я читал, что мне нужно экранировать специальные символы (вроде {и }), и теперь мне интересно, есть ли способ сделать это автоматически. Не уверен, возможно ли это вообще.
В идеале \commandExample{\qty{1.2}{\meter}}команда должна выдаватьOutput:1.2 m - Code:\qty{1.2}{\meter}
МВЭ:
\documentclass{report}
\usepackage{graphicx}
\usepackage{xcolor}
\usepackage{siunitx}
\usepackage{listings}
\definecolor{lightgrey}{rgb}{0.9,0.9,0.9}
\definecolor{darkgreen}{rgb}{0,0.6,0}
\lstset{language=[LaTeX]TeX,
caption = {Missing Caption}
,label = {lst:missingLabel}
,basicstyle = \footnotesize\ttfamily %\footnotesize % \small\ttfamily
,frame = shadowbox%
,numbers = left%
,breaklines = true%
,keywordstyle = \color{darkgreen}%
,commentstyle = \color{red}%
,tabsize = 2%
,backgroundcolor = \color{lightgrey}%
%,texcsstyle = {*\bf\color{blue}}%
%,otherkeywords = $, \{, \}, \[, \]%
,morekeywords = {includegraphics }%
,moretexcs = {graphicspath}%
}
\NewDocumentCommand{\commandExample}{m}{%
Output:#1 - Code:\lstinline{#1}}
\begin{document}
\commandExample{begin}.
\unit{\meter}
%\commandExample{\unit{\meter}} % This line causes it to crash
\end{document}
решение1
Я бы дословно воспринял аргумент и использовал бы \tl_rescan:nnего для набора.
\documentclass{report}
\usepackage{graphicx}
\usepackage{xcolor}
\usepackage{siunitx}
\usepackage{listings}
\definecolor{lightgrey}{rgb}{0.9,0.9,0.9}
\definecolor{darkgreen}{rgb}{0,0.6,0}
\lstset{language=[LaTeX]TeX,
caption = {Missing Caption}
,label = {lst:missingLabel}
,basicstyle = \footnotesize\ttfamily
,frame = shadowbox
,numbers = left
,breaklines = true
,keywordstyle = \color{darkgreen}
,commentstyle = \color{red}
,tabsize = 2
,backgroundcolor = \color{lightgrey}
,texcsstyle = {*\bfseries\color{blue}}
%,otherkeywords = {$, \{, \}, \[, \]}
,morekeywords = {includegraphics,unit}
,moretexcs = {graphicspath}%
}
\ExplSyntaxOn
\NewDocumentCommand{\commandExample}{v}
{
Output:~\tl_rescan:nn {} {#1} ~ - ~ Code:~\lstinline{#1}
}
\ExplSyntaxOff
\begin{document}
\commandExample{\unit{\meter}}
\commandExample{\textit{word}}
\end{document}
решение2
В целомкод предоставленный egregпредпочтительнее моего кода.
Однако механизм mathescape, который должен быть включен через \mathescape=true, \lstsetи который позволяет перейти в математический режим внутри аргумента \lstinlineпосредством вложения элементов между $...$, нарушается при \lstinlineнепосредственном применении к аргументу v-типа.
При включенном mathescape команда \lstinline{$x^2+y^2=2^2$}выдает множество сообщений об ошибках шаблона ! Undefined control sequence. \lst@arg ->$xв случае, если $x^2+y^2=2^2$он был токенизирован как аргумент v-типа.
Так что если в реальной жизни вам не нужна функция Mathescape, я рекомендую использовать код Egreg.
Если в реальном сценарии вам действительно нужна функция mathescape, либо измените ответ egreg так, чтобы \commandExampleон считывал и токенизировал свой аргумент в соответствующем режиме кода категории, либо попробуйте подход, при котором \scantokensили \tl_rescan:nnприменяется \lstinlineтакже к переданным токенам.
Небольшая проблема: в более поздних дистрибутивах LaTeX ваш код не предоставляет никаких определений для \unitи . Поэтому в примере ниже вместо них используются \meterкоманды \siи .\metre
Одна из проблем: особенность заключается в \lstinlineтом, что аргумент \lstinlineобычно не может быть вложен между {и }, если он сам также содержит {. В этом случае аргумент должен быть вложен между символом, который не встречается в аргументе. Так что это \lstinline{\unit{\meter}}не сработает, но вам нужно будет сделать что-то вроде \lstinline|\unit{\meter}|. (Другой трюк, который реализован в ответе egreg, заключается в том, чтобы аргумент был \lstinlineтокенизирован под verbatim-catcode-régime, так что в любом случае он не будет содержать {категории 1 или }категории 2. Но v-type-category-code-régime нарушает некоторые функции \lstinline— по крайней мере, mathescape-feature.)
Другая проблема заключается в том, что TeX ожидает, что аргумент \lstinlineбудет токенизирован в другом режиме кода категории. Поэтому \lstinlineвременно изменяет режим кода категории для захвата токенов, принадлежащих его аргументу, из потока токенов. \lstinlineполагается на необходимость TeX читать из .tex-input-file и токенизировать токены, принадлежащие аргументу в измененном режиме кода категории, чтобы их можно было захватить из потока токенов. Таким образом, \lstinlineработает только на уровне пользователя/верхнем уровне. \lstinlineне работает, когда аргументы передаются после их токенизации в неизменном режиме кода категории, как это было бы в случае, например, при размещении вызовов \lstinlineв текстах определений других макросов, которые захватывают аргументы в неизменном режиме кода категории и передают их в \lstinline.
Эту проблему можно обойти в некоторой степени, если ваш макрос \commandExampleсам изменит режим кода категории перед тем, как захватывать аргументы и передавать их в \lstinline, вложенный в \scantokens{...%}.
Но здесь возникает еще одна проблема: ни LaTeX 2ε, ни expl3, ни xparse не предоставляют тип аргумента verbatim, который позволяет сохранять и передавать разделитель verbatim.
Поэтому в примере ниже приведена команда \UDcollectverbarg, которая переключается в режим буквального кода catcode и захватывает аргумент как без, так и с вложенным между буквальным разделителем аргументом, чтобы эти данные можно было правильно передать для дальнейшей обработки.
\makeatletter
%%======================Code for \UDcollectverbarg=============================
%% \UDcollectverbarg{<mandatory 1>}{<mandatory 2>}|<verbatim arg>|
%%
%% reads <verbatim arg> under verbatim-catcode-regime and delivers:
%%
%% <mandatory 1>{<mandatory 2>{<verbatim arg>}{|<verbatim arg>|}}
%%
%% Instead of verbatim-delimiter | the <verbatim arg> can be nested in braces.
%% You cannot use percent or spaces or horizontal tab as verbatim-delimiter.
%%
%% You can use <mandatory 1> for nesting calls to \UDcollectverbarg.
%% <mandatory 2> gets the <verbatim arg> twice: Once without verbatim-delimiters/braces,
%% once surrounded by verbatim-delimiters/braces.
%% Reason: When you feed it to \scantokens you don't need the verbatim-delimiters.
%% When you use it for writing to temporary files and reading back,
%% you need them.
%%=============================================================================
%% Check whether argument is empty:
%%=============================================================================
\@ifdefinable\UD@stopromannumeral{\chardef\UD@stopromannumeral=`\^^00}%
%%
%% \UD@CheckWhetherNull{<Argument which is to be checked>}%
%% {<Tokens to be delivered in case that argument
%% which is to be checked is empty>}%
%% {<Tokens to be delivered in case that argument
%% which is to be checked is not empty>}%
%%
%% The gist of this macro comes from Robert R. Schneck's \ifempty-macro:
%% <https://groups.google.com/forum/#!original/comp.text.tex/kuOEIQIrElc/lUg37FmhA74J>
\newcommand\UD@CheckWhetherNull[1]{%
\romannumeral\expandafter\@secondoftwo\string{\expandafter
\@secondoftwo\expandafter{\expandafter{\string#1}\expandafter
\@secondoftwo\string}\expandafter\@firstoftwo\expandafter{\expandafter
\@secondoftwo\string}\expandafter\UD@stopromannumeral\@secondoftwo}{%
\expandafter\UD@stopromannumeral\@firstoftwo}%
}%
%%=============================================================================
\newcommand\UDcollectverbarg[2]{%
\begingroup
\let\do\@makeother % <- this and the next line switch to
\dospecials % verbatim-category-code-régime.
\catcode`\{=1 % <- give opening curly brace the usual catcode so a
% curly-brace-balanced argument can be gathered in
% case of the first thing of the verbatimized-argument
% being a curly opening brace.
\catcode`\ =10 % <- give space and horizontal tab the usual catcode so \UD@collectverbarg
\catcode`\^^I=10 % cannot catch a space or a horizontal tab as its 4th undelimited argument.
% (Its 4th undelimited argument denotes the verbatim-
% syntax-delimiter in case of not gathering a
% curly-brace-nested argument.)
\catcode`\%=14 % <- make percent comment.
\kernel@ifnextchar\bgroup
{% seems a curly-brace-nested argument is to be caught:
\catcode`\}=2 % <- give closing curly brace the usual catcode also.
\UD@collectverbarg{#1}{#2}{}%
}{% seems an argument with verbatim-syntax-delimiter is to be caught:
\do\{% <- give opening curly brace the verbatim-catcode again.
\UD@collectverbarg{#1}{#2}%
}%
}%
\newcommand\UD@collectverbarg[3]{%
\do\ % <- Now that \UD@collectverbarg has the delimiter or
\do\^^I% emptiness in its 4th arg, give space and horizontal tab
% the verbatim-catcode again.
\do\^^M% <- Give the carriage-return-character the verbatim-catcode.
\do\%% <- Give the percent-character the verbatim-catcode.
\long\def\@tempb##1#3{%
\def\@tempb{##1}%
\UD@CheckWhetherNull{#3}{%
\def\@tempc{{##1}}%
}{%
\def\@tempc{#3##1#3}%
}%
\@onelevel@sanitize\@tempb % <- Turn characters into their "12/other"-pendants.
% This may be important with things like the
% inputenc-package which may make characters
% active/which give them catcode 13(active).
\@onelevel@sanitize\@tempc
\expandafter\expandafter\expandafter\UD@@collectverbarg% <- this "spits out the result.
\expandafter\expandafter\expandafter{%
\expandafter\@tempb\expandafter}%
\expandafter{\@tempc}{#1}{#2}%
}%
\@tempb
}%
\newcommand\UD@@collectverbarg[4]{%
\endgroup
#3{#4{#1}{#2}}%
}%
%%================= End of code for \UDcollectverbarg =========================
\makeatother
%%
\documentclass{report}
\usepackage{graphicx}
\usepackage{xcolor}
\usepackage{siunitx}
\usepackage{listings}
\definecolor{lightgrey}{rgb}{0.9,0.9,0.9}
\definecolor{darkgreen}{rgb}{0,0.6,0}
\lstset{language=[LaTeX]TeX,
% !!! Let's enable the mathescape-feature to test if it works:
mathescape=true,
%
caption = {Missing Caption}
,label = {lst:missingLabel}
,basicstyle = \footnotesize\ttfamily %\footnotesize % \small\ttfamily
,frame = shadowbox%
,numbers = left%
,breaklines = true%
,keywordstyle = \color{darkgreen}%
,commentstyle = \color{red}%
,tabsize = 2%
,backgroundcolor = \color{lightgrey}%
%,texcsstyle = {*\bf\color{blue}}%
%,otherkeywords = $, \{, \}, \[, \]%
,morekeywords = {includegraphics }%
,moretexcs = {graphicspath}%
}
\makeatletter
\NewDocumentCommand{\commandExample}{}{%
\UDcollectverbarg{\@firstofone}{\@commandExample}%
}%
\begingroup
\catcode`\X=14 %
\catcode`\%=12 X
\csname @firstofone\endcsname{X
\endgroup
\NewDocumentCommand{\@commandExample}{mm}{X
\scantokens{Output: #1 - Code: \lstinline#2%}X
}X
}%
\makeatother
\begin{document}
\verb:\commandExample{begin}: yields:
\commandExample{begin}
\medskip\hrule\medskip
\noindent Both with \verb|\lstinline| and thus with this variant of \verb|\commandExample| you can't have
\verb|{| within arguments that are nested between \verb|{...}|. Use some verbatim-delimiter instead:
\medskip
\verb:\commandExample|\si{\metre}|: yields:
\commandExample|\si{\metre}|
\medskip\hrule\medskip
\noindent \verb|mathescape|-thingies in the code seem to work, too:
\medskip
\verb:\commandExample|$x^2+y^2=z^2$|: yields:
\commandExample|$x^2+y^2=z^2$|
\medskip\hrule\medskip
\verb:\commandExample{$x^2+y^2=z^2$}: yields:
\commandExample{$x^2+y^2=z^2$}
\end{document}
