Liking cljdoc? Tell your friends :D

hive-gimp.pdb.spec

DOMAIN. A GIMP PDB procedure as a value, and its projection onto the command contract.

ProcedureSpec is what resources/hive_gimp/pdb/*.edn holds; ProcedureInfo is what a live describe answers; RunAnswer is what the run forms print back. All are malli schemas registered in the hive registry under :hive-gimp.pdb/* at load. Nothing here touches GIMP.

The argument KIND is an open set: a kind exists because param-type has a method for it, and hive-gimp.pdb.forms/set-forms says how GIMP receives it.

DOMAIN. A GIMP PDB procedure as a value, and its projection onto the
command contract.

`ProcedureSpec` is what `resources/hive_gimp/pdb/*.edn` holds;
`ProcedureInfo` is what a live `describe` answers; `RunAnswer` is what the
run forms print back. All are malli schemas registered in the hive
registry under `:hive-gimp.pdb/*` at load. Nothing here touches GIMP.

The argument KIND is an open set: a kind exists because `param-type` has a
method for it, and `hive-gimp.pdb.forms/set-forms` says how GIMP receives
it.
raw docstring

arg->paramclj

(arg->param {:keys [name kind required? nilable? doc] :as arg})

One exposed ArgSpec as a contract ParamSpec.

One exposed `ArgSpec` as a contract `ParamSpec`.
sourceraw docstring

ArgInfoclj

source

ArgNameclj

schema/ParamName, generatable without test.chuck.

`schema/ParamName`, generatable without test.chuck.
sourceraw docstring

ArgSpecclj

:fixed is always sent and never exposed; otherwise :required? and :default are exclusive, as in ParamSpec.

`:fixed` is always sent and never exposed; otherwise `:required?` and
`:default` are exclusive, as in `ParamSpec`.
sourceraw docstring

assignmentsclj

(assignments spec params)

[arg value] pairs to set on the procedure config, in PDB order, from the wire params of a built GimpCommand. Fixed args always; an absent or nil value is left to GIMP's own default.

`[arg value]` pairs to set on the procedure config, in PDB order, from the
wire `params` of a built `GimpCommand`. Fixed args always; an absent or nil
value is left to GIMP's own default.
sourceraw docstring

Commandclj

schema/CommandName, generatable without test.chuck.

`schema/CommandName`, generatable without test.chuck.
sourceraw docstring

command-ofclj

(command-of spec)

The catalogue command for spec: its :command, else pdb_<procedure>.

The catalogue command for `spec`: its `:command`, else `pdb_<procedure>`.
sourceraw docstring

explainclj

(explain ?schema value)

Why value fails ?schema, or nil.

Why `value` fails `?schema`, or nil.
sourceraw docstring

exposed-argsclj

(exposed-args spec)

Arguments a caller supplies: every arg that is not :fixed.

Arguments a caller supplies: every arg that is not `:fixed`.
sourceraw docstring

fn-nameclj

(fn-name spec)

The Clojure fn defprocedure defines for spec.

The Clojure fn `defprocedure` defines for `spec`.
sourceraw docstring

Kindclj

source

kind?clj

(kind? k)

True when k is a registered argument kind.

True when `k` is a registered argument kind.
sourceraw docstring

kindsclj

(kinds)

Every registered kind, sorted.

Every registered kind, sorted.
sourceraw docstring

OmittedArgclj

source

param-typecljmultimethod

The contract ParamType a caller sends for an argument of kind.

The contract `ParamType` a caller sends for an argument of `kind`.
sourceraw docstring

procedure-info?clj

source

procedure-spec?clj

source

ProcedureInfoclj

source

ProcedureNameclj

source

ProcedureSpecclj

source

registered-schemasclj

source

required-argsclj

(required-args spec)

Exposed arguments without a default, in PDB order.

Exposed arguments without a default, in PDB order.
sourceraw docstring

run-answer?clj

source

RunAnswerclj

source

snakeclj

(snake s)

a-b -> a_b.

`a-b` -> `a_b`.
sourceraw docstring

spec->descriptorclj

(spec->descriptor spec)

The catalogue Descriptor the MCP gimp tool lists and runs for spec.

The catalogue `Descriptor` the MCP `gimp` tool lists and runs for `spec`.
sourceraw docstring

ValueSpecclj

source

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