gboard.cc

Go to the documentation of this file.

// G4Dialog
#include "gboard.h"
#include "gui_session.h"
 
// qt
#include <QVBoxLayout>
#include <QRegularExpression>
 
 
GBoard::GBoard(const std::shared_ptr<GOptions>& gopt, QWidget* parent)
    : QWidget(parent),
      GBase(gopt, GBOARD_LOGGER) {
    // --- Create top bar widgets ---
    // The top bar provides a lightweight "console" UX: filter, clear, save.
    searchLineEdit = new QLineEdit(this);
    searchLineEdit->setObjectName("searchLineEdit");
    searchLineEdit->setPlaceholderText(tr("Filter log lines (case insensitive)..."));
    searchLineEdit->setClearButtonEnabled(true); // Allows quickly removing the filter text.
 
    clearButton = new QToolButton(this);
    clearButton->setObjectName("clearButton");
    clearButton->setIcon(style()->standardIcon(QStyle::SP_DialogResetButton));
    clearButton->setToolTip(tr("Clear Log"));
    clearButton->setText(tr("Clear"));
    // for some reason, the SP_TrashIcon icon is not showing, so using SP_DialogResetButton
    clearButton->setToolButtonStyle(Qt::ToolButtonTextBesideIcon); // Or other style
    clearButton->setEnabled(true);
 
    saveButton = new QToolButton(this);
    saveButton->setIcon(style()->standardIcon(QStyle::SP_DialogSaveButton));
    saveButton->setToolTip(tr("Save Log to File"));
    saveButton->setEnabled(true);
 
 
    // Create a horizontal layout for the top bar.
    auto* topBarLayout = new QHBoxLayout;
    topBarLayout->addWidget(searchLineEdit);
    topBarLayout->addWidget(clearButton);
    topBarLayout->addWidget(saveButton);
    topBarLayout->setSpacing(5);
 
    // Create a QTextEdit for log messages.
    // Rich text is enabled so that HTML fragments (for example ANSI-to-HTML conversions) render correctly.
    logTextEdit = new QTextEdit(this);
    logTextEdit->setAcceptRichText(true);
    logTextEdit->setReadOnly(true);
    logTextEdit->setMinimumHeight(200);
    logTextEdit->setMinimumWidth(400);
 
    auto* layout = new QVBoxLayout(this);
    layout->addLayout(topBarLayout);
    layout->addWidget(logTextEdit, 1); // 1: stretchable
    setLayout(layout);
 
    // --- Connect signals to slots ---
    // UI changes (typing, clicking) are translated into operations on the stored log history.
    connect(searchLineEdit, &QLineEdit::textChanged, this, &GBoard::filterLog);
    connect(clearButton, &QToolButton::clicked, this, &GBoard::clearLog);
    connect(saveButton, &QToolButton::clicked, this, &GBoard::saveLog);
 
    log->info(1, "GBoard initialized");
}
 
void GBoard::appendLog(const QString& htmlFragment) {
    // See header for API docs.
    if (QThread::currentThread() != thread()) {
        QMetaObject::invokeMethod(this, [this, htmlFragment]() { appendLog(htmlFragment); });
        return;
    }
    if (htmlFragment.trimmed().isEmpty()) { return; }
 
    // Append to the source of truth, the full log line list.
    // NOTE: We intentionally store all lines (even when filtered out) so the user can change filters later.
    fullLogLines.append(htmlFragment);
 
    // Coalesce output bursts, including synchronous Geant4 initialization, into one incremental update.
    if (!displayUpdatePending) {
        displayUpdatePending = true;
        QMetaObject::invokeMethod(this, "updateDisplay", Qt::QueuedConnection);
    }
}
 
void GBoard::updateDisplay() {
    // See header for API docs.
    if (!logTextEdit) return;
 
    // Ensure QTextEdit manipulation occurs on the GUI thread.
    // This protects typical usage where log lines arrive from worker threads or external callbacks.
    if (QThread::currentThread() != logTextEdit->thread()) {
        QMetaObject::invokeMethod(this, "updateDisplay", Qt::QueuedConnection);
        return;
    }
 
    displayUpdatePending = false;
 
    const bool          filtering = !currentFilterText.isEmpty();
    Qt::CaseSensitivity cs        = Qt::CaseInsensitive;
 
    // Previously displayed history remains in place; only visit newly received lines.
    while (displayedLineCount < fullLogLines.size()) {
        const auto& line = fullLogLines[displayedLineCount++];
        bool matches = true;
 
        if (filtering) { matches = (line.indexOf(currentFilterText, 0, cs) >= 0); }
 
        if (matches) { logTextEdit->append(line); }
    }
 
    // Auto-scroll to the bottom after updating the display.
    logTextEdit->verticalScrollBar()->setValue(logTextEdit->verticalScrollBar()->maximum());
}
 
void GBoard::filterLog(const QString& searchText) {
    // See header for API docs.
    // Keep the filter string normalized so repeated updates remain stable.
    currentFilterText = searchText.trimmed();
    logTextEdit->clear();
    displayedLineCount = 0;
    updateDisplay();
}
 
void GBoard::clearLog() {
    // See header for API docs.
    if (logTextEdit) {
        fullLogLines.clear();
        logTextEdit->clear();
        displayedLineCount = 0;
        updateDisplay();
        log->info(1, "Log cleared by user.");
    }
}
 
// Slot to Save the Log
void GBoard::saveLog() {
    // See header for API docs.
    if (!logTextEdit) return;
    updateDisplay(); // Include queued output in the exported view.
 
    QString defaultFileName = "gboard_log.log"; // Suggest a default name
    QString fileName        = QFileDialog::getSaveFileName(this,
                                                    tr("Save Log File"),
                                                    defaultFileName, // Default file/path suggestion
                                                    tr("Log Files (*.log);;Text Files (*.txt);;All Files (*)"));
 
    if (fileName.isEmpty()) {
        return; // User cancelled
    }
 
    QFile file(fileName);
    if (!file.open(QIODevice::WriteOnly | QIODevice::Text)) {
        QMessageBox::warning(this, tr("Save Log Error"),
                             tr("Could not open file %1 for writing:\n%2.")
                             .arg(QDir::toNativeSeparators(fileName), file.errorString()));
        log->warning(
            "Failed to save log to %1. Error: %2", fileName.toStdString(), file.errorString().toStdString());
        return;
    }
 
    QTextStream out(&file);
    // Save the plain text content (most common for logs).
    // This captures exactly what the user sees (including filtering) in a portable log-friendly format.
    out << logTextEdit->toPlainText();
    file.close(); // Stream destructor closes it, but explicit is fine
 
    log->info("Log saved successfully to %1", fileName.toStdString());
    // Optional: Show a status bar message or brief confirmation dialog
}