work through documentation with kolja

doc/chapter/2architecture.tex

@@ -12,10 +12,10 @@ The following assumptions are made for the implementation of the node placement
 
 \section{Overview}\label{sec:components}
 The \code{main} package contains an executable class \code{Main}.
-This classes main method creates a graph or reads it from a file using the \code{graph.io} package and then creates a MainView.
+This classes main method reads a graph from a file using the \code{graph.io} package and then creates a MainView.
 The view then instantiates a \code{BKNodePlacement} algorithm and runs it.
 The \code{BKNodePlacement} repeatedly asks the \code{AnimationController} if a step should be done (this is further explained in section~\ref{sec:theActualAlgorithm}).
-For each step it uses works with \code{LayeredGraphNode}s and \code{LayeredGraphEdge}s.
+It uses \code{LayeredGraphNode}s and \code{LayeredGraphEdge}s.
 Meanwhile the view displays the same \code{LayeredGraphNode}s and \code{LayeredGraphEdge}s on the screen.
 
 Figure~\ref{fig:components} contains a component diagram that illustrates these dependencies of the packages.
@@ -29,7 +29,7 @@ Figure~\ref{fig:components} contains a component diagram that illustrates these
 
 
 \section{Input File Format}\label{sec:inputFileFormat}
-The input to \appname is a JSON file.
+The input to \appname\ is a JSON file.
 An example is displayed in figure~\ref{fig:json-example}.
 The structure is as follows:
 \begin{itemize}
