Word abstract -> interface

.gitignore

@@ -1,4 +1,3 @@
-.vscode
 .gradle
 **/build/
 !src/**/build/
@@ -20,24 +19,3 @@ gradle-app.setting
 .project
 # JDT-specific (Eclipse Java Development Tools)
 .classpath
-
-# Compiled class file
-*.class
-
-# Log file
-*.log
-
-# Package Files #
-*.jar
-*.war
-*.nar
-*.ear
-*.zip
-*.tar.gz
-*.rar
-
-*.minisig
-
-# virtual machine crash logs, see http://www.java.com/en/download/help/error_hotspot.xml
-hs_err_pid*
-replay_pid*

README.md

@@ -52,17 +52,14 @@ classDiagram
     Computer --> ProgramCounter
     Program <-- ArrayList
     Program : +toString()
-    Memory --|> LongMemory
-    Word --|> LongWord
+    Memory <|-- LongMemory
+    Word <|-- LongWord
 
 
 ```
 
 ```mermaid
 classDiagram
-    class Operand {
-        + Word getValue()
-    }
     class Instruction {
         + void execute(Memory memory, ProgramCounter pc)
         # String opcode()
@@ -76,9 +73,8 @@ classDiagram
     class JumpEq
     class Mul
     class Print
-    Instruction *-- Operand
-    Operand <|-- Word
-    Operand <|-- Address
+    Instruction --|> Word
+    Instruction --|> Address
     Add --|> Instruction
     Copy --|> Instruction
     Halt --|> Instruction

app/src/main/java/hatelace/Address.java

@@ -1,6 +1,6 @@
 package hatelace;
 
-public class Address implements Operand {
+public class Address {
     int address;
 
     public Address(int address) {
@@ -14,8 +14,4 @@ public class Address implements Operand {
     public String toString() {
         return Integer.toString(address);
     }
-
-    public Word getWord(Memory memory) {
-        return memory.read(this);
-    }
 }

app/src/main/java/hatelace/Instruction.java

@@ -1,11 +1,8 @@
 package hatelace;
 
-public abstract class Instruction {
-    public abstract void execute(Memory memory, ProgramCounter pc);
-
-    protected abstract String opcode();
-
-    protected abstract Object[] operands();
-
-    public abstract String toString();
+public interface Instruction {
+    void execute(Memory memory, ProgramCounter pc);
+    String opcode();
+    Object[] operands();
+    String toString();
 }

app/src/main/java/hatelace/Operand.java

@@ -1,5 +0,0 @@
-package hatelace;
-
-public interface Operand {
-    Word getWord(Memory memory);
-}

app/src/main/java/hatelace/Word.java

@@ -1,11 +1,11 @@
 package hatelace;
 
-public abstract class Word implements Operand {
-    public abstract <T> T getValue();
-    public abstract Word add(Word other);
-    public abstract Word subtract(Word other);
-    public abstract Word multiply(Word other);
-    public abstract Word divide(Word other);
-    public abstract String toString();
-    public abstract boolean equals(Object other);
+public interface Word {
+    <T> T getValue();
+    Word add(Word other);
+    Word subtract(Word other);
+    Word multiply(Word other);
+    Word divide(Word other);
+    String toString();
+    boolean equals(Object other);
 }

app/src/main/java/hatelace/instructions/Add.java

@@ -2,31 +2,32 @@ package hatelace.instructions;
 
 import hatelace.*;
 
-public class Add extends Instruction {
+public class Add implements Instruction {
+    private Address src;
+    private Word imm;
     private Address dest;
-    private Operand o1, o2;
 
     /** Add immediate value to memory address. */
-    public Add(Operand o1, Operand o2, Address dest) {
-        this.o1 = o1;
-        this.o2 = o2;
+    public Add(Address src, Word imm, Address dest) {
+        this.src = src;
+        this.imm = imm;
         this.dest = dest;
     }
 
     public void execute(Memory memory, ProgramCounter PC) {
-        memory.write(this.dest, this.o1.getWord(memory).add(this.o2.getWord(memory)));
+        memory.write(this.dest, memory.read(this.src).add(this.imm));
         PC.incPC();
     }
 
-    protected String opcode() {
+    public String opcode() {
         return "ADD";
     }
 
     public String toString() {
-        return String.format("%s [%s] %s [%s]", this.opcode(), this.o1, this.o2, this.dest);
+        return String.format("%s [%s] %s [%s]", this.opcode(), this.src, this.imm, this.dest);
     }
 
-    protected Object[] operands() {
-        return new Object[] { this.o1, this.o2, this.dest };
+    public Object[] operands() {
+        return new Object[] { this.src, this.imm, this.dest };
     }
 }

app/src/main/java/hatelace/instructions/Copy.java

@@ -2,30 +2,30 @@ package hatelace.instructions;
 
 import hatelace.*;
 
-public class Copy extends Instruction {
-    private Operand src;
+public class Copy implements Instruction {
+    private Word imm;
     private Address dest;
 
     /** Copy immediate value to memory address. */
-    public Copy(Operand src, Address dest) {
-        this.src = src;
+    public Copy(Word imm, Address dest) {
+        this.imm = imm;
         this.dest = dest;
     }
 
     public void execute(Memory memory, ProgramCounter PC) {
-        memory.write(this.dest, this.src.getWord(memory));
+        memory.write(this.dest, this.imm);
         PC.incPC();
     }
 
-    protected String opcode() {
+    public String opcode() {
         return "CPY";
     }
 
-    protected Object[] operands() {
-        return new Object[] {this.src, this.dest};
+    public Object[] operands() {
+        return new Object[] {this.imm, this.dest};
     }
 
     public String toString() {
-        return String.format("%s %s [%s]", this.opcode(), this.src, this.dest);
+        return String.format("%s %s [%s]", this.opcode(), this.imm, this.dest);
     }
 }

app/src/main/java/hatelace/instructions/Halt.java

@@ -2,7 +2,7 @@ package hatelace.instructions;
 
 import hatelace.*;
 
-public class Halt extends Instruction {
+public class Halt implements Instruction {
     /** Halts the CPU */
     public Halt(){};
 
@@ -10,11 +10,11 @@ public class Halt extends Instruction {
         PC.halt();
     }
 
-    protected String opcode() {
+    public String opcode() {
         return "HLT";
     }
 
-    protected Object[] operands() {
+    public Object[] operands() {
         return new Object[] {};
     }
 

app/src/main/java/hatelace/instructions/Jump.java

@@ -2,7 +2,7 @@ package hatelace.instructions;
 
 import hatelace.*;
 
-public class Jump extends Instruction {
+public class Jump implements Instruction {
     private int index;
 
     /** Unconditional jump, non-relative */
@@ -14,11 +14,11 @@ public class Jump extends Instruction {
         PC.setPC(this.index);
     }
 
-    protected String opcode() {
+    public String opcode() {
         return "JMP";
     }
 
-    protected Object[] operands() {
+    public Object[] operands() {
         return new Object[] {this.index};
     }
 

app/src/main/java/hatelace/instructions/JumpEq.java

@@ -2,35 +2,35 @@ package hatelace.instructions;
 
 import hatelace.*;
 
-public class JumpEq extends Instruction {
+public class JumpEq implements Instruction {
     private int index;
-    private Operand o1;
-    private Operand o2;
+    private Address src;
+    private Word imm;
 
     /** Conditional jump */
-    public JumpEq(int index, Operand o1, Operand o2) {
+    public JumpEq(int index, Address src, Word imm) {
         this.index = index;
-        this.o1 = o1;
-        this.o2 = o2;
+        this.src = src;
+        this.imm = imm;
     }
 
     public void execute(Memory memory, ProgramCounter PC) {
-        if (this.o1.getWord(memory).equals(this.o2.getWord(memory))) {
+        if (this.imm.equals(memory.read(this.src))) {
             PC.setPC(this.index);
         } else {
             PC.incPC();
         }
     }
 
-    protected String opcode() {
+    public String opcode() {
         return "JEQ";
     }
 
-    protected Object[] operands() {
-        return new Object[] {this.index, this.o1, this.o2};
+    public Object[] operands() {
+        return new Object[] {this.index, this.src, this.imm};
     }
 
     public String toString() {
-        return String.format("%s %s [%s] %s", this.opcode(), this.index, this.o1, this.o2);
+        return String.format("%s %s [%s] %s", this.opcode(), this.index, this.src, this.imm);
     }
 }

app/src/main/java/hatelace/instructions/Mul.java

@@ -2,32 +2,32 @@ package hatelace.instructions;
 
 import hatelace.*;
 
-public class Mul extends Instruction {
-    private Operand o1;
-    private Operand o2;
+public class Mul implements Instruction {
+    private Address src1;
+    private Address src2;
     private Address dest;
 
     /** Multiply contents of two addresses and store the result in a third memory address. */
-    public Mul(Operand o1, Operand o2, Address dest) {
-        this.o1 = o1;
-        this.o2 = o2;
+    public Mul(Address src1, Address src2, Address dest) {
+        this.src1 = src1;
+        this.src2 = src2;
         this.dest = dest;
     }
 
     public void execute(Memory memory, ProgramCounter PC) {
-        memory.write(this.dest, this.o1.getWord(memory).multiply(this.o2.getWord(memory)));
+        memory.write(this.dest, memory.read(this.src1).multiply(memory.read(this.src2)));
         PC.incPC();
     }
 
-    protected String opcode() {
+    public String opcode() {
         return "MUL";
     }
 
-    protected Object[] operands() {
-        return new Object[] { this.o1, this.o2, this.dest };
+    public Object[] operands() {
+        return new Object[] { this.src1, this.src2, this.dest };
     }
 
     public String toString() {
-        return String.format("%s [%s] [%s] [%s]", this.opcode(), this.o1, this.o2, this.dest);
+        return String.format("%s [%s] [%s] [%s]", this.opcode(), this.src1, this.src2, this.dest);
     }
 }

app/src/main/java/hatelace/instructions/Print.java

@@ -2,7 +2,7 @@ package hatelace.instructions;
 
 import hatelace.*;
 
-public class Print extends Instruction {
+public class Print implements Instruction {
     private Address address;
 
     /** Print content of memory address */
@@ -15,11 +15,11 @@ public class Print extends Instruction {
         PC.incPC();
     }
 
-    protected String opcode() {
+    public String opcode() {
         return "PRT";
     }
 
-    protected Object[] operands() {
+    public Object[] operands() {
         return new Object[] { this.address };
     }
 

app/src/main/java/hatelace/memtypes/IntWord.java

@@ -1,9 +1,8 @@
 package hatelace.memtypes;
 
-import hatelace.Memory;
 import hatelace.Word;
 
-public class IntWord extends Word {
+public class IntWord implements Word {
     private Integer value;
 
     public IntWord(Integer value) {
@@ -16,11 +15,6 @@ public class IntWord extends Word {
         return value;
     }
 
-    @Override
-    public Word getWord(Memory memory) {
-        return this;
-    }
-
     public Word add(Word other) {
         return new IntWord(value + (Integer) other.getValue());
     }

app/src/main/java/hatelace/memtypes/LongWord.java

@@ -1,9 +1,8 @@
 package hatelace.memtypes;
 
-import hatelace.Memory;
 import hatelace.Word;
 
-public class LongWord extends Word {
+public class LongWord implements Word {
     private Long value;
 
     public LongWord(Long value) {
@@ -16,11 +15,6 @@ public class LongWord extends Word {
         return value;
     }
 
-    @Override
-    public Word getWord(Memory memory) {
-        return this;
-    }
-
     public Word add(Word other) {
         return new LongWord(value + (Long) other.getValue());
     }

doc/answers.md

@@ -1,15 +0,0 @@
-1. En interface som alla typer av instruktioner kan ha gemensam borde inte vara helt fel. Vilket i sin tur betyder en klass för varje instruktion där ett instruktions interface implementeras.
-
-2. Man ärver lämplig collection, ex arraylist. Detta är kass design, då komposition är tydligare.
-
-3. "Program" och självaste "datorn" borde vara olika paket, paketet "program" rör program som skall köra på datorn, "datorn" har de klasser som är datorn som t.ex. memory och programCounter osv.
-
-4. Varje instruktion skulle kunna representeras som ett kommando, och datorn skulle utföra dessa kommandon utan att behöva veta exakt vad varje instruktion innebär. På så sätt separeras ansvar, och det blir enklare att lägga till eller ändra instruktioner i framtiden.
-
-5. Designmönstret Template Method kan vara användbart för att undvika duplicerad kod i likartade klasser, särskilt för de instruktionsklasser som ingår i programmet (t.ex. Copy, JumpEq, Mul, Add, Print, Halt). Eftersom dessa instruktionsklasser kan ha vissa gemensamma delar i hur de utför sin uppgift, kan ett template method-mönster användas för att abstrahera och återanvända gemensam kod.
-
-6. För att hantera olika sorters operander på ett enhetligt sätt med hjälp av Strategy-mönstret i en datormodell skulle man kunna implementera olika strategier för hur operander ska hanteras. Operander kan vara antingen konstanter eller adresser, och olika instruktioner kräver olika typer av operander.
-
-7. Additionen bör nog utföras i LongWord.
-
-8.

makefile

@@ -1,8 +1,3 @@
-GITHASH := $(shell git rev-parse --short HEAD)$(shell git diff-index --quiet HEAD || echo "-dirty")
-
-TARNAME := hatelace-imbus_$(GITHASH).tar.gz
-DIRNAME := hatelace
-
 run:
 	./gradlew run
 
@@ -11,35 +6,11 @@ watch:
 
 build:
 	./gradlew build
-	ls -lh app/build/libs/*.jar
 
 clean:
 	./gradlew clean
-	rm -f *.tar.gz *.tar.gz.minisig *.zip *.jpg
 
 test:
 	./gradlew test
 
-$(TARNAME):
-	git archive --format=tar --prefix=$(DIRNAME)/ HEAD > intermediate.tar
-	tar -f intermediate.tar --delete $(DIRNAME)/doc
-	gzip -9 -c intermediate.tar > $(TARNAME)
-	rm intermediate.tar
-
-$(TARNAME).minisig: $(TARNAME)
-	minisign -Sm $(TARNAME)
-
-tar: $(TARNAME)
-	tar -tvf $(TARNAME)
-
-sign: $(TARNAME).minisig
-
-publish: $(TARNAME) $(TARNAME).minisig
-	@git diff-index --quiet HEAD || (echo "git is dirty, commit changes first"; exit 1)
-	ssh server mkdir -p /public/$(DIRNAME)
-	rsync -avz $(TARNAME).minisig server:/public/$(DIRNAME)/$(TARNAME).minisig
-	rsync -avz $(TARNAME) server:/public/$(DIRNAME)/$(TARNAME)
-	ssh server ln -sf /public/$(DIRNAME)/$(TARNAME).minisig /public/$(DIRNAME)/latest.tar.gz.minisig
-	ssh server ln -sf /public/$(DIRNAME)/$(TARNAME) /public/$(DIRNAME)/latest.tar.gz
-
-.PHONY: run watch build clean test archive sign publish
+.PHONY: run build clean