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

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

Added more routines.

File size: 4.2 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?])</procedure>
15
16Displays information about symbols 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
23==== apropos-list
24
25<procedure>(apropos-list 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 PATTERN [ENVIRONMENT] [#:MACROS?])</procedure>
32
33Like {{apropos}} but returns an association list keyed by symbol. The
34associated information is either {{'macro}}, {{'keyword}}, {{'identifier}},
35{{'procedure}} or {{'(procedure . <lambda-list-specification>)}}
36
37==== apropos/environment
38
39<procedure>(apropos/environment PATTERN ENVIRONMENT)</procedure>
40
41Displays information about symbols matching {{PATTERN}} in the
42{{ENVIRONMENT}}.
43
44; {{PATTERN}} : A {{symbol}}, {{string}} or {{regexp}}. When symbol or string substring matching is performed.
45; {{ENVIRONMENT}} : An {{environment}} or a {{syntactic-environment}}.
46
47==== apropos-list/environment
48
49<procedure>(apropos-list/environment PATTERN ENVIRONMENT)</procedure>
50
51Like {{apropos/environment}} but returns a list of matching symbols.
52
53==== apropos-information-list/environment
54
55<procedure>(apropos-information-list/environment PATTERN ENVIRONMENT)</procedure>
56
57Like {{apropos/environment}} but returns an association list keyed by symbol. The
58associated information is either {{'macro}}, {{'keyword}}, {{'identifier}},
59{{'procedure}} or {{'(procedure . <lambda-list-specification>)}}
60
61==== apropos/environments
62
63<procedure>(apropos/environments PATTERN ENVIRONMENT...)</procedure>
64
65Displays information about symbols matching {{PATTERN}} in each
66{{ENVIRONMENT}}.
67
68; {{PATTERN}} : A {{symbol}}, {{string}} or {{regexp}}. When symbol or string substring matching is performed.
69; {{ENVIRONMENT}} : An {{environment}} or a {{syntactic-environment}}.
70
71==== apropos-list/environments
72
73<procedure>(apropos-list/environments PATTERN ENVIRONMENT...)</procedure>
74
75Like {{apropos/environments}} but returns a list of matching symbols.
76
77==== apropos-information-list/environments
78
79<procedure>(apropos-information-list/environments PATTERN ENVIRONMENT...)</procedure>
80
81Like {{apropos/environments}} but returns an association list keyed by symbol. The
82associated information is either {{'macro}}, {{'keyword}}, {{'identifier}},
83{{'procedure}} or {{'(procedure . <lambda-list-specification>)}}
84
85
86== Usage
87
88<enscript language=scheme>
89(require-library apropos)
90(import apropos)
91</enscript>
92
93or
94
95<enscript language=scheme>
96(require-extension apropos)
97(import apropos)
98</enscript>
99
100
101== Examples
102
103
104== Notes
105
106
107== Requirements
108
109[[Unit regex|regex]]
110[[Unit lolevel|lolevel]]
111
112== Bugs and Limitations
113
114* Doesn't show something similar to procedure-information for macros.
115
116
117== Author
118
119[[kon lovett]]
120
121
122== Version history
123
124; 1.0.0 : Chicken 4 release.
125
126
127== License
128
129Copyright (C) 2009 Kon Lovett.  All rights reserved.
130
131Permission is hereby granted, free of charge, to any person obtaining a
132copy of this software and associated documentation files (the Software),
133to deal in the Software without restriction, including without limitation
134the rights to use, copy, modify, merge, publish, distribute, sublicense,
135and/or sell copies of the Software, and to permit persons to whom the
136Software is furnished to do so, subject to the following conditions:
137
138The above copyright notice and this permission notice shall be included
139in all copies or substantial portions of the Software.
140
141THE SOFTWARE IS PROVIDED ASIS, WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
142IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
143FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL
144THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR
145OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE,
146ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
147OTHER DEALINGS IN THE SOFTWARE.
Note: See TracBrowser for help on using the repository browser.