1 ! Copyright (C) 2007 Chris Double.
2 ! See http://factorcode.org/license.txt for BSD license.
3 USING: help.markup help.syntax kernel quotations strings words ;
13 "Given the input string, parse it using the given parser. The result is the abstract "
14 "syntax tree returned by the parser." }
15 { $see-also compile } ;
23 "Compile the parser to a word. The word will have stack effect ( -- ast )."
33 "Returns a parser that matches the given string." } ;
41 "Returns a parser that calls the quotation on the first character of the input string, "
42 "succeeding if that quotation returns true. The AST is the character from the string." } ;
46 { "min" "a character" }
47 { "max" "a character" }
51 "Returns a parser that matches a single character that lies within the range of characters given, inclusive." }
52 { $examples { $code ": digit ( -- parser ) CHAR: 0 CHAR: 9 range ;" } } ;
56 { "seq" "a sequence of parsers" }
60 "Returns a parser that calls all parsers in the given sequence, in order. The parser succeeds if "
61 "all the parsers succeed, otherwise it fails. The AST produced is a sequence of the AST produced by "
62 "the individual parsers." } ;
66 { "seq" "a sequence of parsers" }
70 "Returns a parser that will try all the parsers in the sequence, in order, until one succeeds. "
71 "The resulting AST is that produced by the successful parser." } ;
78 "Returns a parser that parses 0 or more instances of the " { $snippet "parser" } ". The AST produced is "
79 "an array of the AST produced by the " { $snippet "parser" } ". An empty array indicates 0 instances were "
87 "Returns a parser that parses 1 or more instances of the " { $snippet "parser" } ". The AST produced is "
88 "an array of the AST produced by the " { $snippet "parser" } "." } ;
95 "Returns a parser that parses 0 or 1 instances of the " { $snippet "parser" } ". The AST produced is "
96 { $link f } " if 0 instances are parsed, otherwise it is the AST produced by " { $snippet "parser" } "." } ;
101 { "quot" { $quotation ( object -- ? ) } }
104 "Returns a parser that succeeds if the " { $snippet "parser" } " succeeds and the quotation called with "
105 "the AST produced by " { $snippet "parser" } " on the stack returns true." }
107 { $example "USING: kernel math peg prettyprint ;" "\"C\" [ drop t ] satisfy [ 66 > ] semantic parse ." "67" }
115 "Returns a parser that succeeds if the " { $snippet "parser" } " succeeds but does not add anything to the "
116 "AST and does not move the location in the input string. This can be used for lookahead and "
117 "disambiguation, along with the " { $link ensure-not } " word." }
118 { $examples { $code "\"0\" token ensure octal-parser" } } ;
125 "Returns a parser that succeeds if the " { $snippet "parser" } " fails but does not add anything to the "
126 "AST and does not move the location in the input string. This can be used for lookahead and "
127 "disambiguation, along with the " { $link ensure } " word." }
128 { $code "\"+\" token \"=\" token ensure-not \"+=\" token 3array seq" } ;
133 { "quot" { $quotation ( ast -- ast ) } }
136 "Returns a parser that calls the " { $snippet "parser" } " and applies the quotation to the AST resulting "
137 "from that parse. The result of the quotation is then used as the final AST. This can be used "
138 "for manipulating the parse tree to produce a AST better suited for the task at hand rather than "
139 "the default AST. If the quotation returns " { $link fail } " then the parser fails." }
140 { $code "CHAR: 0 CHAR: 9 range [ to-digit ] action" } ;
147 "Returns a parser that calls the original " { $snippet "parser" } " after stripping any whitespace "
148 " from the left of the input string." } ;
155 "Returns a parser that succeeds if the original parser succeeds, but does not "
156 "put any result in the AST. Useful for ignoring 'syntax' in the AST." }
157 { $code "\"[\" token hide number \"]\" token hide 3array seq" } ;
165 "Delays the construction of a parser until it is actually required to parse. This "
166 "allows for calling a parser that results in a recursive call to itself. The quotation "
167 "should return the constructed parser and is called the first time the parser is run. "
168 "The compiled result is memoized for future runs. See " { $link box } " for a word "
169 "that calls the quotation at compile time." } ;
177 "Delays the construction of a parser until the parser is compiled. The quotation "
178 "should return the constructed parser and is called when the parser is compiled. "
179 "The compiled result is memoized for future runs. See " { $link delay } " for a word "
180 "that calls the quotation at runtime." } ;