import bindAll from 'lodash.bindall'; import PropTypes from 'prop-types'; import React from 'react'; import VM from 'scratch-vm'; import {connect} from 'react-redux'; import {updateTargets} from '../reducers/targets'; import {updateBlockDrag} from '../reducers/block-drag'; import {updateMonitors} from '../reducers/monitors'; import {setRunningState, setTurboState} from '../reducers/vm-status'; import {showExtensionAlert} from '../reducers/alerts'; import {updateMicIndicator} from '../reducers/mic-indicator'; /* * Higher Order Component to manage events emitted by the VM * @param {React.Component} WrappedComponent component to manage VM events for * @returns {React.Component} connected component with vm events bound to redux */ const vmListenerHOC = function (WrappedComponent) { class VMListener extends React.Component { constructor (props) { super(props); bindAll(this, [ 'handleKeyDown', 'handleKeyUp', 'handleTargetsUpdate' ]); // We have to start listening to the vm here rather than in // componentDidMount because the HOC mounts the wrapped component, // so the HOC componentDidMount triggers after the wrapped component // mounts. // If the wrapped component uses the vm in componentDidMount, then // we need to start listening before mounting the wrapped component. this.props.vm.on('targetsUpdate', this.handleTargetsUpdate); this.props.vm.on('MONITORS_UPDATE', this.props.onMonitorsUpdate); this.props.vm.on('BLOCK_DRAG_UPDATE', this.props.onBlockDragUpdate); this.props.vm.on('TURBO_MODE_ON', this.props.onTurboModeOn); this.props.vm.on('TURBO_MODE_OFF', this.props.onTurboModeOff); this.props.vm.on('PROJECT_RUN_START', this.props.onProjectRunStart); this.props.vm.on('PROJECT_RUN_STOP', this.props.onProjectRunStop); this.props.vm.on('PERIPHERAL_DISCONNECT_ERROR', this.props.onShowExtensionAlert); this.props.vm.on('MIC_LISTENING', this.props.onMicListeningUpdate); } componentDidMount () { if (this.props.attachKeyboardEvents) { document.addEventListener('keydown', this.handleKeyDown); document.addEventListener('keyup', this.handleKeyUp); } this.props.vm.postIOData('userData', {username: this.props.username}); } componentDidUpdate (prevProps) { if (prevProps.username !== this.props.username) { this.props.vm.postIOData('userData', {username: this.props.username}); } // Re-request a targets update when the shouldEmitTargetsUpdate state changes to true // i.e. when the editor transitions out of fullscreen/player only modes if (this.props.shouldEmitTargetsUpdate && !prevProps.shouldEmitTargetsUpdate) { this.props.vm.emitTargetsUpdate(); } } componentWillUnmount () { this.props.vm.removeListener('PERIPHERAL_DISCONNECT_ERROR', this.props.onShowExtensionAlert); if (this.props.attachKeyboardEvents) { document.removeEventListener('keydown', this.handleKeyDown); document.removeEventListener('keyup', this.handleKeyUp); } } handleTargetsUpdate (data) { if (this.props.shouldEmitTargetsUpdate) { this.props.onTargetsUpdate(data); } } handleKeyDown (e) { // Don't capture keys intended for Blockly inputs. if (e.target !== document && e.target !== document.body) return; this.props.vm.postIOData('keyboard', { keyCode: e.keyCode, key: e.key, isDown: true }); // Prevent space/arrow key from scrolling the page. if (e.keyCode === 32 || // 32=space (e.keyCode >= 37 && e.keyCode <= 40)) { // 37, 38, 39, 40 are arrows e.preventDefault(); } } handleKeyUp (e) { // Always capture up events, // even those that have switched to other targets. this.props.vm.postIOData('keyboard', { keyCode: e.keyCode, key: e.key, isDown: false }); // E.g., prevent scroll. if (e.target !== document && e.target !== document.body) { e.preventDefault(); } } render () { const { /* eslint-disable no-unused-vars */ attachKeyboardEvents, shouldEmitTargetsUpdate, onBlockDragUpdate, onKeyDown, onKeyUp, onMicListeningUpdate, onMonitorsUpdate, onTargetsUpdate, onProjectRunStart, onProjectRunStop, onTurboModeOff, onTurboModeOn, onShowExtensionAlert, /* eslint-enable no-unused-vars */ ...props } = this.props; return <WrappedComponent {...props} />; } } VMListener.propTypes = { attachKeyboardEvents: PropTypes.bool, onBlockDragUpdate: PropTypes.func.isRequired, onKeyDown: PropTypes.func, onKeyUp: PropTypes.func, onMicListeningUpdate: PropTypes.func.isRequired, onMonitorsUpdate: PropTypes.func.isRequired, onProjectRunStart: PropTypes.func.isRequired, onProjectRunStop: PropTypes.func.isRequired, onShowExtensionAlert: PropTypes.func.isRequired, onTargetsUpdate: PropTypes.func.isRequired, onTurboModeOff: PropTypes.func.isRequired, onTurboModeOn: PropTypes.func.isRequired, shouldEmitTargetsUpdate: PropTypes.bool, username: PropTypes.string, vm: PropTypes.instanceOf(VM).isRequired }; VMListener.defaultProps = { attachKeyboardEvents: true }; const mapStateToProps = state => ({ // Do not emit target updates in fullscreen or player only mode shouldEmitTargetsUpdate: !state.scratchGui.mode.isFullScreen && !state.scratchGui.mode.isPlayerOnly, vm: state.scratchGui.vm, username: state.session && state.session.session && state.session.session.user ? state.session.session.user.username : '' }); const mapDispatchToProps = dispatch => ({ onTargetsUpdate: data => { dispatch(updateTargets(data.targetList, data.editingTarget)); }, onMonitorsUpdate: monitorList => { dispatch(updateMonitors(monitorList)); }, onBlockDragUpdate: areBlocksOverGui => { dispatch(updateBlockDrag(areBlocksOverGui)); }, onProjectRunStart: () => dispatch(setRunningState(true)), onProjectRunStop: () => dispatch(setRunningState(false)), onTurboModeOn: () => dispatch(setTurboState(true)), onTurboModeOff: () => dispatch(setTurboState(false)), onShowExtensionAlert: data => { dispatch(showExtensionAlert(data)); }, onMicListeningUpdate: listening => { dispatch(updateMicIndicator(listening)); } }); return connect( mapStateToProps, mapDispatchToProps )(VMListener); }; export default vmListenerHOC;