GenerateUnicodeData.cpp 53 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374757677787980818283848586878889909192939495969798991001011021031041051061071081091101111121131141151161171181191201211221231241251261271281291301311321331341351361371381391401411421431441451461471481491501511521531541551561571581591601611621631641651661671681691701711721731741751761771781791801811821831841851861871881891901911921931941951961971981992002012022032042052062072082092102112122132142152162172182192202212222232242252262272282292302312322332342352362372382392402412422432442452462472482492502512522532542552562572582592602612622632642652662672682692702712722732742752762772782792802812822832842852862872882892902912922932942952962972982993003013023033043053063073083093103113123133143153163173183193203213223233243253263273283293303313323333343353363373383393403413423433443453463473483493503513523533543553563573583593603613623633643653663673683693703713723733743753763773783793803813823833843853863873883893903913923933943953963973983994004014024034044054064074084094104114124134144154164174184194204214224234244254264274284294304314324334344354364374384394404414424434444454464474484494504514524534544554564574584594604614624634644654664674684694704714724734744754764774784794804814824834844854864874884894904914924934944954964974984995005015025035045055065075085095105115125135145155165175185195205215225235245255265275285295305315325335345355365375385395405415425435445455465475485495505515525535545555565575585595605615625635645655665675685695705715725735745755765775785795805815825835845855865875885895905915925935945955965975985996006016026036046056066076086096106116126136146156166176186196206216226236246256266276286296306316326336346356366376386396406416426436446456466476486496506516526536546556566576586596606616626636646656666676686696706716726736746756766776786796806816826836846856866876886896906916926936946956966976986997007017027037047057067077087097107117127137147157167177187197207217227237247257267277287297307317327337347357367377387397407417427437447457467477487497507517527537547557567577587597607617627637647657667677687697707717727737747757767777787797807817827837847857867877887897907917927937947957967977987998008018028038048058068078088098108118128138148158168178188198208218228238248258268278288298308318328338348358368378388398408418428438448458468478488498508518528538548558568578588598608618628638648658668678688698708718728738748758768778788798808818828838848858868878888898908918928938948958968978988999009019029039049059069079089099109119129139149159169179189199209219229239249259269279289299309319329339349359369379389399409419429439449459469479489499509519529539549559569579589599609619629639649659669679689699709719729739749759769779789799809819829839849859869879889899909919929939949959969979989991000100110021003100410051006100710081009101010111012101310141015101610171018101910201021102210231024102510261027102810291030103110321033103410351036103710381039104010411042104310441045104610471048104910501051105210531054105510561057105810591060106110621063106410651066106710681069107010711072107310741075107610771078107910801081108210831084108510861087108810891090109110921093109410951096109710981099110011011102110311041105110611071108110911101111111211131114111511161117111811191120112111221123112411251126112711281129113011311132113311341135113611371138113911401141114211431144114511461147114811491150115111521153115411551156115711581159116011611162116311641165116611671168116911701171117211731174117511761177117811791180118111821183118411851186118711881189119011911192119311941195119611971198119912001201120212031204120512061207120812091210121112121213121412151216121712181219122012211222122312241225122612271228122912301231123212331234123512361237123812391240124112421243124412451246124712481249125012511252125312541255125612571258125912601261126212631264126512661267126812691270127112721273127412751276127712781279128012811282128312841285128612871288128912901291129212931294129512961297129812991300130113021303130413051306130713081309131013111312131313141315131613171318131913201321
  1. /*
  2. * Copyright (c) 2021, Tim Flynn <trflynn89@serenityos.org>
  3. *
  4. * SPDX-License-Identifier: BSD-2-Clause
  5. */
  6. #include "GeneratorUtil.h"
  7. #include <AK/AllOf.h>
  8. #include <AK/Array.h>
  9. #include <AK/CharacterTypes.h>
  10. #include <AK/Find.h>
  11. #include <AK/HashMap.h>
  12. #include <AK/Optional.h>
  13. #include <AK/QuickSort.h>
  14. #include <AK/SourceGenerator.h>
  15. #include <AK/String.h>
  16. #include <AK/StringUtils.h>
  17. #include <AK/Types.h>
  18. #include <AK/Vector.h>
  19. #include <LibCore/ArgsParser.h>
  20. #include <LibCore/Stream.h>
  21. // Some code points are excluded from UnicodeData.txt, and instead are part of a "range" of code
  22. // points, as indicated by the "name" field. For example:
  23. // 3400;<CJK Ideograph Extension A, First>;Lo;0;L;;;;;N;;;;;
  24. // 4DBF;<CJK Ideograph Extension A, Last>;Lo;0;L;;;;;N;;;;;
  25. struct CodePointRange {
  26. u32 first;
  27. u32 last;
  28. };
  29. // SpecialCasing source: https://www.unicode.org/Public/13.0.0/ucd/SpecialCasing.txt
  30. // Field descriptions: https://www.unicode.org/reports/tr44/tr44-13.html#SpecialCasing.txt
  31. struct SpecialCasing {
  32. u32 index { 0 };
  33. u32 code_point { 0 };
  34. Vector<u32> lowercase_mapping;
  35. Vector<u32> uppercase_mapping;
  36. Vector<u32> titlecase_mapping;
  37. String locale;
  38. String condition;
  39. };
  40. // PropList source: https://www.unicode.org/Public/13.0.0/ucd/PropList.txt
  41. // Property descriptions: https://www.unicode.org/reports/tr44/tr44-13.html#PropList.txt
  42. using PropList = HashMap<String, Vector<CodePointRange>>;
  43. // Normalization source: https://www.unicode.org/Public/13.0.0/ucd/DerivedNormalizationProps.txt
  44. // Normalization descriptions: https://www.unicode.org/reports/tr44/#DerivedNormalizationProps.txt
  45. enum class QuickCheck {
  46. Yes,
  47. No,
  48. Maybe,
  49. };
  50. struct Normalization {
  51. CodePointRange code_point_range;
  52. Vector<u32> value;
  53. QuickCheck quick_check { QuickCheck::Yes };
  54. };
  55. using NormalizationProps = HashMap<String, Vector<Normalization>>;
  56. struct CodePointName {
  57. CodePointRange code_point_range;
  58. StringView name;
  59. };
  60. // UnicodeData source: https://www.unicode.org/Public/13.0.0/ucd/UnicodeData.txt
  61. // Field descriptions: https://www.unicode.org/reports/tr44/tr44-13.html#UnicodeData.txt
  62. // https://www.unicode.org/reports/tr44/#General_Category_Values
  63. struct CodePointData {
  64. u32 code_point { 0 };
  65. String name;
  66. Optional<StringView> abbreviation;
  67. u8 canonical_combining_class { 0 };
  68. String bidi_class;
  69. String decomposition_type;
  70. Optional<i8> numeric_value_decimal;
  71. Optional<i8> numeric_value_digit;
  72. Optional<i8> numeric_value_numeric;
  73. bool bidi_mirrored { false };
  74. String unicode_1_name;
  75. String iso_comment;
  76. Optional<u32> simple_uppercase_mapping;
  77. Optional<u32> simple_lowercase_mapping;
  78. Optional<u32> simple_titlecase_mapping;
  79. Vector<u32> special_casing_indices;
  80. };
  81. struct BlockName {
  82. CodePointRange code_point_range;
  83. String name;
  84. };
  85. struct UnicodeData {
  86. u32 code_points_with_non_zero_combining_class { 0 };
  87. u32 simple_uppercase_mapping_size { 0 };
  88. u32 simple_lowercase_mapping_size { 0 };
  89. Vector<SpecialCasing> special_casing;
  90. u32 code_points_with_special_casing { 0 };
  91. u32 largest_casing_transform_size { 0 };
  92. u32 largest_special_casing_size { 0 };
  93. Vector<String> conditions;
  94. Vector<CodePointData> code_point_data;
  95. HashMap<u32, String> code_point_abbreviations;
  96. HashMap<u32, String> code_point_display_name_aliases;
  97. Vector<CodePointName> code_point_display_names;
  98. PropList general_categories;
  99. Vector<Alias> general_category_aliases;
  100. // The Unicode standard defines additional properties (Any, Assigned, ASCII) which are not in
  101. // any UCD file. Assigned code point ranges are derived as this generator is executed.
  102. // https://unicode.org/reports/tr18/#General_Category_Property
  103. PropList prop_list {
  104. { "Any"sv, { { 0, 0x10ffff } } },
  105. { "Assigned"sv, {} },
  106. { "ASCII"sv, { { 0, 0x7f } } },
  107. };
  108. Vector<Alias> prop_aliases;
  109. PropList script_list {
  110. { "Unknown"sv, {} },
  111. };
  112. Vector<Alias> script_aliases;
  113. PropList script_extensions;
  114. PropList block_list {
  115. { "No_Block"sv, {} },
  116. };
  117. Vector<Alias> block_aliases;
  118. Vector<BlockName> block_display_names;
  119. // FIXME: We are not yet doing anything with this data. It will be needed for String.prototype.normalize.
  120. NormalizationProps normalization_props;
  121. PropList grapheme_break_props;
  122. PropList word_break_props;
  123. PropList sentence_break_props;
  124. };
  125. static String sanitize_entry(String const& entry)
  126. {
  127. auto sanitized = entry.replace("-", "_", ReplaceMode::All);
  128. sanitized = sanitized.replace(" ", "_", ReplaceMode::All);
  129. StringBuilder builder;
  130. bool next_is_upper = true;
  131. for (auto ch : sanitized) {
  132. if (next_is_upper)
  133. builder.append_code_point(to_ascii_uppercase(ch));
  134. else
  135. builder.append_code_point(ch);
  136. next_is_upper = ch == '_';
  137. }
  138. return builder.to_string();
  139. }
  140. static Vector<u32> parse_code_point_list(StringView list)
  141. {
  142. Vector<u32> code_points;
  143. auto segments = list.split_view(' ');
  144. for (auto const& code_point : segments)
  145. code_points.append(AK::StringUtils::convert_to_uint_from_hex<u32>(code_point).value());
  146. return code_points;
  147. }
  148. static CodePointRange parse_code_point_range(StringView list)
  149. {
  150. CodePointRange code_point_range {};
  151. if (list.contains(".."sv)) {
  152. auto segments = list.split_view(".."sv);
  153. VERIFY(segments.size() == 2);
  154. auto begin = AK::StringUtils::convert_to_uint_from_hex<u32>(segments[0]).value();
  155. auto end = AK::StringUtils::convert_to_uint_from_hex<u32>(segments[1]).value();
  156. code_point_range = { begin, end };
  157. } else {
  158. auto code_point = AK::StringUtils::convert_to_uint_from_hex<u32>(list).value();
  159. code_point_range = { code_point, code_point };
  160. }
  161. return code_point_range;
  162. }
  163. static ErrorOr<void> parse_special_casing(Core::Stream::BufferedFile& file, UnicodeData& unicode_data)
  164. {
  165. Array<u8, 1024> buffer;
  166. while (TRY(file.can_read_line())) {
  167. auto line = TRY(file.read_line(buffer));
  168. if (line.is_empty() || line.starts_with('#'))
  169. continue;
  170. if (auto index = line.find('#'); index.has_value())
  171. line = line.substring_view(0, *index);
  172. auto segments = line.split_view(';', true);
  173. VERIFY(segments.size() == 5 || segments.size() == 6);
  174. SpecialCasing casing {};
  175. casing.code_point = AK::StringUtils::convert_to_uint_from_hex<u32>(segments[0]).value();
  176. casing.lowercase_mapping = parse_code_point_list(segments[1]);
  177. casing.titlecase_mapping = parse_code_point_list(segments[2]);
  178. casing.uppercase_mapping = parse_code_point_list(segments[3]);
  179. if (auto condition = segments[4].trim_whitespace(); !condition.is_empty()) {
  180. auto conditions = condition.split_view(' ', true);
  181. VERIFY(conditions.size() == 1 || conditions.size() == 2);
  182. if (conditions.size() == 2) {
  183. casing.locale = conditions[0];
  184. casing.condition = conditions[1];
  185. } else if (all_of(conditions[0], is_ascii_lower_alpha)) {
  186. casing.locale = conditions[0];
  187. } else {
  188. casing.condition = conditions[0];
  189. }
  190. if (!casing.locale.is_empty())
  191. casing.locale = String::formatted("{:c}{}", to_ascii_uppercase(casing.locale[0]), casing.locale.substring_view(1));
  192. casing.condition = casing.condition.replace("_", "", ReplaceMode::All);
  193. if (!casing.condition.is_empty() && !unicode_data.conditions.contains_slow(casing.condition))
  194. unicode_data.conditions.append(casing.condition);
  195. }
  196. unicode_data.largest_casing_transform_size = max(unicode_data.largest_casing_transform_size, casing.lowercase_mapping.size());
  197. unicode_data.largest_casing_transform_size = max(unicode_data.largest_casing_transform_size, casing.titlecase_mapping.size());
  198. unicode_data.largest_casing_transform_size = max(unicode_data.largest_casing_transform_size, casing.uppercase_mapping.size());
  199. unicode_data.special_casing.append(move(casing));
  200. }
  201. quick_sort(unicode_data.special_casing, [](auto const& lhs, auto const& rhs) {
  202. if (lhs.code_point != rhs.code_point)
  203. return lhs.code_point < rhs.code_point;
  204. if (lhs.locale.is_empty() && !rhs.locale.is_empty())
  205. return false;
  206. if (!lhs.locale.is_empty() && rhs.locale.is_empty())
  207. return true;
  208. return lhs.locale < rhs.locale;
  209. });
  210. for (u32 i = 0; i < unicode_data.special_casing.size(); ++i)
  211. unicode_data.special_casing[i].index = i;
  212. return {};
  213. }
  214. static ErrorOr<void> parse_prop_list(Core::Stream::BufferedFile& file, PropList& prop_list, bool multi_value_property = false, bool sanitize_property = false)
  215. {
  216. Array<u8, 1024> buffer;
  217. while (TRY(file.can_read_line())) {
  218. auto line = TRY(file.read_line(buffer));
  219. if (line.is_empty() || line.starts_with('#'))
  220. continue;
  221. if (auto index = line.find('#'); index.has_value())
  222. line = line.substring_view(0, *index);
  223. auto segments = line.split_view(';', true);
  224. VERIFY(segments.size() == 2);
  225. auto code_point_range = parse_code_point_range(segments[0].trim_whitespace());
  226. Vector<StringView> properties;
  227. if (multi_value_property)
  228. properties = segments[1].trim_whitespace().split_view(' ');
  229. else
  230. properties = { segments[1].trim_whitespace() };
  231. for (auto& property : properties) {
  232. auto& code_points = prop_list.ensure(sanitize_property ? sanitize_entry(property).trim_whitespace().view() : property.trim_whitespace());
  233. code_points.append(code_point_range);
  234. }
  235. }
  236. return {};
  237. }
  238. static ErrorOr<void> parse_alias_list(Core::Stream::BufferedFile& file, PropList const& prop_list, Vector<Alias>& prop_aliases)
  239. {
  240. String current_property;
  241. Array<u8, 1024> buffer;
  242. auto append_alias = [&](auto alias, auto property) {
  243. // Note: The alias files contain lines such as "Hyphen = Hyphen", which we should just skip.
  244. if (alias == property)
  245. return;
  246. // FIXME: We will, eventually, need to find where missing properties are located and parse them.
  247. if (!prop_list.contains(property))
  248. return;
  249. prop_aliases.append({ property, alias });
  250. };
  251. while (TRY(file.can_read_line())) {
  252. auto line = TRY(file.read_line(buffer));
  253. if (line.is_empty() || line.starts_with('#')) {
  254. if (line.ends_with("Properties"sv))
  255. current_property = line.substring_view(2);
  256. continue;
  257. }
  258. // Note: For now, we only care about Binary Property aliases for Unicode property escapes.
  259. if (current_property != "Binary Properties"sv)
  260. continue;
  261. auto segments = line.split_view(';', true);
  262. VERIFY((segments.size() == 2) || (segments.size() == 3));
  263. auto alias = segments[0].trim_whitespace();
  264. auto property = segments[1].trim_whitespace();
  265. append_alias(alias, property);
  266. if (segments.size() == 3) {
  267. alias = segments[2].trim_whitespace();
  268. append_alias(alias, property);
  269. }
  270. }
  271. return {};
  272. }
  273. static ErrorOr<void> parse_name_aliases(Core::Stream::BufferedFile& file, UnicodeData& unicode_data)
  274. {
  275. Array<u8, 1024> buffer;
  276. while (TRY(file.can_read_line())) {
  277. auto line = TRY(file.read_line(buffer));
  278. if (line.is_empty() || line.starts_with('#'))
  279. continue;
  280. auto segments = line.split_view(';', true);
  281. VERIFY(segments.size() == 3);
  282. auto code_point = AK::StringUtils::convert_to_uint_from_hex<u32>(segments[0].trim_whitespace());
  283. auto alias = segments[1].trim_whitespace();
  284. auto reason = segments[2].trim_whitespace();
  285. if (reason == "abbreviation"sv) {
  286. unicode_data.code_point_abbreviations.set(*code_point, alias);
  287. } else if (reason.is_one_of("correction"sv, "control"sv)) {
  288. if (!unicode_data.code_point_display_name_aliases.contains(*code_point))
  289. unicode_data.code_point_display_name_aliases.set(*code_point, alias);
  290. }
  291. }
  292. return {};
  293. }
  294. static ErrorOr<void> parse_value_alias_list(Core::Stream::BufferedFile& file, StringView desired_category, Vector<String> const& value_list, Vector<Alias>& prop_aliases, bool primary_value_is_first = true, bool sanitize_alias = false)
  295. {
  296. TRY(file.seek(0, Core::Stream::SeekMode::SetPosition));
  297. Array<u8, 1024> buffer;
  298. auto append_alias = [&](auto alias, auto value) {
  299. // Note: The value alias file contains lines such as "Ahom = Ahom", which we should just skip.
  300. if (alias == value)
  301. return;
  302. // FIXME: We will, eventually, need to find where missing properties are located and parse them.
  303. if (!value_list.contains_slow(value))
  304. return;
  305. prop_aliases.append({ value, alias });
  306. };
  307. while (TRY(file.can_read_line())) {
  308. auto line = TRY(file.read_line(buffer));
  309. if (line.is_empty() || line.starts_with('#'))
  310. continue;
  311. if (auto index = line.find('#'); index.has_value())
  312. line = line.substring_view(0, *index);
  313. auto segments = line.split_view(';', true);
  314. auto category = segments[0].trim_whitespace();
  315. if (category != desired_category)
  316. continue;
  317. VERIFY((segments.size() == 3) || (segments.size() == 4));
  318. auto value = primary_value_is_first ? segments[1].trim_whitespace() : segments[2].trim_whitespace();
  319. auto alias = primary_value_is_first ? segments[2].trim_whitespace() : segments[1].trim_whitespace();
  320. append_alias(sanitize_alias ? sanitize_entry(alias).view() : alias, value);
  321. if (segments.size() == 4) {
  322. alias = segments[3].trim_whitespace();
  323. append_alias(sanitize_alias ? sanitize_entry(alias).view() : alias, value);
  324. }
  325. }
  326. return {};
  327. }
  328. static ErrorOr<void> parse_normalization_props(Core::Stream::BufferedFile& file, UnicodeData& unicode_data)
  329. {
  330. Array<u8, 1024> buffer;
  331. while (TRY(file.can_read_line())) {
  332. auto line = TRY(file.read_line(buffer));
  333. if (line.is_empty() || line.starts_with('#'))
  334. continue;
  335. if (auto index = line.find('#'); index.has_value())
  336. line = line.substring_view(0, *index);
  337. auto segments = line.split_view(';', true);
  338. VERIFY((segments.size() == 2) || (segments.size() == 3));
  339. auto code_point_range = parse_code_point_range(segments[0].trim_whitespace());
  340. auto property = segments[1].trim_whitespace().to_string();
  341. Vector<u32> value;
  342. QuickCheck quick_check = QuickCheck::Yes;
  343. if (segments.size() == 3) {
  344. auto value_or_quick_check = segments[2].trim_whitespace();
  345. if ((value_or_quick_check == "N"sv))
  346. quick_check = QuickCheck::No;
  347. else if ((value_or_quick_check == "M"sv))
  348. quick_check = QuickCheck::Maybe;
  349. else
  350. value = parse_code_point_list(value_or_quick_check);
  351. }
  352. auto& normalizations = unicode_data.normalization_props.ensure(property);
  353. normalizations.append({ code_point_range, move(value), quick_check });
  354. auto& prop_list = unicode_data.prop_list.ensure(property);
  355. prop_list.append(move(code_point_range));
  356. }
  357. return {};
  358. }
  359. static void add_canonical_code_point_name(CodePointRange range, StringView name, UnicodeData& unicode_data)
  360. {
  361. // https://www.unicode.org/versions/Unicode14.0.0/ch04.pdf#G142981
  362. // FIXME: Implement the NR1 rules for Hangul syllables.
  363. // These code point ranges are the NR2 set of name replacements defined by Table 4-8.
  364. constexpr Array<CodePointName, 15> s_ideographic_replacements { {
  365. { { 0x3400, 0x4DBF }, "CJK UNIFIED IDEOGRAPH-{:X}"sv },
  366. { { 0x4E00, 0x9FFC }, "CJK UNIFIED IDEOGRAPH-{:X}"sv },
  367. { { 0xF900, 0xFA6D }, "CJK COMPATIBILITY IDEOGRAPH-{:X}"sv },
  368. { { 0xFA70, 0xFAD9 }, "CJK COMPATIBILITY IDEOGRAPH-{:X}"sv },
  369. { { 0x17000, 0x187F7 }, "TANGUT IDEOGRAPH-{:X}"sv },
  370. { { 0x18B00, 0x18CD5 }, "KHITAN SMALL SCRIPT CHARACTER-{:X}"sv },
  371. { { 0x18D00, 0x18D08 }, "TANGUT IDEOGRAPH-{:X}"sv },
  372. { { 0x1B170, 0x1B2FB }, "NUSHU CHARACTER-{:X}"sv },
  373. { { 0x20000, 0x2A6DD }, "CJK UNIFIED IDEOGRAPH-{:X}"sv },
  374. { { 0x2A700, 0x2B734 }, "CJK UNIFIED IDEOGRAPH-{:X}"sv },
  375. { { 0x2B740, 0x2B81D }, "CJK UNIFIED IDEOGRAPH-{:X}"sv },
  376. { { 0x2B820, 0x2CEA1 }, "CJK UNIFIED IDEOGRAPH-{:X}"sv },
  377. { { 0x2CEB0, 0x2EBE0 }, "CJK UNIFIED IDEOGRAPH-{:X}"sv },
  378. { { 0x2F800, 0x2FA1D }, "CJK COMPATIBILITY IDEOGRAPH-{:X}"sv },
  379. { { 0x30000, 0x3134A }, "CJK UNIFIED IDEOGRAPH-{:X}"sv },
  380. } };
  381. auto it = find_if(s_ideographic_replacements.begin(), s_ideographic_replacements.end(),
  382. [&](auto const& replacement) {
  383. return replacement.code_point_range.first == range.first;
  384. });
  385. if (it != s_ideographic_replacements.end()) {
  386. unicode_data.code_point_display_names.append(*it);
  387. return;
  388. }
  389. it = find_if(s_ideographic_replacements.begin(), s_ideographic_replacements.end(),
  390. [&](auto const& replacement) {
  391. return (replacement.code_point_range.first <= range.first) && (range.first <= replacement.code_point_range.last);
  392. });
  393. if (it != s_ideographic_replacements.end()) {
  394. // Drop code points that will have been captured by a range defined by the ideographic replacements.
  395. return;
  396. }
  397. if (auto alias = unicode_data.code_point_display_name_aliases.get(range.first); alias.has_value()) {
  398. // NR4 states that control code points have a null string as their name. Our implementation
  399. // uses the control code's alias as its display name.
  400. unicode_data.code_point_display_names.append({ range, *alias });
  401. return;
  402. }
  403. unicode_data.code_point_display_names.append({ range, name });
  404. }
  405. static ErrorOr<void> parse_block_display_names(Core::Stream::BufferedFile& file, UnicodeData& unicode_data)
  406. {
  407. Array<u8, 1024> buffer;
  408. while (TRY(file.can_read_line())) {
  409. auto line = TRY(file.read_line(buffer));
  410. if (line.is_empty() || line.starts_with('#'))
  411. continue;
  412. auto segments = line.split_view(';', true);
  413. VERIFY(segments.size() == 2);
  414. auto code_point_range = parse_code_point_range(segments[0].trim_whitespace());
  415. auto display_name = segments[1].trim_whitespace();
  416. unicode_data.block_display_names.append({ code_point_range, display_name });
  417. }
  418. TRY(file.seek(0, Core::Stream::SeekMode::SetPosition));
  419. return {};
  420. }
  421. static ErrorOr<void> parse_unicode_data(Core::Stream::BufferedFile& file, UnicodeData& unicode_data)
  422. {
  423. Optional<u32> code_point_range_start;
  424. auto& assigned_code_points = unicode_data.prop_list.find("Assigned"sv)->value;
  425. Optional<u32> assigned_code_point_range_start = 0;
  426. u32 previous_code_point = 0;
  427. Array<u8, 1024> buffer;
  428. while (TRY(file.can_read_line())) {
  429. auto line = TRY(file.read_line(buffer));
  430. if (line.is_empty())
  431. continue;
  432. auto segments = line.split_view(';', true);
  433. VERIFY(segments.size() == 15);
  434. CodePointData data {};
  435. data.code_point = AK::StringUtils::convert_to_uint_from_hex<u32>(segments[0]).value();
  436. data.name = segments[1];
  437. data.canonical_combining_class = AK::StringUtils::convert_to_uint<u8>(segments[3]).value();
  438. data.bidi_class = segments[4];
  439. data.decomposition_type = segments[5];
  440. data.numeric_value_decimal = AK::StringUtils::convert_to_int<i8>(segments[6]);
  441. data.numeric_value_digit = AK::StringUtils::convert_to_int<i8>(segments[7]);
  442. data.numeric_value_numeric = AK::StringUtils::convert_to_int<i8>(segments[8]);
  443. data.bidi_mirrored = segments[9] == "Y"sv;
  444. data.unicode_1_name = segments[10];
  445. data.iso_comment = segments[11];
  446. data.simple_uppercase_mapping = AK::StringUtils::convert_to_uint_from_hex<u32>(segments[12]);
  447. data.simple_lowercase_mapping = AK::StringUtils::convert_to_uint_from_hex<u32>(segments[13]);
  448. data.simple_titlecase_mapping = AK::StringUtils::convert_to_uint_from_hex<u32>(segments[14]);
  449. if (auto abbreviation = unicode_data.code_point_abbreviations.get(data.code_point); abbreviation.has_value())
  450. data.abbreviation = *abbreviation;
  451. if (!assigned_code_point_range_start.has_value())
  452. assigned_code_point_range_start = data.code_point;
  453. if (data.name.starts_with("<"sv) && data.name.ends_with(", First>")) {
  454. VERIFY(!code_point_range_start.has_value() && assigned_code_point_range_start.has_value());
  455. code_point_range_start = data.code_point;
  456. data.name = data.name.substring(1, data.name.length() - 9);
  457. assigned_code_points.append({ *assigned_code_point_range_start, previous_code_point });
  458. assigned_code_point_range_start.clear();
  459. } else if (data.name.starts_with("<"sv) && data.name.ends_with(", Last>")) {
  460. VERIFY(code_point_range_start.has_value());
  461. CodePointRange code_point_range { *code_point_range_start, data.code_point };
  462. assigned_code_points.append(code_point_range);
  463. data.name = data.name.substring(1, data.name.length() - 8);
  464. code_point_range_start.clear();
  465. add_canonical_code_point_name(code_point_range, data.name, unicode_data);
  466. } else {
  467. add_canonical_code_point_name({ data.code_point, data.code_point }, data.name, unicode_data);
  468. if ((data.code_point > 0) && (data.code_point - previous_code_point) != 1) {
  469. VERIFY(assigned_code_point_range_start.has_value());
  470. assigned_code_points.append({ *assigned_code_point_range_start, previous_code_point });
  471. assigned_code_point_range_start = data.code_point;
  472. }
  473. }
  474. bool has_special_casing { false };
  475. for (auto const& casing : unicode_data.special_casing) {
  476. if (casing.code_point == data.code_point) {
  477. data.special_casing_indices.append(casing.index);
  478. has_special_casing = true;
  479. }
  480. }
  481. unicode_data.code_points_with_non_zero_combining_class += data.canonical_combining_class != 0;
  482. unicode_data.simple_uppercase_mapping_size += data.simple_uppercase_mapping.has_value();
  483. unicode_data.simple_lowercase_mapping_size += data.simple_lowercase_mapping.has_value();
  484. unicode_data.code_points_with_special_casing += has_special_casing;
  485. unicode_data.largest_special_casing_size = max(unicode_data.largest_special_casing_size, data.special_casing_indices.size());
  486. previous_code_point = data.code_point;
  487. unicode_data.code_point_data.append(move(data));
  488. }
  489. return {};
  490. }
  491. static ErrorOr<void> generate_unicode_data_header(Core::Stream::BufferedFile& file, UnicodeData& unicode_data)
  492. {
  493. StringBuilder builder;
  494. SourceGenerator generator { builder };
  495. generator.set("casing_transform_size", String::number(unicode_data.largest_casing_transform_size));
  496. auto generate_enum = [&](StringView name, StringView default_, Vector<String> values, Vector<Alias> aliases = {}) {
  497. quick_sort(values);
  498. quick_sort(aliases, [](auto& alias1, auto& alias2) { return alias1.alias < alias2.alias; });
  499. generator.set("name", name);
  500. generator.set("underlying", String::formatted("{}UnderlyingType", name));
  501. generator.set("type", ((values.size() + !default_.is_empty()) < 256) ? "u8"sv : "u16"sv);
  502. generator.append(R"~~~(
  503. using @underlying@ = @type@;
  504. enum class @name@ : @underlying@ {)~~~");
  505. if (!default_.is_empty()) {
  506. generator.set("default", default_);
  507. generator.append(R"~~~(
  508. @default@,)~~~");
  509. }
  510. for (auto const& value : values) {
  511. generator.set("value", value);
  512. generator.append(R"~~~(
  513. @value@,)~~~");
  514. }
  515. for (auto const& alias : aliases) {
  516. generator.set("alias", alias.alias);
  517. generator.set("value", alias.name);
  518. generator.append(R"~~~(
  519. @alias@ = @value@,)~~~");
  520. }
  521. generator.append(R"~~~(
  522. };
  523. )~~~");
  524. };
  525. generator.append(R"~~~(
  526. #pragma once
  527. #include <AK/Types.h>
  528. #include <LibUnicode/Forward.h>
  529. #include <LibUnicode/UnicodeLocale.h>
  530. namespace Unicode {
  531. )~~~");
  532. generate_enum("Condition"sv, "None"sv, move(unicode_data.conditions));
  533. generate_enum("GeneralCategory"sv, {}, unicode_data.general_categories.keys(), unicode_data.general_category_aliases);
  534. generate_enum("Property"sv, {}, unicode_data.prop_list.keys(), unicode_data.prop_aliases);
  535. generate_enum("Script"sv, {}, unicode_data.script_list.keys(), unicode_data.script_aliases);
  536. generate_enum("Block"sv, {}, unicode_data.block_list.keys(), unicode_data.block_aliases);
  537. generate_enum("GraphemeBreakProperty"sv, {}, unicode_data.grapheme_break_props.keys());
  538. generate_enum("WordBreakProperty"sv, {}, unicode_data.word_break_props.keys());
  539. generate_enum("SentenceBreakProperty"sv, {}, unicode_data.sentence_break_props.keys());
  540. generator.append(R"~~~(
  541. struct SpecialCasing {
  542. u32 code_point { 0 };
  543. u32 lowercase_mapping[@casing_transform_size@];
  544. u32 lowercase_mapping_size { 0 };
  545. u32 uppercase_mapping[@casing_transform_size@];
  546. u32 uppercase_mapping_size { 0 };
  547. u32 titlecase_mapping[@casing_transform_size@];
  548. u32 titlecase_mapping_size { 0 };
  549. Locale locale { Locale::None };
  550. Condition condition { Condition::None };
  551. };
  552. }
  553. )~~~");
  554. TRY(file.write(generator.as_string_view().bytes()));
  555. return {};
  556. }
  557. static ErrorOr<void> generate_unicode_data_implementation(Core::Stream::BufferedFile& file, UnicodeData const& unicode_data)
  558. {
  559. StringBuilder builder;
  560. SourceGenerator generator { builder };
  561. generator.set("largest_special_casing_size", String::number(unicode_data.largest_special_casing_size));
  562. generator.set("special_casing_size", String::number(unicode_data.special_casing.size()));
  563. generator.append(R"~~~(
  564. #include <AK/Array.h>
  565. #include <AK/BinarySearch.h>
  566. #include <AK/CharacterTypes.h>
  567. #include <AK/Optional.h>
  568. #include <AK/Span.h>
  569. #include <AK/String.h>
  570. #include <AK/StringView.h>
  571. #include <LibUnicode/CharacterTypes.h>
  572. #include <LibUnicode/UnicodeData.h>
  573. namespace Unicode {
  574. )~~~");
  575. auto append_list_and_size = [&](auto const& list, StringView format) {
  576. if (list.is_empty()) {
  577. generator.append(", {}, 0");
  578. return;
  579. }
  580. bool first = true;
  581. generator.append(", {");
  582. for (auto const& item : list) {
  583. generator.append(first ? " " : ", ");
  584. generator.append(String::formatted(format, item));
  585. first = false;
  586. }
  587. generator.append(String::formatted(" }}, {}", list.size()));
  588. };
  589. generator.append(R"~~~(
  590. static constexpr Array<SpecialCasing, @special_casing_size@> s_special_casing { {)~~~");
  591. for (auto const& casing : unicode_data.special_casing) {
  592. generator.set("code_point", String::formatted("{:#x}", casing.code_point));
  593. generator.append(R"~~~(
  594. { @code_point@)~~~");
  595. constexpr auto format = "0x{:x}"sv;
  596. append_list_and_size(casing.lowercase_mapping, format);
  597. append_list_and_size(casing.uppercase_mapping, format);
  598. append_list_and_size(casing.titlecase_mapping, format);
  599. generator.set("locale", casing.locale.is_empty() ? "None" : casing.locale);
  600. generator.append(", Locale::@locale@");
  601. generator.set("condition", casing.condition.is_empty() ? "None" : casing.condition);
  602. generator.append(", Condition::@condition@");
  603. generator.append(" },");
  604. }
  605. generator.append(R"~~~(
  606. } };
  607. struct CodePointMapping {
  608. u32 code_point { 0 };
  609. u32 mapping { 0 };
  610. };
  611. struct SpecialCaseMapping {
  612. u32 code_point { 0 };
  613. Array<SpecialCasing const*, @largest_special_casing_size@> special_casing {};
  614. u32 special_casing_size { 0 };
  615. };
  616. struct CodePointAbbreviation {
  617. u32 code_point { 0 };
  618. StringView abbreviation {};
  619. };
  620. template<typename MappingType>
  621. struct CodePointComparator {
  622. constexpr int operator()(u32 code_point, MappingType const& mapping)
  623. {
  624. return code_point - mapping.code_point;
  625. }
  626. };
  627. )~~~");
  628. auto append_code_point_mappings = [&](StringView name, StringView mapping_type, u32 size, auto mapping_getter) {
  629. generator.set("name", name);
  630. generator.set("mapping_type", mapping_type);
  631. generator.set("size", String::number(size));
  632. generator.append(R"~~~(
  633. static constexpr Array<@mapping_type@, @size@> s_@name@_mappings { {
  634. )~~~");
  635. constexpr size_t max_mappings_per_row = 20;
  636. size_t mappings_in_current_row = 0;
  637. for (auto const& data : unicode_data.code_point_data) {
  638. auto mapping = mapping_getter(data);
  639. if constexpr (requires { mapping.has_value(); }) {
  640. if (!mapping.has_value())
  641. continue;
  642. } else {
  643. if (mapping.is_empty())
  644. continue;
  645. }
  646. if (mappings_in_current_row++ > 0)
  647. generator.append(" ");
  648. generator.set("code_point", String::formatted("{:#x}", data.code_point));
  649. generator.append("{ @code_point@");
  650. if constexpr (IsSame<decltype(mapping), Optional<u32>>) {
  651. generator.set("mapping", String::formatted("{:#x}", *mapping));
  652. generator.append(", @mapping@ },");
  653. } else if constexpr (IsSame<decltype(mapping), Optional<StringView>>) {
  654. generator.set("mapping", String::formatted("{}", *mapping));
  655. generator.append(", \"@mapping@\"sv },");
  656. } else {
  657. append_list_and_size(data.special_casing_indices, "&s_special_casing[{}]"sv);
  658. generator.append(" },");
  659. }
  660. if (mappings_in_current_row == max_mappings_per_row) {
  661. mappings_in_current_row = 0;
  662. generator.append("\n ");
  663. }
  664. }
  665. generator.append(R"~~~(
  666. } };
  667. )~~~");
  668. };
  669. append_code_point_mappings("combining_class"sv, "CodePointMapping"sv, unicode_data.code_points_with_non_zero_combining_class,
  670. [](auto const& data) -> Optional<u32> {
  671. if (data.canonical_combining_class == 0)
  672. return {};
  673. return data.canonical_combining_class;
  674. });
  675. append_code_point_mappings("uppercase"sv, "CodePointMapping"sv, unicode_data.simple_uppercase_mapping_size, [](auto const& data) { return data.simple_uppercase_mapping; });
  676. append_code_point_mappings("lowercase"sv, "CodePointMapping"sv, unicode_data.simple_lowercase_mapping_size, [](auto const& data) { return data.simple_lowercase_mapping; });
  677. append_code_point_mappings("special_case"sv, "SpecialCaseMapping"sv, unicode_data.code_points_with_special_casing, [](auto const& data) { return data.special_casing_indices; });
  678. append_code_point_mappings("abbreviation"sv, "CodePointAbbreviation"sv, unicode_data.code_point_abbreviations.size(), [](auto const& data) { return data.abbreviation; });
  679. generator.append(R"~~~(
  680. struct CodePointRangeComparator {
  681. constexpr int operator()(u32 code_point, CodePointRange const& range)
  682. {
  683. return (code_point > range.last) - (code_point < range.first);
  684. }
  685. };
  686. )~~~");
  687. auto append_code_point_range_list = [&](String name, Vector<CodePointRange> const& ranges) {
  688. generator.set("name", name);
  689. generator.set("size", String::number(ranges.size()));
  690. generator.append(R"~~~(
  691. static constexpr Array<CodePointRange, @size@> @name@ { {
  692. )~~~");
  693. constexpr size_t max_ranges_per_row = 20;
  694. size_t ranges_in_current_row = 0;
  695. for (auto const& range : ranges) {
  696. if (ranges_in_current_row++ > 0)
  697. generator.append(" ");
  698. generator.set("first", String::formatted("{:#x}", range.first));
  699. generator.set("last", String::formatted("{:#x}", range.last));
  700. generator.append("{ @first@, @last@ },");
  701. if (ranges_in_current_row == max_ranges_per_row) {
  702. ranges_in_current_row = 0;
  703. generator.append("\n ");
  704. }
  705. }
  706. generator.append(R"~~~(
  707. } };
  708. )~~~");
  709. };
  710. auto append_prop_list = [&](StringView collection_name, StringView property_format, PropList const& property_list) {
  711. for (auto const& property : property_list) {
  712. auto name = String::formatted(property_format, property.key);
  713. append_code_point_range_list(move(name), property.value);
  714. }
  715. auto property_names = property_list.keys();
  716. quick_sort(property_names);
  717. generator.set("name", collection_name);
  718. generator.set("size", String::number(property_names.size()));
  719. generator.append(R"~~~(
  720. static constexpr Array<Span<CodePointRange const>, @size@> @name@ { {)~~~");
  721. for (auto const& property_name : property_names) {
  722. generator.set("name", String::formatted(property_format, property_name));
  723. generator.append(R"~~~(
  724. @name@.span(),)~~~");
  725. }
  726. generator.append(R"~~~(
  727. } };
  728. )~~~");
  729. };
  730. append_prop_list("s_general_categories"sv, "s_general_category_{}"sv, unicode_data.general_categories);
  731. append_prop_list("s_properties"sv, "s_property_{}"sv, unicode_data.prop_list);
  732. append_prop_list("s_scripts"sv, "s_script_{}"sv, unicode_data.script_list);
  733. append_prop_list("s_script_extensions"sv, "s_script_extension_{}"sv, unicode_data.script_extensions);
  734. append_prop_list("s_blocks"sv, "s_block_{}"sv, unicode_data.block_list);
  735. append_prop_list("s_grapheme_break_properties"sv, "s_grapheme_break_property_{}"sv, unicode_data.grapheme_break_props);
  736. append_prop_list("s_word_break_properties"sv, "s_word_break_property_{}"sv, unicode_data.word_break_props);
  737. append_prop_list("s_sentence_break_properties"sv, "s_sentence_break_property_{}"sv, unicode_data.sentence_break_props);
  738. generator.append(R"~~~(
  739. struct BlockNameComparator : public CodePointRangeComparator {
  740. constexpr int operator()(u32 code_point, BlockName const& name)
  741. {
  742. return CodePointRangeComparator::operator()(code_point, name.code_point_range);
  743. }
  744. };
  745. )~~~");
  746. generator.set("block_display_names_size", String::number(unicode_data.block_display_names.size()));
  747. generator.append(R"~~~(
  748. static constexpr Array<BlockName, @block_display_names_size@> s_block_display_names { {
  749. )~~~");
  750. for (auto const& block_name : unicode_data.block_display_names) {
  751. generator.set("first", String::formatted("{:#x}", block_name.code_point_range.first));
  752. generator.set("last", String::formatted("{:#x}", block_name.code_point_range.last));
  753. generator.set("name", block_name.name);
  754. generator.append(R"~~~( { { @first@, @last@ }, "@name@"sv },
  755. )~~~");
  756. }
  757. generator.append(R"~~~(} };
  758. )~~~");
  759. generator.append(R"~~~(
  760. Optional<StringView> code_point_block_display_name(u32 code_point)
  761. {
  762. if (auto const* entry = binary_search(s_block_display_names, code_point, nullptr, BlockNameComparator {}))
  763. return entry->display_name;
  764. return {};
  765. }
  766. Span<BlockName const> block_display_names()
  767. {
  768. return s_block_display_names;
  769. }
  770. )~~~");
  771. generator.append(R"~~~(
  772. struct CodePointName {
  773. CodePointRange code_point_range {};
  774. StringView display_name;
  775. };
  776. struct CodePointNameComparator : public CodePointRangeComparator {
  777. constexpr int operator()(u32 code_point, CodePointName const& name)
  778. {
  779. return CodePointRangeComparator::operator()(code_point, name.code_point_range);
  780. }
  781. };
  782. )~~~");
  783. generator.set("code_point_display_names_size", String::number(unicode_data.code_point_display_names.size()));
  784. generator.append(R"~~~(
  785. static constexpr Array<CodePointName, @code_point_display_names_size@> s_code_point_display_names { {
  786. )~~~");
  787. for (auto const& code_point_name : unicode_data.code_point_display_names) {
  788. generator.set("first", String::formatted("{:#x}", code_point_name.code_point_range.first));
  789. generator.set("last", String::formatted("{:#x}", code_point_name.code_point_range.last));
  790. generator.set("name", code_point_name.name);
  791. generator.append(R"~~~( { { @first@, @last@ }, "@name@"sv },
  792. )~~~");
  793. }
  794. generator.append(R"~~~(} };
  795. )~~~");
  796. generator.append(R"~~~(
  797. Optional<String> code_point_display_name(u32 code_point)
  798. {
  799. if (auto const* entry = binary_search(s_code_point_display_names, code_point, nullptr, CodePointNameComparator {})) {
  800. if (entry->display_name.ends_with("{:X}"sv))
  801. return String::formatted(entry->display_name, code_point);
  802. return entry->display_name;
  803. }
  804. return {};
  805. }
  806. )~~~");
  807. auto append_code_point_mapping_search = [&](StringView method, StringView mappings, StringView fallback) {
  808. generator.set("method", method);
  809. generator.set("mappings", mappings);
  810. generator.set("fallback", fallback);
  811. generator.append(R"~~~(
  812. u32 @method@(u32 code_point)
  813. {
  814. auto const* mapping = binary_search(@mappings@, code_point, nullptr, CodePointComparator<CodePointMapping> {});
  815. return mapping ? mapping->mapping : @fallback@;
  816. }
  817. )~~~");
  818. };
  819. append_code_point_mapping_search("canonical_combining_class"sv, "s_combining_class_mappings"sv, "0"sv);
  820. append_code_point_mapping_search("to_unicode_uppercase"sv, "s_uppercase_mappings"sv, "code_point"sv);
  821. append_code_point_mapping_search("to_unicode_lowercase"sv, "s_lowercase_mappings"sv, "code_point"sv);
  822. generator.append(R"~~~(
  823. Span<SpecialCasing const* const> special_case_mapping(u32 code_point)
  824. {
  825. auto const* mapping = binary_search(s_special_case_mappings, code_point, nullptr, CodePointComparator<SpecialCaseMapping> {});
  826. if (mapping == nullptr)
  827. return {};
  828. return mapping->special_casing.span().slice(0, mapping->special_casing_size);
  829. }
  830. Optional<StringView> code_point_abbreviation(u32 code_point)
  831. {
  832. auto const* mapping = binary_search(s_abbreviation_mappings, code_point, nullptr, CodePointComparator<CodePointAbbreviation> {});
  833. if (mapping == nullptr)
  834. return {};
  835. return mapping->abbreviation;
  836. }
  837. )~~~");
  838. auto append_prop_search = [&](StringView enum_title, StringView enum_snake, StringView collection_name) {
  839. generator.set("enum_title", enum_title);
  840. generator.set("enum_snake", enum_snake);
  841. generator.set("collection_name", collection_name);
  842. generator.append(R"~~~(
  843. bool code_point_has_@enum_snake@(u32 code_point, @enum_title@ @enum_snake@)
  844. {
  845. auto index = static_cast<@enum_title@UnderlyingType>(@enum_snake@);
  846. auto const& ranges = @collection_name@.at(index);
  847. auto const* range = binary_search(ranges, code_point, nullptr, CodePointRangeComparator {});
  848. return range != nullptr;
  849. }
  850. )~~~");
  851. };
  852. auto append_from_string = [&](StringView enum_title, StringView enum_snake, PropList const& prop_list, Vector<Alias> const& aliases) {
  853. HashValueMap<StringView> hashes;
  854. hashes.ensure_capacity(prop_list.size() + aliases.size());
  855. for (auto const& prop : prop_list)
  856. hashes.set(prop.key.hash(), prop.key);
  857. for (auto const& alias : aliases)
  858. hashes.set(alias.alias.hash(), alias.alias);
  859. generate_value_from_string(generator, "{}_from_string"sv, enum_title, enum_snake, move(hashes));
  860. };
  861. append_prop_search("GeneralCategory"sv, "general_category"sv, "s_general_categories"sv);
  862. append_from_string("GeneralCategory"sv, "general_category"sv, unicode_data.general_categories, unicode_data.general_category_aliases);
  863. append_prop_search("Property"sv, "property"sv, "s_properties"sv);
  864. append_from_string("Property"sv, "property"sv, unicode_data.prop_list, unicode_data.prop_aliases);
  865. append_prop_search("Script"sv, "script"sv, "s_scripts"sv);
  866. append_prop_search("Script"sv, "script_extension"sv, "s_script_extensions"sv);
  867. append_from_string("Script"sv, "script"sv, unicode_data.script_list, unicode_data.script_aliases);
  868. append_prop_search("Block"sv, "block"sv, "s_blocks"sv);
  869. append_from_string("Block"sv, "block"sv, unicode_data.block_list, unicode_data.block_aliases);
  870. append_prop_search("GraphemeBreakProperty"sv, "grapheme_break_property"sv, "s_grapheme_break_properties"sv);
  871. append_prop_search("WordBreakProperty"sv, "word_break_property"sv, "s_word_break_properties"sv);
  872. append_prop_search("SentenceBreakProperty"sv, "sentence_break_property"sv, "s_sentence_break_properties"sv);
  873. generator.append(R"~~~(
  874. }
  875. )~~~");
  876. TRY(file.write(generator.as_string_view().bytes()));
  877. return {};
  878. }
  879. static Vector<u32> flatten_code_point_ranges(Vector<CodePointRange> const& code_points)
  880. {
  881. Vector<u32> flattened;
  882. for (auto const& range : code_points) {
  883. flattened.grow_capacity(range.last - range.first);
  884. for (u32 code_point = range.first; code_point <= range.last; ++code_point)
  885. flattened.append(code_point);
  886. }
  887. return flattened;
  888. }
  889. static Vector<CodePointRange> form_code_point_ranges(Vector<u32> code_points)
  890. {
  891. Vector<CodePointRange> ranges;
  892. u32 range_start = code_points[0];
  893. u32 range_end = range_start;
  894. for (size_t i = 1; i < code_points.size(); ++i) {
  895. u32 code_point = code_points[i];
  896. if ((code_point - range_end) == 1) {
  897. range_end = code_point;
  898. } else {
  899. ranges.append({ range_start, range_end });
  900. range_start = code_point;
  901. range_end = code_point;
  902. }
  903. }
  904. ranges.append({ range_start, range_end });
  905. return ranges;
  906. }
  907. static void sort_and_merge_code_point_ranges(Vector<CodePointRange>& code_points)
  908. {
  909. quick_sort(code_points, [](auto const& range1, auto const& range2) {
  910. return range1.first < range2.first;
  911. });
  912. for (size_t i = 0; i < code_points.size() - 1;) {
  913. if (code_points[i].last >= code_points[i + 1].first) {
  914. code_points[i].last = max(code_points[i].last, code_points[i + 1].last);
  915. code_points.remove(i + 1);
  916. } else {
  917. ++i;
  918. }
  919. }
  920. auto all_code_points = flatten_code_point_ranges(code_points);
  921. code_points = form_code_point_ranges(all_code_points);
  922. }
  923. static void populate_general_category_unions(PropList& general_categories)
  924. {
  925. // The Unicode standard defines General Category values which are not in any UCD file. These
  926. // values are simply unions of other values.
  927. // https://www.unicode.org/reports/tr44/#GC_Values_Table
  928. auto populate_union = [&](auto alias, auto categories) {
  929. auto& code_points = general_categories.ensure(alias);
  930. for (auto const& category : categories)
  931. code_points.extend(general_categories.find(category)->value);
  932. sort_and_merge_code_point_ranges(code_points);
  933. };
  934. populate_union("LC"sv, Array { "Ll"sv, "Lu"sv, "Lt"sv });
  935. populate_union("L"sv, Array { "Lu"sv, "Ll"sv, "Lt"sv, "Lm"sv, "Lo"sv });
  936. populate_union("M"sv, Array { "Mn"sv, "Mc"sv, "Me"sv });
  937. populate_union("N"sv, Array { "Nd"sv, "Nl"sv, "No"sv });
  938. populate_union("P"sv, Array { "Pc"sv, "Pd"sv, "Ps"sv, "Pe"sv, "Pi"sv, "Pf"sv, "Po"sv });
  939. populate_union("S"sv, Array { "Sm"sv, "Sc"sv, "Sk"sv, "So"sv });
  940. populate_union("Z"sv, Array { "Zs"sv, "Zl"sv, "Zp"sv });
  941. populate_union("C"sv, Array { "Cc"sv, "Cf"sv, "Cs"sv, "Co"sv, "Cn"sv });
  942. }
  943. static void normalize_script_extensions(PropList& script_extensions, PropList const& script_list, Vector<Alias> const& script_aliases)
  944. {
  945. // The ScriptExtensions UCD file lays out its code point ranges rather uniquely compared to
  946. // other files. The Script listed on each line may either be a full Script string or an aliased
  947. // abbreviation. Further, the extensions may or may not include the base Script list. Normalize
  948. // the extensions here to be keyed by the full Script name and always include the base list.
  949. auto extensions = move(script_extensions);
  950. script_extensions = script_list;
  951. for (auto const& extension : extensions) {
  952. auto it = find_if(script_aliases.begin(), script_aliases.end(), [&](auto const& alias) { return extension.key == alias.alias; });
  953. auto const& key = (it == script_aliases.end()) ? extension.key : it->name;
  954. auto& code_points = script_extensions.find(key)->value;
  955. code_points.extend(extension.value);
  956. sort_and_merge_code_point_ranges(code_points);
  957. }
  958. // Lastly, the Common and Inherited script extensions are special. They must not contain any
  959. // code points which appear in other script extensions. The ScriptExtensions UCD file does not
  960. // list these extensions, therefore this peculiarity must be handled programmatically.
  961. // https://www.unicode.org/reports/tr24/#Assignment_ScriptX_Values
  962. auto code_point_has_other_extension = [&](StringView key, u32 code_point) {
  963. for (auto const& extension : extensions) {
  964. if (extension.key == key)
  965. continue;
  966. if (any_of(extension.value, [&](auto const& r) { return (r.first <= code_point) && (code_point <= r.last); }))
  967. return true;
  968. }
  969. return false;
  970. };
  971. auto get_code_points_without_other_extensions = [&](StringView key) {
  972. auto code_points = flatten_code_point_ranges(script_list.find(key)->value);
  973. code_points.remove_all_matching([&](u32 c) { return code_point_has_other_extension(key, c); });
  974. return code_points;
  975. };
  976. auto common_code_points = get_code_points_without_other_extensions("Common"sv);
  977. script_extensions.set("Common"sv, form_code_point_ranges(common_code_points));
  978. auto inherited_code_points = get_code_points_without_other_extensions("Inherited"sv);
  979. script_extensions.set("Inherited"sv, form_code_point_ranges(inherited_code_points));
  980. }
  981. ErrorOr<int> serenity_main(Main::Arguments arguments)
  982. {
  983. StringView generated_header_path;
  984. StringView generated_implementation_path;
  985. StringView unicode_data_path;
  986. StringView special_casing_path;
  987. StringView derived_general_category_path;
  988. StringView prop_list_path;
  989. StringView derived_core_prop_path;
  990. StringView derived_binary_prop_path;
  991. StringView prop_alias_path;
  992. StringView prop_value_alias_path;
  993. StringView name_alias_path;
  994. StringView scripts_path;
  995. StringView script_extensions_path;
  996. StringView blocks_path;
  997. StringView emoji_data_path;
  998. StringView normalization_path;
  999. StringView grapheme_break_path;
  1000. StringView word_break_path;
  1001. StringView sentence_break_path;
  1002. Core::ArgsParser args_parser;
  1003. args_parser.add_option(generated_header_path, "Path to the Unicode Data header file to generate", "generated-header-path", 'h', "generated-header-path");
  1004. args_parser.add_option(generated_implementation_path, "Path to the Unicode Data implementation file to generate", "generated-implementation-path", 'c', "generated-implementation-path");
  1005. args_parser.add_option(unicode_data_path, "Path to UnicodeData.txt file", "unicode-data-path", 'u', "unicode-data-path");
  1006. args_parser.add_option(special_casing_path, "Path to SpecialCasing.txt file", "special-casing-path", 's', "special-casing-path");
  1007. args_parser.add_option(derived_general_category_path, "Path to DerivedGeneralCategory.txt file", "derived-general-category-path", 'g', "derived-general-category-path");
  1008. args_parser.add_option(prop_list_path, "Path to PropList.txt file", "prop-list-path", 'p', "prop-list-path");
  1009. args_parser.add_option(derived_core_prop_path, "Path to DerivedCoreProperties.txt file", "derived-core-prop-path", 'd', "derived-core-prop-path");
  1010. args_parser.add_option(derived_binary_prop_path, "Path to DerivedBinaryProperties.txt file", "derived-binary-prop-path", 'b', "derived-binary-prop-path");
  1011. args_parser.add_option(prop_alias_path, "Path to PropertyAliases.txt file", "prop-alias-path", 'a', "prop-alias-path");
  1012. args_parser.add_option(prop_value_alias_path, "Path to PropertyValueAliases.txt file", "prop-value-alias-path", 'v', "prop-value-alias-path");
  1013. args_parser.add_option(name_alias_path, "Path to NameAliases.txt file", "name-alias-path", 'm', "name-alias-path");
  1014. args_parser.add_option(scripts_path, "Path to Scripts.txt file", "scripts-path", 'r', "scripts-path");
  1015. args_parser.add_option(script_extensions_path, "Path to ScriptExtensions.txt file", "script-extensions-path", 'x', "script-extensions-path");
  1016. args_parser.add_option(blocks_path, "Path to Blocks.txt file", "blocks-path", 'k', "blocks-path");
  1017. args_parser.add_option(emoji_data_path, "Path to emoji-data.txt file", "emoji-data-path", 'e', "emoji-data-path");
  1018. args_parser.add_option(normalization_path, "Path to DerivedNormalizationProps.txt file", "normalization-path", 'n', "normalization-path");
  1019. args_parser.add_option(grapheme_break_path, "Path to GraphemeBreakProperty.txt file", "grapheme-break-path", 'f', "grapheme-break-path");
  1020. args_parser.add_option(word_break_path, "Path to WordBreakProperty.txt file", "word-break-path", 'w', "word-break-path");
  1021. args_parser.add_option(sentence_break_path, "Path to SentenceBreakProperty.txt file", "sentence-break-path", 'i', "sentence-break-path");
  1022. args_parser.parse(arguments);
  1023. auto generated_header_file = TRY(open_file(generated_header_path, Core::Stream::OpenMode::Write));
  1024. auto generated_implementation_file = TRY(open_file(generated_implementation_path, Core::Stream::OpenMode::Write));
  1025. auto unicode_data_file = TRY(open_file(unicode_data_path, Core::Stream::OpenMode::Read));
  1026. auto derived_general_category_file = TRY(open_file(derived_general_category_path, Core::Stream::OpenMode::Read));
  1027. auto special_casing_file = TRY(open_file(special_casing_path, Core::Stream::OpenMode::Read));
  1028. auto prop_list_file = TRY(open_file(prop_list_path, Core::Stream::OpenMode::Read));
  1029. auto derived_core_prop_file = TRY(open_file(derived_core_prop_path, Core::Stream::OpenMode::Read));
  1030. auto derived_binary_prop_file = TRY(open_file(derived_binary_prop_path, Core::Stream::OpenMode::Read));
  1031. auto prop_alias_file = TRY(open_file(prop_alias_path, Core::Stream::OpenMode::Read));
  1032. auto prop_value_alias_file = TRY(open_file(prop_value_alias_path, Core::Stream::OpenMode::Read));
  1033. auto name_alias_file = TRY(open_file(name_alias_path, Core::Stream::OpenMode::Read));
  1034. auto scripts_file = TRY(open_file(scripts_path, Core::Stream::OpenMode::Read));
  1035. auto script_extensions_file = TRY(open_file(script_extensions_path, Core::Stream::OpenMode::Read));
  1036. auto blocks_file = TRY(open_file(blocks_path, Core::Stream::OpenMode::Read));
  1037. auto emoji_data_file = TRY(open_file(emoji_data_path, Core::Stream::OpenMode::Read));
  1038. auto normalization_file = TRY(open_file(normalization_path, Core::Stream::OpenMode::Read));
  1039. auto grapheme_break_file = TRY(open_file(grapheme_break_path, Core::Stream::OpenMode::Read));
  1040. auto word_break_file = TRY(open_file(word_break_path, Core::Stream::OpenMode::Read));
  1041. auto sentence_break_file = TRY(open_file(sentence_break_path, Core::Stream::OpenMode::Read));
  1042. UnicodeData unicode_data {};
  1043. TRY(parse_special_casing(*special_casing_file, unicode_data));
  1044. TRY(parse_prop_list(*derived_general_category_file, unicode_data.general_categories));
  1045. TRY(parse_prop_list(*prop_list_file, unicode_data.prop_list));
  1046. TRY(parse_prop_list(*derived_core_prop_file, unicode_data.prop_list));
  1047. TRY(parse_prop_list(*derived_binary_prop_file, unicode_data.prop_list));
  1048. TRY(parse_prop_list(*emoji_data_file, unicode_data.prop_list));
  1049. TRY(parse_normalization_props(*normalization_file, unicode_data));
  1050. TRY(parse_alias_list(*prop_alias_file, unicode_data.prop_list, unicode_data.prop_aliases));
  1051. TRY(parse_prop_list(*scripts_file, unicode_data.script_list));
  1052. TRY(parse_prop_list(*script_extensions_file, unicode_data.script_extensions, true));
  1053. TRY(parse_block_display_names(*blocks_file, unicode_data));
  1054. TRY(parse_prop_list(*blocks_file, unicode_data.block_list, false, true));
  1055. TRY(parse_name_aliases(*name_alias_file, unicode_data));
  1056. TRY(parse_prop_list(*grapheme_break_file, unicode_data.grapheme_break_props));
  1057. TRY(parse_prop_list(*word_break_file, unicode_data.word_break_props));
  1058. TRY(parse_prop_list(*sentence_break_file, unicode_data.sentence_break_props));
  1059. populate_general_category_unions(unicode_data.general_categories);
  1060. TRY(parse_unicode_data(*unicode_data_file, unicode_data));
  1061. TRY(parse_value_alias_list(*prop_value_alias_file, "gc"sv, unicode_data.general_categories.keys(), unicode_data.general_category_aliases));
  1062. TRY(parse_value_alias_list(*prop_value_alias_file, "sc"sv, unicode_data.script_list.keys(), unicode_data.script_aliases, false));
  1063. TRY(parse_value_alias_list(*prop_value_alias_file, "blk"sv, unicode_data.block_list.keys(), unicode_data.block_aliases, false, true));
  1064. normalize_script_extensions(unicode_data.script_extensions, unicode_data.script_list, unicode_data.script_aliases);
  1065. TRY(generate_unicode_data_header(*generated_header_file, unicode_data));
  1066. TRY(generate_unicode_data_implementation(*generated_implementation_file, unicode_data));
  1067. return 0;
  1068. }