kalevala v0.1.0 Kalevala.Character.Command.RouterMacros View Source

Set of macros to build a command router using NimbleParsec

Link to this section Summary

Functions

command(command)

Wraps NimbleParsec macros to generate a tagged command

dynamic(arg, command, arguments)

Handle dynamic parsing

generate_parse_function(command, command_alias, fun, parse_fun, module \\ nil)

module(arg, list)

Sets the @module tag for parse functions nested inside

parse(command, fun, opts \\ [], parse_fun \\ nil)

Parse a new command

parse_dynamic_text(module, arguments, text)

parse_text(module, fun, command, arg)

spaces(parsec)

Wraps NimbleParsec macros to allow for grabbing spaces

symbol(parsec \\ NimbleParsec.empty(), character)

text(parsec, tag)

Wraps NimbleParsec macros to generate tagged text

word(parsec, tag)

Wraps NimbleParsec macros to generate a tagged word

Link to this section Functions

command(command)

(macro)

Wraps NimbleParsec macros to generate a tagged command

dynamic(arg, command, arguments)

(macro)

Handle dynamic parsing

This runs the parse/2 function on the given module at runtime. This enables parsing things against runtime only data.

generate_parse_function(command, command_alias, fun, parse_fun, module \\ nil)

module(arg, list)

(macro)

Sets the @module tag for parse functions nested inside

parse(command, fun, opts \\ [], parse_fun \\ nil)

(macro)

Parse a new command

command starts out the parse and any whitespace afterwards will be ignored

parse_dynamic_text(module, arguments, text)

parse_text(module, fun, command, arg)

spaces(parsec)

(macro)

Wraps NimbleParsec macros to allow for grabbing spaces

Grabs between other pieces of the command

symbol(parsec \\ NimbleParsec.empty(), character)

(macro)

text(parsec, tag)

(macro)

Wraps NimbleParsec macros to generate tagged text

This grabs as much as it can

word(parsec, tag)

(macro)

Wraps NimbleParsec macros to generate a tagged word

Words are codepoints that don't include a space, or everything inside of quotes.

Both of the following count as a word:

villager
"town crier"