Tidied up Colossus operation

src/core/lib/Colossus.mjs

@@ -1,7 +1,7 @@
 /**
  * Colossus - an emulation of the world's first electronic computer
  *
- * @author VirtualColossus
+ * @author VirtualColossus [martin@virtualcolossus.co.uk]
  * @copyright Crown Copyright 2019
  * @license Apache-2.0
  */
@@ -22,7 +22,6 @@ export class ColossusComputer {
      * @param {Object} starts - rotor start positions
      */
     constructor(ciphertext, pattern, qbusin, qbusswitches, control, starts, settotal, limit) {
-
         this.ITAlookup = ITA2_TABLE;
         this.ReverseITAlookup = {};
         for (const letter in this.ITAlookup) {
@@ -61,15 +60,14 @@ export class ColossusComputer {
 
         this.totalmotor = 0;
         this.P5Zbit = [0, 0];
-
     }
 
     /**
      * Begin a run
-     * @returns {object} -
+     *
+     * @returns {object}
      */
     run() {
-
         const result = {
             printout: ""
         };
@@ -86,7 +84,6 @@ export class ColossusComputer {
         result.printout += fast + " " + slow + "\n";
 
         do {
-
             this.allCounters = [0, 0, 0, 0, 0];
             this.ZbitsOneBack = [0, 0, 0, 0, 0];
             this.XbitsOneBack = [0, 0, 0, 0, 0];
@@ -97,8 +94,8 @@ export class ColossusComputer {
             // Only print result if larger than set total
             let fastRef = "00";
             let slowRef = "00";
-            if (fast !== "") fastRef = this.leftPad(this.rotorPtrs[fast], 2);
-            if (slow !== "") slowRef = this.leftPad(this.rotorPtrs[slow], 2);
+            if (fast !== "") fastRef = this.rotorPtrs[fast].toString().padStart(2, "0");
+            if (slow !== "") slowRef = this.rotorPtrs[slow].toString().padStart(2, "0");
             let printline = "";
             for (let c=0;c<5;c++) {
                 if (this.allCounters[c] > this.settotal) {
@@ -124,7 +121,6 @@ export class ColossusComputer {
             }
 
             runcount++;
-
         } while (JSON.stringify(this.rotorPtrs) !== JSON.stringify(this.starts));
 
         result.counters = this.allCounters;
@@ -137,7 +133,6 @@ export class ColossusComputer {
      * Run tape loop
      */
     runTape() {
-
         let charZin = "";
 
         this.Xptr = [this.rotorPtrs.X1, this.rotorPtrs.X2, this.rotorPtrs.X3, this.rotorPtrs.X4, this.rotorPtrs.X5];
@@ -171,7 +166,6 @@ export class ColossusComputer {
             this.stepThyratrons();
 
         }
-
     }
 
     /**
@@ -246,7 +240,6 @@ export class ColossusComputer {
         // Always move M61 rotor
         this.Mptr[1]++;
         if (this.Mptr[1] > ROTOR_SIZES.M61) this.Mptr[1]=1;
-
     }
 
     /**
@@ -342,7 +335,6 @@ export class ColossusComputer {
         }
 
         return cnt;
-
     }
 
     /**
@@ -381,7 +373,6 @@ export class ColossusComputer {
             }
 
         }
-
     }
 
     /**
@@ -411,17 +402,6 @@ export class ColossusComputer {
         };
     }
 
-    /**
-     * Left Pad number
-     */
-    leftPad(number, targetLength) {
-        let output = number + "";
-        while (output.length < targetLength) {
-            output = "0" + output;
-        }
-        return output;
-    }
-
     /**
      * Read argument bus switches X & . and convert to 1 & 0
      */

src/core/lib/Lorenz.mjs

@@ -1,7 +1,7 @@
 /**
  * Resources required by the Lorenz SZ40/42 and Colossus
  *
- * @author VirtualColossus
+ * @author VirtualColossus [martin@virtualcolossus.co.uk]
  * @copyright Crown Copyright 2019
  * @license Apache-2.0
  */

src/core/operations/Colossus.mjs

@@ -23,7 +23,7 @@ class Colossus extends Operation {
         super();
         this.name = "Colossus";
         this.module = "Bletchley";
-        this.description = "Colossus is the name of the world's first electronic computer. Ten computers were designed by Tommy Flowers and built at the Post Office Research Labs at Dollis Hill in 1943 during World War 2. They assisted with the breaking of the German Lorenz cipher attachment, a machine created to encipher communications between Hitler and his generals on the front lines.<br><br>To learn more, Virtual Colossus, an online, browser based simulation of a Colossus computer is available at <a href='https://virtualcolossus.co.uk' target='_blank'>https://virtualcolossus.co.uk</a>.<br><br>A more detailed description of this operation can be found <a href='https://github.com/VirtualColossus/CyberChef/wiki/Colossus' target='_blank'>here</a>.";
+        this.description = "Colossus is the name of the world's first electronic computer. Ten Colossi were designed by Tommy Flowers and built at the Post Office Research Labs at Dollis Hill in 1943 during World War 2. They assisted with the breaking of the German Lorenz cipher attachment, a machine created to encipher communications between Hitler and his generals on the front lines.<br><br>To learn more, Virtual Colossus, an online, browser based simulation of a Colossus computer is available at <a href='https://virtualcolossus.co.uk' target='_blank'>virtualcolossus.co.uk</a>.<br><br>A more detailed description of this operation can be found <a href='https://github.com/gchq/CyberChef/wiki/Colossus' target='_blank'>here</a>.";
         this.infoURL = "https://wikipedia.org/wiki/Colossus_computer";
         this.inputType = "string";
         this.outputType = "JSON";
@@ -61,7 +61,7 @@ class Colossus extends Operation {
             {
                 name: "K Rack Option",
                 type: "argSelector",
-                "value": [
+                value: [
                     {
                         name: "Select Program",
                         on: [7],
@@ -346,14 +346,13 @@ class Colossus extends Operation {
      * @returns {Object}
      */
     run(input, args) {
-
         input = input.toUpperCase();
         for (const character of input) {
             if (VALID_ITA2.indexOf(character) === -1) {
                 let errltr = character;
-                if (errltr==="\n") errltr = "Carriage Return";
-                if (errltr===" ") errltr = "Space";
-                throw new OperationError("Invalid ITA2 character : "+errltr);
+                if (errltr === "\n") errltr = "Carriage Return";
+                if (errltr === " ") errltr = "Space";
+                throw new OperationError("Invalid ITA2 character : " + errltr);
             }
         }
 
@@ -383,7 +382,8 @@ class Colossus extends Operation {
         const re = new RegExp("^$|^[.x]$");
         for (let qr=0;qr<3;qr++) {
             for (let a=0;a<5;a++) {
-                if (!re.test(args[((qr*7)+(a+9))])) throw new OperationError("Switch R"+(qr+1)+"-Q"+(a+1)+" can only be set to blank, . or x");
+                if (!re.test(args[((qr*7)+(a+9))]))
+                    throw new OperationError("Switch R"+(qr+1)+"-Q"+(a+1)+" can only be set to blank, . or x");
             }
         }
 
@@ -406,7 +406,8 @@ class Colossus extends Operation {
         };
 
         const settotal = parseInt(args[42], 10);
-        if (settotal < 0 || settotal > 9999) throw new OperationError("Set Total must be between 0000 and 9999");
+        if (settotal < 0 || settotal > 9999)
+            throw new OperationError("Set Total must be between 0000 and 9999");
 
         // null|fast|slow for each of S1-5,M1-2,X1-5
         const control = {
@@ -415,7 +416,6 @@ class Colossus extends Operation {
         };
 
         // Start positions
-
         if (args[52]<1 || args[52]>43) throw new OperationError("Ψ1 start must be between 1 and 43");
         if (args[53]<1 || args[53]>47) throw new OperationError("Ψ2 start must be between 1 and 47");
         if (args[54]<1 || args[54]>51) throw new OperationError("Ψ3 start must be between 1 and 51");
@@ -439,11 +439,14 @@ class Colossus extends Operation {
         const result = colossus.run();
 
         return result;
-
     }
 
     /**
      * Select Program
+     *
+     * @param {string} progname
+     * @param {Object[]} args
+     * @returns {Object[]}
      */
     selectProgram(progname, args) {
 

src/core/operations/Lorenz.mjs

@@ -22,7 +22,7 @@ class Lorenz extends Operation {
 
         this.name = "Lorenz";
         this.module = "Bletchley";
-        this.description = "The Lorenz SZ40/42 cipher attachment was a WW2 German rotor cipher machine with twelve rotors which attached in-line between remote teleprinters.<br><br>It used the Vernam cipher with two groups of five rotors (named the psi(ψ) wheels and chi(χ) wheels at Bletchley Park) to create two pseudorandom streams of five bits, encoded in ITA2, which were XOR added to the plaintext. Two other rotors, dubbed the mu(μ) or motor wheels, could hold up the stepping of the psi wheels meaning they stepped intermittently.<br><br>Each rotor has a different number of cams/lugs around their circumference which could be set active or inactive changing the key stream.<br><br>Three models of the Lorenz are emulated, SZ40, SZ42a and SZ42b and three example wheel patterns (the lug settings) are included (KH, ZMUG & BREAM) with the option to set a custom set using the letter 'x' for active or '.' for an inactive lug.<br><br>The input can either be plaintext or ITA2 when sending and ITA2 when receiving.<br><br>To learn more, Virtual Lorenz, an online, browser based simulation of the Lorenz SZ40/42 is available at <a href='https://lorenz.virtualcolossus.co.uk' target='_blank'>https://lorenz.virtualcolossus.co.uk</a>.<br><br>A more detailed description of this operation can be found <a href='https://github.com/gchq/CyberChef/wiki/Lorenz-SZ' target='_blank'>here</a>.";
+        this.description = "The Lorenz SZ40/42 cipher attachment was a WW2 German rotor cipher machine with twelve rotors which attached in-line between remote teleprinters.<br><br>It used the Vernam cipher with two groups of five rotors (named the psi(ψ) wheels and chi(χ) wheels at Bletchley Park) to create two pseudorandom streams of five bits, encoded in ITA2, which were XOR added to the plaintext. Two other rotors, dubbed the mu(μ) or motor wheels, could hold up the stepping of the psi wheels meaning they stepped intermittently.<br><br>Each rotor has a different number of cams/lugs around their circumference which could be set active or inactive changing the key stream.<br><br>Three models of the Lorenz are emulated, SZ40, SZ42a and SZ42b and three example wheel patterns (the lug settings) are included (KH, ZMUG & BREAM) with the option to set a custom set using the letter 'x' for active or '.' for an inactive lug.<br><br>The input can either be plaintext or ITA2 when sending and ITA2 when receiving.<br><br>To learn more, Virtual Lorenz, an online, browser based simulation of the Lorenz SZ40/42 is available at <a href='https://lorenz.virtualcolossus.co.uk' target='_blank'>lorenz.virtualcolossus.co.uk</a>.<br><br>A more detailed description of this operation can be found <a href='https://github.com/gchq/CyberChef/wiki/Lorenz-SZ' target='_blank'>here</a>.";
         this.infoURL = "https://wikipedia.org/wiki/Lorenz_cipher";
         this.inputType = "string";
         this.outputType = "string";