diff options
author | philip.liard@gmail.com <philip.liard@gmail.com@ee073f10-1060-11df-b6a4-87a95322a99c> | 2012-10-31 13:21:11 +0000 |
---|---|---|
committer | philip.liard@gmail.com <philip.liard@gmail.com@ee073f10-1060-11df-b6a4-87a95322a99c> | 2012-10-31 13:21:11 +0000 |
commit | 9b80e34391ebd835244aea31bd2fb427e209fa0f (patch) | |
tree | db89974196c73e5ae1e068422494221e7fc20dd3 | |
parent | 93d3e8b6d7867ccac0dd4e6beeadfbc1b76dd116 (diff) | |
download | phonenumbers-9b80e34391ebd835244aea31bd2fb427e209fa0f.tar.gz |
CPP: Implement PhoneNumberOfflineGeocoder.
Patch contributed by pmezard.
git-svn-id: http://libphonenumber.googlecode.com/svn/trunk/cpp/src/phonenumbers@537 ee073f10-1060-11df-b6a4-87a95322a99c
-rw-r--r-- | geocoding/phonenumber_offline_geocoder.cc | 216 | ||||
-rw-r--r-- | geocoding/phonenumber_offline_geocoder.h | 164 |
2 files changed, 380 insertions, 0 deletions
diff --git a/geocoding/phonenumber_offline_geocoder.cc b/geocoding/phonenumber_offline_geocoder.cc new file mode 100644 index 0000000..9eac002 --- /dev/null +++ b/geocoding/phonenumber_offline_geocoder.cc @@ -0,0 +1,216 @@ +// Copyright (C) 2012 The Libphonenumber Authors +// +// Licensed under the Apache License, Version 2.0 (the "License"); +// you may not use this file except in compliance with the License. +// You may obtain a copy of the License at +// +// http://www.apache.org/licenses/LICENSE-2.0 +// +// Unless required by applicable law or agreed to in writing, software +// distributed under the License is distributed on an "AS IS" BASIS, +// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +// See the License for the specific language governing permissions and +// limitations under the License. + +// Author: Patrick Mezard + +#include "phonenumbers/geocoding/phonenumber_offline_geocoder.h" + +#include <algorithm> +#include <map> +#include <string> + +#include <unicode/unistr.h> // NOLINT(build/include_order) + +#include "phonenumbers/geocoding/area_code_map.h" +#include "phonenumbers/geocoding/geocoding_data.h" +#include "phonenumbers/geocoding/mapping_file_provider.h" +#include "phonenumbers/phonenumberutil.h" +#include "phonenumbers/stl_util.h" + +namespace i18n { +namespace phonenumbers { + +using icu::UnicodeString; +using std::map; +using std::string; + +namespace { + +// Returns true if s1 comes strictly before s2 in lexicographic order. +bool IsLowerThan(const char* s1, const char* s2) { + return strcmp(s1, s2) < 0; +} + +} // namespace + +PhoneNumberOfflineGeocoder::PhoneNumberOfflineGeocoder() { + Init(get_country_calling_codes(), get_country_calling_codes_size(), + get_country_languages, get_prefix_language_code_pairs(), + get_prefix_language_code_pairs_size(), get_prefix_descriptions); +} + +PhoneNumberOfflineGeocoder::PhoneNumberOfflineGeocoder( + const int* country_calling_codes, int country_calling_codes_size, + country_languages_getter get_country_languages, + const char** prefix_language_code_pairs, + int prefix_language_code_pairs_size, + prefix_descriptions_getter get_prefix_descriptions) { + Init(country_calling_codes, country_calling_codes_size, + get_country_languages, prefix_language_code_pairs, + prefix_language_code_pairs_size, get_prefix_descriptions); +} + +void PhoneNumberOfflineGeocoder::Init( + const int* country_calling_codes, int country_calling_codes_size, + country_languages_getter get_country_languages, + const char** prefix_language_code_pairs, + int prefix_language_code_pairs_size, + prefix_descriptions_getter get_prefix_descriptions) { + phone_util_ = PhoneNumberUtil::GetInstance(); + provider_.reset(new MappingFileProvider(country_calling_codes, + country_calling_codes_size, + get_country_languages)); + prefix_language_code_pairs_ = prefix_language_code_pairs; + prefix_language_code_pairs_size_ = prefix_language_code_pairs_size; + get_prefix_descriptions_ = get_prefix_descriptions; +} + +PhoneNumberOfflineGeocoder::~PhoneNumberOfflineGeocoder() { + STLDeleteContainerPairSecondPointers( + available_maps_.begin(), available_maps_.end()); +} + +const AreaCodeMap* PhoneNumberOfflineGeocoder::GetPhonePrefixDescriptions( + int prefix, const string& language, const string& script, + const string& region) const { + string filename; + provider_->GetFileName(prefix, language, script, region, &filename); + if (filename.empty()) { + return NULL; + } + AreaCodeMaps::const_iterator it = available_maps_.find(filename); + if (it == available_maps_.end()) { + it = LoadAreaCodeMapFromFile(filename); + if (it == available_maps_.end()) { + return NULL; + } + } + return it->second; +} + +PhoneNumberOfflineGeocoder::AreaCodeMaps::const_iterator +PhoneNumberOfflineGeocoder::LoadAreaCodeMapFromFile( + const string& filename) const { + const char** const prefix_language_code_pairs_end = + prefix_language_code_pairs_ + prefix_language_code_pairs_size_; + const char** const prefix_language_code_pair = + std::lower_bound(prefix_language_code_pairs_, + prefix_language_code_pairs_end, + filename.c_str(), IsLowerThan); + if (prefix_language_code_pair != prefix_language_code_pairs_end && + filename.compare(*prefix_language_code_pair) == 0) { + AreaCodeMap* const m = new AreaCodeMap(); + m->ReadAreaCodeMap(get_prefix_descriptions_( + prefix_language_code_pair - prefix_language_code_pairs_)); + return available_maps_.insert(AreaCodeMaps::value_type(filename, m)).first; + } + return available_maps_.end(); +} + +string PhoneNumberOfflineGeocoder::GetCountryNameForNumber( + const PhoneNumber& number, const Locale& language) const { + string region_code; + phone_util_->GetRegionCodeForNumber(number, ®ion_code); + return GetRegionDisplayName(®ion_code, language); +} + +string PhoneNumberOfflineGeocoder::GetRegionDisplayName( + const string* region_code, const Locale& language) const { + if (region_code == NULL || region_code->compare("ZZ") == 0 || + region_code->compare( + PhoneNumberUtil::kRegionCodeForNonGeoEntity) == 0) { + return ""; + } + UnicodeString udisplay_country; + icu::Locale("", region_code->c_str()).getDisplayCountry( + language, udisplay_country); + string display_country; + udisplay_country.toUTF8String(display_country); + return display_country; +} + +string PhoneNumberOfflineGeocoder::GetDescriptionForValidNumber( + const PhoneNumber& number, const Locale& language) const { + const char* const description = GetAreaDescription( + number, language.getLanguage(), "", language.getCountry()); + return *description != '\0' + ? description + : GetCountryNameForNumber(number, language); +} + +string PhoneNumberOfflineGeocoder::GetDescriptionForValidNumber( + const PhoneNumber& number, const Locale& language, + const string& user_region) const { + // If the user region matches the number's region, then we just show the + // lower-level description, if one exists - if no description exists, we will + // show the region(country) name for the number. + string region_code; + phone_util_->GetRegionCodeForNumber(number, ®ion_code); + if (user_region.compare(region_code) == 0) { + return GetDescriptionForValidNumber(number, language); + } + // Otherwise, we just show the region(country) name for now. + return GetRegionDisplayName(®ion_code, language); +} + +string PhoneNumberOfflineGeocoder::GetDescriptionForNumber( + const PhoneNumber& number, const Locale& locale) const { + if (!phone_util_->IsValidNumber(number)) { + return ""; + } + return GetDescriptionForValidNumber(number, locale); +} + +string PhoneNumberOfflineGeocoder::GetDescriptionForNumber( + const PhoneNumber& number, const Locale& language, + const string& user_region) const { + if (!phone_util_->IsValidNumber(number)) { + return ""; + } + return GetDescriptionForValidNumber(number, language, user_region); +} + +const char* PhoneNumberOfflineGeocoder::GetAreaDescription( + const PhoneNumber& number, const string& lang, const string& script, + const string& region) const { + const int country_calling_code = number.country_code(); + // NANPA area is not split in C++ code. + const int phone_prefix = country_calling_code; + const AreaCodeMap* const descriptions = GetPhonePrefixDescriptions( + phone_prefix, lang, script, region); + const char* description = descriptions ? descriptions->Lookup(number) : NULL; + // When a location is not available in the requested language, fall back to + // English. + if ((!description || *description == '\0') && MayFallBackToEnglish(lang)) { + const AreaCodeMap* default_descriptions = GetPhonePrefixDescriptions( + phone_prefix, "en", "", ""); + if (!default_descriptions) { + return ""; + } + description = default_descriptions->Lookup(number); + } + return description ? description : ""; +} + +// Don't fall back to English if the requested language is among the following: +// - Chinese +// - Japanese +// - Korean +bool PhoneNumberOfflineGeocoder::MayFallBackToEnglish( + const string& lang) const { + return lang.compare("zh") && lang.compare("ja") && lang.compare("ko"); +} + +} // namespace phonenumbers +} // namespace i18n diff --git a/geocoding/phonenumber_offline_geocoder.h b/geocoding/phonenumber_offline_geocoder.h new file mode 100644 index 0000000..e0389b7 --- /dev/null +++ b/geocoding/phonenumber_offline_geocoder.h @@ -0,0 +1,164 @@ +// Copyright (C) 2012 The Libphonenumber Authors +// +// Licensed under the Apache License, Version 2.0 (the "License"); +// you may not use this file except in compliance with the License. +// You may obtain a copy of the License at +// +// http://www.apache.org/licenses/LICENSE-2.0 +// +// Unless required by applicable law or agreed to in writing, software +// distributed under the License is distributed on an "AS IS" BASIS, +// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +// See the License for the specific language governing permissions and +// limitations under the License. +// +// Author: Patrick Mezard + +#ifndef I18N_PHONENUMBERS_GEOCODING_PHONENUMBER_OFFLINE_GEOCODER_H_ +#define I18N_PHONENUMBERS_GEOCODING_PHONENUMBER_OFFLINE_GEOCODER_H_ + +#include <map> +#include <string> + +#include <unicode/locid.h> // NOLINT(build/include_order) + +#include "base/basictypes.h" +#include "base/memory/scoped_ptr.h" + +namespace i18n { +namespace phonenumbers { + +using std::map; +using std::string; + +class AreaCodeMap; +class MappingFileProvider; +class PhoneNumber; +class PhoneNumberUtil; +struct CountryLanguages; +struct PrefixDescriptions; +typedef icu::Locale Locale; + +// An offline geocoder which provides geographical information related to a +// phone number. +class PhoneNumberOfflineGeocoder { + private: + typedef map<string, const AreaCodeMap*> AreaCodeMaps; + + public: + typedef const CountryLanguages* (*country_languages_getter)(int index); + typedef const PrefixDescriptions* (*prefix_descriptions_getter)(int index); + + PhoneNumberOfflineGeocoder(); + + // For tests + PhoneNumberOfflineGeocoder( + const int* country_calling_codes, + int country_calling_codes_size, + country_languages_getter get_country_languages, + const char** prefix_language_code_pairs, + int prefix_language_code_pairs_size, + prefix_descriptions_getter get_prefix_descriptions); + + virtual ~PhoneNumberOfflineGeocoder(); + + // Returns a text description for the given phone number, in the language + // provided. The description might consist of the name of the country where + // the phone number is from, or the name of the geographical area the phone + // number is from if more detailed information is available. + // + // This method assumes the validity of the number passed in has already been + // checked. + string GetDescriptionForValidNumber(const PhoneNumber& number, + const Locale& language) const; + + // As per GetDescriptionForValidNumber(PhoneNumber, Locale) but also considers + // the region of the user. If the phone number is from the same region as the + // user, only a lower-level description will be returned, if one exists. + // Otherwise, the phone number's region will be returned, with optionally some + // more detailed information. + // + // For example, for a user from the region "US" (United States), we would show + // "Mountain View, CA" for a particular number, omitting the United States + // from the description. For a user from the United Kingdom (region "GB"), for + // the same number we may show "Mountain View, CA, United States" or even just + // "United States". + // + // This method assumes the validity of the number passed in has already been + // checked. + // + // user_region is the region code for a given user. This region will be + // omitted from the description if the phone number comes from this region. It + // is a two-letter uppercase ISO country code as defined by ISO 3166-1. + string GetDescriptionForValidNumber(const PhoneNumber& number, + const Locale& language, const string& user_region) const; + + // As per GetDescriptionForValidNumber(PhoneNumber, Locale) but explicitly + // checks the validity of the number passed in. + string GetDescriptionForNumber(const PhoneNumber& number, + const Locale& locale) const; + + // As per GetDescriptionForValidNumber(PhoneNumber, Locale, String) but + string GetDescriptionForNumber(const PhoneNumber& number, + const Locale& language, const string& user_region) const; + + private: + void Init(const int* country_calling_codes, + int country_calling_codes_size, + country_languages_getter get_country_languages, + const char** prefix_language_code_pairs, + int prefix_language_code_pairs_size, + prefix_descriptions_getter get_prefix_descriptions); + + const AreaCodeMap* GetPhonePrefixDescriptions(int prefix, + const string& language, const string& script, const string& region) const; + + AreaCodeMaps::const_iterator LoadAreaCodeMapFromFile( + const string& filename) const; + + // Returns the customary display name in the given language for the given + // region. + string GetRegionDisplayName(const string* region_code, + const Locale& language) const; + + // Returns the customary display name in the given language for the given + // territory the phone number is from. + string GetCountryNameForNumber(const PhoneNumber& number, + const Locale& language) const; + + // Returns an area-level text description in the given language for the given + // phone number, or an empty string. + // lang is a two-letter lowercase ISO language codes as defined by ISO 639-1. + // script is a four-letter titlecase (the first letter is uppercase and the + // rest of the letters are lowercase) ISO script codes as defined in ISO + // 15924. + // region is a two-letter uppercase ISO country codes as defined by ISO + // 3166-1. + const char* GetAreaDescription(const PhoneNumber& number, const string& lang, + const string& script, + const string& region) const; + + bool MayFallBackToEnglish(const string& lang) const; + + private: + const PhoneNumberUtil* phone_util_; + // The MappingFileProvider knows for which combination of country calling code + // and language a phone prefix mapping file is available in the file system, + // so that a file can be loaded when needed. + scoped_ptr<const MappingFileProvider> provider_; + + const char** prefix_language_code_pairs_; + int prefix_language_code_pairs_size_; + prefix_descriptions_getter get_prefix_descriptions_; + + // A mapping from country calling codes languages pairs to the corresponding + // phone prefix map that has been loaded. + mutable AreaCodeMaps available_maps_; + + DISALLOW_COPY_AND_ASSIGN(PhoneNumberOfflineGeocoder); +}; + +} // namespace phonenumbers +} // namespace i18n + +#endif /* I18N_PHONENUMBERS_GEOCODING_PHONENUMBER_OFFLINE_GEOCODER_H_ */ |