// Copyright (C) 2013 Google Inc.
//
// 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.
#ifndef I18N_ADDRESSINPUT_ADDRESS_UI_H_
#define I18N_ADDRESSINPUT_ADDRESS_UI_H_
#include <libaddressinput/address_field.h>
#include <string>
#include <vector>
namespace i18n {
namespace addressinput {
struct AddressUiComponent;
// Returns the list of supported CLDR region codes.
const std::vector<std::string>& GetRegionCodes();
// Returns the UI components for the CLDR |region_code|. These components
// represent the address input and formatting rules for |region_code|.
//
// Sets the |components_language_code| to the BCP 47 language code that should
// be used to format the address that the user entered via the UI components.
// The |components_language_code| parameter can be NULL.
//
// If |region_code| has rules for latinized address format and the BCP 47
// |ui_language_code| is not the primary language code used in the region, then
// returns the latinized version of the UI components.
//
// If the UI language has a variation, then the function ignores the variation.
// For example, the function does not distinguish among zh-hans, zh-hant, and
// zh.
//
// Returns an empty vector on error.
std::vector<AddressUiComponent> BuildComponents(
const std::string& region_code,
const std::string& ui_language_code,
std::string* components_language_code);
// Returns the fields which are required for the CLDR |region_code|. Returns an
// empty vector on error.
std::vector<AddressField> GetRequiredFields(const std::string& region_code);
// Returns the string to use as a separator between lines when displaying the
// address in a compact form for BCP 47 |language_code|. For example, returns
// ", " for "en".
const std::string& GetCompactAddressLinesSeparator(
const std::string& language_code);
} // namespace addressinput
} // namespace i18n
#endif // I18N_ADDRESSINPUT_ADDRESS_UI_H_