GenerateUnicodeData.cpp 37 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887888889890891892893894895896897898899900901902903904905906907908909910911912913914915916917918919920921922923924925926927928929930931932933934935936937938939940941942943944945946947948949950951952953954955956957958959960961962963964965966
  1. /*
  2. * Copyright (c) 2021, Tim Flynn <trflynn89@pm.me>
  3. *
  4. * SPDX-License-Identifier: BSD-2-Clause
  5. */
  6. #include <AK/AllOf.h>
  7. #include <AK/Array.h>
  8. #include <AK/CharacterTypes.h>
  9. #include <AK/HashMap.h>
  10. #include <AK/Optional.h>
  11. #include <AK/QuickSort.h>
  12. #include <AK/SourceGenerator.h>
  13. #include <AK/String.h>
  14. #include <AK/StringUtils.h>
  15. #include <AK/Types.h>
  16. #include <AK/Vector.h>
  17. #include <LibCore/ArgsParser.h>
  18. #include <LibCore/File.h>
  19. // Some code points are excluded from UnicodeData.txt, and instead are part of a "range" of code
  20. // points, as indicated by the "name" field. For example:
  21. // 3400;<CJK Ideograph Extension A, First>;Lo;0;L;;;;;N;;;;;
  22. // 4DBF;<CJK Ideograph Extension A, Last>;Lo;0;L;;;;;N;;;;;
  23. struct CodePointRange {
  24. u32 first;
  25. u32 last;
  26. };
  27. // SpecialCasing source: https://www.unicode.org/Public/13.0.0/ucd/SpecialCasing.txt
  28. // Field descriptions: https://www.unicode.org/reports/tr44/tr44-13.html#SpecialCasing.txt
  29. struct SpecialCasing {
  30. u32 index { 0 };
  31. u32 code_point { 0 };
  32. Vector<u32> lowercase_mapping;
  33. Vector<u32> uppercase_mapping;
  34. Vector<u32> titlecase_mapping;
  35. String locale;
  36. String condition;
  37. };
  38. // PropList source: https://www.unicode.org/Public/13.0.0/ucd/PropList.txt
  39. // Property descriptions: https://www.unicode.org/reports/tr44/tr44-13.html#PropList.txt
  40. using PropList = HashMap<String, Vector<CodePointRange>>;
  41. // PropertyAliases source: https://www.unicode.org/Public/13.0.0/ucd/PropertyAliases.txt
  42. struct Alias {
  43. String property;
  44. String alias;
  45. };
  46. // UnicodeData source: https://www.unicode.org/Public/13.0.0/ucd/UnicodeData.txt
  47. // Field descriptions: https://www.unicode.org/reports/tr44/tr44-13.html#UnicodeData.txt
  48. // https://www.unicode.org/reports/tr44/#General_Category_Values
  49. struct CodePointData {
  50. u32 code_point { 0 };
  51. String name;
  52. u8 canonical_combining_class { 0 };
  53. String bidi_class;
  54. String decomposition_type;
  55. Optional<i8> numeric_value_decimal;
  56. Optional<i8> numeric_value_digit;
  57. Optional<i8> numeric_value_numeric;
  58. bool bidi_mirrored { false };
  59. String unicode_1_name;
  60. String iso_comment;
  61. Optional<u32> simple_uppercase_mapping;
  62. Optional<u32> simple_lowercase_mapping;
  63. Optional<u32> simple_titlecase_mapping;
  64. Vector<u32> special_casing_indices;
  65. StringView script;
  66. Vector<StringView> script_extensions;
  67. };
  68. struct UnicodeData {
  69. Vector<SpecialCasing> special_casing;
  70. u32 largest_casing_transform_size { 0 };
  71. u32 largest_special_casing_size { 0 };
  72. Vector<String> locales;
  73. Vector<String> conditions;
  74. Vector<CodePointData> code_point_data;
  75. Vector<CodePointRange> code_point_ranges;
  76. PropList general_categories;
  77. Vector<Alias> general_category_aliases;
  78. // The Unicode standard defines additional properties (Any, Assigned, ASCII) which are not in
  79. // any UCD file. Assigned code point ranges are derived as this generator is executed.
  80. // https://unicode.org/reports/tr18/#General_Category_Property
  81. PropList prop_list {
  82. { "Any"sv, { { 0, 0x10ffff } } },
  83. { "Assigned"sv, {} },
  84. { "ASCII"sv, { { 0, 0x7f } } },
  85. };
  86. Vector<Alias> prop_aliases;
  87. PropList script_list {
  88. { "Unknown"sv, {} },
  89. };
  90. Vector<Alias> script_aliases;
  91. PropList script_extensions;
  92. u32 largest_script_extensions_size { 0 };
  93. };
  94. static constexpr auto s_desired_fields = Array {
  95. "simple_uppercase_mapping"sv,
  96. "simple_lowercase_mapping"sv,
  97. };
  98. static void write_to_file_if_different(Core::File& file, StringView contents)
  99. {
  100. auto const current_contents = file.read_all();
  101. if (StringView { current_contents.bytes() } == contents)
  102. return;
  103. VERIFY(file.seek(0));
  104. VERIFY(file.truncate(0));
  105. VERIFY(file.write(contents));
  106. }
  107. static void parse_special_casing(Core::File& file, UnicodeData& unicode_data)
  108. {
  109. auto parse_code_point_list = [&](auto const& line) {
  110. Vector<u32> code_points;
  111. auto segments = line.split(' ');
  112. for (auto const& code_point : segments)
  113. code_points.append(AK::StringUtils::convert_to_uint_from_hex<u32>(code_point).value());
  114. return code_points;
  115. };
  116. while (file.can_read_line()) {
  117. auto line = file.read_line();
  118. if (line.is_empty() || line.starts_with('#'))
  119. continue;
  120. if (auto index = line.find('#'); index.has_value())
  121. line = line.substring(0, *index);
  122. auto segments = line.split(';', true);
  123. VERIFY(segments.size() == 5 || segments.size() == 6);
  124. SpecialCasing casing {};
  125. casing.index = static_cast<u32>(unicode_data.special_casing.size());
  126. casing.code_point = AK::StringUtils::convert_to_uint_from_hex<u32>(segments[0]).value();
  127. casing.lowercase_mapping = parse_code_point_list(segments[1]);
  128. casing.titlecase_mapping = parse_code_point_list(segments[2]);
  129. casing.uppercase_mapping = parse_code_point_list(segments[3]);
  130. if (auto condition = segments[4].trim_whitespace(); !condition.is_empty()) {
  131. auto conditions = condition.split(' ', true);
  132. VERIFY(conditions.size() == 1 || conditions.size() == 2);
  133. if (conditions.size() == 2) {
  134. casing.locale = move(conditions[0]);
  135. casing.condition = move(conditions[1]);
  136. } else if (all_of(conditions[0], is_ascii_lower_alpha)) {
  137. casing.locale = move(conditions[0]);
  138. } else {
  139. casing.condition = move(conditions[0]);
  140. }
  141. casing.locale = casing.locale.to_uppercase();
  142. casing.condition.replace("_", "", true);
  143. if (!casing.locale.is_empty() && !unicode_data.locales.contains_slow(casing.locale))
  144. unicode_data.locales.append(casing.locale);
  145. if (!casing.condition.is_empty() && !unicode_data.conditions.contains_slow(casing.condition))
  146. unicode_data.conditions.append(casing.condition);
  147. }
  148. unicode_data.largest_casing_transform_size = max(unicode_data.largest_casing_transform_size, casing.lowercase_mapping.size());
  149. unicode_data.largest_casing_transform_size = max(unicode_data.largest_casing_transform_size, casing.titlecase_mapping.size());
  150. unicode_data.largest_casing_transform_size = max(unicode_data.largest_casing_transform_size, casing.uppercase_mapping.size());
  151. unicode_data.special_casing.append(move(casing));
  152. }
  153. }
  154. static void parse_prop_list(Core::File& file, PropList& prop_list, bool multi_value_property = false)
  155. {
  156. while (file.can_read_line()) {
  157. auto line = file.read_line();
  158. if (line.is_empty() || line.starts_with('#'))
  159. continue;
  160. if (auto index = line.find('#'); index.has_value())
  161. line = line.substring(0, *index);
  162. auto segments = line.split_view(';', true);
  163. VERIFY(segments.size() == 2);
  164. auto code_point_range = segments[0].trim_whitespace();
  165. Vector<StringView> properties;
  166. if (multi_value_property)
  167. properties = segments[1].trim_whitespace().split_view(' ');
  168. else
  169. properties = { segments[1].trim_whitespace() };
  170. for (auto const& property : properties) {
  171. auto& code_points = prop_list.ensure(property.trim_whitespace());
  172. if (code_point_range.contains(".."sv)) {
  173. segments = code_point_range.split_view(".."sv);
  174. VERIFY(segments.size() == 2);
  175. auto begin = AK::StringUtils::convert_to_uint_from_hex<u32>(segments[0]).value();
  176. auto end = AK::StringUtils::convert_to_uint_from_hex<u32>(segments[1]).value();
  177. code_points.append({ begin, end });
  178. } else {
  179. auto code_point = AK::StringUtils::convert_to_uint_from_hex<u32>(code_point_range).value();
  180. code_points.append({ code_point, code_point });
  181. }
  182. }
  183. }
  184. }
  185. static void parse_alias_list(Core::File& file, PropList const& prop_list, Vector<Alias>& prop_aliases)
  186. {
  187. String current_property;
  188. auto append_alias = [&](auto alias, auto property) {
  189. // Note: The alias files contain lines such as "Hyphen = Hyphen", which we should just skip.
  190. if (alias == property)
  191. return;
  192. // FIXME: We will, eventually, need to find where missing properties are located and parse them.
  193. if (!prop_list.contains(property))
  194. return;
  195. prop_aliases.append({ property, alias });
  196. };
  197. while (file.can_read_line()) {
  198. auto line = file.read_line();
  199. if (line.is_empty() || line.starts_with('#')) {
  200. if (line.ends_with("Properties"sv))
  201. current_property = line.substring(2);
  202. continue;
  203. }
  204. // Note: For now, we only care about Binary Property aliases for Unicode property escapes.
  205. if (current_property != "Binary Properties"sv)
  206. continue;
  207. auto segments = line.split_view(';', true);
  208. VERIFY((segments.size() == 2) || (segments.size() == 3));
  209. auto alias = segments[0].trim_whitespace();
  210. auto property = segments[1].trim_whitespace();
  211. append_alias(alias, property);
  212. if (segments.size() == 3) {
  213. alias = segments[2].trim_whitespace();
  214. append_alias(alias, property);
  215. }
  216. }
  217. }
  218. static void parse_value_alias_list(Core::File& file, StringView desired_category, Vector<String> const& value_list, Vector<Alias>& prop_aliases, bool primary_value_is_first = true)
  219. {
  220. VERIFY(file.seek(0));
  221. auto append_alias = [&](auto alias, auto value) {
  222. // Note: The value alias file contains lines such as "Ahom = Ahom", which we should just skip.
  223. if (alias == value)
  224. return;
  225. // FIXME: We will, eventually, need to find where missing properties are located and parse them.
  226. if (!value_list.contains_slow(value))
  227. return;
  228. prop_aliases.append({ value, alias });
  229. };
  230. while (file.can_read_line()) {
  231. auto line = file.read_line();
  232. if (line.is_empty() || line.starts_with('#'))
  233. continue;
  234. if (auto index = line.find('#'); index.has_value())
  235. line = line.substring(0, *index);
  236. auto segments = line.split_view(';', true);
  237. auto category = segments[0].trim_whitespace();
  238. if (category != desired_category)
  239. continue;
  240. VERIFY((segments.size() == 3) || (segments.size() == 4));
  241. auto value = primary_value_is_first ? segments[1].trim_whitespace() : segments[2].trim_whitespace();
  242. auto alias = primary_value_is_first ? segments[2].trim_whitespace() : segments[1].trim_whitespace();
  243. append_alias(alias, value);
  244. if (segments.size() == 4) {
  245. alias = segments[3].trim_whitespace();
  246. append_alias(alias, value);
  247. }
  248. }
  249. }
  250. static void parse_unicode_data(Core::File& file, UnicodeData& unicode_data)
  251. {
  252. Optional<u32> code_point_range_start;
  253. auto& assigned_code_points = unicode_data.prop_list.find("Assigned"sv)->value;
  254. Optional<u32> assigned_code_point_range_start = 0;
  255. u32 previous_code_point = 0;
  256. auto assign_code_point_property = [&](u32 code_point, auto const& list, auto& property, StringView default_) {
  257. using PropertyType = RemoveCVReference<decltype(property)>;
  258. constexpr bool is_single_item = IsSame<PropertyType, StringView>;
  259. auto assign_property = [&](auto const& item) {
  260. if constexpr (is_single_item)
  261. property = item;
  262. else
  263. property.append(item);
  264. };
  265. for (auto const& item : list) {
  266. for (auto const& range : item.value) {
  267. if ((range.first <= code_point) && (code_point <= range.last)) {
  268. assign_property(item.key);
  269. break;
  270. }
  271. }
  272. if constexpr (is_single_item) {
  273. if (!property.is_empty())
  274. break;
  275. }
  276. }
  277. if (property.is_empty() && !default_.is_empty())
  278. assign_property(default_);
  279. };
  280. while (file.can_read_line()) {
  281. auto line = file.read_line();
  282. if (line.is_empty())
  283. continue;
  284. auto segments = line.split(';', true);
  285. VERIFY(segments.size() == 15);
  286. CodePointData data {};
  287. data.code_point = AK::StringUtils::convert_to_uint_from_hex<u32>(segments[0]).value();
  288. data.name = move(segments[1]);
  289. data.canonical_combining_class = AK::StringUtils::convert_to_uint<u8>(segments[3]).value();
  290. data.bidi_class = move(segments[4]);
  291. data.decomposition_type = move(segments[5]);
  292. data.numeric_value_decimal = AK::StringUtils::convert_to_int<i8>(segments[6]);
  293. data.numeric_value_digit = AK::StringUtils::convert_to_int<i8>(segments[7]);
  294. data.numeric_value_numeric = AK::StringUtils::convert_to_int<i8>(segments[8]);
  295. data.bidi_mirrored = segments[9] == "Y"sv;
  296. data.unicode_1_name = move(segments[10]);
  297. data.iso_comment = move(segments[11]);
  298. data.simple_uppercase_mapping = AK::StringUtils::convert_to_uint_from_hex<u32>(segments[12]);
  299. data.simple_lowercase_mapping = AK::StringUtils::convert_to_uint_from_hex<u32>(segments[13]);
  300. data.simple_titlecase_mapping = AK::StringUtils::convert_to_uint_from_hex<u32>(segments[14]);
  301. if (!assigned_code_point_range_start.has_value())
  302. assigned_code_point_range_start = data.code_point;
  303. if (data.name.starts_with("<"sv) && data.name.ends_with(", First>")) {
  304. VERIFY(!code_point_range_start.has_value() && assigned_code_point_range_start.has_value());
  305. code_point_range_start = data.code_point;
  306. data.name = data.name.substring(1, data.name.length() - 9);
  307. assigned_code_points.append({ *assigned_code_point_range_start, previous_code_point });
  308. assigned_code_point_range_start.clear();
  309. } else if (data.name.starts_with("<"sv) && data.name.ends_with(", Last>")) {
  310. VERIFY(code_point_range_start.has_value());
  311. CodePointRange code_point_range { *code_point_range_start, data.code_point };
  312. unicode_data.code_point_ranges.append(code_point_range);
  313. assigned_code_points.append(code_point_range);
  314. data.name = data.name.substring(1, data.name.length() - 8);
  315. code_point_range_start.clear();
  316. } else if ((data.code_point > 0) && (data.code_point - previous_code_point) != 1) {
  317. VERIFY(assigned_code_point_range_start.has_value());
  318. assigned_code_points.append({ *assigned_code_point_range_start, previous_code_point });
  319. assigned_code_point_range_start = data.code_point;
  320. }
  321. for (auto const& casing : unicode_data.special_casing) {
  322. if (casing.code_point == data.code_point)
  323. data.special_casing_indices.append(casing.index);
  324. }
  325. assign_code_point_property(data.code_point, unicode_data.script_list, data.script, "Unknown"sv);
  326. assign_code_point_property(data.code_point, unicode_data.script_extensions, data.script_extensions, {});
  327. unicode_data.largest_special_casing_size = max(unicode_data.largest_special_casing_size, data.special_casing_indices.size());
  328. unicode_data.largest_script_extensions_size = max(unicode_data.largest_script_extensions_size, data.script_extensions.size());
  329. previous_code_point = data.code_point;
  330. unicode_data.code_point_data.append(move(data));
  331. }
  332. }
  333. static void generate_unicode_data_header(Core::File& file, UnicodeData& unicode_data)
  334. {
  335. StringBuilder builder;
  336. SourceGenerator generator { builder };
  337. generator.set("casing_transform_size", String::number(unicode_data.largest_casing_transform_size));
  338. generator.set("special_casing_size", String::number(unicode_data.largest_special_casing_size));
  339. generator.set("script_extensions_size", String::number(unicode_data.largest_script_extensions_size));
  340. auto generate_enum = [&](StringView name, StringView default_, Vector<String> values, Vector<Alias> aliases = {}) {
  341. quick_sort(values);
  342. quick_sort(aliases, [](auto& alias1, auto& alias2) { return alias1.alias < alias2.alias; });
  343. generator.set("name", name);
  344. generator.set("underlying", String::formatted("{}UnderlyingType", name));
  345. generator.append(R"~~~(
  346. using @underlying@ = u8;
  347. enum class @name@ : @underlying@ {)~~~");
  348. if (!default_.is_empty()) {
  349. generator.set("default", default_);
  350. generator.append(R"~~~(
  351. @default@,)~~~");
  352. }
  353. for (auto const& value : values) {
  354. generator.set("value", value);
  355. generator.append(R"~~~(
  356. @value@,)~~~");
  357. }
  358. for (auto const& alias : aliases) {
  359. generator.set("alias", alias.alias);
  360. generator.set("value", alias.property);
  361. generator.append(R"~~~(
  362. @alias@ = @value@,)~~~");
  363. }
  364. generator.append(R"~~~(
  365. };
  366. )~~~");
  367. };
  368. generator.append(R"~~~(
  369. #pragma once
  370. #include <AK/Optional.h>
  371. #include <AK/Types.h>
  372. #include <LibUnicode/Forward.h>
  373. namespace Unicode {
  374. )~~~");
  375. generate_enum("Locale"sv, "None"sv, move(unicode_data.locales));
  376. generate_enum("Condition"sv, "None"sv, move(unicode_data.conditions));
  377. generate_enum("GeneralCategory"sv, {}, unicode_data.general_categories.keys(), unicode_data.general_category_aliases);
  378. generate_enum("Property"sv, {}, unicode_data.prop_list.keys(), unicode_data.prop_aliases);
  379. generate_enum("Script"sv, {}, unicode_data.script_list.keys(), unicode_data.script_aliases);
  380. generator.append(R"~~~(
  381. struct SpecialCasing {
  382. u32 code_point { 0 };
  383. u32 lowercase_mapping[@casing_transform_size@];
  384. u32 lowercase_mapping_size { 0 };
  385. u32 uppercase_mapping[@casing_transform_size@];
  386. u32 uppercase_mapping_size { 0 };
  387. u32 titlecase_mapping[@casing_transform_size@];
  388. u32 titlecase_mapping_size { 0 };
  389. Locale locale { Locale::None };
  390. Condition condition { Condition::None };
  391. };
  392. struct UnicodeData {
  393. u32 code_point;)~~~");
  394. auto append_field = [&](StringView type, StringView name) {
  395. if (!s_desired_fields.span().contains_slow(name))
  396. return;
  397. generator.set("type", type);
  398. generator.set("name", name);
  399. generator.append(R"~~~(
  400. @type@ @name@;)~~~");
  401. };
  402. // Note: For compile-time performance, only primitive types are used.
  403. append_field("char const*"sv, "name"sv);
  404. append_field("u8"sv, "canonical_combining_class"sv);
  405. append_field("char const*"sv, "bidi_class"sv);
  406. append_field("char const*"sv, "decomposition_type"sv);
  407. append_field("i8"sv, "numeric_value_decimal"sv);
  408. append_field("i8"sv, "numeric_value_digit"sv);
  409. append_field("i8"sv, "numeric_value_numeric"sv);
  410. append_field("bool"sv, "bidi_mirrored"sv);
  411. append_field("char const*"sv, "unicode_1_name"sv);
  412. append_field("char const*"sv, "iso_comment"sv);
  413. append_field("u32"sv, "simple_uppercase_mapping"sv);
  414. append_field("u32"sv, "simple_lowercase_mapping"sv);
  415. append_field("u32"sv, "simple_titlecase_mapping"sv);
  416. generator.append(R"~~~(
  417. SpecialCasing const* special_casing[@special_casing_size@] {};
  418. u32 special_casing_size { 0 };
  419. Script script { Script::Unknown };
  420. Script script_extensions[@script_extensions_size@];
  421. u32 script_extensions_size { 0 };
  422. };
  423. namespace Detail {
  424. Optional<UnicodeData> unicode_data_for_code_point(u32 code_point);
  425. bool code_point_has_general_category(u32 code_point, GeneralCategory general_category);
  426. Optional<GeneralCategory> general_category_from_string(StringView const& general_category);
  427. bool code_point_has_property(u32 code_point, Property property);
  428. Optional<Property> property_from_string(StringView const& property);
  429. Optional<Script> script_from_string(StringView const& script);
  430. }
  431. }
  432. )~~~");
  433. write_to_file_if_different(file, generator.as_string_view());
  434. }
  435. static void generate_unicode_data_implementation(Core::File& file, UnicodeData const& unicode_data)
  436. {
  437. StringBuilder builder;
  438. SourceGenerator generator { builder };
  439. generator.set("special_casing_size", String::number(unicode_data.special_casing.size()));
  440. generator.set("code_point_data_size", String::number(unicode_data.code_point_data.size()));
  441. generator.append(R"~~~(
  442. #include <AK/Array.h>
  443. #include <AK/BinarySearch.h>
  444. #include <AK/CharacterTypes.h>
  445. #include <AK/HashMap.h>
  446. #include <AK/StringView.h>
  447. #include <LibUnicode/UnicodeData.h>
  448. namespace Unicode {
  449. )~~~");
  450. auto append_list_and_size = [&](auto const& list, StringView format) {
  451. if (list.is_empty()) {
  452. generator.append(", {}, 0");
  453. return;
  454. }
  455. bool first = true;
  456. generator.append(", {");
  457. for (auto const& item : list) {
  458. generator.append(first ? " " : ", ");
  459. generator.append(String::formatted(format, item));
  460. first = false;
  461. }
  462. generator.append(String::formatted(" }}, {}", list.size()));
  463. };
  464. generator.append(R"~~~(
  465. static constexpr Array<SpecialCasing, @special_casing_size@> s_special_casing { {)~~~");
  466. for (auto const& casing : unicode_data.special_casing) {
  467. generator.set("code_point", String::formatted("{:#x}", casing.code_point));
  468. generator.append(R"~~~(
  469. { @code_point@)~~~");
  470. constexpr auto format = "0x{:x}"sv;
  471. append_list_and_size(casing.lowercase_mapping, format);
  472. append_list_and_size(casing.uppercase_mapping, format);
  473. append_list_and_size(casing.titlecase_mapping, format);
  474. generator.set("locale", casing.locale.is_empty() ? "None" : casing.locale);
  475. generator.append(", Locale::@locale@");
  476. generator.set("condition", casing.condition.is_empty() ? "None" : casing.condition);
  477. generator.append(", Condition::@condition@");
  478. generator.append(" },");
  479. }
  480. generator.append(R"~~~(
  481. } };
  482. static constexpr Array<UnicodeData, @code_point_data_size@> s_unicode_data { {)~~~");
  483. auto append_field = [&](StringView name, String value) {
  484. if (!s_desired_fields.span().contains_slow(name))
  485. return;
  486. generator.set("value", move(value));
  487. generator.append(", @value@");
  488. };
  489. for (auto const& data : unicode_data.code_point_data) {
  490. generator.set("code_point", String::formatted("{:#x}", data.code_point));
  491. generator.append(R"~~~(
  492. { @code_point@)~~~");
  493. append_field("name", String::formatted("\"{}\"", data.name));
  494. append_field("canonical_combining_class", String::number(data.canonical_combining_class));
  495. append_field("bidi_class", String::formatted("\"{}\"", data.bidi_class));
  496. append_field("decomposition_type", String::formatted("\"{}\"", data.decomposition_type));
  497. append_field("numeric_value_decimal", String::number(data.numeric_value_decimal.value_or(-1)));
  498. append_field("numeric_value_digit", String::number(data.numeric_value_digit.value_or(-1)));
  499. append_field("numeric_value_numeric", String::number(data.numeric_value_numeric.value_or(-1)));
  500. append_field("bidi_mirrored", String::formatted("{}", data.bidi_mirrored));
  501. append_field("unicode_1_name", String::formatted("\"{}\"", data.unicode_1_name));
  502. append_field("iso_comment", String::formatted("\"{}\"", data.iso_comment));
  503. append_field("simple_uppercase_mapping", String::formatted("{:#x}", data.simple_uppercase_mapping.value_or(data.code_point)));
  504. append_field("simple_lowercase_mapping", String::formatted("{:#x}", data.simple_lowercase_mapping.value_or(data.code_point)));
  505. append_field("simple_titlecase_mapping", String::formatted("{:#x}", data.simple_titlecase_mapping.value_or(data.code_point)));
  506. append_list_and_size(data.special_casing_indices, "&s_special_casing[{}]"sv);
  507. generator.append(String::formatted(", Script::{}", data.script));
  508. append_list_and_size(data.script_extensions, "Script::{}"sv);
  509. generator.append(" },");
  510. }
  511. generator.append(R"~~~(
  512. } };
  513. struct CodePointRange {
  514. u32 first { 0 };
  515. u32 last { 0 };
  516. };
  517. struct CodePointRangeComparator {
  518. constexpr int operator()(u32 code_point, CodePointRange const& range)
  519. {
  520. return (code_point > range.last) - (code_point < range.first);
  521. }
  522. };
  523. )~~~");
  524. auto append_code_point_range_list = [&](String name, Vector<CodePointRange> const& ranges) {
  525. generator.set("name", name);
  526. generator.set("size", String::number(ranges.size()));
  527. generator.append(R"~~~(
  528. static constexpr Array<CodePointRange, @size@> @name@ { {
  529. )~~~");
  530. constexpr size_t max_ranges_per_row = 20;
  531. size_t ranges_in_current_row = 0;
  532. for (auto const& range : ranges) {
  533. if (ranges_in_current_row++ > 0)
  534. generator.append(" ");
  535. generator.set("first", String::formatted("{:#x}", range.first));
  536. generator.set("last", String::formatted("{:#x}", range.last));
  537. generator.append("{ @first@, @last@ },");
  538. if (ranges_in_current_row == max_ranges_per_row) {
  539. ranges_in_current_row = 0;
  540. generator.append("\n ");
  541. }
  542. }
  543. generator.append(R"~~~(
  544. } };
  545. )~~~");
  546. };
  547. auto append_prop_list = [&](StringView collection_name, StringView property_format, PropList const& property_list) {
  548. for (auto const& property : property_list) {
  549. auto name = String::formatted(property_format, property.key);
  550. append_code_point_range_list(move(name), property.value);
  551. }
  552. auto property_names = property_list.keys();
  553. quick_sort(property_names);
  554. generator.set("name", collection_name);
  555. generator.set("size", String::number(property_names.size()));
  556. generator.append(R"~~~(
  557. static constexpr Array<Span<CodePointRange const>, @size@> @name@ { {)~~~");
  558. for (auto const& property_name : property_names) {
  559. generator.set("name", String::formatted(property_format, property_name));
  560. generator.append(R"~~~(
  561. @name@.span(),)~~~");
  562. }
  563. generator.append(R"~~~(
  564. } };
  565. )~~~");
  566. };
  567. append_prop_list("s_general_categories"sv, "s_general_category_{}"sv, unicode_data.general_categories);
  568. append_prop_list("s_properties"sv, "s_property_{}"sv, unicode_data.prop_list);
  569. generator.append(R"~~~(
  570. static HashMap<u32, UnicodeData const*> const& ensure_code_point_map()
  571. {
  572. static HashMap<u32, UnicodeData const*> code_point_to_data_map;
  573. code_point_to_data_map.ensure_capacity(s_unicode_data.size());
  574. for (auto const& unicode_data : s_unicode_data)
  575. code_point_to_data_map.set(unicode_data.code_point, &unicode_data);
  576. return code_point_to_data_map;
  577. }
  578. static Optional<u32> index_of_code_point_in_range(u32 code_point)
  579. {)~~~");
  580. for (auto const& range : unicode_data.code_point_ranges) {
  581. generator.set("first", String::formatted("{:#x}", range.first));
  582. generator.set("last", String::formatted("{:#x}", range.last));
  583. generator.append(R"~~~(
  584. if ((code_point > @first@) && (code_point < @last@))
  585. return @first@;)~~~");
  586. }
  587. generator.append(R"~~~(
  588. return {};
  589. }
  590. namespace Detail {
  591. Optional<UnicodeData> unicode_data_for_code_point(u32 code_point)
  592. {
  593. static auto const& code_point_to_data_map = ensure_code_point_map();
  594. VERIFY(is_unicode(code_point));
  595. if (auto data = code_point_to_data_map.get(code_point); data.has_value())
  596. return *(data.value());
  597. if (auto index = index_of_code_point_in_range(code_point); index.has_value()) {
  598. auto data_for_range = *(code_point_to_data_map.get(*index).value());
  599. data_for_range.simple_uppercase_mapping = code_point;
  600. data_for_range.simple_lowercase_mapping = code_point;
  601. return data_for_range;
  602. }
  603. return {};
  604. }
  605. )~~~");
  606. auto append_prop_search = [&](StringView enum_title, StringView enum_snake, StringView collection_name) {
  607. generator.set("enum_title", enum_title);
  608. generator.set("enum_snake", enum_snake);
  609. generator.set("collection_name", collection_name);
  610. generator.append(R"~~~(
  611. bool code_point_has_@enum_snake@(u32 code_point, @enum_title@ @enum_snake@)
  612. {
  613. auto index = static_cast<@enum_title@UnderlyingType>(@enum_snake@);
  614. auto const& ranges = @collection_name@.at(index);
  615. auto const* range = binary_search(ranges, code_point, nullptr, CodePointRangeComparator {});
  616. return range != nullptr;
  617. }
  618. )~~~");
  619. };
  620. append_prop_search("GeneralCategory"sv, "general_category"sv, "s_general_categories"sv);
  621. generator.append(R"~~~(
  622. Optional<GeneralCategory> general_category_from_string(StringView const& general_category)
  623. {)~~~");
  624. for (auto const& general_category : unicode_data.general_categories) {
  625. generator.set("general_category", general_category.key);
  626. generator.append(R"~~~(
  627. if (general_category == "@general_category@"sv)
  628. return GeneralCategory::@general_category@;)~~~");
  629. }
  630. for (auto const& alias : unicode_data.general_category_aliases) {
  631. generator.set("general_category", alias.alias);
  632. generator.append(R"~~~(
  633. if (general_category == "@general_category@"sv)
  634. return GeneralCategory::@general_category@;)~~~");
  635. }
  636. generator.append(R"~~~(
  637. return {};
  638. }
  639. )~~~");
  640. append_prop_search("Property"sv, "property"sv, "s_properties"sv);
  641. generator.append(R"~~~(
  642. Optional<Property> property_from_string(StringView const& property)
  643. {
  644. if (property == "Assigned"sv)
  645. return Property::Assigned;)~~~");
  646. for (auto const& property : unicode_data.prop_list) {
  647. generator.set("property", property.key);
  648. generator.append(R"~~~(
  649. if (property == "@property@"sv)
  650. return Property::@property@;)~~~");
  651. }
  652. for (auto const& alias : unicode_data.prop_aliases) {
  653. generator.set("property", alias.alias);
  654. generator.append(R"~~~(
  655. if (property == "@property@"sv)
  656. return Property::@property@;)~~~");
  657. }
  658. generator.append(R"~~~(
  659. return {};
  660. }
  661. Optional<Script> script_from_string(StringView const& script)
  662. {)~~~");
  663. for (auto const& script : unicode_data.script_list) {
  664. generator.set("script", script.key);
  665. generator.append(R"~~~(
  666. if (script == "@script@"sv)
  667. return Script::@script@;)~~~");
  668. }
  669. for (auto const& alias : unicode_data.script_aliases) {
  670. generator.set("script", alias.alias);
  671. generator.append(R"~~~(
  672. if (script == "@script@"sv)
  673. return Script::@script@;)~~~");
  674. }
  675. generator.append(R"~~~(
  676. return {};
  677. }
  678. }
  679. }
  680. )~~~");
  681. write_to_file_if_different(file, generator.as_string_view());
  682. }
  683. static void populate_general_category_unions(PropList& general_categories)
  684. {
  685. // The Unicode standard defines General Category values which are not in any UCD file. These
  686. // values are simply unions of other values.
  687. // https://www.unicode.org/reports/tr44/#GC_Values_Table
  688. auto populate_union = [&](auto alias, auto categories) {
  689. auto& code_points = general_categories.ensure(alias);
  690. for (auto const& category : categories)
  691. code_points.extend(general_categories.find(category)->value);
  692. quick_sort(code_points, [](auto const& range1, auto const& range2) {
  693. return range1.first < range2.first;
  694. });
  695. // Verify that no code point range overlaps. If this changes some day, we will have to
  696. // combine the overlapping regions for binary seaches through this list to work.
  697. for (size_t i = 0; i < code_points.size() - 1; ++i)
  698. VERIFY(code_points[i].last < code_points[i + 1].first);
  699. };
  700. populate_union("LC"sv, Array { "Ll"sv, "Lu"sv, "Lt"sv });
  701. populate_union("L"sv, Array { "Lu"sv, "Ll"sv, "Lt"sv, "Lm"sv, "Lo"sv });
  702. populate_union("M"sv, Array { "Mn"sv, "Mc"sv, "Me"sv });
  703. populate_union("N"sv, Array { "Nd"sv, "Nl"sv, "No"sv });
  704. populate_union("P"sv, Array { "Pc"sv, "Pd"sv, "Ps"sv, "Pe"sv, "Pi"sv, "Pf"sv, "Po"sv });
  705. populate_union("S"sv, Array { "Sm"sv, "Sc"sv, "Sk"sv, "So"sv });
  706. populate_union("Z"sv, Array { "Zs"sv, "Zl"sv, "Zp"sv });
  707. populate_union("C"sv, Array { "Cc"sv, "Cf"sv, "Cs"sv, "Co"sv, "Cn"sv });
  708. }
  709. int main(int argc, char** argv)
  710. {
  711. char const* generated_header_path = nullptr;
  712. char const* generated_implementation_path = nullptr;
  713. char const* unicode_data_path = nullptr;
  714. char const* special_casing_path = nullptr;
  715. char const* derived_general_category_path = nullptr;
  716. char const* prop_list_path = nullptr;
  717. char const* derived_core_prop_path = nullptr;
  718. char const* derived_binary_prop_path = nullptr;
  719. char const* prop_alias_path = nullptr;
  720. char const* prop_value_alias_path = nullptr;
  721. char const* scripts_path = nullptr;
  722. char const* script_extensions_path = nullptr;
  723. char const* emoji_data_path = nullptr;
  724. Core::ArgsParser args_parser;
  725. args_parser.add_option(generated_header_path, "Path to the Unicode Data header file to generate", "generated-header-path", 'h', "generated-header-path");
  726. args_parser.add_option(generated_implementation_path, "Path to the Unicode Data implementation file to generate", "generated-implementation-path", 'c', "generated-implementation-path");
  727. args_parser.add_option(unicode_data_path, "Path to UnicodeData.txt file", "unicode-data-path", 'u', "unicode-data-path");
  728. args_parser.add_option(special_casing_path, "Path to SpecialCasing.txt file", "special-casing-path", 's', "special-casing-path");
  729. args_parser.add_option(derived_general_category_path, "Path to DerivedGeneralCategory.txt file", "derived-general-category-path", 'g', "derived-general-category-path");
  730. args_parser.add_option(prop_list_path, "Path to PropList.txt file", "prop-list-path", 'p', "prop-list-path");
  731. args_parser.add_option(derived_core_prop_path, "Path to DerivedCoreProperties.txt file", "derived-core-prop-path", 'd', "derived-core-prop-path");
  732. args_parser.add_option(derived_binary_prop_path, "Path to DerivedBinaryProperties.txt file", "derived-binary-prop-path", 'b', "derived-binary-prop-path");
  733. args_parser.add_option(prop_alias_path, "Path to PropertyAliases.txt file", "prop-alias-path", 'a', "prop-alias-path");
  734. args_parser.add_option(prop_value_alias_path, "Path to PropertyValueAliases.txt file", "prop-value-alias-path", 'v', "prop-value-alias-path");
  735. args_parser.add_option(scripts_path, "Path to Scripts.txt file", "scripts-path", 'r', "scripts-path");
  736. args_parser.add_option(script_extensions_path, "Path to ScriptExtensions.txt file", "script-extensions-path", 'x', "script-extensions-path");
  737. args_parser.add_option(emoji_data_path, "Path to emoji-data.txt file", "emoji-data-path", 'e', "emoji-data-path");
  738. args_parser.parse(argc, argv);
  739. auto open_file = [&](StringView path, StringView flags, Core::OpenMode mode = Core::OpenMode::ReadOnly) {
  740. if (path.is_empty()) {
  741. warnln("{} is required", flags);
  742. args_parser.print_usage(stderr, argv[0]);
  743. exit(1);
  744. }
  745. auto file_or_error = Core::File::open(path, mode);
  746. if (file_or_error.is_error()) {
  747. warnln("Failed to open {}: {}", path, file_or_error.release_error());
  748. exit(1);
  749. }
  750. return file_or_error.release_value();
  751. };
  752. auto generated_header_file = open_file(generated_header_path, "-h/--generated-header-path", Core::OpenMode::ReadWrite);
  753. auto generated_implementation_file = open_file(generated_implementation_path, "-c/--generated-implementation-path", Core::OpenMode::ReadWrite);
  754. auto unicode_data_file = open_file(unicode_data_path, "-u/--unicode-data-path");
  755. auto derived_general_category_file = open_file(derived_general_category_path, "-g/--derived-general-category-path");
  756. auto special_casing_file = open_file(special_casing_path, "-s/--special-casing-path");
  757. auto prop_list_file = open_file(prop_list_path, "-p/--prop-list-path");
  758. auto derived_core_prop_file = open_file(derived_core_prop_path, "-d/--derived-core-prop-path");
  759. auto derived_binary_prop_file = open_file(derived_binary_prop_path, "-b/--derived-binary-prop-path");
  760. auto prop_alias_file = open_file(prop_alias_path, "-a/--prop-alias-path");
  761. auto prop_value_alias_file = open_file(prop_value_alias_path, "-v/--prop-value-alias-path");
  762. auto scripts_file = open_file(scripts_path, "-r/--scripts-path");
  763. auto script_extensions_file = open_file(script_extensions_path, "-x/--script-extensions-path");
  764. auto emoji_data_file = open_file(emoji_data_path, "-e/--emoji-data-path");
  765. UnicodeData unicode_data {};
  766. parse_special_casing(special_casing_file, unicode_data);
  767. parse_prop_list(derived_general_category_file, unicode_data.general_categories);
  768. parse_prop_list(prop_list_file, unicode_data.prop_list);
  769. parse_prop_list(derived_core_prop_file, unicode_data.prop_list);
  770. parse_prop_list(derived_binary_prop_file, unicode_data.prop_list);
  771. parse_prop_list(emoji_data_file, unicode_data.prop_list);
  772. parse_alias_list(prop_alias_file, unicode_data.prop_list, unicode_data.prop_aliases);
  773. parse_prop_list(scripts_file, unicode_data.script_list);
  774. parse_prop_list(script_extensions_file, unicode_data.script_extensions, true);
  775. populate_general_category_unions(unicode_data.general_categories);
  776. parse_unicode_data(unicode_data_file, unicode_data);
  777. parse_value_alias_list(prop_value_alias_file, "gc"sv, unicode_data.general_categories.keys(), unicode_data.general_category_aliases);
  778. parse_value_alias_list(prop_value_alias_file, "sc"sv, unicode_data.script_list.keys(), unicode_data.script_aliases, false);
  779. generate_unicode_data_header(generated_header_file, unicode_data);
  780. generate_unicode_data_implementation(generated_implementation_file, unicode_data);
  781. return 0;
  782. }