mirror of
https://github.com/EdgeTX/edgetx.git
synced 2025-07-24 00:35:14 +03:00
[Simulator] New main UI window, debug console, separate outputs window, more. (#4385)
* [package] Add QtSvg support DLLs for Windows.
* [Simulator] Add images/css resources for new version; Create SimulatorIcon and SimulatorStyle classes; Build with SVG support, remove unused bitmaps.
* [Simulator] Improve and simplify VirtualJoystickWidget resize event (sticks maintain X/Y position) & improve values layout w/out trims.
* [Simulator] Refactor Trainer simulator to use VirtualJoystickWidget, gains lock/hold buttons and X/Y position readout.
* [Simulator] More compact layout for Telemetry simulator, reduces min. width and adds scrolling columns to allow smaller window sizes.
* [Simulator] Add new SimulatorMainWindow and RadioOutputsWidget UI classes.
* [storage] Add non-persistent sessionId() to AppData for tracking currently active radio profile ID.
* [Simulator] Major UI updates:
* Use a MainWindow interface with dockable/floatable windows, proper toolbar & menu;
* Persistent size/layout state of all windows/docks/etc between uses, per radio profile;
* Completely separate radio Outputs window with configurable layout (also persistent between uses);
* Translations now enabled in standalone Simulator, follows main Companion setting (they need a lot of updates);
* New custom icons throughout, toolbar icon sizes adhere to user preference in Companion.
* [Simulator] Debug Output console updates:
* New filter feature with optional full RegEx support, can work in inclusive or exclusive modes (full help text is included in UI);
* Up to 50 user-defined filters are saved to permanent settings, also a few predefined filters are provided;
* Saves/restores the last filter used and if it was en/disabled;
* Added word wrap and clear screen features;
* Configurable scroll-back buffer size;
* Increased efficiency & performance of the buffering/printing process.
* [Simulator][OSX] Visual UI tweaks for OS X.
* [Simulator] Fix some debug console settings not being restored properly.
* [Simulator] Add ability to hide/show menu bar; Persist view state of menu bar and radio title bar; Reduce font size on OS X; Other small visual tweaks and improvements.
* [build] Add QtSvg to Linux build scripts (a guess for Dockerfile).
* [build] Fix for Qt 5.3.
* Add OpenTx headers to new files.
* [Companion][storage] Update GeneralSettings() initializer to use current sessionId for profile data retrieval, removes workaround for standalone Simulator being started with arbitrary profile; AppData: always update sessionId when global id() changes.
* [X10] Fixes for new simulator
This commit is contained in:
Max Paperno
Bertrand Songis
parent
b493973d7d
commit
2f9d9c1a99
62 changed files with 6357 additions and 3095 deletions
|
|
@ -21,40 +21,361 @@
|
|||
#include "debugoutput.h"
|
||||
#include "ui_debugoutput.h"
|
||||
|
||||
DebugOutput::DebugOutput(QWidget * parent):
|
||||
QDialog(parent),
|
||||
ui(new Ui::DebugOutput)
|
||||
#include "appdata.h"
|
||||
|
||||
#include <QMessageBox>
|
||||
#include <QScrollBar>
|
||||
#include <QDebug>
|
||||
|
||||
#define DEBUG_OUTPUT_STATE_VERSION 1
|
||||
|
||||
extern AppData g; // ensure what "g" means
|
||||
|
||||
DebugOutput * traceCallbackInstance = 0;
|
||||
const int DebugOutput::m_dataBufferMaxSize = 100; // lines of text (this is not the display buffer)
|
||||
const int DebugOutput::m_dataPrintFreqDefault = 10; // ms
|
||||
const quint16 DebugOutput::m_savedViewStateVersion = 1;
|
||||
|
||||
void traceCb(const char * text)
|
||||
{
|
||||
// divert C callback into simulator instance
|
||||
if (traceCallbackInstance) {
|
||||
traceCallbackInstance->traceCallback(text);
|
||||
}
|
||||
}
|
||||
|
||||
DebugOutput::DebugOutput(QWidget * parent, SimulatorInterface *simulator):
|
||||
QWidget(parent),
|
||||
ui(new Ui::DebugOutput),
|
||||
m_simulator(simulator),
|
||||
m_tmrDataPrint(new QTimer()),
|
||||
m_dataBuffer(QByteArray()),
|
||||
m_radioProfileId(g.sessionId()),
|
||||
m_dataPrintFreq(m_dataPrintFreqDefault),
|
||||
m_running(false),
|
||||
m_filterExclude(true)
|
||||
{
|
||||
ui->setupUi(this);
|
||||
|
||||
#ifdef __APPLE__
|
||||
QFont newFont("Courier", 13);
|
||||
ui->Output->setFont(newFont);
|
||||
ui->Output->setAttribute(Qt::WA_MacNormalSize);
|
||||
#endif
|
||||
#if defined WIN32 || !defined __GNUC__
|
||||
QFont newFont("Courier", 9);
|
||||
ui->Output->setFont(newFont);
|
||||
ui->console->setFont(newFont);
|
||||
#endif
|
||||
|
||||
// TODO : allow selecting multiple filters, but needs to be efficient at output stage
|
||||
|
||||
QStringList stockFilters;
|
||||
stockFilters << "^lua[A-Z].*";
|
||||
stockFilters << "/(error|warning|-(E|W)-)/i";
|
||||
stockFilters << "!^(GC Use|(play|load|write|find(True)?)File|convert(To|From)Simu|\\tfound( in map)?:|eeprom |f_[a-z]+\\(|(push|(p|P)op(up)?|chain)? ?Menu( .+ display)?|RamBackup).+$";
|
||||
|
||||
foreach (const QString & fltr, stockFilters)
|
||||
ui->filterText->addItem(fltr, "no_delete");
|
||||
|
||||
ui->filterText->setValidator(new DebugOutputFilterValidator(ui->filterText));
|
||||
ui->filterText->installEventFilter(new DeleteComboBoxItemEventFilter());
|
||||
|
||||
ui->actionShowFilterHelp->setIcon(SimulatorIcon("info"));
|
||||
ui->actionWordWrap->setIcon(SimulatorIcon("word_wrap"));
|
||||
ui->actionClearScr->setIcon(SimulatorIcon("eraser"));
|
||||
|
||||
ui->btnShowFilterHelp->setDefaultAction(ui->actionShowFilterHelp);
|
||||
ui->btnWordWrap->setDefaultAction(ui->actionWordWrap);
|
||||
ui->btnClearScr->setDefaultAction(ui->actionClearScr);
|
||||
|
||||
restoreState();
|
||||
|
||||
ui->bufferSize->setValue(ui->console->maximumBlockCount());
|
||||
|
||||
// install simulator TRACE hook
|
||||
traceCallbackInstance = this;
|
||||
m_simulator->installTraceHook(traceCb);
|
||||
|
||||
m_tmrDataPrint->setInterval(m_dataPrintFreq);
|
||||
|
||||
connect(ui->filterText, &QComboBox::currentTextChanged, this, &DebugOutput::onFilterTextChanged);
|
||||
connect(m_tmrDataPrint, &QTimer::timeout, this, &DebugOutput::processBytesReceived);
|
||||
}
|
||||
|
||||
DebugOutput::~DebugOutput()
|
||||
{
|
||||
traceCallbackInstance = 0;
|
||||
stop();
|
||||
saveState();
|
||||
if (m_tmrDataPrint)
|
||||
delete m_tmrDataPrint;
|
||||
delete ui;
|
||||
}
|
||||
|
||||
void DebugOutput::traceCallback(const QString & text)
|
||||
void DebugOutput::start()
|
||||
{
|
||||
// ui->Output->appendPlainText(text);
|
||||
QTextCursor cursor(ui->Output->textCursor());
|
||||
m_tmrDataPrint->start();
|
||||
m_running = true;
|
||||
}
|
||||
|
||||
// is the scrollbar at the end?
|
||||
bool atEnd = (ui->Output->verticalScrollBar()->value() == ui->Output->verticalScrollBar()->maximum());
|
||||
void DebugOutput::stop()
|
||||
{
|
||||
m_tmrDataPrint->stop();
|
||||
m_running = false;
|
||||
}
|
||||
|
||||
cursor.movePosition(QTextCursor::End, QTextCursor::MoveAnchor, 1);
|
||||
cursor.insertText(text);
|
||||
void DebugOutput::saveState()
|
||||
{
|
||||
QStringList filters;
|
||||
for (int i = 0; i < ui->filterText->count(); ++i) {
|
||||
if (!ui->filterText->itemText(i).isEmpty() && ui->filterText->itemData(i).toString() != "no_delete")
|
||||
filters << ui->filterText->itemText(i);
|
||||
}
|
||||
g.simuDbgFilters(filters);
|
||||
|
||||
if (atEnd) {
|
||||
ui->Output->verticalScrollBar()->triggerAction(QAbstractSlider::SliderToMaximum);
|
||||
QByteArray state;
|
||||
QDataStream stream(&state, QIODevice::WriteOnly);
|
||||
stream << m_savedViewStateVersion
|
||||
<< (qint16)ui->filterText->currentIndex() << (qint32)ui->console->maximumBlockCount()
|
||||
<< ui->btnFilter->isChecked() << ui->actionWordWrap->isChecked();
|
||||
|
||||
SimulatorOptions opts = g.profile[m_radioProfileId].simulatorOptions();
|
||||
opts.dbgConsoleState = state;
|
||||
g.profile[m_radioProfileId].simulatorOptions(opts);
|
||||
}
|
||||
|
||||
void DebugOutput::restoreState()
|
||||
{
|
||||
quint16 ver = 0;
|
||||
qint16 fci = -1;
|
||||
qint32 mbc = 10000;
|
||||
bool flten = false, wwen = false;
|
||||
QByteArray state = g.profile[m_radioProfileId].simulatorOptions().dbgConsoleState;
|
||||
QDataStream stream(state);
|
||||
|
||||
stream >> ver;
|
||||
if (ver && ver <= m_savedViewStateVersion)
|
||||
stream >> fci >> mbc >> flten >> wwen;
|
||||
|
||||
ui->filterText->insertItems(0, g.simuDbgFilters());
|
||||
ui->filterText->setCurrentIndex(fci);
|
||||
ui->btnFilter->setChecked(flten);
|
||||
ui->console->setMaximumBlockCount(mbc);
|
||||
ui->actionWordWrap->setChecked(wwen);
|
||||
onFilterTextEdited();
|
||||
}
|
||||
|
||||
void DebugOutput::traceCallback(const char * text)
|
||||
{
|
||||
const static QRegExp blank("^[\\r\\n]+$");
|
||||
bool isBlank;
|
||||
|
||||
if (!m_running)
|
||||
return;
|
||||
|
||||
QString line(text);
|
||||
isBlank = line.contains(blank);
|
||||
|
||||
m_mtxDataBuffer.lock();
|
||||
if (isBlank && m_dataBuffer.size())
|
||||
m_dataBuffer[m_dataBuffer.size()-1] += line;
|
||||
else
|
||||
m_dataBuffer.append(text);
|
||||
if (m_dataBuffer.size() > m_dataBufferMaxSize) {
|
||||
m_dataBuffer.removeFirst();
|
||||
qDebug() << __FILE__ << __LINE__ << "Line buffer overflow! size >" << m_dataBufferMaxSize;
|
||||
}
|
||||
m_mtxDataBuffer.unlock();
|
||||
}
|
||||
|
||||
void DebugOutput::processBytesReceived()
|
||||
{
|
||||
QString text;
|
||||
bool fltMatch;
|
||||
const QTextCursor savedCursor(ui->console->textCursor());
|
||||
const int sbValue = ui->console->verticalScrollBar()->value();
|
||||
const bool sbAtBottom = (sbValue == ui->console->verticalScrollBar()->maximum());
|
||||
|
||||
m_tmrDataPrint->stop();
|
||||
while (m_dataBuffer.size() > 1) {
|
||||
m_mtxDataBuffer.lock();
|
||||
text = m_dataBuffer.takeFirst();
|
||||
m_mtxDataBuffer.unlock();
|
||||
// filter
|
||||
if (ui->btnFilter->isChecked()) {
|
||||
fltMatch = text.contains(m_filterRegEx);
|
||||
if ((m_filterExclude && fltMatch) || (!m_filterExclude && !fltMatch)) {
|
||||
continue;
|
||||
}
|
||||
}
|
||||
ui->console->moveCursor(QTextCursor::End);
|
||||
ui->console->textCursor().insertText(text);
|
||||
if (sbAtBottom) {
|
||||
ui->console->moveCursor(QTextCursor::End);
|
||||
ui->console->verticalScrollBar()->setValue(ui->console->verticalScrollBar()->maximum());
|
||||
}
|
||||
else {
|
||||
ui->console->setTextCursor(savedCursor);
|
||||
ui->console->verticalScrollBar()->setValue(sbValue);
|
||||
}
|
||||
QCoreApplication::processEvents();
|
||||
}
|
||||
m_tmrDataPrint->start();
|
||||
}
|
||||
|
||||
/*
|
||||
* UI handlers
|
||||
*/
|
||||
|
||||
void DebugOutput::onFilterTextEdited()
|
||||
{
|
||||
const QString fText = ui->filterText->currentText();
|
||||
if (fText.isEmpty()) {
|
||||
ui->btnFilter->setChecked(false);
|
||||
m_filterRegEx = QRegularExpression();
|
||||
return;
|
||||
}
|
||||
|
||||
m_filterRegEx = makeRegEx(fText, &m_filterExclude);
|
||||
|
||||
if (m_filterRegEx.isValid()) {
|
||||
//ui->btnFilter->setChecked(true);
|
||||
ui->filterText->setStyleSheet("");
|
||||
}
|
||||
else {
|
||||
ui->btnFilter->setChecked(false);
|
||||
m_filterRegEx = QRegularExpression();
|
||||
ui->filterText->setStyleSheet("background-color: rgba(255, 205, 185, 200);");
|
||||
}
|
||||
}
|
||||
|
||||
void DebugOutput::onFilterTextChanged(const QString &)
|
||||
{
|
||||
onFilterTextEdited();
|
||||
}
|
||||
|
||||
void DebugOutput::on_bufferSize_editingFinished()
|
||||
{
|
||||
ui->console->setMaximumBlockCount(ui->bufferSize->value());
|
||||
}
|
||||
|
||||
void DebugOutput::on_actionWordWrap_toggled(bool checked)
|
||||
{
|
||||
ui->console->setLineWrapMode(checked ? QPlainTextEdit::WidgetWidth : QPlainTextEdit::NoWrap);
|
||||
}
|
||||
|
||||
void DebugOutput::on_actionClearScr_triggered()
|
||||
{
|
||||
ui->console->clear();
|
||||
}
|
||||
|
||||
void DebugOutput::on_actionShowFilterHelp_triggered()
|
||||
{
|
||||
// TODO : find some place better for this.
|
||||
QString help = \
|
||||
"<html><head><style>kbd {background-color: ghostwhite; font-size: large; white-space: nowrap;}</style></head><body>"
|
||||
"<p>The filter supports two syntax types: basic matching with common wildcards and well as full Perl-style (<code>pcre</code>) Regular Expressions.</p>"
|
||||
"<p>By default a filter will only show lines which match (<b>inclusive</b>). To make an <b>exclusive</b> filter which removes matching lines, "
|
||||
"prefix the filter expression with a <kbd>!</kbd> (exclamation mark).</p>"
|
||||
"<p>To use <b>Regular Expressions</b> (RegEx), prefix the filter text with a <kbd>/</kbd> (slash) or <kbd>^</kbd> (up caret). "
|
||||
"<ul>"
|
||||
"<li>Put the <kbd>/</kbd> or <kbd>^</kbd> after the exclusive <kbd>!</kbd> indicator if you're using one.</li>"
|
||||
"<li>By default the match is case-sensitive. To make it insensitive, add the typical <kbd>/i</kbd> (slash i) operator at the end of your RegEx.</li>"
|
||||
"<li>If you use a caret (^) to denote a RegEx, it will become part of the Reg. Ex. (that is, matches from start of line).</li>"
|
||||
"<li>If the RegEx is invalid, the filter edit field should show a red border and you will not be able to enable the filter.</li>"
|
||||
"<li>A useful resource for testing REs (with a full reference) can be found at <a href=\"http://www.regexr.com/\">http://www.regexr.com/</a></li>"
|
||||
"</ul></p>"
|
||||
"<p>To use <b>basic matching</b> just type any text. Wildcards <kbd>*</kbd> (asterisk) matches any text and <kbd>?</kbd> (question mark) matches any single character."
|
||||
"<ul>"
|
||||
"<li>The match is always case-insensitive.</li>"
|
||||
"<li>The match always starts from the beginning of a log line. To ignore characters at the start, use a leading <kbd>*</kbd> wildcard.</li>"
|
||||
"<li>A trailing <kbd>*</kbd> is always implied (that is, matches anything to the end of the log line). To avoid this, use a RegEx.</li>"
|
||||
"<li>You can match literal wildcard characters by prefixing them with a <kbd>\\</kbd> (backslash) character (eg. \"foo\\*bar\" matches \"foo*bar\").</li>"
|
||||
"</ul></p>"
|
||||
"<p>After <b>editing text</b>, press ENTER or TAB key (or click anywhere outside the box) to update the filter.</p>"
|
||||
"<p>To <b>remove an entry</b> from the filter selector list, first choose it, and while in the line editor press <kbd>Shift-Delete</kbd> (or <kbd>Shift-Backspace</kbd>) key combination. "
|
||||
"The default filters cannot be removed. Up to 50 filters are stored.</p>"
|
||||
"</body></html>"
|
||||
;
|
||||
QMessageBox * msgbox = new QMessageBox(QMessageBox::NoIcon, tr("Debug Console Filter Help"), help, QMessageBox::Ok, this);
|
||||
msgbox->exec();
|
||||
}
|
||||
|
||||
|
||||
// static
|
||||
QRegularExpression DebugOutput::makeRegEx(const QString & input, bool * isExlusive)
|
||||
{
|
||||
QString output(input);
|
||||
QRegularExpression re;
|
||||
QRegularExpression::PatternOptions reFlags = QRegularExpression::DontCaptureOption;
|
||||
#if (QT_VERSION >= QT_VERSION_CHECK(5, 4, 0))
|
||||
reFlags |= QRegularExpression::OptimizeOnFirstUsageOption;
|
||||
#endif
|
||||
|
||||
if (input.left(1) == "!") {
|
||||
output.remove(0, 1);
|
||||
if (isExlusive)
|
||||
*isExlusive = true;
|
||||
}
|
||||
else if (isExlusive) {
|
||||
*isExlusive = false;
|
||||
}
|
||||
// regex?
|
||||
if (output.left(1) == "/" || output.left(1) == "^") {
|
||||
if (output.left(1) == "/")
|
||||
output.remove(0, 1);
|
||||
// check for case-insensitive flag at end ("/.../i")
|
||||
if (output.endsWith("/i")) {
|
||||
output.chop(2);
|
||||
reFlags |= QRegularExpression::CaseInsensitiveOption;
|
||||
}
|
||||
else if (output.endsWith("/")) {
|
||||
output.chop(1);
|
||||
}
|
||||
re.setPattern(output);
|
||||
}
|
||||
// no, convert arbitrary string to regex
|
||||
else {
|
||||
output.replace(QRegExp("^\\\\/"), "/"); // remove escape before fwd-slash ("\/...")
|
||||
// escape all special chars except * and ?
|
||||
output.replace(QRegExp("(\\\\|\\.|\\+|\\^|\\$|\\||\\)|\\(|\\]|\\[|\\}|\\{)"), "\\\\1");
|
||||
output.replace("\\*", "\x30").replace("\\?", "\x31"); // save escaped wildcard chars
|
||||
output.replace("*", ".*").replace("?", "."); // convert common wildcards
|
||||
output.replace("\x30", "\\\\*").replace("\x31", "\\\\?"); // replace escaped wildcard chars
|
||||
output.prepend("^"); // match from start of line; .append("$"); // match whole line
|
||||
reFlags |= QRegularExpression::CaseInsensitiveOption;
|
||||
re.setPattern(output);
|
||||
}
|
||||
// TODO : user option?
|
||||
re.setPatternOptions(reFlags);
|
||||
return re;
|
||||
}
|
||||
|
||||
|
||||
/*
|
||||
* Filter input validator for RegEx syntax.
|
||||
*/
|
||||
|
||||
QValidator::State DebugOutputFilterValidator::validate(QString & input, int &) const
|
||||
{
|
||||
QRegularExpression re = DebugOutput::makeRegEx(input);
|
||||
if (re.isValid())
|
||||
return QValidator::Acceptable;
|
||||
else
|
||||
return QValidator::Intermediate;
|
||||
}
|
||||
|
||||
/*
|
||||
* Event filter for editable QComboBox to allow deleting items with Shift-Delete/Backspace
|
||||
*/
|
||||
|
||||
bool DeleteComboBoxItemEventFilter::eventFilter(QObject *obj, QEvent *event)
|
||||
{
|
||||
QComboBox * cb = dynamic_cast<QComboBox *>(obj);
|
||||
if (cb && cb->isEditable() && cb->currentIndex() > -1 && cb->currentData().toString() != "no_delete") {
|
||||
if (event->type() == QEvent::KeyPress) {
|
||||
QKeyEvent *keyEvent = static_cast<QKeyEvent *>(event);
|
||||
if ((keyEvent->key() == Qt::Key::Key_Delete || keyEvent->key() == Qt::Key::Key_Backspace) && keyEvent->modifiers() == Qt::ShiftModifier) {
|
||||
cb->removeItem(cb->currentIndex());
|
||||
cb->setCurrentIndex(-1);
|
||||
return true;
|
||||
}
|
||||
}
|
||||
}
|
||||
return QObject::eventFilter(obj, event);
|
||||
}
|
||||
|
|
|
|||
Loading…
Add table
Add a link
Reference in a new issue