Add GUI Decals API

Signed-off-by: Clifford Wolf <clifford@clifford.at>

common/nextpnr.h

@@ -155,6 +155,12 @@ NEXTPNR_NAMESPACE_END
 
 NEXTPNR_NAMESPACE_BEGIN
 
+struct DecalXY
+{
+    DecalId decal;
+    float x = 0, y = 0;
+};
+
 struct BelPin
 {
     BelId bel;
@@ -273,6 +279,60 @@ struct Context : Arch
 
     // --------------------------------------------------------------
 
+    std::vector<GraphicElement> getFrameGraphics() const __attribute__ ((deprecated)) {
+        std::vector<GraphicElement> ret;
+        DecalXY decalxy = getFrameDecal();
+        ret = getDecalGraphics(decalxy.decal);
+        for (auto &it : ret) {
+            it.x1 += decalxy.x;
+            it.x2 += decalxy.x;
+            it.y1 += decalxy.y;
+            it.y2 += decalxy.y;
+        }
+        return ret;
+    }
+
+    std::vector<GraphicElement> getBelGraphics(BelId bel) const __attribute__ ((deprecated)) {
+        std::vector<GraphicElement> ret;
+        DecalXY decalxy = getBelDecal(bel);
+        ret = getDecalGraphics(decalxy.decal);
+        for (auto &it : ret) {
+            it.x1 += decalxy.x;
+            it.x2 += decalxy.x;
+            it.y1 += decalxy.y;
+            it.y2 += decalxy.y;
+        }
+        return ret;
+    }
+
+    std::vector<GraphicElement> getWireGraphics(WireId wire) const __attribute__ ((deprecated)) {
+        std::vector<GraphicElement> ret;
+        DecalXY decalxy = getWireDecal(wire);
+        ret = getDecalGraphics(decalxy.decal);
+        for (auto &it : ret) {
+            it.x1 += decalxy.x;
+            it.x2 += decalxy.x;
+            it.y1 += decalxy.y;
+            it.y2 += decalxy.y;
+        }
+        return ret;
+    }
+
+    std::vector<GraphicElement> getPipGraphics(PipId pip) const __attribute__ ((deprecated)) {
+        std::vector<GraphicElement> ret;
+        DecalXY decalxy = getPipDecal(pip);
+        ret = getDecalGraphics(decalxy.decal);
+        for (auto &it : ret) {
+            it.x1 += decalxy.x;
+            it.x2 += decalxy.x;
+            it.y1 += decalxy.y;
+            it.y2 += decalxy.y;
+        }
+        return ret;
+    }
+
+    // --------------------------------------------------------------
+
     uint64_t rngstate = 0x3141592653589793;
 
     uint64_t rng64()

generic/arch.cc

@@ -107,27 +107,32 @@ void Arch::addBelInout(IdString bel, IdString name, IdString wire)
     wires.at(wire).downhill_bel_pins.push_back(BelPin{bel, name});
 }
 
-void Arch::addFrameGraphic(const GraphicElement &graphic)
+void Arch::addDecalGraphic(DecalId decal, const GraphicElement &graphic)
 {
-    frame_graphics.push_back(graphic);
+    decal_graphics[decal].push_back(graphic);
+}
+
+void Arch::setFrameDecal(DecalXY decalxy)
+{
+    frame_decalxy = decalxy;
     frameGraphicsReload = true;
 }
 
-void Arch::addWireGraphic(WireId wire, const GraphicElement &graphic)
+void Arch::setWireDecal(WireId wire, DecalXY decalxy)
 {
-    wires.at(wire).graphics.push_back(graphic);
+    wires.at(wire).decalxy = decalxy;
     wireGraphicsReload.insert(wire);
 }
 
-void Arch::addPipGraphic(PipId pip, const GraphicElement &graphic)
+void Arch::setPipDecal(PipId pip, DecalXY decalxy)
 {
-    pips.at(pip).graphics.push_back(graphic);
+    pips.at(pip).decalxy = decalxy;
     pipGraphicsReload.insert(pip);
 }
 
-void Arch::addBelGraphic(BelId bel, const GraphicElement &graphic)
+void Arch::setBelDecal(BelId bel, DecalXY decalxy)
 {
-    bels.at(bel).graphics.push_back(graphic);
+    bels.at(bel).decalxy = decalxy;
     belGraphicsReload.insert(bel);
 }
 
@@ -310,13 +315,15 @@ delay_t Arch::estimateDelay(WireId src, WireId dst) const
 
 // ---------------------------------------------------------------
 
-const std::vector<GraphicElement> &Arch::getFrameGraphics() const { return frame_graphics; }
+const std::vector<GraphicElement> &Arch::getDecalGraphics(DecalId decal) const { return decal_graphics.at(decal); }
 
-const std::vector<GraphicElement> &Arch::getBelGraphics(BelId bel) const { return bels.at(bel).graphics; }
+DecalXY Arch::getFrameDecal() const { return frame_decalxy; }
 
