You are looking at historical revision 17639 of this page. It may differ significantly from its current revision.

apropos

Documentation

An apropos facility for Chicken Scheme.

Apropos API

apropos

[procedure] (apropos PATTERN [ENVIRONMENT] [#:macros? MACROS?] [#:qualified? QUALIFIED?] [#:sort SORT])

Displays information about identifiers matching PATTERN in the ENVIRONMENT and, optionally, a MACRO-ENVIRONMENT.

PATTERN
A symbol, string or regexp. When symbol or string substring matching is performed.
ENVIRONMENT
An environment. The default is the (interaction-environment).
MACROS?
Either #t to include macros, or #f to skip them. Default is #f.
QUALIFIED?
Either #t to include qualified identifiers or #f to skip them. Default is #f.
SORT
Either #:name for an identifier sort, or #:kind for a kind+indentifier sort, or #f for unsorted. The default is #:kind.

apropos-list

[procedure] (apropos-list PATTERN [ENVIRONMENT] [#:macros? MACROS?] [#:qualified? QUALIFIED?])

Like apropos but returns a list of matching identifiers.

apropos-information-list

[procedure] (apropos-information-list PATTERN [ENVIRONMENT] [#:macros? MACROS?] [#:qualified? QUALIFIED?] [#:sort? SORT?])

Like apropos but returns an association list keyed by symbol. The associated information is either 'macro, 'keyword, 'variable, 'procedure, '(procedure . <lambda-list-specification>) or '(procedure . <core procedure name>).

Interpreter Usage

A toplevel command is added when the `apropos' extension is loaded by `csi': `,a'. Command help is available.

Usage

 
(require-extension apropos)

or

(require-library apropos)
(import apropos)

Examples

 
> (apropos 'print)
flonum-print-precision  procedure tmp12341235
fprintf                 procedure (port827 fstr828 . args829)
pretty-print            procedure (obj756 . opt757)
pretty-print-width      procedure arg2153
print                   procedure args3042
print*                  procedure args3070
print-call-chain        procedure tmp38423843
print-error-message     procedure (ex4749 . args4750)
printf                  procedure (fstr831 . args832)
sprintf                 procedure (fstr834 . args835)
char-set:printing       variable

> (apropos-list 'print)
(char-set:printing print flonum-print-precision pretty-print pretty-print-width sprintf printf print* print-error-message print-call-chain fprintf)

> (apropos 'print #:qualified? #t)
printer:                       keyword
flonum-print-precision         procedure tmp12341235
fprintf                        procedure (port827 fstr828 . args829)
pretty-print                   procedure (obj756 . opt757)
pretty-print-width             procedure arg2153
print                          procedure args3042
print*                         procedure args3070
print-call-chain               procedure tmp38423843
print-error-message            procedure (ex4749 . args4750)
printf                         procedure (fstr831 . args832)
sprintf                        procedure (fstr834 . args835)
##sys#print-to-string          procedure (xs3578)
##csi#print-usage              procedure
##csi#print-banner             procedure
##sys#register-record-printer  procedure (type3374 proc3375)
##sys#with-print-length-limit  procedure (limit3404 thunk3405)
##sys#user-print-hook          procedure (x3379 readable3380 port3381)
##sys#repl-print-hook          procedure (x2525 port2526)
##sys#print                    procedure (x3102 readable3103 port3104)
##sys#really-print-call-chain  procedure (port3802 chain3803 header3804)
char-set:printing              variable
##sys#record-printers          variable
##sys#repl-print-length-limit  variable

Notes

Requirements

regex lolevel

Bugs and Limitations

Author

kon lovett

Version history
1.1.0
Needs "check-errors" extension.
1.0.0
Chicken 4 release.

License

Copyright (C) 2009 Kon Lovett. All rights reserved.

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the Software), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED ASIS, WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.