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/
10 # tailored as noted in 2nd paragraph below..
12 # TODO: Rule LB 8 remains as it was in Unicode 5.2
13 # This is only because of a limitation of ICU break engine implementation,
14 # not because the older behavior is desirable.
16 # This tailors the line break behavior to correspond to CSS
17 # line-break=loose (BCP47 -u-lb-loose) as defined for languages other than
19 # It sets characters of class CJ to behave like ID.
20 # In addition, it allows breaks:
21 # * before iteration marks 3005, 303B, 309D, 309E, 30FD, 30FE (all NS)
22 # * between characters of LineBreak class IN
25 # Character Classes defined by TR 14.
34 # !!lookAheadHardBreak Described here because it is (as yet) undocumented elsewhere
35 # and only used for the line break rules.
37 # It is used in the implementation of rule LB 10
38 # which says to treat any combining mark that is not attached to a base
39 # character as if it were of class AL (alphabetic).
41 # The problem occurs in the reverse rules.
43 # Consider a sequence like, with correct breaks as shown
46 # Then consider the sequence without the initial ID (ideographic)
49 # Our CM, which in the first example was attached to the ideograph,
50 # is now unattached, becomes an alpha, and joins in with the other
53 # When iterating forwards, these sequences do not present any problems
54 # When iterating backwards, we need to look ahead when encountering
55 # a CM to see whether it attaches to something further on or not.
56 # (Look-ahead in a reverse rule is looking towards the start)
58 # If the CM is unattached, we need to force a break.
60 # !!lookAheadHardBreak forces the run time state machine to
61 # stop immediately when a look ahead rule ( '/' operator) matches,
62 # and set the match position to that of the look-ahead operator,
63 # no matter what other rules may be in play at the time.
65 # See rule LB 19 for an example.
68 $AI = [:LineBreak = Ambiguous:];
69 $AL = [:LineBreak = Alphabetic:];
70 $BA = [:LineBreak = Break_After:];
71 $BB = [:LineBreak = Break_Before:];
72 $BK = [:LineBreak = Mandatory_Break:];
73 $B2 = [:LineBreak = Break_Both:];
74 $CB = [:LineBreak = Contingent_Break:];
75 $CJ = [:LineBreak = Conditional_Japanese_Starter:];
76 $CL = [:LineBreak = Close_Punctuation:];
77 $CM = [:LineBreak = Combining_Mark:];
78 $CP = [:LineBreak = Close_Parenthesis:];
79 $CR = [:LineBreak = Carriage_Return:];
80 $EX = [:LineBreak = Exclamation:];
81 $GL = [:LineBreak = Glue:];
82 $HL = [:LineBreak = Hebrew_Letter:];
83 $HY = [:LineBreak = Hyphen:];
84 $H2 = [:LineBreak = H2:];
85 $H3 = [:LineBreak = H3:];
86 $ID = [[:LineBreak = Ideographic:] $CJ];
87 $IN = [:LineBreak = Inseperable:];
88 $IS = [:LineBreak = Infix_Numeric:];
89 $JL = [:LineBreak = JL:];
90 $JV = [:LineBreak = JV:];
91 $JT = [:LineBreak = JT:];
92 $LF = [:LineBreak = Line_Feed:];
93 $NL = [:LineBreak = Next_Line:];
94 $NSX = [\u3005 \u303B \u309D \u309E \u30FD \u30FE];
95 $NS = [[:LineBreak = Nonstarter:] - $NSX];
96 $NU = [:LineBreak = Numeric:];
97 $OP = [:LineBreak = Open_Punctuation:];
98 $PO = [:LineBreak = Postfix_Numeric:];
99 $PR = [:LineBreak = Prefix_Numeric:];
100 $QU = [:LineBreak = Quotation:];
101 $RI = [:LineBreak = Regional_Indicator:];
102 $SA = [:LineBreak = Complex_Context:];
103 $SG = [:LineBreak = Surrogate:];
104 $SP = [:LineBreak = Space:];
105 $SY = [:LineBreak = Break_Symbols:];
106 $WJ = [:LineBreak = Word_Joiner:];
107 $XX = [:LineBreak = Unknown:];
108 $ZW = [:LineBreak = ZWSpace:];
110 # Special character classes for people & body part emoji:
114 # The following are subsets of $ID
115 $EmojiForSeqs = [\u2764 \U0001F466-\U0001F469 \U0001F48B];
116 $EmojiForMods = [\u261D \u270A-\u270C \U0001F385 \U0001F3C3-\U0001F3C4 \U0001F3C7 \U0001F3CA \U0001F442-\U0001F443 \U0001F446-\U0001F450 \U0001F466-\U0001F469 \U0001F46E-\U0001F478 \U0001F47C \U0001F481-\U0001F483 \U0001F485-\U0001F487 \U0001F4AA \U0001F596 \U0001F645-\U0001F647 \U0001F64B-\U0001F64F \U0001F6A3 \U0001F6B4-\U0001F6B6 \U0001F6C0];
117 $EmojiMods = [\U0001F3FB-\U0001F3FF];
119 # Dictionary character set, for triggering language-based break engines. Currently
120 # limited to LineBreak=Complex_Context. Note that this set only works in Unicode
121 # 5.0 or later as the definition of Complex_Context was corrected to include all
122 # characters requiring dictionary break.
124 $dictionary = [:LineBreak = Complex_Context:];
127 # Rule LB1. By default, treat AI (characters with ambiguous east Asian width),
128 # SA (South East Asian: Thai, Lao, Khmer)
129 # SG (Unpaired Surrogates)
130 # XX (Unknown, unassigned)
131 # as $AL (Alphabetic)
133 $ALPlus = [$AL $AI $SA $SG $XX];
136 # Combining Marks. X $CM* behaves as if it were X. Rule LB6.
138 $ALcm = $ALPlus $CM*;
167 ## -------------------------------------------------
172 # Each class of character can stand by itself as an unbroken token, with trailing combining stuff
204 # CAN_CM is the set of characters that may combine with CM combining chars.
205 # Note that Linebreak UAX 14's concept of a combining char and the rules
206 # for what they can combine with are _very_ different from the rest of Unicode.
208 # Note that $CM itself is left out of this set. If CM is needed as a base
209 # it must be listed separately in the rule.
211 $CAN_CM = [^$SP $BK $CR $LF $NL $ZW $CM]; # Bases that can take CMs
212 $CANT_CM = [ $SP $BK $CR $LF $NL $ZW $CM]; # Bases that can't take CMs
215 # AL_FOLLOW set of chars that can unconditionally follow an AL
216 # Needed in rules where stand-alone $CM s are treated as AL.
217 # Chaining is disabled with CM because it causes other failures,
218 # so for this one case we need to manually list out longer sequences.
220 $AL_FOLLOW_NOCM = [$BK $CR $LF $NL $ZW $SP];
221 $AL_FOLLOW_CM = [$CL $CP $EX $HL $IS $SY $WJ $GL $OP $QU $BA $HY $NS $NSX $IN $NU $ALPlus];
222 $AL_FOLLOW = [$AL_FOLLOW_NOCM $AL_FOLLOW_CM];
226 # Rule LB 4, 5 Mandatory (Hard) breaks.
228 $LB4Breaks = [$BK $CR $LF $NL];
229 $LB4NonBreaks = [^$BK $CR $LF $NL];
233 # LB 6 Do not break before hard line breaks.
235 $LB4NonBreaks? $LB4Breaks {100}; # LB 5 do not break before hard breaks.
236 $CAN_CM $CM* $LB4Breaks {100};
237 $CM+ $LB4Breaks {100};
241 $LB4NonBreaks [$SP $ZW];
242 $CAN_CM $CM* [$SP $ZW];
246 # LB 8 Break after zero width space
247 # TODO: ZW SP* <break>
248 # An engine change is required to write the reverse rule for this.
249 # For now, leave the Unicode 5.2 rule, ZW <break>
251 $LB8Breaks = [$LB4Breaks $ZW];
252 $LB8NonBreaks = [[$LB4NonBreaks] - [$ZW]];
255 # Special forward rule for people & body part emoji:
256 # don't break $ZWJ from subsequent $EmojiForSeqs
257 $EmojiForSeqs $EmojiVar? $EmojiMods? $ZWJ $EmojiForSeqs;
259 # LB 9 Combining marks. X $CM needs to behave like X, where X is not $SP, $BK $CR $LF $NL
260 # $CM not covered by the above needs to behave like $AL
261 # See definition of $CAN_CM.
263 $CAN_CM $CM+; # Stick together any combining sequences that don't match other rules.
267 # LB 11 Do not break before or after WORD JOINER & related characters.
277 # LB 12 Do not break after NBSP and related characters.
284 # LB 12a Do not break before NBSP and related characters ...
287 [[$LB8NonBreaks] - [$SP $BA $HY]] $CM* $GLcm;
293 # LB 13 Don't break before ']' or '!' or ';' or '/', even after spaces.
297 $CM+ $CL; # by rule 10, stand-alone CM behaves as AL
301 $CM+ $CP; # by rule 10, stand-alone CM behaves as AL
305 $CM+ $EX; # by rule 10, stand-alone CM behaves as AL
309 $CM+ $IS; # by rule 10, stand-alone CM behaves as AL
313 $CM+ $SY; # by rule 10, stand-alone CM behaves as AL
317 # LB 14 Do not break after OP, even after spaces
319 $OPcm $SP* $CAN_CM $CM*;
322 $OPcm $SP+ $CM+ $AL_FOLLOW?; # by rule 10, stand-alone CM behaves as AL
328 # Do not break between closing punctuation and $NS, even with intervening spaces
329 # But DO allow a break between closing punctuation and $NSX, don't include it here
330 ($CLcm | $CPcm) $SP* $NScm;
336 # LB 18 Break after spaces.
338 $LB18NonBreaks = [$LB8NonBreaks - [$SP]];
339 $LB18Breaks = [$LB8Breaks $SP];
344 $LB18NonBreaks $CM* $QUcm;
349 $QUcm $LB18NonBreaks $CM*; # Don't let a combining mark go onto $CR, $BK, etc.
350 # TODO: I don't think this rule is needed.
357 $LB20NonBreaks = [$LB18NonBreaks - $CB];
359 # LB 21 x (BA | HY | NS)
362 # DO allow breaks here before NSXcm, so don't include it
363 $LB20NonBreaks $CM* ($BAcm | $HYcm | $NScm);
365 $BBcm [^$CB]; # $BB x
366 $BBcm $LB20NonBreaks $CM*;
368 # LB 21a Don't break after Hebrew + Hyphen
371 $HLcm ($HYcm | $BAcm) [^$CB]?;
373 # LB 21b (forward) Don't break between SY and HL
374 # (break between HL and SY already disallowed by LB 13 above)
378 ($ALcm | $HLcm) $INcm;
379 $CM+ $INcm; # by rule 10, any otherwise unattached CM behaves as AL
381 # $INcm $INcm; # delete this rule for CSS loose
387 $ALcm $NUcm; # includes $LB19
389 $CM+ $NUcm; # Rule 10, any otherwise unattached CM behaves as AL
397 $PRcm ($ALcm | $HLcm);
398 $POcm ($ALcm | $HLcm);
403 ($PRcm | $POcm)? ($OPcm | $HYcm)? $NUcm ($NUcm | $SYcm | $IScm)* ($CLcm | $CPcm)? ($PRcm | $POcm)?;
405 # LB 26 Do not break a Korean syllable
407 $JLcm ($JLcm | $JVcm | $H2cm | $H3cm);
408 ($JVcm | $H2cm) ($JVcm | $JTcm);
409 ($JTcm | $H3cm) $JTcm;
411 # LB 27 Treat korean Syllable Block the same as ID (don't break it)
412 ($JLcm | $JVcm | $JTcm | $H2cm | $H3cm) $INcm;
413 ($JLcm | $JVcm | $JTcm | $H2cm | $H3cm) $POcm;
414 $PRcm ($JLcm | $JVcm | $JTcm | $H2cm | $H3cm);
417 # LB 28 Do not break between alphabetics
419 ($ALcm | $HLcm) ($ALcm | $HLcm);
420 $CM+ ($ALcm | $HLcm); # The $CM+ is from rule 10, an unattached CM is treated as AL
423 $IScm ($ALcm | $HLcm);
426 ($ALcm | $HLcm | $NUcm) $OPcm;
427 $CM+ $OPcm; # The $CM+ is from rule 10, an unattached CM is treated as AL.
428 $CPcm ($ALcm | $HLcm | $NUcm);
430 # LB 30a Do not break between regional indicators.
433 # Special forward rule for people & body part emoji:
434 # don't break between relevant emoji and $EmojiMods
435 $EmojiForMods $EmojiVar? $EmojiMods;
440 ## -------------------------------------------------
476 # Sequences of the form (shown forwards)
477 # [CANT_CM] <break> [CM] [whatever]
478 # The CM needs to behave as an AL
481 [$BK $CR $LF $NL $ZW {eof}] |
483 $SP+ $CM* ([^$OP $CM $SP] | [$AL {eof}])); # if LB 14 will match, need to surpress this break.
484 # LB14 says OP SP* x .
485 # becomes OP SP* x AL
486 # becomes OP SP* x CM+ AL_FOLLOW
488 # Further note: the $AL in [$AL {eof}] is only to work around
489 # a rule compiler bug which complains about
490 # empty sets otherwise.
493 # Sequences of the form (shown forwards)
494 # [CANT_CM] <break> [CM] <break> [PR]
495 # The CM needs to behave as an AL
496 # This rule is concerned about getting the second of the two <breaks> in place.
499 [$PR ] / $CM+ [$BK $CR $LF $NL $ZW $SP {eof}];
505 $LB4Breaks [$LB4NonBreaks-$CM];
506 $LB4Breaks $CM+ $CAN_CM;
512 [$SP $ZW] [$LB4NonBreaks-$CM];
513 [$SP $ZW] $CM+ $CAN_CM;
515 # LB 8 ZW SP* <break>
516 # TODO: to implement this, we need more than one look-ahead hard break in play at a time.
517 # Requires an engine enhancement.
520 # Special reverse rule for people & body part emoji:
521 # don't break $ZWJ from subsequent $EmojiForSeqs
522 $EmojiForSeqs $ZWJ $EmojiMods? $EmojiVar? $EmojiForSeqs;
524 # LB 9,10 Combining marks.
525 # X $CM needs to behave like X, where X is not $SP or controls.
526 # $CM not covered by the above needs to behave like $AL
527 # Stick together any combining sequences that don't match other rules.
532 $CM* $WJ $CM* $CAN_CM;
533 $CM* $WJ [$LB8NonBreaks-$CM];
536 $CM* $CAN_CM $CM* $WJ;
541 $CM* $GL $CM* [$LB8NonBreaks-[$CM $SP $BA $HY]];
547 $CM* $CAN_CM $CM* $GL;
557 $CL [$LB8NonBreaks-$CM];
558 $CP [$LB8NonBreaks-$CM];
559 $EX [$LB8NonBreaks-$CM];
560 $IS [$LB8NonBreaks-$CM];
561 $SY [$LB8NonBreaks-$CM];
563 # Rule 13 & 14 taken together for an edge case.
564 # Match this, shown forward
565 # OP SP+ ($CM+ behaving as $AL) (CL | CP | EX | IS | IY)
566 # This really wants to chain at the $CM+ (which is acting as an $AL)
567 # except for $CM chaining being disabled.
568 [$CL $CP $EX $IS $SY] $CM+ $SP+ $CM* $OP;
572 $CM* $CAN_CM $SP* $CM* $OP;
573 $CANT_CM $SP* $CM* $OP;
574 $AL_FOLLOW? $CM+ $SP $SP* $CM* $OP; # by LB 10, behaves like $AL_FOLLOW? $AL $SP* $CM* $OP
576 $AL_FOLLOW_NOCM $CM+ $SP+ $CM* $OP;
577 $CM* $AL_FOLLOW_CM $CM+ $SP+ $CM* $OP;
578 $SY $CM $SP+ $OP; # TODO: Experiment. Remove.
583 $CM* $OP $SP* $CM* $QU;
586 # Don't include $NSX here
587 $CM* $NS $SP* $CM* ($CL | $CP);
590 $CM* $B2 $SP* $CM* $B2;
592 # LB 18 break after spaces
593 # Nothing explicit needed here.
599 $CM* $QU $CM* $CAN_CM; # . x QU
600 $CM* $QU $LB18NonBreaks;
603 $CM* $CAN_CM $CM* $QU; # QU x .
607 # LB 20 Break before and after CB.
608 # nothing needed here.
612 # Don't include $NSX here
613 $CM* ($BA | $HY | $NS) $CM* [$LB20NonBreaks-$CM]; # . x (BA | HY | NS)
615 $CM* [$LB20NonBreaks-$CM] $CM* $BB; # BB x .
619 [^$CB] $CM* ($HY | $BA) $CM* $HL;
625 $CM* $IN $CM* ($ALPlus | $HL);
627 # $CM* $IN $CM* $IN; # delete this rule for CSS loose
632 $CM* $NU $CM* ($ALPlus | $HL);
633 $CM* ($ALPlus | $HL) $CM* $NU;
637 $CM* ($ALPlus | $HL) $CM* $PR;
638 $CM* ($ALPlus | $HL) $CM* $PO;
642 ($CM* ($PR | $PO))? ($CM* ($CL | $CP))? ($CM* ($NU | $IS | $SY))* $CM* $NU ($CM* ($OP | $HY))? ($CM* ($PR | $PO))?;
645 $CM* ($H3 | $H2 | $JV | $JL) $CM* $JL;
646 $CM* ($JT | $JV) $CM* ($H2 | $JV);
647 $CM* $JT $CM* ($H3 | $JT);
650 $CM* $IN $CM* ($H3 | $H2 | $JT | $JV | $JL);
651 $CM* $PO $CM* ($H3 | $H2 | $JT | $JV | $JL);
652 $CM* ($H3 | $H2 | $JT | $JV | $JL) $CM* $PR;
655 $CM* ($ALPlus | $HL) $CM* ($ALPlus | $HL);
659 $CM* ($ALPlus | $HL) $CM* $IS;
662 $CM* $OP $CM* ($ALPlus | $HL | $NU);
663 $CM* ($ALPlus | $HL | $NU) $CM* $CP;
668 # Special reverse rule for people & body part emoji:
669 # don't break between relevant emoji and $EmojiMods
670 $EmojiMods $EmojiVar? $EmojiForMods;
672 ## -------------------------------------------------
677 $CM+ [^$CM $BK $CR $LF $NL $ZW $SP];
687 $SP+ $CM* ($CL | $CP);
693 $CM* ($HY | $BA) $CM* $HL;
696 ($CM* ($IS | $SY))+ $CM* $NU;
697 ($CL | $CP) $CM* ($NU | $IS | $SY);
699 # For dictionary-based break
700 $dictionary $dictionary;
702 ## -------------------------------------------------
706 # Skip forward over all character classes that are involved in
707 # rules containing patterns with possibly more than one char
710 # It might be slightly more efficient to have specific rules
711 # instead of one generic one, but only if we could
712 # turn off rule chaining. We don't want to move more
715 [$CM $OP $QU $CL $CP $B2 $PR $HY $BA $SP $dictionary]+ [^$CM $OP $QU $CL $CP $B2 $PR $HY $BA $dictionary];
716 $dictionary $dictionary;