native_app_config.h

Go to the documentation of this file.

/**
 * @file
 * @brief Declares app-local runtime configuration helpers and the app-local configuration record.
 */
 
#ifndef PHAROS_NATIVE_APP_CONFIG_H
#define PHAROS_NATIVE_APP_CONFIG_H
 
/**
 * @brief App-local configuration values loaded from app-local config and manifest authority fields.
 */
typedef struct {
  char *conf_path;            /**< App-local configuration file path. */
  char *build_dir;            /**< Build directory override from local config. */
  char *state_dir;            /**< State directory override from local config. */
  char *state_path;           /**< State file override from local config. */
  char *base_path;            /**< Base path override from local config. */
  char *log_path;             /**< Log path override from local config. */
  char *socket_path;          /**< Socket path override from local config. */
  char *error_report_path;    /**< Error report path override from local config. */
  char *debug;                /**< Debug flag override from local config. */
  char *manifest_build_artifact_dir; /**< Build artifact dir authority extracted from the manifest. */
  char *manifest_state_path;  /**< State path authority extracted from the manifest. */
  char *manifest_base_path;   /**< Base path authority extracted from the manifest. */
} AppLocalConfigNative;
 
/** @name App-local configuration helpers
 * @{
 */
/**
 * @brief Resolves a config value relative to the directory that owns a config file.
 * @param conf_path Path to the config file that supplied the value.
 * @param raw_value Raw config value to resolve.
 * @return Newly allocated resolved path, or NULL when no path can be produced.
 */
char *resolve_conf_relative_path_native(const char *conf_path, const char *raw_value);
/**
 * @brief Builds the path to an app-local runtime configuration file.
 * @param app_root Root directory of the Pharos app.
 * @return Newly allocated config path, or NULL on allocation failure.
 */
char *app_local_conf_path_native(const char *app_root);
/**
 * @brief Looks up one key from the app-local runtime configuration.
 * @param app_root Root directory of the Pharos app.
 * @param key Configuration key to read.
 * @return Newly allocated value string, or NULL when the key is not present or cannot be read.
 */
char *app_local_conf_value_native(const char *app_root, const char *key);
/**
 * @brief Loads app-local configuration and manifest-derived path hints into a config record.
 * @param app_root Root directory of the Pharos app.
 * @param config Destination record to populate.
 * @return 0 on success, or a non-zero native status code on failure.
 */
int load_app_local_config_native(const char *app_root, AppLocalConfigNative *config);
/**
 * @brief Releases heap-owned fields in an app-local configuration record.
 * @param config Configuration record to clear.
 */
void free_app_local_config_native(AppLocalConfigNative *config);
/**
 * @brief Normalizes a configured app base path into Pharos runtime form.
 * @param raw_value Raw base path text from config or manifest data.
 * @return Newly allocated normalized base path, or NULL on failure.
 */
char *normalize_base_path_native(const char *raw_value);
 
 
/** @} */
#endif