Main.cpp

Go to the documentation of this file.

// Copyright 2015 - 2026, GIBIS-UNIFESP and the wiRedPanda contributors
// SPDX-License-Identifier: GPL-3.0-or-later
 
#ifdef Q_OS_LINUX
#include <cstdio>
#endif
 
#ifdef Q_OS_WIN
#include <windows.h>
#endif
 
#include <QCommandLineParser>
#include <QDir>
#include <QFile>
#include <QMessageBox>
#include <QRegularExpression>
#include <QStandardPaths>
 
#ifdef HAVE_SENTRY
#include <QScopeGuard>
#include <QSettings>
#include <QUuid>
#endif
 
#include "App/Core/Application.h"
#include "App/Core/Common.h"
#include "App/Core/ThemeManager.h"
#include "App/Element/GraphicElement.h"
#include "App/Scene/Workspace.h"
#include "App/UI/MainWindow.h"
 
#ifdef ENABLE_MCP_SERVER
#include "MCP/Server/Core/MCPProcessor.h"
#endif
 
#ifdef HAVE_SENTRY
#include "thirdparty/sentry/include/sentry.h"
#endif
 
#ifdef Q_OS_LINUX
namespace {
 
QtMessageHandler g_previousMessageHandler = nullptr;
 
void portalQuietMessageHandler(QtMsgType type, const QMessageLogContext &context, const QString &message)
{
    // Qt 6.10 QDesktopUnixServices issues a Screenshot.version Get before the host-portal
    // Register, so xdg-desktop-portal caches our sender and rejects Register (QTBUG-145847).
    if (type == QtWarningMsg && context.category
        && qstrcmp(context.category, "qt.qpa.services") == 0
        && message.startsWith(QLatin1String("Failed to register with host portal"))) {
        return;
    }
    // Qt Wayland's text-input v3 backend emits a "leave event for surface 0x0" warning
    // every time focus changes between widgets — a known Qt issue affecting many apps
    // (FreeCAD, Transmission, Telegram).  No user-actionable signal; spammy on Wayland.
    if (type == QtWarningMsg && context.category
        && qstrcmp(context.category, "qt.qpa.wayland.textinput") == 0) {
        return;
    }
    // Qt's HarfBuzz/font database logs "OpenType support missing for <font>, script <N>"
    // when a fallback font lacks coverage for a particular Unicode script.  Harmless —
    // Qt then falls back to a font that does cover the script.  Note: this is emitted
    // as qDebug, not qCWarning, so we deliberately don't gate on type here.
    if (message.startsWith(QLatin1String("OpenType support missing"))) {
        return;
    }
    if (g_previousMessageHandler) {
        g_previousMessageHandler(type, context, message);
    } else {
        std::fputs(qPrintable(qFormatLogMessage(type, context, message)), stderr);
        std::fputc('\n', stderr);
    }
}
 
}
#endif
 
