You are looking at historical revision 13747 of this page. It may differ significantly from its current revision.
An apropos facility for Chicken Scheme.
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.
- A symbol, string or regexp. When symbol or string substring matching is performed.
- An environment. The default is the (interaction-environment).
- Either #t to include macros, or #f to skip them. Default is #f.
- Either #t to include qualified identifiers or #f to skip them. Default is #f.
- 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>).
A toplevel command is added when the `apropos' extension is loaded by `csi': `,a'. Command help is available.
(require-library apropos) (import apropos)
(require-extension apropos) (import apropos)
Bugs and Limitations
- Doesn't show something similar to procedure-information for macros.
- Chicken 4 release.
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.