ElementAppearance.cpp

Go to the documentation of this file.

// Copyright 2015 - 2026, GIBIS-UNIFESP and the wiRedPanda contributors
// SPDX-License-Identifier: GPL-3.0-or-later
 
#include "App/Element/ElementAppearance.h"
 
#include <algorithm>
#include <cmath>
#include <memory>
 
#include <QDateTime>
#include <QFile>
#include <QFileInfo>
#include <QHash>
#include <QPainter>
#include <QPen>
#include <QPixmapCache>
#include <QRegularExpression>
#include <QSvgRenderer>
 
#include "App/Core/Common.h"
#include "App/Core/ThemeManager.h"
#include "App/Element/GraphicElement.h"
 
namespace {

QByteArray orientSvgTextNodes(const QByteArray &svgBytes, const qreal angle, const bool flipX, const bool flipY)
{
    static const QRegularExpression textTag(QStringLiteral("<text\\b[^>]*>"));
    static const QRegularExpression idAttr(QStringLiteral("\\bid\\s*=\\s*\"([^\"]*)\""));
    static const QRegularExpression transformAttr(QStringLiteral("\\btransform\\s*="));
 
    QString svg = QString::fromUtf8(svgBytes);
 
    // Pass 1: ensure every <text> opening tag carries an id so boundsOnElement() can address it.
    // Inkscape already ids these, but be defensive for hand-written assets.
    {
        QString out;
        qsizetype last = 0;
        int generated = 0;
        auto matches = textTag.globalMatch(svg);
        while (matches.hasNext()) {
            const auto match = matches.next();
            out += svg.mid(last, match.capturedStart() - last);
            QString tag = match.captured(0);
            if (!idAttr.match(tag).hasMatch()) {
                // Insert after "<text" (5 chars) so the new attribute precedes the existing ones.
                tag.insert(5, QStringLiteral(" id=\"wpflip-text-%1\"").arg(generated++));
            }
            out += tag;
            last = match.capturedEnd();
        }
        out += svg.mid(last);
        svg = out;
    }
 
    QSvgRenderer probe(svg.toUtf8());
    if (!probe.isValid()) {
        return svgBytes;
    }
 
    const qreal sx = flipX ? -1.0 : 1.0;
    const qreal sy = flipY ? -1.0 : 1.0;
 
    // Pass 2: inject a counter-orientation transform on each <text>, pivoting about that text's
    // own centre. The item applies Flip ∘ Rotate(angle) to the pixmap content, so the inverse the
    // glyph must carry is Rotate(-angle) ∘ Flip (rotate outer, scale inner). The rotate term is
    // omitted at angle 0 and the scale term when unflipped, so the flip-only output is unchanged.
    QString out;
    qsizetype last = 0;
    auto matches = textTag.globalMatch(svg);
    while (matches.hasNext()) {
        const auto match = matches.next();
        out += svg.mid(last, match.capturedStart() - last);
        QString tag = match.captured(0);
 
        const auto idMatch = idAttr.match(tag);
        if (idMatch.hasMatch() && !transformAttr.match(tag).hasMatch()) {
            const QRectF bounds = probe.boundsOnElement(idMatch.captured(1));
            if (!bounds.isEmpty()) {
                const QPointF c = bounds.center();
                QString ops;
                if (angle != 0.0) {
                    ops += QStringLiteral("rotate(%1) ").arg(-angle);
                }
                if (flipX || flipY) {
                    ops += QStringLiteral("scale(%1,%2) ").arg(sx).arg(sy);
                }
                const QString transform =
                    QStringLiteral(" transform=\"translate(%1,%2) %3translate(%4,%5)\"")
                        .arg(c.x()).arg(c.y()).arg(ops).arg(-c.x()).arg(-c.y());
                tag.insert(5, transform);
            }
        }
 
        out += tag;
        last = match.capturedEnd();
    }
    out += svg.mid(last);
 
    return out.toUtf8();
}

QPixmap orientedSvgPixmap(const QString &resolvedPath, const qreal angle, const bool flipX, const bool flipY)
{
    // Canonicalize to [0,360) so equivalent rotations (e.g. -90 and 270, which render identically)
    // share one cache entry instead of growing the key space without bound — MCP can request any
    // angle and rotate-left produces negatives.
    const qreal canonAngle = std::fmod(std::fmod(angle, 360.0) + 360.0, 360.0);
    // Namespaced so this can never collide with Qt's own internal QPixmapCache keys (which are
    // always prefixed "qt_pixmap") or anything else the app might insert into the same shared,
    // process-wide cache.
    const QString key = QLatin1String("wp_oriented_svg:") + resolvedPath + QLatin1Char('|')
        + QString::number(canonAngle) + QLatin1Char('|')
        + (flipX ? QLatin1Char('1') : QLatin1Char('0'))
        + (flipY ? QLatin1Char('1') : QLatin1Char('0'));
 
    QPixmap cached;
    if (QPixmapCache::find(key, &cached)) {
        return cached;
    }
 
    QFile file(resolvedPath);
    if (!file.open(QIODevice::ReadOnly)) {
        return {};
    }
    const QByteArray raw = file.readAll();
    // No baked-in <text> → nothing to correct; return null so the caller keeps the plain
    // item-flipped base pixmap (identical to legacy behaviour, no redundant re-render).
    if (!raw.contains("<text")) {
        return {};
    }
    const QByteArray modified = orientSvgTextNodes(raw, canonAngle, flipX, flipY);
 
    QSvgRenderer renderer(modified);
    if (!renderer.isValid()) {
        return {};
    }
 
    QPixmap pixmap(renderer.defaultSize());
    pixmap.fill(Qt::transparent);
    QPainter painter(&pixmap);
    painter.setRenderHints(QPainter::Antialiasing | QPainter::SmoothPixmapTransform | QPainter::TextAntialiasing);
    renderer.render(&painter);
    painter.end();
 
    QPixmapCache::insert(key, pixmap);
    return pixmap;
}

std::shared_ptr<QSvgRenderer> sharedSvgRenderer(const QString &resolvedPath, const qreal angle, const bool flipX, const bool flipY)
{
    static QHash<QString, std::shared_ptr<QSvgRenderer>> cache;
 
    const qreal canonAngle = std::fmod(std::fmod(angle, 360.0) + 360.0, 360.0);
    // mtime keeps this in step with QPixmap::load()'s own QPixmapCache keying (see setPixmap()
    // below) so a user-edited custom SVG appearance still picks up on next load.
    const QDateTime mtime = QFileInfo(resolvedPath).lastModified();
    const QString key = resolvedPath + QLatin1Char('|')
        + QString::number(mtime.toMSecsSinceEpoch()) + QLatin1Char('|')
        + QString::number(canonAngle) + QLatin1Char('|')
        + (flipX ? QLatin1Char('1') : QLatin1Char('0'))
        + (flipY ? QLatin1Char('1') : QLatin1Char('0'));
 
    if (const auto it = cache.constFind(key); it != cache.constEnd()) {
        return it.value();
    }
 
    QFile file(resolvedPath);
    if (!file.open(QIODevice::ReadOnly)) {
        cache.insert(key, nullptr);
        return nullptr;
    }
    QByteArray svg = file.readAll();
 
    const bool oriented = angle != 0.0 || flipX || flipY;
    if (oriented && svg.contains("<text")) {
        svg = orientSvgTextNodes(svg, canonAngle, flipX, flipY);
    }
 
    auto renderer = std::make_shared<QSvgRenderer>(svg);
    if (!renderer->isValid()) {
        renderer.reset();
    }
    cache.insert(key, renderer);
    return renderer;
}
 
} // namespace
 
