[bpt/guile.git] / libguile / programs.c

/* Copyright (C) 2001, 2009, 2010, 2011, 2012, 2013 Free Software Foundation, Inc.
 * 
 * This library is free software; you can redistribute it and/or
 * modify it under the terms of the GNU Lesser General Public License
 * as published by the Free Software Foundation; either version 3 of
 * the License, or (at your option) any later version.
 *
 * This library is distributed in the hope that it will be useful, but
 * WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
 * Lesser General Public License for more details.
 *
 * You should have received a copy of the GNU Lesser General Public
 * License along with this library; if not, write to the Free Software
 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
 * 02110-1301 USA
 */

#if HAVE_CONFIG_H
#  include <config.h>
#endif

#include <string.h>
#include "_scm.h"
#include "instructions.h"
#include "modules.h"
#include "programs.h"
#include "procprop.h" /* scm_sym_name */
#include "srcprop.h"  /* scm_sym_filename */
#include "vm.h"

\f
static SCM write_program = SCM_BOOL_F;

SCM_DEFINE (scm_make_program, "make-program", 1, 2, 0,
	    (SCM objcode, SCM objtable, SCM free_variables),
	    "")
#define FUNC_NAME s_scm_make_program
{
  SCM_VALIDATE_OBJCODE (1, objcode);
  if (SCM_UNLIKELY (SCM_UNBNDP (objtable)))
    objtable = SCM_BOOL_F;
  else if (scm_is_true (objtable))
    SCM_VALIDATE_VECTOR (2, objtable);

  if (SCM_UNBNDP (free_variables) || scm_is_false (free_variables))
    {
      SCM ret = scm_words (scm_tc7_program, 3);
      SCM_SET_CELL_OBJECT_1 (ret, objcode);
      SCM_SET_CELL_OBJECT_2 (ret, objtable);
      return ret;
    }
  else
    {
      size_t i, len;
      SCM ret;
      SCM_VALIDATE_VECTOR (3, free_variables);
      len = scm_c_vector_length (free_variables);
      if (SCM_UNLIKELY (len >> 16))
        SCM_OUT_OF_RANGE (3, free_variables);
      ret = scm_words (scm_tc7_program | (len<<16), 3 + len);
      SCM_SET_CELL_OBJECT_1 (ret, objcode);
      SCM_SET_CELL_OBJECT_2 (ret, objtable);
      for (i = 0; i < len; i++)
        SCM_SET_CELL_OBJECT (ret, 3+i,
                             SCM_SIMPLE_VECTOR_REF (free_variables, i));
      return ret;
    }
}
#undef FUNC_NAME

SCM_DEFINE (scm_make_rtl_program, "make-rtl-program", 1, 2, 0,
	    (SCM bytevector, SCM byte_offset, SCM free_variables),
	    "")
#define FUNC_NAME s_scm_make_rtl_program
{
  scm_t_uint8 *code;
  scm_t_uint32 offset;

  if (!scm_is_bytevector (bytevector))
    scm_wrong_type_arg (FUNC_NAME, 1, bytevector);
  if (SCM_UNBNDP (byte_offset))
    offset = 0;
  else
    {
      offset = scm_to_uint32 (byte_offset);
      if (offset > SCM_BYTEVECTOR_LENGTH (bytevector))
        SCM_OUT_OF_RANGE (2, byte_offset);
    }

  code = (scm_t_uint8*) SCM_BYTEVECTOR_CONTENTS (bytevector) + offset;
  if (((scm_t_uintptr) code) % 4)
    SCM_OUT_OF_RANGE (2, byte_offset);

  if (SCM_UNBNDP (free_variables) || scm_is_false (free_variables))
    return scm_cell (scm_tc7_rtl_program, (scm_t_bits) code);
  else
    abort ();
}
#undef FUNC_NAME

SCM_DEFINE (scm_rtl_program_code, "rtl-program-code", 1, 0, 0,
            (SCM program),
            "")
#define FUNC_NAME s_scm_rtl_program_code
{
  SCM_VALIDATE_RTL_PROGRAM (1, program);

  /* FIXME: we need scm_from_uintptr ().  */
  return scm_from_size_t ((size_t) SCM_RTL_PROGRAM_CODE (program));
}
#undef FUNC_NAME

SCM
scm_i_rtl_program_name (SCM program)
{
  static SCM rtl_program_name = SCM_BOOL_F;

  if (scm_is_false (rtl_program_name) && scm_module_system_booted_p)
    rtl_program_name =
        scm_c_private_variable ("system vm program", "rtl-program-name");

  return scm_call_1 (scm_variable_ref (rtl_program_name), program);
}

SCM
scm_i_rtl_program_documentation (SCM program)
{
  static SCM rtl_program_documentation = SCM_BOOL_F;

  if (scm_is_false (rtl_program_documentation) && scm_module_system_booted_p)
    rtl_program_documentation =
      scm_c_private_variable ("system vm program",
                              "rtl-program-documentation");

  return scm_call_1 (scm_variable_ref (rtl_program_documentation), program);
}

SCM
scm_i_rtl_program_properties (SCM program)
{
  static SCM rtl_program_properties = SCM_BOOL_F;

  if (scm_is_false (rtl_program_properties) && scm_module_system_booted_p)
    rtl_program_properties =
      scm_c_private_variable ("system vm program", "rtl-program-properties");

  return scm_call_1 (scm_variable_ref (rtl_program_properties), program);
}

