[pulseview.git] / pv / data / decode / rowdata.hpp

/*
 * This file is part of the PulseView project.
 *
 * Copyright (C) 2014 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/>.
 */

#ifndef PULSEVIEW_PV_DATA_DECODE_ROWDATA_HPP
#define PULSEVIEW_PV_DATA_DECODE_ROWDATA_HPP

#include <unordered_map>
#include <vector>

#include <QtGlobal>
#include <QHash>
#include <QString>

#include <libsigrokdecode/libsigrokdecode.h>

#include <pv/data/decode/annotation.hpp>

using std::deque;
using std::unordered_map;

#if QT_VERSION < QT_VERSION_CHECK(5, 14, 0)
namespace std {
	template<> struct hash<QString> {
		std::size_t operator()(const QString& s) const noexcept {
			return (size_t) qHash(s);
		}
	};
}
#endif

namespace pv {
namespace data {
namespace decode {

class Row;

class RowData
{
public:
	RowData(Row* row);

	const Row* row() const;

	uint64_t get_max_sample() const;

	uint64_t get_annotation_count() const;

	/**
	 * Extracts annotations between the given sample range into a vector.
	 * Note: The annotations are unsorted and only annotations that fully
	 * fit into the sample range are considered.
	 */
	void get_annotation_subset(deque<const pv::data::decode::Annotation*> &dest,
		uint64_t start_sample, uint64_t end_sample) const;

	const deque<Annotation>& annotations() const;

	const Annotation* emplace_annotation(srd_proto_data *pdata);

private:
	deque<Annotation> annotations_;
	unordered_map<QString, vector<QString> > ann_texts_;  // unordered_map since pointers must not change
	Row* row_;
	uint64_t prev_ann_start_sample_;
};

}  // namespace decode
}  // namespace data
}  // namespace pv

#endif // PULSEVIEW_PV_DATA_DECODE_ROWDATA_HPP
Commit	Line	Data
	1	/*
	2	* This file is part of the PulseView project.
	3	*
	4	* Copyright (C) 2014 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	#ifndef PULSEVIEW_PV_DATA_DECODE_ROWDATA_HPP
	21	#define PULSEVIEW_PV_DATA_DECODE_ROWDATA_HPP
	22
	23	#include <unordered_map>
	24	#include <vector>
	25
	26	#include <QtGlobal>
	27	#include <QHash>
	28	#include <QString>
	29
	30	#include <libsigrokdecode/libsigrokdecode.h>
	31
	32	#include <pv/data/decode/annotation.hpp>
	33
	34	using std::deque;
	35	using std::unordered_map;
	36
	37	#if QT_VERSION < QT_VERSION_CHECK(5, 14, 0)
	38	namespace std {
	39	template<> struct hash<QString> {
	40	std::size_t operator()(const QString& s) const noexcept {
	41	return (size_t) qHash(s);
	42	}
	43	};
	44	}
	45	#endif
	46
	47	namespace pv {
	48	namespace data {
	49	namespace decode {
	50
	51	class Row;
	52
	53	class RowData
	54	{
	55	public:
	56	RowData(Row* row);
	57
	58	const Row* row() const;
	59
	60	uint64_t get_max_sample() const;
	61
	62	uint64_t get_annotation_count() const;
	63
	64	/**
	65	* Extracts annotations between the given sample range into a vector.
	66	* Note: The annotations are unsorted and only annotations that fully
	67	* fit into the sample range are considered.
	68	*/
	69	void get_annotation_subset(deque<const pv::data::decode::Annotation*> &dest,
	70	uint64_t start_sample, uint64_t end_sample) const;
	71
	72	const deque<Annotation>& annotations() const;
	73
	74	const Annotation* emplace_annotation(srd_proto_data *pdata);
	75
	76	private:
	77	deque<Annotation> annotations_;
	78	unordered_map<QString, vector<QString> > ann_texts_; // unordered_map since pointers must not change
	79	Row* row_;
	80	uint64_t prev_ann_start_sample_;
	81	};
	82
	83	} // namespace decode
	84	} // namespace data
	85	} // namespace pv
	86
	87	#endif // PULSEVIEW_PV_DATA_DECODE_ROWDATA_HPP