Liking cljdoc? Tell your friends :D

skeptic.analysis.calls


*user-fn-path-predicate-summaries*clj

Project-scoped registry {qualified-sym → {:pred kw [:class C] :path [kw ...]}} recognising user-defined fns whose body reduces to a built-in path-type-predicate on a destructured key of their first parameter. Bound by skeptic.checking.pipeline/check-ns from project-state; read by skeptic.analysis.call-kinds.assumption/call-test-assumption so calls like (b-params? params) propagate as (vector?, [:k], _) narrowing on params.

Project-scoped registry `{qualified-sym → {:pred kw [:class C] :path [kw ...]}}`
recognising user-defined fns whose body reduces to a built-in path-type-predicate
on a destructured key of their first parameter. Bound by
`skeptic.checking.pipeline/check-ns` from project-state; read by
`skeptic.analysis.call-kinds.assumption/call-test-assumption` so calls like `(b-params? params)`
propagate as `(vector?, [:k], _)` narrowing on `params`.
sourceraw docstring

call-infoclj

(call-info ctx fn-node args)

Inputs: [ctx :- s/Any fn-node :- s/Any args :- s/Any] Returns: s/Any

Inputs: [ctx :- s/Any fn-node :- s/Any args :- s/Any]
Returns: s/Any
sourceraw docstring

CallOptsclj

source

CallOptsArglistEntryclj

source

default-call-infoclj

(default-call-info ctx arity output)

Inputs: [ctx :- s/Any arity :- s/Int output :- (s/maybe at/SemanticType)] Returns: s/Any

Inputs: [ctx :- s/Any arity :- s/Int output :- (s/maybe at/SemanticType)]
Returns: s/Any
sourceraw docstring

fun-type->call-optsclj

(fun-type->call-opts fun-type)

Inputs: [fun-type :- at/SemanticType] Returns: CallOpts

Inputs: [fun-type :- at/SemanticType]
Returns: CallOpts
sourceraw docstring

get-key-queryclj

(get-key-query ctx node)

Inputs: [ctx :- s/Any node :- s/Any] Returns: s/Any

Inputs: [ctx :- s/Any node :- s/Any]
Returns: s/Any
sourceraw docstring

instance-call-symsclj

source

keyword-invoke-kw-and-targetclj

(keyword-invoke-kw-and-target node)

Inputs: [node :- s/Any] Returns: (s/maybe [(s/one s/Keyword "kw") (s/one s/Any "target")])

When keyword-invoke-on-local?, returns [kw-keyword target-node].

Inputs: [node :- s/Any]
Returns: (s/maybe [(s/one s/Keyword "kw") (s/one s/Any "target")])

When `keyword-invoke-on-local?`, returns `[kw-keyword target-node]`.
sourceraw docstring

keyword-invoke-on-local?clj

(keyword-invoke-on-local? node)

Inputs: [node :- s/Any] Returns: s/Bool

True for (:k x) as either JVM analyzer :invoke or :keyword-invoke.

Inputs: [node :- s/Any]
Returns: s/Bool

True for `(:k x)` as either JVM analyzer `:invoke` or `:keyword-invoke`.
sourceraw docstring

literal-map-key?clj

(literal-map-key? node)

Inputs: [node :- s/Any] Returns: s/Bool

Inputs: [node :- s/Any]
Returns: s/Bool
sourceraw docstring

literal-node-valueclj

(literal-node-value node)

Inputs: [node :- s/Any] Returns: s/Any

Inputs: [node :- s/Any]
Returns: s/Any
sourceraw docstring

lookup-summaryclj

(lookup-summary accessor-summaries ns-sym node)

Inputs: [accessor-summaries :- s/Any ns-sym :- (s/maybe s/Symbol) node :- s/Any] Returns: s/Any

Inputs: [accessor-summaries :- s/Any ns-sym :- (s/maybe s/Symbol) node :- s/Any]
Returns: s/Any
sourceraw docstring

lookup-typeclj

(lookup-type dict ns-sym node)

Inputs: [dict :- s/Any ns-sym :- (s/maybe s/Symbol) node :- s/Any] Returns: s/Any

Inputs: [dict :- s/Any ns-sym :- (s/maybe s/Symbol) node :- s/Any]
Returns: s/Any
sourceraw docstring

map-literal-key-typeclj

(map-literal-key-type ctx node)

Inputs: [ctx :- s/Any node :- s/Any] Returns: at/SemanticType

