libguile/programs.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_PROGRAMS_H_
  43 #define _SCM_PROGRAMS_H_
  44
  45 #include <libguile.h>
  46
  47 /*
  48  * Programs
  49  */
  50
  51 typedef unsigned char scm_byte_t;
  52
  53 struct scm_program {
  54   size_t size;                  /* the size of the program  */
  55   unsigned char nargs;          /* the number of arguments */
  56   unsigned char nrest;          /* the number of rest argument (0 or 1) */
  57   unsigned char nlocs;          /* the number of local variables */
  58   unsigned char nexts;          /* the number of external variables */
  59   scm_byte_t *base;             /* program base address */
  60   SCM module;                   /* resolve bindings with respect to this module */
  61   SCM meta;                     /* meta data */
  62   SCM objs;                     /* constant objects */
  63   SCM external;                 /* external environment */
  64   SCM holder;                   /* the owner of bytecode */
  65 };
  66
  67 extern scm_t_bits scm_tc16_program;
  68
  69 #define SCM_PROGRAM_P(x)        (SCM_SMOB_PREDICATE (scm_tc16_program, x))
  70 #define SCM_PROGRAM_DATA(x)     ((struct scm_program *) SCM_SMOB_DATA (x))
  71 #define SCM_VALIDATE_PROGRAM(p,x) SCM_MAKE_VALIDATE (p, x, PROGRAM_P)
  72
  73 extern SCM scm_c_make_program (void *addr, size_t size, SCM holder);
  74 extern SCM scm_c_make_closure (SCM program, SCM external);
  75
  76 extern SCM scm_program_p (SCM obj);
  77 extern SCM scm_program_base (SCM program);
  78 extern SCM scm_program_arity (SCM program);
  79 extern SCM scm_program_meta (SCM program);
  80 extern SCM scm_program_objects (SCM program);
  81 extern SCM scm_program_module (SCM program);
  82 extern SCM scm_program_external (SCM program);
  83 extern SCM scm_program_external_set_x (SCM program, SCM external);
  84 extern SCM scm_program_bytecode (SCM program);
  85
  86 extern SCM scm_c_program_source (struct scm_program *p, size_t ip);
  87
  88 extern void scm_bootstrap_programs (void);
  89 extern void scm_init_programs (void);
  90
  91 #endif /* _SCM_PROGRAMS_H_ */
  92
  93 /*
  94   Local Variables:
  95   c-file-style: "gnu"
  96   End:
  97 */