ElementAppearance::ElementAppearance(GraphicElement *owner)
    : m_owner(owner)
{
}
 
ElementAppearance::~ElementAppearance() = default;
 
void ElementAppearance::seedFromMetadata(const QStringList &defaultAppearances,
                                         const QStringList &alternativeAppearances,
                                         const QString &pixmapPath)
{
    m_defaultAppearances = defaultAppearances;
    m_pixmapPath = pixmapPath;
 
    // For elements whose pixmapPath is theme-dependent (e.g. memory elements),
    // defaultAppearances may be left empty in the metadata to avoid evaluating the
    // theme path during static initialisation (before QApplication exists).
    // Populate it lazily here from the now-correct pixmapPath.
    if (m_defaultAppearances.isEmpty() && !m_pixmapPath.isEmpty()) {
        m_defaultAppearances = QStringList({m_pixmapPath});
    }
 
    m_alternativeAppearances = alternativeAppearances.isEmpty() ? m_defaultAppearances : alternativeAppearances;
}
 
QPointF ElementAppearance::pixmapCenter() const
{
    // A procedural render pixmap (IC/Mux/Demux/TruthTable) isn't anchored at local (0,0) once
    // the element's ports outgrow the nominal 64x64 body — boundingRect() (not the raw pixmap
    // rect) is the actual footprint, and its own top-left tracks that offset.
    if (m_hasCustomRenderPixmap) {
        return m_owner->boundingRect().center();
    }
    return QRectF(m_pixmap.rect()).center();
}
 
