preamble.tex

%!TEX root = thesis.tex
% Copyright 2018 Roland Jäger
%
% Permission is hereby granted, free of charge, to any person obtaining a copy
% of this software and associated documentation files (the "Software"), to deal
% in the Software without restriction, including without limitation the rights
% to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
% copies of the Software, and to permit persons to whom the Software is
% furnished to do so, subject to the following conditions:
%
% The above copyright notice and this permission notice shall be included in
% all copies or substantial portions of the Software.
%
% THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
% IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
% FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
% AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
% LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
% OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
% SOFTWARE.

\documentclass[
  a4paper,  % Standard format - only KOMAScript uses paper=a4 - https://tex.stackexchange.com/a/61044/9075
  twoside,  % we are optimizing for both screen and two-side printing. So the page numbers will jump, but the content is configured to stay in the middle (by using the geometry package)
  bibliography=totoc,
  headsepline,
  listof=totoc,
  cleardoublepage=empty,
  parskip=half,
]{scrbook}
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
% PACKAGES
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
%---------------------------------
% Special ordering
%---------------------------------
\usepackage[noTeX]{mmap}% Better text copy support
\usepackage[scale=.9,ttdefault=true]{sourcecodepro}

%---------------------------------
% Language
%---------------------------------
\usepackage[T1]{fontenc} % utf8 <- produce real utf8 characters
\usepackage[utf8]{inputenc} % utf8 <- accept utf8 input characters
\usepackage{datetime}
\usepackage[ngerman,british]{babel}
\usepackage{csquotes} % better quotes
\usepackage[
  backend=biber,
  sortcites=true,
  url=false,
  doi=true,
  eprint=false
]{biblatex}

\input{meta}

%---------------------------------
% Utility
%---------------------------------
\usepackage[colorlinks]{hyperref} % hyper ref "addon"
\usepackage{scrhack} % patches outdated float package
\usepackage{float} % better figure placement
\usepackage[justification=centering,format=plain]{caption} % Caption setup
\usepackage{amsmath} % Math stuff
\usepackage{amsfonts} % Math stuff
\usepackage{xspace} % for automagical spaces after commends
\usepackage[math]{blindtext}
\usepackage[toc,automake,acronym,nomain]{glossaries} % glossary and accronyms
\usepackage{pgffor} % used to iterate over a list
\usepackage[toc,page]{appendix}
\usepackage{upquote}
\usepackage{subfig}
\usepackage{xparse}
\usepackage{expl3}
\usepackage{afterpage}

%---------------------------------
% Style
%---------------------------------
\usepackage[automark]{scrlayer-scrpage}
\usepackage[
  left=3cm,right=3cm,top=2.5cm,bottom=2.5cm,
  headsep=18pt,
  footskip=30pt,
  includehead,
  includefoot
]{geometry}
\usepackage[
  activate={%
      true,%
      nocompatibility%
    }, % activate protrusion and expansion
  final, % enable microtype; use "draft" to disable
  tracking=true,%
  kerning=true,%
  spacing=true,%
  factor=1100, % add 10% to the protrusion amount (default is 1000)
  stretch=10, % reduce stretchability (default is 20/20)
  shrink=10 % reduce shrinkability (default is 20/20)
]{microtype} % Subliminal refinements towards typographical perfection - eg. Hypernation
\usepackage{lastpage} % For page of pages
\usepackage[svgnames,hyperref]{xcolor} % svg colors
\usepackage[
  language=english,
  title={\MetaTitle{}},
  author={\MetaAuthor{}},
  type=master,
  institute=iste,
  course={Softwareengineering},
  examiner={Prof.\ Dr.\ Erhard Plödereder},
  supervisor={Dr.\ Timm Felden},
  startdate={April 11, 2018},
  enddate={October 11, 2018},
]{scientific-thesis-cover}

%---------------------------------
% Environment
%---------------------------------
\usepackage{longtable} % base for tabu (longtabu)
\usepackage{tabu} % Good table environment - best?
\usepackage{enumitem} % Improved enumerate/itemize/description env
\usepackage{graphicx} % for graphics -> \includegraphics
\usepackage{listings-rust}
\usepackage{listings}
\usepackage{tikz}
\usepackage{tikz-qtree}
\usepackage{pgfplots}
\usepackage{wrapfig}
\usepackage{pgfplotstable}


