aboutsummaryrefslogtreecommitdiff
path: root/dev/generate-css-json.js
blob: a0035346951555f48c787cdc409013efd55c3242 (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
/*
 * Copyright (C) 2023  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 css from 'css';
import fs from 'fs';
import path from 'path';
import {fileURLToPath} from 'url';

const dirname = path.dirname(fileURLToPath(import.meta.url));

/**
 * @returns {{cssFile: string, overridesCssFile: string, outputPath: string}[]}
 */
export function getTargets() {
    return [
        {
            cssFile: path.join(dirname, '..', 'ext/css/structured-content.css'),
            overridesCssFile: path.join(dirname, 'data/structured-content-overrides.css'),
            outputPath: path.join(dirname, '..', 'ext/data/structured-content-style.json')
        },
        {
            cssFile: path.join(dirname, '..', 'ext/css/display-pronunciation.css'),
            overridesCssFile: path.join(dirname, 'data/display-pronunciation-overrides.css'),
            outputPath: path.join(dirname, '..', 'ext/data/pronunciation-style.json')
        }
    ];
}

/**
 * @param {import('css-style-applier').RawStyleData} rules
 * @param {string[]} selectors
 * @returns {number}
 */
function indexOfRule(rules, selectors) {
    const jj = selectors.length;
    for (let i = 0, ii = rules.length; i < ii; ++i) {
        const ruleSelectors = rules[i].selectors;
        if (ruleSelectors.length !== jj) { continue; }
        let okay = true;
        for (let j = 0; j < jj; ++j) {
            if (selectors[j] !== ruleSelectors[j]) {
                okay = false;
                break;
            }
        }
        if (okay) { return i; }
    }
    return -1;
}

/**
 * @param {import('css-style-applier').RawStyleDataStyleArray} styles
 * @param {string} property
 * @param {Map<string, number>} removedProperties
 * @returns {number}
 */
function removeProperty(styles, property, removedProperties) {
    let removeCount = removedProperties.get(property);
    if (typeof removeCount !== 'undefined') { return removeCount; }
    removeCount = 0;
    for (let i = 0, ii = styles.length; i < ii; ++i) {
        const key = styles[i][0];
        if (key !== property) { continue; }
        styles.splice(i, 1);
        --i;
        --ii;
        ++removeCount;
    }
    removedProperties.set(property, removeCount);
    return removeCount;
}

/**
 * Manually formats JSON for improved compactness.
 * @param {import('css-style-applier').RawStyleData} rules CSS ruleset.
 * @returns {string}
 */
export function formatRulesJson(rules) {
    // return JSON.stringify(rules, null, 4);
    const indent1 = '    ';
    const indent2 = indent1.repeat(2);
    const indent3 = indent1.repeat(3);
    let result = '';
    result += '[';
    let index1 = 0;
    for (const {selectors, styles} of rules) {
        if (index1 > 0) { result += ','; }
        result += `\n${indent1}{\n${indent2}"selectors": `;
        if (selectors.length === 1) {
            result += `[${JSON.stringify(selectors[0], null, 4)}]`;
        } else {
            result += JSON.stringify(selectors, null, 4).replace(/\n/g, '\n' + indent2);
        }
        result += `,\n${indent2}"styles": [`;
        let index2 = 0;
        for (const [key, value] of styles) {
            if (index2 > 0) { result += ','; }
            result += `\n${indent3}[${JSON.stringify(key)}, ${JSON.stringify(value)}]`;
            ++index2;
        }
        if (index2 > 0) { result += `\n${indent2}`; }
        result += `]\n${indent1}}`;
        ++index1;
    }
    if (index1 > 0) { result += '\n'; }
    result += ']';
    return result;
}

/**
 * Generates a CSS ruleset.
 * @param {string} cssFile Path to CSS file.
 * @param {string} overridesCssFile Path to override CSS file.
 * @returns {import('css-style-applier').RawStyleData}
 * @throws {Error}
 */
export function generateRules(cssFile, overridesCssFile) {
    const content1 = fs.readFileSync(cssFile, {encoding: 'utf8'});
    const content2 = fs.readFileSync(overridesCssFile, {encoding: 'utf8'});
    const stylesheet1 = /** @type {css.StyleRules} */ (css.parse(content1, {}).stylesheet);
    const stylesheet2 = /** @type {css.StyleRules} */ (css.parse(content2, {}).stylesheet);

    const removePropertyPattern = /^remove-property\s+([\w\W]+)$/;
    const removeRulePattern = /^remove-rule$/;
    const propertySeparator = /\s+/;

    /** @type {import('css-style-applier').RawStyleData} */
    const rules = [];

    // Default stylesheet
    for (const rule of stylesheet1.rules) {
        if (rule.type !== 'rule') { continue; }
        const {selectors, declarations} = /** @type {css.Rule} */ (rule);
        if (typeof selectors === 'undefined') { continue; }
        /** @type {import('css-style-applier').RawStyleDataStyleArray} */
        const styles = [];
        if (typeof declarations !== 'undefined') {
            for (const declaration of declarations) {
                if (declaration.type !== 'declaration') { console.log(declaration); continue; }
                const {property, value} = /** @type {css.Declaration} */ (declaration);
                if (typeof property !== 'string' || typeof value !== 'string') { continue; }
                styles.push([property, value]);
            }
        }
        if (styles.length > 0) {
            rules.push({selectors, styles});
        }
    }

    // Overrides
    for (const rule of stylesheet2.rules) {
        if (rule.type !== 'rule') { continue; }
        const {selectors, declarations} = /** @type {css.Rule} */ (rule);
        if (typeof selectors === 'undefined' || typeof declarations === 'undefined') { continue; }
        /** @type {Map<string, number>} */
        const removedProperties = new Map();
        for (const declaration of declarations) {
            switch (declaration.type) {
                case 'declaration':
                    {
                        const index = indexOfRule(rules, selectors);
                        let entry;
                        if (index >= 0) {
                            entry = rules[index];
                        } else {
                            entry = {selectors, styles: []};
                            rules.push(entry);
                        }
                        const {property, value} = /** @type {css.Declaration} */ (declaration);
                        if (typeof property === 'string' && typeof value === 'string') {
                            removeProperty(entry.styles, property, removedProperties);
                            entry.styles.push([property, value]);
                        }
                    }
                    break;
                case 'comment':
                    {
                        const index = indexOfRule(rules, selectors);
                        if (index < 0) { throw new Error('Could not find rule with matching selectors'); }
                        const comment = (/** @type {css.Comment} */ (declaration).comment || '').trim();
                        let m;
                        if ((m = removePropertyPattern.exec(comment)) !== null) {
                            for (const property of m[1].split(propertySeparator)) {
                                const removeCount = removeProperty(rules[index].styles, property, removedProperties);
                                if (removeCount === 0) { throw new Error(`Property removal is unnecessary; ${property} does not exist`); }
                            }
                        } else if (removeRulePattern.test(comment)) {
                            rules.splice(index, 1);
                        }
                    }
                    break;
            }
        }
    }

    // Remove empty
    for (let i = 0, ii = rules.length; i < ii; ++i) {
        if (rules[i].styles.length > 0) { continue; }
        rules.splice(i, 1);
        --i;
        --ii;
    }

    return rules;
}