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

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

New apropos egg

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