GenerateUnicodeData.cpp 55 KB

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