void
scm_i_program_print (SCM program, SCM port, scm_print_state *pstate)
{
  static int print_error = 0;

  if (scm_is_false (write_program) && scm_module_system_booted_p)
    write_program = scm_c_private_variable ("system vm program",
                                            "write-program");
  
  if (SCM_PROGRAM_IS_CONTINUATION (program))
    {
      /* twingliness */
      scm_puts_unlocked ("#<continuation ", port);
      scm_uintprint (SCM_UNPACK (program), 16, port);
      scm_putc_unlocked ('>', port);
    }
  else if (SCM_PROGRAM_IS_PARTIAL_CONTINUATION (program))
    {
      /* twingliness */
      scm_puts_unlocked ("#<partial-continuation ", port);
      scm_uintprint (SCM_UNPACK (program), 16, port);
      scm_putc_unlocked ('>', port);
    }
  else if (scm_is_false (write_program) || print_error)
    {
      if (SCM_RTL_PROGRAM_P (program))
        {
          scm_puts_unlocked ("#<rtl-program ", port);
          scm_uintprint (SCM_UNPACK (program), 16, port);
          scm_putc_unlocked (' ', port);
          scm_uintprint ((scm_t_uintptr) SCM_RTL_PROGRAM_CODE (program), 16, port);
          scm_putc_unlocked ('>', port);
        }
      else
        {
          scm_puts_unlocked ("#<program ", port);
          scm_uintprint (SCM_UNPACK (program), 16, port);
          scm_putc_unlocked ('>', port);
        }
    }
  else
    {
      print_error = 1;
      scm_call_2 (SCM_VARIABLE_REF (write_program), program, port);
      print_error = 0;
    }
}

\f
/*
 * Scheme interface
 */

SCM_DEFINE (scm_program_p, "program?", 1, 0, 0,
	    (SCM obj),
	    "")
#define FUNC_NAME s_scm_program_p
{
  return scm_from_bool (SCM_PROGRAM_P (obj));
}
#undef FUNC_NAME

SCM_DEFINE (scm_rtl_program_p, "rtl-program?", 1, 0, 0,
	    (SCM obj),
	    "")
#define FUNC_NAME s_scm_rtl_program_p
{
  return scm_from_bool (SCM_RTL_PROGRAM_P (obj));
}
#undef FUNC_NAME

SCM_DEFINE (scm_program_base, "program-base", 1, 0, 0,
	    (SCM program),
	    "")
#define FUNC_NAME s_scm_program_base
{
  const struct scm_objcode *c_objcode;

  SCM_VALIDATE_PROGRAM (1, program);

  c_objcode = SCM_PROGRAM_DATA (program);
  return scm_from_unsigned_integer ((scm_t_bits) SCM_C_OBJCODE_BASE (c_objcode));
}
#undef FUNC_NAME

SCM_DEFINE (scm_program_objects, "program-objects", 1, 0, 0,
	    (SCM program),
	    "")
#define FUNC_NAME s_scm_program_objects
{
  SCM_VALIDATE_PROGRAM (1, program);
  return SCM_PROGRAM_OBJTABLE (program);
}
#undef FUNC_NAME

SCM_DEFINE (scm_program_module, "program-module", 1, 0, 0,
	    (SCM program),
	    "")
#define FUNC_NAME s_scm_program_module
{
  SCM objs, mod;
  SCM_VALIDATE_PROGRAM (1, program);
  objs = SCM_PROGRAM_OBJTABLE (program);
  /* If a program is the result of compiling GLIL to assembly, then if
     it has an objtable, the first entry will be a module.  But some
     programs are hand-coded trampolines, like boot programs and
     primitives and the like.  So if a program happens to have a
     non-module in the first slot of the objtable, assume that it is
     such a trampoline, and just return #f for the module.  */
  mod = scm_is_true (objs) ? scm_c_vector_ref (objs, 0) : SCM_BOOL_F;
  return SCM_MODULEP (mod) ? mod : SCM_BOOL_F;
}
#undef FUNC_NAME

SCM_DEFINE (scm_program_meta, "program-meta", 1, 0, 0,
	    (SCM program),
	    "")
#define FUNC_NAME s_scm_program_meta
{
  SCM metaobj;
  
  SCM_VALIDATE_PROGRAM (1, program);

  metaobj = scm_objcode_meta (SCM_PROGRAM_OBJCODE (program));
  if (scm_is_true (metaobj))
    return scm_make_program (metaobj, SCM_PROGRAM_OBJTABLE (program),
                             SCM_BOOL_F);
  else
    return SCM_BOOL_F;
}
#undef FUNC_NAME

SCM_DEFINE (scm_program_bindings, "program-bindings", 1, 0, 0,
	    (SCM program),
	    "")
#define FUNC_NAME s_scm_program_bindings
{
  SCM meta;
  
  SCM_VALIDATE_PROGRAM (1, program);

  meta = scm_program_meta (program);
  if (scm_is_false (meta))
    return SCM_BOOL_F;
  
  return scm_car (scm_call_0 (meta));
}
#undef FUNC_NAME

SCM_DEFINE (scm_program_sources, "program-sources", 1, 0, 0,
	    (SCM program),
	    "")
