c3bcf93698
- Refactor the way apps work: Instead of a C interface, they are now C++ classes. The main reasoning is that attaching data to an app was cumbersome. Having different implementations for different kinds of apps was cumbersome too. (3 or 4 layers of manifest nesting for the TactilityC project) - External apps are still written in C, but they get a createData/destroyData in their manifest, so: - External apps now have their own manifest. - All functions in the original AppManifest are removed and replaced by a single `createApp` function - External apps now automatically register (each app individually!) when they run the first time. As a side-effect they become visible in the `AppList` app! - Adapted all apps for the new interface. - Adapted all internal logic for these changes (Gui, ViewPort, Loader, AppContext, AppInstance, etc.) - Rewrote parts of Loader to use std::shared_ptr to make the code much safer. - Added a refcount check for the `AppInstance` and `App` at the end of their lifecycle. Show warning if refcount is too high.
102 lines
2.7 KiB
C++
102 lines
2.7 KiB
C++
#pragma once
|
|
|
|
#include "Bundle.h"
|
|
#include <memory>
|
|
|
|
namespace tt::app {
|
|
|
|
// Forward declarations
|
|
class App;
|
|
class Paths;
|
|
struct AppManifest;
|
|
enum class Result;
|
|
|
|
typedef union {
|
|
struct {
|
|
bool showStatusbar : 1;
|
|
};
|
|
unsigned char flags;
|
|
} Flags;
|
|
|
|
/**
|
|
* The public representation of an application instance.
|
|
* @warning Do not store references or pointers to these! You can retrieve them via the service registry.
|
|
*/
|
|
class AppContext {
|
|
|
|
protected:
|
|
|
|
virtual ~AppContext() = default;
|
|
|
|
public:
|
|
|
|
virtual const AppManifest& getManifest() const = 0;
|
|
virtual std::shared_ptr<const Bundle> getParameters() const = 0;
|
|
virtual std::unique_ptr<Paths> getPaths() const = 0;
|
|
|
|
virtual std::shared_ptr<App> getApp() const = 0;
|
|
};
|
|
|
|
class Paths {
|
|
|
|
public:
|
|
|
|
Paths() = default;
|
|
virtual ~Paths() = default;
|
|
|
|
/**
|
|
* Returns the directory path for the data location for an app.
|
|
* The data directory is intended to survive OS upgrades.
|
|
* The path will not end with a "/".
|
|
*/
|
|
virtual std::string getDataDirectory() const = 0;
|
|
|
|
/**
|
|
* @see getDataDirectory(), but with LVGL prefix.
|
|
*/
|
|
virtual std::string getDataDirectoryLvgl() const = 0;
|
|
|
|
/**
|
|
* Returns the full path for an entry inside the data location for an app.
|
|
* The data directory is intended to survive OS upgrades.
|
|
* Configuration data should be stored here.
|
|
* @param[in] childPath the path without a "/" prefix
|
|
*/
|
|
virtual std::string getDataPath(const std::string& childPath) const = 0;
|
|
|
|
/**
|
|
* @see getDataPath(), but with LVGL prefix.
|
|
*/
|
|
virtual std::string getDataPathLvgl(const std::string& childPath) const = 0;
|
|
|
|
/**
|
|
* Returns the directory path for the system location for an app.
|
|
* The system directory is not intended to survive OS upgrades.
|
|
* You should not store configuration data here.
|
|
* The path will not end with a "/".
|
|
* This is mainly used for core apps (system/boot/settings type).
|
|
*/
|
|
virtual std::string getSystemDirectory() const = 0;
|
|
|
|
/**
|
|
* @see getSystemDirectory(), but with LVGL prefix.
|
|
*/
|
|
virtual std::string getSystemDirectoryLvgl() const = 0;
|
|
|
|
/**
|
|
* Returns the full path for an entry inside the system location for an app.
|
|
* The data directory is not intended to survive OS upgrades.
|
|
* You should not store configuration data here.
|
|
* This is mainly used for core apps (system/boot/settings type).
|
|
* @param[in] childPath the path without a "/" prefix
|
|
*/
|
|
virtual std::string getSystemPath(const std::string& childPath) const = 0;
|
|
|
|
/**
|
|
* @see getSystemPath(), but with LVGL prefix.
|
|
*/
|
|
virtual std::string getSystemPathLvgl(const std::string& childPath) const = 0;
|
|
};
|
|
|
|
}
|