Liking cljdoc? Tell your friends :D

cloverage.instrument


*exclude-calls*clj

The set of symbols that will suppress instrumentation when any are used in the calling position of a form. Useful for excluding problematic macro call sites from coverage metrics.

The set of symbols that will suppress instrumentation when any are used in
the calling position of a form. Useful for excluding problematic macro call
sites from coverage metrics.
sourceraw docstring

do-wrapcljmultimethod

(do-wrap f line form env)

Traverse the given form and wrap all its sub-forms in a function that evals the form and records that it was called.

Traverse the given form and wrap all its sub-forms in a function that evals
the form and records that it was called.
sourceraw docstring

eval-formclj

(eval-form filename form line-hint instrumented-form)

Evaluate an instrumented-form.

Evaluate an `instrumented-form`.
sourceraw docstring

exclude?clj

(exclude? form)

Whether we should skip instrumenting a form because it is specified in the :exclude-call options.

Whether we should skip instrumenting a form because it is specified in the `:exclude-call` options.
sourceraw docstring

form-typeclj

(form-type form env)

Classifies the given form

Classifies the given form
sourceraw docstring

instrumentclj

(instrument f-var ns-symbol)

Instrument and evaluate the forms in the namespace named by ns-symbol using an instrumentation function referred to by f-var. The instrumentation function has the signature a function with the signature

(f line-hint form) -> instrumented-form

Instrument and evaluate the forms in the namespace named by `ns-symbol` using an instrumentation function referred to
by `f-var`. The instrumentation function has the signature a function with the signature

  (f line-hint form) -> instrumented-form
sourceraw docstring

instrument-fileclj

(instrument-file f-var lib filename)

Instrument all the forms in a file. Returns sequence of instrumented forms.

Instrument all the forms in a file. Returns sequence of instrumented forms.
sourceraw docstring

instrument-formclj

(instrument-form f-var filename form)

Instrument a single form. Returns instrumented form.

Instrument a single `form`. Returns instrumented form.
sourceraw docstring

no-instrclj

(no-instr _ form)

Do not change form at all.

Do not change form at all.
sourceraw docstring

nopclj

(nop _ form)

Instrument form with expressions that do nothing.

Instrument form with expressions that do nothing.
sourceraw docstring

wrapclj

(wrap f-var line-hint form)

Main interface for wrapping expressions using f. Wrap will return a form that during macroexpansion calls f on form and all sub-expressions of form that can be meaningfully wrapped. f should take an expression and return one that evaluates in exactly the same way, possibly with additional side effects.

Main interface for wrapping expressions using `f`.
Wrap will return a form that during macroexpansion calls `f` on `form` and
all sub-expressions of `form` that can be meaningfully wrapped.
`f` should take an expression and return one that evaluates in exactly the
same way, possibly with additional side effects.
sourceraw docstring

wrap-bindingclj

(wrap-binding f line-hint [args & body :as form])

Wrap a let/loop binding

e.g. - a (+ a b) (let or loop)

Wrap a let/loop binding

e.g. - `a (+ a b)`       (let or loop)
sourceraw docstring

wrap-catchclj

(wrap-catch f line [catch-symbol classname localname & body])
source

wrap-deftype-defrecord-methodclj

(wrap-deftype-defrecord-method f line [meth-name args & body :as method-form])
source

wrap-finallyclj

(wrap-finally f line [finally-symbol & body])
source

wrap-fn-bodyclj

(wrap-fn-body f line form)
source

wrap-overloadclj

(wrap-overload f line-hint [args & body :as form])

Wrap a single function overload.

e.g. - ([a b] (+ a b)) or ([n] {:pre [(> n 0)]} (/ 1 n))

Wrap a single function overload.

e.g. - ([a b] (+ a b)) or
        ([n] {:pre [(> n 0)]} (/ 1 n))
sourceraw docstring

wrap-overloadsclj

(wrap-overloads f line-hint form)
source

wrapmcljmacro

(wrapm f-sym line-hint form)

Helper macro for wrap. Takes advantage of &env to track lexical scope while walking form.

Helper macro for wrap.
Takes advantage of &env to track lexical scope while walking `form`.
sourceraw docstring

wrapperclj

(wrapper f line)

Return a function that when called, wraps f through its argument.

Return a function that when called, wraps f through its argument.
sourceraw docstring

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

× close