jpayne@69: // © 2016 and later: Unicode, Inc. and others.
jpayne@69: // License & terms of use: http://www.unicode.org/copyright.html
jpayne@69: /*
jpayne@69: *****************************************************************************************
jpayne@69: * Copyright (C) 2014, International Business Machines
jpayne@69: * Corporation and others. All Rights Reserved.
jpayne@69: *****************************************************************************************
jpayne@69: */
jpayne@69: 
jpayne@69: #ifndef UREGION_H
jpayne@69: #define UREGION_H
jpayne@69: 
jpayne@69: #include "unicode/utypes.h"
jpayne@69: #include "unicode/uenum.h"
jpayne@69: 
jpayne@69: /**
jpayne@69:  * \file
jpayne@69:  * \brief C API: URegion (territory containment and mapping)
jpayne@69:  *
jpayne@69:  * URegion objects represent data associated with a particular Unicode Region Code, also known as a 
jpayne@69:  * Unicode Region Subtag, which is defined based upon the BCP 47 standard. These include:
jpayne@69:  * * Two-letter codes defined by ISO 3166-1, with special LDML treatment of certain private-use or
jpayne@69:  *   reserved codes;
jpayne@69:  * * A subset of 3-digit numeric codes defined by UN M.49.
jpayne@69:  * URegion objects can also provide mappings to and from additional codes. There are different types
jpayne@69:  * of regions that are important to distinguish:
jpayne@69:  * <p>
jpayne@69:  * Macroregion - A code for a "macro geographical (continental) region, geographical sub-region, or 
jpayne@69:  * selected economic and other grouping" as defined in UN M.49. These are typically 3-digit codes,
jpayne@69:  * but contain some 2-letter codes for LDML extensions, such as "QO" for Outlying Oceania.
jpayne@69:  * Macroregions are represented in ICU by one of three region types: WORLD (code 001),
jpayne@69:  * CONTINENTS (regions contained directly by WORLD), and SUBCONTINENTS (regions contained directly
jpayne@69:  * by a continent ).
jpayne@69:  * <p>
jpayne@69:  * TERRITORY - A Region that is not a Macroregion. These are typically codes for countries, but also
jpayne@69:  * include areas that are not separate countries, such as the code "AQ" for Antarctica or the code 
jpayne@69:  * "HK" for Hong Kong (SAR China). Overseas dependencies of countries may or may not have separate 
jpayne@69:  * codes. The codes are typically 2-letter codes aligned with ISO 3166, but BCP47 allows for the use
jpayne@69:  * of 3-digit codes in the future.
jpayne@69:  * <p>
jpayne@69:  * UNKNOWN - The code ZZ is defined by Unicode LDML for use in indicating that region is unknown,
jpayne@69:  * or that the value supplied as a region was invalid.
jpayne@69:  * <p>
jpayne@69:  * DEPRECATED - Region codes that have been defined in the past but are no longer in modern usage,
jpayne@69:  * usually due to a country splitting into multiple territories or changing its name.
jpayne@69:  * <p>
jpayne@69:  * GROUPING - A widely understood grouping of territories that has a well defined membership such
jpayne@69:  * that a region code has been assigned for it.  Some of these are UN M.49 codes that don't fall into 
jpayne@69:  * the world/continent/sub-continent hierarchy, while others are just well-known groupings that have
jpayne@69:  * their own region code. Region "EU" (European Union) is one such region code that is a grouping.
jpayne@69:  * Groupings will never be returned by the uregion_getContainingRegion, since a different type of region
jpayne@69:  * (WORLD, CONTINENT, or SUBCONTINENT) will always be the containing region instead.
jpayne@69:  *
jpayne@69:  * URegion objects are const/immutable, owned and maintained by ICU itself, so there are not functions
jpayne@69:  * to open or close them.
jpayne@69:  */
jpayne@69: 
jpayne@69: /**
jpayne@69:  * URegionType is an enumeration defining the different types of regions.  Current possible
jpayne@69:  * values are URGN_WORLD, URGN_CONTINENT, URGN_SUBCONTINENT, URGN_TERRITORY, URGN_GROUPING,
jpayne@69:  * URGN_DEPRECATED, and URGN_UNKNOWN.
jpayne@69:  * 
jpayne@69:  * @stable ICU 51 
jpayne@69:  */
jpayne@69: typedef enum URegionType {
jpayne@69:     /**
jpayne@69:      * Type representing the unknown region.
jpayne@69:      * @stable ICU 51 
jpayne@69:      */
jpayne@69:     URGN_UNKNOWN,
jpayne@69: 
jpayne@69:     /**
jpayne@69:      * Type representing a territory.
jpayne@69:      * @stable ICU 51 
jpayne@69:      */
jpayne@69:     URGN_TERRITORY,
jpayne@69: 
jpayne@69:     /**
jpayne@69:      * Type representing the whole world.
jpayne@69:      * @stable ICU 51 
jpayne@69:      */
jpayne@69:     URGN_WORLD,
jpayne@69: 
jpayne@69:     /**
jpayne@69:      * Type representing a continent.
jpayne@69:      * @stable ICU 51 
jpayne@69:      */
jpayne@69:     URGN_CONTINENT,
jpayne@69: 
jpayne@69:     /**
jpayne@69:      * Type representing a sub-continent.
jpayne@69:      * @stable ICU 51 
jpayne@69:      */
jpayne@69:     URGN_SUBCONTINENT,
jpayne@69: 
jpayne@69:     /**
jpayne@69:      * Type representing a grouping of territories that is not to be used in
jpayne@69:      * the normal WORLD/CONTINENT/SUBCONTINENT/TERRITORY containment tree.
jpayne@69:      * @stable ICU 51 
jpayne@69:      */
jpayne@69:     URGN_GROUPING,
jpayne@69: 
jpayne@69:     /**
jpayne@69:      * Type representing a region whose code has been deprecated, usually
jpayne@69:      * due to a country splitting into multiple territories or changing its name.
jpayne@69:      * @stable ICU 51 
jpayne@69:      */
jpayne@69:     URGN_DEPRECATED,
jpayne@69: 
jpayne@69: #ifndef U_HIDE_DEPRECATED_API
jpayne@69:     /**
jpayne@69:      * One more than the highest normal URegionType value.
jpayne@69:      * @deprecated ICU 58 The numeric value may change over time, see ICU ticket #12420.
jpayne@69:      */
jpayne@69:     URGN_LIMIT
jpayne@69: #endif  /* U_HIDE_DEPRECATED_API */
jpayne@69: } URegionType;
jpayne@69: 
jpayne@69: #if !UCONFIG_NO_FORMATTING
jpayne@69: 
jpayne@69: /**
jpayne@69:  * Opaque URegion object for use in C programs.
jpayne@69:  * @stable ICU 52
jpayne@69:  */
jpayne@69: struct URegion;
jpayne@69: typedef struct URegion URegion; /**< @stable ICU 52 */
jpayne@69: 
jpayne@69: /**
jpayne@69:  * Returns a pointer to a URegion for the specified region code: A 2-letter or 3-letter ISO 3166
jpayne@69:  * code, UN M.49 numeric code (superset of ISO 3166 numeric codes), or other valid Unicode Region
jpayne@69:  * Code as defined by the LDML specification. The code will be canonicalized internally. If the
jpayne@69:  * region code is NULL or not recognized, the appropriate error code will be set
jpayne@69:  * (U_ILLEGAL_ARGUMENT_ERROR).
jpayne@69:  * @stable ICU 52
jpayne@69:  */
jpayne@69: U_STABLE const URegion* U_EXPORT2
jpayne@69: uregion_getRegionFromCode(const char *regionCode, UErrorCode *status);
jpayne@69: 
jpayne@69: /**
jpayne@69:  * Returns a pointer to a URegion for the specified numeric region code. If the numeric region
jpayne@69:  * code is not recognized, the appropriate error code will be set (U_ILLEGAL_ARGUMENT_ERROR).
jpayne@69:  * @stable ICU 52
jpayne@69:  */
jpayne@69: U_STABLE const URegion* U_EXPORT2
jpayne@69: uregion_getRegionFromNumericCode (int32_t code, UErrorCode *status);
jpayne@69: 
jpayne@69: /**
jpayne@69:  * Returns an enumeration over the canonical codes of all known regions that match the given type.
jpayne@69:  * The enumeration must be closed with with uenum_close().
jpayne@69:  * @stable ICU 52
jpayne@69:  */
jpayne@69: U_STABLE UEnumeration* U_EXPORT2
jpayne@69: uregion_getAvailable(URegionType type, UErrorCode *status);
jpayne@69: 
jpayne@69: /**
jpayne@69:  * Returns true if the specified uregion is equal to the specified otherRegion.
jpayne@69:  * @stable ICU 52
jpayne@69:  */
jpayne@69: U_STABLE UBool U_EXPORT2
jpayne@69: uregion_areEqual(const URegion* uregion, const URegion* otherRegion);
jpayne@69: 
jpayne@69: /**
jpayne@69:  * Returns a pointer to the URegion that contains the specified uregion. Returns NULL if the
jpayne@69:  * specified uregion is code "001" (World) or "ZZ" (Unknown region). For example, calling
jpayne@69:  * this method with region "IT" (Italy) returns the URegion for "039" (Southern Europe).
jpayne@69:  * @stable ICU 52
jpayne@69:  */
jpayne@69: U_STABLE const URegion* U_EXPORT2
jpayne@69: uregion_getContainingRegion(const URegion* uregion);
jpayne@69: 
jpayne@69: /**
jpayne@69:  * Return a pointer to the URegion that geographically contains this uregion and matches the
jpayne@69:  * specified type, moving multiple steps up the containment chain if necessary. Returns NULL if no
jpayne@69:  * containing region can be found that matches the specified type. Will return NULL if URegionType
jpayne@69:  * is URGN_GROUPING, URGN_DEPRECATED, or URGN_UNKNOWN which are not appropriate for this API.
jpayne@69:  * For example, calling this method with uregion "IT" (Italy) for type URGN_CONTINENT returns the
jpayne@69:  * URegion "150" (Europe).
jpayne@69:  * @stable ICU 52
jpayne@69:  */
jpayne@69: U_STABLE const URegion* U_EXPORT2
jpayne@69: uregion_getContainingRegionOfType(const URegion* uregion, URegionType type);
jpayne@69: 
jpayne@69: /**
jpayne@69:  * Return an enumeration over the canonical codes of all the regions that are immediate children
jpayne@69:  * of the specified uregion in the region hierarchy. These returned regions could be either macro
jpayne@69:  * regions, territories, or a mixture of the two, depending on the containment data as defined in
jpayne@69:  * CLDR. This API returns NULL if this uregion doesn't have any sub-regions. For example, calling
jpayne@69:  * this function for uregion "150" (Europe) returns an enumeration containing the various
jpayne@69:  * sub-regions of Europe: "039" (Southern Europe), "151" (Eastern Europe), "154" (Northern Europe),
jpayne@69:  * and "155" (Western Europe). The enumeration must be closed with with uenum_close().
jpayne@69:  * @stable ICU 52
jpayne@69:  */
jpayne@69: U_STABLE UEnumeration* U_EXPORT2
jpayne@69: uregion_getContainedRegions(const URegion* uregion, UErrorCode *status);
jpayne@69: 
jpayne@69: /**
jpayne@69:  * Returns an enumeration over the canonical codes of all the regions that are children of the
jpayne@69:  * specified uregion anywhere in the region hierarchy and match the given type. This API may return
jpayne@69:  * an empty enumeration if this uregion doesn't have any sub-regions that match the given type.
jpayne@69:  * For example, calling this method with region "150" (Europe) and type URGN_TERRITORY" returns an
jpayne@69:  * enumeration containing all the territories in Europe: "FR" (France), "IT" (Italy), "DE" (Germany),
jpayne@69:  * etc. The enumeration must be closed with with uenum_close().
jpayne@69:  * @stable ICU 52
jpayne@69:  */
jpayne@69: U_STABLE UEnumeration* U_EXPORT2
jpayne@69: uregion_getContainedRegionsOfType(const URegion* uregion, URegionType type, UErrorCode *status);
jpayne@69: 
jpayne@69: /**
jpayne@69:  * Returns true if the specified uregion contains the specified otherRegion anywhere in the region
jpayne@69:  * hierarchy.
jpayne@69:  * @stable ICU 52
jpayne@69:  */
jpayne@69: U_STABLE UBool U_EXPORT2
jpayne@69: uregion_contains(const URegion* uregion, const URegion* otherRegion);
jpayne@69: 
jpayne@69: /**
jpayne@69:  * If the specified uregion is deprecated, returns an enumeration over the canonical codes of the
jpayne@69:  * regions that are the preferred replacement regions for the specified uregion. If the specified
jpayne@69:  * uregion is not deprecated, returns NULL. For example, calling this method with uregion
jpayne@69:  * "SU" (Soviet Union) returns a list of the regions containing "RU" (Russia), "AM" (Armenia),
jpayne@69:  * "AZ" (Azerbaijan), etc... The enumeration must be closed with with uenum_close().
jpayne@69:  * @stable ICU 52
jpayne@69:  */
jpayne@69: U_STABLE UEnumeration* U_EXPORT2
jpayne@69: uregion_getPreferredValues(const URegion* uregion, UErrorCode *status);
jpayne@69: 
jpayne@69: /**
jpayne@69:  * Returns the specified uregion's canonical code.
jpayne@69:  * @stable ICU 52
jpayne@69:  */
jpayne@69: U_STABLE const char* U_EXPORT2
jpayne@69: uregion_getRegionCode(const URegion* uregion);
jpayne@69: 
jpayne@69: /**
jpayne@69:  * Returns the specified uregion's numeric code, or a negative value if there is no numeric code
jpayne@69:  * for the specified uregion.
jpayne@69:  * @stable ICU 52
jpayne@69:  */
jpayne@69: U_STABLE int32_t U_EXPORT2
jpayne@69: uregion_getNumericCode(const URegion* uregion);
jpayne@69: 
jpayne@69: /**
jpayne@69:  * Returns the URegionType of the specified uregion.
jpayne@69:  * @stable ICU 52
jpayne@69:  */
jpayne@69: U_STABLE URegionType U_EXPORT2
jpayne@69: uregion_getType(const URegion* uregion);
jpayne@69: 
jpayne@69: 
jpayne@69: #endif /* #if !UCONFIG_NO_FORMATTING */
jpayne@69: 
jpayne@69: #endif