11 files changed, 185 insertions, 39 deletions

diff --git a/ue1/protokoll.pdf b/ue1/protokoll.pdf
index d1a72ac..3682945 100644
--- a/ue1/protokoll.pdf
+++ b/ue1/protokoll.pdf
diff --git a/ue3/mycpu/cdisplay.h b/ue3/mycpu/cdisplay.h
index 0a0a723..1523f68 100644
--- a/ue3/mycpu/cdisplay.h
+++ b/ue3/mycpu/cdisplay.h
@@ -1,7 +1,7 @@
 /**
  * @module cdisplay
  * @author Guenther Neuwirth (0626638), Manuel Mausz (0728348)
- * @brief  Abstract class for displays
+ * @brief  Abstract template class for displays
  * @date   10.05.2009
  */
 
@@ -9,15 +9,16 @@
 #define CDISPLAY_H 1
 
 /**
- * @class CDisplay
+ * @class CDisplayT
  *
- * Abstract class for displays
+ * Abstract template class for displays
  */
-class CDisplay
+template <class T>
+class CDisplayT
 {
   public:
     /**
-     * @method CDisplay
+     * @method CDisplayT
      * @brief  Default ctor
      * @param  name  name of display
      * @return -
@@ -25,12 +26,12 @@ class CDisplay
      * @exception  none
      * @conditions none
      */
-    CDisplay(std::string name)
+    CDisplayT(std::string name)
       : m_name(name)
     {}
 
     /**
-     * @method ~CDisplay
+     * @method ~CDisplayT
      * @brief  Default dtor
      * @param  -
      * @return -
@@ -38,7 +39,7 @@ class CDisplay
      * @exception  none
      * @conditions none
      */
-    virtual ~CDisplay()
+    virtual ~CDisplayT()
     {}
 
     /**
@@ -64,7 +65,7 @@ class CDisplay
      * @exception  none
      * @conditions none
      */
-    virtual void display(const CDat &value) = 0;
+    virtual void display(const T &value) = 0;
 
   protected:
     /* members */
@@ -72,6 +73,13 @@ class CDisplay
     std::string m_name;
 };
 
+/**
+ * @class CDisplay
+ *
+ * Memory definition for CCPU
+ */
+typedef CDisplayT<CDat> CDisplay;
+
 #endif
 
 /* vim: set et sw=2 ts=2: */
diff --git a/ue3/mycpu/cinstruction.cpp b/ue3/mycpu/cinstruction.cpp
index 5c1bd5c..a766015 100644
--- a/ue3/mycpu/cinstruction.cpp
+++ b/ue3/mycpu/cinstruction.cpp
@@ -8,6 +8,7 @@
 #include <sstream>
 #include <stdexcept>
 #include <boost/lexical_cast.hpp>
+#include <assert.h>
 #include "cinstruction.h"
 #include "ccpu.h"
 
