libbf 0.1.3

Brainfuck-like language library
Documentation 
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

//! This module contains error definitions.

use std::io;

use thiserror::Error;

/// A parse error.
///
/// Each variant has the position where the error occurred in Uincode scalar units,
#[derive(Debug, Error)]
pub enum ParseError {
    /// An error returned when a parser unexpectedly reached to "end of file".
    ///
    /// This error typically occurred when a loop was not closed.
    #[error("{0}: Unexpected end-of-file")]
    UnexpectedEndOfFile(
        /// The position where the error occurred.
        usize,
    ),

    /// An error returned when a parser unexpectedly reached to an end-of-loop.
    ///
    /// This error occurred when end-of-loop token was appeared outside a loop.
    #[error("{0}: Unexpected end-of-loop")]
    UnexpectedEndOfLoop(
        /// The position where the error occurred.
        usize,
    ),

    /// A miscellaneous error.
    #[error("{0}: syntax error: {1}")]
    MiscError(
        /// The position where the error occurred.
        usize,
        /// Error details.
        String,
    ),
}

/// A parse Error or IO Error.
#[derive(Debug, Error)]
pub enum ParseOrIoError {
    // A parse error.
    #[error("{0}")]
    ParseError(#[from] ParseError),

    // An IO error.
    #[error("{0}")]
    IoError(#[from] io::Error),
}

/// A program runtime error.
#[derive(Debug, Error)]
pub enum RuntimeError {
    /// An error returned when a program accesses a momory that is out of range.
    ///
    /// An "access" occurs when a deta increment/decrement, input or output instruction is performed
    /// and does not occur when the data pointer just points out of range.
    #[error("out of memory bounds [{0}]")]
    OutOfMemoryBounds(
        /// The address where the instruction tried to access.
        isize,
    ),

    /// An IO error.
    ///
    /// This error occurs when an input or output instruction is failed except end-of-file.
    #[error("IO error: {0}")]
    IoError(#[from] io::Error),

    /// An error returned when an input instruction detects an end-of-file.
    #[error("detected EOF")]
    Eof,
}

#[cfg(test)]
mod tests {
    use super::*;
    #[test]
    fn runtime_error_string() {
        assert_eq!(
            "out of memory bounds [123]",
            RuntimeError::OutOfMemoryBounds(123).to_string()
        );
    }
}