3 # Copyright 2011-2013 The Rust Project Developers. See the COPYRIGHT
4 # file at the top-level directory of this distribution and at
5 # http://rust-lang.org/COPYRIGHT.
7 # Licensed under the Apache License, Version 2.0 <LICENSE-APACHE or
8 # http://www.apache.org/licenses/LICENSE-2.0> or the MIT license
9 # <LICENSE-MIT or http://opensource.org/licenses/MIT>, at your
10 # option. This file may not be copied, modified, or distributed
11 # except according to those terms.
13 # This script uses the following Unicode tables:
14 # - DerivedCoreProperties.txt
15 # - EastAsianWidth.txt
20 # Since this should not require frequent updates, we just store this
21 # out-of-line and check the unicode.rs file into git.
23 import fileinput, re, os, sys, operator
25 preamble = '''// Copyright 2012-2014 The Rust Project Developers. See the COPYRIGHT
26 // file at the top-level directory of this distribution and at
27 // http://rust-lang.org/COPYRIGHT.
29 // Licensed under the Apache License, Version 2.0 <LICENSE-APACHE or
30 // http://www.apache.org/licenses/LICENSE-2.0> or the MIT license
31 // <LICENSE-MIT or http://opensource.org/licenses/MIT>, at your
32 // option. This file may not be copied, modified, or distributed
33 // except according to those terms.
35 // NOTE: The following code was generated by "src/etc/unicode.py", do not edit directly
37 #![allow(missing_docs, non_upper_case_globals, non_snake_case)]
40 # Mapping taken from Table 12 from:
41 # http://www.unicode.org/reports/tr44/#General_Category_Values
42 expanded_categories = {
43 'Lu': ['LC', 'L'], 'Ll': ['LC', 'L'], 'Lt': ['LC', 'L'],
44 'Lm': ['L'], 'Lo': ['L'],
45 'Mn': ['M'], 'Mc': ['M'], 'Me': ['M'],
46 'Nd': ['N'], 'Nl': ['N'], 'No': ['No'],
47 'Pc': ['P'], 'Pd': ['P'], 'Ps': ['P'], 'Pe': ['P'],
48 'Pi': ['P'], 'Pf': ['P'], 'Po': ['P'],
49 'Sm': ['S'], 'Sc': ['S'], 'Sk': ['S'], 'So': ['S'],
50 'Zs': ['Z'], 'Zl': ['Z'], 'Zp': ['Z'],
51 'Cc': ['C'], 'Cf': ['C'], 'Cs': ['C'], 'Co': ['C'], 'Cn': ['C'],
55 # Grapheme cluster data
56 # taken from UAX29, http://www.unicode.org/reports/tr29/
57 # these code points are excluded from the Control category
58 # NOTE: CR and LF are also technically excluded, but for
59 # the sake of convenience we leave them in the Control group
60 # and manually check them in the appropriate place. This is
61 # still compliant with the implementation requirements.
62 grapheme_control_exceptions = set([0x200c, 0x200d])
64 # the Regional_Indicator category
65 grapheme_regional_indicator = [(0x1f1e6, 0x1f1ff)]
67 # "The following ... are specifically excluded" from the SpacingMark category
68 # http://www.unicode.org/reports/tr29/#SpacingMark
69 grapheme_spacingmark_exceptions = [(0x102b, 0x102c), (0x1038, 0x1038),
70 (0x1062, 0x1064), (0x1067, 0x106d), (0x1083, 0x1083), (0x1087, 0x108c),
71 (0x108f, 0x108f), (0x109a, 0x109c), (0x19b0, 0x19b4), (0x19b8, 0x19b9),
72 (0x19bb, 0x19c0), (0x19c8, 0x19c9), (0x1a61, 0x1a61), (0x1a63, 0x1a64),
73 (0xaa7b, 0xaa7b), (0xaa7d, 0xaa7d)]
75 # these are included in the SpacingMark category
76 grapheme_spacingmark_extra = set([0xe33, 0xeb3])
79 if not os.path.exists(f):
80 os.system("curl -O http://www.unicode.org/Public/UNIDATA/%s"
83 if not os.path.exists(f):
84 sys.stderr.write("cannot load %s" % f)
87 def is_valid_unicode(n):
88 return 0 <= n <= 0xD7FF or 0xE000 <= n <= 0x10FFFF
90 def load_unicode_data(f):
99 for line in fileinput.input(f):
100 fields = line.split(";")
101 if len(fields) != 15:
103 [code, name, gencat, combine, bidi,
104 decomp, deci, digit, num, mirror,
105 old, iso, upcase, lowcase, titlecase ] = fields
110 if not is_valid_unicode(code):
113 # generate char to char direct common and simple conversions
114 # uppercase to lowercase
115 if gencat == "Lu" and lowcase != "" and code_org != lowcase:
116 upperlower[code] = int(lowcase, 16)
118 # lowercase to uppercase
119 if gencat == "Ll" and upcase != "" and code_org != upcase:
120 lowerupper[code] = int(upcase, 16)
122 # store decomposition, if given
124 if decomp.startswith('<'):
126 for i in decomp.split()[1:]:
127 seq.append(int(i, 16))
128 compat_decomp[code] = seq
131 for i in decomp.split():
132 seq.append(int(i, 16))
133 canon_decomp[code] = seq
135 # place letter in categories as appropriate
136 for cat in [gencat, "Assigned"] + expanded_categories.get(gencat, []):
137 if cat not in gencats:
139 gencats[cat].append(code)
141 # record combining class, if any
143 if combine not in combines:
144 combines[combine] = []
145 combines[combine].append(code)
147 # generate Not_Assigned from Assigned
148 gencats["Cn"] = gen_unassigned(gencats["Assigned"])
149 # Assigned is not a real category
150 del(gencats["Assigned"])
151 # Other contains Not_Assigned
152 gencats["C"].extend(gencats["Cn"])
153 gencats = group_cats(gencats)
154 combines = to_combines(group_cats(combines))
156 return (canon_decomp, compat_decomp, gencats, combines, lowerupper, upperlower)
158 def group_cats(cats):
161 cats_out[cat] = group_cat(cats[cat])
166 letters = sorted(set(cat))
167 cur_start = letters.pop(0)
169 for letter in letters:
170 assert letter > cur_end, \
171 "cur_end: %s, letter: %s" % (hex(cur_end), hex(letter))
172 if letter == cur_end + 1:
175 cat_out.append((cur_start, cur_end))
176 cur_start = cur_end = letter
177 cat_out.append((cur_start, cur_end))
180 def ungroup_cat(cat):
188 def gen_unassigned(assigned):
189 assigned = set(assigned)
190 return ([i for i in range(0, 0xd800) if i not in assigned] +
191 [i for i in range(0xe000, 0x110000) if i not in assigned])
193 def to_combines(combs):
196 for (lo, hi) in combs[comb]:
197 combs_out.append((lo, hi, comb))
198 combs_out.sort(key=lambda comb: comb[0])
201 def format_table_content(f, content, indent):
204 for chunk in content.split(","):
205 if len(line) + len(chunk) < 98:
212 f.write(line + ",\n")
213 line = " "*indent + chunk
216 def load_properties(f, interestingprops):
219 re1 = re.compile("^([0-9A-F]+) +; (\w+)")
220 re2 = re.compile("^([0-9A-F]+)\.\.([0-9A-F]+) +; (\w+)")
222 for line in fileinput.input(f):
239 if interestingprops and prop not in interestingprops:
243 if prop not in props:
245 props[prop].append((d_lo, d_hi))
248 # load all widths of want_widths, except those in except_cats
249 def load_east_asian_width(want_widths, except_cats):
250 f = "EastAsianWidth.txt"
253 re1 = re.compile("^([0-9A-F]+);(\w+) +# (\w+)")
254 re2 = re.compile("^([0-9A-F]+)\.\.([0-9A-F]+);(\w+) +# (\w+)")
256 for line in fileinput.input(f):
276 if cat in except_cats or width not in want_widths:
280 if width not in widths:
282 widths[width].append((d_lo, d_hi))
286 return "'\\u{%x}'" % c
288 def emit_bsearch_range_table(f):
290 fn bsearch_range_table(c: char, r: &'static [(char,char)]) -> bool {
291 use core::cmp::Ordering::{Equal, Less, Greater};
292 use core::slice::SlicePrelude;
293 r.binary_search(|&(lo,hi)| {
294 if lo <= c && c <= hi { Equal }
295 else if hi < c { Less }
301 def emit_table(f, name, t_data, t_type = "&'static [(char, char)]", is_pub=True,
302 pfun=lambda x: "(%s,%s)" % (escape_char(x[0]), escape_char(x[1]))):
306 f.write(" %sstatic %s: %s = &[\n" % (pub_string, name, t_type))
314 format_table_content(f, data, 8)
317 def emit_property_module(f, mod, tbl, emit_fn):
318 f.write("pub mod %s {\n" % mod)
322 emit_table(f, "%s_table" % cat, tbl[cat])
324 f.write(" pub fn %s(c: char) -> bool {\n" % cat)
325 f.write(" super::bsearch_range_table(c, %s_table)\n" % cat)
329 def emit_regex_module(f, cats, w_data):
330 f.write("pub mod regex {\n")
331 regex_class = "&'static [(char, char)]"
332 class_table = "&'static [(&'static str, &'static %s)]" % regex_class
334 emit_table(f, "UNICODE_CLASSES", cats, class_table,
335 pfun=lambda x: "(\"%s\",&super::%s::%s_table)" % (x[0], x[1], x[0]))
337 f.write(" pub static PERLD: &'static %s = &super::general_category::Nd_table;\n\n"
339 f.write(" pub static PERLS: &'static %s = &super::property::White_Space_table;\n\n"
342 emit_table(f, "PERLW", w_data, regex_class)
346 def emit_conversions_module(f, lowerupper, upperlower):
347 f.write("pub mod conversions {")
349 use core::cmp::Ordering::{Equal, Less, Greater};
350 use core::slice::SlicePrelude;
351 use core::tuple::Tuple2;
352 use core::option::Option;
353 use core::option::Option::{Some, None};
356 pub fn to_lower(c: char) -> char {
357 match bsearch_case_table(c, LuLl_table) {
359 Some(index) => LuLl_table[index].val1()
363 pub fn to_upper(c: char) -> char {
364 match bsearch_case_table(c, LlLu_table) {
366 Some(index) => LlLu_table[index].val1()
370 fn bsearch_case_table(c: char, table: &'static [(char, char)]) -> Option<uint> {
371 match table.binary_search(|&(key, _)| {
372 if c == key { Equal }
373 else if key < c { Less }
376 slice::BinarySearchResult::Found(i) => Some(i),
377 slice::BinarySearchResult::NotFound(_) => None,
382 emit_table(f, "LuLl_table",
383 sorted(upperlower.iteritems(), key=operator.itemgetter(0)), is_pub=False)
384 emit_table(f, "LlLu_table",
385 sorted(lowerupper.iteritems(), key=operator.itemgetter(0)), is_pub=False)
388 def emit_grapheme_module(f, grapheme_table, grapheme_cats):
389 f.write("""pub mod grapheme {
390 use core::slice::SlicePrelude;
391 use core::kinds::Copy;
392 pub use self::GraphemeCat::*;
395 #[allow(non_camel_case_types)]
397 pub enum GraphemeCat {
399 for cat in grapheme_cats + ["Any"]:
400 f.write(" GC_" + cat + ",\n")
403 impl Copy for GraphemeCat {}
405 fn bsearch_range_value_table(c: char, r: &'static [(char, char, GraphemeCat)]) -> GraphemeCat {
406 use core::cmp::Ordering::{Equal, Less, Greater};
407 match r.binary_search(|&(lo, hi, _)| {
408 if lo <= c && c <= hi { Equal }
409 else if hi < c { Less }
412 slice::BinarySearchResult::Found(idx) => {
413 let (_, _, cat) = r[idx];
416 slice::BinarySearchResult::NotFound(_) => GC_Any
420 pub fn grapheme_category(c: char) -> GraphemeCat {
421 bsearch_range_value_table(c, grapheme_cat_table)
426 emit_table(f, "grapheme_cat_table", grapheme_table, "&'static [(char, char, GraphemeCat)]",
427 pfun=lambda x: "(%s,%s,GC_%s)" % (escape_char(x[0]), escape_char(x[1]), x[2]),
431 def emit_charwidth_module(f, width_table):
432 f.write("pub mod charwidth {\n")
433 f.write(" use core::option::Option;\n")
434 f.write(" use core::option::Option::{Some, None};\n")
435 f.write(" use core::slice::SlicePrelude;\n")
436 f.write(" use core::slice;\n")
438 fn bsearch_range_value_table(c: char, is_cjk: bool, r: &'static [(char, char, u8, u8)]) -> u8 {
439 use core::cmp::Ordering::{Equal, Less, Greater};
440 match r.binary_search(|&(lo, hi, _, _)| {
441 if lo <= c && c <= hi { Equal }
442 else if hi < c { Less }
445 slice::BinarySearchResult::Found(idx) => {
446 let (_, _, r_ncjk, r_cjk) = r[idx];
447 if is_cjk { r_cjk } else { r_ncjk }
449 slice::BinarySearchResult::NotFound(_) => 1
455 pub fn width(c: char, is_cjk: bool) -> Option<uint> {
457 _c @ 0 => Some(0), // null is zero width
458 cu if cu < 0x20 => None, // control sequences have no width
459 cu if cu < 0x7F => Some(1), // ASCII
460 cu if cu < 0xA0 => None, // more control sequences
461 _ => Some(bsearch_range_value_table(c, is_cjk, charwidth_table) as uint)
467 f.write(" // character width table. Based on Markus Kuhn's free wcwidth() implementation,\n")
468 f.write(" // http://www.cl.cam.ac.uk/~mgk25/ucs/wcwidth.c\n")
469 emit_table(f, "charwidth_table", width_table, "&'static [(char, char, u8, u8)]", is_pub=False,
470 pfun=lambda x: "(%s,%s,%s,%s)" % (escape_char(x[0]), escape_char(x[1]), x[2], x[3]))
473 def emit_norm_module(f, canon, compat, combine, norm_props):
474 canon_keys = canon.keys()
477 compat_keys = compat.keys()
481 comp_exclusions = norm_props["Full_Composition_Exclusion"]
482 for char in canon_keys:
483 if True in map(lambda (lo, hi): lo <= char <= hi, comp_exclusions):
487 if not canon_comp.has_key(decomp[0]):
488 canon_comp[decomp[0]] = []
489 canon_comp[decomp[0]].append( (decomp[1], char) )
490 canon_comp_keys = canon_comp.keys()
491 canon_comp_keys.sort()
493 f.write("pub mod normalization {\n")
495 def mkdata_fun(table):
497 data = "(%s,&[" % escape_char(char)
499 for d in table[char]:
503 data += escape_char(d)
508 f.write(" // Canonical decompositions\n")
509 emit_table(f, "canonical_table", canon_keys, "&'static [(char, &'static [char])]",
510 pfun=mkdata_fun(canon))
512 f.write(" // Compatibility decompositions\n")
513 emit_table(f, "compatibility_table", compat_keys, "&'static [(char, &'static [char])]",
514 pfun=mkdata_fun(compat))
517 data = "(%s,&[" % escape_char(char)
518 canon_comp[char].sort(lambda x, y: x[0] - y[0])
520 for pair in canon_comp[char]:
524 data += "(%s,%s)" % (escape_char(pair[0]), escape_char(pair[1]))
528 f.write(" // Canonical compositions\n")
529 emit_table(f, "composition_table", canon_comp_keys,
530 "&'static [(char, &'static [(char, char)])]", pfun=comp_pfun)
533 fn bsearch_range_value_table(c: char, r: &'static [(char, char, u8)]) -> u8 {
534 use core::cmp::Ordering::{Equal, Less, Greater};
535 use core::slice::SlicePrelude;
537 match r.binary_search(|&(lo, hi, _)| {
538 if lo <= c && c <= hi { Equal }
539 else if hi < c { Less }
542 slice::BinarySearchResult::Found(idx) => {
543 let (_, _, result) = r[idx];
546 slice::BinarySearchResult::NotFound(_) => 0
551 emit_table(f, "combining_class_table", combine, "&'static [(char, char, u8)]", is_pub=False,
552 pfun=lambda x: "(%s,%s,%s)" % (escape_char(x[0]), escape_char(x[1]), x[2]))
554 f.write(" pub fn canonical_combining_class(c: char) -> u8 {\n"
555 + " bsearch_range_value_table(c, combining_class_table)\n"
563 def remove_from_wtable(wtable, val):
566 if wtable[0][1] < val:
567 wtable_out.append(wtable.pop(0))
568 elif wtable[0][0] > val:
571 (wt_lo, wt_hi, width, width_cjk) = wtable.pop(0)
572 if wt_lo == wt_hi == val:
575 wtable_out.append((wt_lo+1, wt_hi, width, width_cjk))
577 wtable_out.append((wt_lo, wt_hi-1, width, width_cjk))
579 wtable_out.append((wt_lo, val-1, width, width_cjk))
580 wtable_out.append((val+1, wt_hi, width, width_cjk))
582 wtable_out.extend(wtable)
587 def optimize_width_table(wtable):
589 w_this = wtable.pop(0)
591 if w_this[1] == wtable[0][0] - 1 and w_this[2:3] == wtable[0][2:3]:
592 w_tmp = wtable.pop(0)
593 w_this = (w_this[0], w_tmp[1], w_tmp[2], w_tmp[3])
595 wtable_out.append(w_this)
596 w_this = wtable.pop(0)
597 wtable_out.append(w_this)
600 if __name__ == "__main__":
602 if os.path.exists(r):
604 with open(r, "w") as rf:
605 # write the file's preamble
608 # download and parse all the data
610 with open("ReadMe.txt") as readme:
611 pattern = "for Version (\d+)\.(\d+)\.(\d+) of the Unicode"
612 unicode_version = re.search(pattern, readme.read()).groups()
614 /// The version of [Unicode](http://www.unicode.org/)
615 /// that the `UnicodeChar` and `UnicodeStrPrelude` traits are based on.
616 pub const UNICODE_VERSION: (uint, uint, uint) = (%s, %s, %s);
617 """ % unicode_version)
618 (canon_decomp, compat_decomp, gencats, combines,
619 lowerupper, upperlower) = load_unicode_data("UnicodeData.txt")
620 want_derived = ["XID_Start", "XID_Continue", "Alphabetic", "Lowercase", "Uppercase"]
621 other_derived = ["Default_Ignorable_Code_Point", "Grapheme_Extend"]
622 derived = load_properties("DerivedCoreProperties.txt", want_derived + other_derived)
623 scripts = load_properties("Scripts.txt", [])
624 props = load_properties("PropList.txt",
625 ["White_Space", "Join_Control", "Noncharacter_Code_Point"])
626 norm_props = load_properties("DerivedNormalizationProps.txt",
627 ["Full_Composition_Exclusion"])
629 # grapheme cluster category from DerivedCoreProperties
630 # the rest are defined below
632 grapheme_cats["Extend"] = derived["Grapheme_Extend"]
633 del(derived["Grapheme_Extend"])
635 # bsearch_range_table is used in all the property modules below
636 emit_bsearch_range_table(rf)
638 # all of these categories will also be available as \p{} in libregex
640 for (name, cat, pfuns) in ("general_category", gencats, ["N", "Cc"]), \
641 ("derived_property", derived, want_derived), \
642 ("script", scripts, []), \
643 ("property", props, ["White_Space"]):
644 emit_property_module(rf, name, cat, pfuns)
645 allcats.extend(map(lambda x: (x, name), cat))
646 allcats.sort(key=lambda c: c[0])
648 # the \w regex corresponds to Alphabetic + Mark + Decimal_Number +
649 # Connector_Punctuation + Join-Control according to UTS#18
650 # http://www.unicode.org/reports/tr18/#Compatibility_Properties
652 for cat in derived["Alphabetic"], gencats["M"], gencats["Nd"], \
653 gencats["Pc"], props["Join_Control"]:
654 perl_words.extend(ungroup_cat(cat))
655 perl_words = group_cat(perl_words)
657 # emit lookup tables for \p{}, along with \d, \w, and \s for libregex
658 emit_regex_module(rf, allcats, perl_words)
660 # normalizations and conversions module
661 emit_norm_module(rf, canon_decomp, compat_decomp, combines, norm_props)
662 emit_conversions_module(rf, lowerupper, upperlower)
664 ### character width module
666 for zwcat in ["Me", "Mn", "Cf"]:
667 width_table.extend(map(lambda (lo, hi): (lo, hi, 0, 0), gencats[zwcat]))
668 width_table.append((4448, 4607, 0, 0))
670 # get widths, except those that are explicitly marked zero-width above
671 ea_widths = load_east_asian_width(["W", "F", "A"], ["Me", "Mn", "Cf"])
672 # these are doublewidth
673 for dwcat in ["W", "F"]:
674 width_table.extend(map(lambda (lo, hi): (lo, hi, 2, 2), ea_widths[dwcat]))
675 width_table.extend(map(lambda (lo, hi): (lo, hi, 1, 2), ea_widths["A"]))
677 width_table.sort(key=lambda w: w[0])
679 # soft hyphen is not zero width in preformatted text; it's used to indicate
680 # a hyphen inserted to facilitate a linebreak.
681 width_table = remove_from_wtable(width_table, 173)
683 # optimize the width table by collapsing adjacent entities when possible
684 width_table = optimize_width_table(width_table)
685 emit_charwidth_module(rf, width_table)
687 ### grapheme cluster module
688 # from http://www.unicode.org/reports/tr29/#Grapheme_Cluster_Break_Property_Values
689 # Hangul syllable categories
690 want_hangul = ["L", "V", "T", "LV", "LVT"]
691 grapheme_cats.update(load_properties("HangulSyllableType.txt", want_hangul))
694 # This category also includes Cs (surrogate codepoints), but Rust's `char`s are
695 # Unicode Scalar Values only, and surrogates are thus invalid `char`s.
696 grapheme_cats["Control"] = set()
697 for cat in ["Zl", "Zp", "Cc", "Cf"]:
698 grapheme_cats["Control"] |= set(ungroup_cat(gencats[cat]))
699 grapheme_cats["Control"] = group_cat(list(
700 grapheme_cats["Control"]
701 - grapheme_control_exceptions
702 | (set(ungroup_cat(gencats["Cn"]))
703 & set(ungroup_cat(derived["Default_Ignorable_Code_Point"])))))
706 grapheme_cats["RegionalIndicator"] = grapheme_regional_indicator
708 # Prepend - "Currently there are no characters with this value"
709 # (from UAX#29, Unicode 7.0)
712 grapheme_cats["SpacingMark"] = group_cat(list(
713 set(ungroup_cat(gencats["Mc"]))
714 - set(ungroup_cat(grapheme_cats["Extend"]))
715 | grapheme_spacingmark_extra
716 - set(ungroup_cat(grapheme_spacingmark_exceptions))))
719 for cat in grapheme_cats:
720 grapheme_table.extend([(x, y, cat) for (x, y) in grapheme_cats[cat]])
721 grapheme_table.sort(key=lambda w: w[0])
722 emit_grapheme_module(rf, grapheme_table, grapheme_cats.keys())