]> sigrok.org Git - pulseview.git/blobdiff - pv/views/trace/cursorpair.cpp
Fix #1290 by allowing the cursor to show samples
[pulseview.git] / pv / views / trace / cursorpair.cpp
index 2ddecb278e6e86c8b7785d9402ad54a73f5454f3..81688337f94e238c8eaaf0310a54d5ced35a1ee4 100644 (file)
  * along with this program; if not, see <http://www.gnu.org/licenses/>.
  */
 
+#include <algorithm>
+#include <cassert>
+
+#include <QColor>
+#include <QMenu>
+#include <QToolTip>
+
 #include "cursorpair.hpp"
 
+#include "pv/globalsettings.hpp"
 #include "pv/util.hpp"
 #include "ruler.hpp"
 #include "view.hpp"
 
-#include <algorithm>
-#include <cassert>
-
 using std::max;
 using std::make_pair;
 using std::min;
@@ -37,13 +42,32 @@ namespace views {
 namespace trace {
 
 const int CursorPair::DeltaPadding = 8;
-const QColor CursorPair::ViewportFillColour(220, 231, 243);
 
 CursorPair::CursorPair(View &view) :
        TimeItem(view),
        first_(new Cursor(view, 0.0)),
-       second_(new Cursor(view, 1.0))
+       second_(new Cursor(view, 1.0)),
+       label_incomplete_(true)
+{
+       GlobalSettings::add_change_handler(this);
+
+       GlobalSettings settings;
+       fill_color_ = QColor::fromRgba(settings.value(
+               GlobalSettings::Key_View_CursorFillColor).value<uint32_t>());
+       show_frequency_ = settings.value(
+               GlobalSettings::Key_View_CursorShowFrequency).value<bool>();
+       show_interval_ = settings.value(
+               GlobalSettings::Key_View_CursorShowInterval).value<bool>();
+       show_samples_ = settings.value(
+               GlobalSettings::Key_View_CursorShowSamples).value<bool>();
+
+       connect(&view_, SIGNAL(hover_point_changed(const QWidget*, QPoint)),
+               this, SLOT(on_hover_point_changed(const QWidget*, QPoint)));
+}
+
+CursorPair::~CursorPair()
 {
+       GlobalSettings::remove_change_handler(this);
 }
 
 bool CursorPair::enabled() const
@@ -68,11 +92,24 @@ void CursorPair::set_time(const pv::util::Timestamp& time)
        second_->set_time(time + delta);
 }
 
+const pv::util::Timestamp CursorPair::time() const
+{
+       return 0;
+}
+
 float CursorPair::get_x() const
 {
        return (first_->get_x() + second_->get_x()) / 2.0f;
 }
 
+const pv::util::Timestamp CursorPair::delta(const pv::util::Timestamp& other) const
+{
+       if (other < second_->time())
+               return other - first_->time();
+       else
+               return other - second_->time();
+}
+
 QPoint CursorPair::drag_point(const QRect &rect) const
 {
        return first_->drag_point(rect);
@@ -84,6 +121,46 @@ pv::widgets::Popup* CursorPair::create_popup(QWidget *parent)
        return nullptr;
 }
 
+QMenu *CursorPair::create_header_context_menu(QWidget *parent)
+{
+       QMenu *menu = new QMenu(parent);
+
+       QAction *displayIntervalAction = new QAction(tr("Display interval"));
+       displayIntervalAction->setCheckable(true);
+       displayIntervalAction->setChecked(show_interval_);
+       menu->addAction(displayIntervalAction);
+
+       connect(displayIntervalAction, &QAction::toggled, [=]{
+               GlobalSettings settings;
+               settings.setValue(GlobalSettings::Key_View_CursorShowInterval,
+                       !settings.value(GlobalSettings::Key_View_CursorShowInterval).value<bool>());
+               });
+
+       QAction *displayFrequencyAction = new QAction(tr("Display frequency"));
+       displayFrequencyAction->setCheckable(true);
+       displayFrequencyAction->setChecked(show_frequency_);
+       menu->addAction(displayFrequencyAction);
+
+       connect(displayFrequencyAction, &QAction::toggled, [=]{
+               GlobalSettings settings;
+               settings.setValue(GlobalSettings::Key_View_CursorShowFrequency,
+                       !settings.value(GlobalSettings::Key_View_CursorShowFrequency).value<bool>());
+               });
+
+       QAction *displaySamplesAction = new QAction(tr("Display samples"));
+       displaySamplesAction->setCheckable(true);
+       displaySamplesAction->setChecked(show_samples_);
+       menu->addAction(displaySamplesAction);
+
+       connect(displaySamplesAction, &QAction::toggled, [=]{
+               GlobalSettings settings;
+               settings.setValue(GlobalSettings::Key_View_CursorShowSamples,
+                       !settings.value(GlobalSettings::Key_View_CursorShowSamples).value<bool>());
+               });
+
+       return menu;
+}
+
 QRectF CursorPair::label_rect(const QRectF &rect) const
 {
        const QSizeF label_size(text_size_ + LabelPadding * 2);
@@ -110,38 +187,36 @@ void CursorPair::paint_label(QPainter &p, const QRect &rect, bool hover)
        if (!enabled())
                return;
 
-       const QColor text_colour =
-               ViewItem::select_text_colour(Cursor::FillColour);
+       const QColor text_color = ViewItem::select_text_color(Cursor::FillColor);
+       p.setPen(text_color);
 
-       p.setPen(text_colour);
-       compute_text_size(p);
        QRectF delta_rect(label_rect(rect));
-
        const int radius = delta_rect.height() / 2;
-       const QRectF text_rect(delta_rect.intersected(
-               rect).adjusted(radius, 0, -radius, 0));
-       if (text_rect.width() >= text_size_.width()) {
-               const int highlight_radius = delta_rect.height() / 2 - 2;
-
-               if (selected()) {
-                       p.setBrush(Qt::transparent);
-                       p.setPen(highlight_pen());
-                       p.drawRoundedRect(delta_rect, radius, radius);
-               }
+       QRectF text_rect(delta_rect.intersected(rect).adjusted(radius, 0, -radius, 0));
 
-               p.setBrush(hover ? Cursor::FillColour.lighter() :
-                       Cursor::FillColour);
-               p.setPen(Cursor::FillColour.darker());
-               p.drawRoundedRect(delta_rect, radius, radius);
+       QString text = format_string(text_rect.width(),
+               [&p](const QString& s) -> double { return p.boundingRect(QRectF(), 0, s).width(); });
 
-               delta_rect.adjust(1, 1, -1, -1);
-               p.setPen(Cursor::FillColour.lighter());
-               p.drawRoundedRect(delta_rect, highlight_radius, highlight_radius);
+       text_size_ = p.boundingRect(QRectF(), 0, text).size();
 
-               p.setPen(text_colour);
-               p.drawText(text_rect, Qt::AlignCenter | Qt::AlignVCenter,
-                       format_string());
+       if (selected()) {
+               p.setBrush(Qt::transparent);
+               p.setPen(highlight_pen());
+               p.drawRoundedRect(delta_rect, radius, radius);
        }
+
+       p.setBrush(hover ? Cursor::FillColor.lighter() : Cursor::FillColor);
+       p.setPen(Cursor::FillColor.darker());
+       p.drawRoundedRect(delta_rect, radius, radius);
+
+       delta_rect.adjust(1, 1, -1, -1);
+       p.setPen(Cursor::FillColor.lighter());
+       const int highlight_radius = delta_rect.height() / 2 - 2;
+       p.drawRoundedRect(delta_rect, highlight_radius, highlight_radius);
+       label_area_ = delta_rect;
+
+       p.setPen(text_color);
+       p.drawText(text_rect, Qt::AlignCenter | Qt::AlignVCenter, text);
 }
 
 void CursorPair::paint_back(QPainter &p, ViewItemPaintParams &pp)
@@ -150,36 +225,57 @@ void CursorPair::paint_back(QPainter &p, ViewItemPaintParams &pp)
                return;
 
        p.setPen(Qt::NoPen);
-       p.setBrush(QBrush(ViewportFillColour));
+       p.setBrush(fill_color_);
 
        const pair<float, float> offsets(get_cursor_offsets());
-       const int l = (int)max(min(
-               offsets.first, offsets.second), 0.0f);
-       const int r = (int)min(max(
-               offsets.first, offsets.second), (float)pp.width());
+       const int l = (int)max(min(offsets.first, offsets.second), 0.0f);
+       const int r = (int)min(max(offsets.first, offsets.second), (float)pp.width());
 
        p.drawRect(l, pp.top(), r - l, pp.height());
 }
 
-QString CursorPair::format_string()
+QString CursorPair::format_string(int max_width, std::function<double(const QString&)> query_size)
 {
-       const pv::util::SIPrefix prefix = view_.tick_prefix();
-       const pv::util::Timestamp diff = abs(second_->time() - first_->time());
+       int time_precision = 12;
+       int freq_precision = 12;
 
-       const QString s1 = Ruler::format_time_with_distance(
-               diff, diff, prefix, view_.time_unit(), view_.tick_precision(), false);
-       const QString s2 = util::format_time_si(
-               1 / diff, pv::util::SIPrefix::unspecified, 4, "Hz", false);
+       QString s = format_string_sub(time_precision, freq_precision);
 
-       return QString("%1 / %2").arg(s1).arg(s2);
-}
+       // Try full "{time} s / {freq} Hz" format
+       if ((max_width <= 0) || (query_size(s) <= max_width)) {
+               label_incomplete_ = false;
+               return s;
+       }
 
-void CursorPair::compute_text_size(QPainter &p)
-{
-       assert(first_);
-       assert(second_);
+       label_incomplete_ = true;
 
-       text_size_ = p.boundingRect(QRectF(), 0, format_string()).size();
+       // Gradually reduce time precision to match frequency precision
+       while (time_precision > freq_precision) {
+               time_precision--;
+
+               s = format_string_sub(time_precision, freq_precision);
+               if (query_size(s) <= max_width)
+                       return s;
+       }
+
+       // Gradually reduce both precisions down to zero
+       while (time_precision > 0) {
+               time_precision--;
+               freq_precision--;
+
+               s = format_string_sub(time_precision, freq_precision);
+               if (query_size(s) <= max_width)
+                       return s;
+       }
+
+       // Try no trailing digits and drop the unit to at least display something
+       s = format_string_sub(0, 0, false);
+
+       if (query_size(s) <= max_width)
+               return s;
+
+       // Give up
+       return "...";
 }
 
 pair<float, float> CursorPair::get_cursor_offsets() const
@@ -190,6 +286,81 @@ pair<float, float> CursorPair::get_cursor_offsets() const
        return pair<float, float>(first_->get_x(), second_->get_x());
 }
 
