kc3-lang/kc3/libc3/struct_type.h

• Show log

  Commit

• Hash : f0401f0c
  Author : Thomas de Grivel
  Date : 2024-03-04T14:19:12
  

  license

Download

• libc3/struct_type.h

• /* c3
   * Copyright 2022-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 LIBC3_STRUCT_TYPE_H
  #define LIBC3_STRUCT_TYPE_H
  
  #include "types.h"
  
  /* Stack-allocation compatible functions, call struct_type_clean after
     use. */
  void            struct_type_clean (s_struct_type *s);
  s_struct_type * struct_type_init (s_struct_type *s, const s_sym *module,
                                    const s_list *spec);
  s_struct_type * struct_type_init_copy (s_struct_type *s,
                                         const s_struct_type *src);
  
  /* Heap-allocation functions, call struct_type_delete after use. */
  void            struct_type_delete (s_struct_type *s);
  s_struct_type * struct_type_new (const s_sym *module,
                                   const s_list *spec);
  
  /* Utility functions. */
  bool                  struct_type_exists (const s_sym *module);
  const s_struct_type * struct_type_find (const s_sym *module);
  uw                    struct_type_padding (uw offset, uw size);
  
  #endif /* LIBC3_STRUCT_TYPE_H */
  

Download