CheerpX.Linux#setCustomConsole

Configure custom console behavior for handling keyboard input and output display 

namespace CheerpX {
  class Linux {
    setCustomConsole(
      writeFunc: (buf: Buffer) => void,
      cols: number,
      rows: number,
    ): (keyCode: number) => void;
  }
}

Parameters

  • writeFunc ((buf: Buffer) => void) - Function to handle the output sent to the console.
  • cols (number) - Number of columns for the console.
  • rows (number) - Number of rows for the console.

Returns

setCustomConsole returns a function that should be called to simulate user typing in the console.

Examples

Read and write strings

const decoder = new TextDecoder("utf-8");


const send = cx.setCustomConsole(
  (buf) => {
    const string = decoder.decode(buf);
    console.log(string);
  },
  40,
  60,
);


// Send a string
const str = "Hello, world!\n";
for (let i = 0; i < str.length; i++) {
  send(str.charCodeAt(i));
}

Use with Xterm.js

const term = new Terminal({ convertEol: true });
term.open(document.getElementById("terminal"));


const send = cx.setCustomConsole(
  (buf) => {
    term.write(new Uint8Array(buf));
  },
  term.cols,
  term.rows,
);
term.onData((str) => {
  for (let i = 0; i < str.length; i++) {
    send(str.charCodeAt(i));
  }
});

This is what WebVM uses for its interactive terminal.

See also

Was this page helpful?
Suggest changes
CheerpX.Linux#setConsole CheerpX.Linux#setActivateConsole