void ElementAppearance::setPixmap(const int index)
{
    setPixmap(m_usingDefaultAppearance ? m_defaultAppearances.at(index) : m_alternativeAppearances.at(index));
}
 
void ElementAppearance::setPixmap(const QString &pixmapPath)
{
    // Skip if unchanged to avoid redundant loads and cache invalidation
    if (pixmapPath.isEmpty() || (pixmapPath == m_currentPixmapPath)) {
        return;
    }
 
    // Remember the displayed size so a growth (small SVG → large custom raster) can trigger a
    // full device-cache reset below; captured before applyOrientation() replaces m_pixmap.
    const QSize previousSize = m_pixmap.size();
 
    // The pixmap about to load may have different dimensions than the current one,
    // which changes what boundingRect() reports (it's derived from pixmap().rect()) —
    // Qt requires prepareGeometryChange() before any such geometry-affecting mutation,
    // or the old footprint's stale pixels are never scheduled for repaint.
    m_owner->prepareGeometryChange();
 
    // Resolution against contextDir already happened once, at load time (see
    // ExternalFilePath::forReading(), called from GraphicElementSerializer) — by the
    // time a path reaches here it's either a resource reference or already directly
    // usable (a fresh absolute path from a file picker, or an already-resolved one
    // read back from a saved project). Nothing left to do here but load it.
    const QString path = pixmapPath;
 
    // QPixmap::load() already caches internally via the shared QPixmapCache, keyed on
    // path + mtime + size (see MainWindow's setCacheLimit() call for the app-wide budget) — a
    // wrapper cache of our own here would be both redundant and, keyed on the bare path alone,
    // staler than what load() already gives us for free.
    if (!m_basePixmap.load(path)) {
        const QFileInfo info(path);
        const QString reason = !info.exists()
                                   ? tr("File does not exist")
                                   : !info.isReadable()
                                         ? tr("File is not readable")
                                         : tr("Unknown reason");
 
        // Load the default appearance so the element remains renderable before the exception unwinds
        m_basePixmap.load(m_defaultAppearances.constFirst());
        m_pixmap = m_basePixmap;
        // Remember this exact request failed so a later call with the same broken path (e.g.
        // every simulation tick's refresh()) is skipped by the guard above instead of
        // re-attempting the load and re-throwing — each distinct failure surfaces once.
        m_currentPixmapPath = pixmapPath;
        qCDebug(zero) << "Problem loading pixmapPath: " << path;
        throw PANDACEPTION("Couldn't load pixmap: %1 (%2)", path, reason);
    }
 
    m_resolvedPixmapPath = path;
    // Loading a base pixmap hands display ownership back to the derived-pixmap flow.
    m_hasCustomRenderPixmap = false;
    // Derive the displayed pixmap from the base, swapping in a text-corrected variant when the
    // element is rotated or flipped.
    applyOrientation();
 
    // A size change grows/shrinks boundingRect(); DeviceCoordinateCache keeps the old device
    // tile on a plain update(), so reset the cache to force a full re-render and avoid a stale
    // ghost of the previous appearance.
    if (m_pixmap.size() != previousSize) {
        m_owner->invalidateRenderCache();
    }
 
    // The transform origin must be updated whenever the pixmap changes so that
    // rotation and scale operations remain centred on the new image
    m_owner->setTransformOriginPoint(pixmapCenter());
    m_owner->update();
 
    m_currentPixmapPath = pixmapPath;
}
 
