From 5d74f1ee9455cf4084ec2b96a0103503a0a64ae0 Mon Sep 17 00:00:00 2001
From: Richard Newman <rnewman@twinql.com>
Date: Wed, 1 Feb 2017 18:01:50 -0800
Subject: [PATCH] Add utilities for defining parsers. (#218) r=vporof

satisfy_unwrap and ResultParser go into mentat_parser_utils.
---
 parser-utils/Cargo.toml         |  3 +-
 parser-utils/src/lib.rs         | 23 +++++++++-
 query-parser/src/parser_util.rs | 74 +++++++++++++++++++++++++++++++++
 3 files changed, 98 insertions(+), 2 deletions(-)
 create mode 100644 query-parser/src/parser_util.rs

diff --git a/parser-utils/Cargo.toml b/parser-utils/Cargo.toml
index f0c4636a..5d2a2f1c 100644
--- a/parser-utils/Cargo.toml
+++ b/parser-utils/Cargo.toml
@@ -1,6 +1,7 @@
 [package]
 name = "mentat_parser_utils"
 version = "0.1.0"
-authors = ["Victor Porof <vporof@mozilla.com>"]
+authors = ["Victor Porof <vporof@mozilla.com>", "Richard Newman <rnewman@mozilla.com>"]
 
 [dependencies]
+combine = "2.1.1"
diff --git a/parser-utils/src/lib.rs b/parser-utils/src/lib.rs
index b20d9dbd..6ea176f5 100644
--- a/parser-utils/src/lib.rs
+++ b/parser-utils/src/lib.rs
@@ -8,6 +8,18 @@
 // CONDITIONS OF ANY KIND, either express or implied. See the License for the
 // specific language governing permissions and limitations under the License.
 
+extern crate combine;
+
+use combine::ParseResult;
+use combine::combinator::{Expected, FnParser};
+
+// A type definition for a function parser that either parses an `O` from an input stream of type
+// `I`, or fails with an "expected" failure.
+// See <https://docs.rs/combine/2.2.1/combine/trait.Parser.html#method.expected> for more
+// illumination.
+// Nothing about this is specific to the result type of the parser.
+pub type ResultParser<O, I> = Expected<FnParser<I, fn(I) -> ParseResult<O, I>>>;
+
 /// `assert_parses_to!` simplifies some of the boilerplate around running a
 /// parser function against input and expecting a certain result.
 #[macro_export]
@@ -17,4 +29,13 @@ macro_rules! assert_parses_to {
         let result = par.parse(&$input[..]);
         assert_eq!(result, Ok(($expected, &[][..])));
     }}
-}
\ No newline at end of file
+}
+
+/// `satisfy_unwrap!` makes it a little easier to implement a `satisfy_map`
+/// body that matches a particular `Value` enum case, otherwise returning `None`.
+#[macro_export]
+macro_rules! satisfy_unwrap {
+    ( $cas: path, $var: ident, $body: block ) => {
+        satisfy_map(|x: edn::Value| if let $cas($var) = x $body else { None })
+    }
+}
diff --git a/query-parser/src/parser_util.rs b/query-parser/src/parser_util.rs
new file mode 100644
index 00000000..5cf51958
--- /dev/null
+++ b/query-parser/src/parser_util.rs
@@ -0,0 +1,74 @@
+// Copyright 2016 Mozilla
+//
+// Licensed under the Apache License, Version 2.0 (the "License"); you may not use
+// this file except in compliance with the License. You may obtain a copy of the
+// License at http://www.apache.org/licenses/LICENSE-2.0
+// Unless required by applicable law or agreed to in writing, software distributed
+// under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR
+// CONDITIONS OF ANY KIND, either express or implied. See the License for the
+// specific language governing permissions and limitations under the License.
+
+extern crate combine;
+extern crate edn;
+extern crate mentat_query;
+
+/// Generate a `satisfy_map` expression that matches a `PlainSymbol`
+/// value with the given name.
+///
+/// We do this rather than using `combine::token` so that we don't
+/// need to allocate a new `String` inside a `PlainSymbol` inside a `Value`
+/// just to match input.
+macro_rules! matches_plain_symbol {
+    ($name: expr, $input: ident) => {
+        satisfy_map(|x: edn::Value| {
+            if let edn::Value::PlainSymbol(ref s) = x {
+                if s.0.as_str() == $name {
+                    return Some(());
+                }
+            }
+            return None;
+        }).parse_stream($input)
+    }
+}
+
+/// Define an `impl` body for the `$parser` type. The body will contain a parser
+/// function called `$name`, consuming a stream of `$item_type`s. The parser's
+/// result type will be `$result_type`.
+///
+/// The provided `$body` will be evaluated with `$input` bound to the input stream.
+///
+/// `$body`, when run, should return a `ParseResult` of the appropriate result type.
+macro_rules! def_parser_fn {
+    ( $parser: ident, $name: ident, $item_type: ty, $result_type: ty, $input: ident, $body: block ) => {
+        impl<I> $parser<I> where I: Stream<Item = $item_type> {
+            fn $name() -> ResultParser<$result_type, I> {
+                fn inner<I: Stream<Item = $item_type>>($input: I) -> ParseResult<$result_type, I> {
+                    $body
+                }
+                parser(inner as fn(I) -> ParseResult<$result_type, I>).expected("$name")
+            }
+        }
+    }
+}
+
+/// `def_value_parser_fn` is a short-cut to `def_parser_fn` with the input type
+/// being `edn::Value`.
+macro_rules! def_value_parser_fn {
+    ( $parser: ident, $name: ident, $result_type: ty, $input: ident, $body: block ) => {
+        def_parser_fn!($parser, $name, edn::Value, $result_type, $input, $body);
+    }
+}
+
+/// `def_value_satisfy_parser_fn` is a short-cut to `def_parser_fn` with the input type
+/// being `edn::Value` and the body being a call to `satisfy_map` with the given transformer.
+///
+/// In practice this allows you to simply pass a function that accepts an `&edn::Value` and
+/// returns an `Option<$result_type>`: if a suitable value is at the front of the stream,
+/// it will be converted and returned by the parser; otherwise, the parse will fail.
+macro_rules! def_value_satisfy_parser_fn {
+    ( $parser: ident, $name: ident, $result_type: ty, $transformer: path ) => {
+        def_value_parser_fn!($parser, $name, $result_type, input, {
+            satisfy_map(|x: edn::Value| $transformer(&x)).parse_stream(input)
+        });
+    }
+}