Merge pull request #459 from Mcat12/cleanup/reorganize-crates

Cleanup crate structure and add features for SLG/recursive solvers

Author: nikomatsakis

Cargo.lock

@@ -21,11 +21,10 @@ salsa = "0.10.0"
 serde = "1.0"
 serde_derive = "1.0"
 
-chalk-macros = { version = "0.10.1-dev", path = "chalk-macros" }
+chalk-base = { version = "0.10.1-dev", path = "chalk-base" }
 chalk-derive = { version = "0.10.1-dev", path = "chalk-derive" }
 chalk-engine = { version = "0.10.1-dev", path = "chalk-engine" }
 chalk-ir = { version = "0.10.1-dev", path = "chalk-ir" }
-chalk-rust-ir = { version = "0.10.1-dev", path = "chalk-rust-ir" }
 chalk-solve = { version = "0.10.1-dev", path = "chalk-solve" }
 chalk-parse = { version = "0.10.1-dev", path = "chalk-parse" }
 chalk-integration = { version = "0.10.1-dev", path = "chalk-integration" }

Cargo.toml

@@ -3,11 +3,10 @@
 **Note: this is mostly only useful for maintainers**
 
 The following crates get published to crates.io:
-- `chalk-macros`
+- `chalk-base`
 - `chalk-derive`
 - `chalk-engine`
 - `chalk-ir`
-- `chalk-rust-ir`
 - `chalk-solve`
 
 The following crates get versioned without publishing:

book/src/publishing.md

@@ -11,17 +11,18 @@ role of each crate. This crate structure helps to serve Chalk's two goals:
 The following crates are "public facing" crates that you may use when embedding chalk into
 other programs:
 
-* The `chalk-solve` crate, which defines the rules that translate Rust IR into logical predicates.
+* The `chalk-solve` crate, which defines the IR representing Rust concepts like
+  traits and impls and the rules that translate Rust IR into logical predicates.
 * The `chalk-ir` crate, which defines the IR representing types and logical predicates.
-* The `chalk-rust-ir` crate, which defines the IR representing Rust concepts like traits and impls.
 
 The following crate is an implementation detail, used internally by `chalk-solve`:
 
 * The `chalk-engine` crate, which defines the actual engine that solves logical predicate. This
   engine is quite general and not really specific to Rust.
 * The `chalk-derive` crate defines custom derives for the `chalk_ir::fold::Fold` trait and other
   such things.
-* The `chalk-macros` crate defines a few miscellaneous utility macros.
+* The `chalk-base` crate defines some base solver types and a few miscellaneous
+  utility macros.
 
 ## Crates for standalone REPL and testing
 
@@ -30,9 +31,9 @@ harness. These crates build on the crates above. Essentially, they
 define a kind of "minimal embedding" of chalk.
 
 * The `chalk-parser` crate can parse Rust syntax to product an AST.
-* The `chalk-integration` crate can take that AST and use it to drive
-  the `chalk-solve` crate above. The AST is converted into
-  `chalk-rust-ir` by a process called "lowering'.
+* The `chalk-integration` crate can take that AST and use it to drive the
+  `chalk-solve` crate above. The AST is converted into Rust IR by a process
+  called "lowering'.
 * Finally, the main `chalk` crate, along with the testing crate in the
   `tests` directory, define the actual entry points.
 

book/src/what_is_chalk/crates.md

@@ -44,10 +44,10 @@ impls, and struct definitions. Parsing is often the first "phase" of
 transformation that a program goes through in order to become a format that
 chalk can understand.
 
-### Rust Intermediate Representation ([chalk_rust_ir])
+### Rust Intermediate Representation ([chalk_solve::rust_ir])
 
 After getting the AST we convert it to a more convenient intermediate
-representation called [`chalk_rust_ir`][chalk_rust_ir]. This is sort of
+representation called `chalk_rust_ir`. This is sort of
 analogous to the [HIR] in Rust. The process of converting to IR is called
 *lowering*.
 
@@ -133,12 +133,12 @@ queries is called the *solver*.
 
 Chalk's functionality is broken up into the following crates:
 - [**chalk_engine**][chalk_engine]: Defines the core [SLG solver][slg].
-- [**chalk_rust_ir**][chalk_rust_ir], containing the "HIR-like" form of the AST
 - [**chalk_ir**][chalk_ir]: Defines chalk's internal representation of
   types, lifetimes, and goals.
 - [**chalk_solve**][chalk_solve]: Combines `chalk_ir` and `chalk_engine`,
   effectively, which implements logic rules converting `chalk_rust_ir` to
   `chalk_ir`