int main(int argc, char *argv[])
{
#ifdef HAVE_SENTRY
    // Sentry must be initialised before QApplication so that crashes during Qt
    // startup are captured; sentry_close() is called via qScopeGuard at process exit
    // to flush any queued events even if the app exits via an exception or exit().
    sentry_options_t *options = sentry_options_new();
    sentry_options_set_dsn(options, "https://719a4881adf6e678b198bf9aad6b4500@o4508704323469312.ingest.us.sentry.io/4508704326352896");
 
    // Use an absolute path so the crash database is always in the same place
    // regardless of the working directory the app was launched from.
    const auto dbPath = QStandardPaths::writableLocation(QStandardPaths::AppDataLocation) + "/sentry-native";
    sentry_options_set_database_path(options, dbPath.toStdString().c_str());
 
    sentry_options_set_release(options, "wiredpanda@" APP_VERSION);
    sentry_options_set_debug(options, 0);
 
#ifdef QT_DEBUG
    sentry_options_set_environment(options, "development");
#else
    sentry_options_set_environment(options, "production");
#endif
 
    sentry_init(options);
 
    // Anonymous user identification — persisted across sessions via QSettings
    // so Sentry can count unique affected users and correlate issues.
    auto userId = QSettings().value("sentry/userId").toString();
    if (userId.isEmpty()) {
        userId = QUuid::createUuid().toString(QUuid::WithoutBraces);
        QSettings().setValue("sentry/userId", userId);
    }
    sentry_value_t user = sentry_value_new_object();
    sentry_value_set_by_key(user, "id", sentry_value_new_string(userId.toStdString().c_str()));
    sentry_set_user(user);
 
    // Custom tags for filtering and triage
    sentry_set_tag("qt.version", QT_VERSION_STR);
 
    // Make sure everything flushes
    auto sentryClose = qScopeGuard([] { sentry_close(); });
#endif
 
    // Disable all debug/verbose output at startup; the --verbosity option re-enables
    // it after the command-line parser runs below
    Comment::setVerbosity(-1);
 
#ifdef ENABLE_MCP_SERVER
    // Early argument parsing for MCP mode detection
    // This must be done before QApplication creation to set Qt platform correctly
    // Full argument validation happens later with QCommandLineParser
    bool mcpMode = false;
    bool mcpGuiMode = false;
    for (int i = 1; i < argc; i++) {
        if (QString(argv[i]) == "--mcp") {
            mcpMode = true;
        }
        if (QString(argv[i]) == "--mcp-gui") {
            mcpGuiMode = true;
        }
    }
#else
    bool mcpMode = false;
    bool mcpGuiMode = false;
#endif
 
#ifdef Q_OS_LINUX
    // On Linux, CLI-only invocations (codegen, waveform export) must not try to
    // connect to an X11 display — CI runners and headless servers typically don't
    // have one.  Forcing "offscreen" before QApplication avoids a crash.
    bool isCliMode = false;
    for (int i = 1; i < argc; ++i) {
        QString arg = QString::fromLocal8Bit(argv[i]);
        if (arg == "--arduino-file" || arg == "-a" ||
            arg == "--waveform" || arg == "-w" ||
            arg == "--terminal" || arg == "-c" ||
            arg == "--help" || arg == "-h" ||
            arg == "--version" || arg == "-v") {
            isCliMode = true;
            break;
        }
    }
 
    // Also check if no DISPLAY is available (headless environment)
    if (isCliMode || !qEnvironmentVariableIsSet("DISPLAY")) {
        qputenv("QT_QPA_PLATFORM", "offscreen");
    }
#endif
 
#ifdef Q_OS_WIN
    if (!mcpMode && !mcpGuiMode) {
        // Only attach console for non-MCP modes to preserve stdin/stdout pipes
        FILE *fpstdout = stdout, *fpstderr = stderr;
        if (AttachConsole(ATTACH_PARENT_PROCESS)) {
            freopen_s(&fpstdout, "CONOUT$", "w", stdout);
            freopen_s(&fpstderr, "CONOUT$", "w", stderr);
        }
    }
#endif
 
#ifndef Q_OS_WIN
    // Set environment for headless operation if in MCP mode without GUI
    if (mcpMode && !mcpGuiMode) {
        qputenv("QT_QPA_PLATFORM", "offscreen");
    }
#endif
 
#ifdef Q_OS_LINUX
    g_previousMessageHandler = qInstallMessageHandler(portalQuietMessageHandler);
 
    // When launched as an AppImage the runtime changes CWD to the squashfs mount
    // point.  OWD holds the directory the user was actually in, so relative file
    // paths from CLI args and file dialogs resolve correctly.
    if (qEnvironmentVariableIsSet("APPIMAGE")) {
        QDir::setCurrent(qEnvironmentVariable("OWD"));
    }
#endif
 
    Application app(argc, argv);
    app.setOrganizationName("GIBIS-UNIFESP");
    app.setApplicationName("wiRedPanda");
    app.setApplicationVersion(APP_VERSION);
    app.setDesktopFileName("wiredpanda");
    // Fusion style provides a consistent cross-platform look and is required for
    // the custom theme colours defined in ThemeManager to render correctly on all OSes
    app.setStyle("Fusion");
    // Build the window icon from pre-rasterised PNGs so it is always available
    // on the taskbar (SVG rendering requires a plugin that may not be loaded yet
    // at this early startup point, causing a null icon on KDE Wayland / Steam Deck).
    QIcon appIcon;
    appIcon.addPixmap(QPixmap(":/Assets/Icons/64x64/wpanda.png"));
    appIcon.addPixmap(QPixmap(":/Assets/Icons/128x128/wpanda.png"));
    app.setWindowIcon(appIcon);
 
    // Self-registering element metadata (static initialisers in each element's
    // .cpp) may trigger ThemeManager construction before QApplication exists.
    // When that happens the dark palette is silently dropped because
    // Application::instance() is still null.  Re-apply the persisted theme now
    // that the Application and Fusion style are ready.
    ThemeManager::setTheme(ThemeManager::theme());
 
#ifdef Q_OS_LINUX
    // When running as an AppImage, the Wayland compositor resolves the window icon
    // by looking up the desktop file for the app_id ("wiredpanda") in the system's
    // XDG_DATA_DIRS — it does not see the AppImage's internal share directory.
    // Self-registering the desktop file and icon to ~/.local/share/ makes the icon
    // visible to the compositor without requiring appimaged or manual installation.
    {
        const QString appImagePath = qEnvironmentVariable("APPIMAGE");
        const QString appDir = qEnvironmentVariable("APPDIR");
        const QString localShare = QStandardPaths::writableLocation(QStandardPaths::GenericDataLocation);
        const QString appsDir = localShare + "/applications";
        const QString desktopDst = appsDir + "/wiredpanda.desktop";
 
        if (!appImagePath.isEmpty() && !appDir.isEmpty()) {
            // Build the desired desktop file content: take the bundled template and
            // patch in the current AppImage path.  Comparing this against whatever is
            // installed detects both a changed path and any stale content from an older
            // release in one step.
            QString desiredDesktop;
            {
                QFile src(appDir + "/usr/share/applications/wiredpanda.desktop");
                if (src.open(QIODevice::ReadOnly)) {
                    desiredDesktop = QString::fromUtf8(src.readAll());
                    desiredDesktop.replace(QRegularExpression("^Exec=.*$", QRegularExpression::MultilineOption),
                                           "Exec=\"" + appImagePath + "\" %F");
                }
            }
 
            if (!desiredDesktop.isEmpty()) {
                bool needsUpdate = true;
                {
                    QFile installed(desktopDst);
                    if (installed.open(QIODevice::ReadOnly))
                        needsUpdate = (QString::fromUtf8(installed.readAll()) != desiredDesktop);
                }
                if (needsUpdate) {
                    QDir().mkpath(appsDir);
                    QFile dst(desktopDst);
                    if (dst.open(QIODevice::WriteOnly | QIODevice::Truncate)) {
                        const QByteArray bytes = desiredDesktop.toUtf8();
                        if (dst.write(bytes) != bytes.size()) {
                            qCWarning(zero) << "Failed to write desktop entry:" << dst.errorString();
                        }
                    }
                }
            }
 
            // Install icons whenever they are absent — independently of whether the
            // desktop entry needed updating.  Previous versions only installed the SVG,
            // so users running the same AppImage path would never get the PNG installed
            // because needsUpdate was false on every subsequent launch.
            const QString iconsDir = localShare + "/icons/hicolor/scalable/apps";
            QDir().mkpath(iconsDir);
            const QString iconDst = iconsDir + "/wpanda.svg";
            if (!QFile::exists(iconDst))
                QFile::copy(appDir + "/usr/share/icons/hicolor/scalable/apps/wpanda.svg", iconDst);
 
            const QString icons256Dir = localShare + "/icons/hicolor/256x256/apps";
            QDir().mkpath(icons256Dir);
            const QString icon256Dst = icons256Dir + "/wpanda.png";
            if (!QFile::exists(icon256Dst))
                QFile::copy(appDir + "/usr/share/icons/hicolor/256x256/apps/wpanda.png", icon256Dst);
        } else if (QFile::exists(desktopDst)) {
            // Not running as AppImage — remove stale self-registered desktop entry
            // left by a previous AppImage run, so it doesn't shadow the system-wide
            // entry installed by cmake --install.
            QFile::remove(desktopDst);
        }
    }
#endif
 
    try {
        QCommandLineParser parser;
        parser.setApplicationDescription(app.applicationName());
        parser.addHelpOption();
        parser.addVersionOption();
        parser.addPositionalArgument("file", QCoreApplication::translate("main", "Circuit file to open."));
 
        QCommandLineOption verbosityOption(
            {"v2", "verbosity"},
            QCoreApplication::translate("main", "Verbosity level 0 to 5, disabled by default."),
            QCoreApplication::translate("main", "verbosity level"));
        parser.addOption(verbosityOption);
 
        QCommandLineOption arduinoFileOption(
            {"a", "arduino-file"},
            QCoreApplication::translate("main", "Exports circuit to <arduino-file>."),
            QCoreApplication::translate("main", "arduino file"));
        parser.addOption(arduinoFileOption);
 
        QCommandLineOption waveformFileOption(
            {"w", "waveform"},
            QCoreApplication::translate("main", "Exports circuit to waveform text file."),
            QCoreApplication::translate("main", "waveform input text file"));
        parser.addOption(waveformFileOption);
 
        QCommandLineOption terminalFileOption(
            {"c", "terminal"},
            QCoreApplication::translate("main", "Exports circuit to waveform text file, reading input from terminal."));
        parser.addOption(terminalFileOption);
 
        QCommandLineOption blockTruthTableOption(
            {"btt", "blockTruthTable"},
            QCoreApplication::translate("main", "When used with -c/--terminal, block execution if the circuit contains Truth Tables."));
        parser.addOption(blockTruthTableOption);
 
#ifdef ENABLE_MCP_SERVER
        QCommandLineOption mcpModeOption(
            "mcp",
            QCoreApplication::translate("main", "Run in MCP (Model Context Protocol) mode for programmatic control."));
        parser.addOption(mcpModeOption);
 
        QCommandLineOption mcpGuiOption(
            "mcp-gui",
            QCoreApplication::translate("main", "Run MCP mode with a visible GUI window."));
        parser.addOption(mcpGuiOption);
#endif
 
        parser.process(app);
 
        if (const QString verbosity = parser.value(verbosityOption); !verbosity.isEmpty()) {
            Comment::setVerbosity(verbosity.toInt());
        }
 
        QStringList args = parser.positionalArguments();
 
        // --- Non-interactive batch operations ---
        // Each branch loads the circuit, runs the export, then exits immediately
        // without entering the Qt event loop.  Application::interactiveMode is set
        // to false so that error dialogs are suppressed and errors go to stderr only.
 
        // Resolve the positional argument against the original working
        // directory.  QFile would handle a relative path on its own, but
        // resolving up-front means any "file does not exist" error reports the
        // absolute path the user actually opened, which is far less confusing
        // than echoing back a bare basename.
        const QString inputFile = args.empty() ? QString() : QDir::current().absoluteFilePath(args.at(0));
 
        if (const QString arduFile = parser.value(arduinoFileOption); !arduFile.isEmpty()) {
            if (inputFile.isEmpty()) {
                QTextStream(stderr) << QCoreApplication::translate("main", "Error: no input circuit file given.") << '\n';
                return 1;
            }
            Application::interactiveMode = false;
            MainWindow window;
            window.loadPandaFile(inputFile);
            window.exportToArduino(arduFile);
            return 0;
        }
 
        if (const QString wfFile = parser.value(waveformFileOption); !wfFile.isEmpty()) {
            if (inputFile.isEmpty()) {
                QTextStream(stderr) << QCoreApplication::translate("main", "Error: no input circuit file given.") << '\n';
                return 1;
            }
            Application::interactiveMode = false;
            MainWindow window;
            window.loadPandaFile(inputFile);
            window.exportToWaveFormFile(wfFile);
            return 0;
        }
 
        if (const bool isTerminal = parser.isSet(terminalFileOption); isTerminal) {
            if (inputFile.isEmpty()) {
                QTextStream(stderr) << QCoreApplication::translate("main", "Error: no input circuit file given.") << '\n';
                return 1;
            }
            {
                Application::interactiveMode = false;
                MainWindow window;
                window.loadPandaFile(inputFile);
 
                // --blockTruthTable allows callers (e.g. automated graders) to
                // reject circuits that contain truth tables, which cannot be
                // reliably evaluated via the terminal waveform interface.
                if (parser.isSet(blockTruthTableOption)) {
                    bool containsTruthTable = false;
                    auto elements = window.currentTab()->scene()->elements();
 
                    for (const auto *element : elements) {
                        if (element->elementType() == ElementType::TruthTable) {
                            containsTruthTable = true;
                            break;
                        }
                    }
 
                    if (containsTruthTable) {
                        QTextStream(stderr) << QCoreApplication::translate("main", "Error: Circuit contains Truth Table elements.") << '\n';
                        return 1;
                    }
                }
 
                window.exportToWaveFormTerminal();
            }
            return 0;
        }
 
#ifdef ENABLE_MCP_SERVER
        // Handle MCP mode
        if (parser.isSet(mcpModeOption) || parser.isSet(mcpGuiOption)) {
            Application::interactiveMode = false;
 
            auto *window = new MainWindow();
 
            // Show window only if GUI mode is requested
            if (parser.isSet(mcpGuiOption)) {
                window->show();
            }
 
            // Start MCP processor
            MCPProcessor processor(window);
            processor.startProcessing();
 
            return app.exec();
        }
#endif
 
        auto *window = new MainWindow();
        window->show();
 
        if (!inputFile.isEmpty()) {
            window->loadPandaFile(inputFile);
        }
    } catch (const std::exception &e) {
        if (Application::interactiveMode) {
            QMessageBox::critical(nullptr, QObject::tr("Error!"), e.what());
        } else {
            // Non-interactive (CLI / MCP) modes have no dialog to fall back on;
            // without this, the process exits silently and the user sees no
            // indication that the file failed to load.
            QTextStream(stderr) << QCoreApplication::translate("main", "Error: ") << e.what() << '\n';
        }
        return 1;
    }
 
    return app.exec();
}