rcore 0.1.0

Core module for Rair
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
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191

/*
 * helper.rs: Helper functions for implementing external or internal commands.
 * Copyright (C) 2019  Oddcoder
 * This program is free software: you can redistribute it and/or modify
 * it under the terms of the GNU Lesser General Public License as published by
 * the Free Software Foundation, either version 3 of the License, or
 * (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU Lesser General Public License for more details.
 *
 * You should have received a copy of the GNU Lesser General Public License
 * along with this program.  If not, see <http://www.gnu.org/licenses/>.
 */

use core::*;
use rair_env::Environment;
use serde::{Deserialize, Serialize};
use std::cell::RefCell;
use std::fmt;
use std::fmt::Display;
use std::io::Write;
use std::num;
use std::process::exit;
use std::rc::Rc;
use yansi::Paint;

pub type MRc<T> = Rc<RefCell<T>>; //mutable refcounter

pub fn str_to_num(n: &str) -> Result<u64, num::ParseIntError> {
    if n.len() >= 2 {
        match &*n[0..2].to_lowercase() {
            "0b" => return u64::from_str_radix(&n[2..], 2),
            "0x" => return u64::from_str_radix(&n[2..], 16),
            _ => (),
        }
    }
    if n.len() > 1 && n.chars().nth(0).unwrap() == '0' {
        return u64::from_str_radix(&n[1..], 8);
    }
    return u64::from_str_radix(n, 10);
}

pub fn expect(core: &mut Core, args_len: u64, expect: u64) {
    let (r, g, b) = core.env.borrow().get_color("color.4").unwrap();
    let error = Paint::rgb(r, g, b, "Arguments Error").bold();
    let expected = Paint::rgb(r, g, b, format!("{}", expect));
    let found = Paint::rgb(r, g, b, format!("{}", args_len));
    writeln!(core.stderr, "{}: Expected {} argument(s), found {}.", error, expected, found).unwrap();
}

pub fn expect_range(core: &mut Core, args_len: u64, min: u64, max: u64) {
    assert!(min < max);
    let (r, g, b) = core.env.borrow().get_color("color.4").unwrap();
    let error = Paint::rgb(r, g, b, "Arguments Error").bold();
    let min_str = Paint::rgb(r, g, b, format!("{}", min));
    let max_str = Paint::rgb(r, g, b, format!("{}", max));
    let found = Paint::rgb(r, g, b, format!("{}", args_len));
    writeln!(core.stderr, "{}: Expected between {} and {} arguments, found {}.", error, min_str, max_str, found).unwrap();
}

pub fn error_msg(core: &mut Core, title: &str, msg: &str) {
    let (r, g, b) = core.env.borrow().get_color("color.4").unwrap();
    writeln!(core.stderr, "{}: {}", Paint::rgb(r, g, b, "Error").bold(), Paint::rgb(r, g, b, title)).unwrap();
    writeln!(core.stderr, "{}", msg).unwrap();
}

pub fn panic_msg(core: &mut Core, title: &str, msg: &str) -> ! {
    let (r, g, b) = core.env.borrow().get_color("color.4").unwrap();
    writeln!(core.stderr, "{}: {}", Paint::rgb(r, g, b, "Unrecoverable Error").bold(), Paint::rgb(r, g, b, title)).unwrap();
    if !msg.is_empty() {
        writeln!(core.stderr, "{}", msg).unwrap();
    }
    writeln!(core.stderr, "{}", Paint::rgb(r, g, b, "Exiting!").bold()).unwrap();
    exit(-1);
}

pub fn help(core: &mut Core, long: &str, short: &str, usage: Vec<(&str, &str)>) {
    let (r1, g1, b1) = core.env.borrow().get_color("color.6").unwrap();
    let (r2, g2, b2) = core.env.borrow().get_color("color.7").unwrap();
    let used = if short.is_empty() {
        writeln!(core.stdout, "Command: [{}]\n", Paint::rgb(r1, g1, b1, long)).unwrap();
        long
    } else {
        writeln!(core.stdout, "Commands: [{} | {}]\n", Paint::rgb(r1, g1, b1, long), Paint::rgb(r1, g1, b1, short)).unwrap();
        short
    };
    writeln!(core.stdout, "Usage:").unwrap();
    for (args, description) in usage {
        write!(core.stdout, "{}", Paint::rgb(r1, g1, b1, used)).unwrap();
        if !args.is_empty() {
            write!(core.stdout, " {}", Paint::rgb(r2, g2, b2, args)).unwrap();
        }
        writeln!(core.stdout, "\t{}", description,).unwrap()
    }
}

