imta_extra.sty

%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
% File Name:        imta_extra
%
% Description:      Enables advanced functionalities of the IMT Atlantique
%                   LaTeX Template.
%
% Note:             some functionalities require the Minted Package.
%                   This package further requires:
%                      1. To use the --shell-escape option when compiling 
%                         the document (with PDFLaTeX for instance)
%                      2. To have Pymentize installed (Having Python installed,
%                         you can simply run the command: pip install Pygments)
%
%                   Package options: nouppersectioninlof and nouppersectioninlot
%
% Limitations:      /
%
% Errors:           None known
%
% Dependencies:     mdframed
%                   minted
%
% Author:           A. Foucault - armand.foucault@telecom-bretagne.eu
% Contributors:     B. Porteboeuf - benoit.porteboeuf@telecom-bretagne.eu
%
% University:       IMT Atlantique, Brest (France)
%
% TeX Environment:  TeXLive + pdfLaTeX
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
% Revision List:
% Version    Author   Date         Changes
% 1.0        BP       31.10.2017   Original imta.sty package split into
%                                  imta_core.sty and imta_extra.sty
% 1.1        AF       02.11.2017   \imtaConsole and \imtaCode environments
%                                  introduced
% 1.2        BP       02.11.2017   \frontmatter & \mainmatter commands
%                                  introduced - support for uppersection
%                                  display in List of Tables/Figures
% 1.3        BP       05.12.2017   Bug fixed in the \chapter redefinition
% 1.4        BP       17.02.2018   Added \imtaCodeFromFile and 
%                                  \imtaConsoleFromFrile commands
% 1.5        AF       22.02.2018   line number rendering changed in code 
%                                  highlighting environments
% 1.6        BP       18.06.2018   Fixed rare bug in \chapter command
%                                  existance verification
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%


\NeedsTeXFormat{LaTeX2e}



%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
%      P A C K A G E S        %
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%

% Fancy code listings
\RequirePackage{minted}

% Fancy frames and boxes
\RequirePackage{mdframed}



%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
%      D E F A U L T      E X P O R T       S E T T I N G S        %
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%

% Some export-related booleans are introduced
\makeatletter
    \newif\if@printuppersectioninLOF      \@printuppersectioninLOFtrue
    \newif\if@printuppersectioninLOT      \@printuppersectioninLOTtrue
\makeatother

\makeatletter
    \global\newif\if@uppersectionprintedinLOF  \global\@uppersectionprintedinLOFfalse
    \global\newif\if@uppersectionprintedinLOT  \global\@uppersectionprintedinLOTfalse
    \gdef\imtaUpperSectionTitle{\thetitle}
    \gdef\imtaUpperSectionNumber{\relax}
\makeatother



%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
%           O P T I O N S          D E C L A R A T I O N           %
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%

\makeatletter
    % Disables the printing of the upper section in the List Of Figures
    \DeclareOption{nouppersectioninlof}{\@printuppersectioninLOFfalse} 
    % Disables the printing of the upper section in the List Of Tables
    \DeclareOption{nouppersectioninlot}{\@printuppersectioninLOTfalse}
\makeatother

\ExecuteOptions{}
\ProcessOptions\relax



%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
%           C O L O R S           %
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%

% Colors related to code formatting
\definecolor{imtaCodeBackground}{RGB}{235, 235, 235}
\definecolor{imtaCodeLinenosFrame}{RGB}{205, 205, 205}
\definecolor{imtaInlineCodeBackground}{RGB}{230, 230, 230}



%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
%           C O M M A N D S           %
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%

