Playing with tables.

Cargo.toml

@@ -13,4 +13,6 @@ panic = 'abort'     # Abort on panic
 strip = true        # Strip symbols from binary*
 
 [dependencies]
-text_io = "0.1.12"
+text_io = "0.1.12"
+prettytable-rs = "0.10.0"
+#tabled = "0.12.2"

src/bit_utilities.rs

@@ -1,5 +1,6 @@
-use std::fmt;
-use std::fmt::Formatter;
+use prettytable::{Cell, Row, Table};
+use std::collections::VecDeque;
+use std::{cmp, fmt};
 
 fn capitalise(s: &str) -> String {
     let mut c = s.chars();
@@ -13,48 +14,103 @@ fn capitalise(s: &str) -> String {
 #[derive(Debug)]
 pub struct BasicRegister {
     /// A [Vec] that stores the binary data of the register.
-    memory: Vec<bool>,
+    memory: VecDeque<bool>,
 }
 
 impl BasicRegister {
-    pub fn l_shift(&mut self) {
-        let mut res: Vec<bool> = vec![false; self.memory.len()];
+    /// Adjusts a register to a given size in bits.
+    pub fn adjusted_by_size(&mut self, resulting_size: usize) -> Self {
+        let current_memory_size: usize = self.memory.len();
+        let difference: i32 = current_memory_size as i32 - resulting_size as i32;
 
-        res[..(self.memory.len() - 1)]
-            .copy_from_slice(&self.memory[1..((self.memory.len() - 1) + 1)]);
-
-        self.memory = res;
+        match current_memory_size > resulting_size {
+            true => BasicRegister::new(
+                (difference as usize..current_memory_size)
+                    .map(|i| self.memory[i])
+                    .collect::<VecDeque<bool>>(),
+            ),
+            false => {
+                let mut resulting_memory: VecDeque<bool> = vec![false; -difference as usize].into();
+                resulting_memory.append(&mut self.memory);
+                BasicRegister::new(resulting_memory)
+            }
+        }
     }
 
-    pub fn r_shift(&mut self) {
-        let mut res: Vec<bool> = vec![false; self.memory.len()];
+    /// Returns a register which was logically negated.
+    pub fn negated(&self) -> Self {
+        BasicRegister::new(self.memory.iter().map(|val| !val).collect())
+    }
 
-        for i in (1..self.memory.len()).rev() {
-            res[i] = self.memory[i - 1];
+    /// Shifts the register to the left by a specified number of steps, shifting in the provided values.
+    pub fn left_shift(
+        &mut self,
+        shift_in_value_default: Option<bool>,
+        bits_shifted_default: Option<i32>,
+    ) -> VecDeque<bool> {
+        let shift_in_value: bool = shift_in_value_default.unwrap_or(false);
+        let bits_shifted: usize = bits_shifted_default.unwrap_or(1) as usize;
+
+        let mut shifted_bits: VecDeque<bool> = [].into();
+        for _i in 0..bits_shifted {
+            shifted_bits.push_back(self.memory.pop_front().unwrap());
+            self.memory.push_back(shift_in_value)
         }
 
-        self.memory = res;
+        shifted_bits
     }
 
-    pub fn reverse(&mut self) {
-        self.memory = self.memory.iter().map(|val| !val).collect();
+    /// Shifts the register to the left by a specified number of steps, shifting in the provided values.
+    pub fn right_shift(
+        &mut self,
+        shift_in_value_default: Option<bool>,
+        bits_shifted_default: Option<i32>,
+    ) -> VecDeque<bool> {
+        let shift_in_value: bool = shift_in_value_default.unwrap_or(false);
+        let bits_shifted: usize = bits_shifted_default.unwrap_or(1) as usize;
+
+        let mut shifted_bits: VecDeque<bool> = [].into();
+        for _i in 0..bits_shifted {
+            shifted_bits.push_back(self.memory.pop_back().unwrap());
+            self.memory.push_front(shift_in_value)
+        }
+
+        shifted_bits
     }
 
-    pub fn new(memory: Vec<bool>) -> Self {
+    /// Constructs a new BasicRegister from a given VecDeque<bool> as memory.
+    pub fn new(memory: VecDeque<bool>) -> Self {
         Self { memory }
     }
+
+    /// Returns the number of bits stored in a register.
+    pub fn len(&self) -> usize {
+        self.memory.len()
+    }
+
+    /*pub fn table(&self) -> Table {
+        let mut table = Table::new();
+
+        let mut memory_row: Vec<Cell> = vec![Cell::new("Memory")];
+        self.memory
+            .iter()
+            .for_each(|value| memory_row.push(Cell::new((*value as u8).to_string().as_str())));
+
+        table.add_row(Row::new(memory_row));
+        table
+    }*/
 }
 
 impl Default for BasicRegister {
     fn default() -> Self {
         Self {
-            memory: vec![false],
+            memory: [false].into(),
         }
     }
 }
 
 impl fmt::Display for BasicRegister {
-    fn fmt(&self, f: &mut Formatter<'_>) -> fmt::Result {
+    fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
         write!(f, "Memory: [")?;
 
         for (count, v) in self.memory.iter().enumerate() {
@@ -68,6 +124,28 @@ impl fmt::Display for BasicRegister {
     }
 }
 
+/*impl fmt::Binary for BasicRegister {
+    fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
+        write!(f, "Memory: ")?;
+
+        for v in self.memory.iter() {
+            write!(f, "{}", *v as u8)?;
+        }
+
+        write!(f, "")
+    }
+}*/
+
+/// Converts a u8 number to a boolean.
+///
+/// # Returns
+/// - false - if the number is zero or below.
+/// - true - if the number is above zero.
+fn u8_to_bool(number: u8) -> bool {
+    number > 0
+}
+
+/// Reads a Vec<char> containing only 1-s and 0-s from user.
 fn read_vec(variable_name: &str) -> Vec<char> {
     loop {
         print!("Enter {variable_name}: ");
@@ -82,13 +160,14 @@ fn read_vec(variable_name: &str) -> Vec<char> {
     }
 }
 
-pub fn char_to_bool_vector(char_vector: Vec<char>) -> Vec<bool> {
-    let mut bool_vector: Vec<bool> = Vec::new();
+/// Converts a Vec<char> containing only 1-s and 0-s to VecDeque<bool>.
+pub fn char_to_bool_vecdeque(char_vector: Vec<char>) -> VecDeque<bool> {
+    let mut bool_vector: VecDeque<bool> = VecDeque::new();
 
-    for value in char_vector.iter() {
+    for value in char_vector.into_iter() {
         match value {
-            '0' => bool_vector.push(false),
-            '1' => bool_vector.push(true),
+            '0' => bool_vector.push_back(false),
+            '1' => bool_vector.push_back(true),
             _ => (),
         }
     }
@@ -96,6 +175,59 @@ pub fn char_to_bool_vector(char_vector: Vec<char>) -> Vec<bool> {
     bool_vector
 }
 
-pub fn get_memory(variable_name: &str) -> Vec<bool> {
-    char_to_bool_vector(read_vec(variable_name))
+/// Handles getting the memory for the register from the user.
+pub fn get_memory(variable_name: &str) -> VecDeque<bool> {
+    char_to_bool_vecdeque(read_vec(variable_name))
+}
+
+/// Aligns two registers by the length of the bigger one.
+pub fn align_registers(
+    mut first_register: BasicRegister,
+    mut second_register: BasicRegister,
+) -> (BasicRegister, BasicRegister) {
+    let required_size: usize = cmp::max(first_register.len(), second_register.len());
+
+    (
+        first_register.adjusted_by_size(required_size),
+        second_register.adjusted_by_size(required_size),
+    )
+}
+
+/// Sums two terms containing binary numbers and keeps the carry-out.
+/// Returns a tuple containing the register with result and a carry-out.
+fn binary_sum_with_carry(
+    first_term: &BasicRegister,
+    second_term: &BasicRegister,
+) -> (BasicRegister, bool) {
+    let mut sum: BasicRegister = BasicRegister::new(vec![false; first_term.len()].into());
+
+    let mut carry: bool = false;
+    let mut current_bit_sum: u8;
+    for i in (0..first_term.len()).rev() {
+        current_bit_sum = first_term.memory[i] as u8 + second_term.memory[i] as u8 + carry as u8;
+        carry = u8_to_bool(current_bit_sum & 2);
+        sum.memory[i] = u8_to_bool(current_bit_sum & 1);
+    }
+
+    (sum, carry)
+}
+
+/// Sums two terms containing binary numbers.
+/// Returns the BasicRegister with the result.
+pub fn binary_sum(first_term: &BasicRegister, second_term: &BasicRegister) -> BasicRegister {
+    binary_sum_with_carry(first_term, second_term).0
+}
+
+/// Subtracts the value of the subtrahend from the minuend in binary using ones' complement.
+pub fn binary_subtraction(minuend: &BasicRegister, subtrahend: &BasicRegister) -> BasicRegister {
+    let (difference, final_carry) = binary_sum_with_carry(minuend, &subtrahend.negated());
+
+    match final_carry {
+        true => {
+            let mut complement: Vec<bool> = vec![false; difference.len() - 1];
+            complement.extend([true]);
+            binary_sum(&difference, &BasicRegister::new(complement.into()))
+        }
+        false => difference.negated(),
+    }
 }

src/main.rs

@@ -1,44 +1,39 @@
 #[allow(dead_code)]
 mod bit_utilities;
 
-use bit_utilities::*;
-// use text_io::read;
+use bit_utilities as bu;
+use text_io::read;
+
+fn input_handler(first_register: bu::BasicRegister, second_register: bu::BasicRegister) {
+    let (first_register, second_register) = bu::align_registers(first_register, second_register);
+
+    println!();
+    println!("{}", first_register);
+    println!("{}", second_register);
+
+    loop {
+        print!("\nChoose the operation:\n[a]ddition, [s]ubtraction, [m]ultiplication, [d]ivision, [q]uit\n>>> ");
+        let input: String = read!();
+        match input.as_str() {
+            "a" => println!(
+                "Sum:\n{}",
+                bu::binary_sum(&first_register, &second_register)
+            ),
+            "s" => println!(
+                "Subtraction:\n{}",
+                bu::binary_subtraction(&first_register, &second_register)
+            ),
+            "m" => (),
+            "d" => (),
+            "q" => std::process::exit(0x0100),
+            _ => println!("Not an available operation, try again."),
+        }
+    }
+}
 
 fn main() {
-       let mut reg = BasicRegister::new(get_memory("your number"));
-    // let mut reg: BasicRegister = Default::default();
+    let reg = bu::BasicRegister::new(bu::get_memory("your number"));
+    let reg2 = bu::BasicRegister::new(bu::get_memory("your number"));
 
-    println!("\nRegister:");
-    println!("{}", reg);
-
-    println!("\nShifted right:");
-    reg.r_shift();
-    println!("{}", reg);
-
-    println!("\nShifted left:");
-    reg.l_shift();
-    println!("{}", reg);
-
-    println!("\nReversed:");
-    reg.reverse();
-    println!("{}", reg);
-
-    // println!("{}", true);
-    // println!("{}", true);
-
-    // let a: i8 = read!();
-    // println!("{} {0:b}", a);
-    // println!("{} {0:b}", a >> 1);
-    // println!("{} {0:b}", a << 1);
-    // println!("{} {0:b}", !a);
-    // println!("{}", '3'.to_digit(2).unwrap());
-    // let f_text = format!("{a:b}").chars().collect::<Vec<char>>();
-    // println!("{:?}", f_text);
-    // println!("{:?}", char_to_bool_vector(f_text.clone()));
-    // let b: BasicRegister = BasicRegister::new(char_to_bool_vector(f_text));
-    // b.print_register();
-    // println!("{:?}", get_memory(format!("{a:b}")));
-    // println!("{:?}", a.split(" ").collect::<Vec<&str>>());
-    // a = text_io::read!("{}\n");
-    // println!("{a}")
+    input_handler(reg, reg2);
 }