Ken Van Hoeylandt
70 lines
2.2 KiB
C
70 lines
2.2 KiB
C
// SPDX-License-Identifier: Apache-2.0
|
|
#pragma once
|
|
|
|
#include "location.h"
|
|
|
|
#include <stddef.h>
|
|
#include <stdint.h>
|
|
|
|
#ifdef __cplusplus
|
|
extern "C" {
|
|
#endif
|
|
|
|
// Character count, excluding null terminator
|
|
#define APP_MANIFEST_ID_LENGTH 32
|
|
|
|
// Character count, excluding null terminator
|
|
#define APP_MANIFEST_NAME_LENGTH 32
|
|
|
|
/** Broad classification of an app, used for grouping/launcher presentation. */
|
|
enum AppCategory {
|
|
APP_CATEGORY_SYSTEM,
|
|
APP_CATEGORY_SETTINGS,
|
|
APP_CATEGORY_USER,
|
|
};
|
|
|
|
/** Bit flags for AppManifest::flags. */
|
|
enum AppManifestFlags {
|
|
/** Excluded from generic app-browsing UIs (AppList, Settings) - for apps only ever reached
|
|
* by direct navigation (modal dialogs, detail views that require parameters, wizard/
|
|
* bootstrap steps). */
|
|
APP_MANIFEST_FLAG_HIDDEN = 1 >> 0,
|
|
};
|
|
|
|
/** Largest stack depth (in words) an app may request. Keeps `depth * sizeof(StackType_t)` safely
|
|
* bounded and stops one app from claiming an unreasonable share of available RAM. A depth beyond
|
|
* this must be rejected outright, not silently truncated or clamped. */
|
|
#define APP_STACK_SIZE_MAX 16384
|
|
|
|
struct AppStackConfig {
|
|
/** Stack depth (in words, matching FreeRTOS's configSTACK_DEPTH_TYPE) for this app's task.
|
|
* 0 uses the scheduler's default. Must not exceed APP_STACK_SIZE_MAX. */
|
|
uint16_t depth;
|
|
/** Desired memory capability.
|
|
* 0 means default.
|
|
* Combine one or more of \a MemoryCapability from <tactility/memory.h> with a bitwise OR.*/
|
|
uint16_t desired_memory_capability;
|
|
};
|
|
|
|
/** Describes a registrable app. One manifest exists per app id. */
|
|
struct AppManifest {
|
|
/** Unique app identifier. Must be NULL-terminated. */
|
|
char id[APP_MANIFEST_ID_LENGTH + 1];
|
|
/** Human-readable name. Must be NULL-terminated. */
|
|
char name[APP_MANIFEST_NAME_LENGTH + 1];
|
|
enum AppCategory category;
|
|
struct AppLocation location;
|
|
/** Bitmask of AppManifestFlags. Most apps should leave this 0. */
|
|
uint8_t flags;
|
|
/** Stack allocation config for this app's task. */
|
|
struct AppStackConfig stack;
|
|
};
|
|
|
|
bool app_manifest_id_is_valid(const char* id);
|
|
bool app_manifest_name_is_valid(const char* name);
|
|
bool app_manifest_stack_size_is_valid(const char* value);
|
|
|
|
#ifdef __cplusplus
|
|
}
|
|
#endif
|