Next: , Previous: scheme kwargs, Up: Top


21 (scheme session)

21.1 Overview

The same thing as guile 1.6's (ice-9 session), except with hooks that introduce extensibility to the help macro. The added functions are add-value-help-handler! and remove-value-help-handler!.

21.2 Usage

— Special Form: help

(help [NAME]) Prints useful information. Try `(help)'.

— Special Form: system-module

— Function: add-name-help-handler! proc

Adds a handler for performing `help' on a name.

`proc' will be called with the unevaluated name as its argument. That is to say, when the user calls `(help FOO)', the name is FOO, exactly as the user types it.

The return value of `proc' is as specified in `add-value-help-handler!'.

— Function: add-value-help-handler! proc

Adds a handler for performing `help' on a value.

`proc' will be called as (PROC NAME VALUE). `proc' should return #t to indicate that it has performed help, a string to override the default object documentation, or #f to try the other handlers, potentially falling back on the normal behavior for `help'.

— Function: apropos rgx . options

Search for bindings: apropos regexp {options= 'full 'shadow 'value}

— Function: apropos-fold proc init rgx folder
      
     Folds PROCEDURE over bindings matching third arg REGEXP.
     
     Result is
     
       (PROCEDURE MODULE1 NAME1 VALUE1
         (PROCEDURE MODULE2 NAME2 VALUE2
           ...
           (PROCEDURE MODULEn NAMEn VALUEn INIT)))
     
     where INIT is the second arg to `apropos-fold'.
     
     Fourth arg FOLDER is one of
     
       (apropos-fold-accessible MODULE) ;fold over bindings accessible in MODULE
       apropos-fold-exported		   ;fold over all exported bindings
       apropos-fold-all		   ;fold over all bindings

— Function: apropos-fold-accessible module

— Function: apropos-fold-all fold-module init

— Function: apropos-fold-exported fold-module init

— Function: apropos-internal rgx

Return a list of accessible variable names.

— Function: arity obj

— Function: module-commentary name

— Function: remove-name-help-handler! proc

Removes a handler for performing `help' on a name.

See the documentation for `add-name-help-handler' for more information.

— Function: remove-value-help-handler! proc

Removes a handler for performing `help' on a value.

See the documentation for `add-value-help-handler' for more information.

— Function: source obj