$Rn where n is the register number, starting at 0.Test(.*)$R0 becomes Test\\$R0 would become $R0 rather than Test.";
+ this.inputType = "string";
+ this.outputType = "string";
+ this.args = [
+ {
+ "name": "Extractor",
+ "type": "binaryString",
+ "value": "([\\s\\S]*)"
+ },
+ {
+ "name": "Case insensitive",
+ "type": "boolean",
+ "value": true
+ },
+ {
+ "name": "Multiline matching",
+ "type": "boolean",
+ "value": false
+ }
+ ];
+ }
+
+ /**
+ * Register operation.
+ *
+ * @param {Object} state - The current state of the recipe.
+ * @param {number} state.progress - The current position in the recipe.
+ * @param {Dish} state.dish - The Dish being operated on.
+ * @param {Operation[]} state.opList - The list of operations in the recipe.
+ * @returns {Object} The updated state of the recipe.
+ */
+ async run(state) {
+ const ings = state.opList[state.progress].ingValues;
+ const extractorStr = ings[0];
+ const i = ings[1];
+ const m = ings[2];
+
+ let modifiers = "";
+ if (i) modifiers += "i";
+ if (m) modifiers += "m";
+
+ const extractor = new RegExp(extractorStr, modifiers),
+ input = await state.dish.get(Dish.STRING),
+ registers = input.match(extractor);
+
+ if (!registers) return state;
+
+ if (ENVIRONMENT_IS_WORKER()) {
+ self.setRegisters(state.forkOffset + state.progress, state.numRegisters, registers.slice(1));
+ }
+
+ /**
+ * Replaces references to registers (e.g. $R0) with the contents of those registers.
+ *
+ * @param {string} str
+ * @returns {string}
+ */
+ function replaceRegister(str) {
+ // Replace references to registers ($Rn) with contents of registers
+ return str.replace(/(\\*)\$R(\d{1,2})/g, (match, slashes, regNum) => {
+ const index = parseInt(regNum, 10) + 1;
+ if (index <= state.numRegisters || index >= state.numRegisters + registers.length)
+ return match;
+ if (slashes.length % 2 !== 0) return match.slice(1); // Remove escape
+ return slashes + registers[index - state.numRegisters];
+ });
+ }
+
+ // Step through all subsequent ops and replace registers in args with extracted content
+ for (let i = state.progress + 1; i < state.opList.length; i++) {
+ if (state.opList[i].disabled) continue;
+
+ let args = state.opList[i].ingValues;
+ args = args.map(arg => {
+ if (typeof arg !== "string" && typeof arg !== "object") return arg;
+
+ if (typeof arg === "object" && arg.hasOwnProperty("string")) {
+ arg.string = replaceRegister(arg.string);
+ return arg;
+ }
+ return replaceRegister(arg);
+ });
+ state.opList[i].ingValues = args;
+ }
+
+ state.numRegisters += registers.length - 1;
+ return state;
+ }
+
+}
+
+export default Register;
diff --git a/src/core/operations/Return.mjs b/src/core/operations/Return.mjs
new file mode 100644
index 00000000..e758a03c
--- /dev/null
+++ b/src/core/operations/Return.mjs
@@ -0,0 +1,45 @@
+/**
+ * @author n1474335 [n1474335@gmail.com]
+ * @copyright Crown Copyright 2018
+ * @license Apache-2.0
+ */
+
+import Operation from "../Operation";
+
+/**
+ * Return operation
+ */
+class Return extends Operation {
+
+ /**
+ * Return constructor
+ */
+ constructor() {
+ super();
+
+ this.name = "Return";
+ this.flowControl = true;
+ this.module = "Default";
+ this.description = "End execution of operations at this point in the recipe.";
+ this.inputType = "string";
+ this.outputType = "string";
+ this.args = [];
+ }
+
+ /**
+ * Return operation.
+ *
+ * @param {Object} state - The current state of the recipe.
+ * @param {number} state.progress - The current position in the recipe.
+ * @param {Dish} state.dish - The Dish being operated on.
+ * @param {Operation[]} state.opList - The list of operations in the recipe.
+ * @returns {Object} The updated state of the recipe.
+ */
+ run(state) {
+ state.progress = state.opList.length;
+ return state;
+ }
+
+}
+
+export default Return;
diff --git a/src/core/operations/legacy/FlowControl.js b/src/core/operations/legacy/FlowControl.js
deleted file mode 100755
index 16a990e1..00000000
--- a/src/core/operations/legacy/FlowControl.js
+++ /dev/null
@@ -1,386 +0,0 @@
-import Recipe from "./Recipe.js";
-import Dish from "./Dish.js";
-import Magic from "./lib/Magic.js";
-import Utils from "./Utils.js";
-
-
-/**
- * Flow Control operations.
- *
- * @author n1474335 [n1474335@gmail.com]
- * @copyright Crown Copyright 2016
- * @license Apache-2.0
- *
- * @namespace
- */
-const FlowControl = {
-
- /**
- * Fork operation.
- *
- * @param {Object} state - The current state of the recipe.
- * @param {number} state.progress - The current position in the recipe.
- * @param {Dish} state.dish - The Dish being operated on.
- * @param {Operation[]} state.opList - The list of operations in the recipe.
- * @returns {Object} The updated state of the recipe.
- */
- runFork: async function(state) {
- const opList = state.opList,
- inputType = opList[state.progress].inputType,
- outputType = opList[state.progress].outputType,
- input = await state.dish.get(inputType),
- ings = opList[state.progress].ingValues,
- splitDelim = ings[0],
- mergeDelim = ings[1],
- ignoreErrors = ings[2],
- subOpList = [];
- let inputs = [],
- i;
-
- if (input)
- inputs = input.split(splitDelim);
-
- // Create subOpList for each tranche to operate on
- // (all remaining operations unless we encounter a Merge)
- for (i = state.progress + 1; i < opList.length; i++) {
- if (opList[i].name === "Merge" && !opList[i].disabled) {
- break;
- } else {
- subOpList.push(opList[i]);
- }
- }
-
- const recipe = new Recipe();
- let output = "",
- progress = 0;
-
- state.forkOffset += state.progress + 1;
-
- recipe.addOperations(subOpList);
-
- // Take a deep(ish) copy of the ingredient values
- const ingValues = subOpList.map(op => JSON.parse(JSON.stringify(op.ingValues)));
-
- // Run recipe over each tranche
- for (i = 0; i < inputs.length; i++) {
- log.debug(`Entering tranche ${i + 1} of ${inputs.length}`);
-
- // Baseline ing values for each tranche so that registers are reset
- subOpList.forEach((op, i) => {
- op.ingValues = JSON.parse(JSON.stringify(ingValues[i]));
- });
-
- const dish = new Dish();
- dish.set(inputs[i], inputType);
-
- try {
- progress = await recipe.execute(dish, 0, state);
- } catch (err) {
- if (!ignoreErrors) {
- throw err;
- }
- progress = err.progress + 1;
- }
- output += await dish.get(outputType) + mergeDelim;
- }
-
- state.dish.set(output, outputType);
- state.progress += progress;
- return state;
- },
-
-
- /**
- * Merge operation.
- *
- * @param {Object} state - The current state of the recipe.
- * @param {number} state.progress - The current position in the recipe.
- * @param {Dish} state.dish - The Dish being operated on.
- * @param {Operation[]} state.opList - The list of operations in the recipe.
- * @returns {Object} The updated state of the recipe.
- */
- runMerge: function(state) {
- // No need to actually do anything here. The fork operation will
- // merge when it sees this operation.
- return state;
- },
-
-
- /**
- * Register operation.
- *
- * @param {Object} state - The current state of the recipe.
- * @param {number} state.progress - The current position in the recipe.
- * @param {Dish} state.dish - The Dish being operated on.
- * @param {Operation[]} state.opList - The list of operations in the recipe.
- * @returns {Object} The updated state of the recipe.
- */
- runRegister: async function(state) {
- const ings = state.opList[state.progress].ingValues,
- extractorStr = ings[0],
- i = ings[1],
- m = ings[2];
-
- let modifiers = "";
- if (i) modifiers += "i";
- if (m) modifiers += "m";
-
- const extractor = new RegExp(extractorStr, modifiers),
- input = await state.dish.get(Dish.STRING),
- registers = input.match(extractor);
-
- if (!registers) return state;
-
- if (ENVIRONMENT_IS_WORKER()) {
- self.setRegisters(state.forkOffset + state.progress, state.numRegisters, registers.slice(1));
- }
-
- /**
- * Replaces references to registers (e.g. $R0) with the contents of those registers.
- *
- * @param {string} str
- * @returns {string}
- */
- function replaceRegister(str) {
- // Replace references to registers ($Rn) with contents of registers
- return str.replace(/(\\*)\$R(\d{1,2})/g, (match, slashes, regNum) => {
- const index = parseInt(regNum, 10) + 1;
- if (index <= state.numRegisters || index >= state.numRegisters + registers.length)
- return match;
- if (slashes.length % 2 !== 0) return match.slice(1); // Remove escape
- return slashes + registers[index - state.numRegisters];
- });
- }
-
- // Step through all subsequent ops and replace registers in args with extracted content
- for (let i = state.progress + 1; i < state.opList.length; i++) {
- if (state.opList[i].disabled) continue;
-
- let args = state.opList[i].ingValues;
- args = args.map(arg => {
- if (typeof arg !== "string" && typeof arg !== "object") return arg;
-
- if (typeof arg === "object" && arg.hasOwnProperty("string")) {
- arg.string = replaceRegister(arg.string);
- return arg;
- }
- return replaceRegister(arg);
- });
- state.opList[i].setIngValues(args);
- }
-
- state.numRegisters += registers.length - 1;
- return state;
- },
-
-
- /**
- * Jump operation.
- *
- * @param {Object} state - The current state of the recipe.
- * @param {number} state.progress - The current position in the recipe.
- * @param {Dish} state.dish - The Dish being operated on.
- * @param {Operation[]} state.opList - The list of operations in the recipe.
- * @param {number} state.numJumps - The number of jumps taken so far.
- * @returns {Object} The updated state of the recipe.
- */
- runJump: function(state) {
- const ings = state.opList[state.progress].ingValues,
- label = ings[0],
- maxJumps = ings[1],
- jmpIndex = FlowControl._getLabelIndex(label, state);
-
- if (state.numJumps >= maxJumps || jmpIndex === -1) {
- log.debug("Maximum jumps reached or label cannot be found");
- return state;
- }
-
- state.progress = jmpIndex;
- state.numJumps++;
- log.debug(`Jumping to label '${label}' at position ${jmpIndex} (jumps = ${state.numJumps})`);
- return state;
- },
-
-
- /**
- * Conditional Jump operation.
- *
- * @param {Object} state - The current state of the recipe.
- * @param {number} state.progress - The current position in the recipe.
- * @param {Dish} state.dish - The Dish being operated on.
- * @param {Operation[]} state.opList - The list of operations in the recipe.
- * @param {number} state.numJumps - The number of jumps taken so far.
- * @returns {Object} The updated state of the recipe.
- */
- runCondJump: async function(state) {
- const ings = state.opList[state.progress].ingValues,
- dish = state.dish,
- regexStr = ings[0],
- invert = ings[1],
- label = ings[2],
- maxJumps = ings[3],
- jmpIndex = FlowControl._getLabelIndex(label, state);
-
- if (state.numJumps >= maxJumps || jmpIndex === -1) {
- log.debug("Maximum jumps reached or label cannot be found");
- return state;
- }
-
- if (regexStr !== "") {
- const strMatch = await dish.get(Dish.STRING).search(regexStr) > -1;
- if (!invert && strMatch || invert && !strMatch) {
- state.progress = jmpIndex;
- state.numJumps++;
- log.debug(`Jumping to label '${label}' at position ${jmpIndex} (jumps = ${state.numJumps})`);
- }
- }
-
- return state;
- },
-
-
- /**
- * Return operation.
- *
- * @param {Object} state - The current state of the recipe.
- * @param {number} state.progress - The current position in the recipe.
- * @param {Dish} state.dish - The Dish being operated on.
- * @param {Operation[]} state.opList - The list of operations in the recipe.
- * @returns {Object} The updated state of the recipe.
- */
- runReturn: function(state) {
- state.progress = state.opList.length;
- return state;
- },
-
-
- /**
- * Comment operation.
- *
- * @param {Object} state - The current state of the recipe.
- * @param {number} state.progress - The current position in the recipe.
- * @param {Dish} state.dish - The Dish being operated on.
- * @param {Operation[]} state.opList - The list of operations in the recipe.
- * @returns {Object} The updated state of the recipe.
- */
- runComment: function(state) {
- return state;
- },
-
-
- /**
- * Magic operation.
- *
- * @param {Object} state - The current state of the recipe.
- * @param {number} state.progress - The current position in the recipe.
- * @param {Dish} state.dish - The Dish being operated on.
- * @param {Operation[]} state.opList - The list of operations in the recipe.
- * @returns {Object} The updated state of the recipe.
- */
- runMagic: async function(state) {
- const ings = state.opList[state.progress].ingValues,
- depth = ings[0],
- intensive = ings[1],
- extLang = ings[2],
- dish = state.dish,
- currentRecipeConfig = state.opList.map(op => op.getConfig()),
- magic = new Magic(dish.get(Dish.ARRAY_BUFFER)),
- options = await magic.speculativeExecution(depth, extLang, intensive);
-
- let output = `| Recipe (click to load) | -Result snippet | -Properties | -
|---|---|---|
| ${Utils.generatePrettyRecipe(option.recipe, true)} | -${Utils.escapeHtml(Utils.printable(Utils.truncate(option.data, 99)))} | -${language}${fileType}${matchingOps}${useful}${validUTF8}${entropy} | -