root/src/locale_to_unicode_flag.rs

// locale-to-unicode-flag.rs
//
// Copyright 2022 nee <nee-git@patchouli.garden>
// SPDX-License-Identifier: AGPL-3.0-or-later
use anyhow::{bail, Result};

const START_UNICODE: u32 = 0x1f1e6;
const START_ASCII: u32 = 65; // A
const END_ASCII: u32 = 91; // Z+1

// converts a locale string to a flag sequence
// Example: es_CL.UTF-8 -> 🇨🇱
// C.UTF-8 returns a c locale Error
// Locales that aren't formatted in LA_RE format returns an error
// case does not matter
pub fn locale_str_to_flag_sequence(locale_str: String) -> Result<String> {
    let locale_str = locale_str.to_uppercase();
    if locale_str.len() >= 5 && locale_str.get(2..3) == Some("_") {
        let location = &locale_str[3..5];
        region_str_to_flag_sequence(location.to_string())
    } else if locale_str.starts_with("C.") || locale_str == "C" {
        bail!("C locale")
    } else {
        bail!("invalid locale format, no region")
    }
}
// converts a 2char long region string to unicode flag sequence
// Example VN -> 🇻🇳
pub fn region_str_to_flag_sequence(location: String) -> Result<String> {
    let upper = location.to_uppercase();
    let chars = upper.chars();
    if upper.len() < 2 {
        bail!("not a valid region, must be 2 characters long")
    }
    let mut failure: bool = false;
    let result = Ok(chars
        .into_iter()
        .map(|c| {
            let ascii = c as u32;
            if !(START_ASCII..END_ASCII).contains(&ascii) {
                // return Err("not a valid region, must only contain A-Z")
                failure = true;
                return '1';
            }
            std::char::from_u32(START_UNICODE + (ascii - START_ASCII)).unwrap_or_else(|| {
                failure = true;
                '2'
            })
        })
        .collect());
    if failure {
        bail!("failed to convert ascii to unicode")
    } else {
        result
    }
}

#[cfg(test)]
mod test {
    use super::*;

    fn check(a: &str, b: &str) {
        assert_eq!(
            locale_str_to_flag_sequence(a.to_string()).unwrap(),
            b.to_string()
        )
    }

    fn check_r(a: &str, b: &str) {
        assert_eq!(
            region_str_to_flag_sequence(a.to_string()).unwrap(),
            b.to_string()
        )
    }

