mirror of
https://github.com/overleaf/overleaf.git
synced 2024-12-12 19:03:38 -05:00
65b0fd73ea
* Improve "compile" keypress handling * Remove "compile" keypress handling from PDF preview * Remove compile shortcuts from CM6 * Use an event for Vim keybindings * Remove event handlers from Angular/Ace * Move useCompileTriggers into DetachCompileProvider GitOrigin-RevId: 7f0e667b5106a849458e06ebb0f7a413d5d63430
472 lines
11 KiB
JavaScript
472 lines
11 KiB
JavaScript
import { createContext, useContext, useMemo } from 'react'
|
|
import PropTypes from 'prop-types'
|
|
import {
|
|
useLocalCompileContext,
|
|
CompileContextPropTypes,
|
|
} from './local-compile-context'
|
|
import useDetachStateWatcher from '../hooks/use-detach-state-watcher'
|
|
import useDetachAction from '../hooks/use-detach-action'
|
|
import useCompileTriggers from '../../features/pdf-preview/hooks/use-compile-triggers'
|
|
|
|
export const DetachCompileContext = createContext()
|
|
|
|
DetachCompileContext.Provider.propTypes = CompileContextPropTypes
|
|
|
|
export function DetachCompileProvider({ children }) {
|
|
const localCompileContext = useLocalCompileContext()
|
|
if (!localCompileContext) {
|
|
throw new Error(
|
|
'DetachCompileProvider is only available inside LocalCompileProvider'
|
|
)
|
|
}
|
|
|
|
const {
|
|
animateCompileDropdownArrow: _animateCompileDropdownArrow,
|
|
autoCompile: _autoCompile,
|
|
clearingCache: _clearingCache,
|
|
clsiServerId: _clsiServerId,
|
|
codeCheckFailed: _codeCheckFailed,
|
|
compiling: _compiling,
|
|
deliveryLatencies: _deliveryLatencies,
|
|
draft: _draft,
|
|
error: _error,
|
|
fileList: _fileList,
|
|
hasChanges: _hasChanges,
|
|
highlights: _highlights,
|
|
lastCompileOptions: _lastCompileOptions,
|
|
logEntries: _logEntries,
|
|
logEntryAnnotations: _logEntryAnnotations,
|
|
pdfFile: _pdfFile,
|
|
pdfViewer: _pdfViewer,
|
|
position: _position,
|
|
rawLog: _rawLog,
|
|
setAnimateCompileDropdownArrow: _setAnimateCompileDropdownArrow,
|
|
setAutoCompile: _setAutoCompile,
|
|
setDraft: _setDraft,
|
|
setError: _setError,
|
|
setHasLintingError: _setHasLintingError,
|
|
setHighlights: _setHighlights,
|
|
setPosition: _setPosition,
|
|
setShowCompileTimeWarning: _setShowCompileTimeWarning,
|
|
setShowLogs: _setShowLogs,
|
|
toggleLogs: _toggleLogs,
|
|
setStopOnFirstError: _setStopOnFirstError,
|
|
setStopOnValidationError: _setStopOnValidationError,
|
|
showLogs: _showLogs,
|
|
showCompileTimeWarning: _showCompileTimeWarning,
|
|
showFasterCompilesFeedbackUI: _showFasterCompilesFeedbackUI,
|
|
stopOnFirstError: _stopOnFirstError,
|
|
stopOnValidationError: _stopOnValidationError,
|
|
stoppedOnFirstError: _stoppedOnFirstError,
|
|
uncompiled: _uncompiled,
|
|
validationIssues: _validationIssues,
|
|
firstRenderDone: _firstRenderDone,
|
|
cleanupCompileResult: _cleanupCompileResult,
|
|
recompileFromScratch: _recompileFromScratch,
|
|
setCompiling: _setCompiling,
|
|
startCompile: _startCompile,
|
|
stopCompile: _stopCompile,
|
|
setChangedAt: _setChangedAt,
|
|
clearCache: _clearCache,
|
|
} = localCompileContext
|
|
|
|
const [animateCompileDropdownArrow] = useDetachStateWatcher(
|
|
'animateCompileDropdownArrow',
|
|
_animateCompileDropdownArrow,
|
|
'detacher',
|
|
'detached'
|
|
)
|
|
const [autoCompile] = useDetachStateWatcher(
|
|
'autoCompile',
|
|
_autoCompile,
|
|
'detacher',
|
|
'detached'
|
|
)
|
|
const [clearingCache] = useDetachStateWatcher(
|
|
'clearingCache',
|
|
_clearingCache,
|
|
'detacher',
|
|
'detached'
|
|
)
|
|
const [clsiServerId] = useDetachStateWatcher(
|
|
'clsiServerId',
|
|
_clsiServerId,
|
|
'detacher',
|
|
'detached'
|
|
)
|
|
const [codeCheckFailed] = useDetachStateWatcher(
|
|
'codeCheckFailed',
|
|
_codeCheckFailed,
|
|
'detacher',
|
|
'detached'
|
|
)
|
|
const [compiling] = useDetachStateWatcher(
|
|
'compiling',
|
|
_compiling,
|
|
'detacher',
|
|
'detached'
|
|
)
|
|
const [deliveryLatencies] = useDetachStateWatcher(
|
|
'deliveryLatencies',
|
|
_deliveryLatencies,
|
|
'detacher',
|
|
'detached'
|
|
)
|
|
const [draft] = useDetachStateWatcher('draft', _draft, 'detacher', 'detached')
|
|
const [error] = useDetachStateWatcher('error', _error, 'detacher', 'detached')
|
|
const [fileList] = useDetachStateWatcher(
|
|
'fileList',
|
|
_fileList,
|
|
'detacher',
|
|
'detached'
|
|
)
|
|
const [hasChanges] = useDetachStateWatcher(
|
|
'hasChanges',
|
|
_hasChanges,
|
|
'detacher',
|
|
'detached'
|
|
)
|
|
const [highlights] = useDetachStateWatcher(
|
|
'highlights',
|
|
_highlights,
|
|
'detacher',
|
|
'detached'
|
|
)
|
|
const [lastCompileOptions] = useDetachStateWatcher(
|
|
'lastCompileOptions',
|
|
_lastCompileOptions,
|
|
'detacher',
|
|
'detached'
|
|
)
|
|
const [logEntries] = useDetachStateWatcher(
|
|
'logEntries',
|
|
_logEntries,
|
|
'detacher',
|
|
'detached'
|
|
)
|
|
const [logEntryAnnotations] = useDetachStateWatcher(
|
|
'logEntryAnnotations',
|
|
_logEntryAnnotations,
|
|
'detacher',
|
|
'detached'
|
|
)
|
|
const [pdfFile] = useDetachStateWatcher(
|
|
'pdfFile',
|
|
_pdfFile,
|
|
'detacher',
|
|
'detached'
|
|
)
|
|
const [pdfViewer] = useDetachStateWatcher(
|
|
'pdfViewer',
|
|
_pdfViewer,
|
|
'detacher',
|
|
'detached'
|
|
)
|
|
const [position] = useDetachStateWatcher(
|
|
'position',
|
|
_position,
|
|
'detacher',
|
|
'detached'
|
|
)
|
|
const [rawLog] = useDetachStateWatcher(
|
|
'rawLog',
|
|
_rawLog,
|
|
'detacher',
|
|
'detached'
|
|
)
|
|
const [showCompileTimeWarning] = useDetachStateWatcher(
|
|
'showCompileTimeWarning',
|
|
_showCompileTimeWarning,
|
|
'detacher',
|
|
'detached'
|
|
)
|
|
const [showLogs] = useDetachStateWatcher(
|
|
'showLogs',
|
|
_showLogs,
|
|
'detacher',
|
|
'detached'
|
|
)
|
|
const [showFasterCompilesFeedbackUI] = useDetachStateWatcher(
|
|
'showFasterCompilesFeedbackUI',
|
|
_showFasterCompilesFeedbackUI,
|
|
'detacher',
|
|
'detached'
|
|
)
|
|
const [stopOnFirstError] = useDetachStateWatcher(
|
|
'stopOnFirstError',
|
|
_stopOnFirstError,
|
|
'detacher',
|
|
'detached'
|
|
)
|
|
const [stopOnValidationError] = useDetachStateWatcher(
|
|
'stopOnValidationError',
|
|
_stopOnValidationError,
|
|
'detacher',
|
|
'detached'
|
|
)
|
|
const [stoppedOnFirstError] = useDetachStateWatcher(
|
|
'stoppedOnFirstError',
|
|
_stoppedOnFirstError,
|
|
'detacher',
|
|
'detached'
|
|
)
|
|
const [uncompiled] = useDetachStateWatcher(
|
|
'uncompiled',
|
|
_uncompiled,
|
|
'detacher',
|
|
'detached'
|
|
)
|
|
const [validationIssues] = useDetachStateWatcher(
|
|
'validationIssues',
|
|
_validationIssues,
|
|
'detacher',
|
|
'detached'
|
|
)
|
|
|
|
const setAnimateCompileDropdownArrow = useDetachAction(
|
|
'setAnimateCompileDropdownArrow',
|
|
_setAnimateCompileDropdownArrow,
|
|
'detached',
|
|
'detacher'
|
|
)
|
|
const setAutoCompile = useDetachAction(
|
|
'setAutoCompile',
|
|
_setAutoCompile,
|
|
'detached',
|
|
'detacher'
|
|
)
|
|
const setDraft = useDetachAction(
|
|
'setDraft',
|
|
_setDraft,
|
|
'detached',
|
|
'detacher'
|
|
)
|
|
const setError = useDetachAction(
|
|
'setError',
|
|
_setError,
|
|
'detacher',
|
|
'detached'
|
|
)
|
|
const setPosition = useDetachAction(
|
|
'setPosition',
|
|
_setPosition,
|
|
'detached',
|
|
'detacher'
|
|
)
|
|
const firstRenderDone = useDetachAction(
|
|
'firstRenderDone',
|
|
_firstRenderDone,
|
|
'detached',
|
|
'detacher'
|
|
)
|
|
const setHasLintingError = useDetachAction(
|
|
'setHasLintingError',
|
|
_setHasLintingError,
|
|
'detacher',
|
|
'detached'
|
|
)
|
|
const setHighlights = useDetachAction(
|
|
'setHighlights',
|
|
_setHighlights,
|
|
'detacher',
|
|
'detached'
|
|
)
|
|
const setShowCompileTimeWarning = useDetachAction(
|
|
'setShowCompileTimeWarning',
|
|
_setShowCompileTimeWarning,
|
|
'detached',
|
|
'detacher'
|
|
)
|
|
const setShowLogs = useDetachAction(
|
|
'setShowLogs',
|
|
_setShowLogs,
|
|
'detached',
|
|
'detacher'
|
|
)
|
|
const toggleLogs = useDetachAction(
|
|
'toggleLogs',
|
|
_toggleLogs,
|
|
'detached',
|
|
'detacher'
|
|
)
|
|
const setStopOnFirstError = useDetachAction(
|
|
'setStopOnFirstError',
|
|
_setStopOnFirstError,
|
|
'detached',
|
|
'detacher'
|
|
)
|
|
const setStopOnValidationError = useDetachAction(
|
|
'setStopOnValidationError',
|
|
_setStopOnValidationError,
|
|
'detached',
|
|
'detacher'
|
|
)
|
|
const cleanupCompileResult = useDetachAction(
|
|
'cleanupCompileResult',
|
|
_cleanupCompileResult,
|
|
'detached',
|
|
'detacher'
|
|
)
|
|
const recompileFromScratch = useDetachAction(
|
|
'recompileFromScratch',
|
|
_recompileFromScratch,
|
|
'detached',
|
|
'detacher'
|
|
)
|
|
const setCompiling = useDetachAction(
|
|
'setCompiling',
|
|
_setCompiling,
|
|
'detacher',
|
|
'detached'
|
|
)
|
|
const startCompile = useDetachAction(
|
|
'startCompile',
|
|
_startCompile,
|
|
'detached',
|
|
'detacher'
|
|
)
|
|
const stopCompile = useDetachAction(
|
|
'stopCompile',
|
|
_stopCompile,
|
|
'detached',
|
|
'detacher'
|
|
)
|
|
const setChangedAt = useDetachAction(
|
|
'setChangedAt',
|
|
_setChangedAt,
|
|
'detached',
|
|
'detacher'
|
|
)
|
|
const clearCache = useDetachAction(
|
|
'clearCache',
|
|
_clearCache,
|
|
'detached',
|
|
'detacher'
|
|
)
|
|
|
|
useCompileTriggers(startCompile, setChangedAt)
|
|
|
|
const value = useMemo(
|
|
() => ({
|
|
animateCompileDropdownArrow,
|
|
autoCompile,
|
|
clearCache,
|
|
clearingCache,
|
|
clsiServerId,
|
|
codeCheckFailed,
|
|
compiling,
|
|
deliveryLatencies,
|
|
draft,
|
|
error,
|
|
fileList,
|
|
hasChanges,
|
|
highlights,
|
|
lastCompileOptions,
|
|
logEntryAnnotations,
|
|
logEntries,
|
|
pdfDownloadUrl: pdfFile?.pdfDownloadUrl,
|
|
pdfFile,
|
|
pdfUrl: pdfFile?.pdfUrl,
|
|
pdfViewer,
|
|
position,
|
|
rawLog,
|
|
recompileFromScratch,
|
|
setAnimateCompileDropdownArrow,
|
|
setAutoCompile,
|
|
setCompiling,
|
|
setDraft,
|
|
setError,
|
|
setHasLintingError,
|
|
setHighlights,
|
|
setPosition,
|
|
setShowCompileTimeWarning,
|
|
setShowLogs,
|
|
toggleLogs,
|
|
setStopOnFirstError,
|
|
setStopOnValidationError,
|
|
showLogs,
|
|
showCompileTimeWarning,
|
|
showFasterCompilesFeedbackUI,
|
|
startCompile,
|
|
stopCompile,
|
|
stopOnFirstError,
|
|
stopOnValidationError,
|
|
stoppedOnFirstError,
|
|
uncompiled,
|
|
validationIssues,
|
|
firstRenderDone,
|
|
setChangedAt,
|
|
cleanupCompileResult,
|
|
}),
|
|
[
|
|
animateCompileDropdownArrow,
|
|
autoCompile,
|
|
clearCache,
|
|
clearingCache,
|
|
clsiServerId,
|
|
codeCheckFailed,
|
|
compiling,
|
|
deliveryLatencies,
|
|
draft,
|
|
error,
|
|
fileList,
|
|
hasChanges,
|
|
highlights,
|
|
lastCompileOptions,
|
|
logEntryAnnotations,
|
|
logEntries,
|
|
pdfFile,
|
|
pdfViewer,
|
|
position,
|
|
rawLog,
|
|
recompileFromScratch,
|
|
setAnimateCompileDropdownArrow,
|
|
setAutoCompile,
|
|
setCompiling,
|
|
setDraft,
|
|
setError,
|
|
setHasLintingError,
|
|
setHighlights,
|
|
setPosition,
|
|
setShowCompileTimeWarning,
|
|
setShowLogs,
|
|
toggleLogs,
|
|
setStopOnFirstError,
|
|
setStopOnValidationError,
|
|
showCompileTimeWarning,
|
|
showLogs,
|
|
showFasterCompilesFeedbackUI,
|
|
startCompile,
|
|
stopCompile,
|
|
stopOnFirstError,
|
|
stopOnValidationError,
|
|
stoppedOnFirstError,
|
|
uncompiled,
|
|
validationIssues,
|
|
firstRenderDone,
|
|
setChangedAt,
|
|
cleanupCompileResult,
|
|
]
|
|
)
|
|
|
|
return (
|
|
<DetachCompileContext.Provider value={value}>
|
|
{children}
|
|
</DetachCompileContext.Provider>
|
|
)
|
|
}
|
|
|
|
DetachCompileProvider.propTypes = {
|
|
children: PropTypes.any,
|
|
}
|
|
|
|
export function useDetachCompileContext(propTypes) {
|
|
const data = useContext(DetachCompileContext)
|
|
PropTypes.checkPropTypes(
|
|
propTypes,
|
|
data,
|
|
'data',
|
|
'DetachCompileContext.Provider'
|
|
)
|
|
return data
|
|
}
|