2 * This file is part of the PulseView project.
4 * Copyright (C) 2015 Victor Anjin <virinext@gmail.com>
5 * Copyright (C) 2019 Soeren Apel <soeren@apelpie.net>
7 * The MIT License (MIT)
11 * Permission is hereby granted, free of charge, to any person obtaining a copy
12 * of this software and associated documentation files (the "Software"), to deal
13 * in the Software without restriction, including without limitation the rights
14 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
15 * copies of the Software, and to permit persons to whom the Software is
16 * furnished to do so, subject to the following conditions:
18 * The above copyright notice and this permission notice shall be included in all
19 * copies or substantial portions of the Software.
21 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
22 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
23 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
24 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
25 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
26 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
30 #include <QApplication>
37 #include <QPaintEvent>
39 #include "QHexView.hpp"
41 const unsigned int BYTES_PER_LINE = 16;
42 const unsigned int HEXCHARS_IN_LINE = BYTES_PER_LINE * 3 - 1;
43 const unsigned int GAP_ADR_HEX = 10;
44 const unsigned int GAP_HEX_ASCII = 10;
45 const unsigned int GAP_ASCII_SLIDER = 5;
48 QHexView::QHexView(QWidget *parent):
49 QAbstractScrollArea(parent),
52 setFont(QFont("Courier", 10));
54 charWidth_ = fontMetrics().boundingRect('X').width();
55 charHeight_ = fontMetrics().height();
57 // Determine X coordinates of the three sub-areas
59 posHex_ = 10 * charWidth_ + GAP_ADR_HEX;
60 posAscii_ = posHex_ + HEXCHARS_IN_LINE * charWidth_ + GAP_HEX_ASCII;
62 setFocusPolicy(Qt::StrongFocus);
65 void QHexView::setData(QByteArray *data)
67 verticalScrollBar()->setValue(0);
76 void QHexView::showFromOffset(size_t offset)
78 if (data_ && (offset < (size_t)data_->count())) {
79 setCursorPos(offset * 2);
81 int cursorY = cursorPos_ / (2 * BYTES_PER_LINE);
82 verticalScrollBar() -> setValue(cursorY);
88 void QHexView::clear()
90 verticalScrollBar()->setValue(0);
96 QSize QHexView::getFullSize() const
98 size_t width = posAscii_ + (BYTES_PER_LINE * charWidth_) +
99 GAP_ASCII_SLIDER + verticalScrollBar()->width();
102 return QSize(width, 0);
104 size_t height = data_->count() / BYTES_PER_LINE;
106 if (data_->count() % BYTES_PER_LINE)
109 height *= charHeight_;
111 return QSize(width, height);
114 void QHexView::paintEvent(QPaintEvent *event)
116 QPainter painter(viewport());
118 // Calculate and update the widget and paint area sizes
119 QSize widgetSize = getFullSize();
120 setMinimumWidth(widgetSize.width());
121 setMaximumWidth(widgetSize.width());
122 QSize areaSize = viewport()->size();
124 verticalScrollBar()->setPageStep(areaSize.height() / charHeight_);
125 verticalScrollBar()->setRange(0, (widgetSize.height() - areaSize.height()) / charHeight_ + 1);
127 // Fill widget background
128 painter.fillRect(event->rect(), palette().color(QPalette::Base));
130 if (!data_ || (data_->size() == 0)) {
131 painter.setPen(palette().color(QPalette::Text));
132 QString s = tr("No data available");
133 int x = (areaSize.width() - fontMetrics().boundingRect(s).width()) / 2;
134 int y = areaSize.height() / 2;
135 painter.drawText(x, y, s);
139 // Determine first/last line indices
140 size_t firstLineIdx = verticalScrollBar()->value();
142 size_t lastLineIdx = firstLineIdx + areaSize.height() / charHeight_;
143 if (lastLineIdx > (data_->count() / BYTES_PER_LINE)) {
144 lastLineIdx = data_->count() / BYTES_PER_LINE;
145 if (data_->count() % BYTES_PER_LINE)
149 // Fill address area background
150 painter.fillRect(QRect(posAddr_, event->rect().top(),
151 posHex_ - (GAP_ADR_HEX / 2), height()), palette().color(QPalette::Window));
153 // Paint divider line between hex and ASCII areas
154 int line_x = posAscii_ - (GAP_HEX_ASCII / 2);
155 painter.setPen(palette().color(QPalette::Midlight));
156 painter.drawLine(line_x, event->rect().top(), line_x, height());
158 // Paint address area
159 painter.setPen(palette().color(QPalette::ButtonText));
161 int yStart = charHeight_;
162 for (size_t lineIdx = firstLineIdx, y = yStart; lineIdx < lastLineIdx; lineIdx++) {
164 QString address = QString("%1").arg(lineIdx * 16, 10, 16, QChar('0')).toUpper();
165 painter.drawText(posAddr_, y, address);
170 QBrush regular = painter.brush();
171 QBrush selected = QBrush(palette().color(QPalette::Highlight));
172 QByteArray data = data_->mid(firstLineIdx * BYTES_PER_LINE,
173 (lastLineIdx - firstLineIdx) * BYTES_PER_LINE);
175 yStart = charHeight_;
176 for (size_t lineIdx = firstLineIdx, y = yStart; lineIdx < lastLineIdx; lineIdx++) {
178 painter.setBackgroundMode(Qt::OpaqueMode);
181 for (size_t i = 0; i < BYTES_PER_LINE && ((lineIdx - firstLineIdx) * BYTES_PER_LINE + i) < (size_t)data.size(); i++) {
182 size_t pos = (lineIdx * BYTES_PER_LINE + i) * 2;
184 if ((pos >= selectBegin_) && (pos < selectEnd_)) {
185 painter.setBackground(selected);
186 painter.setPen(palette().color(QPalette::HighlightedText));
188 painter.setBackground(regular);
189 painter.setPen(palette().color(QPalette::Text));
193 QString val = QString::number((data.at((lineIdx - firstLineIdx) * BYTES_PER_LINE + i) & 0xF0) >> 4, 16).toUpper();
194 painter.drawText(x, y, val);
197 val = QString::number((data.at((lineIdx - firstLineIdx) * BYTES_PER_LINE + i) & 0xF), 16).toUpper();
198 painter.drawText(x + charWidth_, y, val);
206 // Paint ASCII characters
207 yStart = charHeight_;
208 for (size_t lineIdx = firstLineIdx, y = yStart; lineIdx < lastLineIdx; lineIdx++) {
211 for (size_t i = 0; ((lineIdx - firstLineIdx) * BYTES_PER_LINE + i) < (size_t)data.size() && (i < BYTES_PER_LINE); i++) {
212 char ch = data[(unsigned int)((lineIdx - firstLineIdx) * BYTES_PER_LINE + i)];
214 if ((ch < 0x20) || (ch > 0x7E))
217 size_t pos = (lineIdx * BYTES_PER_LINE + i) * 2;
218 if ((pos >= selectBegin_) && (pos < selectEnd_)) {
219 painter.setBackground(selected);
220 painter.setPen(palette().color(QPalette::HighlightedText));
222 painter.setBackground(regular);
223 painter.setPen(palette().color(QPalette::Text));
226 painter.drawText(x, y, QString(ch));
235 int x = (cursorPos_ % (2 * BYTES_PER_LINE));
236 int y = cursorPos_ / (2 * BYTES_PER_LINE);
238 int cursorX = (((x / 2) * 3) + (x % 2)) * charWidth_ + posHex_;
239 int cursorY = y * charHeight_ + 4;
240 painter.fillRect(cursorX, cursorY, 2, charHeight_, palette().color(QPalette::WindowText));
244 void QHexView::keyPressEvent(QKeyEvent *event)
246 bool setVisible = false;
249 if (event->matches(QKeySequence::MoveToNextChar)) {
250 setCursorPos(cursorPos_ + 1);
251 resetSelection(cursorPos_);
254 if (event->matches(QKeySequence::MoveToPreviousChar)) {
255 setCursorPos(cursorPos_ - 1);
256 resetSelection(cursorPos_);
260 if (event->matches(QKeySequence::MoveToEndOfLine)) {
261 setCursorPos(cursorPos_ | ((BYTES_PER_LINE * 2) - 1));
262 resetSelection(cursorPos_);
265 if (event->matches(QKeySequence::MoveToStartOfLine)) {
266 setCursorPos(cursorPos_ | (cursorPos_ % (BYTES_PER_LINE * 2)));
267 resetSelection(cursorPos_);
270 if (event->matches(QKeySequence::MoveToPreviousLine)) {
271 setCursorPos(cursorPos_ - BYTES_PER_LINE * 2);
272 resetSelection(cursorPos_);
275 if (event->matches(QKeySequence::MoveToNextLine)) {
276 setCursorPos(cursorPos_ + BYTES_PER_LINE * 2);
277 resetSelection(cursorPos_);
281 if (event->matches(QKeySequence::MoveToNextPage)) {
282 setCursorPos(cursorPos_ + (viewport()->height() / charHeight_ - 1) * 2 * BYTES_PER_LINE);
283 resetSelection(cursorPos_);
286 if (event->matches(QKeySequence::MoveToPreviousPage)) {
287 setCursorPos(cursorPos_ - (viewport()->height() / charHeight_ - 1) * 2 * BYTES_PER_LINE);
288 resetSelection(cursorPos_);
291 if (event->matches(QKeySequence::MoveToEndOfDocument)) {
293 setCursorPos(data_->count() * 2);
294 resetSelection(cursorPos_);
297 if (event->matches(QKeySequence::MoveToStartOfDocument)) {
299 resetSelection(cursorPos_);
304 if (event->matches(QKeySequence::SelectAll)) {
307 setSelection(2 * data_->count() + 1);
310 if (event->matches(QKeySequence::SelectNextChar)) {
311 int pos = cursorPos_ + 1;
316 if (event->matches(QKeySequence::SelectPreviousChar)) {
317 int pos = cursorPos_ - 1;
322 if (event->matches(QKeySequence::SelectEndOfLine)) {
323 int pos = cursorPos_ - (cursorPos_ % (2 * BYTES_PER_LINE)) + (2 * BYTES_PER_LINE);
328 if (event->matches(QKeySequence::SelectStartOfLine)) {
329 int pos = cursorPos_ - (cursorPos_ % (2 * BYTES_PER_LINE));
334 if (event->matches(QKeySequence::SelectPreviousLine)) {
335 int pos = cursorPos_ - (2 * BYTES_PER_LINE);
340 if (event->matches(QKeySequence::SelectNextLine)) {
341 int pos = cursorPos_ + (2 * BYTES_PER_LINE);
347 if (event->matches(QKeySequence::SelectNextPage)) {
348 int pos = cursorPos_ + (((viewport()->height() / charHeight_) - 1) * 2 * BYTES_PER_LINE);
353 if (event->matches(QKeySequence::SelectPreviousPage)) {
354 int pos = cursorPos_ - (((viewport()->height() / charHeight_) - 1) * 2 * BYTES_PER_LINE);
359 if (event->matches(QKeySequence::SelectEndOfDocument)) {
362 pos = data_->count() * 2;
367 if (event->matches(QKeySequence::SelectStartOfDocument)) {
374 if (event->matches(QKeySequence::Copy) && (data_)) {
379 QByteArray data = data_->mid(selectBegin_ / 2, (selectEnd_ - selectBegin_) / 2 + 1);
380 if (selectBegin_ % 2) {
381 text += QString::number((data.at((idx+1) / 2) & 0xF), 16);
387 int selectedSize = selectEnd_ - selectBegin_;
388 while (idx < selectedSize) {
389 QString val = QString::number((data.at((copyOffset + idx) / 2) & 0xF0) >> 4, 16);
390 if ((idx + 1) < selectedSize) {
391 val += QString::number((data.at((copyOffset + idx) / 2) & 0xF), 16);
396 if ((idx/2) % BYTES_PER_LINE == (BYTES_PER_LINE - 1))
402 QClipboard *clipboard = QApplication::clipboard();
403 clipboard->setText(text);
404 if (clipboard->supportsSelection())
405 clipboard->setText(text);
411 viewport()->update();
414 void QHexView::mouseMoveEvent(QMouseEvent *event)
416 int actPos = cursorPosFromMousePos(event->pos());
417 setCursorPos(actPos);
418 setSelection(actPos);
420 viewport()->update();
423 void QHexView::mousePressEvent(QMouseEvent *event)
425 int cPos = cursorPosFromMousePos(event->pos());
427 if ((QApplication::keyboardModifiers() & Qt::ShiftModifier) && (event->button() == Qt::LeftButton))
430 resetSelection(cPos);
434 viewport()->update();
437 size_t QHexView::cursorPosFromMousePos(const QPoint &position)
441 if (((size_t)position.x() >= posHex_) &&
442 ((size_t)position.x() < (posHex_ + HEXCHARS_IN_LINE * charWidth_))) {
444 // Note: We add 1.5 character widths so that selection across
445 // byte gaps is smoother
446 int x = (position.x() + (1.5 * charWidth_ / 2) - posHex_) / charWidth_;
448 // Note: We allow only full bytes to be selected, not nibbles,
449 // so we round to the nearest byte gap
452 int firstLineIdx = verticalScrollBar()->value();
453 int y = (position.y() / charHeight_) * 2 * BYTES_PER_LINE;
454 pos = x + y + firstLineIdx * BYTES_PER_LINE * 2;
460 void QHexView::resetSelection()
462 selectBegin_ = selectInit_;
463 selectEnd_ = selectInit_;
466 void QHexView::resetSelection(int pos)
476 void QHexView::setSelection(int pos)
481 if ((size_t)pos >= selectInit_) {
483 selectBegin_ = selectInit_;
486 selectEnd_ = selectInit_;
490 void QHexView::setCursorPos(int position)
497 maxPos = data_->count() * 2;
499 if (position > maxPos)
502 cursorPos_ = position;
505 void QHexView::ensureVisible()
507 QSize areaSize = viewport()->size();
509 int firstLineIdx = verticalScrollBar() -> value();
510 int lastLineIdx = firstLineIdx + areaSize.height() / charHeight_;
512 int cursorY = cursorPos_ / (2 * BYTES_PER_LINE);
514 if (cursorY < firstLineIdx)
515 verticalScrollBar() -> setValue(cursorY);
516 else if(cursorY >= lastLineIdx)
517 verticalScrollBar() -> setValue(cursorY - areaSize.height() / charHeight_ + 1);