summaryrefslogtreecommitdiff
path: root/ext/js/dictionary/dictionary-data-util.js
blob: a2a106cc895d0f8464822a1b373ec0309a9e5704 (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
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
/*
 * Copyright (C) 2023-2024  Yomitan Authors
 * Copyright (C) 2020-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/>.
 */

/**
 * @param {import('dictionary').TermDictionaryEntry} dictionaryEntry
 * @returns {import('dictionary-data-util').TagGroup[]}
 */
export function groupTermTags(dictionaryEntry) {
    const {headwords} = dictionaryEntry;
    const headwordCount = headwords.length;
    const uniqueCheck = (headwordCount > 1);
    const resultsIndexMap = new Map();
    const results = [];
    for (let i = 0; i < headwordCount; ++i) {
        const {tags} = headwords[i];
        for (const tag of tags) {
            if (uniqueCheck) {
                const {name, category, content, dictionaries} = tag;
                const key = createMapKey([name, category, content, dictionaries]);
                const index = resultsIndexMap.get(key);
                if (typeof index !== 'undefined') {
                    const existingItem = results[index];
                    existingItem.headwordIndices.push(i);
                    continue;
                }
                resultsIndexMap.set(key, results.length);
            }

            const item = {tag, headwordIndices: [i]};
            results.push(item);
        }
    }
    return results;
}

/**
 * @param {import('dictionary').TermDictionaryEntry} dictionaryEntry
 * @returns {import('dictionary-data-util').DictionaryFrequency<import('dictionary-data-util').TermFrequency>[]}
 */
export function groupTermFrequencies(dictionaryEntry) {
    const {headwords, frequencies: sourceFrequencies} = dictionaryEntry;

    /** @type {import('dictionary-data-util').TermFrequenciesMap1} */
    const map1 = new Map();
    for (const {headwordIndex, dictionary, hasReading, frequency, displayValue} of sourceFrequencies) {
        const {term, reading} = headwords[headwordIndex];

        let map2 = map1.get(dictionary);
        if (typeof map2 === 'undefined') {
            map2 = new Map();
            map1.set(dictionary, map2);
        }

        const readingKey = hasReading ? reading : null;
        const key = createMapKey([term, readingKey]);
        let frequencyData = map2.get(key);
        if (typeof frequencyData === 'undefined') {
            frequencyData = {term, reading: readingKey, values: new Map()};
            map2.set(key, frequencyData);
        }

        frequencyData.values.set(createMapKey([frequency, displayValue]), {frequency, displayValue});
    }

    const results = [];
    for (const [dictionary, map2] of map1.entries()) {
        const frequencies = [];
        for (const {term, reading, values} of map2.values()) {
            frequencies.push({
                term,
                reading,
                values: [...values.values()]
            });
        }
        results.push({dictionary, frequencies});
    }
    return results;
}

/**
 * @param {import('dictionary').KanjiFrequency[]} sourceFrequencies
 * @returns {import('dictionary-data-util').DictionaryFrequency<import('dictionary-data-util').KanjiFrequency>[]}
 */
export function groupKanjiFrequencies(sourceFrequencies) {
    /** @type {import('dictionary-data-util').KanjiFrequenciesMap1} */
    const map1 = new Map();
    for (const {dictionary, character, frequency, displayValue} of sourceFrequencies) {
        let map2 = map1.get(dictionary);
        if (typeof map2 === 'undefined') {
            map2 = new Map();
            map1.set(dictionary, map2);
        }

        let frequencyData = map2.get(character);
        if (typeof frequencyData === 'undefined') {
            frequencyData = {character, values: new Map()};
            map2.set(character, frequencyData);
        }

        frequencyData.values.set(createMapKey([frequency, displayValue]), {frequency, displayValue});
    }

    const results = [];
    for (const [dictionary, map2] of map1.entries()) {
        const frequencies = [];
        for (const {character, values} of map2.values()) {
            frequencies.push({
                character,
                values: [...values.values()]
            });
        }
        results.push({dictionary, frequencies});
    }
    return results;
}

/**
 * @param {import('dictionary').TermDictionaryEntry} dictionaryEntry
 * @returns {import('dictionary-data-util').DictionaryGroupedPronunciations[]}
 */
export function getGroupedPronunciations(dictionaryEntry) {
    const {headwords, pronunciations: termPronunciations} = dictionaryEntry;

    const allTerms = new Set();
    const allReadings = new Set();
    for (const {term, reading} of headwords) {
        allTerms.add(term);
        allReadings.add(reading);
    }

    /** @type {Map<string, import('dictionary-data-util').GroupedPronunciationInternal[]>} */
    const groupedPronunciationsMap = new Map();
    for (const {headwordIndex, dictionary, pronunciations} of termPronunciations) {
        const {term, reading} = headwords[headwordIndex];
        let dictionaryGroupedPronunciationList = groupedPronunciationsMap.get(dictionary);
        if (typeof dictionaryGroupedPronunciationList === 'undefined') {
            dictionaryGroupedPronunciationList = [];
            groupedPronunciationsMap.set(dictionary, dictionaryGroupedPronunciationList);
        }
        for (const pronunciation of pronunciations) {
            let groupedPronunciation = findExistingGroupedPronunciation(reading, pronunciation, dictionaryGroupedPronunciationList);
            if (groupedPronunciation === null) {
                groupedPronunciation = {
                    pronunciation,
                    terms: new Set(),
                    reading
                };
                dictionaryGroupedPronunciationList.push(groupedPronunciation);
            }
            groupedPronunciation.terms.add(term);
        }
    }

    /** @type {import('dictionary-data-util').DictionaryGroupedPronunciations[]} */
    const results2 = [];
    const multipleReadings = (allReadings.size > 1);
    for (const [dictionary, dictionaryGroupedPronunciationList] of groupedPronunciationsMap.entries()) {
        /** @type {import('dictionary-data-util').GroupedPronunciation[]} */
        const pronunciations2 = [];
        for (const groupedPronunciation of dictionaryGroupedPronunciationList) {
            const {pronunciation, terms, reading} = groupedPronunciation;
            const exclusiveTerms = !areSetsEqual(terms, allTerms) ? getSetIntersection(terms, allTerms) : [];
            const exclusiveReadings = [];
            if (multipleReadings) {
                exclusiveReadings.push(reading);
            }
            pronunciations2.push({
                pronunciation,
                terms: [...terms],
                reading,
                exclusiveTerms,
                exclusiveReadings
            });
        }

        results2.push({dictionary, pronunciations: pronunciations2});
    }
    return results2;
}

/**
 * @template {import('dictionary').PronunciationType} T
 * @param {import('dictionary').Pronunciation[]} pronunciations
 * @param {T} type
 * @returns {import('dictionary').PronunciationGeneric<T>[]}
 */
export function getPronunciationsOfType(pronunciations, type) {
    /** @type {import('dictionary').PronunciationGeneric<T>[]} */
    const results = [];
    for (const pronunciation of pronunciations) {
        if (pronunciation.type !== type) { continue; }
        // This is type safe, but for some reason the cast is needed.
        results.push(/** @type {import('dictionary').PronunciationGeneric<T>} */ (pronunciation));
    }
    return results;
}

/**
 * @param {import('dictionary').Tag[]|import('anki-templates').Tag[]} termTags
 * @returns {import('dictionary-data-util').TermFrequencyType}
 */
export function getTermFrequency(termTags) {
    let totalScore = 0;
    for (const {score} of termTags) {
        totalScore += score;
    }
    if (totalScore > 0) {
        return 'popular';
    } else if (totalScore < 0) {
        return 'rare';
    } else {
        return 'normal';
    }
}

/**
 * @param {import('dictionary').TermHeadword[]} headwords
 * @param {number[]} headwordIndices
 * @param {Set<string>} allTermsSet
 * @param {Set<string>} allReadingsSet
 * @returns {string[]}
 */
export function getDisambiguations(headwords, headwordIndices, allTermsSet, allReadingsSet) {
    if (allTermsSet.size <= 1 && allReadingsSet.size <= 1) { return []; }

    /** @type {Set<string>} */
    const terms = new Set();
    /** @type {Set<string>} */
    const readings = new Set();
    for (const headwordIndex of headwordIndices) {
        const {term, reading} = headwords[headwordIndex];
        terms.add(term);
        readings.add(reading);
    }

    /** @type {string[]} */
    const disambiguations = [];
    const addTerms = !areSetsEqual(terms, allTermsSet);
    const addReadings = !areSetsEqual(readings, allReadingsSet);
    if (addTerms) {
        disambiguations.push(...getSetIntersection(terms, allTermsSet));
    }
    if (addReadings) {
        if (addTerms) {
            for (const term of terms) {
                readings.delete(term);
            }
        }
        disambiguations.push(...getSetIntersection(readings, allReadingsSet));
    }
    return disambiguations;
}

/**
 * @param {string[]} wordClasses
 * @returns {boolean}
 */
export function isNonNounVerbOrAdjective(wordClasses) {
    let isVerbOrAdjective = false;
    let isSuruVerb = false;
    let isNoun = false;
    for (const wordClass of wordClasses) {
        switch (wordClass) {
            case 'v1':
            case 'v5':
            case 'vk':
            case 'vz':
            case 'adj-i':
                isVerbOrAdjective = true;
                break;
            case 'vs':
                isVerbOrAdjective = true;
                isSuruVerb = true;
                // falls through
            case 'n':
                isNoun = true;
                break;
        }
    }
    return isVerbOrAdjective && !(isSuruVerb && isNoun);
}

// Private

/**
 * @param {string} reading
 * @param {import('dictionary').Pronunciation} pronunciation
 * @param {import('dictionary-data-util').GroupedPronunciationInternal[]} groupedPronunciationList
 * @returns {?import('dictionary-data-util').GroupedPronunciationInternal}
 */
function findExistingGroupedPronunciation(reading, pronunciation, groupedPronunciationList) {
    const existingGroupedPronunciation = groupedPronunciationList.find((groupedPronunciation) => {
        return groupedPronunciation.reading === reading && arePronunciationsEquivalent(groupedPronunciation, pronunciation);
    });

    return existingGroupedPronunciation || null;
}

/**
 * @param {import('dictionary-data-util').GroupedPronunciationInternal} groupedPronunciation
 * @param {import('dictionary').Pronunciation} pronunciation2
 * @returns {boolean}
 */
function arePronunciationsEquivalent({pronunciation: pronunciation1}, pronunciation2) {
    if (
        pronunciation1.type !== pronunciation2.type ||
        !areTagListsEqual(pronunciation1.tags, pronunciation2.tags)
    ) {
        return false;
    }
    switch (pronunciation1.type) {
        case 'pitch-accent':
        {
            // This cast is valid based on the type check at the start of the function.
            const pitchAccent2 = /** @type {import('dictionary').PitchAccent} */ (pronunciation2);
            return (
                pronunciation1.position === pitchAccent2.position &&
                areArraysEqual(pronunciation1.nasalPositions, pitchAccent2.nasalPositions) &&
                areArraysEqual(pronunciation1.devoicePositions, pitchAccent2.devoicePositions)
            );
        }
        case 'phonetic-transcription':
        {
            // This cast is valid based on the type check at the start of the function.
            const phoneticTranscription2 = /** @type {import('dictionary').PhoneticTranscription} */ (pronunciation2);
            return pronunciation1.ipa === phoneticTranscription2.ipa;
        }
    }
    return true;
}

/**
 * @template [T=unknown]
 * @param {T[]} array1
 * @param {T[]} array2
 * @returns {boolean}
 */
function areArraysEqual(array1, array2) {
    const ii = array1.length;
    if (ii !== array2.length) { return false; }
    for (let i = 0; i < ii; ++i) {
        if (array1[i] !== array2[i]) { return false; }
    }
    return true;
}

/**
 * @param {import('dictionary').Tag[]} tagList1
 * @param {import('dictionary').Tag[]} tagList2
 * @returns {boolean}
 */
function areTagListsEqual(tagList1, tagList2) {
    const ii = tagList1.length;
    if (tagList2.length !== ii) { return false; }

    for (let i = 0; i < ii; ++i) {
        const tag1 = tagList1[i];
        const tag2 = tagList2[i];
        if (tag1.name !== tag2.name || !areArraysEqual(tag1.dictionaries, tag2.dictionaries)) {
            return false;
        }
    }

    return true;
}

/**
 * @template [T=unknown]
 * @param {Set<T>} set1
 * @param {Set<T>} set2
 * @returns {boolean}
 */
function areSetsEqual(set1, set2) {
    if (set1.size !== set2.size) {
        return false;
    }

    for (const value of set1) {
        if (!set2.has(value)) {
            return false;
        }
    }

    return true;
}

/**
 * @template [T=unknown]
 * @param {Set<T>} set1
 * @param {Set<T>} set2
 * @returns {T[]}
 */
function getSetIntersection(set1, set2) {
    const result = [];
    for (const value of set1) {
        if (set2.has(value)) {
            result.push(value);
        }
    }
    return result;
}

/**
 * @param {unknown[]} array
 * @returns {string}
 */
function createMapKey(array) {
    return JSON.stringify(array);
}