GenerateUnicodeData.cpp 59 KB

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