Liking cljdoc? Tell your friends :D

std.lang


!cljmacro

(! tag body)

switch between defined annex envs

switch between defined annex envs
raw docstring

add-listenerclj

(add-listener notify id sink-key f)

adds a listener to the sink

adds a listener to the sink
raw docstring

annex-currentclj

(annex-current)
(annex-current ns)

gets the current annex. May not exist

(annex/annex-current) => any?

gets the current annex. May not exist

(annex/annex-current)
=> any?
raw docstring

annex-resetclj

(annex-reset)
(annex-reset ns)

resets the current annex

resets the current annex
raw docstring

annex:getclj

(annex:get tag)
(annex:get tag ns)

gets the runtime associated with an annex

gets the runtime associated with an annex
raw docstring

annex:listclj

(annex:list)
(annex:list ns)

lists all annexs

lists all annexs
raw docstring

annex:restart-allclj

(annex:restart-all)
(annex:restart-all ns)

stops and starts all annex runtimes

stops and starts all annex runtimes
raw docstring

annex:startclj

(annex:start tag)
(annex:start tag ns)

starts an annex tag

starts an annex tag
raw docstring

annex:start-allclj

(annex:start-all)
(annex:start-all ns)

starts all the annex tags

starts all the annex tags
raw docstring

annex:stopclj

(annex:stop tag)
(annex:stop tag ns)

stops an annex tag

stops an annex tag
raw docstring

annex:stop-allclj

(annex:stop-all)
(annex:stop-all ns)

stops all annexs

stops all annexs
raw docstring

as-luaclj

(as-lua input)

change [] to {}

change `[]` to `{}`
raw docstring

basic-typed-argsclj

(basic-typed-args args)

typed args without grammar checks

