Hash :
96b055e1
Author :
Thomas de Grivel
Date :
2024-11-14T16:27:55
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58
/* kc3
* Copyright 2022,2023,2024 kmx.io <contact@kmx.io>
*
* Permission is hereby granted to use this software granted the above
* copyright notice and this permission paragraph are included in all
* copies and substantial portions of this software.
*
* THIS SOFTWARE IS PROVIDED "AS-IS" WITHOUT ANY GUARANTEE OF
* PURPOSE AND PERFORMANCE. IN NO EVENT WHATSOEVER SHALL THE
* AUTHOR BE CONSIDERED LIABLE FOR THE USE AND PERFORMANCE OF
* THIS SOFTWARE.
*/
/**
* @file struct_type.h
* @brief Struct type : [key: value, ...]
*
* A structure type is defined using defstruct.
* There can be only one defstruct per module.
* The struct type can be referred to by just the module name.
* The rest of the module should contain operations on that struct.
*/
#ifndef LIBKC3_STRUCT_TYPE_H
#define LIBKC3_STRUCT_TYPE_H
#include "types.h"
/* Stack-allocation functions, call struct_type_clean after use. */
void struct_type_clean (s_struct_type *st);
s_struct_type * struct_type_init (s_struct_type *st,
const s_sym *module,
const s_list *spec);
s_struct_type * struct_type_init_cast (s_struct_type *st,
const s_sym * const *type,
const s_tag *src);
s_struct_type * struct_type_init_update_clean (s_struct_type *st,
const s_struct_type *src,
const s_cfn *clean);
s_struct_type * struct_type_init_copy (s_struct_type *st,
const s_struct_type *src);
/* Heap-allocation functions, call struct_type_delete after use. */
void struct_type_delete (s_struct_type *st);
s_struct_type * struct_type_new (const s_sym *module,
const s_list *spec);
/* Observers. */
void * struct_type_copy_data (const s_struct_type *st,
void *dest,
const void *src);
bool * struct_type_exists (const s_sym *module,
bool *dest);
s_struct_type ** struct_type_find (const s_sym *module,
s_struct_type **dest);
uw * struct_type_find_key_index (const s_struct_type *st,
const s_sym *key,
uw *dest);
uw struct_type_padding (uw offset, uw size);
#endif /* LIBKC3_STRUCT_TYPE_H */