%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
% CONFIGURATIONS
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
%---------------------------------
% Image folders
%---------------------------------
\graphicspath{{./img}}

%---------------------------------
% Biographie
%---------------------------------
\addbibresource{lit.bib}

%---------------------------------
% Import the glossary
%---------------------------------
\input{glossary}

%---------------------------------
% Tikz libs
%---------------------------------
\usetikzlibrary{arrows.meta}
\usetikzlibrary{calc}
\usetikzlibrary{fit}
\usetikzlibrary{positioning}
\usetikzlibrary{trees}
\usetikzlibrary{shapes}
\usetikzlibrary{matrix}

\usetikzlibrary{external}
\tikzexternalize
\makeatletter
\tikzset{%
  external/system call={%
      pdflatex %
      \tikzexternalcheckshellescape %
      -halt-on-error %
      -interaction=batchmode %
      -output-directory="latex.out" %
      -jobname "\image" %
      "\texsource"%
    },
}
\makeatother

%---------------------------------
% PGF Layer
%---------------------------------
\pgfdeclarelayer{bg}    % declare background layer
\pgfdeclarelayer{fg}    % declare background layer
\pgfsetlayers{bg,main,fg}  % set the order of the layers (main is the standard layer)

%---------------------------------
% Intex date format
%---------------------------------
\newdateformat{myInTextDateFormat}{%
  \ordinaldate{\THEDAY}\ \monthname[\THEMONTH] \THEYEAR%
}

%---------------------------------
% Normal Font for header and footer
%---------------------------------
\setkomafont{pageheadfoot}{\normalfont\sffamily}
\setkomafont{pagenumber}{\normalfont}

%---------------------------------
% Less space between list items
%---------------------------------
\setlist{itemsep=.5em}
\setlist{parsep=.5em}

%---------------------------------
% Meta data and Link Colour
%---------------------------------
\newcommand{\myShade}{70}

\definecolor{mylinkcolor}{RGB}{113, 31, 155}
\definecolor{mycitecolor}{RGB}{255, 189, 76}
\definecolor{myurlcolor}{RGB}{62, 106, 171}

\hypersetup{
  pdfauthor   = {\MetaAuthor},
  pdftitle    = {\MetaTitle},
  pdfsubject  = {\MetaTitle},
  pdfkeywords = {\MetaUniversity, \MetaTitle},
  colorlinks  = true,
  linkcolor   = mylinkcolor!\myShade!black,
  citecolor   = mycitecolor!\myShade!black,
  urlcolor    = myurlcolor!\myShade!black,
}

%---------------------------------
% Microtype optimisations
%---------------------------------
% http://www.khirevich.com/latex/microtype/
\SetProtrusion{encoding={*},family={bch},series={*},size={6,7}}
{1={ ,750},2={ ,500},3={ ,500},4={ ,500},5={ ,500},%
  6={ ,500},7={ ,600},8={ ,500},9={ ,500},0={ ,500}}
\SetExtraKerning[unit=space]
{encoding={*}, family={bch}, series={*}, size={footnotesize,small,normalsize}}
{%
\textendash={400,400}, % en-dash, add more space around it
"28={ ,150}, % left bracket, add space from right
"29={150, }, % right bracket, add space from left
\textquotedblleft={ ,150}, % left quotation mark, space from right
\textquotedblright={150, } % right quotation mark, space from left
}
\SetExtraKerning[unit=space]
{encoding={*}, family={qhv}, series={b}, size={large,Large}}
{%
  1={-200,-200},%
  \textendash={400,400}%
}
\SetTracking{encoding={*}, shape=sc}{20}
\microtypecontext{spacing=nonfrench}

%---------------------------------
% Caption format
%---------------------------------
\captionsetup{
  format=plain,
  indention=.5cm,
  labelfont=bf,
  justification=justified,
  %single line captions should be centered, multiline captions justified
  singlelinecheck=true
}

