infix.h

Go to the documentation of this file.

#pragma once
/*
G -----4~------------4~------------------
D ---67-67---------67-67-------4~4-------
A 4-------4~----4-------4~--4/5~--5~54---
E ---------------------------------------
 
 * This source code is dual-licensed under the Artistic License 2.0 or the MIT License.
 * You may choose to use this code under the terms of either license.
 *
 * SPDX-License-Identifier: (Artistic-2.0 OR MIT)
 *
 * The documentation blocks within this file are licensed under the
 * Creative Commons Attribution 4.0 International License (CC BY 4.0).
 *
 * SPDX-License-Identifier: CC-BY-4.0
 */
 
#define INFIX_MAJOR 0
#define INFIX_MINOR 1
#define INFIX_PATCH 0
// Define the POSIX source macro to ensure function declarations for shm_open,
// ftruncate, etc., are visible on all POSIX-compliant systems.
// This must be defined before any system headers are included.
#ifndef _DEFAULT_SOURCE
#define _DEFAULT_SOURCE
#endif
 
// Define the POSIX source macro to ensure function declarations for posix_memalign
// are visible. This must be defined before any system headers are included.
#if !defined(_POSIX_C_SOURCE)
#define _POSIX_C_SOURCE 200809L
#endif
 
#include <stdbool.h>
#include <stddef.h>
#include <stdint.h>
 
typedef struct infix_type_t infix_type;
typedef struct infix_struct_member_t infix_struct_member;
typedef struct infix_function_argument_t infix_function_argument;
typedef struct infix_forward_t infix_forward_t;
typedef struct infix_reverse_t infix_reverse_t;
typedef infix_reverse_t infix_context_t;
typedef struct infix_arena_t infix_arena_t;
typedef struct infix_library_t infix_library_t;
typedef struct infix_registry_t infix_registry_t;
 
typedef enum {
    INFIX_TYPE_PRIMITIVE,           
    INFIX_TYPE_POINTER,             
    INFIX_TYPE_STRUCT,              
    INFIX_TYPE_UNION,               
    INFIX_TYPE_ARRAY,               
    INFIX_TYPE_REVERSE_TRAMPOLINE,  
    INFIX_TYPE_ENUM,                
    INFIX_TYPE_COMPLEX,             
    INFIX_TYPE_VECTOR,              
    INFIX_TYPE_NAMED_REFERENCE,     
    INFIX_TYPE_VOID                 
} infix_type_category;
 
typedef enum {
    INFIX_PRIMITIVE_BOOL,        
    INFIX_PRIMITIVE_UINT8,       
    INFIX_PRIMITIVE_SINT8,       
    INFIX_PRIMITIVE_UINT16,      
    INFIX_PRIMITIVE_SINT16,      
    INFIX_PRIMITIVE_UINT32,      
    INFIX_PRIMITIVE_SINT32,      
    INFIX_PRIMITIVE_UINT64,      
    INFIX_PRIMITIVE_SINT64,      
    INFIX_PRIMITIVE_UINT128,     
    INFIX_PRIMITIVE_SINT128,     
    INFIX_PRIMITIVE_FLOAT,       
    INFIX_PRIMITIVE_DOUBLE,      
    INFIX_PRIMITIVE_LONG_DOUBLE  
} infix_primitive_type_id;
 
typedef enum { INFIX_AGGREGATE_STRUCT, INFIX_AGGREGATE_UNION } infix_aggregate_category_t;
 
struct infix_type_t {
    infix_type_category category;  
    size_t size;                   
    size_t alignment;              
    bool is_arena_allocated;  
    union {
        infix_primitive_type_id primitive_id;
        struct {
            struct infix_type_t * pointee_type;  
        } pointer_info;
        struct {
            const char * name;              
            infix_struct_member * members;  
            size_t num_members;             
        } aggregate_info;
        struct {
            struct infix_type_t * element_type;  
            size_t num_elements;                 
        } array_info;
        struct {
            struct infix_type_t * return_type;  
            infix_function_argument * args;     
            size_t num_args;                    
            size_t num_fixed_args;              
        } func_ptr_info;
        struct {
            struct infix_type_t * underlying_type;  
        } enum_info;
        struct {
            struct infix_type_t * base_type;  
        } complex_info;
        struct {
            struct infix_type_t * element_type;  
            size_t num_elements;                 
        } vector_info;
        struct {
            const char * name;
            infix_aggregate_category_t aggregate_category;
        } named_reference;
    } meta;
};
 
struct infix_struct_member_t {
    const char * name;  
    infix_type * type;  
    size_t offset;      
};
 
struct infix_function_argument_t {
    const char * name;  
    infix_type * type;  
};
 
 
#include "common/compat_c23.h"
 
#ifndef infix_malloc
#define infix_malloc malloc
#endif
 
