pv/views/trace/ruler.cpp

   1 /*
   2  * This file is part of the PulseView project.
   3  *
   4  * Copyright (C) 2012 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 <extdef.h>
  21
  22 #include <QApplication>
  23 #include <QFontMetrics>
  24 #include <QMenu>
  25 #include <QMouseEvent>
  26
  27 #include <pv/globalsettings.hpp>
  28
  29 #include "ruler.hpp"
  30 #include "view.hpp"
  31
  32 using namespace Qt;
  33
  34 using std::function;
  35 using std::max;
  36 using std::min;
  37 using std::shared_ptr;
  38 using std::vector;
  39
  40 namespace pv {
  41 namespace views {
  42 namespace trace {
  43
  44 const float Ruler::RulerHeight = 2.5f; // x Text Height
  45
  46 const float Ruler::HoverArrowSize = 0.5f; // x Text Height
  47
  48 Ruler::Ruler(View &parent) :
  49         MarginWidget(parent)
  50 {
  51         setMouseTracking(true);
  52
  53         connect(&view_, SIGNAL(hover_point_changed(const QWidget*, QPoint)),
  54                 this, SLOT(on_hover_point_changed(const QWidget*, QPoint)));
  55         connect(&view_, SIGNAL(offset_changed()),
  56                 this, SLOT(invalidate_tick_position_cache()));
  57         connect(&view_, SIGNAL(scale_changed()),
  58                 this, SLOT(invalidate_tick_position_cache()));
  59         connect(&view_, SIGNAL(tick_prefix_changed()),
  60                 this, SLOT(invalidate_tick_position_cache()));
  61         connect(&view_, SIGNAL(tick_precision_changed()),
  62                 this, SLOT(invalidate_tick_position_cache()));
  63         connect(&view_, SIGNAL(tick_period_changed()),
  64                 this, SLOT(invalidate_tick_position_cache()));
  65         connect(&view_, SIGNAL(time_unit_changed()),
  66                 this, SLOT(invalidate_tick_position_cache()));
  67 }
  68
  69 QSize Ruler::sizeHint() const
  70 {
  71         const int text_height = calculate_text_height();
  72         return QSize(0, RulerHeight * text_height);
  73 }
  74
  75 QSize Ruler::extended_size_hint() const
  76 {
  77         QRectF max_rect;
  78         vector< shared_ptr<TimeItem> > items(view_.time_items());
  79         for (auto &i : items)
  80                 max_rect = max_rect.united(i->label_rect(QRect()));
  81         return QSize(0, sizeHint().height() - max_rect.top() / 2 +
  82                 ViewItem::HighlightRadius);
  83 }
  84
  85 QString Ruler::format_time_with_distance(
  86         const pv::util::Timestamp& distance,
  87         const pv::util::Timestamp& t,
  88         pv::util::SIPrefix prefix,
  89         pv::util::TimeUnit unit,
  90         unsigned precision,
  91         bool sign)
  92 {
  93         const unsigned limit = 60;
  94
  95         if (t.is_zero())
  96                 return "0";
  97
  98         // If we have to use samples then we have no alternative formats
  99         if (unit == pv::util::TimeUnit::Samples)
 100                 return pv::util::format_time_si_adjusted(t, prefix, precision, "sa", sign);
 101
 102         QString unit_string;
 103         if (unit == pv::util::TimeUnit::Time)
 104                 unit_string = "s";
 105         // Note: In case of pv::util::TimeUnit::None, unit_string remains empty
 106
 107         // View zoomed way out -> low precision (0), big distance (>=60s)
 108         // -> DD:HH:MM
 109         if ((precision == 0) && (distance >= limit))
 110                 return pv::util::format_time_minutes(t, 0, sign);
 111
 112         // View in "normal" range -> medium precision, medium step size
 113         // -> HH:MM:SS.mmm... or xxxx (si unit) if less than limit seconds
 114         // View zoomed way in -> high precision (>3), low step size (<1s)
 115         // -> HH:MM:SS.mmm... or xxxx (si unit) if less than limit seconds
 116         if (abs(t) < limit)
 117                 return pv::util::format_time_si_adjusted(t, prefix, precision, unit_string, sign);
 118         else
 119                 return pv::util::format_time_minutes(t, precision, sign);
 120 }
 121
 122 pv::util::Timestamp Ruler::get_absolute_time_from_x_pos(uint32_t x) const
 123 {
 124         return view_.offset() + ((double)x + 0.5) * view_.scale();
 125 }
 126
 127 pv::util::Timestamp Ruler::get_ruler_time_from_x_pos(uint32_t x) const
 128 {
 129         return view_.ruler_offset() + ((double)x + 0.5) * view_.scale();
 130 }
 131
 132 pv::util::Timestamp Ruler::get_ruler_time_from_absolute_time(const pv::util::Timestamp& abs_time) const
 133 {
 134         return abs_time + view_.zero_offset();
 135 }
 136
 137 pv::util::Timestamp Ruler::get_absolute_time_from_ruler_time(const pv::util::Timestamp& ruler_time) const
 138 {
 139         return ruler_time - view_.zero_offset();
 140 }
 141
 142 void Ruler::contextMenuEvent(QContextMenuEvent *event)
 143 {
 144         MarginWidget::contextMenuEvent(event);
 145
 146         // Don't show a context menu if the MarginWidget found a widget that shows one
 147         if (event->isAccepted())
 148                 return;
 149
 150         context_menu_x_pos_ = event->pos().x();
 151
 152         QMenu *const menu = new QMenu(this);
 153
 154         QAction *const create_marker = new QAction(tr("Create marker here"), this);
 155         connect(create_marker, SIGNAL(triggered()), this, SLOT(on_createMarker()));
 156         menu->addAction(create_marker);
 157
 158         QAction *const set_zero_position = new QAction(tr("Set as zero point"), this);
 159         connect(set_zero_position, SIGNAL(triggered()), this, SLOT(on_setZeroPosition()));
 160         menu->addAction(set_zero_position);
 161
 162         QAction *const toggle_hover_marker = new QAction(this);
 163         connect(toggle_hover_marker, SIGNAL(triggered()), this, SLOT(on_toggleHoverMarker()));
 164         menu->addAction(toggle_hover_marker);
 165
 166         GlobalSettings settings;
 167         const bool hover_marker_shown =
 168                 settings.value(GlobalSettings::Key_View_ShowHoverMarker).toBool();
 169         toggle_hover_marker->setText(hover_marker_shown ?
 170                 tr("Disable mouse hover marker") : tr("Enable mouse hover marker"));
 171
 172         event->setAccepted(true);
 173         menu->popup(event->globalPos());
 174 }
 175
 176 void Ruler::resizeEvent(QResizeEvent*)
 177 {
 178         // the tick calculation depends on the width of this widget
 179         invalidate_tick_position_cache();
 180 }
 181
 182 vector< shared_ptr<ViewItem> > Ruler::items()
 183 {
 184         const vector< shared_ptr<TimeItem> > time_items(view_.time_items());
 185         return vector< shared_ptr<ViewItem> >(
 186                 time_items.begin(), time_items.end());
 187 }
 188
 189 void Ruler::item_hover(const shared_ptr<ViewItem> &item, QPoint pos)
 190 {
 191         Q_UNUSED(pos);
 192         hover_item_ = dynamic_pointer_cast<TimeItem>(item);
 193 }
 194
 195 shared_ptr<TimeItem> Ruler::get_reference_item()
 196 {
 197         if (mouse_modifiers_ & Qt::ShiftModifier)
 198                 return nullptr;
 199
 200         if (hover_item_ != nullptr)
 201                 return hover_item_;
 202
 203         shared_ptr<TimeItem> found(nullptr);
 204         const vector< shared_ptr<TimeItem> > items(view_.time_items());
 205         for (auto i = items.rbegin(); i != items.rend(); i++) {
 206                 if ((*i)->enabled() && (*i)->selected()) {
 207                         if (found == nullptr)
 208                                 found = *i;
 209                         else
 210                                 return nullptr; // Return null if multiple items are selected
 211                 }
 212         }
 213
 214         return found;
 215 }
 216
 217 shared_ptr<ViewItem> Ruler::get_mouse_over_item(const QPoint &pt)
 218 {
 219         const vector< shared_ptr<TimeItem> > items(view_.time_items());
 220         for (auto i = items.rbegin(); i != items.rend(); i++)
 221                 if ((*i)->enabled() && (*i)->label_rect(rect()).contains(pt))
 222                         return *i;
 223         return nullptr;
 224 }
 225
 226 void Ruler::mouseDoubleClickEvent(QMouseEvent *event)
 227 {
 228         hover_item_ = view_.add_flag(get_absolute_time_from_x_pos(event->x()));
 229 }
 230
 231 void Ruler::paintEvent(QPaintEvent*)
 232 {
 233         if (!tick_position_cache_) {
 234                 auto ffunc = [this](const pv::util::Timestamp& t) {
 235                         return format_time_with_distance(
 236                                 this->view_.tick_period(),
 237                                 t,
 238                                 this->view_.tick_prefix(),
 239                                 this->view_.time_unit(),
 240                                 this->view_.tick_precision());
 241                 };
 242
 243                 tick_position_cache_ = calculate_tick_positions(
 244                         view_.tick_period(),
 245                         view_.ruler_offset(),
 246                         view_.scale(),
 247                         width(),
 248                         view_.minor_tick_count(),
 249                         ffunc);
 250         }
 251
 252         const int ValueMargin = 3;
 253
 254         const int text_height = calculate_text_height();
 255         const int ruler_height = RulerHeight * text_height;
 256         const int major_tick_y1 = text_height + ValueMargin * 2;
 257         const int minor_tick_y1 = (major_tick_y1 + ruler_height) / 2;
 258
 259         QPainter p(this);
 260
 261         // Draw the tick marks
 262         p.setPen(palette().color(foregroundRole()));
 263
 264         for (const auto& tick: tick_position_cache_->major) {
 265                 const int leftedge = 0;
 266                 const int rightedge = width();
 267                 const int x_tick = tick.first;
 268                 if ((x_tick > leftedge) && (x_tick < rightedge)) {
 269                         const int x_left_bound = QFontMetrics(font()).width(tick.second) / 2;
 270                         const int x_right_bound = rightedge - x_left_bound;
 271                         const int x_legend = min(max(x_tick, x_left_bound), x_right_bound);
 272                         p.drawText(x_legend, ValueMargin, 0, text_height,
 273                                 AlignCenter | AlignTop | TextDontClip, tick.second);
 274                         p.drawLine(QPointF(x_tick, major_tick_y1),
 275                         QPointF(tick.first, ruler_height));
 276                 }
 277         }
 278
 279         for (const auto& tick: tick_position_cache_->minor) {
 280                 p.drawLine(QPointF(tick, minor_tick_y1),
 281                                 QPointF(tick, ruler_height));
 282         }
 283
 284         // Draw the hover mark
 285         draw_hover_mark(p, text_height);
 286
 287         p.setRenderHint(QPainter::Antialiasing);
 288
 289         // The cursor labels are not drawn with the arrows exactly on the
 290         // bottom line of the widget, because then the selection shadow
 291         // would be clipped away.
 292         const QRect r = rect().adjusted(0, 0, 0, -ViewItem::HighlightRadius);
 293
 294         // Draw the items
 295         const vector< shared_ptr<TimeItem> > items(view_.time_items());
 296         for (auto &i : items) {
 297                 const bool highlight = !item_dragging_ &&
 298                         i->label_rect(r).contains(mouse_point_);
 299                 i->paint_label(p, r, highlight);
 300         }
 301 }
 302
 303 void Ruler::draw_hover_mark(QPainter &p, int text_height)
 304 {
 305         const int x = view_.hover_point().x();
 306
 307         if (x == -1)
 308                 return;
 309
 310         p.setPen(QPen(Qt::NoPen));
 311         p.setBrush(QBrush(palette().color(foregroundRole())));
 312
 313         const int b = RulerHeight * text_height;
 314         const float hover_arrow_size = HoverArrowSize * text_height;
 315         const QPointF points[] = {
 316                 QPointF(x, b),
 317                 QPointF(x - hover_arrow_size, b - hover_arrow_size),
 318                 QPointF(x + hover_arrow_size, b - hover_arrow_size)
 319         };
 320         p.drawPolygon(points, countof(points));
 321 }
 322
 323 int Ruler::calculate_text_height() const
 324 {
 325         return QFontMetrics(font()).ascent();
 326 }
 327
 328 TickPositions Ruler::calculate_tick_positions(
 329         const pv::util::Timestamp& major_period,
 330         const pv::util::Timestamp& offset,
 331         const double scale,
 332         const int width,
 333         const unsigned int minor_tick_count,
 334         function<QString(const pv::util::Timestamp&)> format_function)
 335 {
 336         TickPositions tp;
 337
 338         const pv::util::Timestamp minor_period = major_period / minor_tick_count;
 339         const pv::util::Timestamp first_major_division = floor(offset / major_period);
 340         const pv::util::Timestamp first_minor_division = ceil(offset / minor_period);
 341         const pv::util::Timestamp t0 = first_major_division * major_period;
 342
 343         int division = (round(first_minor_division -
 344                 first_major_division * minor_tick_count)).convert_to<int>() - 1;
 345
 346         double x;
 347
 348         do {
 349                 pv::util::Timestamp t = t0 + division * minor_period;
 350                 x = ((t - offset) / scale).convert_to<double>();
 351
 352                 if (division % minor_tick_count == 0) {
 353                         // Recalculate 't' without using 'minor_period' which is a fraction
 354                         t = t0 + division / minor_tick_count * major_period;
 355                         tp.major.emplace_back(x, format_function(t));
 356                 } else {
 357                         tp.minor.emplace_back(x);
 358                 }
 359
 360                 division++;
 361         } while (x < width);
 362
 363         return tp;
 364 }
 365
 366 void Ruler::on_hover_point_changed(const QWidget* widget, const QPoint &hp)
 367 {
 368         (void)widget;
 369         (void)hp;
 370
 371         update();
 372 }
 373
 374 void Ruler::invalidate_tick_position_cache()
 375 {
 376         tick_position_cache_ = boost::none;
 377 }
 378
 379 void Ruler::on_createMarker()
 380 {
 381         hover_item_ = view_.add_flag(get_absolute_time_from_x_pos(mouse_down_point_.x()));
 382 }
 383
 384 void Ruler::on_setZeroPosition()
 385 {
 386         view_.set_zero_position(get_absolute_time_from_x_pos(mouse_down_point_.x()));
 387 }
 388
 389 void Ruler::on_toggleHoverMarker()
 390 {
 391         GlobalSettings settings;
 392         const bool state = settings.value(GlobalSettings::Key_View_ShowHoverMarker).toBool();
 393         settings.setValue(GlobalSettings::Key_View_ShowHoverMarker, !state);
 394 }
 395
 396 } // namespace trace
 397 } // namespace views
 398 } // namespace pv