add dynamic RSX commands defined by addRsx (needed for speech.rsx example)

Author: benchmarko

CodeGeneratorJs.js

@@ -457,9 +457,9 @@ CodeGeneratorJs.prototype = {
 					sLabel = that.iLine + "s" + that.iStopCount; // we use stopCount
 					that.iStopCount += 1;
 
-					if (!bRsxAvailable) { // if RSX not available, we delay the error until it is executed (or catched by on error goto)
+					if (!bRsxAvailable) { // if RSX not available at compile time, delay error until execution (supports dynamic/temporary RSX)
 						aNodeArgs.unshift('"' + sRsxName + '"'); // put as first arg
-						sRsxName = "rsxExec"; // and call special handler which triggers error if not available
+						sRsxName = "rsxExec"; // and call dispatcher which handles both temporary and permanent RSX
 					}
 
 					node.pv = "o.rsx." + sRsxName + "(" + aNodeArgs.join(", ") + "); o.goto(\"" + sLabel + "\"); break;\ncase \"" + sLabel + "\":"; // most RSX commands need goto (era, ren,...)

Controller.js

@@ -216,6 +216,23 @@ Controller.prototype = {
 		return sKey;
 	},
 
+	addRsx(sKey, oRsxConstructor) {
+		var oExample;
+
+		if (!sKey) { // maybe ""
+			sKey = (document.currentScript && document.currentScript.getAttribute("data-key")) || this.model.getProperty("example");
+			// on IE we can just get the current example
+		}
+
+		oExample = this.model.getExample(sKey);
+		oExample.key = sKey; // maybe changed
+		oExample.rsx = true; // mark that example has RSX
+		oExample.rsxConstructor = oRsxConstructor; // store constructor for later registration
+		oExample.loaded = true;
+		Utils.console.log("addRsx:", sKey);
+		return sKey;
+	},
+
 	setDatabaseSelectOptions: function () {
 		var sSelect = "databaseSelect",
 			aItems = [],
@@ -987,6 +1004,13 @@ Controller.prototype = {
 				if (!bSuppressLog) {
 					Utils.console.log("Example", sUrl, oExample.meta || "", "loaded");
 				}
+				
+				// Reset and register temporary RSX if available
+				that.oVm.rsx.rsxReset();
+				if (oExample.rsxConstructor) {
+					that.oVm.rsx.rsxRegister(oExample.rsxConstructor);
+				}
+				
 				sInput = oExample.script;
 				that.model.setProperty("example", oInFile.sMemorizedExample);
 				that.oVm.vmStop("", 0, true);

CpcVm.js

@@ -353,6 +353,10 @@ CpcVm.prototype = {
 		return this.oVariables.getAllVariables();
 	},
 
+	vmGetVariableByIndex(index) { // also called from JS script
+		return this.oVariables.getVariableByIndex(index);
+	},
+
 	vmSetStartLine: function (iLine) {
 		this.iStartLine = iLine;
 	},
@@ -737,6 +741,10 @@ CpcVm.prototype = {
 		return this.oInFile;
 	},
 
+	vmGetKeyboard: function () {
+		return this.oKeyboard;
+	},
+
 	vmGetOutFileObject: function () {
 		return this.oOutFile;
 	},

CpcVmRsx.js

@@ -18,18 +18,48 @@ function CpcVmRsx(oVm) {
 CpcVmRsx.prototype = {
 	rsxInit: function (oVm) {
 		this.oVm = oVm;
+		this.rsxTemporary = {}; // temporary/dynamic RSX registered at runtime
 	},
 
 	rsxIsAvailable: function (sName) {
-		return sName in this;
+		return (sName in this.rsxTemporary) || (sName in this); // check temporary first, then permanent
+	},
+
+	rsxRegister: function (oRsxConstructor) {
+		// Register temporary RSX from constructor
+		// Constructor should be a function that returns an object with getRsxCommands() method
+		var oRsxModule, oRsxCommands, sCommand;
+
+		oRsxModule = new oRsxConstructor();
+		if (oRsxModule.getRsxCommands) {
+			oRsxCommands = oRsxModule.getRsxCommands();
+			for (sCommand in oRsxCommands) {
+				if (oRsxCommands.hasOwnProperty(sCommand)) {
+					this.rsxTemporary[sCommand] = oRsxCommands[sCommand];
+				}
+			}
+		}
+	},
+
+	rsxReset: function () {
+		// Clear temporary RSX (called when loading new example)
+		this.rsxTemporary = {};
 	},
 
 	rsxExec: function (sName) { // varargs
-		var aArgs;
+		var aArgs, fnRsx;
 
-		if (this.rsxIsAvailable(sName)) {
+		// Check temporary RSX first, then permanent
+		if (sName in this.rsxTemporary) {
+			// Temporary RSX: call with this = CpcVm (the VM instance)
+			fnRsx = this.rsxTemporary[sName];
+			aArgs = Array.prototype.slice.call(arguments, 1);
+			fnRsx.apply(this.oVm, aArgs);
+		} else if (typeof this[sName] === "function") {
+			// Permanent RSX: call with this = CpcVmRsx
+			fnRsx = this[sName];
 			aArgs = Array.prototype.slice.call(arguments, 1);
-			this[sName].apply(this, aArgs);
+			fnRsx.apply(this, aArgs);
 		} else {
 			throw this.oVm.vmComposeError(Error(), 28, "|" + sName); // Unknown command
 		}

Keyboard.js

@@ -502,8 +502,12 @@ Keyboard.prototype = {
 		return sKey;
 	},
 
-	putKeyInBuffer: function (sKey) {
+	putKeyInBuffer: function (sKey, bTriggerOnKeyDown) {
 		this.aKeyBuffer.push(sKey);
+
+		if (bTriggerOnKeyDown && this.fnOnKeyDown) { // trigger handler for async events (e.g., speech synthesis)
+			this.fnOnKeyDown(this.aKeyBuffer);
+		}
 	},
 
 	putKeysInBuffer: function (sInput) {

cpcbasic.js

@@ -60,6 +60,10 @@ cpcBasic = {
 		return cpcBasic.controller.addItem(sKey, input);
 	},
 
+	addRsx(sKey, oRsxConstructor) {
+		return cpcBasic.controller.addRsx(sKey, oRsxConstructor);
+	},
+
 	// https://stackoverflow.com/questions/901115/how-can-i-get-query-string-values-in-javascript
 	fnParseUri: function (oConfig) {
 		var aMatch,

index.html

@@ -4,7 +4,7 @@
 <meta http-equiv="content-type" content="text/html; charset=UTF-8" />
 <meta name="viewport" content="width=device-width, initial-scale=1.0">
 <link rel="stylesheet" href="cpcbasic.css" />
-<title id="title">CPC Basic v0.10.18</title>
+<title id="title">CPC Basic v0.10.19</title>
 </head>
 
 <body id="pageBody">

package.json

@@ -1,6 +1,6 @@
 {
   "name": "cpcbasic",
-  "version": "0.10.18",
+  "version": "0.10.19",
   "description": "# CPCBasic - Run CPC BASIC in a Browser",
   "main": "cpcbasic.js",
   "directories": {

test/testParseExamples.qunit.js

@@ -208,6 +208,20 @@ cpcBasic = {
 		return sKey;
 	},
 
+	addRsx2(sKey, oRsxConstructor) {
+		var oExample;
+
+		if (!sKey) {
+			sKey = this.model.getProperty("example");
+		}
+
+		oExample = this.model.getExample(sKey);
+		oExample.key = sKey; // maybe changed
+		oExample.rsx = new oRsxConstructor();
+		oExample.loaded = true;
+		return sKey;
+	},
+
 	fnHereDoc: function (fn) {
 		return String(fn).
 			replace(/^[^/]+\/\*\S*/, "").
@@ -229,6 +243,10 @@ cpcBasic = {
 			input = this.fnHereDoc(input);
 		}
 		return this.addItem2(sKey, input);
+	},
+
+	addRsx(sKey, oRsxConstructor) {
+		return this.addRsx2(sKey, oRsxConstructor);
 	}
 };