#define FUNC_NAME s_scm_program_sources
{
  SCM meta, sources, ret, filename;
  
  SCM_VALIDATE_PROGRAM (1, program);

  meta = scm_program_meta (program);
  if (scm_is_false (meta))
    return SCM_EOL;
  
  filename = SCM_BOOL_F;
  ret = SCM_EOL;
  for (sources = scm_cadr (scm_call_0 (meta)); !scm_is_null (sources);
       sources = scm_cdr (sources))
    {
      SCM x = scm_car (sources);
      if (scm_is_pair (x))
        {
          if (scm_is_number (scm_car (x)))
            {
              SCM addr = scm_car (x);
              ret = scm_acons (addr, scm_cons (filename, scm_cdr (x)),
                               ret);
            }
          else if (scm_is_eq (scm_car (x), scm_sym_filename))
            filename = scm_cdr (x);
        }
    }
  return scm_reverse_x (ret, SCM_UNDEFINED);
}
#undef FUNC_NAME

SCM_DEFINE (scm_program_arities, "program-arities", 1, 0, 0,
	    (SCM program),
	    "")
#define FUNC_NAME s_scm_program_arities
{
  SCM meta;
  
  SCM_VALIDATE_PROGRAM (1, program);

  meta = scm_program_meta (program);
  if (scm_is_false (meta))
    return SCM_BOOL_F;

  return scm_caddr (scm_call_0 (meta));
}
#undef FUNC_NAME

SCM
scm_i_program_properties (SCM program)
#define FUNC_NAME "%program-properties"
{
  SCM meta;
  
  SCM_VALIDATE_PROGRAM (1, program);

  meta = scm_program_meta (program);
  if (scm_is_false (meta))
    return SCM_EOL;
  
  return scm_cdddr (scm_call_0 (meta));
}
#undef FUNC_NAME

static SCM
program_source (SCM program, size_t ip, SCM sources)
{
  SCM source = SCM_BOOL_F;

  while (!scm_is_null (sources)
         && scm_to_size_t (scm_caar (sources)) <= ip)
    {
      source = scm_car (sources);
      sources = scm_cdr (sources);
    }
  
  return source; /* (addr . (filename . (line . column))) */
}

SCM_DEFINE (scm_program_source, "program-source", 2, 1, 0,
	    (SCM program, SCM ip, SCM sources),
	    "")
#define FUNC_NAME s_scm_program_source
{
  SCM_VALIDATE_PROGRAM (1, program);
  if (SCM_UNBNDP (sources))
    sources = scm_program_sources (program);
  return program_source (program, scm_to_size_t (ip), sources);
}
#undef FUNC_NAME
    
SCM_DEFINE (scm_program_num_free_variables, "program-num-free-variables", 1, 0, 0,
	    (SCM program),
	    "")
#define FUNC_NAME s_scm_program_num_free_variables
{
  if (SCM_RTL_PROGRAM_P (program)) {
    return scm_from_ulong (SCM_RTL_PROGRAM_NUM_FREE_VARIABLES (program));
  }

  SCM_VALIDATE_PROGRAM (1, program);
  return scm_from_ulong (SCM_PROGRAM_NUM_FREE_VARIABLES (program));
}
#undef FUNC_NAME

SCM_DEFINE (scm_program_free_variable_ref, "program-free-variable-ref", 2, 0, 0,
	    (SCM program, SCM i),
	    "")
#define FUNC_NAME s_scm_program_free_variable_ref
{
  unsigned long idx;

  if (SCM_RTL_PROGRAM_P (program)) {
    SCM_VALIDATE_ULONG_COPY (2, i, idx);
    if (idx >= SCM_RTL_PROGRAM_NUM_FREE_VARIABLES (program))
      SCM_OUT_OF_RANGE (2, i);
    return SCM_RTL_PROGRAM_FREE_VARIABLE_REF (program, idx);
  }

  SCM_VALIDATE_PROGRAM (1, program);
  SCM_VALIDATE_ULONG_COPY (2, i, idx);
  if (idx >= SCM_PROGRAM_NUM_FREE_VARIABLES (program))
    SCM_OUT_OF_RANGE (2, i);
  return SCM_PROGRAM_FREE_VARIABLE_REF (program, idx);
}
#undef FUNC_NAME

SCM_DEFINE (scm_program_free_variable_set_x, "program-free-variable-set!", 3, 0, 0,
	    (SCM program, SCM i, SCM x),
	    "")
#define FUNC_NAME s_scm_program_free_variable_set_x
{
  unsigned long idx;

  if (SCM_RTL_PROGRAM_P (program)) {
    SCM_VALIDATE_ULONG_COPY (2, i, idx);
    if (idx >= SCM_RTL_PROGRAM_NUM_FREE_VARIABLES (program))
      SCM_OUT_OF_RANGE (2, i);
    SCM_RTL_PROGRAM_FREE_VARIABLE_SET (program, idx, x);
    return SCM_UNSPECIFIED;
  }

  SCM_VALIDATE_PROGRAM (1, program);
  SCM_VALIDATE_ULONG_COPY (2, i, idx);
  if (idx >= SCM_PROGRAM_NUM_FREE_VARIABLES (program))
    SCM_OUT_OF_RANGE (2, i);
  SCM_PROGRAM_FREE_VARIABLE_SET (program, idx, x);
  return SCM_UNSPECIFIED;
}
#undef FUNC_NAME

SCM_DEFINE (scm_program_objcode, "program-objcode", 1, 0, 0,
	    (SCM program),
	    "Return a @var{program}'s object code.")
