Implement attaching of SPICE libraries to Qucs XML libraries

SPICE libraries referenced by SpiceLibComp are copied to the the subdirectory when creating a library from project.
ra3xdh · Jan 19, 2025 · 0d53e47 · 0d53e47
1 parent 88fb62f
commit 0d53e47
Show file tree

Hide file tree

Showing 12 changed files with 76 additions and 26 deletions.
diff --git a/qucs/components/component.h b/qucs/components/component.h
@@ -49,7 +49,8 @@ class Component : public Element {
   virtual QStringList getExtraVariables();
   virtual QString getProbeVariable(bool isXyce = false);
   virtual QString getSpiceModel();
-  virtual QString getSpiceLibrary(bool withDirective = true) { Q_UNUSED(withDirective); return QString(); }
+  virtual QString getSpiceLibrary() { return QString(); }
+  virtual QStringList getSpiceLibraryFiles() { return QStringList(); }
   virtual QString getNgspiceBeforeSim(QString sim, int lvl=0);
   virtual QString getNgspiceAfterSim(QString sim, int lvl=0);
   virtual QString getVAvariables() {return QString();};

diff --git a/qucs/components/libcomp.cpp b/qucs/components/libcomp.cpp
@@ -413,7 +413,7 @@ QStringList LibComp::getAttachedMOD()
     return mod_lst;
 }
 
-QString LibComp::getSpiceLibrary(bool withDirective)
+QString LibComp::getSpiceLibrary()
 {
   QStringList files;
   QString content;
@@ -433,15 +433,8 @@ QString LibComp::getSpiceLibrary(bool withDirective)
   }
 
   QString s;
-  if (withDirective) {
-    for (const auto &file: files) { // for netlist
-      s += QStringLiteral(".INCLUDE \"%1\"\n").arg(file);
-    }
-  } else {
-    for (const auto &file: files) { // for making library
-      QFileInfo inf(file);
-      s += QStringLiteral("\"%1\" ").arg(inf.fileName());
-    }
+  for (const auto &file: files) { // for netlist
+    s += QStringLiteral(".INCLUDE \"%1\"\n").arg(file);
   }
   return s;
 }
diff --git a/qucs/components/libcomp.h b/qucs/components/libcomp.h
@@ -34,7 +34,7 @@ class LibComp : public MultiViewComponent  {
   QString getSubcircuitFile();
   QStringList getAttachedMOD(); // LibComp can reference cfunc.mod and ifspec.ifs
   QStringList getAttachedIFS(); // These should be compiled before SPICE simulation
-  QString getSpiceLibrary(bool withDirective);
+  QString getSpiceLibrary();
 
 protected:
   QString netlist();

diff --git a/qucs/dialogs/librarydialog.cpp b/qucs/dialogs/librarydialog.cpp
@@ -508,6 +508,17 @@ void LibraryDialog::slotSave()
         }
         kern->createSubNetlsit(ts,true);
         intoStream(Stream, tmp, "Spice");
+
+        QStringList libs = kern->collectSpiceLibraryFiles(Doc);
+        QStringList copiedFiles;
+        for (QString &file: libs) {
+          QString ofile = file;
+          intoFile(file, ofile, copiedFiles);
+        }
+        if (!copiedFiles.isEmpty()) {
+          Stream << "<SpiceAttach \"" << copiedFiles.join("\" \"")
+                 << "\">\n";
+        }
         delete kern;
         QucsSettings.DefaultSimulator = sim;
     //}

diff --git a/qucs/extsimkernels/abstractspicekernel.cpp b/qucs/extsimkernels/abstractspicekernel.cpp
@@ -1595,3 +1595,30 @@ QString AbstractSpiceKernel::collectSpiceLibs(Schematic* sch)
   return collected_spicelib.join("");
 }
 
+
+QStringList AbstractSpiceKernel::collectSpiceLibraryFiles(Schematic *sch)
+{
+  QStringList collected_spicelib;
+  for(Component *pc = sch->a_DocComps.first(); pc != 0; pc = sch->a_DocComps.next()) {
+    QStringList new_libs;
+    if (pc->Model == "Sub") {
+      Schematic *sub = new Schematic(nullptr, ((Subcircuit *)pc)->getSubcircuitFile());
+      if(!sub->loadDocument())      // load document if possible
+      {
+        delete sub;
+        continue;
+      }
+      new_libs = collectSpiceLibraryFiles(sub);
+      delete sub;
+    } else {
+      new_libs = pc->getSpiceLibraryFiles();
+    }
+    for (const auto&lib: new_libs) {
+      if (!collected_spicelib.contains(lib)) {
+        collected_spicelib.append(lib);
+      }
+    }
+  }
+  return collected_spicelib;
+}
+
diff --git a/qucs/extsimkernels/abstractspicekernel.h b/qucs/extsimkernels/abstractspicekernel.h
@@ -130,6 +130,7 @@ class AbstractSpiceKernel : public QObject
     virtual void SaveNetlist(QString filename);
     virtual bool waitEndOfSimulation();
     void setConsole(QPlainTextEdit *console) { a_console = console; }
