source.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_SOURCE_H_
#define LOOMC_SOURCE_H_
 
#include <stdio.h>
 
#include "loomc/status.h"

 
#ifdef __cplusplus
extern "C" {
#endif

typedef struct loomc_source_t loomc_source_t;

typedef enum loomc_source_format_e {
  LOOMC_SOURCE_FORMAT_UNKNOWN = 0,

  LOOMC_SOURCE_FORMAT_TEXT = 1,

  LOOMC_SOURCE_FORMAT_BYTECODE = 2,
} loomc_source_format_t;

typedef enum loomc_source_storage_e {
  LOOMC_SOURCE_STORAGE_BORROWED = 0,

  LOOMC_SOURCE_STORAGE_COPY = 1,

  LOOMC_SOURCE_STORAGE_EXTERNAL = 2,
} loomc_source_storage_t;

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

typedef struct loomc_source_options_t {
  loomc_structure_type_t type;

  loomc_host_size_t structure_size;

  const void* next;

  loomc_source_format_t format;

  loomc_string_view_t identifier;

  loomc_byte_span_t contents;

  loomc_source_storage_t storage;

  loomc_source_release_fn_t release;

  void* release_user_data;
} loomc_source_options_t;

typedef struct loomc_source_load_options_t {
  loomc_structure_type_t type;

  loomc_host_size_t structure_size;

  const void* next;

  loomc_source_format_t format;

  loomc_string_view_t identifier;
} loomc_source_load_options_t;

LOOMC_API_EXPORT loomc_status_t
loomc_source_create(const loomc_source_options_t* options,
                    loomc_allocator_t allocator, loomc_source_t** out_source);

LOOMC_API_EXPORT loomc_status_t loomc_source_create_from_file(
    FILE* file, const loomc_source_load_options_t* options,
    loomc_allocator_t allocator, loomc_source_t** out_source);

LOOMC_API_EXPORT loomc_status_t loomc_source_create_from_path(
    loomc_string_view_t path, const loomc_source_load_options_t* options,
    loomc_allocator_t allocator, loomc_source_t** out_source);

LOOMC_API_EXPORT void loomc_source_retain(loomc_source_t* source);

LOOMC_API_EXPORT void loomc_source_release(loomc_source_t* source);

LOOMC_API_EXPORT loomc_source_format_t
loomc_source_format(const loomc_source_t* source);

LOOMC_API_EXPORT loomc_string_view_t
loomc_source_identifier(const loomc_source_t* source);

LOOMC_API_EXPORT loomc_byte_span_t
loomc_source_contents(const loomc_source_t* source);
 
#ifdef __cplusplus
}  // extern "C"
#endif
 
#endif  // LOOMC_SOURCE_H_