%---------------------------------
% Listings style
%---------------------------------
% This is a hack for sourcecode pro
% See https://github.com/silkeh/latex-sourcecodepro/issues/4
\makeatletter
\lst@CCPutMacro
\lst@ProcessOther {"60}{%
\lst@ttfamily{\raisebox{4pt}{\`{}}}% used with ttfamily
\textasciigrave%
}% used with other fonts
\@empty\z@\@empty
\makeatother

\lstdefinestyle{myStyle}{
belowcaptionskip=1\baselineskip,
breaklines=true,
xleftmargin=\parindent,
basicstyle={\color{white!10!black}\small\ttfamily},
keywordstyle=[1]{\bfseries\color[rgb]{0,.3,.7}},
keywordstyle=[2]{\bfseries\color{Orange}},
keywordstyle=[3]{\bfseries\color{Coral}},
keywordstyle=[4]{\bfseries\color{Teal}},
keywordstyle=[5]{\color{SaddleBrown}},
keywordstyle=[6]{\color{DodgerBlue!75!black}},
keywordstyle=[7]{\color{black}},
commentstyle={\color{DimGray}},
stringstyle={\color{DarkGreen}},
numberstyle={\tiny\color{Gray}},
identifierstyle={\color{black}},
breaklines=true,
breakatwhitespace=true,
keepspaces,
aboveskip=0.8em,
belowcaptionskip=-1em,
literate={%
{Ö}{{\"O}}1%
{Ä}{{\"A}}1%
{Ü}{{\"U}}1%
{ß}{{\ss}}1%
{ü}{{\"u}}1%
{ä}{{\"a}}1%
{ö}{{\"o}}1%
{~}{{\textasciitilde}}1%
{fl}{{f{}l}}2%
{fi}{{f{}i}}2%
},
}
\lstdefinestyle{myInlineStyle}{
style=myStyle,
basicstyle={\color{white!15!black}\small\ttfamily},
keywordstyle=[1]{},
keywordstyle=[2]{},
keywordstyle=[3]{},
keywordstyle=[4]{},
keywordstyle=[5]{},
keywordstyle=[6]{},
keywordstyle=[7]{},
commentstyle={},
stringstyle={},
numberstyle={},
identifierstyle={},
moredelim=[s][{}]{\#[}{]},
}

\lstdefinestyle{myEnvStyle}{
  style=myStyle,
  frameshape={RYR}{Y}{Y}{RYR},
  captionpos=b,
  numbers=left,
}

%---------------------------------
% Listing shorthandles
%---------------------------------
\newcommand\cod{\lstinline[style=myInlineStyle]} % the body {} is evaluated by lstinline - this leads to the highest compatibility.
\newcommand\codc{\lstinline[language=C++, style=myInlineStyle]} % the body {} is evaluated by lstinline - this leads to the highest compatibility.
\newcommand\codr{\lstinline[language=Rust, style=myInlineStyle]} % the body {} is evaluated by lstinline - this leads to the highest compatibility.
\newcommand\codj{\lstinline[language=Java, style=myInlineStyle]} % the body {} is evaluated by lstinline - this leads to the highest compatibility.
\newcommand\cods{\lstinline[language=Scala, style=myInlineStyle]} % the body {} is evaluated by lstinline - this leads to the highest compatibility.

%---------------------------------
% Setup Listings cations for subfigures
%---------------------------------
\providecommand*{\lstlistingautorefname}{\lstlistingname}
\providecommand*{\sublstlistingautorefname}{\lstlistingname}
\providecommand*{\subfigureautorefname}{Figure}
\AfterPreamble{\newsubfloat{lstlisting}}

%---------------------------------
% Make naming scheme coherent
%---------------------------------
\renewcommand*{\lstlistlistingname}{List of Listings}

%---------------------------------
% Prevent single page figures with no text
%---------------------------------
\setcounter{topnumber}{1}
\setcounter{bottomnumber}{1}
\setcounter{totalnumber}{3}
\renewcommand{\topfraction}{0.85}
\renewcommand{\bottomfraction}{0.95}
\renewcommand{\textfraction}{0.1}
\renewcommand{\floatpagefraction}{0.75}

%---------------------------------
% No backwardscompatibility
%---------------------------------
\pgfplotsset{compat=1.16}

%---------------------------------
% Fix hypernation
%---------------------------------
\hyphenation{Zei-len-um-bruch}

%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
% COMMANDS
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
%---------------------------------
% Ref footnotes
%---------------------------------
\makeatletter
\newcommand{\myFootnoteref}[1]{\protected@xdef\@thefnmark{\ref{#1}}\@footnotemark}
\makeatother

%---------------------------------
% hyphen used between two capitals
%---------------------------------
\newcommand{\myCapitalHyphen}{%
  \raisebox{0.24ex}{%
    \resizebox{0.4em}{%
      \height%
    }{-}%
  }%
  \kern-0.07em%
}

%---------------------------------
% href Link as foot note
%---------------------------------
\newcommand{\myFnUrl}[2]{%
  \ifthenelse{\equal{#1}{}}{%
    \footnote{\url{#2}}%
  }{%
    \href{#2}{#1}\footnote{ \url{#2}}%
  }%
}

%---------------------------------
% Horizontal line for title page
%---------------------------------
\newcommand{\HRule}{\rule{\linewidth}{0.2mm}}

%-------------------
% Command to break text without spaces or hyphens
%-------------------
\newcommand\myTextBreaker[1]{\tbhelp#1\relax\relax\relax}
\def\tbhelp#1#2\relax{{#1}\penalty0\ifx\relax#2\else\tbhelp#2\relax\fi}

%-------------------
% Command to break urls without spaces or hyphens
%-------------------
\makeatletter
\catcode`\%=12
\newcommand\pcnt{\%}
\catcode`\%=14

\catcode`\_=12
\newcommand\unsc{\_}
\catcode`\_=8

\newcommand*\myURLBreaker{\myURLBreaker@iii\myURLBreaker@i}
\newcommand*\myURLBreaker@iii[1]{\begingroup\catcode`\_12\catcode`\%12 #1}
\newcommand*\myURLBreaker@i[1]{\href{#1}{\ubhelp#1\relax\relax\relax}\endgroup}
\def\ubhelp#1#2\relax{{#1}\penalty0\ifx\relax#2\else\ubhelp#2\relax\fi}
\makeatother

%-------------------
% Convenience command to create a nested table
%-------------------
\newcommand{\specialcell}[2][l]{%
  \setlength{\extrarowheight}{0pt}%
  \def\arraystretch{1}%
  \tabulinesep=.025em%
  \begin{tabular}[t]{@{}#1@{}}#2\end{tabular}%
}

%-------------------
% Listings Shortcuts
%-------------------
\ExplSyntaxOn
\NewDocumentCommand{\makestring}{om} {
  \tl_set:Nn \l_input_tl { #2 }
  \regex_replace_all:nnN {[^a-zA-Z]} {} \l_input_tl
  \IfNoValueTF{#1} {
    \tl_use:N \l_input_tl
  } {
    \tl_set_eq:NN #1 \l_input_tl
  }
}
\ExplSyntaxOff

\newcommand\LstCut[1]{%
  \makestring[\tmp]{#1}%
  \expandafter\def\csname\tmp\endcsname{\cod{#1}\xspace}%
  \expandafter\def\csname\tmp s\endcsname{\cod{#1}s\xspace}%
}
\LstCut{AgeObject}
\LstCut{Age}
\LstCut{age}
\LstCut{Arc<T>}
\LstCut{A}
\LstCut{B}
\LstCut{cast()}
\LstCut{CastAble}
\LstCut{Cell<T>}
\LstCut{default}
\LstCut{Deleteable}
\LstCut{enum}
\LstCut{FieldDeclaration}
\LstCut{FileReader}
\LstCut{FileWriter}
\LstCut{File}
\LstCut{Foo}
\LstCut{foreign_data}
\LstCut{ForeignFieldData}
\LstCut{ForeignFieldDeclaration}
\LstCut{ForeignObject}
\LstCut{ForeignPool}
\LstCut{Foreign}
\LstCut{for}
\LstCut{fun()}
\LstCut{F}
\LstCut{gun()}
\LstCut{HashMap}
\LstCut{HazardPtr<T>}
\LstCut{hun()}
\LstCut{id}
\LstCut{match}
\LstCut{mod}
\LstCut{Mutex<T>}
\LstCut{Node}
\LstCut{None}
\LstCut{nun()}
\LstCut{open()}
\LstCut{Option<T>}
\LstCut{panic}
\LstCut{PartsMaker}
\LstCut{PoolMaker}
\LstCut{PoolProxy}
\LstCut{Pool}
\LstCut{Ptr<T>}
\LstCut{pub(crate)}
\LstCut{pub}
\LstCut{Rc<RefCell<T>>}
\LstCut{Rc<T>}
\LstCut{Read}
\LstCut{Ref<T>}
\LstCut{RefCell<T>}
\LstCut{RefMut<T>}
\LstCut{RwLock<T>}
\LstCut{self}
\LstCut{Self}
\LstCut{Send}
\LstCut{Sized}
\LstCut{skill_id}
\LstCut{SkillFail}
\LstCut{SkillFileBuilder}
\LstCut{SkillFile}
\LstCut{SkillObject}
\LstCut{SkillString}
\LstCut{Some<T>}
\LstCut{Some}
\LstCut{static}
\LstCut{StringBlock}
\LstCut{StringPool}
\LstCut{String}
\LstCut{struct}
\LstCut{Sync}
\LstCut{TraitObject}
\LstCut{trait}
\LstCut{type_id}
\LstCut{T}
\LstCut{UnsafeCell<T>}
\LstCut{unsafe}
\LstCut{UserFieldDeclaration}
\LstCut{UserPartsMaker}
\LstCut{UserTypePool}
\LstCut{UserType}
\LstCut{use}
\LstCut{U}
\LstCut{Vec<T>}
\LstCut{Vec}
\LstCut{Weak<T>}
\LstCut{x}
\LstCut{y}

%-------------------
% Use Tikz to externalize lst pictures
%-------------------
\NewDocumentCommand{\LstTikzBox}{mO{.949\linewidth}mO{}}%
{%
\newsavebox{#1}%
\begin{lrbox}{#1}%
  \begin{tikzpicture}[every node/.style={inner sep=0,outer sep=0}]%
    \node{%
      \hspace*{18pt}%
      \begin{minipage}{#2}%
        \vspace*{-2pt}
        \lstinputlisting[%
          style=myEnvStyle,%
          language=Rust,%
          nolol=ture,%
          #4%
        ]{#3}%
        \vspace*{-6pt}
      \end{minipage}%
      \hspace*{4pt}%
    };%
  \end{tikzpicture}%
\end{lrbox}%
}
\NewDocumentCommand{\LstTikzFig}{ommmO{}}%
{%
  \IfNoValueTF{#1}{%
    \edef\tmp{\csname#4\endcsname}%
    \expandafter\LstTikzBox\tmp{#2}[#5]%
    \begin{figure}[ht]%
      \captionsetup{type=lstlisting}%
      \centering%
      \expandafter\usebox{\tmp}%
      \caption{#3}\label{#4}%
    \end{figure}%
  }{%
    \lstinputlisting[%
      style=myEnvStyle,%
      language=Rust,%
      nolol=ture,%
      caption={#3},
      label={#4},
      #5%
    ]{#2}%
  }%
}

%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
% Environments
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
% custom legend environment to support horizontal legends
\makeatletter
\newenvironment{customlegend}[1][]{%
  \begingroup
  % inits/clears the lists (which might be populated from previous
  % axes):
  \pgfplots@init@cleared@structures
  \pgfplotsset{#1}%
}{%
  % draws the legend:
  \pgfplots@createlegend
  \endgroup
}%

% makes \addlegendimage available (typically only available within an
% axis environment):
\def\addlegendimage{\pgfplots@addlegendimage}
\makeatother

%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
% Special treatment
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
\usepackage{subfiles}