pv/views/trace/cursorpair.cpp

   1 /*
   2  * This file is part of the PulseView project.
   3  *
   4  * Copyright (C) 2013 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 #include <algorithm>
  21 #include <cassert>
  22
  23 #include <QColor>
  24 #include <QMenu>
  25 #include <QToolTip>
  26
  27 #include "cursorpair.hpp"
  28
  29 #include "pv/globalsettings.hpp"
  30 #include "pv/util.hpp"
  31 #include "ruler.hpp"
  32 #include "view.hpp"
  33
  34 using std::max;
  35 using std::make_pair;
  36 using std::min;
  37 using std::shared_ptr;
  38 using std::pair;
  39
  40 namespace pv {
  41 namespace views {
  42 namespace trace {
  43
  44 const int CursorPair::DeltaPadding = 8;
  45
  46 CursorPair::CursorPair(View &view) :
  47         TimeItem(view),
  48         first_(new Cursor(view, 0.0)),
  49         second_(new Cursor(view, 1.0)),
  50         label_incomplete_(true)
  51 {
  52         GlobalSettings::add_change_handler(this);
  53
  54         GlobalSettings settings;
  55         fill_color_ = QColor::fromRgba(settings.value(
  56                 GlobalSettings::Key_View_CursorFillColor).value<uint32_t>());
  57         show_frequency_ = settings.value(
  58                 GlobalSettings::Key_View_CursorShowFrequency).value<bool>();
  59         show_interval_ = settings.value(
  60                 GlobalSettings::Key_View_CursorShowInterval).value<bool>();
  61
  62         connect(&view_, SIGNAL(hover_point_changed(const QWidget*, QPoint)),
  63                 this, SLOT(on_hover_point_changed(const QWidget*, QPoint)));
  64 }
  65
  66 CursorPair::~CursorPair()
  67 {
  68         GlobalSettings::remove_change_handler(this);
  69 }
  70
  71 bool CursorPair::enabled() const
  72 {
  73         return view_.cursors_shown();
  74 }
  75
  76 shared_ptr<Cursor> CursorPair::first() const
  77 {
  78         return first_;
  79 }
  80
  81 shared_ptr<Cursor> CursorPair::second() const
  82 {
  83         return second_;
  84 }
  85
  86 void CursorPair::set_time(const pv::util::Timestamp& time)
  87 {
  88         const pv::util::Timestamp delta = second_->time() - first_->time();
  89         first_->set_time(time);
  90         second_->set_time(time + delta);
  91 }
  92
  93 const pv::util::Timestamp CursorPair::time() const
  94 {
  95         return 0;
  96 }
  97
  98 float CursorPair::get_x() const
  99 {
 100         return (first_->get_x() + second_->get_x()) / 2.0f;
 101 }
 102
 103 const pv::util::Timestamp CursorPair::delta(const pv::util::Timestamp& other) const
 104 {
 105         if (other < second_->time())
 106                 return other - first_->time();
 107         else
 108                 return other - second_->time();
 109 }
 110
 111 QPoint CursorPair::drag_point(const QRect &rect) const
 112 {
 113         return first_->drag_point(rect);
 114 }
 115
 116 pv::widgets::Popup* CursorPair::create_popup(QWidget *parent)
 117 {
 118         (void)parent;
 119         return nullptr;
 120 }
 121
 122 QMenu *CursorPair::create_header_context_menu(QWidget *parent)
 123 {
 124         QMenu *menu = new QMenu(parent);
 125
 126         QAction *displayIntervalAction = new QAction(tr("Display interval"));
 127         displayIntervalAction->setCheckable(true);
 128         displayIntervalAction->setChecked(show_interval_);
 129         menu->addAction(displayIntervalAction);
 130
 131         connect(displayIntervalAction, &QAction::toggled, [=]{
 132                 GlobalSettings settings;
 133                 settings.setValue(GlobalSettings::Key_View_CursorShowInterval,
 134                         !settings.value(GlobalSettings::Key_View_CursorShowInterval).value<bool>());
 135                 });
 136
 137         QAction *displayFrequencyAction = new QAction(tr("Display frequency"));
 138         displayFrequencyAction->setCheckable(true);
 139         displayFrequencyAction->setChecked(show_frequency_);
 140         menu->addAction(displayFrequencyAction);
 141
 142         connect(displayFrequencyAction, &QAction::toggled, [=]{
 143                 GlobalSettings settings;
 144                 settings.setValue(GlobalSettings::Key_View_CursorShowFrequency,
 145                         !settings.value(GlobalSettings::Key_View_CursorShowFrequency).value<bool>());
 146                 });
 147
 148         return menu;
 149 }
 150
 151 QRectF CursorPair::label_rect(const QRectF &rect) const
 152 {
 153         const QSizeF label_size(text_size_ + LabelPadding * 2);
 154         const pair<float, float> offsets(get_cursor_offsets());
 155         const pair<float, float> normal_offsets(
 156                 (offsets.first < offsets.second) ? offsets :
 157                 make_pair(offsets.second, offsets.first));
 158
 159         const float height = label_size.height();
 160         const float left = max(normal_offsets.first + DeltaPadding, -height);
 161         const float right = min(normal_offsets.second - DeltaPadding,
 162                 (float)rect.width() + height);
 163
 164         return QRectF(left, rect.height() - label_size.height() -
 165                 TimeMarker::ArrowSize - 0.5f,
 166                 right - left, height);
 167 }
 168
 169 void CursorPair::paint_label(QPainter &p, const QRect &rect, bool hover)
 170 {
 171         assert(first_);
 172         assert(second_);
 173
 174         if (!enabled())
 175                 return;
 176
 177         const QColor text_color = ViewItem::select_text_color(Cursor::FillColor);
 178         p.setPen(text_color);
 179
 180         QRectF delta_rect(label_rect(rect));
 181         const int radius = delta_rect.height() / 2;
 182         QRectF text_rect(delta_rect.intersected(rect).adjusted(radius, 0, -radius, 0));
 183
 184         QString text = format_string(text_rect.width(),
 185                 [&p](const QString& s) -> double { return p.boundingRect(QRectF(), 0, s).width(); });
 186
 187         text_size_ = p.boundingRect(QRectF(), 0, text).size();
 188
 189         if (selected()) {
 190                 p.setBrush(Qt::transparent);
 191                 p.setPen(highlight_pen());
 192                 p.drawRoundedRect(delta_rect, radius, radius);
 193         }
 194
 195         p.setBrush(hover ? Cursor::FillColor.lighter() : Cursor::FillColor);
 196         p.setPen(Cursor::FillColor.darker());
 197         p.drawRoundedRect(delta_rect, radius, radius);
 198
 199         delta_rect.adjust(1, 1, -1, -1);
 200         p.setPen(Cursor::FillColor.lighter());
 201         const int highlight_radius = delta_rect.height() / 2 - 2;
 202         p.drawRoundedRect(delta_rect, highlight_radius, highlight_radius);
 203         label_area_ = delta_rect;
 204
 205         p.setPen(text_color);
 206         p.drawText(text_rect, Qt::AlignCenter | Qt::AlignVCenter, text);
 207 }
 208
 209 void CursorPair::paint_back(QPainter &p, ViewItemPaintParams &pp)
 210 {
 211         if (!enabled())
 212                 return;
 213
 214         p.setPen(Qt::NoPen);
 215         p.setBrush(fill_color_);
 216
 217         const pair<float, float> offsets(get_cursor_offsets());
 218         const int l = (int)max(min(offsets.first, offsets.second), 0.0f);
 219         const int r = (int)min(max(offsets.first, offsets.second), (float)pp.width());
 220
 221         p.drawRect(l, pp.top(), r - l, pp.height());
 222 }
 223
 224 QString CursorPair::format_string(int max_width, std::function<double(const QString&)> query_size)
 225 {
 226         int time_precision = 12;
 227         int freq_precision = 12;
 228
 229         QString s = format_string_sub(time_precision, freq_precision);
 230
 231         // Try full "{time} s / {freq} Hz" format
 232         if ((max_width <= 0) || (query_size(s) <= max_width)) {
 233                 label_incomplete_ = false;
 234                 return s;
 235         }
 236
 237         label_incomplete_ = true;
 238
 239         // Gradually reduce time precision to match frequency precision
 240         while (time_precision > freq_precision) {
 241                 time_precision--;
 242
 243                 s = format_string_sub(time_precision, freq_precision);
 244                 if (query_size(s) <= max_width)
 245                         return s;
 246         }
 247
 248         // Gradually reduce both precisions down to zero
 249         while (time_precision > 0) {
 250                 time_precision--;
 251                 freq_precision--;
 252
 253                 s = format_string_sub(time_precision, freq_precision);
 254                 if (query_size(s) <= max_width)
 255                         return s;
 256         }
 257
 258         // Try no trailing digits and drop the unit to at least display something
 259         s = format_string_sub(0, 0, false);
 260
 261         if (query_size(s) <= max_width)
 262                 return s;
 263
 264         // Give up
 265         return "...";
 266 }
 267
 268 pair<float, float> CursorPair::get_cursor_offsets() const
 269 {
 270         assert(first_);
 271         assert(second_);
 272
 273         return pair<float, float>(first_->get_x(), second_->get_x());
 274 }
 275
 276 void CursorPair::on_setting_changed(const QString &key, const QVariant &value)
 277 {
 278         if (key == GlobalSettings::Key_View_CursorFillColor)
 279                 fill_color_ = QColor::fromRgba(value.value<uint32_t>());
 280
 281         if (key == GlobalSettings::Key_View_CursorShowFrequency)
 282                 show_frequency_ = value.value<bool>();
 283
 284         if (key == GlobalSettings::Key_View_CursorShowInterval)
 285                 show_interval_ = value.value<bool>();
 286 }
 287
 288 void CursorPair::on_hover_point_changed(const QWidget* widget, const QPoint& hp)
 289 {
 290         if (widget != view_.ruler())
 291                 return;
 292
 293         if (!label_incomplete_)
 294                 return;
 295
 296         if (label_area_.contains(hp))
 297                 QToolTip::showText(view_.mapToGlobal(hp), format_string());
 298         else
 299                 QToolTip::hideText();  // TODO Will break other tooltips when there can be others
 300 }
 301
 302 QString CursorPair::format_string_sub(int time_precision, int freq_precision, bool show_unit)
 303 {
 304         QString s = " ";
 305
 306         const pv::util::SIPrefix prefix = view_.tick_prefix();
 307         const pv::util::Timestamp diff = abs(second_->time() - first_->time());
 308
 309         const QString time = Ruler::format_time_with_distance(
 310                 diff, diff, prefix, (show_unit ? view_.time_unit() : pv::util::TimeUnit::None),
 311                 time_precision, false);
 312
 313         // We can only show a frequency when there's a time base
 314         if (view_.time_unit() == pv::util::TimeUnit::Time) {
 315                 int items = 0;
 316
 317                 if (show_frequency_) {
 318                         const QString freq = util::format_value_si(
 319                                 1 / diff.convert_to<double>(), pv::util::SIPrefix::unspecified,
 320                                 freq_precision, (show_unit ? "Hz" : nullptr), false);
 321                         s = QString("%1").arg(freq);
 322                         items++;
 323                 }
 324
 325                 if (show_interval_) {
 326                         if (items > 0)
 327                                 s = QString("%1 / %2").arg(s, time);
 328                         else
 329                                 s = QString("%1").arg(time);
 330                         items++;
 331                 }
 332         } else
 333                 // In this case, we return the number of samples, really
 334                 s = time;
 335
 336         return s;
 337 }
 338
 339 } // namespace trace
 340 } // namespace views
 341 } // namespace pv