[pulseview.git] / pv / views / tabular_decoder / model.cpp

/*
 * This file is part of the PulseView project.
 *
 * Copyright (C) 2020 Soeren Apel <soeren@apelpie.net>
 *
 * 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 <QDebug>
#include <QString>

#include "pv/views/tabular_decoder/view.hpp"

#include "view.hpp"

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

using std::make_shared;

using pv::util::Timestamp;
using pv::util::format_time_si;
using pv::util::format_time_minutes;
using pv::util::SIPrefix;

namespace pv {
namespace views {
namespace tabular_decoder {

AnnotationCollectionModel::AnnotationCollectionModel(QObject* parent) :
	QAbstractTableModel(parent),
	all_annotations_(nullptr),
	dataset_(nullptr),
	signal_(nullptr),
	prev_segment_(0),
	prev_last_row_(0),
	start_index_(0),
	end_index_(0),
	hide_hidden_(false)
{
	// TBD Maybe use empty columns as indentation levels to indicate stacked decoders
	header_data_.emplace_back(tr("Sample"));     // Column #0
	header_data_.emplace_back(tr("Time"));       // Column #1
	header_data_.emplace_back(tr("Decoder"));    // Column #2
	header_data_.emplace_back(tr("Ann Row"));    // Column #3
	header_data_.emplace_back(tr("Ann Class"));  // Column #4
	header_data_.emplace_back(tr("Value"));      // Column #5
}

QVariant AnnotationCollectionModel::data_from_ann(const Annotation* ann, int index) const
{
	switch (index) {
	case 0: return QVariant((qulonglong)ann->start_sample());  // Column #0, Start Sample
	case 1: {                                                  // Column #1, Start Time
			Timestamp t = ann->start_sample() / signal_->get_samplerate();
			QString unit = signal_->get_samplerate() ? tr("s") : tr("sa");
			QString s;
			if ((t < 60) || (signal_->get_samplerate() == 0))  // i.e. if unit is sa
				s = format_time_si(t, SIPrefix::unspecified, 3, unit, false);
			else
				s = format_time_minutes(t, 3, false);
			return QVariant(s);
		}
	case 2: return QVariant(ann->row()->decoder()->name());    // Column #2, Decoder
	case 3: return QVariant(ann->row()->description());        // Column #3, Ann Row
	case 4: return QVariant(ann->ann_class_description());     // Column #4, Ann Class
	case 5: return QVariant(ann->longest_annotation());        // Column #5, Value
	default: return QVariant();
	}
}

QVariant AnnotationCollectionModel::data(const QModelIndex& index, int role) const
{
	if (!signal_ || !index.isValid() || !index.internalPointer())
		return QVariant();

	const Annotation* ann =
		static_cast<const Annotation*>(index.internalPointer());

	if ((role == Qt::DisplayRole) || (role == Qt::ToolTipRole))
		return data_from_ann(ann, index.column());

	if (role == Qt::BackgroundRole) {
		int level = 0;

		const unsigned int ann_stack_level = ann->row_data()->row()->decoder()->get_stack_level();
		level = (signal_->decoder_stack().size() - 1 - ann_stack_level);

		// Only use custom cell background color if column index reached the hierarchy level
		if (index.column() >= level) {
			if (GlobalSettings::current_theme_is_dark())
				return QBrush(ann->dark_color());
			else
				return QBrush(ann->bright_color());
		}
	}

	return QVariant();
}

Qt::ItemFlags AnnotationCollectionModel::flags(const QModelIndex& index) const
{
	if (!index.isValid())
		return Qt::NoItemFlags;

	return Qt::ItemIsEnabled | Qt::ItemIsSelectable | Qt::ItemNeverHasChildren;
}

QVariant AnnotationCollectionModel::headerData(int section, Qt::Orientation orientation,
	int role) const
{
	if ((orientation == Qt::Horizontal) && (role == Qt::DisplayRole))
		return header_data_.at(section);

	return QVariant();
}

QModelIndex AnnotationCollectionModel::index(int row, int column,
	const QModelIndex& parent_idx) const
{
	(void)parent_idx;
	assert(column >= 0);

	if (!dataset_ || (row < 0))
		return QModelIndex();

	QModelIndex idx;

	if (start_index_ == end_index_) {
		if ((size_t)row < dataset_->size())
			idx = createIndex(row, column, (void*)dataset_->at(row));
	} else {
		if ((size_t)row < (end_index_ - start_index_))
			idx = createIndex(row, column, (void*)dataset_->at(start_index_ + row));
	}

	return idx;
}

QModelIndex AnnotationCollectionModel::parent(const QModelIndex& index) const
{
	(void)index;

	return QModelIndex();
}

int AnnotationCollectionModel::rowCount(const QModelIndex& parent_idx) const
{
	(void)parent_idx;

	if (!dataset_)
		return 0;

	if (start_index_ == end_index_)
		return dataset_->size();
	else
		return (end_index_ - start_index_);
}

int AnnotationCollectionModel::columnCount(const QModelIndex& parent_idx) const
{
	(void)parent_idx;

	return header_data_.size();
}

void AnnotationCollectionModel::set_signal_and_segment(data::DecodeSignal* signal, uint32_t current_segment)
{
	if (!signal) {
		all_annotations_ = nullptr;
		dataset_ = nullptr;
		signal_ = nullptr;

		dataChanged(QModelIndex(), QModelIndex());
		layoutChanged();
		return;
	}

	disconnect(this, SLOT(on_annotation_visibility_changed()));

	all_annotations_ = signal->get_all_annotations_by_segment(current_segment);
	signal_ = signal;

	for (const shared_ptr<Decoder>& dec : signal_->decoder_stack())
		connect(dec.get(), SIGNAL(annotation_visibility_changed()),
			this, SLOT(on_annotation_visibility_changed()));

	if (hide_hidden_)
		update_annotations_without_hidden();
	else
		dataset_ = all_annotations_;

	if (!dataset_ || dataset_->empty()) {
		prev_segment_ = current_segment;
		return;
	}

	// Re-apply the requested sample range
	set_sample_range(start_sample_, end_sample_);

	const size_t new_row_count = dataset_->size() - 1;

	// Force the view associated with this model to update when the segment changes
	if (prev_segment_ != current_segment) {
		dataChanged(QModelIndex(), QModelIndex());
		layoutChanged();
	} else {
		// Force the view associated with this model to update when we have more annotations
		if (prev_last_row_ < new_row_count) {
			dataChanged(index(prev_last_row_, 0), index(new_row_count, 0));
			layoutChanged();
		}
	}

	prev_segment_ = current_segment;
	prev_last_row_ = new_row_count;
}

void AnnotationCollectionModel::set_sample_range(uint64_t start_sample, uint64_t end_sample)
{
	// Check if there's even anything to reset
	if ((start_sample == end_sample) && (start_index_ == end_index_))
		return;

	if (!dataset_ || dataset_->empty() || (end_sample == 0)) {
		start_index_ = 0;
		end_index_ = 0;
		start_sample_ = 0;
		end_sample_ = 0;

		dataChanged(QModelIndex(), QModelIndex());
		layoutChanged();
		return;
	}

	start_sample_ = start_sample;
	end_sample_ = end_sample;

	// Determine first and last indices into the annotation list
	int64_t i = -1;
	bool ann_outside_range;
	do {
		i++;

		if (i == (int64_t)dataset_->size()) {
			start_index_ = 0;
			end_index_ = 0;

			dataChanged(QModelIndex(), QModelIndex());
			layoutChanged();
			return;
		}
		const Annotation* ann = (*dataset_)[i];
		ann_outside_range =
			((ann->start_sample() < start_sample) && (ann->end_sample() < start_sample));
	} while (ann_outside_range);
	start_index_ = i;

	// Ideally, we would be able to set end_index_ to the last annotation that
	// is within range. However, as annotations in the list are sorted by
	// start sample and hierarchy level, we may encounter this scenario:
	//   [long annotation that spans across view]
	//   [short annotations that aren't seen]
	//   [short annotations that are seen]
	// ..in which our output would only show the first long annotations.
	// For this reason, we simply show everything after the first visible
	// annotation for now.

	end_index_ = dataset_->size();

	dataChanged(index(0, 0), index((end_index_ - start_index_), 0));
	layoutChanged();
}

void AnnotationCollectionModel::set_hide_hidden(bool hide_hidden)
{
	hide_hidden_ = hide_hidden;

	if (hide_hidden_) {
		dataset_ = &all_annotations_without_hidden_;
		update_annotations_without_hidden();
	} else {
		dataset_ = all_annotations_;
		all_annotations_without_hidden_.clear();  // To conserve memory
	}

	// Re-apply the requested sample range
	set_sample_range(start_sample_, end_sample_);

	if (dataset_)
		dataChanged(index(0, 0), index(dataset_->size(), 0));
	else
		dataChanged(QModelIndex(), QModelIndex());

	layoutChanged();
}

void AnnotationCollectionModel::update_annotations_without_hidden()
{
	uint64_t count = 0;

	if (!all_annotations_ || all_annotations_->empty()) {
		all_annotations_without_hidden_.clear();
		return;
	}

	for (const Annotation* ann : *all_annotations_) {
		if (!ann->visible())
			continue;

		if (all_annotations_without_hidden_.size() < (count + 100))
			all_annotations_without_hidden_.resize(count + 100);

		all_annotations_without_hidden_[count++] = ann;
	}

	all_annotations_without_hidden_.resize(count);
}

void AnnotationCollectionModel::on_annotation_visibility_changed()
{
	if (!hide_hidden_)
		return;

	update_annotations_without_hidden();

	// Re-apply the requested sample range
	set_sample_range(start_sample_, end_sample_);

	if (dataset_)
		dataChanged(index(0, 0), index(dataset_->size(), 0));
	else
		dataChanged(QModelIndex(), QModelIndex());

	layoutChanged();
}

} // namespace tabular_decoder
} // namespace views
} // namespace pv
Commit	Line	Data
24d69d27 SA	1	/*
	2	* This file is part of the PulseView project.
	3	*
	4	* Copyright (C) 2020 Soeren Apel <soeren@apelpie.net>
	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
f54e68b0	20	#include <QDebug>
24d69d27 SA	21	#include <QString>
	22
	23	#include "pv/views/tabular_decoder/view.hpp"
	24
d656b010 SA	25	#include "view.hpp"
d656b010 SA	26
85125b0f	27	#include "pv/util.hpp"
8e168b23	28	#include "pv/globalsettings.hpp"
85125b0f	29
24d69d27 SA	30	using std::make_shared;
24d69d27 SA	31
85125b0f SA	32	using pv::util::Timestamp;
	33	using pv::util::format_time_si;
	34	using pv::util::format_time_minutes;
	35	using pv::util::SIPrefix;
	36
24d69d27 SA	37	namespace pv {
	38	namespace views {
	39	namespace tabular_decoder {
	40
	41	AnnotationCollectionModel::AnnotationCollectionModel(QObject* parent) :
f54e68b0 SA	42	QAbstractTableModel(parent),
f54e68b0 SA	43	all_annotations_(nullptr),
86d4b8e3	44	dataset_(nullptr),
d656b010	45	signal_(nullptr),
f54e68b0	46	prev_segment_(0),
86d4b8e3	47	prev_last_row_(0),
8997f62a SA	48	start_index_(0),
8997f62a SA	49	end_index_(0),
86d4b8e3	50	hide_hidden_(false)
24d69d27	51	{
f54e68b0	52	// TBD Maybe use empty columns as indentation levels to indicate stacked decoders
88a25978 SA	53	header_data_.emplace_back(tr("Sample")); // Column #0
	54	header_data_.emplace_back(tr("Time")); // Column #1
	55	header_data_.emplace_back(tr("Decoder")); // Column #2
	56	header_data_.emplace_back(tr("Ann Row")); // Column #3
	57	header_data_.emplace_back(tr("Ann Class")); // Column #4
	58	header_data_.emplace_back(tr("Value")); // Column #5
24d69d27 SA	59	}
24d69d27 SA	60
85125b0f SA	61	QVariant AnnotationCollectionModel::data_from_ann(const Annotation* ann, int index) const
	62	{
	63	switch (index) {
	64	case 0: return QVariant((qulonglong)ann->start_sample()); // Column #0, Start Sample
	65	case 1: { // Column #1, Start Time
	66	Timestamp t = ann->start_sample() / signal_->get_samplerate();
	67	QString unit = signal_->get_samplerate() ? tr("s") : tr("sa");
	68	QString s;
	69	if ((t < 60) \|\| (signal_->get_samplerate() == 0)) // i.e. if unit is sa
	70	s = format_time_si(t, SIPrefix::unspecified, 3, unit, false);
	71	else
	72	s = format_time_minutes(t, 3, false);
	73	return QVariant(s);
	74	}
	75	case 2: return QVariant(ann->row()->decoder()->name()); // Column #2, Decoder
	76	case 3: return QVariant(ann->row()->description()); // Column #3, Ann Row
	77	case 4: return QVariant(ann->ann_class_description()); // Column #4, Ann Class
	78	case 5: return QVariant(ann->longest_annotation()); // Column #5, Value
	79	default: return QVariant();
	80	}
	81	}
	82
24d69d27 SA	83	QVariant AnnotationCollectionModel::data(const QModelIndex& index, int role) const
24d69d27 SA	84	{
6d46525f	85	if (!signal_ \|\| !index.isValid() \|\| !index.internalPointer())
24d69d27 SA	86	return QVariant();
24d69d27 SA	87
88a25978 SA	88	const Annotation* ann =
88a25978 SA	89	static_cast<const Annotation*>(index.internalPointer());
f54e68b0	90
85125b0f SA	91	if ((role == Qt::DisplayRole) \|\| (role == Qt::ToolTipRole))
85125b0f SA	92	return data_from_ann(ann, index.column());
24d69d27	93
88a25978	94	if (role == Qt::BackgroundRole) {
d656b010 SA	95	int level = 0;
	96
	97	const unsigned int ann_stack_level = ann->row_data()->row()->decoder()->get_stack_level();
	98	level = (signal_->decoder_stack().size() - 1 - ann_stack_level);
	99
	100	// Only use custom cell background color if column index reached the hierarchy level
	101	if (index.column() >= level) {
8e168b23	102	if (GlobalSettings::current_theme_is_dark())
d656b010 SA	103	return QBrush(ann->dark_color());
	104	else
	105	return QBrush(ann->bright_color());
	106	}
88a25978 SA	107	}
88a25978 SA	108
24d69d27 SA	109	return QVariant();
	110	}
	111
	112	Qt::ItemFlags AnnotationCollectionModel::flags(const QModelIndex& index) const
	113	{
	114	if (!index.isValid())
9a35b05d	115	return Qt::NoItemFlags;
24d69d27	116
9a35b05d	117	return Qt::ItemIsEnabled \| Qt::ItemIsSelectable \| Qt::ItemNeverHasChildren;
24d69d27 SA	118	}
	119
	120	QVariant AnnotationCollectionModel::headerData(int section, Qt::Orientation orientation,
	121	int role) const
	122	{
6d46525f	123	if ((orientation == Qt::Horizontal) && (role == Qt::DisplayRole))
f54e68b0	124	return header_data_.at(section);
24d69d27 SA	125
	126	return QVariant();
	127	}
	128
	129	QModelIndex AnnotationCollectionModel::index(int row, int column,
	130	const QModelIndex& parent_idx) const
	131	{
f54e68b0	132	(void)parent_idx;
6d46525f	133	assert(column >= 0);
24d69d27	134
593ea025	135	if (!dataset_ \|\| (row < 0))
f54e68b0	136	return QModelIndex();
24d69d27	137
86d4b8e3 SA	138	QModelIndex idx;
86d4b8e3 SA	139
8997f62a SA	140	if (start_index_ == end_index_) {
	141	if ((size_t)row < dataset_->size())
	142	idx = createIndex(row, column, (void*)dataset_->at(row));
	143	} else {
	144	if ((size_t)row < (end_index_ - start_index_))
	145	idx = createIndex(row, column, (void*)dataset_->at(start_index_ + row));
	146	}
24d69d27	147
86d4b8e3	148	return idx;
24d69d27 SA	149	}
	150
	151	QModelIndex AnnotationCollectionModel::parent(const QModelIndex& index) const
	152	{
f54e68b0	153	(void)index;
24d69d27	154
f54e68b0	155	return QModelIndex();
24d69d27 SA	156	}
	157
	158	int AnnotationCollectionModel::rowCount(const QModelIndex& parent_idx) const
	159	{
f54e68b0	160	(void)parent_idx;
24d69d27	161
86d4b8e3	162	if (!dataset_)
24d69d27 SA	163	return 0;
24d69d27 SA	164
8997f62a SA	165	if (start_index_ == end_index_)
	166	return dataset_->size();
	167	else
	168	return (end_index_ - start_index_);
24d69d27 SA	169	}
	170
	171	int AnnotationCollectionModel::columnCount(const QModelIndex& parent_idx) const
	172	{
f54e68b0 SA	173	(void)parent_idx;
	174
	175	return header_data_.size();
24d69d27 SA	176	}
24d69d27 SA	177
f54e68b0 SA	178	void AnnotationCollectionModel::set_signal_and_segment(data::DecodeSignal* signal, uint32_t current_segment)
f54e68b0 SA	179	{
88a25978 SA	180	if (!signal) {
88a25978 SA	181	all_annotations_ = nullptr;
86d4b8e3	182	dataset_ = nullptr;
d656b010	183	signal_ = nullptr;
86d4b8e3	184
88a25978 SA	185	dataChanged(QModelIndex(), QModelIndex());
	186	layoutChanged();
	187	return;
	188	}
	189
02078aa1 SA	190	disconnect(this, SLOT(on_annotation_visibility_changed()));
02078aa1 SA	191
f54e68b0	192	all_annotations_ = signal->get_all_annotations_by_segment(current_segment);
d656b010	193	signal_ = signal;
f54e68b0	194
02078aa1 SA	195	for (const shared_ptr<Decoder>& dec : signal_->decoder_stack())
	196	connect(dec.get(), SIGNAL(annotation_visibility_changed()),
	197	this, SLOT(on_annotation_visibility_changed()));
	198
86d4b8e3 SA	199	if (hide_hidden_)
	200	update_annotations_without_hidden();
	201	else
	202	dataset_ = all_annotations_;
	203
	204	if (!dataset_ \|\| dataset_->empty()) {
f54e68b0 SA	205	prev_segment_ = current_segment;
	206	return;
	207	}
	208
8997f62a SA	209	// Re-apply the requested sample range
	210	set_sample_range(start_sample_, end_sample_);
	211
86d4b8e3	212	const size_t new_row_count = dataset_->size() - 1;
f54e68b0 SA	213
	214	// Force the view associated with this model to update when the segment changes
	215	if (prev_segment_ != current_segment) {
	216	dataChanged(QModelIndex(), QModelIndex());
	217	layoutChanged();
	218	} else {
	219	// Force the view associated with this model to update when we have more annotations
	220	if (prev_last_row_ < new_row_count) {
c84afcfd	221	dataChanged(index(prev_last_row_, 0), index(new_row_count, 0));
f54e68b0 SA	222	layoutChanged();
	223	}
	224	}
	225
	226	prev_segment_ = current_segment;
	227	prev_last_row_ = new_row_count;
	228	}
24d69d27	229
8997f62a SA	230	void AnnotationCollectionModel::set_sample_range(uint64_t start_sample, uint64_t end_sample)
	231	{
	232	// Check if there's even anything to reset
	233	if ((start_sample == end_sample) && (start_index_ == end_index_))
	234	return;
	235
	236	if (!dataset_ \|\| dataset_->empty() \|\| (end_sample == 0)) {
	237	start_index_ = 0;
	238	end_index_ = 0;
	239	start_sample_ = 0;
	240	end_sample_ = 0;
	241
	242	dataChanged(QModelIndex(), QModelIndex());
	243	layoutChanged();
	244	return;
	245	}
	246
	247	start_sample_ = start_sample;
	248	end_sample_ = end_sample;
	249
	250	// Determine first and last indices into the annotation list
	251	int64_t i = -1;
	252	bool ann_outside_range;
	253	do {
	254	i++;
	255
	256	if (i == (int64_t)dataset_->size()) {
	257	start_index_ = 0;
	258	end_index_ = 0;
	259
	260	dataChanged(QModelIndex(), QModelIndex());
	261	layoutChanged();
	262	return;
	263	}
	264	const Annotation* ann = (*dataset_)[i];
	265	ann_outside_range =
	266	((ann->start_sample() < start_sample) && (ann->end_sample() < start_sample));
	267	} while (ann_outside_range);
	268	start_index_ = i;
	269
	270	// Ideally, we would be able to set end_index_ to the last annotation that
	271	// is within range. However, as annotations in the list are sorted by
	272	// start sample and hierarchy level, we may encounter this scenario:
	273	// [long annotation that spans across view]
	274	// [short annotations that aren't seen]
	275	// [short annotations that are seen]
	276	// ..in which our output would only show the first long annotations.
	277	// For this reason, we simply show everything after the first visible
	278	// annotation for now.
	279
	280	end_index_ = dataset_->size();
	281
	282	dataChanged(index(0, 0), index((end_index_ - start_index_), 0));
	283	layoutChanged();
	284	}
	285
86d4b8e3 SA	286	void AnnotationCollectionModel::set_hide_hidden(bool hide_hidden)
	287	{
	288	hide_hidden_ = hide_hidden;
	289
	290	if (hide_hidden_) {
	291	dataset_ = &all_annotations_without_hidden_;
	292	update_annotations_without_hidden();
	293	} else {
	294	dataset_ = all_annotations_;
	295	all_annotations_without_hidden_.clear(); // To conserve memory
	296	}
8997f62a SA	297
	298	// Re-apply the requested sample range
	299	set_sample_range(start_sample_, end_sample_);
	300
	301	if (dataset_)
	302	dataChanged(index(0, 0), index(dataset_->size(), 0));
	303	else
	304	dataChanged(QModelIndex(), QModelIndex());
	305
	306	layoutChanged();
86d4b8e3 SA	307	}
	308
	309	void AnnotationCollectionModel::update_annotations_without_hidden()
	310	{
	311	uint64_t count = 0;
	312
	313	if (!all_annotations_ \|\| all_annotations_->empty()) {
	314	all_annotations_without_hidden_.clear();
	315	return;
	316	}
	317
	318	for (const Annotation* ann : *all_annotations_) {
	319	if (!ann->visible())
	320	continue;
	321
	322	if (all_annotations_without_hidden_.size() < (count + 100))
	323	all_annotations_without_hidden_.resize(count + 100);
	324
	325	all_annotations_without_hidden_[count++] = ann;
	326	}
	327
	328	all_annotations_without_hidden_.resize(count);
86d4b8e3 SA	329	}
86d4b8e3 SA	330
02078aa1 SA	331	void AnnotationCollectionModel::on_annotation_visibility_changed()
	332	{
	333	if (!hide_hidden_)
	334	return;
	335
	336	update_annotations_without_hidden();
	337
	338	// Re-apply the requested sample range
	339	set_sample_range(start_sample_, end_sample_);
	340
	341	if (dataset_)
	342	dataChanged(index(0, 0), index(dataset_->size(), 0));
	343	else
	344	dataChanged(QModelIndex(), QModelIndex());
	345
	346	layoutChanged();
	347	}
	348
24d69d27 SA	349	} // namespace tabular_decoder
	350	} // namespace views
	351	} // namespace pv