sdrangel/sdrgui/channel/channelgui.cpp

///////////////////////////////////////////////////////////////////////////////////
// Copyright (C) 2012 maintech GmbH, Otto-Hahn-Str. 15, 97204 Hoechberg, Germany //
// written by Christian Daniel                                                   //
// Copyright (C) 2015-2020, 2022 Edouard Griffiths, F4EXB <f4exb06@gmail.com>    //
// Copyright (C) 2022-2023 Jon Beniston, M7RCE <jon@beniston.com>                //
//                                                                               //
// This program is free software; you can redistribute it and/or modify          //
// it under the terms of the GNU General Public License as published by          //
// the Free Software Foundation as version 3 of the License, or                  //
// (at your option) any later version.                                           //
//                                                                               //
// This program is distributed in the hope that it will be useful,               //
// but WITHOUT ANY WARRANTY; without even the implied warranty of                //
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the                  //
// GNU General Public License V3 for more details.                               //
//                                                                               //
// You should have received a copy of the GNU General Public License             //
// along with this program. If not, see <http://www.gnu.org/licenses/>.          //
///////////////////////////////////////////////////////////////////////////////////

#include <QCloseEvent>
#include <QStyle>
#include <QLabel>
#include <QPushButton>
#include <QVBoxLayout>
#include <QHBoxLayout>
#include <QSizeGrip>
#include <QTextEdit>
#include <QObjectCleanupHandler>
#include <QDesktopServices>
#include <QOpenGLWidget>
#include <QMdiArea>

#include "mainwindow.h"
#include "gui/workspaceselectiondialog.h"
#include "gui/devicesetselectiondialog.h"
#include "gui/rollupcontents.h"
#include "gui/dialogpositioner.h"

#include "channelgui.h"

