API for clojure.repl - Clojure v1.4 (legacy)

Overview

Utilities meant to be used interactively at the REPL

Usage: (apropos str-or-pattern)

Given a regular expression or stringable thing, return a seq of
all definitions in all currently-loaded namespaces that match the
str-or-pattern.

Usage: (demunge fn-name)

Given a string representation of a fn class,
as in a stack trace element, returns a readable version.

Usage: (dir nsname)

Prints a sorted directory of public vars in a namespace

Usage: (dir-fn ns)

Returns a sorted seq of symbols naming public vars in
a namespace

Usage: (doc name)

Prints documentation for a var or special form given its name

Usage: (find-doc re-string-or-pattern)

Prints documentation for any var whose documentation or name
contains a match for re-string-or-pattern

Usage: (pst)
       (pst e-or-depth)
       (pst e depth)

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.

Usage: (root-cause t)

Returns the initial cause of an exception or error by peeling off all of
its wrappers

Usage: (set-break-handler!)
       (set-break-handler! f)

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.

Usage: (source n)

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)

Usage: (source-fn x)

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)

Usage: (stack-element-str el)

Returns a (possibly unmunged) string representation of a StackTraceElement

Usage: (thread-stopper)
       (thread-stopper thread)

Returns a function that takes one arg and uses that as an exception message
to stop the given thread.  Defaults to the current thread