finished testbench generation

[blast.git] / AbstractBlock.h

diff --git a/AbstractBlock.h b/AbstractBlock.h
index aee8c99766ae2256175662dbba913f1734d25382..f40af86773e020d59e417508004dbb63d7572319 100644 (file)
--- a/AbstractBlock.h
+++ b/AbstractBlock.h
@@ -4,13 +4,16 @@
 #include <iostream>\r
 \r
 #include <QtCore>\r
 #include <iostream>\r
 \r
 #include <QtCore>\r

+#include <QtXml>\r

 \r
 #include "AbstractInterface.h"\r
 class AbstractInterface;\r
 class BlockParameter;\r
 \r
 #include "AbstractInterface.h"\r
 class AbstractInterface;\r
 class BlockParameter;\r

+class Graph;\r

 \r
 #define AB_TO_REF(ptr) ((ReferenceBlock*)ptr)\r
 #define AB_TO_FUN(ptr) ((FunctionalBlock*)ptr)\r
 \r
 #define AB_TO_REF(ptr) ((ReferenceBlock*)ptr)\r
 #define AB_TO_FUN(ptr) ((FunctionalBlock*)ptr)\r

+#define AB_TO_SPE(ptr) ((SpecialBlock*)ptr)\r

 #define AB_TO_GRP(ptr) ((GroupBlock*)ptr)\r
 \r
 using namespace std;\r
 #define AB_TO_GRP(ptr) ((GroupBlock*)ptr)\r
 \r
 using namespace std;\r


