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

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

Chgnd nomenclature.

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