diff options
Diffstat (limited to 'branch-master/repl-utils-api.html')
| -rw-r--r-- | branch-master/repl-utils-api.html | 203 |
1 files changed, 201 insertions, 2 deletions
diff --git a/branch-master/repl-utils-api.html b/branch-master/repl-utils-api.html index d2d6a101..9275d3e4 100644 --- a/branch-master/repl-utils-api.html +++ b/branch-master/repl-utils-api.html @@ -37,7 +37,7 @@ namespace. </ul> <span class="toc-header">Namespaces</span> <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="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="import-static-api.html" class="wiki_link">import-static</a></li><li><a href="io-api.html" class="wiki_link">io</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="jmx-api.html" class="wiki_link">jmx</a></li><li><a href="json-api.html" class="wiki_link">json</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="priority-map-api.html" class="wiki_link">priority-map</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="properties-api.html" class="wiki_link">properties</a></li><li><a href="prxml-api.html" class="wiki_link">prxml</a></li><li><a href="reflect-api.html" class="wiki_link">reflect</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-api.html" class="wiki_link">seq</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="singleton-api.html" class="wiki_link">singleton</a></li><li><a href="sql-api.html" class="wiki_link">sql</a></li><li><a href="stream-utils-api.html" class="wiki_link">stream-utils</a></li><li><a href="string-api.html" class="wiki_link">string</a></li><li><a href="strint-api.html" class="wiki_link">strint</a></li><li><a href="swing-utils-api.html" class="wiki_link">swing-utils</a></li><li><a href="test-base64-api.html" class="wiki_link">test-base64</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> + <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="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="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="jmx-api.html" class="wiki_link">jmx</a></li><li><a href="json-api.html" class="wiki_link">json</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="priority-map-api.html" class="wiki_link">priority-map</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="reflect-api.html" class="wiki_link">reflect</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-api.html" class="wiki_link">seq</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="singleton-api.html" class="wiki_link">singleton</a></li><li><a href="sql-api.html" class="wiki_link">sql</a></li><li><a href="stream-utils-api.html" class="wiki_link">stream-utils</a></li><li><a href="strint-api.html" class="wiki_link">strint</a></li><li><a href="swing-utils-api.html" class="wiki_link">swing-utils</a></li><li><a href="test-base64-api.html" class="wiki_link">test-base64</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 class="BranchTOC"> <span class="toc-header">Other Versions</span> @@ -57,7 +57,33 @@ namespace. <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="#clojure.contrib.repl-utils/*local-javadocs*">*local-javadocs*</a> + </div><div style="margin-left: 1em;" class="toc-entry"> + <a href="#clojure.contrib.repl-utils/*remote-javadocs*">*remote-javadocs*</a> + </div><div style="margin-left: 1em;" class="toc-entry"> + <a href="#clojure.contrib.repl-utils/add-break-thread!">add-break-thread!</a> + </div><div style="margin-left: 1em;" class="toc-entry"> + <a href="#clojure.contrib.repl-utils/add-local-javadoc">add-local-javadoc</a> + </div><div style="margin-left: 1em;" class="toc-entry"> + <a href="#clojure.contrib.repl-utils/add-remote-javadoc">add-remote-javadoc</a> + </div><div style="margin-left: 1em;" class="toc-entry"> + <a href="#clojure.contrib.repl-utils/break-threads">break-threads</a> + </div><div style="margin-left: 1em;" class="toc-entry"> + <a href="#clojure.contrib.repl-utils/expression-info">expression-info</a> + </div><div style="margin-left: 1em;" class="toc-entry"> + <a href="#clojure.contrib.repl-utils/find-javadoc-url">find-javadoc-url</a> + </div><div style="margin-left: 1em;" class="toc-entry"> + <a href="#clojure.contrib.repl-utils/javadoc">javadoc</a> + </div><div style="margin-left: 1em;" class="toc-entry"> + <a href="#clojure.contrib.repl-utils/run">run</a> + </div><div style="margin-left: 1em;" class="toc-entry"> + <a href="#clojure.contrib.repl-utils/run*">run*</a> + </div><div style="margin-left: 1em;" class="toc-entry"> + <a href="#clojure.contrib.repl-utils/show">show</a> + </div><div style="margin-left: 1em;" class="toc-entry"> + <a href="#clojure.contrib.repl-utils/start-handling-break">start-handling-break</a> + </div> <br /> </div> </div> @@ -77,7 +103,180 @@ namespace. <br /> <h2>Public Variables and Functions</h2> +<div id="var-entry"> + <br /> + <hr /> + <h2 id="clojure.contrib.repl-utils/*local-javadocs*">*local-javadocs*</h2> + <span id="var-type">var</span><br /> + <pre id="var-usage"></pre> + <pre id="var-docstr">Ref to a list of local paths for Javadoc-generated HTML +files.</pre> + + + <a href="http://github.com/clojure/clojure-contrib/blob//modules/clojure/contrib/repl_utils/javadoc.clj#L18" id="var-source">Source</a> +</div><div id="var-entry"> + <br /> + <hr /> + <h2 id="clojure.contrib.repl-utils/*remote-javadocs*">*remote-javadocs*</h2> + <span id="var-type">var</span><br /> + <pre id="var-usage"></pre> + <pre id="var-docstr">Ref to a map from package name prefixes to URLs for remote +Javadocs.</pre> + + + <a href="http://github.com/clojure/clojure-contrib/blob//modules/clojure/contrib/repl_utils/javadoc.clj#L28" id="var-source">Source</a> +</div><div id="var-entry"> + <br /> + <hr /> + <h2 id="clojure.contrib.repl-utils/add-break-thread!">add-break-thread!</h2> + <span id="var-type">function</span><br /> + <pre id="var-usage">Usage: (add-break-thread!) + (add-break-thread! t) +</pre> + <pre id="var-docstr">Add the given thread to break-threads so that it will be stopped +any time the user presses Ctrl-C. Calls start-handling-break for +you. Adds the current thread if none is given.</pre> + + + <a href="http://github.com/clojure/clojure-contrib/blob/4083a0695087d34d13dbbe5a9b49d7c7b30ef2c4/modules/repl-utils/src/main/clojure/clojure/contrib/repl_utils.clj#L122" id="var-source">Source</a> +</div><div id="var-entry"> + <br /> + <hr /> + <h2 id="clojure.contrib.repl-utils/add-local-javadoc">add-local-javadoc</h2> + <span id="var-type">function</span><br /> + <pre id="var-usage">Usage: (add-local-javadoc path) +</pre> + <pre id="var-docstr">Adds to the list of local Javadoc paths.</pre> + + + <a href="http://github.com/clojure/clojure-contrib/blob//modules/clojure/contrib/repl_utils/javadoc.clj#L43" id="var-source">Source</a> +</div><div id="var-entry"> + <br /> + <hr /> + <h2 id="clojure.contrib.repl-utils/add-remote-javadoc">add-remote-javadoc</h2> + <span id="var-type">function</span><br /> + <pre id="var-usage">Usage: (add-remote-javadoc package-prefix url) +</pre> + <pre id="var-docstr">Adds to the list of remote Javadoc URLs. package-prefix is the +beginning of the package name that has docs at this URL.</pre> + + + <a href="http://github.com/clojure/clojure-contrib/blob//modules/clojure/contrib/repl_utils/javadoc.clj#L48" id="var-source">Source</a> +</div><div id="var-entry"> + <br /> + <hr /> + <h2 id="clojure.contrib.repl-utils/break-threads">break-threads</h2> + <span id="var-type">var</span><br /> + <pre id="var-usage"></pre> + <pre id="var-docstr">Threads to stop when Ctrl-C is pressed. See 'add-break-thread!'</pre> + + + <a href="http://github.com/clojure/clojure-contrib/blob/4083a0695087d34d13dbbe5a9b49d7c7b30ef2c4/modules/repl-utils/src/main/clojure/clojure/contrib/repl_utils.clj#L103" id="var-source">Source</a> +</div><div id="var-entry"> + <br /> + <hr /> + <h2 id="clojure.contrib.repl-utils/expression-info">expression-info</h2> + <span id="var-type">function</span><br /> + <pre id="var-usage">Usage: (expression-info expr) +</pre> + <pre id="var-docstr">Uses the Clojure compiler to analyze the given s-expr. Returns +a map with keys :class and :primitive? indicating what the compiler +concluded about the return value of the expression. Returns nil if +not type info can be determined at compile-time. + +Example: (expression-info '(+ (int 5) (float 10))) +Returns: {:class float, :primitive? true}</pre> + + + <a href="http://github.com/clojure/clojure-contrib/blob/4083a0695087d34d13dbbe5a9b49d7c7b30ef2c4/modules/repl-utils/src/main/clojure/clojure/contrib/repl_utils.clj#L135" id="var-source">Source</a> +</div><div id="var-entry"> + <br /> + <hr /> + <h2 id="clojure.contrib.repl-utils/find-javadoc-url">find-javadoc-url</h2> + <span id="var-type">function</span><br /> + <pre id="var-usage">Usage: (find-javadoc-url classname) +</pre> + <pre id="var-docstr">Searches for a URL for the given class name. Tries +*local-javadocs* first, then *remote-javadocs*. Returns a string.</pre> + + + <a href="http://github.com/clojure/clojure-contrib/blob//modules/clojure/contrib/repl_utils/javadoc.clj#L54" id="var-source">Source</a> +</div><div id="var-entry"> + <br /> + <hr /> + <h2 id="clojure.contrib.repl-utils/javadoc">javadoc</h2> + <span id="var-type">function</span><br /> + <pre id="var-usage">Usage: (javadoc class-or-object) +</pre> + <pre id="var-docstr">Opens a browser window displaying the javadoc for the argument. +Tries *local-javadocs* first, then *remote-javadocs*.</pre> + + + <a href="http://github.com/clojure/clojure-contrib/blob//modules/clojure/contrib/repl_utils/javadoc.clj#L74" id="var-source">Source</a> +</div><div id="var-entry"> + <br /> + <hr /> + <h2 id="clojure.contrib.repl-utils/run">run</h2> + <span id="var-type">macro</span><br /> + <pre id="var-usage">Usage: (run ns-name & args) +</pre> + <pre id="var-docstr">Loads the specified namespace and invokes its "main" function with +optional args. ns-name is not evaluated.</pre> + + + <a href="http://github.com/clojure/clojure-contrib/blob/4083a0695087d34d13dbbe5a9b49d7c7b30ef2c4/modules/repl-utils/src/main/clojure/clojure/contrib/repl_utils.clj#L160" id="var-source">Source</a> +</div><div id="var-entry"> + <br /> + <hr /> + <h2 id="clojure.contrib.repl-utils/run*">run*</h2> + <span id="var-type">function</span><br /> + <pre id="var-usage">Usage: (run* ns-sym & args) +</pre> + <pre id="var-docstr">Loads the specified namespace and invokes its "main" function with +optional args.</pre> + + + <a href="http://github.com/clojure/clojure-contrib/blob/4083a0695087d34d13dbbe5a9b49d7c7b30ef2c4/modules/repl-utils/src/main/clojure/clojure/contrib/repl_utils.clj#L153" id="var-source">Source</a> +</div><div id="var-entry"> + <br /> + <hr /> + <h2 id="clojure.contrib.repl-utils/show">show</h2> + <span id="var-type">function</span><br /> + <pre id="var-usage">Usage: (show x) + (show x selector) +</pre> + <pre id="var-docstr">With one arg prints all static and instance members of x or (class x). +Each member is listed with a number which can be given as 'selector' +to return the member object -- the REPL will print more details for +that member. + +The selector also may be a string or regex, in which case only +members whose names match 'selector' as a case-insensitive regex +will be printed. +Finally, the selector also may be a predicate, in which case only +members for which the predicate returns true will be printed. The +predicate will be passed a single argument, a map that includes the +:text that will be printed and the :member object itself, as well as +all the properies of the member object as translated by 'bean'. + +Examples: (show Integer) (show []) (show String 23) (show String "case")</pre> + + + <a href="http://github.com/clojure/clojure-contrib/blob/4083a0695087d34d13dbbe5a9b49d7c7b30ef2c4/modules/repl-utils/src/main/clojure/clojure/contrib/repl_utils.clj#L65" id="var-source">Source</a> +</div><div id="var-entry"> + <br /> + <hr /> + <h2 id="clojure.contrib.repl-utils/start-handling-break">start-handling-break</h2> + <span id="var-type">function</span><br /> + <pre id="var-usage">Usage: (start-handling-break) +</pre> + <pre id="var-docstr">Register INT signal handler. After calling this, Ctrl-C will cause +all break-threads to be stopped. See 'add-break-thread!'</pre> + + + <a href="http://github.com/clojure/clojure-contrib/blob/4083a0695087d34d13dbbe5a9b49d7c7b30ef2c4/modules/repl-utils/src/main/clojure/clojure/contrib/repl_utils.clj#L107" id="var-source">Source</a> +</div> </div> |