source: icGREP/icgrep-devel/icgrep/UCD/ucd_compiler.cpp @ 4627

Last change on this file since 4627 was 4627, checked in by nmedfort, 4 years ago

Temporary check-in.

File size: 19.9 KB
Line 
1#include "ucd_compiler.hpp"
2#include <cc/cc_compiler.h>
3#include <UCD/unicode_set.h>
4#include <utf8_encoder.h>
5#include <iostream>
6
7using namespace cc;
8using namespace re;
9using namespace pablo;
10
11namespace UCD {
12
13/** ------------------------------------------------------------------------------------------------------------- *
14 * @brief generateWithDefaultIfHierarchy
15 * @param set the unicode set to generate
16 * @param the entry block to the function we're filling
17 * @return the output stream with a 1-bit in any position of a character in the unicode set
18 ** ------------------------------------------------------------------------------------------------------------- */
19PabloAST * UCDCompiler::generateWithIfHierarchy(const RangeList & ifRanges, const UnicodeSet & set, PabloBuilder & entry) {
20    return generateWithIfHierarchy(ifRanges, set, 0, CC::UNICODE_MAX, entry);
21}
22
23/** ------------------------------------------------------------------------------------------------------------- *
24 * @brief generateCharClassDefsInIfHierarchy
25 * @param ifRangeList
26 ** ------------------------------------------------------------------------------------------------------------- */
27PabloAST * UCDCompiler::generateWithIfHierarchy(const RangeList & ifRanges, const UnicodeSet & set, const codepoint_t lo, const codepoint_t hi, PabloBuilder & block) {
28
29    PabloAST * target = block.createZeroes();
30    // Codepoints in unenclosed ranges will be computed unconditionally.
31    // Generate them first so that computed subexpressions may be shared
32    // with calculations within the if hierarchy.
33
34    const auto enclosed = rangeIntersect(ifRanges, lo, hi);
35
36    for (const auto rg : rangeGaps(enclosed, lo, hi)) {
37        target = generateSubRanges(set, lo_codepoint(rg), hi_codepoint(rg), block, target);
38    }
39
40    const auto outer = outerRanges(enclosed);
41    const auto inner = innerRanges(enclosed);
42
43    for (const auto range : outer) {
44        codepoint_t lo, hi;
45        std::tie(lo, hi) = range;
46        if (rangeIntersect(set, lo, hi).empty()) {
47            continue;
48        }
49        PabloBuilder inner_block = PabloBuilder::Create(block);
50        PabloAST * inner_target = generateWithIfHierarchy(inner, set, lo, hi, inner_block);
51        // If this range is empty, just skip creating the if block
52        if (LLVM_UNLIKELY(isa<Zeroes>(inner_target))) {
53            continue;
54        }
55        Assign * matches = inner_block.createAssign("m", inner_target);
56        block.createIf(ifTestCompiler(lo, hi, block), {matches}, inner_block);
57        target = block.createOr(target, matches);
58    }
59
60    return target;
61}
62
63/** ------------------------------------------------------------------------------------------------------------- *
64 * @brief generateCharClassSubDefs
65 * @param ifRangeList
66 ** ------------------------------------------------------------------------------------------------------------- */
67PabloAST * UCDCompiler::generateSubRanges(const UnicodeSet & set, const codepoint_t lo, const codepoint_t hi, PabloBuilder & block, PabloAST * target) {
68    const auto range = rangeIntersect(set, lo, hi);
69    // Divide by UTF-8 length, separating out E0, ED, F0 and F4 ranges
70    const std::array<interval_t, 9> ranges =
71        {{{0, 0x7F}, {0x80, 0x7FF}, {0x800, 0xFFF}, {0x1000, 0xD7FF}, {0xD800, 0xDFFF},
72         {0xE000, 0xFFFF}, {0x10000, 0x3FFFF}, {0x40000, 0xFFFFF}, {0x100000, 0x10FFFF}}};
73    for (auto r : ranges) {
74        const auto subrange = rangeIntersect(range, lo_codepoint(r), hi_codepoint(r));
75        target = sequenceGenerator(std::move(subrange), 1, block, target, nullptr);
76    }
77    return target;
78}
79
80/** ------------------------------------------------------------------------------------------------------------- *
81 * @brief sequenceGenerator
82 * @param ifRangeList
83 *
84 *
85 * Generate remaining code to match UTF-8 code sequences within the codepoint set cpset, assuming that the code
86 * matching the sequences up to byte number byte_no have been generated.
87 ** ------------------------------------------------------------------------------------------------------------- */
88PabloAST * UCDCompiler::sequenceGenerator(const RangeList && ranges, const unsigned byte_no, PabloBuilder & block, PabloAST * target, PabloAST * prefix) {
89
90    if (LLVM_LIKELY(!ranges.empty())) {
91
92        codepoint_t lo, hi;
93        std::tie(lo, hi) = ranges[0];
94
95        const auto min = UTF8_Encoder::length(lo_codepoint(ranges.front()));
96        const auto max = UTF8_Encoder::length(hi_codepoint(ranges.back()));
97
98        if (min != max) {
99            const auto mid = UTF8_Encoder::maxCodePoint(min);
100            target = sequenceGenerator(std::move(rangeIntersect(ranges, lo, mid)), byte_no, block, target, prefix);
101            target = sequenceGenerator(std::move(rangeIntersect(ranges, mid + 1, hi)), byte_no, block, target, prefix);
102        }
103        else if (min == byte_no) {
104            // We have a single byte remaining to match for all code points in this CC.
105            // Use the byte class compiler to generate matches for these codepoints.
106            const auto bytes = byteDefinitions(ranges, byte_no);
107            PabloAST * testVar = mCharacterClassCompiler.compileCC(makeCC(bytes), block);
108            if (byte_no > 1) {
109                testVar = block.createAnd(testVar, block.createAdvance(makePrefix(lo, byte_no, block, prefix), 1));
110            }
111            target = block.createOr(target, testVar);
112        }
113        else {
114            for (auto rg : ranges) {
115                codepoint_t lo, hi;
116                std::tie(lo, hi) = rg;
117                const auto lo_byte = UTF8_Encoder::encodingByte(lo, byte_no);
118                const auto hi_byte = UTF8_Encoder::encodingByte(hi, byte_no);
119                if (lo_byte != hi_byte) {
120                    if (!UTF8_Encoder::isLowCodePointAfterByte(lo, byte_no)) {
121                        const codepoint_t mid = lo | ((1 << (6 * (min - byte_no))) - 1);
122                        target = sequenceGenerator(lo, mid, byte_no, block, target, prefix);
123                        target = sequenceGenerator(mid + 1, hi, byte_no, block, target, prefix);
124                    }
125                    else if (!UTF8_Encoder::isHighCodePointAfterByte(hi, byte_no)) {
126                        const codepoint_t mid = hi & ~((1 << (6 * (min - byte_no))) - 1);
127                        target = sequenceGenerator(lo, mid - 1, byte_no, block, target, prefix);
128                        target = sequenceGenerator(mid, hi, byte_no, block, target, prefix);
129                    }
130                    else { // we have a prefix group of type (a)
131                        PabloAST * byteVar = mCharacterClassCompiler.compileCC(makeCC(lo_byte, hi_byte), block);
132                        PabloAST * infix = byteVar;
133                        if (byte_no > 1) {
134                            infix = block.createAnd(block.createAdvance(prefix, 1), byteVar);
135                        }
136                        PabloAST * suffixVar = mCharacterClassCompiler.compileCC(mSuffix, block);
137                        for (auto i = byte_no; i < UTF8_Encoder::length(lo); ++i) {
138                            infix = block.createAnd(suffixVar, block.createAdvance(infix, 1));
139                        }
140                        target = block.createOr(target, infix);
141                    }
142                }
143                else { // lbyte == hbyte
144                    PabloAST * byteVar = mCharacterClassCompiler.compileCC(makeCC(lo_byte, hi_byte), block);
145                    PabloAST * infix = byteVar;
146                    if (byte_no > 1) {
147                        infix = block.createAnd(block.createAdvance(prefix ? prefix : byteVar, 1), byteVar);
148                    }
149                    if (byte_no < UTF8_Encoder::length(lo)) {
150                        target = sequenceGenerator(lo, hi, byte_no + 1, block, target, infix);
151                    }
152                }
153            }
154        }
155    }
156
157    return target;
158}
159
160/** ------------------------------------------------------------------------------------------------------------- *
161 * @brief sequenceGenerator
162 ** ------------------------------------------------------------------------------------------------------------- */
163inline PabloAST * UCDCompiler::sequenceGenerator(const codepoint_t lo, const codepoint_t hi, const unsigned byte_no, PabloBuilder & block, PabloAST * target, PabloAST * prefix) {
164    return sequenceGenerator({{ lo, hi }}, byte_no, block, target, prefix);
165}
166
167/** ------------------------------------------------------------------------------------------------------------- *
168 * @brief ifTestCompiler
169 ** ------------------------------------------------------------------------------------------------------------- */
170inline PabloAST * UCDCompiler::ifTestCompiler(const codepoint_t lo, const codepoint_t hi, PabloBuilder & block) {
171    return ifTestCompiler(lo, hi, 1, block, block.createOnes());
172}
173
174/** ------------------------------------------------------------------------------------------------------------- *
175 * @brief ifTestCompiler
176 ** ------------------------------------------------------------------------------------------------------------- */
177PabloAST * UCDCompiler::ifTestCompiler(const codepoint_t lo, const codepoint_t hi, const unsigned byte_no, PabloBuilder & block, PabloAST * target) {
178
179    codepoint_t lo_byte = UTF8_Encoder::encodingByte(lo, byte_no);
180    codepoint_t hi_byte = UTF8_Encoder::encodingByte(hi, byte_no);
181    const bool at_lo_boundary = (lo == 0 || UTF8_Encoder::encodingByte(lo - 1, byte_no) != lo_byte);
182    const bool at_hi_boundary = (hi == 0x10FFFF || UTF8_Encoder::encodingByte(hi + 1, byte_no) != hi_byte);
183
184    if (at_lo_boundary && at_hi_boundary) {
185        if (lo_byte != hi_byte) {
186            if (lo == 0x80) lo_byte = 0xC0;
187            if (hi == 0x10FFFF) hi_byte = 0xFF;
188        }
189        PabloAST * cc = mCharacterClassCompiler.compileCC(makeCC(lo_byte, hi_byte), block);
190        target = block.createAnd(cc, target);
191    }
192    else if (lo_byte == hi_byte) {
193        PabloAST * cc = mCharacterClassCompiler.compileCC(makeCC(lo_byte, hi_byte), block);
194        target = block.createAnd(cc, target);
195        target = block.createAdvance(target, 1);
196        target = ifTestCompiler(lo, hi, byte_no + 1, block, target);
197    }
198    else if (!at_hi_boundary) {
199        const auto mid = UTF8_Encoder::minCodePointWithCommonBytes(hi, byte_no);
200        PabloAST * e1 = ifTestCompiler(lo, mid - 1, byte_no, block, target);
201        PabloAST * e2 = ifTestCompiler(mid, hi, byte_no, block, target);
202        target = block.createOr(e1, e2);
203    }
204    else {
205        const auto mid = UTF8_Encoder::maxCodePointWithCommonBytes(lo, byte_no);
206        PabloAST * e1 = ifTestCompiler(lo, mid, byte_no, block, target);
207        PabloAST * e2 = ifTestCompiler(mid + 1, hi, byte_no, block, target);
208        target = block.createOr(e1, e2);
209    }
210    return target;
211}
212
213/** ------------------------------------------------------------------------------------------------------------- *
214 * @brief definePrecedingPrefix
215 * @param ifRangeList
216 *
217 *
218 * Ensure the sequence of preceding bytes is defined, up to, but not including the given byte_no
219 ** ------------------------------------------------------------------------------------------------------------- */
220PabloAST * UCDCompiler::makePrefix(const codepoint_t cp, const unsigned byte_no, PabloBuilder & pb, PabloAST * prefix) {
221    assert (byte_no >= 1 && byte_no <= 4);
222    assert (byte_no == 1 || prefix != nullptr);
223    for (unsigned i = 1; i != byte_no; ++i) {
224        const CC * const cc = makeCC(UTF8_Encoder::encodingByte(cp, i));
225        PabloAST * var = mCharacterClassCompiler.compileCC(cc, pb);
226        if (i > 1) {
227            var = pb.createAnd(var, pb.createAdvance(prefix, 1));
228        }
229        prefix = var;
230    }
231    return prefix;
232}
233
234/** ------------------------------------------------------------------------------------------------------------- *
235 * @brief definePrecedingPrefix
236 * @param ifRangeList
237 *
238 *
239 * Ensure the sequence of preceding bytes is defined, up to, but not including the given byte_no
240 ** ------------------------------------------------------------------------------------------------------------- */
241UCDCompiler::RangeList UCDCompiler::byteDefinitions(const RangeList & list, const unsigned byte_no) {
242    RangeList result;
243    result.reserve(list.size());
244    for (const auto & i : list) {
245        result.emplace_back(UTF8_Encoder::encodingByte(lo_codepoint(i), byte_no), UTF8_Encoder::encodingByte(hi_codepoint(i), byte_no));
246    }
247    return result;
248}
249
250/** ------------------------------------------------------------------------------------------------------------- *
251 * @brief rangeIntersect
252 * @param list
253 * @param lo
254 * @param hi
255 ** ------------------------------------------------------------------------------------------------------------- */
256template <typename RangeListOrUnicodeSet>
257UCDCompiler::RangeList UCDCompiler::rangeIntersect(const RangeListOrUnicodeSet & list, const codepoint_t lo, const codepoint_t hi) {
258    RangeList result;
259    for (const auto i : list) {
260        if ((lo_codepoint(i) <= hi) && (hi_codepoint(i) >= lo)) {
261            result.emplace_back(std::max(lo, lo_codepoint(i)), std::min(hi, hi_codepoint(i)));
262        }
263    }
264    return result;
265}
266
267/** ------------------------------------------------------------------------------------------------------------- *
268 * @brief rangeGaps
269 * @param cc
270 * @param lo
271 * @param hi
272 ** ------------------------------------------------------------------------------------------------------------- */
273UCDCompiler::RangeList UCDCompiler::rangeGaps(const RangeList & list, const codepoint_t lo, const codepoint_t hi) {
274    RangeList gaps;
275    if (LLVM_LIKELY(lo < hi)) {
276        if (LLVM_UNLIKELY(list.empty())) {
277            gaps.emplace_back(lo, hi);
278        }
279        else {
280            codepoint_t cp = lo;
281            for (const auto & i : list) {
282                if (hi_codepoint(i) < cp) {
283                    continue;
284                }
285                else if (lo_codepoint(i) > cp) {
286                    gaps.emplace_back(cp, lo_codepoint(i) - 1);
287                }
288                else if (hi_codepoint(i) >= hi) {
289                    continue;
290                }
291                cp = hi_codepoint(i) + 1;
292            }
293        }
294    }
295    return gaps;
296}
297
298/** ------------------------------------------------------------------------------------------------------------- *
299 * @brief outerRanges
300 * @param list
301 ** ------------------------------------------------------------------------------------------------------------- */
302UCDCompiler::RangeList UCDCompiler::outerRanges(const RangeList & list) {
303    RangeList ranges;
304    if (LLVM_LIKELY(list.size() > 0)) {
305        auto i = list.cbegin();
306        for (auto j = i + 1; j != list.cend(); ++j) {
307            if (hi_codepoint(*j) > hi_codepoint(*i)) {
308                ranges.emplace_back(lo_codepoint(*i), hi_codepoint(*i));
309                i = j;
310            }
311        }
312        if (LLVM_LIKELY(i != list.end())) {
313            ranges.emplace_back(lo_codepoint(*i), hi_codepoint(*i));
314        }
315    }
316    return ranges;
317}
318
319/** ------------------------------------------------------------------------------------------------------------- *
320 * @brief innerRanges
321 * @param list
322 ** ------------------------------------------------------------------------------------------------------------- */
323UCDCompiler::RangeList UCDCompiler::innerRanges(const RangeList & list) {
324    RangeList ranges;
325    if (LLVM_LIKELY(list.size() > 0)) {
326        for (auto i = list.cbegin(), j = i + 1; j != list.cend(); ++j) {
327            if (hi_codepoint(*j) <= hi_codepoint(*i)) {
328                ranges.emplace_back(lo_codepoint(*j), hi_codepoint(*j));
329            }
330            else {
331                i = j;
332            }
333        }
334    }
335    return ranges;
336}
337
338/** ------------------------------------------------------------------------------------------------------------- *
339 * @brief generateWithDefaultIfHierarchy
340 * @param set the unicode set to generate
341 * @param the entry block to the function we're filling
342 * @return the output stream with a 1-bit in any position of a character in the unicode set
343 ** ------------------------------------------------------------------------------------------------------------- */
344PabloAST * UCDCompiler::generateWithDefaultIfHierarchy(const UnicodeSet & set, PabloBuilder & entry) {
345
346    const RangeList defaultIfHierachy = {
347        // Non-ASCII
348        {0x80, 0x10FFFF},
349        // Two-byte sequences
350        {0x80, 0x7FF},
351        {0x100, 0x3FF},
352        // 0100..017F; Latin Extended-A
353        // 0180..024F; Latin Extended-B
354        // 0250..02AF; IPA Extensions
355        // 02B0..02FF; Spacing Modifier Letters
356        {0x100, 0x2FF}, {0x100, 0x24F}, {0x100, 0x17F}, {0x180, 0x24F}, {0x250, 0x2AF}, {0x2B0, 0x2FF},
357        // 0300..036F; Combining Diacritical Marks
358        // 0370..03FF; Greek and Coptic
359        {0x300, 0x36F}, {0x370, 0x3FF},
360        // 0400..04FF; Cyrillic
361        // 0500..052F; Cyrillic Supplement
362        // 0530..058F; Armenian
363        // 0590..05FF; Hebrew
364        // 0600..06FF; Arabic
365        {0x400, 0x5FF}, {0x400, 0x4FF}, {0x500, 0x058F}, {0x500, 0x52F}, {0x530, 0x58F}, {0x590, 0x5FF}, {0x600, 0x6FF},
366        // 0700..074F; Syriac
367        // 0750..077F; Arabic Supplement
368        // 0780..07BF; Thaana
369        // 07C0..07FF; NKo
370        {0x700, 0x77F}, {0x700, 0x74F}, {0x750, 0x77F}, {0x780, 0x7FF}, {0x780, 0x7BF}, {0x7C0, 0x7FF},
371        // Three-byte sequences
372        {0x800, 0xFFFF}, {0x800, 0x4DFF}, {0x800, 0x1FFF}, {0x800, 0x0FFF},
373        // 0800..083F; Samaritan
374        // 0840..085F; Mandaic
375        // 08A0..08FF; Arabic Extended-A
376        // 0900..097F; Devanagari
377        // 0980..09FF; Bengali
378        // 0A00..0A7F; Gurmukhi
379        // 0A80..0AFF; Gujarati
380        // 0B00..0B7F; Oriya
381        // 0B80..0BFF; Tamil
382        // 0C00..0C7F; Telugu
383        // 0C80..0CFF; Kannada
384        // 0D00..0D7F; Malayalam
385        // 0D80..0DFF; Sinhala
386        // 0E00..0E7F; Thai
387        // 0E80..0EFF; Lao
388        // 0F00..0FFF; Tibetan
389        {0x1000, 0x1FFF},
390        // 1000..109F; Myanmar
391        // 10A0..10FF; Georgian
392        // 1100..11FF; Hangul Jamo
393        // 1200..137F; Ethiopic
394        // 1380..139F; Ethiopic Supplement
395        // 13A0..13FF; Cherokee
396        // 1400..167F; Unified Canadian Aboriginal Syllabics
397        // 1680..169F; Ogham
398        // 16A0..16FF; Runic
399        // 1700..171F; Tagalog
400        // 1720..173F; Hanunoo
401        // 1740..175F; Buhid
402        // 1760..177F; Tagbanwa
403        // 1780..17FF; Khmer
404        // 1800..18AF; Mongolian
405        // 18B0..18FF; Unified Canadian Aboriginal Syllabics Extended
406        // 1900..194F; Limbu
407        // 1950..197F; Tai Le
408        // 1980..19DF; New Tai Lue
409        // 19E0..19FF; Khmer Symbols
410        // 1A00..1A1F; Buginese
411        // 1A20..1AAF; Tai Tham
412        // 1AB0..1AFF; Combining Diacritical Marks Extended
413        // 1B00..1B7F; Balinese
414        // 1B80..1BBF; Sundanese
415        // 1BC0..1BFF; Batak
416        // 1C00..1C4F; Lepcha
417        // 1C50..1C7F; Ol Chiki
418        // 1CC0..1CCF; Sundanese Supplement
419        // 1CD0..1CFF; Vedic Extensions
420        // 1D00..1D7F; Phonetic Extensions
421        // 1D80..1DBF; Phonetic Extensions Supplement
422        // 1DC0..1DFF; Combining Diacritical Marks Supplement
423        // 1E00..1EFF; Latin Extended Additional
424        // 1F00..1FFF; Greek Extended
425        {0x2000, 0x4DFF}, {0x2000, 0x2FFF},
426        {0x3000, 0x4DFF},
427        {0x4E00, 0x9FFF},
428        // 4E00..9FFF; CJK Unified Ideographs
429        {0xA000, 0xFFFF},
430
431        {0x10000, 0x10FFFF}};
432
433//    llvm::raw_os_ostream out(std::cerr);
434
435//    for (auto range : set) {
436//        out << range.first << ',' << range.second << "\n";
437//    }
438
439//    out.flush();
440
441    return generateWithIfHierarchy(defaultIfHierachy, set, entry);
442}
443
444/** ------------------------------------------------------------------------------------------------------------- *
445 * @brief constructor
446 ** ------------------------------------------------------------------------------------------------------------- */
447UCDCompiler::UCDCompiler(cc::CC_Compiler & ccCompiler)
448: mCharacterClassCompiler(ccCompiler)
449, mSuffix(makeCC(0x80, 0xBF)) { }
450
451}
Note: See TracBrowser for help on using the repository browser.