From 98f3be87dde146d646fa950765313fe35cd02183 Mon Sep 17 00:00:00 2001
From: yzamir <kobi.zamir@gmail.com>
Date: Mon, 2 Oct 2023 09:23:00 +0300
Subject: [PATCH] Add NOP command and a list for command lengths

Signed-off-by: yzamir <kobi.zamir@gmail.com>
---
 README.ASM.md                       |  1 +
 public/js/components/code-editor.js |  2 +-
 src/compiler.mjs                    | 28 ++++++------
 src/debug.mjs                       | 16 +++++++
 src/disassemble.mjs                 |  9 ++--
 src/opcodes.mjs                     | 71 ++++++++++++++++++++---------
 src/vm.mjs                          | 24 ++++------
 7 files changed, 94 insertions(+), 57 deletions(-)

diff --git a/README.ASM.md b/README.ASM.md
index 253d9ee..4b34e9f 100644
--- a/README.ASM.md
+++ b/README.ASM.md
@@ -20,6 +20,7 @@ SMART Assembly is a simple assembly language designed for educational purposes.
 
 Here's a list of available opcodes in the SMART Assembly language:
 
+- `NOP`: No operation, move the program counter.
 - `LOADA <label>`: Load the value from the memory location specified by `<label>` into register A.
 - `LOADB <label>`: Load the value from the memory location specified by `<label>` into register B.
 - `STOREA <label>`: Store the value from register A into the memory location specified by `<label>`.
