com.fulcrologic.statecharts.state-machine — com.fulcrologic/statecharts 1.0.0-alpha1

Implementation using a close approximation of https://www.w3.org/TR/2015/REC-scxml-20150901, including the suggested algorithm in that document, translated as closely as possible to CLJC. Future versions of the specification will appear as new namespaces to maintain compatibility through time.

::sc/k in the docstrings of this namespace assumes the alias [com.fulcrologic.statecharts :as sc], which can be generated as only an alias, though an empty namespace of that name does exist.

all-descendants clj/s

(all-descendants machine s)

Returns a set of IDs of the (recursive) descendants (children) of s

assign-parents clj/s

(assign-parents {parent-id :id initial :initial :as parent} nodes)

atomic-state? clj/s

(atomic-state? machine element-or-id)

child-states clj/s

(child-states machine element-or-id)

Find all of the immediate children (IDs) of element-or-id that are states (final, element-or-id, or parallel)

compound-state? clj/s

(compound-state? machine element-or-id)

Returns true if the given state contains other states.

descendant? clj/s

(descendant? machine s1 s2)

element clj/s

(element machine element-or-id)

Find the node in the machine that has the given ID (of any type)

element-id clj/s

(element-id machine element-or-id)

entry-handlers clj/s

(entry-handlers machine element-or-id)

exit-handlers clj/s

(exit-handlers machine element-or-id)

Returns the immediate child elements that are on-exit.

final-state? clj/s

(final-state? machine element-or-id)

find-least-common-compound-ancestor clj/s

(find-least-common-compound-ancestor machine states)

Returns the ELEMENT that is the common compound ancestor of all the states. NOTE: This may be the state machine itself. The compound state returned will be the one closest to all of the states.

get-children clj/s

(get-children machine element-or-id type)

Returns the ID of the child nodes of the given element-or-id which have the given type.

get-parent clj/s

(get-parent machine element-or-id)

Get the immediate parent (id) of the given element-or-id. Returns :ROOT if the parent is the root, and nil if the element queried is already the root.

get-parent-state clj/s

[machine element-or-id]

Alias for nearest-ancestor-state.

get-proper-ancestors clj/s

(get-proper-ancestors machine element-or-id)

(get-proper-ancestors machine element-or-id stopping-element-or-id)

Returns the node ids from machine that are proper ancestors of element-or-id (an id or actual element-or-id). If stopping-element-or-id-or-id is included, then that will stop the retrieval (not including the stopping element-or-id). The results are in the ancestry order (i.e. deepest element-or-id first).

history-element? clj/s

(history-element? machine element-or-id)

history-elements clj/s

(history-elements machine element-or-id)

ids-in-document-order clj/s

(ids-in-document-order machine)

(ids-in-document-order
  {desired-order :com.fulcrologic.statecharts/document-order :as machine}
  {:keys [id] :as node})

Returns the IDs of the states in the given node, in document order (not including the node itself). You can specify ::sc/document-order :breadth-first on the top-level machine definition to get a depth-first interpretation vs. breadth.

in-document-order clj/s

(in-document-order machine nodes-or-ids)

Given a set/sequence of actual nodes-or-ids (as maps), returns a vector of those nodes-or-ids, but in document order.

in-entry-order clj/s

[machine nodes]

Same as in-document-order.

in-exit-order clj/s

(in-exit-order machine nodes)

The reverse of in-document-order.

initial-element clj/s

(initial-element machine element-or-id)

Returns the element that represents the <initial> element of a compound state element-or-id. Returns nil if the element isn't a compound state.

invalid-history-elements clj/s

(invalid-history-elements machine)

Returns a sequence of history elements from machine that have errors. Each node will contain a :msgs key with the problem descriptions. This is a static check.

invocations clj/s

(invocations machine element-or-id)

Returns the IDs of the nodes that are invocations within element-or-id

machine clj/s

(machine {:keys [initial name binding] :as attrs} & children)

Create a new state machine definition that mimics the structure and semantics of SCXML.

Attributes:

::sc/document-order - :breadth-first or :depth-first (default). See Conformance.adoc. :initial - ID(s) of initial state(s) of the machine. Default is the top-most initial element, or the first element in document order. :name - Optional name :binding - :late or :early (default is :early)

nearest-ancestor-state clj/s

(nearest-ancestor-state machine element-or-id)

Returns the ID of the state (if any) that encloses the given element-or-id, or nil if there is no ancestor state.

parallel-state? clj/s

(parallel-state? machine element-or-id)

scxml clj/s

See machine. SCXML-compliant name for top-level element.

source clj/s

[machine element-or-id] Returns the source (nearest ancestor that is a state element) of an element (meant to be used for transitions).

state? clj/s

(state? machine element-or-id)

transition-element clj/s

(transition-element machine element-or-id)

Returns the element that represents the first transition of element-or-id. This should only be used on nodes that have a single required transition, such as <initial> and <history> nodes.

transitions clj/s

(transitions machine element-or-id)

with-default-initial-state clj/s

(with-default-initial-state {:keys [id initial] :as parent} children)

Scans children for an initial state. If no such state is found then it creates one and sets the target to the first child that is a state.