DecodeTrace: Honor a decoder's shown flag

[pulseview.git] / pv / views / trace / view.hpp

/*
 * This file is part of the PulseView project.
 *
 * Copyright (C) 2012 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_VIEWS_TRACEVIEW_VIEW_HPP
#define PULSEVIEW_PV_VIEWS_TRACEVIEW_VIEW_HPP

#include <cstdint>
#include <list>
#include <memory>
#include <set>
#include <unordered_map>
#include <vector>

#include <QAbstractScrollArea>
#include <QShortcut>
#include <QSizeF>
#include <QSplitter>

#include <pv/globalsettings.hpp>
#include <pv/util.hpp>
#include <pv/data/signaldata.hpp>
#include <pv/views/viewbase.hpp>

#include "cursorpair.hpp"
#include "flag.hpp"
#include "trace.hpp"
#include "tracetreeitemowner.hpp"

using std::list;
using std::unordered_map;
using std::unordered_set;
using std::set;
using std::shared_ptr;
using std::vector;

namespace sigrok {
class ChannelGroup;
}

namespace pv {

class Session;

namespace data {
class Logic;
}

namespace views {

namespace trace {

class DecodeTrace;
class Header;
class Ruler;
class Signal;
class Viewport;
class TriggerMarker;

class CustomScrollArea : public QAbstractScrollArea
{
	Q_OBJECT

public:
	CustomScrollArea(QWidget *parent = nullptr);
	bool viewportEvent(QEvent *event);
};

class View : public ViewBase, public TraceTreeItemOwner, public GlobalSettingsInterface
{
	Q_OBJECT

private:
	enum StickyEvents {
		TraceTreeItemHExtentsChanged = 1,
		TraceTreeItemVExtentsChanged = 2
	};

private:
	static const pv::util::Timestamp MaxScale;
	static const pv::util::Timestamp MinScale;

	static const int MaxScrollValue;

	static const int ScaleUnits[3];

public:
	explicit View(Session &session, bool is_main_view=false, QMainWindow *parent = nullptr);

	~View();

	virtual ViewType get_type() const;

	/**
	 * Resets the view to its default state after construction. It does however
	 * not reset the signal bases or any other connections with the session.
	 */
	virtual void reset_view_state();

	Session& session();  // This method is needed for TraceTreeItemOwner, not ViewBase
	const Session& session() const;  // This method is needed for TraceTreeItemOwner, not ViewBase

	/**
	 * Returns the signals contained in this view.
	 */
	unordered_set< shared_ptr<Signal> > signals() const;

	shared_ptr<Signal> get_signal_by_signalbase(shared_ptr<data::SignalBase> base) const;

	virtual void clear_signals();

	void add_signal(const shared_ptr<Signal> signal);

#ifdef ENABLE_DECODE
	virtual void clear_decode_signals();

	virtual void add_decode_signal(shared_ptr<data::DecodeSignal> signal);

	virtual void remove_decode_signal(shared_ptr<data::DecodeSignal> signal);