@@ -20,39 +23,75 @@ class AbstractBlock {
 \r
 public:  \r
       \r
 \r
 public:  \r
       \r

-  AbstractBlock();\r
-  AbstractBlock(const QString& _name);\r
+  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
+  enum SpecialType { NotSpecial = 0, Source = 1, Sink = 2, ClkConvert = 3 };\r
+\r
+\r
+  AbstractBlock(Graph* _graph);\r
+  //AbstractBlock(const QString& _name);\r

   virtual ~AbstractBlock();\r
 \r
   // getters\r
   inline QString getName() { return name; }\r
   virtual ~AbstractBlock();\r
 \r
   // getters\r
   inline QString getName() { return name; }\r

+  inline int getSpecialType() { return specialType; }\r
+  inline QString getVersion() { return version; }\r

   inline int nbParameters() { return params.size(); }\r
   inline int nbParameters() { return params.size(); }\r

-  inline QList<BlockParameter *> getParameters() { return params; }\r
+  inline Graph* getGraph() { return graph; }\r
+\r

   inline QList<AbstractInterface*> getInputs() { return inputs; }\r
   inline QList<AbstractInterface*> getOutputs() { return outputs; }\r
   inline QList<AbstractInterface*> getInputs() { return inputs; }\r
   inline QList<AbstractInterface*> getOutputs() { return outputs; }\r

-  inline QList<AbstractInterface*> getBidirs() { return bidirs; }\r
+  inline QList<AbstractInterface*> getBidirs() { return bidirs; }  \r
+  QList<AbstractInterface *> getInterfaces(int direction = AbstractInterface::AnyDirection, int purpose = AbstractInterface::AnyPurpose);\r
+  QList<AbstractInterface *> getDataInputs(); //! return all inputs of type data\r
+  QList<AbstractInterface *> getDataOutputs(); //! return all inputs of type data\r
+  QList<AbstractInterface *> getControlInputs(); //! return all inputs of type control\r
+  QList<AbstractInterface *> getControlOutputs(); //! return all outputs of type control\r
+  AbstractInterface* getIfaceFromName(QString name);\r
+\r
+  inline QList<BlockParameter *> getParameters() { return params; }\r
+  BlockParameter* getParameterFromName(QString name);\r

   QList<BlockParameter *> getUserParameters();\r
   QList<BlockParameter *> getGenericParameters();\r
   QList<BlockParameter *> getPortParameters();\r
   QList<BlockParameter *> getWishboneParameters();\r
   QList<BlockParameter *> getUserParameters();\r
   QList<BlockParameter *> getGenericParameters();\r
   QList<BlockParameter *> getPortParameters();\r
   QList<BlockParameter *> getWishboneParameters();\r

+\r

   inline AbstractBlock* getParent() { return parent; }\r
   inline AbstractBlock* getParent() { return parent; }\r

-  inline bool getPatternComputed() { return patternComputed; }\r
+  inline bool getOutputPatternComputed() { return outputPatternComputed; }\r
+  inline int getTraversalLevel() { return traversalLevel; }\r

   \r
   // setters\r
   void setName(const QString& str);\r
   \r
   // setters\r
   void setName(const QString& str);\r

+  void setSpecialType(int type);\r
+  inline void setVersion(const QString& _version) { version = _version; }\r

   virtual void setParent(AbstractBlock* _parent);\r
   virtual void setParent(AbstractBlock* _parent);\r

-  inline void setPatternComputed(bool state) { patternComputed = state; }\r
+  inline void setOutputPatternComputed(bool state) {  outputPatternComputed = state; }\r
+  inline void resetTraversalLevel() { traversalLevel = -1; }\r
+  inline void setTraversalLevel(int level) { traversalLevel = level; }\r

 \r
   // testers\r
   virtual bool isReferenceBlock();\r
   virtual bool isFunctionalBlock();\r
 \r
   // testers\r
   virtual bool isReferenceBlock();\r
   virtual bool isFunctionalBlock();\r

+  virtual bool isSpecialBlock();\r

   virtual bool isGroupBlock();\r
   virtual bool isGroupBlock();\r

-  virtual bool isSourceBlock(); //! a source block is outside the top group and simulates a peripheral (NB: this is also a generator)\r
+  virtual bool isStimuliBlock(); //! a stimuli block is outside the top group and simulates a peripheral (NB: this is also a source)\r

   virtual bool isTopGroupBlock();\r
   virtual bool isTopGroupBlock();\r

-  bool isGeneratorBlock(); //! a generator block has no data inputs and thus executes infinitely\r
+  bool isSourceBlock(); //! a source block is either a block that has no data inputs or that is of special type source. Thus it executes infinitely\r
+  bool isSinkBlock(); //! a sink block has no data outputs and just collects what it receives (i.e. no compatibility check)\r

   bool isWBConfigurable();\r
 \r
   // others\r
   bool isWBConfigurable();\r
 \r
   // others\r

+  int getSpecialTypeFromString(QString str);\r
+\r
+  /*!\r
+   * \brief connectClkReset connects the clock and reset inputs to a clkrstgen block or the the group ifaces\r
+   * \param idBlockClk is the id of the clock interface (there may be severals)\r
+   * \param idGen is the id of the clkrstgen block\r
+  */  \r
+  virtual QList<QString> getExternalResources() = 0; // returns the list of all external files needed for VHDL generation\r
+  virtual void generateVHDL(const QString& path) throw(Exception) = 0; // main entry to generate the VHDL code\r
+  void generateComponent(QTextStream& out, bool hasController=false) throw(Exception); // generate the component using reference\r
+  void generateEntity(QTextStream& out, bool hasController=false) throw(Exception); // generate the entity using reference\r
+\r

   virtual void parametersValidation(QList<AbstractBlock*>* checkedBlocks, QList<AbstractBlock*>* blocksToConfigure) = 0; // ugly but usefull   \r
 \r
   void addParameter(BlockParameter *param);\r
   virtual void parametersValidation(QList<AbstractBlock*>* checkedBlocks, QList<AbstractBlock*>* blocksToConfigure) = 0; // ugly but usefull   \r
 \r
   void addParameter(BlockParameter *param);\r


@@ -61,22 +100,19 @@ public:
   void removeAllInterfaces();\r
   void defineBlockParam(BlockParameter *param);\r
 \r
   void removeAllInterfaces();\r
   void defineBlockParam(BlockParameter *param);\r
 \r

-  QList<AbstractInterface *> getInterfaces(int direction = AbstractInterface::AnyDirection, int purpose = AbstractInterface::AnyPurpose);\r
-  QList<AbstractInterface *> getDataInputs(); //! return all inputs of type data\r
-  QList<AbstractInterface *> getDataOutputs(); //! return all inputs of type data\r
-  QList<AbstractInterface *> getControlInputs(); //! return all inputs of type control\r
-  QList<AbstractInterface *> getControlOutputs(); //! return all outputs of type control\r
-  AbstractInterface* getIfaceFromName(QString name);\r
-  BlockParameter* getParameterFromName(QString name);\r

 \r
   // patterns\r
 \r
   // patterns\r

-  virtual bool checkInputPatternCompatibility() = 0;\r
-  virtual bool computeOutputPattern(int nbExec = -1) = 0;\r
+  virtual void checkInputPatternCompatibility() throw(Exception) = 0;\r
+  virtual void computeOutputPattern(int nbExec = -1) throw(Exception) = 0;\r
+  virtual void computeAdmittanceDelays() throw(Exception) = 0;\r

   \r
 protected:\r
 \r
 \r
   QString name;\r
   \r
 protected:\r
 \r
 \r
   QString name;\r

+  int specialType;\r
+  QString version;\r
+  Graph* graph;\r

 \r
   // parameters\r
   QList<BlockParameter *> params;\r
 \r
   // parameters\r
   QList<BlockParameter *> params;\r


@@ -89,10 +125,18 @@ protected:
   // others\r
   \r
   // patterns  \r
   // others\r
   \r
   // patterns  \r

-  bool patternComputed;\r
+  bool outputPatternComputed;\r
+  int traversalLevel; // the level (0, 1, ...) during the traversal of the graph\r

   \r
   // NB: only GroupBlock and FunctionalBlock have a real parent, except sources that have no parents\r
   AbstractBlock* parent;\r
   \r
   // NB: only GroupBlock and FunctionalBlock have a real parent, except sources that have no parents\r
   AbstractBlock* parent;\r

+\r
+  virtual void generateComments(QTextStream& out, QDomElement &elt, QString coreFile) throw(Exception) = 0; // generates comments from <comments> element\r
+  virtual void generateLibraries(QTextStream& out, QDomElement &elt) throw(Exception) = 0; // generates libraries from <libraries> element  \r
+  virtual void generateArchitecture(QTextStream& out, QDomElement &elt ) throw(Exception) = 0; // generate the architecture using <architecture> element\r
+  virtual void generateController(QTextStream& out) throw(Exception) = 0; // generate the wishbone controller of the block\r
+  virtual void generateEntityOrComponentBody(QTextStream& out, int indentLevel, bool hasController=false) throw(Exception) = 0; // generate the entity/compo body using reference\r
+\r

 };\r
 \r
 #endif // __ABSTRACTBLOCK_H__\r
 };\r
 \r
 #endif // __ABSTRACTBLOCK_H__\r