[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"

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)
{
	GlobalSettings::add_change_handler(this);
	theme_is_dark_ = GlobalSettings::current_theme_is_dark();

	// 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 (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;
	}

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

	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_setting_changed(const QString &key, const QVariant &value)
{
	(void)key;
	(void)value;

	// We don't really care about the actual setting, we just update the
	// flag that indicates whether we are using a bright or dark color theme
	theme_is_dark_ = GlobalSettings::current_theme_is_dark();
}

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