refactor(editor): rename block-std to std (#11250)

Closes: BS-2946
This commit is contained in:
Saul-Mirone
2025-03-28 07:20:34 +00:00
parent 4498676a96
commit 205cd7a86d
1029 changed files with 1580 additions and 1698 deletions

View File

@@ -0,0 +1,56 @@
import { UIEventState, UIEventStateContext } from '../base.js';
import type { UIEventDispatcher } from '../dispatcher.js';
import { ClipboardEventState } from '../state/clipboard.js';
import { EventScopeSourceType, EventSourceState } from '../state/source.js';
export class ClipboardControl {
private readonly _copy = (event: ClipboardEvent) => {
const clipboardEventState = new ClipboardEventState({
event,
});
this._dispatcher.run(
'copy',
this._createContext(event, clipboardEventState)
);
};
private readonly _cut = (event: ClipboardEvent) => {
const clipboardEventState = new ClipboardEventState({
event,
});
this._dispatcher.run(
'cut',
this._createContext(event, clipboardEventState)
);
};
private readonly _paste = (event: ClipboardEvent) => {
const clipboardEventState = new ClipboardEventState({
event,
});
this._dispatcher.run(
'paste',
this._createContext(event, clipboardEventState)
);
};
constructor(private readonly _dispatcher: UIEventDispatcher) {}
private _createContext(event: Event, clipboardState: ClipboardEventState) {
return UIEventStateContext.from(
new UIEventState(event),
new EventSourceState({
event,
sourceType: EventScopeSourceType.Selection,
}),
clipboardState
);
}
listen() {
this._dispatcher.disposables.addFromEvent(document, 'cut', this._cut);
this._dispatcher.disposables.addFromEvent(document, 'copy', this._copy);
this._dispatcher.disposables.addFromEvent(document, 'paste', this._paste);
}
}

View File

@@ -0,0 +1,129 @@
import { DisposableGroup } from '@blocksuite/global/disposable';
import { IS_ANDROID, IS_MAC } from '@blocksuite/global/env';
import {
type UIEventHandler,
UIEventState,
UIEventStateContext,
} from '../base.js';
import type { EventOptions, UIEventDispatcher } from '../dispatcher.js';
import { androidBindKeymapPatch, bindKeymap } from '../keymap.js';
import { KeyboardEventState } from '../state/index.js';
import { EventScopeSourceType, EventSourceState } from '../state/source.js';
export class KeyboardControl {
private readonly _down = (event: KeyboardEvent) => {
if (!this._shouldTrigger(event)) {
return;
}
const keyboardEventState = new KeyboardEventState({
event,
composing: this.composition,
});
this._dispatcher.run(
'keyDown',
this._createContext(event, keyboardEventState)
);
};
private readonly _shouldTrigger = (event: KeyboardEvent) => {
if (event.isComposing) {
return false;
}
const mod = IS_MAC ? event.metaKey : event.ctrlKey;
if (
['c', 'v', 'x'].includes(event.key) &&
mod &&
!event.shiftKey &&
!event.altKey
) {
return false;
}
return true;
};
private readonly _up = (event: KeyboardEvent) => {
if (!this._shouldTrigger(event)) {
return;
}
const keyboardEventState = new KeyboardEventState({
event,
composing: this.composition,
});
this._dispatcher.run(
'keyUp',
this._createContext(event, keyboardEventState)
);
};
private composition = false;
constructor(private readonly _dispatcher: UIEventDispatcher) {}
private _createContext(event: Event, keyboardState: KeyboardEventState) {
return UIEventStateContext.from(
new UIEventState(event),
new EventSourceState({
event,
sourceType: EventScopeSourceType.Selection,
}),
keyboardState
);
}
bindHotkey(keymap: Record<string, UIEventHandler>, options?: EventOptions) {
const disposables = new DisposableGroup();
if (IS_ANDROID) {
disposables.add(
this._dispatcher.add(
'beforeInput',
ctx => {
if (this.composition) return false;
const binding = androidBindKeymapPatch(keymap);
return binding(ctx);
},
options
)
);
}
disposables.add(
this._dispatcher.add(
'keyDown',
ctx => {
if (this.composition) return false;
const binding = bindKeymap(keymap);
return binding(ctx);
},
options
)
);
return () => disposables.dispose();
}
listen() {
this._dispatcher.disposables.addFromEvent(document, 'keydown', this._down);
this._dispatcher.disposables.addFromEvent(document, 'keyup', this._up);
this._dispatcher.disposables.addFromEvent(
document,
'compositionstart',
() => {
this.composition = true;
},
{
capture: true,
}
);
this._dispatcher.disposables.addFromEvent(
document,
'compositionend',
() => {
this.composition = false;
},
{
capture: true,
}
);
}
}

View File

@@ -0,0 +1,626 @@
import { IS_IPAD } from '@blocksuite/global/env';
import { Vec } from '@blocksuite/global/gfx';
import { nextTick } from '@blocksuite/global/utils';
import { UIEventState, UIEventStateContext } from '../base.js';
import type { UIEventDispatcher } from '../dispatcher.js';
import {
DndEventState,
MultiPointerEventState,
PointerEventState,
} from '../state/index.js';
import { EventScopeSourceType, EventSourceState } from '../state/source.js';
import { isFarEnough } from '../utils.js';
type PointerId = typeof PointerEvent.prototype.pointerId;
function createContext(
event: Event,
state: PointerEventState | MultiPointerEventState
) {
return UIEventStateContext.from(
new UIEventState(event),
new EventSourceState({
event,
sourceType: EventScopeSourceType.Target,
}),
state
);
}
const POLL_INTERVAL = 1000;
abstract class PointerControllerBase {
constructor(
protected _dispatcher: UIEventDispatcher,
protected _getRect: () => DOMRect
) {}
abstract listen(): void;
}
class PointerEventForward extends PointerControllerBase {
private readonly _down = (event: PointerEvent) => {
const { pointerId } = event;
const pointerState = new PointerEventState({
event,
rect: this._getRect(),
startX: -Infinity,
startY: -Infinity,
last: null,
});
this._startStates.set(pointerId, pointerState);
this._lastStates.set(pointerId, pointerState);
this._dispatcher.run('pointerDown', createContext(event, pointerState));
};
private readonly _lastStates = new Map<PointerId, PointerEventState>();
private readonly _move = (event: PointerEvent) => {
const { pointerId } = event;
const start = this._startStates.get(pointerId) ?? null;
const last = this._lastStates.get(pointerId) ?? null;
const state = new PointerEventState({
event,
rect: this._getRect(),
startX: start?.x ?? -Infinity,
startY: start?.y ?? -Infinity,
last,
});
this._lastStates.set(pointerId, state);
this._dispatcher.run('pointerMove', createContext(event, state));
};
private readonly _startStates = new Map<PointerId, PointerEventState>();
private readonly _upOrOut = (up: boolean) => (event: PointerEvent) => {
const { pointerId } = event;
const start = this._startStates.get(pointerId) ?? null;
const last = this._lastStates.get(pointerId) ?? null;
const state = new PointerEventState({
event,
rect: this._getRect(),
startX: start?.x ?? -Infinity,
startY: start?.y ?? -Infinity,
last,
});
this._startStates.delete(pointerId);
this._lastStates.delete(pointerId);
this._dispatcher.run(
up ? 'pointerUp' : 'pointerOut',
createContext(event, state)
);
};
listen() {
const { host, disposables } = this._dispatcher;
disposables.addFromEvent(host, 'pointerdown', this._down);
disposables.addFromEvent(host, 'pointermove', this._move);
disposables.addFromEvent(host, 'pointerup', this._upOrOut(true));
disposables.addFromEvent(host, 'pointerout', this._upOrOut(false));
}
}
class ClickController extends PointerControllerBase {
private readonly _down = (event: PointerEvent) => {
// disable for secondary pointer
if (event.isPrimary === false) return;
if (
this._downPointerState &&
event.pointerId === this._downPointerState.raw.pointerId &&
event.timeStamp - this._downPointerState.raw.timeStamp < 500 &&
!isFarEnough(event, this._downPointerState.raw)
) {
this._pointerDownCount++;
} else {
this._pointerDownCount = 1;
}
this._downPointerState = new PointerEventState({
event,
rect: this._getRect(),
startX: -Infinity,
startY: -Infinity,
last: null,
});
};
private _downPointerState: PointerEventState | null = null;
private _pointerDownCount = 0;
private readonly _up = (event: PointerEvent) => {
if (!this._downPointerState) return;
if (isFarEnough(this._downPointerState.raw, event)) {
this._pointerDownCount = 0;
this._downPointerState = null;
return;
}
const state = new PointerEventState({
event,
rect: this._getRect(),
startX: -Infinity,
startY: -Infinity,
last: null,
});
const context = createContext(event, state);
const run = () => {
this._dispatcher.run('click', context);
if (this._pointerDownCount === 2) {
this._dispatcher.run('doubleClick', context);
}
if (this._pointerDownCount === 3) {
this._dispatcher.run('tripleClick', context);
}
};
run();
};
listen() {
const { host, disposables } = this._dispatcher;
disposables.addFromEvent(host, 'pointerdown', this._down);
disposables.addFromEvent(host, 'pointerup', this._up);
}
}
class DragController extends PointerControllerBase {
private readonly _down = (event: PointerEvent) => {
if (this._nativeDragging) return;
if (!event.isPrimary) {
if (this._dragging && this._lastPointerState) {
this._up(this._lastPointerState.raw);
}
this._reset();
return;
}
const pointerState = new PointerEventState({
event,
rect: this._getRect(),
startX: -Infinity,
startY: -Infinity,
last: null,
});
this._startPointerState = pointerState;
this._dispatcher.disposables.addFromEvent(
document,
'pointermove',
this._move
);
this._dispatcher.disposables.addFromEvent(document, 'pointerup', this._up);
};
private _dragging = false;
private _lastPointerState: PointerEventState | null = null;
private readonly _move = (event: PointerEvent) => {
if (
this._startPointerState === null ||
this._startPointerState.raw.pointerId !== event.pointerId
)
return;
const start = this._startPointerState;
const last = this._lastPointerState ?? start;
const state = new PointerEventState({
event,
rect: this._getRect(),
startX: start.x,
startY: start.y,
last,
});
this._lastPointerState = state;
if (
!this._nativeDragging &&
!this._dragging &&
isFarEnough(event, this._startPointerState.raw)
) {
this._dragging = true;
this._dispatcher.run('dragStart', createContext(event, start));
}
if (this._dragging) {
this._dispatcher.run('dragMove', createContext(event, state));
}
};
private readonly _nativeDragEnd = (event: DragEvent) => {
this._nativeDragging = false;
const dndEventState = new DndEventState({ event });
this._dispatcher.run(
'nativeDragEnd',
this._createContext(event, dndEventState)
);
};
private _nativeDragging = false;
private readonly _nativeDragMove = (event: DragEvent) => {
const dndEventState = new DndEventState({ event });
this._dispatcher.run(
'nativeDragMove',
this._createContext(event, dndEventState)
);
};
private readonly _nativeDragStart = (event: DragEvent) => {
this._reset();
this._nativeDragging = true;
const dndEventState = new DndEventState({ event });
this._dispatcher.run(
'nativeDragStart',
this._createContext(event, dndEventState)
);
};
private readonly _nativeDragOver = (event: DragEvent) => {
// prevent default to allow drop in editor
event.preventDefault();
const dndEventState = new DndEventState({ event });
this._dispatcher.run(
'nativeDragOver',
this._createContext(event, dndEventState)
);
};
private readonly _nativeDragLeave = (event: DragEvent) => {
const dndEventState = new DndEventState({ event });
this._dispatcher.run(
'nativeDragLeave',
this._createContext(event, dndEventState)
);
};
private readonly _nativeDrop = (event: DragEvent) => {
this._reset();
this._nativeDragging = false;
const dndEventState = new DndEventState({ event });
this._dispatcher.run(
'nativeDrop',
this._createContext(event, dndEventState)
);
};
private readonly _reset = () => {
this._dragging = false;
this._startPointerState = null;
this._lastPointerState = null;
document.removeEventListener('pointermove', this._move);
document.removeEventListener('pointerup', this._up);
};
private _startPointerState: PointerEventState | null = null;
private readonly _up = (event: PointerEvent) => {
if (
!this._startPointerState ||
this._startPointerState.raw.pointerId !== event.pointerId
)
return;
const start = this._startPointerState;
const last = this._lastPointerState;
const state = new PointerEventState({
event,
rect: this._getRect(),
startX: start.x,
startY: start.y,
last,
});
if (this._dragging) {
this._dispatcher.run('dragEnd', createContext(event, state));
}
this._reset();
};
// https://mikepk.com/2020/10/iOS-safari-scribble-bug/
private _applyScribblePatch() {
if (!IS_IPAD) return;
const { host, disposables } = this._dispatcher;
disposables.addFromEvent(host, 'touchmove', (event: TouchEvent) => {
if (
this._dragging &&
this._startPointerState &&
this._startPointerState.raw.pointerType === 'pen'
) {
event.preventDefault();
}
});
}
private _createContext(event: Event, dndState: DndEventState) {
return UIEventStateContext.from(
new UIEventState(event),
new EventSourceState({
event,
sourceType: EventScopeSourceType.Target,
}),
dndState
);
}
listen() {
const { host, disposables } = this._dispatcher;
disposables.addFromEvent(host, 'pointerdown', this._down);
this._applyScribblePatch();
disposables.add(
host.std.dnd.monitor({
onDragStart: () => {
this._nativeDragging = true;
},
onDrop: () => {
this._nativeDragging = false;
},
})
);
disposables.addFromEvent(host, 'dragstart', this._nativeDragStart);
disposables.addFromEvent(host, 'dragend', this._nativeDragEnd);
disposables.addFromEvent(host, 'drag', this._nativeDragMove);
disposables.addFromEvent(host, 'drop', this._nativeDrop);
disposables.addFromEvent(host, 'dragover', this._nativeDragOver);
disposables.addFromEvent(host, 'dragleave', this._nativeDragLeave);
}
}
abstract class DualDragControllerBase extends PointerControllerBase {
private readonly _down = (event: PointerEvent) => {
// Another pointer down
if (
this._startPointerStates.primary !== null &&
this._startPointerStates.secondary !== null
) {
this._reset();
}
if (this._startPointerStates.primary === null && !event.isPrimary) {
return;
}
const state = new PointerEventState({
event,
rect: this._getRect(),
startX: -Infinity,
startY: -Infinity,
last: null,
});
if (event.isPrimary) {
this._startPointerStates.primary = state;
} else {
this._startPointerStates.secondary = state;
}
};
private _lastPointerStates: {
primary: PointerEventState | null;
secondary: PointerEventState | null;
} = {
primary: null,
secondary: null,
};
private readonly _move = (event: PointerEvent) => {
if (
this._startPointerStates.primary === null ||
this._startPointerStates.secondary === null
) {
return;
}
const { isPrimary } = event;
const startPrimaryState = this._startPointerStates.primary;
let lastPrimaryState = this._lastPointerStates.primary;
const startSecondaryState = this._startPointerStates.secondary;
let lastSecondaryState = this._lastPointerStates.secondary;
if (isPrimary) {
lastPrimaryState = new PointerEventState({
event,
rect: this._getRect(),
startX: startPrimaryState.x,
startY: startPrimaryState.y,
last: lastPrimaryState,
});
} else {
lastSecondaryState = new PointerEventState({
event,
rect: this._getRect(),
startX: startSecondaryState.x,
startY: startSecondaryState.y,
last: lastSecondaryState,
});
}
const multiPointerState = new MultiPointerEventState(event, [
lastPrimaryState ?? startPrimaryState,
lastSecondaryState ?? startSecondaryState,
]);
this._handleMove(event, multiPointerState);
this._lastPointerStates = {
primary: lastPrimaryState,
secondary: lastSecondaryState,
};
};
private readonly _reset = () => {
this._startPointerStates = {
primary: null,
secondary: null,
};
this._lastPointerStates = {
primary: null,
secondary: null,
};
};
private _startPointerStates: {
primary: PointerEventState | null;
secondary: PointerEventState | null;
} = {
primary: null,
secondary: null,
};
private readonly _upOrOut = (event: PointerEvent) => {
const { pointerId } = event;
if (
pointerId === this._startPointerStates.primary?.raw.pointerId ||
pointerId === this._startPointerStates.secondary?.raw.pointerId
) {
this._reset();
}
};
abstract _handleMove(
event: PointerEvent,
state: MultiPointerEventState
): void;
override listen(): void {
const { host, disposables } = this._dispatcher;
disposables.addFromEvent(host, 'pointerdown', this._down);
disposables.addFromEvent(host, 'pointermove', this._move);
disposables.addFromEvent(host, 'pointerup', this._upOrOut);
disposables.addFromEvent(host, 'pointerout', this._upOrOut);
}
}
class PinchController extends DualDragControllerBase {
override _handleMove(event: PointerEvent, state: MultiPointerEventState) {
if (event.pointerType !== 'touch') return;
const deltaFirstPointer = state.pointers[0].delta;
const deltaSecondPointer = state.pointers[1].delta;
const deltaFirstPointerVec = Vec.toVec(deltaFirstPointer);
const deltaSecondPointerVec = Vec.toVec(deltaSecondPointer);
const deltaFirstPointerValue = Vec.len(deltaFirstPointerVec);
const deltaSecondPointerValue = Vec.len(deltaSecondPointerVec);
const deltaDotProduct = Vec.dpr(
deltaFirstPointerVec,
deltaSecondPointerVec
);
const deltaValueThreshold = 0.1;
// the changes of distance between two pointers is not far enough
if (
!isFarEnough(deltaFirstPointer, deltaSecondPointer) ||
deltaDotProduct > 0 ||
deltaFirstPointerValue < deltaValueThreshold ||
deltaSecondPointerValue < deltaValueThreshold
)
return;
this._dispatcher.run('pinch', createContext(event, state));
}
}
class PanController extends DualDragControllerBase {
override _handleMove(event: PointerEvent, state: MultiPointerEventState) {
if (event.pointerType !== 'touch') return;
const deltaFirstPointer = state.pointers[0].delta;
const deltaSecondPointer = state.pointers[1].delta;
const deltaDotProduct = Vec.dpr(
Vec.toVec(deltaFirstPointer),
Vec.toVec(deltaSecondPointer)
);
// the center move distance is not far enough
if (
!isFarEnough(deltaFirstPointer, deltaSecondPointer) &&
deltaDotProduct < 0
)
return;
this._dispatcher.run('pan', createContext(event, state));
}
}
export class PointerControl {
private _cachedRect: DOMRect | null = null;
private readonly _getRect = () => {
if (this._cachedRect === null) {
this._updateRect();
}
return this._cachedRect as DOMRect;
};
// XXX: polling is used instead of MutationObserver
// due to potential performance issues
private _pollingInterval: number | null = null;
private readonly controllers: PointerControllerBase[];
constructor(private readonly _dispatcher: UIEventDispatcher) {
this.controllers = [
new PointerEventForward(_dispatcher, this._getRect),
new ClickController(_dispatcher, this._getRect),
new DragController(_dispatcher, this._getRect),
new PanController(_dispatcher, this._getRect),
new PinchController(_dispatcher, this._getRect),
];
}
private _startPolling() {
const poll = () => {
nextTick()
.then(() => this._updateRect())
.catch(console.error);
};
this._pollingInterval = window.setInterval(poll, POLL_INTERVAL);
poll();
}
protected _updateRect() {
if (!this._dispatcher.host) return;
this._cachedRect = this._dispatcher.host.getBoundingClientRect();
}
dispose() {
if (this._pollingInterval !== null) {
clearInterval(this._pollingInterval);
this._pollingInterval = null;
}
}
listen() {
this._startPolling();
this.controllers.forEach(controller => controller.listen());
}
}

View File

@@ -0,0 +1,156 @@
import type { BlockComponent } from '../../view/index.js';
import { UIEventState, UIEventStateContext } from '../base.js';
import type {
EventHandlerRunner,
EventName,
UIEventDispatcher,
} from '../dispatcher.js';
import { EventScopeSourceType, EventSourceState } from '../state/source.js';
export class RangeControl {
private readonly _buildScope = (eventName: EventName) => {
let scope: EventHandlerRunner[] | undefined;
const selection = document.getSelection();
if (selection && selection.rangeCount > 0) {
const range = selection.getRangeAt(0);
scope = this._buildEventScopeByNativeRange(eventName, range);
this._prev = range;
} else if (this._prev !== null) {
scope = this._buildEventScopeByNativeRange(eventName, this._prev);
this._prev = null;
}
return scope;
};
private readonly _compositionEnd = (event: Event) => {
const scope = this._buildScope('compositionEnd');
this._dispatcher.run('compositionEnd', this._createContext(event), scope);
};
private readonly _compositionStart = (event: Event) => {
const scope = this._buildScope('compositionStart');
this._dispatcher.run('compositionStart', this._createContext(event), scope);
};
private readonly _compositionUpdate = (event: Event) => {
const scope = this._buildScope('compositionUpdate');
this._dispatcher.run(
'compositionUpdate',
this._createContext(event),
scope
);
};
private _prev: Range | null = null;
private readonly _selectionChange = (event: Event) => {
const selection = document.getSelection();
if (!selection) return;
if (!selection.containsNode(this._dispatcher.host, true)) return;
if (selection.containsNode(this._dispatcher.host)) return;
const scope = this._buildScope('selectionChange');
this._dispatcher.run('selectionChange', this._createContext(event), scope);
};
constructor(private readonly _dispatcher: UIEventDispatcher) {}
private _buildEventScopeByNativeRange(name: EventName, range: Range) {
const blockIds = this._findBlockComponentPath(range);
return this._dispatcher.buildEventScope(name, blockIds);
}
private _createContext(event: Event) {
return UIEventStateContext.from(
new UIEventState(event),
new EventSourceState({
event,
sourceType: EventScopeSourceType.Selection,
})
);
}
private _findBlockComponentPath(range: Range): string[] {
const start = range.startContainer;
const end = range.endContainer;
const ancestor = range.commonAncestorContainer;
const getBlockView = (node: Node): BlockComponent | null => {
const el = node instanceof Element ? node : node.parentElement;
// TODO(mirone/#6534): find a better way to get block element from a node
return el?.closest<BlockComponent>('[data-block-id]') ?? null;
};
if (ancestor.nodeType === Node.TEXT_NODE) {
const leaf = getBlockView(ancestor);
if (leaf) {
return [leaf.blockId];
}
}
const nodes = new Set<Node>();
let startRecorded = false;
const dfsDOMSearch = (current: Node | null, ancestor: Node) => {
if (!current) {
return;
}
if (current === ancestor) {
return;
}
if (current === end) {
nodes.add(current);
startRecorded = false;
return;
}
if (current === start) {
startRecorded = true;
}
// eslint-disable-next-line sonarjs/no-collapsible-if
if (startRecorded) {
if (
current.nodeType === Node.TEXT_NODE ||
current.nodeType === Node.ELEMENT_NODE
) {
nodes.add(current);
}
}
dfsDOMSearch(current.firstChild, ancestor);
dfsDOMSearch(current.nextSibling, ancestor);
};
dfsDOMSearch(ancestor.firstChild, ancestor);
const blocks = new Set<string>();
nodes.forEach(node => {
const blockView = getBlockView(node);
if (!blockView) {
return;
}
if (blocks.has(blockView.blockId)) {
return;
}
blocks.add(blockView.blockId);
});
return Array.from(blocks);
}
listen() {
const { host, disposables } = this._dispatcher;
disposables.addFromEvent(
document,
'selectionchange',
this._selectionChange
);
disposables.addFromEvent(host, 'compositionstart', this._compositionStart);
disposables.addFromEvent(host, 'compositionend', this._compositionEnd);
disposables.addFromEvent(
host,
'compositionupdate',
this._compositionUpdate
);
}
}