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

apropos

Documentation

An apropos facility for Chicken Scheme.

apropos

[procedure] (apropos PATTERN [ENVIRONMENT] [#:MACROS?])

Displays information about symbols 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. When missing the (interaction-environment) is assumed.
#:MACROS?
A boolean. Include macros?

apropos-list

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

Like apropos but returns a list of matching symbols.

apropos-information-list

[procedure] (apropos-information-list PATTERN [ENVIRONMENT] [#:MACROS?])

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

apropos/environment

[procedure] (apropos/environment PATTERN ENVIRONMENT)

Displays information about symbols matching PATTERN in the ENVIRONMENT.

PATTERN
A symbol, string or regexp. When symbol or string substring matching is performed.
ENVIRONMENT
An environment or a syntactic-environment.

apropos-list/environment

[procedure] (apropos-list/environment PATTERN ENVIRONMENT)

Like apropos/environment but returns a list of matching symbols.

apropos-information-list/environment

[procedure] (apropos-information-list/environment PATTERN ENVIRONMENT)

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

apropos/environments

[procedure] (apropos/environments PATTERN ENVIRONMENT...)

Displays information about symbols matching PATTERN in each ENVIRONMENT.

PATTERN
A symbol, string or regexp. When symbol or string substring matching is performed.
ENVIRONMENT
An environment or a syntactic-environment.

apropos-list/environments

[procedure] (apropos-list/environments PATTERN ENVIRONMENT...)

Like apropos/environments but returns a list of matching symbols.

apropos-information-list/environments

[procedure] (apropos-information-list/environments PATTERN ENVIRONMENT...)

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

Usage

(require-library apropos)
(import apropos)

or

(require-extension apropos)
(import apropos)

Examples

Notes

Requirements

regex lolevel

Bugs and Limitations

Author

kon lovett

Version history

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.