% \imtaInlinecode
% Typeset inline code
% First parameter is the language of the text to typeset
% Second parameter is the text to typeset
\newcommand{\imtaInlinecode}[2]{%
    \setlength{\fboxsep}{2pt}\colorbox{imtaInlineCodeBackground}{\mintinline{#1}{#2}}%
}


% \imtaFrontMatter
% Resets the page counter and switches to roman numbers (useful for the preamble)
\makeatletter
\newif\if@imtaMainMatter \@imtaMainMattertrue

\def\imtaFrontMatter{%
    \@imtaMainMatterfalse \pagenumbering{roman} \setcounter{page}{1}}

% \imtaMainMatter
% Resets the page counter and switches to arabic numbers (useful for the main content)
\def\imtaMainMatter{%
    \@imtaMainMattertrue \pagenumbering{arabic} \setcounter{page}{1}}
\makeatother



% \chapter
% \chapter is redefined when relevant, in order to update the upper section informations
\makeatletter
\@ifundefined{chapter}{%
     \relax
    }{%
     \let\imtaExtraOldChapter\chapter
     \renewcommand*{\chapter}{\@ifstar{\imtaExtraStarChapter}{\@dblarg\imtaExtraNoStarChapter}}
     
     \newcommand*\imtaExtraStarChapter[1]{%
         \imtaExtraOldChapter*{#1}
         \gdef\imtaUpperSectionNumber{\relax}
          \gdef\imtaUpperSectionTitle{#1}
          \global\@uppersectionprintedinLOFfalse
          \global\@uppersectionprintedinLOTfalse}
     
     \def\imtaExtraNoStarChapter[#1]#2{%
         \imtaExtraOldChapter[{#1}]{#2}
         \gdef\imtaUpperSectionNumber{\thechapter. } 
         \gdef\imtaUpperSectionTitle{#1}
          \global\@uppersectionprintedinLOFfalse
          \global\@uppersectionprintedinLOTfalse}
}
\makeatother


% \section 
% \section is redefined, in order to update the upper section informations
\makeatletter
\@ifundefined{chapter}{%
 
     \let\imtaExtraOldSection\section
     \renewcommand{\section}{\@ifstar{\imtaExtraStarSection}{\@dblarg\imtaExtraNoStarSection}}
     \newcommand\imtaExtraStarSection[1]{%
         \imtaExtraOldSection*{#1}  \gdef\imtaUpperSectionTitle{#1} \gdef\imtaUpperSectionNumber{\relax} \global\@uppersectionprintedinLOFfalse  \global\@uppersectionprintedinLOTfalse}
     \def\imtaExtraNoStarSection[#1]#2{%
         \imtaExtraOldSection[{#1}]{#2} \gdef\imtaUpperSectionTitle{#1} \gdef\imtaUpperSectionNumber{\thesection. } \global\@uppersectionprintedinLOFfalse  \global\@uppersectionprintedinLOTfalse}
    }{%    
    \relax
}
\makeatother




%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
%           E N V I R O N M E N T S           %
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%

% imtaCode
% Format a listing of code
% The only argument of this environment is the language of the code to format
%% This environment wraps around minted, and is therefore a verbatim environment
\newenvironment{imtaCode}[1]{%
    \VerbatimEnvironment%
    \renewcommand{\theFancyVerbLine}{\texttt{\textcolor{gray!150}{\normalsize \oldstylenums{\arabic{FancyVerbLine}}}}}%
    \vspace{0.5\baselineskip}%
    \begin{mdframed}[backgroundcolor=imtaCodeLinenosFrame, innerrightmargin=0pt, innertopmargin=0pt, innerbottommargin=0pt, linewidth=1pt]
        \begin{mdframed}[backgroundcolor=imtaCodeBackground, skipabove=0pt, skipbelow=0pt, rightmargin=0pt, leftmargin=3ex, linewidth=0pt, 
            innertopmargin=5pt, innerbottommargin=5pt, innerleftmargin=1ex]%
            \begin{minted}[linenos, breaklines]{#1}%
            }{
            \end{minted}%
        \end{mdframed}%
    \end{mdframed}%
}




% imtaCodeFromFile{<file>}{<language>}
% Formats a listing of code from an input file
% Where <file> is the path to the file and <language> is the minted label
% for the corresponding language 
\newcommand{\imtaCodeFromFile}[2]{%    \VerbatimEnvironment%
    \renewcommand{\theFancyVerbLine}{\texttt{\textcolor{gray!150}{\normalsize \oldstylenums{\arabic{FancyVerbLine}}}}}%
    \vspace{0.5\baselineskip}%
    \begin{mdframed}[backgroundcolor=imtaCodeLinenosFrame, innerrightmargin=0pt, innertopmargin=0pt, innerbottommargin=0pt, linewidth=1pt]
        \begin{mdframed}[backgroundcolor=imtaCodeBackground, skipabove=0pt, skipbelow=0pt, rightmargin=0pt, leftmargin=3ex, linewidth=0pt, 
            innertopmargin=5pt, innerbottommargin=5pt, innerleftmargin=1ex]%
            \inputminted[linenos, breaklines]{#2}{#1}
        \end{mdframed}%
    \end{mdframed}%
}


% imtaConsole
% Format a console session
\newenvironment{imtaConsole}{%
    \VerbatimEnvironment%
    \vspace{0.5\baselineskip}%
    \begin{mdframed}[backgroundcolor=imtaCodeBackground, innerleftmargin=5pt]%
    \begin{minted}[breaklines]{text}%
}{
    \end{minted}%
    \end{mdframed}%
}


% imtaConsoleFromFile{<file>}
% Formats a console session from an input file
% Where <file> is the path to the file
\newcommand{\imtaConsoleFromFile}[1]{%
    \vspace{0.5\baselineskip}%
    \begin{mdframed}[backgroundcolor=imtaCodeBackground, innerleftmargin=5pt]%
        \inputminted[breaklines]{text}{#1}
    \end{mdframed}%
}



%\figure
% The figure environment is redefined to update the LOF with the upper section title when relevant
 \makeatletter 
     \def\printuppersectioninlof{%
         \if@uppersectionprintedinLOF
             \relax
         \else
             \if@printuppersectioninLOF
                \if@chapterdefined
                     \addcontentsline{lof}{chapter}{\imtaUpperSectionNumber \imtaUpperSectionTitle}
                 \else
                     \addcontentsline{lof}{section}{\imtaUpperSectionNumber \imtaUpperSectionTitle}
                 \fi
             \fi
         \fi
         \global\@uppersectionprintedinLOFtrue}
     
     \let\imtaOldfigure\figure
     
     \def\figure{\@ifnextchar{[}{\imtaFigurewarg}{\imtaFigurewotarg}}
     
     
     \def\imtaFigurewarg[#1]{%        
         \imtaOldfigure[#1]\printuppersectioninlof}
     
     \def\imtaFigurewotarg{%
         \imtaOldfigure\printuppersectioninlof}
 \makeatother



% \table
% The table environment is redefined to update the LOT with the upper section title when relevant
\makeatletter
    \def\printuppersectioninlot{%
        \if@uppersectionprintedinLOT
            \relax
        \else
            \if@printuppersectioninLOT
                \if@chapterdefined
	                \addcontentsline{lot}{chapter}{\imtaUpperSectionNumber \imtaUpperSectionTitle}
                \else
                	\addcontentsline{lot}{section}{\imtaUpperSectionNumber \imtaUpperSectionTitle}
                \fi
            \fi
        \fi
        \global\@uppersectionprintedinLOTtrue}
    
    \let\imtaOldtable\table
    
    \def\table{\@ifnextchar{[}{\imtaTablewarg}{\imtaTablewotarg}}    
    
    \def\imtaTablewarg[#1]{%        
        \imtaOldtable[#1]\printuppersectioninlot}
    
    \def\imtaTablewotarg{%
        \imtaOldtable\printuppersectioninlot}
\makeatother

%%%%%%%%%% END %%%%%%%%%% 
%%%%%%%%%%%%%%%%%%%%%%%%%