[Tex/LaTex] It is possible to define “styles” in tcolorbox listings?

listingstcolorbox

I am writing a document where I use tcolorbox to list code. I would like to have a couple of commands to list code from an external file, and one (or two) environment for inline snippets. What I have (and it's nicely working) is something along the way of this MWE:

\RequirePackage{filecontents}
\begin{filecontents}{test.c}
#include <stdio.h>

int main() { 
    return 0;
}

\end{filecontents}

\documentclass{article}
\usepackage[listings, breakable, skins, fitting]{tcolorbox}

% from http://tex.stackexchange.com/a/163617/38080
\newtcbinputlisting[auto counter]{\putcodecomment}[2]{
    listing file={#1},
    title={Listing \thetcbcounter: #1}, fonttitle=\bfseries,
    listing and comment,
    comment={#2},
    %%% start of common things here 
    breakable,
    width=0.9\linewidth,
    bicolor,
    lower separated=true,
    colback=red!5,
    colframe=red!75!black,
    listing options={
      language          = {[Visual]C++},           % Language
      basicstyle        = \ttfamily,             % Default format          
      keywordstyle      = \color{blue},          % Keywordformat                               
      breaklines        = true,                  % Automatic line breaks
      breakatwhitespace = true,                  % Line breaks only at white spaces
      tabsize           = 4,                     % Number of spaces equal to a tab
      showspaces        = false,                 % Show spaces in the code
      showtabs          = false,                 % Show tabs in the code
      showstringspaces  = false,                 % Show spaces among strings
  },
}

\newtcblisting{justcode}[0]{
    listing only,
    breakable,
    width=0.9\linewidth,
    %%% start of common things here 
    breakable,
    width=0.9\linewidth,
    bicolor,
    lower separated=true,
    colback=red!5,
    colframe=red!75!black,
    listing options={
      language          = {[Visual]C++},           % Language
      basicstyle        = \ttfamily,       % Default format          
      keywordstyle      = \color{blue},          % Keywordformat                               
      breaklines        = true,                  % Automatic line breaks
      breakatwhitespace = true,                  % Line breaks only at white spaces
      tabsize           = 4,                     % Number of spaces equal to a tab
      showspaces        = false,                 % Show spaces in the code
      showtabs          = false,                 % Show tabs in the code
      showstringspaces  = false,                 % Show spaces among strings
  },
}

\begin{document}

\putcodecomment{test.c}{%
    No comment here 
}

\begin{justcode}
    a = a + 1; 
\end{justcode}

\end{document}

… which works, but as you can see, I had to use copy and paste to "repeat" the common part of the options of the boxes. Now, if I want to change the color of the background, I need to change it in two (really they are four) different place.

I tried to put all the common option in a \def\commonoptions{...} but it choked…

Is there a way to put the common part in common "style" so that I can organize it better? Something on the line of the tikz styles?

Best Answer

Just use \lstdefinestyle{foo}{ your options} and say listing options={style=foo}, this will save a lot of typing (or work).

You can change the listing options after setting the style:

listing options={style=foo,numbers=right}, for example.

Here's a modified version of the O.P. code

\RequirePackage{filecontents}
\begin{filecontents}{test.c}
#include <stdio.h>

int main() { 
    return 0;
}

\end{filecontents}

\documentclass{article}
\usepackage[listings, breakable, skins, fitting]{tcolorbox}

\lstdefinestyle{rmano}{      language          = {[Visual]C++},           % Language
      basicstyle        = \ttfamily,             % Default format          
      keywordstyle      = \color{blue},          % Keywordformat                               
      breaklines        = true,                  % Automatic line breaks
      breakatwhitespace = true,                  % Line breaks only at white spaces
      tabsize           = 4,                     % Number of spaces equal to a tab
      showspaces        = false,                 % Show spaces in the code
      showtabs          = false,                 % Show tabs in the code
      showstringspaces  = false,                 % Show spaces among strings
}

% from http://tex.stackexchange.com/a/163617/38080
\newtcbinputlisting[auto counter]{\putcodecomment}[2]{
    listing file={#1},
    title={Listing \thetcbcounter: #1}, fonttitle=\bfseries,
    listing and comment,
    comment={#2},
    %%% start of common things here 
    breakable,
    width=0.9\linewidth,
    bicolor,
    lower separated=true,
    colback=red!5,
    colframe=red!75!black,
    listing options={style=rmano}
  }

\newtcblisting{justcode}[0]{
    listing only,
    breakable,
    width=0.9\linewidth,
    %%% start of common things here 
    breakable,
    width=0.9\linewidth,
    bicolor,
    lower separated=true,
    colback=red!5,
    colframe=red!75!black,
    listing options={style={rmano},
  },
}

\begin{document}

\putcodecomment{test.c}{%
    No comment here 
}

\begin{justcode}
    a = a + 1; 
\end{justcode}

\end{document}

Edit

Here's a version that has common options for tcolorbox as well:

Use

\def\commonboxoptions{    breakable,
    width=0.9\linewidth,
    bicolor,
    lower separated=true,
    colback=red!5!,
    colframe=red!75!black,
}

and say code={\pgfkeysalsofrom{\commonboxoptions}} in the tcolorbox options (the listing boxes here!)

\RequirePackage{filecontents}
\begin{filecontents}{test.c}
#include <stdio.h>

int main() { 
    return 0;
}

\end{filecontents}

\documentclass{article}
\usepackage[listings, breakable, skins, fitting]{tcolorbox}

\lstdefinestyle{rmano}{      language          = {[Visual]C++},           % Language
      basicstyle        = \ttfamily,             % Default format          
      keywordstyle      = \color{blue},          % Keywordformat                               
      breaklines        = true,                  % Automatic line breaks
      breakatwhitespace = true,                  % Line breaks only at white spaces
      tabsize           = 4,                     % Number of spaces equal to a tab
      showspaces        = false,                 % Show spaces in the code
      showtabs          = false,                 % Show tabs in the code
      showstringspaces  = false,                 % Show spaces among strings
}

\def\commonboxoptions{    breakable,
    width=0.9\linewidth,
    bicolor,
    lower separated=true,
    colback=red!5!,
    colframe=red!75!black,
}

% from http://tex.stackexchange.com/a/163617/38080
\newtcbinputlisting[auto counter]{\putcodecomment}[2]{
    listing file={#1},
    title={Listing \thetcbcounter: #1}, fonttitle=\bfseries,
    listing and comment,
    comment={#2},
    %%% start of common things here 
    code={\pgfkeysalsofrom{\commonboxoptions}},
    listing options={style=rmano}
  }

\newtcblisting{justcode}[0]{
    listing only,
    breakable,
    width=0.9\linewidth,
    %%% start of common things here 
    code={\pgfkeysalsofrom{\commonboxoptions}},
    listing options={style={rmano},
  },
}

\begin{document}

\putcodecomment{test.c}{%
    No comment here 
}

\begin{justcode}
    a = a + 1; 
\end{justcode}

\end{document}

Related Solutions

[Tex/LaTex] tcolorbox – list of listings

In the solution below I've used the \@starttoc command to start a file \jobname.thm

% make a List of Theorems using the 
% \@starttoc command which creates \jobname.thm
\newcommand\listtheoremname{List of Theorems}
\newcommand\listoftheorems{%
  \section*{\listtheoremname}\@starttoc{thm}}

and have then copied the definition of the theorem command from tcbtheorems.code.tex and added

   \addcontentsline{thm}{subsection}{\protect\numberline{\csname the#2\endcsname} #3}, % new bit

which adds the theorem number and description to \jobname.thm

% copied from tcbtheorems.code.tex and added
% \addcontentsline...
\tcbset{
  theorem/.code args={#1#2#3#4}{%
  \refstepcounter{#2}\label{#4}%
   \addcontentsline{thm}{subsection}{\protect\numberline{\csname the#2\endcsname} #3}, % new bit
  \pgfkeysalso{title={\setlength{\hangindent}{\widthof{#1~\csname the#2\endcsname:\ }}\hangafter=1 \mbox{#1~\csname the#2\endcsname:\ }#3}}}%
}

I have also created a addtolol key which stands for add to list of listings

% add tcblistings to \jobname.lol (list of listings)
\tcbset{
  addtolol/.code={\addcontentsline{lol}{subsection}{\kvtcb@title}},
  }

which can be used as a key in any of the tcolorbox and friends environments

\begin{tcolorbox}[colback=blue!5,colframe=blue!75!black,title=My title,addtolol]

One problem with my implementation is that the addtolol key must be placed after the title key; if anyone has suggestions on how to fix this, let me know.

Here's a screenshot from the solution below.

screenshot

Complete MWE

\documentclass{article}
\usepackage{tikz}
\usepackage{float} % here.sty is considered obsolete (according to documentation)
\usepackage[listings,theorems]{tcolorbox}
\tcbset{noparskip}

\makeatletter

% make a List of Theorems using the 
% \@starttoc command which creates \jobname.thm
\newcommand\listtheoremname{List of Theorems}
\newcommand\listoftheorems{%
  \section*{\listtheoremname}\@starttoc{thm}}

% copied from tcbtheorems.code.tex and added
% \addcontentsline...
\tcbset{
  theorem/.code args={#1#2#3#4}{%
  \refstepcounter{#2}\label{#4}%
   \addcontentsline{thm}{subsection}{\protect\numberline{\csname the#2\endcsname} #3}, % new bit
  \pgfkeysalso{title={\setlength{\hangindent}{\widthof{#1~\csname the#2\endcsname:\ }}\hangafter=1 \mbox{#1~\csname the#2\endcsname:\ }#3}}}%
}

% add tcblistings to \jobname.lol (list of listings)
\tcbset{
  addtolol/.code={\addcontentsline{lol}{subsection}{\kvtcb@title}},
  }
\makeatother

% moved new theorem declaration to the preamble
\newcounter{mytheorem}[section]
\def\themytheorem{\thesection.\arabic{mytheorem}}

\tcbmaketheorem{theo}{Theorem}{fonttitle=\bfseries\upshape, fontupper=\slshape,
     arc=0mm, colback=blue!5,colframe=blue!75!black}{mytheorem}{theorem}

\begin{document}
\tableofcontents{}
\listoffigures{}
\listoftables{}
\lstlistoflistings{}
\listoftheorems % new bit
\pagebreak{}
%----------------------------------------------------------
\section{Colored boxes}

\begin{tcolorbox}[colback=red!5,colframe=red!75!black,title=My title]
  My box.
\end{tcolorbox}

\begin{tcolorbox}[colback=blue!5,colframe=blue!75!black,title=My title,addtolol]
  My box with my title.
\end{tcolorbox}

%----------------------------------------------------------
\section{\LaTeX-Examples}

\begin{tcblisting}{colback=red!5,colframe=red!75!black,title=Some title,addtolol}
This is a \LaTeX\ example:
$\displaystyle\sum\limits_{i=1}^n i = \frac{n(n+1)}{2}$.
\end{tcblisting}

 %----------------------------------------------------------
\section{Theorems}


\begin{theo}{Summation of Numbers}{summation}
  For all natural number $n$ it holds:\\[2mm]
  $\displaystyle\sum\limits_{i=1}^n i = \frac{n(n+1)}{2}$.
\end{theo}

We have given Theorem \ref{theorem:summation} on page \pageref{theorem:summation}.

\pagebreak{}
%----------------------------------------------------------

\section{Tables, Listings and Figures}
%----------------------------------------------------------
This is table 1
%----------------------------------------------------------

\begin{table}[H]
  \centering
  \begin{tabular}{ll}
    Header1 & Header2 \\ \hline
    Cell1 & Cell2 \\
  \end{tabular}
  \caption{My Table No1}
  \label{tab:tab-1}
\end{table}
  %----------------------------------------------------------
This is table 2

 \begin{table}[H]
  \centering
  \begin{tabular}{ll}
    Header3 & Header4 \\ \hline
    Cell3 & Cell4 \\
  \end{tabular}
  \caption{My Table No2}
\end{table}

%----------------------------------------------------------
This is figure 1
%----------------------------------------------------------
\begin{figure}[H]
  \centering
\begin{tikzpicture}
    \draw (0,0) node {A} --
          (2,0) node {B};
\end{tikzpicture} 
  \caption{Figure No1}
  \label{fig:fig-1}
\end{figure}
%----------------------------------------------------------
This is figure 2
%----------------------------------------------------------
\begin{figure}[H]
  \centering
\begin{tikzpicture}
    \draw (0,0) node {C} --
          (2,0) node {D};
\end{tikzpicture} 
  \caption{Figure No2}
  \label{fig:fig-2}
\end{figure}

\begin{lstlisting}[caption={Java Logic 1},label=java1]
public class Main
{
    public Main(String args[])
    {
        // Java logic in listing 1
    }
}
\end{lstlisting}
%\label{code:Listing-1}

\begin{lstlisting}[caption={Java Logic 2},label=java2]
public class Main
{
    public Main(String args[])
    {
        // More Java logic in listing 2
    }
}
\end{lstlisting}
%\label{code:Listing-2}

\end{document}

[Tex/LaTex] Lstinputlisting and listings styles

If the file contains the appropriate listing environment (like cplusplus or rcode), then you can just use \input{<filename>}. If it doesn't (or just contains the raw code that should be formatted), you can create a new command that does all of the setup for you, just like it would for your \lstnewenvironment creations. The following can be used in conjunction with the solution in Multiple listings styles:

enter image description here

\documentclass{article}
\usepackage{listings}% http://ctan.org/pkg/listings
\usepackage{filecontents}% http://ctan.org/pkg/filecontents

\begin{filecontents*}{cplusplus.c}
// 'Hello World!' program 

#include <iostream>

int main()
{
  std::cout << "Hello World!" << std::endl;
  return 0;
}
\end{filecontents*}
\begin{filecontents*}{rcode.r}
cat('Hello, world!\n')
\end{filecontents*}
\begin{filecontents*}{pseudocode.p}
print "Hello world"
\end{filecontents*}

\makeatletter
% --------------------------------------- C++
\let\oldaddcontentsline\addcontentsline
\newcommand{\lstlistcplusplusname}{List of C++}
\lst@UserCommand\lstlistofcplusplus{\bgroup
    \let\contentsname\lstlistcplusplusname
    \let\lst@temp\@starttoc \def\@starttoc##1{\lst@temp{loc}}%
    \tableofcontents \egroup}
\newcommand{\lstinputcplusplus}[2][]{{%
  \renewcommand{\lstlistingname}{C++ Code}%
  \renewcommand{\addcontentsline}[3]{\oldaddcontentsline{loc}{##2}{##3}}%
  \lstinputlisting[language=C++,#1]{#2}%
}}
% --------------------------------------- R
\newcommand{\lstlistrcodename}{List of R}
\lst@UserCommand\lstlistofrcode{\bgroup
    \let\contentsname\lstlistrcodename
    \let\lst@temp\@starttoc \def\@starttoc##1{\lst@temp{lor}}%
    \tableofcontents \egroup}
\newcommand{\lstinputrcode}[2][]{{%
  \renewcommand{\lstlistingname}{R Code}%
  \renewcommand{\addcontentsline}[3]{\oldaddcontentsline{lor}{##2}{##3}}%
  \lstinputlisting[language=R,#1]{#2}%
}}
% --------------------------------------- Pseudocode
\newcommand{\lstlistpseudocodename}{List of Pseudocode}
\lst@UserCommand\lstlistofpseudocode{\bgroup
    \let\contentsname\lstlistpseudocodename
    \let\lst@temp\@starttoc \def\@starttoc##1{\lst@temp{lop}}%
    \tableofcontents \egroup}
\newcommand{\lstinputpseudocode}[2][]{{%
  \renewcommand{\lstlistingname}{Pseudocode}%
  \renewcommand{\addcontentsline}[3]{\oldaddcontentsline{lop}{##2}{##3}}%
  \lstinputlisting[basicstyle=\ttfamily,#1]{#2}%
}}
\makeatother
\begin{document}

\lstlistofcplusplus
\lstlistofrcode
\lstlistofpseudocode

\lstinputcplusplus[caption={Hello world}]{cplusplus.c}

\lstinputrcode[caption={Hello world}]{rcode.r}

\lstinputpseudocode[caption={Hello world}]{pseudocode.p}

\end{document}

The macros provided for inputting a listing of a specific type are \lstinputcplusplus[<options>]{<filename>}, \lstinputrcode[<options>]{<filename>} and \lstinputpseudocode[<options>]{<filename>}.

Best Answer

Related Solutions

[Tex/LaTex] tcolorbox – list of listings

[Tex/LaTex] Lstinputlisting and listings styles

Related Question