libguile/objcodes.h

   1 /* Copyright (C) 2001, 2009 Free Software Foundation, Inc.
   2  *
   3  * This library is free software; you can redistribute it and/or
   4  * modify it under the terms of the GNU Lesser General Public License
   5  * as published by the Free Software Foundation; either version 3 of
   6  * the License, or (at your option) any later version.
   7  *
   8  * This library is distributed in the hope that it will be useful, but
   9  * WITHOUT ANY WARRANTY; without even the implied warranty of
  10  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  11  * Lesser General Public License for more details.
  12  *
  13  * You should have received a copy of the GNU Lesser General Public
  14  * License along with this library; if not, write to the Free Software
  15  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
  16  * 02110-1301 USA
  17  */
  18
  19 #ifndef _SCM_OBJCODES_H_
  20 #define _SCM_OBJCODES_H_
  21
  22 #include <libguile.h>
  23
  24 /* objcode data should be directly mappable to this C structure. */
  25 struct scm_objcode {
  26   scm_t_uint8 nargs;
  27   scm_t_uint8 nrest;
  28   scm_t_uint16 nlocs;
  29   scm_t_uint32 len;             /* the maximum index of base[] */
  30   scm_t_uint32 metalen;         /* well, i lie. this many bytes at the end of
  31                                    base[] for metadata */
  32   scm_t_uint32 unused;          /* pad so that `base' is 8-byte aligned */
  33   scm_t_uint8 base[0];
  34 };
  35
  36 #define SCM_F_OBJCODE_IS_MMAP     (1<<0)
  37 #define SCM_F_OBJCODE_IS_U8VECTOR (1<<1)
  38 #define SCM_F_OBJCODE_IS_SLICE    (1<<2)
  39
  40 SCM_API scm_t_bits scm_tc16_objcode;
  41
  42 #define SCM_OBJCODE_P(x)        (SCM_SMOB_PREDICATE (scm_tc16_objcode, x))
  43 #define SCM_OBJCODE_DATA(x)     ((struct scm_objcode *) SCM_SMOB_DATA (x))
  44 #define SCM_VALIDATE_OBJCODE(p,x) SCM_MAKE_VALIDATE (p, x, OBJCODE_P)
  45
  46 #define SCM_OBJCODE_LEN(x)      (SCM_OBJCODE_DATA (x)->len)
  47 #define SCM_OBJCODE_META_LEN(x) (SCM_OBJCODE_DATA (x)->metalen)
  48 #define SCM_OBJCODE_TOTAL_LEN(x) (SCM_OBJCODE_LEN (x) + SCM_OBJCODE_META_LEN (x))
  49 #define SCM_OBJCODE_NARGS(x)    (SCM_OBJCODE_DATA (x)->nargs)
  50 #define SCM_OBJCODE_NREST(x)    (SCM_OBJCODE_DATA (x)->nrest)
  51 #define SCM_OBJCODE_NLOCS(x)    (SCM_OBJCODE_DATA (x)->nlocs)
  52 #define SCM_OBJCODE_BASE(x)     (SCM_OBJCODE_DATA (x)->base)
  53
  54 #define SCM_OBJCODE_IS_MMAP(x)  (SCM_SMOB_FLAGS (x) & SCM_F_OBJCODE_IS_MMAP)
  55 #define SCM_OBJCODE_IS_U8VECTOR(x) (SCM_SMOB_FLAGS (x) & SCM_F_OBJCODE_IS_U8VECTOR)
  56 #define SCM_OBJCODE_IS_SLICE(x) (SCM_SMOB_FLAGS (x) & SCM_F_OBJCODE_IS_SLICE)
  57
  58 SCM scm_c_make_objcode_slice (SCM parent, const scm_t_uint8 *ptr);
  59 SCM_API SCM scm_load_objcode (SCM file);
  60 SCM_API SCM scm_objcode_p (SCM obj);
  61 SCM_API SCM scm_objcode_meta (SCM objcode);
  62 SCM_API SCM scm_bytecode_to_objcode (SCM bytecode);
  63 SCM_API SCM scm_objcode_to_bytecode (SCM objcode);
  64 SCM_API SCM scm_write_objcode (SCM objcode, SCM port);
  65
  66 SCM_INTERNAL void scm_bootstrap_objcodes (void);
  67 SCM_INTERNAL void scm_init_objcodes (void);
  68
  69 #endif /* _SCM_OBJCODES_H_ */
  70
  71 /*
  72   Local Variables:
  73   c-file-style: "gnu"
  74   End:
  75 */