pub struct CmdFunctions {
    pub run: fn(&mut Core, &[String]),
    pub help: fn(&mut Core),
}

pub trait Cmd {
    fn run(&mut self, &mut Core, &[String]);
    fn help(&self, &mut Core);
}
#[derive(Copy, Clone, PartialEq, Debug, Serialize, Deserialize)]
pub enum AddrMode {
    Vir,
    Phy,
}

impl Display for AddrMode {
    fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
        match self {
            AddrMode::Phy => write!(f, "Phy"),
            AddrMode::Vir => write!(f, "Vir"),
        }
    }
}

pub fn is_color<Core>(_: &str, value: &str, env: &Environment<Core>, _: &mut Core) -> bool {
    return env.is_color(value);
}

#[cfg(test)]
mod test_helper {
    use super::*;
    use std::fmt::Write;
    use writer::Writer;
    #[test]
    fn test_str_to_num() {
        assert_eq!(str_to_num("12345").unwrap(), 12345);
        assert_eq!(str_to_num("012345").unwrap(), 0o12345);
        assert_eq!(str_to_num("0b101001").unwrap(), 0b101001);
        assert_eq!(str_to_num("0x12345").unwrap(), 0x12345);
        assert_eq!(str_to_num("0X1F2f345").unwrap(), 0x1f2f345);
        assert_eq!(str_to_num("0").unwrap(), 0);
        assert!(str_to_num("0x12345123451234512").is_err());
    }

    #[test]
    fn test_except() {
        let mut core = Core::new_no_colors();
        core.stderr = Writer::new_buf();
        Paint::disable();
        expect(&mut core, 5, 7);
        assert_eq!(core.stderr.utf8_string().unwrap(), "Arguments Error: Expected 7 argument(s), found 5.\n");
    }
    #[test]
    fn test_expect_range() {
        let mut core = Core::new_no_colors();
        core.stderr = Writer::new_buf();
        Paint::disable();
        expect_range(&mut core, 5, 7, 10);
        assert_eq!(core.stderr.utf8_string().unwrap(), "Arguments Error: Expected between 7 and 10 arguments, found 5.\n");
    }

    #[test]
    fn test_error_msg() {
        let mut core = Core::new_no_colors();
        core.stderr = Writer::new_buf();
        Paint::disable();
        error_msg(&mut core, "Error Title", "Something might have failed.");
        assert_eq!(core.stderr.utf8_string().unwrap(), "Error: Error Title\nSomething might have failed.\n");
    }
    #[test]
    fn test_help_short() {
        let mut core = Core::new_no_colors();
        core.stdout = Writer::new_buf();
        Paint::disable();
        help(&mut core, "Test", "t", vec![("t1", "test 1"), ("t2", "test 2")]);
        assert_eq!(core.stdout.utf8_string().unwrap(), "Commands: [Test | t]\n\nUsage:\nt t1\ttest 1\nt t2\ttest 2\n");
    }
    #[test]
    fn test_help_long() {
        let mut core = Core::new_no_colors();
        core.stdout = Writer::new_buf();
        Paint::disable();
        help(&mut core, "Test", "", vec![("t1", "test 1"), ("t2", "test 2")]);
        assert_eq!(core.stdout.utf8_string().unwrap(), "Command: [Test]\n\nUsage:\nTest t1\ttest 1\nTest t2\ttest 2\n");
    }
    #[test]
    fn test_addr_mode() {
        let mut s = String::new();
        write!(s, "{} {}", AddrMode::Phy, AddrMode::Vir).unwrap();
        assert_eq!(s, "Phy Vir");
    }
}