libguile/objcodes.h

   1 /* Copyright (C) 2001 Free Software Foundation, Inc.
   2  *
   3  * This program is free software; you can redistribute it and/or modify
   4  * it under the terms of the GNU General Public License as published by
   5  * the Free Software Foundation; either version 2, or (at your option)
   6  * any later version.
   7  *
   8  * This program is distributed in the hope that it will be useful,
   9  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  10  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  11  * GNU General Public License for more details.
  12  *
  13  * You should have received a copy of the GNU General Public License
  14  * along with this software; see the file COPYING.  If not, write to
  15  * the Free Software Foundation, Inc., 59 Temple Place, Suite 330,
  16  * Boston, MA 02111-1307 USA
  17  *
  18  * As a special exception, the Free Software Foundation gives permission
  19  * for additional uses of the text contained in its release of GUILE.
  20  *
  21  * The exception is that, if you link the GUILE library with other files
  22  * to produce an executable, this does not by itself cause the
  23  * resulting executable to be covered by the GNU General Public License.
  24  * Your use of that executable is in no way restricted on account of
  25  * linking the GUILE library code into it.
  26  *
  27  * This exception does not however invalidate any other reasons why
  28  * the executable file might be covered by the GNU General Public License.
  29  *
  30  * This exception applies only to the code released by the
  31  * Free Software Foundation under the name GUILE.  If you copy
  32  * code from other Free Software Foundation releases into a copy of
  33  * GUILE, as the General Public License permits, the exception does
  34  * not apply to the code that you add in this way.  To avoid misleading
  35  * anyone as to the status of such modified files, you must delete
  36  * this exception notice from them.
  37  *
  38  * If you write modifications of your own for GUILE, it is your choice
  39  * whether to permit this exception to apply to your modifications.
  40  * If you do not wish that, delete this exception notice.  */
  41
  42 #ifndef _SCM_OBJCODES_H_
  43 #define _SCM_OBJCODES_H_
  44
  45 #include <libguile.h>
  46
  47 /* objcode data should be directly mappable to this C structure. */
  48 struct scm_objcode {
  49   scm_t_uint8 nargs;
  50   scm_t_uint8 nrest;
  51   scm_t_uint8 nlocs;
  52   scm_t_uint8 nexts;
  53   scm_t_uint32 len;             /* the maximum index of base[] */
  54   scm_t_uint32 metalen;         /* well, i lie. this many bytes at the end of
  55                                    base[] for metadata */
  56   scm_t_uint8 base[0];
  57 };
  58
  59 #define SCM_F_OBJCODE_IS_MMAP     (1<<0)
  60 #define SCM_F_OBJCODE_IS_U8VECTOR (1<<1)
  61 #define SCM_F_OBJCODE_IS_SLICE    (1<<2)
  62
  63 extern scm_t_bits scm_tc16_objcode;
  64
  65 #define SCM_OBJCODE_P(x)        (SCM_SMOB_PREDICATE (scm_tc16_objcode, x))
  66 #define SCM_OBJCODE_DATA(x)     ((struct scm_objcode *) SCM_SMOB_DATA (x))
  67 #define SCM_VALIDATE_OBJCODE(p,x) SCM_MAKE_VALIDATE (p, x, OBJCODE_P)
  68
  69 #define SCM_OBJCODE_LEN(x)      (SCM_OBJCODE_DATA (x)->len)
  70 #define SCM_OBJCODE_META_LEN(x) (SCM_OBJCODE_DATA (x)->metalen)
  71 #define SCM_OBJCODE_TOTAL_LEN(x) (SCM_OBJCODE_LEN (x) + SCM_OBJCODE_META_LEN (x))
  72 #define SCM_OBJCODE_NARGS(x)    (SCM_OBJCODE_DATA (x)->nargs)
  73 #define SCM_OBJCODE_NREST(x)    (SCM_OBJCODE_DATA (x)->nrest)
  74 #define SCM_OBJCODE_NLOCS(x)    (SCM_OBJCODE_DATA (x)->nlocs)
  75 #define SCM_OBJCODE_NEXTS(x)    (SCM_OBJCODE_DATA (x)->nexts)
  76 #define SCM_OBJCODE_BASE(x)     (SCM_OBJCODE_DATA (x)->base)
  77
  78 #define SCM_OBJCODE_IS_MMAP(x)  (SCM_SMOB_FLAGS (x) & SCM_F_OBJCODE_IS_MMAP)
  79 #define SCM_OBJCODE_IS_U8VECTOR(x) (SCM_SMOB_FLAGS (x) & SCM_F_OBJCODE_IS_U8VECTOR)
  80 #define SCM_OBJCODE_IS_SLICE(x) (SCM_SMOB_FLAGS (x) & SCM_F_OBJCODE_IS_SLICE)
  81
  82 SCM scm_c_make_objcode_slice (SCM parent, scm_t_uint8 *ptr);
  83 extern SCM scm_load_objcode (SCM file);
  84 extern SCM scm_objcode_p (SCM obj);
  85 extern SCM scm_objcode_meta (SCM objcode);
  86 extern SCM scm_bytecode_to_objcode (SCM bytecode);
  87 extern SCM scm_objcode_to_bytecode (SCM objcode);
  88 extern SCM scm_write_objcode (SCM objcode, SCM port);
  89
  90 extern void scm_bootstrap_objcodes (void);
  91 extern void scm_init_objcodes (void);
  92
  93 #endif /* _SCM_OBJCODES_H_ */
  94
  95 /*
  96   Local Variables:
  97   c-file-style: "gnu"
  98   End:
  99 */