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

Last change on this file since 4367 was 4367, checked in by cameron, 5 years ago

Refactoring to separate UCD parsing from header file generation.

File size: 12.0 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# September 10, 2014
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 = "7.0.0"
17
18PropertyAliases_template = r"""
19namespace UCD {
20  enum property_t {
21%s
22  };
23  const std::vector<std::string> property_full_name = {
24%s
25  };
26  const std::unordered_map<std::string, property_t> alias_map = {
27%s
28  };
29}
30"""
31
32PropertyValueAliases_template = r"""
33namespace UCD {
34  enum binary_value_t {N, Y};
35%s
36
37  const std::vector<std::string> value_name[] = {
38%s};
39
40  const std::unordered_map<std::string, int> property_value_alias_map[] = {
41%s};
42
43}
44"""
45
46EnumeratedProperty_template = r"""
47  namespace %s {
48    enum value_t {
49      %s};
50    const std::vector<std::string> value_names = {
51      %s};
52    const std::unordered_map<std::string, int> aliases_only_map = {
53      %s};
54  }
55"""
56
57   
58CodepointProperties = ['scf', 'slc', 'suc', 'stc']
59
60class UCD_generator():
61    def __init__(self):
62            self.supported_props = []
63            self.property_data_headers = []
64            self.missing_specs = {}
65
66    def load_property_name_info(self):
67       (self.property_enum_name_list, self.full_name_map, self.property_lookup_map, self.property_kind_map) = parse_PropertyAlias_txt()
68
69    def generate_PropertyAliases_h(self):
70       f = cformat.open_header_file_for_write('PropertyAliases')
71       cformat.write_imports(f, ["<string>", "<vector>", "<unordered_map>"])
72       enum_text = cformat.multiline_fill(self.property_enum_name_list, ',')
73       full_name_text = cformat.multiline_fill(['"%s"' % self.full_name_map[e] for e in self.property_enum_name_list], ',')
74       map_text = cformat.multiline_fill(['{"%s", %s}' % (k, self.property_lookup_map[k]) for k in sorted(self.property_lookup_map.keys())], ',')
75       f.write(PropertyAliases_template % (enum_text, full_name_text, map_text))
76       cformat.close_header_file(f)
77
78    def load_property_value_info(self):
79       (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)
80
81
82    def generate_PropertyValueAliases_h(self):
83       f = cformat.open_header_file_for_write('PropertyValueAliases')
84       cformat.write_imports(f, ["<string>", "<unordered_map>", '"PropertyAliases.h"'])
85       f.write("namespace UCD {\n")
86       #  Generate the aliases for all Binary properties.
87       enum_text = cformat.multiline_fill(['N', 'Y'], ',', 6)
88       full_name_text = cformat.multiline_fill(['"No"', '"Yes"'], ',', 6)
89       binary_map_text = cformat.multiline_fill(['{"n", N}', '{"y", Y}', '{"no", N}', '{"yes", Y}', '{"f", N}', '{"t", Y}', '{"false", N}', '{"true", Y}'], ',', 6)
90       f.write(EnumeratedProperty_template % ('Binary', enum_text, full_name_text, binary_map_text))
91       #
92       for p in self.property_enum_name_list:
93         if self.property_value_list.has_key(p):
94           if not self.property_kind_map[p] == 'Binary':
95             enum_text = cformat.multiline_fill(self.property_value_list[p], ',', 6)
96             if p == 'ccc': # Special case: add numeric value information for ccc.
97               enum_text += r"""
98        };
99        const uint8_t enum_val[] = {
100    """
101               enum_text += "      " + cformat.multiline_fill(["%s" % (self.property_value_enum_integer[p][e]) for e in self.property_value_list['ccc']], ',', 6)
102             full_names = [self.property_value_full_name_map[p][e] for e in self.property_value_list[p]]
103             full_name_text = cformat.multiline_fill(['"%s"' % name for name in full_names], ',', 6)
104             canon_full_names = [canonicalize(name) for name in full_names]
105             aliases_only = [k for k in self.property_value_lookup_map[p].keys() if not canonicalize(k) in canon_full_names and k == canonicalize(k)]
106             map_text = cformat.multiline_fill(['{"%s", %s::%s}' % (k, p.upper(), self.property_value_lookup_map[p][k]) for k in sorted(aliases_only)], ',', 6)
107             f.write(EnumeratedProperty_template % (p.upper(), enum_text, full_name_text, map_text))
108       f.write("}\n")
109       cformat.close_header_file(f)
110
111 
112    def generate_property_value_file(self, filename_root, property_code, default_value = None):
113       canonical_property_value_map = self.property_value_lookup_map[property_code]
114       (prop_values, value_map) = parse_UCD_enumerated_property_map(property_code, filename_root + '.txt', canonical_property_value_map, default_value)
115       for v in self.property_value_list[property_code]:
116          if not v in prop_values: 
117             #raise Exception("Property %s value %s missing" % (self.full_name_map[property_code], v))
118             print("Warning: property %s has no instance of value %s" % (self.full_name_map[property_code], v))
119             value_map[v] = empty_uset()
120       basename = os.path.basename(filename_root)
121       f = cformat.open_header_file_for_write(os.path.basename(filename_root))
122       cformat.write_imports(f, ["<vector>", '"unicode_set.h"', '"PropertyAliases.h"', '"PropertyValueAliases.h"'])
123       f.write("\nnamespace UCD {\n")
124       f.write("  namespace %s {\n" % property_code.upper())
125       for v in self.property_value_list[property_code]:
126         f.write("    const UnicodeSet %s_Set \n" % v.lower())
127         f.write(value_map[v].showC(6) + ";\n")
128       print "%s: %s bytes" % (basename, sum([value_map[v].bytes() for v in value_map.keys()]))
129       set_list = ['%s_Set' % v.lower() for v in self.property_value_list[property_code]]
130       f.write("    const EnumeratedPropertyObject property_object\n")
131       f.write("      {%s,\n" % property_code)
132       f.write("       %s::value_names,\n" % property_code.upper())
133       f.write("       %s::aliases_only_map,\n" % property_code.upper())
134       f.write("       {")
135       f.write(cformat.multiline_fill(set_list, ',', 8))
136       f.write("\n       }};\n  }\n}\n")
137       cformat.close_header_file(f)
138       self.supported_props.append(property_code)
139       self.property_data_headers.append(basename)
140
141    def generate_ScriptExtensions_h(self):
142       filename_root = 'ScriptExtensions'
143       property_code = 'scx'
144       canonical_property_value_map = self.property_value_lookup_map['sc']
145       (scripts, script_map) = parse_UCD_codepoint_name_map('Scripts.txt', canonical_property_value_map)
146       (scx_sets, scx_set_map) = parse_UCD_codepoint_name_map('ScriptExtensions.txt')
147       value_map = {}
148       basename = os.path.basename(filename_root)
149       f = cformat.open_header_file_for_write(basename)
150       cformat.write_imports(f, ["<vector>", '"PropertyAliases.h"', '"PropertyValueAliases.h"', '"unicode_set.h"'])
151       f.write("\nusing namespace UCD;\n\n")
152       explicitly_defined_set = empty_uset()
153       for scx_list in scx_sets:
154         scx_items = scx_list.split(" ")
155         for scx in scx_items:
156            #sc = canonical_property_value_map[canonicalize(scx)]
157            sc = scx
158            if value_map.has_key(sc): 
159               value_map[sc] = uset_union(value_map[sc], scx_set_map[scx_list])
160            else: value_map[sc] = scx_set_map[scx_list]
161         explicitly_defined_set = uset_union(explicitly_defined_set, scx_set_map[scx_list])
162       for v in self.property_value_list['sc']:
163          if value_map.has_key(v):
164            value_map[v] = uset_union(value_map[v], uset_difference(script_map[v], explicitly_defined_set))
165          elif script_map.has_key(v):
166            value_map[v] = script_map[v]
167          else: value_map[v] = empty_uset()
168       for v in self.property_value_list['sc']:
169         #v = canonical_property_value_map[canonicalize(v)]
170         f.write("    const UnicodeSet %s_Ext \n" % v.lower())
171         f.write(value_map[v].showC(6) + ";\n")
172       print "%s: %s bytes" % (basename, sum([value_map[v].bytes() for v in value_map.keys()]))
173       set_list = ['%s_Ext' % v.lower() for v in self.property_value_list['sc']]
174       f.write("    const EnumeratedPropertyObject property_object\n")
175       f.write("      {%s,\n" % property_code)
176       f.write("       SC::value_names,\n")
177       f.write("       SC:aliases_only_map,\n")
178       f.write("       {")
179       f.write(cformat.multiline_fill(set_list, ',', 8))
180       f.write("\n       }};\n  }\n}\n")
181       cformat.close_header_file(f)
182       self.supported_props.append('property_code')
183       self.property_data_headers.append(basename)
184
185
186    def generate_binary_properties_file(self, filename_root):
187       (props, prop_map) = parse_UCD_codepoint_name_map(filename_root + '.txt', self.property_lookup_map)
188       basename = os.path.basename(filename_root)
189       f = cformat.open_header_file_for_write(basename)
190       cformat.write_imports(f, ["<vector>", '"unicode_set.h"', '"PropertyAliases.h"'])
191       f.write("\nnamespace UCD {\n")
192       print "%s: %s bytes" % (basename, sum([prop_map[p].bytes() for p in prop_map.keys()]))
193       for p in sorted(props):
194         f.write("  namespace %s {\n    const UnicodeSet codepoint_set \n" % p.upper())
195         f.write(prop_map[p].showC(6) + ";\n")
196         f.write("    const BinaryPropertyObject property_object{%s, codepoint_set};\n  }\n" % p)
197       f.write("}\n\n")
198       cformat.close_header_file(f)
199       self.supported_props += props
200       self.property_data_headers.append(basename)
201
202    def generate_PropertyObjectTable_h(self):
203       f = cformat.open_header_file_for_write('PropertyObjectTable')
204       cformat.write_imports(f, ['"PropertyObjects.h"', '"PropertyAliases.h"'])
205       cformat.write_imports(f, ['"%s.h"' % fname for fname in self.property_data_headers])
206       f.write("\nnamespace UCD {\n")
207       objlist = []
208       for p in self.property_enum_name_list:
209         k = self.property_kind_map[p]
210         if (k == 'Enumerated' or k == 'Catalog') and p in self.supported_props:
211            objlist.append("&%s::property_object" % p.upper())
212         elif k == 'String':
213            if p in CodepointProperties:
214              objlist.append("new UnsupportedPropertyObject(%s, CodepointProperty)" % p)
215            else:
216              objlist.append("new UnsupportedPropertyObject(%s, StringProperty)" % p)
217         elif k == 'Binary' and p in self.supported_props:
218            objlist.append("&%s::property_object" % p.upper())
219         else:
220            objlist.append("new UnsupportedPropertyObject(%s, %sProperty)" % (p, k))
221       f.write("\n  const PropertyObject* property_object_table[] = {\n    ")
222       f.write(",\n    ".join(objlist) + '  };\n}\n')
223       cformat.close_header_file(f)
224
225
226
227def UCD_main():
228   ucd = UCD_generator()
229
230   # First parse all property names and their aliases
231   ucd.load_property_name_info()
232   #
233   # Generate the PropertyAliases.h file to define all the Unicode property_t enum
234   # and the basic property information.
235   ucd.generate_PropertyAliases_h()
236   #
237   # Next parse all property value names and their aliases.  Generate the data.
238   ucd.load_property_value_info()
239   ucd.generate_PropertyValueAliases_h()
240   #
241   # The Block property
242   ucd.generate_property_value_file('Blocks', 'blk')
243   #
244   # Scripts
245   ucd.generate_property_value_file('Scripts', 'sc')
246   #
247   # Script Extensions
248   ucd.generate_ScriptExtensions_h()
249   #
250   # General Category
251   ucd.generate_property_value_file('extracted/DerivedGeneralCategory', 'gc')
252   #
253   # Binary properties from PropList.txt
254   ucd.generate_binary_properties_file('PropList')
255   #
256   # Binary properties from DerivedCoreProperties.txt
257   ucd.generate_binary_properties_file('DerivedCoreProperties')
258   #
259   #
260   # LineBreak types
261   ucd.generate_property_value_file('LineBreak', 'lb')
262   #
263   # East Asian Width
264   ucd.generate_property_value_file('EastAsianWidth', 'ea')
265   #
266   # Hangul Syllable Type
267   ucd.generate_property_value_file('HangulSyllableType', 'hst')
268   #
269   # Jamo Short Name - AAARGH - property value for 110B is an empty string!!!!!  - Not in PropertyValueAliases.txt
270   # ucd.generate_property_value_file('Jamo', 'jsn')
271   #
272   # Stubs
273   #
274   ucd.generate_PropertyObjectTable_h()
275
276if __name__ == "__main__":
277  UCD_main()
Note: See TracBrowser for help on using the repository browser.