2 * This file is part of the PulseView project.
4 * Copyright (C) 2019 Soeren Apel <soeren@apelpie.net>
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.
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.
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/>.
24 #include <QFileDialog>
27 #include <QMessageBox>
29 #include <QVBoxLayout>
31 #include <libsigrokdecode/libsigrokdecode.h>
34 #include "QHexView.hpp"
36 #include "pv/globalsettings.hpp"
37 #include "pv/session.hpp"
38 #include "pv/util.hpp"
39 #include "pv/data/decode/decoder.hpp"
41 using pv::data::DecodeSignal;
42 using pv::data::SignalBase;
43 using pv::data::decode::Decoder;
44 using pv::util::Timestamp;
46 using std::shared_ptr;
50 namespace decoder_binary {
52 const char* SaveTypeNames[SaveTypeCount] = {
55 "Hex Dump, with offset",
60 View::View(Session &session, bool is_main_view, QMainWindow *parent) :
61 ViewBase(session, is_main_view, parent),
63 // Note: Place defaults in View::reset_view_state(), not here
65 decoder_selector_(new QComboBox()),
66 format_selector_(new QComboBox()),
67 class_selector_(new QComboBox()),
68 stacked_widget_(new QStackedWidget()),
69 hex_view_(new QHexView()),
70 save_button_(new QToolButton()),
71 save_action_(new QAction(this)),
74 QVBoxLayout *root_layout = new QVBoxLayout(this);
75 root_layout->setContentsMargins(0, 0, 0, 0);
78 QToolBar* toolbar = new QToolBar();
79 toolbar->setContextMenuPolicy(Qt::PreventContextMenu);
80 parent->addToolBar(toolbar);
83 toolbar->addWidget(new QLabel(tr("Decoder:")));
84 toolbar->addWidget(decoder_selector_);
85 toolbar->addWidget(class_selector_);
86 toolbar->addSeparator();
87 toolbar->addWidget(new QLabel(tr("Show data as")));
88 toolbar->addWidget(format_selector_);
89 toolbar->addSeparator();
90 toolbar->addWidget(save_button_);
93 format_selector_->addItem(tr("Hexdump"), QVariant(QString("text/hexdump")));
96 root_layout->addWidget(stacked_widget_);
97 stacked_widget_->addWidget(hex_view_);
98 stacked_widget_->setCurrentIndex(0);
100 connect(decoder_selector_, SIGNAL(currentIndexChanged(int)),
101 this, SLOT(on_selected_decoder_changed(int)));
102 connect(class_selector_, SIGNAL(currentIndexChanged(int)),
103 this, SLOT(on_selected_class_changed(int)));
106 decoder_selector_->setSizeAdjustPolicy(QComboBox::AdjustToContents);
107 class_selector_->setSizeAdjustPolicy(QComboBox::AdjustToContents);
110 save_action_->setText(tr("&Save..."));
111 save_action_->setIcon(QIcon::fromTheme("document-save-as",
112 QIcon(":/icons/document-save-as.png")));
113 #if QT_VERSION >= QT_VERSION_CHECK(6, 0, 0)
114 save_action_->setShortcut(QKeySequence(Qt::CTRL | Qt::Key_S));
116 save_action_->setShortcut(QKeySequence(Qt::CTRL + Qt::Key_S));
118 connect(save_action_, SIGNAL(triggered(bool)),
119 this, SLOT(on_actionSave_triggered()));
121 QMenu *save_menu = new QMenu();
122 connect(save_menu, SIGNAL(triggered(QAction*)),
123 this, SLOT(on_actionSave_triggered(QAction*)));
125 for (int i = 0; i < SaveTypeCount; i++) {
126 QAction *const action = save_menu->addAction(tr(SaveTypeNames[i]));
127 action->setData(QVariant::fromValue(i));
130 save_button_->setMenu(save_menu);
131 save_button_->setDefaultAction(save_action_);
132 save_button_->setPopupMode(QToolButton::MenuButtonPopup);
134 parent->setSizePolicy(hex_view_->sizePolicy()); // TODO Must be updated when selected widget changes
136 // Set up metadata event handler
137 session_.metadata_obj_manager()->add_observer(this);
144 session_.metadata_obj_manager()->remove_observer(this);
147 ViewType View::get_type() const
149 return ViewTypeDecoderBinary;
152 void View::reset_view_state()
154 ViewBase::reset_view_state();
156 decoder_selector_->clear();
157 class_selector_->clear();
158 format_selector_->setCurrentIndex(0);
159 save_button_->setEnabled(false);
164 void View::clear_decode_signals()
166 ViewBase::clear_decode_signals();
172 void View::add_decode_signal(shared_ptr<data::DecodeSignal> signal)
174 ViewBase::add_decode_signal(signal);
176 connect(signal.get(), SIGNAL(name_changed(const QString&)),
177 this, SLOT(on_signal_name_changed(const QString&)));
178 connect(signal.get(), SIGNAL(decoder_stacked(void*)),
179 this, SLOT(on_decoder_stacked(void*)));
180 connect(signal.get(), SIGNAL(decoder_removed(void*)),
181 this, SLOT(on_decoder_removed(void*)));
183 // Add all decoders provided by this signal
184 auto stack = signal->decoder_stack();
185 if (stack.size() > 1) {
186 for (const shared_ptr<Decoder>& dec : stack)
187 // Only add the decoder if it has binary output
188 if (dec->get_binary_class_count() > 0) {
189 QString title = QString("%1 (%2)").arg(signal->name(), dec->name());
190 decoder_selector_->addItem(title, QVariant::fromValue((void*)dec.get()));
193 if (!stack.empty()) {
194 shared_ptr<Decoder>& dec = stack.at(0);
195 if (dec->get_binary_class_count() > 0)
196 decoder_selector_->addItem(signal->name(), QVariant::fromValue((void*)dec.get()));
200 void View::remove_decode_signal(shared_ptr<data::DecodeSignal> signal)
202 // Remove all decoders provided by this signal
203 for (const shared_ptr<Decoder>& dec : signal->decoder_stack()) {
204 int index = decoder_selector_->findData(QVariant::fromValue((void*)dec.get()));
207 decoder_selector_->removeItem(index);
210 ViewBase::remove_decode_signal(signal);
212 if (signal.get() == signal_) {
219 void View::save_settings(QSettings &settings) const
221 ViewBase::save_settings(settings);
224 void View::restore_settings(QSettings &settings)
226 // Note: It is assumed that this function is only called once,
227 // immediately after restoring a previous session.
228 ViewBase::restore_settings(settings);
231 void View::reset_data()
236 binary_data_exists_ = false;
241 void View::update_data()
246 const DecodeBinaryClass* bin_class =
247 signal_->get_binary_data_class(current_segment_, decoder_, bin_class_id_);
249 hex_view_->set_data(bin_class);
251 if (!binary_data_exists_)
254 if (!save_button_->isEnabled())
255 save_button_->setEnabled(true);
258 void View::save_data() const
266 GlobalSettings settings;
267 const QString dir = settings.value("MainWindow/SaveDirectory").toString();
269 const QString file_name = QFileDialog::getSaveFileName(
270 parent_, tr("Save Binary Data"), dir, tr("Binary Data Files (*.bin);;All Files (*)"));
272 if (file_name.isEmpty())
275 QFile file(file_name);
276 if (file.open(QIODevice::WriteOnly | QIODevice::Truncate)) {
277 pair<size_t, size_t> selection = hex_view_->get_selection();
279 vector<uint8_t> data;
280 data.resize(selection.second - selection.first + 1);
282 signal_->get_merged_binary_data_chunks_by_offset(current_segment_, decoder_,
283 bin_class_id_, selection.first, selection.second, &data);
285 int64_t bytes_written = file.write((const char*)data.data(), data.size());
287 if ((bytes_written == -1) || ((uint64_t)bytes_written != data.size())) {
288 QMessageBox msg(parent_);
289 msg.setText(tr("Error") + "\n\n" + tr("File %1 could not be written to.").arg(file_name));
290 msg.setStandardButtons(QMessageBox::Ok);
291 msg.setIcon(QMessageBox::Warning);
298 void View::save_data_as_hex_dump(bool with_offset, bool with_ascii) const
306 GlobalSettings settings;
307 const QString dir = settings.value("MainWindow/SaveDirectory").toString();
309 const QString file_name = QFileDialog::getSaveFileName(
310 parent_, tr("Save Binary Data"), dir, tr("Hex Dumps (*.txt);;All Files (*)"));
312 if (file_name.isEmpty())
315 QFile file(file_name);
316 if (file.open(QIODevice::WriteOnly | QIODevice::Truncate | QIODevice::Text)) {
317 pair<size_t, size_t> selection = hex_view_->get_selection();
319 vector<uint8_t> data;
320 data.resize(selection.second - selection.first + 1);
322 signal_->get_merged_binary_data_chunks_by_offset(current_segment_, decoder_,
323 bin_class_id_, selection.first, selection.second, &data);
325 QTextStream out_stream(&file);
327 uint64_t offset = selection.first;
328 uint64_t n = hex_view_->get_bytes_per_line();
331 while (offset < selection.second) {
332 size_t end = std::min((uint64_t)(selection.second), offset + n);
333 offset = hex_view_->create_hex_line(offset, end, &s, with_offset, with_ascii);
334 #if QT_VERSION >= QT_VERSION_CHECK(5, 15, 0)
335 out_stream << s << Qt::endl;
337 out_stream << s << endl;
341 #if QT_VERSION >= QT_VERSION_CHECK(5, 15, 0)
342 out_stream << Qt::endl;
347 if (out_stream.status() != QTextStream::Ok) {
348 QMessageBox msg(parent_);
349 msg.setText(tr("Error") + "\n\n" + tr("File %1 could not be written to.").arg(file_name));
350 msg.setStandardButtons(QMessageBox::Ok);
351 msg.setIcon(QMessageBox::Warning);
358 void View::on_selected_decoder_changed(int index)
361 disconnect(signal_, SIGNAL(new_binary_data(unsigned int, void*, unsigned int)));
365 decoder_ = (Decoder*)decoder_selector_->itemData(index).value<void*>();
367 // Find the signal that contains the selected decoder
368 for (const shared_ptr<DecodeSignal>& ds : decode_signals_)
369 for (const shared_ptr<Decoder>& dec : ds->decoder_stack())
370 if (decoder_ == dec.get())
373 class_selector_->clear();
376 // Populate binary class selector
377 uint32_t bin_classes = decoder_->get_binary_class_count();
378 for (uint32_t i = 0; i < bin_classes; i++) {
379 const data::decode::DecodeBinaryClassInfo* class_info = decoder_->get_binary_class(i);
380 class_selector_->addItem(class_info->description, QVariant::fromValue(i));
383 connect(signal_, SIGNAL(new_binary_data(unsigned int, void*, unsigned int)),
384 this, SLOT(on_new_binary_data(unsigned int, void*, unsigned int)));
390 void View::on_selected_class_changed(int index)
392 bin_class_id_ = class_selector_->itemData(index).value<uint32_t>();
394 binary_data_exists_ = (signal_) ?
395 signal_->get_binary_data_chunk_count(current_segment_, decoder_, bin_class_id_) :
401 void View::on_signal_name_changed(const QString &name)
405 SignalBase* sb = qobject_cast<SignalBase*>(QObject::sender());
408 DecodeSignal* signal = dynamic_cast<DecodeSignal*>(sb);
411 // Update all decoder entries provided by this signal
412 auto stack = signal->decoder_stack();
413 if (stack.size() > 1) {
414 for (const shared_ptr<Decoder>& dec : stack) {
415 QString title = QString("%1 (%2)").arg(signal->name(), dec->name());
416 int index = decoder_selector_->findData(QVariant::fromValue((void*)dec.get()));
419 decoder_selector_->setItemText(index, title);
422 if (!stack.empty()) {
423 shared_ptr<Decoder>& dec = stack.at(0);
424 int index = decoder_selector_->findData(QVariant::fromValue((void*)dec.get()));
427 decoder_selector_->setItemText(index, signal->name());
431 void View::on_new_binary_data(unsigned int segment_id, void* decoder, unsigned int bin_class_id)
433 if ((segment_id == current_segment_) && (decoder == decoder_) && (bin_class_id == bin_class_id_))
434 if (!delayed_view_updater_.isActive())
435 delayed_view_updater_.start();
438 void View::on_decoder_stacked(void* decoder)
440 // TODO This doesn't change existing entries for the same signal - but it should as the naming scheme may change
442 Decoder* d = static_cast<Decoder*>(decoder);
444 // Only add the decoder if it has binary output
445 if (d->get_binary_class_count() == 0)
448 // Find the signal that contains the selected decoder
449 DecodeSignal* signal = nullptr;
451 for (const shared_ptr<DecodeSignal>& ds : decode_signals_)
452 for (const shared_ptr<Decoder>& dec : ds->decoder_stack())
458 // Add the decoder to the list
459 QString title = QString("%1 (%2)").arg(signal->name(), d->name());
460 decoder_selector_->addItem(title, QVariant::fromValue((void*)d));
463 void View::on_decoder_removed(void* decoder)
465 Decoder* d = static_cast<Decoder*>(decoder);
467 // Remove the decoder from the list
468 int index = decoder_selector_->findData(QVariant::fromValue((void*)d));
471 decoder_selector_->removeItem(index);
474 void View::on_actionSave_triggered(QAction* action)
476 int save_type = SaveTypeBinary;
478 save_type = action->data().toInt();
482 case SaveTypeBinary: save_data(); break;
483 case SaveTypeHexDumpPlain: save_data_as_hex_dump(false, false); break;
484 case SaveTypeHexDumpWithOffset: save_data_as_hex_dump(true, false); break;
485 case SaveTypeHexDumpComplete: save_data_as_hex_dump(true, true); break;
489 void View::on_metadata_object_changed(MetadataObject* obj,
490 MetadataValueType value_type)
492 // Check if we need to update the model's data range. We only work on the
493 // end sample value because the start sample value is updated first and
495 if ((obj->type() == MetadataObjMainViewRange) &&
496 (value_type == MetadataValueEndSample)) {
498 int64_t start_sample = obj->value(MetadataValueStartSample).toLongLong();
499 int64_t end_sample = obj->value(MetadataValueEndSample).toLongLong();
501 hex_view_->set_visible_sample_range(start_sample, end_sample);
504 if (obj->type() == MetadataObjMousePos)
505 hex_view_->set_highlighted_data_sample(obj->value(MetadataValueStartSample).toLongLong());
508 void View::perform_delayed_view_update()
510 if (signal_ && !binary_data_exists_)
511 if (signal_->get_binary_data_chunk_count(current_segment_, decoder_, bin_class_id_))
512 binary_data_exists_ = true;
518 } // namespace decoder_binary