105 lines
2.8 KiB
C++
105 lines
2.8 KiB
C++
#pragma once
|
|
|
|
#include <Tactility/app/AppRegistration.h>
|
|
|
|
#include <string>
|
|
|
|
namespace tt::app {
|
|
|
|
class App;
|
|
class AppContext;
|
|
|
|
/** Application types */
|
|
enum class Category {
|
|
/** Standard apps, provided by the system. */
|
|
System,
|
|
/** The apps that are launched/shown by the Settings app. The Settings app itself is of type AppTypeSystem. */
|
|
Settings,
|
|
/** User-provided apps. */
|
|
User
|
|
};
|
|
|
|
/** Result status code for application result callback. */
|
|
enum class Result {
|
|
Ok = 0U,
|
|
Cancelled = 1U,
|
|
Error = 2U
|
|
};
|
|
|
|
class Location {
|
|
|
|
std::string path;
|
|
Location() = default;
|
|
explicit Location(const std::string& path) : path(path) {}
|
|
|
|
public:
|
|
|
|
static Location internal() { return {}; }
|
|
|
|
static Location external(const std::string& path) {
|
|
return Location(path);
|
|
}
|
|
|
|
/** Internal apps are all apps that are part of the firmware release. */
|
|
bool isInternal() const { return path.empty(); }
|
|
|
|
/**
|
|
* External apps are all apps that are not part of the firmware release.
|
|
* e.g. an application on the sd card or one that is installed in /data
|
|
*/
|
|
bool isExternal() const { return !path.empty(); }
|
|
const std::string& getPath() const { return path; }
|
|
};
|
|
|
|
typedef std::shared_ptr<App>(*CreateApp)();
|
|
|
|
struct AppManifest {
|
|
|
|
struct Flags {
|
|
constexpr static uint32_t None = 0;
|
|
/** Don't show the statusbar */
|
|
constexpr static uint32_t HideStatusBar = 1 << 0;
|
|
/** Hint to other systems to not show this app (e.g. in launcher or settings) */
|
|
constexpr static uint32_t Hidden = 1 << 1;
|
|
};
|
|
|
|
/** The SDK version that was used to compile this app. (e.g. "0.6.0") */
|
|
std::string targetSdk = {};
|
|
|
|
/** Comma-separated list of platforms, e.g. "esp32,esp32s3" */
|
|
std::string targetPlatforms = {};
|
|
|
|
/** The identifier by which the app is launched by the system and other apps. */
|
|
std::string appId = {};
|
|
|
|
/** The user-readable name of the app. Used in UI. */
|
|
std::string appName = {};
|
|
|
|
/** Optional icon. */
|
|
std::string appIcon = {};
|
|
|
|
/** The version as it is displayed to the user (e.g. "1.2.0") */
|
|
std::string appVersionName = {};
|
|
|
|
/** The technical version (must be incremented with new releases of the app */
|
|
uint64_t appVersionCode = {};
|
|
|
|
/** App category helps with listing apps in Launcher, app list or settings apps. */
|
|
Category appCategory = Category::User;
|
|
|
|
/** Where the app is located */
|
|
Location appLocation = Location::internal();
|
|
|
|
/** Controls various settings */
|
|
uint32_t appFlags = Flags::None;
|
|
|
|
/** Create the instance of the app */
|
|
CreateApp createApp = nullptr;
|
|
};
|
|
|
|
struct {
|
|
bool operator()(const std::shared_ptr<AppManifest>& left, const std::shared_ptr<AppManifest>& right) const { return left->appName < right->appName; }
|
|
} SortAppManifestByName;
|
|
|
|
} // namespace
|