libguile/programs.h

   1 /* Copyright (C) 2001, 2009, 2010, 2011, 2012, 2013 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_PROGRAMS_H_
  20 #define _SCM_PROGRAMS_H_
  21
  22 #include <libguile.h>
  23 #include <libguile/objcodes.h>
  24
  25 /*
  26  * The new RTL programs.
  27  */
  28
  29 #define SCM_RTL_PROGRAM_P(x) (SCM_HAS_TYP7 (x, scm_tc7_rtl_program))
  30 #define SCM_RTL_PROGRAM_CODE(x) ((scm_t_uint32 *) SCM_CELL_WORD_1 (x))
  31 #define SCM_RTL_PROGRAM_FREE_VARIABLES(x) (SCM_CELL_OBJECT_LOC (x, 2))
  32 #define SCM_RTL_PROGRAM_FREE_VARIABLE_REF(x,i) (SCM_RTL_PROGRAM_FREE_VARIABLES (x)[i])
  33 #define SCM_RTL_PROGRAM_FREE_VARIABLE_SET(x,i,v) (SCM_RTL_PROGRAM_FREE_VARIABLES (x)[i]=(v))
  34 #define SCM_RTL_PROGRAM_NUM_FREE_VARIABLES(x) (SCM_CELL_WORD_0 (x) >> 16)
  35 #define SCM_VALIDATE_RTL_PROGRAM(p,x) SCM_MAKE_VALIDATE (p, x, RTL_PROGRAM_P)
  36
  37 static inline SCM
  38 scm_i_make_rtl_program (const scm_t_uint32 *code)
  39 {
  40   return scm_cell (scm_tc7_rtl_program, (scm_t_bits)code);
  41 }
  42
  43 SCM_INTERNAL SCM scm_make_rtl_program (SCM bytevector, SCM byte_offset, SCM free_variables);
  44 SCM_INTERNAL SCM scm_rtl_program_p (SCM obj);
  45 SCM_INTERNAL SCM scm_rtl_program_code (SCM program);
  46
  47 SCM_INTERNAL SCM scm_i_rtl_program_name (SCM program);
  48 SCM_INTERNAL SCM scm_i_rtl_program_documentation (SCM program);
  49 SCM_INTERNAL SCM scm_i_rtl_program_properties (SCM program);
  50
  51 /*
  52  * Programs
  53  */
  54
  55 #define SCM_F_PROGRAM_IS_BOOT 0x100
  56 #define SCM_F_PROGRAM_IS_PRIMITIVE 0x200
  57 #define SCM_F_PROGRAM_IS_PRIMITIVE_GENERIC 0x400
  58 #define SCM_F_PROGRAM_IS_CONTINUATION 0x800
  59 #define SCM_F_PROGRAM_IS_PARTIAL_CONTINUATION 0x1000
  60
  61 #define SCM_PROGRAM_P(x)        (SCM_HAS_TYP7 (x, scm_tc7_program))
  62 #define SCM_PROGRAM_OBJCODE(x)  (SCM_CELL_OBJECT_1 (x))
  63 #define SCM_PROGRAM_OBJTABLE(x) (SCM_CELL_OBJECT_2 (x))
  64 #define SCM_PROGRAM_FREE_VARIABLES(x) (SCM_CELL_OBJECT_LOC (x, 3))
  65 #define SCM_PROGRAM_FREE_VARIABLE_REF(x,i) (SCM_PROGRAM_FREE_VARIABLES (x)[i])
  66 #define SCM_PROGRAM_FREE_VARIABLE_SET(x,i,v) (SCM_PROGRAM_FREE_VARIABLES (x)[i]=(v))
  67 #define SCM_PROGRAM_NUM_FREE_VARIABLES(x) (SCM_CELL_WORD_0 (x) >> 16)
  68 #define SCM_PROGRAM_DATA(x)     (SCM_OBJCODE_DATA (SCM_PROGRAM_OBJCODE (x)))
  69 #define SCM_VALIDATE_PROGRAM(p,x) SCM_MAKE_VALIDATE (p, x, PROGRAM_P)
  70 #define SCM_PROGRAM_IS_BOOT(x)  (SCM_CELL_WORD_0 (x) & SCM_F_PROGRAM_IS_BOOT)
  71 #define SCM_PROGRAM_IS_PRIMITIVE(x) (SCM_CELL_WORD_0 (x) & SCM_F_PROGRAM_IS_PRIMITIVE)
  72 #define SCM_PROGRAM_IS_PRIMITIVE_GENERIC(x) (SCM_CELL_WORD_0 (x) & SCM_F_PROGRAM_IS_PRIMITIVE_GENERIC)
  73 #define SCM_PROGRAM_IS_CONTINUATION(x) (SCM_CELL_WORD_0 (x) & SCM_F_PROGRAM_IS_CONTINUATION)
  74 #define SCM_PROGRAM_IS_PARTIAL_CONTINUATION(x) (SCM_CELL_WORD_0 (x) & SCM_F_PROGRAM_IS_PARTIAL_CONTINUATION)
  75
  76 SCM_API SCM scm_make_program (SCM objcode, SCM objtable, SCM free_variables);
  77
  78 SCM_API SCM scm_program_p (SCM obj);
  79 SCM_API SCM scm_program_base (SCM program);
  80 SCM_API SCM scm_program_meta (SCM program);
  81 SCM_API SCM scm_program_bindings (SCM program);
  82 SCM_API SCM scm_program_sources (SCM program);
  83 SCM_API SCM scm_program_source (SCM program, SCM ip, SCM sources);
  84 SCM_API SCM scm_program_arities (SCM program);
  85 SCM_API SCM scm_program_objects (SCM program);
  86 SCM_API SCM scm_program_module (SCM program);
  87 SCM_API SCM scm_program_num_free_variables (SCM program);
  88 SCM_API SCM scm_program_free_variable_ref (SCM program, SCM i);
  89 SCM_API SCM scm_program_free_variable_set_x (SCM program, SCM i, SCM x);
  90 SCM_API SCM scm_program_objcode (SCM program);
  91
  92 SCM_API SCM scm_c_program_source (SCM program, size_t ip);
  93
  94 SCM_INTERNAL SCM scm_i_program_properties (SCM program);
  95 SCM_INTERNAL int scm_i_program_arity (SCM program, int *req, int *opt, int *rest);
  96 SCM_INTERNAL void scm_i_program_print (SCM program, SCM port,
  97                                        scm_print_state *pstate);
  98 SCM_INTERNAL void scm_bootstrap_programs (void);
  99 SCM_INTERNAL void scm_init_programs (void);
 100
 101 #endif /* _SCM_PROGRAMS_H_ */
 102
 103 /*
 104   Local Variables:
 105   c-file-style: "gnu"
 106   End:
 107 */