(mapv (juxt meta identity) (basic-typed-args '(:int i, :const :int j))) => '[[{:- [:int]} i] [{:- [:const :int]} j]]

typed args without grammar checks

(mapv (juxt meta identity)
      (basic-typed-args '(:int i, :const :int j)))
=> '[[{:- [:int]} i]
     [{:- [:const :int]} j]]
raw docstring

clear-sinkclj

(clear-sink {:keys [sinks]} id)

clears a sink

clears a sink
raw docstring

default-libraryclj

(default-library & [override])

gets the default library

gets the default library
raw docstring

default-library:resetclj

(default-library:reset & [override])

clears the default library, including all grammars

clears the default library, including all grammars
raw docstring

default-notifyclj

(default-notify)

gets the default notify server

(notify/default-notify)

gets the default notify server

(notify/default-notify)
raw docstring

default-notify:resetclj

(default-notify:reset)

resets the default notify server

resets the default notify server
raw docstring

defmacro.!cljmacro

(defmacro.! sym args & body)

macro for runtime lang macros

macro for runtime lang macros
raw docstring

delete-entry!clj

(delete-entry! lib {:keys [lang module section id] :as m})

deletes an entry from the library

deletes an entry from the library
raw docstring

delete-module!clj

(delete-module! lib lang module-id)

deletes a module from the library

deletes a module from the library
raw docstring

delete-modules!clj

(delete-modules! lib lang module-ids)

deletes a bunch of modules from the library

deletes a bunch of modules from the library
raw docstring

emit-asclj

(emit-as lang forms & [meta])

helper function for emitting multiple forms

helper function for emitting multiple forms
raw docstring

emit-entryclj

(emit-entry grammar entry {:keys [snapshot module emit] :as mopts})

emits a given entry

emits a given entry
raw docstring

emit-entry-depsclj

(emit-entry-deps {:keys [lang module id] :as ptr} {:keys [library] :as meta})

emits only the entry deps

emits only the entry deps
raw docstring

emit-mainclj

(emit-main form grammar mopts)

creates the raw emit with loop

(emit/emit-main '(not (+ 1 2 3)) +grammar+ {}) => "!(1 + 2 + 3)"

creates the raw emit with loop

(emit/emit-main '(not (+ 1 2 3))
                +grammar+
                {})
=> "!(1 + 2 + 3)"
raw docstring

emit-moduleclj

(emit-module)
(emit-module lang-or-rt)
(emit-module lang-or-rt module-id)

emits the entire module

emits the entire module
raw docstring

emit-ptrclj

(emit-ptr ptr & [opts])

emits the poiner as a string

emits the poiner as a string
raw docstring

emit-scriptclj

(emit-script form {:keys [library lang emit] :as meta})

emits a script with all dependencies

emits a script with all dependencies
raw docstring

emit-strclj

(emit-str form meta)

converts to an output string

converts to an output string
raw docstring

emit-symbolclj

(emit-symbol lang sym & [mopts])

emits string given symbol and grammar

emits string given symbol and grammar
raw docstring

emit-type-recordclj

(emit-type-record {:keys [modifiers symbol]})

formats to standard

formats to standard
raw docstring

force-reloadclj

(force-reload ns lang)

forces reloading of all dependent namespaces

forces reloading of all dependent namespaces
raw docstring

get-bookclj

(get-book lib lang)

gets a book from library

gets a book from library
raw docstring

get-book-rawclj

(get-book-raw lib lang)

gets the raw book, without merge

(b/list-entries (lib/get-book-raw +library+ :redis)) => empty?

(b/list-entries (lib/get-book +library+ :redis)) => coll?

gets the raw book, without merge

(b/list-entries (lib/get-book-raw +library+ :redis))
=> empty?

(b/list-entries (lib/get-book +library+ :redis))
=> coll?
raw docstring

get-entryclj

(get-entry m)

gets the entry if pointer

gets the entry if pointer
raw docstring

get-moduleclj

(get-module lib lang module-id)

gets a module from library

gets a module from library
raw docstring

get-sinkclj

(get-sink {:keys [sinks]} id)

gets a sink from the notification app server

gets a sink from the notification app server
raw docstring

get-snapshotclj

(get-snapshot lib)

gets the current snapshot for the library

gets the current snapshot for the library
raw docstring

grammarclj

(grammar lang)

gets the grammar

gets the grammar
raw docstring

intern-macrosclj

(intern-macros lang ns & [module-id library merge-op])

interns all macros from one namespace to another

interns all macros from one namespace to another
raw docstring

lang-pointerclj

(lang-pointer lang)
(lang-pointer lang {:keys [module id] :as m})

creates a lang pointer

creates a lang pointer
raw docstring

lang-rtclj

(lang-rt)
(lang-rt lang)
(lang-rt ns lang)

getn the runtime contexts in a map

getn the runtime contexts in a map
raw docstring

lang-rt-defaultclj

(lang-rt-default ptr)

gets the default runtime function

gets the default runtime function
raw docstring

lang-rt-listclj

(lang-rt-list)
(lang-rt-list ns)

lists rt in a namespace

lists rt in a namespace
raw docstring

lib-module-entriesclj

(lib-module-entries)
(lib-module-entries module-id)
(lib-module-entries module-id {:keys [lang entry]})

outputs module entries

outputs module entries
raw docstring

lib-module-overviewclj

(lib-module-overview)
(lib-module-overview module-id)
(lib-module-overview module-id {:keys [lang entry]})

lists all modules

lists all modules
raw docstring

lib-module-purgeclj

(lib-module-purge)
(lib-module-purge module-id)
(lib-module-purge module-id {:keys [lang]})

purges modules

purges modules
raw docstring

lib-module-unusedclj

(lib-module-unused)
(lib-module-unused module-id)
(lib-module-unused module-id {:keys [lang]})

lists unused modules

lists unused modules
raw docstring

lib-overviewclj

(lib-overview)
(lib-overview lang)

specifies lib overview task

specifies lib overview task
raw docstring

lint-clearclj

(lint-clear)

clears all linted namespaces

clears all linted namespaces
raw docstring

lint-setclj

(lint-set ns)
(lint-set ns option)

sets the linter for a namespace

sets the linter for a namespace
raw docstring

macro-formclj

(macro-form)

gets the current macro form

gets the current macro form
raw docstring

macro-grammarclj

(macro-grammar)

gets the current grammar

gets the current grammar
raw docstring

macro-optsclj

(macro-opts)

gets current macro-opts

gets current macro-opts
raw docstring

module-entriesclj

(module-entries lang ns pred)

gets all module entries

(w/module-entries :xtalk 'xt.lang.base-lib identity) => coll?

gets all module entries

(w/module-entries :xtalk 'xt.lang.base-lib identity)
=> coll?
raw docstring

(print-module)
(print-module lang-or-rt)

emits and prints out the module

(std.print/with-out-str (w/print-module (l/rt 'xt.lang.base-lib :xtalk))) => string?

emits and prints out the module

(std.print/with-out-str
  (w/print-module (l/rt 'xt.lang.base-lib :xtalk)))
=> string?
raw docstring

ptr-clipclj

(ptr-clip ptr)

copies pointer text to clipboard

copies pointer text to clipboard
raw docstring

ptr-display-strclj

(ptr-display-str ptr)

copies pointer text to clipboard

copies pointer text to clipboard
raw docstring

ptr-printclj

(ptr-print ptr)

copies pointer text to clipboard

copies pointer text to clipboard
raw docstring

ptr-setupclj

(ptr-setup ptr)

calls setup on a pointer

calls setup on a pointer
raw docstring

ptr-setup-depsclj

(ptr-setup-deps ptr)

calls setup on a pointer and all dependencies

calls setup on a pointer and all dependencies
raw docstring

ptr-teardownclj

(ptr-teardown ptr)

calls teardown on a pointer

calls teardown on a pointer
raw docstring

ptr-teardown-depsclj

(ptr-teardown-deps ptr)

calls teardown on pointer all dependencies

calls teardown on pointer all dependencies
raw docstring

purge-book!clj

(purge-book! lib lang)

clears all modules from book

clears all modules from book
raw docstring

remove-listenerclj

(remove-listener notify id sink-key)

removes a listener from the sink

removes a listener from the sink
raw docstring

rt-macro-optsclj

(rt-macro-opts lang-or-runtime)

creates the default macro-opts for a runtime

creates the default macro-opts for a runtime
raw docstring

rt:innerclj

(rt:inner)
(rt:inner lang & [ns])

gets the inner client for a shared runtime

gets the inner client for a shared runtime
raw docstring

rt:invokeclj

(rt:invoke ns lang code)

invokes code in the given namespace

invokes code in the given namespace
raw docstring

rt:moduleclj

(rt:module lang-or-rt)

gets the book module for a runtime

gets the book module for a runtime
raw docstring

rt:module-metaclj

(rt:module-meta lang-or-rt)

gets the book module for a runtime

gets the book module for a runtime
raw docstring

rt:module-purgeclj

(rt:module-purge)
(rt:module-purge lang-or-rt)

purges the current workspace

purges the current workspace
raw docstring

rt:restartclj

(rt:restart)
(rt:restart lang & [ns])

restarts the shared runtime

restarts the shared runtime
raw docstring

rt:scaffoldclj

(rt:scaffold lang)
(rt:scaffold rt module-id)

rt:scaffold-importsclj

(rt:scaffold-imports lang)
(rt:scaffold-imports rt module-id)

rt:scaffold-toclj

(rt:scaffold-to lang)
(rt:scaffold-to rt module-id)

rt:setupclj

(rt:setup lang)
(rt:setup rt module-id)

rt:setup-singleclj

(rt:setup-single lang)
(rt:setup-single rt module-id)

rt:setup-toclj

(rt:setup-to lang)
(rt:setup-to rt module-id)

rt:spaceclj

(rt:space lang & [namespace])

will return space if not found (no default space)

will return space if not found (no default space)
raw docstring

rt:teardownclj

(rt:teardown lang)
(rt:teardown rt module-id)

rt:teardown-atclj

(rt:teardown-at lang)
(rt:teardown-at rt module-id)

rt:teardown-singleclj

(rt:teardown-single lang)
(rt:teardown-single rt module-id)

rt:teardown-toclj

(rt:teardown-to lang)
(rt:teardown-to rt module-id)

runtime-libraryclj

(runtime-library)

gets the current runtime (annex or default)

(runtime-library) => lib/library?

gets the current runtime (annex or default)

(runtime-library)
=> lib/library?
raw docstring

scriptcljmacro

(script lang)
(script lang module)
(script lang module config)

script macro

script macro
raw docstring

script+cljmacro

(script+ [tag lang])
(script+ [tag lang] config)

macro for test extension setup

macro for test extension setup
raw docstring

script-cljmacro

(script- lang)
(script- lang config)

macro for test setup

macro for test setup
raw docstring

script-rt-stopclj

(script-rt-stop)
(script-rt-stop lang)
(script-rt-stop lang ns)

stops the current runtime

stops the current runtime
raw docstring

sym-default-strclj

(sym-default-str sym)

default fast symbol conversion

default fast symbol conversion
raw docstring

sym-entryclj

(sym-entry lang sym)

gets the entry using a symbol

gets the entry using a symbol
raw docstring

sym-fullclj

(sym-full {:keys [module id]})
(sym-full module id)

creates a full symbol

creates a full symbol
raw docstring

sym-idclj

(sym-id id)

gets the symbol id

gets the symbol id
raw docstring

sym-moduleclj

(sym-module id)

gets the symbol namespace

gets the symbol namespace
raw docstring

sym-pairclj

(sym-pair id)

gets the symbol pair

(sym-pair 'L.core/identity) => '[L.core identity]

gets the symbol pair

(sym-pair 'L.core/identity)
=> '[L.core identity]
raw docstring

tmpl-entryclj

(tmpl-entry s)

forms for various argument types

forms for various argument types
raw docstring

tmpl-macroclj

(tmpl-macro [s args {:keys [property optional vargs empty]}])

forms for various argument types

forms for various argument types
raw docstring

with-tracecljmacro

(with-trace & body)

form to control trace option

form to control `trace` option
raw docstring

with:cache-forcecljmacro

(with:cache-force & body)

forces the cache to update

forces the cache to update
raw docstring

with:cache-nonecljmacro

(with:cache-none & body)

skips the cache

skips the cache
raw docstring

with:clipcljmacro

(with:clip & body)

form to control clip option

form to control `clip` option
raw docstring

with:emitcljmacro

(with:emit & body)

binds the top-level emit function to common/emit-fn

(emit/with:emit (common/emit-fn '(not (+ 1 2 3)) +grammar+ {})) => "!(1 + 2 + 3)"

binds the top-level emit function to common/*emit-fn*

(emit/with:emit
 (common/*emit-fn* '(not (+ 1 2 3))
                   +grammar+
                   {}))
=> "!(1 + 2 + 3)"
raw docstring

with:explodecljmacro

(with:explode & body)

form to control explode option

form to control `explode` option
raw docstring

with:inputcljmacro

(with:input & body)

form to control input option

form to control `input` option
raw docstring

with:librarycljmacro

(with:library [lib] & body)

injects a library as the default

injects a library as the default
raw docstring

with:macro-optscljmacro

(with:macro-opts [mopts] & body)

bind macro opts

bind macro opts
raw docstring

with:printcljmacro

(with:print & body)

form to control print option

form to control `print` option
raw docstring

with:print-allcljmacro

(with:print-all & body)

toggles print for all intermediate steps

toggles print for all intermediate steps
raw docstring

with:rawcljmacro

(with:raw & body)

form to control raw option

form to control `raw` option
raw docstring

with:rtcljmacro

(with:rt [rt] & body)

forcibly applies a runtime

forcibly applies a runtime
raw docstring

with:rt-wrapcljmacro

(with:rt-wrap [f] & body)

wraps an additional function to the invoke function

wraps an additional function to the invoke function
raw 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