libguile/objcodes.h

   1 /* Copyright (C) 2001, 2009, 2010 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 {
  27   scm_t_uint32 len;             /* the maximum index of base[] */
  28   scm_t_uint32 metalen;         /* well, i lie. this many bytes at the end of
  29                                    base[] for metadata */
  30   /* In C99, we'd have:
  31      scm_t_uint8 base[];  */
  32 };
  33
  34 /* Return a pointer to the base of objcode OBJ.  */
  35 #define SCM_C_OBJCODE_BASE(obj)                         \
  36   ((scm_t_uint8 *)(obj) + sizeof (struct scm_objcode))
  37
  38 #define SCM_F_OBJCODE_IS_MMAP       (1<<0)
  39 #define SCM_F_OBJCODE_IS_BYTEVECTOR (1<<1)
  40 #define SCM_F_OBJCODE_IS_SLICE      (1<<2)
  41 #define SCM_F_OBJCODE_IS_STATIC     (1<<3)
  42
  43 #define SCM_OBJCODE_P(x)        (SCM_NIMP (x) && SCM_TYP7 (x) == scm_tc7_objcode)
  44 #define SCM_OBJCODE_DATA(x)     ((struct scm_objcode *) SCM_CELL_WORD_1 (x))
  45 #define SCM_VALIDATE_OBJCODE(p,x) SCM_MAKE_VALIDATE (p, x, OBJCODE_P)
  46
  47 #define SCM_OBJCODE_LEN(x)      (SCM_OBJCODE_DATA (x)->len)
  48 #define SCM_OBJCODE_META_LEN(x) (SCM_OBJCODE_DATA (x)->metalen)
  49 #define SCM_OBJCODE_TOTAL_LEN(x) (SCM_OBJCODE_LEN (x) + SCM_OBJCODE_META_LEN (x))
  50 #define SCM_OBJCODE_BASE(x)     (SCM_C_OBJCODE_BASE (SCM_OBJCODE_DATA (x)))
  51
  52 #define SCM_OBJCODE_FLAGS(x)    (SCM_CELL_WORD_0 (x) >> 8)
  53 #define SCM_OBJCODE_IS_MMAP(x)  (SCM_OBJCODE_FLAGS (x) & SCM_F_OBJCODE_IS_MMAP)
  54 #define SCM_OBJCODE_IS_BYTEVECTOR(x) (SCM_OBJCODE_FLAGS (x) & SCM_F_OBJCODE_IS_BYTEVECTOR)
  55 #define SCM_OBJCODE_IS_SLICE(x) (SCM_OBJCODE_FLAGS (x) & SCM_F_OBJCODE_IS_SLICE)
  56
  57 SCM scm_c_make_objcode_slice (SCM parent, const scm_t_uint8 *ptr);
  58 SCM_API SCM scm_load_objcode (SCM file);
  59 SCM_API SCM scm_objcode_p (SCM obj);
  60 SCM_API SCM scm_objcode_meta (SCM objcode);
  61 SCM_API SCM scm_bytecode_to_objcode (SCM bytecode);
  62 SCM_API SCM scm_objcode_to_bytecode (SCM objcode);
  63 SCM_API SCM scm_write_objcode (SCM objcode, SCM port);
  64
  65 SCM_INTERNAL void scm_i_objcode_print (SCM objcode, SCM port,
  66                                        scm_print_state *pstate);
  67 SCM_INTERNAL void scm_bootstrap_objcodes (void);
  68 SCM_INTERNAL void scm_init_objcodes (void);
  69
  70 #endif /* _SCM_OBJCODES_H_ */
  71
  72 /*
  73   Local Variables:
  74   c-file-style: "gnu"
  75   End:
  76 */