diff options
author | Andy Wingo <wingo@pobox.com> | 2013-05-16 23:38:29 +0200 |
---|---|---|
committer | Andy Wingo <wingo@pobox.com> | 2013-06-09 23:59:01 +0200 |
commit | bf8328ec16cbe76b7af9703bb41e964865034561 (patch) | |
tree | 53957dcaa2955689353c2cab6c8435b190fb1978 /libguile/procprop.c | |
parent | 9128b1a19fe89de1aacafe5ccffd06e193f531bc (diff) | |
download | guile-bf8328ec16cbe76b7af9703bb41e964865034561.tar.gz |
procedure-documentation works on RTL procedures
* libguile/procprop.h:
* libguile/procprop.c (scm_procedure_documentation): Move here from
procs.c, and to make the logic more similar to that of procedure-name,
which allows RTL programs to dispatch to rtl-program-documentation.
* libguile/programs.c (scm_i_rtl_program_documentation):
* libguile/programs.h:
* module/system/vm/program.scm (rtl-program-documentation): New
plumbing.
* module/system/vm/debug.scm (find-program-docstring): New interface to
grovel ELF for a docstring.
Diffstat (limited to 'libguile/procprop.c')
-rw-r--r-- | libguile/procprop.c | 33 |
1 files changed, 33 insertions, 0 deletions
diff --git a/libguile/procprop.c b/libguile/procprop.c index 62476c037..d7ce09b95 100644 --- a/libguile/procprop.c +++ b/libguile/procprop.c @@ -238,6 +238,39 @@ SCM_DEFINE (scm_procedure_name, "procedure-name", 1, 0, 0, #undef FUNC_NAME +SCM_GLOBAL_SYMBOL (scm_sym_documentation, "documentation"); + +SCM_DEFINE (scm_procedure_documentation, "procedure-documentation", 1, 0, 0, + (SCM proc), + "Return the documentation string associated with @code{proc}. By\n" + "convention, if a procedure contains more than one expression and the\n" + "first expression is a string constant, that string is assumed to contain\n" + "documentation for that procedure.") +#define FUNC_NAME s_scm_procedure_documentation +{ + SCM props, ret; + + SCM_VALIDATE_PROC (1, proc); + + while (SCM_STRUCTP (proc) && SCM_STRUCT_APPLICABLE_P (proc)) + proc = SCM_STRUCT_PROCEDURE (proc); + + props = scm_weak_table_refq (overrides, proc, SCM_BOOL_F); + + if (scm_is_pair (props)) + ret = scm_assq_ref (props, scm_sym_documentation); + else if (SCM_RTL_PROGRAM_P (proc)) + ret = scm_i_rtl_program_documentation (proc); + else if (SCM_PROGRAM_P (proc)) + ret = scm_assq_ref (scm_i_program_properties (proc), scm_sym_documentation); + else + ret = SCM_BOOL_F; + + return ret; +} +#undef FUNC_NAME + + SCM_DEFINE (scm_procedure_source, "procedure-source", 1, 0, 0, (SCM proc), "Return the source of the procedure @var{proc}.") |