[bpt/guile.git] / srfi / README

This directory includes most of Guile's SRFI support.       -*- text -*-

For more details about what SRFI means, and what the various numbers
stand for, please refer to the SRFI homepage at

  http://srfi.schemers.org

SRFI-0: cond-expand

  Supported by default, no module required.

SRFI-1: List Library

  A full toolbox of list processing procedures.  (use-modules (srfi
  srfi-1)) will make them available for use.

SRFI-2: and-let*

  (use-modules (srfi srfi-2)) to make and-let* available.

SRFI-4: Homogeneous numeric vector datatypes

SRFI-6: open-input-string, open-output-string and get-output-string

  (use-modules (srfi srfi-6)) to make these available. (Currently,
  these procedures are available without using the module, but the
  procedures might be factored out of the core library in the
  future.)

SRFI-8: receive

  (use-modules (srfi srfi-8)) to make receive available.

SRFI-9: define-record-type

  A mechanism for defining record types.  (use-modules (srfi srfi-9))
  makes this syntactic form available.

SRFI-10: #,()

  The hash-comma reader extension.  (use-modules (srfi srfi-10))
  activates the extension.

SRFI-11: let-values and let-values*

  Syntactic extensions for handling multiple values.  (use-modules
  (srfi srfi-11)) makes these syntactic forms available.

SRFI-13: string library

  A lot of (more or less) useful string processing procedures.
  (use-modules (srfi srfi-13)) loads the procedures.

SRFI-14: character-set library

  Character-set library.  (use-modules (srfi srfi-14)) loads the
  procedures and standard variables.

SRFI-16: case-lambda

  Syntactic form which permits writing functions acting different
  according to the number of arguments passed.  (use-modules (srfi
  srfi-16)) makes this syntactic form available.

SRFI-17: Generalized set!

  Guile supports generalized set! by default, but this module makes it
  fully compliant to the SRFI.  (use-modules (srfi srfi-17)) loads the
  procedures.

SRFI-19: Time Data Types and Procedures

  A lot of data types and procedures for dealing with times and
  dates.  (use-modules (srfi srfi-19)) loads the procedures.

SRFI-23: Error reporting mechanism

  Guile fully supports this SRFI.  No need to load any module.

SRFI-26: Notation for Specializing Parameters without Currying

  Exports: cut, cute.

SRFI-31: A special form for recursive evaluation

  Exports: rec.

SRFI-34: Exception Handling for Programs

  Exports: with-exception-handler, raise.
  Exports syntax: guard.

SRFI-39: Parameter objects

  Exports: make-parameter, with-parameters*.
  Exports syntax: parameterize.

SRFI-55: require-extension

  Supported by default, no module required.
Commit	Line	Data
1b2f40b9 MG	1	This directory includes most of Guile's SRFI support. -- text --
	2
	3	For more details about what SRFI means, and what the various numbers
	4	stand for, please refer to the SRFI homepage at
	5
	6	http://srfi.schemers.org
	7
1b2f40b9 MG	8	SRFI-0: cond-expand
1b2f40b9 MG	9
f7fb2f39	10	Supported by default, no module required.
1b2f40b9	11
e9680547 MG	12	SRFI-1: List Library
	13
	14	A full toolbox of list processing procedures. (use-modules (srfi
	15	srfi-1)) will make them available for use.
	16
1b2f40b9 MG	17	SRFI-2: and-let*
	18
	19	(use-modules (srfi srfi-2)) to make and-let* available.
	20
e1ea3bf9 MD	21	SRFI-4: Homogeneous numeric vector datatypes
e1ea3bf9 MD	22
1b2f40b9 MG	23	SRFI-6: open-input-string, open-output-string and get-output-string
	24
	25	(use-modules (srfi srfi-6)) to make these available. (Currently,
	26	these procedures are available without using the module, but the
	27	procedures might be factored out of the core library in the
	28	future.)
	29
	30	SRFI-8: receive
	31
	32	(use-modules (srfi srfi-8)) to make receive available.
	33
	34	SRFI-9: define-record-type
	35
	36	A mechanism for defining record types. (use-modules (srfi srfi-9))
	37	makes this syntactic form available.
	38
	39	SRFI-10: #,()
	40
	41	The hash-comma reader extension. (use-modules (srfi srfi-10))
	42	activates the extension.
	43
	44	SRFI-11: let-values and let-values*
	45
	46	Syntactic extensions for handling multiple values. (use-modules
	47	(srfi srfi-11)) makes these syntactic forms available.
	48
	49	SRFI-13: string library
	50
	51	A lot of (more or less) useful string processing procedures.
	52	(use-modules (srfi srfi-13)) loads the procedures.
	53
	54	SRFI-14: character-set library
	55
	56	Character-set library. (use-modules (srfi srfi-14)) loads the
	57	procedures and standard variables.
	58
	59	SRFI-16: case-lambda
	60
	61	Syntactic form which permits writing functions acting different
	62	according to the number of arguments passed. (use-modules (srfi
	63	srfi-16)) makes this syntactic form available.
	64
	65	SRFI-17: Generalized set!
	66
	67	Guile supports generalized set! by default, but this module makes it
	68	fully compliant to the SRFI. (use-modules (srfi srfi-17)) loads the
	69	procedures.
	70
	71	SRFI-19: Time Data Types and Procedures
	72
	73	A lot of data types and procedures for dealing with times and
	74	dates. (use-modules (srfi srfi-19)) loads the procedures.
	75
ee85583a	76	SRFI-23: Error reporting mechanism
1b2f40b9	77
ee85583a	78	Guile fully supports this SRFI. No need to load any module.
e1ea3bf9 MD	79
	80	SRFI-26: Notation for Specializing Parameters without Currying
	81
	82	Exports: cut, cute.
	83
	84	SRFI-31: A special form for recursive evaluation
	85
	86	Exports: rec.
	87
	88	SRFI-34: Exception Handling for Programs
	89
	90	Exports: with-exception-handler, raise.
	91	Exports syntax: guard.
	92
	93	SRFI-39: Parameter objects
	94
	95	Exports: make-parameter, with-parameters*.
	96	Exports syntax: parameterize.
f7fb2f39 RB	97
	98	SRFI-55: require-extension
	99
	100	Supported by default, no module required.