source.h

Go to the documentation of this file.

 
#ifndef PRISM_SOURCE_H
#define PRISM_SOURCE_H
 
#include "prism/compiler/exported.h"
#include "prism/compiler/filesystem.h"
#include "prism/compiler/nodiscard.h"
#include "prism/compiler/nonnull.h"
 
#include <stddef.h>
#include <stdint.h>
 
typedef struct pm_source_t pm_source_t;
 
typedef char * (pm_source_stream_fgets_t)(char *string, int size, void *stream);
 
typedef int (pm_source_stream_feof_t)(void *stream);
 
typedef enum {
    PM_SOURCE_INIT_SUCCESS = 0,
 
    PM_SOURCE_INIT_ERROR_GENERIC = 1,
 
    PM_SOURCE_INIT_ERROR_DIRECTORY = 2,
 
    PM_SOURCE_INIT_ERROR_NON_REGULAR = 3
} pm_source_init_result_t;
 
PRISM_EXPORTED_FUNCTION PRISM_NODISCARD pm_source_t * pm_source_constant_new(const uint8_t *data, size_t length);
 
PRISM_EXPORTED_FUNCTION PRISM_NODISCARD pm_source_t * pm_source_shared_new(const uint8_t *data, size_t length);
 
PRISM_EXPORTED_FUNCTION PRISM_NODISCARD pm_source_t * pm_source_owned_new(uint8_t *data, size_t length);
 
PRISM_EXPORTED_FUNCTION PRISM_NODISCARD pm_source_t * pm_source_file_new(const char *filepath, pm_source_init_result_t *result) PRISM_NONNULL(1, 2);
 
PRISM_EXPORTED_FUNCTION PRISM_NODISCARD pm_source_t * pm_source_mapped_new(const char *filepath, int open_flags, pm_source_init_result_t *result) PRISM_NONNULL(1, 3);
 
PRISM_EXPORTED_FUNCTION PRISM_NODISCARD pm_source_t * pm_source_stream_new(void *stream, pm_source_stream_fgets_t *fgets, pm_source_stream_feof_t *feof);
 
PRISM_EXPORTED_FUNCTION void pm_source_free(pm_source_t *source) PRISM_NONNULL(1);
 
PRISM_EXPORTED_FUNCTION size_t pm_source_length(const pm_source_t *source) PRISM_NONNULL(1);
 
PRISM_EXPORTED_FUNCTION const uint8_t * pm_source_source(const pm_source_t *source) PRISM_NONNULL(1);
 
#endif