aboutsummaryrefslogtreecommitdiff
path: root/ext/js/data/anki-util.js
blob: 1edbc58c505a2000888e0725ff4d43c312c9aafc (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
/*
 * Copyright (C) 2023-2024  Yomitan Authors
 * Copyright (C) 2021-2022  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/>.
 */

import {isObject} from '../core.js';

/**
 * This class has some general utility functions for working with Anki data.
 */
export class AnkiUtil {
    /** @type {RegExp} @readonly */
    static _markerPattern = /\{([\w-]+)\}/g;

    /**
     * Gets the root deck name of a full deck name. If the deck is a root deck,
     * the same name is returned. Nested decks are separated using '::'.
     * @param {string} deckName A string of the deck name.
     * @returns {string} A string corresponding to the name of the root deck.
     */
    static getRootDeckName(deckName) {
        const index = deckName.indexOf('::');
        return index >= 0 ? deckName.substring(0, index) : deckName;
    }

    /**
     * Checks whether or not any marker is contained in a string.
     * @param {string} string A string to check.
     * @returns {boolean} `true` if the text contains an Anki field marker, `false` otherwise.
     */
    static stringContainsAnyFieldMarker(string) {
        const result = this._markerPattern.test(string);
        this._markerPattern.lastIndex = 0;
        return result;
    }

    /**
     * Gets a list of all markers that are contained in a string.
     * @param {string} string A string to check.
     * @returns {string[]} An array of marker strings.
     */
    static getFieldMarkers(string) {
        const pattern = this._markerPattern;
        const markers = [];
        while (true) {
            const match = pattern.exec(string);
            if (match === null) { break; }
            markers.push(match[1]);
        }
        return markers;
    }

    /**
     * Returns a regular expression which can be used to find markers in a string.
     * @param {boolean} global Whether or not the regular expression should have the global flag.
     * @returns {RegExp} A new `RegExp` instance.
     */
    static cloneFieldMarkerPattern(global) {
        return new RegExp(this._markerPattern.source, global ? 'g' : '');
    }

    /**
     * Checks whether or not a note object is valid.
     * @param {import('anki').Note} note A note object to check.
     * @returns {boolean} `true` if the note is valid, `false` otherwise.
     */
    static isNoteDataValid(note) {
        if (!isObject(note)) { return false; }
        const {fields, deckName, modelName} = note;
        return (
            typeof deckName === 'string' &&
            typeof modelName === 'string' &&
            Object.entries(fields).length > 0
        );
    }
}