ChannelGUI::ChannelGUI(QWidget *parent) :
    QMdiSubWindow(parent),
    m_resizer(this),
    m_contextMenuType(ContextMenuType::ContextMenuNone),
    m_deviceType(DeviceType::DeviceRx),
    m_deviceSetIndex(0),
    m_channelIndex(0),
    m_drag(false),
    m_disableResize(false),
    m_mdi(nullptr)
{
    qDebug("ChannelGUI::ChannelGUI");
    setWindowFlags(windowFlags() | Qt::FramelessWindowHint);
    setObjectName("ChannelGUI");
    setStyleSheet(QString(tr("#ChannelGUI { border: 1px solid %1; background-color: %2; }")
        .arg(palette().highlight().color().darker(115).name())
        .arg(palette().dark().color().darker(115).name())));

    m_indexLabel = new QLabel();
    m_indexLabel->setFixedSize(50, 16);
    m_indexLabel->setStyleSheet("QLabel { background-color: rgb(128, 128, 128); qproperty-alignment: AlignCenter; }");
    m_indexLabel->setText(tr("X%1:%2").arg(m_deviceSetIndex).arg(m_channelIndex));
    m_indexLabel->setToolTip("Channel index");

    m_settingsButton = new QPushButton();
    m_settingsButton->setFixedSize(20, 20);
    QIcon settingsIcon(":/gear.png");
    m_settingsButton->setIcon(settingsIcon);
    m_settingsButton->setToolTip("Common settings");

    m_titleLabel = new QLabel();
    m_titleLabel->setText("Channel");
    m_titleLabel->setToolTip("Channel name");
    m_titleLabel->setFixedHeight(20);
    m_titleLabel->setMinimumWidth(20);
    m_titleLabel->setSizePolicy(QSizePolicy::Expanding,QSizePolicy::Fixed);

    m_helpButton = new QPushButton();
    m_helpButton->setFixedSize(20, 20);
    QIcon helpIcon(":/help.png");
    m_helpButton->setIcon(helpIcon);
    m_helpButton->setToolTip("Show channel documentation in browser");

    m_moveButton = new QPushButton();
    m_moveButton->setFixedSize(20, 20);
    QIcon moveIcon(":/exit.png");
    m_moveButton->setIcon(moveIcon);
    m_moveButton->setToolTip("Move to another workspace");

    m_shrinkButton = new QPushButton();
    m_shrinkButton->setFixedSize(20, 20);
    QIcon shrinkIcon(":/shrink.png");
    m_shrinkButton->setIcon(shrinkIcon);
    m_shrinkButton->setToolTip("Adjust window to minimum size");

    m_maximizeButton = new QPushButton();
    m_maximizeButton->setFixedSize(20, 20);
    QIcon maximizeIcon(":/maximize.png");
    m_maximizeButton->setIcon(maximizeIcon);
    m_maximizeButton->setToolTip("Adjust window to maximum size in workspace");

    m_hideButton = new QPushButton();
    m_hideButton->setFixedSize(20, 20);
    QIcon hideIcon(":/hide.png");
    m_hideButton->setIcon(hideIcon);
    m_hideButton->setToolTip("Hide channel");

    m_closeButton = new QPushButton();
    m_closeButton->setFixedSize(20, 20);
    QIcon closeIcon(":/cross.png");
    m_closeButton->setIcon(closeIcon);
    m_closeButton->setToolTip("Close channel");

    m_duplicateButton = new QPushButton();
    m_duplicateButton->setFixedSize(20, 20);
    QIcon m_duplicateIcon(":/duplicate.png");
    m_duplicateButton->setIcon(m_duplicateIcon);
    m_duplicateButton->setToolTip("Duplicate channel");

    m_moveToDeviceButton = new QPushButton();
    m_moveToDeviceButton->setFixedSize(20, 20);
    QIcon moveRoundIcon(":/exit_round.png");
    m_moveToDeviceButton->setIcon(moveRoundIcon);
    m_moveToDeviceButton->setToolTip("Move to another device");

    m_statusFrequency = new QLabel();
    m_statusFrequency->setAlignment(Qt::AlignRight |Qt::AlignVCenter);
    m_statusFrequency->setFixedHeight(20);
    m_statusFrequency->setFixedWidth(90);
    m_statusFrequency->setSizePolicy(QSizePolicy::Fixed,QSizePolicy::Fixed);
    m_statusFrequency->setText(tr("%L1").arg(0));
    m_statusFrequency->setToolTip("Channel absolute frequency (Hz)");

    m_statusLabel = new QLabel();
    m_statusLabel->setFixedHeight(20);
    m_statusLabel->setMinimumWidth(20);
    m_statusLabel->setContentsMargins(10, 0, 0, 0); // Add space between statusFrequency and statusLabel
    m_statusLabel->setSizePolicy(QSizePolicy::Expanding,QSizePolicy::Fixed);
    m_statusLabel->setToolTip("Channel status");

    m_layouts = new QVBoxLayout();
    m_layouts->setContentsMargins(m_resizer.m_gripSize, m_resizer.m_gripSize, m_resizer.m_gripSize, m_resizer.m_gripSize);
    m_layouts->setSpacing(0);

    m_topLayout = new QHBoxLayout();
    m_topLayout->setContentsMargins(0, 0, 0, 0);
    m_topLayout->addWidget(m_indexLabel);
    m_topLayout->addWidget(m_settingsButton);
    m_topLayout->addWidget(m_titleLabel);
    m_topLayout->addWidget(m_helpButton);
    m_topLayout->addWidget(m_moveButton);
    m_topLayout->addWidget(m_shrinkButton);
    m_topLayout->addWidget(m_maximizeButton);
    m_topLayout->addWidget(m_hideButton);
    m_topLayout->addWidget(m_closeButton);

    m_centerLayout = new QHBoxLayout();
    m_centerLayout->setContentsMargins(0, 0, 0, 0);
    m_rollupContents = new RollupContents(); // Do not delete! Done in child's destructor with "delete ui"
    m_centerLayout->addWidget(m_rollupContents);

    m_bottomLayout = new QHBoxLayout();
    m_bottomLayout->setContentsMargins(0, 0, 0, 0);
    m_bottomLayout->addWidget(m_duplicateButton);
    m_bottomLayout->addWidget(m_moveToDeviceButton);
    m_bottomLayout->addWidget(m_statusFrequency);
    m_bottomLayout->addWidget(m_statusLabel);
    m_sizeGripBottomRight = new QSizeGrip(this);
    m_sizeGripBottomRight->setSizePolicy(QSizePolicy::Fixed, QSizePolicy::Fixed);
    m_sizeGripBottomRight->setFixedHeight(20);
    m_bottomLayout->addWidget(m_sizeGripBottomRight, 0, Qt::AlignBottom | Qt::AlignRight);

    m_layouts->addLayout(m_topLayout);
    m_layouts->addLayout(m_centerLayout);
    m_layouts->addLayout(m_bottomLayout);

    QObjectCleanupHandler().add(layout());
    setLayout(m_layouts);

    connect(m_settingsButton, SIGNAL(clicked()), this, SLOT(activateSettingsDialog()));
    connect(m_helpButton, SIGNAL(clicked()), this, SLOT(showHelp()));
    connect(m_moveButton, SIGNAL(clicked()), this, SLOT(openMoveToWorkspaceDialog()));
    connect(m_shrinkButton, SIGNAL(clicked()), this, SLOT(shrinkWindow()));
    connect(m_maximizeButton, SIGNAL(clicked()), this, SLOT(maximizeWindow()));
    connect(this, SIGNAL(forceShrink()), this, SLOT(shrinkWindow()));
    connect(m_hideButton, SIGNAL(clicked()), this, SLOT(hide()));
    connect(m_closeButton, SIGNAL(clicked()), this, SLOT(close()));
    connect(m_duplicateButton, SIGNAL(clicked()), this, SLOT(duplicateChannel()));
    connect(m_moveToDeviceButton, SIGNAL(clicked()), this, SLOT(openMoveToDeviceSetDialog()));

    connect(
        m_rollupContents,
        &RollupContents::widgetRolled,
        this,
        &ChannelGUI::onWidgetRolled
    );
}

