ReferenceBlock.cpp

   1 #include "ReferenceBlock.h"
   2
   3 #include "ReferenceInterface.h"
   4 #include "BlockParameter.h"
   5 #include "BlockParameterUser.h"
   6 #include "BlockParameterGeneric.h"
   7 #include "BlockParameterPort.h"
   8 #include "BlockParameterWishbone.h"
   9
  10 ReferenceBlock::ReferenceBlock(const QString _xmlFile) : AbstractBlock() {
  11   xmlFile = _xmlFile;
  12 }
  13
  14 void ReferenceBlock::addCategory(int id) {
  15  categories.append(id);
  16 }
  17
  18 void ReferenceBlock::setBriefDescription(const QString& str) {
  19   if(str != NULL)
  20     descriptionBrief = str;
  21 }
  22
  23 void ReferenceBlock::setDetailedDescription(const QString& str) {
  24   if(str != NULL)
  25     descriptionDetail = str;
  26 }
  27
  28 void ReferenceBlock::addImplementation(BlockImplementation *impl) {
  29   implementations.append(impl);
  30 }
  31
  32 void ReferenceBlock::setHashMd5() {
  33   QFile file(xmlFile);
  34   if (file.open(QIODevice::ReadOnly)) {
  35     QByteArray fileData = file.readAll();
  36     QByteArray hashData = QCryptographicHash::hash(fileData, QCryptographicHash::Md5);
  37     hashMd5 = QString(hashData.toHex());
  38     cout << qPrintable(xmlFile) << " has md5 hash : " << qPrintable(hashMd5) << endl;
  39   }
  40   else {
  41     hashMd5 = "";
  42   }
  43 }
  44
  45 void ReferenceBlock::load(QDomElement &elt) throw(Exception) {
  46
  47
  48   cout << "Block : get informations" << endl;
  49   QDomElement eltInfo  = elt.firstChildElement("informations");
  50   try {
  51     loadInformations(eltInfo);
  52   }
  53   catch(int err) {
  54     throw(err);
  55   }
  56
  57   cout << "Block : get params" << endl;
  58   QDomElement eltParams  = eltInfo.nextSiblingElement("parameters");
  59   try {
  60     loadParameters(eltParams);
  61   }
  62   catch(int err) {
  63     throw(err);
  64   }
  65
  66   cout << "Block : get interfaces" << endl;
  67   QDomElement eltInter  = eltParams.nextSiblingElement("interfaces");
  68   try {
  69     loadInterfaces(eltInter);
  70   }
  71   catch(int err) {
  72     throw(err);
  73   }
  74 }
  75
  76 void ReferenceBlock::loadInformations(QDomElement &elt) throw(Exception) {
  77
  78   bool ok;
  79   if ((elt.isNull()) || (elt.tagName() != "informations")) throw (Exception(BLOCKFILE_CORRUPTED));
  80   // getting name
  81   cout << "Block info : get name" << endl;
  82   QDomNode nodeName = elt.firstChild();
  83   QDomNode nodeNameTxt = nodeName.firstChild();
  84   if (nodeNameTxt.isNull()) {
  85     name = "no_name";
  86   }
  87   else {
  88     QDomText txtName = nodeNameTxt.toText();
  89     name = txtName.data().trimmed();
  90     cout<< "block name : " << qPrintable(name) << endl;
  91   }
  92
  93   // getting categories
  94   cout << "Block info : get categories" << endl;
  95   QDomElement eltCat = nodeName.nextSiblingElement("category");
  96
  97   QString idsStr = eltCat.attribute("ids","none");
  98   if (idsStr == "none") throw (Exception(BLOCKFILE_CORRUPTED));
  99   QStringList listCat = idsStr.split(",");
 100   foreach(QString str, listCat)
 101   {
 102     int idCat = str.toInt(&ok);
 103     categories.append(idCat);
 104   }
 105
 106   // getting description
 107   cout << "Block info : get description" << endl;
 108   QDomElement eltDesc = eltCat.nextSiblingElement("description");
 109   // getting brief
 110   QDomElement eltBrief = eltDesc.firstChildElement("brief");
 111   QDomNode nodeBriefTxt = eltBrief.firstChild();
 112   if (nodeBriefTxt.isNull()) {
 113     descriptionBrief = "no brief description";
 114   }
 115   else {
 116     QDomText txtBrief = nodeBriefTxt.toText();
 117     descriptionBrief = txtBrief.data().trimmed();
 118     cout << "block brief desc : " << qPrintable(descriptionBrief) << endl;
 119   }
 120   // getting detailed
 121   QDomElement eltDetail = eltBrief.nextSiblingElement("detailed");
 122   QDomNode nodeDetailTxt = eltDetail.firstChild();
 123   if (nodeDetailTxt.isNull()) {
 124     descriptionDetail = "no detailed description";
 125   }
 126   else {
 127     QDomText txtDetail = nodeDetailTxt.toText();
 128     descriptionDetail = txtDetail.data().trimmed();
 129     cout << "block detail desc : " << qPrintable(descriptionDetail) << endl;
 130   }
 131 }
 132
 133 void ReferenceBlock::loadParameters(QDomElement &elt) throw(Exception) {
 134
 135   if ((elt.isNull()) || (elt.tagName() != "parameters")) throw (Exception(BLOCKFILE_CORRUPTED));
 136
 137   QDomNodeList listNodeParam = elt.elementsByTagName("parameter");
 138   for(int i=0; i<listNodeParam.size(); i++) {
 139     QDomNode node = listNodeParam.at(i);
 140     QDomElement elt = node.toElement();
 141     QString nameStr = elt.attribute("name","none");
 142     QString contextStr = elt.attribute("context","none");
 143     QString typeStr = elt.attribute("type","none");
 144     QString valueStr = elt.attribute("value","none");
 145     BlockParameter *param = NULL;
 146
 147     if(valueStr == "none"){
 148         if (contextStr == "generic") throw (Exception(BLOCKFILE_CORRUPTED)); // set is required for generics
 149         valueStr = "";
 150     }
 151     if (contextStr == "user") {
 152       param = new BlockParameterUser(this,nameStr,valueStr);
 153     }
 154     else if (contextStr == "generic") {
 155       param = new BlockParameterGeneric(this,nameStr,typeStr,valueStr);
 156     }
 157     else if (contextStr == "wb") {
 158       QString widthStr = elt.attribute("width","none");
 159       QString wbStr = elt.attribute("wishbone","none");
 160       int access = 0;
 161       int duration = 0;
 162       QString wbValue = "";
 163       QStringList listWb = wbStr.split(",");
 164
 165       if (listWb.at(0) == "r") {
 166         access = BlockParameter::Read;
 167       }
 168       else if (wbStr == "w") {
 169         access = BlockParameter::Write;
 170         bool ok;
 171         wbValue = listWb.at(1).toInt(&ok);
 172         if(!ok){
 173             if(listWb.at(1) == "true" || listWb.at(1) == "false"){
 174                 wbValue = listWb.at(1);
 175             } else {
 176                 wbValue = "data";
 177             }
 178         }
 179         if(listWb.at(2) == "trigger") {
 180             duration = BlockParameter::Trigger;
 181         }
 182         else if(listWb.at(2) == "perm") {
 183             duration = BlockParameter::Permanent;
 184         }
 185       }
 186       param = new BlockParameterWishbone(this,nameStr,typeStr,widthStr,valueStr,access,wbValue,duration);
 187     }
 188     else if (contextStr == "port") {
 189       QString ifaceStr = elt.attribute("iface","none");
 190       param = new BlockParameterPort(this,nameStr,valueStr,ifaceStr);
 191
 192     }
 193     else {
 194       throw (Exception(BLOCKFILE_CORRUPTED));
 195     }
 196     params.append(param);
 197   }
 198 }
 199
 200 void ReferenceBlock::loadInterfaces(QDomElement &elt) throw(Exception) {
 201
 202   QString nameStr;
 203   QString typeStr;
 204   QString widthStr;
 205   QString purposeStr;
 206   int purpose;
 207   QString multStr;
 208   int mult;
 209   AbstractInterface* inter;
 210
 211   if ((elt.isNull()) || (elt.tagName() != "interfaces")) throw (Exception(BLOCKFILE_CORRUPTED));
 212
 213   QDomElement eltInputs = elt.firstChildElement("inputs");
 214   QDomNodeList listNodeInputs = eltInputs.elementsByTagName("input");
 215   for(int i=0;i<listNodeInputs.size();i++) {
 216     QDomNode node = listNodeInputs.at(i);
 217     QDomElement eltInput = node.toElement();
 218     nameStr = eltInput.attribute("name","none");
 219     typeStr = eltInput.attribute("type","none");
 220     widthStr = eltInput.attribute("width","none");
 221     purposeStr = eltInput.attribute("purpose","none");
 222     cout << "block : " << this->getName().toStdString() << endl;
 223     cout << "purpose for " << nameStr.toStdString() << " : " << purposeStr.toStdString() << endl;
 224     purpose = ReferenceInterface::translatePurpose(purposeStr);
 225     cout << "translated purpose : " << purpose << endl;
 226     multStr = eltInput.attribute("multiplicity","none");
 227     mult = ReferenceInterface::translateMultiplicity(multStr);
 228
 229     inter = new ReferenceInterface(this,nameStr,typeStr,widthStr,AbstractInterface::Input, purpose, mult);
 230     inputs.append(inter);
 231   }
 232
 233   QDomElement eltOutputs = eltInputs.nextSiblingElement("outputs");
 234   QDomNodeList listNodeOutputs = eltOutputs.elementsByTagName("output");
 235   for(int i=0;i<listNodeOutputs.size();i++) {
 236     QDomNode node = listNodeOutputs.at(i);
 237     QDomElement eltOutput = node.toElement();
 238     nameStr = eltOutput.attribute("name","none");
 239     typeStr = eltOutput.attribute("type","none");
 240     widthStr = eltOutput.attribute("width","none");
 241     purposeStr = eltOutput.attribute("type","none");
 242     purpose = ReferenceInterface::translatePurpose(purposeStr);
 243     multStr = eltOutput.attribute("multiplicity","none");
 244     mult = ReferenceInterface::translateMultiplicity(multStr);
 245
 246     inter = new ReferenceInterface(this,nameStr,typeStr,widthStr,AbstractInterface::Output, purpose, mult);
 247     outputs.append(inter);
 248   }
 249
 250   QDomElement eltBidirs = eltInputs.nextSiblingElement("bidirs");
 251   QDomNodeList listNodeBidirs = eltBidirs.elementsByTagName("bidir");
 252   for(int i=0;i<listNodeBidirs.size();i++) {
 253     QDomNode node = listNodeBidirs.at(i);
 254     QDomElement eltBidir = node.toElement();
 255     nameStr = eltBidir.attribute("name","none");
 256     typeStr = eltBidir.attribute("type","none");
 257     widthStr = eltBidir.attribute("width","none");
 258     purposeStr = eltBidir.attribute("type","none");
 259     purpose = ReferenceInterface::translatePurpose(purposeStr);
 260     multStr = eltBidir.attribute("multiplicity","none");
 261     mult = ReferenceInterface::translateMultiplicity(multStr);
 262
 263     inter = new ReferenceInterface(this,nameStr,typeStr,widthStr,AbstractInterface::InOut, purpose, mult);
 264     bidirs.append(inter);
 265   }
 266 }
 267
 268 void ReferenceBlock::parametersValidation(QList<AbstractBlock *> *checkedBlocks, QList<AbstractBlock *> *blocksToConfigure)
 269 {
 270     return;
 271 }
 272
 273 /* operator<<() :
 274    only used to save all ReferenceBlock in a library in binary format, so that reference blocks
 275    are read very fast at application startup.
 276
 277  */
 278 QDataStream& operator<<(QDataStream &out, const ReferenceBlock &b) {
 279
 280   out.setVersion(QDataStream::Qt_5_0);
 281
 282   QByteArray blockData;
 283   QDataStream toWrite(&blockData, QIODevice::WriteOnly);
 284
 285   toWrite << b.name;
 286   toWrite << b.xmlFile;
 287   toWrite << b.descriptionBrief;
 288   toWrite << b.descriptionDetail;
 289   toWrite << b.categories;
 290   toWrite << b.hashMd5;
 291   toWrite << b.params.size();
 292   BlockParameter* p;
 293   for(int i=0;i<b.params.size();i++) {
 294     p = b.params.at(i);
 295     toWrite << p->getContext();
 296     toWrite << p->getName();
 297     toWrite << p->getTypeString();
 298     toWrite << p->getValue().toString();
 299     if (p->isPortParameter()) {
 300       toWrite << ((BlockParameterPort*)p)->getIfaceName();
 301     }
 302     else if (p->isWishboneParameter()) {
 303       BlockParameterWishbone* pwb = (BlockParameterWishbone*)p;
 304       toWrite << pwb->getWidth();
 305       toWrite << pwb->getWBAccess();
 306       toWrite << pwb->getWBValue();
 307       toWrite << pwb->getWBDuration();
 308     }
 309
 310   }
 311
 312   toWrite << b.inputs.size();
 313   for(int i=0; i<b.inputs.size(); i++){
 314     ReferenceInterface *iface = (ReferenceInterface *)(b.inputs.at(i));
 315     toWrite << iface->getName();
 316     toWrite << iface->getWidth();
 317     toWrite << iface->getPurpose();
 318     toWrite << iface->getDirection();
 319     toWrite << iface->getMultiplicity();
 320   }
 321   toWrite << b.outputs.size();
 322   for(int i=0; i<b.outputs.size(); i++){
 323     ReferenceInterface *iface = (ReferenceInterface *)(b.outputs.at(i));
 324     toWrite << iface->getName();
 325     toWrite << iface->getWidth();
 326     toWrite << iface->getPurpose();
 327     toWrite << iface->getDirection();
 328     toWrite << iface->getMultiplicity();
 329   }
 330   toWrite << b.bidirs.size();
 331   for(int i=0; i<b.bidirs.size(); i++){
 332     ReferenceInterface *iface = (ReferenceInterface *)(b.bidirs.at(i));
 333     toWrite << iface->getName();
 334     toWrite << iface->getWidth();
 335     toWrite << iface->getPurpose();
 336     toWrite << iface->getDirection();
 337     toWrite << iface->getMultiplicity();
 338   }
 339
 340   out << blockData;
 341
 342   return out;
 343 }
 344
 345 QDataStream& operator>>(QDataStream &in, ReferenceBlock &b) {
 346
 347   quint32 blockSize;
 348   ReferenceInterface* iface;
 349   BlockParameter* p;
 350   int val;
 351   QString txt="";
 352
 353   in.setVersion(QDataStream::Qt_5_0);
 354
 355   in >> blockSize;
 356
 357   in >> b.name;
 358   in >> b.xmlFile;
 359   in >> b.descriptionBrief;
 360   in >> b.descriptionDetail;
 361   in >> b.categories;
 362   in >> b.hashMd5;
 363   b.params.clear();
 364   int nb;
 365   in >> nb;
 366   cout << qPrintable(b.name) << " has " << nb << " parameters" << endl;
 367   for(int i=0;i<nb;i++) {
 368     QString contextStr = "";
 369     QString nameStr= "";
 370     QString typeStr = "";
 371     QString valueStr = "";
 372     in >> contextStr;
 373     in >> nameStr;
 374     in >> typeStr;
 375     in >> valueStr;
 376
 377     if (contextStr == "user") {
 378       p = new BlockParameterUser(&b,nameStr,valueStr);
 379     }
 380     else if (contextStr == "generic") {
 381       p = new BlockParameterGeneric(&b,nameStr,typeStr,valueStr);
 382     }
 383     else if (contextStr == "port") {
 384       QString ifaceStr = "";
 385       in >> ifaceStr;
 386       p = new BlockParameterPort(&b,nameStr,valueStr,ifaceStr);
 387     }
 388     else if (contextStr == "wb") {
 389       QString widthStr = "";
 390       int wbAccess;
 391       QString wbValue;
 392       int wbDuration;
 393       in >> widthStr;
 394       in >> wbAccess;
 395       in >> wbValue;
 396       in >> wbDuration;
 397       p = new BlockParameterWishbone(&b,nameStr,typeStr,widthStr,valueStr,wbAccess,wbValue,wbDuration);
 398     }
 399     b.params.append(p);
 400   }
 401
 402   b.inputs.clear();
 403   in >> nb;
 404   for(int i=0;i<nb;i++) {
 405     iface = new ReferenceInterface(&b);
 406     in >> txt;
 407     iface->setName(txt);
 408     in >> txt;
 409     iface->setWidth(txt);
 410     in >> val;
 411     iface->setPurpose(val);
 412     in >> val;
 413     iface->setDirection(val);
 414     in >> val;
 415     iface->setMultiplicity(val);
 416     b.inputs.append(iface);
 417   }
 418
 419   b.outputs.clear();
 420   in >> nb;
 421   for(int i=0;i<nb;i++) {
 422     iface = new ReferenceInterface(&b);
 423     in >> txt;
 424     iface->setName(txt);
 425     in >> txt;
 426     iface->setWidth(txt);
 427     in >> val;
 428     iface->setPurpose(val);
 429     in >> val;
 430     iface->setDirection(val);
 431     in >> val;
 432     iface->setMultiplicity(val);
 433     b.outputs.append(iface);
 434   }
 435
 436   b.bidirs.clear();
 437   in >> nb;
 438   for(int i=0;i<nb;i++) {
 439     iface = new ReferenceInterface(&b);
 440     in >> txt;
 441     iface->setName(txt);
 442     in >> txt;
 443     iface->setWidth(txt);
 444     in >> val;
 445     iface->setPurpose(val);
 446     in >> val;
 447     iface->setDirection(val);
 448     in >> val;
 449     iface->setMultiplicity(val);
 450     b.bidirs.append(iface);
 451   }
 452
 453   return in;
 454 }