#endif

	shared_ptr<Signal> get_signal_under_mouse_cursor() const;

	/**
	 * Returns the view of the owner.
	 */
	virtual View* view();

	/**
	 * Returns the view of the owner.
	 */
	virtual const View* view() const;

	Viewport* viewport();

	const Viewport* viewport() const;

	const Ruler* ruler() const;

	virtual void save_settings(QSettings &settings) const;

	virtual void restore_settings(QSettings &settings);

	/**
	 * Gets a list of time markers.
	 */
	vector< shared_ptr<TimeItem> > time_items() const;

	/**
	 * Returns the view time scale in seconds per pixel.
	 */
	double scale() const;

	/**
	 * Returns the internal view version of the time offset of the left edge
	 * of the view in seconds.
	 */
	const pv::util::Timestamp& offset() const;

	/**
	 * Returns the ruler version of the time offset of the left edge
	 * of the view in seconds.
	 */
	const pv::util::Timestamp& ruler_offset() const;

	void set_zero_position(const pv::util::Timestamp& position);

	void reset_zero_position();

	pv::util::Timestamp zero_offset() const;

	/**
	 * Returns the vertical scroll offset.
	 */
	int owner_visual_v_offset() const;

	/**
	 * Sets the visual v-offset.
	 */
	void set_v_offset(int offset);

	/**
	 * Sets the visual h-offset.
	 */
	void set_h_offset(int offset);

	/**
	 * Gets the length of the horizontal scrollbar.
	 */
	int get_h_scrollbar_maximum() const;

	/**
	 * Returns the SI prefix to apply to the graticule time markings.
	 */
	pv::util::SIPrefix tick_prefix() const;

	/**
	 * Returns the number of fractional digits shown for the time markings.
	 */
	unsigned int tick_precision() const;

	/**
	 * Returns period of the graticule time markings.
	 */
	const pv::util::Timestamp& tick_period() const;

	/**
	 * Returns number of minor division ticks per time marking.
	 */
	unsigned int minor_tick_count() const;

	/**
	 * Returns the unit of time currently used.
	 */
	util::TimeUnit time_unit() const;

	/**
	 * Returns the number of nested parents that this row item owner has.
	 */
	unsigned int depth() const;

	/**
	 * Returns the currently displayed segment, starting at 0.
	 */
	uint32_t current_segment() const;

	/**
	 * Returns whether the currently shown segment can be influenced
	 * (selected) or not.
	 */
	bool segment_is_selectable() const;

	Trace::SegmentDisplayMode segment_display_mode() const;
	void set_segment_display_mode(Trace::SegmentDisplayMode mode);

	void zoom(double steps);
	void zoom(double steps, int offset);

	void zoom_fit(bool gui_state);

	/**
	 * Sets the scale and offset.
	 * @param scale The new view scale in seconds per pixel.
	 * @param offset The view time offset in seconds.
	 */
	void set_scale_offset(double scale, const pv::util::Timestamp& offset);

	set< shared_ptr<pv::data::SignalData> > get_visible_data() const;

	pair<pv::util::Timestamp, pv::util::Timestamp> get_time_extents() const;

	/**
	 * Returns true if the trace background should be drawn with a colored background.
	 */
	bool colored_bg() const;

	/**
	 * Returns true if cursors are displayed. false otherwise.
	 */
	bool cursors_shown() const;

	/**
	 * Shows or hides the cursors.
	 */
	void show_cursors(bool show = true);

	/**
	 * Sets the cursors to the given offsets. You will still have to call show_cursors separately.
	 */
	void set_cursors(pv::util::Timestamp& first, pv::util::Timestamp& second);

	/**
	 * Moves the cursors to a convenient position in the view.
	 */
	void centre_cursors();

	/**
	 * Returns a reference to the pair of cursors.
	 */
	shared_ptr<CursorPair> cursors() const;

	/**
	 * Adds a new flag at a specified time.
	 */
	shared_ptr<Flag> add_flag(const pv::util::Timestamp& time);

	/**
	 * Removes a flag from the list.
	 */
	void remove_flag(shared_ptr<Flag> flag);

	/**
	 * Gets the list of flags.
	 */
	vector< shared_ptr<Flag> > flags() const;

	const QPoint& hover_point() const;
	const QWidget* hover_widget() const;

	/**
	 * Determines the closest level change (i.e. edge) to a given point, which
	 * is useful for e.g. the "snap to edge" functionality.
	 *
	 * @param p The current position of the mouse cursor
	 * @return The sample number of the nearest level change or -1 if none
	 */
	int64_t get_nearest_level_change(const QPoint &p);

	void restack_all_trace_tree_items();

	int header_width() const;

	void on_setting_changed(const QString &key, const QVariant &value);

Q_SIGNALS:
	void hover_point_changed(const QWidget* widget, const QPoint &hp);

	void selection_changed();

	/// Emitted when the offset changed.
	void offset_changed();

	/// Emitted when the scale changed.
	void scale_changed();

	void sticky_scrolling_changed(bool state);

	void always_zoom_to_fit_changed(bool state);

	/// Emitted when the tick_prefix changed.
	void tick_prefix_changed();

	/// Emitted when the tick_precision changed.
	void tick_precision_changed();

	/// Emitted when the tick_period changed.
	void tick_period_changed();

	/// Emitted when the time_unit changed.
	void time_unit_changed();

	/// Emitted when the currently selected segment changed
	void segment_changed(int segment_id);

	/// Emitted when the multi-segment display mode changed
	/// @param mode is a value of Trace::SegmentDisplayMode
	void segment_display_mode_changed(int mode, bool segment_selectable);

	/// Emitted when the cursors are shown/hidden
	void cursor_state_changed(bool show);

public Q_SLOTS:
	void trigger_event(int segment_id, util::Timestamp location);

private:
	void get_scroll_layout(double &length, pv::util::Timestamp &offset) const;

	/**
	 * Simultaneously sets the zoom and offset.
	 * @param scale The scale to set the view to in seconds per pixel. This
	 * value is clamped between MinScale and MaxScale.
	 * @param offset The offset of the left edge of the view in seconds.
	 */
	void set_zoom(double scale, int offset);

	/**
	 * Find a tick spacing and number formatting that does not cause
	 * the values to collide.
	 */
	void calculate_tick_spacing();

	void adjust_top_margin();

	void update_scroll();

	void reset_scroll();

	void set_scroll_default();

	void determine_if_header_was_shrunk();

	void resize_header_to_fit();

	void update_layout();

	TraceTreeItemOwner* find_prevalent_trace_group(
		const shared_ptr<sigrok::ChannelGroup> &group,
		const unordered_map<shared_ptr<data::SignalBase>,
			shared_ptr<Signal> > &signal_map);

	static vector< shared_ptr<Trace> >
		extract_new_traces_for_channels(
		const vector< shared_ptr<sigrok::Channel> > &channels,
		const unordered_map<shared_ptr<data::SignalBase>,
			shared_ptr<Signal> > &signal_map,
		set< shared_ptr<Trace> > &add_list);

	void determine_time_unit();

	bool eventFilter(QObject *object, QEvent *event);

	virtual void contextMenuEvent(QContextMenuEvent *event);

	void resizeEvent(QResizeEvent *event);

	void update_hover_point();

