Console is now remote and more functional

Author: azertyfun

.gitignore

@@ -1,2 +1,3 @@
 *.log
+*.o
 out/

.idea/workspace.xml

@@ -45,7 +45,7 @@ Options:
   --edc                    Adds an EDC device.
   --M35FD=path/to/file     Adds an M35FD device with a floppy stored in path/to/file.
   --M525HD=path/to/file    Adds an M525HD device with a hard disk stored in path/to/file.
-  --console                Makes the LEM1802s and keyboard work with stdin/stdout. Only works with consoles that support ANSI escape codes (i.e. not cmd, but cygwin does). Flags that would otherwise spawn a window are disabled.
+  --console                Disables debugger and EDC, and creates a server on port 25570 that can be used by remoteConsole.py to control the LEM1802 and keyboard via a remote console. Useful if you want to run the emulator headless.
 ```
 
 Screenshot

README.md

@@ -0,0 +1,99 @@
+#!/usr/bin/env python3
+
+import sys
+import curses
+import socket
+
+colors = [curses.COLOR_BLACK, curses.COLOR_BLUE, curses.COLOR_GREEN, curses.COLOR_CYAN, curses.COLOR_RED, curses.COLOR_MAGENTA, curses.COLOR_RED, curses.COLOR_CYAN, curses.COLOR_WHITE, curses.COLOR_RED, curses.COLOR_GREEN, curses.COLOR_CYAN, curses.COLOR_RED, curses.COLOR_RED, curses.COLOR_YELLOW, curses.COLOR_WHITE]
+
+def init_curses():
+    stdscr = curses.initscr()
+    curses.noecho()
+    curses.raw()
+    curses.start_color()
+    stdscr.keypad(True)
+
+    stdscr.timeout(0)
+
+    return stdscr
+
+def free_curses():
+    curses.nocbreak()
+    stdscr.keypad(False)
+    curses.echo()
+    curses.endwin()
+
+def init_networking():
+    mySocket = socket.socket(socket.AF_INET, socket.SOCK_STREAM)
+    mySocket.connect((sys.argv[1], int(sys.argv[2])))
+    return mySocket
+
+if len(sys.argv) != 3:
+    print("Error: two arguments needed.")
+    print("Usage:\n./remoteConsole.py <address> <port>")
+    sys.exit()
+
+stdscr = init_curses()
+try:
+    socket = init_networking()
+    while True:
+
+        # We can't make a receive of 12*32*2 bytes at once because a bytearray doesn't work after 512 items for some reason.
+        data = []
+        for i in range(0, 12*32*2):
+            b = socket.recv(1)
+            data.append(b[0])
+
+        stdscr.clear()
+
+        pairs = []
+        pairPointer = 1
+
+        for i in range(0, 12*32):
+            try:
+                d = (data[i * 2] << 8) | data[i * 2 + 1]
+            except IndexError:
+                stdscr.addstr("error at index " + str(i))
+
+            if i % 32 == 0 and i != 0:
+                stdscr.addstr("\n");
+
+            c = d & 0x7F
+            blink = (d >> 7) & 1
+            color = (d >> 8) & 0xFF
+            #stdscr.addstr("Color: " + str(colors[color >> 4]) + ", " + str(colors[color & 0xF]));
+            #stdscr.getch()
+            pair = [pairPointer, colors[color >> 4], colors[color & 0xF]]
+            foundPair = False
+            for p in pairs:
+                if p[1] == pair[1] and p[2] == pair[2]:
+                    pair[0] = p[0]
+                    foundPair = True
+                    break
+
+            if not foundPair:
+                pairs.append(pair)
+                pairPointer = pairPointer + 1
+                try:
+                    curses.init_pair(pair[0], pair[1], pair[2])
+                except curses.error:
+                    stdscr.addstr("pairPointer: " + str(pairPointer))
+                    stdscr.getch()
+
+            stdscr.addstr(chr(c), curses.color_pair(pair[0]))
+            #stdscr.getch()
+
+        c = stdscr.getch()
+        if c != curses.ERR:
+            b = bytearray()
+            b.append(c)
+            b.append(0)
+            socket.send(b)
+            if c == 3:
+                free_curses()
+                break
+
+        stdscr.refresh()
+
+finally:
+    free_curses()

remoteConsole/remoteConsole.py

@@ -46,7 +46,7 @@ public static void usage() {
 				"  --edc                    Adds an EDC device.\n" +
 				"  --M35FD=path/to/file     Adds an M35FD device with a floppy stored in path/to/file.\n" +
 				"  --M525HD=path/to/file    Adds an M525HD device with a hard disk stored in path/to/file.\n" +
-				"  --console                Makes the LEM1802s and keyboard work with stdin/stdout. Only works with consoles that support ANSI escape codes (i.e. not cmd, but cygwin does). Flags that would otherwise spawn a window are disabled.");
+				"  --console                Disables debugger and EDC, and creates a server on port 25570 that can be used by remoteConsole.py to control the LEM1802 and keyboard via a remote console. Useful if you want to run the emulator headless.");
 
 		System.exit(-1);
 	}

src/tk/azertyfun/dcputoolchain/DCPUToolChain.java

@@ -16,13 +16,16 @@ public class Emulator implements CallbackStop {
 
 	private LinkedList<DCPUHardware> hardware = new LinkedList<>();
 	private LinkedList<LemDisplay> lemDisplays = new LinkedList<>();
-	private LinkedList<KeyboardInterface> keyboardInterfaces = new LinkedList<>();
+	private LinkedList<KeyboardDisplay> keyboardDisplays = new LinkedList<>();
 	private LinkedList<EdcDisplay> edcDisplays = new LinkedList<>();
 
 	private TickingThread ticking;
 
 	private DebuggerInterface debuggerInterface;
 
+	private boolean console = false;
+	private ConsoleServer consoleServer;
+
 	public Emulator(String[] args) {
 		String input_file = args[1];
 
@@ -41,11 +44,8 @@ public Emulator(String[] args) {
 		boolean assemble = false;
 		boolean debugger = false;
 		boolean optimize_shortLiterals = true;
-		boolean console = false;
 		boolean addLem = false; //If we have to add a LEM, it must be initialized last because creating a JFrame after having initialized glfw will make java (at least with OpenJDK 8) crash.
 
-		int console_offset = 0;
-
 		if(args.length > 2) {
 
 			for(int i = 2; i < args.length; ++i) {
@@ -78,21 +78,21 @@ public Emulator(String[] args) {
 					hardware.getLast().connectTo(dcpu);
 					hardware.getLast().powerOn();
 
-					KeyboardInterface keyboardInterface;
-					if(console) {
-						keyboardInterface = new KeyboardConsole((GenericKeyboard) hardware.getLast(), cpuControl, this);
-						(new Thread((KeyboardConsole) keyboardInterface)).start();
-					} else {
-						keyboardInterface = new KeyboardDisplay((GenericKeyboard) hardware.getLast(), cpuControl);
+					if(!console) {
+						KeyboardDisplay keyboardDisplay = new KeyboardDisplay((GenericKeyboard) hardware.getLast(), cpuControl);
+						keyboardDisplays.add(keyboardDisplay);
 					}
-					keyboardInterfaces.add(keyboardInterface);
 				} else if(args[i].equalsIgnoreCase("--EDC")) {
-					hardware.add(hardwareTracker.requestEDC());
-					hardware.getLast().connectTo(dcpu);
-					hardware.getLast().powerOn();
+					if(!console) {
+						hardware.add(hardwareTracker.requestEDC());
+						hardware.getLast().connectTo(dcpu);
+						hardware.getLast().powerOn();
 
-					EdcDisplay edcDisplay = new EdcDisplay((EDC) hardware.getLast());
-					edcDisplays.add(edcDisplay);
+						EdcDisplay edcDisplay = new EdcDisplay((EDC) hardware.getLast());
+						edcDisplays.add(edcDisplay);
+					} else {
+						System.out.println("WARNING: Ignored edc flag, console flag specified.");
+					}
 				} else {
 					if (!args[i].equalsIgnoreCase("--console")) {
 						String[] splitted = args[i].split("=");
@@ -170,15 +170,11 @@ public Emulator(String[] args) {
 				hardware.getLast().connectTo(dcpu);
 				hardware.getLast().powerOn();
 
-				LemDisplay lemDisplay;
-				if(console) {
-					lemDisplay = new LemDisplayConsole((LEM1802) hardware.getLast(), console_offset);
-					console_offset += 12;
-				} else {
-					lemDisplay = new LemDisplayGlfw((LEM1802) hardware.getLast());
+				if(!console) {
+					LemDisplay lemDisplay = new LemDisplay((LEM1802) hardware.getLast());
+					lemDisplay.start();
+					lemDisplays.add(lemDisplay);
 				}
-				lemDisplay.start();
-				lemDisplays.add(lemDisplay);
 			}
 		} else {
 			LEM1802 lem1802 = hardwareTracker.requestLem();
@@ -200,6 +196,19 @@ public Emulator(String[] args) {
 			debuggerInterface = new DebuggerInterface(dcpu, ticking, this);
 		}
 
+		if(console) {
+			consoleServer = new ConsoleServer(25570);
+			for(GenericKeyboard genericKeyboard : hardwareTracker.getKeyboards()) {
+				consoleServer.addKeyboard(genericKeyboard);
+			}
+
+			for(LEM1802 lem1802 : hardwareTracker.getLems()) {
+				consoleServer.addLemDisplayConsole(lem1802);
+			}
+
+			consoleServer.start();
+		}
+
 		try {
 			if(assemble) {
 				File tmpFile = File.createTempFile("DCPUToolchain", Long.toString(System.currentTimeMillis()));
@@ -255,12 +264,15 @@ public void stopCallback() {
 			debuggerInterface.close();
 		for(LemDisplay lemDisplay : lemDisplays)
 			lemDisplay.close();
-		for(KeyboardInterface keyboardInterface : keyboardInterfaces)
+		for(KeyboardDisplay keyboardInterface : keyboardDisplays)
 			keyboardInterface.close();
 		for(EdcDisplay edcDisplay : edcDisplays)
 			edcDisplay.close();
 		ticking.setStopped();
 
+		if(console)
+			consoleServer.setStopped();
+
 		try {
 			Thread.sleep(1000);
 			System.exit(0);

src/tk/azertyfun/dcputoolchain/Emulator.java

@@ -109,4 +109,12 @@ public M525HD getM525HD(String id) {
 		}
 		return null;
 	}
+
+	public LinkedList<GenericKeyboard> getKeyboards() {
+		return keyboards;
+	}
+
+	public LinkedList<LEM1802> getLems() {
+		return lems;
+	}
 }

src/tk/azertyfun/dcputoolchain/emulator/HardwareTracker.java

@@ -0,0 +1,113 @@
+package tk.azertyfun.dcputoolchain.interfaces;
+
+import tk.azertyfun.dcputoolchain.emulator.GenericKeyboard;
+import tk.azertyfun.dcputoolchain.emulator.LEM1802;
+
+import java.io.BufferedReader;
+import java.io.IOException;
+import java.io.InputStreamReader;
+import java.io.OutputStream;
+import java.net.ServerSocket;
+import java.net.Socket;
+import java.net.SocketException;
+import java.util.LinkedList;
+
+public class ConsoleServer extends Thread {
+
+	private boolean stopped = false;
+	private int port;
+	private StoppableThread readThread, writeThread;
+	private LinkedList<GenericKeyboard> keyboards = new LinkedList<>();
+	private LinkedList<LEM1802> lem1802s = new LinkedList<>();
+
+	public ConsoleServer(int port) {
+		this.port = port;
+	}
+
+	@Override
+	public void run() {
+		try {
+			ServerSocket serverSocket = new ServerSocket(port);
+
+			while(!stopped) {
+				System.out.println("Waiting for connection from console...");
+				Socket clientSocket = serverSocket.accept();
+				System.out.println("Client console connected!");
+				OutputStream out = clientSocket.getOutputStream();
+				BufferedReader in = new BufferedReader(new InputStreamReader(clientSocket.getInputStream()));
+
+				(readThread = new StoppableThread() {
+					public void run() {
+						while(!stopped) {
+							try {
+								if(in.ready()) {
+									for (GenericKeyboard genericKeyboard : keyboards) {
+										int key = in.read();
+
+										switch(key) { // /!\ IMPORTANT NOTICE: It is impossible in console mode to capture insert, delete, arrow keys, shift or control.
+											case 0:
+												break;
+											case 0x8:
+											case 0x7F: //BACKSPACE-DEL (ncurses doesn't seem to differenciate)
+												genericKeyboard.pressedKeyCode(0x10);
+												break;
+											case 0xa: //LF
+												genericKeyboard.pressedKeyCode(0x11);
+												break;
+											default:
+												genericKeyboard.pressedKey((char) key);
+										}
+									}
+								} else {
+									Thread.sleep(10);
+								}
+							} catch (InterruptedException | IOException e) {
+								e.printStackTrace();
+							}
+						}
+					}
+				}).start();
+
+				(writeThread = new StoppableThread() {
+					public void run() {
+						while(!stopped) {
+							try {
+								char[] ram = lem1802s.getFirst().getVideoRam();
+								for (char c : ram) {
+									out.write((byte) ((c & 0xFF00) >> 8));
+									out.write((byte) (c & 0xFF));
+								}
+								Thread.sleep(100);
+							} catch (SocketException e) {
+								readThread.stopped = true;
+								stopped = true;
+							} catch (InterruptedException | IOException e) {
+								e.printStackTrace();
+							}
+						}
+					}
+				}).start();
+			}
+		} catch (IOException e) {
+			e.printStackTrace();
+		}
+	}
+
+	public void setStopped() {
+		stopped = true;
+		readThread.stopped = true;
+		writeThread.stopped = true;
+	}
+
+	public void addLemDisplayConsole(LEM1802 lem1802) {
+		lem1802s.add(lem1802);
+	}
+
+	public void addKeyboard(GenericKeyboard genericKeyboard) {
+		keyboards.add(genericKeyboard);
+	}
+
+	private abstract class StoppableThread extends Thread {
+		public boolean stopped = false;
+	}
+}