blob: 0cc31985c90b3938a169fbb6e8c205fce11c498f (
plain)
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
|
<html>
<head>
<title>trace API reference (clojure.contrib)</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" />
<!-- TODO: are we using these (from clojure.org)? If so, add the files -->
<script src="file/view/code_highlighter.js" type="text/javascript"></script>
<script src="file/view/clojure.js" type="text/javascript"></script>
<style>.menuWrapper{height: 36px;}</style>
<!--[if lte IE 6]>
<link rel="stylesheet" href="http://www.wikispaces.com/_/2009051601/s/internal_ie.css" type="text/css" />
<![endif]-->
</head>
<!--
This document was auto-generated from the clojure.contrib source by contrib-autodoc.
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="Clojure-contrib" href="index.html">Clojure-contrib</a></h1>
</div>
<div id="leftcolumn"><div><div style="text-align: center;"></div>
<div class="menu">
<div class="WikiCustomNav WikiElement wiki">
<a class="wiki_link" href="index.html">Overview</a><br />
<a class="wiki_link" href="api-index.html">API Index</a><br />
<a class="wiki_link" href="#">Namespaces:</a>
<ul id="left-sidebar-list">
<li><a href="accumulators-api.html" class="wiki_link">accumulators</a></li><li><a href="agent-utils-api.html" class="wiki_link">agent-utils</a></li><li><a href="base64-api.html" class="wiki_link">base64</a></li><li><a href="classpath-api.html" class="wiki_link">classpath</a></li><li><a href="combinatorics-api.html" class="wiki_link">combinatorics</a></li><li><a href="command-line-api.html" class="wiki_link">command-line</a></li><li><a href="complex-numbers-api.html" class="wiki_link">complex-numbers</a></li><li><a href="cond-api.html" class="wiki_link">cond</a></li><li><a href="condition-api.html" class="wiki_link">condition</a></li><li><a href="core-api.html" class="wiki_link">core</a></li><li><a href="dataflow-api.html" class="wiki_link">dataflow</a></li><li><a href="datalog-api.html" class="wiki_link">datalog</a></li><li><a href="def-api.html" class="wiki_link">def</a></li><li><a href="duck-streams-api.html" class="wiki_link">duck-streams</a></li><li><a href="error-kit-api.html" class="wiki_link">error-kit</a></li><li><a href="except-api.html" class="wiki_link">except</a></li><li><a href="fcase-api.html" class="wiki_link">fcase</a></li><li><a href="find-namespaces-api.html" class="wiki_link">find-namespaces</a></li><li><a href="fnmap-api.html" class="wiki_link">fnmap</a></li><li><a href="gen-html-docs-api.html" class="wiki_link">gen-html-docs</a></li><li><a href="generic.arithmetic-api.html" class="wiki_link">generic.arithmetic</a></li><li><a href="generic.collection-api.html" class="wiki_link">generic.collection</a></li><li><a href="generic.comparison-api.html" class="wiki_link">generic.comparison</a></li><li><a href="generic.functor-api.html" class="wiki_link">generic.functor</a></li><li><a href="generic.math-functions-api.html" class="wiki_link">generic.math-functions</a></li><li><a href="graph-api.html" class="wiki_link">graph</a></li><li><a href="greatest-least-api.html" class="wiki_link">greatest-least</a></li><li><a href="http.agent-api.html" class="wiki_link">http.agent</a></li><li><a href="http.connection-api.html" class="wiki_link">http.connection</a></li><li><a href="import-static-api.html" class="wiki_link">import-static</a></li><li><a href="jar-api.html" class="wiki_link">jar</a></li><li><a href="java-utils-api.html" class="wiki_link">java-utils</a></li><li><a href="javadoc.browse-api.html" class="wiki_link">javadoc.browse</a></li><li><a href="jmx-api.html" class="wiki_link">jmx</a></li><li><a href="json.read-api.html" class="wiki_link">json.read</a></li><li><a href="json.write-api.html" class="wiki_link">json.write</a></li><li><a href="lazy-seqs-api.html" class="wiki_link">lazy-seqs</a></li><li><a href="lazy-xml-api.html" class="wiki_link">lazy-xml</a></li><li><a href="logging-api.html" class="wiki_link">logging</a></li><li><a href="macro-utils-api.html" class="wiki_link">macro-utils</a></li><li><a href="macros-api.html" class="wiki_link">macros</a></li><li><a href="map-utils-api.html" class="wiki_link">map-utils</a></li><li><a href="math-api.html" class="wiki_link">math</a></li><li><a href="miglayout-api.html" class="wiki_link">miglayout</a></li><li><a href="mmap-api.html" class="wiki_link">mmap</a></li><li><a href="mock-api.html" class="wiki_link">mock</a></li><li><a href="monadic-io-streams-api.html" class="wiki_link">monadic-io-streams</a></li><li><a href="monads-api.html" class="wiki_link">monads</a></li><li><a href="ns-utils-api.html" class="wiki_link">ns-utils</a></li><li><a href="pprint-api.html" class="wiki_link">pprint</a></li><li><a href="probabilities.finite-distributions-api.html" class="wiki_link">probabilities.finite-distributions</a></li><li><a href="probabilities.monte-carlo-api.html" class="wiki_link">probabilities.monte-carlo</a></li><li><a href="probabilities.random-numbers-api.html" class="wiki_link">probabilities.random-numbers</a></li><li><a href="profile-api.html" class="wiki_link">profile</a></li><li><a href="prxml-api.html" class="wiki_link">prxml</a></li><li><a href="repl-ln-api.html" class="wiki_link">repl-ln</a></li><li><a href="repl-utils-api.html" class="wiki_link">repl-utils</a></li><li><a href="seq-utils-api.html" class="wiki_link">seq-utils</a></li><li><a href="server-socket-api.html" class="wiki_link">server-socket</a></li><li><a href="set-api.html" class="wiki_link">set</a></li><li><a href="shell-out-api.html" class="wiki_link">shell-out</a></li><li><a href="singleton-api.html" class="wiki_link">singleton</a></li><li><a href="sql-api.html" class="wiki_link">sql</a></li><li><a href="str-utils-api.html" class="wiki_link">str-utils</a></li><li><a href="str-utils2-api.html" class="wiki_link">str-utils2</a></li><li><a href="stream-utils-api.html" class="wiki_link">stream-utils</a></li><li><a href="swing-utils-api.html" class="wiki_link">swing-utils</a></li><li><a href="trace-api.html" class="wiki_link">trace</a></li><li><a href="types-api.html" class="wiki_link">types</a></li><li><a href="with-ns-api.html" class="wiki_link">with-ns</a></li><li><a href="zip-filter-api.html" class="wiki_link">zip-filter</a></li>
</ul>
</div>
</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><div id="toc">
<h1 class="nopad">Table of Contents</h1>
<div style="margin-left: 1em;" class="toc-section">
<a href="#toc0">Overview</a>
<div style="margin-left: 1em;" class="toc-entry">
<a href="#trace/*trace-depth*">*trace-depth*</a>
</div><div style="margin-left: 1em;" class="toc-entry">
<a href="#trace/deftrace">deftrace</a>
</div><div style="margin-left: 1em;" class="toc-entry">
<a href="#trace/trace">trace</a>
</div><div style="margin-left: 1em;" class="toc-entry">
<a href="#trace/trace-fn-call">trace-fn-call</a>
</div><div style="margin-left: 1em;" class="toc-entry">
<a href="#trace/trace-indent">trace-indent</a>
</div><div style="margin-left: 1em;" class="toc-entry">
<a href="#trace/tracer">tracer</a>
</div>
<br />
</div>
</div>
</div></div>
<div id="content-tag"><div><h1 id="overview">API for <span id="namespace-name">trace</span></h1>
by <span id="author">Stuart Sierra</span><br />
<br />Usage:
<pre>
(ns your-namespace
(:require <span id="long-name">clojure.contrib.trace</span>))
</pre><pre>
</pre><h2>Overview</h2>
<pre id="namespace-docstr">This file defines simple "tracing" macros to help you see what your
code is doing.</pre>
<br />
<h2>Public Variables and Functions</h2>
<div id="var-entry">
<br />
<hr />
<h2 id="trace/*trace-depth*">*trace-depth*</h2>
<span id="var-type">var</span><br />
<pre id="var-usage"></pre>
<pre id="var-docstr">Current stack depth of traced function calls.</pre>
<a href="http://github.com/richhickey/clojure-contrib/blob/2d0079c159a37740173bbe289daca41e48723bfd/src/clojure/contrib/trace.clj#L40" id="var-source">Source</a>
</div><div id="var-entry">
<br />
<hr />
<h2 id="trace/deftrace">deftrace</h2>
<span id="var-type">macro</span><br />
<pre id="var-usage">Usage: (deftrace name & definition)
</pre>
<pre id="var-docstr">Use in place of defn; traces each call/return of this fn, including
arguments. Nested calls to deftrace'd functions will print a
tree-like structure.</pre>
<a href="http://github.com/richhickey/clojure-contrib/blob/2d0079c159a37740173bbe289daca41e48723bfd/src/clojure/contrib/trace.clj#L75" id="var-source">Source</a>
</div><div id="var-entry">
<br />
<hr />
<h2 id="trace/trace">trace</h2>
<span id="var-type">function</span><br />
<pre id="var-usage">Usage: (trace value)
(trace name value)
</pre>
<pre id="var-docstr">Sends name (optional) and value to the tracer function, then
returns value. May be wrapped around any expression without
affecting the result.</pre>
<a href="http://github.com/richhickey/clojure-contrib/blob/2d0079c159a37740173bbe289daca41e48723bfd/src/clojure/contrib/trace.clj#L50" id="var-source">Source</a>
</div><div id="var-entry">
<br />
<hr />
<h2 id="trace/trace-fn-call">trace-fn-call</h2>
<span id="var-type">function</span><br />
<pre id="var-usage">Usage: (trace-fn-call name f args)
</pre>
<pre id="var-docstr">Traces a single call to a function f with args. 'name' is the
symbol name of the function.</pre>
<a href="http://github.com/richhickey/clojure-contrib/blob/2d0079c159a37740173bbe289daca41e48723bfd/src/clojure/contrib/trace.clj#L64" id="var-source">Source</a>
</div><div id="var-entry">
<br />
<hr />
<h2 id="trace/trace-indent">trace-indent</h2>
<span id="var-type">function</span><br />
<pre id="var-usage">Usage: (trace-indent)
</pre>
<pre id="var-docstr">Returns an indentation string based on *trace-depth*</pre>
<a href="http://github.com/richhickey/clojure-contrib/blob/2d0079c159a37740173bbe289daca41e48723bfd/src/clojure/contrib/trace.clj#L59" id="var-source">Source</a>
</div><div id="var-entry">
<br />
<hr />
<h2 id="trace/tracer">tracer</h2>
<span id="var-type">function</span><br />
<pre id="var-usage">Usage: (tracer name value)
</pre>
<pre id="var-docstr">This function is called by trace. Prints to standard output, but
may be rebound to do anything you like. 'name' is optional.</pre>
<a href="http://github.com/richhickey/clojure-contrib/blob/2d0079c159a37740173bbe289daca41e48723bfd/src/clojure/contrib/trace.clj#L44" id="var-source">Source</a>
</div>
</div></div>
</div>
</div>
</div>
</div>
<div id="foot">
<div style="text-align: center;">
Copyright 2008-2009 Rich Hickey and the various contributors
</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>
|
