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 Free Software Foundation, Inc.
   7  *
   8  * This program is free software; you can redistribute it and/or modify
   9  * it under the terms of the GNU General Public License as published by
  10  * the Free Software Foundation; either version 2, or (at your option)
  11  * any later version.
  12  *
  13  * This program is distributed in the hope that it will be useful,
  14  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  15  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  16  * GNU General Public License for more details.
  17  *
  18  * You should have received a copy of the GNU General Public License
  19  * along with this software; see the file COPYING.  If not, write to
  20  * the Free Software Foundation, Inc., 59 Temple Place, Suite 330,
  21  * Boston, MA 02111-1307 USA
  22  *
  23  * As a special exception, the Free Software Foundation gives permission
  24  * for additional uses of the text contained in its release of GUILE.
  25  *
  26  * The exception is that, if you link the GUILE library with other files
  27  * to produce an executable, this does not by itself cause the
  28  * resulting executable to be covered by the GNU General Public License.
  29  * Your use of that executable is in no way restricted on account of
  30  * linking the GUILE library code into it.
  31  *
  32  * This exception does not however invalidate any other reasons why
  33  * the executable file might be covered by the GNU General Public License.
  34  *
  35  * This exception applies only to the code released by the
  36  * Free Software Foundation under the name GUILE.  If you copy
  37  * code from other Free Software Foundation releases into a copy of
  38  * GUILE, as the General Public License permits, the exception does
  39  * not apply to the code that you add in this way.  To avoid misleading
  40  * anyone as to the status of such modified files, you must delete
  41  * this exception notice from them.
  42  *
  43  * If you write modifications of your own for GUILE, it is your choice
  44  * whether to permit this exception to apply to your modifications.
  45  * If you do not wish that, delete this exception notice.  */
  46
  47 \f
  48
  49 #include "libguile/__scm.h"
  50 #include "libguile/print.h"
  51
  52 \f
  53
  54 /* Number of words with negative index */
  55 #define scm_struct_n_extra_words 4
  56 #define scm_struct_entity_n_extra_words 6
  57
  58 /* These are how the initial words of a vtable are allocated. */
  59 #define scm_struct_i_setter     -6 /* Setter */
  60 #define scm_struct_i_procedure  -5 /* Optional procedure slot */
  61 #define scm_struct_i_free       -4 /* Destructor */
  62 #define scm_struct_i_ptr        -3 /* Start of block (see alloc_struct) */
  63 #define scm_struct_i_n_words    -2 /* How many words allocated to this struct? */
  64 #define scm_struct_i_size       -1 /* Instance size */
  65 #define scm_struct_i_flags      -1 /* Upper 12 bits used as flags */
  66
  67 /* These indices must correspond to required_vtable_fields in
  68    struct.c. */
  69 #define scm_vtable_index_layout  0 /* A symbol describing the physical arrangement of this type. */
  70 #define scm_vtable_index_vtable  1 /* A pointer to the handle for this vtable. */
  71 #define scm_vtable_index_printer 2 /* A printer for this struct type. */
  72 #define scm_vtable_offset_user   3 /* Where do user fields start? */
  73
  74 typedef size_t (*scm_t_struct_free) (scm_t_bits * vtable, scm_t_bits * data);
  75
  76 #define SCM_STRUCTF_MASK   (0xFFF << 20)
  77 #define SCM_STRUCTF_ENTITY (1L << 30) /* Indicates presence of proc slots */
  78 #define SCM_STRUCTF_LIGHT  (1L << 31) /* Light representation
  79                                          (no hidden words) */
  80
  81 #define SCM_STRUCTP(X)                  (!SCM_IMP(X) && (SCM_TYP3(X) == scm_tc3_struct))
  82 #define SCM_STRUCT_DATA(X)              ((scm_t_bits *) SCM_CELL_WORD_1 (X))
  83 #define SCM_STRUCT_VTABLE_DATA(X)       ((scm_t_bits *) (SCM_CELL_WORD_0 (X) - scm_tc3_struct))
  84
  85 #define SCM_STRUCT_LAYOUT(X)            (SCM_PACK (SCM_STRUCT_VTABLE_DATA (X) [scm_vtable_index_layout]))
  86 #define SCM_SET_STRUCT_LAYOUT(X, v)     (SCM_STRUCT_VTABLE_DATA (X) [scm_vtable_index_layout] = SCM_UNPACK (v))
  87
  88 #define SCM_STRUCT_VTABLE(X)            (SCM_PACK (SCM_STRUCT_VTABLE_DATA (X) [scm_vtable_index_vtable]))
  89 #define SCM_STRUCT_VTABLE_FLAGS(X) \
  90   (SCM_STRUCT_VTABLE_DATA (X) [scm_struct_i_flags])
  91 #define SCM_STRUCT_PRINTER(X)           (SCM_PACK (SCM_STRUCT_VTABLE_DATA (X) [scm_vtable_index_printer]))
  92 #define SCM_SET_STRUCT_PRINTER(x, v)\
  93    (SCM_STRUCT_VTABLE_DATA (x) [scm_vtable_index_printer] = SCM_UNPACK (v))
  94 #define SCM_SET_VTABLE_DESTRUCTOR(X, D) (SCM_STRUCT_DATA (X) [scm_struct_i_free] = (scm_t_bits) (D))
  95 /* Efficiency is important in the following macro, since it's used in GC */
  96 #define SCM_LAYOUT_TAILP(X)             (((X) & 32) == 0) /* R, W or O */
  97
  98 #define SCM_STRUCT_TABLE_NAME(X) SCM_CAR (X)
  99 #define SCM_SET_STRUCT_TABLE_NAME(X, NAME) SCM_SETCAR (X, NAME)
 100 #define SCM_STRUCT_TABLE_CLASS(X) SCM_CDR (X)
 101 #define SCM_SET_STRUCT_TABLE_CLASS(X, CLASS) SCM_SETCDR (X, CLASS)
 102 extern SCM scm_struct_table;
 103
 104 #define SCM_STRUCT_GC_CHAIN(X) SCM_CELL_OBJECT_3 (X)
 105 #define SCM_SET_STRUCT_GC_CHAIN(X, Y) SCM_SET_CELL_OBJECT_3 (X, Y)
 106 extern SCM scm_structs_to_free;
 107
 108 \f
 109
 110 extern scm_t_bits * scm_alloc_struct (int n_words, int n_extra, char * who);
 111 extern size_t scm_struct_free_0 (scm_t_bits * vtable, scm_t_bits * data);
 112 extern size_t scm_struct_free_light (scm_t_bits * vtable, scm_t_bits * data);
 113 extern size_t scm_struct_free_standard (scm_t_bits * vtable, scm_t_bits * data);
 114 extern size_t scm_struct_free_entity (scm_t_bits * vtable, scm_t_bits * data);
 115 extern SCM scm_make_struct_layout (SCM fields);
 116 extern SCM scm_struct_p (SCM x);
 117 extern SCM scm_struct_vtable_p (SCM x);
 118 extern SCM scm_make_struct (SCM vtable, SCM tail_array_size, SCM init);
 119 extern SCM scm_make_vtable_vtable (SCM extra_fields, SCM tail_array_size, SCM init);
 120 extern SCM scm_struct_ref (SCM handle, SCM pos);
 121 extern SCM scm_struct_set_x (SCM handle, SCM pos, SCM val);
 122 extern SCM scm_struct_vtable (SCM handle);
 123 extern SCM scm_struct_vtable_tag (SCM handle);
 124 extern unsigned long scm_struct_ihashq (SCM obj, unsigned long n);
 125 extern SCM scm_struct_create_handle (SCM obj);
 126 extern SCM scm_struct_vtable_name (SCM vtable);
 127 extern SCM scm_set_struct_vtable_name_x (SCM vtable, SCM name);
 128 extern void scm_print_struct (SCM exp, SCM port, scm_print_state *);
 129 extern void scm_struct_prehistory (void);
 130 extern void scm_init_struct (void);
 131
 132 #endif  /* SCM_STRUCT_H */
 133
 134 /*
 135   Local Variables:
 136   c-file-style: "gnu"
 137   End:
 138 */