toolmenumanager.cpp

/*
 * Copyright (c) 2024 Analog Devices Inc.
 *
 * This file is part of Scopy
 * (see https://www.github.com/analogdevicesinc/scopy).
 *
 * 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, either 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 for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program. If not, see <https://www.gnu.org/licenses/>.
 *
 */

#include "toolmenumanager.h"
#include <toolmenuitem.h>
#include <QLoggingCategory>
#include <pluginbase/preferences.h>
#include <QButtonGroup>
#include <baseheaderwidget.h>
#include <compositeheaderwidget.h>
#include <menuheader.h>
#include <style.h>

Q_LOGGING_CATEGORY(CAT_TOOLMENUMANAGER, "ToolMenuManager")
using namespace scopy;

ToolMenuManager::ToolMenuManager(ToolStack *ts, DetachedToolWindowManager *dtm, ToolMenu *toolMenu, QObject *parent)
	: QObject(parent)
	, m_ts(ts)
	, m_dtm(dtm)
	, m_toolMenu(toolMenu)
{}

ToolMenuManager::~ToolMenuManager() {}

void ToolMenuManager::addMenuItem(QString deviceId, QString devName, QList<ToolMenuEntry *> tools, int itemIndex)
{
	QString param;
	if(!tools.isEmpty())
		param = tools.at(0)->param();
	MenuSectionCollapseWidget *devSection = createMenuSectionItem(devName, param);
	QButtonGroup *menuBtnGroup = m_toolMenu->btnGroup();
	for(ToolMenuEntry *tme : tools) {
		ToolMenuItem *toolMenuItem = createToolMenuItem(tme, devSection);
		devSection->add(toolMenuItem);
		menuBtnGroup->addButton(toolMenuItem);
		connect(tme, &ToolMenuEntry::updateTool, this, &ToolMenuManager::updateTool);
		connect(tme, &ToolMenuEntry::updateToolAttached, this,
			[this, toolMenuItem](bool oldAttach) { updateToolAttached(oldAttach, toolMenuItem); });
		Q_EMIT tme->updateToolEntry();
	}
	m_toolMenu->add(itemIndex, deviceId, devSection);
	m_itemMap[deviceId] = devSection;
	qDebug(CAT_TOOLMENUMANAGER) << "Menu item with id" << deviceId << "has been added";
}

void ToolMenuManager::removeMenuItem(QString deviceId)
{
	if(!m_itemMap.contains(deviceId)) {
		qDebug(CAT_TOOLMENUMANAGER) << "No entry with id:" << deviceId;
		return;
	}
	MenuSectionCollapseWidget *devSection = m_itemMap[deviceId];
	m_itemMap.remove(deviceId);
	m_toolMenu->remove(devSection);
	delete devSection;
	devSection = nullptr;
	qDebug(CAT_TOOLMENUMANAGER) << "Menu item with id" << deviceId << "has been removed";
}

void ToolMenuManager::changeToolListContents(QString deviceId, QList<ToolMenuEntry *> tools)
{
	if(!m_itemMap.contains(deviceId)) {
		qDebug(CAT_TOOLMENUMANAGER) << "No entry with id:" << deviceId;
		return;
	}
	for(ToolMenuEntry *tme : tools) {
		tme->disconnect(this);
	}
	MenuSectionCollapseWidget *menuItem = m_itemMap[deviceId];
	QString devName = menuItem->collapseSection()->title();
	int itemIndex = m_toolMenu->indexOf(menuItem);
	removeMenuItem(deviceId);
	addMenuItem(deviceId, devName, tools, itemIndex);
	showMenuItem(deviceId);
	highlightCrtItem();
}

void ToolMenuManager::showMenuItem(QString id)
{
	if(!m_connectedDev.contains(m_prevItem)) {
		hideMenuItem(m_prevItem);
	}
	if(!m_itemMap.contains(id)) {
		// if the id is not a device id, it could be a tool id
		Q_EMIT requestToolSelect(id);
		return;
	}

	m_itemMap[id]->show();
	m_prevItem = id;
}

void ToolMenuManager::hideMenuItem(QString id)
{
	if(!m_itemMap.contains(id))
		return;
	m_itemMap[id]->hide();
}

void ToolMenuManager::deviceConnected(QString id)
{
	m_connectedDev.append(id);
	showMenuItem(id);
}

void ToolMenuManager::deviceDisconnected(QString id)
{
	m_connectedDev.removeAll(id);
	if(m_prevItem.compare(id) != 0) {
		hideMenuItem(id);
	}
}

void ToolMenuManager::onDisplayNameChanged(QString id, QString devName)
{
	m_itemMap[id]->collapseSection()->setTitle(devName);
}

void ToolMenuManager::updateTool(QWidget *old)
{

	ToolMenuEntry *tme = dynamic_cast<ToolMenuEntry *>(QObject::sender());
	Q_ASSERT(tme);
	QString id = tme->uuid();
	QWidget *tool = tme->tool();

	if(old != nullptr) { // we had a widget
		saveToolAttachedState(tme);
		if(m_ts->contains(id)) {
			m_ts->remove(id);
		}
		if(m_dtm->contains(id)) {
			m_dtm->remove(id);
		}
	}
	if(tool != nullptr) { // we have a new widget
		if(tme->attached()) {
			m_ts->add(id, tool);
		} else {
			m_dtm->add(id, tme);
		}
		loadToolAttachedState(tme);
	}
	qDebug(CAT_TOOLMENUMANAGER) << "updating tool for " << tme->name() << " - " << id;
}

