lol768
commented
5 years ago Hey @PHPirates, sorry for the belated reply! I've been busy with some exams and some travel.
You're quite right in that they're internal minted commands. As part of this dissertation work, I wrote a style which I'm guessing you already found over at https://github.com/lol768/id7-pygments-style/
https://github.com/gpoore/minted/issues/230 is indeed the issue motivating the TeX I ended up writing. The basic problem is:
My code samples are not just code, they use a bunch of LaTeX inside the code sample to highlight things. For example, here's a SQL injection vulnerability with the vulnerable part of the code highlighted:
The red box is a \colorbox and an \faIcon within the code sample. Unfortunately, only some lexers provided by Pygments correctly handle this. There is a long-standing bug in Pygments that was raised 4 years ago which means that I can't use escapeinside for languages like C# or Java. Instead, I manually run Minted on just the bare source code, copy the generated output (from _minted-document) and then manually paste it into the LaTeX document already-highlighted. From here, I can then add my annotations and other custom code.
But! This doesn't "just work". The problem is that Pygments lazy-loads the \PYG<x> commands. When you do what I just did and try and paste the generated output and remove the original minted environment, nothing is loaded! Hence, the compile fails because it doesn't understand any of the commands.
The solution is to include the code twice. Once with no annotations, in a way that's hidden from the final document (imagine display: none, but for LaTeX, if you're familiar with CSS) in order to trick Minted into thinking the commands are necessary and loading them. And then another time, which appears in the final document, with all the necessary annotations and modifications.
The custom id7 Pygments style (which is named after the university's 7th brand iteration) complicates things a bit further, but ensures that the code samples look pretty and are consistent with the rest of the document. You need to have the style installed for any of this to work, since we use \usemintedstyle{idseven} to load it in the preamble.
The reason your example doesn't work is because the \PYGidseven{k+kd} definition isn't loaded. In Pygments land, k is a keyword and kd is a Keyword.Declaration. So we can make your minimal example compile by doing something like this:
\documentclass{article}
\usepackage{minted}
\usemintedstyle{idseven}
% Compile using XeLaTeX with -shell-escape
\begin{document}
\begin{minted}{java}
public class MyClass {
// exists solely to pre-load the k+kd definition
}
\end{minted}
\begin{Verbatim}[commandchars=\\\{\}]
\PYGidseven{k+kd}{public}
\end{Verbatim}
\end{document}In this example, we first have minted compile a simple java class. The public keyword in this code sample is enough for minted to realise that it needs to load the k+kd style, and the subsequent Verbatim environment works just fine.
In addition to this fun hackery, you'll notice that some code samples are highlighted using an environment like this:
\begin{minted}{rrtlex.py:RrtLexer -x}
% ...
\end{minted}This one is hilarious - minted doesn't support custom lexers. So, we take advantage of a command injection 'vulnerability' in the minted LaTeX package to inject an additional argument into the pygmentize command that's invoked to do the actual nitty-gritty highlighting work. This allows us to specify our own lexer file to use, which was written specifically for the dissertation.
mbg
PHPirates
Hey, I was using your document as a test document, but when I tried to compile it (using xelatex and shell escape) your use of these
\PYGidsevencommands confused me, are those internal minted commands? I don't know enough of pygments :/ They get meUndefined control sequence. ...ED\PYGidsevenZus {}META}\PYGidsevenI did find that
idsevenis the pygments style. I found https://github.com/gpoore/minted/issues/230 but it didn't get any clearer.I can reproduce the problem when I compile the following
[Edit] I hope it's no problem for your supervisor that I am trying to compile it... I won't distribute the result, of course.