summaryrefslogtreecommitdiff
path: root/Master/texmf-dist/doc
diff options
context:
space:
mode:
authorKarl Berry <karl@freefriends.org>2019-07-10 20:28:04 +0000
committerKarl Berry <karl@freefriends.org>2019-07-10 20:28:04 +0000
commit38035d16f502e46fac8ff2451219410a87edf7e9 (patch)
treea1a50aaf29dd083a241b73ed66c7136d58252637 /Master/texmf-dist/doc
parentdd5347d453541300a1195d59f647c2760c44cf56 (diff)
codeanatomy (10jul19)
git-svn-id: svn://tug.org/texlive/trunk@51596 c570f23f-e606-0410-a88d-b1316a301751
Diffstat (limited to 'Master/texmf-dist/doc')
-rw-r--r--Master/texmf-dist/doc/latex/codeanatomy/README.md58
-rw-r--r--Master/texmf-dist/doc/latex/codeanatomy/codeanatomy.lstlisting.pdfbin0 -> 123804 bytes
-rw-r--r--Master/texmf-dist/doc/latex/codeanatomy/codeanatomy.lstlisting.tex591
-rw-r--r--Master/texmf-dist/doc/latex/codeanatomy/codeanatomy.pdfbin0 -> 94180 bytes
-rw-r--r--Master/texmf-dist/doc/latex/codeanatomy/codeanatomy.usage.pdfbin0 -> 82732 bytes
-rw-r--r--Master/texmf-dist/doc/latex/codeanatomy/codeanatomy.usage.tex383
-rw-r--r--Master/texmf-dist/doc/latex/codeanatomy/literatur.bib8
7 files changed, 1040 insertions, 0 deletions
diff --git a/Master/texmf-dist/doc/latex/codeanatomy/README.md b/Master/texmf-dist/doc/latex/codeanatomy/README.md
new file mode 100644
index 00000000000..bc619b60850
--- /dev/null
+++ b/Master/texmf-dist/doc/latex/codeanatomy/README.md
@@ -0,0 +1,58 @@
+# `codeanatomy` -- Draw Code Anatomy
+
+(C) 2019 Hồng-Phúc Bùi
+
+The idea of this Package is to typeset illustrations of pieces of code with
+annotations on each single parts of code (Code Anatomy). The origin of this idea is
+code illustrations in the texbook _Computer Science An Interdisciplinary Approach_
+from Robert Sedgewick and Kevin Wayne.
+
+This package just provides tools to draw those figures.
+
+Some illustrations can be found here:
+
+https://introcs.cs.princeton.edu/java/home/
+
+for example the origin illustation of static method in java:
+<img src="https://introcs.cs.princeton.edu/java/11cheatsheet/images/function.png">
+
+
+## Licence
+
+This package may be distributed and/or modified under the conditions of the
+LaTeX Project Public License (LPPL), either version 1.3c of this
+License or any later version. The latest version
+of this license is in the file https://www.latex-project.org/lppl.txt
+
+## Build and Install (for Distributor)
+* To build the style file `codeanatomy.sty` just run **one** of
+
+```
+latex codeanatomy.ins
+pdflatex codeanatomy.ins
+xelatex codeanatomy.ins
+lualatex codeanatomy.ins
+```
+
+then you can copy `codeanatomy.sty` to your local `texmf` tree, where latex can find it.
+
+* To create PDF Document manual you must use `lualatex`
+
+```
+lualatex codeanatomy.dtx
+lualatex codeanatomy.usage.tex
+lualatex codeanatomy.lstlisting.tex
+```
+
+(`lualatex` because of my name, really ego right! It needs unicode to be typeset correctly.)
+
+## Development
+I try to use latex3 as much as posible. You can use
+
+```
+l3build doc
+```
+
+to create the style file and documentation files at once. You can also (like I also do) use `make`
+to call repeatly tasks.
+
diff --git a/Master/texmf-dist/doc/latex/codeanatomy/codeanatomy.lstlisting.pdf b/Master/texmf-dist/doc/latex/codeanatomy/codeanatomy.lstlisting.pdf
new file mode 100644
index 00000000000..f1f9f9e2876
--- /dev/null
+++ b/Master/texmf-dist/doc/latex/codeanatomy/codeanatomy.lstlisting.pdf
Binary files differ
diff --git a/Master/texmf-dist/doc/latex/codeanatomy/codeanatomy.lstlisting.tex b/Master/texmf-dist/doc/latex/codeanatomy/codeanatomy.lstlisting.tex
new file mode 100644
index 00000000000..2c8e536dbc6
--- /dev/null
+++ b/Master/texmf-dist/doc/latex/codeanatomy/codeanatomy.lstlisting.tex
@@ -0,0 +1,591 @@
+\documentclass[full]{l3doc}
+
+\usepackage{fontspec}
+\usepackage[backend=biber]{biblatex}
+\addbibresource{literatur.bib}
+
+\usepackage{codeanatomy}
+
+\usepackage{listings}
+\lstset {
+ basicstyle=\small\ttfamily%
+ ,language=%
+ ,escapeinside={!}{!}%
+ ,resetmargins=true%
+ ,columns=flexible%
+ ,literate={-}{-}1%
+ ,keepspaces=true
+}
+
+\def\thinmargin{\list{}{\rightmargin-30pt\leftmargin-70pt}\item[]}
+\let\endthinmargin=\endlist
+
+\usepackage{filecontents}
+
+% others shortcuts
+\newcommand{\slsh}{\textbackslash{}}
+\newcommand{\TikZ}{Ti\textit{k}Z}
+\newcommand{\inputlisting}[1]{%
+\lstinputlisting[%
+ basicstyle=\footnotesize\ttfamily%
+ ,xleftmargin=-70pt%
+ ,resetmargins=true%
+ ,firstline=5%
+ ,language=%
+ ,columns=flexible%
+ ,escapeinside={}{}%
+ ]{#1}%
+}
+
+\usepackage{hyperref}
+
+\GetFileInfo{codeanatomy.sty}
+\DoNotIndex{}
+
+\title{
+ \pkg{codeanatomy} -- Draw Code Anatomy%
+ \thanks{This file describes \fileversion,
+ last revised \filedate.}\\\vspace*{2ex}
+ \normalsize{Usage with \pkg{listings}}
+}
+
+\author{
+ Hồng-Phúc Bùi
+ \thanks{
+ E-mail:
+ \href{mailto:Hồng-Phúc Bùi}
+ {hong-phuc.bui (at) htwsaar dot de}
+ }
+}
+
+\date{Released \filedate}
+
+\AtEndDocument{
+ \printbibliography
+}
+
+\begin{document}
+
+\maketitle
+\tableofcontents
+
+\section{General Usage in Conjuntion with Package \pkg{listings}}
+\subsection{Setup Package \pkg{listings}}
+The most important setup for the package \pkg{listings} is the delimiter to escape \LaTeX{}
+commands in Listing. With this escape delimiter we can mark a piece of code as with |\cPart|.
+In this example we use |!| and |!| as delimiter. Code between |!| and |!| is evaluated as
+\LaTeX{}-code.
+
+\lstset {
+ escapeinside={+}{+}
+}
+\begin{thinmargin}
+\begin{tikzpicture}[remember picture]
+% {[on background layer]\draw[code grid debug] (-3.5,-0.5) grid (5.5,4.5);}
+\node(code) [anatomy] at (0,0){%
+\begin{lstlisting}
+\usepackage{codeanatomy}
+\usepackage{listings}
+\lstset {
+ basicstyle=\small\ttfamily
+ ,escapeinside=+\cPart{delimiter}{\{!\}\{!\}}+
+}
+\end{lstlisting}
+};
+\codeAnnotation{delimiterText} (4,-0.5) {Setup \texttt{!} and \texttt{!}\\as delimiter}
+
+\draw[->, annotation] (delimiterText) -- (delimiter);
+\end{tikzpicture}
+\end{thinmargin}
+
+
+Delimiter can also be reset in |document|-Environment, typical just before a new \verb:\begin{lstlisting}:
+environment so each anatomy can have different delimiter. The fact is, in this document I use |+| and |+| for
+the above listing, so that I can typeset |!| in this listing.
+
+\subsection{Typeset Code}
+The command |\codeBlock| does not work if the environment |lstlisting| is passed to its argument. So instead of
+|\codeBlock| we must use the \TikZ{} command |\node|:
+
+\begin{thinmargin}
+\begin{tikzpicture}[remember picture]
+\node(code) [anatomy] at (0,0) {
+\begin{lstlisting}
+\begin{tikzpicture}[remember picture]
++\cPart{tikzNode}{\slsh{}node(code) [anatomy] at (0,0)}+ {
++\cPart{listingBegin}{\texttt{\slsh{}begin\{lstlisting\}}}\vspace{1.5pt}+
++\mtPoint{mostLeft}+function gcd(p,q) {
+ if (q === 0) {
+ return q;
+ }else{
+ let r = p % q;
+ return gcd(q, r);+\extremPoint{mostRight}+
+ }
+}+\mbPoint{mostBottom}+
++\cPart{listingEnd}{\texttt{\slsh{}end\{lstlisting\}}}+
+}+\cPart{semiColon}{;}+
+\end{tikzpicture}
+\end{lstlisting}
+};
+
+\fitExtrem{listingContent}{(mostLeft) (mostRight) (mostBottom)}
+
+% Annotations
+\codeAnnotation{tikzNodeText} (-2, 5.5) {use \texttt{\slsh{}node}\\instead of\\\texttt{\slsh{}codeBlock}}
+\codeAnnotation{listingText} (-2, 3) {typeset code\\in\\\texttt{lstlisting}\\environment}
+\codeAnnotation{listingContentText} (6.5, 3) {whitespaces\\in code\\are kept}
+\codeAnnotation{semiColonText} (6.5, 0.6) {don't forget\\semicolon}
+
+% Arrows from labels to code parts
+\draw[->,annotation] (tikzNodeText) -- (tikzNode.west);
+\draw[->,annotation] (listingText) -- (listingBegin.west);
+\draw[->,annotation] (listingText) -- (listingEnd.west);
+\draw[->,annotation] (listingContentText) -- (listingContent);
+\draw[->,annotation] (semiColonText) -- (semiColon);
+\end{tikzpicture}
+\end{thinmargin}
+
+Figure~\ref{fig:full-formatted-code} shows result of the above code.
+
+\begin{figure}[ht]
+\centering
+\begin{tikzpicture}[remember picture]
+\node(code) [anatomy] at (0,0) {
+\begin{lstlisting}
+function gcd(p,q) {
+ if (q === 0) {
+ return q;
+ }else{
+ let r = p % q;
+ return gcd(q, r)
+ }
+}
+\end{lstlisting}
+};
+\end{tikzpicture}
+\caption{Code Listing is formatted\label{fig:full-formatted-code}}
+\end{figure}
+
+\subsection{Mark Code}
+% --------------------
+
+The command |\cPart| can be used to mark single-line code parts. For
+multiple-line code parts once can use |\extremPoint| to mark the outer most
+points of code parts and |\fitExtrem| to cover exterm points of a code part.
+These commmands must be put in delimiter, here |!| and |!|.
+
+\begin{thinmargin}
+\begin{tikzpicture}[remember picture]
+\node(code) [anatomy] at (0,0) {
+\begin{lstlisting}
+\begin{tikzpicture}[remember picture]
+\node(code) [anatomy] at (0,0) {
++\texttt{\slsh{}begin\{lstlisting\}}+
+!\cPart{fnHead}{function \cPart{fnName}{gcd}\cPart{paramList}{(p,q)}}! {
+ +\cPart{ep1}{!\slsh{}mtPoint\{mostLeft\}!}+if (q === 0) {
+ return q;
+ }else{
+ +\cPart{cp}{!\slsh{}cPart\{localVar\}\{let r\}!}+ = p % q;
+ return gcd(q, r);+\cPart{ep2}{!\slsh{}extremPoint\{mostRight\}!}+
+ }+\cPart{ep3}{!\slsh{}mbPoint\{mostBottom\}!}+
+}
++\texttt{\slsh{}end\{lstlisting\}}+
+};
+\fitExtrem{fnBody}{(mostLeft) (mostRight) (mostBottom)}
+\end{tikzpicture}
+\end{lstlisting}
+};
+% Annotations
+\codeAnnotation{epText} (11,2.5) {\texttt{extremPoint}-s mark\\outer most\\of the function body}
+\codeAnnotation{cpText} (-2,3) {\texttt{cPart} marks a\\single line\\code part}
+% Arrows
+\draw[->,annotation] (epText) -- (ep1.south east);
+\draw[->,annotation] (epText) -- (ep2.east);
+\draw[->,annotation] (epText) -- (ep3.south east);
+\draw[->,annotation] (cpText) -- (cp);
+\end{tikzpicture}
+\end{thinmargin}
+
+Figure~\ref{fig:listing-code-parts} shows the result of the above code.
+
+\begin{figure}[ht]
+\centering
+\lstset{escapeinside={!}{!}}
+\begin{tikzpicture}[remember picture]
+\node(code) [anatomy] at (0,0) {
+\begin{lstlisting}
+!\cPart{fnHead}{function \cPart{fnName}{gcd}\cPart{paramList}{(p,q)}}! {
+ !\mtPoint{mostLeft}!if (q === 0) {
+ return q;
+ }else{
+ !\cPart{localVar}{let r}! = p % q;
+ return gcd(q, r);!\extremPoint{mostRight}!
+ }!\mbPoint{mostBottom}!
+}
+\end{lstlisting}
+};
+\fitExtrem{fnBody}{(mostLeft) (mostRight) (mostBottom)}
+\end{tikzpicture}
+\caption{Code Listing with mark of code parts\label{fig:listing-code-parts}}
+\end{figure}
+
+\subsection{Add Annotations to Listing}
+% -------------------------------------
+This step is the same as the description in the main document of package \pkg{codeanatomy}.
+Readers can typeset annotations to the above listing like an exercise.
+
+
+
+
+
+
+\section{Some examples}
+% ====================
+% Reset to standard
+
+Most of examples in this section are redrawn from the textbook~\autocite{sedgewick-wayne-2016}.
+
+\subsection{Anatomy of a Java Program~\autocite[5]{sedgewick-wayne-2016}}
+% -----------------------------------
+
+\begin{filecontents}{java-program.tex}
+\lstset{escapeinside={!}{!}}
+\begin{tikzpicture}[remember picture]
+\node(code) [anatomy] at (0,0){%
+\begin{lstlisting}
+public !\iPart{class}{class}! !\cPart{className}{HelloWorld}!
+{
+ !\mtPoint{mainLeft}!public static void main(String[] argv)
+ {
+ !\hmtPoint{left}\iPart{assign}{
+ \bgcode{// Prints "Hello World" in the terminal window}}
+ \extremPoint{fnR} \extremPoint{mR}!
+ !\iPart{fnCall}{System.out.print( "Hello World");}\dmbPoint{mostBottom}!
+ }!\mbPoint{mainBottom}!
+}
+\end{lstlisting}
+};
+
+\fitExtrem{classBody}{(mainLeft) (mR) (mainBottom)}
+\fitExtrem{functionBody}{(left) (fnR) (mostBottom)}
+
+
+\codeAnnotation{fileNameText} (1.5,5) {text file named \texttt{HelloWorld.java}}
+\codeAnnotation{classNameText} (3.5,4.25) {name}
+\codeAnnotation{classBodyText} (6.5,3.6) {\texttt{main()} method}
+\codeAnnotation{functionBodyText} (2.5,-0.5) {body}
+\codeAnnotation{statement} (8,0) {statements}
+
+\draw[->,annotation] (fileNameText) -- (class);
+\draw[->,annotation] (classNameText) -- (className);
+\draw[->,annotation] (classBodyText.south west) -- (classBody);
+\draw[->,annotation] (functionBodyText) -- (functionBody);
+\draw[->,annotation] (statement) -- (assign.353);
+\draw[->,annotation] (statement) -- (fnCall.350);
+\end{tikzpicture}
+\end{filecontents}
+
+\begin{thinmargin}
+\inputlisting{java-program.tex}
+\end{thinmargin}
+
+\input{java-program.tex}
+
+\subsection{Anatomy of an expression~\autocite[17]{sedgewick-wayne-2016}}
+% -----------------------------------
+
+\begin{filecontents}{java-expression.tex}
+\lstset{escapeinside={!}{!}}
+\begin{tikzpicture}[remember picture]
+\codeBlock{\cPart{op1}{4} \cPart{op}{*} \cPart{op2}{( x - 3 )} }
+
+\codeAnnotation{operand} (1,1.5) {operands\\(and expression)}
+\codeAnnotation{operator} (0.7,-1) {operator}
+
+\draw[->,annotation] (operand) -- (op1.north);
+\draw[->,annotation] (operand) -- (op2.north);
+\draw[->,annotation] (operator) -- (op.south);
+\end{tikzpicture}
+\end{filecontents}
+
+\begin{thinmargin}
+ \inputlisting{java-expression.tex}
+\end{thinmargin}
+
+\input{java-expression.tex}
+
+\subsection{Using a primitive Data Type~\autocite[17]{sedgewick-wayne-2016}}
+% -------------------------------------
+
+\begin{filecontents}{using-a-primitive-data-type.tex}
+\lstset{escapeinside={!}{!}}
+\begin{tikzpicture}[
+ remember picture %
+ ,code annotation/.append style = { % customize style of annotation text
+ font=\sffamily\footnotesize
+ }
+]
+{[on background layer]\draw[code grid debug] (-2.5,-0.5) grid (2.5,2.5);}
+\node(code) [anatomy] at (0,0){%
+\begin{lstlisting}
+!\cPart{d}{int a, b;}!
+!\iPart{v}{a}! = !\cPart{l}{1234}!;
+!\iPart{a}{b = 99}!;
+!\cPart{i}{int c = a + b}!;
+\end{lstlisting}
+};
+% Annotations
+\codeAnnotation{declareText} ( 1,2.75 ) {declaration statement}
+\codeAnnotation{literalText} ( 2.5,1.45) {literal}
+\codeAnnotation{varText} (-1.5,1.75 ) {variable name}
+\codeAnnotation{assignText} (-1.5,0.75 ) {assignment\\statement}
+\codeAnnotation{initText} (-1.5,-0.75) {inline initialization\\statement}
+% Arrows
+\draw[->,annotation] (declareText) -- (d);
+\draw[->,annotation] (literalText) -- (l);
+\draw[->,annotation] (varText.south east) -- (v);
+\draw[->,annotation] (assignText) -- (a);
+\draw[->,annotation] (initText) -- (i.south west);
+\end{tikzpicture}
+\end{filecontents}
+
+\begin{thinmargin}
+ \inputlisting{using-a-primitive-data-type.tex}
+\end{thinmargin}
+
+\input{using-a-primitive-data-type.tex}
+
+\subsection{Anatomy of a method signature~\autocite[30]{sedgewick-wayne-2016}}
+% ---------------------------------------
+
+\begin{filecontents}{anatomy-of-a-method-signature.tex}
+\lstset{escapeinside={!}{!}}
+\begin{tikzpicture}[remember picture]
+\node(code) [anatomy] at (0,0) {
+\begin{lstlisting}
+public class !\iPart{l}{Math}!
+ ....
+ !\cPart{s}{\bgcode{static} \iPart{r}{double} \iPart{n}{sqrt}(\iPart{a}{double} a)}!
+ ....
+\end{lstlisting}
+};
+% Annotation
+\codeAnnotation{lText} (3,2.5) {library name}
+\codeAnnotation{sText} (-1,1) {signature}
+\codeAnnotation{nText} (4.5,1.5) {method name}
+\codeAnnotation{rText} (2.0,-0.51) {return type}
+\codeAnnotation{aText} (4.5,-0.51) {argument type}
+% Arrows
+\draw[->, annotation] (lText) -- (l);
+\draw[->, annotation] (nText) -- (n);
+\draw[->, annotation] (sText) -- (s);
+\draw[->, annotation] (rText) -- (r);
+\draw[->, annotation] (aText) -- (a);
+\end{tikzpicture}
+\end{filecontents}
+
+\begin{thinmargin}
+ \inputlisting{anatomy-of-a-method-signature.tex}
+\end{thinmargin}
+
+\input{anatomy-of-a-method-signature.tex}
+
+\subsection{Using a library method~\autocite[30]{sedgewick-wayne-2016}}
+% --------------------------------
+
+\begin{filecontents}{using-a-library-method.tex}
+\begin{tikzpicture}[remember picture]
+\codeBlock{%
+\iPart{r}{double} d = \iPart{l}{Math}.\iPart{m}{sqrt}(\iPart{a}{b*b - 4.0*a*c)};
+}
+% Annotation
+\codeAnnotation{lText} (2, 1.125) {library name}
+\codeAnnotation{mText} (4.5, 1.125) {method name}
+\codeAnnotation{rText} (2,-0.7) {return type}
+\codeAnnotation{aText} (4,-0.7) {argument}
+% Arrows
+\draw[->,annotation] (lText) -- (l);
+\draw[->,annotation] (mText) -- (m);
+\draw[->,annotation] (rText.north west) -- (r);
+\draw[->,annotation] (aText.north east) -- (a);
+\end{tikzpicture}
+\end{filecontents}
+
+\begin{thinmargin}
+ \inputlisting{using-a-library-method.tex}
+\end{thinmargin}
+
+\input{using-a-library-method.tex}
+
+\subsection{Anatomy of an \texttt{if} statement~\autocite[51]{sedgewick-wayne-2016}}
+% ---------------------------------------------
+
+\begin{filecontents}{anatomy-of-an-if-statement.tex}
+\lstset{escapeinside={!}{!}}
+\begin{tikzpicture}[remember picture]
+% {[on background layer]\draw[code grid debug] (-2.5,-0.5) grid (2.5,2.5);}
+\node(code) [anatomy] at (0,0) {%
+\begin{lstlisting}
+if (!\cPart{e}{x > y}!)
+{
+ int t = x;!\mtPoint{tr}!
+ x = y;
+ !\mbPoint{bl}! y = t;!\extremPoint{br}!
+}
+\end{lstlisting}
+};
+
+\fitExtrem{b}{(tr) (bl) (br)}
+% Annotation
+\codeAnnotation{eText} (1,3.5) {boolean\\expression}
+\codeAnnotation{bText} (-1,1.125) {sequence\\of\\statements}
+% Arrow
+\draw[->,annotation] (eText) -- (e);
+\draw[->,annotation] (bText) -- (b);
+\end{tikzpicture}
+\end{filecontents}
+
+\begin{thinmargin}
+ \inputlisting{anatomy-of-an-if-statement.tex}
+\end{thinmargin}
+
+\input{anatomy-of-an-if-statement.tex}
+
+\subsection{Anatomy of a \texttt{while} loop~\autocite[54]{sedgewick-wayne-2016}}
+% ------------------------------------------
+
+\begin{filecontents}{anatomy-of-a-while-loop.tex}
+\lstset{escapeinside={!}{!}}
+\begin{tikzpicture}[remember picture]
+% {[on background layer]\draw[code grid debug] (-2.5,-0.5) grid (2.5,2.5);}
+\node(code) [anatomy] at (0,0) {
+\begin{lstlisting}
+!\cPart{i}{\bgcode{int power = 1;}}\phantom{\rule[-2ex]{0.1ex}{0.1ex}}!
+while ( !\cPart{c}{power <= n/2}! )
+!\cPart{po}{\{}!
+ !\cPart{b}{power = 2*power;}!
+!\cPart{pc}{\}}!
+\end{lstlisting}
+};
+
+% Annotation
+\codeAnnotation{iText} (-1,3.25) {initialization is a\\separate statement}
+\codeAnnotation{cText} (3.5,3) {loop-\\continuation\\condition}
+\codeAnnotation{pText} (-1.5,0.5) {braces are\\optional\\when body\\is a single\\statement}
+\codeAnnotation{bText} (2.125,-0.5) {body}
+% Arrows
+\draw[->,annotation] (iText) -- (i.north west);
+\draw[->,annotation] (cText) -- (c);
+\draw[->,annotation] (bText) -- (b);
+\draw[->,annotation] (pText) -- (po);
+\draw[->,annotation] (pText) -- (pc);
+\end{tikzpicture}
+\end{filecontents}
+
+\begin{thinmargin}
+ \inputlisting{anatomy-of-a-while-loop.tex}
+\end{thinmargin}
+
+{\sffamily test font if while do}
+
+\input{anatomy-of-a-while-loop.tex}
+
+\subsection{Anatomy of a \texttt{for} loop~\autocite[59]{sedgewick-wayne-2016}}
+% ----------------------------------------
+
+\begin{filecontents}{anatomy-of-a-for-loop.tex}
+\lstset{escapeinside={!}{!}}
+\begin{tikzpicture}[
+ remember picture
+ ,code annotation/.append style={%
+ font=\sffamily\itshape\scriptsize
+ }
+]
+ % {[on background layer]\draw[code grid debug] (-2.5,-0.5) grid (5.5,3.5);}
+\node(code) [anatomy] at (0,0){%
+\begin{lstlisting}
+!\iPart{init}{\bgcode{int power = 1;}}!
+for ( !\cPart{i}{int i = 0}!; !\cPart{c}{i <= n}!; !\cPart{u}{i++}! )
+{
+ !\mtPoint{left}!System.out.println(i + " " + power);!\mtPoint{right}!
+ power *= 2;!\mbPoint{bottom}!
+}
+\end{lstlisting}
+};
+\fitExtrem{b}{(left) (right) (bottom)}
+% Annotations
+\codeAnnotation{initText} (-1.5,2.7) {initialize another\\variable in a\\separate\\statement}
+\codeAnnotation{iText} (1,3.5) {declare and initialize\\a loop control variable}
+\codeAnnotation{cText} (3.5,3) {loop-\\continuation\\condition}
+\codeAnnotation{uText} (6,3) {increment}
+\codeAnnotation{bText} (3.5,-0.25) {body}
+% arrows on the background
+{[on background layer]
+\draw[->,annotation] (initText.350) -- (init.north west);
+\draw[->,annotation] (iText) -- (i);
+\draw[->,annotation] (cText) -- (c);
+\draw[->,annotation] (uText) -- (u);
+\draw[->,annotation] (bText) -- (b);
+}
+\end{tikzpicture}
+\end{filecontents}
+
+\begin{thinmargin}
+ \inputlisting{anatomy-of-a-for-loop.tex}
+\end{thinmargin}
+
+\input{anatomy-of-a-for-loop.tex}
+
+\subsection{Anatomy of a static method~\autocite[196]{sedgewick-wayne-2016}}
+% ----------------------------------------
+\begin{filecontents}{anatomy-of-a-static-method.tex}
+\lstset{escapeinside={!}{!}}
+\begin{tikzpicture}[remember picture]
+ %{[on background layer]\draw[code grid debug] (-2.5,-0.5) grid (8.5,3.5);}
+\node(code) [anatomy] at (0,0) {%
+\begin{lstlisting}
+!\cPart{s}{public static \cPart{rt}{double} \cPart{fn}{harmonic}(\cPart{al}{\iPart{at}{int} \iPart{pv}{n}})}!
+{
+ !\hmtPoint{left}\cPart{lv}{double sum}! = 0.0;
+ for (int i = 0; i <= n; ++i)!\extremPoint{right}!
+ {
+ sum += 1.0/i;
+ }
+ !\cPart{rs}{return sum;}\dmbPoint{bottom}!
+}
+\end{lstlisting}
+};
+
+\fitExtrem{b}{(left) (right) (bottom)}
+
+% Annotation
+\codeAnnotation{sText} (-0.7,5) {signature}
+\codeAnnotation{rtText} (2,5) {return\\type}
+\codeAnnotation{fnText} ( 4,5) {method\\name}
+\codeAnnotation{alText} ( 6,5) {argument\\list}
+\codeAnnotation{atText} (6.5,1.75) {argument\\type}
+\codeAnnotation{pvText} (7.5,2.70) {parameter\\variable}
+\codeAnnotation{lvText} (-0.7,2.5) {local\\variable}
+\codeAnnotation{bText} (-0.7,1.5) {method\\body}
+\codeAnnotation{rsText} (3,-0.4) {return statement}
+% Arrows
+\draw[->,annotation] (sText) -- (s.north west);
+\draw[->,annotation] (rtText) -- (rt);
+\draw[->,annotation] (fnText) -- (fn);
+\draw[->,annotation] (alText) -- (al);
+\draw[->,annotation] (atText) -- (at);
+\draw[->,annotation] (pvText) -- (pv);
+\draw[->,annotation] (lvText) -- (lv.west);
+\draw[->,annotation] (bText) -- (b);
+\draw[->,annotation] (rsText) -- (rs);
+\end{tikzpicture}
+\end{filecontents}
+
+\begin{thinmargin}
+ \inputlisting{anatomy-of-a-static-method.tex}
+\end{thinmargin}
+
+\input{anatomy-of-a-static-method.tex}
+
+\end{document}
+
diff --git a/Master/texmf-dist/doc/latex/codeanatomy/codeanatomy.pdf b/Master/texmf-dist/doc/latex/codeanatomy/codeanatomy.pdf
new file mode 100644
index 00000000000..dae4d979d49
--- /dev/null
+++ b/Master/texmf-dist/doc/latex/codeanatomy/codeanatomy.pdf
Binary files differ
diff --git a/Master/texmf-dist/doc/latex/codeanatomy/codeanatomy.usage.pdf b/Master/texmf-dist/doc/latex/codeanatomy/codeanatomy.usage.pdf
new file mode 100644
index 00000000000..bae40b72c12
--- /dev/null
+++ b/Master/texmf-dist/doc/latex/codeanatomy/codeanatomy.usage.pdf
Binary files differ
diff --git a/Master/texmf-dist/doc/latex/codeanatomy/codeanatomy.usage.tex b/Master/texmf-dist/doc/latex/codeanatomy/codeanatomy.usage.tex
new file mode 100644
index 00000000000..5136905babb
--- /dev/null
+++ b/Master/texmf-dist/doc/latex/codeanatomy/codeanatomy.usage.tex
@@ -0,0 +1,383 @@
+\documentclass[full]{l3doc}
+\usepackage{fontspec}
+\usepackage{biblatex}
+\addbibresource{literatur.bib}
+\newcommand{\slsh}{\textbackslash{}}
+\newcommand{\TikZ}{Ti\textit{k}Z}
+\def\thinmargin{\list{}{\rightmargin-50pt\leftmargin-90pt}\item[]}
+\let\endthinmargin=\endlist
+
+\usepackage{listings}
+\lstset {
+ basicstyle=\small\ttfamily
+ ,escapeinside={+}{+}
+}
+
+\usepackage{codeanatomy}
+
+\begin{document}
+
+\GetFileInfo{codeanatomy.sty}
+\DoNotIndex{}
+
+\title{
+ \pkg{codeanatomy} -- Draw Code Anatomy%
+ \thanks{This file describes \fileversion,
+ last revised \filedate.}\\[1ex]
+ \normalsize{Usage}
+}
+
+\author{
+ Hồng-Phúc Bùi
+ \thanks{
+ E-mail:
+ \href{mailto:Hồng-Phúc Bùi}
+ {hong-phuc.bui (at) htwsaar dot de}
+ }
+}
+
+\date{Released \filedate}
+
+\AtEndDocument{
+ \printbibliography
+}
+
+\maketitle
+\tableofcontents
+
+\begin{documentation}
+\section{Introduction}
+The idea of this Package is to typeset illustrations of pieces of code with
+annotations on each single parts of code (Code Anatomy). The origin of this idear is
+code illustrations in the texbook~\autocite{sedgewick-wayne-2016}. This package
+just provides tool to draw those figures.
+
+\section{Tutorial}
+In this tutorial we will draw an anatomy of a function like the
+figure~\ref{fig:tut1-function} step by step.
+
+\begin{figure}
+\begin{centering}
+\begin{tikzpicture}[remember picture]
+\codeBlock{
+\cPart{functionHead}{function \cPart{functionName}{gcd} \cPart{parameterList}{(p, q)}}\{ \\[2.5pt] %
+\ptab{}\mtPoint{mostLeft}if (q === 0) \{\\
+\ptab\ptab{}return p; \\
+\ptab{}\} else \{\\
+\ptab\ptab{}return gcd(q, p \% q);\extremPoint{mostRight}\\
+\ptab{}\}\mbPoint{mostBottom}\\
+\}
+};
+
+\node(functionBody)[draw,code part,fit=(mostLeft) (mostRight) (mostBottom)] {};
+
+% Anotation labels
+\codeAnnotation{functionHeadText}(-1,3) {Function\\Head}
+\codeAnnotation{functionBodyText}(-1,1.5){Function\\Body}
+\codeAnnotation{functionNameText}(1,4) {Function Name}
+\codeAnnotation{parameterListText} (4,4) {Paramter List}
+
+% Annotation labels to Code
+\draw[->, annotation] (functionBodyText) -- (functionBody);
+\draw[->, annotation] (functionHeadText) -- (functionHead);
+\draw[->, annotation] (functionNameText) -- (functionName);
+\draw[->, annotation] (parameterListText) -- (parameterList);
+\end{tikzpicture}
+
+\caption{Anatomy of a function\label{fig:tut1-function}}
+\end{centering}
+\end{figure}
+
+\subsection{Package Usage}
+To use this package, just insert |\usepackage{codeanatomy}| in your \LaTeX{} file.
+
+\subsection{Create an anatomy environment}
+Next step is to create a |tikzpicture| environment. All commands in this package must be placed in
+a |tikzpicture| environment with option |remember picture|.
+
+\begin{thinmargin}
+\begin{tikzpicture}[remember picture]
+\codeBlock{
+\textbackslash{}begin\{tikzpicture\}[\cPart{option}{remember picture}]\\
+\cPart{debugGrid}{\{[on background layer]\textbackslash{}draw[code grid debug] (-0.5,-0.5) grid (6.5,4.5);\}}\\
+\% ... \\
+\textbackslash{}end\{tikzpicture\}
+}
+
+% Annotation labels
+\codeAnnotation{optionText} (5,2.5) {necsessary for\\later mark}
+\codeAnnotation{debugGridText} (7,0) {plot a thin grey grid on background\\usefull to determinate coordinate of annotation}
+
+% Annotation labels to code
+\draw[->, annotation] (optionText) -- (option);
+\draw[->, annotation] (debugGridText) -- (debugGrid);
+\end{tikzpicture}
+\end{thinmargin}
+
+
+\subsection{Typeset Code Listing in a TikZ-Node}
+As next step we need to put the piece of code in the |tikzpicture| environment using
+the command |\codeBlock|. \medskip
+
+
+\begin{thinmargin}
+\begin{tikzpicture}[remember picture]
+\codeBlock{
+\textbackslash{}begin\{tikzpicture\}[remember picture]\\
+\{[on background layer]\textbackslash{}draw[code grid debug]\\
+ \ptab\ptab (-0.5,-0.5) grid (6.5,4.5);\}\\
+\textbackslash{}codeBlock\{\% \\
+\mtPoint{mostLeft}function gcd(p, q) \{ \\
+\ptab{}if (q === 0) \{ \\
+\ptab\ptab{}return p; \\
+\ptab{}\} else \{ \\
+\ptab\ptab{}return gcd(q, p\%q);\extremPoint{mostRight}\\
+\ptab\} \\
+\mbPoint{mostBottom}\}\\
+\} \\
+\textbackslash{}end\{tikzpicture\}
+}
+
+\node(codeBlockBody)[draw,code part,fit=(mostLeft) (mostRight) (mostBottom)] {};
+
+\codeAnnotation{codeBlockBodyText} (7,2.5) {Anatomy of Code}
+\draw[->, annotation] (codeBlockBodyText) -- (codeBlockBody);
+\end{tikzpicture}
+\end{thinmargin}
+
+The result of the above code is shown in the figure~\ref{fig:function-compressed},
+which is not what we really want. All extra whitespaces and newlines in the
+listing are removed, further more |{| and |}| are interpreted as \LaTeX{} tokens and are not
+displayed.
+
+\begin{figure}[h]
+\begin{centering}
+\begin{tikzpicture}[remember picture]
+{[on background layer]\draw[code grid debug] (-0.5,-0.5) grid (6.5,4.5);}
+\codeBlock{
+function gcd(p, q) {
+ if (q === 0) {
+ return p;
+ } else {
+ return gcd(q, p\%q);
+ }
+}
+}
+\end{tikzpicture}
+\caption{Unformated Code\label{fig:function-compressed}}
+\end{centering}
+\end{figure}
+
+
+We need to put |\ptab| and |\\| into code to keep whitespaces and newlines. The characters |{| and |}|
+also need to be escaped by prefixing a |\| before them.
+
+\begin{thinmargin}
+\begin{tikzpicture}[remember picture]
+\codeBlock{
+\textbackslash{}begin\{tikzpicture\}[remember picture]\\
+\{[on background layer]\textbackslash{}draw[code grid debug]\\
+ \ptab\ptab (-0.5,-0.5) grid (6.5,4.5);\}\\
+\textbackslash{}codeBlock\{\%\\
+function gcd(p, q) \slsh\{ \cPart{sh1}{\slsh\slsh}\\
+\cPart{ptab1}{\slsh{}ptab\{\}}if (q === 0) \slsh\{ \cPart{sh2}{\slsh\slsh}\\
+\cPart{ptab2}{\slsh{}ptab\slsh{}ptab\{\}}return p; \cPart{sh3}{\slsh\slsh}\\
+\cPart{ptab3}{\slsh{}ptab}\slsh\} else \slsh\{ \cPart{sh4}{\slsh\slsh}\\
+\cPart{ptab4}{\slsh{}ptab\slsh{}ptab\{\}}return gcd(q, p\slsh\%q); \cPart{sh5}{\slsh\slsh}\\
+\cPart{ptab5}{\slsh{}ptab}\slsh\} \cPart{sh6}{\slsh\slsh}\\
+\slsh\} \cPart{sh7}{\slsh\slsh}\\
+\} \\
+\textbackslash{}end\{tikzpicture\}
+}
+
+% Annotation labels
+\codeAnnotation{shText} (9,2.5) {Double backslash}
+\codeAnnotation{ptabText} (-2,2.5) {\texttt{\slsh{}ptab} proceduces\\whitespaces}
+% Annotation labels to code
+\draw[->, annotation] (shText.20) to[out=90,in=0] (sh1.east);
+\draw[->, annotation] (shText.80) to[out=95,in=0] (sh2.east);
+\draw[->, annotation] (shText) -- (sh3);
+\draw[->, annotation] (shText) -- (sh4);
+\draw[->, annotation] (shText) -- (sh5);
+\draw[->, annotation] (shText.270) to[out=260,in=0] (sh6);
+\draw[->, annotation] (shText.340) to[out=260,in=0] (sh7);
+
+\draw[->, annotation] (ptabText) -- (ptab1.west);
+\draw[->, annotation] (ptabText) -- (ptab2.west);
+\draw[->, annotation] (ptabText) -- (ptab3.west);
+\draw[->, annotation] (ptabText) -- (ptab4.west);
+\draw[->, annotation] (ptabText) -- (ptab5.west);
+\end{tikzpicture}
+\end{thinmargin}
+
+The result (figure~\ref{fig:function-formated}) is much more like what we expect
+than the version before (figure~\ref{fig:function-compressed}).
+
+\begin{figure}[h]
+\begin{centering}
+\begin{tikzpicture}[remember picture]
+{[on background layer]\draw[code grid debug] (-0.5,-0.5) grid (6.5,4.5);}
+\codeBlock{
+function gcd(p, q) \{ \\
+\ptab{}if (q === 0) \{ \\
+\ptab\ptab{}return p; \\
+\ptab\} else \{ \\
+\ptab\ptab{}return gcd(q, p\%q); \\
+\ptab\} \\
+\} \\
+}
+\end{tikzpicture}
+\caption{Formated Function\label{fig:function-formated}}
+\end{centering}
+\end{figure}
+
+\subsection{Mark Parts of Code}
+Now we can mark interesting parts of code with a blue boxes created by |\cPart|. At some positions
+we can use |\\[<length>]| to add a little amount of vertical space, sothat the boxes do not touch
+each others.
+
+\begin{thinmargin}
+\begin{tikzpicture}[remember picture]
+{[on background layer]\draw[code grid debug] (-0.5,-0.5) grid (10.5,4.5);}\\
+\codeBlock{
+\textbackslash{}begin\{tikzpicture\}[remember picture]\\
+\{[on background layer]\textbackslash{}draw[code grid debug]\\
+ \ptab\ptab (-0.5,-0.5) grid (6.5,4.5);\}\\
+\textbackslash{}codeBlock\{\%\\
+\cPart{nestedCodePart}{\slsh{}cPart\{functionHead\}\{function\slsh{}cPart\{functionName\}\{gcd\} \slsh{}cPart\{paramList\}\{(p, q)\}\}} \slsh\{\\
+ \slsh\slsh[2.5pt]\\
+\slsh{}ptab\{\}\cPart{ep1}{\slsh{}mtPoint\{mostLeft\}}if (q === 0) \slsh\{ \slsh\slsh\\
+\slsh{}ptab \slsh{}ptab\{\}return p; \slsh\slsh\\
+\slsh{}ptab \slsh\} else \slsh\{ \slsh\slsh\\
+\slsh{}ptab \slsh{}ptab\{\}return gcd(q, p\slsh\%q); \cPart{ep2}{\slsh{}extremPoint\{mostRight\}} \slsh\slsh\\
+\slsh{}ptab\cPart{ep3}{\slsh{}mbPoint\{mostBottom\}}\slsh\} \slsh\slsh\\
+\slsh\} \slsh\slsh\\
+\} \\
+ \\
+\cPart{fitExtemCmd}{\slsh{}fitExtrem\{functionBody\}\{(mostLeft) (mostRight) (mostBottom)\}}\\
+\slsh{}end\{tikzpicture\}
+}
+
+\codeAnnotation{nestedCodePartText}(11,6){\texttt{cPart} can be nested}
+\codeAnnotation{exText} (15,3){\texttt{extremPoint}s\\are used to mark\\outer most points of\\a multiline code part}
+\codeAnnotation{fitExtemCmdText} (6,-1){\texttt{fitExtrem} draws a rectangle\\which covers all passed extrem points}
+
+\draw[->, annotation] (nestedCodePartText) to[out=270,in=90] (nestedCodePart);
+\draw[->, annotation] (exText) to[out=145,in=320] (ep1.south east);
+\draw[->, annotation] (exText) to[out=190,in=300] (ep2.320);
+\draw[->, annotation] (exText) to[out=220,in=350] (ep3.340);
+\draw[->, annotation] (fitExtemCmdText) -- (fitExtemCmd);
+\end{tikzpicture}
+\end{thinmargin}
+
+
+\begin{figure}[ht]
+\centering
+\begin{tikzpicture}[remember picture]
+{[on background layer]\draw[code grid debug]
+ (-0.5,-0.5) grid (6.5,4.5);}
+\codeBlock{%
+\cPart{functionHead}{function\cPart{functionName}{gcd} \cPart{paramList}{(p, q)}} \{
+\\[2.5pt]
+\ptab{}\mtPoint{mostLeft} if (q === 0) \{ \\
+\ptab\ptab{}return p; \\
+\ptab\} else \{ \\
+\ptab\ptab{}return gcd(q, p\%q); \extremPoint{mostRight} \\
+\ptab\mbPoint{mostBottom}\} \\
+\} \\
+}
+\fitExtrem{functionBody}{(mostLeft) (mostRight) (mostBottom)}
+\end{tikzpicture}
+\caption{Function with marked parts\label{fig:function-parts}}
+\end{figure}
+
+\subsection{Create Annotation Labels}
+We can use |\codeAnnotation| to create annotation labels for each parts of code. To draw an
+arrow from label to a code part we can use the \TikZ{}command\\
+|\draw[->,annotation]| \parg{annotation label} |--| \parg{code part} |;|.\\
+Whereas \parg{annotation label}s are the first argument of |\codeAnnotation|s and
+\parg{code part}s are the first argument of |\cPart|s.
+
+\begin{thinmargin}
+\begin{tikzpicture}[remember picture]
+\codeBlock{
+\textbackslash{}begin\{tikzpicture\}[remember picture]\\
+\{[on background layer]\textbackslash{}draw[code grid debug]\\
+ \ptab\ptab (-0.5,-0.5) grid (6.5,4.5);\}\\
+\textbackslash{}codeBlock\{\%\\
+\slsh{}cPart\{functionHead\} \{function \slsh{}cPart\{functionName\}\{gcd\} \slsh{}cPart\{paramList\}\{(p, q)\}\} \slsh\{\\
+ \slsh\slsh[2.5pt]\\
+\slsh{}ptab\{\}\slsh{}mtPoint\{mostLeft\} if (q === 0) \slsh\{ \slsh\slsh\\
+\slsh{}ptab\slsh{}ptab\{\} return p; \slsh\slsh\\
+\slsh{}ptab\slsh \} else \slsh\{ \slsh\slsh\\
+\slsh{}ptab\slsh{}ptab\{\} return gcd(q, p\slsh\%q); \slsh{}extremPoint\{mostRight\} \slsh\slsh\\
+\slsh{}ptab\slsh{}mbPoint\{mostBottom\}\slsh\} \slsh\slsh\\
+\slsh\} \\
+\} \\
+ \\
+\slsh{}fitExtrem\{functionBody\}\{(mostLeft) (mostRight) (mostBottom)\}\\
+\\
+\% Annotations \\
+\slsh{}codeAnnotation\{functionHeadText\}(-1,3)\{Function\slsh\slsh{}head\} \\
+\slsh{}codeAnnotation\{functionBodyText\}(-1,1)\{Function\slsh\slsh{}body\} \\
+\slsh{}codeAnnotation\{functionNameText\}( 1,4)\{Function\slsh\slsh{}name\} \\
+\slsh{}codeAnnotation\{paramListText\} ( 3,4)\{Parameter\slsh\slsh{}list\} \\
+\\
+\% Annotation labels to code parts\\
+\slsh{}draw[->,annotation] (functionHeadText) -- (functionHead);\\
+\slsh{}draw[->,annotation] (functionBodyText) -- (functionBody);\\
+\slsh{}draw[->,annotation] (functionNameText) -- (functionName);\\
+\slsh{}draw[->,annotation] (paramListText) -- (paramList);\\
+\slsh{}end\{tikzpicture\}
+}
+
+\end{tikzpicture}
+\end{thinmargin}
+
+Instead of operator |--| we can use operator |to| \oarg{\TikZ{} options} to draw a path from
+\parg{annotation label} to \parg{code part}. Finally we can remove the command
+|\draw[code grid debug]...| at the begin of the |tikzpicture|.
+The final result is shown in the figure~\ref{fig:function-final}, which is almost the same
+as figure~\ref{fig:tut1-function}.
+
+\begin{figure}[ht]
+\centering
+\begin{tikzpicture}[remember picture]
+\codeBlock{%
+\cPart{functionHead} {function \cPart{functionName}{gcd} \cPart{paramList}{(p, q)}} \{
+\\[2.5pt]
+\ptab{}\mtPoint{mostLeft}if (q === 0) \{ \\
+\ptab\ptab{} return p; \\
+\ptab\} else \{ \\
+\ptab\ptab{} return gcd(q, p\%q);\extremPoint{mostRight} \\
+\ptab\mbPoint{mostBottom}\} \\
+\}
+}
+\fitExtrem{functionBody}{(mostLeft) (mostRight) (mostBottom)}
+% Annotations
+\codeAnnotation{functionHeadText}(-1,3){Function\\head}
+\codeAnnotation{functionBodyText}(-1,1){Function\\body}
+\codeAnnotation{functionNameText}( 1,4){Function\\name}
+\codeAnnotation{paramListText} ( 3,4){Parameter\\list}
+% Annotation labels to code parts
+\draw[->,annotation] (functionHeadText) -- (functionHead);
+\draw[->,annotation] (functionBodyText) -- (functionBody);
+\draw[->,annotation] (functionNameText) -- (functionName);
+\draw[->,annotation] (paramListText) -- (paramList);
+\end{tikzpicture}
+
+\caption{Function with Annotation Labels\label{fig:function-final}}
+\end{figure}
+
+\section{Usage in conjuntion with \pkg{listings}}
+
+As we see in the previous section, the command |\codeBlock| cannot typeset whitespaces correctly as we
+expect. A way to typeset code listing is using the package \pkg{listings}. See \texttt{codeanatomy.lstlisting.pdf}
+
+
+\section{Customize style}
+TODO
+
+\end{documentation}
+\end{document}
+
diff --git a/Master/texmf-dist/doc/latex/codeanatomy/literatur.bib b/Master/texmf-dist/doc/latex/codeanatomy/literatur.bib
new file mode 100644
index 00000000000..27824d42ac4
--- /dev/null
+++ b/Master/texmf-dist/doc/latex/codeanatomy/literatur.bib
@@ -0,0 +1,8 @@
+@BOOK{sedgewick-wayne-2016,
+ place={Boston},
+ title={Computer Science},
+ subtitle={An Interdisciplinary Approach},
+ publisher={Addison-Wesley},
+ author={Sedgewick, Robert and Wayne, Kevin},
+ year={2016}
+} \ No newline at end of file