AbstractInterface.h

   1 #ifndef __ABSTRACTINTERFACE_H__
   2 #define __ABSTRACTINTERFACE_H__
   3
   4 #include <iostream>
   5
   6 #include <QtCore>
   7 #include <QtGui>
   8
   9 class AbstractBlock;
  10
  11 #include "Exception.h"
  12 class Exception;
  13
  14 #define AI_TO_REF(ptr) ((ReferenceInterface*)ptr)
  15 #define AI_TO_FUN(ptr) ((FunctionalInterface*)ptr)
  16 #define AI_TO_GRP(ptr) ((GroupInterface*)ptr)
  17 #define AI_TO_CON(ptr) ((ConnectedInterface*)ptr)
  18
  19 using namespace std;
  20 using namespace Qt;
  21
  22
  23 class AbstractInterface {
  24
  25 public :
  26
  27   enum IfaceWidthType { Expression = 1, Boolean, Natural, Inherited}; //! Inherited is only for Group interface
  28   enum IfaceWidthDir { LittleEndian = 1, BigEndian}; //! LittleEndian = X downto 0, BigEndian = 0 to X
  29   enum IfacePurpose { AnyPurpose = 0, Data = 1, Control, Clock, Reset, Wishbone };
  30   enum IfaceDirection { AnyDirection = 0, Input = 1, Output = 2, InOut = 3 };
  31   enum IfaceVHDLContext {AnyContext = 0, Entity = 1, Component = 2, Architecture = 3, Signal = 4 }; // NB : 3 is when creating an instance of the block that owns this iface
  32   enum IfaceVHDLFlags { NoComma = 1 };
  33
  34   static int getIntDirection(QString str);
  35   static int getIntPurpose(QString str);
  36
  37   AbstractInterface(AbstractBlock* _owner);
  38   AbstractInterface(AbstractBlock* _owner, const QString& _name, int _direction, int _purpose, const QString& _type, const QString& _width, int _endianess = LittleEndian);
  39   AbstractInterface(AbstractInterface* other);
  40   virtual ~AbstractInterface();
  41
  42   // getters
  43   inline QString getName() { return name;}
  44   inline int getType() { return type; }
  45   QString getTypeString();
  46   inline int getEndianess() { return endianess; }
  47   QString getEndianessString();
  48   inline QString getWidthString() { return width;}
  49   virtual int getWidth(); // return -1 if size cannot be determine
  50   inline int getPurpose() { return purpose;}
  51   QString getPurposeString();
  52   inline int getDirection() { return direction;}
  53   QString getDirectionString();
  54   inline AbstractBlock *getOwner() { return owner;}
  55   inline AbstractInterface* getAssociatedIface() { return associatedIface; }
  56
  57   double getDoubleWidth() throw(QException);
  58
  59
  60   // setters
  61   inline void setOwner(AbstractBlock* _owner) { owner = _owner; }
  62   void setName(const QString& _name);
  63   inline void setWidth(const QString& _width) { width = _width; }
  64   inline void setType(int _type) { type = _type;}
  65   inline void setEndianess(int _endianess) { endianess = _endianess;}
  66   inline void setType(const QString& _type) { type = typeFromString(_type);}
  67   void setPurpose(int _purpose);
  68   void setDirection(int _direction);
  69   bool setAssociatedIface(AbstractInterface* iface);
  70
  71   // testers
  72   virtual bool isReferenceInterface();
  73   virtual bool isFunctionalInterface();
  74   virtual bool isGroupInterface();
  75
  76   // others
  77   virtual AbstractInterface *clone() = 0;
  78
  79   int typeFromString(const QString &_type);
  80
  81   QString toVHDL(int context, int flags) throw(Exception);
  82
  83 protected:
  84   QString name;
  85   int purpose;
  86   int direction;
  87   int type;
  88   QString width;
  89   int endianess;
  90
  91
  92   AbstractBlock* owner;
  93   /*!
  94    * \brief associatedIface the control (resp. data) interface that is bounded to this data (resp. control) interface
  95    * If a reference block is designed to be fully integrated in Blast, nearly every data interface is bounded
  96    * to a control interface that signals if the value presented on the interface is valid or not. associatedIface
  97    * references this control interface if this is a data interface, and a data interface is this is a control interface.
  98    * Note that the association is done by the call of setAssociatedIface() that must be done only for a control interface.
  99    * (NB: a test is done in the method to prevent the other case).
 100    */
 101   AbstractInterface* associatedIface;
 102
 103
 104 };
 105
 106
 107 #endif // __ABSTRACTINTERFACE_H__