Ken Van Hoeylandt
52 lines
2.1 KiB
C
52 lines
2.1 KiB
C
// SPDX-License-Identifier: Apache-2.0
|
|
#pragma once
|
|
|
|
#include <tactility/error.h>
|
|
|
|
#include <stddef.h>
|
|
|
|
#ifdef __cplusplus
|
|
extern "C" {
|
|
#endif
|
|
|
|
/**
|
|
* Computes the install directory for @a app_id (does not check whether anything is actually
|
|
* installed there).
|
|
* @param[out] path always NULL-terminated on return, even on failure. Empty when @a path_size
|
|
* is 0, since nothing is written in that case.
|
|
* @retval ERROR_NONE on success
|
|
* @retval ERROR_BUFFER_OVERFLOW @a path_size is too small to hold the path (including the
|
|
* NULL terminator)
|
|
* @retval ERROR_NOT_FOUND the app install location isn't available (e.g. no SD card)
|
|
*/
|
|
error_t app_get_install_path(const char* app_id, char* path, size_t path_size);
|
|
|
|
/**
|
|
* Installs a package from a tarball at @a source_path: extracts it into the package's install
|
|
* directory, parses the extracted manifest.properties (see app/package_manifest.h) into a
|
|
* PackageManifest and one or more AppManifestBindings, then registers each with app_manager_add()
|
|
* as an AppLocation{APP_LOCATION_PATH, <binary path>} app.
|
|
* If a package with the same id is already installed (via a previous app_install() call), it is
|
|
* uninstalled first: every one of its apps stopped if running, then its old install directory
|
|
* removed, before the new one takes its place.
|
|
* @param[in] source_path path to a tar file containing the package (must have
|
|
* manifest.properties at its root)
|
|
* @retval ERROR_NONE on success
|
|
* @retval ERROR_NOT_FOUND @a source_path doesn't exist / can't be read
|
|
* @retval ERROR_INVALID_ARGUMENT the tarball has no valid manifest.properties at its root
|
|
*/
|
|
error_t app_install(const char* source_path);
|
|
|
|
/**
|
|
* Uninstalls a previously app_install()-ed package: stops every one of its apps if currently
|
|
* running, deletes its install directory, and unregisters all of them (app_manager_remove()).
|
|
* @param[in] app_id the package id it was installed under (PackageManifest::id)
|
|
* @retval ERROR_NONE on success
|
|
* @retval ERROR_NOT_FOUND no such package was installed via app_install()
|
|
*/
|
|
error_t app_uninstall(const char* app_id);
|
|
|
|
#ifdef __cplusplus
|
|
}
|
|
#endif
|