source: project/wiki/eggref/4/apropos @ 13739

Last change on this file since 13739 was 13739, checked in by Kon Lovett, 11 years ago

Chgd sort. Rmvd 1st class env routines.

File size: 2.8 KB
Line 
1[[tags: egg]]
2
3== apropos
4
5[[toc:]]
6
7
8== Documentation
9
10An ''apropos'' facility for Chicken Scheme.
11
12==== apropos
13
14<procedure>(apropos PATTERN [ENVIRONMENT] [#:macros? MACROS?] [#:qualified? QUALIFIED?] [#:sort SORT])</procedure>
15
16Displays information about identifiers matching {{PATTERN}} in the
17{{ENVIRONMENT}} and, optionally, a {{MACRO-ENVIRONMENT}}.
18
19; {{PATTERN}} : A {{symbol}}, {{string}} or {{regexp}}. When symbol or string substring matching is performed.
20; {{ENVIRONMENT}} : An environment. When missing the {{(interaction-environment)}} is assumed.
21; {{MACROS?}} : A boolean. Include macros?
22; {{QUALIFIED?}} : A boolean. Include qualified identifiers?
23; {{SORT}} : Either {{#:name}} or {{#:kind}}.
24
25==== apropos-list
26
27<procedure>(apropos-list PATTERN [ENVIRONMENT] [#:macros? MACROS?] [#:qualified? QUALIFIED?])</procedure>
28
29Like {{apropos}} but returns a list of matching identifiers.
30
31==== apropos-information-list
32
33<procedure>(apropos-information-list PATTERN [ENVIRONMENT] [#:macros? MACROS?] [#:qualified? QUALIFIED?] [#:sort? SORT?])</procedure>
34
35Like {{apropos}} but returns an association list keyed by symbol. The
36associated information is either {{'macro}}, {{'keyword}}, {{'variable}},
37{{'procedure}}, {{'(procedure . <lambda-list-specification>)}} or
38{{'(procedure . <core procedure name>)}}.
39
40
41== Usage
42
43<enscript language=scheme>
44(require-library apropos)
45(import apropos)
46</enscript>
47
48or
49
50<enscript language=scheme>
51(require-extension apropos)
52(import apropos)
53</enscript>
54
55
56== Examples
57
58
59== Notes
60
61
62== Requirements
63
64[[Unit regex|regex]]
65[[Unit lolevel|lolevel]]
66
67== Bugs and Limitations
68
69* Doesn't show something similar to procedure-information for macros.
70
71
72== Author
73
74[[kon lovett]]
75
76
77== Version history
78
79; 1.0.0 : Chicken 4 release.
80
81
82== License
83
84Copyright (C) 2009 Kon Lovett.  All rights reserved.
85
86Permission is hereby granted, free of charge, to any person obtaining a
87copy of this software and associated documentation files (the Software),
88to deal in the Software without restriction, including without limitation
89the rights to use, copy, modify, merge, publish, distribute, sublicense,
90and/or sell copies of the Software, and to permit persons to whom the
91Software is furnished to do so, subject to the following conditions:
92
93The above copyright notice and this permission notice shall be included
94in all copies or substantial portions of the Software.
95
96THE SOFTWARE IS PROVIDED ASIS, WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
97IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
98FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL
99THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR
100OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE,
101ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
102OTHER DEALINGS IN THE SOFTWARE.
Note: See TracBrowser for help on using the repository browser.