QPixmap ElementAppearance::previewPixmapAt(const int index, const QSize &size) const
{
    if (index < 0 || index >= m_alternativeAppearances.size()) {
        return {};
    }
 
    // m_alternativeAppearances is always seeded to match m_defaultAppearances and only diverges
    // per-slot via setAlternativeAppearanceAt(), so it's already "the currently active path for
    // that slot" — no need to branch on the (element-wide) m_usingDefaultAppearance flag here.
    QPixmap pixmap;
    pixmap.load(m_alternativeAppearances.at(index));
 
    return pixmap.isNull() ? pixmap : pixmap.scaled(size, Qt::KeepAspectRatio, Qt::SmoothTransformation);
}
 
void ElementAppearance::setRenderPixmap(const QPixmap &pixmap)
{
    // See the identical call in setPixmap(): this pixmap's dimensions feed boundingRect().
    m_owner->prepareGeometryChange();
    const QSize previousSize = m_pixmap.size();
    m_pixmap = pixmap;
    m_hasCustomRenderPixmap = true;
    // A size change (e.g. a port count change resizing the procedural body) leaves a stale
    // DeviceCoordinateCache tile; reset the cache so the next paint re-renders in full.
    if (m_pixmap.size() != previousSize) {
        m_owner->invalidateRenderCache();
    }
    // The owner's body is drawn from this footprint, so rotation must pivot on its centre —
    // the base-pixmap flow gets the same guarantee from setPixmap().
    m_owner->setTransformOriginPoint(pixmapCenter());
}
 
void ElementAppearance::applyOrientation()
{
    // A procedural render pixmap (IC, TruthTable, Mux, Demux) is the owner's body-sizing/body
    // canvas and is not derived from m_basePixmap — re-deriving here would replace it with the
    // stale (or null) base skin. Orientation is handled by the item transform alone.
    if (m_hasCustomRenderPixmap) {
        m_owner->update();
        return;
    }
 
    // Only rotatable elements transform their graphic, so only they need the baked <text> labels
    // counter-oriented. A non-rotatable element keeps its icon upright (it moves only its ports),
    // so its text — if any — must render as authored and never be counter-oriented.
    const bool oriented = m_owner->rotatesGraphic()
        && (m_owner->isFlippedX() || m_owner->isFlippedY() || (m_owner->rotation() != 0.0));
    // A rotated/flipped SVG variant can differ in size from the base skin, which changes what
    // boundingRect() reports (it's derived from pixmap().rect()). setPixmap()/setRenderPixmap()
    // already guard their own callers, but reapplyAppearanceOrientation() reaches here directly
    // on a rotate/flip, so the mutation below needs its own prepareGeometryChange().
    m_owner->prepareGeometryChange();
    if (oriented && m_resolvedPixmapPath.endsWith(QLatin1String(".svg"), Qt::CaseInsensitive)) {
        const QPixmap variant = orientedSvgPixmap(m_resolvedPixmapPath, m_owner->rotation(), m_owner->isFlippedX(), m_owner->isFlippedY());
        m_pixmap = variant.isNull() ? m_basePixmap : variant;
    } else {
        m_pixmap = m_basePixmap;
    }
    rebuildSvgRenderer();
    m_owner->update();
}
 
void ElementAppearance::rebuildSvgRenderer()
{
    // render() draws this vector renderer so SVG elements stay crisp at any zoom; raster (PNG/JPG)
    // appearances leave it null and fall back to drawing the rasterised m_pixmap.
    if (!m_resolvedPixmapPath.endsWith(QLatin1String(".svg"), Qt::CaseInsensitive)) {
        m_svgRenderer.reset();
        return;
    }
 
    // Counter-orient each <text> while rotated/flipped so pin labels stay upright — the same
    // correction orientedSvgPixmap() bakes into the rasterised variant. Gated on rotatesGraphic()
    // because a non-rotatable element never transforms its graphic, so its text stays as authored.
    // Zeroing angle/flip when not oriented also means every unoriented element (the vast majority)
    // shares one sharedSvgRenderer() cache entry regardless of its nominal rotation/flip state.
    const bool oriented = m_owner->rotatesGraphic()
        && (m_owner->isFlippedX() || m_owner->isFlippedY() || (m_owner->rotation() != 0.0));
 
    m_svgRenderer = sharedSvgRenderer(m_resolvedPixmapPath,
                                       oriented ? m_owner->rotation() : 0.0,
                                       oriented && m_owner->isFlippedX(),
                                       oriented && m_owner->isFlippedY());
}
 
