From d4d487298c25b16cebf873374428ecbc0d56cb75 Mon Sep 17 00:00:00 2001
From: Andrey Kalmykov <wawuwo@ya.ru>
Date: Thu, 6 Feb 2025 18:10:00 +0100
Subject: [PATCH] Add wire planner

---
 qucs/CMakeLists.txt   |   3 +-
 qucs/wire_planner.cpp | 107 ++++++++++++++++++++++++++++++++++++++++++
 qucs/wire_planner.h   |  27 +++++++++++
 3 files changed, 136 insertions(+), 1 deletion(-)
 create mode 100644 qucs/wire_planner.cpp
 create mode 100644 qucs/wire_planner.h

diff --git a/qucs/CMakeLists.txt b/qucs/CMakeLists.txt
index 3a5ac163..a19bfbb3 100755
--- a/qucs/CMakeLists.txt
+++ b/qucs/CMakeLists.txt
@@ -147,7 +147,7 @@ SET(QUCS_SRCS
   syntax.cpp misc.cpp messagedock.cpp
   settings.cpp
   imagewriter.cpp printerwriter.cpp projectView.cpp
-  symbolwidget.cpp
+  symbolwidget.cpp wire_planner.cpp
 )
 
 SET(QUCS_HDRS
@@ -170,6 +170,7 @@ symbolwidget.h
 textdoc.h
 wire.h
 wirelabel.h
+wire_planner.h
 )
 
 #
diff --git a/qucs/wire_planner.cpp b/qucs/wire_planner.cpp
new file mode 100644
index 00000000..53d9a7b2
--- /dev/null
+++ b/qucs/wire_planner.cpp
@@ -0,0 +1,107 @@
+#include "wire_planner.h"
+
+namespace qucs_s {
+namespace wire {
+
+inline bool is_horizontal_or_vertical(const QPoint from, const QPoint to) {
+    return from.x() == to.x() || from.y() == to.y();
+}
+
+// TODO: migrate to C++20 and yonger and use std::midpoint instead
+int midpoint(int a, int b) {
+  return a + (b - a) / 2;
+}
+
+
+std::vector<QPoint> straight(const QPoint from, const QPoint to) {
+    return {from, to};
+}
+
+std::vector<QPoint> two_step_xy(const QPoint from, const QPoint to) {
+    if (is_horizontal_or_vertical(from, to)) {
+        return {from, to};
+    };
+
+    /*
+    From o---+
+             |
+             +---o To
+    */
+    return {from, {to.x(), from.y()}, to};
+}
+
+std::vector<QPoint> two_step_yx(const QPoint from, const QPoint to) {
+    if (is_horizontal_or_vertical(from, to)) {
+        return {from, to};
+    };
+
+    /*
+    From o
+         |
+         +---o To
+    */
+    return {from, {from.x(), to.y()}, to};
+}
+
+std::vector<QPoint> three_step_xy(const QPoint from, const QPoint to) {
+    if (is_horizontal_or_vertical(from, to)) {
+        return {from, to};
+    };
+
+    /*
+    From o---+
+             |
+             +---o To
+    */
+    int mid_x = midpoint(from.x(), to.x());
+    return {from, {mid_x, from.y()}, {mid_x, to.y()}, to};
+}
+
+std::vector<QPoint> three_step_yx(const QPoint from, const QPoint to) {
+    if (is_horizontal_or_vertical(from, to)) {
+        return {from, to};
+    };
+
+    /*
+      o From
+      |
+      +---+
+          |
+          o To
+    */
+    int mid_y = midpoint(from.y(), to.y());
+    return {from, {from.x(), mid_y}, {to.x(), mid_y}, to};
+}
+
+
+static const std::map<Planner::PlanType, Planner::RouterFunc> routers = {
+    {Planner::PlanType::TwoStepXY, two_step_xy},
+    {Planner::PlanType::TwoStepYX, two_step_yx},
+    {Planner::PlanType::ThreeStepXY,three_step_xy},
+    {Planner::PlanType::ThreeStepYX, three_step_yx}
+};
+
+
+Planner::Planner() : current{routers.begin()} {}
+
+std::vector<QPoint> Planner::plan(PlanType type, const QPoint from, const QPoint to) {
+    return routers.at(type)(from, to);
+}
+
+std::vector<QPoint> Planner::plan(const QPoint from, const QPoint to) const {
+    return current->second(from, to);
+}
+
+void Planner::next() {
+    ++current;
+
+    if (current != routers.cend()) {
+        return;
+    }
+
+    current = routers.cbegin();
+}
+
+
+} // namespace wire
+} // namespace qucs_s
diff --git a/qucs/wire_planner.h b/qucs/wire_planner.h
new file mode 100644
index 00000000..d616f96a
--- /dev/null
+++ b/qucs/wire_planner.h
@@ -0,0 +1,27 @@
+#ifndef WIRE_PLANNER_H
+#define WIRE_PLANNER_H
+
+#include <QPoint>
+#include <functional>
+#include <map>
+
+namespace qucs_s {
+namespace wire {
+
+class Planner {
+  public:
+    using RouterFunc = std::function<std::vector<QPoint>(QPoint, QPoint)>;
+    enum class PlanType { TwoStepXY, TwoStepYX, ThreeStepXY, ThreeStepYX };
+
+    Planner();
+    static std::vector<QPoint> plan(PlanType type, const QPoint from, const QPoint to);
+    std::vector<QPoint> plan(const QPoint from, const QPoint to) const;
+    void next();
+  private:
+    std::map<PlanType, RouterFunc>::const_iterator current;
+};
+
+} // namespace wire
+} // namespace qucs_s
+
+#endif