+void CursorPair::on_setting_changed(const QString &key, const QVariant &value)
+{
+       if (key == GlobalSettings::Key_View_CursorFillColor)
+               fill_color_ = QColor::fromRgba(value.value<uint32_t>());
+
+       if (key == GlobalSettings::Key_View_CursorShowFrequency)
+               show_frequency_ = value.value<bool>();
+
+       if (key == GlobalSettings::Key_View_CursorShowInterval)
+               show_interval_ = value.value<bool>();
+
+       if (key == GlobalSettings::Key_View_CursorShowSamples)
+               show_samples_ = value.value<bool>();
+}
+
+void CursorPair::on_hover_point_changed(const QWidget* widget, const QPoint& hp)
+{
+       if (widget != view_.ruler())
+               return;
+
+       if (!label_incomplete_)
+               return;
+
+       if (label_area_.contains(hp))
+               QToolTip::showText(view_.mapToGlobal(hp), format_string());
+       else
+               QToolTip::hideText();  // TODO Will break other tooltips when there can be others
+}
+
+QString CursorPair::format_string_sub(int time_precision, int freq_precision, bool show_unit)
+{
+       QString s = " ";
+
+       const pv::util::SIPrefix prefix = view_.tick_prefix();
+       const pv::util::Timestamp diff = abs(second_->time() - first_->time());
+
+       const QString time = Ruler::format_time_with_distance(
+               diff, diff, prefix, (show_unit ? view_.time_unit() : pv::util::TimeUnit::None),
+               time_precision, false);
+
+       // We can only show a frequency when there's a time base
+       if (view_.time_unit() == pv::util::TimeUnit::Time) {
+               int items = 0;
+
+               if (show_frequency_) {
+                       const QString freq = util::format_value_si(
+                               1 / diff.convert_to<double>(), pv::util::SIPrefix::unspecified,
+                               freq_precision, (show_unit ? "Hz" : nullptr), false);
+                       s = QString("%1").arg(freq);
+                       items++;
+               }
+
+               if (show_interval_) {
+                       if (items > 0)
+                               s = QString("%1 / %2").arg(s, time);
+                       else
+                               s = QString("%1").arg(time);
+                       items++;
+               }
+
+               if (show_samples_) {
+                       const QString samples = QString::number(
+                               (diff * view_.session().get_samplerate()).convert_to<uint64_t>());
+                       if (items > 0)
+                               s = QString("%1 / %2").arg(s, samples);
+                       else
+                               s = QString("%1").arg(samples);
+               }
+       } else
+               // In this case, we return the number of samples, really
+               s = time;
+
+       return s;
+}
+
 } // namespace trace
 } // namespace views
 } // namespace pv