Sourcetrail/src/lib_gui/qt/graphics/graph/QtGraphEdge.cpp

#include "QtGraphEdge.h"

#include <QCursor>
#include <QGraphicsSceneEvent>
#include <QGraphicsItemGroup>

#include "GraphViewStyle.h"
#include "Edge.h"
#include "TokenComponentAggregation.h"
#include "TokenComponentInheritanceChain.h"
#include "TokenComponentIsAmbiguous.h"
#include "QtLineItemAngled.h"
#include "QtLineItemBezier.h"
#include "QtLineItemStraight.h"
#include "QtGraphNode.h"
#include "MessageActivateEdge.h"
#include "MessageActivateTrailEdge.h"
#include "MessageFocusIn.h"
#include "MessageFocusOut.h"
#include "MessageGraphNodeBundleSplit.h"
#include "MessageGraphNodeHide.h"
#include "MessageTooltipShow.h"
#include "MessageTooltipHide.h"
#include "utility.h"

QtGraphEdge* QtGraphEdge::s_focusedEdge = nullptr;
QtGraphEdge* QtGraphEdge::s_focusedBezierEdge = nullptr;

QtGraphEdge::QtGraphEdge(
	QtGraphNode* owner,
	QtGraphNode* target,
	const Edge* data,
	size_t weight,
	bool isActive,
	bool isInteractive,
	bool horizontal,
	TokenComponentAggregation::Direction direction
)
	: m_data(data)
	, m_owner(owner)
	, m_target(target)
	, m_child(nullptr)
	, m_isActive(isActive)
	, m_isFocused(false)
	, m_isHorizontal(horizontal)
	, m_weight(weight)
	, m_direction(direction)
	, m_isTrailEdge(false)
	, m_useBezier(false)
	, m_isInteractive(isInteractive)
	, m_mousePos(0.0f, 0.0f)
	, m_mouseMoved(false)
{
	this->setCursor(Qt::PointingHandCursor);

	if (m_direction == TokenComponentAggregation::DIRECTION_BACKWARD)
	{
		QtGraphNode* temp = m_owner;
		m_owner = m_target;
		m_target = temp;
	}

	s_focusedEdge = nullptr;
	s_focusedBezierEdge = nullptr;
}

QtGraphEdge::~QtGraphEdge()
{
}

const Edge* QtGraphEdge::getData() const
{
	return m_data;
}

QtGraphNode* QtGraphEdge::getOwner()
{
	return m_owner;
}

QtGraphNode* QtGraphEdge::getTarget()
{
	return m_target;
}

Id QtGraphEdge::getTokenId() const
{
	if (getData())
	{
		return getData()->getId();
	}

	return 0;
}

