yomichan/ext/fg/js/popup-factory.js

/*
 * Copyright (C) 2019-2020  Yomichan Authors
 *
 * This program is free software: you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation, either version 3 of the License, or
 * (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program.  If not, see <https://www.gnu.org/licenses/>.
 */

/* global
 * FrontendApiReceiver
 * Popup
 */

class PopupFactory {
    constructor(frameId) {
        this._popups = new Map();
        this._frameId = frameId;
    }

    // Public functions

    async prepare() {
        const apiReceiver = new FrontendApiReceiver(`popup-factory#${this._frameId}`, new Map([
            ['getOrCreatePopup',   {async: false, handler: this._onApiGetOrCreatePopup.bind(this)}],
            ['setOptionsContext',  {async: true,  handler: this._onApiSetOptionsContext.bind(this)}],
            ['hide',               {async: false, handler: this._onApiHide.bind(this)}],
            ['isVisible',          {async: true,  handler: this._onApiIsVisibleAsync.bind(this)}],
            ['setVisibleOverride', {async: true,  handler: this._onApiSetVisibleOverride.bind(this)}],
            ['containsPoint',      {async: true,  handler: this._onApiContainsPoint.bind(this)}],
            ['showContent',        {async: true,  handler: this._onApiShowContent.bind(this)}],
            ['setCustomCss',       {async: false, handler: this._onApiSetCustomCss.bind(this)}],
            ['clearAutoPlayTimer', {async: false, handler: this._onApiClearAutoPlayTimer.bind(this)}],
            ['setContentScale',    {async: false, handler: this._onApiSetContentScale.bind(this)}],
            ['getUrl',             {async: false, handler: this._onApiGetUrl.bind(this)}]
        ]));
        apiReceiver.prepare();
    }

    getOrCreatePopup(id=null, parentId=null, depth=null) {
        // Find by existing id
        if (id !== null) {
            const popup = this._popups.get(id);
            if (typeof popup !== 'undefined') {
                return popup;
            }
        }

        // Find by existing parent id
        let parent = null;
        if (parentId !== null) {
            parent = this._popups.get(parentId);
            if (typeof parent !== 'undefined') {
                const popup = parent.child;
                if (popup !== null) {
                    return popup;
                }
            } else {
                parent = null;
            }
        }

        // New unique id
        if (id === null) {
            id = yomichan.generateId(16);
        }

        // Create new popup
        if (parent !== null) {
            if (depth !== null) {
                throw new Error('Depth cannot be set when parent exists');
            }
            depth = parent.depth + 1;
        } else if (depth === null) {
            depth = 0;
        }
        const popup = new Popup(id, depth, this._frameId);
        if (parent !== null) {
            popup.setParent(parent);
        }
        this._popups.set(id, popup);
        popup.prepare();
        return popup;
    }

    // API message handlers

    _onApiGetOrCreatePopup({id, parentId}) {
        const popup = this.getOrCreatePopup(id, parentId);
        return {
            id: popup.id
        };
    }

    async _onApiSetOptionsContext({id, optionsContext, source}) {
        const popup = this._getPopup(id);
        return await popup.setOptionsContext(optionsContext, source);
    }

    _onApiHide({id, changeFocus}) {
        const popup = this._getPopup(id);
        return popup.hide(changeFocus);
    }

    async _onApiIsVisibleAsync({id}) {
        const popup = this._getPopup(id);
        return await popup.isVisible();
    }

    async _onApiSetVisibleOverride({id, visible}) {
        const popup = this._getPopup(id);
        return await popup.setVisibleOverride(visible);
    }

    async _onApiContainsPoint({id, x, y}) {
        const popup = this._getPopup(id);
        [x, y] = this._convertPopupPointToRootPagePoint(popup, x, y);
        return await popup.containsPoint(x, y);
    }

    async _onApiShowContent({id, elementRect, writingMode, type, details, context}) {
        const popup = this._getPopup(id);
        elementRect = this._convertJsonRectToDOMRect(popup, elementRect);
        if (!this._popupCanShow(popup)) { return; }
        return await popup.showContent(elementRect, writingMode, type, details, context);
    }

    _onApiSetCustomCss({id, css}) {
        const popup = this._getPopup(id);
        return popup.setCustomCss(css);
    }

    _onApiClearAutoPlayTimer({id}) {
        const popup = this._getPopup(id);
        return popup.clearAutoPlayTimer();
    }

    _onApiSetContentScale({id, scale}) {
        const popup = this._getPopup(id);
        return popup.setContentScale(scale);
    }

    _onApiGetUrl() {
        return window.location.href;
    }

    // Private functions

    _getPopup(id) {
        const popup = this._popups.get(id);
        if (typeof popup === 'undefined') {
            throw new Error(`Invalid popup ID ${id}`);
        }
        return popup;
    }

    _convertJsonRectToDOMRect(popup, jsonRect) {
        const [x, y] = this._convertPopupPointToRootPagePoint(popup, jsonRect.x, jsonRect.y);
        return new DOMRect(x, y, jsonRect.width, jsonRect.height);
    }

    _convertPopupPointToRootPagePoint(popup, x, y) {
        if (popup.parent !== null) {
            const popupRect = popup.parent.getFrameRect();
            x += popupRect.x;
            y += popupRect.y;
        }
        return [x, y];
    }

    _popupCanShow(popup) {
        return popup.parent === null || popup.parent.isVisibleSync();
    }
}