pv/views/trace/trace.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 <extdef.h>
  21
  22 #include <cassert>
  23 #include <cmath>
  24
  25 #include <QApplication>
  26 #include <QFormLayout>
  27 #include <QKeyEvent>
  28 #include <QLineEdit>
  29
  30 #include "trace.hpp"
  31 #include "tracepalette.hpp"
  32 #include "view.hpp"
  33
  34 #include "pv/globalsettings.hpp"
  35 #include "pv/widgets/colorbutton.hpp"
  36 #include "pv/widgets/popup.hpp"
  37
  38 using std::pair;
  39 using std::shared_ptr;
  40
  41 namespace pv {
  42 namespace views {
  43 namespace trace {
  44
  45 const QPen Trace::AxisPen(QColor(0, 0, 0, 30 * 256 / 100));
  46 const int Trace::LabelHitPadding = 2;
  47
  48 const QColor Trace::BrightGrayBGColor = QColor(0, 0, 0, 10 * 255 / 100);
  49 const QColor Trace::DarkGrayBGColor = QColor(0, 0, 0, 15 * 255 / 100);
  50
  51 Trace::Trace(shared_ptr<data::SignalBase> channel) :
  52         base_(channel),
  53         axis_pen_(AxisPen),
  54         segment_display_mode_(ShowLastSegmentOnly),  // Will be overwritten by View
  55         current_segment_(0),
  56         popup_(nullptr),
  57         popup_form_(nullptr)
  58 {
  59         connect(channel.get(), SIGNAL(name_changed(const QString&)),
  60                 this, SLOT(on_name_changed(const QString&)));
  61         connect(channel.get(), SIGNAL(color_changed(const QColor&)),
  62                 this, SLOT(on_color_changed(const QColor&)));
  63
  64         GlobalSettings::add_change_handler(this);
  65
  66         GlobalSettings settings;
  67         show_hover_marker_ =
  68                 settings.value(GlobalSettings::Key_View_ShowHoverMarker).toBool();
  69 }
  70
  71 Trace::~Trace()
  72 {
  73         GlobalSettings::remove_change_handler(this);
  74 }
  75
  76 shared_ptr<data::SignalBase> Trace::base() const
  77 {
  78         return base_;
  79 }
  80
  81 bool Trace::is_selectable(QPoint pos) const
  82 {
  83         // True if the header was clicked, false if the trace area was clicked
  84         const View *view = owner_->view();
  85         assert(view);
  86
  87         return (pos.x() <= view->header_width());
  88 }
  89
  90 bool Trace::is_draggable(QPoint pos) const
  91 {
  92         // While the header label that belongs to this trace is draggable,
  93         // the trace itself shall not be. Hence we return true if the header
  94         // was clicked and false if the trace area was clicked
  95         const View *view = owner_->view();
  96         assert(view);
  97
  98         return (pos.x() <= view->header_width());
  99 }
 100
 101 void Trace::set_segment_display_mode(SegmentDisplayMode mode)
 102 {
 103         segment_display_mode_ = mode;
 104
 105         if (owner_)
 106                 owner_->row_item_appearance_changed(true, true);
 107 }
 108
 109 void Trace::on_setting_changed(const QString &key, const QVariant &value)
 110 {
 111         if (key == GlobalSettings::Key_View_ShowHoverMarker)
 112                 show_hover_marker_ = value.toBool();
 113 }
 114
 115 void Trace::paint_label(QPainter &p, const QRect &rect, bool hover)
 116 {
 117         const int y = get_visual_y();
 118
 119         p.setBrush(base_->color());
 120
 121         if (!enabled())
 122                 return;
 123
 124         const QRectF r = label_rect(rect);
 125
 126         // When selected, move the arrow to the left so that the border can show
 127         const QPointF offs = (selected()) ? QPointF(-2, 0) : QPointF(0, 0);
 128
 129         // Paint the label
 130         const float label_arrow_length = r.height() / 2;
 131         QPointF points[] = {
 132                 offs + r.topLeft(),
 133                 offs + QPointF(r.right() - label_arrow_length, r.top()),
 134                 offs + QPointF(r.right(), y),
 135                 offs + QPointF(r.right() - label_arrow_length, r.bottom()),
 136                 offs + r.bottomLeft()
 137         };
 138         QPointF highlight_points[] = {
 139                 offs + QPointF(r.left() + 1, r.top() + 1),
 140                 offs + QPointF(r.right() - label_arrow_length, r.top() + 1),
 141                 offs + QPointF(r.right() - 1, y),
 142                 offs + QPointF(r.right() - label_arrow_length, r.bottom() - 1),
 143                 offs + QPointF(r.left() + 1, r.bottom() - 1)
 144         };
 145
 146         if (selected()) {
 147                 p.setPen(highlight_pen());
 148                 p.setBrush(Qt::transparent);
 149                 p.drawPolygon(points, countof(points));
 150         }
 151
 152         p.setPen(Qt::transparent);
 153         p.setBrush(hover ? base_->color().lighter() : base_->color());
 154         p.drawPolygon(points, countof(points));
 155
 156         p.setPen(base_->color().lighter());
 157         p.setBrush(Qt::transparent);
 158         p.drawPolygon(highlight_points, countof(highlight_points));
 159
 160         p.setPen(base_->color().darker());
 161         p.setBrush(Qt::transparent);
 162         p.drawPolygon(points, countof(points));
 163
 164         // Paint the text
 165         p.setPen(select_text_color(base_->color()));
 166         p.setFont(QApplication::font());
 167         p.drawText(QRectF(r.x(), r.y(),
 168                 r.width() - label_arrow_length, r.height()),
 169                 Qt::AlignCenter | Qt::AlignVCenter, base_->name());
 170 }
 171
 172 QMenu* Trace::create_header_context_menu(QWidget *parent)
 173 {
 174         QMenu *const menu = ViewItem::create_header_context_menu(parent);
 175
 176         return menu;
 177 }
 178
 179 pv::widgets::Popup* Trace::create_popup(QWidget *parent)
 180 {
 181         using pv::widgets::Popup;
 182
 183         popup_ = new Popup(parent);
 184         popup_->set_position(parent->mapToGlobal(
 185                 drag_point(parent->rect())), Popup::Right);
 186
 187         create_popup_form();
 188
 189         connect(popup_, SIGNAL(closed()), this, SLOT(on_popup_closed()));
 190
 191         return popup_;
 192 }
 193
 194 QRectF Trace::label_rect(const QRectF &rect) const
 195 {
 196         QFontMetrics m(QApplication::font());
 197         const QSize text_size(
 198                 m.boundingRect(QRect(), 0, base_->name()).width(), m.height());
 199         const QSizeF label_size(
 200                 text_size.width() + LabelPadding.width() * 2,
 201                 ceilf((text_size.height() + LabelPadding.height() * 2) / 2) * 2);
 202         const float half_height = label_size.height() / 2;
 203         return QRectF(
 204                 rect.right() - half_height - label_size.width() - 0.5,
 205                 get_visual_y() + 0.5f - half_height,
 206                 label_size.width() + half_height,
 207                 label_size.height());
 208 }
 209
 210 QRectF Trace::hit_box_rect(const ViewItemPaintParams &pp) const
 211 {
 212         // This one is only for the trace itself, excluding the header area
 213         const View *view = owner_->view();
 214         assert(view);
 215
 216         pair<int, int> extents = v_extents();
 217         const int top = pp.top() + get_visual_y() + extents.first;
 218         const int height = extents.second - extents.first;
 219
 220         return QRectF(pp.left() + view->header_width(), top,
 221                 pp.width() - view->header_width(), height);
 222 }
 223
 224 void Trace::set_current_segment(const int segment)
 225 {
 226         current_segment_ = segment;
 227 }
 228
 229 int Trace::get_current_segment() const
 230 {
 231         return current_segment_;
 232 }
 233
 234 void Trace::hover_point_changed(const QPoint &hp)
 235 {
 236         (void)hp;
 237
 238         if (owner_)
 239                 owner_->row_item_appearance_changed(false, true);
 240 }
 241
 242 void Trace::paint_back(QPainter &p, ViewItemPaintParams &pp)
 243 {
 244         const View *view = owner_->view();
 245         assert(view);
 246
 247         if (view->colored_bg())
 248                 p.setBrush(base_->bgcolor());
 249         else
 250                 p.setBrush(pp.next_bg_color_state() ? BrightGrayBGColor : DarkGrayBGColor);
 251
 252         p.setPen(QPen(Qt::NoPen));
 253
 254         const pair<int, int> extents = v_extents();
 255         p.drawRect(pp.left(), get_visual_y() + extents.first,
 256                 pp.width(), extents.second - extents.first);
 257 }
 258
 259 void Trace::paint_axis(QPainter &p, ViewItemPaintParams &pp, int y)
 260 {
 261         p.setRenderHint(QPainter::Antialiasing, false);
 262
 263         p.setPen(axis_pen_);
 264         p.drawLine(QPointF(pp.left(), y), QPointF(pp.right(), y));
 265
 266         p.setRenderHint(QPainter::Antialiasing, true);
 267 }
 268
 269 void Trace::add_color_option(QWidget *parent, QFormLayout *form)
 270 {
 271         using pv::widgets::ColorButton;
 272
 273         ColorButton *const color_button = new ColorButton(
 274                 TracePalette::Rows, TracePalette::Cols, parent);
 275         color_button->set_palette(TracePalette::Colors);
 276         color_button->set_color(base_->color());
 277         connect(color_button, SIGNAL(selected(const QColor&)),
 278                 this, SLOT(on_coloredit_changed(const QColor&)));
 279
 280         form->addRow(tr("Color"), color_button);
 281 }
 282
 283 void Trace::paint_hover_marker(QPainter &p)
 284 {
 285         const View *view = owner_->view();
 286         assert(view);
 287
 288         const int x = view->hover_point().x();
 289
 290         if (x == -1)
 291                 return;
 292
 293         p.setPen(QPen(QColor(Qt::lightGray)));
 294
 295         const pair<int, int> extents = v_extents();
 296
 297         p.setRenderHint(QPainter::Antialiasing, false);
 298         p.drawLine(x, get_visual_y() + extents.first,
 299                 x, get_visual_y() + extents.second);
 300         p.setRenderHint(QPainter::Antialiasing, true);
 301 }
 302
 303 void Trace::create_popup_form()
 304 {
 305         // Clear the layout
 306
 307         // Transfer the layout and the child widgets to a temporary widget
 308         // which we delete after the event was handled. This way, the layout
 309         // and all widgets contained therein are deleted after the event was
 310         // handled, leaving the parent popup_ time to handle the change.
 311         if (popup_form_) {
 312                 QWidget *suicidal = new QWidget();
 313                 suicidal->setLayout(popup_form_);
 314                 suicidal->deleteLater();
 315         }
 316
 317         // Repopulate the popup
 318         popup_form_ = new QFormLayout(popup_);
 319         popup_->setLayout(popup_form_);
 320         populate_popup_form(popup_, popup_form_);
 321 }
 322
 323 void Trace::populate_popup_form(QWidget *parent, QFormLayout *form)
 324 {
 325         QLineEdit *const name_edit = new QLineEdit(parent);
 326         name_edit->setText(base_->name());
 327         connect(name_edit, SIGNAL(textChanged(const QString&)),
 328                 this, SLOT(on_nameedit_changed(const QString&)));
 329         form->addRow(tr("Name"), name_edit);
 330
 331         add_color_option(parent, form);
 332 }
 333
 334 void Trace::on_name_changed(const QString &text)
 335 {
 336         /* This event handler is called by SignalBase when the name was changed there */
 337         (void)text;
 338
 339         if (owner_) {
 340                 owner_->extents_changed(true, false);
 341                 owner_->row_item_appearance_changed(true, false);
 342         }
 343 }
 344
 345 void Trace::on_color_changed(const QColor &color)
 346 {
 347         /* This event handler is called by SignalBase when the color was changed there */
 348         (void)color;
 349
 350         if (owner_)
 351                 owner_->row_item_appearance_changed(true, true);
 352 }
 353
 354 void Trace::on_popup_closed()
 355 {
 356         popup_ = nullptr;
 357         popup_form_ = nullptr;
 358 }
 359
 360 void Trace::on_nameedit_changed(const QString &name)
 361 {
 362         /* This event handler notifies SignalBase that the name changed */
 363         base_->set_name(name);
 364 }
 365
 366 void Trace::on_coloredit_changed(const QColor &color)
 367 {
 368         /* This event handler notifies SignalBase that the color changed */
 369         base_->set_color(color);
 370 }
 371
 372 } // namespace trace
 373 } // namespace views
 374 } // namespace pv