void QtGraphEdge::updateLine()
{
	const QtGraphNode* owner = m_owner;
	const QtGraphNode* target = m_target;

	Edge::EdgeType type = (getData() ? getData()->getType() : Edge::EDGE_AGGREGATION);
	GraphViewStyle::EdgeStyle style =
		GraphViewStyle::getStyleForEdgeType(type, m_isActive | m_isFocused, false, m_isTrailEdge, isAmbiguous());

	Vec4i ownerRect = owner->getBoundingRect();
	Vec4i targetRect = target->getBoundingRect();

	Vec4i ownerParentRect;
	Vec4i targetParentRect;

	const QtGraphNode* ownerParent = owner->getLastParent();
	const QtGraphNode* targetParent = target->getLastParent();

	const QtGraphNode* ownerNonGroupParent = owner->getLastNonGroupParent();
	const QtGraphNode* targetNonGroupParent = target->getLastNonGroupParent();

	if (ownerParent == targetParent && ownerParent->isGroupNode())
	{
		ownerParentRect = ownerNonGroupParent->getBoundingRect();
		targetParentRect = targetNonGroupParent->getBoundingRect();
	}
	else
	{
		ownerParentRect = ownerParent->getBoundingRect();
		targetParentRect = targetParent->getBoundingRect();
	}

	QtLineItemBase::Route route = m_isHorizontal ? QtLineItemBase::ROUTE_HORIZONTAL : QtLineItemBase::ROUTE_VERTICAL;

	if (m_useBezier)
	{
		for (QGraphicsItem* item : childItems())
		{
			item->hide();
			item->setParentItem(nullptr);
		}

		style.originOffset.y() = 0;
		style.targetOffset.y() = 0;

		for (const Vec4i& rect : m_path)
		{
			QtLineItemBezier* bezier = new QtLineItemBezier(this);
			bezier->updateLine(ownerRect, rect, ownerParentRect, rect, style, m_weight, false);
			bezier->setRoute(route);

			QtLineItemStraight* line = new QtLineItemStraight(this);
			if (route == QtLineItemBase::ROUTE_HORIZONTAL)
			{
				line->updateLine(Vec2i(rect.x(), (rect.y() + rect.w()) / 2), Vec2i(rect.z(), (rect.y() + rect.w()) / 2), style);
			}
			else
			{
				line->updateLine(Vec2i((rect.x() + rect.z()) / 2, rect.y()), Vec2i((rect.x() + rect.z()) / 2, rect.w()), style);
			}

			ownerRect = rect;
			ownerParentRect = rect;
		}

		bool showArrow = m_direction != TokenComponentAggregation::DIRECTION_NONE;

		QtLineItemBezier* bezier = new QtLineItemBezier(this);
		bezier->updateLine(ownerRect, targetRect, ownerParentRect, targetParentRect, style, m_weight, showArrow);
		bezier->setRoute(route);

		if (ownerNonGroupParent == targetNonGroupParent)
		{
			if (ownerRect.y() < target->getBoundingRect().y())
			{
				bezier->setOnBack(true);
			}
			else
			{
				bezier->setOnFront(true);
			}
		}
	}
	else
	{
		const Vec2i* ownerColumnSize;
		const Vec2i* targetColumnSize;

		if (ownerParent != targetParent)
		{
			ownerColumnSize = &ownerParent->getColumnSize();
			targetColumnSize = &targetParent->getColumnSize();
		}
		else
		{
			ownerColumnSize = &ownerNonGroupParent->getColumnSize();
			targetColumnSize = &targetNonGroupParent->getColumnSize();
		}

		ownerParentRect.z = std::max(ownerParentRect.x + ownerColumnSize->x, ownerParentRect.z());
		targetParentRect.z = std::max(targetParentRect.x + targetColumnSize->x, targetParentRect.z());

		if (!m_child)
		{
			m_child = new QtLineItemAngled(this);
		}

		QtLineItemAngled* child = dynamic_cast<QtLineItemAngled*>(m_child);

		if (owner->getIsActive() && ownerNonGroupParent == targetNonGroupParent)
		{
			child->setOnBack(true);
		}

		if (target->getIsActive())
		{
			child->setEarlyBend(true);

			if (ownerNonGroupParent == targetNonGroupParent ||
				(type == Edge::EDGE_OVERRIDE &&
					targetParentRect.z() + style.targetOffset.x + style.originOffset.x > ownerParentRect.x()))
			{
				child->setOnFront(true);
			}
			else
			{
				child->setOnFront(false);
			}
		}

		// increase z-value for inheritance and specialization edges between members
		if ((type == Edge::EDGE_INHERITANCE || type == Edge::EDGE_TEMPLATE_SPECIALIZATION) &&
			(owner != ownerNonGroupParent || target != targetNonGroupParent))
		{
			if (style.zValue < 0)
			{
				style.zValue += 5;
			}
		}
		else if (type == Edge::EDGE_INHERITANCE || (type == Edge::EDGE_TEMPLATE_SPECIALIZATION &&
				owner == ownerNonGroupParent && target == targetNonGroupParent))
		{
			route = QtLineItemBase::ROUTE_VERTICAL;

			if (target->hasActiveChild())
			{
				child->setEarlyBend(true);
			}
		}
		else if (type != Edge::EDGE_AGGREGATION ||
			owner != ownerNonGroupParent || target != targetNonGroupParent)
		{
			route = QtLineItemBase::ROUTE_HORIZONTAL;
		}

		child->setRoute(route);

		bool showArrow = true;
		if (type == Edge::EDGE_AGGREGATION)
		{
			showArrow = m_direction != TokenComponentAggregation::DIRECTION_NONE;
		}

		if (getData())
		{
			TokenComponentInheritanceChain* componentInheritance = getData()->getComponent<TokenComponentInheritanceChain>();
			if (componentInheritance && componentInheritance->inheritanceEdgeIds.size() > 1)
			{
				style.dashed = true;
			}
		}

		child->updateLine(ownerRect, targetRect, ownerParentRect, targetParentRect, style, m_weight, showArrow);
	}

	this->setZValue(style.zValue);
}

bool QtGraphEdge::getIsActive() const
{
	return m_isActive;
}

void QtGraphEdge::setIsActive(bool isActive)
{
	if (m_isActive != isActive)
	{
		m_isActive = isActive;
		updateLine();
	}
}

void QtGraphEdge::setIsFocused(bool isFocused)
{
	if (m_isFocused != isFocused)
	{
		m_isFocused = isFocused;
		updateLine();
	}
}

void QtGraphEdge::onClick()
{
	if (!getData() || m_owner->isGroupNode() || m_target->isGroupNode())
	{
		QtGraphNode* node = (m_direction == TokenComponentAggregation::DIRECTION_BACKWARD ? m_owner : m_target);
		if (m_owner->isGroupNode())
		{
			node = m_owner;
		}
		else if (m_target->isGroupNode())
		{
			node = m_target;
		}

		MessageGraphNodeBundleSplit(node->getTokenId()).dispatch();
	}
	else if (isTrailEdge())
	{
		MessageActivateTrailEdge(
			{ getData()->getId() },
			getData()->getType(),
			getData()->getFrom()->getNameHierarchy(),
			getData()->getTo()->getNameHierarchy()
		).dispatch();
	}
	else
	{
		TokenComponentInheritanceChain* componentInheritance = getData()->getComponent<TokenComponentInheritanceChain>();

		MessageActivateEdge msg(
			getData()->getId(),
			componentInheritance ? Edge::EDGE_AGGREGATION : getData()->getType(),
			getData()->getFrom()->getNameHierarchy(),
			getData()->getTo()->getNameHierarchy()
		);

		if (getData()->getType() == Edge::EDGE_AGGREGATION)
		{
			msg.aggregationIds =
				utility::toVector<Id>(getData()->getComponent<TokenComponentAggregation>()->getAggregationIds());
		}
		else if (componentInheritance)
		{
			msg.aggregationIds = componentInheritance->inheritanceEdgeIds;
		}

		msg.dispatch();
	}
}

