From a4e8f799fb4665b210086c28647e0fa335384913 Mon Sep 17 00:00:00 2001
From: Nadrieril
Date: Sat, 13 Apr 2019 12:08:14 +0200
Subject: Clarify role of dhall_generated_parser crate

---
 Cargo.lock                                       |  20 ++--
 Cargo.toml                                       |   2 +-
 dhall_core/Cargo.toml                            |   2 +-
 dhall_core/src/parser.rs                         |   2 +-
 dhall_generated_parser/.gitignore                |   1 +
 dhall_generated_parser/Cargo.toml                |  19 +++
 dhall_generated_parser/build.rs                  |  64 ++++++++++
 dhall_generated_parser/src/dhall.abnf            |   1 +
 dhall_generated_parser/src/dhall.pest.visibility | 141 +++++++++++++++++++++++
 dhall_generated_parser/src/lib.rs                |  10 ++
 dhall_parser/.gitignore                          |   1 -
 dhall_parser/Cargo.toml                          |  19 ---
 dhall_parser/build.rs                            |  64 ----------
 dhall_parser/src/dhall.abnf                      |   1 -
 dhall_parser/src/dhall.pest.visibility           | 141 -----------------------
 dhall_parser/src/lib.rs                          |  14 ---
 16 files changed, 249 insertions(+), 253 deletions(-)
 create mode 100644 dhall_generated_parser/.gitignore
 create mode 100644 dhall_generated_parser/Cargo.toml
 create mode 100644 dhall_generated_parser/build.rs
 create mode 120000 dhall_generated_parser/src/dhall.abnf
 create mode 100644 dhall_generated_parser/src/dhall.pest.visibility
 create mode 100644 dhall_generated_parser/src/lib.rs
 delete mode 100644 dhall_parser/.gitignore
 delete mode 100644 dhall_parser/Cargo.toml
 delete mode 100644 dhall_parser/build.rs
 delete mode 120000 dhall_parser/src/dhall.abnf
 delete mode 100644 dhall_parser/src/dhall.pest.visibility
 delete mode 100644 dhall_parser/src/lib.rs

