Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Remove touchInputEnabled and pointerEventsEnabled #1576

Closed
wants to merge 7 commits into from
Closed

Remove touchInputEnabled and pointerEventsEnabled #1576

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
7 commits
Select commit Hold shift + click to select a range
7718914
Remove touchInputEnabled and pointerEventsEnabled
jamesmaa Nov 6, 2024
263e097
Revert small change
jamesmaa Nov 6, 2024
20a391e
Missed change
jamesmaa Nov 6, 2024
ecd6137
Forgot to save
jamesmaa Nov 6, 2024
0ac18d7
Restore _getPointerEventListeners
jamesmaa Nov 6, 2024
e39daf1
Remove unused code
jamesmaa Nov 6, 2024
ac98aa6
Add touchEnd and contextMenu
jamesmaa Nov 6, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 0 additions & 10 deletions ext/data/schemas/options-schema.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -453,8 +453,6 @@
"required": [
"inputs",
"preventMiddleMouse",
"touchInputEnabled",
"pointerEventsEnabled",
"selectText",
"alphanumeric",
"autoHideResults",
Expand Down Expand Up @@ -676,14 +674,6 @@
}
}
},
"touchInputEnabled": {
"type": "boolean",
"default": true
},
"pointerEventsEnabled": {
"type": "boolean",
"default": false
},
"selectText": {
"type": "boolean",
"default": true
Expand Down
2 changes: 0 additions & 2 deletions ext/js/app/frontend.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -506,8 +506,6 @@ export class Frontend {
normalizeCssZoom: scanningOptions.normalizeCssZoom,
selectText: scanningOptions.selectText,
delay: scanningOptions.delay,
touchInputEnabled: scanningOptions.touchInputEnabled,
pointerEventsEnabled: scanningOptions.pointerEventsEnabled,
scanLength: scanningOptions.length,
layoutAwareScan: scanningOptions.layoutAwareScan,
matchTypePrefix: scanningOptions.matchTypePrefix,
Expand Down
13 changes: 13 additions & 0 deletions ext/js/data/options-util.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -566,6 +566,7 @@ export class OptionsUtil {
this._updateVersion52,
this._updateVersion53,
this._updateVersion54,
this._updateVersion55,
];
/* eslint-enable @typescript-eslint/unbound-method */
if (typeof targetVersion === 'number' && targetVersion < result.length) {
Expand Down Expand Up @@ -1521,6 +1522,18 @@ export class OptionsUtil {
}
}

/**
* - Remove scanning.touchInputEnabled
* - Remove scanning.pointerEventsEnabled
* @type {import('options-util').UpdateFunction}
*/
async _updateVersion55(options) {
for (const profile of options.profiles) {
delete profile.options.scanning.touchInputEnabled;
delete profile.options.scanning.pointerEventsEnabled;
}
}

/**
* @param {string} url
* @returns {Promise<chrome.tabs.Tab>}
Expand Down
4 changes: 0 additions & 4 deletions ext/js/display/display.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -457,8 +457,6 @@ export class Display extends EventDispatcher {
normalizeCssZoom: scanningOptions.normalizeCssZoom,
selectText: scanningOptions.selectText,
delay: scanningOptions.delay,
touchInputEnabled: scanningOptions.touchInputEnabled,
pointerEventsEnabled: scanningOptions.pointerEventsEnabled,
scanLength: scanningOptions.length,
layoutAwareScan: scanningOptions.layoutAwareScan,
preventMiddleMouse: scanningOptions.preventMiddleMouse.onSearchQuery,
Expand Down Expand Up @@ -2054,8 +2052,6 @@ export class Display extends EventDispatcher {
normalizeCssZoom: scanningOptions.normalizeCssZoom,
selectText: false,
delay: scanningOptions.delay,
touchInputEnabled: false,
pointerEventsEnabled: false,
scanLength: scanningOptions.length,
layoutAwareScan: scanningOptions.layoutAwareScan,
preventMiddleMouse: false,
Expand Down
104 changes: 3 additions & 101 deletions ext/js/language/text-scanner.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -104,10 +104,6 @@ export class TextScanner extends EventDispatcher {
this._selectText = false;
/** @type {number} */
this._delay = 0;
/** @type {boolean} */
this._touchInputEnabled = false;
/** @type {boolean} */
this._pointerEventsEnabled = false;
/** @type {number} */
this._scanLength = 1;
/** @type {boolean} */
Expand Down Expand Up @@ -261,8 +257,6 @@ export class TextScanner extends EventDispatcher {
normalizeCssZoom,
selectText,
delay,
touchInputEnabled,
pointerEventsEnabled,
scanLength,
layoutAwareScan,
preventMiddleMouse,
Expand All @@ -286,12 +280,6 @@ export class TextScanner extends EventDispatcher {
if (typeof delay === 'number') {
this._delay = delay;
}
if (typeof touchInputEnabled === 'boolean') {
this._touchInputEnabled = touchInputEnabled;
}
if (typeof pointerEventsEnabled === 'boolean') {
this._pointerEventsEnabled = pointerEventsEnabled;
}
if (typeof scanLength === 'number') {
this._scanLength = scanLength;
}
Expand Down Expand Up @@ -589,11 +577,6 @@ export class TextScanner extends EventDispatcher {
this._resetPreventNextClickScan();
}

/** */
_onSearchClickTouchStart() {
this._resetPreventNextClickScan();
}

/**
* @param {MouseEvent} e
*/
Expand Down Expand Up @@ -746,18 +729,6 @@ export class TextScanner extends EventDispatcher {
}
}

/**
* @param {TouchEvent} e
*/
_onTouchStart(e) {
if (this._primaryTouchIdentifier !== null || e.changedTouches.length === 0) {
return;
}

const {clientX, clientY, identifier} = e.changedTouches[0];
this._onPrimaryTouchStart(e, clientX, clientY, identifier);
}

/**
* @param {TouchEvent|PointerEvent} e
* @param {number} x
Expand Down Expand Up @@ -822,47 +793,6 @@ export class TextScanner extends EventDispatcher {
}
}

/**
* @param {TouchEvent} e
*/
_onTouchCancel(e) {
if (this._primaryTouchIdentifier === null) { return; }

const primaryTouch = this._getTouch(e.changedTouches, this._primaryTouchIdentifier);
if (primaryTouch === null) { return; }

this._onPrimaryTouchEnd(e, 0, 0, false);
}

/**
* @param {TouchEvent} e
*/
_onTouchMove(e) {
this._touchTapValid = false;

if (this._primaryTouchIdentifier === null) { return; }

if (!e.cancelable) {
this._onPrimaryTouchEnd(e, 0, 0, false);
return;
}

if (!this._preventScroll) { return; }

const primaryTouch = this._getTouch(e.changedTouches, this._primaryTouchIdentifier);
if (primaryTouch === null) { return; }

const inputInfo = this._getMatchingInputGroupFromEvent('touch', 'touchMove', e);
if (inputInfo === null) { return; }

const {input} = inputInfo;
if (input !== null && input.scanOnTouchMove) {
void this._searchAt(primaryTouch.clientX, primaryTouch.clientY, inputInfo);
}

e.preventDefault(); // Disable scroll
}

/**
* @param {PointerEvent} e
* @returns {boolean|void}
Expand Down Expand Up @@ -1139,30 +1069,18 @@ export class TextScanner extends EventDispatcher {
this._scanTimerPromise = null;
}

/**
* @returns {boolean}
*/
_arePointerEventsSupported() {
return (this._pointerEventsEnabled && typeof PointerEvent !== 'undefined');
}

/** */
_hookEvents() {
const capture = true;
/** @type {import('event-listener-collection').AddEventListenerArgs[]} */
let eventListenerInfos;
if (this._searchOnClickOnly) {
eventListenerInfos = this._getMouseClickOnlyEventListeners(capture);
} else if (this._arePointerEventsSupported()) {
eventListenerInfos = this._getPointerEventListeners(capture);
} else {
eventListenerInfos = [...this._getMouseEventListeners(capture)];
eventListenerInfos = [...this._getPointerEventListeners(capture), ...this._getMouseEventListeners(capture)];
if (this._scanWithoutMousemove) {
eventListenerInfos.push(...this._getKeyboardEventListeners(capture));
}
if (this._touchInputEnabled) {
eventListenerInfos.push(...this._getTouchEventListeners(capture));
}
}
if (this._searchOnClick) {
eventListenerInfos.push(...this._getMouseClickOnlyEventListeners2(capture));
Expand All @@ -1188,9 +1106,11 @@ export class TextScanner extends EventDispatcher {
[this._node, 'pointercancel', this._onPointerCancel.bind(this), capture],
[this._node, 'pointerout', this._onPointerOut.bind(this), capture],
[this._node, 'touchmove', this._onTouchMovePreventScroll.bind(this), {passive: false, capture}],
[this._node, 'touchend', this._onTouchEnd.bind(this), capture],
[this._node, 'mousedown', this._onMouseDown.bind(this), capture],
[this._node, 'click', this._onClick.bind(this), capture],
[this._node, 'auxclick', this._onAuxClick.bind(this), capture],
[this._node, 'contextmenu', this._onContextMenu.bind(this), capture],
];
}

Expand Down Expand Up @@ -1218,21 +1138,6 @@ export class TextScanner extends EventDispatcher {
];
}

/**
* @param {boolean} capture
* @returns {import('event-listener-collection').AddEventListenerArgs[]}
*/
_getTouchEventListeners(capture) {
return [
[this._node, 'auxclick', this._onAuxClick.bind(this), capture],
[this._node, 'touchstart', this._onTouchStart.bind(this), {passive: true, capture}],
[this._node, 'touchend', this._onTouchEnd.bind(this), capture],
[this._node, 'touchcancel', this._onTouchCancel.bind(this), capture],
[this._node, 'touchmove', this._onTouchMove.bind(this), {passive: false, capture}],
[this._node, 'contextmenu', this._onContextMenu.bind(this), capture],
];
}

/**
* @param {boolean} capture
* @returns {import('event-listener-collection').AddEventListenerArgs[]}
Expand All @@ -1255,9 +1160,6 @@ export class TextScanner extends EventDispatcher {
];
if (documentElement !== null) {
entries.push([documentElement, 'mousedown', this._onSearchClickMouseDown.bind(this), capture]);
if (this._touchInputEnabled) {
entries.push([documentElement, 'touchstart', this._onSearchClickTouchStart.bind(this), {passive: true, capture}]);
}
}
return entries;
}
Expand Down
36 changes: 0 additions & 36 deletions ext/settings.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -544,42 +544,6 @@ <h1>Yomitan Settings</h1>
<input type="number" data-setting="scanning.length" min="1" step="1">
</div>
</div></div>
<div class="settings-item advanced-only">
<div class="settings-item-inner settings-item-inner-wrappable">
<div class="settings-item-left">
<div class="settings-item-label">
Support inputs for devices with touch screens
<a tabindex="0" class="more-toggle more-only" data-parent-distance="4">(?)</a>
</div>
</div>
<div class="settings-item-right flex-row-wrap">
<div class="settings-item-group settings-item-group-wrap">
<label class="settings-item-group-item flex-label no-wrap">
<label class="checkbox"><input type="checkbox" data-setting="scanning.touchInputEnabled"><span class="checkbox-body"><span class="checkbox-fill"></span><span class="checkbox-border"></span><span class="checkbox-check"></span></span></label>
<span>Touch inputs</span>
</label>
<label class="settings-item-group-item flex-label no-wrap">
<label class="checkbox"><input type="checkbox" data-setting="scanning.pointerEventsEnabled"><span class="checkbox-body"><span class="checkbox-fill"></span><span class="checkbox-border"></span><span class="checkbox-check"></span></span></label>
<span>Pointer inputs</span>
</label>
</div>
</div>
</div>
<div class="settings-item-children more" hidden>
<p>
To enable text scanning when using devices with a touch screen, either the <em>Touch inputs</em> or the <em>Pointer inputs</em> option must be enabled.
<em>Touch inputs</em> supports generic touches on a touch screen device, but do not distinguish between touch and pen inputs.
<em>Pointer inputs</em> supports supports the detection pen devices, but may not work on all devices.
If both options are enabled, <em>Pointer inputs</em> takes precedence.
</p>
<p>
The <em>Pointer inputs</em> option is only visible when the <em>Advanced</em> option is enabled.
</p>
<p>
<a tabindex="0" class="more-toggle" data-parent-distance="3">Less&hellip;</a>
</p>
</div>
</div>
<div class="settings-item settings-item-button advanced-only" data-modal-action="show,input-action-prevention"><div class="settings-item-inner">
<div class="settings-item-left">
<div class="settings-item-label">Configure input action prevention&hellip;</div>
Expand Down
5 changes: 1 addition & 4 deletions test/options-util.test.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -81,7 +81,6 @@ function createProfileOptionsTestData1() {
},
scanning: {
middleMouse: true,
touchInputEnabled: true,
selectText: true,
alphanumeric: true,
autoHideResults: false,
Expand Down Expand Up @@ -329,7 +328,6 @@ function createProfileOptionsUpdatedTestData1() {
autoPlay: false,
},
scanning: {
touchInputEnabled: true,
selectText: true,
alphanumeric: true,
autoHideResults: false,
Expand All @@ -343,7 +341,6 @@ function createProfileOptionsUpdatedTestData1() {
enableSearchTags: false,
layoutAwareScan: false,
hideDelay: 0,
pointerEventsEnabled: false,
matchTypePrefix: false,
hidePopupOnCursorExit: false,
hidePopupOnCursorExitDelay: 0,
Expand Down Expand Up @@ -645,7 +642,7 @@ function createOptionsUpdatedTestData1() {
},
],
profileCurrent: 0,
version: 54,
version: 55,
global: {
database: {
prefixWildcardsSupported: false,
Expand Down
2 changes: 0 additions & 2 deletions types/ext/settings.d.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -179,8 +179,6 @@ export type AudioSourceOptions = {
export type ScanningOptions = {
inputs: ScanningInput[];
preventMiddleMouse: ScanningPreventMiddleMouseOptions;
touchInputEnabled: boolean;
pointerEventsEnabled: boolean;
selectText: boolean;
alphanumeric: boolean;
autoHideResults: boolean;
Expand Down
2 changes: 0 additions & 2 deletions types/ext/text-scanner.d.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -34,8 +34,6 @@ export type Options = {
normalizeCssZoom?: boolean;
selectText?: boolean;
delay?: number;
touchInputEnabled?: boolean;
pointerEventsEnabled?: boolean;
scanLength?: number;
layoutAwareScan?: boolean;
preventMiddleMouse?: boolean;
Expand Down