native_artifact_emit.h

Go to the documentation of this file.

/**
 * @file
 * @brief Declares helpers that build native artifact and report payload strings.
 */
 
#ifndef PHAROS_NATIVE_ARTIFACT_EMIT_H
#define PHAROS_NATIVE_ARTIFACT_EMIT_H
 
/** @name Artifact emission helpers
 * @{
 */
/**
 * @brief Counts how many times a substring occurs in a string.
 * @param text Text to scan.
 * @param needle Substring to count.
 * @return Number of occurrences found.
 */
int count_substring_occurrences(const char *text, const char *needle);
/**
 * @brief Duplicates a string while escaping it for JSON string output.
 * @param value Source string value.
 * @return Newly allocated JSON-escaped string payload, or NULL on failure.
 */
char *json_string_dup_native(const char *value);
/**
 * @brief Builds the artifact directory path for a generated website target.
 * @param build_dir Base build directory.
 * @param target_id Website target identifier.
 * @return Newly allocated artifact directory path, or NULL on failure.
 */
char *native_website_artifact_dir(const char *build_dir, const char *target_id);
/**
 * @brief Builds the report file path for a website build or status operation.
 * @param build_dir Base build directory.
 * @param verb Report verb such as build or status.
 * @param target_id Website target identifier.
 * @return Newly allocated report path, or NULL on failure.
 */
char *native_website_report_path(const char *build_dir, const char *verb, const char *target_id);
/**
 * @brief Builds a JSON status report for a native website artifact.
 * @param report_id Stable report identifier.
 * @param verb Report verb such as status.
 * @param target_id Website target identifier.
 * @param artifact_dir Website artifact directory.
 * @return Newly allocated JSON report text, or NULL on failure.
 */
char *build_native_website_status_report_json(const char *report_id, const char *verb, const char *target_id, const char *artifact_dir);
/**
 * @brief Builds the default index.html payload for a native app artifact.
 * @param app_id App identifier to embed.
 * @return Newly allocated HTML text, or NULL on failure.
 */
char *build_native_app_index_html(const char *app_id);
/**
 * @brief Builds an artifact-localized copy of the app-owned manifest.
 * @param manifest_text Source app manifest JSON text.
 * @param artifact_generated_by Generator identifier to stamp into the artifact section.
 * @param state_path Effective state file path.
 * @param base_path Effective base path.
 * @param log_path Effective log path.
 * @param log_format Effective log format.
 * @param error_report_path Effective error report path.
 * @param debug Effective debug setting.
 * @param compiled_entrypoint Compiled runtime entrypoint path.
 * @param route_count Number of emitted routes.
 * @param surface_count Number of emitted surfaces.
 * @param workflow_count Number of emitted workflows.
 * @return Newly allocated JSON text, or NULL on failure.
 */
char *build_artifact_local_app_manifest_json(
  const char *manifest_text,
  const char *artifact_generated_by,
  const char *state_path,
  const char *base_path,
  const char *log_path,
  const char *log_format,
  const char *error_report_path,
  const char *debug,
  const char *compiled_entrypoint,
  int route_count,
  int surface_count,
  int workflow_count
);
/**
 * @brief Builds a JSON report describing a native app build result.
 * @param artifact_dir Emitted artifact directory.
 * @param app_id App identifier.
 * @param state_path Effective state file path.
 * @param base_path Effective base path.
 * @param log_path Effective log path.
 * @param log_format Effective log format.
 * @param error_report_path Effective error report path.
 * @param debug Effective debug setting.
 * @param host_profile Host profile selected for the app.
 * @param compiled_entrypoint Compiled runtime entrypoint path.
 * @return Newly allocated JSON report text, or NULL on failure.
 */
char *build_native_app_build_report_json(
  const char *artifact_dir,
  const char *app_id,
  const char *state_path,
  const char *base_path,
  const char *log_path,
  const char *log_format,
  const char *error_report_path,
  const char *debug,
  const char *host_profile,
  const char *compiled_entrypoint
);
 
 
/** @} */
#endif