@@ -56,7 +56,7 @@ The internal representation of graphs is further explained in the section~\ref{s
     The node can be higher if it contains other nodes that need more space.
     If the whole layout is too large, it is resized, such that all nodes are proportionately shrunk: In that case the minimum height can be exceeded after the shrinking.
     Default 40.\\\hline
-    dummy & boolean & yes & Iff this is explicitly set to yes, then the node is a dummy node. \\\hline
+    dummy & boolean & yes & Iff this is explicitly set to true, then the node is a dummy node. \\\hline
     layers & < < node > > & yes & The layers of nodes inside this node (Hierarchy). \\\hline
     edges & < edge > & yes & The edges between nodes whose parent node is this node. Also see section~\ref{sec:assumptions}. \\\hline
     \caption[Node Attributes]{Node Attributes. < \emph{element type} > is a list.}
@@ -102,27 +102,33 @@ The internal representation of graphs is further explained in the section~\ref{s
 
 \section{Internal graph representation, \code{graph}}\label{sec:graph}
 One feature that is important to us, is to be able to work with hierarchical graphs (cf.\ chapter~\ref{ch:progress}).
-Therefore a node not only has edges to other nodes, but also it can contain other nodes and edges.
+Therefore a node can contain other nodes and edges.
 So far this is similar to what we described in section~\ref{sec:inputFileFormat}.
 Additionally, there are multiple attributes that are used during the computation or as output variables.
 \begin{itemize}
+    \item The \member{parent} of a node is the node that contains it in the hierarchy.
+    \item \member{dummy} specifies whether this node is a dummy node.
+    \item \member{name} is the name of the node.
     \item The attributes \member{shift}, \member{sink},  \member{root} and  \member{align} correspond to the variables used by Brandes and Köpf~\cite{brandes_fast_2001}.
     They are summarized in table~\ref{table:bk-variables}.
-    \item The \member{parent} of a node is the node that contains it in the hierarchy.
-    \item The attributes \member{x} and \member{y} are the coordinates of the node relative to its \code{parent}.
+    \item The attribute \member{xUndef} determines whether the x coordinate of the node has already been assigned a value.
+    \item The attributes \member{x} and \member{y} are the coordinates of the node relative to its \member{parent}.
     \item The attributes \member{w} and \member{h} are the width and height of the node.
     \item The attributes \member{color} is the color in which the node is displayed.
-    \item The attribute \member{xUndef} determines whether the x coordinate of the node has already been assigned a value.
     \item The attribute \member{selected} is used to highlight the node that is currently active in each layout.
 \end{itemize}
-The last five bullet points are available for each of the four extremal layouts and for the combined layout.
+The last six bullet points are available separately for each of the four extremal layouts.
+The last four bullet points are also separately available for the combined layout.
 
-Similarly, edges have additional attributes:
+Similarly, edges have the following attributes in addition to those given through the JSON format:
 \begin{itemize}
-    \item \member{dummyNode} specifies whether they are dummy edges.
-    \item \member{conflicted} corresponds to the variable used by Brandes and Köpf~\cite{brandes_fast_2001} and indicates that this edge won't be drawn vertically.
+    \item \member{dummyEdge} specifies whether they are edges between two dummy nodes.
     \item \member{bindPoints} is a list of bend points for the edge, including the beginning and end point of the edge.
+    \item \member{reversed} specifies if this edge was reversed earlier (not used by \appname).
+    \item \member{graph} is the node that contains the edges (hierarchy).
+    \item \member{conflicted} corresponds to the variable used by Brandes and Köpf~\cite{brandes_fast_2001} and indicates that this edge won't be drawn vertically.
 \end{itemize}
+The last bullet point is available separately for each of the four extremal layouts and for the combined layout.
 
 A class diagram of the package \code{graph} is displayed in figure~\ref{fig:graph}.
 
@@ -137,13 +143,15 @@ A class diagram of the package \code{graph} is displayed in figure~\ref{fig:grap
     \begin{longtable}{|l|p{10cm}|}
         \hline
         Attribute & Explanation \\\hline\hline
-        root & The root node of the block of this node.
+        \member{root} & The root node of the block of this node.
         Unique for all nodes in the same block. \\\hline
-        sink & The topmost sink in the block graph that can be reached from the block that this node belongs to.
+        \member{sink} & The topmost sink in the block graph that can be reached from the block that this node belongs to.
         Only used for nodes that are the root of a block.
         Unique for all nodes in the same class. \\\hline
-        shift & The shift of the class that this node belongs to.
+        \member{shift} & The shift of the class that this node belongs to.
         Only used for nodes that are a sink of a class. \\\hline
+        \member{align} & The next node in the same block as this node.
+        The \member{align} of the last node in the block is the root node of the block again.\\\hline
     \end{longtable}
     \caption{Variables also used by Brandes and Köpf~\cite{brandes_fast_2001}}
     \label{table:bk-variables}
@@ -155,7 +163,7 @@ This section expects the reader to be familiar with the node placement algorithm
 We recommend section 3.2.1 of Carstens~\cite{carstens_node_2012} for a detailed explanation.
 
 A stage of the algorithm, interface \code{AlgorithmStage}, is an interval during which each step of the algorithm is performed in a similar way.
-Each time such a step is performed it returns whether the stage is already finished.
+Each time such a step is performed it returns whether the stage is already finished or a breakpoint has been reached.
 For example, a forward step in the stage of calculating one extremal layout, \code{ExtremalLayoutCalc}, consists of either a step of calculating the blocks, \code{BlockCalc}, or a step of compacting the layout, \code{Compaction}.
 All the stages are displayed in class diagram~\ref{fig:animation_and_bk}.
 
@@ -166,8 +174,8 @@ This works the following:
 \begin{enumerate}
     \item The \code{MainView} creates a node placement algorithm (only \code{BKNodePlacement} available).
     It sends an \code{AnimationController} as a parameter for the constructor.
-    \item The algorithm concurrently asks the \code{AnimationController} if it should do a forward or backward step.
-    \item The \code{AnimationController} waits until it knows which action to take (for example if the user pressed the right arrow key).
+    \item The algorithm concurrently asks the \code{AnimationController} if it should do a forward or backward step and if that is a \enquote{step into}, \enquote{step over} or \enquote{step out}.
+    \item The \code{AnimationController} waits until it knows which action to take (for example if the user pressed Alt + Right arrow key).
     Alternatively, if the animation is not paused, it waits until a specific delay has passed.
     Then it returns to the algorithm which step to take next.
     \item The algorithm potentially calls one the step methods of other stages while executing one step.
@@ -185,12 +193,17 @@ This works the following:
 This section only covers the software architecture regarding the views.
 For an explanation of what is actually displayed, see chapter~\ref{ch:ui}
 
-The distinguish two kinds of views:
 \begin{itemize}
-    \item The main window displays four regions for the different extremal layouts while also forwarding keyboard commands to the \code{AnimationController}.
-    For this we use a \code{JFrame} from the Swing library.
+    \item The main window displays a \code{lane} of the class \code{JLayeredPane} and a \code{menue} of the class \code{JPanel}.
+    The main window itself is a \code{JFrame} from the Swing library.
+    \item The \code{lane} display the current status of the graph.
+    \item The \code{menue} display \code{NiceButton}s and pseudocode.
     \item \code{EdgeView} and \code{NodeView} are \code{JPanel}s, which means they can be drawn onto the \code{JFrame}.
-    For this they have to know about which part of the graph and which layout they belong to.
+    For this they have to know about which part of the graph and which layout they belong to (some attributes).
+    \item A \code{NiceButton} is a \code{JButton} that has an image on it.
+    \item For rendering the pseudocode we use a \code{PseudoCodeRenderer} that is a \code{DefaultTreeCellRenderer}.
+    For example, it sets line numbers and highlights selected code lines.
+    \item A \code{RenderHelper} that contains some additional utility functions for the views.
 \end{itemize}
 A class diagram of the packages \code{view} and \code{main} is displayed in figure~\ref{fig:view}.
 

doc/chapter/3ui.tex

@@ -1,7 +1,7 @@
 Note that since the application is still under construction, so not all screenshots may be up to date.
 
 \section{Graphical presentation of the running algorithm}\label{sec:graphicalPresentationOfTheRunningAlgorithm}
-A first sketch of how we want \appname to look is shown in figure~\ref{fig:sketch}.
+A first sketch of how we want \appname\ to look is shown in figure~\ref{fig:sketch}.
 The current development status is displayed in figure~\ref{fig:full-application-example}.
 Another example graph and an explanation of the shapes and colors is provided in figure~\ref{fig:example}.
 Figure~\ref{fig:originalpapergraph} compares our results to those of Brandes and Köpf~\cite{brandes_fast_2001}.
@@ -10,8 +10,8 @@ Figure~\ref{fig:originalpapergraph} compares our results to those of Brandes and
     \centering
     \includegraphics[width=\linewidth]{img/skizze}
     \caption[First sketch of the planned layout]{A first sketch of the planned layout, created with Microsoft Paint.
-    The buttons are (first row, from left to right): step over, step into, step out, run, pause, debug; and (second row, from left to right): step back, step back out, run backwards.
-    The actions corresponding to the buttons are the same as described for the keyboard input in table~\ref{table:keys}, at least for the features that are already implemented.
+    The buttons are (first row, from left to right): step over, step into, step out, run, pause, debug; and (second row, from left to right): step back over, step back into, step back out, run backwards, load graph, save graph, generate random graph.
+    The actions corresponding to the buttons are the same as described for the keyboard input in table~\ref{table:keys}, at least for the features that are already implemented (all of them).
     The left four rectangles show the progress of the four extremal layouts.
     The right rectangle shows pseudocode of the algorithm and the position of the current step.}
     \label{fig:sketch}

doc/chapter/4progress.tex

@@ -42,6 +42,6 @@ The following features are either planned (\planned), under construction (\progr
     \item[\done] Working with hierarchical graphs.
     \item[\done] Scaling the display with the (adjustable) window size.
     \item[\planned] Working with disconnected graphs (cf.\ section~\ref{sec:assumptions}), either by modifying the algorithm or by processing the connected components one by one (low priority).
-    \item[\planned] Creating ElkNode~\cite{noauthor_elk:_2018} objects from LayeredNode (\ref{sec:graph}) objects.
+    \item[\done] Creating ElkNode~\cite{noauthor_elk:_2018} objects from LayeredNode (\ref{sec:graph}) objects.
     \item[\planned] Creating LayeredNode (\ref{sec:graph}) objects from ElkNode~\cite{noauthor_elk:_2018} objects (low priority).
 \end{itemize}