void QtGraphEdge::onHide()
{
	Id tokenId = getTokenId();

	if (tokenId)
	{
		MessageGraphNodeHide(tokenId).dispatch();
	}
}

void QtGraphEdge::focusIn()
{
	if (!m_isFocused)
	{
		m_isFocused = true;
		updateLine();

		if (s_focusedEdge == this)
		{
			Edge::EdgeType type = (getData() ? getData()->getType() : Edge::EDGE_AGGREGATION);

			TooltipInfo info;
			info.title = Edge::getReadableTypeString(type);

			if (isAmbiguous())
			{
				info.title = L"ambiguous " + info.title;
			}

			if (type == Edge::EDGE_AGGREGATION && m_direction == TokenComponentAggregation::DIRECTION_NONE)
			{
				info.title = L"bidirectional " + info.title;
			}

			if (type == Edge::EDGE_AGGREGATION)
			{
				info.count = m_weight;
				info.countText = "edge";
			}
			info.offset = Vec2i(10, 20);

			if (type == Edge::EDGE_INHERITANCE && getData())
			{
				TokenComponentInheritanceChain* componentInheritance = getData()->getComponent<TokenComponentInheritanceChain>();
				if (componentInheritance && componentInheritance->inheritanceEdgeIds.size() > 1)
				{
					info.title = L"multi-level " + info.title;
				}
			}

			MessageTooltipShow(info, TOOLTIP_ORIGIN_GRAPH).dispatch();
		}
	}
}

void QtGraphEdge::focusOut()
{
	if (m_isFocused)
	{
		m_isFocused = false;
		updateLine();

		if (s_focusedEdge == this)
		{
			MessageTooltipHide().dispatch();
		}
	}
}

void QtGraphEdge::mousePressEvent(QGraphicsSceneMouseEvent* event)
{
	m_mousePos = Vec2i(event->scenePos().x(), event->scenePos().y());
	m_mouseMoved = false;
}

void QtGraphEdge::mouseMoveEvent(QGraphicsSceneMouseEvent* event)
{
	Vec2i mousePos = Vec2i(event->scenePos().x(), event->scenePos().y());

	if ((mousePos - m_mousePos).getLength() > 1.0f)
	{
		m_mouseMoved = true;
	}
}

void QtGraphEdge::mouseReleaseEvent(QGraphicsSceneMouseEvent* event)
{
	if (!m_mouseMoved && m_isInteractive && event->button() == Qt::LeftButton)
	{
		if (event->modifiers() & Qt::AltModifier)
		{
			this->onHide();
		}
		else
		{
			this->onClick();
		}
	}
}

void QtGraphEdge::hoverEnterEvent(QGraphicsSceneHoverEvent* event)
{
	if (m_useBezier)
	{
		if (s_focusedBezierEdge && s_focusedBezierEdge != this)
		{
			s_focusedBezierEdge->focusOut();
		}

		s_focusedBezierEdge = this;
	}

	s_focusedEdge = this;

	if (getData() && !m_useBezier)
	{
		MessageFocusIn(std::vector<Id>(1, getData()->getId()), TOOLTIP_ORIGIN_GRAPH).dispatch();
	}
	else
	{
		focusIn();
	}
}

void QtGraphEdge::hoverLeaveEvent(QGraphicsSceneHoverEvent* event)
{
	s_focusedBezierEdge = nullptr;

	if (getData() && !m_useBezier)
	{
		MessageFocusOut(std::vector<Id>(1, getData()->getId())).dispatch();
	}
	else
	{
		focusOut();
	}

	s_focusedEdge = nullptr;
}

void QtGraphEdge::setDirection(TokenComponentAggregation::Direction direction)
{
	if (m_direction != direction)
	{
		m_direction = direction;
		updateLine();
	}
}

bool QtGraphEdge::isTrailEdge() const
{
	return m_isTrailEdge;
}

void QtGraphEdge::setIsTrailEdge(std::vector<Vec4i> path, bool horizontal)
{
	m_path = path;
	m_isTrailEdge = true;
	m_useBezier = true;
	m_isHorizontal = horizontal;
}

void QtGraphEdge::setUseBezier(bool useBezier)
{
	m_useBezier = useBezier;
	m_isHorizontal = true;
}

void QtGraphEdge::clearPath()
{
	m_path.clear();
}

bool QtGraphEdge::isAmbiguous() const
{
	return m_data && m_data->getComponent<TokenComponentIsAmbiguous>();
}