1 # Copyright (C) 2016 and later: Unicode, Inc. and others.
2 # License & terms of use: http://www.unicode.org/copyright.html
3 # Copyright (c) 2002-2016 International Business Machines Corporation and
4 # others. All Rights Reserved.
9 # Implement default line breaking as defined by
10 # Unicode Standard Annex #14 Revision 37 for Unicode 9.0
11 # http://www.unicode.org/reports/tr14/
12 # tailored as noted in 2nd paragraph below.
14 # Includes extensions to the handling of emoji ZWJ sequences from
15 # https://goo.gl/cluFCn
17 # TODO: Rule LB 8 remains as it was in Unicode 5.2
18 # This is only because of a limitation of ICU break engine implementation,
19 # not because the older behavior is desirable.
21 # This tailors the line break behavior for Finnish, while otherwise behaving
22 # per UAX 14 which corresponds to CSS line-break=strict (BCP47 -u-lb-strict).
23 # It sets characters of class CJ to behave like NS.
25 # This corresponds to CSS line-break=strict (BCP47 -u-lb-strict).
26 # It sets characters of class CJ to behave like NS.
29 # Character Classes defined by TR 14.
34 $AI = [:LineBreak = Ambiguous:];
35 $AL = [:LineBreak = Alphabetic:];
36 $BA = [:LineBreak = Break_After:];
37 $HH = [\u2010]; # \u2010 is HYPHEN, default line break is BA.
38 $BB = [:LineBreak = Break_Before:];
39 $BK = [:LineBreak = Mandatory_Break:];
40 $B2 = [:LineBreak = Break_Both:];
41 $CB = [:LineBreak = Contingent_Break:];
42 $CJ = [:LineBreak = Conditional_Japanese_Starter:];
43 $CL = [:LineBreak = Close_Punctuation:];
44 # $CM = [:LineBreak = Combining_Mark:];
45 $CP = [:LineBreak = Close_Parenthesis:];
46 $CR = [:LineBreak = Carriage_Return:];
47 $EB = [[:LineBreak = EB:] \U0001F46A-\U0001F46D\U0001F46F\U0001F91D\U0001F93C];
48 $EM = [:LineBreak = EM:];
49 $EX = [:LineBreak = Exclamation:];
50 $GL = [:LineBreak = Glue:];
51 $HL = [:LineBreak = Hebrew_Letter:];
52 $HY = [:LineBreak = Hyphen:];
53 $H2 = [:LineBreak = H2:];
54 $H3 = [:LineBreak = H3:];
55 $ID = [:LineBreak = Ideographic:];
56 $IN = [:LineBreak = Inseperable:];
57 $IS = [:LineBreak = Infix_Numeric:];
58 $JL = [:LineBreak = JL:];
59 $JV = [:LineBreak = JV:];
60 $JT = [:LineBreak = JT:];
61 $LF = [:LineBreak = Line_Feed:];
62 $NL = [:LineBreak = Next_Line:];
63 # NS includes CJ for CSS strict line breaking.
64 $NS = [[:LineBreak = Nonstarter:] $CJ];
65 $NU = [:LineBreak = Numeric:];
66 $OP = [:LineBreak = Open_Punctuation:];
67 $PO = [:LineBreak = Postfix_Numeric:];
68 $PR = [:LineBreak = Prefix_Numeric:];
69 $QU = [:LineBreak = Quotation:];
70 $RI = [:LineBreak = Regional_Indicator:];
71 $SA = [:LineBreak = Complex_Context:];
72 $SG = [:LineBreak = Surrogate:];
73 $SP = [:LineBreak = Space:];
74 $SY = [:LineBreak = Break_Symbols:];
75 $WJ = [:LineBreak = Word_Joiner:];
76 $XX = [:LineBreak = Unknown:];
77 $ZW = [:LineBreak = ZWSpace:];
78 $ZWJ = [:LineBreak = ZWJ:];
80 $EmojiNRK = [[\p{Emoji}] - [$RI \u002a\u00230-9©®™〰〽]];
81 # Data for Extended Pictographic scraped from CLDR common/properties/ExtendedPictographic.txt, r13267
82 $Extended_Pict = [\U0001F774-\U0001F77F\U00002700-\U00002701\U00002703-\U00002704\U0000270E\U00002710-\U00002711\U00002765-\U00002767\U0001F030-\U0001F093\U0001F094-\U0001F09F\U0001F10D-\U0001F10F\U0001F12F\U0001F16C-\U0001F16F\U0001F1AD-\U0001F1E5\U0001F260-\U0001F265\U0001F203-\U0001F20F\U0001F23C-\U0001F23F\U0001F249-\U0001F24F\U0001F252-\U0001F25F\U0001F266-\U0001F2FF\U0001F7D5-\U0001F7FF\U0001F000-\U0001F003\U0001F005-\U0001F02B\U0001F02C-\U0001F02F\U0001F322-\U0001F323\U0001F394-\U0001F395\U0001F398\U0001F39C-\U0001F39D\U0001F3F1-\U0001F3F2\U0001F3F6\U0001F4FE\U0001F53E-\U0001F548\U0001F54F\U0001F568-\U0001F56E\U0001F571-\U0001F572\U0001F57B-\U0001F586\U0001F588-\U0001F589\U0001F58E-\U0001F58F\U0001F591-\U0001F594\U0001F597-\U0001F5A3\U0001F5A6-\U0001F5A7\U0001F5A9-\U0001F5B0\U0001F5B3-\U0001F5BB\U0001F5BD-\U0001F5C1\U0001F5C5-\U0001F5D0\U0001F5D4-\U0001F5DB\U0001F5DF-\U0001F5E0\U0001F5E2\U0001F5E4-\U0001F5E7\U0001F5E9-\U0001F5EE\U0001F5F0-\U0001F5F2\U0001F5F4-\U0001F5F9\U00002605\U00002607-\U0000260D\U0000260F-\U00002610\U00002612\U00002616-\U00002617\U00002619-\U0000261C\U0000261E-\U0000261F\U00002621\U00002624-\U00002625\U00002627-\U00002629\U0000262B-\U0000262D\U00002630-\U00002637\U0000263B-\U00002647\U00002654-\U0000265F\U00002661-\U00002662\U00002664\U00002667\U00002669-\U0000267A\U0000267C-\U0000267E\U00002680-\U00002691\U00002695\U00002698\U0000269A\U0000269D-\U0000269F\U000026A2-\U000026A9\U000026AC-\U000026AF\U000026B2-\U000026BC\U000026BF-\U000026C3\U000026C6-\U000026C7\U000026C9-\U000026CD\U000026D0\U000026D2\U000026D5-\U000026E8\U000026EB-\U000026EF\U000026F6\U000026FB-\U000026FC\U000026FE-\U000026FF\U00002388\U0001FA00-\U0001FFFD\U0001F0A0-\U0001F0AE\U0001F0B1-\U0001F0BF\U0001F0C1-\U0001F0CF\U0001F0D1-\U0001F0F5\U0001F0AF-\U0001F0B0\U0001F0C0\U0001F0D0\U0001F0F6-\U0001F0FF\U0001F80C-\U0001F80F\U0001F848-\U0001F84F\U0001F85A-\U0001F85F\U0001F888-\U0001F88F\U0001F8AE-\U0001F8FF\U0001F900-\U0001F90B\U0001F91F\U0001F928-\U0001F92F\U0001F931-\U0001F932\U0001F94C\U0001F95F-\U0001F96B\U0001F992-\U0001F997\U0001F9D0-\U0001F9E6\U0001F90C-\U0001F90F\U0001F93F\U0001F94D-\U0001F94F\U0001F96C-\U0001F97F\U0001F998-\U0001F9BF\U0001F9C1-\U0001F9CF\U0001F9E7-\U0001F9FF\U0001F6C6-\U0001F6CA\U0001F6D3-\U0001F6D4\U0001F6E6-\U0001F6E8\U0001F6EA\U0001F6F1-\U0001F6F2\U0001F6F7-\U0001F6F8\U0001F6D5-\U0001F6DF\U0001F6ED-\U0001F6EF\U0001F6F9-\U0001F6FF];
84 # By LB9, a ZWJ also behaves as a CM. Including it in the definition of CM avoids having to explicitly
85 # list it in the numerous rules that use CM.
86 # By LB1, SA characters with general categor of Mn or Mc also resolve to CM.
88 $CM = [[:LineBreak = Combining_Mark:] $ZWJ [$SA & [[:Mn:][:Mc:]]]];
90 # Dictionary character set, for triggering language-based break engines. Currently
91 # limited to LineBreak=Complex_Context (SA).
96 # Rule LB1. By default, treat AI (characters with ambiguous east Asian width),
97 # SA (Dictionary chars, excluding Mn and Mc)
98 # SG (Unpaired Surrogates)
99 # XX (Unknown, unassigned)
100 # as $AL (Alphabetic)
102 $ALPlus = [$AL $AI $SG $XX [$SA-[[:Mn:][:Mc:]]]];
105 ## -------------------------------------------------
110 # CAN_CM is the set of characters that may combine with CM combining chars.
111 # Note that Linebreak UAX 14's concept of a combining char and the rules
112 # for what they can combine with are _very_ different from the rest of Unicode.
114 # Note that $CM itself is left out of this set. If CM is needed as a base
115 # it must be listed separately in the rule.
117 $CAN_CM = [^$SP $BK $CR $LF $NL $ZW $CM]; # Bases that can take CMs
118 $CANT_CM = [ $SP $BK $CR $LF $NL $ZW $CM]; # Bases that can't take CMs
121 # AL_FOLLOW set of chars that can unconditionally follow an AL
122 # Needed in rules where stand-alone $CM s are treated as AL.
124 $AL_FOLLOW = [$BK $CR $LF $NL $ZW $SP $CL $CP $EX $HL $IS $SY $WJ $GL $OP $QU $BA $HH $HY $NS $IN $NU $PR $PO $ALPlus];
128 # Rule LB 4, 5 Mandatory (Hard) breaks.
130 $LB4Breaks = [$BK $CR $LF $NL];
131 $LB4NonBreaks = [^$BK $CR $LF $NL $CM];
135 # LB 6 Do not break before hard line breaks.
137 $LB4NonBreaks? $LB4Breaks {100}; # LB 5 do not break before hard breaks.
138 $CAN_CM $CM* $LB4Breaks {100};
139 ^$CM+ $LB4Breaks {100};
143 $LB4NonBreaks [$SP $ZW];
144 $CAN_CM $CM* [$SP $ZW];
148 # LB 8 Break after zero width space
149 # TODO: ZW SP* <break>
150 # An engine change is required to write the reverse rule for this.
151 # For now, leave the Unicode 5.2 rule, ZW <break>
153 $LB8Breaks = [$LB4Breaks $ZW];
154 $LB8NonBreaks = [[$LB4NonBreaks] - [$ZW]];
156 # LB 8a ZWJ x (ID | Extended_Pict | EmojiNRK) Emoji ZWJ sequences.
158 $ZWJ ($ID | $Extended_Pict | $EmojiNRK);
160 # LB 9 Combining marks. X $CM needs to behave like X, where X is not $SP, $BK $CR $LF $NL
161 # $CM not covered by the above needs to behave like $AL
162 # See definition of $CAN_CM.
164 $CAN_CM $CM+; # Stick together any combining sequences that don't match other rules.
168 # LB 11 Do not break before or after WORD JOINER & related characters.
177 # LB 12 Do not break after NBSP and related characters.
183 # LB 12a Do not break before NBSP and related characters ...
186 [[$LB8NonBreaks] - [$SP $BA $HH $HY]] $CM* $GL;
192 # LB 13 Don't break before ']' or '!' or ';' or '/', even after spaces.
196 ^$CM+ $CL; # by rule 10, stand-alone CM behaves as AL
200 ^$CM+ $CP; # by rule 10, stand-alone CM behaves as AL
204 ^$CM+ $EX; # by rule 10, stand-alone CM behaves as AL
208 ^$CM+ $IS; # by rule 10, stand-alone CM behaves as AL
212 ^$CM+ $SY; # by rule 10, stand-alone CM behaves as AL
216 # LB 14 Do not break after OP, even after spaces
220 $OP $CM* $SP+ $CM+ $AL_FOLLOW?; # by rule 10, stand-alone CM behaves as AL
221 # by rule 8, CM following a SP is stand-alone.
227 ($CL | $CP) $CM* $SP* $NS;
233 # LB 18 Break after spaces.
235 $LB18NonBreaks = [$LB8NonBreaks - [$SP]];
236 $LB18Breaks = [$LB8Breaks $SP];
241 $LB18NonBreaks $CM* $QU;
252 $LB20NonBreaks = [$LB18NonBreaks - $CB];
254 # LB 20.09 added rule for Finnish tailoring
255 # LB 21 x (BA | HY | NS)
258 $LB20NonBreaks $CM* ($BA | $HH | $HY | $NS) $CM* / $AL;
259 $LB20NonBreaks $CM* ($BA | $HH | $HY | $NS);
261 ^$CM+ ($BA | $HY | $HH | $NS);
263 $BB $CM* [^$CB]; # $BB x
264 $BB $CM* $LB20NonBreaks;
266 # LB 21a Don't break after Hebrew + Hyphen
269 $HL $CM* ($HY | $BA | $HH) $CM* [^$CB]?;
271 # LB 21b (forward) Don't break between SY and HL
272 # (break between HL and SY already disallowed by LB 13 above)
276 ($ALPlus | $HL) $CM* $IN;
277 ^$CM+ $IN; # by rule 10, any otherwise unattached CM behaves as AL
279 ($ID | $EB | $EM) $CM* $IN;
286 ($ALPlus | $HL) $CM* $NU;
287 ^$CM+ $NU; # Rule 10, any otherwise unattached CM behaves as AL
288 $NU $CM* ($ALPlus | $HL);
292 $PR $CM* ($ID | $EB | $EM);
293 ($ID | $EB | $EM) $CM* $PO;
299 ($PR | $PO) $CM* ($ALPlus | $HL);
300 ($ALPlus | $HL) $CM* ($PR | $PO);
301 ^$CM+ ($PR | $PO); # Rule 10, any otherwise unattached CM behaves as AL
306 (($PR | $PO) $CM*)? (($OP | $HY) $CM*)? $NU ($CM* ($NU | $SY | $IS))*
307 ($CM* ($CL | $CP))? ($CM* ($PR | $PO))?;
309 # LB 26 Do not break a Korean syllable
311 $JL $CM* ($JL | $JV | $H2 | $H3);
312 ($JV | $H2) $CM* ($JV | $JT);
313 ($JT | $H3) $CM* $JT;
315 # LB 27 Treat korean Syllable Block the same as ID (don't break it)
316 ($JL | $JV | $JT | $H2 | $H3) $CM* $IN;
317 ($JL | $JV | $JT | $H2 | $H3) $CM* $PO;
318 $PR $CM* ($JL | $JV | $JT | $H2 | $H3);
321 # LB 28 Do not break between alphabetics
323 ($ALPlus | $HL) $CM* ($ALPlus | $HL);
324 ^$CM+ ($ALPlus | $HL); # The $CM+ is from rule 10, an unattached CM is treated as AL
327 $IS $CM* ($ALPlus | $HL);
330 ($ALPlus | $HL | $NU) $CM* $OP;
331 ^$CM+ $OP; # The $CM+ is from rule 10, an unattached CM is treated as AL.
332 $CP $CM* ($ALPlus | $HL | $NU);
334 # LB 30a Do not break between regional indicators. Break after pairs of them.
335 # Tricky interaction with LB8a: ZWJ x ID
336 $RI $CM* $RI / [[^$BK $CR $LF $NL $SP $ZW $WJ $CL $CP $EX $IS $SY $GL $QU $BA $HY $NS $CM] {eof}];
337 $RI $CM* $RI $CM* $ZWJ / [[^$BK $CR $LF $NL $SP $ZW $WJ $CL $CP $EX $IS $SY $GL $QU $BA $HY $NS $CM $ID $Extended_Pict $EmojiNRK] {eof}];
338 $RI $CM* $RI $CM* [$CM-$ZWJ] / [[^$BK $CR $LF $NL $SP $ZW $WJ $CL $CP $EX $IS $SY $GL $QU $BA $HY $NS $CM] {eof}];
340 $RI $CM* $RI $CM* [$BK $CR $LF $NL $SP $ZW $WJ $CL $CP $EX $IS $SY $GL $QU $BA $HY $NS {eof}];
341 $RI $CM* $RI $CM* $ZWJ ($ID | $Extended_Pict | $EmojiNRK);
343 # LB 30b Do not break between an Emoji Base and an Emoji Modifier
349 ## -------------------------------------------------
353 # LB 9 Combining Marks.
354 # Stick together any combining sequences that don't match other rules.
359 # Sequences of the form (shown forwards)
360 # [CANT_CM] <break> [CM] [whatever]
361 # The CM needs to behave as an AL
364 [$BK $CR $LF $NL $ZW {eof}] |
366 $SP+ $CM* ([^$OP $CM $SP] | [$AL {eof}])); # if LB 14 will match, need to surpress this break.
367 # LB14 says OP SP* x .
368 # becomes OP SP* x AL
369 # becomes OP SP* x CM+ AL_FOLLOW
371 # Further note: the $AL in [$AL {eof}] is only to work around
372 # a rule compiler bug which complains about
373 # empty sets otherwise.
378 $LB4Breaks [$LB4NonBreaks-$CM];
379 $LB4Breaks $CM+ $CAN_CM;
385 [$SP $ZW] [$LB4NonBreaks-$CM];
386 [$SP $ZW] $CM+ $CAN_CM;
388 # LB 8 ZW SP* <break>
389 # TODO: to implement this, we need more than one look-ahead hard break in play at a time.
390 # Requires an engine enhancement.
393 # LB 8a ZWJ x (ID | Extended_Pict | EmojiNRK)
395 ($ID | $Extended_Pict | $EmojiNRK) $ZWJ $CM* $CAN_CM?;
398 # LB 9,10 Combining marks.
399 # X $CM needs to behave like X, where X is not $SP or controls.
400 # $CM not covered by the above needs to behave like $AL
401 # Stick together any combining sequences that don't match other rules.
408 $WJ [$LB8NonBreaks-$CM];
416 $GL $CM* [$LB8NonBreaks-[$CM $SP $BA $HH $HY]];
432 $CL [$LB8NonBreaks-$CM];
433 $CP [$LB8NonBreaks-$CM];
434 $EX [$LB8NonBreaks-$CM];
435 $IS [$LB8NonBreaks-$CM];
436 $SY [$LB8NonBreaks-$CM];
442 $AL_FOLLOW? $CM+ $SP+ $CM* $OP; # by LB 10, behaves like $AL_FOLLOW? $AL $SP+ $CM* $OP
449 $NS $SP* $CM* ($CL | $CP);
454 # LB 18 break after spaces
455 # Nothing explicit needed here.
461 $QU $CM* $CAN_CM; # . x QU
465 $CAN_CM $CM* $QU; # QU x .
469 # LB 20 Break before and after CB.
470 # nothing needed here.
473 # LB 20.09 added rule for Finnish tailoring
474 $AL ($HY | $HH) / $SP;
477 ($BA | $HH | $HY | $NS) $CM* [$LB20NonBreaks-$CM]; # . x (BA | HY | NS)
479 [$LB20NonBreaks-$CM] $CM* $BB; # BB x .
483 [^$CB] $CM* ($HY | $BA | $HH) $CM* $HL;
489 $IN $CM* ($ALPlus | $HL);
491 $IN $CM* ($ID | $EB | $EM);
496 $NU $CM* ($ALPlus | $HL);
497 ($ALPlus | $HL) $CM* $NU;
500 ($ID | $EB | $EM) $CM* $PR;
501 $PO $CM* ($ID | $EB | $EM);
504 ($ALPlus | $HL) $CM* ($PR | $PO);
505 ($PR | $PO) $CM* ($ALPlus | $HL);
509 ($CM* ($PR | $PO))? ($CM* ($CL | $CP))? ($CM* ($NU | $IS | $SY))* $CM* $NU ($CM* ($OP | $HY))? ($CM* ($PR | $PO))?;
512 ($H3 | $H2 | $JV | $JL) $CM* $JL;
513 ($JT | $JV) $CM* ($H2 | $JV);
514 $JT $CM* ($H3 | $JT);
517 $IN $CM* ($H3 | $H2 | $JT | $JV | $JL);
518 $PO $CM* ($H3 | $H2 | $JT | $JV | $JL);
519 ($H3 | $H2 | $JT | $JV | $JL) $CM* $PR;
522 ($ALPlus | $HL) $CM* ($ALPlus | $HL);
526 ($ALPlus | $HL) $CM* $IS;
529 $OP $CM* ($ALPlus | $HL | $NU);
530 ($ALPlus | $HL | $NU) $CM* $CP;
533 # Pairs of Regional Indicators.
534 # The following two rules are nearly identical. The first matches only sequences with an odd number of adjacent RIs,
535 # the second with an even number. Stripping away the cruft they look like
536 # [^RI] RI / (RI RI)+ ^RI;
537 # [^RI] RI RI / (RI RI)+ ^RI;
539 [{bof} $NS $HY $BA $QU $CL $CP $EX $IS $SY $WJ $GL $ZW $SP $BK $CR $LF $NL $ZWJ] $CM* $RI / ($CM* $RI $CM* $RI)+ $CM* [{eof}[^$RI $CM]];
540 [{bof} $NS $HY $BA $QU $CL $CP $EX $IS $SY $WJ $GL $ZW $SP $BK $CR $LF $NL $ZWJ] $CM* $RI $CM* $RI / ($CM* $RI $CM* $RI)+ $CM* [{eof}[^$RI $CM]];
542 # In general, adjacent RIs stay together. The hard-break rules, above, overide this, forcing in the boundaries between pairs.
545 # WJ, GL, QU, etc. are classes with rules like "WJ x " which includes "WJ x RI".
546 $RI $CM* ([$WJ $GL $QU $BB] | (($HY | $BA)$CM* $HL));
549 # LB 30b Do not break between an Emoji Base and an Emoji Modifier
553 ## -------------------------------------------------
558 ^$CM+ [^$CM $BK $CR $LF $NL $ZW $SP];
568 $SP+ $CM* ($CL | $CP);
574 $CM* ($HY | $BA | $HH) $CM* $HL;
577 ($CM* ($IS | $SY))+ $CM* $NU;
578 ($CL | $CP) $CM* ($NU | $IS | $SY);
583 # For dictionary-based break
584 $dictionary $dictionary;
586 ## -------------------------------------------------
590 # Skip forward over all character classes that are involved in
591 # rules containing patterns with possibly more than one char
594 # It might be slightly more efficient to have specific rules
595 # instead of one generic one, but only if we could
596 # turn off rule chaining. We don't want to move more
599 ^[$CM $OP $QU $CL $CP $B2 $PR $HY $BA $SP $RI $ZWJ $dictionary]+ [^$CM $OP $QU $CL $CP $B2 $PR $HY $BA $RI $ZWJ $dictionary];
600 $dictionary $dictionary;