-const std::vector<GraphicElement> &Arch::getWireGraphics(WireId wire) const { return wires.at(wire).graphics; }
+DecalXY Arch::getBelDecal(BelId bel) const { return bels.at(bel).decalxy; }
 
-const std::vector<GraphicElement> &Arch::getPipGraphics(PipId pip) const { return pips.at(pip).graphics; }
+DecalXY Arch::getWireDecal(WireId wire) const { return wires.at(wire).decalxy; }
+
+DecalXY Arch::getPipDecal(PipId pip) const { return pips.at(pip).decalxy; }
 
 // ---------------------------------------------------------------
 

generic/arch.h

@@ -34,16 +34,16 @@ struct PipInfo
     IdString name, bound_net;
     WireId srcWire, dstWire;
     DelayInfo delay;
-    std::vector<GraphicElement> graphics;
+    DecalXY decalxy;
 };
 
 struct WireInfo
 {
     IdString name, bound_net;
-    std::vector<GraphicElement> graphics;
     std::vector<PipId> downhill, uphill, aliases;
     BelPin uphill_bel_pin;
     std::vector<BelPin> downhill_bel_pins;
+    DecalXY decalxy;
     int grid_x, grid_y;
 };
 
@@ -58,7 +58,7 @@ struct BelInfo
 {
     IdString name, type, bound_cell;
     std::unordered_map<IdString, PinInfo> pins;
-    std::vector<GraphicElement> graphics;
+    DecalXY decalxy;
     int grid_x, grid_y;
     bool gb;
 };
@@ -74,7 +74,9 @@ struct Arch : BaseCtx
     std::vector<IdString> bel_ids, wire_ids, pip_ids;
     std::unordered_map<IdString, std::vector<IdString>> bel_ids_by_type;
 
-    std::vector<GraphicElement> frame_graphics;
+    std::unordered_map<DecalId, std::vector<GraphicElement>> decal_graphics;
+    DecalXY frame_decalxy;
+
     float grid_distance_to_delay;
 
     void addWire(IdString name, int x, int y);
@@ -86,10 +88,11 @@ struct Arch : BaseCtx
     void addBelOutput(IdString bel, IdString name, IdString wire);
     void addBelInout(IdString bel, IdString name, IdString wire);
 
-    void addFrameGraphic(const GraphicElement &graphic);
+    void addDecalGraphic(DecalId decal, const GraphicElement &graphic);
-    void addWireGraphic(WireId wire, const GraphicElement &graphic);
+    void setFrameDecal(DecalXY decalxy);
-    void addPipGraphic(PipId pip, const GraphicElement &graphic);
+    void setWireDecal(WireId wire, DecalXY decalxy);
-    void addBelGraphic(BelId bel, const GraphicElement &graphic);
+    void setPipDecal(PipId pip, DecalXY decalxy);
+    void setBelDecal(BelId bel, DecalXY decalxy);
 
     // ---------------------------------------------------------------
     // Common Arch API. Every arch must provide the following methods.
@@ -155,10 +158,11 @@ struct Arch : BaseCtx
     float getDelayNS(delay_t v) const { return v; }
     uint32_t getDelayChecksum(delay_t v) const { return 0; }
 
-    const std::vector<GraphicElement> &getFrameGraphics() const;
+    const std::vector<GraphicElement> &getDecalGraphics(DecalId decal) const;
-    const std::vector<GraphicElement> &getBelGraphics(BelId bel) const;
+    DecalXY getFrameDecal() const;
-    const std::vector<GraphicElement> &getWireGraphics(WireId wire) const;
+    DecalXY getBelDecal(BelId bel) const;
-    const std::vector<GraphicElement> &getPipGraphics(PipId pip) const;
+    DecalXY getWireDecal(WireId wire) const;
+    DecalXY getPipDecal(PipId pip) const;
 
     bool allGraphicsReload = false;
     bool frameGraphicsReload = false;

generic/archdefs.h

@@ -49,5 +49,6 @@ typedef IdString PortPin;
 typedef IdString BelId;
 typedef IdString WireId;
 typedef IdString PipId;
+typedef IdString DecalId;
 
 NEXTPNR_NAMESPACE_END

gui/fpgaviewwidget.cc

@@ -363,6 +363,26 @@ void FPGAViewWidget::paintGL()
         lineShader_.draw(bels, matrix);
     }
 