diff --git a/public/js/components/code-editor.js b/public/js/components/code-editor.js
index 29c25e9..01f2bc1 100644
--- a/public/js/components/code-editor.js
+++ b/public/js/components/code-editor.js
@@ -127,7 +127,7 @@ class CodeEditor extends HTMLElement {
   highlightText() {
     const text = this.editor.innerHTML;
     const highlightedText = text
-      .replace(/(LOADA|LOADB|STOREA|STOREB|ORA|ORB|ANDA|ANDB|XORA|XORB|NOTA|NOTB|SHLA|SHLB|SHRA|SHRB|JUMP|JZA|JZB|ADDA|ADDB|END|DATA)/g, '<span class="code">$1</span>')
+      .replace(/(NOP|LOADA|LOADB|STOREA|STOREB|ORA|ORB|ANDA|ANDB|XORA|XORB|NOTA|NOTB|SHLA|SHLB|SHRA|SHRB|JUMP|JZA|JZB|ADDA|ADDB|END|DATA)/g, '<span class="code">$1</span>')
       .replace(/(0x[\da-fA-F]{2})/g, '<span class="literal">$1</span>')
       .replace(/(^|<br>)(\s*\w+:)/g, '$1<span class="label">$2</span>')
       .replace(/(;.*?)(<br>|$)/gm, (_, p1, p2) => {
diff --git a/src/compiler.mjs b/src/compiler.mjs
index e1861a8..90190bf 100644
--- a/src/compiler.mjs
+++ b/src/compiler.mjs
@@ -1,7 +1,6 @@
-import opcodes from './opcodes.mjs';
-import {
-  findKeyByValue, formatAddress, formatHexByte, formatBinary,
-} from './utils.mjs';
+import { opcodes, opcodesParams } from './opcodes.mjs';
+import { findKeyByValue } from './utils.mjs';
+import { throwFormattedError } from './debug.mjs';
 
 /**
  * Removes comments from a line of assembly code.
@@ -62,7 +61,7 @@ function processLabel(instruction, operands, labels, address) {
 
   if (instruction === 'DATA') {
     address += operands.length; // For each data value
-  } else if (opcodes[instruction] !== undefined) {
+  } else if (instruction in opcodes) {
     address += 1; // For the opcode
     address += operands.length; // For each operand
   }
@@ -80,11 +79,12 @@ function processLabel(instruction, operands, labels, address) {
 function processInstruction(instruction, operands, memory, labels, memoryMapping) {
   const addToMemory = (value, type, asmOpcode = null, asmOperand = null) => {
     const address = memory.length;
+    const valueInt = parseInt(value, 10);
 
-    memory.push(value);
+    memory.push(valueInt);
     memoryMapping.push({
       address,
-      value: parseInt(value, 10),
+      value: valueInt,
       type,
       asmOpcode,
       asmOperand,
@@ -96,22 +96,20 @@ function processInstruction(instruction, operands, memory, labels, memoryMapping
     operands.forEach((operand) => {
       addToMemory(parseValue(operand), 'data', null, operand);
     });
-  } else if (opcodes[instruction] !== undefined) {
+  } else if (instruction in opcodes) {
     addToMemory(opcodes[instruction], 'opcode', instruction);
 
+    if (operands.length !== opcodesParams[opcodes[instruction]]) {
+      throwFormattedError('Wrong number of operands', instruction, memory.length);
+    }
+
     operands.forEach((operand) => {
       const operandValue = findKeyByValue(labels, operand) || parseValue(operand);
       addToMemory(operandValue, 'operand', null, operand);
     });
   } else if (instruction) {
     // Note: a valid line with a lable and no opCode will have an instruction == undefined.
-    const formattedInstructionHex = formatHexByte(instruction);
-    const formattedInstructionBinary = formatBinary(instruction, 8); // Assuming 8 bits for the instruction
-    const formattedAddressHex = formatAddress(memory.length);
-    const formattedAddressDecimal = memory.length;
-
-    const errorMessage = `Invalid instruction [${formattedInstructionHex} | ${formattedInstructionBinary}] at address ${formattedAddressHex} (${formattedAddressDecimal})!`;
-    throw new Error(errorMessage);
+    throwFormattedError('Invalid instruction', instruction, memory.length);
   }
 }
 
diff --git a/src/debug.mjs b/src/debug.mjs
index 1d7ff62..3789511 100644
--- a/src/debug.mjs
+++ b/src/debug.mjs
@@ -2,6 +2,22 @@ import {
   formatHexByte, formatBinary, formatDecimal, formatAddress,
 } from './utils.mjs';
 
+/**
+ * Formats the error message and throws an error.
+ *
+ * @param {string} message - The error message.
+ * @param {number} instruction - The instruction code.
+ * @param {number} memoryLength - The length of the memory.
+ * @throws {Error} Throws an error with a formatted message.
+ */
+export function throwFormattedError(message, instruction, memoryLength) {
+  const formattedAddressHex = formatAddress(memoryLength);
+  const formattedAddressDecimal = memoryLength;
+
+  const errorMessage = `${message} opCOde [${instruction}] at address [${formattedAddressHex} (${formattedAddressDecimal})]`;
+  throw new Error(errorMessage);
+}
+
 /**
  * Dumps the labels and their addresses to the console.
  *
diff --git a/src/disassemble.mjs b/src/disassemble.mjs
index 13cb116..3c56599 100644
--- a/src/disassemble.mjs
+++ b/src/disassemble.mjs
@@ -1,4 +1,4 @@
-import opcodes from './opcodes.mjs';
+import { opcodes } from './opcodes.mjs';
 import { findKeyByValue } from './utils.mjs';
 
 /**
@@ -58,8 +58,6 @@ export function disassemble(memory) {
         case 'LOADB':
         case 'STOREA':
         case 'STOREB':
-        case 'ORA':
-        case 'ORB':
         case 'ANDA':
         case 'ANDB':
         case 'XORA':
@@ -86,6 +84,11 @@ export function disassemble(memory) {
           operandValue = memory[++address];
           asmOperand = operandValue.toString(); // Directly use the integer value for shifts
           break;
+        case 'ORA':
+        case 'ORB':
+        case 'NOP':
+          // obCodes with no operands
+          break;
         case 'END':
           progEnd = true;
           break;
diff --git a/src/opcodes.mjs b/src/opcodes.mjs
index 5e4aa7a..2a5e45b 100644
--- a/src/opcodes.mjs
+++ b/src/opcodes.mjs
@@ -1,26 +1,53 @@
-const opcodes = {
-  LOADA: 0x00,
-  LOADB: 0x01,
-  STOREA: 0x02,
-  STOREB: 0x03,
-  ORA: 0x04,
-  ORB: 0x05,
-  ANDA: 0x06,
-  ANDB: 0x07,
-  XORA: 0x08,
-  XORB: 0x09,
-  NOTA: 0x0A,
-  NOTB: 0x0B,
-  SHLA: 0x0C,
-  SHLB: 0x0D,
-  SHRA: 0x0E,
-  SHRB: 0x0F,
-  JUMP: 0x10,
-  JZA: 0x11,
-  JZB: 0x12,
-  ADDA: 0x13,
-  ADDB: 0x14,
+export const opcodes = {
+  NOP: 0x00,
+  LOADA: 0x01,
+  LOADB: 0x02,
+  STOREA: 0x03,
+  STOREB: 0x04,
+  ORA: 0x05,
+  ORB: 0x06,
+  ANDA: 0x07,
+  ANDB: 0x08,
+  XORA: 0x09,
+  XORB: 0x0A,
+  NOTA: 0x0B,
+  NOTB: 0x0C,
+  SHLA: 0x0D,
+  SHLB: 0x0E,
+  SHRA: 0x0F,
+  SHRB: 0x10,
+  JUMP: 0x11,
+  JZA: 0x12,
+  JZB: 0x13,
+  ADDA: 0x14,
+  ADDB: 0x15,
   END: 0xFF,
 };
 
+export const opcodesParams = {
+  [opcodes.NOP]: 0,
+  [opcodes.LOADA]: 1,
+  [opcodes.LOADB]: 1,
+  [opcodes.STOREA]: 1,
+  [opcodes.STOREB]: 1,
+  [opcodes.ORA]: 1,
+  [opcodes.ORB]: 1,
+  [opcodes.ANDA]: 1,
+  [opcodes.ANDB]: 1,
+  [opcodes.XORA]: 1,
+  [opcodes.XORB]: 1,
+  [opcodes.NOTA]: 0,
+  [opcodes.NOTB]: 0,
+  [opcodes.SHLA]: 1,
+  [opcodes.SHLB]: 2,
+  [opcodes.SHRA]: 1,
+  [opcodes.SHRB]: 1,
+  [opcodes.JUMP]: 1,
+  [opcodes.JZA]: 1,
+  [opcodes.JZB]: 1,
+  [opcodes.ADDA]: 1,
+  [opcodes.ADDB]: 1,
+  [opcodes.END]: 0,
+};
+
 export default opcodes;
diff --git a/src/vm.mjs b/src/vm.mjs
index 29faa3a..f772803 100644
--- a/src/vm.mjs
+++ b/src/vm.mjs
@@ -1,7 +1,5 @@
-import opcodes from './opcodes.mjs';
-import {
-  formatHexByte, formatBinary, formatAddress,
-} from './utils.mjs';
+import { opcodes, opcodesParams } from './opcodes.mjs';
+import { throwFormattedError } from './debug.mjs';
 
 class VM {
   constructor(memorySize = 256) {
@@ -12,8 +10,7 @@ class VM {
   }
 
   fetchOperand() {
-    this.pc++;
-    return this.memory[this.pc];
+    return this.memory[this.pc + 1];
   }
 
   /**
@@ -23,8 +20,10 @@ class VM {
    */
   execute() {
     let jumpFlag = false;
+    const instruction = this.memory[this.pc];
 
     const handlers = {
+      [opcodes.NOP]: () => true,
       [opcodes.LOADA]: () => this.registerA = this.memory[this.fetchOperand()],
       [opcodes.LOADB]: () => this.registerB = this.memory[this.fetchOperand()],
       [opcodes.STOREA]: () => this.memory[this.fetchOperand()] = this.registerA,
@@ -49,22 +48,15 @@ class VM {
       [opcodes.END]: () => false,
     };
 
-    const instruction = this.memory[this.pc];
-    if (handlers[instruction]) {
+    if (instruction in handlers) {
       handlers[instruction]();
     } else {
-      const formattedInstructionHex = formatHexByte(instruction);
-      const formattedInstructionBinary = formatBinary(instruction, 8); // Assuming 8 bits for the instruction
-      const formattedAddressHex = formatAddress(this.pc);
-      const formattedAddressDecimal = this.pc;
-
-      const errorMessage = `Invalid instruction [${formattedInstructionHex} | ${formattedInstructionBinary}] at address ${formattedAddressHex} (${formattedAddressDecimal})!`;
-      throw new Error(errorMessage);
+      throwFormattedError('Invalid instruction', instruction, this.pc);
     }
 
     // Dont incriment the counter on jumps
     if (!jumpFlag) {
-      this.pc++;
+      this.pc += (1 + opcodesParams[instruction]);
     }
 
     // Memory gurd