#define FUNC_NAME s_scm_program_objcode
{
  SCM_VALIDATE_PROGRAM (1, program);

  return SCM_PROGRAM_OBJCODE (program);
}
#undef FUNC_NAME

/* procedure-minimum-arity support. */
static void
parse_arity (SCM arity, int *req, int *opt, int *rest)
{
  SCM x = scm_cddr (arity);
  
  if (scm_is_pair (x))
    {
      *req = scm_to_int (scm_car (x));
      x = scm_cdr (x);
      if (scm_is_pair (x))
        {
          *opt = scm_to_int (scm_car (x));
          x = scm_cdr (x);
          if (scm_is_pair (x))
            *rest = scm_is_true (scm_car (x));
          else
            *rest = 0;
        }
      else
        *opt = *rest = 0;
    }
  else
    *req = *opt = *rest = 0;
}
  
static int
scm_i_rtl_program_minimum_arity (SCM program, int *req, int *opt, int *rest)
{
  static SCM rtl_program_minimum_arity = SCM_BOOL_F;
  SCM l;

  if (scm_is_false (rtl_program_minimum_arity) && scm_module_system_booted_p)
    rtl_program_minimum_arity =
        scm_c_private_variable ("system vm program",
                                "rtl-program-minimum-arity");

  l = scm_call_1 (scm_variable_ref (rtl_program_minimum_arity), program);
  if (scm_is_false (l))
    return 0;

  *req = scm_to_int (scm_car (l));
  *opt = scm_to_int (scm_cadr (l));
  *rest = scm_is_true (scm_caddr (l));

  return 1;
}

int
scm_i_program_arity (SCM program, int *req, int *opt, int *rest)
{
  SCM arities;
  
  if (SCM_RTL_PROGRAM_P (program))
    return scm_i_rtl_program_minimum_arity (program, req, opt, rest);

  arities = scm_program_arities (program);
  if (!scm_is_pair (arities))
    return 0;

  parse_arity (scm_car (arities), req, opt, rest);
  arities = scm_cdr (arities);
  
  for (; scm_is_pair (arities); arities = scm_cdr (arities))
    {
      int thisreq, thisopt, thisrest;

      parse_arity (scm_car (arities), &thisreq, &thisopt, &thisrest);

      if (thisreq < *req
          || (thisreq == *req
              && ((thisrest && (!*rest || thisopt > *opt))
                  || (!thisrest && !*rest && thisopt > *opt))))
        {
          *req = thisreq;
          *opt = thisopt;
          *rest = thisrest;
        }
    }

  return 1;
}

\f

void
scm_bootstrap_programs (void)
{
  scm_c_register_extension ("libguile-" SCM_EFFECTIVE_VERSION,
                            "scm_init_programs",
                            (scm_t_extension_init_func)scm_init_programs, NULL);
}

void
scm_init_programs (void)
{
#ifndef SCM_MAGIC_SNARFER
#include "libguile/programs.x"
#endif
}

/*
  Local Variables:
  c-file-style: "gnu"
  End:
*/
Commit	Line	Data
510ca126	1	/* Copyright (C) 2001, 2009, 2010, 2011, 2012, 2013 Free Software Foundation, Inc.
17e90c5e	2	*
560b9c25	3	* This library is free software; you can redistribute it and/or
53befeb7 NJ	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.
17e90c5e	7	*
53befeb7 NJ	8	* This library is distributed in the hope that it will be useful, but
53befeb7 NJ	9	* WITHOUT ANY WARRANTY; without even the implied warranty of
560b9c25 AW	10	* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
560b9c25 AW	11	* Lesser General Public License for more details.
17e90c5e	12	*
560b9c25 AW	13	* You should have received a copy of the GNU Lesser General Public
560b9c25 AW	14	* License along with this library; if not, write to the Free Software
53befeb7 NJ	15	* Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
53befeb7 NJ	16	* 02110-1301 USA
560b9c25	17	*/
17e90c5e	18
13c47753 AW	19	#if HAVE_CONFIG_H
	20	# include <config.h>
	21	#endif
	22
17e90c5e	23	#include <string.h>
560b9c25	24	#include "_scm.h"
17e90c5e	25	#include "instructions.h"
8e367074	26	#include "modules.h"
17e90c5e	27	#include "programs.h"
6f6f0dac LC	28	#include "procprop.h" /* scm_sym_name */
6f6f0dac LC	29	#include "srcprop.h" /* scm_sym_filename */
17e90c5e KN	30	#include "vm.h"
	31
	32	\f
e6fea618	33	static SCM write_program = SCM_BOOL_F;
17e90c5e	34
53e28ed9	35	SCM_DEFINE (scm_make_program, "make-program", 1, 2, 0,
57ab0671	36	(SCM objcode, SCM objtable, SCM free_variables),
53e28ed9 AW	37	"")
53e28ed9 AW	38	#define FUNC_NAME s_scm_make_program
17e90c5e	39	{
53e28ed9 AW	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);
20d47c39	45
6f16379e AW	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	}
17e90c5e KN	69	}
	70	#undef FUNC_NAME
	71
