CDL main-netlist always wrapped in a subcircuit

-fixed mac build issue
-introduced set/reset net-name mapping api to Component class
-implemented set/reset net-name mapping in class SubCirPort, Node,
 Schematic and Wire
-implemented CDL PININFO in class CdlNetListWriter
-implemented subcircuit wrapping of CDL main netlist in class
 CdlNetListWriter

Signed-off-by: ThomasZecha <zecha@ihp-microelectronics.com>

Author: ThomasZecha

qucs-s-spar-viewer/smithchartwidget.cpp

@@ -167,10 +167,18 @@ SmithChartWidget::SmithChartWidget(QWidget *parent)
          // Connect the signals
   connect(m_Z0ComboBox, QOverload<int>::of(&QComboBox::currentIndexChanged),
           this, &SmithChartWidget::onZ0Changed);
+
+#if QT_VERSION >= QT_VERSION_CHECK(6, 7, 0)
   connect(m_ShowAdmittanceChartCheckBox, &QCheckBox::checkStateChanged,
           this, &SmithChartWidget::onShowAdmittanceChartChanged);
   connect(m_ShowConstantCurvesCheckBox, &QCheckBox::checkStateChanged,
           this, &SmithChartWidget::onShowConstantCurvesChanged);
+#else
+  connect(m_ShowAdmittanceChartCheckBox, &QCheckBox::stateChanged,
+          this, &SmithChartWidget::onShowAdmittanceChartChanged);
+  connect(m_ShowConstantCurvesCheckBox, &QCheckBox::stateChanged,
+          this, &SmithChartWidget::onShowConstantCurvesChanged);
+#endif
 
   setLayout(mainLayout);
 }

qucs/components/component.cpp

@@ -29,8 +29,6 @@
 #include "node.h"
 #include "misc.h"
 
-#include <QPen>
-#include <QString>
 #include <QMessageBox>
 #include <QPainter>
 #include <QDebug>

qucs/components/component.h

@@ -18,22 +18,20 @@
 #ifndef COMPONENT_H
 #define COMPONENT_H
 
+#include "extsimkernels/spicecompat.h"
+#include "element.h"
+#include "property.h"
+
 // QObject is needed here to be transitively included
 // from component implementations. Some how non-Linux
 // builds fail without explicit QObject inclusion
 #include <QObject>
-#include "extsimkernels/spicecompat.h"
-
 #include <QList>
-
-#include "element.h"
-#include "property.h"
-
+#include <QString>
+#include <QPen>
+#include <QPair>
 
 class Schematic;
