GenerateUnicodeData.cpp 59 KB

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