ChannelGUI::~ChannelGUI()
{
    qDebug("ChannelGUI::~ChannelGUI");
    delete m_sizeGripBottomRight;
    delete m_bottomLayout;
    delete m_centerLayout;
    delete m_topLayout;
    delete m_layouts;
    delete m_statusLabel;
    delete m_statusFrequency;
    delete m_moveToDeviceButton;
    delete m_duplicateButton;
    delete m_closeButton;
    delete m_hideButton;
    delete m_shrinkButton;
    delete m_maximizeButton;
    delete m_moveButton;
    delete m_helpButton;
    delete m_titleLabel;
    delete m_settingsButton;
    delete m_indexLabel;
    qDebug("ChannelGUI::~ChannelGUI: end");
}

void ChannelGUI::closeEvent(QCloseEvent *event)
{
    qDebug("ChannelGUI::closeEvent");
    emit closing();
    event->accept();
}

void ChannelGUI::mousePressEvent(QMouseEvent* event)
{
    if ((event->button() == Qt::LeftButton) && isOnMovingPad())
    {
        m_drag = true;
        m_DragPosition = event->globalPos() - pos();
        event->accept();
    }
    else
    {
        m_resizer.mousePressEvent(event);
    }
}

void ChannelGUI::mouseReleaseEvent(QMouseEvent* event)
{
    m_resizer.mouseReleaseEvent(event);
}

void ChannelGUI::mouseMoveEvent(QMouseEvent* event)
{
    if ((event->buttons() & Qt::LeftButton) && isOnMovingPad())
    {
        move(event->globalPos() - m_DragPosition);
        event->accept();
    }
    else
    {
        m_resizer.mouseMoveEvent(event);
    }
}

void ChannelGUI::leaveEvent(QEvent* event)
{
    m_resizer.leaveEvent(event);
    QMdiSubWindow::leaveEvent(event);
}

void ChannelGUI::activateSettingsDialog()
{
    QPoint p = QCursor::pos();
    m_contextMenuType = ContextMenuType::ContextMenuChannelSettings;
    emit customContextMenuRequested(p);
}

void ChannelGUI::showHelp() const
{
    if (m_helpURL.isEmpty()) {
        return;
    }

    QString url;

    if (m_helpURL.startsWith("http")) {
        url = m_helpURL;
    } else {
        url = QString("https://github.com/f4exb/sdrangel/blob/master/%1").arg(m_helpURL); // Something like "plugins/channelrx/chanalyzer/readme.md"
    }

    QDesktopServices::openUrl(QUrl(url));
}

void ChannelGUI::openMoveToWorkspaceDialog()
{
    int numberOfWorkspaces = MainWindow::getInstance()->getNumberOfWorkspaces();
    WorkspaceSelectionDialog dialog(numberOfWorkspaces, getWorkspaceIndex(), this);
    dialog.exec();

    if (dialog.hasChanged()) {
        emit moveToWorkspace(dialog.getSelectedIndex());
    }
}

