aboutsummaryrefslogtreecommitdiff
path: root/types/ext/language-transformer-internal.d.ts
blob: c3ea4b7c3413daf3ee9e7f3fcd88c90e253d342a (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
/*
 * Copyright (C) 2024  Yomitan 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/>.
 */

export type Transform = {
    id: string;
    name: string;
    rules: Rule[];
    heuristic: RegExp;
    description?: string;
};

export type Rule = {
    type: 'suffix' | 'prefix' | 'wholeWord' | 'other';
    isInflected: RegExp;
    deinflect: (inflectedWord: string) => string;
    conditionsIn: number;
    conditionsOut: number;
};

export type TransformedText = {
    text: string;
    conditions: number;
    trace: Trace;
};

export type Trace = TraceFrame[];

export type TraceFrame = {
    text: string;
    transform: string;
    ruleIndex: number;
};

export type ConditionTypeToConditionFlagsMap = Map<string, number>;

export type LanguageTransformDescriptorInternal = {
    transforms: Transform[];
    conditionTypeToConditionFlagsMap: ConditionTypeToConditionFlagsMap;
    partOfSpeechToConditionFlagsMap: ConditionTypeToConditionFlagsMap;
};