1
  2
  3
  4
  5
  6
  7
  8
  9
 10
 11
 12
 13
 14
 15
 16
 17
 18
 19
 20
 21
 22
 23
 24
 25
 26
 27
 28
 29
 30
 31
 32
 33
 34
 35
 36
 37
 38
 39
 40
 41
 42
 43
 44
 45
 46
 47
 48
 49
 50
 51
 52
 53
 54
 55
 56
 57
 58
 59
 60
 61
 62
 63
 64
 65
 66
 67
 68
 69
 70
 71
 72
 73
 74
 75
 76
 77
 78
 79
 80
 81
 82
 83
 84
 85
 86
 87
 88
 89
 90
 91
 92
 93
 94
 95
 96
 97
 98
 99
100
101

//! # Pancake Stack
//! This is a Rust implementation of the [Pancake Stack](https://esolangs.org/wiki/Pancake_Stack) esoteric programming language.
//! This crate includes a parser and an interpreter.
//!
//! > Pancake Stack is a stack-based esoteric programming language created by
//! > User [JWinslow23](https://esolangs.org/wiki/User:JWinslow23)
//! > in [2013](https://en.wikipedia.org/wiki/2013), in which programs require you to
//! > manipulate a stack of [pancakes](https://i.ytimg.com/vi/FLd00Bx4tOk/maxresdefault.jpg).
//!
//!
//! **Basic Usage**
//!
//! A program can be parsed with [`pancakestack::parse_program_str`](./parse/fn.parse_program_str.html) and run with [`pancakestack::run_program`](./interpret/fn.run_program.html).
//!
//! ```rust
//! # use std::fs::File;
//! # use std::io::Read;
//! # fn run() {
//! // load program from file
//! let mut file = File::open("example.pancake").unwrap();
//! let mut program_str = String::new();
//! file.read_to_string(&mut program_str).unwrap();
//!
//! // parse the program
//! let program = pancakestack::parse_program_str(&program_str);
//!
//! // run the program
//! pancakestack::run_program(&program, std::io::stdin(), std::io::stdout()).unwrap();
//! # }
//! ```
//!
//! Alternatively you can run a program from a [str](https://doc.rust-lang.org/std/primitive.str.html) or a [Read](https://doc.rust-lang.org/std/io/trait.Read.html) with [`pancakestack::run_program_str`](./interpret/fn.run_program_str.html) and  [`pancakestack::run_program_from_read`](./interpret/fn.run_program_from_read.html) respectively.
//!
//! ```rust
//! # use std::fs::File;
//! # use std::io::Read;
//! # fn run() {
//! // load script file
//! let mut file = File::open("example.pancake").unwrap();
//!
//! // write program into string
//! let mut program = String::new();
//! file.read_to_string(&mut program).unwrap();
//!
//! pancakestack::run_program_str(&program, std::io::stdin(), std::io::stdout()).unwrap();
//! # }
//! ```
//!
//! ```rust
//! # use std::fs::File;
//! # fn run() {
//! // open script file
//! let mut file = File::open("example.pancake").unwrap();
//!
//! // run the script directly from the file
//! pancakestack::run_program_from_read(file, std::io::stdin(), std::io::stdout()).unwrap();
//! # }
//! ```
//!
//! All `pancakestack::run_*`methods accept a [`Read`](https://doc.rust-lang.org/std/io/trait.Read.html) as the input of the script and a [`Write`](https://doc.rust-lang.org/std/io/trait.Write.html) as the output.
//!
//! The examples until now used [`stdin()`](https://doc.rust-lang.org/std/io/fn.stdin.html) and [`stdout()`](https://doc.rust-lang.org/std/io/fn.stdout.html), but it is possible to use anything implementing [`Read`](https://doc.rust-lang.org/std/io/trait.Read.html) and [`Write`](https://doc.rust-lang.org/std/io/trait.Write.html) respectively.
//! The following example shows the use of strings as input and output:
//!
//! ```rust
//! # use std::fs::File;
//! # fn run() {
//! let file = File::open("example.pancake").unwrap();
//! let input = b"some input";
//! let mut output_buf = Vec::new();
//! pancakestack::run_program_from_read(file, &input[..], &mut output_buf).unwrap();
//! let output = std::str::from_utf8(&output_buf).unwrap();
//! # }
//! ```
//!
//!
//! **Construct programs**
//!
//! A program can be parsed from a [`str`](https://doc.rust-lang.org/std/str/) with [`pancakestack::run_program_str`](./interpret/fn.run_program_str.html). A single line (=command) can be parsed with [`BorrowedCommand::from_line`](./parse/enum.BorrowedCommand.html#method.from_line).
//!
//! Parsed programs are slices of [`BorrowedCommand`](./parse/enum.BorrowedCommand.html)s and can be run with [`pancakestack::run_program`](./interpret/fn.run_program.html).
//!
//! ```rust
//! use pancakestack::BorrowedCommand;
//!
//! let program = [
//!     BorrowedCommand::PutThisPancakeOnTop("test"),
//!     BorrowedCommand::ShowMeAPancake,
//!     BorrowedCommand::EatAllOfThePancakes
//! ];
//! pancakestack::run_program(&program, std::io::stdin(), std::io::stdout()).unwrap();
//!

#[macro_use]
extern crate lazy_static;

pub mod interpret;
pub mod parse;

pub use interpret::*;
pub use parse::*;