shelly-shell 0.4.0

A Rust based Unix style shell with a typed and structured language syntax.
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


use std::{ fmt::{ self, Debug, Display, Formatter }, sync::Arc };

/**
 * Allow the caller to take the current location in the Rust source code.
 */
#[macro_export]
macro_rules! location_here
{
    () => {{
        use $crate::language::text::location::Location;

        Location::new(file!(), line!() as usize, column!() as usize)
    }};
}


/**
 * Represents a location in the source code.
 */
#[derive(Clone, PartialEq, PartialOrd, Eq)]
pub struct Location
{
    /**
     * The name of the location the source code originates from. Can be things like a file name/path
     * or a keyword like "<repl>". Used for knowing where in the what source code this location is
     * coming from.
     */
    pub origin: Arc<str>,

    /**
     * A 1-based line number in the source code.
     */
    pub line: usize,

    /**
     * A 1-based column number in the source code.
     */
    pub column: usize
}


impl Location
{
    /**
     * Construct a new location with the given origin, line, and column.
     */
    pub fn new(origin: impl Into<Arc<str>>, line: usize, column: usize) -> Self
    {
        Self { origin: origin.into(), line, column }
    }
}


impl Default for Location
{
    /**
     * Construct a default location with an unspecified origin and the first line and column.
     */
    fn default() -> Self
    {
        Self { origin: Arc::from("<unspecified>"), line: 1, column: 1 }
    }
}


impl Display for Location
{
    /**
     * Format the location as a string in the form "origin: (line, column)".
     */
    fn fmt(&self, formatter: &mut Formatter<'_>) -> fmt::Result
    {
        write!(formatter, "{}: ({}, {})", self.origin, self.line, self.column)
    }
}


impl Debug for Location
{
    /**
     * Format the location for debugging purposes.
     */
    fn fmt(&self, formatter: &mut Formatter<'_>) -> fmt::Result
    {
        write!(formatter, "{}", self)
    }
}