texlive[67453] Master/texmf-dist: runcode (23jun23)
commits+karl at tug.org
commits+karl at tug.org
Fri Jun 23 22:33:51 CEST 2023
Revision: 67453
http://tug.org/svn/texlive?view=revision&revision=67453
Author: karl
Date: 2023-06-23 22:33:51 +0200 (Fri, 23 Jun 2023)
Log Message:
-----------
runcode (23jun23)
Modified Paths:
--------------
trunk/Master/texmf-dist/doc/latex/runcode/README
trunk/Master/texmf-dist/doc/latex/runcode/runcode.pdf
trunk/Master/texmf-dist/doc/latex/runcode/runcode.tex
trunk/Master/texmf-dist/tex/latex/runcode/runcode.sty
Modified: trunk/Master/texmf-dist/doc/latex/runcode/README
===================================================================
--- trunk/Master/texmf-dist/doc/latex/runcode/README 2023-06-23 20:33:23 UTC (rev 67452)
+++ trunk/Master/texmf-dist/doc/latex/runcode/README 2023-06-23 20:33:51 UTC (rev 67453)
@@ -1,4 +1,4 @@
-LaTeX Package: runcode 2023/06/13 v1.9
+LaTeX Package: runcode 2023/06/23 v2.0
----------------------------------------
The runcode package enables the execution of source code (e.g., R,
Julia, Matlab, shell, Python, etc.) and embed the results in the pdf file
Modified: trunk/Master/texmf-dist/doc/latex/runcode/runcode.pdf
===================================================================
(Binary files differ)
Modified: trunk/Master/texmf-dist/doc/latex/runcode/runcode.tex
===================================================================
--- trunk/Master/texmf-dist/doc/latex/runcode/runcode.tex 2023-06-23 20:33:23 UTC (rev 67452)
+++ trunk/Master/texmf-dist/doc/latex/runcode/runcode.tex 2023-06-23 20:33:51 UTC (rev 67453)
@@ -1,6 +1,6 @@
-% LaTeX Package: runcode 2023/06/13 v1.9
+% LaTeX Package: runcode 2023/06/23 v2.0
%
-% Copyright (C) 2020-2022 by Haim Bar and HaiYing Wang
+% Copyright (C) 2020-2023 by Haim Bar and HaiYing Wang
%
% This file may be distributed and/or modified under the
% conditions of the LaTeX Project Public License, either
@@ -49,7 +49,7 @@
\end{abstract}
\section{Installation}
-\label{sec:org8c6be84}
+\label{sec:org594ce40}
You can simply put the runcode.sty file in the \LaTeX{} project folder.
The server mode requires the
@@ -65,9 +65,9 @@
\section{Usage}
-\label{sec:org951dfd0}
+\label{sec:org826d1b1}
\subsection{Load the package:}
-\label{sec:org516e8f6}
+\label{sec:orgfba21b6}
\begin{minted}[]{latex}
\usepackage[options]{runcode}
\end{minted}
@@ -121,12 +121,12 @@
\setminted[R]{linenos, frame=single, bgcolor=lightgray, breaklines=true}
\end{minted}
-Similarly, \href{https://ctan.org/pkg/fvextra}{fvextra} and \href{https://ctan.org/pkg/listings?lang=en}{listings} packages can be customized through the \texttt{\textbackslash{}lstset}
-and \texttt{\textbackslash{}fvset} commands, respectively, e.g.:
+Similarly, \href{https://ctan.org/pkg/fvextra}{fvextra} and \href{https://ctan.org/pkg/listings?lang=en}{listings} packages can be customized through the \texttt{\textbackslash{}fvset}
+and \texttt{\textbackslash{}lstset} commands, respectively, e.g.:
\begin{minted}[]{latex}
+\fvset{fontsize=\small, linenos=true, frame=single}
\lstset{basicstyle=\large, frame=single}
-\fvset{fontsize=\small, linenos=true, frame=single}
\end{minted}
The outputs from executing codes are displayed in
@@ -139,7 +139,7 @@
\end{minted}
\subsection{Basic commands:}
-\label{sec:org917f9dc}
+\label{sec:org9a60003}
\begin{itemize}
\item \texttt{\textbackslash{}runExtCode\{Arg1\}\{Arg2\}\{Arg3\}[Arg4]} runs an external code.
@@ -146,14 +146,18 @@
\begin{itemize}
\item \texttt{Arg1} is the executable program.
\item \texttt{Arg2} is the source file name.
-\item \texttt{Arg3} is the output file name (with an empty value, the counter
-\texttt{codeOutput} is used).
-\item \texttt{Arg4} controls whether to run the code. \texttt{Arg4} is optional with
-three possible values: if skipped or with empty value, the value of
-the global Boolean variable \texttt{runcode} is used; if the value is set
-to \texttt{run}, the code will be executed; if set to \texttt{cache} (or anything
-else), use cached results (see more about the cache below).
+\item \texttt{Arg3} is the output file name (with an empty value, the counter \texttt{codeOutput} is
+used).
+\item \texttt{Arg4} controls whether to run the code. \texttt{Arg4} is optional with three possible
+values.
+\begin{itemize}
+\item empty value or skipped: the value of the global Boolean variable \texttt{runcode}
+is used;
+\item \texttt{run}: the code will be executed;
+\item \texttt{cache} (or anything else): use cached results; if the output file does not
+exist, the cache option will be overridden and the code will run.
\end{itemize}
+\end{itemize}
\item \texttt{\textbackslash{}showCode\{Arg1\}\{Arg2\}[Arg3][Arg4]} shows the source code, using
\href{https://ctan.org/pkg/minted}{minted} (requires \href{https://pygments.org/}{pygments}), \href{https://ctan.org/pkg/fvextra}{fvextra}, or \href{https://ctan.org/pkg/listings?lang=en}{listings}.
@@ -174,10 +178,10 @@
as that of \texttt{Arg3} in \texttt{\textbackslash{}runExtCode}. If an empty value is given to
\texttt{Arg1}, the counter \texttt{codeOutput} is used.
\item \texttt{Arg2} is optional and it controls the type of output with a default
-value \texttt{vbox}
+value \texttt{vbox}.
\begin{itemize}
-\item \texttt{vbox} (or skipped) = verbatim in a box.
-\item \texttt{tex} = pure latex.
+\item \texttt{vbox} (or skipped) = verbatim in a box;
+\item \texttt{tex} = pure latex;
\item \texttt{inline} = embed result in text.
\end{itemize}
\end{itemize}
@@ -190,38 +194,61 @@
\item \texttt{Arg1} is the executable program or programming language.
\item \texttt{Arg2} is the source code.
\item \texttt{Arg3} is the output file name (optional);
-\item \texttt{Arg4} is the output type.
+\item \texttt{Arg4} is the output type and controls whether to run the code.
\begin{itemize}
-\item \texttt{inline} (or skipped or with empty value) = embed result in text.
-\item \texttt{vbox} = verbatim in a box.
+\item \texttt{inline} (or skipped or with empty value): embed result in text;
+\item \texttt{vbox}: verbatim in a box;
+\item \texttt{cache} or appending \texttt{.cache} to the argument (e.g., \texttt{vbox.cache}) AND the
+output file in \texttt{Arg3} exists: the cached result will be used and the code
+will not run.
\end{itemize}
\end{itemize}
\end{itemize}
+
+\subsection{Extended commands:}
+\label{sec:org57656ef}
+\begin{itemize}
+\item \texttt{\textbackslash{}runCodeIncOut\{Arg1\}\{Arg2\}[Arg3][Arg4][Arg5]} runs an external code and
+embeds the output. This is a combination of \texttt{\textbackslash{}runExtCode} and \texttt{\textbackslash{}includeOutput}.
+\begin{itemize}
+\item \texttt{Arg1} is the executable program.
+\item \texttt{Arg2} is the source file name.
+\item \texttt{Arg3} (optional) controls whether to run the code. Its functionality is the
+same as that of \texttt{Arg4} of \texttt{\textbackslash{}runExtCode}.
+\item \texttt{Arg4} (optional) is the output file name. Its functionality is the same as
+that of \texttt{Arg3} of \texttt{\textbackslash{}runExtCode}.
+\item \texttt{Arg5} (optional) controls the type of output with a default value \texttt{vbox}. Its
+functionality is the same as that of \texttt{Arg3} of \texttt{\textbackslash{}includeOutput}.
+\end{itemize}
+\end{itemize}
+
\subsection{Language specific shortcuts:}
-\label{sec:org7b04bad}
+\label{sec:org9f79956}
\href{https://julialang.org/}{Julia}
\begin{itemize}
-\item \texttt{\textbackslash{}runJulia[Arg1]\{Arg2\}\{Arg3\}[Arg4]} runs an external
-\href{https://julialang.org/}{Julia} code file.
+\item \texttt{\textbackslash{}runJulia[Arg1]\{Arg2\}\{Arg3\}[Arg4]} runs an external \href{https://julialang.org/}{Julia} code file.
\begin{itemize}
-\item \texttt{Arg1} is optional and uses
-\href{https://pypi.org/project/talk2stat/}{talk2stat}'s
-\href{https://julialang.org/}{Julia} server by default.
-\item \texttt{Arg2}, \texttt{Arg3}, and \texttt{Arg4} have the same effects as those of the
-basic command \texttt{\textbackslash{}runExtCode}.
+\item \texttt{Arg1} is optional and uses \href{https://pypi.org/project/talk2stat/}{talk2stat}'s \href{https://julialang.org/}{Julia} server by default.
+\item \texttt{Arg2}, \texttt{Arg3}, and \texttt{Arg4} have the same effects as those of the basic command
+\texttt{\textbackslash{}runExtCode}.
\end{itemize}
-\item \texttt{\textbackslash{}inlnJulia[Arg1]\{Arg2\}[Arg3][Arg4]} runs \href{https://julialang.org/}{Julia}
-source code (\texttt{Arg2}) and displays the output in line.
+\item \texttt{\textbackslash{}runJuliaIncOut[Arg1]\{Arg2\}[Arg3][Arg4][Arg5]} runs an external \href{https://julialang.org/}{Julia} code
+file and embeds the output.
\begin{itemize}
-\item \texttt{Arg1} is optional and uses the \href{https://julialang.org/}{Julia}
-server by default.
-\item \texttt{Arg2} is the \href{https://julialang.org/}{Julia} source code to run.
-If the \href{https://julialang.org/}{Julia} source code is wrapped
-between "\texttt{```}" on both sides (as in the markdown grammar), then it
-will be implemented directly; otherwise the code will be written to
-a file on the disk and then be called.
+\item \texttt{Arg1} is optional and uses \href{https://pypi.org/project/talk2stat/}{talk2stat}'s \href{https://julialang.org/}{Julia} server by default.
+\item \texttt{Arg2}, \texttt{Arg3}, \texttt{Arg4}, and \texttt{Arg5} have the same effects as those of the command
+\texttt{\textbackslash{}runCodeIncOut}.
+\end{itemize}
+\item \texttt{\textbackslash{}inlnJulia[Arg1]\{Arg2\}[Arg3][Arg4]} runs \href{https://julialang.org/}{Julia} source code (\texttt{Arg2}) and displays
+the output in line.
+\begin{itemize}
+\item \texttt{Arg1} is optional and uses the \href{https://julialang.org/}{Julia} server by default.
+\item \texttt{Arg2} is the \href{https://julialang.org/}{Julia} source code to run. If the \href{https://julialang.org/}{Julia} source code is wrapped
+between "\texttt{```}" on both sides (as in the markdown grammar), then it will be
+implemented directly; otherwise the code will be written to a file on the
+disk and then be called.
\item \texttt{Arg3} and \texttt{Arg4} have the same effects as those of the basic command \texttt{\textbackslash{}inln}.
\end{itemize}
\end{itemize}
@@ -229,30 +256,27 @@
\href{https://www.mathworks.com/products/matlab.html}{MatLab}
\begin{itemize}
-\item \texttt{\textbackslash{}runMatLab[Arg1]\{Arg2\}\{Arg3\}[Arg4]} runs an external
-\href{https://www.mathworks.com/products/matlab.html}{MatLab} code file.
+\item \texttt{\textbackslash{}runMatLab[Arg1]\{Arg2\}\{Arg3\}[Arg4]} runs an external \href{https://www.mathworks.com/products/matlab.html}{MatLab} code file.
\begin{itemize}
-\item \texttt{Arg1} is optional and uses
-\href{https://pypi.org/project/talk2stat/}{talk2stat}'s
-\href{https://www.mathworks.com/products/matlab.html}{MatLab} server by
-default.
-\item \texttt{Arg2}, \texttt{Arg3}, and \texttt{Arg4} have the same effects as those of the
-basic command \texttt{\textbackslash{}runExtCode}.
+\item \texttt{Arg1} is optional and uses \href{https://pypi.org/project/talk2stat/}{talk2stat}'s \href{https://www.mathworks.com/products/matlab.html}{MatLab} server by default.
+\item \texttt{Arg2}, \texttt{Arg3}, and \texttt{Arg4} have the same effects as those of the basic command
+\texttt{\textbackslash{}runExtCode}.
\end{itemize}
-\item \texttt{\textbackslash{}inlnMatLab[Arg1]\{Arg2\}[Arg3][Arg4]} runs
-\href{https://www.mathworks.com/products/matlab.html}{MatLab} source code
-(\texttt{Arg2}) and displays the output in line.
+\item \texttt{\textbackslash{}runMatLabIncOut[Arg1]\{Arg2\}[Arg3][Arg4][Arg5]} runs an external \href{https://www.mathworks.com/products/matlab.html}{MatLab} code
+file and embeds the output.
\begin{itemize}
-\item \texttt{Arg1} is optional and uses the
-\href{https://www.mathworks.com/products/matlab.html}{MatLab} server by
-default.
-\item \texttt{Arg2} is the
-\href{https://www.mathworks.com/products/matlab.html}{MatLab} source
-code to run. If the
-\href{https://www.mathworks.com/products/matlab.html}{MatLab} source
-code is wrapped between "```" on both sides (as in the markdown
-grammar), then it will be implemented directly; otherwise the code
-will be written to a file on the disk and then be called.
+\item \texttt{Arg1} is optional and uses \href{https://pypi.org/project/talk2stat/}{talk2stat}'s \href{https://www.mathworks.com/products/matlab.html}{MatLab} server by default.
+\item \texttt{Arg2}, \texttt{Arg3}, \texttt{Arg4}, and \texttt{Arg5} have the same effects as those of the command
+\texttt{\textbackslash{}runCodeIncOut}.
+\end{itemize}
+\item \texttt{\textbackslash{}inlnMatLab[Arg1]\{Arg2\}[Arg3][Arg4]} runs \href{https://www.mathworks.com/products/matlab.html}{MatLab} source code (\texttt{Arg2}) and
+displays the output in line.
+\begin{itemize}
+\item \texttt{Arg1} is optional and uses the \href{https://www.mathworks.com/products/matlab.html}{MatLab} server by default.
+\item \texttt{Arg2} is the \href{https://www.mathworks.com/products/matlab.html}{MatLab} source code to run. If the \href{https://www.mathworks.com/products/matlab.html}{MatLab} source code is wrapped
+between "```" on both sides (as in the markdown grammar), then it will be
+implemented directly; otherwise the code will be written to a file on the
+disk and then be called.
\item \texttt{Arg3} and \texttt{Arg4} have the same effects as those of the basic command \texttt{\textbackslash{}inln}.
\end{itemize}
\end{itemize}
@@ -260,36 +284,35 @@
\href{https://www.python.org/}{Python}
\begin{itemize}
-\item \texttt{\textbackslash{}runPython[Arg1]\{Arg2\}\{Arg3\}[Arg4]} runs an external
-\href{https://www.python.org/}{Python} code file.
+\item \texttt{\textbackslash{}runPython[Arg1]\{Arg2\}\{Arg3\}[Arg4]} runs an external \href{https://www.python.org/}{Python} code file.
\begin{itemize}
-\item \texttt{Arg1} is optional and uses
-\href{https://pypi.org/project/talk2stat/}{talk2stat}'s
-\href{https://julialang.org/}{Julia} server by default.
-\item \texttt{Arg2}, \texttt{Arg3}, and \texttt{Arg4} have the same effects as those of the
-basic command \texttt{\textbackslash{}runExtCode}.
+\item \texttt{Arg1} is optional and uses \href{https://pypi.org/project/talk2stat/}{talk2stat}'s \href{https://www.python.org/}{Python} server by default.
+\item \texttt{Arg2}, \texttt{Arg3}, and \texttt{Arg4} have the same effects as those of the basic command
+\texttt{\textbackslash{}runExtCode}.
\end{itemize}
-\item \texttt{\textbackslash{}inlnPython[Arg1]\{Arg2\}[Arg3][Arg4]} runs
-\href{https://www.python.org/}{Python} source code (\texttt{Arg2}) and displays
-the output in line.
+\item \texttt{\textbackslash{}runPythonIncOut[Arg1]\{Arg2\}[Arg3][Arg4][Arg5]} runs an external \href{https://www.python.org/}{Python} code
+file and embeds the output.
\begin{itemize}
-\item \texttt{Arg1} is optional and uses the \href{https://www.python.org/}{Python}
-server by default.
-\item \texttt{Arg2} is the \href{https://julialang.org/}{Julia} source code to run.
-If the \href{https://www.python.org/}{Python} source code is wrapped
-between "```" on both sides (as in the markdown grammar), then it
-will be implemented directly; otherwise the code will be written to
-a file on the disk and then be called.
+\item \texttt{Arg1} is optional and uses \href{https://pypi.org/project/talk2stat/}{talk2stat}'s \href{https://www.python.org/}{Python} server by default.
+\item \texttt{Arg2}, \texttt{Arg3}, \texttt{Arg4}, and \texttt{Arg5} have the same effects as those of the command
+\texttt{\textbackslash{}runCodeIncOut}.
+\end{itemize}
+\item \texttt{\textbackslash{}inlnPython[Arg1]\{Arg2\}[Arg3][Arg4]} runs \href{https://www.python.org/}{Python} source code (\texttt{Arg2}) and
+displays the output in line.
+\begin{itemize}
+\item \texttt{Arg1} is optional and uses the \href{https://www.python.org/}{Python} server by default.
+\item \texttt{Arg2} is the \href{https://julialang.org/}{Julia} source code to run. If the \href{https://www.python.org/}{Python} source code is wrapped
+between "```" on both sides (as in the markdown grammar), then it will be
+implemented directly; otherwise the code will be written to a file on the
+disk and then be called.
\item \texttt{Arg3} and \texttt{Arg4} have the same effects as those of the basic command \texttt{\textbackslash{}inln}.
\end{itemize}
-\item \texttt{\textbackslash{}runPythonBatch[Arg1][Arg2]} runs an external
-\href{https://www.python.org/}{Python} code file in batch mode (without a
-server running). Python (at least currently), unlike the other
-languages we use, does not have an option to save and restore a
-session, which means that once a Python session ends, the working
-environement (variable, functions) is deleted. In order to allow a
-batch-mode in Python, we implemented such capability. It requires the
-\href{https://pypi.org/project/dill/}{dill} module, which has to be
+\item \texttt{\textbackslash{}runPythonBatch[Arg1][Arg2]} runs an external \href{https://www.python.org/}{Python} code file in batch mode
+(without a server running). Python (at least currently), unlike the other
+languages we use, does not have an option to save and restore a session, which
+means that once a Python session ends, the working environement (variable,
+functions) is deleted. In order to allow a batch-mode in Python, we
+implemented such capability. It requires the \href{https://pypi.org/project/dill/}{dill} module, which has to be
installed via \texttt{pip3 install dill}.
\begin{itemize}
\item \texttt{Arg1} is the \href{https://www.python.org/}{Python} source file name,
@@ -300,25 +323,29 @@
\href{https://www.r-project.org/}{R}
\begin{itemize}
-\item \texttt{\textbackslash{}runR[Arg1]\{Arg2\}\{Arg3\}[Arg4]} runs an external
-\href{https://www.r-project.org/}{R} code file.
+\item \texttt{\textbackslash{}runR[Arg1]\{Arg2\}\{Arg3\}[Arg4]} runs an external \href{https://www.r-project.org/}{R} code file.
\begin{itemize}
-\item \texttt{Arg1} is optional and uses
-\href{https://pypi.org/project/talk2stat/}{talk2stat}'s
-\href{https://www.r-project.org/}{R} server by default.
-\item \texttt{Arg2}, \texttt{Arg3}, and \texttt{Arg4} have the same effects as those of the
-basic command \texttt{\textbackslash{}runExtCode}.
+\item \texttt{Arg1} is optional and uses \href{https://pypi.org/project/talk2stat/}{talk2stat}'s \href{https://www.r-project.org/}{R} server by default.
+\item \texttt{Arg2}, \texttt{Arg3}, and \texttt{Arg4} have the same effects as those of the basic command
+\texttt{\textbackslash{}runExtCode}.
\end{itemize}
+
+\item \texttt{\textbackslash{}runRIncOut[Arg1]\{Arg2\}[Arg3][Arg4][Arg5]} runs an external \href{https://www.r-project.org/}{R} code file and
+embeds the output.
+\begin{itemize}
+\item \texttt{Arg1} is optional and uses \href{https://pypi.org/project/talk2stat/}{talk2stat}'s \href{https://www.r-project.org/}{R} server by default.
+\item \texttt{Arg2}, \texttt{Arg3}, \texttt{Arg4}, and \texttt{Arg5} have the same effects as those of the command
+\texttt{\textbackslash{}runCodeIncOut}.
+\end{itemize}
+
\item \texttt{\textbackslash{}inlnR[Arg1]\{Arg2\}[Arg3][Arg4]} runs \href{https://www.r-project.org/}{R}
source code (\texttt{Arg2}) and displays the output in line.
\begin{itemize}
-\item \texttt{Arg1} is optional and uses the \href{https://www.r-project.org/}{R}
-server by default.
-\item \texttt{Arg2} is the \href{https://www.r-project.org/}{R} source code to run.
-If the \href{https://www.r-project.org/}{R} source code is wrapped
-between "```" on both sides (as in the markdown grammar), then it
-will be implemented directly; otherwise the code will be written to
-a file on the disk and then be called.
+\item \texttt{Arg1} is optional and uses the \href{https://www.r-project.org/}{R} server by default.
+\item \texttt{Arg2} is the \href{https://www.r-project.org/}{R} source code to run. If the \href{https://www.r-project.org/}{R} source code is wrapped between
+"```" on both sides (as in the markdown grammar), then it will be
+implemented directly; otherwise the code will be written to a file on the
+disk and then be called.
\item \texttt{Arg3} and \texttt{Arg4} have the same effects as those of the basic command \texttt{\textbackslash{}inln}.
\end{itemize}
\end{itemize}
@@ -325,9 +352,16 @@
\section{Revisions}
-\label{sec:orgdd95675}
+\label{sec:orga78221a}
\begin{itemize}
-\item v1.9, June 13, 2023: Update \texttt{\textbackslash{}inln} command; the optional \texttt{Arg3} is the output
+\item v2.0, June 23, 2023: add \texttt{\textbackslash{}runCodeIncOut} command that runs an external code and
+embeds the output and andd some language specific shortcuts; update
+\texttt{\textbackslash{}runExtCode} so that if the output file does not exist, the \texttt{cache} option will
+be overridden and the code will run; update \texttt{\textbackslash{}inln} so that its \texttt{Arg4} accept
+\texttt{cache} or appending \texttt{.cache} to use the cached result. We thank \href{https://github.com/kiryph}{kiryph} for
+suggesting these features.
+
+\item v1.9, June 13, 2023: update \texttt{\textbackslash{}inln} command; the optional \texttt{Arg3} is the output
file name and the optional \texttt{Arg4} is the output type.
\item v1.8, January 18, 2023, add support to \href{https://ctan.org/pkg/listings?lang=en}{listings.}
\item v1.7, August 20, 2022: changed the tmp/ folder to generated/ in order to
@@ -347,7 +381,7 @@
\end{itemize}
\section{Contributing}
-\label{sec:orge68f2c0}
+\label{sec:org097e6a5}
We welcome your contributions to this package by opening issues on
GitHub and/or making a pull request. We also appreciate more example
documents written using \texttt{runcode}.
Modified: trunk/Master/texmf-dist/tex/latex/runcode/runcode.sty
===================================================================
--- trunk/Master/texmf-dist/tex/latex/runcode/runcode.sty 2023-06-23 20:33:23 UTC (rev 67452)
+++ trunk/Master/texmf-dist/tex/latex/runcode/runcode.sty 2023-06-23 20:33:51 UTC (rev 67453)
@@ -4,7 +4,7 @@
%
% This package is based on an ongoing work by Haim Bar and HaiYing Wang, and comments and questions are welcome!
-\ProvidesPackage{runcode}[2023/06/13 runcode v1.9]
+\ProvidesPackage{runcode}[2023/06/23 runcode v2.0]
\newif\ifruncode
% Change to \runcodefalse if you want to suspend code execution
@@ -12,6 +12,15 @@
\DeclareOption{run}{\runcodetrue}
\DeclareOption{cache}{\runcodefalse}
+% to control whether \inln will get the result from the program(R, Python, etc.)
+% or get it from cache (if available), then we define the following. The default
+% is true (to run any \inln command in the tex file)
+\newif\ifinlnrun
+% Change to \inlnrunfalse if you want to get the results from cache for all
+% \inln instances in the tex file (if cache is not available, it will be executed
+% even if this variable is set to false)
+\inlnruntrue
+
% Choose the package for code typesetting. The default is minted.
% The other two options are listings and fvextra. For backward compatibility,
% it is possible to use nominted, in which case fvextra is used.
@@ -144,7 +153,7 @@
\usepackage{xcolor} % for highlighting
\usepackage{inputenc}
\usepackage{textgreek}
-\usepackage{filecontents}
+% \usepackage{filecontents}
\usepackage{xifthen}
\usepackage{xparse}
\usepackage{xstring}
@@ -249,7 +258,7 @@
% codeOutput is used).
% Arg #4 controls when to run the code (optional - if not given, it listens
% to \runcode; run = force the code to run; cache or anything else =
-% use cache)
+% use cache. If the output file does not exist, override the cache option and run the code)
\NewDocumentCommand{\runExtCode}{m m m O{}}{
\IfFileExists{#2}{
\stepcounter{codeOutput}
@@ -264,11 +273,13 @@
}{
\ifstrequal{#4}{run}{\immediate\write18{#1 #2 > \tmpname }}{}
}
+ \IfFileExists{\tmpname}{}{\immediate\write18{#1 #2 > \tmpname }}
}{
\textcolor{red}{\textbf{runExtCode: File #2 does not exist!}}
}
}
+
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
% \includeOutput[Arg #1]{Arg #2} is used to embed the output from executed code.
% Arg #1 is the output file name (optional - if not given, the counter
@@ -314,9 +325,10 @@
% and embed resulting output.
% Arg #1 is the executable program;
% Arg #2 is the source code;
-% Arg #3 is the output file name (optional);
+% Arg #3 is the output file name (optional).
% Arg #4 is the type output (if skipped or with empty value the default type is
-% inline; vbox = verbatim in a box);
+% inline; vbox = verbatim in a box); If you append .cache to the argument
+%. AND the output file in Arg#3 exists, then \inln will use the cached result;
\NewDocumentCommand{\inln}{m m O{} O{inline}}{\-
\unskip
@@ -323,7 +335,9 @@
\ifthenelse{\isempty{#3}}
{\stepcounter{codeOutput}\unskip\unskip\setvalue{\tmpname}{\generated/\jobname_inln\thecodeOutput}\unskip\unskip\unskip}
{\unskip\setvalue{\tmpname}{\generated/#3}\unskip\unskip\unskip}
- \unskip\unskip\unskip
+ \unskip\unskip\unskip
+ \IfFileExists{\tmpname.tex}{\IfEndWith{#4}{cache}{\inlnrunfalse}{\inlnruntrue}}{\inlnruntrue}
+ \ifinlnrun
\ifruncode % cache mode - don't try to run the code, just get the previous results
\IfBeginWith{#2}{```}{\ifruncode\immediate\write18{#1 > \tmpname.tex}\unskip\fi}
{\newwrite\tempfile
@@ -333,10 +347,12 @@
\ifruncode
\immediate\write18{#1 \tmpname.txt > \tmpname.tex}\unskip
\fi}
- \fi % end cache mode
+ \fi
+ \fi% end cache mode
+ \unskip\unskip\unskip
\IfFileExists{\tmpname.tex}
{\checkZeroBytes{\tmpname.tex}\unskip
- \ifstrequal{#4}{vbox}
+ \IfBeginWith{#4}{vbox}
{\begin{tcolorbox}
\ifminted\unskip
\inputminted{text}{\tmpname.tex}\unskip
@@ -350,6 +366,29 @@
{\unskip{\input{\tmpname.tex}}\unskip}}
{\textcolor{red}{\textbf{Output file \tmpname~ not found}}}}
+%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
+% Extended and language-specific comments:
+
+%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
+% \runCodeIncOut: runs an external code and embeds the output.
+% Arg #1 is the executable program,
+% Arg #2 is the source file name,
+% Arg #3 controls when to run the code (optional - if not given, it listens
+% to \runcode; run = force the code to run; cache or anything else =
+% use cache). The same functionality as that of Arg #4 of \runExtCode.
+% Arg #4 is the output file name (optional - if not given, the counter
+% codeOutput is used). The same functionality as that of Arg #4 of
+% \runExtCode.
+% Arg #5 is the optional type output with default "vbox"
+% (vbox = verbatim in a box, tex = pure latex, or inline)
+% The same functionality as that of Arg #2 of \includeOutput.
+
+\NewDocumentCommand{\runCodeIncOut}{m m O{} O{} O{vbox}}{
+ \runExtCode{#1}{#2}{#4}[#3]
+ \includeOutput{#4}[#5]
+}
+
+% R
\NewDocumentCommand{\runR}{O{python3 -c 'from talk2stat.talk2stat import client; client("./","R","#2")'} m m O{}}
{
\def\runcmd{python3 -c 'from talk2stat.talk2stat import client; client("./","R","#2")'}
@@ -358,8 +397,16 @@
{\runExtCode{#1}{#2}{#3}[#4]}
}
+\NewDocumentCommand{\runRIncOut}
+{O{python3 -c 'from talk2stat.talk2stat import client; client("./","R","#2")'} m O{} O{} O{vbox}}
+{\def\runcmd{python3 -c 'from talk2stat.talk2stat import client; client("./","R","#2")'}
+ \ifstrequal{#1}{\runcmd}
+ {\runCodeIncOut{#1}{}[#3][#4][#5]}
+ {\runCodeIncOut{#1}{#2}[#3][#4][#5]}}
+
\NewDocumentCommand{\inlnR}{O{python3 -c 'from talk2stat.talk2stat import client; client("./","R","\tmpname.txt")'} m O{} O{inline}}{\IfBeginWith{#2}{```}{\inln{python3 -c 'from talk2stat.talk2stat import client;rc0="""#2""";rc0=rc0.lstrip("```").rstrip("```");client("./","R",f"```{rc0}```")'}{#2}[#3][#4]}{\inln{#1}{#2}[#3][#4]}}
+% Julia
\NewDocumentCommand{\runJulia}{O{python3 -c 'from talk2stat.talk2stat import client; client("./","julia","#2")'} m m O{}}
{
\def\runcmd{python3 -c 'from talk2stat.talk2stat import client; client("./","julia","#2")'}
@@ -368,8 +415,16 @@
{\runExtCode{#1}{#2}{#3}[#4]}
}
+\NewDocumentCommand{\runJuliaIncOut}
+{O{python3 -c 'from talk2stat.talk2stat import client; client("./","julia","#2")'} m O{} O{} O{vbox}}
+{\def\runcmd{python3 -c 'from talk2stat.talk2stat import client; client("./","julia","#2")'}
+ \ifstrequal{#1}{\runcmd}
+ {\runCodeIncOut{#1}{}[#3][#4][#5]}
+ {\runCodeIncOut{#1}{#2}[#3][#4][#5]}}
+
\NewDocumentCommand{\inlnJulia}{O{python3 -c 'from talk2stat.talk2stat import client; client("./","julia","\tmpname.txt")'} m O{} O{inline}}{\IfBeginWith{#2}{```}{\inln{python3 -c 'from talk2stat.talk2stat import client;rc0="""#2""";rc0=rc0.lstrip("```").rstrip("```");client("./","julia",f"```{rc0}```")'}{#2}[#3][#4]}{\inln{#1}{#2}[#3][#4]}}
+% Matlab
\NewDocumentCommand{\runMatlab}{O{python3 -c 'from talk2stat.talk2stat import client; client("./","matlab","#2")'} m m O{}}
{
\def\runcmd{python3 -c 'from talk2stat.talk2stat import client; client("./","matlab","#2")'}
@@ -378,9 +433,16 @@
{\runExtCode{#1}{#2}{#3}[#4]}
}
+\NewDocumentCommand{\runMatlabIncOut}
+{O{python3 -c 'from talk2stat.talk2stat import client; client("./","matlab","#2")'} m O{} O{} O{vbox}}
+{\def\runcmd{python3 -c 'from talk2stat.talk2stat import client; client("./","matlab","#2")'}
+ \ifstrequal{#1}{\runcmd}
+ {\runCodeIncOut{#1}{}[#3][#4][#5]}
+ {\runCodeIncOut{#1}{#2}[#3][#4][#5]}}
+
\NewDocumentCommand{\inlnMatlab}{O{python3 -c 'from talk2stat.talk2stat import client; client("./","matlab","\tmpname.txt")'} m O{} O{inline}}{\IfBeginWith{#2}{```}{\inln{python3 -c 'from talk2stat.talk2stat import client;rc0="""#2""";rc0=rc0.lstrip("```").rstrip("```");client("./","matlab",f"```{rc0}```")'}{#2}[#3][#4]}{\inln{#1}{#2}[#3][#4]}}
-
+% Python
\NewDocumentCommand{\runPython}{O{python3 -c 'from talk2stat.talk2stat import client; client("./","python","#2")'} m m O{}}
{
\def\runcmd{python3 -c 'from talk2stat.talk2stat import client; client("./","python","#2")'}
@@ -389,6 +451,13 @@
{\runExtCode{#1}{#2}{#3}[#4]}
}
+\NewDocumentCommand{\runPythonIncOut}
+{O{python3 -c 'from talk2stat.talk2stat import client; client("./","python","#2")'} m O{} O{} O{vbox}}
+{\def\runcmd{python3 -c 'from talk2stat.talk2stat import client; client("./","python","#2")'}
+ \ifstrequal{#1}{\runcmd}
+ {\runCodeIncOut{#1}{}[#3][#4][#5]}
+ {\runCodeIncOut{#1}{#2}[#3][#4][#5]}}
+
\NewDocumentCommand{\inlnPython}{O{python3 -c 'from talk2stat.talk2stat import client; client("./","python","\tmpname.txt")'} m O{} O{inline}}{\IfBeginWith{#2}{```}{\inln{python3 -c 'from talk2stat.talk2stat import client;rc0="""#2""";rc0=rc0.lstrip("```").rstrip("```");client("./","python",f"```{rc0}```")'}{#2}[#3][#4]}{\inln{#1}{#2}[#3][#4]}}
@@ -434,4 +503,4 @@
}
-\endinput
+\endinput
\ No newline at end of file
More information about the tex-live-commits
mailing list.