diff --git a/Cargo.lock b/Cargo.lock
index 2d143ea..a90b921 100644
--- a/Cargo.lock
+++ b/Cargo.lock
@@ -82,31 +82,31 @@ dependencies = [
 name = "dhall_core"
 version = "0.1.0"
 dependencies = [
- "dhall_parser 0.1.0",
+ "dhall_generated_parser 0.1.0",
  "iter_patterns 0.1.0",
  "itertools 0.8.0 (registry+https://github.com/rust-lang/crates.io-index)",
  "pest 2.1.0 (git+https://github.com/pest-parser/pest)",
 ]
 
 [[package]]
-name = "dhall_generator"
+name = "dhall_generated_parser"
 version = "0.1.0"
 dependencies = [
- "dhall_core 0.1.0",
- "itertools 0.8.0 (registry+https://github.com/rust-lang/crates.io-index)",
- "proc-macro2 0.4.27 (registry+https://github.com/rust-lang/crates.io-index)",
+ "abnf_to_pest 0.1.0",
+ "pest 2.1.0 (git+https://github.com/pest-parser/pest)",
+ "pest_generator 2.1.0 (registry+https://github.com/rust-lang/crates.io-index)",
  "quote 0.6.11 (registry+https://github.com/rust-lang/crates.io-index)",
- "syn 0.15.29 (registry+https://github.com/rust-lang/crates.io-index)",
 ]
 
 [[package]]
-name = "dhall_parser"
+name = "dhall_generator"
 version = "0.1.0"
 dependencies = [
- "abnf_to_pest 0.1.0",
- "pest 2.1.0 (git+https://github.com/pest-parser/pest)",
- "pest_generator 2.1.0 (registry+https://github.com/rust-lang/crates.io-index)",
+ "dhall_core 0.1.0",
+ "itertools 0.8.0 (registry+https://github.com/rust-lang/crates.io-index)",
+ "proc-macro2 0.4.27 (registry+https://github.com/rust-lang/crates.io-index)",
  "quote 0.6.11 (registry+https://github.com/rust-lang/crates.io-index)",
+ "syn 0.15.29 (registry+https://github.com/rust-lang/crates.io-index)",
 ]
 
 [[package]]
diff --git a/Cargo.toml b/Cargo.toml
index c2c0fae..fc7d003 100644
--- a/Cargo.toml
+++ b/Cargo.toml
@@ -4,7 +4,7 @@ cargo-features = ["profile-overrides"]
 members = [
     "abnf_to_pest",
     "dhall",
-    "dhall_parser",
+    "dhall_generated_parser",
     "dhall_core",
     "dhall_generator",
     "iter_patterns",
diff --git a/dhall_core/Cargo.toml b/dhall_core/Cargo.toml
index f4aaf10..f51318f 100644
--- a/dhall_core/Cargo.toml
+++ b/dhall_core/Cargo.toml
@@ -11,5 +11,5 @@ doctest = false
 [dependencies]
 itertools = "0.8.0"
 pest = { git = "https://github.com/pest-parser/pest" }
-dhall_parser = { path = "../dhall_parser" }
+dhall_generated_parser = { path = "../dhall_generated_parser" }
 iter_patterns = { path = "../iter_patterns" }
diff --git a/dhall_core/src/parser.rs b/dhall_core/src/parser.rs
index e83f8a4..2d47ad7 100644
--- a/dhall_core/src/parser.rs
+++ b/dhall_core/src/parser.rs
@@ -5,7 +5,7 @@ pub use pest::Span;
 use std::collections::BTreeMap;
 use std::path::PathBuf;
 
-use dhall_parser::{DhallParser, Rule};
+use dhall_generated_parser::{DhallParser, Rule};
 
 use crate::*;
 
diff --git a/dhall_generated_parser/.gitignore b/dhall_generated_parser/.gitignore
new file mode 100644
index 0000000..8a0bac6
--- /dev/null
+++ b/dhall_generated_parser/.gitignore
@@ -0,0 +1 @@
+src/dhall.pest
diff --git a/dhall_generated_parser/Cargo.toml b/dhall_generated_parser/Cargo.toml
new file mode 100644
index 0000000..9e4ae49
--- /dev/null
+++ b/dhall_generated_parser/Cargo.toml
@@ -0,0 +1,19 @@
+[package]
+name = "dhall_generated_parser"
+version = "0.1.0"
+authors = ["Nadrieril <nadrieril@users.noreply.github.com>"]
+license = "BSD-2-Clause"
+edition = "2018"
+build = "build.rs"
+
+[lib]
+test = false
+doctest = false
+
+[build-dependencies]
+abnf_to_pest = { path = "../abnf_to_pest" }
+pest_generator = "2.1"
+quote = "0.6.11"
+
+[dependencies]
+pest = { git = "https://github.com/pest-parser/pest" }
diff --git a/dhall_generated_parser/build.rs b/dhall_generated_parser/build.rs
new file mode 100644
index 0000000..615a55c
--- /dev/null
+++ b/dhall_generated_parser/build.rs
@@ -0,0 +1,64 @@
+use std::env;
+use std::fs::File;
+use std::io::{BufRead, BufReader, Read, Write};
+use std::path::Path;
+
+use abnf_to_pest::render_rules_to_pest;
+
+fn main() -> std::io::Result<()> {
+    // TODO: upstream changes to grammar
+    // let abnf_path = "../dhall-lang/standard/dhall.abnf";
+    let abnf_path = "src/dhall.abnf";
+    let visibility_path = "src/dhall.pest.visibility";
+    let pest_path = "src/dhall.pest";
+    println!("cargo:rerun-if-changed={}", abnf_path);
+    println!("cargo:rerun-if-changed={}", visibility_path);
+
+    let mut file = File::open(abnf_path)?;
+    let mut data = Vec::new();
+    file.read_to_end(&mut data)?;
+    data.push('\n' as u8);
+
+    let mut rules = abnf_to_pest::parse_abnf(&data)?;
+    for line in BufReader::new(File::open(visibility_path)?).lines() {
+        let line = line?;
+        if line.len() >= 2 && &line[0..2] == "# " {
+            rules.get_mut(&line[2..]).map(|x| x.silent = true);
+        }
+    }
+    rules.remove("simple_label");
+
+    let mut file = File::create(pest_path)?;
+    writeln!(&mut file, "// AUTO-GENERATED FILE. See build.rs.")?;
+    writeln!(&mut file, "{}", render_rules_to_pest(rules).pretty(80))?;
+
+    writeln!(&mut file)?;
+    writeln!(
+        &mut file,
+        "simple_label = {{
+              keyword ~ simple_label_next_char+
+            | !keyword ~ simple_label_first_char ~ simple_label_next_char*
+    }}"
+    )?;
+    writeln!(
+        &mut file,
+        "final_expression = ${{ SOI ~ complete_expression ~ EOI }}"
+    )?;
+
+    // Generate pest parser manually to avoid spurious recompilations
+    let derived = {
+        let pest_path = "dhall.pest";
+        let pest = quote::quote! {
+            #[grammar = #pest_path]
+            pub struct DhallParser;
+        };
+        pest_generator::derive_parser(pest, false)
+    };
+
+    let out_dir = env::var("OUT_DIR").unwrap();
+    let grammar_path = Path::new(&out_dir).join("grammar.rs");
+    let mut file = File::create(grammar_path)?;
+    writeln!(file, "pub struct DhallParser;\n{}", derived,)?;
+
+    Ok(())
+}
diff --git a/dhall_generated_parser/src/dhall.abnf b/dhall_generated_parser/src/dhall.abnf
new file mode 120000
index 0000000..ce13b8e
--- /dev/null
+++ b/dhall_generated_parser/src/dhall.abnf
@@ -0,0 +1 @@
+../../dhall-lang/standard/dhall.abnf
\ No newline at end of file
diff --git a/dhall_generated_parser/src/dhall.pest.visibility b/dhall_generated_parser/src/dhall.pest.visibility
new file mode 100644
index 0000000..f881a50
--- /dev/null
+++ b/dhall_generated_parser/src/dhall.pest.visibility
@@ -0,0 +1,141 @@
+# end_of_line
+# tab
+# block_comment
+# block_comment_chunk
+# block_comment_continue
+# not_end_of_line
+# line_comment
+# whitespace_chunk
+# whsp
+# whsp1
+# ALPHA
+# DIGIT
+# HEXDIG
+# simple_label_first_char
+# simple_label_next_char
+simple_label
+# quoted_label_char
+quoted_label
+label
+nonreserved_label
+# any_label
+double_quote_chunk
+double_quote_escaped
+double_quote_char
+double_quote_literal
+single_quote_continue
+escaped_quote_pair
+escaped_interpolation
+single_quote_char
+single_quote_literal
+interpolation
+# text_literal
+if_
+# then
+# else_
+# let_
+in_
+# as_
+# using
+merge
+missing
+# Infinity
+NaN
+Some
+# keyword
+Optional
+Text
+List
+# combine
+# combine_types
+# prefer
+lambda
+forall
+arrow
+# exponent
+numeric_double_literal
+minus_infinity_literal
+plus_infinity_literal
+double_literal
+natural_literal
+integer_literal
+identifier
+# path_character
+# quoted_path_character
+unquoted_path_component
+quoted_path_component
+path_component
+path
+# local
+parent_path
+here_path
+home_path
+absolute_path
+scheme
+http_raw
+authority
+# userinfo
+# host
+# port
+# IP_literal
+# IPvFuture
+# IPv6address
+# h16
+# ls32
+# IPv4address
+# dec_octet
+# reg_name
+# pchar
+query
+# pct_encoded
+# unreserved
+# sub_delims
+http
+env
+bash_environment_variable
+posix_environment_variable
+# posix_environment_variable_character
+import_type
+hash
+import_hashed
+import
+expression
+annotated_expression
+let_binding
+empty_collection
+non_empty_optional
+# operator_expression
+import_alt_expression
+or_expression
+plus_expression
+text_append_expression
+list_append_expression
+and_expression
+combine_expression
+prefer_expression
+combine_types_expression
+times_expression
+equal_expression
+not_equal_expression
+application_expression
+# import_expression
+selector_expression
+selector
+labels
+primitive_expression
+# record_type_or_literal
+empty_record_literal
+empty_record_type
+non_empty_record_type_or_literal
+non_empty_record_type
+record_type_entry
+non_empty_record_literal
+record_literal_entry
+union_type_or_literal
+empty_union_type
+non_empty_union_type_or_literal
+union_literal_variant_value
+union_type_entry
+union_type_or_literal_variant_type
+non_empty_list_literal
+# complete_expression
diff --git a/dhall_generated_parser/src/lib.rs b/dhall_generated_parser/src/lib.rs
new file mode 100644
index 0000000..97a0d54
--- /dev/null
+++ b/dhall_generated_parser/src/lib.rs
@@ -0,0 +1,10 @@
+// This crate only contains the grammar-generated parser. The rest of the
+// parser is in dhall_core. This separation is because compiling the
+// grammar-generated parser is extremely slow.
+// See the https://pest.rs documentation for details on what this crate contains.
+// The pest file is auto-generated and is located at ./dhall.pest.
+// It is generated from grammar.abnf in a rather straightforward manner. Some
+// additional overrides are done in ../build.rs.
+// The lines that are commented out in ./dhall.pest.visibility are marked as
+// silent (see pest docs for what that means) in the generated pest file.
+include!(concat!(env!("OUT_DIR"), "/grammar.rs"));
diff --git a/dhall_parser/.gitignore b/dhall_parser/.gitignore
deleted file mode 100644
index 8a0bac6..0000000
--- a/dhall_parser/.gitignore
+++ /dev/null
@@ -1 +0,0 @@
-src/dhall.pest
diff --git a/dhall_parser/Cargo.toml b/dhall_parser/Cargo.toml
deleted file mode 100644
index 5ee7eca..0000000
--- a/dhall_parser/Cargo.toml
+++ /dev/null
@@ -1,19 +0,0 @@
-[package]
-name = "dhall_parser"
-version = "0.1.0"
-authors = ["Nadrieril <nadrieril@users.noreply.github.com>"]
-license = "BSD-2-Clause"
-edition = "2018"
-build = "build.rs"
-
-[lib]
-test = false
-doctest = false
-
-[build-dependencies]
-abnf_to_pest = { path = "../abnf_to_pest" }
-pest_generator = "2.1"
-quote = "0.6.11"
-
-[dependencies]
-pest = { git = "https://github.com/pest-parser/pest" }
diff --git a/dhall_parser/build.rs b/dhall_parser/build.rs
deleted file mode 100644
index 615a55c..0000000
--- a/dhall_parser/build.rs
+++ /dev/null
@@ -1,64 +0,0 @@
-use std::env;
-use std::fs::File;
-use std::io::{BufRead, BufReader, Read, Write};
-use std::path::Path;
-
-use abnf_to_pest::render_rules_to_pest;
-
-fn main() -> std::io::Result<()> {
-    // TODO: upstream changes to grammar
-    // let abnf_path = "../dhall-lang/standard/dhall.abnf";
-    let abnf_path = "src/dhall.abnf";
-    let visibility_path = "src/dhall.pest.visibility";
-    let pest_path = "src/dhall.pest";
-    println!("cargo:rerun-if-changed={}", abnf_path);
-    println!("cargo:rerun-if-changed={}", visibility_path);
-
-    let mut file = File::open(abnf_path)?;
-    let mut data = Vec::new();
-    file.read_to_end(&mut data)?;
-    data.push('\n' as u8);
-
-    let mut rules = abnf_to_pest::parse_abnf(&data)?;
-    for line in BufReader::new(File::open(visibility_path)?).lines() {
-        let line = line?;
-        if line.len() >= 2 && &line[0..2] == "# " {
-            rules.get_mut(&line[2..]).map(|x| x.silent = true);
-        }
-    }
-    rules.remove("simple_label");
-
-    let mut file = File::create(pest_path)?;
-    writeln!(&mut file, "// AUTO-GENERATED FILE. See build.rs.")?;
-    writeln!(&mut file, "{}", render_rules_to_pest(rules).pretty(80))?;
-
-    writeln!(&mut file)?;
-    writeln!(
-        &mut file,
-        "simple_label = {{
-              keyword ~ simple_label_next_char+
-            | !keyword ~ simple_label_first_char ~ simple_label_next_char*
-    }}"
-    )?;
-    writeln!(
-        &mut file,
-        "final_expression = ${{ SOI ~ complete_expression ~ EOI }}"
-    )?;
-
-    // Generate pest parser manually to avoid spurious recompilations
-    let derived = {
-        let pest_path = "dhall.pest";
-        let pest = quote::quote! {
-            #[grammar = #pest_path]
-            pub struct DhallParser;
-        };
-        pest_generator::derive_parser(pest, false)
-    };
-
-    let out_dir = env::var("OUT_DIR").unwrap();
-    let grammar_path = Path::new(&out_dir).join("grammar.rs");
-    let mut file = File::create(grammar_path)?;
-    writeln!(file, "pub struct DhallParser;\n{}", derived,)?;
-
-    Ok(())
-}
diff --git a/dhall_parser/src/dhall.abnf b/dhall_parser/src/dhall.abnf
deleted file mode 120000
index ce13b8e..0000000
--- a/dhall_parser/src/dhall.abnf
+++ /dev/null
@@ -1 +0,0 @@
-../../dhall-lang/standard/dhall.abnf
\ No newline at end of file
diff --git a/dhall_parser/src/dhall.pest.visibility b/dhall_parser/src/dhall.pest.visibility
deleted file mode 100644
index f881a50..0000000
--- a/dhall_parser/src/dhall.pest.visibility
+++ /dev/null
@@ -1,141 +0,0 @@
-# end_of_line
-# tab
-# block_comment
-# block_comment_chunk
-# block_comment_continue
-# not_end_of_line
-# line_comment
-# whitespace_chunk
-# whsp
-# whsp1
-# ALPHA
-# DIGIT
-# HEXDIG
-# simple_label_first_char
-# simple_label_next_char
-simple_label
-# quoted_label_char
-quoted_label
-label
-nonreserved_label
-# any_label
-double_quote_chunk
-double_quote_escaped
-double_quote_char
-double_quote_literal
-single_quote_continue
-escaped_quote_pair
-escaped_interpolation
-single_quote_char
-single_quote_literal
-interpolation
-# text_literal
-if_
-# then
-# else_
-# let_
-in_
-# as_
-# using
-merge
-missing
-# Infinity
-NaN
-Some
-# keyword
-Optional
-Text
-List
-# combine
-# combine_types
-# prefer
-lambda
-forall
-arrow
-# exponent
-numeric_double_literal
-minus_infinity_literal
-plus_infinity_literal
-double_literal
-natural_literal
-integer_literal
-identifier
-# path_character
-# quoted_path_character
-unquoted_path_component
-quoted_path_component
-path_component
-path
-# local
-parent_path
-here_path
-home_path
-absolute_path
-scheme
-http_raw
-authority
-# userinfo
-# host
-# port
-# IP_literal
-# IPvFuture
-# IPv6address
-# h16
-# ls32
-# IPv4address
-# dec_octet
-# reg_name
-# pchar
-query
-# pct_encoded
-# unreserved
-# sub_delims
-http
-env
-bash_environment_variable
-posix_environment_variable
-# posix_environment_variable_character
-import_type
-hash
-import_hashed
-import
-expression
-annotated_expression
-let_binding
-empty_collection
-non_empty_optional
-# operator_expression
-import_alt_expression
-or_expression
-plus_expression
-text_append_expression
-list_append_expression
-and_expression
-combine_expression
-prefer_expression
-combine_types_expression
-times_expression
-equal_expression
-not_equal_expression
-application_expression
-# import_expression
-selector_expression
-selector
-labels
-primitive_expression
-# record_type_or_literal
-empty_record_literal
-empty_record_type
-non_empty_record_type_or_literal
-non_empty_record_type
-record_type_entry
-non_empty_record_literal
-record_literal_entry
-union_type_or_literal
-empty_union_type
-non_empty_union_type_or_literal
-union_literal_variant_value
-union_type_entry
-union_type_or_literal_variant_type
-non_empty_list_literal
-# complete_expression
diff --git a/dhall_parser/src/lib.rs b/dhall_parser/src/lib.rs
deleted file mode 100644
index e0843af..0000000
--- a/dhall_parser/src/lib.rs
+++ /dev/null
@@ -1,14 +0,0 @@
-// This crate only contains the grammar-generated parser. The rest of the
-// parser is in dhall_core. This separation is because compiling the
-// grammar-generated parser is extremely slow. Eventually, the whole parser
-// should probably be moved to here.
-// See the https://pest.rs documentation for details on what this crate contains.
-// The pest file is auto-generated and is located at ./dhall.pest.
-// It is generated from grammar.abnf in a rather straightforward manner. Some
-// additional overrides are done in ../build.rs.
-// The lines that are commented out in ./dhall.pest.visibility are marked as
-// silent (see pest docs for what that means) in the generated pest file.
-// The abnf file has quite a lot of modifications compared to the one from
-// the standard. Hopefully those changes should be merged upstream, but for now
-// feel free to edit it to make parsing easier.
-include!(concat!(env!("OUT_DIR"), "/grammar.rs"));
-- 
cgit v1.2.3