510ca126 AW	72	SCM_DEFINE (scm_make_rtl_program, "make-rtl-program", 1, 2, 0,
	73	(SCM bytevector, SCM byte_offset, SCM free_variables),
	74	"")
	75	#define FUNC_NAME s_scm_make_rtl_program
	76	{
	77	scm_t_uint8 *code;
	78	scm_t_uint32 offset;
	79
	80	if (!scm_is_bytevector (bytevector))
	81	scm_wrong_type_arg (FUNC_NAME, 1, bytevector);
	82	if (SCM_UNBNDP (byte_offset))
	83	offset = 0;
	84	else
	85	{
	86	offset = scm_to_uint32 (byte_offset);
	87	if (offset > SCM_BYTEVECTOR_LENGTH (bytevector))
	88	SCM_OUT_OF_RANGE (2, byte_offset);
	89	}
	90
	91	code = (scm_t_uint8*) SCM_BYTEVECTOR_CONTENTS (bytevector) + offset;
	92	if (((scm_t_uintptr) code) % 4)
	93	SCM_OUT_OF_RANGE (2, byte_offset);
	94
	95	if (SCM_UNBNDP (free_variables) \|\| scm_is_false (free_variables))
	96	return scm_cell (scm_tc7_rtl_program, (scm_t_bits) code);
	97	else
	98	abort ();
	99	}
	100	#undef FUNC_NAME
	101
	102	SCM_DEFINE (scm_rtl_program_code, "rtl-program-code", 1, 0, 0,
	103	(SCM program),
	104	"")
	105	#define FUNC_NAME s_scm_rtl_program_code
	106	{
	107	SCM_VALIDATE_RTL_PROGRAM (1, program);
	108
	109	/* FIXME: we need scm_from_uintptr (). */
	110	return scm_from_size_t ((size_t) SCM_RTL_PROGRAM_CODE (program));
	111	}
	112	#undef FUNC_NAME
	113
e65f80af AW	114	SCM
e65f80af AW	115	scm_i_rtl_program_name (SCM program)
510ca126	116	{
e65f80af AW	117	static SCM rtl_program_name = SCM_BOOL_F;
	118
	119	if (scm_is_false (rtl_program_name) && scm_module_system_booted_p)
	120	rtl_program_name =
	121	scm_c_private_variable ("system vm program", "rtl-program-name");
	122
	123	return scm_call_1 (scm_variable_ref (rtl_program_name), program);
510ca126 AW	124	}
510ca126 AW	125
bf8328ec AW	126	SCM
	127	scm_i_rtl_program_documentation (SCM program)
	128	{
	129	static SCM rtl_program_documentation = SCM_BOOL_F;
	130
	131	if (scm_is_false (rtl_program_documentation) && scm_module_system_booted_p)
	132	rtl_program_documentation =
	133	scm_c_private_variable ("system vm program",
	134	"rtl-program-documentation");
	135
	136	return scm_call_1 (scm_variable_ref (rtl_program_documentation), program);
	137	}
	138
c4c098e3 AW	139	SCM
	140	scm_i_rtl_program_properties (SCM program)
	141	{
	142	static SCM rtl_program_properties = SCM_BOOL_F;
	143
	144	if (scm_is_false (rtl_program_properties) && scm_module_system_booted_p)
	145	rtl_program_properties =
	146	scm_c_private_variable ("system vm program", "rtl-program-properties");
	147
	148	return scm_call_1 (scm_variable_ref (rtl_program_properties), program);
	149	}
	150
2fb924f6 AW	151	void
2fb924f6 AW	152	scm_i_program_print (SCM program, SCM port, scm_print_state *pstate)
e6fea618	153	{
0ba8bb71 AW	154	static int print_error = 0;
0ba8bb71 AW	155
5c8cefe5	156	if (scm_is_false (write_program) && scm_module_system_booted_p)
eb2bc00f AW	157	write_program = scm_c_private_variable ("system vm program",
eb2bc00f AW	158	"write-program");
e6fea618	159
1d1cae0e AW	160	if (SCM_PROGRAM_IS_CONTINUATION (program))
	161	{
	162	/* twingliness */
0607ebbf	163	scm_puts_unlocked ("#<continuation ", port);
76e38162	164	scm_uintprint (SCM_UNPACK (program), 16, port);
0607ebbf	165	scm_putc_unlocked ('>', port);
1d1cae0e	166	}
5c606217	167	else if (SCM_PROGRAM_IS_PARTIAL_CONTINUATION (program))
2150e9a8 AW	168	{
2150e9a8 AW	169	/* twingliness */
0607ebbf	170	scm_puts_unlocked ("#<partial-continuation ", port);
2150e9a8	171	scm_uintprint (SCM_UNPACK (program), 16, port);
0607ebbf	172	scm_putc_unlocked ('>', port);
2150e9a8	173	}
1d1cae0e	174	else if (scm_is_false (write_program) \|\| print_error)
2fb924f6	175	{
e65f80af AW	176	if (SCM_RTL_PROGRAM_P (program))
	177	{
	178	scm_puts_unlocked ("#<rtl-program ", port);
	179	scm_uintprint (SCM_UNPACK (program), 16, port);
	180	scm_putc_unlocked (' ', port);
	181	scm_uintprint ((scm_t_uintptr) SCM_RTL_PROGRAM_CODE (program), 16, port);
	182	scm_putc_unlocked ('>', port);
	183	}
	184	else
	185	{
	186	scm_puts_unlocked ("#<program ", port);
	187	scm_uintprint (SCM_UNPACK (program), 16, port);
	188	scm_putc_unlocked ('>', port);
	189	}
2fb924f6 AW	190	}
	191	else
	192	{
	193	print_error = 1;
	194	scm_call_2 (SCM_VARIABLE_REF (write_program), program, port);
	195	print_error = 0;
	196	}
e6fea618 AW	197	}
e6fea618 AW	198
17e90c5e KN	199	\f
	200	/*
	201	* Scheme interface
	202	*/
	203
	204	SCM_DEFINE (scm_program_p, "program?", 1, 0, 0,
	205	(SCM obj),
	206	"")
	207	#define FUNC_NAME s_scm_program_p
	208	{
5c8cefe5	209	return scm_from_bool (SCM_PROGRAM_P (obj));
17e90c5e KN	210	}
	211	#undef FUNC_NAME
	212
