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.
15 # This corresponds to CSS line-break=strict (BCP47 -u-lb-strict).
16 # It sets characters of class CJ to behave like NS.
19 # Character Classes defined by TR 14.
28 # !!lookAheadHardBreak Described here because it is (as yet) undocumented elsewhere
29 # and only used for the line break rules.
31 # It is used in the implementation of rule LB 10
32 # which says to treat any combining mark that is not attached to a base
33 # character as if it were of class AL (alphabetic).
35 # The problem occurs in the reverse rules.
37 # Consider a sequence like, with correct breaks as shown
40 # Then consider the sequence without the initial ID (ideographic)
43 # Our CM, which in the first example was attached to the ideograph,
44 # is now unattached, becomes an alpha, and joins in with the other
47 # When iterating forwards, these sequences do not present any problems
48 # When iterating backwards, we need to look ahead when encountering
49 # a CM to see whether it attaches to something further on or not.
50 # (Look-ahead in a reverse rule is looking towards the start)
52 # If the CM is unattached, we need to force a break.
54 # !!lookAheadHardBreak forces the run time state machine to
55 # stop immediately when a look ahead rule ( '/' operator) matches,
56 # and set the match position to that of the look-ahead operator,
57 # no matter what other rules may be in play at the time.
59 # See rule LB 19 for an example.
62 $AI = [:LineBreak = Ambiguous:];
63 $AL = [:LineBreak = Alphabetic:];
64 $BA = [:LineBreak = Break_After:];
65 $BB = [:LineBreak = Break_Before:];
66 $BK = [:LineBreak = Mandatory_Break:];
67 $B2 = [:LineBreak = Break_Both:];
68 $CB = [:LineBreak = Contingent_Break:];
69 $CJ = [:LineBreak = Conditional_Japanese_Starter:];
70 $CL = [:LineBreak = Close_Punctuation:];
71 $CM = [:LineBreak = Combining_Mark:];
72 $CP = [:LineBreak = Close_Parenthesis:];
73 $CR = [:LineBreak = Carriage_Return:];
74 $EX = [:LineBreak = Exclamation:];
75 $GL = [:LineBreak = Glue:];
76 $HL = [:LineBreak = Hebrew_Letter:];
77 $HY = [:LineBreak = Hyphen:];
78 $H2 = [:LineBreak = H2:];
79 $H3 = [:LineBreak = H3:];
80 $ID = [:LineBreak = Ideographic:];
81 $IN = [:LineBreak = Inseperable:];
82 $IS = [:LineBreak = Infix_Numeric:];
83 $JL = [:LineBreak = JL:];
84 $JV = [:LineBreak = JV:];
85 $JT = [:LineBreak = JT:];
86 $LF = [:LineBreak = Line_Feed:];
87 $NL = [:LineBreak = Next_Line:];
88 $NS = [[:LineBreak = Nonstarter:] $CJ];
89 $NU = [:LineBreak = Numeric:];
90 $OP = [:LineBreak = Open_Punctuation:];
91 $PO = [:LineBreak = Postfix_Numeric:];
92 $PR = [:LineBreak = Prefix_Numeric:];
93 $QU = [:LineBreak = Quotation:];
94 $RI = [:LineBreak = Regional_Indicator:];
95 $SA = [:LineBreak = Complex_Context:];
96 $SG = [:LineBreak = Surrogate:];
97 $SP = [:LineBreak = Space:];
98 $SY = [:LineBreak = Break_Symbols:];
99 $WJ = [:LineBreak = Word_Joiner:];
100 $XX = [:LineBreak = Unknown:];
101 $ZW = [:LineBreak = ZWSpace:];
103 # Special character classes for people & body part emoji:
107 # The following are subsets of $ID
108 $EmojiForSeqs = [\u2764 \U0001F466-\U0001F469 \U0001F48B];
109 $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];
110 $EmojiMods = [\U0001F3FB-\U0001F3FF];
112 # Dictionary character set, for triggering language-based break engines. Currently
113 # limited to LineBreak=Complex_Context. Note that this set only works in Unicode
114 # 5.0 or later as the definition of Complex_Context was corrected to include all
115 # characters requiring dictionary break.
117 $dictionary = [:LineBreak = Complex_Context:];
120 # Rule LB1. By default, treat AI (characters with ambiguous east Asian width),
121 # SA (South East Asian: Thai, Lao, Khmer)
122 # SG (Unpaired Surrogates)
123 # XX (Unknown, unassigned)
124 # as $AL (Alphabetic)
126 $ALPlus = [$AL $AI $SA $SG $XX];
129 # Combining Marks. X $CM* behaves as if it were X. Rule LB6.
131 $ALcm = $ALPlus $CM*;
159 ## -------------------------------------------------
164 # Each class of character can stand by itself as an unbroken token, with trailing combining stuff
195 # CAN_CM is the set of characters that may combine with CM combining chars.
196 # Note that Linebreak UAX 14's concept of a combining char and the rules
197 # for what they can combine with are _very_ different from the rest of Unicode.
199 # Note that $CM itself is left out of this set. If CM is needed as a base
200 # it must be listed separately in the rule.
202 $CAN_CM = [^$SP $BK $CR $LF $NL $ZW $CM]; # Bases that can take CMs
203 $CANT_CM = [ $SP $BK $CR $LF $NL $ZW $CM]; # Bases that can't take CMs
206 # AL_FOLLOW set of chars that can unconditionally follow an AL
207 # Needed in rules where stand-alone $CM s are treated as AL.
208 # Chaining is disabled with CM because it causes other failures,
209 # so for this one case we need to manually list out longer sequences.
211 $AL_FOLLOW_NOCM = [$BK $CR $LF $NL $ZW $SP];
212 $AL_FOLLOW_CM = [$CL $CP $EX $HL $IS $SY $WJ $GL $OP $QU $BA $HY $NS $IN $NU $ALPlus];
213 $AL_FOLLOW = [$AL_FOLLOW_NOCM $AL_FOLLOW_CM];
217 # Rule LB 4, 5 Mandatory (Hard) breaks.
219 $LB4Breaks = [$BK $CR $LF $NL];
220 $LB4NonBreaks = [^$BK $CR $LF $NL];
224 # LB 6 Do not break before hard line breaks.
226 $LB4NonBreaks? $LB4Breaks {100}; # LB 5 do not break before hard breaks.
227 $CAN_CM $CM* $LB4Breaks {100};
228 $CM+ $LB4Breaks {100};
232 $LB4NonBreaks [$SP $ZW];
233 $CAN_CM $CM* [$SP $ZW];
237 # LB 8 Break after zero width space
238 # TODO: ZW SP* <break>
239 # An engine change is required to write the reverse rule for this.
240 # For now, leave the Unicode 5.2 rule, ZW <break>
242 $LB8Breaks = [$LB4Breaks $ZW];
243 $LB8NonBreaks = [[$LB4NonBreaks] - [$ZW]];
246 # Special forward rule for people & body part emoji:
247 # don't break $ZWJ from subsequent $EmojiForSeqs
248 $EmojiForSeqs $EmojiVar? $EmojiMods? $ZWJ $EmojiForSeqs;
250 # LB 9 Combining marks. X $CM needs to behave like X, where X is not $SP, $BK $CR $LF $NL
251 # $CM not covered by the above needs to behave like $AL
252 # See definition of $CAN_CM.
254 $CAN_CM $CM+; # Stick together any combining sequences that don't match other rules.
258 # LB 11 Do not break before or after WORD JOINER & related characters.
268 # LB 12 Do not break after NBSP and related characters.
275 # LB 12a Do not break before NBSP and related characters ...
278 [[$LB8NonBreaks] - [$SP $BA $HY]] $CM* $GLcm;
284 # LB 13 Don't break before ']' or '!' or ';' or '/', even after spaces.
288 $CM+ $CL; # by rule 10, stand-alone CM behaves as AL
292 $CM+ $CP; # by rule 10, stand-alone CM behaves as AL
296 $CM+ $EX; # by rule 10, stand-alone CM behaves as AL
300 $CM+ $IS; # by rule 10, stand-alone CM behaves as AL
304 $CM+ $SY; # by rule 10, stand-alone CM behaves as AL
308 # LB 14 Do not break after OP, even after spaces
310 $OPcm $SP* $CAN_CM $CM*;
313 $OPcm $SP+ $CM+ $AL_FOLLOW?; # by rule 10, stand-alone CM behaves as AL
319 ($CLcm | $CPcm) $SP* $NScm;
325 # LB 18 Break after spaces.
327 $LB18NonBreaks = [$LB8NonBreaks - [$SP]];
328 $LB18Breaks = [$LB8Breaks $SP];
333 $LB18NonBreaks $CM* $QUcm;
338 $QUcm $LB18NonBreaks $CM*; # Don't let a combining mark go onto $CR, $BK, etc.
339 # TODO: I don't think this rule is needed.
346 $LB20NonBreaks = [$LB18NonBreaks - $CB];
348 # LB 21 x (BA | HY | NS)
351 $LB20NonBreaks $CM* ($BAcm | $HYcm | $NScm);
353 $BBcm [^$CB]; # $BB x
354 $BBcm $LB20NonBreaks $CM*;
356 # LB 21a Don't break after Hebrew + Hyphen
359 $HLcm ($HYcm | $BAcm) [^$CB]?;
361 # LB 21b (forward) Don't break between SY and HL
362 # (break between HL and SY already disallowed by LB 13 above)
366 ($ALcm | $HLcm) $INcm;
367 $CM+ $INcm; # by rule 10, any otherwise unattached CM behaves as AL
375 $ALcm $NUcm; # includes $LB19
377 $CM+ $NUcm; # Rule 10, any otherwise unattached CM behaves as AL
385 $PRcm ($ALcm | $HLcm);
386 $POcm ($ALcm | $HLcm);
391 ($PRcm | $POcm)? ($OPcm | $HYcm)? $NUcm ($NUcm | $SYcm | $IScm)* ($CLcm | $CPcm)? ($PRcm | $POcm)?;
393 # LB 26 Do not break a Korean syllable
395 $JLcm ($JLcm | $JVcm | $H2cm | $H3cm);
396 ($JVcm | $H2cm) ($JVcm | $JTcm);
397 ($JTcm | $H3cm) $JTcm;
399 # LB 27 Treat korean Syllable Block the same as ID (don't break it)
400 ($JLcm | $JVcm | $JTcm | $H2cm | $H3cm) $INcm;
401 ($JLcm | $JVcm | $JTcm | $H2cm | $H3cm) $POcm;
402 $PRcm ($JLcm | $JVcm | $JTcm | $H2cm | $H3cm);
405 # LB 28 Do not break between alphabetics
407 ($ALcm | $HLcm) ($ALcm | $HLcm);
408 $CM+ ($ALcm | $HLcm); # The $CM+ is from rule 10, an unattached CM is treated as AL
411 $IScm ($ALcm | $HLcm);
414 ($ALcm | $HLcm | $NUcm) $OPcm;
415 $CM+ $OPcm; # The $CM+ is from rule 10, an unattached CM is treated as AL.
416 $CPcm ($ALcm | $HLcm | $NUcm);
418 # LB 30a Do not break between regional indicators.
421 # Special forward rule for people & body part emoji:
422 # don't break between relevant emoji and $EmojiMods
423 $EmojiForMods $EmojiVar? $EmojiMods;
428 ## -------------------------------------------------
463 # Sequences of the form (shown forwards)
464 # [CANT_CM] <break> [CM] [whatever]
465 # The CM needs to behave as an AL
468 [$BK $CR $LF $NL $ZW {eof}] |
470 $SP+ $CM* ([^$OP $CM $SP] | [$AL {eof}])); # if LB 14 will match, need to surpress this break.
471 # LB14 says OP SP* x .
472 # becomes OP SP* x AL
473 # becomes OP SP* x CM+ AL_FOLLOW
475 # Further note: the $AL in [$AL {eof}] is only to work around
476 # a rule compiler bug which complains about
477 # empty sets otherwise.
480 # Sequences of the form (shown forwards)
481 # [CANT_CM] <break> [CM] <break> [PR]
482 # The CM needs to behave as an AL
483 # This rule is concerned about getting the second of the two <breaks> in place.
486 [$PR ] / $CM+ [$BK $CR $LF $NL $ZW $SP {eof}];
492 $LB4Breaks [$LB4NonBreaks-$CM];
493 $LB4Breaks $CM+ $CAN_CM;
499 [$SP $ZW] [$LB4NonBreaks-$CM];
500 [$SP $ZW] $CM+ $CAN_CM;
502 # LB 8 ZW SP* <break>
503 # TODO: to implement this, we need more than one look-ahead hard break in play at a time.
504 # Requires an engine enhancement.
507 # Special reverse rule for people & body part emoji:
508 # don't break $ZWJ from subsequent $EmojiForSeqs
509 $EmojiForSeqs $ZWJ $EmojiMods? $EmojiVar? $EmojiForSeqs;
511 # LB 9,10 Combining marks.
512 # X $CM needs to behave like X, where X is not $SP or controls.
513 # $CM not covered by the above needs to behave like $AL
514 # Stick together any combining sequences that don't match other rules.
519 $CM* $WJ $CM* $CAN_CM;
520 $CM* $WJ [$LB8NonBreaks-$CM];
523 $CM* $CAN_CM $CM* $WJ;
528 $CM* $GL $CM* [$LB8NonBreaks-[$CM $SP $BA $HY]];
534 $CM* $CAN_CM $CM* $GL;
544 $CL [$LB8NonBreaks-$CM];
545 $CP [$LB8NonBreaks-$CM];
546 $EX [$LB8NonBreaks-$CM];
547 $IS [$LB8NonBreaks-$CM];
548 $SY [$LB8NonBreaks-$CM];
550 # Rule 13 & 14 taken together for an edge case.
551 # Match this, shown forward
552 # OP SP+ ($CM+ behaving as $AL) (CL | CP | EX | IS | IY)
553 # This really wants to chain at the $CM+ (which is acting as an $AL)
554 # except for $CM chaining being disabled.
555 [$CL $CP $EX $IS $SY] $CM+ $SP+ $CM* $OP;
559 $CM* $CAN_CM $SP* $CM* $OP;
560 $CANT_CM $SP* $CM* $OP;
561 $AL_FOLLOW? $CM+ $SP $SP* $CM* $OP; # by LB 10, behaves like $AL_FOLLOW? $AL $SP* $CM* $OP
563 $AL_FOLLOW_NOCM $CM+ $SP+ $CM* $OP;
564 $CM* $AL_FOLLOW_CM $CM+ $SP+ $CM* $OP;
565 $SY $CM $SP+ $OP; # TODO: Experiment. Remove.
570 $CM* $OP $SP* $CM* $QU;
573 $CM* $NS $SP* $CM* ($CL | $CP);
576 $CM* $B2 $SP* $CM* $B2;
578 # LB 18 break after spaces
579 # Nothing explicit needed here.
585 $CM* $QU $CM* $CAN_CM; # . x QU
586 $CM* $QU $LB18NonBreaks;
589 $CM* $CAN_CM $CM* $QU; # QU x .
593 # LB 20 Break before and after CB.
594 # nothing needed here.
598 $CM* ($BA | $HY | $NS) $CM* [$LB20NonBreaks-$CM]; # . x (BA | HY | NS)
600 $CM* [$LB20NonBreaks-$CM] $CM* $BB; # BB x .
604 [^$CB] $CM* ($HY | $BA) $CM* $HL;
610 $CM* $IN $CM* ($ALPlus | $HL);
617 $CM* $NU $CM* ($ALPlus | $HL);
618 $CM* ($ALPlus | $HL) $CM* $NU;
622 $CM* ($ALPlus | $HL) $CM* $PR;
623 $CM* ($ALPlus | $HL) $CM* $PO;
627 ($CM* ($PR | $PO))? ($CM* ($CL | $CP))? ($CM* ($NU | $IS | $SY))* $CM* $NU ($CM* ($OP | $HY))? ($CM* ($PR | $PO))?;
630 $CM* ($H3 | $H2 | $JV | $JL) $CM* $JL;
631 $CM* ($JT | $JV) $CM* ($H2 | $JV);
632 $CM* $JT $CM* ($H3 | $JT);
635 $CM* $IN $CM* ($H3 | $H2 | $JT | $JV | $JL);
636 $CM* $PO $CM* ($H3 | $H2 | $JT | $JV | $JL);
637 $CM* ($H3 | $H2 | $JT | $JV | $JL) $CM* $PR;
640 $CM* ($ALPlus | $HL) $CM* ($ALPlus | $HL);
644 $CM* ($ALPlus | $HL) $CM* $IS;
647 $CM* $OP $CM* ($ALPlus | $HL | $NU);
648 $CM* ($ALPlus | $HL | $NU) $CM* $CP;
653 # Special reverse rule for people & body part emoji:
654 # don't break between relevant emoji and $EmojiMods
655 $EmojiMods $EmojiVar? $EmojiForMods;
657 ## -------------------------------------------------
662 $CM+ [^$CM $BK $CR $LF $NL $ZW $SP];
672 $SP+ $CM* ($CL | $CP);
678 $CM* ($HY | $BA) $CM* $HL;
681 ($CM* ($IS | $SY))+ $CM* $NU;
682 ($CL | $CP) $CM* ($NU | $IS | $SY);
684 # For dictionary-based break
685 $dictionary $dictionary;
687 ## -------------------------------------------------
691 # Skip forward over all character classes that are involved in
692 # rules containing patterns with possibly more than one char
695 # It might be slightly more efficient to have specific rules
696 # instead of one generic one, but only if we could
697 # turn off rule chaining. We don't want to move more
700 [$CM $OP $QU $CL $CP $B2 $PR $HY $BA $SP $dictionary]+ [^$CM $OP $QU $CL $CP $B2 $PR $HY $BA $dictionary];
701 $dictionary $dictionary;