basis/unicode/collation/collation.factor

   1 ! Copyright (C) 2008 Daniel Ehrenberg.
   2 ! See http://factorcode.org/license.txt for BSD license.
   3 USING: accessors arrays assocs combinators
   4 combinators.short-circuit combinators.smart fry kernel locals make
   5 math math.order math.parser namespaces sequences
   6 simple-flat-file splitting strings unicode.data ;
   7 IN: unicode.collation
   8
   9 <PRIVATE
  10
  11 SYMBOL: ducet
  12
  13 TUPLE: weight-levels primary secondary tertiary ignorable? ;
  14 : <weight-levels> ( primary secondary tertiary -- weight-levels> )
  15     weight-levels new
  16         swap >>tertiary
  17         swap >>secondary
  18         swap >>primary ; inline
  19
  20 : parse-weight ( string -- weight )
  21     "]" split but-last [
  22         weight-levels new swap rest unclip CHAR: * = swapd >>ignorable?
  23         swap "." split first3 [ hex> ] tri@
  24         [ >>primary ] [ >>secondary ] [ >>tertiary ] tri*
  25     ] map ;
  26
  27 : parse-keys ( string -- chars )
  28     " " split [ hex> ] "" map-as ;
  29
  30 : parse-ducet ( file -- ducet )
  31     load-data-file [ [ parse-keys ] [ parse-weight ] bi* ] H{ } assoc-map-as ;
  32
  33 "vocab:unicode/UCA/allkeys.txt" parse-ducet ducet set-global
  34
  35 ! https://www.unicode.org/reports/tr10/tr10-41.html#Well_Formed_DUCET
  36 ! WF5 - Well-formedness 5 condition:
  37 ! https://www.unicode.org/reports/tr10/tr10-41.html#WF5
  38 !    { "0CC6" "0CC2" "0CD5" } ! 0CD5 is not a non-starter, don't add 2-gram "0CC6" "0CC2"to ducet
  39 !    { "0DD9" "0DCF" "0DCA" } ! already in allkeys.txt file
  40 !    { "0FB2" "0F71" "0F80" } ! added below
  41 !    { "0FB3" "0F71" "0F80" } ! added below
  42 ! This breaks the unicode tests that ship in CollationTest_SHIFTED.txt
  43 ! but it's supposedly more correct.
  44 : fixup-ducet-for-tibetan ( -- )
  45     {
  46         {
  47             { 0x0FB2 0x0F71 } ! CE(0FB2) CE(0F71)
  48             {
  49                 T{ weight-levels
  50                     { primary 12719 }
  51                     { secondary 32 }
  52                     { tertiary 2 }
  53                 }
  54                 T{ weight-levels
  55                     { primary 12741 }
  56                     { secondary 32 }
  57                     { tertiary 2 }
  58                 }
  59             }
  60         }
  61         {
  62             { 0x0FB3 0x0F71 } ! CE(0FB3) CE(0F71)
  63             {
  64                 T{ weight-levels
  65                     { primary 12722 }
  66                     { secondary 32 }
  67                     { tertiary 2 }
  68                 }
  69                 T{ weight-levels
  70                     { primary 12741 }
  71                     { secondary 32 }
  72                     { tertiary 2 }
  73                 }
  74             }
  75         }
  76
  77         {
  78             { 0x0FB2 0x0F71 0x0F72 } ! CE(0FB2) CE(0F71 0F72)
  79             {
  80                 T{ weight-levels
  81                     { primary 12719 }
  82                     { secondary 32 }
  83                     { tertiary 2 }
  84                 }
  85                 T{ weight-levels
  86                     { primary 12743 }
  87                     { secondary 32 }
  88                     { tertiary 2 }
  89                 }
  90             }
  91         }
  92         {
  93             { 0x0FB2 0x0F73        } ! CE(0FB2) CE(0F71 0F72)
  94             {
  95                 T{ weight-levels
  96                     { primary 12719 }
  97                     { secondary 32 }
  98                     { tertiary 2 }
  99                 }
 100                 T{ weight-levels
 101                     { primary 12743 }
 102                     { secondary 32 }
 103                     { tertiary 2 }
 104                 }
 105             }
 106         }
 107         {
 108             { 0x0FB2 0x0F71 0x0F74 } ! CE(0FB2) CE(0F71 0F74)
 109             {
 110                 T{ weight-levels
 111                     { primary 12719 }
 112                     { secondary 32 }
 113                     { tertiary 2 }
 114                 }
 115                 T{ weight-levels
 116                     { primary 12747 }
 117                     { secondary 32 }
 118                     { tertiary 2 }
 119                 }
 120             }
 121         }
 122         {
 123             { 0x0FB2 0x0F75        } ! CE(0FB2) CE(0F71 0F74)
 124             {
 125                 T{ weight-levels
 126                     { primary 12719 }
 127                     { secondary 32 }
 128                     { tertiary 2 }
 129                 }
 130                 T{ weight-levels
 131                     { primary 12747 }
 132                     { secondary 32 }
 133                     { tertiary 2 }
 134                 }
 135             }
 136         }
 137         {
 138             { 0x0FB3 0x0F71 0x0F72 } ! CE(0FB3) CE(0F71 0F72)
 139             {
 140                 T{ weight-levels
 141                     { primary 12722 }
 142                     { secondary 32 }
 143                     { tertiary 2 }
 144                 }
 145                 T{ weight-levels
 146                     { primary 12743 }
 147                     { secondary 32 }
 148                     { tertiary 2 }
 149                 }
 150             }
 151         }
 152         {
 153             { 0x0FB3 0x0F73        } ! CE(0FB3) CE(0F71 0F72)
 154             {
 155                 T{ weight-levels
 156                     { primary 12722 }
 157                     { secondary 32 }
 158                     { tertiary 2 }
 159                 }
 160                 T{ weight-levels
 161                     { primary 12743 }
 162                     { secondary 32 }
 163                     { tertiary 2 }
 164                 }
 165             }
 166         }
 167         {
 168             { 0x0FB3 0x0F71 0x0F74 } ! CE(0FB3) CE(0F71 0F74)
 169             {
 170                 T{ weight-levels
 171                     { primary 12722 }
 172                     { secondary 32 }
 173                     { tertiary 2 }
 174                 }
 175                 T{ weight-levels
 176                     { primary 12747 }
 177                     { secondary 32 }
 178                     { tertiary 2 }
 179                 }
 180             }
 181         }
 182         {
 183             { 0x0FB3 0x0F75        } ! CE(0FB3) CE(0F71 0F74)
 184             {
 185                 T{ weight-levels
 186                     { primary 12722 }
 187                     { secondary 32 }
 188                     { tertiary 2 }
 189                 }
 190                 T{ weight-levels
 191                     { primary 12747 }
 192                     { secondary 32 }
 193                     { tertiary 2 }
 194                 }
 195             }
 196         }
 197     } ducet get-global '[ swap >string _ set-at ] assoc-each ;
 198
 199 ! These values actually break the collation unit tests in CollationTest_SHIFTED.txt
 200 ! So we disable those tests in favor of supposedly better collation for Tibetan.
 201 ! https://www.unicode.org/reports/tr10/tr10-41.html#Well_Formed_DUCET
 202
 203 fixup-ducet-for-tibetan
 204
 205 : tangut-block? ( char -- ? )
 206     ! Tangut Block, Tangut Components Block
 207     { [ 0x17000 0x187FF between? ] [ 0x18800 0x18AFF between? ] } 1|| ; inline
 208
 209 : nushu-block? ( char -- ? )
 210     0x1b170 0x1B2FB between? ; inline
 211
 212 ! https://wiki.computercraft.cc/Module:Unicode_data
 213 ! Unicode TR10 - Computing Implicit Weights
 214 : base ( char -- base )
 215     {
 216         { [ dup 0x03400 0x04DB5 between? ] [ drop 0xFB80 ] } ! Extension A
 217         { [ dup 0x20000 0x2A6D6 between? ] [ drop 0xFB80 ] } ! Extension B
 218         { [ dup 0x2A700 0x2B734 between? ] [ drop 0xFB80 ] } ! Extension C
 219         { [ dup 0x2B740 0x2B81D between? ] [ drop 0xFB80 ] } ! Extension D
 220         { [ dup 0x2B820 0x2CEA1 between? ] [ drop 0xFB80 ] } ! Extension E
 221         { [ dup 0x2CEB0 0x2EBE0 between? ] [ drop 0xFB80 ] } ! Extension F
 222         { [ dup 0x04E00 0x09FEF between? ] [ drop 0xFB40 ] } ! CJK
 223         [ drop 0xFBC0 ] ! Other
 224     } cond ;
 225
 226 : tangut-AAAA ( char -- weight-levels )
 227     drop 0xfb00 0x0020 0x0002 <weight-levels> ; inline
 228
 229 : tangut-BBBB ( char -- weight-levels )
 230     0x17000 - 0x8000 bitor 0 0 <weight-levels> ; inline
 231
 232 : nushu-AAAA ( char -- weight-levels )
 233     drop 0xfb01 0x0020 0x0002 <weight-levels> ; inline
 234
 235 : nushu-BBBB ( char -- weight-levels )
 236     0x1B170 - 0x8000 bitor 0 0 <weight-levels> ; inline
 237
 238 : AAAA ( char -- weight-levels )
 239     [ base ] [ -15 shift ] bi + 0x0020 0x0002 <weight-levels> ; inline
 240
 241 : BBBB ( char -- weight-levels )
 242     0x7FFF bitand 0x8000 bitor 0 0 <weight-levels> ; inline
 243
 244 : derive-weight ( 1string -- weight-levels-pair )
 245     first
 246     {
 247         { [ dup tangut-block? ] [ [ tangut-AAAA ] [ tangut-BBBB ] bi 2array ] }
 248         { [ dup nushu-block? ] [ [ nushu-AAAA ] [ nushu-BBBB ] bi 2array ] }
 249         [ [ AAAA ] [ BBBB ] bi 2array ]
 250     } cond ;
 251
 252 : building-last ( -- char )
 253     building get [ 0 ] [ last last ] if-empty ;
 254
 255 ! https://www.unicode.org/reports/tr10/tr10-41.html#Collation_Graphemes
 256 : blocked? ( char -- ? )
 257     combining-class dup { 0 f } member?
 258     [ drop building-last non-starter? ]
 259     [ building-last combining-class = ] if ;
 260
 261 : possible-bases ( -- slice-of-building )
 262     building get dup [ first non-starter? not ] find-last
 263     drop [ 0 ] unless* tail-slice ;
 264
 265 :: ?combine ( char slice i -- ? )
 266     i slice nth char suffix :> str
 267     str ducet get-global key? dup
 268     [ str i slice set-nth ] when ;
 269
 270 : add ( char -- )
 271     dup blocked? [ 1string , ] [
 272         dup possible-bases dup length <iota>
 273         [ ?combine ] 2with any?
 274         [ drop ] [ 1string , ] if
 275     ] if ;
 276
 277 : string>graphemes ( string -- graphemes )
 278     [ [ add ] each ] { } make ;
 279
 280 : char>weight-levels ( 1string -- weight-levels )
 281     ducet get-global ?at [ derive-weight ] unless ; inline
 282
 283 : graphemes>weights ( graphemes -- weights )
 284     [
 285         dup weight-levels?
 286         [ 1array ] ! From tailoring
 287         [ char>weight-levels ] if
 288     ] { } map-as concat ;
 289
 290 : append-weights ( weight-levels quot -- seq )
 291     [ [ ignorable?>> ] reject ] dip
 292     map [ zero? ] reject ; inline
 293
 294 : variable-weight ( weight-levels -- obj )
 295     dup ignorable?>> [ primary>> ] [ drop 0xFFFF ] if ;
 296
 297 : weights>bytes ( weights -- array )
 298     [
 299         {
 300             [ [ primary>> ] append-weights { 0 } ]
 301             [ [ secondary>> ] append-weights { 0 } ]
 302             [ [ tertiary>> ] append-weights { 0 } ]
 303             [ [ [ secondary>> ] [ tertiary>> ] bi [ zero? ] bi@ and not ] filter [ variable-weight ] map ]
 304         } cleave
 305     ] { } append-outputs-as ;
 306
 307 PRIVATE>
 308
 309 : completely-ignorable? ( weight -- ? )
 310     {
 311         [ primary>> zero? ]
 312         [ secondary>> zero? ]
 313         [ tertiary>> zero? ]
 314     } 1&& ;
 315
 316 : filter-ignorable ( weights -- weights' )
 317     f swap [
 318         [ nip ] [ primary>> zero? and ] 2bi
 319         [ swap ignorable?>> or ]
 320         [ swap completely-ignorable? or not ] 2bi
 321     ] filter nip ;