510ca126 AW	213	SCM_DEFINE (scm_rtl_program_p, "rtl-program?", 1, 0, 0,
	214	(SCM obj),
	215	"")
	216	#define FUNC_NAME s_scm_rtl_program_p
	217	{
	218	return scm_from_bool (SCM_RTL_PROGRAM_P (obj));
	219	}
	220	#undef FUNC_NAME
	221
ac99cb0c KN	222	SCM_DEFINE (scm_program_base, "program-base", 1, 0, 0,
	223	(SCM program),
	224	"")
	225	#define FUNC_NAME s_scm_program_base
	226	{
3dbbe28d LC	227	const struct scm_objcode *c_objcode;
3dbbe28d LC	228
ac99cb0c KN	229	SCM_VALIDATE_PROGRAM (1, program);
ac99cb0c KN	230
3dbbe28d	231	c_objcode = SCM_PROGRAM_DATA (program);
3d27ef4b	232	return scm_from_unsigned_integer ((scm_t_bits) SCM_C_OBJCODE_BASE (c_objcode));
ac99cb0c KN	233	}
	234	#undef FUNC_NAME
	235
53e28ed9 AW	236	SCM_DEFINE (scm_program_objects, "program-objects", 1, 0, 0,
	237	(SCM program),
	238	"")
	239	#define FUNC_NAME s_scm_program_objects
	240	{
	241	SCM_VALIDATE_PROGRAM (1, program);
	242	return SCM_PROGRAM_OBJTABLE (program);
	243	}
	244	#undef FUNC_NAME
	245
	246	SCM_DEFINE (scm_program_module, "program-module", 1, 0, 0,
	247	(SCM program),
	248	"")
	249	#define FUNC_NAME s_scm_program_module
	250	{
7884975a	251	SCM objs, mod;
53e28ed9 AW	252	SCM_VALIDATE_PROGRAM (1, program);
53e28ed9 AW	253	objs = SCM_PROGRAM_OBJTABLE (program);
7884975a AW	254	/* If a program is the result of compiling GLIL to assembly, then if
	255	it has an objtable, the first entry will be a module. But some
	256	programs are hand-coded trampolines, like boot programs and
	257	primitives and the like. So if a program happens to have a
	258	non-module in the first slot of the objtable, assume that it is
	259	such a trampoline, and just return #f for the module. */
	260	mod = scm_is_true (objs) ? scm_c_vector_ref (objs, 0) : SCM_BOOL_F;
	261	return SCM_MODULEP (mod) ? mod : SCM_BOOL_F;
53e28ed9 AW	262	}
	263	#undef FUNC_NAME
	264
ac99cb0c KN	265	SCM_DEFINE (scm_program_meta, "program-meta", 1, 0, 0,
	266	(SCM program),
	267	"")
	268	#define FUNC_NAME s_scm_program_meta
17e90c5e	269	{
ac47d5f6 AW	270	SCM metaobj;
ac47d5f6 AW	271
17e90c5e	272	SCM_VALIDATE_PROGRAM (1, program);
ac47d5f6 AW	273
	274	metaobj = scm_objcode_meta (SCM_PROGRAM_OBJCODE (program));
	275	if (scm_is_true (metaobj))
31a26df2 AW	276	return scm_make_program (metaobj, SCM_PROGRAM_OBJTABLE (program),
31a26df2 AW	277	SCM_BOOL_F);
ac47d5f6 AW	278	else
ac47d5f6 AW	279	return SCM_BOOL_F;
17e90c5e KN	280	}
	281	#undef FUNC_NAME
	282
e311f5fa AW	283	SCM_DEFINE (scm_program_bindings, "program-bindings", 1, 0, 0,
	284	(SCM program),
	285	"")
	286	#define FUNC_NAME s_scm_program_bindings
9a9f6487	287	{
e311f5fa AW	288	SCM meta;
	289
	290	SCM_VALIDATE_PROGRAM (1, program);
9a9f6487	291
53e28ed9	292	meta = scm_program_meta (program);
2fda0242	293	if (scm_is_false (meta))
9a9f6487	294	return SCM_BOOL_F;
e311f5fa AW	295
	296	return scm_car (scm_call_0 (meta));
	297	}
	298	#undef FUNC_NAME
	299
	300	SCM_DEFINE (scm_program_sources, "program-sources", 1, 0, 0,
	301	(SCM program),
	302	"")
	303	#define FUNC_NAME s_scm_program_sources
	304	{
028e3d06	305	SCM meta, sources, ret, filename;
e311f5fa AW	306
	307	SCM_VALIDATE_PROGRAM (1, program);
	308
	309	meta = scm_program_meta (program);
9a9f6487	310	if (scm_is_false (meta))
e311f5fa AW	311	return SCM_EOL;
e311f5fa AW	312
028e3d06 AW	313	filename = SCM_BOOL_F;
	314	ret = SCM_EOL;
	315	for (sources = scm_cadr (scm_call_0 (meta)); !scm_is_null (sources);
	316	sources = scm_cdr (sources))
	317	{
	318	SCM x = scm_car (sources);
	319	if (scm_is_pair (x))
	320	{
	321	if (scm_is_number (scm_car (x)))
	322	{
	323	SCM addr = scm_car (x);
	324	ret = scm_acons (addr, scm_cons (filename, scm_cdr (x)),
	325	ret);
	326	}
	327	else if (scm_is_eq (scm_car (x), scm_sym_filename))
	328	filename = scm_cdr (x);
	329	}
	330	}
	331	return scm_reverse_x (ret, SCM_UNDEFINED);
e311f5fa AW	332	}
	333	#undef FUNC_NAME
	334
