GenerateUnicodeData.cpp 33 KB

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