+    QStringList collectSpiceLibraryFiles(Schematic *sch);
     static QString collectSpiceLibs(Schematic* sch);
 
 signals:

diff --git a/qucs/spicecomponents/sp_include.cpp b/qucs/spicecomponents/sp_include.cpp
@@ -75,7 +75,7 @@ Element* S4Q_Include::info(QString& Name, char* &BitmapFile, bool getNewOne)
   return 0;
 }
 
-QString S4Q_Include::getSpiceLibrary(bool withDirective)
+QString S4Q_Include::getSpiceLibrary()
 {
     if (isActive != COMP_IS_ACTIVE) return QString();
     QString s;
@@ -99,3 +99,16 @@ QString S4Q_Include::getSpiceLibrary(bool withDirective)
     return s;
 }
 
+QStringList S4Q_Include::getSpiceLibraryFiles()
+{
+  QStringList files;
+  for (Property *pp : Props) {
+    QString val = pp->Value;
+    if (!val.isEmpty()) {
+      val = misc::properAbsFileName(val, containingSchematic);
+      files.append(val);
+    }
+  }
+  return files;
+}
+
diff --git a/qucs/spicecomponents/sp_include.h b/qucs/spicecomponents/sp_include.h
@@ -28,7 +28,8 @@ class S4Q_Include : public Component  {
   ~S4Q_Include();
   Component* newOne();
   static Element* info(QString&, char* &, bool getNewOne=false);
-  QString getSpiceLibrary(bool withDirective = true);
+  QString getSpiceLibrary();
+  QStringList getSpiceLibraryFiles();
 
 protected:
   QString vhdlCode(int) { return QString(); }

diff --git a/qucs/spicecomponents/sp_lib.cpp b/qucs/spicecomponents/sp_lib.cpp
@@ -71,7 +71,7 @@ Element* S4Q_Lib::info(QString& Name, char* &BitmapFile, bool getNewOne)
   return 0;
 }
 
-QString S4Q_Lib::getSpiceLibrary(bool withDirective)
+QString S4Q_Lib::getSpiceLibrary()
 {
   if (isActive != COMP_IS_ACTIVE) return QString();
   QString s;

diff --git a/qucs/spicecomponents/sp_lib.h b/qucs/spicecomponents/sp_lib.h
@@ -28,7 +28,7 @@ class S4Q_Lib : public Component  {
   ~S4Q_Lib();
   Component* newOne();
   static Element* info(QString&, char* &, bool getNewOne=false);
-  QString getSpiceLibrary(bool withDirective = true);
+  QString getSpiceLibrary();
 
 protected:
   QString vhdlCode(int) { return QString(); }

diff --git a/qucs/spicecomponents/spicelibcomp.cpp b/qucs/spicecomponents/spicelibcomp.cpp
@@ -246,16 +246,18 @@ QString SpiceLibComp::cdl_netlist()
     return spice_netlist(spicecompat::CDL);
 }
 
-QString SpiceLibComp::getSpiceLibrary(bool withDirective)
+QString SpiceLibComp::getSpiceLibrary()
 {
     if (isActive != COMP_IS_ACTIVE) return QString();
-    QString f = misc::properAbsFileName(getProperty("File")->Value, containingSchematic);
-    QString s;
-    if (withDirective) {
-      s = QStringLiteral(".INCLUDE \"%1\"\n").arg(f);
-    } else {
-      QFileInfo inf(f);
-      s = QStringLiteral("\"%1\" ").arg(inf.fileName());
-    }
+    QString f = misc::properAbsFileName(Props.at(0)->Value, containingSchematic);
+    QString s = QStringLiteral(".INCLUDE \"%1\"\n").arg(f);
     return s;
 }
+
+QStringList SpiceLibComp::getSpiceLibraryFiles()
+{
+  QString f = misc::properAbsFileName(getProperty("File")->Value, containingSchematic);
+  QStringList files;
+  files.append(f);
+  return files;
+}
diff --git a/qucs/spicecomponents/spicelibcomp.h b/qucs/spicecomponents/spicelibcomp.h
@@ -27,7 +27,8 @@ class SpiceLibComp : public MultiViewComponent  {
  ~SpiceLibComp() {};
   Component* newOne();
   static Element* info(QString&, char* &, bool getNewOne=false);
-  QString getSpiceLibrary(bool withDirective = true);
+  QString getSpiceLibrary();
+  QStringList getSpiceLibraryFiles();
 
 protected:
   QString spice_netlist(spicecompat::SpiceDialect dialect = spicecompat::SPICEDefault);