unmaintained: New home for misfit Factor vocabularies.

[factor-unmaintained.git] / peg-lexer / peg-lexer-docs.factor

diff --git a/peg-lexer/peg-lexer-docs.factor b/peg-lexer/peg-lexer-docs.factor
new file mode 100644 (file)
index 0000000..df7c628
--- /dev/null
+++ b/peg-lexer/peg-lexer-docs.factor
@@ -0,0 +1,14 @@
+USING: peg.ebnf help.syntax help.markup strings ;
+IN: peg-lexer
+
+HELP: ON-BNF:
+{ $syntax "ON-BNF: word ... ;ON-BNF" }
+{ $description "Creates a parsing word using a parser for lexer control, adding the resulting ast to the stack.  Parser syntax is as in " { $link POSTPONE: EBNF: } } ;
+
+HELP: create-bnf
+{ $values { "name" string } { "parser" parser } }
+{ $description "Runtime equivalent of " { $link POSTPONE: ON-BNF: } " also useful with manually constructed parsers." } ;
+
+HELP: factor
+{ $values { "input" string } { "ast" "a sequence of tokens" } }
+{ $description "Tokenizer that acts like standard factor lexer, separating tokens by whitespace." } ;