ReferenceBlock.h

   1 #ifndef __REFERENCEBLOCK_H__
   2 #define __REFERENCEBLOCK_H__
   3
   4 #include <iostream>
   5
   6 #include <QtCore>
   7 #include <QtGui>
   8 #include <QtWidgets>
   9 #include <QtXml>
  10
  11 #include "AbstractBlock.h"
  12 class AbstractBlock;
  13
  14 #include "BlockImplementation.h"
  15
  16 #include "Exception.h"
  17 class Exception;
  18
  19 using namespace std;
  20 using namespace Qt;
  21
  22
  23 class ReferenceBlock : public AbstractBlock {
  24
  25 public:
  26
  27   ReferenceBlock(const QString _xmlFile);
  28
  29   int getType();
  30   inline QString getXmlFile() { return xmlFile; }
  31   inline QString getBriefDescription() { return descriptionBrief; }
  32   inline QString getDetailedDescription() { return descriptionDetail; }
  33   inline QList<int> getCategories() { return categories; }
  34   inline QList<BlockImplementation *> getImplementations() { return implementations; }
  35   inline QString getHashMd5() { return hashMd5; }
  36
  37   inline AbstractBlock* getParent() { return NULL; }
  38
  39   void addCategory(int id);
  40   void setBriefDescription(const QString& str);
  41   void setDetailedDescription(const QString& str);
  42   void addImplementation(BlockImplementation* impl);
  43
  44   void load(QDomElement &elt) throw(Exception);
  45   void setHashMd5();
  46
  47   QList<QString> getExternalResources();
  48   void generateVHDL(const QString& path) throw(Exception); // main entry to generate the VHDL code
  49
  50   void parametersValidation(QList<AbstractBlock*>* checkedBlocks, QList<AbstractBlock*>* blocksToConfigure);
  51
  52 private:
  53   QString xmlFile; // the xml file from which attributes are initialized.
  54   QString hashMd5;
  55   QString descriptionBrief;
  56   QString descriptionDetail;
  57   QList<int> categories;
  58   QList<BlockImplementation *> implementations; // set when implementations are read
  59
  60   // loading methods for the different tags in the XML desc.
  61   void loadInformations(QDomElement &elt) throw(Exception);
  62   void loadParameters(QDomElement &elt) throw(Exception);
  63   void loadInterfaces(QDomElement &elt) throw(Exception);
  64   void createInterfaceForParameters() throw(Exception);
  65
  66   friend QDataStream &operator<<(QDataStream &out, const ReferenceBlock &b);
  67   friend QDataStream &operator>>(QDataStream &in, ReferenceBlock &b);
  68
  69   // patterns
  70   void checkInputPatternCompatibility() throw(Exception);
  71   void computeOutputPattern(int nbExec = -1) throw(Exception);
  72   void computeAdmittanceDelays() throw(Exception);
  73
  74   void generateComments(QTextStream& out, QDomElement &elt, QString coreFile) throw(Exception); // generates comments from <comments> element
  75   void generateLibraries(QTextStream& out, QDomElement &elt) throw(Exception); // generates libraries from <libraries> element
  76   void generateArchitecture(QTextStream& out, QDomElement &elt ) throw(Exception); // generate the architecture using <architecture> element
  77   void generateController(QTextStream& out) throw(Exception); // generate the wishbone controller of the block
  78   void generateEntityOrComponentBody(QTextStream& out, int indentLevel, bool hasController=false) throw(Exception); // generate the entity/compo body using reference
  79
  80 };
  81
  82 #endif // __REFERENCEBLOCK_H__