+  - Contains the `rust_ir` module, which defines the "HIR-like" Rust IR
   - Defines the `coherence` module, which implements coherence rules
   - [`chalk_engine::context`][engine-context] provides the necessary hooks.
 - [**chalk_parse**][chalk_parse]: Defines the raw AST and a parser.
@@ -197,7 +197,7 @@ Likewise, lowering tests use the [`lowering_success!` and
 [chalk_ir]: https://rust-lang.github.io/chalk/chalk_ir/index.html
 [chalk_parse]: https://rust-lang.github.io/chalk/chalk_parse/index.html
 [chalk_solve]: https://rust-lang.github.io/chalk/chalk_solve/index.html
-[chalk_rust_ir]: https://rust-lang.github.io/chalk/chalk_rust_ir/index.html
+[chalk_solve::rust_ir]: https://rust-lang.github.io/chalk/chalk_solve/rust_ir/index.html
 [doc-chalk]: https://rust-lang.github.io/chalk/chalk/index.html
 [engine-context]: https://rust-lang.github.io/chalk/chalk_engine/context/index.html
 [chalk-program]: https://rust-lang.github.io/chalk/chalk_integration/program/struct.Program.html
@@ -211,7 +211,7 @@ Likewise, lowering tests use the [`lowering_success!` and
 [chalki]: https://github.com/rust-lang/chalk/blob/master/src/main.rs
 [clause]: https://github.com/rust-lang/chalk/blob/master/GLOSSARY.md#clause
 [coherence-src]: https://rust-lang.github.io/chalk/chalk_solve/coherence/index.html
-[ir-code]: https://rust-lang.github.io/chalk/chalk_rust_ir/
+[ir-code]: https://rust-lang.github.io/chalk/chalk_solve/rust_ir/
 [solve-wf-src]: https://rust-lang.github.io/chalk/chalk_solve/wf/index.html
 [solve_goal]: https://github.com/rust-lang/chalk/blob/4bce000801de31bf45c02f742a5fce335c9f035f/src/test.rs#L85
 [test-lowering-macros]: https://github.com/rust-lang/chalk/blob/4bce000801de31bf45c02f742a5fce335c9f035f/src/test_util.rs#L21-L54

book/src/what_is_chalk/walkthrough.md

@@ -1,7 +1,7 @@
 [package]
-name = "chalk-macros"
+name = "chalk-base"
 version = "0.10.1-dev"
-description = "Macros for Chalk"
+description = "Base types for Chalk logic engines"
 license = "Apache-2.0/MIT"
 authors = ["Rust Compiler Team", "Chalk developers"]
 repository = "https://github.com/rust-lang/chalk"

chalk-macros/Cargo.toml renamed to chalk-base/Cargo.toml

@@ -1,3 +1,3 @@
-Various macros used within Chalk.
+Base types used by the SLG and recursive solvers.
 
 See [Github](https://github.com/rust-lang/chalk) for up-to-date information.

chalk-macros/README.md renamed to chalk-base/README.md

@@ -0,0 +1,8 @@
+#[macro_use]
+extern crate lazy_static;
+
+#[macro_use]
+mod macros;
+pub mod results;
+
+pub use macros::*;

chalk-base/src/lib.rs

@@ -1,9 +1,5 @@
 use std::cell::RefCell;
 
-#[macro_use]
-extern crate lazy_static;
-
-#[macro_use]
 mod index;
 
 lazy_static! {

chalk-macros/src/index.rs renamed to chalk-base/src/macros/index.rs

@@ -6,3 +6,8 @@ pub type Fallible<T> = Result<T, NoSolution>;
 /// cannot be performed.
 #[derive(Copy, Clone, Debug, PartialEq, Eq, PartialOrd, Ord, Hash)]
 pub struct NoSolution;
+
+/// Error type for the `UnificationOps::program_clauses` method --
+/// indicates that the complete set of program clauses for this goal
+/// cannot be enumerated.
+pub struct Floundered;

chalk-macros/src/lib.rs renamed to chalk-base/src/macros/mod.rs

@@ -235,7 +235,7 @@ fn derive_zip(mut s: synstructure::Structure) -> TokenStream {
     });
 
     // when the two variants are different
-    quote!((_, _)  => Err(::chalk_engine::fallible::NoSolution)).to_tokens(&mut body);
+    quote!((_, _)  => Err(::chalk_base::results::NoSolution)).to_tokens(&mut body);
 
     s.add_bounds(synstructure::AddBounds::None);
     s.bound_impl(
@@ -246,7 +246,7 @@ fn derive_zip(mut s: synstructure::Structure) -> TokenStream {
                 zipper: &mut Z,
                  a: &Self,
                  b: &Self,
-            ) -> ::chalk_engine::fallible::Fallible<()>
+            ) -> ::chalk_base::results::Fallible<()>
             where
                 #interner: 'i,
                 {
@@ -316,7 +316,7 @@ fn derive_fold(mut s: synstructure::Structure) -> TokenStream {
                 &self,
                 folder: &mut dyn ::chalk_ir::fold::Folder < 'i, #interner, #target_interner >,
                 outer_binder: ::chalk_ir::DebruijnIndex,
-            ) -> ::chalk_engine::fallible::Fallible<Self::Result>
+            ) -> ::chalk_base::results::Fallible<Self::Result>
             where
                 #interner: 'i,
                 #target_interner: 'i,

chalk-engine/src/fallible.rs renamed to chalk-base/src/results.rs

@@ -15,4 +15,4 @@ default = []
 [dependencies]
 rustc-hash = { version = "1.1.0" }
 
-chalk-macros = { version = "0.10.1-dev", path = "../chalk-macros" }
+chalk-base = { version = "0.10.1-dev", path = "../chalk-base" }

chalk-derive/src/lib.rs

@@ -5,9 +5,9 @@
 //! `DomainGoal` type, add arena lifetime parameters, and more. See
 //! [`Context`] trait for a list of types.
 
-use crate::fallible::Fallible;
 use crate::hh::HhGoal;
 use crate::{CompleteAnswer, ExClause};
+use chalk_base::results::{Fallible, Floundered};
 use std::fmt::Debug;
 use std::hash::Hash;
 
@@ -282,11 +282,6 @@ pub trait AggregateOps<C: Context> {
 /// other operations on terms.
 pub trait InferenceTable<C: Context>: ResolventOps<C> + TruncateOps<C> + UnificationOps<C> {}
 
-/// Error type for the `UnificationOps::program_clauses` method --
-/// indicates that the complete set of program clauses for this goal
-/// cannot be enumerated.
-pub struct Floundered;
-
 /// Methods for unifying and manipulating terms and binders.
 pub trait UnificationOps<C: Context> {
     // Used by: simplify

chalk-engine/Cargo.toml

@@ -54,15 +54,14 @@
 //!   Popularized by Lambda Prolog.
 
 #[macro_use]
-extern crate chalk_macros;
+extern crate chalk_base;
 
 use crate::context::Context;
 use std::cmp::min;
 use std::usize;
 
 pub mod context;
 mod derived;
-pub mod fallible;
 pub mod forest;
 pub mod hh;
 mod logic;

chalk-engine/src/context.rs

@@ -1,7 +1,6 @@
 use crate::context::{
-    Context, ContextOps, Floundered, InferenceTable, ResolventOps, TruncateOps, UnificationOps,
+    Context, ContextOps, InferenceTable, ResolventOps, TruncateOps, UnificationOps,
 };
-use crate::fallible::NoSolution;
 use crate::forest::Forest;
 use crate::hh::HhGoal;
 use crate::stack::{Stack, StackIndex};
@@ -10,6 +9,7 @@ use crate::table::{AnswerIndex, Table};
 use crate::{
     Answer, CompleteAnswer, ExClause, FlounderedSubgoal, Literal, Minimums, TableIndex, TimeStamp,
 };
+use chalk_base::results::{Floundered, NoSolution};
 
 type RootSearchResult<T> = Result<T, RootSearchFail>;
 

chalk-engine/src/lib.rs

@@ -1,8 +1,8 @@
 use crate::context::{Context, ContextOps, InferenceTable};
-use crate::fallible::Fallible;
 use crate::forest::Forest;
 use crate::hh::HhGoal;
 use crate::{ExClause, Literal, TimeStamp};
+use chalk_base::results::Fallible;
 
 impl<C: Context> Forest<C> {
     /// Simplifies an HH goal into a series of positive domain goals

chalk-engine/src/logic.rs

@@ -13,10 +13,9 @@ publish = false
 string_cache = "0.8.0"
 salsa = "0.10.0"
 
-chalk-macros = { version = "0.10.1-dev", path = "../chalk-macros" }
+chalk-base = { version = "0.10.1-dev", path = "../chalk-base" }
 chalk-derive = { version = "0.10.1-dev", path = "../chalk-derive" }
 chalk-engine = { version = "0.10.1-dev", path = "../chalk-engine" }
 chalk-ir = { version = "0.10.1-dev", path = "../chalk-ir" }
-chalk-rust-ir = { version = "0.10.1-dev", path = "../chalk-rust-ir" }
 chalk-solve = { version = "0.10.1-dev", path = "../chalk-solve" }
 chalk-parse = { version = "0.10.1-dev", path = "../chalk-parse" }