lbm_flat_value.h

Go to the documentation of this file.

/*
    Copyright 2023, 2024 Joel Svensson    svenssonjoel@yahoo.se
 
    This program is free software: you can redistribute it and/or modify
    it under the terms of the GNU General Public License as published by
    the Free Software Foundation, either version 3 of the License, or
    (at your option) any later version.
 
    This program is distributed in the hope that it will be useful,
    but WITHOUT ANY WARRANTY; without even the implied warranty of
    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
    GNU General Public License for more details.
 
    You should have received a copy of the GNU General Public License
    along with this program.  If not, see <http://www.gnu.org/licenses/>.
*/
 
#ifndef LBM_FLAT_VALUE_H_
#define LBM_FLAT_VALUE_H_
 
#include <heap.h>
#include <symrepr.h>
#include <lbm_memory.h>
#include <lbm_image.h>
 
typedef struct {
  uint8_t *buf;
  lbm_uint buf_size;
  lbm_uint buf_pos;
} lbm_flat_value_t;
                               // Arity
#define S_CONS            0x01 // 2      car, cdr
#define S_SYM_VALUE       0x02 // 1      value
#define S_SYM_STRING      0x03
#define S_BYTE_VALUE      0x04
#define S_I28_VALUE       0x05
#define S_U28_VALUE       0x06
#define S_I32_VALUE       0x07
#define S_U32_VALUE       0x08
#define S_FLOAT_VALUE     0x09
#define S_I64_VALUE       0x0A
#define S_U64_VALUE       0x0B
#define S_DOUBLE_VALUE    0x0C
#define S_LBM_ARRAY       0x0D
#define S_I56_VALUE       0x0E
#define S_U56_VALUE       0x0F
#define S_CONSTANT_REF    0x10
#define S_LBM_LISP_ARRAY  0x1F
 
#define S_SHARED          0x20
#define S_REF             0x21
 
 
// Maximum number of recursive calls
#define FLATTEN_VALUE_MAXIMUM_DEPTH 2000
 
#define FLATTEN_VALUE_OK  0
#define FLATTEN_VALUE_ERROR_CANNOT_BE_FLATTENED -1
#define FLATTEN_VALUE_ERROR_BUFFER_TOO_SMALL    -2
#define FLATTEN_VALUE_ERROR_ARRAY               -3
#define FLATTEN_VALUE_ERROR_CIRCULAR            -4
#define FLATTEN_VALUE_ERROR_MAXIMUM_DEPTH       -5
#define FLATTEN_VALUE_ERROR_NOT_ENOUGH_MEMORY   -6
#define FLATTEN_VALUE_ERROR_FATAL               -7
 
#define UNFLATTEN_SHARING_TABLE_ERROR -4
#define UNFLATTEN_SHARING_TABLE_REQUIRED -3
#define UNFLATTEN_MALFORMED     -2
#define UNFLATTEN_GC_RETRY      -1
#define UNFLATTEN_OK             0
 
 
bool lbm_start_flatten(lbm_flat_value_t *v, size_t buffer_size);
bool lbm_finish_flatten(lbm_flat_value_t *v);
bool f_cons(lbm_flat_value_t *v);
bool f_lisp_array(lbm_flat_value_t *v, uint32_t num_elt);
bool f_sym(lbm_flat_value_t *v, lbm_uint sym_id);
bool f_sym_string(lbm_flat_value_t *v, char *str);
bool f_i(lbm_flat_value_t *v, lbm_int i);
bool f_u(lbm_flat_value_t *v, lbm_uint u);
bool f_b(lbm_flat_value_t *v, uint8_t b);
bool f_i32(lbm_flat_value_t *v, int32_t w);
bool f_u32(lbm_flat_value_t *v, uint32_t w);
bool f_float(lbm_flat_value_t *v, float f);
bool f_i64(lbm_flat_value_t *v, int64_t w);
bool f_u64(lbm_flat_value_t *v, uint64_t w);
bool f_lbm_array(lbm_flat_value_t *v, uint32_t num_bytes, uint8_t *data);
lbm_value flatten_value(lbm_value v);
int flatten_value_c(lbm_flat_value_t *fv, lbm_value v);
int flatten_value_size(lbm_value v, bool image);
void lbm_set_max_flatten_depth(int depth);
int lbm_get_max_flatten_depth(void);
 
bool lbm_unflatten_value(lbm_flat_value_t *v, lbm_value *res);
bool lbm_unflatten_value_sharing(sharing_table *st, lbm_uint *target_map, lbm_flat_value_t *v, lbm_value *res);
#endif