source: icGREP/icgrep-devel/icgrep/re/re_compiler.cpp @ 5042

Last change on this file since 5042 was 5042, checked in by cameron, 3 years ago

Add pablo.atEOF; clean out bit4/6 hack for unterminated final lines in icgrep.

File size: 35.4 KB
Line 
1/*
2 *  Copyright (c) 2014 International Characters.
3 *  This software is licensed to the public under the Open Software License 3.0.
4 *  icgrep is a trademark of International Characters.
5 */
6#include <re/re_compiler.h>
7#include <re/re_toolchain.h>
8//Regular Expressions
9#include <re/re_name.h>
10#include <re/re_any.h>
11#include <re/re_start.h>
12#include <re/re_end.h>
13#include <re/re_alt.h>
14#include <re/re_cc.h>
15#include <re/re_seq.h>
16#include <re/re_rep.h>
17#include <re/re_diff.h>
18#include <re/re_intersect.h>
19#include <re/re_assertion.h>
20#include <re/re_grapheme_boundary.hpp>
21#include <re/re_analysis.h>
22#include <re/re_memoizer.hpp>
23#include <re/printer_re.h>
24#include <pablo/codegenstate.h>
25#include <UCD/ucd_compiler.hpp>
26#include <UCD/resolve_properties.h>
27#ifndef DISABLE_PREGENERATED_UCD_FUNCTIONS
28#include <UCD/precompiled_properties.h>
29#endif
30#include <assert.h>
31#include <stdexcept>
32#include <iostream>
33#include <pablo/printer_pablos.h>
34#include "llvm/Support/CommandLine.h"
35#include <sstream>
36#include <unordered_set>
37
38
39#define UNICODE_LINE_BREAK (!AlgorithmOptionIsSet(DisableUnicodeLineBreak))
40
41using namespace pablo;
42
43namespace re {
44
45void RE_Compiler::initializeRequiredStreams() {
46
47    Assign * LF = mPB.createAssign("LF", mCCCompiler.compileCC(makeCC(0x0A)));
48    PabloAST * CR = mCCCompiler.compileCC(makeCC(0x0D));
49    PabloAST * LF_VT_FF_CR = mCCCompiler.compileCC(makeCC(0x0A, 0x0D));
50
51    PabloBuilder crb = PabloBuilder::Create(mPB);
52    PabloAST * cr1 = crb.createAdvance(CR, 1, "cr1");
53    Assign * acrlf = crb.createAssign("crlf", crb.createAnd(cr1, LF));
54    mPB.createIf(CR, {acrlf}, crb);
55    mCRLF = acrlf;
56
57    PabloAST * u8pfx = mCCCompiler.compileCC(makeCC(0xC0, 0xFF));
58    PabloBuilder it = PabloBuilder::Create(mPB);
59    PabloAST * u8pfx2 = mCCCompiler.compileCC(makeCC(0xC2, 0xDF), it);
60    PabloAST * u8pfx3 = mCCCompiler.compileCC(makeCC(0xE0, 0xEF), it);
61    PabloAST * u8pfx4 = mCCCompiler.compileCC(makeCC(0xF0, 0xF4), it);
62    Assign * u8suffix = it.createAssign("u8suffix", mCCCompiler.compileCC(makeCC(0x80, 0xBF)));
63
64    //
65    // Two-byte sequences
66    PabloBuilder it2 = PabloBuilder::Create(it);
67    Assign * u8scope22 = it2.createAssign("u8scope22", it2.createAdvance(u8pfx2, 1));
68    Assign * NEL = it2.createAssign("NEL", it2.createAnd(it2.createAdvance(mCCCompiler.compileCC(makeCC(0xC2), it2), 1), mCCCompiler.compileCC(makeCC(0x85), it2)));
69    it.createIf(u8pfx2, {u8scope22, NEL}, it2);
70
71    //
72    // Three-byte sequences
73    PabloBuilder it3 = PabloBuilder::Create(it);
74    Assign * u8scope32 = it3.createAssign("u8scope32", it3.createAdvance(u8pfx3, 1));
75    PabloAST * u8scope33 = it3.createAdvance(u8pfx3, 2);
76    Assign * u8scope3X = it3.createAssign("u8scope3X", it3.createOr(u8scope32, u8scope33));
77    PabloAST * E2_80 = it3.createAnd(it3.createAdvance(mCCCompiler.compileCC(makeCC(0xE2), it3), 1), mCCCompiler.compileCC(makeCC(0x80), it3));
78    Assign * LS_PS = it3.createAssign("LS_PS", it3.createAnd(it3.createAdvance(E2_80, 1), mCCCompiler.compileCC(makeCC(0xA8,0xA9), it3)));
79    PabloAST * E0_invalid = it3.createAnd(it3.createAdvance(mCCCompiler.compileCC(makeCC(0xE0), it3), 1), mCCCompiler.compileCC(makeCC(0x80, 0x9F), it3));
80    PabloAST * ED_invalid = it3.createAnd(it3.createAdvance(mCCCompiler.compileCC(makeCC(0xED), it3), 1), mCCCompiler.compileCC(makeCC(0xA0, 0xBF), it3));
81    Assign * EX_invalid = it3.createAssign("EX_invalid", it3.createOr(E0_invalid, ED_invalid));
82    it.createIf(u8pfx3, {u8scope32, u8scope3X, LS_PS, EX_invalid}, it3);
83
84    //
85    // Four-byte sequences
86    PabloBuilder it4 = PabloBuilder::Create(it);
87    PabloAST * u8scope42 = it4.createAdvance(u8pfx4, 1, "u8scope42");
88    PabloAST * u8scope43 = it4.createAdvance(u8scope42, 1, "u8scope43");
89    PabloAST * u8scope44 = it4.createAdvance(u8scope43, 1, "u8scope44");
90    Assign * u8scope4nonfinal = it4.createAssign("u8scope4nonfinal", it4.createOr(u8scope42, u8scope43));
91    Assign * u8scope4X = it4.createAssign("u8scope4X", it4.createOr(u8scope4nonfinal, u8scope44));
92    PabloAST * F0_invalid = it4.createAnd(it4.createAdvance(mCCCompiler.compileCC(makeCC(0xF0), it4), 1), mCCCompiler.compileCC(makeCC(0x80, 0x8F), it4));
93    PabloAST * F4_invalid = it4.createAnd(it4.createAdvance(mCCCompiler.compileCC(makeCC(0xF4), it4), 1), mCCCompiler.compileCC(makeCC(0x90, 0xBF), it4));
94    Assign * FX_invalid = it4.createAssign("FX_invalid", it4.createOr(F0_invalid, F4_invalid));
95    it.createIf(u8pfx4, {u8scope4nonfinal, u8scope4X, FX_invalid}, it4);
96
97    //
98    // Invalid cases
99    PabloAST * anyscope = it.createOr(u8scope22, it.createOr(u8scope3X, u8scope4X));
100    PabloAST * legalpfx = it.createOr(it.createOr(u8pfx2, u8pfx3), u8pfx4);
101    //  Any scope that does not have a suffix byte, and any suffix byte that is not in
102    //  a scope is a mismatch, i.e., invalid UTF-8.
103    PabloAST * mismatch = it.createXor(anyscope, u8suffix);
104    //
105    PabloAST * EF_invalid = it.createOr(EX_invalid, FX_invalid);
106    PabloAST * pfx_invalid = it.createXor(u8pfx, legalpfx);
107    Assign * u8invalid = it.createAssign("u8invalid", it.createOr(pfx_invalid, it.createOr(mismatch, EF_invalid)));
108    Assign * u8valid = it.createAssign("u8valid", it.createNot(u8invalid));
109    //
110    //
111
112    Assign * valid_pfx = it.createAssign("valid_pfx", it.createAnd(u8pfx, u8valid));
113    mNonFinal = it.createAssign("nonfinal", it.createAnd(it.createOr(it.createOr(u8pfx, u8scope32), u8scope4nonfinal), u8valid));
114
115    Assign * NEL_LS_PS = it.createAssign("NEL_LS_PS", it.createOr(NEL, LS_PS));
116    mPB.createIf(u8pfx, {u8invalid, valid_pfx, mNonFinal, NEL_LS_PS}, it);
117
118    PabloAST * LB_chars = mPB.createOr(LF_VT_FF_CR, NEL_LS_PS);
119    PabloAST * u8single = mPB.createAnd(mCCCompiler.compileCC(makeCC(0x00, 0x7F)), mPB.createNot(u8invalid));
120    mInitial = mPB.createOr(u8single, valid_pfx, "initial");
121    mFinal = mPB.createNot(mPB.createOr(mNonFinal, u8invalid), "final");
122    PabloAST * UnicodeLineBreak = mPB.createAnd(LB_chars, mPB.createNot(mCRLF));  // count the CR, but not CRLF
123    PabloAST * lb = UNICODE_LINE_BREAK ? UnicodeLineBreak : LF;
124    PabloAST * unterminatedLineAtEOF = mPB.createAtEOF(mPB.createAdvance(mPB.createNot(LB_chars), 1));
125    mLineBreak = mPB.createOr(lb, unterminatedLineAtEOF);
126    mAny = mPB.createNot(lb, "any");
127    mFunction.setResult(1, mPB.createAssign("lf", mLineBreak));
128}
129
130static inline CC * getDefinitionIfCC(RE * re) {
131    if (LLVM_LIKELY(isa<Name>(re))) {
132        Name * name = cast<Name>(re);
133        if (name->getDefinition() && isa<CC>(name->getDefinition())) {
134            return cast<CC>(name->getDefinition());
135        }
136    }
137    return nullptr;
138}
139
140RE * RE_Compiler::resolveUnicodeProperties(RE * re) {
141
142    Memoizer memoizer;
143    Name * graphemeClusterRule = nullptr;
144
145    std::function<RE*(RE*)> resolve = [&](RE * re) -> RE * {
146        if (Name * name = dyn_cast<Name>(re)) {
147            auto f = memoizer.find(name);
148            if (f == memoizer.end()) {
149                if (LLVM_LIKELY(name->getDefinition() != nullptr)) {
150                    name->setDefinition(resolve(name->getDefinition()));
151                } else if (LLVM_LIKELY(name->getType() == Name::Type::UnicodeProperty)) {
152                    if (UCD::resolvePropertyDefinition(name)) {
153                        resolve(name->getDefinition());
154                    } else {
155                        #ifndef DISABLE_PREGENERATED_UCD_FUNCTIONS
156                        if (AlgorithmOptionIsSet(UsePregeneratedUnicode)) {
157                            const std::string functionName = UCD::resolvePropertyFunction(name);
158                            const UCD::ExternalProperty & ep = UCD::resolveExternalProperty(functionName);
159                            Call * call = mPB.createCall(Prototype::Create(functionName, std::get<1>(ep), std::get<2>(ep), std::get<0>(ep)), mCCCompiler.getBasisBits());
160                            name->setCompiled(call);
161                        } else {
162                        #endif
163                            name->setDefinition(makeCC(UCD::resolveUnicodeSet(name)));
164                        #ifndef DISABLE_PREGENERATED_UCD_FUNCTIONS
165                        }
166                        #endif
167                    }
168                } else {
169                    throw std::runtime_error("All non-unicode-property Name objects should have been defined prior to Unicode property resolution.");
170                }
171            } else {
172                return *f;
173            }
174        } else if (Seq * seq = dyn_cast<Seq>(re)) {
175            for (auto si = seq->begin(); si != seq->end(); ++si) {
176                *si = resolve(*si);
177            }
178        } else if (Alt * alt = dyn_cast<Alt>(re)) {
179            CC * unionCC = nullptr;
180            std::stringstream name;
181            for (auto ai = alt->begin(); ai != alt->end(); ) {
182                RE * re = resolve(*ai);
183                if (CC * cc = getDefinitionIfCC(re)) {
184                    if (unionCC == nullptr) {
185                        unionCC = cc;
186                    } else {
187                        unionCC = makeCC(unionCC, cc);
188                        name << '+';
189                    }
190                    Name * n = cast<Name>(re);
191                    if (n->hasNamespace()) {
192                        name << n->getNamespace() << ':';
193                    }
194                    name << n->getName();
195                    ai = alt->erase(ai);
196                } else {
197                    *ai++ = re;
198                }
199            }
200            if (unionCC) {
201                alt->push_back(makeName(name.str(), unionCC));
202            }
203            if (alt->size() == 1) {
204                return alt->front();
205            }
206        } else if (Rep * rep = dyn_cast<Rep>(re)) {
207            rep->setRE(resolve(rep->getRE()));
208        } else if (Assertion * a = dyn_cast<Assertion>(re)) {
209            a->setAsserted(resolve(a->getAsserted()));
210        } else if (Diff * diff = dyn_cast<Diff>(re)) {
211            diff->setLH(resolve(diff->getLH()));
212            diff->setRH(resolve(diff->getRH()));
213            CC * lh = getDefinitionIfCC(diff->getLH());
214            CC * rh = getDefinitionIfCC(diff->getRH());
215            if (lh && rh) {
216                return resolve(makeName("diff", subtractCC(lh, rh)));
217            }
218        } else if (Intersect * ix = dyn_cast<Intersect>(re)) {
219            ix->setLH(resolve(ix->getLH()));
220            ix->setRH(resolve(ix->getRH()));
221            CC * lh = getDefinitionIfCC(ix->getLH());
222            CC * rh = getDefinitionIfCC(ix->getRH());
223            if (lh && rh) {
224                return resolve(makeName("intersect", intersectCC(lh, rh)));
225            }
226        } else if (GraphemeBoundary * gb = dyn_cast<GraphemeBoundary>(re)) {
227            if (LLVM_LIKELY(gb->getBoundaryRule() == nullptr)) {
228                switch (gb->getType()) {
229                    case GraphemeBoundary::Type::ClusterBoundary:
230                        if (graphemeClusterRule == nullptr) {
231                            graphemeClusterRule = cast<Name>(resolve(generateGraphemeClusterBoundaryRule()));
232                        }
233                        gb->setBoundaryRule(graphemeClusterRule);
234                        break;
235                    default:
236                        throw std::runtime_error("Only grapheme cluster boundary rules are supported in icGrep 1.0");
237                }
238            }
239            if (gb->getExpression()) {
240                resolve(gb->getExpression());
241            }
242        }
243        return re;
244    };
245
246    UCD::UCDCompiler::NameMap nameMap;
247    std::unordered_set<Name *> visited;
248
249    std::function<void(RE*)> gather = [&](RE * re) {
250        assert ("RE object cannot be null!" && re);
251        if (isa<Name>(re)) {
252            if (visited.insert(cast<Name>(re)).second) {
253                if (isa<CC>(cast<Name>(re)->getDefinition())) {
254                    nameMap.emplace(cast<Name>(re), nullptr);
255                } else {
256                    gather(cast<Name>(re)->getDefinition());
257                }
258            }
259        } else if (isa<Seq>(re)) {
260            for (RE * item : *cast<Seq>(re)) {
261                gather(item);
262            }
263        } else if (isa<Alt>(re)) {
264            for (RE * item : *cast<Alt>(re)) {
265                gather(item);
266            }
267        } else if (isa<Rep>(re)) {
268            gather(cast<Rep>(re)->getRE());
269        } else if (isa<Assertion>(re)) {
270            gather(cast<Assertion>(re)->getAsserted());
271        } else if (isa<Diff>(re)) {
272            gather(cast<Diff>(re)->getLH());
273            gather(cast<Diff>(re)->getRH());
274        } else if (isa<Intersect>(re)) {
275            gather(cast<Intersect>(re)->getLH());
276            gather(cast<Intersect>(re)->getRH());
277        } else if (isa<GraphemeBoundary>(re)) {
278            if (cast<GraphemeBoundary>(re)->getExpression()) {
279                gather(cast<GraphemeBoundary>(re)->getExpression());
280            }
281            gather(cast<GraphemeBoundary>(re)->getBoundaryRule());
282        }
283    };
284
285    re = resolve(re);
286    gather(re);
287
288    if (LLVM_LIKELY(nameMap.size() > 0)) {
289        UCD::UCDCompiler ucdCompiler(mCCCompiler);
290        if (LLVM_UNLIKELY(AlgorithmOptionIsSet(DisableIfHierarchy))) {
291            ucdCompiler.generateWithoutIfHierarchy(nameMap, mPB);
292        } else {
293            ucdCompiler.generateWithDefaultIfHierarchy(nameMap, mPB);
294        }
295        for (auto t : nameMap) {
296            if (t.second) {
297                mCompiledName.insert(std::make_pair(t.first, makeMarker(MarkerPosition::FinalMatchByte, t.second)));
298            }
299        }
300    }
301
302    // Now precompile any grapheme segmentation rules
303    if (graphemeClusterRule) {
304        auto gcb = compileName(graphemeClusterRule, mPB);
305        mCompiledName.insert(std::make_pair(graphemeClusterRule, gcb));
306    }
307    return re;
308}
309
310void RE_Compiler::compileUnicodeNames(RE *& re) {
311    re = resolveUnicodeProperties(re);
312}
313
314Name * RE_Compiler::generateGraphemeClusterBoundaryRule() {
315    // 3.1.1 Grapheme Cluster Boundary Rules
316    #define Behind(x) makeLookBehindAssertion(x)
317    #define Ahead(x) makeLookAheadAssertion(x)
318
319    RE * GCB_Control = makeName("gcb", "cn", Name::Type::UnicodeProperty);
320    RE * GCB_CR = makeName("gcb", "cr", Name::Type::UnicodeProperty);
321    RE * GCB_LF = makeName("gcb", "lf", Name::Type::UnicodeProperty);
322    RE * GCB_Control_CR_LF = makeAlt({GCB_CR, GCB_LF, GCB_Control});
323
324    // Break at the start and end of text.
325    RE * GCB_1 = makeStart();
326    RE * GCB_2 = makeEnd();
327    // Do not break between a CR and LF.
328    RE * GCB_3 = makeSeq({Behind(GCB_CR), Ahead(GCB_LF)});
329    // Otherwise, break before and after controls.
330    RE * GCB_4 = Behind(GCB_Control_CR_LF);
331    RE * GCB_5 = Ahead(GCB_Control_CR_LF);
332    RE * GCB_1_5 = makeAlt({GCB_1, GCB_2, makeDiff(makeAlt({GCB_4, GCB_5}), GCB_3)});
333
334    RE * GCB_L = makeName("gcb", "l", Name::Type::UnicodeProperty);
335    RE * GCB_V = makeName("gcb", "v", Name::Type::UnicodeProperty);
336    RE * GCB_LV = makeName("gcb", "lv", Name::Type::UnicodeProperty);
337    RE * GCB_LVT = makeName("gcb", "lvt", Name::Type::UnicodeProperty);
338    RE * GCB_T = makeName("gcb", "t", Name::Type::UnicodeProperty);
339    RE * GCB_RI = makeName("gcb", "ri", Name::Type::UnicodeProperty);
340    // Do not break Hangul syllable sequences.
341    RE * GCB_6 = makeSeq({Behind(GCB_L), Ahead(makeAlt({GCB_L, GCB_V, GCB_LV, GCB_LVT}))});
342    RE * GCB_7 = makeSeq({Behind(makeAlt({GCB_LV, GCB_V})), Ahead(makeAlt({GCB_V, GCB_T}))});
343    RE * GCB_8 = makeSeq({Behind(makeAlt({GCB_LVT, GCB_T})), Ahead(GCB_T)});
344    // Do not break between regional indicator symbols.
345    RE * GCB_8a = makeSeq({Behind(GCB_RI), Ahead(GCB_RI)});
346    // Do not break before extending characters.
347    RE * GCB_9 = Ahead(makeName("gcb", "ex", Name::Type::UnicodeProperty));
348    // Do not break before SpacingMarks, or after Prepend characters.
349    RE * GCB_9a = Ahead(makeName("gcb", "sm", Name::Type::UnicodeProperty));
350    RE * GCB_9b = Behind(makeName("gcb", "pp", Name::Type::UnicodeProperty));
351    RE * GCB_6_9b = makeAlt({GCB_6, GCB_7, GCB_8, GCB_8a, GCB_9, GCB_9a, GCB_9b});
352    // Otherwise, break everywhere.
353    RE * GCB_10 = makeSeq({Behind(makeAny()), Ahead(makeAny())});
354
355    Name * gcb = makeName("gcb", Name::Type::UnicodeProperty);
356    gcb->setDefinition(makeAlt({GCB_1_5, makeDiff(GCB_10, GCB_6_9b)}));
357    return gcb;
358}
359
360void RE_Compiler::finalizeMatchResult(MarkerType match_result, bool InvertMatches) {
361    PabloAST * match_follow = mPB.createMatchStar(markerVar(match_result), mAny);
362    if (InvertMatches) {
363        match_follow = mPB.createNot(match_follow);
364    }
365    mFunction.setResult(0, mPB.createAssign("matches", mPB.createAnd(match_follow, mLineBreak)));
366}
367
368MarkerType RE_Compiler::compile(RE * re, PabloBuilder & pb) {
369    return process(re, makeMarker(MarkerPosition::FinalPostPositionByte, pb.createOnes()), pb);
370}
371
372MarkerType RE_Compiler::process(RE * re, MarkerType marker, PabloBuilder & pb) {
373    if (isa<Name>(re)) {
374        return compileName(cast<Name>(re), marker, pb);
375    } else if (isa<Seq>(re)) {
376        return compileSeq(cast<Seq>(re), marker, pb);
377    } else if (isa<Alt>(re)) {
378        return compileAlt(cast<Alt>(re), marker, pb);
379    } else if (isa<Rep>(re)) {
380        return compileRep(cast<Rep>(re), marker, pb);
381    } else if (isa<Assertion>(re)) {
382        return compileAssertion(cast<Assertion>(re), marker, pb);
383    } else if (isa<Any>(re)) {
384        return compileAny(marker, pb);
385    } else if (isa<Diff>(re)) {
386        return compileDiff(cast<Diff>(re), marker, pb);
387    } else if (isa<Intersect>(re)) {
388        return compileIntersect(cast<Intersect>(re), marker, pb);
389    } else if (isa<Start>(re)) {
390        return compileStart(marker, pb);
391    } else if (isa<End>(re)) {
392        return compileEnd(marker, pb);
393    } else if (isa<GraphemeBoundary>(re)) {
394        return compileGraphemeBoundary(cast<GraphemeBoundary>(re), marker, pb);
395    }
396    throw std::runtime_error("RE Compiler failed to process " + Printer_RE::PrintRE(re));
397}
398
399inline MarkerType RE_Compiler::compileAny(const MarkerType m, PabloBuilder & pb) {
400    PabloAST * nextFinalByte = markerVar(AdvanceMarker(m, MarkerPosition::FinalPostPositionByte, pb));
401    PabloAST * lb = mLineBreak;
402    if (UNICODE_LINE_BREAK) {
403        lb = pb.createOr(mLineBreak, mCRLF);
404    }
405    return makeMarker(MarkerPosition::FinalMatchByte, pb.createAnd(nextFinalByte, pb.createNot(lb), "dot"));
406}
407
408inline MarkerType RE_Compiler::compileName(Name * name, MarkerType marker, PabloBuilder & pb) {
409    MarkerType nameMarker = compileName(name, pb);
410    MarkerType nextPos;
411    if (markerPos(marker) == MarkerPosition::FinalPostPositionByte) {
412        nextPos = marker;
413    } else if (name->getType() == Name::Type::Byte) {
414        nextPos = AdvanceMarker(marker, MarkerPosition::InitialPostPositionByte, pb);
415    } else {
416        nextPos = AdvanceMarker(marker, MarkerPosition::FinalPostPositionByte, pb);
417    }
418    nameMarker.stream = pb.createAnd(markerVar(nextPos), markerVar(nameMarker), name->getName());
419    return nameMarker;
420}
421
422inline MarkerType RE_Compiler::compileName(Name * name, PabloBuilder & pb) {
423    auto f = mCompiledName.find(name);
424    if (LLVM_LIKELY(f != mCompiledName.end())) {
425        return f->second;
426    } else if (LLVM_LIKELY(name->getDefinition() != nullptr)) {
427        MarkerType m = compile(name->getDefinition(), pb);
428        mCompiledName.insert(std::make_pair(name, m));
429        return m;
430    }
431    throw std::runtime_error("Unresolved name " + name->getName());
432}
433
434MarkerType RE_Compiler::compileSeq(Seq * seq, MarkerType marker, PabloBuilder & pb) {
435    // if-hierarchies are not inserted within unbounded repetitions
436    if (mStarDepth > 0) {
437        for (RE * re : *seq) {
438            marker = process(re, marker, pb);
439        }
440        return marker;
441    } else {
442        return compileSeqTail(seq->begin(), seq->end(), 0, marker, pb);
443    }
444}
445
446MarkerType RE_Compiler::compileSeqTail(Seq::iterator current, Seq::iterator end, int matchLenSoFar, MarkerType marker, PabloBuilder & pb) {
447    if (current == end) return marker;
448    if (matchLenSoFar < IfInsertionGap) {
449        RE * r = *current;
450        marker = process(r, marker, pb);
451        current++;
452        return compileSeqTail(current, end, matchLenSoFar + minMatchLength(r), marker, pb);
453    } else {
454        PabloBuilder nested = PabloBuilder::Create(pb);
455        MarkerType m1 = compileSeqTail(current, end, 0, marker, nested);
456        Assign * m1a = nested.createAssign("m", markerVar(m1));
457        pb.createIf(markerVar(marker), {m1a}, nested);
458        return makeMarker(m1.pos, m1a);
459    }
460}
461
462MarkerType RE_Compiler::compileAlt(Alt * alt, MarkerType marker, PabloBuilder & pb) {
463    std::vector<PabloAST *>  accum = {pb.createZeroes(), pb.createZeroes(), pb.createZeroes()};
464    MarkerType const base = marker;
465    // The following may be useful to force a common Advance rather than separate
466    // Advances in each alternative.
467    // MarkerType const base = makeMarker(InitialPostPositionByte, postPositionVar(marker, pb), pb);
468    for (RE * re : *alt) {
469        MarkerType rslt = process(re, base, pb);
470        MarkerPosition p = markerPos(rslt);
471        accum[p] = pb.createOr(accum[p], markerVar(rslt), "alt");
472    }
473    if (isa<Zeroes>(accum[MarkerPosition::InitialPostPositionByte]) && isa<Zeroes>(accum[MarkerPosition::FinalPostPositionByte])) {
474        return makeMarker(MarkerPosition::FinalMatchByte, accum[MarkerPosition::FinalMatchByte]);
475    }
476    PabloAST * combine = pb.createOr(accum[InitialPostPositionByte], pb.createAdvance(accum[MarkerPosition::FinalMatchByte], 1), "alt");
477    if (isa<Zeroes>(accum[FinalPostPositionByte])) {
478        return makeMarker(InitialPostPositionByte, combine);
479    }
480    combine = pb.createOr(pb.createScanThru(pb.createAnd(mInitial, combine), mNonFinal), accum[MarkerPosition::FinalPostPositionByte], "alt");
481    return makeMarker(MarkerPosition::FinalPostPositionByte, combine);
482}
483
484MarkerType RE_Compiler::compileAssertion(Assertion * a, MarkerType marker, PabloBuilder & pb) {
485    RE * asserted = a->getAsserted();
486    if (a->getKind() == Assertion::Kind::Lookbehind) {
487        MarkerType lookback = compile(asserted, pb);
488        AlignMarkers(marker, lookback, pb);
489        PabloAST * lb = markerVar(lookback);
490        if (a->getSense() == Assertion::Sense::Negative) {
491            lb = pb.createNot(lb);
492        }
493        return makeMarker(markerPos(marker), pb.createAnd(markerVar(marker), lb, "lookback"));
494    } else if (isUnicodeUnitLength(asserted)) {
495        MarkerType lookahead = compile(asserted, pb);
496        if (LLVM_LIKELY(markerPos(lookahead) == MarkerPosition::FinalMatchByte)) {
497            PabloAST * la = markerVar(lookahead);
498            if (a->getSense() == Assertion::Sense::Negative) {
499                la = pb.createNot(la);
500            }
501            MarkerType fbyte = AdvanceMarker(marker, MarkerPosition::FinalPostPositionByte, pb);
502            return makeMarker(MarkerPosition::FinalPostPositionByte, pb.createAnd(markerVar(fbyte), la, "lookahead"));
503        }
504    }
505    throw std::runtime_error("Unsupported lookahead assertion.");
506}
507
508inline bool alignedUnicodeLength(const RE * lh, const RE * rh) {
509    const auto lhl = getUnicodeUnitLengthRange(lh);
510    const auto rhl = getUnicodeUnitLengthRange(rh);
511    return (lhl.first == lhl.second && lhl.first == rhl.first && lhl.second == rhl.second);
512}
513
514MarkerType RE_Compiler::compileDiff(Diff * diff, MarkerType marker, PabloBuilder & pb) {
515    RE * lh = diff->getLH();
516    RE * rh = diff->getRH();
517    if (alignedUnicodeLength(lh, rh)) {
518        MarkerType t1 = process(lh, marker, pb);
519        MarkerType t2 = process(rh, marker, pb);
520        AlignMarkers(t1, t2, pb);
521        return makeMarker(markerPos(t1), pb.createAnd(markerVar(t1), pb.createNot(markerVar(t2)), "diff"));
522    }
523    throw std::runtime_error("Unsupported Diff operands: " + Printer_RE::PrintRE(diff));
524}
525
526MarkerType RE_Compiler::compileIntersect(Intersect * x, MarkerType marker, PabloBuilder & pb) {
527    RE * lh = x->getLH();
528    RE * rh = x->getRH();
529    if (alignedUnicodeLength(lh, rh)) {
530        MarkerType t1 = process(lh, marker, pb);
531        MarkerType t2 = process(rh, marker, pb);
532        AlignMarkers(t1, t2, pb);
533        return makeMarker(markerPos(t1), pb.createAnd(markerVar(t1), markerVar(t2), "intersect"));
534    }
535    throw std::runtime_error("Unsupported Intersect operands: " + Printer_RE::PrintRE(x));
536}
537
538MarkerType RE_Compiler::compileRep(Rep * rep, MarkerType marker, PabloBuilder & pb) {
539    int lb = rep->getLB();
540    int ub = rep->getUB();
541    if (lb > 0) {
542        marker = processLowerBound(rep->getRE(), lb, marker, pb);
543    }
544    if (ub == Rep::UNBOUNDED_REP) {
545        marker = processUnboundedRep(rep->getRE(), marker, pb);
546    } else if (lb < ub) {
547        marker = processBoundedRep(rep->getRE(), ub - lb, marker, pb);
548    }
549    return marker;
550}
551
552/*
553   Given a stream |repeated| marking positions associated with matches to an item
554   of length |repeated_lgth|, compute a stream marking |repeat_count| consecutive
555   occurrences of such items.
556*/
557
558inline PabloAST * RE_Compiler::consecutive_matches(PabloAST * repeated, int length, int repeat_count, PabloBuilder & pb) {
559    int i = length;
560    int total = repeat_count * length;
561    PabloAST * consecutive_i = repeated;
562    while (i * 2 < total) {
563        PabloAST * v = consecutive_i;
564        PabloAST * v2 =  pb.createAdvance(v, i);
565        i *= 2;
566        consecutive_i = pb.createAnd(v, v2, "at" + std::to_string(i) + "of" + std::to_string(total));
567    }
568    if (i < total) {
569        PabloAST * v = consecutive_i;
570        consecutive_i = pb.createAnd(v, pb.createAdvance(v, total - i), "at" + std::to_string(total));
571    }
572    return consecutive_i;
573}
574
575inline PabloAST * RE_Compiler::reachable(PabloAST * repeated, int length, int repeat_count, PabloBuilder & pb) {
576    int i = length;
577    int total_lgth = repeat_count * length;
578    if (repeat_count == 0) {
579        return repeated;
580    }
581    PabloAST * reachable_i = pb.createOr(repeated, pb.createAdvance(repeated, 1), "within1");
582    while (i * 2 < total_lgth) {
583        PabloAST * v = reachable_i;
584        PabloAST * v2 =  pb.createAdvance(v, i);
585        i *= 2;
586        reachable_i = pb.createOr(v, v2, "within" + std::to_string(i));
587    }
588    if (i < total_lgth) {
589        PabloAST * v = reachable_i;
590        reachable_i = pb.createOr(v, pb.createAdvance(v, total_lgth - i), "within" + std::to_string(total_lgth));
591    }
592    return reachable_i;
593}
594
595MarkerType RE_Compiler::processLowerBound(RE * repeated, int lb, MarkerType marker, PabloBuilder & pb) {
596    if (!mGraphemeBoundaryRule && isByteLength(repeated) && !AlgorithmOptionIsSet(DisableLog2BoundedRepetition)) {
597        PabloAST * cc = markerVar(compile(repeated, pb));
598        PabloAST * cc_lb = consecutive_matches(cc, 1, lb, pb);
599        PabloAST * marker_fwd = pb.createAdvance(markerVar(marker), markerPos(marker) == MarkerPosition::FinalMatchByte ? lb : lb - 1);
600        return makeMarker(MarkerPosition::FinalMatchByte, pb.createAnd(marker_fwd, cc_lb, "lowerbound"));
601    }
602    // Fall through to general case.
603    for (int i = 1; i <= lb; ++i) {
604        marker = process(repeated, marker, pb);
605        if (mGraphemeBoundaryRule) {
606            marker = AdvanceMarker(marker, MarkerPosition::FinalPostPositionByte, pb);
607        }
608    }
609    return marker;
610}
611
612MarkerType RE_Compiler::processBoundedRep(RE * repeated, int ub, MarkerType marker, PabloBuilder & pb) {
613    if (!mGraphemeBoundaryRule && isByteLength(repeated) && ub > 1 && !AlgorithmOptionIsSet(DisableLog2BoundedRepetition)) {
614        // log2 upper bound for fixed length (=1) class
615        // Create a mask of positions reachable within ub from current marker.
616        // Use matchstar, then apply filter.
617        PabloAST * match = markerVar(AdvanceMarker(marker, MarkerPosition::InitialPostPositionByte, pb));
618        PabloAST * upperLimitMask = reachable(match, 1, ub, pb);
619        PabloAST * cursor = markerVar(AdvanceMarker(marker, MarkerPosition::InitialPostPositionByte, pb));
620        PabloAST * rep_class_var = markerVar(compile(repeated, pb));
621        return makeMarker(MarkerPosition::InitialPostPositionByte, pb.createAnd(pb.createMatchStar(cursor, rep_class_var), upperLimitMask, "bounded"));
622    }
623    // Fall through to general case.
624    for (int i = 1; i <= ub; ++i) {
625        MarkerType a = process(repeated, marker, pb);
626        MarkerType m = marker;
627        AlignMarkers(a, m, pb);
628        marker = makeMarker(markerPos(a), pb.createOr(markerVar(a), markerVar(m), "upper" + std::to_string(i)));
629        if (mGraphemeBoundaryRule) {
630            marker = AdvanceMarker(marker, MarkerPosition::FinalPostPositionByte, pb);
631        }
632    }
633    return marker;
634}
635
636MarkerType RE_Compiler::processUnboundedRep(RE * repeated, MarkerType marker, PabloBuilder & pb) {
637    // always use PostPosition markers for unbounded repetition.
638    PabloAST * base = markerVar(AdvanceMarker(marker, MarkerPosition::InitialPostPositionByte, pb));
639    if (!mGraphemeBoundaryRule && isByteLength(repeated)  && !AlgorithmOptionIsSet(DisableMatchStar)) {
640        PabloAST * cc = markerVar(compile(repeated, pb));
641        PabloAST * mstar = nullptr;
642        mstar = pb.createMatchStar(base, cc, "unbounded");
643        return makeMarker(MarkerPosition::InitialPostPositionByte, mstar);
644    } else if (isUnicodeUnitLength(repeated) && !AlgorithmOptionIsSet(DisableMatchStar) && !AlgorithmOptionIsSet(DisableUnicodeMatchStar)) {
645        PabloAST * cc = markerVar(compile(repeated, pb));
646        PabloAST * mstar = nullptr;
647        PabloAST * nonFinal = mNonFinal;
648        if (mGraphemeBoundaryRule) {
649            nonFinal = pb.createOr(nonFinal, pb.createNot(mGraphemeBoundaryRule, "gext"));
650        }
651        cc = pb.createOr(cc, nonFinal);
652        mstar = pb.createMatchStar(base, cc);
653        PabloAST * final = mFinal;
654        if (mGraphemeBoundaryRule) {
655            final = mGraphemeBoundaryRule;
656        }
657        return makeMarker(MarkerPosition::FinalPostPositionByte, pb.createAnd(mstar, final, "unbounded"));
658    } else if (mStarDepth > 0){
659        PabloBuilder * outerb = pb.getParent();
660        Assign * starPending = outerb->createAssign("pending", outerb->createZeroes());
661        Assign * starAccum = outerb->createAssign("accum", outerb->createZeroes());
662        mStarDepth++;
663        PabloAST * m1 = pb.createOr(base, starPending);
664        PabloAST * m2 = pb.createOr(base, starAccum);
665        MarkerType result = process(repeated, makeMarker(MarkerPosition::InitialPostPositionByte, m1), pb);
666        result = AdvanceMarker(result, MarkerPosition::InitialPostPositionByte, pb);
667        PabloAST * loopComputation = markerVar(result);
668        Next * nextPending = pb.createNext(starPending, pb.createAnd(loopComputation, pb.createNot(m2)));
669        Next * nextStarAccum = pb.createNext(starAccum, pb.createOr(loopComputation, m2));
670        mWhileTest = pb.createOr(mWhileTest, nextPending);
671        mLoopVariants.push_back(nextPending);
672        mLoopVariants.push_back(nextStarAccum);
673        mStarDepth--;
674        return makeMarker(markerPos(result), pb.createAssign("unbounded", pb.createOr(base, nextStarAccum)));
675    } else {
676        Assign * whileTest = pb.createAssign("test", base);
677        Assign * whilePending = pb.createAssign("pending", base);
678        Assign * whileAccum = pb.createAssign("accum", base);
679        mWhileTest = pb.createZeroes();
680        PabloBuilder wb = PabloBuilder::Create(pb);
681        mStarDepth++;
682        MarkerType result = process(repeated, makeMarker(MarkerPosition::InitialPostPositionByte, whilePending), wb);
683        result = AdvanceMarker(result, MarkerPosition::InitialPostPositionByte, wb);
684        PabloAST * loopComputation = markerVar(result);
685        Next * nextWhilePending = wb.createNext(whilePending, wb.createAnd(loopComputation, wb.createNot(whileAccum)));
686        Next * nextWhileAccum = wb.createNext(whileAccum, wb.createOr(loopComputation, whileAccum));
687        Next * nextWhileTest = wb.createNext(whileTest, wb.createOr(mWhileTest, nextWhilePending));
688        mLoopVariants.push_back(nextWhilePending);
689        mLoopVariants.push_back(nextWhileAccum);
690        mLoopVariants.push_back(nextWhileTest);
691        pb.createWhile(nextWhileTest, mLoopVariants, wb);
692        mStarDepth--;
693        mLoopVariants.clear();
694        return makeMarker(markerPos(result), pb.createAssign("unbounded", nextWhileAccum));
695    }
696}
697
698inline MarkerType RE_Compiler::compileStart(const MarkerType marker, pablo::PabloBuilder & pb) {
699    MarkerType m = AdvanceMarker(marker, MarkerPosition::InitialPostPositionByte, pb);
700    if (UNICODE_LINE_BREAK) {
701        PabloAST * line_end = mPB.createOr(mLineBreak, mCRLF);
702        PabloAST * sol = pb.createNot(pb.createOr(pb.createAdvance(pb.createNot(line_end), 1), mCRLF));
703        return makeMarker(MarkerPosition::InitialPostPositionByte, pb.createAnd(markerVar(m), sol, "sol"));
704    } else {
705        PabloAST * sol = pb.createNot(pb.createAdvance(pb.createNot(mLineBreak), 1));
706        return makeMarker(MarkerPosition::FinalPostPositionByte, pb.createAnd(markerVar(m), sol, "sol"));
707    }
708}
709
710inline MarkerType RE_Compiler::compileEnd(const MarkerType marker, pablo::PabloBuilder & pb) {
711    if (UNICODE_LINE_BREAK) {
712        PabloAST * nextPos = markerVar(AdvanceMarker(marker, MarkerPosition::FinalPostPositionByte, pb));
713        return makeMarker(MarkerPosition::FinalPostPositionByte, pb.createAnd(nextPos, mLineBreak, "eol"));
714    } else {
715        PabloAST * nextPos = markerVar(AdvanceMarker(marker, MarkerPosition::InitialPostPositionByte, pb));  // For LF match
716        return makeMarker(MarkerPosition::FinalPostPositionByte, pb.createAnd(nextPos, mLineBreak, "eol"));
717    }
718}
719
720inline MarkerType RE_Compiler::compileGraphemeBoundary(GraphemeBoundary * gb, MarkerType marker, pablo::PabloBuilder & pb) {
721    auto f = mCompiledName.find(gb->getBoundaryRule());
722    assert ("Internal error: failed to locate grapheme boundary rule!" && (f != mCompiledName.end()));
723    if (gb->getExpression()) {
724        const auto graphemeBoundaryRule = mGraphemeBoundaryRule;
725        mGraphemeBoundaryRule = markerVar(f->second);
726        marker = process(gb->getExpression(), marker, pb);
727        marker = AdvanceMarker(marker, MarkerPosition::FinalPostPositionByte, pb);
728        mGraphemeBoundaryRule = graphemeBoundaryRule;
729    } else {
730        marker = AdvanceMarker(marker, MarkerPosition::FinalPostPositionByte, pb);
731        PabloAST * rule = markerVar(f->second);
732        if (gb->getSense() == GraphemeBoundary::Sense::Negative) {
733            rule = pb.createNot(rule);
734        }
735        marker = makeMarker(MarkerPosition::FinalPostPositionByte, pb.createAnd(markerVar(marker), rule, "gb"));
736    }
737    return marker;
738}
739
740inline MarkerType RE_Compiler::AdvanceMarker(MarkerType marker, const MarkerPosition newpos, PabloBuilder & pb) {
741    if (marker.pos != newpos) {
742        if (marker.pos == MarkerPosition::FinalMatchByte) {
743            marker.stream = pb.createAdvance(marker.stream, 1, "ipp");
744            marker.pos = MarkerPosition::InitialPostPositionByte;
745        }
746        if (newpos == MarkerPosition::FinalPostPositionByte) {
747            PabloAST * nonFinal = mNonFinal;
748            if (mGraphemeBoundaryRule) {
749                nonFinal = pb.createOr(nonFinal, pb.createNot(mGraphemeBoundaryRule, "gext"));
750            }
751            marker.stream = pb.createScanThru(pb.createAnd(mInitial, marker.stream), nonFinal, "fpp");
752            marker.pos = MarkerPosition::FinalPostPositionByte;
753        }
754    }
755    return marker;
756}
757
758inline void RE_Compiler::AlignMarkers(MarkerType & m1, MarkerType & m2, PabloBuilder & pb) {
759    if (m1.pos < m2.pos) {
760        m1 = AdvanceMarker(m1, m2.pos, pb);
761    } else if (m2.pos < m1.pos) {
762        m2 = AdvanceMarker(m2, m1.pos, pb);
763    }
764}
765
766RE_Compiler::RE_Compiler(pablo::PabloFunction & function, cc::CC_Compiler & ccCompiler)
767: mCCCompiler(ccCompiler)
768, mLineBreak(nullptr)
769, mCRLF(nullptr)
770, mAny(nullptr)
771, mGraphemeBoundaryRule(nullptr)
772, mInitial(nullptr)
773, mNonFinal(nullptr)
774, mFinal(nullptr)
775, mWhileTest(nullptr)
776, mStarDepth(0)
777, mLoopVariants()
778, mPB(ccCompiler.getBuilder().getPabloBlock(), ccCompiler.getBuilder())
779, mFunction(function)
780{
781
782}
783
784} // end of namespace re
Note: See TracBrowser for help on using the repository browser.