ForthVM v0.5.0

ForthVM.Dictionary (ForthVM v0.5.0) View Source

Dictionary utilities

Link to this section Summary

Functions

add(dictionary, word_name, word, doc \\ %{stack: "( )", doc: ""})
add_const(dictionary, word_name, value)
add_var(dictionary, word_name, value \\ nil)
get(dictionary, word_name)
get_var(dictionary, word_name)
new()
print_word_doc(dictionary, device, word_name, width \\ nil)
register_module_word_from_doc(module, doc, dictionary)
register_module_words(module, dictionary)

Automatically register all module's functions that have a doc matching "{word_name}: ({in} -- {out}) {doc}"

set_var(dictionary, word_name, value)

Link to this section Functions

Link to this function

add(dictionary, word_name, word, doc \\ %{stack: "( )", doc: ""})

View Source
Link to this function

add_const(dictionary, word_name, value)

View Source

Specs

add_const(map(), any(), any()) :: map()
Link to this function

add_var(dictionary, word_name, value \\ nil)

View Source
Link to this function

get(dictionary, word_name)

View Source
Link to this function

get_var(dictionary, word_name)

View Source
Link to this function

new()

View Source
Link to this function

register_module_word_from_doc(module, doc, dictionary)

View Source
Link to this function

register_module_words(module, dictionary)

View Source

Automatically register all module's functions that have a doc matching "{word_name}: ({in} -- {out}) {doc}"

Link to this function

set_var(dictionary, word_name, value)

View Source