libguile/programs.c

   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 #if HAVE_CONFIG_H
  20 #  include <config.h>
  21 #endif
  22
  23 #include <string.h>
  24 #include "_scm.h"
  25 #include "instructions.h"
  26 #include "modules.h"
  27 #include "programs.h"
  28 #include "procprop.h" /* scm_sym_name */
  29 #include "srcprop.h"  /* scm_sym_filename */
  30 #include "vm.h"
  31
  32 \f
  33 static SCM write_program = SCM_BOOL_F;
  34
  35 SCM_DEFINE (scm_make_program, "make-program", 1, 2, 0,
  36             (SCM objcode, SCM objtable, SCM free_variables),
  37             "")
  38 #define FUNC_NAME s_scm_make_program
  39 {
  40   SCM_VALIDATE_OBJCODE (1, objcode);
  41   if (SCM_UNLIKELY (SCM_UNBNDP (objtable)))
  42     objtable = SCM_BOOL_F;
  43   else if (scm_is_true (objtable))
  44     SCM_VALIDATE_VECTOR (2, objtable);
  45
  46   if (SCM_UNBNDP (free_variables) || scm_is_false (free_variables))
  47     {
  48       SCM ret = scm_words (scm_tc7_program, 3);
  49       SCM_SET_CELL_OBJECT_1 (ret, objcode);
  50       SCM_SET_CELL_OBJECT_2 (ret, objtable);
  51       return ret;
  52     }
  53   else
  54     {
  55       size_t i, len;
  56       SCM ret;
  57       SCM_VALIDATE_VECTOR (3, free_variables);
  58       len = scm_c_vector_length (free_variables);
  59       if (SCM_UNLIKELY (len >> 16))
  60         SCM_OUT_OF_RANGE (3, free_variables);
  61       ret = scm_words (scm_tc7_program | (len<<16), 3 + len);
  62       SCM_SET_CELL_OBJECT_1 (ret, objcode);
  63       SCM_SET_CELL_OBJECT_2 (ret, objtable);
  64       for (i = 0; i < len; i++)
  65         SCM_SET_CELL_OBJECT (ret, 3+i,
  66                              SCM_SIMPLE_VECTOR_REF (free_variables, i));
  67       return ret;
  68     }
  69 }
  70 #undef FUNC_NAME
  71
  72 void
  73 scm_i_program_print (SCM program, SCM port, scm_print_state *pstate)
  74 {
  75   static int print_error = 0;
  76
  77   if (scm_is_false (write_program) && scm_module_system_booted_p)
  78     write_program = scm_module_local_variable
  79       (scm_c_resolve_module ("system vm program"),
  80        scm_from_locale_symbol ("write-program"));
  81
  82   if (SCM_PROGRAM_IS_CONTINUATION (program))
  83     {
  84       /* twingliness */
  85       scm_puts ("#<continuation ", port);
  86       scm_uintprint (SCM_UNPACK (program), 16, port);
  87       scm_putc ('>', port);
  88     }
  89   else if (SCM_PROGRAM_IS_PARTIAL_CONTINUATION (program))
  90     {
  91       /* twingliness */
  92       scm_puts ("#<partial-continuation ", port);
  93       scm_uintprint (SCM_UNPACK (program), 16, port);
  94       scm_putc ('>', port);
  95     }
  96   else if (scm_is_false (write_program) || print_error)
  97     {
  98       scm_puts ("#<program ", port);
  99       scm_uintprint (SCM_UNPACK (program), 16, port);
 100       scm_putc ('>', port);
 101     }
 102   else
 103     {
 104       print_error = 1;
 105       scm_call_2 (SCM_VARIABLE_REF (write_program), program, port);
 106       print_error = 0;
 107     }
 108 }
 109
 110 \f
 111 /*
 112  * Scheme interface
 113  */
 114
 115 SCM_DEFINE (scm_program_p, "program?", 1, 0, 0,
 116             (SCM obj),
 117             "")
 118 #define FUNC_NAME s_scm_program_p
 119 {
 120   return scm_from_bool (SCM_PROGRAM_P (obj));
 121 }
 122 #undef FUNC_NAME
 123
 124 SCM_DEFINE (scm_program_base, "program-base", 1, 0, 0,
 125             (SCM program),
 126             "")
 127 #define FUNC_NAME s_scm_program_base
 128 {
 129   const struct scm_objcode *c_objcode;
 130
 131   SCM_VALIDATE_PROGRAM (1, program);
 132
 133   c_objcode = SCM_PROGRAM_DATA (program);
 134   return scm_from_ulong ((unsigned long) SCM_C_OBJCODE_BASE (c_objcode));
 135 }
 136 #undef FUNC_NAME
 137
 138 SCM_DEFINE (scm_program_objects, "program-objects", 1, 0, 0,
 139             (SCM program),
 140             "")
 141 #define FUNC_NAME s_scm_program_objects
 142 {
 143   SCM_VALIDATE_PROGRAM (1, program);
 144   return SCM_PROGRAM_OBJTABLE (program);
 145 }
 146 #undef FUNC_NAME
 147
 148 SCM_DEFINE (scm_program_module, "program-module", 1, 0, 0,
 149             (SCM program),
 150             "")
 151 #define FUNC_NAME s_scm_program_module
 152 {
 153   SCM objs;
 154   SCM_VALIDATE_PROGRAM (1, program);
 155   objs = SCM_PROGRAM_OBJTABLE (program);
 156   return scm_is_true (objs) ? scm_c_vector_ref (objs, 0) : SCM_BOOL_F;
 157 }
 158 #undef FUNC_NAME
 159
 160 SCM_DEFINE (scm_program_meta, "program-meta", 1, 0, 0,
 161             (SCM program),
 162             "")
 163 #define FUNC_NAME s_scm_program_meta
 164 {
 165   SCM metaobj;
 166
 167   SCM_VALIDATE_PROGRAM (1, program);
 168
 169   metaobj = scm_objcode_meta (SCM_PROGRAM_OBJCODE (program));
 170   if (scm_is_true (metaobj))
 171     return scm_make_program (metaobj, SCM_PROGRAM_OBJTABLE (program),
 172                              SCM_BOOL_F);
 173   else
 174     return SCM_BOOL_F;
 175 }
 176 #undef FUNC_NAME
 177
 178 SCM_DEFINE (scm_program_bindings, "program-bindings", 1, 0, 0,
 179             (SCM program),
 180             "")
 181 #define FUNC_NAME s_scm_program_bindings
 182 {
 183   SCM meta;
 184
 185   SCM_VALIDATE_PROGRAM (1, program);
 186
 187   meta = scm_program_meta (program);
 188   if (scm_is_false (meta))
 189     return SCM_BOOL_F;
 190
 191   return scm_car (scm_call_0 (meta));
 192 }
 193 #undef FUNC_NAME
 194
 195 SCM_DEFINE (scm_program_sources, "program-sources", 1, 0, 0,
 196             (SCM program),
 197             "")
 198 #define FUNC_NAME s_scm_program_sources
 199 {
 200   SCM meta, sources, ret, filename;
 201
 202   SCM_VALIDATE_PROGRAM (1, program);
 203
 204   meta = scm_program_meta (program);
 205   if (scm_is_false (meta))
 206     return SCM_EOL;
 207
 208   filename = SCM_BOOL_F;
 209   ret = SCM_EOL;
 210   for (sources = scm_cadr (scm_call_0 (meta)); !scm_is_null (sources);
 211        sources = scm_cdr (sources))
 212     {
 213       SCM x = scm_car (sources);
 214       if (scm_is_pair (x))
 215         {
 216           if (scm_is_number (scm_car (x)))
 217             {
 218               SCM addr = scm_car (x);
 219               ret = scm_acons (addr, scm_cons (filename, scm_cdr (x)),
 220                                ret);
 221             }
 222           else if (scm_is_eq (scm_car (x), scm_sym_filename))
 223             filename = scm_cdr (x);
 224         }
 225     }
 226   return scm_reverse_x (ret, SCM_UNDEFINED);
 227 }
 228 #undef FUNC_NAME
 229
 230 SCM_DEFINE (scm_program_arities, "program-arities", 1, 0, 0,
 231             (SCM program),
 232             "")
 233 #define FUNC_NAME s_scm_program_arities
 234 {
 235   SCM meta;
 236
 237   SCM_VALIDATE_PROGRAM (1, program);
 238
 239   meta = scm_program_meta (program);
 240   if (scm_is_false (meta))
 241     return SCM_BOOL_F;
 242
 243   return scm_caddr (scm_call_0 (meta));
 244 }
 245 #undef FUNC_NAME
 246
 247 SCM
 248 scm_i_program_properties (SCM program)
 249 #define FUNC_NAME "%program-properties"
 250 {
 251   SCM meta;
 252
 253   SCM_VALIDATE_PROGRAM (1, program);
 254
 255   meta = scm_program_meta (program);
 256   if (scm_is_false (meta))
 257     return SCM_EOL;
 258
 259   return scm_cdddr (scm_call_0 (meta));
 260 }
 261 #undef FUNC_NAME
 262
 263 SCM_DEFINE (scm_program_source, "program-source", 2, 0, 0,
 264             (SCM program, SCM ip),
 265             "")
 266 #define FUNC_NAME s_scm_program_source
 267 {
 268   SCM_VALIDATE_PROGRAM (1, program);
 269   return scm_c_program_source (program, scm_to_size_t (ip));
 270 }
 271 #undef FUNC_NAME
 272
 273 extern SCM
 274 scm_c_program_source (SCM program, size_t ip)
 275 {
 276   SCM sources, source = SCM_BOOL_F;
 277
 278   for (sources = scm_program_sources (program);
 279        !scm_is_null (sources)
 280          && scm_to_size_t (scm_caar (sources)) <= ip;
 281        sources = scm_cdr (sources))
 282     source = scm_car (sources);
 283
 284   return source; /* (addr . (filename . (line . column))) */
 285 }
 286
 287 SCM_DEFINE (scm_program_num_free_variables, "program-num-free-variables", 1, 0, 0,
 288             (SCM program),
 289             "")
 290 #define FUNC_NAME s_scm_program_num_free_variables
 291 {
 292   SCM_VALIDATE_PROGRAM (1, program);
 293   return scm_from_ulong (SCM_PROGRAM_NUM_FREE_VARIABLES (program));
 294 }
 295 #undef FUNC_NAME
 296
 297 SCM_DEFINE (scm_program_free_variable_ref, "program-free-variable-ref", 2, 0, 0,
 298             (SCM program, SCM i),
 299             "")
 300 #define FUNC_NAME s_scm_program_free_variable_ref
 301 {
 302   unsigned long idx;
 303   SCM_VALIDATE_PROGRAM (1, program);
 304   SCM_VALIDATE_ULONG_COPY (2, i, idx);
 305   if (idx >= SCM_PROGRAM_NUM_FREE_VARIABLES (program))
 306     SCM_OUT_OF_RANGE (2, i);
 307   return SCM_PROGRAM_FREE_VARIABLE_REF (program, idx);
 308 }
 309 #undef FUNC_NAME
 310
 311 SCM_DEFINE (scm_program_free_variable_set_x, "program-free-variable-set!", 3, 0, 0,
 312             (SCM program, SCM i, SCM x),
 313             "")
 314 #define FUNC_NAME s_scm_program_free_variable_set_x
 315 {
 316   unsigned long idx;
 317   SCM_VALIDATE_PROGRAM (1, program);
 318   SCM_VALIDATE_ULONG_COPY (2, i, idx);
 319   if (idx >= SCM_PROGRAM_NUM_FREE_VARIABLES (program))
 320     SCM_OUT_OF_RANGE (2, i);
 321   SCM_PROGRAM_FREE_VARIABLE_SET (program, idx, x);
 322   return SCM_UNSPECIFIED;
 323 }
 324 #undef FUNC_NAME
 325
 326 SCM_DEFINE (scm_program_objcode, "program-objcode", 1, 0, 0,
 327             (SCM program),
 328             "Return a @var{program}'s object code.")
 329 #define FUNC_NAME s_scm_program_objcode
 330 {
 331   SCM_VALIDATE_PROGRAM (1, program);
 332
 333   return SCM_PROGRAM_OBJCODE (program);
 334 }
 335 #undef FUNC_NAME
 336
 337 /* This one is a shim to pre-case-lambda internal interfaces. Avoid it if you
 338    can -- use program-arguments or the like. */
 339 static SCM sym_arglist;
 340 int
 341 scm_i_program_arity (SCM program, int *req, int *opt, int *rest)
 342 {
 343   SCM arities, x;
 344
 345   arities = scm_program_arities (program);
 346   if (!scm_is_pair (arities))
 347     return 0;
 348   /* take the last arglist, it will be least specific */
 349   while (scm_is_pair (scm_cdr (arities)))
 350     arities = scm_cdr (arities);
 351   x = scm_cddar (arities);
 352   if (scm_is_pair (x))
 353     {
 354       *req = scm_to_int (scm_car (x));
 355       x = scm_cdr (x);
 356       if (scm_is_pair (x))
 357         {
 358           *opt = scm_to_int (scm_car (x));
 359           x = scm_cdr (x);
 360           if (scm_is_pair (x))
 361             *rest = scm_is_true (scm_car (x));
 362           else
 363             *rest = 0;
 364         }
 365       else
 366         *opt = *rest = 0;
 367     }
 368   else
 369     *req = *opt = *rest = 0;
 370
 371   return 1;
 372 }
 373
 374 \f
 375
 376 void
 377 scm_bootstrap_programs (void)
 378 {
 379   /* arglist can't be snarfed, because snarfage is only loaded when (system vm
 380      program) is loaded. perhaps static-alloc will fix this. */
 381   sym_arglist = scm_from_locale_symbol ("arglist");
 382   scm_c_register_extension ("libguile-" SCM_EFFECTIVE_VERSION,
 383                             "scm_init_programs",
 384                             (scm_t_extension_init_func)scm_init_programs, NULL);
 385 }
 386
 387 void
 388 scm_init_programs (void)
 389 {
 390 #ifndef SCM_MAGIC_SNARFER
 391 #include "libguile/programs.x"
 392 #endif
 393 }
 394
 395 /*
 396   Local Variables:
 397   c-file-style: "gnu"
 398   End:
 399 */