use disposables for transient mouse listeners
This commit is contained in:
@@ -7,7 +7,7 @@ import { addDisposableListener } from '../Dom';
|
|||||||
import { IBufferService, IMouseStateService, ICoreService, ILogService, IOptionsService } from '../../common/services/Services';
|
import { IBufferService, IMouseStateService, ICoreService, ILogService, IOptionsService } from '../../common/services/Services';
|
||||||
import { CoreMouseAction, CoreMouseButton, CoreMouseEventType, ICoreMouseEvent, IDisposable } from '../../common/Types';
|
import { CoreMouseAction, CoreMouseButton, CoreMouseEventType, ICoreMouseEvent, IDisposable } from '../../common/Types';
|
||||||
import { C0 } from '../../common/data/EscapeSequences';
|
import { C0 } from '../../common/data/EscapeSequences';
|
||||||
import { DisposableStore, MutableDisposable, toDisposable } from '../../common/Lifecycle';
|
import { DisposableStore, MutableDisposable } from '../../common/Lifecycle';
|
||||||
import { ICoreBrowserService, IMouseCoordsService, IMouseService, IMouseServiceTarget, IRenderService, ISelectionService } from './Services';
|
import { ICoreBrowserService, IMouseCoordsService, IMouseService, IMouseServiceTarget, IRenderService, ISelectionService } from './Services';
|
||||||
import { Gesture, EventType as GestureEventType, IGestureEvent } from '../scrollable/touch';
|
import { Gesture, EventType as GestureEventType, IGestureEvent } from '../scrollable/touch';
|
||||||
|
|
||||||
@@ -21,7 +21,8 @@ interface IMouseBindContext {
|
|||||||
readonly target: IMouseServiceTarget;
|
readonly target: IMouseServiceTarget;
|
||||||
readonly focus: () => void;
|
readonly focus: () => void;
|
||||||
readonly requestedEvents: RequestedMouseEvents;
|
readonly requestedEvents: RequestedMouseEvents;
|
||||||
listenerDocument: Document | null;
|
readonly mouseupListener: MutableDisposable<IDisposable>;
|
||||||
|
readonly mousedragListener: MutableDisposable<IDisposable>;
|
||||||
}
|
}
|
||||||
|
|
||||||
export class MouseService implements IMouseService {
|
export class MouseService implements IMouseService {
|
||||||
@@ -46,7 +47,7 @@ export class MouseService implements IMouseService {
|
|||||||
}
|
}
|
||||||
|
|
||||||
public bindMouse(target: IMouseServiceTarget, register: (disposable: IDisposable) => void, focus: () => void): void {
|
public bindMouse(target: IMouseServiceTarget, register: (disposable: IDisposable) => void, focus: () => void): void {
|
||||||
const { element, document } = target;
|
const { element } = target;
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Event listener state handling.
|
* Event listener state handling.
|
||||||
@@ -62,7 +63,11 @@ export class MouseService implements IMouseService {
|
|||||||
mousedrag: null,
|
mousedrag: null,
|
||||||
mousemove: null
|
mousemove: null
|
||||||
};
|
};
|
||||||
const ctx: IMouseBindContext = { target, focus, requestedEvents, listenerDocument: null };
|
const mouseupListener = new MutableDisposable<IDisposable>();
|
||||||
|
const mousedragListener = new MutableDisposable<IDisposable>();
|
||||||
|
register(mouseupListener);
|
||||||
|
register(mousedragListener);
|
||||||
|
const ctx: IMouseBindContext = { target, focus, requestedEvents, mouseupListener, mousedragListener };
|
||||||
const eventListeners: Record<'mouseup' | 'wheel' | 'mousedrag' | 'mousemove', EventListener> = {
|
const eventListeners: Record<'mouseup' | 'wheel' | 'mousedrag' | 'mousemove', EventListener> = {
|
||||||
mouseup: (ev: Event) => this._handleMouseUp(ctx, ev as MouseEvent),
|
mouseup: (ev: Event) => this._handleMouseUp(ctx, ev as MouseEvent),
|
||||||
wheel: (ev: Event) => this._handleWheel(ctx, ev as WheelEvent),
|
wheel: (ev: Event) => this._handleWheel(ctx, ev as WheelEvent),
|
||||||
@@ -86,17 +91,6 @@ export class MouseService implements IMouseService {
|
|||||||
// force initial onProtocolChange so we dont miss early mouse requests
|
// force initial onProtocolChange so we dont miss early mouse requests
|
||||||
this._mouseStateService.activeProtocol = this._mouseStateService.activeProtocol;
|
this._mouseStateService.activeProtocol = this._mouseStateService.activeProtocol;
|
||||||
|
|
||||||
// Ensure document-level listeners are removed on dispose
|
|
||||||
register(toDisposable(() => {
|
|
||||||
const listenerDocument = ctx.listenerDocument ?? document;
|
|
||||||
if (requestedEvents.mouseup) {
|
|
||||||
listenerDocument.removeEventListener('mouseup', requestedEvents.mouseup);
|
|
||||||
}
|
|
||||||
if (requestedEvents.mousedrag) {
|
|
||||||
listenerDocument.removeEventListener('mousemove', requestedEvents.mousedrag);
|
|
||||||
}
|
|
||||||
}));
|
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* "Always on" event listeners.
|
* "Always on" event listeners.
|
||||||
*/
|
*/
|
||||||
@@ -201,14 +195,8 @@ export class MouseService implements IMouseService {
|
|||||||
this._sendEvent(ctx, ev);
|
this._sendEvent(ctx, ev);
|
||||||
if (!ev.buttons) {
|
if (!ev.buttons) {
|
||||||
// if no other button is held remove global handlers
|
// if no other button is held remove global handlers
|
||||||
const listenerDocument = ctx.listenerDocument ?? ctx.target.document;
|
ctx.mouseupListener.clear();
|
||||||
if (ctx.requestedEvents.mouseup) {
|
ctx.mousedragListener.clear();
|
||||||
listenerDocument.removeEventListener('mouseup', ctx.requestedEvents.mouseup);
|
|
||||||
}
|
|
||||||
if (ctx.requestedEvents.mousedrag) {
|
|
||||||
listenerDocument.removeEventListener('mousemove', ctx.requestedEvents.mousedrag);
|
|
||||||
}
|
|
||||||
ctx.listenerDocument = null;
|
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
@@ -253,12 +241,11 @@ export class MouseService implements IMouseService {
|
|||||||
// Use the element's current document in case it moved to another window after open.
|
// Use the element's current document in case it moved to another window after open.
|
||||||
const listenerDocument = ctx.target.element.ownerDocument ?? ctx.target.document;
|
const listenerDocument = ctx.target.element.ownerDocument ?? ctx.target.document;
|
||||||
if (ctx.requestedEvents.mouseup) {
|
if (ctx.requestedEvents.mouseup) {
|
||||||
listenerDocument.addEventListener('mouseup', ctx.requestedEvents.mouseup);
|
ctx.mouseupListener.value = addDisposableListener(listenerDocument, 'mouseup', ctx.requestedEvents.mouseup);
|
||||||
}
|
}
|
||||||
if (ctx.requestedEvents.mousedrag) {
|
if (ctx.requestedEvents.mousedrag) {
|
||||||
listenerDocument.addEventListener('mousemove', ctx.requestedEvents.mousedrag);
|
ctx.mousedragListener.value = addDisposableListener(listenerDocument, 'mousemove', ctx.requestedEvents.mousedrag);
|
||||||
}
|
}
|
||||||
ctx.listenerDocument = listenerDocument;
|
|
||||||
}
|
}
|
||||||
|
|
||||||
private _handlePassiveWheel(ctx: IMouseBindContext, ev: WheelEvent): false | void {
|
private _handlePassiveWheel(ctx: IMouseBindContext, ev: WheelEvent): false | void {
|
||||||
@@ -407,7 +394,6 @@ export class MouseService implements IMouseService {
|
|||||||
private _handleProtocolChange(ctx: IMouseBindContext, eventListeners: Record<'mouseup' | 'wheel' | 'mousedrag' | 'mousemove', EventListener>, events: CoreMouseEventType): void {
|
private _handleProtocolChange(ctx: IMouseBindContext, eventListeners: Record<'mouseup' | 'wheel' | 'mousedrag' | 'mousemove', EventListener>, events: CoreMouseEventType): void {
|
||||||
const { element } = ctx.target;
|
const { element } = ctx.target;
|
||||||
const { requestedEvents } = ctx;
|
const { requestedEvents } = ctx;
|
||||||
const listenerDocument = ctx.listenerDocument ?? ctx.target.document;
|
|
||||||
// apply global changes on events
|
// apply global changes on events
|
||||||
if (events) {
|
if (events) {
|
||||||
if (this._optionsService.rawOptions.logLevel === 'debug') {
|
if (this._optionsService.rawOptions.logLevel === 'debug') {
|
||||||
@@ -441,18 +427,14 @@ export class MouseService implements IMouseService {
|
|||||||
}
|
}
|
||||||
|
|
||||||
if (!(events & CoreMouseEventType.UP)) {
|
if (!(events & CoreMouseEventType.UP)) {
|
||||||
if (requestedEvents.mouseup) {
|
ctx.mouseupListener.clear();
|
||||||
listenerDocument.removeEventListener('mouseup', requestedEvents.mouseup);
|
|
||||||
}
|
|
||||||
requestedEvents.mouseup = null;
|
requestedEvents.mouseup = null;
|
||||||
} else {
|
} else {
|
||||||
requestedEvents.mouseup ??= eventListeners.mouseup;
|
requestedEvents.mouseup ??= eventListeners.mouseup;
|
||||||
}
|
}
|
||||||
|
|
||||||
if (!(events & CoreMouseEventType.DRAG)) {
|
if (!(events & CoreMouseEventType.DRAG)) {
|
||||||
if (requestedEvents.mousedrag) {
|
ctx.mousedragListener.clear();
|
||||||
listenerDocument.removeEventListener('mousemove', requestedEvents.mousedrag);
|
|
||||||
}
|
|
||||||
requestedEvents.mousedrag = null;
|
requestedEvents.mousedrag = null;
|
||||||
} else {
|
} else {
|
||||||
requestedEvents.mousedrag ??= eventListeners.mousedrag;
|
requestedEvents.mousedrag ??= eventListeners.mousedrag;
|
||||||
|
|||||||
Reference in New Issue
Block a user