@@ -35,6 +36,7 @@ const unsigned CInstruction::parseRegister(const std::string& str)
 
 inline void CInstruction::checkRegister(CCPU *cpu, const unsigned regidx)
 {
+  assert(cpu != NULL);
   if (regidx >= cpu->getRegisterCount())
   {
     stringstream sstr;
diff --git a/ue3/mycpu/instructions.cpp b/ue3/mycpu/instructions.cpp
index c2ce096..ef9e944 100644
--- a/ue3/mycpu/instructions.cpp
+++ b/ue3/mycpu/instructions.cpp
@@ -6,6 +6,7 @@
  */
 
 #include <map>
+#include <assert.h>
 #include "instructions.h"
 
 using namespace std;
@@ -22,6 +23,8 @@ void CInstructionInc::compile(std::list<std::string>& params)
 
 void CInstructionInc::execute(CCPU *cpu)
 {
+  assert(cpu != NULL);
+  assert(cpu->getRegisters() != NULL);
   checkRegister(cpu, m_regidx1);
   cpu->getRegisters()[ m_regidx1 ]++;
 }
@@ -40,6 +43,8 @@ void CInstructionDec::compile(std::list<std::string>& params)
 
 void CInstructionDec::execute(CCPU *cpu)
 {
+  assert(cpu != NULL);
+  assert(cpu->getRegisters() != NULL);
   checkRegister(cpu, m_regidx1);
   cpu->getRegisters()[ m_regidx1 ]--;
 }
@@ -62,6 +67,8 @@ void CInstructionAdd::compile(std::list<std::string>& params)
 
 void CInstructionAdd::execute(CCPU *cpu)
 {
+  assert(cpu != NULL);
+  assert(cpu->getRegisters() != NULL);
   checkRegister(cpu, m_regidx1);
   checkRegister(cpu, m_regidx2);
   checkRegister(cpu, m_regidx3);
@@ -87,6 +94,8 @@ void CInstructionSub::compile(std::list<std::string>& params)
 
 void CInstructionSub::execute(CCPU *cpu)
 {
+  assert(cpu != NULL);
+  assert(cpu->getRegisters() != NULL);
   checkRegister(cpu, m_regidx1);
   checkRegister(cpu, m_regidx2);
   checkRegister(cpu, m_regidx3);
@@ -137,6 +146,8 @@ void CInstructionDiv::compile(std::list<std::string>& params)
 
 void CInstructionDiv::execute(CCPU *cpu)
 {
+  assert(cpu != NULL);
+  assert(cpu->getRegisters() != NULL);
   checkRegister(cpu, m_regidx1);
   checkRegister(cpu, m_regidx2);
   checkRegister(cpu, m_regidx3);
@@ -160,6 +171,9 @@ void CInstructionLoad::compile(std::list<std::string>& params)
 
 void CInstructionLoad::execute(CCPU *cpu)
 {
+  assert(cpu != NULL);
+  assert(cpu->getRegisters() != NULL);
+  assert(cpu->getMemory() != NULL);
   checkRegister(cpu, m_regidx1);
   checkRegister(cpu, m_regidx2);
   CDat val(cpu->getRegisters()[ m_regidx2 ]);
@@ -182,6 +196,9 @@ void CInstructionStore::compile(std::list<std::string>& params)
 
 void CInstructionStore::execute(CCPU *cpu)
 {
+  assert(cpu != NULL);
+  assert(cpu->getRegisters() != NULL);
+  assert(cpu->getMemory() != NULL);
   checkRegister(cpu, m_regidx1);
   checkRegister(cpu, m_regidx2);
   CDat val(cpu->getRegisters()[ m_regidx2 ]);
@@ -202,6 +219,8 @@ void CInstructionTest::compile(std::list<std::string>& params)
 
 void CInstructionTest::execute(CCPU *cpu)
 {
+  assert(cpu != NULL);
+  assert(cpu->getRegisters() != NULL);
   checkRegister(cpu, m_regidx1);
   if (cpu->getRegisters()[ m_regidx1 ] == CDat(0))
     cpu->setFlagZero(true);
@@ -223,6 +242,9 @@ void CInstructionJumpA::compile(std::list<std::string>& params)
 
 void CInstructionJumpA::execute(CCPU *cpu)
 {
+  assert(cpu != NULL);
+  assert(cpu->getRegisters() != NULL);
+  assert(cpu->getProgram() != NULL);
   if (m_addr.empty())
     throw runtime_error("Empty address");
   cpu->getRegisters()[ 0 ] = cpu->getProgram()->findLabel(m_addr);
@@ -242,8 +264,13 @@ void CInstructionJumpZ::compile(std::list<std::string>& params)
 
 void CInstructionJumpZ::execute(CCPU *cpu)
 {
+  assert(cpu != NULL);
+  assert(cpu->getRegisters() != NULL);
+  assert(cpu->getProgram() != NULL);
   if (!cpu->getFlagZero())
     return;
+  if (m_addr.empty())
+    throw runtime_error("Empty address");
   cpu->getRegisters()[ 0 ] = cpu->getProgram()->findLabel(m_addr);
 }
 
@@ -261,8 +288,13 @@ void CInstructionJumpS::compile(std::list<std::string>& params)
 
 void CInstructionJumpS::execute(CCPU *cpu)
 {
+  assert(cpu != NULL);
+  assert(cpu->getRegisters() != NULL);
+  assert(cpu->getProgram() != NULL);
   if (!cpu->getFlagSign())
     return;
+  if (m_addr.empty())
+    throw runtime_error("Empty address");
   cpu->getRegisters()[ 0 ] = cpu->getProgram()->findLabel(m_addr);
 }
 
@@ -282,6 +314,8 @@ void CInstructionWrite::compile(std::list<std::string>& params)
 
 void CInstructionWrite::execute(CCPU *cpu)
 {
+  assert(cpu != NULL);
+  assert(cpu->getRegisters() != NULL);
   checkRegister(cpu, m_regidx1);
   if (m_dev.empty())
     throw runtime_error("Empty device");
diff --git a/ue3/mycpu/test/memory1 b/ue3/mycpu/test/memory1
deleted file mode 100644
index 209e3ef..0000000
--- a/ue3/mycpu/test/memory1
+++ /dev/null
@@ -1 +0,0 @@
-20
diff --git a/ue3/mycpu/test/program1 b/ue3/mycpu/test/program1
deleted file mode 100644
index ae5e9d2..0000000
--- a/ue3/mycpu/test/program1
+++ /dev/null
@@ -1,13 +0,0 @@
-# set R2 = 10
-LOAD R2, R1
-
-# start of loop
-label Loop:
-inc R3
-sub R4, R3, R2
-test R4
-jumpz EndLoop
-write WDEZ, R3
-jumpa Loop
-
-label EndLoop:
diff --git a/ue3/mycpu/test/test.sh b/ue3/mycpu/test/test.sh
index ad2ae4d..ff1076c 100755
--- a/ue3/mycpu/test/test.sh
+++ b/ue3/mycpu/test/test.sh
@@ -32,9 +32,11 @@ do
   if [ "$md5_1" != "$md5_2" ]
   then
     echo "  ERROR: output and $reffile differ"
-    diff -Nau $reffile $tmpfile
+    diff -Naur "$reffile" "$tmpfile"
+    rm -rf "$tmpfile"
     exit 1
   else
     echo "  SUCCESS"
   fi
+  rm -rf "$tmpfile"
 done
diff --git a/ue3/protokoll.pdf b/ue3/protokoll.pdf
new file mode 100644
index 0000000..3d8c5eb
--- /dev/null
+++ b/ue3/protokoll.pdf
diff --git a/ue3/protokoll/mycpu.png b/ue3/protokoll/mycpu.png
new file mode 100644
index 0000000..570d50a
--- /dev/null
+++ b/ue3/protokoll/mycpu.png
diff --git a/ue3/protokoll/mycpu.vpp b/ue3/protokoll/mycpu.vpp
new file mode 100644
index 0000000..1f4b264
--- /dev/null
+++ b/ue3/protokoll/mycpu.vpp
diff --git a/ue3/protokoll/protokoll.tex b/ue3/protokoll/protokoll.tex
index 8b413e7..dd53735 100644
--- a/ue3/protokoll/protokoll.tex
+++ b/ue3/protokoll/protokoll.tex
@@ -38,44 +38,110 @@ Manuel Mausz, \matrnr 0728348\\
 
 Abbildung~\ref{fig:classdiagram1} zeigt das Klassendiagramm der Aufgabe.
 
-TODO
+Als Datentyp für Register und Hauptspeicher der CPU wurde ein allgemeines
+Template implementiert, welche andere Datentypen oder Klasse umhüllen kann.
+Zudem wurden die gängigsten Operatoren definiert, die man sich von einem
+Datentyp erwarten kann. Gemäß der Aufgabenstellung wurde der Datentyp CDat als
+umhüllter Integer-Wert definiert.
+
+Der Hauptspeicher der CPU wurde als abgeleitetes Template \mbox{CVectorMem} des
+Templates \mbox{std::vector<T, Allocator>} implementiert, damit dieses um die
+Methode \mbox{initialize} und \mbox{dump} erweitert werden konnten. Erstere
+dient zur Initialisierung des Hauptspeichers bzw. Füllung des Vectors,
+zweiteres zur Debugausgabe. Der Datentyp CMem wurde via typedef als
+\mbox{CVectorMem} mit dem Templateargument CDat definiert. Somit enthält der
+Hauptspeicher nur Elemente des Typs CDat.
+
+Die geforderten zwei Display-Klassen \mbox{CDisplayWDEZ} und 
+\mbox{CDisplayWHEX} wurden von der abstrakten Klasse CDisplay abgeleitet, welche
+selbst als Template CDisplayT mit dem Templateargument CDat definiert ist.
+
+Der Programmspeicher \mbox{CProgram} wurde vom Template
+\mbox{std::vector<CInstruction *>} abgeleitet. Somit ist diese Klasse, ähnlich
+wie CMem, selbst ein Vector. Zudem wurden weitere Methoden hinzugefügt. Die
+Methode \mbox{compile} dient zum Kompilieren bzw. Umwandeln des
+Syntax der Programmdatei in Instanzen der Klasse CInstruction, die später von
+der CPU ausgeführt werden. Zur Umwandlung werden bei der Instantiierung von
+\mbox{CProgram} sämtliche erlaubten Instruktionen (also Instanzen von
+\mbox{CInstruction}) in ein \mbox{std::set} eingefügt. Im Zuge der Methode
+\mbox{compile} wird durch Iterieren die jeweilige Instruktion gesucht und durch
+Anwendung des Designpattern \textit{Factory method pattern} die Instruktion
+dupliziert und in \mbox{CProgram} gespeichert. Labels werden zwecks Effizienz in
+einer \mbox{std::map} festgehalten.
+
+Die jeweiligen unterstützen Instruktionen wurden wie gefordert von der Klasse
+\mbox{CInstruction} abgeleitet. \mbox{CInstruction} fordert die
+Implementierung einer Methode \mbox{compile}, die während des parsens der
+Programmdatei von \mbox{CProgram} aufgerufen werden, als auch eine Methode
+\mbox{execute}, die im Zuge der Ausführung des Programms von CCPU
+aufgerufen werden.
+
+Die eigentliche CPU wird durch die Klasse \mbox{CCPU} implementiert. Diese
+dient hauptsächlich als Container für die einzelnen, notwendigen Teile
+(Hauptspeicher, Programmspeicher, Displays, ...) und besitzt daher entsprechend
+viele get- und set-Funktionen. Die Methode \mbox{run} dient zur Ausführung des
+Programms und ist eine Schleife, die über die Instruktionen iteriert und die
+Methode \mbox{execute} aufruft.
 
 %==================================================================
-\begin{figure}[htb]
-  \begin{center}
-    \epsfxsize=0.9\textwidth\epsfbox{mycpu.png}
-  \end{center}
-  \caption{Klassendiagramm 1}
-  \label{fig:classdiagram1}
-\end{figure}
+\begin{center}
+  \begin{figure}[htb]
+    \epsfxsize=1.6\textwidth\epsfbox{mycpu.png}
+    \caption{Klassendiagramm 1}
+    \label{fig:classdiagram1}
+  \end{figure}
+\end{center}
 %==================================================================
 
 \subsection{Verwaltung der Ressourcen}
 
-TODO
+Alle Objekte, die im Konstruktor alloziert werden, werden im Destruktor wieder
+freigegeben. Die Objekte, die über die \textit{Factory method pattern}
+alloziert werden, werden im Zuge des Destruktor des Vectors bzw.
+von \mbox{CProgram} wieder freigegeben.
 
 \subsection{Fehlerbehandlung}
 
-TODO
+Es wurden keine eigenen Exceptions eingeführt. Statt dessen werden Exceptions
+meist in Exceptions des Typs \mbox{std::runtime\_error} umgewandelt. Da die
+Hierarchie nicht sehr tief ist, fängt lediglich \mbox{CPropram::compile}
+Exceptions des Typs \mbox{std::runtime\_error}, um zusätzliche Information an
+den ursprünglichen Aufrufer der Methode weiterzugeben. Dies geschieht ebenfalls
+per Exception des Typs \mbox{std::runtime\_error}.
 
 \subsection{Implementierung}
 
-TODO
-
+Siehe Punkt~\ref{Design} und Abbildung~\ref{fig:classdiagram1} sowie
+Punkt~\ref{Listings}.\\
+Es wurde viel mit Templates gearbeitet.
 
 \section{Projektverlauf}
 
 \subsection{Probleme und Fallstricke}
 
-TODO
+Abgesehen von den mittlerweile üblichen Schwierigkeiten die Angabe bzw.
+die Gedanken dessen Verfassers verstehen zu wollen, arbeitete das erste Design
+noch vermehrt mit Text. Unter anderem hatte die Methode
+\mbox{CInstruction::execute} einen Parameter des Typs \mbox{std::string}, was
+zum dazu führte, das die Instruktion bei jeder Aufführung (zum Beispiel durch
+Jumps) erneut geparsed werden musste.
 
 \subsection{Arbeitsaufwand}
 
 \begin{tabular}{ll}
   \toprule
-  Entwicklungsschritt / Meilenstein & Arbeitsaufwand in Stunden\\
+  Entwicklungsschritt / Meilenstein & Arbeitsaufwand\\
+  \midrule
+  Erstes Design & 3 Stunden\\
+  \hline
+  Implementierung & 3 Tage\\
+  \hline
+  Anpassung des Designs und der Implementierung & 4 Stunden\\
+  \hline
+  Dokumentation (Doxygen) und Überprüfung aller\\
+  Anforderungen gemäß der Programmierrichtlinien & 4 Stunden\\
   \hline
-  TODO & TODO\\
+  Erstellung des Protokolls & 3 Stunden\\
   \bottomrule
 \end{tabular}
 
@@ -88,5 +154,53 @@ TODO
 \subsection{mycpu.cpp}
 \lstinputlisting{../mycpu/mycpu.cpp}
 
+\newpage
+\subsection{cdat.h}
+\lstinputlisting{../mycpu/cdat.h}
+
+\newpage
+\subsection{cmem.h}
+\lstinputlisting{../mycpu/cmem.h}
+
+\newpage
+\subsection{cinstruction.h}
+\lstinputlisting{../mycpu/cinstruction.h}
+
+\newpage
+\subsection{cinstruction.cpp}
+\lstinputlisting{../mycpu/cinstruction.cpp}
+
+\newpage
+\subsection{instructions.h}
+\lstinputlisting{../mycpu/instructions.h}
+
+\newpage
+\subsection{instructions.cpp}
+\lstinputlisting{../mycpu/instructions.cpp}
+
+\newpage
+\subsection{cdisplay.h}
+\lstinputlisting{../mycpu/cdisplay.h}
+
+\newpage
+\subsection{displays.h}
+\lstinputlisting{../mycpu/displays.h}
+
+\newpage
+\subsection{cprogram.h}
+\lstinputlisting{../mycpu/cprogram.h}
+
+\newpage
+\subsection{cprogram.cpp}
+\lstinputlisting{../mycpu/cprogram.cpp}
+
+\newpage
+\subsection{ccpu.h}
+\lstinputlisting{../mycpu/ccpu.h}
+
+\newpage
+\subsection{ccpu.cpp}
+\lstinputlisting{../mycpu/ccpu.cpp}
+
 \end{document}