void ToolMenuManager::updateToolAttached(bool oldAttach, ToolMenuItem *toolMenuItem)
{
	ToolMenuEntry *tme = dynamic_cast<ToolMenuEntry *>(QObject::sender());
	Q_ASSERT(tme);
	QWidget *tool = tme->tool();
	QString id = tme->uuid();

	if(tme->attached()) {
		// tool is detached, it will attach to the main window
		if(m_dtm->contains(id)) {
			m_dtm->remove(id);
		}
		m_ts->add(id, tool);
		attachSuccesful(toolMenuItem);
	} else {
		// tool is attached, it will detach
		if(m_ts->contains(id)) {
			m_ts->remove(id);
		}
		m_dtm->add(id, tme);
		detachSuccesful(toolMenuItem);
	}
	// by this time, the tool has changed it's state, either from attached to detached, or from detached to attached
	saveToolAttachedState(tme);
	showTool(toolMenuItem);

	// highlight the current tool from the main window
	if(tme->attached()) {
		// the selected tool just attached, so it will be at the top of the stack, therefore highlighted
		if(toolMenuItem) {
			toolMenuItem->setChecked(true);
		}
	}
}

void ToolMenuManager::highlightCrtItem()
{
	QWidget *crtStackWidget = m_ts->currentWidget();
	if(crtStackWidget) {
		QString id = m_ts->getKey(crtStackWidget);
		Q_EMIT toolStackChanged(id);
	}
}

void ToolMenuManager::loadToolAttachedState(ToolMenuEntry *tme)
{
	Preferences *p = Preferences::GetInstance();
	QString prefId;
	if(!p->get("general_save_attached").toBool())
		return;

	prefId = tme->id() + "_attached";
	p->init(prefId, tme->attached());
	bool attach = p->get(prefId).toBool();
	tme->setAttached(attach);
}

void ToolMenuManager::saveToolAttachedState(ToolMenuEntry *tme)
{
	Preferences *p = Preferences::GetInstance();
	if(!p->get("general_save_attached").toBool())
		return;
	QString prefId;
	prefId = tme->id() + "_attached";
	bool attach = tme->attached();
	p->set(prefId, attach);
}

void ToolMenuManager::detachSuccesful(ToolMenuItem *toolMenuItem)
{
	QButtonGroup *menuBtnGroup = m_toolMenu->btnGroup();
	if(toolMenuItem) {
		toolMenuItem->setCheckable(false);
		menuBtnGroup->removeButton(toolMenuItem);
	}
}

void ToolMenuManager::attachSuccesful(ToolMenuItem *toolMenuItem)
{
	QButtonGroup *menuBtnGroup = m_toolMenu->btnGroup();
	if(toolMenuItem) {
		toolMenuItem->setCheckable(true);
		menuBtnGroup->addButton(toolMenuItem);
	}
}

void ToolMenuManager::showTool(ToolMenuItem *toolMenuItem)
{
	if(toolMenuItem) {
		toolMenuItem->setChecked(true);
	}
	Q_EMIT requestToolSelect(toolMenuItem->getId());
}

void ToolMenuManager::setTmeAttached(ToolMenuEntry *tme)
{
	Preferences *p = Preferences::GetInstance();
	if(!p->get("general_doubleclick_attach").toBool())
		return;
	tme->setAttached(!tme->attached());
}

MenuSectionCollapseWidget *ToolMenuManager::createMenuSectionItem(QString deviceName, QString uri)
{
	MenuSectionCollapseWidget *section = new MenuSectionCollapseWidget(
		deviceName, MenuCollapseSection::MHCW_ARROW, MenuCollapseSection::MHW_COMPOSITEWIDGET, m_toolMenu);
	section->contentLayout()->setSpacing(0);
	section->menuSection()->layout()->setMargin(0);
	section->setSizePolicy(QSizePolicy::Expanding, QSizePolicy::Preferred);

	MenuCollapseHeader *collapseHeader = dynamic_cast<MenuCollapseHeader *>(section->collapseSection()->header());
	if(collapseHeader) {
		CompositeHeaderWidget *chw = dynamic_cast<CompositeHeaderWidget *>(collapseHeader->headerWidget());
		if(chw) {
			chw->add(new QLabel(uri, chw));
			chw->layout()->setContentsMargins(Style::getDimension(json::global::unit_1), 0, 0, 0);
		}
		Style::setStyle(collapseHeader, style::properties::widget::bottomBorder);
	}
	section->setCollapsed(false);
	section->hide();
	return section;
}

ToolMenuItem *ToolMenuManager::createToolMenuItem(ToolMenuEntry *tme, QWidget *parent)
{
	ToolMenuItem *toolMenuItem = new ToolMenuItem(tme->uuid(), tme->name(), tme->icon(), parent);
	connect(toolMenuItem->getToolRunBtn(), &QPushButton::toggled, tme, &ToolMenuEntry::runToggled);
	connect(toolMenuItem->getToolRunBtn(), &QPushButton::clicked, tme, &ToolMenuEntry::runClicked);
	connect(toolMenuItem, &QPushButton::clicked, this, [=]() { Q_EMIT requestToolSelect(toolMenuItem->getId()); });
	connect(toolMenuItem, &ToolMenuItem::doubleclick, this, [this, tme]() { setTmeAttached(tme); });
	connect(tme, &ToolMenuEntry::updateToolEntry, toolMenuItem, &ToolMenuItem::updateItem);
	connect(this, &ToolMenuManager::toolStackChanged, toolMenuItem, &ToolMenuItem::selectCrtItem);

	return toolMenuItem;
}

#include "moc_toolmenumanager.cpp"