Inputs: [ctx :- s/Any node :- s/Any]
Returns: at/SemanticType
sourceraw docstring

node-infoclj

(node-info node)

Inputs: [node :- s/Any] Returns: s/Any

Inputs: [node :- s/Any]
Returns: s/Any
sourceraw docstring

path-predicate-summary-from-formclj

(path-predicate-summary-from-form form)

Returns {:pred kw :path [kw]} when form is (s/defn name [doc?] [attr-map?] :- s/Bool [{:keys [...]} :- _] (PRED k)) where PRED is a recognised built-in single-arg type predicate and k is one of the destructured :keys. Returns nil otherwise. Only the single-arity, single-body shape is recognised; multi-arity, attr maps with metadata other than the schema marker, and predicates not in the built-in registry fall through.

Returns `{:pred kw :path [kw]}` when `form` is
`(s/defn name [doc?] [attr-map?] :- s/Bool [{:keys [...]} :- _] (PRED k))`
where PRED is a recognised built-in single-arg type predicate and `k` is one
of the destructured `:keys`. Returns nil otherwise.
Only the single-arity, single-body shape is recognised; multi-arity, attr
maps with metadata other than the schema marker, and predicates not in the
built-in registry fall through.
sourceraw docstring

qualify-symbolclj

(qualify-symbol ns-sym sym)

Inputs: [ns-sym :- s/Any sym :- s/Any] Returns: s/Any

Inputs: [ns-sym :- s/Any sym :- s/Any]
Returns: s/Any
sourceraw docstring

resolved-call-symclj

(resolved-call-sym fn-node)

Inputs: [fn-node :- s/Any] Returns: (s/maybe s/Symbol)

Inputs: [fn-node :- s/Any]
Returns: (s/maybe s/Symbol)
sourceraw docstring

static-nil?-call?clj

(static-nil?-call? node)

Inputs: [node :- s/Any] Returns: s/Bool

Inputs: [node :- s/Any]
Returns: s/Bool
sourceraw docstring

static-nil?-targetclj

(static-nil?-target node)

Inputs: [node :- s/Any] Returns: (s/maybe s/Any)

Inputs: [node :- s/Any]
Returns: (s/maybe s/Any)
sourceraw docstring

type-predicate-assumption-infoclj

(type-predicate-assumption-info fn-node args)

Inputs: [fn-node :- s/Any args :- [s/Any]] Returns: (s/maybe aos/PredInfo)

Inputs: [fn-node :- s/Any args :- [s/Any]]
Returns: (s/maybe aos/PredInfo)
sourceraw docstring

type-predicate-assumption-info-for-symclj

(type-predicate-assumption-info-for-sym sym args)

Inputs: [sym :- (s/maybe s/Symbol) args :- [s/Any]] Returns: (s/maybe aos/PredInfo)

Inputs: [sym :- (s/maybe s/Symbol) args :- [s/Any]]
Returns: (s/maybe aos/PredInfo)
sourceraw docstring

type-predicate-call?clj

(type-predicate-call? fn-node args)

Inputs: [fn-node :- s/Any args :- [s/Any]] Returns: s/Bool

Inputs: [fn-node :- s/Any args :- [s/Any]]
Returns: s/Bool
sourceraw docstring

type-predicate-sym->predclj

source

typed-callable?clj

(typed-callable? fn-node)

Inputs: [fn-node :- s/Any] Returns: s/Bool

Inputs: [fn-node :- s/Any]
Returns: s/Bool
sourceraw docstring

user-fn-path-predicate-infoclj

(user-fn-path-predicate-info sym)

Inputs: [sym :- (s/maybe s/Symbol)] Returns: (s/maybe #:s{Keyword s/Any})

Lookup helper for *user-fn-path-predicate-summaries*.

Inputs: [sym :- (s/maybe s/Symbol)]
Returns: (s/maybe #:s{Keyword s/Any})

Lookup helper for `*user-fn-path-predicate-summaries*`.
sourceraw docstring

var->symclj

(var->sym var)

Inputs: [var :- s/Any] Returns: (s/maybe s/Symbol)

Inputs: [var :- s/Any]
Returns: (s/maybe s/Symbol)
sourceraw docstring

cljdoc builds & hosts documentation for Clojure/Script libraries

Keyboard shortcuts
Ctrl+kJump to recent docs
Move to previous article
Move to next article
Ctrl+/Jump to the search field
× close