1 # Copyright (c) 2002-2015 International Business Machines Corporation and
2 # others. All Rights Reserved.
7 # Implement default line breaking as defined by
8 # Unicode Standard Annex #14 Revision 29 for Unicode 6.2
9 # http://www.unicode.org/reports/tr14/
11 # TODO: Rule LB 8 remains as it was in Unicode 5.2
12 # This is only because of a limitation of ICU break engine implementation,
13 # not because the older behavior is desirable.
16 # Character Classes defined by TR 14.
25 # !!lookAheadHardBreak Described here because it is (as yet) undocumented elsewhere
26 # and only used for the line break rules.
28 # It is used in the implementation of rule LB 10
29 # which says to treat any combining mark that is not attached to a base
30 # character as if it were of class AL (alphabetic).
32 # The problem occurs in the reverse rules.
34 # Consider a sequence like, with correct breaks as shown
37 # Then consider the sequence without the initial ID (ideographic)
40 # Our CM, which in the first example was attached to the ideograph,
41 # is now unattached, becomes an alpha, and joins in with the other
44 # When iterating forwards, these sequences do not present any problems
45 # When iterating backwards, we need to look ahead when encountering
46 # a CM to see whether it attaches to something further on or not.
47 # (Look-ahead in a reverse rule is looking towards the start)
49 # If the CM is unattached, we need to force a break.
51 # !!lookAheadHardBreak forces the run time state machine to
52 # stop immediately when a look ahead rule ( '/' operator) matches,
53 # and set the match position to that of the look-ahead operator,
54 # no matter what other rules may be in play at the time.
56 # See rule LB 19 for an example.
59 $AI = [:LineBreak = Ambiguous:];
60 $AL = [:LineBreak = Alphabetic:];
61 $BA = [:LineBreak = Break_After:];
62 $BB = [:LineBreak = Break_Before:];
63 $BK = [:LineBreak = Mandatory_Break:];
64 $B2 = [:LineBreak = Break_Both:];
65 $CB = [:LineBreak = Contingent_Break:];
66 $CJ = [:LineBreak = Conditional_Japanese_Starter:];
67 $CL = [:LineBreak = Close_Punctuation:];
68 $CM = [:LineBreak = Combining_Mark:];
69 $CP = [:LineBreak = Close_Parenthesis:];
70 $CR = [:LineBreak = Carriage_Return:];
71 $EX = [:LineBreak = Exclamation:];
72 $GL = [:LineBreak = Glue:];
73 $HL = [:LineBreak = Hebrew_Letter:];
74 $HY = [:LineBreak = Hyphen:];
75 $H2 = [:LineBreak = H2:];
76 $H3 = [:LineBreak = H3:];
77 $ID = [[:LineBreak = Ideographic:] $CJ];
78 $IN = [:LineBreak = Inseperable:];
79 $IS = [:LineBreak = Infix_Numeric:];
80 $JL = [:LineBreak = JL:];
81 $JV = [:LineBreak = JV:];
82 $JT = [:LineBreak = JT:];
83 $LF = [:LineBreak = Line_Feed:];
84 $NL = [:LineBreak = Next_Line:];
85 $NS = [:LineBreak = Nonstarter:];
86 $NU = [:LineBreak = Numeric:];
87 $OP = [:LineBreak = Open_Punctuation:];
88 $PO = [:LineBreak = Postfix_Numeric:];
89 $PR = [:LineBreak = Prefix_Numeric:];
90 $QU = [:LineBreak = Quotation:];
91 $RI = [:LineBreak = Regional_Indicator:];
92 $SA = [:LineBreak = Complex_Context:];
93 $SG = [:LineBreak = Surrogate:];
94 $SP = [:LineBreak = Space:];
95 $SY = [:LineBreak = Break_Symbols:];
96 $WJ = [:LineBreak = Word_Joiner:];
97 $XX = [:LineBreak = Unknown:];
98 $ZW = [:LineBreak = ZWSpace:];
100 # Special character classes for people & body part emoji:
104 # The following are subsets of $ID
105 $EmojiForSeqs = [\u2764 \U0001F441 \U0001F466-\U0001F469 \U0001F48B \U0001F5E8];
106 $EmojiForMods = [\u261D \u26F9 \u270A-\u270D \U0001F385 \U0001F3C3-\U0001F3C4 \U0001F3C7 \U0001F3CA-\U0001F3CB \U0001F442-\U0001F443 \U0001F446-\U0001F450 \U0001F466-\U0001F469 \U0001F46E-\U0001F478 \U0001F47C \U0001F481-\U0001F483 \U0001F485-\U0001F487 \U0001F4AA \U0001F590 \U0001F595 \U0001F596 \U0001F645-\U0001F647 \U0001F64B-\U0001F64F \U0001F6A3 \U0001F6B4-\U0001F6B6 \U0001F6C0 \U0001F918];
107 $EmojiMods = [\U0001F3FB-\U0001F3FF];
109 # Dictionary character set, for triggering language-based break engines. Currently
110 # limited to LineBreak=Complex_Context. Note that this set only works in Unicode
111 # 5.0 or later as the definition of Complex_Context was corrected to include all
112 # characters requiring dictionary break.
114 $dictionary = [:LineBreak = Complex_Context:];
117 # Rule LB1. By default, treat AI (characters with ambiguous east Asian width),
118 # SA (South East Asian: Thai, Lao, Khmer)
119 # SG (Unpaired Surrogates)
120 # XX (Unknown, unassigned)
121 # as $AL (Alphabetic)
123 $ALPlus = [$AL $AI $SA $SG $XX];
126 # Combining Marks. X $CM* behaves as if it were X. Rule LB6.
128 $ALcm = $ALPlus $CM*;
156 ## -------------------------------------------------
161 # Each class of character can stand by itself as an unbroken token, with trailing combining stuff
192 # CAN_CM is the set of characters that may combine with CM combining chars.
193 # Note that Linebreak UAX 14's concept of a combining char and the rules
194 # for what they can combine with are _very_ different from the rest of Unicode.
196 # Note that $CM itself is left out of this set. If CM is needed as a base
197 # it must be listed separately in the rule.
199 $CAN_CM = [^$SP $BK $CR $LF $NL $ZW $CM]; # Bases that can take CMs
200 $CANT_CM = [ $SP $BK $CR $LF $NL $ZW $CM]; # Bases that can't take CMs
203 # AL_FOLLOW set of chars that can unconditionally follow an AL
204 # Needed in rules where stand-alone $CM s are treated as AL.
205 # Chaining is disabled with CM because it causes other failures,
206 # so for this one case we need to manually list out longer sequences.
208 $AL_FOLLOW_NOCM = [$BK $CR $LF $NL $ZW $SP];
209 $AL_FOLLOW_CM = [$CL $CP $EX $HL $IS $SY $WJ $GL $OP $QU $BA $HY $NS $IN $NU $ALPlus];
210 $AL_FOLLOW = [$AL_FOLLOW_NOCM $AL_FOLLOW_CM];
214 # Rule LB 4, 5 Mandatory (Hard) breaks.
216 $LB4Breaks = [$BK $CR $LF $NL];
217 $LB4NonBreaks = [^$BK $CR $LF $NL];
221 # LB 6 Do not break before hard line breaks.
223 $LB4NonBreaks? $LB4Breaks {100}; # LB 5 do not break before hard breaks.
224 $CAN_CM $CM* $LB4Breaks {100};
225 $CM+ $LB4Breaks {100};
229 $LB4NonBreaks [$SP $ZW];
230 $CAN_CM $CM* [$SP $ZW];
234 # LB 8 Break after zero width space
235 # TODO: ZW SP* <break>
236 # An engine change is required to write the reverse rule for this.
237 # For now, leave the Unicode 5.2 rule, ZW <break>
239 $LB8Breaks = [$LB4Breaks $ZW];
240 $LB8NonBreaks = [[$LB4NonBreaks] - [$ZW]];
243 # Special forward rule for people & body part emoji:
244 # don't break $ZWJ from subsequent $EmojiForSeqs
245 $EmojiForSeqs $EmojiVar? $EmojiMods? $ZWJ $EmojiForSeqs;
247 # LB 9 Combining marks. X $CM needs to behave like X, where X is not $SP, $BK $CR $LF $NL
248 # $CM not covered by the above needs to behave like $AL
249 # See definition of $CAN_CM.
251 $CAN_CM $CM+; # Stick together any combining sequences that don't match other rules.
255 # LB 11 Do not break before or after WORD JOINER & related characters.
265 # LB 12 Do not break after NBSP and related characters.
272 # LB 12a Do not break before NBSP and related characters ...
275 [[$LB8NonBreaks] - [$SP $BA $HY]] $CM* $GLcm;
281 # LB 13 Don't break before ']' or '!' or ';' or '/', even after spaces.
285 $CM+ $CL; # by rule 10, stand-alone CM behaves as AL
289 $CM+ $CP; # by rule 10, stand-alone CM behaves as AL
293 $CM+ $EX; # by rule 10, stand-alone CM behaves as AL
297 $CM+ $IS; # by rule 10, stand-alone CM behaves as AL
301 $CM+ $SY; # by rule 10, stand-alone CM behaves as AL
305 # LB 14 Do not break after OP, even after spaces
307 $OPcm $SP* $CAN_CM $CM*;
310 $OPcm $SP+ $CM+ $AL_FOLLOW?; # by rule 10, stand-alone CM behaves as AL
316 ($CLcm | $CPcm) $SP* $NScm;
322 # LB 18 Break after spaces.
324 $LB18NonBreaks = [$LB8NonBreaks - [$SP]];
325 $LB18Breaks = [$LB8Breaks $SP];
330 $LB18NonBreaks $CM* $QUcm;
335 $QUcm $LB18NonBreaks $CM*; # Don't let a combining mark go onto $CR, $BK, etc.
336 # TODO: I don't think this rule is needed.
343 $LB20NonBreaks = [$LB18NonBreaks - $CB];
345 # LB 21 x (BA | HY | NS)
348 $LB20NonBreaks $CM* ($BAcm | $HYcm | $NScm);
350 $BBcm [^$CB]; # $BB x
351 $BBcm $LB20NonBreaks $CM*;
353 # LB 21a Don't break after Hebrew + Hyphen
356 $HLcm ($HYcm | $BAcm) [^$CB]?;
358 # LB 21b (forward) Don't break between SY and HL
359 # (break between HL and SY already disallowed by LB 13 above)
363 ($ALcm | $HLcm) $INcm;
364 $CM+ $INcm; # by rule 10, any otherwise unattached CM behaves as AL
372 $ALcm $NUcm; # includes $LB19
374 $CM+ $NUcm; # Rule 10, any otherwise unattached CM behaves as AL
382 $PRcm ($ALcm | $HLcm);
383 $POcm ($ALcm | $HLcm);
388 ($PRcm | $POcm)? ($OPcm | $HYcm)? $NUcm ($NUcm | $SYcm | $IScm)* ($CLcm | $CPcm)? ($PRcm | $POcm)?;
390 # LB 26 Do not break a Korean syllable
392 $JLcm ($JLcm | $JVcm | $H2cm | $H3cm);
393 ($JVcm | $H2cm) ($JVcm | $JTcm);
394 ($JTcm | $H3cm) $JTcm;
396 # LB 27 Treat korean Syllable Block the same as ID (don't break it)
397 ($JLcm | $JVcm | $JTcm | $H2cm | $H3cm) $INcm;
398 ($JLcm | $JVcm | $JTcm | $H2cm | $H3cm) $POcm;
399 $PRcm ($JLcm | $JVcm | $JTcm | $H2cm | $H3cm);
402 # LB 28 Do not break between alphabetics
404 ($ALcm | $HLcm) ($ALcm | $HLcm);
405 $CM+ ($ALcm | $HLcm); # The $CM+ is from rule 10, an unattached CM is treated as AL
408 $IScm ($ALcm | $HLcm);
411 ($ALcm | $HLcm | $NUcm) $OPcm;
412 $CM+ $OPcm; # The $CM+ is from rule 10, an unattached CM is treated as AL.
413 $CPcm ($ALcm | $HLcm | $NUcm);
415 # LB 30a Do not break between regional indicators.
418 # Special forward rule for people & body part emoji:
419 # don't break between relevant emoji and $EmojiMods
420 $EmojiForMods $EmojiVar? $EmojiMods;
425 ## -------------------------------------------------
460 # Sequences of the form (shown forwards)
461 # [CANT_CM] <break> [CM] [whatever]
462 # The CM needs to behave as an AL
465 [$BK $CR $LF $NL $ZW {eof}] |
467 $SP+ $CM* ([^$OP $CM $SP] | [$AL {eof}])); # if LB 14 will match, need to surpress this break.
468 # LB14 says OP SP* x .
469 # becomes OP SP* x AL
470 # becomes OP SP* x CM+ AL_FOLLOW
472 # Further note: the $AL in [$AL {eof}] is only to work around
473 # a rule compiler bug which complains about
474 # empty sets otherwise.
477 # Sequences of the form (shown forwards)
478 # [CANT_CM] <break> [CM] <break> [PR]
479 # The CM needs to behave as an AL
480 # This rule is concerned about getting the second of the two <breaks> in place.
483 [$PR ] / $CM+ [$BK $CR $LF $NL $ZW $SP {eof}];
489 $LB4Breaks [$LB4NonBreaks-$CM];
490 $LB4Breaks $CM+ $CAN_CM;
496 [$SP $ZW] [$LB4NonBreaks-$CM];
497 [$SP $ZW] $CM+ $CAN_CM;
499 # LB 8 ZW SP* <break>
500 # TODO: to implement this, we need more than one look-ahead hard break in play at a time.
501 # Requires an engine enhancement.
504 # Special reverse rule for people & body part emoji:
505 # don't break $ZWJ from subsequent $EmojiForSeqs
506 $EmojiForSeqs $ZWJ $EmojiMods? $EmojiVar? $EmojiForSeqs;
508 # LB 9,10 Combining marks.
509 # X $CM needs to behave like X, where X is not $SP or controls.
510 # $CM not covered by the above needs to behave like $AL
511 # Stick together any combining sequences that don't match other rules.
516 $CM* $WJ $CM* $CAN_CM;
517 $CM* $WJ [$LB8NonBreaks-$CM];
520 $CM* $CAN_CM $CM* $WJ;
525 $CM* $GL $CM* [$LB8NonBreaks-[$CM $SP $BA $HY]];
531 $CM* $CAN_CM $CM* $GL;
541 $CL [$LB8NonBreaks-$CM];
542 $CP [$LB8NonBreaks-$CM];
543 $EX [$LB8NonBreaks-$CM];
544 $IS [$LB8NonBreaks-$CM];
545 $SY [$LB8NonBreaks-$CM];
547 # Rule 13 & 14 taken together for an edge case.
548 # Match this, shown forward
549 # OP SP+ ($CM+ behaving as $AL) (CL | CP | EX | IS | IY)
550 # This really wants to chain at the $CM+ (which is acting as an $AL)
551 # except for $CM chaining being disabled.
552 [$CL $CP $EX $IS $SY] $CM+ $SP+ $CM* $OP;
556 $CM* $CAN_CM $SP* $CM* $OP;
557 $CANT_CM $SP* $CM* $OP;
558 $AL_FOLLOW? $CM+ $SP $SP* $CM* $OP; # by LB 10, behaves like $AL_FOLLOW? $AL $SP* $CM* $OP
560 $AL_FOLLOW_NOCM $CM+ $SP+ $CM* $OP;
561 $CM* $AL_FOLLOW_CM $CM+ $SP+ $CM* $OP;
562 $SY $CM $SP+ $OP; # TODO: Experiment. Remove.
567 $CM* $OP $SP* $CM* $QU;
570 $CM* $NS $SP* $CM* ($CL | $CP);
573 $CM* $B2 $SP* $CM* $B2;
575 # LB 18 break after spaces
576 # Nothing explicit needed here.
582 $CM* $QU $CM* $CAN_CM; # . x QU
583 $CM* $QU $LB18NonBreaks;
586 $CM* $CAN_CM $CM* $QU; # QU x .
590 # LB 20 Break before and after CB.
591 # nothing needed here.
595 $CM* ($BA | $HY | $NS) $CM* [$LB20NonBreaks-$CM]; # . x (BA | HY | NS)
597 $CM* [$LB20NonBreaks-$CM] $CM* $BB; # BB x .
601 [^$CB] $CM* ($HY | $BA) $CM* $HL;
607 $CM* $IN $CM* ($ALPlus | $HL);
614 $CM* $NU $CM* ($ALPlus | $HL);
615 $CM* ($ALPlus | $HL) $CM* $NU;
619 $CM* ($ALPlus | $HL) $CM* $PR;
620 $CM* ($ALPlus | $HL) $CM* $PO;
624 ($CM* ($PR | $PO))? ($CM* ($CL | $CP))? ($CM* ($NU | $IS | $SY))* $CM* $NU ($CM* ($OP | $HY))? ($CM* ($PR | $PO))?;
627 $CM* ($H3 | $H2 | $JV | $JL) $CM* $JL;
628 $CM* ($JT | $JV) $CM* ($H2 | $JV);
629 $CM* $JT $CM* ($H3 | $JT);
632 $CM* $IN $CM* ($H3 | $H2 | $JT | $JV | $JL);
633 $CM* $PO $CM* ($H3 | $H2 | $JT | $JV | $JL);
634 $CM* ($H3 | $H2 | $JT | $JV | $JL) $CM* $PR;
637 $CM* ($ALPlus | $HL) $CM* ($ALPlus | $HL);
641 $CM* ($ALPlus | $HL) $CM* $IS;
644 $CM* $OP $CM* ($ALPlus | $HL | $NU);
645 $CM* ($ALPlus | $HL | $NU) $CM* $CP;
650 # Special reverse rule for people & body part emoji:
651 # don't break between relevant emoji and $EmojiMods
652 $EmojiMods $EmojiVar? $EmojiForMods;
654 ## -------------------------------------------------
659 $CM+ [^$CM $BK $CR $LF $NL $ZW $SP];
669 $SP+ $CM* ($CL | $CP);
675 $CM* ($HY | $BA) $CM* $HL;
678 ($CM* ($IS | $SY))+ $CM* $NU;
679 ($CL | $CP) $CM* ($NU | $IS | $SY);
681 # For dictionary-based break
682 $dictionary $dictionary;
684 ## -------------------------------------------------
688 # Skip forward over all character classes that are involved in
689 # rules containing patterns with possibly more than one char
692 # It might be slightly more efficient to have specific rules
693 # instead of one generic one, but only if we could
694 # turn off rule chaining. We don't want to move more
697 [$CM $OP $QU $CL $CP $B2 $PR $HY $BA $SP $dictionary]+ [^$CM $OP $QU $CL $CP $B2 $PR $HY $BA $dictionary];
698 $dictionary $dictionary;