6c6a4439 AW	335	SCM_DEFINE (scm_program_arities, "program-arities", 1, 0, 0,
	336	(SCM program),
	337	"")
	338	#define FUNC_NAME s_scm_program_arities
	339	{
	340	SCM meta;
	341
	342	SCM_VALIDATE_PROGRAM (1, program);
	343
	344	meta = scm_program_meta (program);
	345	if (scm_is_false (meta))
	346	return SCM_BOOL_F;
	347
	348	return scm_caddr (scm_call_0 (meta));
	349	}
	350	#undef FUNC_NAME
	351
07e424b7 AW	352	SCM
	353	scm_i_program_properties (SCM program)
	354	#define FUNC_NAME "%program-properties"
e311f5fa AW	355	{
	356	SCM meta;
	357
	358	SCM_VALIDATE_PROGRAM (1, program);
	359
	360	meta = scm_program_meta (program);
	361	if (scm_is_false (meta))
	362	return SCM_EOL;
	363
6c6a4439	364	return scm_cdddr (scm_call_0 (meta));
e311f5fa AW	365	}
	366	#undef FUNC_NAME
	367
b262b74b AW	368	static SCM
	369	program_source (SCM program, size_t ip, SCM sources)
	370	{
	371	SCM source = SCM_BOOL_F;
	372
	373	while (!scm_is_null (sources)
	374	&& scm_to_size_t (scm_caar (sources)) <= ip)
	375	{
	376	source = scm_car (sources);
	377	sources = scm_cdr (sources);
	378	}
	379
	380	return source; /* (addr . (filename . (line . column))) */
	381	}
	382
	383	SCM_DEFINE (scm_program_source, "program-source", 2, 1, 0,
	384	(SCM program, SCM ip, SCM sources),
028e3d06 AW	385	"")
	386	#define FUNC_NAME s_scm_program_source
	387	{
	388	SCM_VALIDATE_PROGRAM (1, program);
b262b74b AW	389	if (SCM_UNBNDP (sources))
	390	sources = scm_program_sources (program);
	391	return program_source (program, scm_to_size_t (ip), sources);
028e3d06 AW	392	}
	393	#undef FUNC_NAME
	394
6f16379e	395	SCM_DEFINE (scm_program_num_free_variables, "program-num-free-variables", 1, 0, 0,
17e90c5e KN	396	(SCM program),
17e90c5e KN	397	"")
6f16379e AW	398	#define FUNC_NAME s_scm_program_num_free_variables
6f16379e AW	399	{
ee0a2b51 AW	400	if (SCM_RTL_PROGRAM_P (program)) {
	401	return scm_from_ulong (SCM_RTL_PROGRAM_NUM_FREE_VARIABLES (program));
	402	}
	403
6f16379e AW	404	SCM_VALIDATE_PROGRAM (1, program);
	405	return scm_from_ulong (SCM_PROGRAM_NUM_FREE_VARIABLES (program));
	406	}
	407	#undef FUNC_NAME
	408
	409	SCM_DEFINE (scm_program_free_variable_ref, "program-free-variable-ref", 2, 0, 0,
	410	(SCM program, SCM i),
	411	"")
	412	#define FUNC_NAME s_scm_program_free_variable_ref
	413	{
	414	unsigned long idx;
ee0a2b51 AW	415
	416	if (SCM_RTL_PROGRAM_P (program)) {
	417	SCM_VALIDATE_ULONG_COPY (2, i, idx);
	418	if (idx >= SCM_RTL_PROGRAM_NUM_FREE_VARIABLES (program))
	419	SCM_OUT_OF_RANGE (2, i);
	420	return SCM_RTL_PROGRAM_FREE_VARIABLE_REF (program, idx);
	421	}
	422
6f16379e AW	423	SCM_VALIDATE_PROGRAM (1, program);
	424	SCM_VALIDATE_ULONG_COPY (2, i, idx);
	425	if (idx >= SCM_PROGRAM_NUM_FREE_VARIABLES (program))
	426	SCM_OUT_OF_RANGE (2, i);
	427	return SCM_PROGRAM_FREE_VARIABLE_REF (program, idx);
	428	}
	429	#undef FUNC_NAME
	430
	431	SCM_DEFINE (scm_program_free_variable_set_x, "program-free-variable-set!", 3, 0, 0,
	432	(SCM program, SCM i, SCM x),
	433	"")
	434	#define FUNC_NAME s_scm_program_free_variable_set_x
