X-Git-Url: https://bilbo.iut-bm.univ-fcomte.fr/and/gitweb/blast.git/blobdiff_plain/abbc64cf04a35ab3549d5c516f44c7c5921baa63..4327c2b8817b627249d98d889835726217c81a4e:/AbstractBlock.h

diff --git a/AbstractBlock.h b/AbstractBlock.h
index 2c89cbf..efbd474 100644
--- a/AbstractBlock.h
+++ b/AbstractBlock.h
@@ -4,12 +4,16 @@
 #include <iostream>
 
 #include <QtCore>
+#include <QtXml>
 
+#include "AbstractInterface.h"
 class AbstractInterface;
 class BlockParameter;
+class Graph;
 
 #define AB_TO_REF(ptr) ((ReferenceBlock*)ptr)
 #define AB_TO_FUN(ptr) ((FunctionalBlock*)ptr)
+#define AB_TO_SPE(ptr) ((SpecialBlock*)ptr)
 #define AB_TO_GRP(ptr) ((GroupBlock*)ptr)
 
 using namespace std;
@@ -18,48 +22,97 @@ using namespace Qt;
 class AbstractBlock {
 
 public:  
+      
+  enum BlockVHDLContext {AnyContext = 0, Entity = 1, Component = 2, Architecture = 3 }; // NB : 3 is when creating an instance of the block that owns this iface
+  enum SpecialType { NotSpecial = 0, Source = 1, Sink = 2, ClkConvert = 3 };
 
-  AbstractBlock();
-  AbstractBlock(const QString& _name);
+
+  AbstractBlock(Graph* _graph);
+  //AbstractBlock(const QString& _name);
   virtual ~AbstractBlock();
 
   // getters
   inline QString getName() { return name; }
-  inline QList<BlockParameter *> getParameters() { return params; }
+  inline int getSpecialType() { return specialType; }
+  inline QString getVersion() { return version; }
+  inline int nbParameters() { return params.size(); }
+  inline Graph* getGraph() { return graph; }
+
   inline QList<AbstractInterface*> getInputs() { return inputs; }
   inline QList<AbstractInterface*> getOutputs() { return outputs; }
-  inline QList<AbstractInterface*> getBidirs() { return bidirs; }
+  inline QList<AbstractInterface*> getBidirs() { return bidirs; }  
+  QList<AbstractInterface *> getInterfaces(int direction = AbstractInterface::AnyDirection, int purpose = AbstractInterface::AnyPurpose);
+  QList<AbstractInterface *> getDataInputs(); //! return all inputs of type data
+  QList<AbstractInterface *> getDataOutputs(); //! return all inputs of type data
+  QList<AbstractInterface *> getControlInputs(); //! return all inputs of type control
+  QList<AbstractInterface *> getControlOutputs(); //! return all outputs of type control
+  AbstractInterface* getIfaceFromName(QString name);
+
+  inline QList<BlockParameter *> getParameters() { return params; }
+  BlockParameter* getParameterFromName(QString name);
   QList<BlockParameter *> getUserParameters();
   QList<BlockParameter *> getGenericParameters();
   QList<BlockParameter *> getPortParameters();
   QList<BlockParameter *> getWishboneParameters();
+
   inline AbstractBlock* getParent() { return parent; }
+  inline bool getOutputPatternComputed() { return outputPatternComputed; }
+  inline int getTraversalLevel() { return traversalLevel; }
+  
   // setters
   void setName(const QString& str);
+  void setSpecialType(int type);
+  inline void setVersion(const QString& _version) { version = _version; }
   virtual void setParent(AbstractBlock* _parent);
+  inline void setOutputPatternComputed(bool state) {  outputPatternComputed = state; }
+  inline void resetTraversalLevel() { traversalLevel = -1; }
+  inline void setTraversalLevel(int level) { traversalLevel = level; }
 
   // testers
   virtual bool isReferenceBlock();
   virtual bool isFunctionalBlock();
+  virtual bool isSpecialBlock();
   virtual bool isGroupBlock();
+  virtual bool isStimuliBlock(); //! a stimuli block is outside the top group and simulates a peripheral (NB: this is also a source)
+  virtual bool isTopGroupBlock();
+  bool isSourceBlock(); //! a source block has no data inputs and thus executes infinitely
+  bool isSinkBlock(); //! a sink block has no data outputs and just collects what it receives (i.e. no compatibility check)
   bool isWBConfigurable();
 
   // others
+  int getSpecialTypeFromString(QString str);
+
+  /*!
+   * \brief connectClkReset connects the clock and reset inputs to a clkrstgen block or the the group ifaces
+   * \param idBlockClk is the id of the clock interface (there may be severals)
+   * \param idGen is the id of the clkrstgen block
+  */  
+  virtual QList<QString> getExternalResources() = 0; // returns the list of all external files needed for VHDL generation
+  virtual void generateVHDL(const QString& path) throw(Exception) = 0; // main entry to generate the VHDL code
+  void generateComponent(QTextStream& out, bool hasController=false) throw(Exception); // generate the component using reference
+  void generateEntity(QTextStream& out, bool hasController=false) throw(Exception); // generate the entity using reference
+
   virtual void parametersValidation(QList<AbstractBlock*>* checkedBlocks, QList<AbstractBlock*>* blocksToConfigure) = 0; // ugly but usefull   
 
   void addParameter(BlockParameter *param);
   void addInterface(AbstractInterface *inter);
   void removeInterface(AbstractInterface *inter);
+  void removeAllInterfaces();
   void defineBlockParam(BlockParameter *param);
 
-  QList<AbstractInterface *> getInterfaces();
-  AbstractInterface* getIfaceFromName(QString name);
-  BlockParameter* getParameterFromName(QString name);
 
+  // patterns
+  virtual void checkInputPatternCompatibility() throw(Exception) = 0;
+  virtual void computeOutputPattern(int nbExec = -1) throw(Exception) = 0;
+  virtual void computeAdmittanceDelays() throw(Exception) = 0;
+  
 protected:
 
 
   QString name;
+  int specialType;
+  QString version;
+  Graph* graph;
 
   // parameters
   QList<BlockParameter *> params;
@@ -68,11 +121,22 @@ protected:
   QList<AbstractInterface*> inputs;
   QList<AbstractInterface*> outputs;
   QList<AbstractInterface*> bidirs;
-
+  
   // others
-
-  // NB: only GroupBlock and FunctionalBlock have a real parent
+  
+  // patterns  
+  bool outputPatternComputed;
+  int traversalLevel; // the level (0, 1, ...) during the traversal of the graph
+  
+  // NB: only GroupBlock and FunctionalBlock have a real parent, except sources that have no parents
   AbstractBlock* parent;
+
+  virtual void generateComments(QTextStream& out, QDomElement &elt, QString coreFile) throw(Exception) = 0; // generates comments from <comments> element
+  virtual void generateLibraries(QTextStream& out, QDomElement &elt) throw(Exception) = 0; // generates libraries from <libraries> element  
+  virtual void generateArchitecture(QTextStream& out, QDomElement &elt ) throw(Exception) = 0; // generate the architecture using <architecture> element
+  virtual void generateController(QTextStream& out) throw(Exception) = 0; // generate the wishbone controller of the block
+  virtual void generateEntityOrComponentBody(QTextStream& out, int indentLevel, bool hasController=false) throw(Exception) = 0; // generate the entity/compo body using reference
+
 };
 
 #endif // __ABSTRACTBLOCK_H__