#ifndef infix_calloc
#define infix_calloc calloc
#endif
 
#ifndef infix_realloc
#define infix_realloc realloc
#endif
 
#ifndef infix_free
#define infix_free free
#endif
 
#ifndef infix_memcpy
#define infix_memcpy memcpy
#endif
 
#ifndef infix_memset
#define infix_memset memset
#endif
typedef void (*infix_unbound_cif_func)(void *, void *, void **);
 
typedef void (*infix_cif_func)(void *, void **);
 
typedef void (*infix_closure_handler_fn)(infix_context_t * context, void * return_value, void ** args);
 
typedef enum {
    INFIX_SUCCESS = 0,              
    INFIX_ERROR_ALLOCATION_FAILED,  
    INFIX_ERROR_INVALID_ARGUMENT,   
    INFIX_ERROR_UNSUPPORTED_ABI,    
    INFIX_ERROR_LAYOUT_FAILED,      
    INFIX_ERROR_PROTECTION_FAILED,  
    INFIX_ERROR_                    
} infix_status;
 
c23_nodiscard infix_registry_t * infix_registry_create(void);
 
void infix_registry_destroy(infix_registry_t * registry);
 
c23_nodiscard infix_status infix_register_types(infix_registry_t *, const char *);
 
c23_nodiscard infix_status infix_forward_create(infix_forward_t **, const char *, void *, infix_registry_t *);
 
c23_nodiscard infix_status infix_forward_create_unbound(infix_forward_t **, const char *, infix_registry_t *);
 
c23_nodiscard infix_status infix_reverse_create_callback(infix_reverse_t **, const char *, void *, infix_registry_t *);
 
c23_nodiscard infix_status
infix_reverse_create_closure(infix_reverse_t **, const char *, infix_closure_handler_fn, void *, infix_registry_t *);
 
c23_nodiscard infix_status infix_signature_parse(
    const char *, infix_arena_t **, infix_type **, infix_function_argument **, size_t *, size_t *, infix_registry_t *);
 
c23_nodiscard infix_status infix_type_from_signature(infix_type **, infix_arena_t **, const char *, infix_registry_t *);
 
c23_nodiscard infix_library_t * infix_library_open(const char *);
 
void infix_library_close(infix_library_t *);
 
c23_nodiscard void * infix_library_get_symbol(infix_library_t *, const char *);
 
infix_status infix_read_global(infix_library_t *, const char *, const char *, void *);
 
infix_status infix_write_global(infix_library_t *, const char *, const char *, void *);
 
c23_nodiscard infix_status
infix_forward_create_manual(infix_forward_t **, infix_type *, infix_type **, size_t, size_t, void *);
 
c23_nodiscard infix_status
infix_forward_create_unbound_manual(infix_forward_t **, infix_type *, infix_type **, size_t, size_t);
 
c23_nodiscard infix_status
infix_reverse_create_callback_manual(infix_reverse_t **, infix_type *, infix_type **, size_t, size_t, void *);
 
c23_nodiscard infix_status infix_reverse_create_closure_manual(
    infix_reverse_t **, infix_type *, infix_type **, size_t, size_t, infix_closure_handler_fn, void *);
 
 
void infix_forward_destroy(infix_forward_t *);
 
void infix_reverse_destroy(infix_reverse_t *);
 
c23_nodiscard infix_type * infix_type_create_primitive(infix_primitive_type_id);
 
c23_nodiscard infix_type * infix_type_create_pointer(void);
 
c23_nodiscard infix_status infix_type_create_pointer_to(infix_arena_t *, infix_type **, infix_type *);
 
c23_nodiscard infix_type * infix_type_create_void(void);
 
c23_nodiscard infix_status infix_type_create_struct(infix_arena_t *, infix_type **, infix_struct_member *, size_t);
 
c23_nodiscard infix_status
infix_type_create_packed_struct(infix_arena_t *, infix_type **, size_t, size_t, infix_struct_member *, size_t);
 
c23_nodiscard infix_status infix_type_create_union(infix_arena_t *, infix_type **, infix_struct_member *, size_t);
 
c23_nodiscard infix_status infix_type_create_array(infix_arena_t *, infix_type **, infix_type *, size_t);
 
c23_nodiscard infix_status infix_type_create_enum(infix_arena_t *, infix_type **, infix_type *);
 
c23_nodiscard infix_status infix_type_create_named_reference(infix_arena_t *,
                                                             infix_type **,
                                                             const char *,
                                                             infix_aggregate_category_t);
 
c23_nodiscard infix_status infix_type_create_complex(infix_arena_t *, infix_type **, infix_type *);
 
c23_nodiscard infix_status infix_type_create_vector(infix_arena_t *, infix_type **, infix_type *, size_t);
 
infix_struct_member infix_type_create_member(const char *, infix_type *, size_t);
 
c23_nodiscard infix_arena_t * infix_arena_create(size_t);
 
