fif.stack-machine.words — fif-lang/fif 1.4.0

Functions for realizing word functions and word variables.

get-global-metadata clj/s

(get-global-metadata sm wname)

Gets the metadata for the given wname word definition.

get-global-word clj/s

(get-global-word sm name)

Gets a word definition within the global scope.

get-metadata clj/s

(get-metadata sm wname)

Gets the word metadata in the local scope.

get-metadata-listing clj/s

(get-metadata-listing sm)

Merges the metadata from each scope into a single map consistingof all word key with word metadata value pairs.

get-word clj/s

(get-word sm name)

Gets a word definition within the current scope of the stack-machine.

get-word-listing clj/s

(get-word-listing sm)

Merges the words from each scope into a single map consisting of all word key and word definition value pairs.

not-found clj/s

set-global-meta clj/s

(set-global-meta
  sm
  wname
  &
  {:keys [doc source group stdlib? variable?]
   :or {doc nil source nil group nil stdlib? false variable? false}})

Sets the metadata for a particular global word definition, which consists of the keys :doc, :source, :stdlib? and :variable?.

Meta Data Keys:

:doc - Is a string explaining the given word definition.

:source - If it is a word definition defined within fif, this will contain the word definition source code in the form of an EDN vector collectionconsisting of the source.

:group - Set the word definition to a particular key group ex. :stdlib.collection

:stdlib? - If true, the word definition is part of the fif standard libraries.

:variable? - If true, the word definition is a single value data value or data collection.

set-global-metadata clj/s

(set-global-metadata sm wname wmeta)

Sets metadata for the given wname which is an independent data-store containing information on the word definition defined by wname in the form of wmeta. wmeta should be a map of key values describing the word definition.

set-global-word clj/s

(set-global-word sm name wfunc)

Sets a word definition within the global scope.

set-global-word-defn clj/s

(set-global-word-defn
  sm
  wname
  wfunc
  &
  {:keys [doc source group stdlib? variable?]
   :or {doc nil source nil group nil stdlib? false variable? false}})

Used to set a word definition function while conveniently allowing you to set the metadata as well.

set-local-meta clj/s

(set-local-meta
  sm
  wname
  &
  {:keys [doc source group stdlib? variable?]
   :or {doc nil source nil group nil stdlib? false variable? false}})

Sets the metadata for a particular global word definition, which consists of the keys :doc, :source, :stdlib? and :variable?.

Meta Data Keys:

:doc - Is a string explaining the given word definition.

:source - If it is a word definition defined within fif, this will contain the word definition source code in the form of an EDN vector collectionconsisting of the source.

:group - Set the word definition to a particular key group ex. :stdlib.collection

:stdlib? - If true, the word definition is part of the fif standard libraries.

:variable? - If true, the word definition is a single value data value or data collection.

set-local-word-defn clj/s

(set-local-word-defn
  sm
  wname
  wfunc
  &
  {:keys [doc source group stdlib? variable?]
   :or {doc nil source nil group nil stdlib? false variable? false}})

Used to set a word definition function while conveniently allowing you to set the metadata as well.

set-metadata clj/s

(set-metadata sm wname wmeta)

Sets the word metadata in the local scope.

set-word clj/s

(set-word sm name wfunc)

Sets a word definition within the current scope with the given name. wfunc is a function which takes the current stack-machine, and performs an operation within the given stack machine.

update-global-metadata clj/s

(update-global-metadata sm wname f & args)

update-metadata clj/s

(update-metadata sm wname f & args)