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

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

Restructure regular expression command flags

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