void ElementAppearance::setAppearance(const bool defaultAppearance, const QString &fileName)
{
    if (defaultAppearance) {
        m_alternativeAppearances = m_defaultAppearances;
    } else {
        m_alternativeAppearances[0] = fileName;
    }
 
    m_usingDefaultAppearance = defaultAppearance;
    setPixmap(0);
}
 
void ElementAppearance::setAppearanceAt(const int index, const QString &fileName)
{
    if (index < 0 || index >= m_alternativeAppearances.size()) {
        return;
    }
 
    if (fileName.isEmpty()) {
        m_alternativeAppearances[index] = m_defaultAppearances.at(index);
    } else {
        m_alternativeAppearances[index] = fileName;
    }
 
    m_usingDefaultAppearance = (m_alternativeAppearances == m_defaultAppearances);
    setPixmap(index);
}
 
void ElementAppearance::setAlternativeAppearanceAt(const int index, const QString &path)
{
    if (index < 0 || index >= m_alternativeAppearances.size()) {
        return;
    }
    m_alternativeAppearances[index] = path;
}
 
void ElementAppearance::recomputeUsingDefault()
{
    m_usingDefaultAppearance = std::equal(
        m_defaultAppearances.begin(), m_defaultAppearances.end(),
        m_alternativeAppearances.begin(), m_alternativeAppearances.end()
        );
}
 
QStringList ElementAppearance::externalFiles() const
{
    QStringList result;
    for (int i = 0; i < m_alternativeAppearances.size() && i < m_defaultAppearances.size(); ++i) {
        const QString &appearance = m_alternativeAppearances.at(i);
        if (appearance != m_defaultAppearances.at(i) && !appearance.startsWith(":/")) {
            result.append(appearance);
        }
    }
    return result;
}
 
void ElementAppearance::render(QPainter *painter, const QRectF &boundingRect, const bool selected) const
{
    if (selected) {
        painter->save();
        painter->setBrush(m_selectionBrush);
        // 0.5 pen width keeps the selection outline thin regardless of zoom level
        painter->setPen(QPen(m_selectionPen, 0.5, Qt::SolidLine));
        // Corner radius of 5 matches the visual rounding used on element bodies
        painter->drawRoundedRect(boundingRect, 5, 5);
        painter->restore();
    }
 
    // Draw the body from vector data (crisp at any zoom) when the appearance is an SVG; fall back to
    // the rasterised pixmap for raster (PNG/JPG) appearances. DeviceCoordinateCache re-renders this
    // per zoom level, so the SVG stays sharp instead of scaling a fixed-size bitmap.
    if (m_svgRenderer && m_svgRenderer->isValid()) {
        painter->save();
        painter->setRenderHints(QPainter::Antialiasing | QPainter::TextAntialiasing |
                                QPainter::SmoothPixmapTransform, true);
        // Render into the SVG's native box at the origin — the same 0,0..defaultSize the raster occupied.
        m_svgRenderer->render(painter, QRectF(QPointF(0, 0), QSizeF(m_svgRenderer->defaultSize())));
        painter->restore();
    } else {
        // Pixmap origin is always (0,0) in item coordinates; the transform origin
        // (centre of the pixmap) is set separately via setTransformOriginPoint().
        painter->drawPixmap(QPoint(0, 0), m_pixmap);
    }
}
 
void ElementAppearance::applyTheme(const ThemeAttributes &theme)
{
    m_selectionBrush = theme.m_selectionBrush;
    m_selectionPen = theme.m_selectionPen;
}