+    // Draw Wires.
+    auto wires = LineShaderData(0.0005f, QColor("#b000ba"));
+    if (ctx_) {
+        for (auto wire : ctx_->getWires()) {
+            for (auto &el : ctx_->getWireGraphics(wire))
+                drawElement(wires, el);
+        }
+        lineShader_.draw(wires, matrix);
+    }
+
+    // Draw Pips.
+    auto pips = LineShaderData(0.0005f, QColor("#b000ba"));
+    if (ctx_) {
+        for (auto wire : ctx_->getPips()) {
+            for (auto &el : ctx_->getPipGraphics(wire))
+                drawElement(pips, el);
+        }
+        lineShader_.draw(pips, matrix);
+    }
+
     // Draw Frame Graphics.
     auto frames = LineShaderData(0.002f, QColor("#0066ba"));
     if (ctx_) {

ice40/arch.cc

@@ -400,10 +400,39 @@ delay_t Arch::estimateDelay(WireId src, WireId dst) const
 
 // -----------------------------------------------------------------------
 
-std::vector<GraphicElement> Arch::getFrameGraphics() const
+DecalXY Arch::getFrameDecal() const
+{
+    DecalXY decalxy;
+    decalxy.decal.type = 'f';
+    return decalxy;
+}
+
+DecalXY Arch::getBelDecal(BelId bel) const
+{
+    DecalXY decalxy;
+    decalxy.decal.type = 'b';
+    decalxy.decal.z = bel.index;
+    return decalxy;
+}
+
+DecalXY Arch::getWireDecal(WireId wire) const
+{
+    DecalXY decalxy;
+    return decalxy;
+}
+
+DecalXY Arch::getPipDecal(PipId pip) const
+{
+    DecalXY decalxy;
+    return decalxy;
+};
+
+std::vector<GraphicElement> Arch::getDecalGraphics(DecalId decal) const
 {
     std::vector<GraphicElement> ret;
 
+    if (decal.type == 'f')
+    {
         for (int x = 0; x <= chip_info->width; x++)
             for (int y = 0; y <= chip_info->height; y++) {
                 GraphicElement el;
@@ -413,13 +442,12 @@ std::vector<GraphicElement> Arch::getFrameGraphics() const
                 el.x1 = x, el.x2 = x, el.y1 = y - 0.05, el.y2 = y + 0.05, el.z = 0;
                 ret.push_back(el);
             }
-
-    return ret;
     }
 
-std::vector<GraphicElement> Arch::getBelGraphics(BelId bel) const
+    if (decal.type == 'b')
     {
-    std::vector<GraphicElement> ret;
+        BelId bel;
+        bel.index = decal.z;
 
         auto bel_type = getBelType(bel);
 
@@ -504,24 +532,11 @@ std::vector<GraphicElement> Arch::getBelGraphics(BelId bel) const
             el.z = 0;
             ret.push_back(el);
         }
+    }
 
     return ret;
 }
 
-std::vector<GraphicElement> Arch::getWireGraphics(WireId wire) const
-{
-    std::vector<GraphicElement> ret;
-    // FIXME
-    return ret;
-}
-
-std::vector<GraphicElement> Arch::getPipGraphics(PipId pip) const
-{
-    std::vector<GraphicElement> ret;
-    // FIXME
-    return ret;
-};
-
 // -----------------------------------------------------------------------
 
 bool Arch::getCellDelay(const CellInfo *cell, IdString fromPort, IdString toPort, delay_t &delay) const

ice40/arch.h

@@ -643,10 +643,12 @@ struct Arch : BaseCtx
 
     // -------------------------------------------------
 
-    std::vector<GraphicElement> getFrameGraphics() const;
+    std::vector<GraphicElement> getDecalGraphics(DecalId decal) const;
-    std::vector<GraphicElement> getBelGraphics(BelId bel) const;
+
-    std::vector<GraphicElement> getWireGraphics(WireId wire) const;
+    DecalXY getFrameDecal() const;
-    std::vector<GraphicElement> getPipGraphics(PipId pip) const;
+    DecalXY getBelDecal(BelId bel) const;
+    DecalXY getWireDecal(WireId wire) const;
+    DecalXY getPipDecal(PipId pip) const;
 
     bool allGraphicsReload = false;
     bool frameGraphicsReload = false;

ice40/archdefs.h

@@ -21,6 +21,8 @@
 #error Include "archdefs.h" via "nextpnr.h" only.
 #endif
 
+#include <boost/functional/hash_fwd.hpp>
+
 NEXTPNR_NAMESPACE_BEGIN
 
 typedef int delay_t;
@@ -107,6 +109,13 @@ struct PipId
     bool operator!=(const PipId &other) const { return index != other.index; }
 };
 
+struct DecalId
+{
+    char type = 0; // Bel/Wire/Pip/Frame (b/w/p/f)
+    uint8_t x = 0, y = 0;
+    uint32_t z = 0;
+};
+
 NEXTPNR_NAMESPACE_END
 
 namespace std {
@@ -135,4 +144,17 @@ template <> struct hash<NEXTPNR_NAMESPACE_PREFIX BelType> : hash<int>
 template <> struct hash<NEXTPNR_NAMESPACE_PREFIX PortPin> : hash<int>
 {
 };
+
+template <> struct hash<NEXTPNR_NAMESPACE_PREFIX DecalId>
+{
+    std::size_t operator()(const NEXTPNR_NAMESPACE_PREFIX DecalId &decal) const noexcept {
+        std::size_t seed = 0;
+        boost::hash_combine(seed, hash<int>()(decal.type));
+        boost::hash_combine(seed, hash<int>()(decal.x));
+        boost::hash_combine(seed, hash<int>()(decal.y));
+        boost::hash_combine(seed, hash<int>()(decal.z));
+        return seed;
+    }
+};
+
 } // namespace std