-class QString;
-class QPen;
-
 
 class Component : public Element {
 public:
@@ -84,6 +82,9 @@ class Component : public Element {
   virtual void setSchematic (Schematic* p) { containingSchematic = p; }
   virtual Schematic* getSchematic () {return containingSchematic; }
 
+  virtual void setNetNameMapping(QList<QPair<QString, QString>>& pinInfo) { Q_UNUSED(pinInfo) }
+  virtual void resetNetNameMapping() {}
+
   QList<qucs::Line *>     Lines;
   QList<qucs::Polyline *> Polylines;
   QList<struct qucs::Arc *>      Arcs;

qucs/components/subcirport.cpp

@@ -17,6 +17,7 @@
 #include "subcirport.h"
 #include "node.h"
 
+#include <utility>
 
 SubCirPort::SubCirPort()
 {
@@ -112,6 +113,27 @@ QString SubCirPort::spice_netlist(spicecompat::SpiceDialect dialect /* = spiceco
     return QString();
 }
 
+void SubCirPort::setNetNameMapping(QList<QPair<QString, QString>>& pinInfo)
+{
+    Q_ASSERT(!Ports.isEmpty());
+    Q_ASSERT(Props.size() >= 2);
+
+    Ports.first()->Connection->setNetNameMapping(Name);
+
+    const QString type(Props.at(1)->Value);
+    pinInfo.append(
+            std::make_pair(
+                Name,
+                (type == "analog" ? "I" : type == "in" ? "I" : type == "out" ? "O" : "B")));
+}
+
+void SubCirPort::resetNetNameMapping()
+{
+    Q_ASSERT(!Ports.isEmpty());
+
+    Ports.first()->Connection->resetNetNameMapping();
+}
+
 // -------------------------------------------------------
 QString SubCirPort::vhdlCode(int)
 {

qucs/components/subcirport.h

@@ -31,6 +31,8 @@ class SubCirPort : public MultiViewComponent  {
 protected:
   QString netlist();
   QString spice_netlist(spicecompat::SpiceDialect dialect = spicecompat::SPICEDefault);
+  virtual void setNetNameMapping(QList<QPair<QString, QString>>& pinInfo);
+  virtual void resetNetNameMapping();
   QString vhdlCode(int);
   QString verilogCode(int);
   void createSymbol();

qucs/extsimkernels/CdlNetlistWriter.cpp

@@ -36,13 +36,16 @@
 CdlNetlistWriter::CdlNetlistWriter(
         QTextStream& netlistStream,
         Schematic* schematic,
-        bool resolveSpicePrefix) :
+        bool resolveSpicePrefix,
+        const QString& subCircuitName) :
     a_netlistStream(netlistStream),
     a_schematic(schematic),
     a_resolveSpicePrefix(resolveSpicePrefix),
     a_netListString(),
     a_netListStringStream(&a_netListString, QIODeviceBase::WriteOnly),
-    a_effectiveNetlistStream(resolveSpicePrefix ? a_netListStringStream : a_netlistStream)
+    a_effectiveNetlistStream(resolveSpicePrefix ? a_netListStringStream : a_netlistStream),
+    a_pinInfo(),
+    a_subCircuitName(subCircuitName)
 {
     if (a_resolveSpicePrefix)
     {
@@ -66,7 +69,7 @@ bool CdlNetlistWriter::write()
 
     startNetlist();
 
-    a_effectiveNetlistStream << ".END\n";
+    a_effectiveNetlistStream << ".ENDS\n" << ".END\n";
 
     if (a_resolveSpicePrefix)
     {
@@ -76,6 +79,8 @@ bool CdlNetlistWriter::write()
         a_netlistStream << a_netListString;
     }
 
+    a_schematic->resetNetNameMapping();
+
     return true;
 }
 
@@ -163,6 +168,8 @@ int CdlNetlistWriter::prepareNetlist()
         return -10;
     }
 
+    a_schematic->setNetNameMapping(a_pinInfo);
+
     return numPorts;
 }
 
@@ -171,7 +178,7 @@ void CdlNetlistWriter::startNetlist()
     QString s;
 
     // Parameters, Initial conditions, Options
-    for (Component *pc : a_schematic->a_DocComps)
+    for (Component *pc: a_schematic->a_DocComps)
     {
         if (pc->isEquation)
         {
@@ -180,17 +187,37 @@ void CdlNetlistWriter::startNetlist()
         }
     }
 
+    // always wrap the main netlist in a subcircuit
+    a_effectiveNetlistStream << ".SUBCKT " << a_subCircuitName;
+    for (auto pinInfo: a_pinInfo)
+    {
+        a_effectiveNetlistStream << " " << pinInfo.first;
+    }
+    a_effectiveNetlistStream << "\n";
+
     // global net 0 is always ground
-    a_effectiveNetlistStream << ".GLOBAL 0:G\n";
+    a_effectiveNetlistStream << "*.GLOBAL 0:G\n";
+
+    if (!a_pinInfo.isEmpty())
+    {
+        a_effectiveNetlistStream << "*.PININFO";
+
+        for (auto pinInfo: a_pinInfo)
+        {
+            a_effectiveNetlistStream << " " << pinInfo.first << ":" << pinInfo.second;
+        }
+
+        a_effectiveNetlistStream << "\n";
+    }
 
     // Components
-    for (Component *pc : a_schematic->a_DocComps)
+    for (Component *pc: a_schematic->a_DocComps)
     {
         if (a_schematic->getIsAnalog() && !pc->isSimulation && !pc->isEquation)
         {
             s = pc->getSpiceNetlist(spicecompat::CDL);
 
-            a_effectiveNetlistStream << s;
+            a_effectiveNetlistStream << (s == "\n" ? "" : s);
         }
     }
 

qucs/extsimkernels/CdlNetlistWriter.h

@@ -24,13 +24,20 @@
 #include <QMap>
 #include <QStringList>
 #include <QTextStream>
+#include <QList>
+#include <QPair>
+#include <QString>
 
 class Schematic;
 
 class CdlNetlistWriter
 {
 public:
-    CdlNetlistWriter(QTextStream& netlistStream, Schematic* schematic, bool resolveSpicePrefix);
+    CdlNetlistWriter(
+            QTextStream& netlistStream,
+            Schematic* schematic,
+            bool resolveSpicePrefix,
+            const QString& subCircuitName);
     ~CdlNetlistWriter() {};
 
     bool write();
@@ -47,6 +54,8 @@ class CdlNetlistWriter
     QString a_netListString;
     QTextStream a_netListStringStream;
     QTextStream& a_effectiveNetlistStream;
+    QList<QPair<QString, QString>> a_pinInfo;
+    const QString a_subCircuitName;
 };
 
 #endif // CDL_NETLIST_WRITER_H

qucs/main.cpp

@@ -479,13 +479,22 @@ int doCdlNetlist(
     QScopedPointer<QString> netlistString;
     QScopedPointer<QFile> cdlFile;
 
+    QString subCircuitName;
+
     if (netlist2Console)
     {
+        subCircuitName = "console";
+
         netlistString.reset(new QString());
         netlistStream.reset(new QTextStream(netlistString.get()));
     }
     else
     {
+        // The main-netlist wrapping subcircuit gets the name from the netlist storage
+        // file name excluding the potential file suffix
+        subCircuitName = netlistFileName.split(QDir::separator()).last();
+        subCircuitName = subCircuitName.left(subCircuitName.lastIndexOf("."));
+
         cdlFile.reset(new QFile(netlistFileName));
 
         if (cdlFile->open(QFile::WriteOnly))
@@ -508,7 +517,7 @@ int doCdlNetlist(
         }
     }
 
-    CdlNetlistWriter cdlWriter(*netlistStream, schematic.get(), resolveSpicePrefix);
+    CdlNetlistWriter cdlWriter(*netlistStream, schematic.get(), resolveSpicePrefix, subCircuitName);
     if (!cdlWriter.write())
     {
         QMessageBox::critical(

qucs/node.cpp

@@ -28,7 +28,8 @@ Node::Node(int x, int y) :
     a_components(),
     a_dtype(""),
     a_state(0),
-    a_name()
+    a_name(),
+    a_mappedName()
 {
     Type  = isNode;
     cx = x;
@@ -120,3 +121,29 @@ Node* Node::merge(Node* donor)
 
     return donor;
 }
+
+void Node::setNetNameMapping(const QString& netName)
+{
+    if (!a_mappedName.has_value() || a_mappedName.value() != netName)
+    {
+        a_mappedName = netName;
+
+        std::for_each(
+                a_wires.begin(),
+                a_wires.end(),
+                [netName](Wire* &wire) { wire->setNetNameMapping(netName); });
+    }
+}
+
+void Node::resetNetNameMapping()
+{
+    if (a_mappedName.has_value())
+    {
+        a_mappedName.reset();
+
+        std::for_each(
+                a_wires.begin(),
+                a_wires.end(),
+                [](Wire* &wire) { wire->resetNetNameMapping(); });
+    }
+}

qucs/node.h

@@ -20,6 +20,7 @@
 
 #include "conductor.h"
 #include <list>
+#include <optional>
 
 #include <QDebug>
 
@@ -73,12 +74,15 @@ class Node : public Conductor {
 
   inline void setName(const QString& name) { a_name = name; }
   inline void addName(const QString& name) { a_name += name; }
-  inline QString getName() const { return a_name; }
+  inline QString getName() const { return a_mappedName.has_value() ? a_mappedName.value() : a_name; }
   inline void setDType(const QString& dtype) { a_dtype = dtype; }
   inline QString getDType() const { return a_dtype; }
   inline void setState(int state) { a_state = state; }
   inline int getState() const { return a_state; }
 
+  void setNetNameMapping(const QString& netName);
+  void resetNetNameMapping();
+
 private:
   // Nodes usually have quite a few connections. In ideal case, when all wire
   // placement optimizations work properly, there can be at most four connections
@@ -94,6 +98,7 @@ class Node : public Conductor {
   QString a_dtype;  // type of node (used by digital files)
   int a_state;      // remember some things during some operations
   QString a_name;   // node name used by creation of netlist
+  std::optional<QString> a_mappedName;
 };
 
 #endif