void infix_arena_destroy(infix_arena_t *);
 
c23_nodiscard void * infix_arena_alloc(infix_arena_t *, size_t, size_t);
 
c23_nodiscard void * infix_arena_calloc(infix_arena_t *, size_t, size_t, size_t);
 
typedef enum {
    INFIX_DIALECT_SIGNATURE,         
    INFIX_DIALECT_ITANIUM_MANGLING,  
    INFIX_DIALECT_MSVC_MANGLING      
} infix_print_dialect_t;
 
c23_nodiscard infix_status infix_type_print(char *, size_t, const infix_type *, infix_print_dialect_t);
 
c23_nodiscard infix_status infix_function_print(char *,
                                                size_t,
                                                const char *,
                                                const infix_type *,
                                                const infix_function_argument *,
                                                size_t,
                                                size_t,
                                                infix_print_dialect_t);
 
c23_nodiscard infix_unbound_cif_func infix_forward_get_unbound_code(infix_forward_t *);
 
c23_nodiscard infix_cif_func infix_forward_get_code(infix_forward_t *);
 
c23_nodiscard void * infix_reverse_get_code(const infix_reverse_t *);
 
c23_nodiscard void * infix_reverse_get_user_data(const infix_reverse_t *);
 
c23_nodiscard size_t infix_forward_get_num_args(const infix_forward_t *);
 
c23_nodiscard size_t infix_forward_get_num_fixed_args(const infix_forward_t *);
 
c23_nodiscard const infix_type * infix_forward_get_return_type(const infix_forward_t *);
 
c23_nodiscard const infix_type * infix_forward_get_arg_type(const infix_forward_t *, size_t);
 
c23_nodiscard size_t infix_reverse_get_num_args(const infix_reverse_t *);
 
c23_nodiscard const infix_type * infix_reverse_get_return_type(const infix_reverse_t *);
 
c23_nodiscard size_t infix_reverse_get_num_fixed_args(const infix_reverse_t *);
 
c23_nodiscard const infix_type * infix_reverse_get_arg_type(const infix_reverse_t *, size_t);
c23_nodiscard infix_type_category infix_type_get_category(const infix_type *);
 
c23_nodiscard size_t infix_type_get_size(const infix_type *);
 
c23_nodiscard size_t infix_type_get_alignment(const infix_type *);
 
c23_nodiscard size_t infix_type_get_member_count(const infix_type *);
 
c23_nodiscard const infix_struct_member * infix_type_get_member(const infix_type *, size_t);
 
c23_nodiscard const char * infix_type_get_arg_name(const infix_type *, size_t);
 
c23_nodiscard const infix_type * infix_type_get_arg_type(const infix_type *, size_t);
typedef enum {
    INFIX_CATEGORY_NONE,        
    INFIX_CATEGORY_GENERAL,     
    INFIX_CATEGORY_ALLOCATION,  
    INFIX_CATEGORY_PARSER,      
    INFIX_CATEGORY_ABI          
} infix_error_category_t;
 
typedef enum {
    // General & Success (0-99)
    INFIX_CODE_SUCCESS = 0,  
    INFIX_CODE_UNKNOWN,      
 
    // Allocation Errors (100-199)
    INFIX_CODE_OUT_OF_MEMORY = 100,        
    INFIX_CODE_EXECUTABLE_MEMORY_FAILURE,  
    INFIX_CODE_PROTECTION_FAILURE,         
 
    // Signature Parsing Errors (200-299)
    INFIX_CODE_UNEXPECTED_TOKEN = 200,  
    INFIX_CODE_UNTERMINATED_AGGREGATE,  
    INFIX_CODE_INVALID_KEYWORD,         
    INFIX_CODE_MISSING_RETURN_TYPE,     
    INFIX_CODE_INTEGER_OVERFLOW,  
    INFIX_CODE_RECURSION_DEPTH_EXCEEDED,  
    INFIX_CODE_EMPTY_MEMBER_NAME,         
 
    // ABI & Layout Errors (300-399)
    INFIX_CODE_UNSUPPORTED_ABI = 300,  
    INFIX_CODE_TYPE_TOO_LARGE,         
    INFIX_CODE_UNRESOLVED_NAMED_TYPE,  
    INFIX_CODE_INVALID_MEMBER_TYPE,    
 
    // Loader Errors (400-499)
    INFIX_CODE_LIBRARY_NOT_FOUND = 400,  
    INFIX_CODE_SYMBOL_NOT_FOUND,         
    INFIX_CODE_LIBRARY_LOAD_FAILED       
} infix_error_code_t;
 
typedef struct {
    infix_error_category_t category;  
    infix_error_code_t code;          
    size_t position;         
    long system_error_code;  
    char message[256];       
} infix_error_details_t;
 
infix_error_details_t infix_get_last_error(void);