Implement a Custom Application Manager Example

Provides the basic structure and starting point for a custom application manager executable.

Screenshot

Introduction

The application manager is compiled as a self-contained executable that can be configured in large parts through the YAML-based config file system and startup plugins. However, if you need to have more control over the application's startup behavior, it may be necessary to implement a custom application manager executable.

Note: Currently, all C++ classes in the application manager modules are considered private API, so there are no compatibility guarantees at all.

If you still require this behavior, this example provides a starting point that you can build your custom implementation upon. Keep in mind, that this custom application manager executable needs a System UI to display something on the screen, just like the standard appman executable.

The following is a breakdown of the minimal code necessary:

#include <QtAppManCommon/global.h>
#include <QtAppManCommon/logging.h>
#include <QtAppManMain/main.h>
#include <QtAppManMain/configuration.h>
#include <QtAppManPackage/packageutilities.h>
#include <QtAppManManager/sudo.h>

QT_USE_NAMESPACE_AM

The application manager is split into functional building blocks. These include statements pull in the basic set of classes that you need. To avoid possible clashes with QML plugins, all of the application manager's symbols are namespaced - QT_USE_NAMESPACE_AM expands to the equivalent using statement.

    QCoreApplication::setApplicationName(qSL("Custom Application Manager"));
    QCoreApplication::setApplicationVersion("0.1");

Generally, it's a good idea to set an application name and version.

    Logging::initialize(argc, argv);

We want the application manager's logging part to be initialized as early as possible, especially when we are dealing with DLT logging.

If you are using the application manager's installer part, this function needs to be called before the QApplication constructor to make sure that your C locale is a UTF-8 variant. This is a requirement, to get deterministic results when using libarchive with non-ASCII filenames.

    Sudo::forkServer(Sudo::DropPrivilegesPermanently);

Again, for the installer part only, an additional setup step is necessary before running the QApplication constructor: if the executable is setuid-root, this call will fork off a child process which keeps the root privileges while the main process permanently drops them.

    try {
        Main a(argc, argv);

        Configuration cfg;
        cfg.parse();

        a.setup(&cfg);
        a.loadQml(cfg.loadDummyData());
        a.showWindow(cfg.fullscreen() && !cfg.noFullscreen());

        return MainBase::exec();
    } catch (const std::exception &e) {
        qCCritical(LogSystem) << "ERROR:" << e.what();
        return 2;
    }

This try block is the heart of the custom application manager. You need to create a Main object, which is a class derived from QGuiApplication, plus a suitable configuration object. In this simple case, we use the application manager's default YAML parsing, so we instantiate a DefaultConfiguration object. The rest of the function involves parsing the configuration and then calling the relevant setup routines on the Main object.

Depending on your application manager's configuration, the Main object can be derived differently: headless, with widgets, or standard. So, you need to know the correct base class for the exec() call. However, the MainBase typedef circumvents this problem.

Most functions in the application manager throw exceptions that are derived from std::exception, so a catch handler is compulsory.

Example project @ code.qt.io

© 2019 Luxoft Sweden AB. Documentation contributions included herein are the copyrights of their respective owners. The documentation provided herein is licensed under the terms of the GNU Free Documentation License version 1.3 as published by the Free Software Foundation. Qt and respective logos are trademarks of The Qt Company Ltd. in Finland and/or other countries worldwide. All other trademarks are property of their respective owners.