commit 9034801373986936ae213fdb2fede11b2e6b738c Author: Adrien Burgun Date: Thu Jun 16 22:06:02 2022 +0200 :tada: First commit diff --git a/.gitignore b/.gitignore new file mode 100644 index 0000000..235f9a2 --- /dev/null +++ b/.gitignore @@ -0,0 +1,6 @@ +target/ +**/*.rs.bk +Cargo.lock +bin/ +pkg/ +wasm-pack.log diff --git a/Cargo.toml b/Cargo.toml new file mode 100644 index 0000000..03c8554 --- /dev/null +++ b/Cargo.toml @@ -0,0 +1,10 @@ +[workspace] + +members = [ + "stackline-wasm", + "stackline" +] + +[profile.release] +# Tell `rustc` to optimize for small code size. +opt-level = "s" diff --git a/LICENSE_APACHE b/LICENSE_APACHE new file mode 100644 index 0000000..1b5ec8b --- /dev/null +++ b/LICENSE_APACHE @@ -0,0 +1,176 @@ + Apache License + Version 2.0, January 2004 + http://www.apache.org/licenses/ + +TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION + +1. Definitions. + + "License" shall mean the terms and conditions for use, reproduction, + and distribution as defined by Sections 1 through 9 of this document. + + "Licensor" shall mean the copyright owner or entity authorized by + the copyright owner that is granting the License. + + "Legal Entity" shall mean the union of the acting entity and all + other entities that control, are controlled by, or are under common + control with that entity. For the purposes of this definition, + "control" means (i) the power, direct or indirect, to cause the + direction or management of such entity, whether by contract or + otherwise, or (ii) ownership of fifty percent (50%) or more of the + outstanding shares, or (iii) beneficial ownership of such entity. + + "You" (or "Your") shall mean an individual or Legal Entity + exercising permissions granted by this License. + + "Source" form shall mean the preferred form for making modifications, + including but not limited to software source code, documentation + source, and configuration files. + + "Object" form shall mean any form resulting from mechanical + transformation or translation of a Source form, including but + not limited to compiled object code, generated documentation, + and conversions to other media types. + + "Work" shall mean the work of authorship, whether in Source or + Object form, made available under the License, as indicated by a + copyright notice that is included in or attached to the work + (an example is provided in the Appendix below). + + "Derivative Works" shall mean any work, whether in Source or Object + form, that is based on (or derived from) the Work and for which the + editorial revisions, annotations, elaborations, or other modifications + represent, as a whole, an original work of authorship. For the purposes + of this License, Derivative Works shall not include works that remain + separable from, or merely link (or bind by name) to the interfaces of, + the Work and Derivative Works thereof. + + "Contribution" shall mean any work of authorship, including + the original version of the Work and any modifications or additions + to that Work or Derivative Works thereof, that is intentionally + submitted to Licensor for inclusion in the Work by the copyright owner + or by an individual or Legal Entity authorized to submit on behalf of + the copyright owner. For the purposes of this definition, "submitted" + means any form of electronic, verbal, or written communication sent + to the Licensor or its representatives, including but not limited to + communication on electronic mailing lists, source code control systems, + and issue tracking systems that are managed by, or on behalf of, the + Licensor for the purpose of discussing and improving the Work, but + excluding communication that is conspicuously marked or otherwise + designated in writing by the copyright owner as "Not a Contribution." + + "Contributor" shall mean Licensor and any individual or Legal Entity + on behalf of whom a Contribution has been received by Licensor and + subsequently incorporated within the Work. + +2. Grant of Copyright License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + copyright license to reproduce, prepare Derivative Works of, + publicly display, publicly perform, sublicense, and distribute the + Work and such Derivative Works in Source or Object form. + +3. Grant of Patent License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + (except as stated in this section) patent license to make, have made, + use, offer to sell, sell, import, and otherwise transfer the Work, + where such license applies only to those patent claims licensable + by such Contributor that are necessarily infringed by their + Contribution(s) alone or by combination of their Contribution(s) + with the Work to which such Contribution(s) was submitted. If You + institute patent litigation against any entity (including a + cross-claim or counterclaim in a lawsuit) alleging that the Work + or a Contribution incorporated within the Work constitutes direct + or contributory patent infringement, then any patent licenses + granted to You under this License for that Work shall terminate + as of the date such litigation is filed. + +4. Redistribution. You may reproduce and distribute copies of the + Work or Derivative Works thereof in any medium, with or without + modifications, and in Source or Object form, provided that You + meet the following conditions: + + (a) You must give any other recipients of the Work or + Derivative Works a copy of this License; and + + (b) You must cause any modified files to carry prominent notices + stating that You changed the files; and + + (c) You must retain, in the Source form of any Derivative Works + that You distribute, all copyright, patent, trademark, and + attribution notices from the Source form of the Work, + excluding those notices that do not pertain to any part of + the Derivative Works; and + + (d) If the Work includes a "NOTICE" text file as part of its + distribution, then any Derivative Works that You distribute must + include a readable copy of the attribution notices contained + within such NOTICE file, excluding those notices that do not + pertain to any part of the Derivative Works, in at least one + of the following places: within a NOTICE text file distributed + as part of the Derivative Works; within the Source form or + documentation, if provided along with the Derivative Works; or, + within a display generated by the Derivative Works, if and + wherever such third-party notices normally appear. The contents + of the NOTICE file are for informational purposes only and + do not modify the License. You may add Your own attribution + notices within Derivative Works that You distribute, alongside + or as an addendum to the NOTICE text from the Work, provided + that such additional attribution notices cannot be construed + as modifying the License. + + You may add Your own copyright statement to Your modifications and + may provide additional or different license terms and conditions + for use, reproduction, or distribution of Your modifications, or + for any such Derivative Works as a whole, provided Your use, + reproduction, and distribution of the Work otherwise complies with + the conditions stated in this License. + +5. Submission of Contributions. Unless You explicitly state otherwise, + any Contribution intentionally submitted for inclusion in the Work + by You to the Licensor shall be under the terms and conditions of + this License, without any additional terms or conditions. + Notwithstanding the above, nothing herein shall supersede or modify + the terms of any separate license agreement you may have executed + with Licensor regarding such Contributions. + +6. Trademarks. This License does not grant permission to use the trade + names, trademarks, service marks, or product names of the Licensor, + except as required for reasonable and customary use in describing the + origin of the Work and reproducing the content of the NOTICE file. + +7. Disclaimer of Warranty. Unless required by applicable law or + agreed to in writing, Licensor provides the Work (and each + Contributor provides its Contributions) on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or + implied, including, without limitation, any warranties or conditions + of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A + PARTICULAR PURPOSE. You are solely responsible for determining the + appropriateness of using or redistributing the Work and assume any + risks associated with Your exercise of permissions under this License. + +8. Limitation of Liability. In no event and under no legal theory, + whether in tort (including negligence), contract, or otherwise, + unless required by applicable law (such as deliberate and grossly + negligent acts) or agreed to in writing, shall any Contributor be + liable to You for damages, including any direct, indirect, special, + incidental, or consequential damages of any character arising as a + result of this License or out of the use or inability to use the + Work (including but not limited to damages for loss of goodwill, + work stoppage, computer failure or malfunction, or any and all + other commercial damages or losses), even if such Contributor + has been advised of the possibility of such damages. + +9. Accepting Warranty or Additional Liability. While redistributing + the Work or Derivative Works thereof, You may choose to offer, + and charge a fee for, acceptance of support, warranty, indemnity, + or other liability obligations and/or rights consistent with this + License. However, in accepting such obligations, You may act only + on Your own behalf and on Your sole responsibility, not on behalf + of any other Contributor, and only if You agree to indemnify, + defend, and hold each Contributor harmless for any liability + incurred by, or claims asserted against, such Contributor by reason + of your accepting any such warranty or additional liability. + +END OF TERMS AND CONDITIONS diff --git a/LICENSE_MIT b/LICENSE_MIT new file mode 100644 index 0000000..74aa193 --- /dev/null +++ b/LICENSE_MIT @@ -0,0 +1,25 @@ +Copyright (c) 2018 Adrien Burgun + +Permission is hereby granted, free of charge, to any +person obtaining a copy of this software and associated +documentation files (the "Software"), to deal in the +Software without restriction, including without +limitation the rights to use, copy, modify, merge, +publish, distribute, sublicense, and/or sell copies of +the Software, and to permit persons to whom the Software +is furnished to do so, subject to the following +conditions: + +The above copyright notice and this permission notice +shall be included in all copies or substantial portions +of the Software. + +THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF +ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED +TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A +PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT +SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY +CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION +OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR +IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER +DEALINGS IN THE SOFTWARE. diff --git a/README.md b/README.md new file mode 100644 index 0000000..272fbd3 --- /dev/null +++ b/README.md @@ -0,0 +1,3 @@ +# Stackline v2 + +This is the successor of [stackline](https://github.com/adri326/stackline), an esoteric language inspired by [Wireworld](https://mathworld.wolfram.com/WireWorld.html) and [ORCA](https://github.com/hundredrabbits/Orca). diff --git a/stackline-wasm/.appveyor.yml b/stackline-wasm/.appveyor.yml new file mode 100644 index 0000000..50910bd --- /dev/null +++ b/stackline-wasm/.appveyor.yml @@ -0,0 +1,11 @@ +install: + - appveyor-retry appveyor DownloadFile https://win.rustup.rs/ -FileName rustup-init.exe + - if not defined RUSTFLAGS rustup-init.exe -y --default-host x86_64-pc-windows-msvc --default-toolchain nightly + - set PATH=%PATH%;C:\Users\appveyor\.cargo\bin + - rustc -V + - cargo -V + +build: false + +test_script: + - cargo test --locked diff --git a/stackline-wasm/.travis.yml b/stackline-wasm/.travis.yml new file mode 100644 index 0000000..7a91325 --- /dev/null +++ b/stackline-wasm/.travis.yml @@ -0,0 +1,69 @@ +language: rust +sudo: false + +cache: cargo + +matrix: + include: + + # Builds with wasm-pack. + - rust: beta + env: RUST_BACKTRACE=1 + addons: + firefox: latest + chrome: stable + before_script: + - (test -x $HOME/.cargo/bin/cargo-install-update || cargo install cargo-update) + - (test -x $HOME/.cargo/bin/cargo-generate || cargo install --vers "^0.2" cargo-generate) + - cargo install-update -a + - curl https://rustwasm.github.io/wasm-pack/installer/init.sh -sSf | sh -s -- -f + script: + - cargo generate --git . --name testing + # Having a broken Cargo.toml (in that it has curlies in fields) anywhere + # in any of our parent dirs is problematic. + - mv Cargo.toml Cargo.toml.tmpl + - cd testing + - wasm-pack build + - wasm-pack test --chrome --firefox --headless + + # Builds on nightly. + - rust: nightly + env: RUST_BACKTRACE=1 + before_script: + - (test -x $HOME/.cargo/bin/cargo-install-update || cargo install cargo-update) + - (test -x $HOME/.cargo/bin/cargo-generate || cargo install --vers "^0.2" cargo-generate) + - cargo install-update -a + - rustup target add wasm32-unknown-unknown + script: + - cargo generate --git . --name testing + - mv Cargo.toml Cargo.toml.tmpl + - cd testing + - cargo check + - cargo check --target wasm32-unknown-unknown + - cargo check --no-default-features + - cargo check --target wasm32-unknown-unknown --no-default-features + - cargo check --no-default-features --features console_error_panic_hook + - cargo check --target wasm32-unknown-unknown --no-default-features --features console_error_panic_hook + - cargo check --no-default-features --features "console_error_panic_hook wee_alloc" + - cargo check --target wasm32-unknown-unknown --no-default-features --features "console_error_panic_hook wee_alloc" + + # Builds on beta. + - rust: beta + env: RUST_BACKTRACE=1 + before_script: + - (test -x $HOME/.cargo/bin/cargo-install-update || cargo install cargo-update) + - (test -x $HOME/.cargo/bin/cargo-generate || cargo install --vers "^0.2" cargo-generate) + - cargo install-update -a + - rustup target add wasm32-unknown-unknown + script: + - cargo generate --git . --name testing + - mv Cargo.toml Cargo.toml.tmpl + - cd testing + - cargo check + - cargo check --target wasm32-unknown-unknown + - cargo check --no-default-features + - cargo check --target wasm32-unknown-unknown --no-default-features + - cargo check --no-default-features --features console_error_panic_hook + - cargo check --target wasm32-unknown-unknown --no-default-features --features console_error_panic_hook + # Note: no enabling the `wee_alloc` feature here because it requires + # nightly for now. diff --git a/stackline-wasm/Cargo.toml b/stackline-wasm/Cargo.toml new file mode 100644 index 0000000..49df506 --- /dev/null +++ b/stackline-wasm/Cargo.toml @@ -0,0 +1,31 @@ +[package] +name = "stackline-wasm" +version = "0.1.0" +authors = ["Adrien Burgun "] +edition = "2018" + +[lib] +crate-type = ["cdylib", "rlib"] + +[features] +default = ["console_error_panic_hook"] + +[dependencies] +wasm-bindgen = "0.2.63" +stackline = { path = "../stackline" } + +# The `console_error_panic_hook` crate provides better debugging of panics by +# logging them with `console.error`. This is great for development, but requires +# all the `std::fmt` and `std::panicking` infrastructure, so isn't great for +# code size when deploying. +console_error_panic_hook = { version = "0.1.6", optional = true } + +# `wee_alloc` is a tiny allocator for wasm that is only ~1K in code size +# compared to the default allocator's ~10K. It is slower than the default +# allocator, however. +# +# Unfortunately, `wee_alloc` requires nightly Rust when targeting wasm for now. +wee_alloc = { version = "0.4.5", optional = true } + +[dev-dependencies] +wasm-bindgen-test = "0.3.13" diff --git a/stackline-wasm/README.md b/stackline-wasm/README.md new file mode 100644 index 0000000..51e6e70 --- /dev/null +++ b/stackline-wasm/README.md @@ -0,0 +1,3 @@ +# stackline-wasm + +WASM bindings for stackline. diff --git a/stackline-wasm/src/lib.rs b/stackline-wasm/src/lib.rs new file mode 100644 index 0000000..d87e5c8 --- /dev/null +++ b/stackline-wasm/src/lib.rs @@ -0,0 +1,19 @@ +mod utils; + +use wasm_bindgen::prelude::*; + +// When the `wee_alloc` feature is enabled, use `wee_alloc` as the global +// allocator. +#[cfg(feature = "wee_alloc")] +#[global_allocator] +static ALLOC: wee_alloc::WeeAlloc = wee_alloc::WeeAlloc::INIT; + +#[wasm_bindgen] +extern { + fn alert(s: &str); +} + +#[wasm_bindgen] +pub fn greet() { + alert("Hello, stackline2-wasm!"); +} diff --git a/stackline-wasm/src/utils.rs b/stackline-wasm/src/utils.rs new file mode 100644 index 0000000..b1d7929 --- /dev/null +++ b/stackline-wasm/src/utils.rs @@ -0,0 +1,10 @@ +pub fn set_panic_hook() { + // When the `console_error_panic_hook` feature is enabled, we can call the + // `set_panic_hook` function at least once during initialization, and then + // we will get better error messages if our code ever panics. + // + // For more details see + // https://github.com/rustwasm/console_error_panic_hook#readme + #[cfg(feature = "console_error_panic_hook")] + console_error_panic_hook::set_once(); +} diff --git a/stackline-wasm/tests/web.rs b/stackline-wasm/tests/web.rs new file mode 100644 index 0000000..de5c1da --- /dev/null +++ b/stackline-wasm/tests/web.rs @@ -0,0 +1,13 @@ +//! Test suite for the Web and headless browsers. + +#![cfg(target_arch = "wasm32")] + +extern crate wasm_bindgen_test; +use wasm_bindgen_test::*; + +wasm_bindgen_test_configure!(run_in_browser); + +#[wasm_bindgen_test] +fn pass() { + assert_eq!(1 + 1, 2); +} diff --git a/stackline/Cargo.toml b/stackline/Cargo.toml new file mode 100644 index 0000000..8fadbb2 --- /dev/null +++ b/stackline/Cargo.toml @@ -0,0 +1,9 @@ +[package] +name = "stackline" +version = "0.1.0" +edition = "2021" + +# See more keys and their definitions at https://doc.rust-lang.org/cargo/reference/manifest.html + +[dependencies] +dyn-clone = "1.0" diff --git a/stackline/src/lib.rs b/stackline/src/lib.rs new file mode 100644 index 0000000..d6bc474 --- /dev/null +++ b/stackline/src/lib.rs @@ -0,0 +1,86 @@ +use std::cell::RefCell; +use std::num::NonZeroUsize; +use std::rc::Weak; + +pub mod utils; +use utils::*; + +pub mod tile; +use tile::*; + +mod signal; +pub use signal::*; + +pub struct World { + tiles: Vec>, + width: NonZeroUsize, + height: NonZeroUsize, + + signals: Vec>, +} + +impl World { + pub fn empty(width: usize, height: usize) -> Option { + // TODO: check that width * height is a valid usize + + Some(Self { + width: width.try_into().ok()?, + height: height.try_into().ok()?, + tiles: vec![RefCell::new(FullTile::default()); width * height], + + signals: vec![], + }) + } + + pub fn send_signal( + &mut self, + position: (usize, usize), + signal: Signal, + ) -> Option> { + let tile = self.get(position)?; + let weak = { + let mut guard = tile.try_borrow_mut().ok()?; + guard.set_signal(signal)? + }; + + self.signals.push(weak.clone()); + + Some(weak) + } + + /// Returns `Some((x + Δx, y + Δy))` iff `(x + Δx, y + Δy)` is inside the world + #[inline] + pub fn offset(&self, position: (usize, usize), offset: (i8, i8)) -> Option<(usize, usize)> { + if offset.0 < 0 && (-offset.0) as usize > position.0 + || offset.1 < 0 && (-offset.1) as usize > position.1 + { + return None; + } + + // TODO: check that position and position + offset are valid isize values + let new_pos = ( + (position.0 as isize + offset.0 as isize) as usize, + (position.1 as isize + offset.1 as isize) as usize, + ); + + if new_pos.0 < self.width.get() && new_pos.1 < self.height.get() { + Some(new_pos) + } else { + None + } + } + + #[inline] + pub fn get<'b>(&'b self, position: (usize, usize)) -> Option<&'b RefCell> { + if !self.in_bounds(position) { + return None; + } + + self.tiles.get(position.1 * self.width.get() + position.0) + } + + #[inline] + pub fn in_bounds(&self, position: (usize, usize)) -> bool { + position.0 < self.width.get() && position.1 < self.height.get() + } +} diff --git a/stackline/src/signal.rs b/stackline/src/signal.rs new file mode 100644 index 0000000..4d8b533 --- /dev/null +++ b/stackline/src/signal.rs @@ -0,0 +1,14 @@ +use super::*; + +#[derive(Clone, Debug)] +pub struct Signal { + pub direction: Direction, +} + +impl Signal { + pub fn clone_with_dir(&self, direction: Direction) -> Self { + let mut res = self.clone(); + res.direction = direction; + res + } +} diff --git a/stackline/src/tile/mod.rs b/stackline/src/tile/mod.rs new file mode 100644 index 0000000..785333c --- /dev/null +++ b/stackline/src/tile/mod.rs @@ -0,0 +1,89 @@ +use super::*; +use dyn_clone::{clone_box, DynClone}; +use std::rc::Rc; + +mod wire; +pub use wire::*; + +/** Represents a tile that may be empty and may have a signal. The tile may only have a signal if it isn't empty. +Cloning a `FullTile` results in a `FullTile` that does not have any signal. + +## Invariants + +- `self.cell.is_none() -> self.signal.is_none()` +- `self.accepts_signal() -> self.cell.is_some()` + +**/ +#[derive(Clone, Debug)] +pub struct FullTile { + cell: Option, + signal: Option>, +} + +impl FullTile { + pub fn new(cell: Option) -> Self { + Self { cell, signal: None } + } + + pub fn update(&mut self, world: &mut World, pos: (usize, usize)) { + match self.cell { + Some(ref mut tile) => { + tile.update(world, &mut self.signal, pos); + } + None => {} + } + } + + pub fn accepts_signal(&self, direction: Direction) -> bool { + match self.cell { + Some(ref tile) => tile.accepts_signal(direction), + None => false, + } + } + + /// Returns Some(signal) iff self.cell.is_some() + pub fn set_signal(&mut self, signal: Signal) -> Option> { + if self.cell.is_some() { + let rc = Rc::new(signal); + let weak = Rc::downgrade(&rc); + self.signal = Some(rc); + Some(weak) + } else { + None + } + } +} + +impl Default for FullTile { + fn default() -> Self { + Self::new(None) + } +} + +pub trait Tile: DynClone + std::fmt::Debug { + fn update(&mut self, world: &mut World, signal: &mut Option>, pos: (usize, usize)); + + /// Should return true iff the tile accepts a signal travelling in `Direction` + fn accepts_signal(&self, _direction: Direction) -> bool { + true + } +} + +#[derive(Debug)] +pub struct AnyTile(Box); + +impl AnyTile { + fn update(&mut self, world: &mut World, signal: &mut Option>, pos: (usize, usize)) { + self.0.update(world, signal, pos) + } + + fn accepts_signal(&self, direction: Direction) -> bool { + self.0.accepts_signal(direction) + } +} + +impl Clone for AnyTile { + fn clone(&self) -> Self { + Self(clone_box(self.0.as_ref())) + } +} diff --git a/stackline/src/tile/wire.rs b/stackline/src/tile/wire.rs new file mode 100644 index 0000000..5f4c8a0 --- /dev/null +++ b/stackline/src/tile/wire.rs @@ -0,0 +1,45 @@ +//! Wires and diodes + +use super::*; + +#[derive(Clone, Debug)] +pub struct Wire(Orientation); + +impl Tile for Wire { + fn update(&mut self, world: &mut World, signal: &mut Option>, pos: (usize, usize)) { + if let Some(signal) = std::mem::take(signal) { + for &direction in self.0.into_directions() { + if direction == signal.direction.opposite() { + continue; + } + + if let Some(new_pos) = world.offset(pos, direction.into_offset()) { + let tile = world.get(new_pos).unwrap(); + if tile.borrow().accepts_signal(direction) { + world.send_signal(new_pos, (*signal).clone_with_dir(direction)).unwrap(); + } + } + } + } + } + + fn accepts_signal(&self, direction: Direction) -> bool { + self.0.contains(direction) + } +} + +#[derive(Clone, Debug)] +pub struct Diode(Direction); + +impl Tile for Diode { + fn update(&mut self, world: &mut World, signal: &mut Option>, pos: (usize, usize)) { + if let Some(signal) = std::mem::take(signal) { + if let Some(new_pos) = world.offset(pos, self.0.into_offset()) { + let tile = world.get(new_pos).unwrap(); + if tile.borrow().accepts_signal(self.0) { + world.send_signal(new_pos, (*signal).clone_with_dir(self.0)).unwrap(); + } + } + } + } +} diff --git a/stackline/src/utils.rs b/stackline/src/utils.rs new file mode 100644 index 0000000..c71d482 --- /dev/null +++ b/stackline/src/utils.rs @@ -0,0 +1,95 @@ +/// Represents one or many undirected orientation(s), since we are in a 2D grid, this may either be [Horizontal], [Vertical] or both ([Any]) +#[derive(Debug, Clone, Copy, PartialEq, Eq)] +#[repr(u8)] +pub enum Orientation { + Horizontal, + Vertical, + Any, +} + +/// Represents one directed orientation +#[derive(Debug, Clone, Copy, PartialEq, Eq)] +#[repr(u8)] +pub enum Direction { + Up, + Down, + Left, + Right, +} + +const HORIZONTAL: [Direction; 2] = [Direction::Left, Direction::Right]; +const VERTICAL: [Direction; 2] = [Direction::Up, Direction::Down]; +const ANY: [Direction; 4] = [ + Direction::Up, + Direction::Down, + Direction::Left, + Direction::Right, +]; + +impl Orientation { + /// Converts an [Orientation] into an array of [Direction]s + #[inline] + pub fn into_directions(self) -> &'static [Direction] { + match self { + Orientation::Horizontal => &HORIZONTAL, + Orientation::Vertical => &VERTICAL, + Orientation::Any => &ANY, + } + } + + /// Returns true iff `dir ∈ self` + #[inline] + pub fn contains(&self, dir: Direction) -> bool { + match (self, dir) { + (Orientation::Vertical, Direction::Up) => true, + (Orientation::Vertical, Direction::Down) => true, + (Orientation::Horizontal, Direction::Left) => true, + (Orientation::Horizontal, Direction::Right) => true, + (Orientation::Any, _) => true, + _ => false, + } + } +} + +impl Direction { + /// Converts a [Direction] in a pair `(Δx, Δy)`, with [Up] being equal to `(0, -1)` + #[inline] + pub fn into_offset(self) -> (i8, i8) { + match self { + Direction::Up => (0, -1), + Direction::Down => (0, 1), + Direction::Left => (-1, 0), + Direction::Right => (1, 0), + } + } + + /// Returns the opposite direction + #[inline] + pub fn opposite(self) -> Self { + match self { + Direction::Up => Direction::Down, + Direction::Down => Direction::Up, + Direction::Left => Direction::Right, + Direction::Right => Direction::Left, + } + } +} + +#[cfg(test)] +mod test { + use super::*; + + #[test] + fn test_orientation_contains_self() { + let list = [ + Orientation::Horizontal, + Orientation::Vertical, + Orientation::Any, + ]; + for orientation in list.into_iter() { + for direction in orientation.into_directions() { + assert!(orientation.contains(*direction)); + } + } + } +}