62082959	435	{
6f16379e	436	unsigned long idx;
ee0a2b51 AW	437
	438	if (SCM_RTL_PROGRAM_P (program)) {
	439	SCM_VALIDATE_ULONG_COPY (2, i, idx);
	440	if (idx >= SCM_RTL_PROGRAM_NUM_FREE_VARIABLES (program))
	441	SCM_OUT_OF_RANGE (2, i);
	442	SCM_RTL_PROGRAM_FREE_VARIABLE_SET (program, idx, x);
	443	return SCM_UNSPECIFIED;
	444	}
	445
62082959	446	SCM_VALIDATE_PROGRAM (1, program);
6f16379e AW	447	SCM_VALIDATE_ULONG_COPY (2, i, idx);
	448	if (idx >= SCM_PROGRAM_NUM_FREE_VARIABLES (program))
	449	SCM_OUT_OF_RANGE (2, i);
	450	SCM_PROGRAM_FREE_VARIABLE_SET (program, idx, x);
	451	return SCM_UNSPECIFIED;
62082959 LC	452	}
	453	#undef FUNC_NAME
	454
53e28ed9	455	SCM_DEFINE (scm_program_objcode, "program-objcode", 1, 0, 0,
17e90c5e	456	(SCM program),
53e28ed9 AW	457	"Return a @var{program}'s object code.")
53e28ed9 AW	458	#define FUNC_NAME s_scm_program_objcode
17e90c5e KN	459	{
17e90c5e KN	460	SCM_VALIDATE_PROGRAM (1, program);
fa19602c	461
53e28ed9	462	return SCM_PROGRAM_OBJCODE (program);
17e90c5e KN	463	}
	464	#undef FUNC_NAME
	465
cb2ce548 AW	466	/* procedure-minimum-arity support. */
	467	static void
	468	parse_arity (SCM arity, int req, int opt, int *rest)
56164a5a	469	{
cb2ce548	470	SCM x = scm_cddr (arity);
56164a5a	471
56164a5a AW	472	if (scm_is_pair (x))
	473	{
	474	*req = scm_to_int (scm_car (x));
	475	x = scm_cdr (x);
	476	if (scm_is_pair (x))
	477	{
	478	*opt = scm_to_int (scm_car (x));
	479	x = scm_cdr (x);
	480	if (scm_is_pair (x))
	481	*rest = scm_is_true (scm_car (x));
	482	else
	483	*rest = 0;
	484	}
	485	else
	486	opt = rest = 0;
	487	}
	488	else
	489	req = opt = *rest = 0;
cb2ce548 AW	490	}
cb2ce548 AW	491
eb2bc00f AW	492	static int
	493	scm_i_rtl_program_minimum_arity (SCM program, int req, int opt, int *rest)
	494	{
	495	static SCM rtl_program_minimum_arity = SCM_BOOL_F;
	496	SCM l;
	497
	498	if (scm_is_false (rtl_program_minimum_arity) && scm_module_system_booted_p)
	499	rtl_program_minimum_arity =
081cf910	500	scm_c_private_variable ("system vm program",
eb2bc00f AW	501	"rtl-program-minimum-arity");
	502
	503	l = scm_call_1 (scm_variable_ref (rtl_program_minimum_arity), program);
	504	if (scm_is_false (l))
	505	return 0;
	506
	507	*req = scm_to_int (scm_car (l));
	508	*opt = scm_to_int (scm_cadr (l));
	509	*rest = scm_is_true (scm_caddr (l));
	510
	511	return 1;
	512	}
	513
cb2ce548 AW	514	int
	515	scm_i_program_arity (SCM program, int req, int opt, int *rest)
	516	{
	517	SCM arities;
	518
eb2bc00f AW	519	if (SCM_RTL_PROGRAM_P (program))
	520	return scm_i_rtl_program_minimum_arity (program, req, opt, rest);
	521
cb2ce548 AW	522	arities = scm_program_arities (program);
	523	if (!scm_is_pair (arities))
	524	return 0;
	525
	526	parse_arity (scm_car (arities), req, opt, rest);
	527	arities = scm_cdr (arities);
	528
	529	for (; scm_is_pair (arities); arities = scm_cdr (arities))
	530	{
	531	int thisreq, thisopt, thisrest;
	532
	533	parse_arity (scm_car (arities), &thisreq, &thisopt, &thisrest);
	534
	535	if (thisreq < *req
	536	\|\| (thisreq == *req
	537	&& ((thisrest && (!rest \|\| thisopt > opt))
	538	\|\| (!thisrest && !rest && thisopt > opt))))
	539	{
	540	*req = thisreq;
	541	*opt = thisopt;
	542	*rest = thisrest;
	543	}
	544	}
	545
56164a5a AW	546	return 1;
56164a5a AW	547	}
fa19602c	548
17e90c5e	549	\f
56164a5a	550
17e90c5e	551	void
07e56b27	552	scm_bootstrap_programs (void)
17e90c5e	553	{
44602b08 AW	554	scm_c_register_extension ("libguile-" SCM_EFFECTIVE_VERSION,
44602b08 AW	555	"scm_init_programs",
60ae5ca2	556	(scm_t_extension_init_func)scm_init_programs, NULL);
07e56b27	557	}
17e90c5e	558
07e56b27 AW	559	void
	560	scm_init_programs (void)
	561	{
17e90c5e	562	#ifndef SCM_MAGIC_SNARFER
aeeff258	563	#include "libguile/programs.x"
17e90c5e KN	564	#endif
	565	}
	566
	567	/*
	568	Local Variables:
	569	c-file-style: "gnu"
	570	End:
	571	*/