void ChannelGUI::onWidgetRolled(QWidget *widget, bool show)
{
    sizeToContents();  // set min/max constraints before trying to resize

    // When a window is maximized or returns from maximized to normal,
    // RolledContents gets QEvent::Hide and QEvent::Show events, which results in
    // onWidgetRolled being called twice.
    // We need to make sure we don't save widget heights while this occurs. The
    // window manager will take care of maximizing/restoring the window size.
    // We do need to resize when a widget is rolled up, but we also need to avoid
    // resizing when a window is maximized when first shown in tabbed layout
    if (!m_disableResize && !isMaximized())
    {
        if (show)
        {
            int dh = m_heightsMap.contains(widget) ? m_heightsMap[widget] - widget->height() : widget->minimumHeight();
            resize(width(), 52 + 3 + m_rollupContents->height() + dh);
        }
        else
        {
            m_heightsMap[widget] = widget->height();
            resize(width(), 52 + 3 + m_rollupContents->height());
        }
    }
}

// Size the window according to the size of rollup widget
void ChannelGUI::sizeToContents()
{
    // Adjust policy depending on which widgets are currently visible
    if (getRollupContents()->hasExpandableWidgets()) {
        setSizePolicy(getRollupContents()->sizePolicy().horizontalPolicy(), QSizePolicy::Expanding);
    } else {
        setSizePolicy(getRollupContents()->sizePolicy().horizontalPolicy(), QSizePolicy::Fixed);
    }

    // If size policy is fixed, hide widgets that resize the window
    if ((sizePolicy().verticalPolicy() == QSizePolicy::Fixed) && (sizePolicy().horizontalPolicy() == QSizePolicy::Fixed))
    {
        m_shrinkButton->hide();
        m_maximizeButton->hide();
        m_sizeGripBottomRight->hide();
    }
    else if ((sizePolicy().verticalPolicy() == QSizePolicy::Fixed) || (sizePolicy().horizontalPolicy() == QSizePolicy::Fixed))
    {
        m_shrinkButton->show();
        m_maximizeButton->hide();
        m_sizeGripBottomRight->show();
    }
    else
    {
        m_shrinkButton->show();
        m_maximizeButton->show();
        m_sizeGripBottomRight->show();
    }

    // Calculate min/max size for window. This is min/max size of contents, plus
    // extra needed for window frame and title bar
    QSize size;
    size = getRollupContents()->maximumSize();
    size.setHeight(std::min(size.height() + getAdditionalHeight(), QWIDGETSIZE_MAX));
    size.setWidth(std::min(size.width() + m_resizer.m_gripSize * 2, QWIDGETSIZE_MAX));
    setMaximumSize(size);

    // m_resizer uses minimumSizeHint(), m_sizeGripBottomRight uses minimumSize()
    // QWidget docs says: If minimumSize() is set, the minimum size hint will be ignored.
    // However, we use maximum of both:
    //  - minimumSize.width() to respect minimumWidth set in .ui file
    //  - minimumSizeHint.width() to ensure widgets are fully displayed when larger than above
    //    which may be the case when we have widgets hidden in a rollup, as the width
    //    set in .ui file may just be for the smallest of widgets
    size = getRollupContents()->minimumSize();
    size = size.expandedTo(getRollupContents()->minimumSizeHint());
    size = size.expandedTo(m_topLayout->minimumSize());
    size.setHeight(size.height() + getAdditionalHeight());
    size.setWidth(size.width() + m_resizer.m_gripSize * 2);
    setMinimumSize(size);

    // Restrict size of window to size of desktop
    DialogPositioner::sizeToDesktop(this);
}

void ChannelGUI::duplicateChannel()
{
    emit duplicateChannelEmitted();
}

void ChannelGUI::openMoveToDeviceSetDialog()
{
    DeviceSetSelectionDialog dialog(MainWindow::getInstance()->getDeviceUISets(), m_deviceSetIndex, this);
    dialog.exec();

    if (dialog.hasChanged() && (dialog.getSelectedIndex() != m_deviceSetIndex)) {
        emit moveToDeviceSet(dialog.getSelectedIndex());
    }
}