public:
	void row_item_appearance_changed(bool label, bool content);
	void time_item_appearance_changed(bool label, bool content);

	void extents_changed(bool horz, bool vert);

private Q_SLOTS:
	void on_signal_name_changed();
	void on_splitter_moved();

	void on_zoom_in_shortcut_triggered();
	void on_zoom_out_shortcut_triggered();
	void on_scroll_to_start_shortcut_triggered();
	void on_scroll_to_end_shortcut_triggered();

	void h_scroll_value_changed(int value);
	void v_scroll_value_changed();

	void signals_changed();
	void capture_state_updated(int state);

	void on_new_segment(int new_segment_id);
	void on_segment_completed(int new_segment_id);
	void on_segment_changed(int segment);

	void on_settingViewTriggerIsZeroTime_changed(const QVariant new_value);

	virtual void perform_delayed_view_update();

	void process_sticky_events();

	/**
	 * Sets the 'offset_' and ruler_offset_ members and emits the 'offset_changed'
	 * signal if needed.
	 */
	void set_offset(const pv::util::Timestamp& offset, bool force_update = false);

	/**
	 * Sets the 'scale_' member and emits the 'scale_changed'
	 * signal if needed.
	 */
	void set_scale(double scale);

	/**
	 * Sets the 'tick_prefix_' member and emits the 'tick_prefix_changed'
	 * signal if needed.
	 */
	void set_tick_prefix(pv::util::SIPrefix tick_prefix);

	/**
	 * Sets the 'tick_precision_' member and emits the 'tick_precision_changed'
	 * signal if needed.
	 */
	void set_tick_precision(unsigned tick_precision);

	/**
	 * Sets the 'tick_period_' member and emits the 'tick_period_changed'
	 * signal if needed.
	 */
	void set_tick_period(const pv::util::Timestamp& tick_period);

	/**
	 * Sets the 'time_unit' member and emits the 'time_unit_changed'
	 * signal if needed.
	 */
	void set_time_unit(pv::util::TimeUnit time_unit);

	/**
	 * Sets the current segment with the first segment starting at 0.
	 */
	void set_current_segment(uint32_t segment_id);

private:
	CustomScrollArea *scrollarea_;
	Viewport *viewport_;
	Ruler *ruler_;
	Header *header_;
	QSplitter *splitter_;

	QShortcut *zoom_in_shortcut_, *zoom_in_shortcut_2_;
	QShortcut *zoom_out_shortcut_, *zoom_out_shortcut_2_;
	QShortcut *home_shortcut_, *end_shortcut_;

	unordered_set< shared_ptr<Signal> > signals_;

#ifdef ENABLE_DECODE
	vector< shared_ptr<DecodeTrace> > decode_traces_;
#endif

	Trace::SegmentDisplayMode segment_display_mode_;

	/// Signals whether the user can change the currently shown segment.
	bool segment_selectable_;

	/// The view time scale in seconds per pixel.
	double scale_;

	/// The internal view version of the time offset in seconds.
	pv::util::Timestamp offset_;
	/// The ruler version of the time offset in seconds.
	pv::util::Timestamp ruler_offset_;
	/// The offset of the zero point in seconds.
	pv::util::Timestamp zero_offset_;

	bool updating_scroll_;
	bool settings_restored_;
	bool header_was_shrunk_;

	bool sticky_scrolling_;
	bool colored_bg_;
	bool always_zoom_to_fit_;

	pv::util::Timestamp tick_period_;
	pv::util::SIPrefix tick_prefix_;
	unsigned int minor_tick_count_;
	unsigned int tick_precision_;
	util::TimeUnit time_unit_;

	bool show_cursors_;
	shared_ptr<CursorPair> cursors_;

	list< shared_ptr<Flag> > flags_;
	char next_flag_text_;

	vector< shared_ptr<TriggerMarker> > trigger_markers_;

	QWidget* hover_widget_;
	QPoint hover_point_;
	shared_ptr<Signal> signal_under_mouse_cursor_;
	uint16_t snap_distance_;

	unsigned int sticky_events_;
	QTimer lazy_event_handler_;

	// This is true when the defaults couldn't be set due to insufficient info
	bool scroll_needs_defaults_;

	// A nonzero value indicates the v offset to restore. See View::resizeEvent()
	int saved_v_offset_;

	// These are used to determine whether the view was altered after acq started
	double scale_at_acq_start_;
	pv::util::Timestamp offset_at_acq_start_;

	// Used to suppress performing a "zoom to fit" when the session stops. This
	// is needed when the view's settings are restored before acquisition ends.
	// In that case we want to keep the restored settings, not have a "zoom to fit"
	// mess them up.
	bool suppress_zoom_to_fit_after_acq_;
};

} // namespace trace
} // namespace views
} // namespace pv

#endif // PULSEVIEW_PV_VIEWS_TRACEVIEW_VIEW_HPP