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 <QMouseEvent>
  25
  26 #include "ruler.hpp"
  27 #include "view.hpp"
  28
  29 using namespace Qt;
  30
  31 using std::function;
  32 using std::shared_ptr;
  33 using std::vector;
  34
  35 namespace pv {
  36 namespace views {
  37 namespace trace {
  38
  39 const float Ruler::RulerHeight = 2.5f; // x Text Height
  40 const int Ruler::MinorTickSubdivision = 4;
  41
  42 const float Ruler::HoverArrowSize = 0.5f; // x Text Height
  43
  44 Ruler::Ruler(View &parent) :
  45         MarginWidget(parent)
  46 {
  47         setMouseTracking(true);
  48
  49         connect(&view_, SIGNAL(hover_point_changed()),
  50                 this, SLOT(hover_point_changed()));
  51         connect(&view_, SIGNAL(offset_changed()),
  52                 this, SLOT(invalidate_tick_position_cache()));
  53         connect(&view_, SIGNAL(scale_changed()),
  54                 this, SLOT(invalidate_tick_position_cache()));
  55         connect(&view_, SIGNAL(tick_prefix_changed()),
  56                 this, SLOT(invalidate_tick_position_cache()));
  57         connect(&view_, SIGNAL(tick_precision_changed()),
  58                 this, SLOT(invalidate_tick_position_cache()));
  59         connect(&view_, SIGNAL(tick_period_changed()),
  60                 this, SLOT(invalidate_tick_position_cache()));
  61         connect(&view_, SIGNAL(time_unit_changed()),
  62                 this, SLOT(invalidate_tick_position_cache()));
  63 }
  64
  65 QSize Ruler::sizeHint() const
  66 {
  67         const int text_height = calculate_text_height();
  68         return QSize(0, RulerHeight * text_height);
  69 }
  70
  71 QSize Ruler::extended_size_hint() const
  72 {
  73         QRectF max_rect;
  74         vector< shared_ptr<TimeItem> > items(view_.time_items());
  75         for (auto &i : items)
  76                 max_rect = max_rect.united(i->label_rect(QRect()));
  77         return QSize(0, sizeHint().height() - max_rect.top() / 2 +
  78                 ViewItem::HighlightRadius);
  79 }
  80
  81 QString Ruler::format_time_with_distance(
  82         const pv::util::Timestamp& distance,
  83         const pv::util::Timestamp& t,
  84         pv::util::SIPrefix prefix,
  85         pv::util::TimeUnit unit,
  86         unsigned precision,
  87         bool sign)
  88 {
  89         const unsigned limit = 60;
  90
  91         if (t.is_zero())
  92                 return "0";
  93
  94         // If we have to use samples then we have no alternative formats
  95         if (unit == pv::util::TimeUnit::Samples)
  96                 return pv::util::format_time_si_adjusted(t, prefix, precision, "sa", sign);
  97
  98         // View zoomed way out -> low precision (0), big distance (>=60s)
  99         // -> DD:HH:MM
 100         if ((precision == 0) && (distance >= limit))
 101                 return pv::util::format_time_minutes(t, 0, sign);
 102
 103         // View in "normal" range -> medium precision, medium step size
 104         // -> HH:MM:SS.mmm... or xxxx (si unit) if less than limit seconds
 105         // View zoomed way in -> high precision (>3), low step size (<1s)
 106         // -> HH:MM:SS.mmm... or xxxx (si unit) if less than limit seconds
 107         if (abs(t) < limit)
 108                 return pv::util::format_time_si_adjusted(t, prefix, precision, "s", sign);
 109         else
 110                 return pv::util::format_time_minutes(t, precision, sign);
 111 }
 112
 113 vector< shared_ptr<ViewItem> > Ruler::items()
 114 {
 115         const vector< shared_ptr<TimeItem> > time_items(view_.time_items());
 116         return vector< shared_ptr<ViewItem> >(
 117                 time_items.begin(), time_items.end());
 118 }
 119
 120 shared_ptr<ViewItem> Ruler::get_mouse_over_item(const QPoint &pt)
 121 {
 122         const vector< shared_ptr<TimeItem> > items(view_.time_items());
 123         for (auto i = items.rbegin(); i != items.rend(); i++)
 124                 if ((*i)->enabled() && (*i)->label_rect(rect()).contains(pt))
 125                         return *i;
 126         return nullptr;
 127 }
 128
 129 void Ruler::paintEvent(QPaintEvent*)
 130 {
 131         if (!tick_position_cache_) {
 132                 auto ffunc = [this](const pv::util::Timestamp& t) {
 133                         return format_time_with_distance(
 134                                 this->view_.tick_period(),
 135                                 t,
 136                                 this->view_.tick_prefix(),
 137                                 this->view_.time_unit(),
 138                                 this->view_.tick_precision());
 139                 };
 140
 141                 tick_position_cache_ = calculate_tick_positions(
 142                         view_.tick_period(),
 143                         view_.offset(),
 144                         view_.scale(),
 145                         width(),
 146                         ffunc);
 147         }
 148
 149         const int ValueMargin = 3;
 150
 151         const int text_height = calculate_text_height();
 152         const int ruler_height = RulerHeight * text_height;
 153         const int major_tick_y1 = text_height + ValueMargin * 2;
 154         const int minor_tick_y1 = (major_tick_y1 + ruler_height) / 2;
 155
 156         QPainter p(this);
 157
 158         // Draw the tick marks
 159         p.setPen(palette().color(foregroundRole()));
 160
 161         for (const auto& tick: tick_position_cache_->major) {
 162                 p.drawText(tick.first, ValueMargin, 0, text_height,
 163                                 AlignCenter | AlignTop | TextDontClip, tick.second);
 164                 p.drawLine(QPointF(tick.first, major_tick_y1),
 165                         QPointF(tick.first, ruler_height));
 166         }
 167
 168         for (const auto& tick: tick_position_cache_->minor) {
 169                 p.drawLine(QPointF(tick, minor_tick_y1),
 170                                 QPointF(tick, ruler_height));
 171         }
 172
 173         // Draw the hover mark
 174         draw_hover_mark(p, text_height);
 175
 176         p.setRenderHint(QPainter::Antialiasing);
 177
 178         // The cursor labels are not drawn with the arrows exactly on the
 179         // bottom line of the widget, because then the selection shadow
 180         // would be clipped away.
 181         const QRect r = rect().adjusted(0, 0, 0, -ViewItem::HighlightRadius);
 182
 183         // Draw the items
 184         const vector< shared_ptr<TimeItem> > items(view_.time_items());
 185         for (auto &i : items) {
 186                 const bool highlight = !item_dragging_ &&
 187                         i->label_rect(r).contains(mouse_point_);
 188                 i->paint_label(p, r, highlight);
 189         }
 190 }
 191
 192 Ruler::TickPositions Ruler::calculate_tick_positions(
 193         const pv::util::Timestamp& major_period,
 194         const pv::util::Timestamp& offset,
 195         const double scale,
 196         const int width,
 197         function<QString(const pv::util::Timestamp&)> format_function)
 198 {
 199         TickPositions tp;
 200
 201         const pv::util::Timestamp minor_period = major_period / MinorTickSubdivision;
 202         const pv::util::Timestamp first_major_division = floor(offset / major_period);
 203         const pv::util::Timestamp first_minor_division = ceil(offset / minor_period);
 204         const pv::util::Timestamp t0 = first_major_division * major_period;
 205
 206         int division = (round(first_minor_division -
 207                 first_major_division * MinorTickSubdivision)).convert_to<int>() - 1;
 208
 209         double x;
 210
 211         do {
 212                 pv::util::Timestamp t = t0 + division * minor_period;
 213                 x = ((t - offset) / scale).convert_to<double>();
 214
 215                 if (division % MinorTickSubdivision == 0) {
 216                         // Recalculate 't' without using 'minor_period' which is a fraction
 217                         t = t0 + division / MinorTickSubdivision * major_period;
 218                         tp.major.emplace_back(x, format_function(t));
 219                 } else {
 220                         tp.minor.emplace_back(x);
 221                 }
 222
 223                 division++;
 224         } while (x < width);
 225
 226         return tp;
 227 }
 228
 229 void Ruler::mouseDoubleClickEvent(QMouseEvent *event)
 230 {
 231         view_.add_flag(view_.offset() + ((double)event->x() + 0.5) * view_.scale());
 232 }
 233
 234 void Ruler::draw_hover_mark(QPainter &p, int text_height)
 235 {
 236         const int x = view_.hover_point().x();
 237
 238         if (x == -1)
 239                 return;
 240
 241         p.setPen(QPen(Qt::NoPen));
 242         p.setBrush(QBrush(palette().color(foregroundRole())));
 243
 244         const int b = RulerHeight * text_height;
 245         const float hover_arrow_size = HoverArrowSize * text_height;
 246         const QPointF points[] = {
 247                 QPointF(x, b),
 248                 QPointF(x - hover_arrow_size, b - hover_arrow_size),
 249                 QPointF(x + hover_arrow_size, b - hover_arrow_size)
 250         };
 251         p.drawPolygon(points, countof(points));
 252 }
 253
 254 int Ruler::calculate_text_height() const
 255 {
 256         return QFontMetrics(font()).ascent();
 257 }
 258
 259 void Ruler::hover_point_changed()
 260 {
 261         update();
 262 }
 263
 264 void Ruler::invalidate_tick_position_cache()
 265 {
 266         tick_position_cache_ = boost::none;
 267 }
 268
 269 void Ruler::resizeEvent(QResizeEvent*)
 270 {
 271         // the tick calculation depends on the width of this widget
 272         invalidate_tick_position_cache();
 273 }
 274
 275 } // namespace trace
 276 } // namespace views
 277 } // namespace pv