ruler.hpp

Go to the documentation of this file.

/*
 * 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_TRACE_RULER_HPP
#define PULSEVIEW_PV_VIEWS_TRACE_RULER_HPP

#include <functional>
#include <memory>

#include <boost/optional.hpp>

#include "marginwidget.hpp"
#include <pv/util.hpp>

using std::function;
using std::pair;
using std::shared_ptr;
using std::vector;

namespace RulerTest {
struct tick_position_test_0;
struct tick_position_test_1;
struct tick_position_test_2;
}

namespace pv {
namespace views {
namespace trace {

class TimeItem;
class ViewItem;

struct TickPositions
{
    vector<pair<double, QString>> major;
    vector<double> minor;
};

class Ruler : public MarginWidget
{
    Q_OBJECT

    friend struct RulerTest::tick_position_test_0;
    friend struct RulerTest::tick_position_test_1;
    friend struct RulerTest::tick_position_test_2;

private:
    static const float RulerHeight;

    static const float HoverArrowSize;

public:
    Ruler(View &parent);

    QSize sizeHint() const override;

    QSize extended_size_hint() const override;

    static QString format_time_with_distance(
        const pv::util::Timestamp& distance,
        const pv::util::Timestamp& t,
        pv::util::SIPrefix prefix = pv::util::SIPrefix::unspecified,
        pv::util::TimeUnit unit = pv::util::TimeUnit::Time,
        unsigned precision = 0,
        bool sign = true);

    pv::util::Timestamp get_absolute_time_from_x_pos(uint32_t x) const;
    pv::util::Timestamp get_ruler_time_from_x_pos(uint32_t x) const;

    pv::util::Timestamp get_ruler_time_from_absolute_time(const pv::util::Timestamp& abs_time) const;
    pv::util::Timestamp get_absolute_time_from_ruler_time(const pv::util::Timestamp& ruler_time) const;

    shared_ptr<TimeItem> get_reference_item() const;

protected:
    virtual void contextMenuEvent(QContextMenuEvent *event) override;
    void resizeEvent(QResizeEvent*) override;
    virtual void item_hover(const shared_ptr<ViewItem> &item, QPoint pos) override;

private:
    vector< shared_ptr<ViewItem> > items() override;

    shared_ptr<ViewItem> get_mouse_over_item(const QPoint &pt) override;

    void mouseDoubleClickEvent(QMouseEvent *event) override;

    void paintEvent(QPaintEvent *event) override;

    void draw_hover_mark(QPainter &p, int text_height);

    int calculate_text_height() const;

    static TickPositions calculate_tick_positions(
        const pv::util::Timestamp& major_period,
        const pv::util::Timestamp& offset,
        const double scale,
        const int width,
        const unsigned int minor_tick_count,
        function<QString(const pv::util::Timestamp&)> format_function);

private Q_SLOTS:
    void on_hover_point_changed(const QWidget* widget, const QPoint &hp);

    void invalidate_tick_position_cache();

    void on_createMarker();
    void on_setZeroPosition();
    void on_resetZeroPosition();
    void on_toggleHoverMarker();

private:
    boost::optional<TickPositions> tick_position_cache_;

    shared_ptr<TimeItem> hover_item_;

    uint32_t context_menu_x_pos_;
};

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

#endif // PULSEVIEW_PV_VIEWS_TRACE_RULER_HPP