Merge pull request #1237 from wawuwo/refactor-out-some-q3ptrlist-usages

Replace some Q3PtrList usages with QList

qucs/mouseactions.cpp

@@ -105,12 +105,11 @@ bool MouseActions::pasteElements(Schematic *Doc)
     if (!Doc->paste(&stream, &movingElements))
         return false;
 
-    Element *pe;
     int xmax, xmin, ymax, ymin;
     xmin = ymin = INT_MAX;
     xmax = ymax = INT_MIN;
     // First, get the max and min coordinates of all selected elements.
-    for (pe = movingElements.first(); pe != 0; pe = movingElements.next()) {
+    for (auto* pe : movingElements) {
         if (pe->Type == isWire) {
             if (pe->x1 < xmin)
                 xmin = pe->x1;
@@ -137,7 +136,7 @@ bool MouseActions::pasteElements(Schematic *Doc)
     Doc->setOnGrid(xmin, ymin);
 
     // moving with mouse cursor in the midpoint
-    for (pe = movingElements.first(); pe != 0; pe = movingElements.next())
+    for (auto* pe : movingElements)
         if (pe->Type & isLabel) {
             pe->cx += xmin;
             pe->x1 += xmin;
@@ -187,9 +186,8 @@ void MouseActions::editLabel(Schematic *Doc, WireLabel *pl)
 // -----------------------------------------------------------
 // Reinserts all elements (moved by the user) back into the schematic.
 void MouseActions::endElementMoving(Schematic *Doc,
-                                    Q3PtrList<Element> *movElements) {
+                                    QList<Element*> *movElements) {
-  Element *pe;
+  for (auto* pe : *movElements) {
-  for (pe = movElements->first(); pe != nullptr; pe = movElements->next()) {
     //    pe->isSelected = false;  // deselect first (maybe afterwards pe ==
     //    NULL)
     switch (pe->Type) { // FIXME: use casts.
@@ -245,11 +243,10 @@ void MouseActions::endElementMoving(Schematic *Doc,
 
 // -----------------------------------------------------------
 // Moves elements in "movElements" by x/y
-void MouseActions::moveElements(Q3PtrList<Element> *movElements, int x, int y)
+void MouseActions::moveElements(QList<Element*> *movElements, int x, int y)
 {
     Wire *pw;
-    Element *pe;
+    for (auto* pe : *movElements) {
-    for (pe = movElements->first(); pe != 0; pe = movElements->next()) {
         if (pe->Type == isWire) {
             pw = (Wire *) pe; // connected wires are not moved completely
 
@@ -499,12 +496,21 @@ void MouseActions::MMoveMoving(Schematic *Doc, QMouseEvent *Event)
     MAy3 = MAy1 = MAy2 - MAy1;
 
     movingElements.clear();
-    Doc->copySelectedElements(&movingElements);
+    {
+        // Q3PtrList is long time deprecated and has to be replaced with another
+        // container type, which is not always easy. Here it's simpler to use it
+        // once and go back to QList, because copySelectedElements() uses API
+        // unique to Q3PtrList and to refactor it is a piece of work
+        Q3PtrList<Element> temp_buffer;
+        temp_buffer.setAutoDelete(false);
+        Doc->copySelectedElements(&temp_buffer);
+        for (auto* e : temp_buffer) { movingElements.append(e); }
+    }
     Doc->viewport()->repaint();
 
     Wire *pw;
     // Changes the position of all moving elements by dx/dy
-    for (Element *pe = movingElements.first(); pe != 0; pe = movingElements.next()) {
+    for (Element *pe : movingElements) {
         if (pe->Type == isWire) {
             pw = (Wire *) pe; // connecting wires are not moved completely
 
@@ -566,7 +572,6 @@ void MouseActions::MMoveMoving2(Schematic *Doc, QMouseEvent *Event)
   MAx2 = inModel.x();
   MAy2 = inModel.y();
 
-  Element *pe;
 
   if ((Event->modifiers().testFlag(Qt::ControlModifier)) == 0)
     Doc->setOnGrid(MAx2, MAy2); // use grid only if CTRL key not pressed
@@ -578,7 +583,7 @@ void MouseActions::MMoveMoving2(Schematic *Doc, QMouseEvent *Event)
   moveElements(&movingElements, MAx1, MAy1); // moves elements by MAx1/MAy1
 
   // paint afterwards to avoid conflict between wire and label painting
-  for (pe = movingElements.first(); pe != 0; pe = movingElements.next())
+  for (auto* pe : movingElements)
     pe->paintScheme(Doc);
   //    if(pe->Type == isWire)  if(((Wire*)pe)->Label)
   //      if(!((Wire*)pe)->Label->isSelected)
@@ -1860,18 +1865,16 @@ void MouseActions::MReleaseSetLimits(Schematic *Doc, QMouseEvent *Event)
 // -----------------------------------------------------------
 void MouseActions::paintElementsScheme(Schematic *p)
 {
-    Element *pe;
+    for (auto* pe : movingElements)
-    for (pe = movingElements.first(); pe != nullptr; pe = movingElements.next())
         pe->paintScheme(p);
 }
 
 // -----------------------------------------------------------
 void MouseActions::moveElements(Schematic *Doc, int &x1, int &y1)
 {
-    Element *pe;
     Doc->setOnGrid(x1, y1);
 
-    for (pe = movingElements.first(); pe != 0; pe = movingElements.next()) {
+    for (auto* pe : movingElements) {
         if (pe->Type & isLabel) {
             pe->cx += x1;
             pe->x1 += x1;
@@ -1886,10 +1889,9 @@ void MouseActions::moveElements(Schematic *Doc, int &x1, int &y1)
 void MouseActions::rotateElements(Schematic *Doc, int &x1, int &y1)
 {
     int x2;
-    Element *pe;
     Doc->setOnGrid(x1, y1);
 
-    for (pe = movingElements.first(); pe != 0; pe = movingElements.next()) {
+    for (auto* pe : movingElements) {
         switch (pe->Type) {
         case isComponent:
         case isAnalogComponent:
@@ -1924,11 +1926,10 @@ void MouseActions::MReleasePaste(Schematic *Doc, QMouseEvent *Event)
     QFileInfo Info(Doc->getDocName());
     //QPainter painter(Doc->viewport());
 
-    Element *pe;
     switch (Event->button()) {
     case Qt::LeftButton:
         // insert all moved elements into document
-        for (pe = movingElements.first(); pe != 0; pe = movingElements.next()) {
+        for (auto* pe : movingElements) {
             pe->isSelected = false;
             switch (pe->Type) {
             case isWire:

qucs/mouseactions.h

@@ -50,7 +50,7 @@ public:
   QMouseEvent *focusMEvent;
 
   int  MAx1, MAy1,MAx2, MAy2, MAx3, MAy3;  // cache for mouse movements
-  Q3PtrList<Element> movingElements;
+  QList<Element*> movingElements;
   int movingRotated;
 
   // menu appearing by right mouse button click on component
@@ -123,8 +123,8 @@ public:
   void paintElementsScheme(Schematic*);
   void rotateElements(Schematic*, int&, int&);
   void moveElements(Schematic*, int&, int&);
-  static void moveElements(Q3PtrList<Element>*, int, int);
+  static void moveElements(QList<Element*>*, int, int);
-  void endElementMoving(Schematic*, Q3PtrList<Element>*);
+  void endElementMoving(Schematic*, QList<Element*>*);
   void rightPressMenu(Schematic*, QMouseEvent*, float, float);
 };
 

qucs/qucs_actions.cpp

@@ -1127,9 +1127,19 @@ void QucsApp::slotCursorLeft(bool left)
   }
   if(!editText->isHidden()) return;  // for edit of component property ?
 
-  Q3PtrList<Element> movingElements;
+  QList<Element*> movingElements;
   Schematic *Doc = (Schematic*)DocumentTab->currentWidget();
-  int markerCount = Doc->copySelectedElements(&movingElements);
+  int markerCount = 0;
+  {
+    // Q3PtrList is long time deprecated and has to be replaced with another
+    // container type, which is not always easy. Here it's simpler to use it
+    // once and go back to QList, because copySelectedElements() uses API
+    // unique to Q3PtrList and to refactor it is a piece of work
+    Q3PtrList<Element> temp_buffer;
+    temp_buffer.setAutoDelete(false);
+    markerCount = Doc->copySelectedElements(&temp_buffer);
+    for (auto* e : temp_buffer) { movingElements.append(e); }
+  }
 
   if((movingElements.count() - markerCount) < 1) {
     if(markerCount > 0) {  // only move marker if nothing else selected
@@ -1193,9 +1203,19 @@ void QucsApp::slotCursorUp(bool up)
     return;
   }
 
-  Q3PtrList<Element> movingElements;
+  QList<Element*> movingElements;
   Schematic *Doc = (Schematic*)DocumentTab->currentWidget();
-  int markerCount = Doc->copySelectedElements(&movingElements);
+  int markerCount = 0;
+  {
+    // Q3PtrList is long time deprecated and has to be replaced with another
+    // container type, which is not always easy. Here it's simpler to use it
+    // once and go back to QList, because copySelectedElements() uses API
+    // unique to Q3PtrList and to refactor it is a piece of work
+    Q3PtrList<Element> temp_buffer;
+    temp_buffer.setAutoDelete(false);
+    markerCount = Doc->copySelectedElements(&temp_buffer);
+    for (auto* e : temp_buffer) { movingElements.append(e); }
+  }
 
   if((movingElements.count() - markerCount) < 1) { // all selections are markers
     if(markerCount > 0) {  // only move marker if nothing else selected

qucs/schematic.cpp

@@ -1668,7 +1668,7 @@ void Schematic::cut()
 
 // ---------------------------------------------------
 // Performs paste function from clipboard
-bool Schematic::paste(QTextStream *stream, Q3PtrList<Element> *pe)
+bool Schematic::paste(QTextStream *stream, QList<Element*> *pe)
 {
     return pasteFromClipboard(stream, pe);
 }

qucs/schematic.h

@@ -188,7 +188,7 @@ public:
 
   void    cut();
   void    copy();
-  bool    paste(QTextStream*, Q3PtrList<Element>*);
+  bool    paste(QTextStream*, QList<Element*>*);
   bool    load();
   int     save();
   int     saveSymbolCpp (void);
@@ -462,8 +462,8 @@ public:
   void  deleteWire(Wire*);
 
   Marker* setMarker(int, int);
-  void    markerLeftRight(bool, Q3PtrList<Element>*);
+  void    markerLeftRight(bool, QList<Element*>*);
-  void    markerUpDown(bool, Q3PtrList<Element>*);
+  void    markerUpDown(bool, QList<Element*>*);
 
   Element* selectElement(float, float, bool, int *index=0);
   void     deselectElements(Element*) const;
@@ -539,15 +539,15 @@ private:
 
   bool loadProperties(QTextStream*);
   void simpleInsertComponent(Component*);
-  bool loadComponents(QTextStream*, Q3PtrList<Component> *List=0);
+  bool loadComponents(QTextStream*, QList<Component*> *List=0);
   void simpleInsertWire(Wire*);
-  bool loadWires(QTextStream*, Q3PtrList<Element> *List=0);
+  bool loadWires(QTextStream*, QList<Element*> *List=0);
-  bool loadDiagrams(QTextStream*, Q3PtrList<Diagram>*);
+  bool loadDiagrams(QTextStream*, QList<Diagram*>*);
-  bool loadPaintings(QTextStream*, Q3PtrList<Painting>*);
+  bool loadPaintings(QTextStream*, QList<Painting*>*);
   bool loadIntoNothing(QTextStream*);
 
   QString createClipboardFile();
-  bool    pasteFromClipboard(QTextStream *, Q3PtrList<Element>*);
+  bool    pasteFromClipboard(QTextStream *, QList<Element*>*);
 
   QString createUndoString(char);
   bool    rebuild(QString *);

qucs/schematic_element.cpp

@@ -982,14 +982,14 @@ Marker* Schematic::setMarker(int x, int y)
 
 // ---------------------------------------------------
 // Moves the marker pointer left/right on the graph.
-void Schematic::markerLeftRight(bool left, Q3PtrList<Element> *Elements)
+void Schematic::markerLeftRight(bool left, QList<Element*> *Elements)
 {
     bool acted = false;
-    for(auto i : *Elements) {
+    for (auto* e : *Elements) {
-        Marker* pm = prechecked_cast<Marker*>(i);
+        if (auto* pm = dynamic_cast<Marker*>(e)) {
-        assert(pm);
+            if (pm->moveLeftRight(left))
-        if(pm->moveLeftRight(left))
+                acted = true;
-            acted = true;
+            }
     }
 
     if(acted)  setChanged(true, true, 'm');
@@ -997,14 +997,14 @@ void Schematic::markerLeftRight(bool left, Q3PtrList<Element> *Elements)
 
 // ---------------------------------------------------
 // Moves the marker pointer up/down on the more-dimensional graph.
-void Schematic::markerUpDown(bool up, Q3PtrList<Element> *Elements)
+void Schematic::markerUpDown(bool up, QList<Element*> *Elements)
 {
-    Marker *pm;
     bool acted = false;
-    for(pm = (Marker*)Elements->first(); pm!=0; pm = (Marker*)Elements->next())
+    for (auto* e : *Elements) {
-    {
+        if (auto* pm = dynamic_cast<Marker*>(e)) {
-        if(pm->moveUpDown(up))
+            if (pm->moveUpDown(up))
-            acted = true;
+                acted = true;
+        }
     }
 
     if(acted)  setChanged(true, true, 'm');

qucs/schematic_file.cpp

@@ -61,6 +61,22 @@ extern void osdi_log_skip(void *handle, char* msg, uint32_t lvl)
   (void)lvl;
 }
 
+namespace shim {
+  // Historically Qucs-S has been using Q3PtrList a lot and it's not so easy
+  // to replace it. The goal of this shim is to help with transition to new
+  // container type.
+  // Wherever possible a "barrier" is made by replacing Q3PtrList with QList
+  // to stop its propagating. QList is passed instead of original Q3PtrList
+  // and then its contents are copied back to Q3PtrList as if it was passed
+  // in the first place
+template <typename T>
+void copyToQ3PtrList(const QList<T*>& src, Q3PtrList<T>& dst) {
+  for (auto* item : src) {
+    dst.append(item);
+  }
+}
+} // namespace shim
+
 // -------------------------------------------------------------
 // Creates a Qucs file format (without document properties) in the returning
 // string. This is used to copy the selected elements into the clipboard.
@@ -131,7 +147,7 @@ bool Schematic::loadIntoNothing(QTextStream *stream)
 
 // -------------------------------------------------------------
 // Paste from clipboard.
-bool Schematic::pasteFromClipboard(QTextStream *stream, Q3PtrList<Element> *pe)
+bool Schematic::pasteFromClipboard(QTextStream *stream, QList<Element*> *pe)
 {
   QString Line;
 
@@ -161,7 +177,7 @@ bool Schematic::pasteFromClipboard(QTextStream *stream, Q3PtrList<Element> *pe)
         if(!loadIntoNothing(stream)) return false; }
       else
       if(Line == "<Paintings>") {
-        if(!loadPaintings(stream, (Q3PtrList<Painting>*)pe)) return false; }
+        if(!loadPaintings(stream, (QList<Painting*>*)pe)) return false; }
       else {
         QMessageBox::critical(0, QObject::tr("Error"),
         QObject::tr("Clipboard Format Error:\nUnknown field!"));
@@ -176,16 +192,16 @@ bool Schematic::pasteFromClipboard(QTextStream *stream, Q3PtrList<Element> *pe)
   while(!stream->atEnd()) {
     Line = stream->readLine();
     if(Line == "<Components>") {
-      if(!loadComponents(stream, (Q3PtrList<Component>*)pe)) return false; }
+      if(!loadComponents(stream, (QList<Component*>*)pe)) return false; }
     else
     if(Line == "<Wires>") {
       if(!loadWires(stream, pe)) return false; }
     else
     if(Line == "<Diagrams>") {
-      if(!loadDiagrams(stream, (Q3PtrList<Diagram>*)pe)) return false; }
+      if(!loadDiagrams(stream, (QList<Diagram*>*)pe)) return false; }
     else
     if(Line == "<Paintings>") {
-      if(!loadPaintings(stream, (Q3PtrList<Painting>*)pe)) return false; }
+      if(!loadPaintings(stream, (QList<Painting*>*)pe)) return false; }
     else {
       QMessageBox::critical(0, QObject::tr("Error"),
       QObject::tr("Clipboard Format Error:\nUnknown field!"));
@@ -869,7 +885,7 @@ void Schematic::simpleInsertComponent(Component *c)
 }
 
 // -------------------------------------------------------------
-bool Schematic::loadComponents(QTextStream *stream, Q3PtrList<Component> *List)
+bool Schematic::loadComponents(QTextStream *stream, QList<Component*> *List)
 {
   QString Line, cstr;
   Component *c;
@@ -939,7 +955,7 @@ void Schematic::simpleInsertWire(Wire *pw)
 }
 
 // -------------------------------------------------------------
-bool Schematic::loadWires(QTextStream *stream, Q3PtrList<Element> *List)
+bool Schematic::loadWires(QTextStream *stream, QList<Element*> *List)
 {
   Wire *w;
   QString Line;
@@ -976,7 +992,7 @@ bool Schematic::loadWires(QTextStream *stream, Q3PtrList<Element> *List)
 }
 
 // -------------------------------------------------------------
-bool Schematic::loadDiagrams(QTextStream *stream, Q3PtrList<Diagram> *List)
+bool Schematic::loadDiagrams(QTextStream *stream, QList<Diagram*> *List)
 {
   Diagram *d;
   QString Line, cstr;
@@ -1019,7 +1035,7 @@ bool Schematic::loadDiagrams(QTextStream *stream, Q3PtrList<Diagram> *List)
 }
 
 // -------------------------------------------------------------
-bool Schematic::loadPaintings(QTextStream *stream, Q3PtrList<Painting> *List)
+bool Schematic::loadPaintings(QTextStream *stream, QList<Painting*> *List)
 {
   Painting *p=0;
   QString Line, cstr;
@@ -1135,10 +1151,12 @@ bool Schematic::loadDocument()
     if(Line.isEmpty()) continue;
 
     if(Line == "<Symbol>") {
-      if(!loadPaintings(&stream, &a_SymbolPaints)) {
+      QList<Painting*> paintings;
+      if (!loadPaintings(&stream, &paintings)) {
         file.close();
         return false;
       }
+      shim::copyToQ3PtrList(paintings, a_SymbolPaints);
     }
     else
     if(Line == "<Properties>") {
@@ -1151,10 +1169,16 @@ bool Schematic::loadDocument()
       if(!loadWires(&stream)) { file.close(); return false; } }
     else
     if(Line == "<Diagrams>") {
-      if(!loadDiagrams(&stream, &a_DocDiags)) { file.close(); return false; } }
+      QList<Diagram*> diagrams;
+      if (!loadDiagrams(&stream, &diagrams)) { file.close(); return false; }
+      shim::copyToQ3PtrList(diagrams, a_DocDiags);
+    }
     else
     if(Line == "<Paintings>") {
-      if(!loadPaintings(&stream, &a_DocPaints)) { file.close(); return false; } }
+      QList<Painting*> paintings;
+      if (!loadPaintings(&stream, &paintings)) { file.close(); return false; }
+      shim::copyToQ3PtrList(paintings, a_DocPaints);
+    }
     else {
        qDebug() << Line;
        QMessageBox::critical(0, QObject::tr("Error"),
@@ -1241,8 +1265,16 @@ bool Schematic::rebuild(QString *s)
   // read content *************************
   if(!loadComponents(&stream))  return false;
   if(!loadWires(&stream))  return false;
-  if(!loadDiagrams(&stream, &a_DocDiags))  return false;
+  {
-  if(!loadPaintings(&stream, &a_DocPaints)) return false;
+    QList<Diagram*> diagrams;
+    if (!loadDiagrams(&stream, &diagrams)) return false;
+    shim::copyToQ3PtrList(diagrams, a_DocDiags);
+  }
+  {
+    QList<Painting*> paintings;
+    if (!loadPaintings(&stream, &paintings)) return false;
+    shim::copyToQ3PtrList(paintings, a_DocPaints);
+  }
 
   return true;
 }
@@ -1261,8 +1293,12 @@ bool Schematic::rebuildSymbol(QString *s)
   Line = stream.readLine();  // skip components
   Line = stream.readLine();  // skip wires
   Line = stream.readLine();  // skip diagrams
-  if(!loadPaintings(&stream, &a_SymbolPaints)) return false;
 
+  {
+    QList<Painting*> paintings;
+    if (!loadPaintings(&stream, &paintings)) return false;
+    shim::copyToQ3PtrList(paintings, a_SymbolPaints);
+  }
   return true;
 }