/* * Copyright (c) 2021, Tim Flynn * * SPDX-License-Identifier: BSD-2-Clause */ #include #include #include #include #include #include #include #include #include #include #include #include #include // Some code points are excluded from UnicodeData.txt, and instead are part of a "range" of code // points, as indicated by the "name" field. For example: // 3400;;Lo;0;L;;;;;N;;;;; // 4DBF;;Lo;0;L;;;;;N;;;;; struct CodePointRange { u32 first; u32 last; }; // SpecialCasing source: https://www.unicode.org/Public/13.0.0/ucd/SpecialCasing.txt // Field descriptions: https://www.unicode.org/reports/tr44/tr44-13.html#SpecialCasing.txt struct SpecialCasing { u32 index { 0 }; u32 code_point { 0 }; Vector lowercase_mapping; Vector uppercase_mapping; Vector titlecase_mapping; String locale; String condition; }; // PropList source: https://www.unicode.org/Public/13.0.0/ucd/PropList.txt // Property descriptions: https://www.unicode.org/reports/tr44/tr44-13.html#PropList.txt // https://www.unicode.org/reports/tr44/tr44-13.html#WordBreakProperty.txt using PropList = HashMap>; // PropertyAliases source: https://www.unicode.org/Public/13.0.0/ucd/PropertyAliases.txt struct Alias { String property; String alias; }; // UnicodeData source: https://www.unicode.org/Public/13.0.0/ucd/UnicodeData.txt // Field descriptions: https://www.unicode.org/reports/tr44/tr44-13.html#UnicodeData.txt // https://www.unicode.org/reports/tr44/#General_Category_Values struct CodePointData { u32 code_point { 0 }; String name; String general_category; u8 canonical_combining_class { 0 }; String bidi_class; String decomposition_type; Optional numeric_value_decimal; Optional numeric_value_digit; Optional numeric_value_numeric; bool bidi_mirrored { false }; String unicode_1_name; String iso_comment; Optional simple_uppercase_mapping; Optional simple_lowercase_mapping; Optional simple_titlecase_mapping; Vector special_casing_indices; Vector prop_list; StringView script; StringView word_break_property; }; struct UnicodeData { Vector special_casing; u32 largest_casing_transform_size { 0 }; u32 largest_special_casing_size { 0 }; Vector locales; Vector conditions; Vector code_point_data; Vector code_point_ranges; u32 last_contiguous_code_point { 0 }; // The Unicode standard defines General Category values which are not in any UCD file. These // values are simply unions of other values. // https://www.unicode.org/reports/tr44/#GC_Values_Table Vector general_categories; Vector general_category_unions { { "Ll | Lu | Lt"sv, "LC"sv }, { "Lu | Ll | Lt | Lm | Lo"sv, "L"sv }, { "Mn | Mc | Me"sv, "M"sv }, { "Nd | Nl | No"sv, "N"sv }, { "Pc | Pd | Ps | Pe | Pi | Pf | Po"sv, "P"sv }, { "Sm | Sc | Sk | So"sv, "S"sv }, { "Zs | Zl | Zp"sv, "Z"sv }, { "Cc | Cf | Cs | Co"sv, "C"sv }, // FIXME: This union should also contain "Cn" (Unassigned), which we don't parse yet. }; Vector general_category_aliases; // The Unicode standard defines additional properties (Any, Assigned, ASCII) which are not in // any UCD file. Assigned is set as the default enum value 0 so "property & Assigned == Assigned" // is always true. Any is not assigned code points here because this file only parses assigned // code points, whereas Any will include unassigned code points. // https://unicode.org/reports/tr18/#General_Category_Property PropList prop_list { { "Any"sv, {} }, { "ASCII"sv, { { 0, 0x7f } } }, }; Vector prop_aliases; PropList script_list { { "Unknown"sv, {} }, }; Vector script_aliases; PropList word_break_prop_list; }; static constexpr auto s_desired_fields = Array { "general_category"sv, "simple_uppercase_mapping"sv, "simple_lowercase_mapping"sv, }; static void write_to_file_if_different(Core::File& file, StringView contents) { auto const current_contents = file.read_all(); if (StringView { current_contents.bytes() } == contents) return; VERIFY(file.seek(0)); VERIFY(file.truncate(0)); VERIFY(file.write(contents)); } static void parse_special_casing(Core::File& file, UnicodeData& unicode_data) { auto parse_code_point_list = [&](auto const& line) { Vector code_points; auto segments = line.split(' '); for (auto const& code_point : segments) code_points.append(AK::StringUtils::convert_to_uint_from_hex(code_point).value()); return code_points; }; while (file.can_read_line()) { auto line = file.read_line(); if (line.is_empty() || line.starts_with('#')) continue; if (auto index = line.find('#'); index.has_value()) line = line.substring(0, *index); auto segments = line.split(';', true); VERIFY(segments.size() == 5 || segments.size() == 6); SpecialCasing casing {}; casing.index = static_cast(unicode_data.special_casing.size()); casing.code_point = AK::StringUtils::convert_to_uint_from_hex(segments[0]).value(); casing.lowercase_mapping = parse_code_point_list(segments[1]); casing.titlecase_mapping = parse_code_point_list(segments[2]); casing.uppercase_mapping = parse_code_point_list(segments[3]); if (auto condition = segments[4].trim_whitespace(); !condition.is_empty()) { auto conditions = condition.split(' ', true); VERIFY(conditions.size() == 1 || conditions.size() == 2); if (conditions.size() == 2) { casing.locale = move(conditions[0]); casing.condition = move(conditions[1]); } else if (all_of(conditions[0], is_ascii_lower_alpha)) { casing.locale = move(conditions[0]); } else { casing.condition = move(conditions[0]); } casing.locale = casing.locale.to_uppercase(); casing.condition.replace("_", "", true); if (!casing.locale.is_empty() && !unicode_data.locales.contains_slow(casing.locale)) unicode_data.locales.append(casing.locale); if (!casing.condition.is_empty() && !unicode_data.conditions.contains_slow(casing.condition)) unicode_data.conditions.append(casing.condition); } unicode_data.largest_casing_transform_size = max(unicode_data.largest_casing_transform_size, casing.lowercase_mapping.size()); unicode_data.largest_casing_transform_size = max(unicode_data.largest_casing_transform_size, casing.titlecase_mapping.size()); unicode_data.largest_casing_transform_size = max(unicode_data.largest_casing_transform_size, casing.uppercase_mapping.size()); unicode_data.special_casing.append(move(casing)); } } static void parse_prop_list(Core::File& file, PropList& prop_list) { while (file.can_read_line()) { auto line = file.read_line(); if (line.is_empty() || line.starts_with('#')) continue; if (auto index = line.find('#'); index.has_value()) line = line.substring(0, *index); auto segments = line.split_view(';', true); VERIFY(segments.size() == 2); auto code_point_range = segments[0].trim_whitespace(); auto property = segments[1].trim_whitespace(); auto& code_points = prop_list.ensure(property); if (code_point_range.contains(".."sv)) { segments = code_point_range.split_view(".."sv); VERIFY(segments.size() == 2); auto begin = AK::StringUtils::convert_to_uint_from_hex(segments[0]).value(); auto end = AK::StringUtils::convert_to_uint_from_hex(segments[1]).value(); code_points.append({ begin, end }); } else { auto code_point = AK::StringUtils::convert_to_uint_from_hex(code_point_range).value(); code_points.append({ code_point, code_point }); } } } static void parse_alias_list(Core::File& file, PropList const& prop_list, Vector& prop_aliases) { String current_property; auto append_alias = [&](auto alias, auto property) { // Note: The alias files contain lines such as "Hyphen = Hyphen", which we should just skip. if (alias == property) return; // FIXME: We will, eventually, need to find where missing properties are located and parse them. if (!prop_list.contains(property)) return; prop_aliases.append({ property, alias }); }; while (file.can_read_line()) { auto line = file.read_line(); if (line.is_empty() || line.starts_with('#')) { if (line.ends_with("Properties"sv)) current_property = line.substring(2); continue; } // Note: For now, we only care about Binary Property aliases for Unicode property escapes. if (current_property != "Binary Properties"sv) continue; auto segments = line.split_view(';', true); VERIFY((segments.size() == 2) || (segments.size() == 3)); auto alias = segments[0].trim_whitespace(); auto property = segments[1].trim_whitespace(); append_alias(alias, property); if (segments.size() == 3) { alias = segments[2].trim_whitespace(); append_alias(alias, property); } } } static void parse_value_alias_list(Core::File& file, StringView desired_category, Vector const& value_list, Vector const& prop_unions, Vector& prop_aliases, bool primary_value_is_first = true) { VERIFY(file.seek(0)); auto append_alias = [&](auto alias, auto value) { // Note: The value alias file contains lines such as "Ahom = Ahom", which we should just skip. if (alias == value) return; // FIXME: We will, eventually, need to find where missing properties are located and parse them. if (!value_list.contains_slow(value) && !any_of(prop_unions, [&](auto const& u) { return value == u.alias; })) return; prop_aliases.append({ value, alias }); }; while (file.can_read_line()) { auto line = file.read_line(); if (line.is_empty() || line.starts_with('#')) continue; if (auto index = line.find('#'); index.has_value()) line = line.substring(0, *index); auto segments = line.split_view(';', true); auto category = segments[0].trim_whitespace(); if (category != desired_category) continue; VERIFY((segments.size() == 3) || (segments.size() == 4)); auto value = primary_value_is_first ? segments[1].trim_whitespace() : segments[2].trim_whitespace(); auto alias = primary_value_is_first ? segments[2].trim_whitespace() : segments[1].trim_whitespace(); append_alias(alias, value); if (segments.size() == 4) { alias = segments[3].trim_whitespace(); append_alias(alias, value); } } } static void parse_unicode_data(Core::File& file, UnicodeData& unicode_data) { Optional code_point_range_start; auto assign_code_point_property = [&](u32 code_point, auto const& list, auto& property, StringView default_) { using PropertyType = RemoveCVReference; constexpr bool is_single_item = IsSame; auto assign_property = [&](auto const& item) { if constexpr (is_single_item) property = item; else property.append(item); }; for (auto const& item : list) { for (auto const& range : item.value) { if ((range.first <= code_point) && (code_point <= range.last)) { assign_property(item.key); break; } } if constexpr (is_single_item) { if (!property.is_empty()) break; } } if (property.is_empty()) assign_property(default_); }; while (file.can_read_line()) { auto line = file.read_line(); if (line.is_empty()) continue; auto segments = line.split(';', true); VERIFY(segments.size() == 15); CodePointData data {}; data.code_point = AK::StringUtils::convert_to_uint_from_hex(segments[0]).value(); data.name = move(segments[1]); data.general_category = move(segments[2]); data.canonical_combining_class = AK::StringUtils::convert_to_uint(segments[3]).value(); data.bidi_class = move(segments[4]); data.decomposition_type = move(segments[5]); data.numeric_value_decimal = AK::StringUtils::convert_to_int(segments[6]); data.numeric_value_digit = AK::StringUtils::convert_to_int(segments[7]); data.numeric_value_numeric = AK::StringUtils::convert_to_int(segments[8]); data.bidi_mirrored = segments[9] == "Y"sv; data.unicode_1_name = move(segments[10]); data.iso_comment = move(segments[11]); data.simple_uppercase_mapping = AK::StringUtils::convert_to_uint_from_hex(segments[12]); data.simple_lowercase_mapping = AK::StringUtils::convert_to_uint_from_hex(segments[13]); data.simple_titlecase_mapping = AK::StringUtils::convert_to_uint_from_hex(segments[14]); if (data.name.starts_with("<"sv) && data.name.ends_with(", First>")) { VERIFY(!code_point_range_start.has_value()); code_point_range_start = data.code_point; data.name = data.name.substring(1, data.name.length() - 9); } else if (data.name.starts_with("<"sv) && data.name.ends_with(", Last>")) { VERIFY(code_point_range_start.has_value()); unicode_data.code_point_ranges.append({ *code_point_range_start, data.code_point }); data.name = data.name.substring(1, data.name.length() - 8); code_point_range_start.clear(); } for (auto const& casing : unicode_data.special_casing) { if (casing.code_point == data.code_point) data.special_casing_indices.append(casing.index); } assign_code_point_property(data.code_point, unicode_data.prop_list, data.prop_list, "Assigned"sv); assign_code_point_property(data.code_point, unicode_data.script_list, data.script, "Unknown"sv); assign_code_point_property(data.code_point, unicode_data.word_break_prop_list, data.word_break_property, "Other"sv); unicode_data.largest_special_casing_size = max(unicode_data.largest_special_casing_size, data.special_casing_indices.size()); if (!unicode_data.general_categories.contains_slow(data.general_category)) unicode_data.general_categories.append(data.general_category); unicode_data.code_point_data.append(move(data)); } } static void generate_unicode_data_header(Core::File& file, UnicodeData& unicode_data) { StringBuilder builder; SourceGenerator generator { builder }; generator.set("casing_transform_size", String::number(unicode_data.largest_casing_transform_size)); generator.set("special_casing_size", String::number(unicode_data.largest_special_casing_size)); auto generate_enum = [&](StringView name, StringView default_, Vector values, Vector unions = {}, Vector aliases = {}, bool as_bitmask = false) { VERIFY(!as_bitmask || (values.size() <= 64)); quick_sort(values); quick_sort(unions, [](auto& union1, auto& union2) { return union1.alias < union2.alias; }); quick_sort(aliases, [](auto& alias1, auto& alias2) { return alias1.alias < alias2.alias; }); generator.set("name", name); generator.set("underlying", String::formatted("{}UnderlyingType", name)); if (as_bitmask) { generator.append(R"~~~( using @underlying@ = u64; enum class @name@ : @underlying@ {)~~~"); } else { generator.append(R"~~~( enum class @name@ {)~~~"); } if (!default_.is_empty()) { generator.set("default", default_); generator.append(R"~~~( @default@,)~~~"); } u8 index = 0; for (auto const& value : values) { generator.set("value", value); if (as_bitmask) { generator.set("index", String::number(index++)); generator.append(R"~~~( @value@ = static_cast<@underlying@>(1) << @index@,)~~~"); } else { generator.append(R"~~~( @value@,)~~~"); } } for (auto const& union_ : unions) { generator.set("union", union_.alias); generator.set("value", union_.property); generator.append(R"~~~( @union@ = @value@,)~~~"); } for (auto const& alias : aliases) { generator.set("alias", alias.alias); generator.set("value", alias.property); generator.append(R"~~~( @alias@ = @value@,)~~~"); } generator.append(R"~~~( }; )~~~"); if (as_bitmask) { generator.append(R"~~~( constexpr @name@ operator&(@name@ value1, @name@ value2) { return static_cast<@name@>(static_cast<@underlying@>(value1) & static_cast<@underlying@>(value2)); } constexpr @name@ operator|(@name@ value1, @name@ value2) { return static_cast<@name@>(static_cast<@underlying@>(value1) | static_cast<@underlying@>(value2)); } )~~~"); } }; generator.append(R"~~~( #pragma once #include #include #include namespace Unicode { )~~~"); generate_enum("Locale"sv, "None"sv, move(unicode_data.locales)); generate_enum("Condition"sv, "None"sv, move(unicode_data.conditions)); generate_enum("GeneralCategory"sv, "None"sv, unicode_data.general_categories, unicode_data.general_category_unions, unicode_data.general_category_aliases, true); generate_enum("Property"sv, "Assigned"sv, unicode_data.prop_list.keys(), {}, unicode_data.prop_aliases, true); generate_enum("Script"sv, {}, unicode_data.script_list.keys(), {}, unicode_data.script_aliases); generate_enum("WordBreakProperty"sv, "Other"sv, unicode_data.word_break_prop_list.keys()); generator.append(R"~~~( struct SpecialCasing { u32 code_point { 0 }; u32 lowercase_mapping[@casing_transform_size@]; u32 lowercase_mapping_size { 0 }; u32 uppercase_mapping[@casing_transform_size@]; u32 uppercase_mapping_size { 0 }; u32 titlecase_mapping[@casing_transform_size@]; u32 titlecase_mapping_size { 0 }; Locale locale { Locale::None }; Condition condition { Condition::None }; }; struct UnicodeData { u32 code_point;)~~~"); auto append_field = [&](StringView type, StringView name) { if (!s_desired_fields.span().contains_slow(name)) return; generator.set("type", type); generator.set("name", name); generator.append(R"~~~( @type@ @name@;)~~~"); }; // Note: For compile-time performance, only primitive types are used. append_field("char const*"sv, "name"sv); append_field("GeneralCategory"sv, "general_category"sv); append_field("u8"sv, "canonical_combining_class"sv); append_field("char const*"sv, "bidi_class"sv); append_field("char const*"sv, "decomposition_type"sv); append_field("i8"sv, "numeric_value_decimal"sv); append_field("i8"sv, "numeric_value_digit"sv); append_field("i8"sv, "numeric_value_numeric"sv); append_field("bool"sv, "bidi_mirrored"sv); append_field("char const*"sv, "unicode_1_name"sv); append_field("char const*"sv, "iso_comment"sv); append_field("u32"sv, "simple_uppercase_mapping"sv); append_field("u32"sv, "simple_lowercase_mapping"sv); append_field("u32"sv, "simple_titlecase_mapping"sv); generator.append(R"~~~( SpecialCasing const* special_casing[@special_casing_size@] {}; u32 special_casing_size { 0 }; Property properties { Property::Assigned }; Script script { Script::Unknown }; WordBreakProperty word_break_property { WordBreakProperty::Other }; }; namespace Detail { Optional unicode_data_for_code_point(u32 code_point); Optional property_from_string(StringView const& property); Optional general_category_from_string(StringView const& general_category); Optional