libguile/struct.h

   1 /* classes: h_files */
   2
   3 #ifndef SCM_STRUCT_H
   4 #define SCM_STRUCT_H
   5
   6 /* Copyright (C) 1995,1997,1999,2000,2001, 2006, 2007, 2008 Free Software Foundation, Inc.
   7  *
   8  * This library is free software; you can redistribute it and/or
   9  * modify it under the terms of the GNU Lesser General Public License
  10  * as published by the Free Software Foundation; either version 3 of
  11  * the License, or (at your option) any later version.
  12  *
  13  * This library is distributed in the hope that it will be useful, but
  14  * WITHOUT ANY WARRANTY; without even the implied warranty of
  15  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  16  * Lesser General Public License for more details.
  17  *
  18  * You should have received a copy of the GNU Lesser General Public
  19  * License along with this library; if not, write to the Free Software
  20  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
  21  * 02110-1301 USA
  22  */
  23
  24 \f
  25
  26 #include "libguile/__scm.h"
  27 #include "libguile/print.h"
  28
  29 \f
  30
  31 /* Number of words with negative index */
  32 #define scm_struct_n_extra_words 4
  33 #define scm_struct_entity_n_extra_words 6
  34
  35 /* These are how the initial words of a vtable are allocated. */
  36 #define scm_struct_i_setter     -6 /* Setter */
  37 #define scm_struct_i_procedure  -5 /* Optional procedure slot */
  38 #define scm_struct_i_free       -4 /* Destructor */
  39 #define scm_struct_i_ptr        -3 /* Start of block (see alloc_struct) */
  40 #define scm_struct_i_n_words    -2 /* How many words allocated to this struct? */
  41 #define scm_struct_i_size       -1 /* Instance size */
  42 #define scm_struct_i_flags      -1 /* Upper 12 bits used as flags */
  43
  44 /* These indices must correspond to required_vtable_fields in
  45    struct.c. */
  46 #define scm_vtable_index_layout  0 /* A symbol describing the physical arrangement of this type. */
  47 #define scm_vtable_index_vtable  1 /* A pointer to the handle for this vtable. */
  48 #define scm_vtable_index_printer 2 /* A printer for this struct type. */
  49 #define scm_vtable_offset_user   3 /* Where do user fields start? */
  50
  51 typedef void (*scm_t_struct_free) (scm_t_bits * vtable, scm_t_bits * data);
  52
  53 #define SCM_STRUCTF_MASK   (0xFFF << 20)
  54 #define SCM_STRUCTF_ENTITY (1L << 30) /* Indicates presence of proc slots */
  55 #define SCM_STRUCTF_LIGHT  (1L << 31) /* Light representation
  56                                          (no hidden words) */
  57
  58 #define SCM_STRUCTP(X)                  (!SCM_IMP(X) && (SCM_TYP3(X) == scm_tc3_struct))
  59 #define SCM_STRUCT_DATA(X)              ((scm_t_bits *) SCM_CELL_WORD_1 (X))
  60 #define SCM_STRUCT_VTABLE_DATA(X)       ((scm_t_bits *) (SCM_CELL_WORD_0 (X) - scm_tc3_struct))
  61
  62 #define SCM_STRUCT_LAYOUT(X)            (SCM_PACK (SCM_STRUCT_VTABLE_DATA (X) [scm_vtable_index_layout]))
  63 #define SCM_SET_STRUCT_LAYOUT(X, v)     (SCM_STRUCT_VTABLE_DATA (X) [scm_vtable_index_layout] = SCM_UNPACK (v))
  64
  65 #define SCM_STRUCT_VTABLE(X)            (SCM_PACK (SCM_STRUCT_VTABLE_DATA (X) [scm_vtable_index_vtable]))
  66 #define SCM_STRUCT_VTABLE_FLAGS(X) \
  67   (SCM_STRUCT_VTABLE_DATA (X) [scm_struct_i_flags])
  68 #define SCM_STRUCT_PRINTER(X)           (SCM_PACK (SCM_STRUCT_VTABLE_DATA (X) [scm_vtable_index_printer]))
  69 #define SCM_SET_STRUCT_PRINTER(x, v)\
  70    (SCM_STRUCT_VTABLE_DATA (x) [scm_vtable_index_printer] = SCM_UNPACK (v))
  71 #define SCM_SET_VTABLE_DESTRUCTOR(X, D) (SCM_STRUCT_DATA (X) [scm_struct_i_free] = (scm_t_bits) (D))
  72 /* Efficiency is important in the following macro, since it's used in GC */
  73 #define SCM_LAYOUT_TAILP(X)             (((X) & 32) == 0) /* R, W or O */
  74
  75 #define SCM_STRUCT_TABLE_NAME(X) SCM_CAR (X)
  76 #define SCM_SET_STRUCT_TABLE_NAME(X, NAME) SCM_SETCAR (X, NAME)
  77 #define SCM_STRUCT_TABLE_CLASS(X) SCM_CDR (X)
  78 #define SCM_SET_STRUCT_TABLE_CLASS(X, CLASS) SCM_SETCDR (X, CLASS)
  79 SCM_API SCM scm_struct_table;
  80
  81 #define SCM_STRUCT_GC_CHAIN(X) SCM_CELL_OBJECT_3 (X)
  82 #define SCM_SET_STRUCT_GC_CHAIN(X, Y) SCM_SET_CELL_OBJECT_3 (X, Y)
  83
  84 \f
  85
  86 SCM_API scm_t_bits * scm_alloc_struct (int n_words, int n_extra,
  87                                        const char *what);
  88 SCM_API SCM scm_make_struct_layout (SCM fields);
  89 SCM_API SCM scm_struct_p (SCM x);
  90 SCM_API SCM scm_struct_vtable_p (SCM x);
  91 SCM_API SCM scm_make_struct (SCM vtable, SCM tail_array_size, SCM init);
  92 SCM_API SCM scm_make_vtable (SCM fields, SCM printer);
  93 SCM_API SCM scm_make_vtable_vtable (SCM extra_fields, SCM tail_array_size, SCM init);
  94 SCM_INTERNAL SCM scm_i_struct_equalp (SCM s1, SCM s2);
  95 SCM_API SCM scm_struct_ref (SCM handle, SCM pos);
  96 SCM_API SCM scm_struct_set_x (SCM handle, SCM pos, SCM val);
  97 SCM_API SCM scm_struct_vtable (SCM handle);
  98 SCM_API SCM scm_struct_vtable_tag (SCM handle);
  99 SCM_API unsigned long scm_struct_ihashq (SCM obj, unsigned long n);
 100 SCM_API SCM scm_struct_create_handle (SCM obj);
 101 SCM_API SCM scm_struct_vtable_name (SCM vtable);
 102 SCM_API SCM scm_set_struct_vtable_name_x (SCM vtable, SCM name);
 103 SCM_API void scm_print_struct (SCM exp, SCM port, scm_print_state *);
 104 SCM_API void scm_struct_prehistory (void);
 105 SCM_INTERNAL void scm_init_struct (void);
 106
 107 #endif  /* SCM_STRUCT_H */
 108
 109 /*
 110   Local Variables:
 111   c-file-style: "gnu"
 112   End:
 113 */