src/Mod/Start/Gui/AppStartGui.cpp

// SPDX-License-Identifier: LGPL-2.1-or-later
/****************************************************************************
 *                                                                          *
 *   Copyright (c) 2024 The FreeCAD Project Association AISBL               *
 *                                                                          *
 *   This file is part of FreeCAD.                                          *
 *                                                                          *
 *   FreeCAD is free software: you can redistribute it and/or modify it     *
 *   under the terms of the GNU Lesser General Public License as            *
 *   published by the Free Software Foundation, either version 2.1 of the   *
 *   License, or (at your option) any later version.                        *
 *                                                                          *
 *   FreeCAD is distributed in the hope that it will be useful, but         *
 *   WITHOUT ANY WARRANTY; without even the implied warranty of             *
 *   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU       *
 *   Lesser General Public License for more details.                        *
 *                                                                          *
 *   You should have received a copy of the GNU Lesser General Public       *
 *   License along with FreeCAD. If not, see                                *
 *   <https://www.gnu.org/licenses/>.                                       *
 *                                                                          *
 ***************************************************************************/

#include <QString>
#include <QTimer>


#include <Base/Console.h>
#include <Base/Interpreter.h>
#include <Base/PyObjectBase.h>
#include <Gui/Language/Translator.h>
#include <Gui/Command.h>
#include <Gui/MainWindow.h>
#include <Gui/WidgetFactory.h>
#include "DlgStartPreferencesImp.h"


#include <gsl/pointers>

#include "Manipulator.h"
#include "StartView.h"

void loadStartResource()
{
    // add resources and reloads the translators
    Q_INIT_RESOURCE(Start);
    Q_INIT_RESOURCE(Start_translation);
    Gui::Translator::instance()->refresh();
}

namespace StartGui
{
extern PyObject* initModule();
}


namespace StartGui
{
class Module: public Py::ExtensionModule<Module>
{
public:
    Module()
        : Py::ExtensionModule<Module>("StartGui")
    {
        initialize("This module is the StartGui module.");  // register with Python
    }
};

class StartLauncher
{
public:
    StartLauncher()
    {
        // QTimers don't fire until the event loop starts, which is our signal that the GUI is up
        QTimer::singleShot(100, [this] { Launch(); });
    }

    void Launch()
    {
        auto hGrp = App::GetApplication().GetParameterGroupByPath(
            "User parameter:BaseApp/Preferences/Mod/Start"
        );
        bool showOnStartup = hGrp->GetBool("ShowOnStartup", true);
        if (showOnStartup) {
            Gui::Application::Instance->commandManager().runCommandByName("Start_Start");
            QTimer::singleShot(100, [this] { EnsureLaunched(); });
        }
    }

    void EnsureLaunched()
    {
        // It's possible that "Start_Start" didn't result in the creation of an MDI window, if it
        // was called to early. This polls the views to make sure the view was created, and if it
        // was not, re-calls the command.
        auto mw = Gui::getMainWindow();
        auto existingView = mw->findChild<StartGui::StartView*>(QLatin1String("StartView"));
        if (!existingView) {
            Launch();
        }
    }
};

PyObject* initModule()
{
    auto newModule = gsl::owner<Module*>(new Module);
    return Base::Interpreter().addModule(newModule);  // Transfer ownership
}

}  // namespace StartGui

/* Python entry */
PyMOD_INIT_FUNC(StartGui)
{
    static StartGui::StartLauncher* launcher = new StartGui::StartLauncher();
    Q_UNUSED(launcher)

    Base::Console().log("Loading GUI of Start module… ");
    PyObject* mod = StartGui::initModule();
    auto manipulator = std::make_shared<StartGui::Manipulator>();
    Gui::WorkbenchManipulator::installManipulator(manipulator);
    loadStartResource();
    Base::Console().log("done\n");

    // register preferences pages
    new Gui::PrefPageProducer<StartGui::DlgStartPreferencesImp>(QT_TRANSLATE_NOOP("QObject", "Start"));

    PyMOD_Return(mod);
}