Liking cljdoc? Tell your friends :D

flow-storm.instrument


*environment*clj


definstrumentercljmacro

(definstrumenter & args)

Defines a private function for instrumenting forms. This is like defn-, except the metadata of the return value is merged with that of the first input argument.

Defines a private function for instrumenting forms.
This is like `defn-`, except the metadata of the return value is
merged with that of the first input argument.
raw docstring

dont-break-formsclj

Set of special-forms that we don't wrap breakpoints around. These are either forms that don't do anything interesting (like quote) or forms that just can't be wrapped (like catch and finally).

Set of special-forms that we don't wrap breakpoints around.
These are either forms that don't do anything interesting (like
`quote`) or forms that just can't be wrapped (like `catch` and
`finally`).
raw docstring

fn-def-form?clj

(fn-def-form? form)

hacked-macroexpandclj

(hacked-macroexpand form)

hacked-macroexpand-1clj

(hacked-macroexpand-1 form)

instrument-tagged-codeclj

(instrument-tagged-code form ctx)

Return form instrumented with breakpoints. It is expected that something in form will contain a ::breakfunction metadata, whose value should be a var holding a macro. This macro should take three arguments, the form being evaluated, a map containing coordinates vector (see below), and the original form (before macroexpansion).

This function walks through the code attaching to objects the ::extras metadata, which is a map currently containing a :coor vector. The :coor specifies its position inside the top-level form. As an example, a coordinate vector of [3 2 0] means:

  • enter this sexp and move forward three times,
  • enter this sexp and move forward twice,
  • enter this sexp.

After that, it fully macroexpands the code, walks through it again, and wraps in a ::breakfunction any form that contains the previously attached metadata.

Return `form` instrumented with breakpoints.
It is expected that something in `form` will contain a
::breakfunction metadata, whose value should be a var holding a macro. This
macro should take three arguments, the form being evaluated, a map containing
coordinates vector (see below), and the original form (before macroexpansion).

This function walks through the code attaching to objects the ::extras
metadata, which is a map currently containing a :coor vector. The :coor
specifies its position inside the top-level form. As an example, a coordinate
vector of [3 2 0] means:
  - enter this sexp and move forward three times,
  - enter this sexp and move forward twice,
  - enter this sexp.

After that, it fully macroexpands the code, walks through it again, and wraps
in a ::breakfunction any form that contains the previously attached metadata.
raw docstring

macroexpand-allclj

(macroexpand-all form & [original-key])

Like clojure.walk/macroexpand-all, but preserves and macroexpands metadata. Also store the original form (unexpanded and stripped of metadata) in the metadata of the expanded form under original-key.

Like `clojure.walk/macroexpand-all`, but preserves and macroexpands
metadata. Also store the original form (unexpanded and stripped of
metadata) in the metadata of the expanded form under original-key.
raw docstring

merge-metaclj

(merge-meta obj & metamaps)

Non-throwing version of (vary-meta obj merge metamap-1 metamap-2 ...). Like vary-meta, this only applies to immutable objects. For instance, this function does nothing on atoms, because the metadata of an atom is part of the atom itself and can only be changed destructively.

Non-throwing version of (vary-meta obj merge metamap-1 metamap-2 ...).
Like `vary-meta`, this only applies to immutable objects. For
instance, this function does nothing on atoms, because the metadata
of an `atom` is part of the atom itself and can only be changed
destructively.
raw docstring

(print-form form & [expand? meta?])

Pretty print form. If expand? is true, macroexpand the form. If meta? is true, also print meta. This function is intended for inspection of instrumented code.

Pretty print form.
If expand? is true, macroexpand the form. If meta? is true, also print
meta. This function is intended for inspection of instrumented code.
raw docstring

strip-metaclj

(strip-meta form)
(strip-meta form keys)

Strip meta from form. If keys are provided, strip only those keys.

Strip meta from form.
If keys are provided, strip only those keys.
raw docstring

tag-formclj

(tag-form coor form)

tag-form-recursivelyclj

(tag-form-recursively form)

Like tag-form but also tag all forms inside the given form.

Like `tag-form` but also tag all forms inside the given form.
raw docstring

target-from-envclj

(target-from-env env)

wrap-dyn-bindingsclj

(wrap-dyn-bindings orig-form
                   {:keys [form-id form-flow-id instrument-fn on-outer-form-fn]}
                   forms)

wrap-fn-bodiesclj

(wrap-fn-bodies [_ & arities] wrapper)

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

× close