/* global Blob,URL,requestAnimationFrame */ import React from 'react'; import {Terminal} from 'xterm'; import * as fit from 'xterm/lib/addons/fit/fit'; import * as webLinks from 'xterm/lib/addons/webLinks/webLinks'; import * as winptyCompat from 'xterm/lib/addons/winptyCompat/winptyCompat'; import {clipboard} from 'electron'; import * as Color from 'color'; import terms from '../terms'; import processClipboard from '../utils/paste'; Terminal.applyAddon(fit); Terminal.applyAddon(webLinks); Terminal.applyAddon(winptyCompat); // map old hterm constants to xterm.js const CURSOR_STYLES = { BEAM: 'bar', UNDERLINE: 'underline', BLOCK: 'block' }; const getTermOptions = props => { // Set a background color only if it is opaque const needTransparency = Color(props.backgroundColor).alpha() < 1; const backgroundColor = needTransparency ? 'transparent' : props.backgroundColor; return { macOptionIsMeta: props.modifierKeys.altIsMeta, scrollback: props.scrollback, cursorStyle: CURSOR_STYLES[props.cursorShape], cursorBlink: props.cursorBlink, fontFamily: props.fontFamily, fontSize: props.fontSize, fontWeight: props.fontWeight, fontWeightBold: props.fontWeightBold, lineHeight: props.lineHeight, letterSpacing: props.letterSpacing, allowTransparency: needTransparency, macOptionClickForcesSelection: props.macOptionSelectionMode === 'force', // HACK: Terminal.setOption breaks if we don't apply these in this order // TODO: The above notice can be removed once this is addressed: // https://github.com/xtermjs/xterm.js/pull/1790#issuecomment-450000121 rendererType: props.webGLRenderer ? 'webgl' : 'canvas', experimentalCharAtlas: props.webGLRenderer ? 'webgl' : 'dynamic', theme: { foreground: props.foregroundColor, background: backgroundColor, cursor: props.cursorColor, cursorAccent: props.cursorAccentColor, // TODO: This hard codes the selection color to opaque white because the // webgl renderer doesn't support anything else at the moment. Remove this // once WebGL gets support for selection color. Discussed here: // https://github.com/xtermjs/xterm.js/pull/1790 selection: props.webGLRenderer ? '#fff' : props.selectionColor, black: props.colors.black, red: props.colors.red, green: props.colors.green, yellow: props.colors.yellow, blue: props.colors.blue, magenta: props.colors.magenta, cyan: props.colors.cyan, white: props.colors.white, brightBlack: props.colors.lightBlack, brightRed: props.colors.lightRed, brightGreen: props.colors.lightGreen, brightYellow: props.colors.lightYellow, brightBlue: props.colors.lightBlue, brightMagenta: props.colors.lightMagenta, brightCyan: props.colors.lightCyan, brightWhite: props.colors.lightWhite } }; }; export default class Term extends React.PureComponent { constructor(props) { super(props); props.ref_(props.uid, this); this.termRef = null; this.termWrapperRef = null; this.termRect = null; this.onOpen = this.onOpen.bind(this); this.onWindowResize = this.onWindowResize.bind(this); this.onWindowPaste = this.onWindowPaste.bind(this); this.onTermRef = this.onTermRef.bind(this); this.onTermWrapperRef = this.onTermWrapperRef.bind(this); this.onMouseUp = this.onMouseUp.bind(this); this.termOptions = {}; this.disposableListeners = []; } componentDidMount() { const {props} = this; this.termOptions = getTermOptions(props); this.term = props.term || new Terminal(this.termOptions); this.term.attachCustomKeyEventHandler(this.keyboardHandler); this.term.open(this.termRef); this.term.webLinksInit(); this.term.winptyCompatInit(); if (props.term) { //We need to set options again after reattaching an existing term Object.keys(this.termOptions).forEach(option => this.term.setOption(option, this.termOptions[option])); } if (this.props.isTermActive) { this.term.focus(); } this.onOpen(this.termOptions); if (props.onTitle) { this.disposableListeners.push(this.term.addDisposableListener('title', props.onTitle)); } if (props.onActive) { this.disposableListeners.push(this.term.addDisposableListener('focus', props.onActive)); } if (props.onData) { this.disposableListeners.push(this.term.addDisposableListener('data', props.onData)); } if (props.onResize) { this.disposableListeners.push( this.term.addDisposableListener('resize', ({cols, rows}) => { props.onResize(cols, rows); }) ); } if (props.onCursorMove) { this.disposableListeners.push( this.term.addDisposableListener('cursormove', () => { const cursorFrame = { x: this.term._core.buffer.x * this.term._core.renderer.dimensions.actualCellWidth, y: this.term._core.buffer.y * this.term._core.renderer.dimensions.actualCellHeight, width: this.term._core.renderer.dimensions.actualCellWidth, height: this.term._core.renderer.dimensions.actualCellHeight, col: this.term._core.buffer.y, row: this.term._core.buffer.x }; props.onCursorMove(cursorFrame); }) ); } window.addEventListener('resize', this.onWindowResize, { passive: true }); window.addEventListener('paste', this.onWindowPaste, { capture: true }); terms[this.props.uid] = this; } onOpen() { // we need to delay one frame so that styles // get applied and we can make an accurate measurement // of the container width and height requestAnimationFrame(() => { this.fitResize(); }); } getTermDocument() { // eslint-disable-next-line no-console console.warn( 'The underlying terminal engine of Hyper no longer ' + 'uses iframes with individual `document` objects for each ' + 'terminal instance. This method call is retained for ' + "backwards compatibility reasons. It's ok to attach directly" + 'to the `document` object of the main `window`.' ); return document; } onWindowResize() { this.fitResize(); } // intercepting paste event for any necessary processing of // clipboard data, if result is falsy, paste event continues onWindowPaste(e) { if (!this.props.isTermActive) return; const processed = processClipboard(); if (processed) { e.preventDefault(); e.stopPropagation(); this.term._core.handler(processed); } } onMouseUp(e) { if (this.props.quickEdit && e.button === 2) { if (this.term.hasSelection()) { clipboard.writeText(this.term.getSelection()); this.term.clearSelection(); } else { document.execCommand('paste'); } } else if (this.props.copyOnSelect && this.term.hasSelection()) { clipboard.writeText(this.term.getSelection()); } } write(data) { this.term.write(data); } focus() { this.term.focus(); } clear() { this.term.clear(); } reset() { this.term.reset(); } resize(cols, rows) { this.term.resize(cols, rows); } selectAll() { this.term.selectAll(); } fitResize() { if (!this.termWrapperRef) { return; } this.term.fit(); } keyboardHandler(e) { // Has Mousetrap flagged this event as a command? return !e.catched; } componentWillReceiveProps(nextProps) { if (!this.props.cleared && nextProps.cleared) { this.clear(); } const nextTermOptions = getTermOptions(nextProps); // Update only options that have changed. Object.keys(nextTermOptions) .filter(option => option !== 'theme' && nextTermOptions[option] !== this.termOptions[option]) .forEach(option => { try { this.term.setOption(option, nextTermOptions[option]); } catch (e) { if (/The webgl renderer only works with the webgl char atlas/i.test(e.message)) { // Ignore this because the char atlas will also be changed } else { throw e; } } }); // Do we need to update theme? const shouldUpdateTheme = !this.termOptions.theme || nextTermOptions.rendererType !== this.termOptions.rendererType || Object.keys(nextTermOptions.theme).some( option => nextTermOptions.theme[option] !== this.termOptions.theme[option] ); if (shouldUpdateTheme) { this.term.setOption('theme', nextTermOptions.theme); } this.termOptions = nextTermOptions; if (!this.props.isTermActive && nextProps.isTermActive) { requestAnimationFrame(() => { this.fitResize(); }); } if ( this.props.fontSize !== nextProps.fontSize || this.props.fontFamily !== nextProps.fontFamily || this.props.lineHeight !== nextProps.lineHeight || this.props.letterSpacing !== nextProps.letterSpacing ) { // resize to fit the container this.fitResize(); } if (nextProps.rows !== this.props.rows || nextProps.cols !== this.props.cols) { this.resize(nextProps.cols, nextProps.rows); } } onTermWrapperRef(component) { this.termWrapperRef = component; } onTermRef(component) { this.termRef = component; } componentWillUnmount() { terms[this.props.uid] = null; this.props.ref_(this.props.uid, null); // to clean up the terminal, we remove the listeners // instead of invoking `destroy`, since it will make the // term insta un-attachable in the future (which we need // to do in case of splitting, see `componentDidMount` this.disposableListeners.forEach(handler => handler.dispose()); this.disposableListeners = []; window.removeEventListener('resize', this.onWindowResize, { passive: true }); window.removeEventListener('paste', this.onWindowPaste, { capture: true }); } render() { return (