diff --git a/src/bindings/php/hammer.xml b/src/bindings/php/hammer.xml
index 2172292..9f72737 100644
--- a/src/bindings/php/hammer.xml
+++ b/src/bindings/php/hammer.xml
@@ -58,12 +58,12 @@
- HParseResult parse(string input)
+ object HParseResult parse(string str)
Parse an input
Top-level function to call a parser that has been built over some piece of input.
-
+ -->
int compile(string backend, array params)
Generate parse tables for the given parsing backend
@@ -76,7 +76,7 @@
- object benchmark(array testcases)
+ object HBenchmarkResults benchmark(array testcases)
Benchmark this parser using all the applicable parsing backends against a set of test cases you provide
@@ -86,7 +86,7 @@
- HParseResult hammer_token(string token)
+ object HParser hammer_token(string token)
Parse a token (primitive)
Given a string, returns a parser that parses that string value.
@@ -98,7 +98,7 @@
- HParseResult hammer_ch(string ch)
+ object HParser hammer_ch(string ch)
Parse a character (primitive)
Given a single character, returns a parser that parses that character.
@@ -110,7 +110,7 @@
- HParseResult hammer_ch_range(string lower, string upper)
+ object HParser hammer_ch_range(string lower, string upper)
Parse a character within the given range (primitive)
Given two single-character bounds, lower and upper, returns a parser that parses a single character within the range [lower, upper] (inclusive).
@@ -122,7 +122,7 @@
- HParseResult hammer_int_range(HParser p, int lower, int upper)
+ object HParser hammer_int_range(object HParser p, int lower, int upper)
Parse an integer within the given range (primitive)
Given an integer parser, p, and two integer bounds, lower and upper, returns a parser that parses an integral value within the range [lower, upper] (inclusive).
@@ -134,7 +134,7 @@
- HParseResult hammer_bits(int len, bool sign)
+ object HParser hammer_bits(int len, bool sign)
Parse a specified number of bits (primitive)
Returns a parser that parses the specified number of bits. sign == true if signed, false if unsigned.
@@ -146,7 +146,7 @@
- HParseResult hammer_int64()
+ object HParser hammer_int64()
Parse a 64-bit signed integer (primitive)
Returns a parser that parses a signed 8-byte integer value.
@@ -158,7 +158,7 @@
- HParseResult hammer_int32()
+ object HParser hammer_int32()
Parse a 32-bit signed integer (primitive)
Returns a parser that parses a signed 4-byte integer value.
@@ -170,7 +170,7 @@
- HParseResult hammer_int16()
+ object HParser hammer_int16()
Parse a 16-bit signed integer (primitive)
Returns a parser that parses a signed 2-byte integer value.
@@ -182,7 +182,7 @@
- HParseResult hammer_int8()
+ object HParser hammer_int8()
Parse an 8-bit signed integer (primitive)
Returns a parser that parses a signed 1-byte integer value.
@@ -194,7 +194,7 @@
- HParseResult hammer_uint64()
+ object HParser hammer_uint64()
Parse a 64-bit unsigned integer (primitive)
Returns a parser that parses an unsigned 8-byte integer value.
@@ -206,7 +206,7 @@
- HParseResult hammer_uint32()
+ object HParser hammer_uint32()
Parse a 32-bit unsigned integer (primitive)
Returns a parser that parses an unsigned 4-byte integer value.
@@ -218,7 +218,7 @@
- HParseResult hammer_uint16()
+ object HParser hammer_uint16()
Parse a 16-bit unsigned integer (primitive)
Returns a parser that parses an unsigned 2-byte integer value.
@@ -230,7 +230,7 @@
- HParseResult hammer_uint8()
+ object HParser hammer_uint8()
Parse an 8-bit unsigned integer (primitive)
Returns a parser that parses an unsigned 1-byte integer value.
@@ -242,7 +242,7 @@
- HParseResult hammer_whitespace(HParser p)
+ object HParser hammer_whitespace(object HParser p)
Parse something preceded by whitespace (higher-order)
Given a parser, p, returns a parser that skips any whitespace and then applies p.
@@ -254,7 +254,7 @@
- HParseResult hammer_left(HParser p, HParser q)
+ object HParser hammer_left(object HParser p, object HParser q)
Take the leftmost result of two parsers (higher-order)
Given two parsers, p and q, returns a parser that parses them in sequence but only returns p's result.
@@ -266,7 +266,7 @@
- HParseResult hammer_right(HParser p, HParser q)
+ object HParser hammer_right(object HParser p, object HParser q)
Take the rightmost result of two parsers (higher-order)
Given two parsers, p and q, returns a parser that parses them in sequence but only returns q's result.
@@ -278,7 +278,7 @@
- HParseResult hammer_middle(HParser p, HParser x, HParser q)
+ object HParser hammer_middle(object HParser p, object HParser x, object HParser q)
Take the middle result of three parsers (higher-order)
Given three parsers, p, x, and q, returns a parser that parses them in sequence but only returns x's result.
@@ -290,7 +290,7 @@
- HParseResult hammer_action(HParser p, callable f)
+ object HParser hammer_action(object HParser p, callback f)
Attach a semantic action to a parser (higher-order)
Given another parser, p, and a function, f, returns a parser that applies p, then applies f to everything in the AST of p's result.
@@ -302,7 +302,7 @@
- HParseResult hammer_in(string charset)
+ object HParser hammer_in(string charset)
Parse a character that appears in charset (primitive)
Parse a single character in the given charset.
@@ -314,7 +314,7 @@
- HParseResult hammer_not_in(string charset)
+ object HParser hammer_not_in(string charset)
Parse a character that does not appear in charset (primitive)
Parse a single character *not* in the given charset.
@@ -326,7 +326,7 @@
- HParseResult hammer_end_p()
+ object HParser hammer_end_p()
Recognize the end-of-input (primitive)
A no-argument parser that succeeds if there is no more input to parse.
@@ -338,7 +338,7 @@
- HParseResult hammer_nothing_p()
+ object HParser hammer_nothing_p()
This parser always fails (primitive)
hammer_nothing_p is primarily useful when stubbing out a larger parser. If you define a rule as hammer_nothing_p(), the top-level parser will run, but if a rule containing hammer_nothing_p is invoked, the parse will fail.
@@ -350,7 +350,7 @@
- HParseResult hammer_sequence(array p_array)
+ object HParser hammer_sequence(array p_array)
Apply a list of parsers sequentially (higher-order)
Given an array of parsers, p_array, apply each parser in order. The parse succeeds only if all parsers succeed.
@@ -362,7 +362,7 @@
- HParseResult hammer_choice(array p_array)
+ object HParser hammer_choice(array p_array)
Apply any one of a list of parsers (higher-order)
Given an array of parsers, p_array, apply each parser in order. The first parser to succeed produces the result; if no parsers succeed, the parse fails.
@@ -374,7 +374,7 @@
- HParseResult hammer_butnot(HParser p1, HParser p2)
+ object HParser hammer_butnot(object HParser p1, object HParser p2)
Parse p1 but not p2 (higher-order)
Given two parsers, p1 and p2, this parser succeeds in the following cases:
@@ -389,7 +389,7 @@
- HParseResult hammer_difference(HParser p1, HParser p2)
+ object HParser hammer_difference(object HParser p1, object HParser p2)
Parse p1 but not p2 (higher-order)
Given two parsers, p1 and p2, this parser succeeds in the following cases:
@@ -404,7 +404,7 @@
- HParseResult hammer_xor(HParser p1, HParser p2)
+ object HParser hammer_xor(object HParser p1, object HParser p2)
Parse p1 or p2 but not both (higher-order)
Given two parsers, p1 and p2, this parser suceeds if *either* p1 or p2 succeed, but not if they both do.
@@ -416,7 +416,7 @@
- HParseResult hammer_many(HParser p)
+ object HParser hammer_many(object HParser p)
Parse zero or more instances of p (higher-order)
Given a parser, p, this parser succeeds for zero or more repetitions of p.
@@ -428,7 +428,7 @@
- HParseResult hammer_many1(HParser p)
+ object HParser hammer_many1(object HParser p)
Parse one or more instances of p (higher-order)
Given a parser, p, this parser succeeds for one or more repetitions of p.
@@ -440,7 +440,7 @@
- HParseResult hammer_repeat_n(HParser p, int n)
+ object HParser hammer_repeat_n(object HParser p, int n)
Parse exactly n instances of p (higher-order)
Given a parser, p, this parser succeeds for exactly N repetitions of p.
@@ -452,7 +452,7 @@
- HParseResult hammer_optional(HParser p)
+ object HParser hammer_optional(object HParser p)
Mark a parser as optional, like ? in regular expressions (higher-order)
Given a parser, p, this parser succeeds with the value p parsed or with an empty result.
@@ -464,7 +464,7 @@
- HParseResult hammer_ignore(HParser p)
+ object HParser hammer_ignore(object HParser p)
Apply p but leave its result out of the final AST (higher-order)
Given a parser, p, this parser succeeds if p succeeds, but doesn't include p's result in the final result.
@@ -476,7 +476,7 @@
- HParseResult hammer_sepBy(HParser p, HParser sep)
+ object HParser hammer_sepBy(object HParser p, object HParser sep)
Parse a (possibly empty) sequence of values separated by a separator (higher-order)
Given a parser, p, and a parser for a separator, sep, this parser matches a (possibly empty) list of things that p can parse, separated by sep. For example, if p is hammer_many1(hammer_ch_range('0', '9')) and sep is hammer_ch(','), hammer_sepBy(p, sep) will match a comma-separated list of integers.
@@ -488,7 +488,7 @@
- HParseResult hammer_sepBy1(HParser p, HParser sep)
+ object HParser hammer_sepBy1(object HParser p, object HParser sep)
Parse a sequence of values separated by a separator (higher-order)
Given a parser, p, and a parser for a separator, sep, this parser matches a list of things that p can parse, separated by sep. Unlike hammer_sepBy, this ensures that the result has at least one element. For example, if p is hammer_many(hammer_ch_range('0', '9')), hammer_sepBy1(p, sep) will match a comma-separated list of integers.
@@ -500,7 +500,7 @@
- HParseResult hammer_epsilon_p()
+ object HParser hammer_epsilon_p()
Parse the empty string (primitive)
This parser always returns a zero-length match, i.e., the empty string.
@@ -512,7 +512,7 @@
- HParseResult hammer_length_value(HParser length, HParser value)
+ object HParser hammer_length_value(object HParser length, object HParser value)
Parse (length) repetitions of (value) (higher-order)
This parser applies its first argument to read an unsigned integer value, then applies its second argument that many times. length should produce an integer value; this is checked at runtime. Specifically, length's token type must be int.
@@ -524,7 +524,7 @@
- HParseResult hammer_attr_bool(HParser p, callable pred)
+ object HParser hammer_attr_bool(object HParser p, callback pred)
Ensure that some property holds for the AST (higher-order)
This parser attaches a predicate function, which returns true or false, to a parser. The function is evaluated over the parser's result. The parse only succeeds if pred returns true.
@@ -538,7 +538,7 @@
- HParseResult hammer_and(HParser p)
+ object HParser hammer_and(object HParser p)
Verify that p succeeds, but don't actually apply it (higher-order)
This parser asserts that a conditional syntax is satisfied, but doesn't consume that conditional syntax. This is useful for lookahead. As an example:
@@ -558,7 +558,7 @@
- HParseResult hammer_not(HParser p)
+ object HParser hammer_not(object HParser p)
Verify that p does not succeed, and don't consume any input (higher-order)
This parser asserts that a conditional syntax is *not* satisfied, and doesn't consume the additional syntax. As a somewhat contrived example:
@@ -580,7 +580,7 @@
- HParseResult hammer_indirect()
+ object HParser hammer_indirect()
Forward-declare a parser to be used recursively (higher-order)
Create a parser that calls out to another, as yet unknown, parser. Note that the inner parser must be bound later, using hammer_bind_indirect(). This can be used to create recursive parsers.
@@ -592,7 +592,7 @@
- void hammer_bind_indirect(HParser p)
+ void hammer_bind_indirect(object HParser p)
Set the inner parser of an indirect parser.
See hammer_indirect() for details.