1 # Copyright (c) 2002-2010 International Business Machines Corporation and
2 # others. All Rights Reserved.
7 # Implement default line breaking as defined by
8 # Unicode Standard Annex #14 Revision 24 for Unicode 6.0
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 $CL = [:LineBreak = Close_Punctuation:];
67 $CM = [:LineBreak = Combining_Mark:];
68 $CP = [:LineBreak = Close_Parenthesis:];
69 $CR = [:LineBreak = Carriage_Return:];
70 $EX = [:LineBreak = Exclamation:];
71 $GL = [:LineBreak = Glue:];
72 $HY = [:LineBreak = Hyphen:];
73 $H2 = [:LineBreak = H2:];
74 $H3 = [:LineBreak = H3:];
75 $ID = [:LineBreak = Ideographic:];
76 $IN = [:LineBreak = Inseperable:];
77 $IS = [:LineBreak = Infix_Numeric:];
78 $JL = [:LineBreak = JL:];
79 $JV = [:LineBreak = JV:];
80 $JT = [:LineBreak = JT:];
81 $LF = [:LineBreak = Line_Feed:];
82 $NL = [:LineBreak = Next_Line:];
83 $NS = [:LineBreak = Nonstarter:];
84 $NU = [:LineBreak = Numeric:];
85 $OP = [:LineBreak = Open_Punctuation:];
86 $PO = [:LineBreak = Postfix_Numeric:];
87 $PR = [:LineBreak = Prefix_Numeric:];
88 $QU = [:LineBreak = Quotation:];
89 $SA = [:LineBreak = Complex_Context:];
90 $SG = [:LineBreak = Surrogate:];
91 $SP = [:LineBreak = Space:];
92 $SY = [:LineBreak = Break_Symbols:];
93 $WJ = [:LineBreak = Word_Joiner:];
94 $XX = [:LineBreak = Unknown:];
95 $ZW = [:LineBreak = ZWSpace:];
97 # Dictionary character set, for triggering language-based break engines. Currently
98 # limited to LineBreak=Complex_Context. Note that this set only works in Unicode
99 # 5.0 or later as the definition of Complex_Context was corrected to include all
100 # characters requiring dictionary break.
102 $dictionary = [:LineBreak = Complex_Context:];
105 # Rule LB1. By default, treat AI (characters with ambiguous east Asian width),
106 # SA (South East Asian: Thai, Lao, Khmer)
107 # SG (Unpaired Surrogates)
108 # XX (Unknown, unassigned)
109 # as $AL (Alphabetic)
111 $ALPlus = [$AL $AI $SA $SG $XX];
114 # Combining Marks. X $CM* behaves as if it were X. Rule LB6.
116 $ALcm = $ALPlus $CM*;
142 ## -------------------------------------------------
147 # Each class of character can stand by itself as an unbroken token, with trailing combining stuff
176 # CAN_CM is the set of characters that may combine with CM combining chars.
177 # Note that Linebreak UAX 14's concept of a combining char and the rules
178 # for what they can combine with are _very_ different from the rest of Unicode.
180 # Note that $CM itself is left out of this set. If CM is needed as a base
181 # it must be listed separately in the rule.
183 $CAN_CM = [^$SP $BK $CR $LF $NL $ZW $CM]; # Bases that can take CMs
184 $CANT_CM = [ $SP $BK $CR $LF $NL $ZW $CM]; # Bases that can't take CMs
187 # AL_FOLLOW set of chars that can unconditionally follow an AL
188 # Needed in rules where stand-alone $CM s are treated as AL.
189 # Chaining is disabled with CM because it causes other failures,
190 # so for this one case we need to manually list out longer sequences.
192 $AL_FOLLOW_NOCM = [$BK $CR $LF $NL $ZW $SP];
193 $AL_FOLLOW_CM = [$CL $CP $EX $IS $SY $WJ $GL $OP $QU $BA $HY $NS $IN $NU $ALPlus];
194 $AL_FOLLOW = [$AL_FOLLOW_NOCM $AL_FOLLOW_CM];
198 # Rule LB 4, 5 Mandatory (Hard) breaks.
200 $LB4Breaks = [$BK $CR $LF $NL];
201 $LB4NonBreaks = [^$BK $CR $LF $NL];
205 # LB 6 Do not break before hard line breaks.
207 $LB4NonBreaks? $LB4Breaks {100}; # LB 5 do not break before hard breaks.
208 $CAN_CM $CM* $LB4Breaks {100};
209 $CM+ $LB4Breaks {100};
213 $LB4NonBreaks [$SP $ZW];
214 $CAN_CM $CM* [$SP $ZW];
218 # LB 8 Break after zero width space
219 # TODO: ZW SP* <break>
220 # An engine change is required to write the reverse rule for this.
221 # For now, leave the Unicode 5.2 rule, ZW <break>
223 $LB8Breaks = [$LB4Breaks $ZW];
224 $LB8NonBreaks = [[$LB4NonBreaks] - [$ZW]];
227 # LB 9 Combining marks. X $CM needs to behave like X, where X is not $SP, $BK $CR $LF $NL
228 # $CM not covered by the above needs to behave like $AL
229 # See definition of $CAN_CM.
231 $CAN_CM $CM+; # Stick together any combining sequences that don't match other rules.
235 # LB 11 Do not break before or after WORD JOINER & related characters.
245 # LB 12 Do not break after NBSP and related characters.
252 # LB 12a Do not break before NBSP and related characters ...
255 [[$LB8NonBreaks] - [$SP $BA $HY]] $CM* $GLcm;
261 # LB 13 Don't break before ']' or '!' or ';' or '/', even after spaces.
265 $CM+ $CL; # by rule 10, stand-alone CM behaves as AL
269 $CM+ $CP; # by rule 10, stand-alone CM behaves as AL
273 $CM+ $EX; # by rule 10, stand-alone CM behaves as AL
277 $CM+ $IS; # by rule 10, stand-alone CM behaves as AL
281 $CM+ $SY; # by rule 10, stand-alone CM behaves as AL
285 # LB 14 Do not break after OP, even after spaces
287 $OPcm $SP* $CAN_CM $CM*;
290 $OPcm $SP+ $CM+ $AL_FOLLOW?; # by rule 10, stand-alone CM behaves as AL
296 ($CLcm | $CPcm) $SP* $NScm;
302 # LB 18 Break after spaces.
304 $LB18NonBreaks = [$LB8NonBreaks - [$SP]];
305 $LB18Breaks = [$LB8Breaks $SP];
310 $LB18NonBreaks $CM* $QUcm;
315 $QUcm $LB18NonBreaks $CM*; # Don't let a combining mark go onto $CR, $BK, etc.
316 # TODO: I don't think this rule is needed.
323 $LB20NonBreaks = [$LB18NonBreaks - $CB];
325 # LB 21 x (BA | HY | NS)
328 $LB20NonBreaks $CM* ($BAcm | $HYcm | $NScm);
330 $BBcm [^$CB]; # $BB x
331 $BBcm $LB20NonBreaks $CM*;
335 $CM+ $INcm; # by rule 10, any otherwise unattached CM behaves as AL
343 $ALcm $NUcm; # includes $LB19
344 $CM+ $NUcm; # Rule 10, any otherwise unattached CM behaves as AL
357 ($PRcm | $POcm)? ($OPcm | $HYcm)? $NUcm ($NUcm | $SYcm | $IScm)* ($CLcm | $CPcm)? ($PRcm | $POcm)?;
359 # LB 26 Do not break a Korean syllable
361 $JLcm ($JLcm | $JVcm | $H2cm | $H3cm);
362 ($JVcm | $H2cm) ($JVcm | $JTcm);
363 ($JTcm | $H3cm) $JTcm;
365 # LB 27 Treat korean Syllable Block the same as ID (don't break it)
366 ($JLcm | $JVcm | $JTcm | $H2cm | $H3cm) $INcm;
367 ($JLcm | $JVcm | $JTcm | $H2cm | $H3cm) $POcm;
368 $PRcm ($JLcm | $JVcm | $JTcm | $H2cm | $H3cm);
371 # LB 28 Do not break between alphabetics
374 $CM+ $ALcm; # The $CM+ is from rule 10, an unattached CM is treated as AL
380 ($ALcm | $NUcm) $OPcm;
381 $CM+ $OPcm; # The $CM+ is from rule 10, an unattached CM is treated as AL.
382 $CPcm ($ALcm | $NUcm);
388 ## -------------------------------------------------
421 # Sequences of the form (shown forwards)
422 # [CANT_CM] <break> [CM] [whatever]
423 # The CM needs to behave as an AL
426 [$BK $CR $LF $NL $ZW {eof}] |
428 $SP+ $CM* ([^$OP $CM $SP] | [$AL {eof}])); # if LB 14 will match, need to surpress this break.
429 # LB14 says OP SP* x .
430 # becomes OP SP* x AL
431 # becomes OP SP* x CM+ AL_FOLLOW
433 # Further note: the $AL in [$AL {eof}] is only to work around
434 # a rule compiler bug which complains about
435 # empty sets otherwise.
438 # Sequences of the form (shown forwards)
439 # [CANT_CM] <break> [CM] <break> [PR]
440 # The CM needs to behave as an AL
441 # This rule is concerned about getting the second of the two <breaks> in place.
444 [$PR ] / $CM+ [$BK $CR $LF $NL $ZW $SP {eof}];
450 $LB4Breaks [$LB4NonBreaks-$CM];
451 $LB4Breaks $CM+ $CAN_CM;
457 [$SP $ZW] [$LB4NonBreaks-$CM];
458 [$SP $ZW] $CM+ $CAN_CM;
460 # LB 8 ZW SP* <break>
461 # TODO: to implement this, we need more than one look-ahead hard break in play at a time.
462 # Requires an engine enhancement.
465 # LB 9,10 Combining marks.
466 # X $CM needs to behave like X, where X is not $SP or controls.
467 # $CM not covered by the above needs to behave like $AL
468 # Stick together any combining sequences that don't match other rules.
473 $CM* $WJ $CM* $CAN_CM;
474 $CM* $WJ [$LB8NonBreaks-$CM];
477 $CM* $CAN_CM $CM* $WJ;
482 $CM* $GL $CM* [$LB8NonBreaks-[$CM $SP $BA $HY]];
488 $CM* $CAN_CM $CM* $GL;
498 $CL [$LB8NonBreaks-$CM];
499 $CP [$LB8NonBreaks-$CM];
500 $EX [$LB8NonBreaks-$CM];
501 $IS [$LB8NonBreaks-$CM];
502 $SY [$LB8NonBreaks-$CM];
504 # Rule 13 & 14 taken together for an edge case.
505 # Match this, shown forward
506 # OP SP+ ($CM+ behaving as $AL) (CL | CP | EX | IS | IY)
507 # This really wants to chain at the $CM+ (which is acting as an $AL)
508 # except for $CM chaining being disabled.
509 [$CL $CP $EX $IS $SY] $CM+ $SP+ $CM* $OP;
513 $CM* $CAN_CM $SP* $CM* $OP;
514 $CANT_CM $SP* $CM* $OP;
515 $AL_FOLLOW? $CM+ $SP $SP* $CM* $OP; # by LB 10, behaves like $AL_FOLLOW? $AL $SP* $CM* $OP
517 $AL_FOLLOW_NOCM $CM+ $SP+ $CM* $OP;
518 $CM* $AL_FOLLOW_CM $CM+ $SP+ $CM* $OP;
519 $SY $CM $SP+ $OP; # TODO: Experiment. Remove.
524 $CM* $OP $SP* $CM* $QU;
527 $CM* $NS $SP* $CM* ($CL | $CP);
530 $CM* $B2 $SP* $CM* $B2;
532 # LB 18 break after spaces
533 # Nothing explicit needed here.
539 $CM* $QU $CM* $CAN_CM; # . x QU
540 $CM* $QU $LB18NonBreaks;
543 $CM* $CAN_CM $CM* $QU; # QU x .
547 # LB 20 Break before and after CB.
548 # nothing needed here.
552 $CM* ($BA | $HY | $NS) $CM* [$LB20NonBreaks-$CM]; # . x (BA | HY | NS)
554 $CM* [$LB20NonBreaks-$CM] $CM* $BB; # BB x .
560 $CM* $IN $CM* $ALPlus;
567 $CM* $NU $CM* $ALPlus;
568 $CM* $ALPlus $CM* $NU;
572 $CM* $ALPlus $CM* $PR;
573 $CM* $ALPlus $CM* $PO;
577 ($CM* ($PR | $PO))? ($CM* ($CL | $CP))? ($CM* ($NU | $IS | $SY))* $CM* $NU ($CM* ($OP | $HY))? ($CM* ($PR | $PO))?;
580 $CM* ($H3 | $H2 | $JV | $JL) $CM* $JL;
581 $CM* ($JT | $JV) $CM* ($H2 | $JV);
582 $CM* $JT $CM* ($H3 | $JT);
585 $CM* $IN $CM* ($H3 | $H2 | $JT | $JV | $JL);
586 $CM* $PO $CM* ($H3 | $H2 | $JT | $JV | $JL);
587 $CM* ($H3 | $H2 | $JT | $JV | $JL) $CM* $PR;
590 $CM* $ALPlus $CM* $ALPlus;
594 $CM* $ALPlus $CM* $IS;
597 $CM* $OP $CM* ($ALPlus | $NU);
598 $CM* ($ALPlus | $NU) $CM* $CP;
601 ## -------------------------------------------------
606 $CM+ [^$CM $BK $CR $LF $NL $ZW $SP];
616 $SP+ $CM* ($CL | $CP);
622 ($CM* ($IS | $SY))+ $CM* $NU;
623 ($CL | $CP) $CM* ($NU | $IS | $SY);
625 # For dictionary-based break
626 $dictionary $dictionary;
628 ## -------------------------------------------------
632 # Skip forward over all character classes that are involved in
633 # rules containing patterns with possibly more than one char
636 # It might be slightly more efficient to have specific rules
637 # instead of one generic one, but only if we could
638 # turn off rule chaining. We don't want to move more
641 [$CM $OP $QU $CL $CP $B2 $PR $HY $SP $dictionary]+ [^$CM $OP $QU $CL $CP $B2 $PR $HY $dictionary];
642 $dictionary $dictionary;