Liking cljdoc? Tell your friends :D

zpst.core


analyzeclj

(analyze)
(analyze e)

After collect has been called, and the exception has been recreated, there is a lot of information held in the exception(s). Extract that information from the exception(s) and put it into the zdb internal database.

After collect has been called, and the exception has been recreated,
there is a lot of information held in the exception(s).  Extract that
information from the exception(s) and put it into the zdb internal
database.
sourceraw docstring

check-frameclj

(check-frame n)

Given a frame number, check to see that it is in range.

Given a frame number, check to see that it is in range.
sourceraw docstring

clearclj

(clear)

Empty the database and frame pointer into the database.

Empty the database and frame pointer into the database.
sourceraw docstring

collectclj

(collect)
(collect e-or-options)
(collect e options)

This will scan the stack trace from an exception and find all of the functions where we can see the source code -- which are, presumabely, the functions for which we may want to examine the inputs and outputs. You can also specify the namespaces that you want information collected for here (as well as in set-options!).

This will scan the stack trace from an exception and find all of the
functions where we can see the source code -- which are, presumabely,
the functions for which we may want to examine the inputs and outputs.
You can also specify the namespaces that you want information collected
for here (as well as in set-options!).
sourceraw docstring

epstclj

(epst)
(epst e-or-options)
(epst e options)

Prints a complete stack trace of all nested (chained) exceptions, showing nesting and the cause chain all the way down. Similar to pst, but shows the whole exception structure. By default elides some stack trace lines that come from hooking functions. Use {:elide? false} to disable this.

Prints a complete stack trace of all nested (chained) exceptions,
showing nesting and the cause chain all the way down. Similar to
pst, but shows the whole exception structure.  By default elides
some stack trace lines that come from hooking functions.  Use
{:elide? false} to disable this.
sourceraw docstring

find-in-seqclj

(find-in-seq coll x)

Given something, find its location in a seq.

Given something, find its location in a seq.
sourceraw docstring

get-argclj

(get-arg name-or-n)

Get an argument from the current environment. Accepts either a number where 0 is the first argument, or a name.

Get an argument from the current environment.  Accepts either a number
where 0 is the first argument, or a name.
sourceraw docstring

get-arg-numberclj

(get-arg-number name-or-n params frame-num)

Given a number, symbol, or string name, find the number of this argument in the args vector.

Given a number, symbol, or string name, find the number of this argument
in the args vector.
sourceraw docstring

get-frameclj

(get-frame)
(get-frame n)

Given a frame number, get this frame from zdb.

Given a frame number, get this frame from zdb.
sourceraw docstring

get-re-eval-returnclj

(get-re-eval-return)

Return whatever re-eval returned on its last invocation.

Return whatever re-eval returned on its last invocation.
sourceraw docstring

re-evalclj

(re-eval)
(re-eval n)

Recreate a call just like the one at function n. If no value is given, use the information from zframe.

Recreate a call just like the one at function n.  If no value
is given, use the information from zframe.
sourceraw docstring

replace-frame!clj

(replace-frame! n new-frame)

Set a new frame in the database, being very careful to not return the results of the swap!

Set a new frame in the database, being very careful to not
return the results of the swap!
sourceraw docstring

restore-arg!clj

(restore-arg! name-or-n)

Set an argument that has been changed back to the original value.

Set an argument that has been changed back to the original value.
sourceraw docstring

set-arg!clj

(set-arg! name-or-n v)

Change the argument specified by a name, number, or string.

Change the argument specified by a name, number, or string.
sourceraw docstring

set-frame!clj

(set-frame! n)

Given a number and a database, create an environment to examine and reproduce a particular call.

Given a number and a database, create an environment
to examine and reproduce a particular call.
sourceraw docstring

set-options!clj

(set-options! options)

Change current options.

Change current options.
sourceraw docstring

showclj

(show & rest)

Show information about frames. Takes things to show: :args :params :source :stack, then zero to two numbers, and then an optional options map.

Show information about frames.  Takes things to show: :args :params
:source :stack, then zero to two numbers, and then an optional options
map.
sourceraw docstring

validate-and-merge-optionsclj

(validate-and-merge-options subset subset-string options)

Validate the option map of a subset of zpst and merge it into the existing option-map for that subcomponent. The subset is a keyword, the subset-string is a description for any errors. Throw a useful exception if they don't validate.

Validate the option map of a subset of zpst and merge it into
the existing option-map for that subcomponent.  The subset is a
keyword, the subset-string is a description for any errors.  Throw
a useful exception if they don't validate.
sourceraw docstring

zdbclj

source

zframe-numclj

source

zpstclj

(zpst)
(zpst x)
(zpst x y)
(zpst x y z)

Show the code and arguments of a stack trace. Three possible arguments, x y and z. Possible choices are:

[] use *e and default options

[x] x is number, use it for depth x is map, it is options map x is neither, assume it is exception

[x y] x is number, use it for depth, y must be options map y is number, use it for depth, x must be exception y is map, use it as options map, x must be exception This is the entry into the actual zpst operation

[x y z] y is number and z is map, y is depth, z options map, x exception

All other values are errors.

Show the code and arguments of a stack trace. 
Three possible arguments, x y and z. Possible choices are:

[] use *e and default options

[x] x is number, use it for depth
    x is map, it is options map
    x is neither, assume it is exception

[x y] x is number, use it for depth, y must be options map
      y is number, use it for depth, x must be exception
      y is map, use it as options map, x must be exception
        This is the entry into the actual zpst operation

[x y z] y is number and z is map, y is depth, z options map, x exception

All other values are errors.
sourceraw docstring

zre-eval-returnclj

source

cljdoc is a website building & hosting documentation for Clojure/Script libraries

× close