source: proto/charsetcompiler/UCD/UCD_properties.py @ 4735

Last change on this file since 4735 was 4735, checked in by cameron, 4 years ago

Support for Grapheme, Sentence, Word break properties

File size: 12.8 KB
Line 
1#
2# UCD_properties.py - parsing Unicode Character Database (UCD) files
3# and generating C headers for property data using a compact bitset
4# representation.
5#
6# Robert D. Cameron
7# January 2, 2015
8#
9# Licensed under Open Software License 3.0.
10#
11#
12import re, string, os.path, cformat
13from unicode_set import *
14from UCD_parser import *
15
16UCD_dir = "8.0.0"
17
18PropertyAliases_template = r"""
19namespace UCD {
20    enum property_t {
21        %s};
22    const static std::vector<std::string> property_enum_name = {
23        %s};
24    const static std::vector<std::string> property_full_name = {
25        %s};
26    static std::unordered_map<std::string, int> alias_map {{
27        %s}};
28}
29"""
30
31EnumeratedProperty_template = r"""
32    namespace %s_ns {
33        enum value_t {
34            %s};
35        const static std::vector<std::string> enum_names = {
36            %s};
37        const static std::vector<std::string> value_names = {
38            %s};
39        static std::unordered_map<std::string, int> aliases_only_map {{
40            %s}};
41    }
42"""
43
44CodepointProperties = ['scf', 'slc', 'suc', 'stc']
45
46class UCD_generator():
47    def __init__(self):
48        self.supported_props = []
49        self.property_data_headers = []
50        self.missing_specs = {}
51
52    def load_property_name_info(self):
53        (self.property_enum_name_list, self.full_name_map, self.property_lookup_map, self.property_kind_map) = parse_PropertyAlias_txt()
54
55    def generate_PropertyAliases_h(self):
56        f = cformat.open_header_file_for_write('PropertyAliases')
57        cformat.write_imports(f, ["<string>", "<unordered_map>", "<vector>"])
58        enum_text = cformat.multiline_fill(self.property_enum_name_list, ',', 8)
59        enum_text2 = cformat.multiline_fill(['"%s"' % e for e in self.property_enum_name_list], ',', 8)
60        full_name_text = cformat.multiline_fill(['"%s"' % self.full_name_map[e] for e in self.property_enum_name_list], ',', 8)
61        map_text = cformat.multiline_fill(['{"%s", %s}' % (k, self.property_lookup_map[k]) for k in sorted(self.property_lookup_map.keys())], ',', 8)
62        f.write(PropertyAliases_template % (enum_text, enum_text2, full_name_text, map_text))
63        cformat.close_header_file(f)
64
65    def load_property_value_info(self):
66        (self.property_value_list, self.property_value_enum_integer, self.property_value_full_name_map, self.property_value_lookup_map, self.missing_specs) = parse_PropertyValueAlias_txt(self.property_lookup_map)
67
68
69    def generate_PropertyValueAliases_h(self):
70        f = cformat.open_header_file_for_write('PropertyValueAliases')
71        cformat.write_imports(f, ['"PropertyAliases.h"', "<vector>", "<unordered_map>", "<string>"])
72        f.write("namespace UCD {\n")
73        #  Generate the aliases for all Binary properties.
74        enum_text = cformat.multiline_fill(['N', 'Y'], ',', 12)
75        enum_names = cformat.multiline_fill(['"N"', '"Y"'], ',', 12)
76        full_name_text = cformat.multiline_fill(['"No"', '"Yes"'], ',', 12)
77        binary_properties = ['{"n", N}', '{"y", Y}', '{"no", N}', '{"yes", Y}', '{"f", N}', '{"t", Y}', '{"false", N}', '{"true", Y}']
78        binary_map_text = cformat.multiline_fill(binary_properties, ',', 12)
79        f.write(EnumeratedProperty_template % ('Binary', enum_text, enum_names, full_name_text, binary_map_text))
80        #
81        for p in self.property_enum_name_list:
82           if self.property_value_list.has_key(p):
83              if not self.property_kind_map[p] == 'Binary':
84                  enum_text = cformat.multiline_fill(self.property_value_list[p], ',', 12)
85                  enum_names = cformat.multiline_fill(['"%s"' % s for s in self.property_value_list[p]], ',', 12)
86                  if p == 'ccc': # Special case: add numeric value information for ccc.
87                      enum_text += r"""
88        };
89        const uint16_t enum_val[] = {
90    """
91                      enum_text += "      " + cformat.multiline_fill(["%s" % (self.property_value_enum_integer[p][e]) for e in self.property_value_list['ccc']], ',', 12)
92                  full_names = [self.property_value_full_name_map[p][e] for e in self.property_value_list[p]]
93                  full_name_text = cformat.multiline_fill(['"%s"' % name for name in full_names], ',', 12)
94                  canon_full_names = [canonicalize(name) for name in full_names]
95                  canon_enums = [canonicalize(e) for e in self.property_value_list[p]]
96                  canon_keys = [canonicalize(k) for k in self.property_value_lookup_map[p].keys()]
97                  aliases_only = [k for k in canon_keys if not k in canon_enums + canon_full_names]
98                  map_text = cformat.multiline_fill(['{"%s", %s_ns::%s}' % (k, p.upper(), self.property_value_lookup_map[p][k]) for k in sorted(aliases_only)], ',', 12)
99                  f.write(EnumeratedProperty_template % (p.upper(), enum_text, enum_names, full_name_text, map_text))
100        f.write("}\n")
101        cformat.close_header_file(f)
102
103 
104    def generate_property_value_file(self, filename_root, property_code, default_value = None):
105        vlist = self.property_value_list[property_code]
106        canon_map = self.property_value_lookup_map[property_code]
107        (prop_values, value_map) = parse_UCD_enumerated_property_map(property_code, vlist, canon_map, filename_root + '.txt', default_value)
108        basename = os.path.basename(filename_root)
109        f = cformat.open_header_file_for_write(os.path.basename(filename_root))
110        cformat.write_imports(f, ['"PropertyObjects.h"', '"PropertyValueAliases.h"', '"unicode_set.h"'])
111        f.write("\nnamespace UCD {\n")
112        f.write("    namespace %s_ns {\n" % property_code.upper())
113        for v in self.property_value_list[property_code]:
114            f.write("    /** Code Point Ranges for %s\n    " % v)
115            f.write(cformat.multiline_fill(['[%s, %s]' % (lo, hi) for (lo, hi) in uset_to_range_list(value_map[v])], ',', 4))
116            f.write("**/\n")
117            f.write("    const UnicodeSet %s_Set \n" % v.lower())
118            f.write(value_map[v].showC(8) + ";\n")
119        print "%s: %s bytes" % (basename, sum([value_map[v].bytes() for v in value_map.keys()]))
120        set_list = ['&%s_Set' % v.lower() for v in self.property_value_list[property_code]]
121        f.write("    static EnumeratedPropertyObject property_object\n")
122        f.write("        {%s,\n" % property_code)
123        f.write("         %s_ns::enum_names,\n" % property_code.upper())
124        f.write("         %s_ns::value_names,\n" % property_code.upper())
125        f.write("         %s_ns::aliases_only_map,\n" % property_code.upper())
126        f.write("         {")
127        f.write(cformat.multiline_fill(set_list, ',', 8))
128        f.write("\n         }};\n    }\n}\n")
129        cformat.close_header_file(f)
130        self.supported_props.append(property_code)
131        self.property_data_headers.append(basename)
132
133    def generate_ScriptExtensions_h(self):
134        filename_root = 'ScriptExtensions'
135        property_code = 'scx'
136        (prop_values, value_map) = parse_ScriptExtensions_txt(self.property_value_list['sc'], self.property_value_lookup_map['sc'])
137        basename = os.path.basename(filename_root)
138        f = cformat.open_header_file_for_write(basename)
139        cformat.write_imports(f, ['"PropertyObjects.h"', '"PropertyValueAliases.h"', '"unicode_set.h"'])
140        f.write("\nnamespace UCD {\n")
141        f.write("    namespace SCX_ns {\n")
142        for v in self.property_value_list['sc']:
143            f.write("        /** Code Point Ranges for %s\n        " % v)
144            f.write(cformat.multiline_fill(['[%s, %s]' % (lo, hi) for (lo, hi) in uset_to_range_list(value_map[v])], ',', 8))
145            f.write("**/\n")
146            f.write("        const UnicodeSet %s_Ext \n" % v.lower())
147            f.write(value_map[v].showC(12) + ";\n")
148        set_list = ['&%s_Ext' % v.lower() for v in self.property_value_list['sc']]
149        f.write("        static ExtensionPropertyObject property_object\n")
150        f.write("       {%s,\n" % property_code)
151        f.write("        UCD::sc,\n")
152        f.write("       {")
153        f.write(cformat.multiline_fill(set_list, ',', 8))
154        f.write("\n        }};\n    }\n}\n")
155        cformat.close_header_file(f)
156        print "%s: %s bytes" % (basename, sum([value_map[v].bytes() for v in value_map.keys()]))
157        self.supported_props.append(property_code)
158        self.property_data_headers.append(basename)
159
160    def generate_binary_properties_file(self, filename_root):
161        (props, prop_map) = parse_UCD_codepoint_name_map(filename_root + '.txt', self.property_lookup_map)
162        basename = os.path.basename(filename_root)
163        f = cformat.open_header_file_for_write(basename)
164        cformat.write_imports(f, ['"PropertyAliases.h"', '"unicode_set.h"', "<vector>"])
165        f.write("\nnamespace UCD {\n")
166        for p in sorted(props):
167            # f.write("  namespace %s_ns {\n    const UnicodeSet codepoint_set \n" % p.upper())
168            # f.write(prop_map[p].showC(12) + ";\n")
169            # f.write("    static BinaryPropertyObject property_object{%s, codepoint_set};\n  }\n" % p)
170            f.write("    namespace %s_ns {\n" % p.upper())
171            f.write("        /** Code Point Ranges for %s\n        " % p)
172            f.write(cformat.multiline_fill(['[%s, %s]' % (lo, hi) for (lo, hi) in uset_to_range_list(prop_map[p])], ',', 8))
173            f.write("**/\n")
174            f.write("        const UnicodeSet codepoint_set \n")
175            f.write(prop_map[p].showC(12) + ";\n")
176            f.write("        static BinaryPropertyObject property_object{%s, codepoint_set};\n    }\n" % p)
177        f.write("}\n\n")
178        cformat.close_header_file(f)
179        print "%s: %s bytes" % (basename, sum([prop_map[p].bytes() for p in prop_map.keys()]))
180        self.supported_props += props
181        self.property_data_headers.append(basename)
182
183    def generate_PropertyObjectTable_h(self):
184        f = cformat.open_header_file_for_write('PropertyObjectTable')
185        cformat.write_imports(f, ['"PropertyObjects.h"', '"PropertyAliases.h"', '<array>'])
186        cformat.write_imports(f, ['"%s.h"' % fname for fname in self.property_data_headers])
187        f.write("\nnamespace UCD {\n")
188        objlist = []
189        for p in self.property_enum_name_list:
190            k = self.property_kind_map[p]
191            if p in self.supported_props:
192                objlist.append("&%s_ns::property_object" % p.upper())
193            elif k == 'String':
194                if p in CodepointProperties:
195                    objlist.append("new UnsupportedPropertyObject(%s, PropertyObject::ClassTypeId::CodepointProperty)" % p)
196                else:
197                    objlist.append("new UnsupportedPropertyObject(%s, PropertyObject::ClassTypeId::StringProperty)" % p)
198            else:
199                objlist.append("new UnsupportedPropertyObject(%s, PropertyObject::ClassTypeId::%sProperty)" % (p, k))
200        f.write("\n  const std::array<PropertyObject *, %i> property_object_table = {{\n    " % len(objlist))
201        f.write(",\n    ".join(objlist) + '  }};\n}\n')
202        cformat.close_header_file(f)
203
204
205
206def UCD_main():
207    ucd = UCD_generator()
208
209    # First parse all property names and their aliases
210    ucd.load_property_name_info()
211    #
212    # Generate the PropertyAliases.h file to define all the Unicode property_t enum
213    # and the basic property information.
214    ucd.generate_PropertyAliases_h()
215    #
216    # Next parse all property value names and their aliases.  Generate the data.
217    ucd.load_property_value_info()
218    ucd.generate_PropertyValueAliases_h()
219    #
220    # The Block property
221    ucd.generate_property_value_file('Blocks', 'blk')
222    #
223    # Scripts
224    ucd.generate_property_value_file('Scripts', 'sc')
225    #
226    # Script Extensions
227    ucd.generate_ScriptExtensions_h()
228    #
229    # General Category
230    ucd.generate_property_value_file('extracted/DerivedGeneralCategory', 'gc')
231    #
232    # Binary properties from PropList.txt
233    ucd.generate_binary_properties_file('PropList')
234    #
235    # Binary properties from DerivedCoreProperties.txt
236    ucd.generate_binary_properties_file('DerivedCoreProperties')
237    #
238    #
239    # LineBreak types
240    ucd.generate_property_value_file('LineBreak', 'lb')
241    #
242    # Grapheme Cluster Break property
243    ucd.generate_property_value_file('auxiliary/GraphemeBreakProperty', 'GCB')
244    #
245    # Sentence Break property
246    ucd.generate_property_value_file('auxiliary/SentenceBreakProperty', 'SB')
247    #
248    # Word Break property
249    ucd.generate_property_value_file('auxiliary/WordBreakProperty', 'WB')
250    #
251    # East Asian Width
252    ucd.generate_property_value_file('EastAsianWidth', 'ea')
253    #
254    # Hangul Syllable Type
255    ucd.generate_property_value_file('HangulSyllableType', 'hst')
256    #
257    # Jamo Short Name - AAARGH - property value for 110B is an empty string!!!!!  - Not in PropertyValueAliases.txt
258    # ucd.generate_property_value_file('Jamo', 'jsn')
259    #
260    # Stubs
261    #
262    ucd.generate_PropertyObjectTable_h()
263
264if __name__ == "__main__":
265  UCD_main()
Note: See TracBrowser for help on using the repository browser.