void ChannelGUI::maximizeWindow()
{
    // If maximize is pressed when maximized, go full screen
    if (isMaximized())
    {
        m_mdi = mdiArea();
        if (m_mdi) {
            m_mdi->removeSubWindow(this);
        }
        showNormal(); // If we don't go back to normal first, window doesn't get bigger
        showFullScreen();
        m_shrinkButton->setToolTip("Adjust window to maximum size in workspace");
    }
    else
    {
        m_disableResize = true;
        showMaximized();
        m_shrinkButton->setToolTip("Restore window to normal");
        m_maximizeButton->setToolTip("Make window full screen");
        m_disableResize = false;
        // QOpenGLWidget widgets don't always paint properly first time after being maximized,
        // so force an update. Should really fix why they aren't painted properly in the first place
        QList<QOpenGLWidget *> widgets = findChildren<QOpenGLWidget *>();
        for (auto widget : widgets) {
            widget->update();
        }
    }
}

void ChannelGUI::shrinkWindow()
{
    qDebug("ChannelGUI::shrinkWindow");
    // If m_normalParentWidget, window was made full screen
    if (m_mdi)
    {
        m_disableResize = true;
        showNormal();
        m_mdi->addSubWindow(this);
        show();
        showMaximized();
        m_shrinkButton->setToolTip("Restore window to normal");
        m_disableResize = false;
        m_mdi = nullptr;
    }
    else if (isMaximized())
    {
        m_disableResize = true;
        showNormal();
        m_shrinkButton->setToolTip("Adjust window to minimum size");
        m_maximizeButton->setToolTip("Adjust window to maximum size in workspace");
        m_disableResize = false;
    }
    else
    {
        adjustSize();
    }
}

void ChannelGUI::setTitle(const QString& title)
{
    m_titleLabel->setText(title);
}

void ChannelGUI::setTitleColor(const QColor& c)
{
    m_indexLabel->setStyleSheet(tr("QLabel { background-color: %1; color: %2; }")
        .arg(c.name())
        .arg(getTitleColor(c).name())
    );
}

void ChannelGUI::setDeviceType(DeviceType type)
{
    m_deviceType = type;
    updateIndexLabel();
}

void ChannelGUI::setDisplayedame(const QString& name)
{
    m_displayedName = name;
}

void ChannelGUI::setIndexToolTip(const QString& tooltip)
{
    m_indexLabel->setToolTip(tr("%1 / %2").arg(tooltip).arg(m_displayedName));
}

void ChannelGUI::setIndex(int index)
{
    m_channelIndex = index;
    updateIndexLabel();
}

void ChannelGUI::setDeviceSetIndex(int index)
{
    m_deviceSetIndex = index;
    updateIndexLabel();
}

void ChannelGUI::setStatusFrequency(qint64 frequency)
{
    m_statusFrequency->setText(tr("%L1").arg(frequency));
}

void ChannelGUI::setStatusText(const QString& text)
{
    m_statusLabel->setText(text);
}

void ChannelGUI::updateIndexLabel()
{
    if ((m_deviceType == DeviceType::DeviceMIMO) && (getStreamIndex() >= 0)) {
        m_indexLabel->setText(tr("%1%2:%3.%4").arg(getDeviceTypeTag()).arg(m_deviceSetIndex).arg(m_channelIndex).arg(getStreamIndex()));
    }
    else {
        m_indexLabel->setText(tr("%1%2:%3").arg(getDeviceTypeTag()).arg(m_deviceSetIndex).arg(m_channelIndex));
    }
}

bool ChannelGUI::isOnMovingPad() const
{
    return m_indexLabel->underMouse() || m_titleLabel->underMouse() || m_statusFrequency->underMouse() || m_statusLabel->underMouse();
}

void ChannelGUI::setHighlighted(bool highlighted)
{
    setStyleSheet(QString(tr("#ChannelGUI { border: 1px solid %1; background-color: %2; }")
        .arg(highlighted ? "#FFFFFF" : palette().highlight().color().darker(115).name())
        .arg(palette().dark().color().darker(115).name())));
}

QString ChannelGUI::getDeviceTypeTag() const
{
    switch (m_deviceType)
    {
        case DeviceType::DeviceRx:
            return "R";
        case DeviceType::DeviceTx:
            return "T";
        case DeviceType::DeviceMIMO:
            return "M";
        default:
            return "X";
    }
}

QColor ChannelGUI::getTitleColor(const QColor& backgroundColor)
{
    double l = 0.2126*backgroundColor.redF() + 0.7152*backgroundColor.greenF() + 0.0722*backgroundColor.blueF();
    return l < 0.5 ? Qt::white : Qt::black;
}