    #[test]
    fn it_works() {
        assert_eq!(
            locale_str_to_flag_sequence("C.UTF-8".to_string()).ok(),
            None
        );

        check("cs_CZ", "🇨🇿");
        check("de_DE", "🇩🇪");
        check("de_DE.UTF-8", "🇩🇪");
        check("en_AU", "🇦🇺");
        check("en_AU.UTF-8", "🇦🇺");
        check("en_CA", "🇨🇦");
        check("en_GB", "🇬🇧");
        check("en_GB.UTF-8", "🇬🇧");
        check("en_IE", "🇮🇪");
        check("en_US", "🇺🇸");
        check("en_US.UTF-8", "🇺🇸");
        check("es_CL.UTF-8", "🇨🇱");
        check("es_ES.UTF-8", "🇪🇸");
        check("fr_FR", "🇫🇷");
        check("fr_FR.UTF-8", "🇫🇷");
        check("it_IT.UTF-8", "🇮🇹");
        check("pl_PL", "🇵🇱");
        check("pl_PL.UTF-8", "🇵🇱");
        check("pt_BR", "🇧🇷");
        check("pt_BR.UTF-8", "🇧🇷");

        check_r("AC", "🇦🇨"); //   Ascension Island
        check_r("AD", "🇦🇩"); //   Andorra
        check_r("AE", "🇦🇪"); //   United Arab Emirates
        check_r("AF", "🇦🇫"); //   Afghanistan
        check_r("AG", "🇦🇬"); //   Antigua & Barbuda
        check_r("AI", "🇦🇮"); //   Anguilla
        check_r("AL", "🇦🇱"); //   Albania
        check_r("AM", "🇦🇲"); //   Armenia
        check_r("AO", "🇦🇴"); //   Angola
        check_r("AQ", "🇦🇶"); //   Antarctica
        check_r("AR", "🇦🇷"); //   Argentina
        check_r("AS", "🇦🇸"); //   American Samoa
        check_r("AT", "🇦🇹"); //   Austria
        check_r("AU", "🇦🇺"); //   Australia
        check_r("AW", "🇦🇼"); //   Aruba
        check_r("AX", "🇦🇽"); //   Åland Islands
        check_r("AZ", "🇦🇿"); //   Azerbaijan
        check_r("BA", "🇧🇦"); //   Bosnia & Herzegovina
        check_r("BB", "🇧🇧"); //   Barbados
        check_r("BD", "🇧🇩"); //   Bangladesh
        check_r("BE", "🇧🇪"); //   Belgium
        check_r("BF", "🇧🇫"); //   Burkina Faso
        check_r("BG", "🇧🇬"); //   Bulgaria
        check_r("BH", "🇧🇭"); //   Bahrain
        check_r("BI", "🇧🇮"); //   Burundi
        check_r("BJ", "🇧🇯"); //   Benin
        check_r("BL", "🇧🇱"); //   St. Barthélemy
        check_r("BM", "🇧🇲"); //   Bermuda
        check_r("BN", "🇧🇳"); //   Brunei
        check_r("BO", "🇧🇴"); //   Bolivia
        check_r("BQ", "🇧🇶"); //   Caribbean Netherlands
        check_r("BR", "🇧🇷"); //   Brazil
        check_r("BS", "🇧🇸"); //   Bahamas
        check_r("BT", "🇧🇹"); //   Bhutan
        check_r("BV", "🇧🇻"); //   Bouvet Island
        check_r("BW", "🇧🇼"); //   Botswana
        check_r("BY", "🇧🇾"); //   Belarus
        check_r("BZ", "🇧🇿"); //   Belize
        check_r("CA", "🇨🇦"); //   Canada
        check_r("CC", "🇨🇨"); //   Cocos (Keeling) Islands
        check_r("CD", "🇨🇩"); //   Congo - Kinshasa
        check_r("CF", "🇨🇫"); //   Central African Republic
        check_r("CG", "🇨🇬"); //   Congo - Brazzaville
        check_r("CH", "🇨🇭"); //   Switzerland
        check_r("CI", "🇨🇮"); //   Côte d'Ivoire
        check_r("CK", "🇨🇰"); //   Cook Islands
        check_r("CL", "🇨🇱"); //   Chile
        check_r("CM", "🇨🇲"); //   Cameroon
        check_r("CN", "🇨🇳"); //   China
        check_r("CO", "🇨🇴"); //   Colombia
        check_r("CP", "🇨🇵"); //   Clipperton Island
        check_r("CR", "🇨🇷"); //   Costa Rica
        check_r("CU", "🇨🇺"); //   Cuba
        check_r("CV", "🇨🇻"); //   Cape Verde
        check_r("CW", "🇨🇼"); //   Curaçao
        check_r("CX", "🇨🇽"); //   Christmas Island
        check_r("CY", "🇨🇾"); //   Cyprus
        check_r("CZ", "🇨🇿"); //   Czechia
        check_r("DE", "🇩🇪"); //   Germany
        check_r("DG", "🇩🇬"); //   Diego Garcia
        check_r("DJ", "🇩🇯"); //   Djibouti
        check_r("DK", "🇩🇰"); //   Denmark
        check_r("DM", "🇩🇲"); //   Dominica
        check_r("DO", "🇩🇴"); //   Dominican Republic
        check_r("DZ", "🇩🇿"); //   Algeria
        check_r("EA", "🇪🇦"); //   Ceuta & Melilla
        check_r("EC", "🇪🇨"); //   Ecuador
        check_r("EE", "🇪🇪"); //   Estonia
        check_r("EG", "🇪🇬"); //   Egypt
        check_r("EH", "🇪🇭"); //   Western Sahara
        check_r("ER", "🇪🇷"); //   Eritrea
        check_r("ES", "🇪🇸"); //   Spain
        check_r("ET", "🇪🇹"); //   Ethiopia
        check_r("EU", "🇪🇺"); //   European Union
        check_r("FI", "🇫🇮"); //   Finland
        check_r("FJ", "🇫🇯"); //   Fiji
        check_r("FK", "🇫🇰"); //   Falkland Islands
        check_r("FM", "🇫🇲"); //   Micronesia
        check_r("FO", "🇫🇴"); //   Faroe Islands
        check_r("FR", "🇫🇷"); //   France
        check_r("GA", "🇬🇦"); //   Gabon
        check_r("GB", "🇬🇧"); //   United Kingdom
        check_r("GD", "🇬🇩"); //   Grenada
        check_r("GE", "🇬🇪"); //   Georgia
        check_r("GF", "🇬🇫"); //   French Guiana
        check_r("GG", "🇬🇬"); //   Guernsey
        check_r("GH", "🇬🇭"); //   Ghana
        check_r("GI", "🇬🇮"); //   Gibraltar
        check_r("GL", "🇬🇱"); //   Greenland
        check_r("GM", "🇬🇲"); //   Gambia
        check_r("GN", "🇬🇳"); //   Guinea
        check_r("GP", "🇬🇵"); //   Guadeloupe
        check_r("GQ", "🇬🇶"); //   Equatorial Guinea
        check_r("GR", "🇬🇷"); //   Greece
        check_r("GS", "🇬🇸"); //   South Georgia & South Sandwich Islands
        check_r("GT", "🇬🇹"); //   Guatemala
        check_r("GU", "🇬🇺"); //   Guam
        check_r("GW", "🇬🇼"); //   Guinea-Bissau
        check_r("GY", "🇬🇾"); //   Guyana
        check_r("HK", "🇭🇰"); //   Hong Kong SAR China
        check_r("HM", "🇭🇲"); //   Heard & McDonald Islands
        check_r("HN", "🇭🇳"); //   Honduras
        check_r("HR", "🇭🇷"); //   Croatia
        check_r("HT", "🇭🇹"); //   Haiti
        check_r("HU", "🇭🇺"); //   Hungary
        check_r("IC", "🇮🇨"); //   Canary Islands
        check_r("ID", "🇮🇩"); //   Indonesia
        check_r("IE", "🇮🇪"); //   Ireland
        check_r("IL", "🇮🇱"); //   Israel
        check_r("IM", "🇮🇲"); //   Isle of Man
        check_r("IN", "🇮🇳"); //   India
        check_r("IO", "🇮🇴"); //   British Indian Ocean Territory
        check_r("IQ", "🇮🇶"); //   Iraq
        check_r("IR", "🇮🇷"); //   Iran
        check_r("IS", "🇮🇸"); //   Iceland
        check_r("IT", "🇮🇹"); //   Italy
        check_r("JE", "🇯🇪"); //   Jersey
        check_r("JM", "🇯🇲"); //   Jamaica
        check_r("JO", "🇯🇴"); //   Jordan
        check_r("JP", "🇯🇵"); //   Japan
        check_r("KE", "🇰🇪"); //   Kenya
        check_r("KG", "🇰🇬"); //   Kyrgyzstan
        check_r("KH", "🇰🇭"); //   Cambodia
        check_r("KI", "🇰🇮"); //   Kiribati
        check_r("KM", "🇰🇲"); //   Comoros
        check_r("KN", "🇰🇳"); //   St. Kitts & Nevis
        check_r("KP", "🇰🇵"); //   North Korea
        check_r("KR", "🇰🇷"); //   South Korea
        check_r("KW", "🇰🇼"); //   Kuwait
        check_r("KY", "🇰🇾"); //   Cayman Islands
        check_r("KZ", "🇰🇿"); //   Kazakhstan
        check_r("LA", "🇱🇦"); //   Laos
        check_r("LB", "🇱🇧"); //   Lebanon
        check_r("LC", "🇱🇨"); //   St. Lucia
        check_r("LI", "🇱🇮"); //   Liechtenstein
        check_r("LK", "🇱🇰"); //   Sri Lanka
        check_r("LR", "🇱🇷"); //   Liberia
        check_r("LS", "🇱🇸"); //   Lesotho
        check_r("LT", "🇱🇹"); //   Lithuania
        check_r("LU", "🇱🇺"); //   Luxembourg
        check_r("LV", "🇱🇻"); //   Latvia
        check_r("LY", "🇱🇾"); //   Libya
        check_r("MA", "🇲🇦"); //   Morocco
        check_r("MC", "🇲🇨"); //   Monaco
        check_r("MD", "🇲🇩"); //   Moldova
        check_r("ME", "🇲🇪"); //   Montenegro
        check_r("MF", "🇲🇫"); //   St. Martin
        check_r("MG", "🇲🇬"); //   Madagascar
        check_r("MH", "🇲🇭"); //   Marshall Islands
        check_r("MK", "🇲🇰"); //   North Macedonia
        check_r("ML", "🇲🇱"); //   Mali
        check_r("MM", "🇲🇲"); //   Myanmar (Burma)
        check_r("MN", "🇲🇳"); //   Mongolia
        check_r("MO", "🇲🇴"); //   Macao SAR China
        check_r("MP", "🇲🇵"); //   Northern Mariana Islands
        check_r("MQ", "🇲🇶"); //   Martinique
        check_r("MR", "🇲🇷"); //   Mauritania
        check_r("MS", "🇲🇸"); //   Montserrat
        check_r("MT", "🇲🇹"); //   Malta
        check_r("MU", "🇲🇺"); //   Mauritius
        check_r("MV", "🇲🇻"); //   Maldives
        check_r("MW", "🇲🇼"); //   Malawi
        check_r("MX", "🇲🇽"); //   Mexico
        check_r("MY", "🇲🇾"); //   Malaysia
        check_r("MZ", "🇲🇿"); //   Mozambique
        check_r("NA", "🇳🇦"); //   Namibia
        check_r("NC", "🇳🇨"); //   New Caledonia
        check_r("NE", "🇳🇪"); //   Niger
        check_r("NF", "🇳🇫"); //   Norfolk Island
        check_r("NG", "🇳🇬"); //   Nigeria
        check_r("NI", "🇳🇮"); //   Nicaragua
        check_r("NL", "🇳🇱"); //   Netherlands
        check_r("NO", "🇳🇴"); //   Norway
        check_r("NP", "🇳🇵"); //   Nepal
        check_r("NR", "🇳🇷"); //   Nauru
        check_r("NU", "🇳🇺"); //   Niue
        check_r("NZ", "🇳🇿"); //   New Zealand
        check_r("OM", "🇴🇲"); //   Oman
        check_r("PA", "🇵🇦"); //   Panama
        check_r("PE", "🇵🇪"); //   Peru
        check_r("PF", "🇵🇫"); //   French Polynesia
        check_r("PG", "🇵🇬"); //   Papua New Guinea
        check_r("PH", "🇵🇭"); //   Philippines
        check_r("PK", "🇵🇰"); //   Pakistan
        check_r("PL", "🇵🇱"); //   Poland
        check_r("PM", "🇵🇲"); //   St. Pierre & Miquelon
        check_r("PN", "🇵🇳"); //   Pitcairn Islands
        check_r("PR", "🇵🇷"); //   Puerto Rico
        check_r("PS", "🇵🇸"); //   Palestinian Territories
        check_r("PT", "🇵🇹"); //   Portugal
        check_r("PW", "🇵🇼"); //   Palau
        check_r("PY", "🇵🇾"); //   Paraguay
        check_r("QA", "🇶🇦"); //   Qatar
        check_r("RE", "🇷🇪"); //   Réunion
        check_r("RO", "🇷🇴"); //   Romania
        check_r("RS", "🇷🇸"); //   Serbia
        check_r("RU", "🇷🇺"); //   Russia
        check_r("RW", "🇷🇼"); //   Rwanda
        check_r("SA", "🇸🇦"); //   Saudi Arabia
        check_r("SB", "🇸🇧"); //   Solomon Islands
        check_r("SC", "🇸🇨"); //   Seychelles
        check_r("SD", "🇸🇩"); //   Sudan
        check_r("SE", "🇸🇪"); //   Sweden
        check_r("SG", "🇸🇬"); //   Singapore
        check_r("SH", "🇸🇭"); //   St. Helena
        check_r("SI", "🇸🇮"); //   Slovenia
        check_r("SJ", "🇸🇯"); //   Svalbard & Jan Mayen
        check_r("SK", "🇸🇰"); //   Slovakia
        check_r("SL", "🇸🇱"); //   Sierra Leone
        check_r("SM", "🇸🇲"); //   San Marino
        check_r("SN", "🇸🇳"); //   Senegal
        check_r("SO", "🇸🇴"); //   Somalia
        check_r("SR", "🇸🇷"); //   Suriname
        check_r("SS", "🇸🇸"); //   South Sudan
        check_r("ST", "🇸🇹"); //   São Tomé & Príncipe
        check_r("SV", "🇸🇻"); //   El Salvador
        check_r("SX", "🇸🇽"); //   Sint Maarten
        check_r("SY", "🇸🇾"); //   Syria
        check_r("SZ", "🇸🇿"); //   Eswatini
        check_r("TA", "🇹🇦"); //   Tristan da Cunha
        check_r("TC", "🇹🇨"); //   Turks & Caicos Islands
        check_r("TD", "🇹🇩"); //   Chad
        check_r("TF", "🇹🇫"); //   French Southern Territories
        check_r("TG", "🇹🇬"); //   Togo
        check_r("TH", "🇹🇭"); //   Thailand
        check_r("TJ", "🇹🇯"); //   Tajikistan
        check_r("TK", "🇹🇰"); //   Tokelau
        check_r("TL", "🇹🇱"); //   Timor-Leste
        check_r("TM", "🇹🇲"); //   Turkmenistan
        check_r("TN", "🇹🇳"); //   Tunisia
        check_r("TO", "🇹🇴"); //   Tonga
        check_r("TR", "🇹🇷"); //   Turkey
        check_r("TT", "🇹🇹"); //   Trinidad & Tobago
        check_r("TV", "🇹🇻"); //   Tuvalu
        check_r("TW", "🇹🇼"); //   Taiwan
        check_r("TZ", "🇹🇿"); //   Tanzania
        check_r("UA", "🇺🇦"); //   Ukraine
        check_r("UG", "🇺🇬"); //   Uganda
        check_r("UM", "🇺🇲"); //   U.S. Outlying Islands
        check_r("UN", "🇺🇳"); //   United Nations
        check_r("US", "🇺🇸"); //   United States
        check_r("UY", "🇺🇾"); //   Uruguay
        check_r("UZ", "🇺🇿"); //   Uzbekistan
        check_r("VA", "🇻🇦"); //   Vatican City
        check_r("VC", "🇻🇨"); //   St. Vincent & Grenadines
        check_r("VE", "🇻🇪"); //   Venezuela
        check_r("VG", "🇻🇬"); //   British Virgin Islands
        check_r("VI", "🇻🇮"); //   U.S. Virgin Islands
        check_r("VN", "🇻🇳"); //   Vietnam
        check_r("VU", "🇻🇺"); //   Vanuatu
        check_r("WF", "🇼🇫"); //   Wallis & Futuna
        check_r("WS", "🇼🇸"); //   Samoa
        check_r("XK", "🇽🇰"); //   Kosovo
        check_r("YE", "🇾🇪"); //   Yemen
        check_r("YT", "🇾🇹"); //   Mayotte
        check_r("ZA", "🇿🇦"); //   South Africa
        check_r("ZM", "🇿🇲"); //   Zambia
        check_r("ZW", "🇿🇼"); //   Zimbabwe
    }
}