AbstractBlock.h

   1 #ifndef __ABSTRACTBLOCK_H__\r
   2 #define __ABSTRACTBLOCK_H__\r
   3 \r
   4 #include <iostream>\r
   5 \r
   6 #include <QtCore>\r
   7 #include <QtXml>\r
   8 \r
   9 #include "AbstractInterface.h"\r
  10 class AbstractInterface;\r
  11 class BlockParameter;\r
  12 \r
  13 #define AB_TO_REF(ptr) ((ReferenceBlock*)ptr)\r
  14 #define AB_TO_FUN(ptr) ((FunctionalBlock*)ptr)\r
  15 #define AB_TO_SPE(ptr) ((SpecialBlock*)ptr)\r
  16 #define AB_TO_GRP(ptr) ((GroupBlock*)ptr)\r
  17 \r
  18 using namespace std;\r
  19 using namespace Qt;\r
  20 \r
  21 class AbstractBlock {\r
  22 \r
  23 public:  \r
  24       \r
  25   enum BlockVHDLContext {AnyContext = 0, Entity = 1, Component = 2, Architecture = 3 }; // NB : 3 is when creating an instance of the block that owns this iface\r
  26   enum SpecialType { NotSpecial = 0, Source = 1, Sink = 2, ClkConvert = 3 };\r
  27 \r
  28 \r
  29   AbstractBlock();\r
  30   //AbstractBlock(const QString& _name);\r
  31   virtual ~AbstractBlock();\r
  32 \r
  33   // getters\r
  34   inline QString getName() { return name; }\r
  35   inline int getSpecialType() { return specialType; }\r
  36   inline QString getVersion() { return version; }\r
  37   inline int nbParameters() { return params.size(); }\r
  38 \r
  39   inline QList<AbstractInterface*> getInputs() { return inputs; }\r
  40   inline QList<AbstractInterface*> getOutputs() { return outputs; }\r
  41   inline QList<AbstractInterface*> getBidirs() { return bidirs; }  \r
  42   QList<AbstractInterface *> getInterfaces(int direction = AbstractInterface::AnyDirection, int purpose = AbstractInterface::AnyPurpose);\r
  43   QList<AbstractInterface *> getDataInputs(); //! return all inputs of type data\r
  44   QList<AbstractInterface *> getDataOutputs(); //! return all inputs of type data\r
  45   QList<AbstractInterface *> getControlInputs(); //! return all inputs of type control\r
  46   QList<AbstractInterface *> getControlOutputs(); //! return all outputs of type control\r
  47   AbstractInterface* getIfaceFromName(QString name);\r
  48 \r
  49   inline QList<BlockParameter *> getParameters() { return params; }\r
  50   BlockParameter* getParameterFromName(QString name);\r
  51   QList<BlockParameter *> getUserParameters();\r
  52   QList<BlockParameter *> getGenericParameters();\r
  53   QList<BlockParameter *> getPortParameters();\r
  54   QList<BlockParameter *> getWishboneParameters();\r
  55 \r
  56   inline AbstractBlock* getParent() { return parent; }\r
  57   inline bool getOutputPatternComputed() { return outputPatternComputed; }\r
  58   inline int getTraversalLevel() { return traversalLevel; }\r
  59   \r
  60   // setters\r
  61   void setName(const QString& str);\r
  62   void setSpecialType(int type);\r
  63   inline void setVersion(const QString& _version) { version = _version; }\r
  64   virtual void setParent(AbstractBlock* _parent);\r
  65   inline void setOutputPatternComputed(bool state) {  outputPatternComputed = state; }\r
  66   inline void resetTraversalLevel() { traversalLevel = -1; }\r
  67   inline void setTraversalLevel(int level) { traversalLevel = level; }\r
  68 \r
  69   // testers\r
  70   virtual bool isReferenceBlock();\r
  71   virtual bool isFunctionalBlock();\r
  72   virtual bool isSpecialBlock();\r
  73   virtual bool isGroupBlock();\r
  74   virtual bool isStimuliBlock(); //! a stimuli block is outside the top group and simulates a peripheral (NB: this is also a source)\r
  75   virtual bool isTopGroupBlock();\r
  76   bool isSourceBlock(); //! a source block has no data inputs and thus executes infinitely\r
  77   bool isSinkBlock(); //! a sink block has no data outputs and just collects what it receives (i.e. no compatibility check)\r
  78   bool isWBConfigurable();\r
  79 \r
  80   // others\r
  81   int getSpecialTypeFromString(QString str);\r
  82 \r
  83   /*!\r
  84    * \brief connectClkReset connects the clock and reset inputs to a clkrstgen block or the the group ifaces\r
  85    * \param idBlockClk is the id of the clock interface (there may be severals)\r
  86    * \param idGen is the id of the clkrstgen block\r
  87   */\r
  88   void connectClock(QString clkName, int idGen = 0) throw(Exception);\r
  89   void connectReset(QString rstName, int idGen = 0) throw(Exception);\r
  90   virtual QList<QString> getExternalResources() = 0; // returns the list of all external files needed for VHDL generation\r
  91   virtual void generateVHDL(const QString& path) throw(Exception) = 0; // main entry to generate the VHDL code\r
  92   void generateComponent(QTextStream& out, bool hasController=false) throw(Exception); // generate the component using reference\r
  93   void generateEntity(QTextStream& out, bool hasController=false) throw(Exception); // generate the entity using reference\r
  94 \r
  95   virtual void parametersValidation(QList<AbstractBlock*>* checkedBlocks, QList<AbstractBlock*>* blocksToConfigure) = 0; // ugly but usefull   \r
  96 \r
  97   void addParameter(BlockParameter *param);\r
  98   void addInterface(AbstractInterface *inter);\r
  99   void removeInterface(AbstractInterface *inter);\r
 100   void removeAllInterfaces();\r
 101   void defineBlockParam(BlockParameter *param);\r
 102 \r
 103 \r
 104   // patterns\r
 105   virtual void checkInputPatternCompatibility() throw(Exception) = 0;\r
 106   virtual void computeOutputPattern(int nbExec = -1) throw(Exception) = 0;\r
 107   virtual void computeAdmittanceDelays() throw(Exception) = 0;\r
 108   \r
 109 protected:\r
 110 \r
 111 \r
 112   QString name;\r
 113   int specialType;\r
 114   QString version;\r
 115 \r
 116   // parameters\r
 117   QList<BlockParameter *> params;\r
 118 \r
 119   // interfaces\r
 120   QList<AbstractInterface*> inputs;\r
 121   QList<AbstractInterface*> outputs;\r
 122   QList<AbstractInterface*> bidirs;\r
 123   \r
 124   // others\r
 125   \r
 126   // patterns  \r
 127   bool outputPatternComputed;\r
 128   int traversalLevel; // the level (0, 1, ...) during the traversal of the graph\r
 129   \r
 130   // NB: only GroupBlock and FunctionalBlock have a real parent, except sources that have no parents\r
 131   AbstractBlock* parent;\r
 132 \r
 133   virtual void generateComments(QTextStream& out, QDomElement &elt, QString coreFile) throw(Exception) = 0; // generates comments from <comments> element\r
 134   virtual void generateLibraries(QTextStream& out, QDomElement &elt) throw(Exception) = 0; // generates libraries from <libraries> element  \r
 135   virtual void generateArchitecture(QTextStream& out, QDomElement &elt ) throw(Exception) = 0; // generate the architecture using <architecture> element\r
 136   virtual void generateController(QTextStream& out) throw(Exception) = 0; // generate the wishbone controller of the block\r
 137   virtual void generateEntityOrComponentBody(QTextStream& out, int indentLevel, bool hasController=false) throw(Exception) = 0; // generate the entity/compo body using reference\r
 138 \r
 139 };\r
 140 \r
 141 #endif // __ABSTRACTBLOCK_H__\r