native_app_runtime_paths.h

Go to the documentation of this file.

/**
 * @file
 * @brief Declares helpers for locating app roots and deriving runtime paths.
 */
 
#ifndef PHAROS_NATIVE_APP_RUNTIME_PATHS_H
#define PHAROS_NATIVE_APP_RUNTIME_PATHS_H
 
/** @name App runtime path helpers
 * @{
 */
/**
 * @brief Searches one directory for an app root matching a target identifier.
 * @param base_dir Directory whose child entries should be inspected.
 * @param target_id App identifier to match.
 * @return Newly allocated app root path, or NULL when no match is found.
 */
char *match_app_root_in_directory(const char *base_dir, const char *target_id);
/**
 * @brief Locates an app root for a target using explicit app-dir hints and canonical apps directories.
 * @param target_id App identifier to locate.
 * @param app_dir_hint Optional app directory or apps directory hint.
 * @param repo_root Repository root whose apps directory may be consulted.
 * @param binary_dir Executable directory for nearby apps-directory fallback discovery.
 * @return Newly allocated app root path, or NULL when the app cannot be found.
 */
char *find_app_root_for_target(const char *target_id, const char *app_dir_hint, const char *repo_root, const char *binary_dir);
/**
 * @brief Builds the default local build directory path for an app.
 * @param app_root Root directory of the app.
 * @return Newly allocated build directory path, or NULL on failure.
 */
char *app_build_dir_local_native(const char *app_root);
/**
 * @brief Resolves the effective build directory for an app.
 * @param app_root Root directory of the app.
 * @param build_dir_override Optional explicit build directory override.
 * @return Newly allocated effective build directory path, or NULL on failure.
 */
char *effective_app_build_dir_native(const char *app_root, const char *build_dir_override);
/**
 * @brief Resolves the artifact directory for one app from a build root or deployed app parent.
 * @param build_dir Build root or deployed app parent directory.
 * @param app_id App identifier.
 * @return Newly allocated artifact directory path, or NULL on failure.
 */
char *app_artifact_dir_from_build_dir_native(const char *build_dir, const char *app_id);
/**
 * @brief Resolves the effective artifact directory for an app from framework build root plus app-owned contract hints.
 * @param app_root Root directory of the app.
 * @param build_dir Effective build directory selected by Pharos.
 * @param app_id App identifier.
 * @return Newly allocated artifact directory path, or NULL on failure.
 */
char *effective_app_artifact_dir_native(const char *app_root, const char *build_dir, const char *app_id);
/**
 * @brief Builds the default local state file path for an app.
 * @param app_root Root directory of the app.
 * @param build_dir Effective build directory for the app.
 * @param app_id App identifier.
 * @return Newly allocated state file path, or NULL on failure.
 */
char *app_state_path_local_native(const char *app_root, const char *build_dir, const char *app_id);
/**
 * @brief Resolves the effective state file path for an app.
 * @param app_root Root directory of the app.
 * @param build_dir Effective build directory for the app.
 * @param app_id App identifier.
 * @param state_path_override Optional explicit state file override.
 * @param state_dir_override Optional explicit state directory override.
 * @return Newly allocated effective state file path, or NULL on failure.
 */
char *effective_app_state_path_native(const char *app_root, const char *build_dir, const char *app_id, const char *state_path_override, const char *state_dir_override);
/**
 * @brief Builds the default local URL base path for an app.
 * @param app_root Root directory of the app.
 * @return Newly allocated base path string, or NULL on failure.
 */
char *app_base_path_local_native(const char *app_root);
/**
 * @brief Resolves the effective URL base path for an app.
 * @param app_root Root directory of the app.
 * @param base_path_override Optional explicit base path override.
 * @return Newly allocated effective base path, or NULL on failure.
 */
char *effective_app_base_path_native(const char *app_root, const char *base_path_override);
/**
 * @brief Builds the default local log file path for an app.
 * @param app_root Root directory of the app.
 * @param app_id App identifier.
 * @return Newly allocated log path, or NULL on failure.
 */
char *app_log_path_local_native(const char *app_root, const char *app_id);
/**
 * @brief Resolves the effective log file path for an app.
 * @param app_root Root directory of the app.
 * @param app_id App identifier.
 * @param log_path_override Optional explicit log path override.
 * @return Newly allocated effective log path, or NULL on failure.
 */
char *effective_app_log_path_native(const char *app_root, const char *app_id, const char *log_path_override);
/**
 * @brief Builds the default local log format setting for an app.
 * @param app_root Root directory of the app.
 * @return Newly allocated log format string, or NULL on failure.
 */
char *app_log_format_local_native(const char *app_root);
/**
 * @brief Resolves the effective log format for an app.
 * @param app_root Root directory of the app.
 * @return Newly allocated effective log format string, or NULL on failure.
 */
char *effective_app_log_format_native(const char *app_root);
/**
 * @brief Builds the default local error report path for an app.
 * @param app_root Root directory of the app.
 * @return Newly allocated error report path, or NULL on failure.
 */
char *app_error_report_path_local_native(const char *app_root);
/**
 * @brief Resolves the effective error report path for an app.
 * @param app_root Root directory of the app.
 * @param app_id App identifier.
 * @return Newly allocated effective error report path, or NULL on failure.
 */
char *effective_app_error_report_path_native(const char *app_root, const char *app_id);
/**
 * @brief Builds the default local debug setting for an app.
 * @param app_root Root directory of the app.
 * @return Newly allocated debug setting string, or NULL on failure.
 */
char *app_debug_local_native(const char *app_root);
/**
 * @brief Resolves the effective debug setting for an app.
 * @param app_root Root directory of the app.
 * @param debug_override Optional explicit debug override.
 * @return Newly allocated effective debug setting string, or NULL on failure.
 */
char *effective_app_debug_native(const char *app_root, const char *debug_override);
 
 
/** @} */
#endif