pm_string.h

Go to the documentation of this file.

 
#ifndef PRISM_STRING_H
#define PRISM_STRING_H
 
#include "prism/defines.h"
 
#include <assert.h>
#include <errno.h>
#include <stdbool.h>
#include <stddef.h>
#include <stdlib.h>
#include <string.h>
 
// The following headers are necessary to read files using demand paging.
#ifdef _WIN32
#include <windows.h>
#elif defined(_POSIX_MAPPED_FILES)
#include <fcntl.h>
#include <sys/mman.h>
#include <sys/stat.h>
#elif defined(PRISM_HAS_FILESYSTEM)
#include <fcntl.h>
#include <sys/stat.h>
#endif
 
typedef struct {
    const uint8_t *source;
 
    size_t length;
 
    enum {
        PM_STRING_CONSTANT,
 
        PM_STRING_SHARED,
 
        PM_STRING_OWNED,
 
#ifdef PRISM_HAS_MMAP
        PM_STRING_MAPPED
#endif
    } type;
} pm_string_t;
 
PRISM_EXPORTED_FUNCTION size_t pm_string_sizeof(void);
 
#define PM_STRING_EMPTY ((pm_string_t) { .type = PM_STRING_CONSTANT, .source = NULL, .length = 0 })
 
void pm_string_shared_init(pm_string_t *string, const uint8_t *start, const uint8_t *end);
 
void pm_string_owned_init(pm_string_t *string, uint8_t *source, size_t length);
 
void pm_string_constant_init(pm_string_t *string, const char *source, size_t length);
 
typedef enum {
    PM_STRING_INIT_SUCCESS = 0,
    PM_STRING_INIT_ERROR_GENERIC = 1,
    PM_STRING_INIT_ERROR_DIRECTORY = 2
} pm_string_init_result_t;
 
PRISM_EXPORTED_FUNCTION pm_string_init_result_t pm_string_mapped_init(pm_string_t *string, const char *filepath);
 
PRISM_EXPORTED_FUNCTION pm_string_init_result_t pm_string_file_init(pm_string_t *string, const char *filepath);
 
void pm_string_ensure_owned(pm_string_t *string);
 
int pm_string_compare(const pm_string_t *left, const pm_string_t *right);
 
PRISM_EXPORTED_FUNCTION size_t pm_string_length(const pm_string_t *string);
 
PRISM_EXPORTED_FUNCTION const uint8_t * pm_string_source(const pm_string_t *string);
 
PRISM_EXPORTED_FUNCTION void pm_string_free(pm_string_t *string);
 
#endif