nearly finished GroupBlock VHDL gen

[blast.git] / FunctionalBlock.h

diff --git a/FunctionalBlock.h b/FunctionalBlock.h
index 6f47a008033b7747ed9d7508c3dd6e4c158dd9cd..7bba2c8ed273565cc6a89c6f751e888d87cfa40e 100644 (file)
--- a/FunctionalBlock.h
+++ b/FunctionalBlock.h
@@ -27,12 +27,13 @@ class FunctionalBlock : public AbstractBlock {
 public:\r
 \r
   FunctionalBlock(GroupBlock* _parent, ReferenceBlock* _reference) throw(Exception);\r
 public:\r
 \r
   FunctionalBlock(GroupBlock* _parent, ReferenceBlock* _reference) throw(Exception);\r

-\r
+  ~FunctionalBlock();\r

   // getters\r
   inline ReferenceBlock* getReference() { return reference; }\r
   inline QList<int> getProductionCounter() { return productionCounter; }\r
   inline QMap<AbstractInterface*, QList<char>* > getConsumptionPattern() { return consumptionPattern; }\r
   inline QMap<AbstractInterface*, QList<char>* > getProductionPattern() { return productionPattern; }\r
   // getters\r
   inline ReferenceBlock* getReference() { return reference; }\r
   inline QList<int> getProductionCounter() { return productionCounter; }\r
   inline QMap<AbstractInterface*, QList<char>* > getConsumptionPattern() { return consumptionPattern; }\r
   inline QMap<AbstractInterface*, QList<char>* > getProductionPattern() { return productionPattern; }\r

+  inline QMap<AbstractInterface*, QList<int>* > getAdmittanceDelays() { return admittanceDelays; }\r

   inline int getConsumptionPatternLength() { return lengthCP; }\r
   inline int getProductionPatternLength() { return lengthPP; }\r
   inline int getDelta() { return delta; }\r
   inline int getConsumptionPatternLength() { return lengthCP; }\r
   inline int getProductionPatternLength() { return lengthPP; }\r
   inline int getDelta() { return delta; }\r


@@ -50,31 +51,50 @@ public:
   // others\r
 \r
   void populate(); // create parameters and interface from reference block\r
   // others\r
 \r
   void populate(); // create parameters and interface from reference block\r

+  void generateVHDL(const QString& path) throw(Exception); // main entry to generate the VHDL code  \r
+\r

   void parametersValidation(QList<AbstractBlock *> *checkedBlocks, QList<AbstractBlock*>* blocksToConfigure);\r
 \r
   QString getReferenceXmlFile();\r
   QString getReferenceHashMd5();\r
   \r
   // patterns\r
   void parametersValidation(QList<AbstractBlock *> *checkedBlocks, QList<AbstractBlock*>* blocksToConfigure);\r
 \r
   QString getReferenceXmlFile();\r
   QString getReferenceHashMd5();\r
   \r
   // patterns\r

-  bool createPatterns();\r
-  bool createDelta();\r
-  bool createConsumptionPattern(); // initialize a QList<char> for each interface from patterns defined in implementation\r
-  bool createProductionPattern(); // initialize a QList<char> for each interface from patterns defined in implementation\r
-  bool createProductionCounter(); // initialize a QList<int> from counter defined in implementation\r
-  bool createAdmittance(int nbExec); // initialize a QList<char> from consumption pattern and delta\r
+  void createPatterns() throw(Exception); // called in Graph, before checking compatibility and computing output pattern\r
+  void checkInputPatternCompatibility() throw(Exception);\r
+  void computeOutputPattern(int nbExec = -1) throw(Exception);\r
+  void computeAdmittanceDelays() throw(Exception); // compute differences between IP and admittance\r
+\r
+private:  \r
+  // patterns\r
+  void createDelta() throw(Exception);\r
+  void createConsumptionPattern() throw(Exception); // initialize a QList<char> for each interface from patterns defined in implementation\r
+  void createProductionPattern() throw(Exception); // initialize a QList<char> for each interface from patterns defined in implementation\r
+  void createProductionCounter() throw(Exception); // initialize a QList<int> from counter defined in implementation\r
+  void createAdmittance(int nbExec) throw(Exception); // initialize a QList<char> from consumption pattern and delta\r
+\r

   void clearConsumptionPattern();\r
   void clearProductionPattern();\r
   void clearConsumptionPattern();\r
   void clearProductionPattern();\r

-  void createInputPattern();\r
+  void createInputPattern() throw(Exception);\r

   void clearInputPattern();\r
   void clearInputPattern();\r

-  int getNumberOfExecution(); // compute number of block execution from inputPattern and delta\r
-  bool checkInputPatternCompatibility();\r
-  bool computeOutputPattern(int nbExec = -1);\r
+  void clearOutputPattern();\r
+  void clearAdmittanceDelays();\r
+  int createTriggers(); // compute the clock cycle at which the block is triggered\r

   \r
   \r

-private:  \r
-  // patterns    \r
-  double evaluateExpression(const QString& expression, bool* ok);\r
-  QList<char>* expandPattern(const QString& patternIn, bool* ok);\r
-  void expandPatternRecur(const QString& patternIn, int* offset, bool* ok, QList<char> *patternOut);\r
+  double evaluateExpression(const QString& expression) throw(Exception);\r
+  QList<char>* expandPattern(const QString& patternIn) throw(Exception);\r
+  QList<char> expandPatternRecur(const QString& patternIn, int* offset)  throw(Exception);\r
+  QString replaceExpressions(const QString& patternIn) throw(Exception);\r
+  /*!\r
+   * \brief samePatterns\r
+   * \param patternSrc the pattern that must be tested with patternDest (is patternDest == patternDest)  \r
+   * \param srcCol the column index within patternSrc\r
+   * \param patternDest the pattern that must be tested with patternSrc\r
+   * \param destCol the column index within patternDest      \r
+   * BEWARE: this method returns as soons as there is an acces problem (i.e. out of list range, impossible combine, ...)\r
+   leaving the dest pattern in an inconsistent state. Thus, it is a good idea to call canCombine before.\r
+   */\r
+  bool samePatterns(const QMap<AbstractInterface*, QList<char>* >& patternSrc, int srcCol, const QMap<AbstractInterface*, QList<char>* >& patternDest, int destCol);\r
+  bool samePatterns(const QMap<AbstractInterface*, QList<char>* >& patternSrc, const QList<int>& srcCols, const QMap<AbstractInterface*, QList<char>* >& patternDest, int destCol);\r

   /*!\r
    * \brief canCombinePatterns\r
    * \param patternSrc the pattern that must be combined with patternDest (patternDest = patternDest OR patternSrc)  \r
   /*!\r
    * \brief canCombinePatterns\r
    * \param patternSrc the pattern that must be combined with patternDest (patternDest = patternDest OR patternSrc)  \r


@@ -118,6 +138,7 @@ private:
   * isValidGroup checks if there is at least one 1 in the column offset of pattern.\r
   */\r
   bool isValidDataGroup(const QMap<AbstractInterface*, QList<char>* >& pattern, int offset);\r
   * isValidGroup checks if there is at least one 1 in the column offset of pattern.\r
   */\r
   bool isValidDataGroup(const QMap<AbstractInterface*, QList<char>* >& pattern, int offset);\r

+  bool isValidDataGroup(const QMap<AbstractInterface*, QList<char>* >& pattern, const QList<int> offsets);\r

   /*!\r
   * \brief isOnlyXGroup\r
   * \param pattern the pattern to test\r
   /*!\r
   * \brief isOnlyXGroup\r
   * \param pattern the pattern to test\r


@@ -134,13 +155,21 @@ private:
   */\r
   void shiftRightPattern(const QMap<AbstractInterface*, QList<char>* >& pattern, int offset);\r
 \r
   */\r
   void shiftRightPattern(const QMap<AbstractInterface*, QList<char>* >& pattern, int offset);\r
 \r

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

   QMap<AbstractInterface*, QList<char>* > consumptionPattern;\r
   QMap<AbstractInterface*, QList<char>* > consumptionPattern;\r

-  QMap<AbstractInterface*, QString > admittanceCyclic; // the admittance expressed as prologue-cyclic part-eppilogue, deduced from admittance\r
+  QMap<AbstractInterface*, QString > admittanceCyclic; // the admittance expressed as prologue-cyclic part-epilogue, deduced from admittance\r

   QMap<AbstractInterface*, QList<char>* > admittance; // the admittance taking into account nb exec.\r
   QMap<AbstractInterface*, QList<char>* > admittance; // the admittance taking into account nb exec.\r

+  QMap<AbstractInterface*, QList<int>* > admittanceDelays; // the delay between what should be consumed and IP\r

   QMap<AbstractInterface*, QList<char>* > productionPattern;\r
   QMap<AbstractInterface*,QList<char>* > inputPattern;\r
   QMap<AbstractInterface*, QList<char>* > outputPattern; // CAUTION: the QList<char>* must also be stored in the outputPattern attributes of AbstractInterface\r
   QMap<AbstractInterface*, QList<char>* > productionPattern;\r
   QMap<AbstractInterface*,QList<char>* > inputPattern;\r
   QMap<AbstractInterface*, QList<char>* > outputPattern; // CAUTION: the QList<char>* must also be stored in the outputPattern attributes of AbstractInterface\r

-  QList<int> productionCounter; //! only usefull for control output interfaces\r
+  QList<int> productionCounter; // only usefull for control output interfaces\r
+  QList<int> triggers; // the clock cycles at which the block is triggered, taking into account IP\r

   int lengthIP; // for convenience, set in createInputPattern()\r
   int lengthCP; // for convenience, set in createConsumptionPattern()\r
   int lengthAP; // for convenience, set in createAdmittance()\r
   int lengthIP; // for convenience, set in createInputPattern()\r
   int lengthCP; // for convenience, set in createConsumptionPattern()\r
   int lengthAP; // for convenience, set in createAdmittance()\r