/
clojure.repl-api.html
313 lines (266 loc) · 15.1 KB
/
clojure.repl-api.html
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
<html>
<head>
<meta content="text/html; charset=utf-8" http-equiv="Content-Type" />
<title>clojure.repl - Clojure v1.7 API documentation</title>
<link href="../static/favicon.png" rel="icon" />
<link href="../static/favicon.png" rel="shortcut icon" />
<link media="all" type="text/css" href="../static/clojure.css" rel="stylesheet" />
<link media="all" type="text/css" href="../static/wiki.css" rel="stylesheet" />
<link media="all" type="text/css" href="../static/internal.css" rel="stylesheet" />
<style>.menuWrapper{height: 36px;}</style>
</head>
<!--
This document was auto-generated from the source by the clojure autodoc system.
To report errors or ask questions about the overall documentation structure, formatting,
etc., contact Tom Faulhaber (google mail name: tomfaulhaber).
For errors in the documentation of a particular namespace, contact the author of that
namespace.
-->
<body>
<div id="AllContentContainer">
<div id="Header">
<a id="Logo" href="index.html"><img alt="Clojure" height="100" width="100" src="../static/clojure-icon.gif" /></a>
<h1><a title="page header title" id="page-header" href="index.html">Clojure Core API Reference</a></h1>
</div>
<div id="leftcolumn"><div style="text-align: center;"></div>
<div class="menu">
<div class="WikiCustomNav WikiElement wiki">
<span class="toc-header"><span id="project-name">Clojure</span> <span id="version">v1.7</span> API</span><br />
<ul>
<li><a class="wiki_link" href="index.html">Overview</a></li>
<li><a class="wiki_link" href="api-index.html">API Index</a></li>
</ul>
<div class="NamespaceTOC">
<span class="toc-header">Namespaces</span>
<ul id="left-sidebar-list">
<li><a href="clojure.core-api.html" class="wiki_link">clojure.core</a></li><li><a href="clojure.data-api.html" class="wiki_link">clojure.data</a></li><li><a href="clojure.edn-api.html" class="wiki_link">clojure.edn</a></li><li><a href="clojure.inspector-api.html" class="wiki_link">clojure.inspector</a></li><li><a href="clojure.instant-api.html" class="wiki_link">clojure.instant</a></li><li><a href="clojure.java.browse-api.html" class="wiki_link">clojure.java.browse</a></li><li><a href="clojure.java.io-api.html" class="wiki_link">clojure.java.io</a></li><li><a href="clojure.java.javadoc-api.html" class="wiki_link">clojure.java.javadoc</a></li><li><a href="clojure.java.shell-api.html" class="wiki_link">clojure.java.shell</a></li><li><a href="clojure.main-api.html" class="wiki_link">clojure.main</a></li><li><a href="clojure.pprint-api.html" class="wiki_link">clojure.pprint</a></li><li><a href="clojure.reflect-api.html" class="wiki_link">clojure.reflect</a></li><li><a href="clojure.repl-api.html" class="wiki_link">clojure.repl</a></li><li><a href="clojure.set-api.html" class="wiki_link">clojure.set</a></li><li><a href="clojure.stacktrace-api.html" class="wiki_link">clojure.stacktrace</a></li><li><a href="clojure.string-api.html" class="wiki_link">clojure.string</a></li><li><a href="clojure.template-api.html" class="wiki_link">clojure.template</a></li><li><a href="clojure.test-api.html" class="wiki_link">clojure.test</a></li><li><a href="clojure.walk-api.html" class="wiki_link">clojure.walk</a></li><li><a href="clojure.xml-api.html" class="wiki_link">clojure.xml</a></li><li><a href="clojure.zip-api.html" class="wiki_link">clojure.zip</a></li>
</ul>
</div>
<div class="BranchTOC">
<span class="toc-header">Other Versions</span>
<ul id="left-sidebar-branch-list">
<li><a href="../index.html" class="wiki_link">v1.6 (stable)</a></li><li><a href="../branch-clojure-1.5.0/index.html" class="wiki_link">v1.5 (stable)</a></li><li><a href="../branch-clojure-1.4.0/index.html" class="wiki_link">v1.4 (legacy)</a></li><li><a href="../branch-1.3.x/index.html" class="wiki_link">v1.3 (legacy)</a></li><li><a href="../branch-1.2.x/index.html" class="wiki_link">v1.2 (legacy)</a></li><li><a href="../branch-1.1.x/index.html" class="wiki_link">v1.1 (legacy)</a></li>
</ul>
</div>
<a href="http://clojure.org" class="wiki_link">Clojure Home</a>
</div>
</div>
</div>
<div id="rightcolumn">
<div id="Content">
<div class="contentBox"><div class="innerContentBox">
<div id="content_view" class="wiki wikiPage">
<div id="right-sidebar"><div id="toc">
<h1 class="nopad">Table of Contents</h1>
<div style="margin-left: 1em;" class="toc-section">
<a href="#toc0" style="margin-top: 3px;">Overview</a>
</div><div style="margin-left: 1em;" class="toc-section">
<a href="#" style="margin-top: 3px;"></a>
</div><div style="margin-left: 1em;" class="toc-section">
<a href="#" style="margin-top: 3px;"></a>
</div><div style="margin-left: 1em;" class="toc-section">
<a href="#var-section" style="margin-top: 3px;">Vars and Functions</a>
<div style="margin-left: 1em;" class="toc-entry">
<a class="toc-entry-anchor" href="#clojure.repl/apropos">apropos</a>
</div><div style="margin-left: 1em;" class="toc-entry">
<a class="toc-entry-anchor" href="#clojure.repl/demunge">demunge</a>
</div><div style="margin-left: 1em;" class="toc-entry">
<a class="toc-entry-anchor" href="#clojure.repl/dir">dir</a>
</div><div style="margin-left: 1em;" class="toc-entry">
<a class="toc-entry-anchor" href="#clojure.repl/dir-fn">dir-fn</a>
</div><div style="margin-left: 1em;" class="toc-entry">
<a class="toc-entry-anchor" href="#clojure.repl/doc">doc</a>
</div><div style="margin-left: 1em;" class="toc-entry">
<a class="toc-entry-anchor" href="#clojure.repl/find-doc">find-doc</a>
</div><div style="margin-left: 1em;" class="toc-entry">
<a class="toc-entry-anchor" href="#clojure.repl/pst">pst</a>
</div><div style="margin-left: 1em;" class="toc-entry">
<a class="toc-entry-anchor" href="#clojure.repl/root-cause">root-cause</a>
</div><div style="margin-left: 1em;" class="toc-entry">
<a class="toc-entry-anchor" href="#clojure.repl/set-break-handler!">set-break-handler!</a>
</div><div style="margin-left: 1em;" class="toc-entry">
<a class="toc-entry-anchor" href="#clojure.repl/source">source</a>
</div><div style="margin-left: 1em;" class="toc-entry">
<a class="toc-entry-anchor" href="#clojure.repl/source-fn">source-fn</a>
</div><div style="margin-left: 1em;" class="toc-entry">
<a class="toc-entry-anchor" href="#clojure.repl/stack-element-str">stack-element-str</a>
</div><div style="margin-left: 1em;" class="toc-entry">
<a class="toc-entry-anchor" href="#clojure.repl/thread-stopper">thread-stopper</a>
</div>
</div>
</div>
</div>
<div id="content-tag"><h1 id="overview">API for <span id="clojure.repl">clojure.repl</span>
- <span id="header-project">Clojure</span> <span id="header-version">v1.7</span><span id="header-status-block"> (<span id="header-status">in development</span>)</span>
</h1>
<span id="author-line">by <span id="author-name">Chris Houser, Christophe Grand, Stephen Gilardi, Michel Salim</span><br /></span>
<br />Full namespace name: <span id="long-name">clojure.repl</span>
<p></p>
<h2>Overview</h2>
<pre id="namespace-docstr">Utilities meant to be used interactively at the REPL</pre>
<br />
<div id="var-section">
<p></p>
<h2>Public Variables and Functions</h2>
<div id="var-entry">
<br />
<hr />
<h2 id="clojure.repl/apropos">apropos</h2>
<span id="var-type">function</span><br />
<pre id="var-usage">Usage: (apropos str-or-pattern)
</pre>
<pre id="var-docstr">Given a regular expression or stringable thing, return a seq of all
public definitions in all currently-loaded namespaces that match the
str-or-pattern.</pre>
<a href="https://github.com/clojure/clojure/blob/61bc3523eebaade6a1d856f74330169eb26211ea/src/clj/clojure/repl.clj#L168" id="var-source">Source</a>
</div><div id="var-entry">
<br />
<hr />
<h2 id="clojure.repl/demunge">demunge</h2>
<span id="var-type">function</span><br />
<pre id="var-usage">Usage: (demunge fn-name)
</pre>
<pre id="var-docstr">Given a string representation of a fn class,
as in a stack trace element, returns a readable version.</pre>
<span class="var-added"><span id="content">Added in Clojure version 1.3</span><br /></span>
<a href="https://github.com/clojure/clojure/blob/61bc3523eebaade6a1d856f74330169eb26211ea/src/clj/clojure/repl.clj#L194" id="var-source">Source</a>
</div><div id="var-entry">
<br />
<hr />
<h2 id="clojure.repl/dir">dir</h2>
<span id="var-type">macro</span><br />
<pre id="var-usage">Usage: (dir nsname)
</pre>
<pre id="var-docstr">Prints a sorted directory of public vars in a namespace</pre>
<a href="https://github.com/clojure/clojure/blob/61bc3523eebaade6a1d856f74330169eb26211ea/src/clj/clojure/repl.clj#L188" id="var-source">Source</a>
</div><div id="var-entry">
<br />
<hr />
<h2 id="clojure.repl/dir-fn">dir-fn</h2>
<span id="var-type">function</span><br />
<pre id="var-usage">Usage: (dir-fn ns)
</pre>
<pre id="var-docstr">Returns a sorted seq of symbols naming public vars in
a namespace</pre>
<a href="https://github.com/clojure/clojure/blob/61bc3523eebaade6a1d856f74330169eb26211ea/src/clj/clojure/repl.clj#L182" id="var-source">Source</a>
</div><div id="var-entry">
<br />
<hr />
<h2 id="clojure.repl/doc">doc</h2>
<span id="var-type">macro</span><br />
<pre id="var-usage">Usage: (doc name)
</pre>
<pre id="var-docstr">Prints documentation for a var or special form given its name</pre>
<span class="var-added"><span id="content">Added in Clojure version 1.0</span><br /></span>
<a href="https://github.com/clojure/clojure/blob/61bc3523eebaade6a1d856f74330169eb26211ea/src/clj/clojure/repl.clj#L120" id="var-source">Source</a>
</div><div id="var-entry">
<br />
<hr />
<h2 id="clojure.repl/find-doc">find-doc</h2>
<span id="var-type">function</span><br />
<pre id="var-usage">Usage: (find-doc re-string-or-pattern)
</pre>
<pre id="var-docstr">Prints documentation for any var whose documentation or name
contains a match for re-string-or-pattern</pre>
<span class="var-added"><span id="content">Added in Clojure version 1.0</span><br /></span>
<a href="https://github.com/clojure/clojure/blob/61bc3523eebaade6a1d856f74330169eb26211ea/src/clj/clojure/repl.clj#L104" id="var-source">Source</a>
</div><div id="var-entry">
<br />
<hr />
<h2 id="clojure.repl/pst">pst</h2>
<span id="var-type">function</span><br />
<pre id="var-usage">Usage: (pst)
(pst e-or-depth)
(pst e depth)
</pre>
<pre id="var-docstr">Prints a stack trace of the exception, to the depth requested. If none supplied, uses the root cause of the
most recent repl exception (*e), and a depth of 12.</pre>
<span class="var-added"><span id="content">Added in Clojure version 1.3</span><br /></span>
<a href="https://github.com/clojure/clojure/blob/61bc3523eebaade6a1d856f74330169eb26211ea/src/clj/clojure/repl.clj#L227" id="var-source">Source</a>
</div><div id="var-entry">
<br />
<hr />
<h2 id="clojure.repl/root-cause">root-cause</h2>
<span id="var-type">function</span><br />
<pre id="var-usage">Usage: (root-cause t)
</pre>
<pre id="var-docstr">Returns the initial cause of an exception or error by peeling off all of
its wrappers</pre>
<span class="var-added"><span id="content">Added in Clojure version 1.3</span><br /></span>
<a href="https://github.com/clojure/clojure/blob/61bc3523eebaade6a1d856f74330169eb26211ea/src/clj/clojure/repl.clj#L201" id="var-source">Source</a>
</div><div id="var-entry">
<br />
<hr />
<h2 id="clojure.repl/set-break-handler!">set-break-handler!</h2>
<span id="var-type">function</span><br />
<pre id="var-usage">Usage: (set-break-handler!)
(set-break-handler! f)
</pre>
<pre id="var-docstr">Register INT signal handler. After calling this, Ctrl-C will cause
the given function f to be called with a single argument, the signal.
Uses thread-stopper if no function given.</pre>
<a href="https://github.com/clojure/clojure/blob/61bc3523eebaade6a1d856f74330169eb26211ea/src/clj/clojure/repl.clj#L263" id="var-source">Source</a>
</div><div id="var-entry">
<br />
<hr />
<h2 id="clojure.repl/source">source</h2>
<span id="var-type">macro</span><br />
<pre id="var-usage">Usage: (source n)
</pre>
<pre id="var-docstr">Prints the source code for the given symbol, if it can find it.
This requires that the symbol resolve to a Var defined in a
namespace for which the .clj is in the classpath.
Example: (source filter)</pre>
<a href="https://github.com/clojure/clojure/blob/61bc3523eebaade6a1d856f74330169eb26211ea/src/clj/clojure/repl.clj#L159" id="var-source">Source</a>
</div><div id="var-entry">
<br />
<hr />
<h2 id="clojure.repl/source-fn">source-fn</h2>
<span id="var-type">function</span><br />
<pre id="var-usage">Usage: (source-fn x)
</pre>
<pre id="var-docstr">Returns a string of the source code for the given symbol, if it can
find it. This requires that the symbol resolve to a Var defined in
a namespace for which the .clj is in the classpath. Returns nil if
it can't find the source. For most REPL usage, 'source' is more
convenient.
Example: (source-fn 'filter)</pre>
<a href="https://github.com/clojure/clojure/blob/61bc3523eebaade6a1d856f74330169eb26211ea/src/clj/clojure/repl.clj#L134" id="var-source">Source</a>
</div><div id="var-entry">
<br />
<hr />
<h2 id="clojure.repl/stack-element-str">stack-element-str</h2>
<span id="var-type">function</span><br />
<pre id="var-usage">Usage: (stack-element-str el)
</pre>
<pre id="var-docstr">Returns a (possibly unmunged) string representation of a StackTraceElement</pre>
<span class="var-added"><span id="content">Added in Clojure version 1.3</span><br /></span>
<a href="https://github.com/clojure/clojure/blob/61bc3523eebaade6a1d856f74330169eb26211ea/src/clj/clojure/repl.clj#L214" id="var-source">Source</a>
</div><div id="var-entry">
<br />
<hr />
<h2 id="clojure.repl/thread-stopper">thread-stopper</h2>
<span id="var-type">function</span><br />
<pre id="var-usage">Usage: (thread-stopper)
(thread-stopper thread)
</pre>
<pre id="var-docstr">Returns a function that takes one arg and uses that as an exception message
to stop the given thread. Defaults to the current thread</pre>
<a href="https://github.com/clojure/clojure/blob/61bc3523eebaade6a1d856f74330169eb26211ea/src/clj/clojure/repl.clj#L257" id="var-source">Source</a>
</div>
</div>
</div>
</div>
</div>
</div>
</div>
<div id="foot">
<div style="text-align: center;" id="copyright">Copyright 2007-2014 by Rich Hickey</div>
</div>
</div>
<div id="DesignedBy">Logo & site design by <a title="Visit Tom Hickey's website." href="http://www.tomhickey.com">Tom Hickey</a>.<br />
Clojure auto-documentation system by Tom Faulhaber.</div>
</div>
<!-- /AllContentContainer -->
</body>
</html>