[pulseview.git] / pv / views / trace / cursorpair.cpp

/*
 * This file is part of the PulseView project.
 *
 * Copyright (C) 2013 Joel Holdsworth <joel@airwebreathe.org.uk>
 *
 * 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 2 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 <http://www.gnu.org/licenses/>.
 */

#include <algorithm>
#include <cassert>

#include <QColor>
#include <QMenu>
#include <QToolTip>

#include "cursorpair.hpp"

#include "pv/globalsettings.hpp"
#include "pv/util.hpp"
#include "ruler.hpp"
#include "view.hpp"

using std::max;
using std::make_pair;
using std::min;
using std::shared_ptr;
using std::pair;

namespace pv {
namespace views {
namespace trace {

const int CursorPair::DeltaPadding = 8;

CursorPair::CursorPair(View &view) :
	TimeItem(view),
	first_(new Cursor(view, 0.0)),
	second_(new Cursor(view, 1.0)),
	label_incomplete_(true)
{
	GlobalSettings::add_change_handler(this);

	GlobalSettings settings;
	fill_color_ = QColor::fromRgba(settings.value(
		GlobalSettings::Key_View_CursorFillColor).value<uint32_t>());
	show_frequency_ = settings.value(
		GlobalSettings::Key_View_CursorShowFrequency).value<bool>();
	show_interval_ = settings.value(
		GlobalSettings::Key_View_CursorShowInterval).value<bool>();
	show_samples_ = settings.value(
		GlobalSettings::Key_View_CursorShowSamples).value<bool>();

	connect(&view_, SIGNAL(hover_point_changed(const QWidget*, QPoint)),
		this, SLOT(on_hover_point_changed(const QWidget*, QPoint)));
}

CursorPair::~CursorPair()
{
	GlobalSettings::remove_change_handler(this);
}

bool CursorPair::enabled() const
{
	return view_.cursors_shown();
}

shared_ptr<Cursor> CursorPair::first() const
{
	return first_;
}

shared_ptr<Cursor> CursorPair::second() const
{
	return second_;
}

void CursorPair::set_time(const pv::util::Timestamp& time)
{
	const pv::util::Timestamp delta = second_->time() - first_->time();
	first_->set_time(time);
	second_->set_time(time + delta);
}

const pv::util::Timestamp CursorPair::time() const
{
	return 0;
}

float CursorPair::get_x() const
{
	return (first_->get_x() + second_->get_x()) / 2.0f;
}

const pv::util::Timestamp CursorPair::delta(const pv::util::Timestamp& other) const
{
	if (other < second_->time())
		return other - first_->time();
	else
		return other - second_->time();
}

QPoint CursorPair::drag_point(const QRect &rect) const
{
	return first_->drag_point(rect);
}

pv::widgets::Popup* CursorPair::create_popup(QWidget *parent)
{
	(void)parent;
	return nullptr;
}

QMenu *CursorPair::create_header_context_menu(QWidget *parent)
{
	QMenu *menu = new QMenu(parent);

	QAction *displayIntervalAction = new QAction(tr("Display interval"), this);
	displayIntervalAction->setCheckable(true);
	displayIntervalAction->setChecked(show_interval_);
	menu->addAction(displayIntervalAction);

	connect(displayIntervalAction, &QAction::toggled, displayIntervalAction,
		[=]{
			GlobalSettings settings;
			settings.setValue(GlobalSettings::Key_View_CursorShowInterval,
				!settings.value(GlobalSettings::Key_View_CursorShowInterval).value<bool>());
		});

	QAction *displayFrequencyAction = new QAction(tr("Display frequency"), this);
	displayFrequencyAction->setCheckable(true);
	displayFrequencyAction->setChecked(show_frequency_);
	menu->addAction(displayFrequencyAction);

	connect(displayFrequencyAction, &QAction::toggled, displayFrequencyAction,
		[=]{
			GlobalSettings settings;
			settings.setValue(GlobalSettings::Key_View_CursorShowFrequency,
				!settings.value(GlobalSettings::Key_View_CursorShowFrequency).value<bool>());
		});

	QAction *displaySamplesAction = new QAction(tr("Display samples"), this);
	displaySamplesAction->setCheckable(true);
	displaySamplesAction->setChecked(show_samples_);
	menu->addAction(displaySamplesAction);

	connect(displaySamplesAction, &QAction::toggled, displaySamplesAction,
		[=]{
			GlobalSettings settings;
			settings.setValue(GlobalSettings::Key_View_CursorShowSamples,
				!settings.value(GlobalSettings::Key_View_CursorShowSamples).value<bool>());
		});

	return menu;
}

QRectF CursorPair::label_rect(const QRectF &rect) const
{
	const QSizeF label_size(text_size_ + LabelPadding * 2);
	const pair<float, float> offsets(get_cursor_offsets());
	const pair<float, float> normal_offsets(
		(offsets.first < offsets.second) ? offsets :
		make_pair(offsets.second, offsets.first));

	const float height = label_size.height();
	const float left = max(normal_offsets.first + DeltaPadding, -height);
	const float right = min(normal_offsets.second - DeltaPadding,
		(float)rect.width() + height);

	return QRectF(left, rect.height() - label_size.height() -
		TimeMarker::ArrowSize - 0.5f,
		right - left, height);
}

void CursorPair::paint_label(QPainter &p, const QRect &rect, bool hover)
{
	assert(first_);
	assert(second_);

	if (!enabled())
		return;

	const QColor text_color = ViewItem::select_text_color(Cursor::FillColor);
	p.setPen(text_color);

	QRectF delta_rect(label_rect(rect));
	const int radius = delta_rect.height() / 2;
	QRectF text_rect(delta_rect.intersected(rect).adjusted(radius, 0, -radius, 0));

	QString text = format_string(text_rect.width(),
		[&p](const QString& s) -> double { return p.boundingRect(QRectF(), 0, s).width(); });

	text_size_ = p.boundingRect(QRectF(), 0, text).size();

	/* Currently, selecting the middle section between two cursors doesn't do
	 * anything, so don't highlight it when selected
	if (selected()) {
		p.setBrush(Qt::transparent);
		p.setPen(highlight_pen());
		p.drawRoundedRect(delta_rect, radius, radius);
	} */

	p.setBrush(hover ? Cursor::FillColor.lighter() : Cursor::FillColor);
	p.setPen(Cursor::FillColor.darker());
	p.drawRoundedRect(delta_rect, radius, radius);

	delta_rect.adjust(1, 1, -1, -1);
	p.setPen(Cursor::FillColor.lighter());
	const int highlight_radius = delta_rect.height() / 2 - 2;
	p.drawRoundedRect(delta_rect, highlight_radius, highlight_radius);
	label_area_ = delta_rect;

	p.setPen(text_color);
	p.drawText(text_rect, Qt::AlignCenter | Qt::AlignVCenter, text);
}

void CursorPair::paint_back(QPainter &p, ViewItemPaintParams &pp)
{
	if (!enabled())
		return;

	p.setPen(Qt::NoPen);
	p.setBrush(fill_color_);

	const pair<float, float> offsets(get_cursor_offsets());
	const int l = (int)max(min(offsets.first, offsets.second), 0.0f);
	const int r = (int)min(max(offsets.first, offsets.second), (float)pp.width());

	p.drawRect(l, pp.top(), r - l, pp.height());
}

QString CursorPair::format_string(int max_width, std::function<double(const QString&)> query_size)
{
	int time_precision = 12;
	int freq_precision = 12;

	QString s = format_string_sub(time_precision, freq_precision);

	// Try full "{time} s / {freq} Hz" format
	if ((max_width <= 0) || (query_size(s) <= max_width)) {
		label_incomplete_ = false;
		return s;
	}

	label_incomplete_ = true;

	// Gradually reduce time precision to match frequency precision
	while (time_precision > freq_precision) {
		time_precision--;

		s = format_string_sub(time_precision, freq_precision);
		if (query_size(s) <= max_width)
			return s;
	}

	// Gradually reduce both precisions down to zero
	while (time_precision > 0) {
		time_precision--;
		freq_precision--;

		s = format_string_sub(time_precision, freq_precision);
		if (query_size(s) <= max_width)
			return s;
	}

	// Try no trailing digits and drop the unit to at least display something
	s = format_string_sub(0, 0, false);

	if (query_size(s) <= max_width)
		return s;

	// Give up
	return "...";
}

pair<float, float> CursorPair::get_cursor_offsets() const
{
	assert(first_);
	assert(second_);

	return pair<float, float>(first_->get_x(), second_->get_x());
}

void CursorPair::on_setting_changed(const QString &key, const QVariant &value)
{
	if (key == GlobalSettings::Key_View_CursorFillColor)
		fill_color_ = QColor::fromRgba(value.value<uint32_t>());

	if (key == GlobalSettings::Key_View_CursorShowFrequency)
		show_frequency_ = value.value<bool>();

	if (key == GlobalSettings::Key_View_CursorShowInterval)
		show_interval_ = value.value<bool>();

	if (key == GlobalSettings::Key_View_CursorShowSamples)
		show_samples_ = value.value<bool>();
}

void CursorPair::on_hover_point_changed(const QWidget* widget, const QPoint& hp)
{
	if (widget != view_.ruler())
		return;

	if (!label_incomplete_)
		return;

	if (label_area_.contains(hp))
		QToolTip::showText(view_.mapToGlobal(hp), format_string());
	else
		QToolTip::hideText();  // TODO Will break other tooltips when there can be others
}

QString CursorPair::format_string_sub(int time_precision, int freq_precision, bool show_unit)
{
	QString s = " ";

	const pv::util::SIPrefix prefix = view_.tick_prefix();
	const pv::util::Timestamp diff = abs(second_->time() - first_->time());

	const QString time = Ruler::format_time_with_distance(
		diff, diff, prefix, (show_unit ? view_.time_unit() : pv::util::TimeUnit::None),
		time_precision, false);

	// We can only show a frequency when there's a time base
	if (view_.time_unit() == pv::util::TimeUnit::Time) {
		int items = 0;

		if (show_frequency_) {
			const QString freq = util::format_value_si(
				1 / diff.convert_to<double>(), pv::util::SIPrefix::unspecified,
				freq_precision, (show_unit ? "Hz" : nullptr), false);
			s = QString("%1").arg(freq);
			items++;
		}

		if (show_interval_) {
			if (items > 0)
				s = QString("%1 / %2").arg(s, time);
			else
				s = QString("%1").arg(time);
			items++;
		}

		if (show_samples_) {
			const QString samples = QString::number(
				(diff * view_.session().get_samplerate()).convert_to<uint64_t>());
			if (items > 0)
				s = QString("%1 / %2").arg(s, samples);
			else
				s = QString("%1").arg(samples);
		}
	} else
		// In this case, we return the number of samples, really
		s = time;

	return s;
}

} // namespace trace
} // namespace views
} // namespace pv
Commit	Line	Data
	1	/*
	2	* This file is part of the PulseView project.
	3	*
	4	* Copyright (C) 2013 Joel Holdsworth <joel@airwebreathe.org.uk>
	5	*
	6	* This program is free software; you can redistribute it and/or modify
	7	* it under the terms of the GNU General Public License as published by
	8	* the Free Software Foundation; either version 2 of the License, or
	9	* (at your option) any later version.
	10	*
	11	* This program is distributed in the hope that it will be useful,
	12	* but WITHOUT ANY WARRANTY; without even the implied warranty of
	13	* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
	14	* GNU General Public License for more details.
	15	*
	16	* You should have received a copy of the GNU General Public License
	17	* along with this program; if not, see <http://www.gnu.org/licenses/>.
	18	*/
	19
	20	#include <algorithm>
	21	#include <cassert>
	22
	23	#include <QColor>
	24	#include <QMenu>
	25	#include <QToolTip>
	26
	27	#include "cursorpair.hpp"
	28
	29	#include "pv/globalsettings.hpp"
	30	#include "pv/util.hpp"
	31	#include "ruler.hpp"
	32	#include "view.hpp"
	33
	34	using std::max;
	35	using std::make_pair;
	36	using std::min;
	37	using std::shared_ptr;
	38	using std::pair;
	39
	40	namespace pv {
	41	namespace views {
	42	namespace trace {
	43
	44	const int CursorPair::DeltaPadding = 8;
	45
	46	CursorPair::CursorPair(View &view) :
	47	TimeItem(view),
	48	first_(new Cursor(view, 0.0)),
	49	second_(new Cursor(view, 1.0)),
	50	label_incomplete_(true)
	51	{
	52	GlobalSettings::add_change_handler(this);
	53
	54	GlobalSettings settings;
	55	fill_color_ = QColor::fromRgba(settings.value(
	56	GlobalSettings::Key_View_CursorFillColor).value<uint32_t>());
	57	show_frequency_ = settings.value(
	58	GlobalSettings::Key_View_CursorShowFrequency).value<bool>();
	59	show_interval_ = settings.value(
	60	GlobalSettings::Key_View_CursorShowInterval).value<bool>();
	61	show_samples_ = settings.value(
	62	GlobalSettings::Key_View_CursorShowSamples).value<bool>();
	63
	64	connect(&view_, SIGNAL(hover_point_changed(const QWidget*, QPoint)),
	65	this, SLOT(on_hover_point_changed(const QWidget*, QPoint)));
	66	}
	67
	68	CursorPair::~CursorPair()
	69	{
	70	GlobalSettings::remove_change_handler(this);
	71	}
	72
	73	bool CursorPair::enabled() const
	74	{
	75	return view_.cursors_shown();
	76	}
	77
	78	shared_ptr<Cursor> CursorPair::first() const
	79	{
	80	return first_;
	81	}
	82
	83	shared_ptr<Cursor> CursorPair::second() const
	84	{
	85	return second_;
	86	}
	87
	88	void CursorPair::set_time(const pv::util::Timestamp& time)
	89	{
	90	const pv::util::Timestamp delta = second_->time() - first_->time();
	91	first_->set_time(time);
	92	second_->set_time(time + delta);
	93	}
	94
	95	const pv::util::Timestamp CursorPair::time() const
	96	{
	97	return 0;
	98	}
	99
	100	float CursorPair::get_x() const
	101	{
	102	return (first_->get_x() + second_->get_x()) / 2.0f;
	103	}
	104
	105	const pv::util::Timestamp CursorPair::delta(const pv::util::Timestamp& other) const
	106	{
	107	if (other < second_->time())
	108	return other - first_->time();
	109	else
	110	return other - second_->time();
	111	}
	112
	113	QPoint CursorPair::drag_point(const QRect &rect) const
	114	{
	115	return first_->drag_point(rect);
	116	}
	117
	118	pv::widgets::Popup* CursorPair::create_popup(QWidget *parent)
	119	{
	120	(void)parent;
	121	return nullptr;
	122	}
	123
	124	QMenu CursorPair::create_header_context_menu(QWidget parent)
	125	{
	126	QMenu *menu = new QMenu(parent);
	127
	128	QAction *displayIntervalAction = new QAction(tr("Display interval"), this);
	129	displayIntervalAction->setCheckable(true);
	130	displayIntervalAction->setChecked(show_interval_);
	131	menu->addAction(displayIntervalAction);
	132
	133	connect(displayIntervalAction, &QAction::toggled, displayIntervalAction,
	134	[=]{
	135	GlobalSettings settings;
	136	settings.setValue(GlobalSettings::Key_View_CursorShowInterval,
	137	!settings.value(GlobalSettings::Key_View_CursorShowInterval).value<bool>());
	138	});
	139
	140	QAction *displayFrequencyAction = new QAction(tr("Display frequency"), this);
	141	displayFrequencyAction->setCheckable(true);
	142	displayFrequencyAction->setChecked(show_frequency_);
	143	menu->addAction(displayFrequencyAction);
	144
	145	connect(displayFrequencyAction, &QAction::toggled, displayFrequencyAction,
	146	[=]{
	147	GlobalSettings settings;
	148	settings.setValue(GlobalSettings::Key_View_CursorShowFrequency,
	149	!settings.value(GlobalSettings::Key_View_CursorShowFrequency).value<bool>());
	150	});
	151
	152	QAction *displaySamplesAction = new QAction(tr("Display samples"), this);
	153	displaySamplesAction->setCheckable(true);
	154	displaySamplesAction->setChecked(show_samples_);
	155	menu->addAction(displaySamplesAction);
	156
	157	connect(displaySamplesAction, &QAction::toggled, displaySamplesAction,
	158	[=]{
	159	GlobalSettings settings;
	160	settings.setValue(GlobalSettings::Key_View_CursorShowSamples,
	161	!settings.value(GlobalSettings::Key_View_CursorShowSamples).value<bool>());
	162	});
	163
	164	return menu;
	165	}
	166
	167	QRectF CursorPair::label_rect(const QRectF &rect) const
	168	{
	169	const QSizeF label_size(text_size_ + LabelPadding * 2);
	170	const pair<float, float> offsets(get_cursor_offsets());
	171	const pair<float, float> normal_offsets(
	172	(offsets.first < offsets.second) ? offsets :
	173	make_pair(offsets.second, offsets.first));
	174
	175	const float height = label_size.height();
	176	const float left = max(normal_offsets.first + DeltaPadding, -height);
	177	const float right = min(normal_offsets.second - DeltaPadding,
	178	(float)rect.width() + height);
	179
	180	return QRectF(left, rect.height() - label_size.height() -
	181	TimeMarker::ArrowSize - 0.5f,
	182	right - left, height);
	183	}
	184
	185	void CursorPair::paint_label(QPainter &p, const QRect &rect, bool hover)
	186	{
	187	assert(first_);
	188	assert(second_);
	189
	190	if (!enabled())
	191	return;
	192
	193	const QColor text_color = ViewItem::select_text_color(Cursor::FillColor);
	194	p.setPen(text_color);
	195
	196	QRectF delta_rect(label_rect(rect));
	197	const int radius = delta_rect.height() / 2;
	198	QRectF text_rect(delta_rect.intersected(rect).adjusted(radius, 0, -radius, 0));
	199
	200	QString text = format_string(text_rect.width(),
	201	[&p](const QString& s) -> double { return p.boundingRect(QRectF(), 0, s).width(); });
	202
	203	text_size_ = p.boundingRect(QRectF(), 0, text).size();
	204
	205	/* Currently, selecting the middle section between two cursors doesn't do
	206	* anything, so don't highlight it when selected
	207	if (selected()) {
	208	p.setBrush(Qt::transparent);
	209	p.setPen(highlight_pen());
	210	p.drawRoundedRect(delta_rect, radius, radius);
	211	} */
	212
	213	p.setBrush(hover ? Cursor::FillColor.lighter() : Cursor::FillColor);
	214	p.setPen(Cursor::FillColor.darker());
	215	p.drawRoundedRect(delta_rect, radius, radius);
	216
	217	delta_rect.adjust(1, 1, -1, -1);
	218	p.setPen(Cursor::FillColor.lighter());
	219	const int highlight_radius = delta_rect.height() / 2 - 2;
	220	p.drawRoundedRect(delta_rect, highlight_radius, highlight_radius);
	221	label_area_ = delta_rect;
	222
	223	p.setPen(text_color);
	224	p.drawText(text_rect, Qt::AlignCenter \| Qt::AlignVCenter, text);
	225	}
	226
	227	void CursorPair::paint_back(QPainter &p, ViewItemPaintParams &pp)
	228	{
	229	if (!enabled())
	230	return;
	231
	232	p.setPen(Qt::NoPen);
	233	p.setBrush(fill_color_);
	234
	235	const pair<float, float> offsets(get_cursor_offsets());
	236	const int l = (int)max(min(offsets.first, offsets.second), 0.0f);
	237	const int r = (int)min(max(offsets.first, offsets.second), (float)pp.width());
	238
	239	p.drawRect(l, pp.top(), r - l, pp.height());
	240	}
	241
	242	QString CursorPair::format_string(int max_width, std::function<double(const QString&)> query_size)
	243	{
	244	int time_precision = 12;
	245	int freq_precision = 12;
	246
	247	QString s = format_string_sub(time_precision, freq_precision);
	248
	249	// Try full "{time} s / {freq} Hz" format
	250	if ((max_width <= 0) \|\| (query_size(s) <= max_width)) {
	251	label_incomplete_ = false;
	252	return s;
	253	}
	254
	255	label_incomplete_ = true;
	256
	257	// Gradually reduce time precision to match frequency precision
	258	while (time_precision > freq_precision) {
	259	time_precision--;
	260
	261	s = format_string_sub(time_precision, freq_precision);
	262	if (query_size(s) <= max_width)
	263	return s;
	264	}
	265
	266	// Gradually reduce both precisions down to zero
	267	while (time_precision > 0) {
	268	time_precision--;
	269	freq_precision--;
	270
	271	s = format_string_sub(time_precision, freq_precision);
	272	if (query_size(s) <= max_width)
	273	return s;
	274	}
	275
	276	// Try no trailing digits and drop the unit to at least display something
	277	s = format_string_sub(0, 0, false);
	278
	279	if (query_size(s) <= max_width)
	280	return s;
	281
	282	// Give up
	283	return "...";
	284	}
	285
	286	pair<float, float> CursorPair::get_cursor_offsets() const
	287	{
	288	assert(first_);
	289	assert(second_);
	290
	291	return pair<float, float>(first_->get_x(), second_->get_x());
	292	}
	293
	294	void CursorPair::on_setting_changed(const QString &key, const QVariant &value)
	295	{
	296	if (key == GlobalSettings::Key_View_CursorFillColor)
	297	fill_color_ = QColor::fromRgba(value.value<uint32_t>());
	298
	299	if (key == GlobalSettings::Key_View_CursorShowFrequency)
	300	show_frequency_ = value.value<bool>();
	301
	302	if (key == GlobalSettings::Key_View_CursorShowInterval)
	303	show_interval_ = value.value<bool>();
	304
	305	if (key == GlobalSettings::Key_View_CursorShowSamples)
	306	show_samples_ = value.value<bool>();
	307	}
	308
	309	void CursorPair::on_hover_point_changed(const QWidget* widget, const QPoint& hp)
	310	{
	311	if (widget != view_.ruler())
	312	return;
	313
	314	if (!label_incomplete_)
	315	return;
	316
	317	if (label_area_.contains(hp))
	318	QToolTip::showText(view_.mapToGlobal(hp), format_string());
	319	else
	320	QToolTip::hideText(); // TODO Will break other tooltips when there can be others
	321	}
	322
	323	QString CursorPair::format_string_sub(int time_precision, int freq_precision, bool show_unit)
	324	{
	325	QString s = " ";
	326
	327	const pv::util::SIPrefix prefix = view_.tick_prefix();
	328	const pv::util::Timestamp diff = abs(second_->time() - first_->time());
	329
	330	const QString time = Ruler::format_time_with_distance(
	331	diff, diff, prefix, (show_unit ? view_.time_unit() : pv::util::TimeUnit::None),
	332	time_precision, false);
	333
	334	// We can only show a frequency when there's a time base
	335	if (view_.time_unit() == pv::util::TimeUnit::Time) {
	336	int items = 0;
	337
	338	if (show_frequency_) {
	339	const QString freq = util::format_value_si(
	340	1 / diff.convert_to<double>(), pv::util::SIPrefix::unspecified,
	341	freq_precision, (show_unit ? "Hz" : nullptr), false);
	342	s = QString("%1").arg(freq);
	343	items++;
	344	}
	345
	346	if (show_interval_) {
	347	if (items > 0)
	348	s = QString("%1 / %2").arg(s, time);
	349	else
	350	s = QString("%1").arg(time);
	351	items++;
	352	}
	353
	354	if (show_samples_) {
	355	const QString samples = QString::number(
	356	(diff * view_.session().get_samplerate()).convert_to<uint64_t>());
	357	if (items > 0)
	358	s = QString("%1 / %2").arg(s, samples);
	359	else
	360	s = QString("%1").arg(samples);
	361	}
	362	} else
	363	// In this case, we return the number of samples, really
	364	s = time;
	365
	366	return s;
	367	}
	368
	369	} // namespace trace
	370	} // namespace views
	371	} // namespace pv