1 files changed, 64 insertions, 27 deletions

diff --git a/ue4/mycpu/cinstruction.h b/ue4/mycpu/cinstruction.h
index a2e3743..85122b4 100644
--- a/ue4/mycpu/cinstruction.h
+++ b/ue4/mycpu/cinstruction.h
@@ -1,7 +1,7 @@
 /**
  * @module cinstruction
  * @author Guenther Neuwirth (0626638), Manuel Mausz (0728348)
- * @brief  Abstract class for displays
+ * @brief  Abstract class for instructions
  * @date   26.05.2009
  */
 
@@ -11,21 +11,46 @@
 #include <iostream>
 #include <list>
 #include <sstream>
-#include <stdexcept>
 #include <boost/lexical_cast.hpp>
 #include <assert.h>
+#include <stdexcept>
+
+/**
+ * @class CInstructionError
+ *
+ * Exception thrown by implemententations of CInstruction
+ */
+class CInstructionError
+ : public std::invalid_argument
+{
+  public:
+    /**
+     * @method CInstructionError
+     * @brief  Default exception ctor
+     * @param  what  message to pass along
+     * @return -
+     * @globalvars none
+     * @exception  none
+     * @pre  none
+     * @post none
+     */
+    CInstructionError(const std::string& what)
+      : std::invalid_argument(what)
+    {}
+};
+
 #include "ccpu.h"
 
 /* forward declare CCPU */
-template<class T, int >
+template <class T>
 class CCPU;
 
 /**
  * @class CInstruction
  *
- * Abstract class for displays
+ * Abstract class for instructions
  */
-template<class T=CDat<int>, int width=0>
+template <class T>
 class CInstruction
 {
   public:
@@ -36,7 +61,8 @@ class CInstruction
      * @return -
      * @globalvars none
      * @exception  none
-     * @conditions none
+     * @pre  none
+     * @post none
      */
     CInstruction(std::string name)
       : m_name(name)
@@ -49,7 +75,8 @@ class CInstruction
      * @return -
      * @globalvars none
      * @exception  none
-     * @conditions none
+     * @pre  none
+     * @post none
      */
     virtual ~CInstruction()
     {}
@@ -61,7 +88,8 @@ class CInstruction
      * @return true if instructionname is name
      * @globalvars none
      * @exception  none
-     * @conditions none
+     * @pre  none
+     * @post none
      */
     virtual bool operator==(std::string& name)
     {
@@ -74,8 +102,9 @@ class CInstruction
      * @param  cpu  pointer to cpu
      * @return -
      * @globalvars none
-     * @exception  std::runtime_error
-     * @conditions none
+     * @exception  CInstructionError
+     * @pre  none
+     * @post none
      */
     virtual CInstruction& operator()(CCPU<T> *cpu)
     {
@@ -90,7 +119,8 @@ class CInstruction
      * @return name of instruction
      * @globalvars none
      * @exception  none
-     * @conditions none
+     * @pre  none
+     * @post none
      */
     virtual const std::string& getName()
     {
@@ -104,7 +134,8 @@ class CInstruction
      * @return reference to outputstream
      * @globalvars none
      * @exception  none
-     * @conditions none
+     * @pre  none
+     * @post none
      */
     virtual std::ostream& dump(std::ostream& stream)
     {
@@ -120,7 +151,8 @@ class CInstruction
      * @return reference to outputstream
      * @globalvars none
      * @exception  none
-     * @conditions none
+     * @pre  none
+     * @post none
      */
     friend std::ostream& operator<<(std::ostream& stream, CInstruction& instr)
     {
@@ -133,8 +165,9 @@ class CInstruction
      * @param  str  register in assembler syntax
      * @return registernumber
      * @globalvars none
-     * @exception  std::runtime_error
-     * @conditions none
+     * @exception  CInstructionError
+     * @pre  none
+     * @post none
      */
     virtual const unsigned parseRegister(const std::string& str);
 
@@ -146,8 +179,9 @@ class CInstruction
      * @param  regidx  registernumber
      * @return -
      * @globalvars none
-     * @exception  std::runtime_error
-     * @conditions none
+     * @exception  CInstructionError
+     * @pre  none
+     * @post none
      */
     virtual void checkRegister(CCPU<T> *cpu, const unsigned regidx);
 
@@ -158,7 +192,8 @@ class CInstruction
      * @return new instruction instance
      * @globalvars none
      * @exception  none
-     * @conditions none
+     * @pre  none
+     * @post none
      */
     virtual CInstruction *factory() = 0;
 
@@ -169,8 +204,9 @@ class CInstruction
      * @param  params  list of parameters of this instruction
      * @return -
      * @globalvars none
-     * @exception  std::runtime_error
-     * @conditions none
+     * @exception  CInstructionError
+     * @pre  none
+     * @post none
      */
     virtual void compile(std::list<std::string>& params) = 0;
 
@@ -180,8 +216,9 @@ class CInstruction
      * @param  cpu  pointer to cpu
      * @return -
      * @globalvars none
-     * @exception  std::runtime_error
-     * @conditions none
+     * @exception  CInstructionError
+     * @pre  none
+     * @post none
      */
     virtual void execute(CCPU<T> *cpu) = 0;
 
@@ -193,12 +230,12 @@ class CInstruction
 
 /*----------------------------------------------------------------------------*/
 
-template<class T=CDat<int>, int width=0>
+template<class T>
 const unsigned CInstruction<T>::parseRegister(const std::string& str)
 {
   unsigned reg;
   if (str.length() < 2 || str[0] != 'r')
-    throw std::runtime_error("Invalid syntax of register");
+    throw CInstructionError("Invalid syntax of register");
 
   try
   {
@@ -206,7 +243,7 @@ const unsigned CInstruction<T>::parseRegister(const std::string& str)
   }
   catch(boost::bad_lexical_cast& ex)
   {
-    throw std::runtime_error("Invalid syntax of register");
+    throw CInstructionError("Invalid syntax of register");
   }
 
   return reg;
@@ -214,7 +251,7 @@ const unsigned CInstruction<T>::parseRegister(const std::string& str)
 
 /*----------------------------------------------------------------------------*/
 
-template<class T=CDat<int>, int width=0>
+template<class T>
 inline void CInstruction<T>::checkRegister(CCPU<T> *cpu, const unsigned regidx)
 {
   assert(cpu != NULL);
@@ -222,7 +259,7 @@ inline void CInstruction<T>::checkRegister(CCPU<T> *cpu, const unsigned regidx)
   {
     std::stringstream sstr;
     sstr << "Register R" << regidx << " doesn't exist (out of bound)";
-    throw std::runtime_error(sstr.str());
+    throw CInstructionError(sstr.str());
   }
 }