All files / src vdu-capture.js

92.59% Statements 50/54
96% Branches 24/25
100% Functions 8/8
92.15% Lines 47/51

Press n or j to go to the next uncovered block, b, p or k for the previous block.

1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114              1x                           8x 8x 8x 8x 8x 8x 8x 8x   2x 1x     1x     1x 1x           20x 11x 11x   20x       66x 66x 18x 18x 8x 8x 8x   18x   48x   8x 8x 8x             2x 2x 2x       38x 66x 8x 8x 8x 8x   30x 1x         1x                           1x 1x 1x 1x 1x      
/**
 * Turns the bytes a program sends to the VDU into text elements,
 * `{ x, y, text, foreground, background, mode }`, following the cursor and
 * colour codes and swallowing the parameters of the rest. Text-mode output
 * only; anything visual wants a screenshot.
 */
// How many parameter bytes follow each BBC VDU code that takes any.
const SequenceParamCounts = {
    1: 1, // next character to the printer only
    17: 1, // COLOUR n
    18: 2, // GCOL
    19: 5, // define logical colour
    22: 1, // MODE n
    25: 5, // PLOT
    28: 4, // define text window
    29: 4, // define graphics origin
    31: 2, // TAB(x,y)
};
 
export class VduTextCapture {
    constructor(onElement, { isAtom = false } = {}) {
        this.onElement = onElement;
        this.isAtom = isAtom;
        this.attributes = { x: 0, y: 0, text: "", foreground: 7, background: 0, mode: 7 };
        this.currentText = "";
        this.params = [];
        this.nextN = 0;
        this.vduProc = null;
        this.sequenceHandlers = {
            17: (p) => {
                if (p[0] & 0x80) this.attributes.background = p[0] & 0xf;
                else this.attributes.foreground = p[0] & 0xf;
            },
            22: (p) => {
                Object.assign(this.attributes, { mode: p[0], x: 0, y: 0, foreground: 7, background: 0 });
            },
            31: (p) => {
                this.attributes.x = p[0];
                this.attributes.y = p[1];
            },
        };
    }
 
    flush() {
        if (this.currentText.length) {
            this.onElement({ ...this.attributes, text: this.currentText });
            this.attributes.x += this.currentText.length;
        }
        this.currentText = "";
    }
 
    onChar(c) {
        const attributes = this.attributes;
        if (this.nextN) {
            this.params.push(c);
            if (--this.nextN === 0) {
                if (this.vduProc) this.vduProc(this.params);
                this.params = [];
                this.vduProc = null;
            }
            return;
        }
        switch (c) {
            case 10:
                this.flush();
                attributes.y++;
                return;
            case 12:
                this.flush();
                attributes.x = 0;
                attributes.y = 0;
                return;
            case 13:
                this.flush();
                attributes.x = 0;
                return;
        }
        // The Atom has no multi-byte VDU sequences; treating its bytes as
        // parameters would swallow printable characters.
        const paramCount = this.isAtom ? undefined : SequenceParamCounts[c];
        if (paramCount !== undefined) {
            this.flush();
            this.nextN = paramCount;
            this.vduProc = this.sequenceHandlers[c] ?? null;
            return;
        }
        if (c >= 32 && c < 0x7f) this.currentText += String.fromCharCode(c);
        else this.flush();
    }
 
    /** The decoder's position in the byte stream, for a machine snapshot to carry. */
    snapshot() {
        return {
            attributes: { ...this.attributes },
            currentText: this.currentText,
            params: [...this.params],
            nextN: this.nextN,
        };
    }
 
    /**
     * Puts back a snapshot(). The handler for a half-read sequence is a
     * closure and does not survive, so such a sequence is dropped rather
     * than printed as text.
     */
    restore(state) {
        Object.assign(this.attributes, state.attributes);
        this.currentText = state.currentText;
        this.params = [...state.params];
        this.nextN = state.nextN;
        this.vduProc = null;
    }
}