artifact.h

Go to the documentation of this file.

// Copyright 2026 The IREE Authors
//
// Licensed under the Apache License v2.0 with LLVM Exceptions.
// See https://llvm.org/LICENSE.txt for license information.
// SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
 
#ifndef LOOMC_ARTIFACT_H_
#define LOOMC_ARTIFACT_H_
 
#include <stdio.h>
 
#include "loomc/source.h"

 
#ifdef __cplusplus
extern "C" {
#endif

#define LOOMC_ARTIFACT_FORMAT_LOOM_TEXT "loom-text"

#define LOOMC_ARTIFACT_FORMAT_LOOM_BYTECODE "loombc"

#define LOOMC_ARTIFACT_FORMAT_JSON "json"

typedef enum loomc_artifact_kind_e {
  LOOMC_ARTIFACT_KIND_EXECUTABLE = 0,

  LOOMC_ARTIFACT_KIND_TEXT = 1,

  LOOMC_ARTIFACT_KIND_REPORT = 2,

  LOOMC_ARTIFACT_KIND_MODULE = 3,

  LOOMC_ARTIFACT_KIND_LAUNCH_CONFIG = 4,
} loomc_artifact_kind_t;

typedef struct loomc_artifact_t {
  loomc_artifact_kind_t kind;

  loomc_string_view_t format;

  loomc_string_view_t identifier;

  loomc_byte_span_t contents;
} loomc_artifact_t;

typedef void(LOOMC_API_PTR* loomc_artifact_release_fn_t)(
    void* user_data, loomc_byte_span_t contents);

LOOMC_API_EXPORT loomc_status_t loomc_artifact_create_source(
    const loomc_artifact_t* artifact, loomc_source_format_t format,
    loomc_allocator_t allocator, loomc_source_t** out_source);

LOOMC_API_EXPORT loomc_status_t
loomc_artifact_write_to_file(const loomc_artifact_t* artifact, FILE* file);

LOOMC_API_EXPORT loomc_status_t loomc_artifact_write_to_path(
    const loomc_artifact_t* artifact, loomc_string_view_t path,
    loomc_allocator_t allocator);
 
#ifdef __cplusplus
}  // extern "C"
#endif
 
#endif  // LOOMC_ARTIFACT_H_