Mercurial > repos > rliterman > csp2

annotate CSP2/CSP2_env/env-d9b9114564458d9d-741b3de822f2aaca6c6caa4325c4afce/include/unicode/region.h @ 69:33d812a61356

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
planemo upload commit 2e9511a184a1ca667c7be0c6321a36dc4e3d116d
author jpayne
date Tue, 18 Mar 2025 17:55:14 -0400
parents
children
rev   line source
jpayne@69 1 // © 2016 and later: Unicode, Inc. and others.
jpayne@69 2 // License & terms of use: http://www.unicode.org/copyright.html
jpayne@69 3 /*
jpayne@69 4 *******************************************************************************
jpayne@69 5 * Copyright (C) 2014-2016, International Business Machines Corporation and others.
jpayne@69 6 * All Rights Reserved.
jpayne@69 7 *******************************************************************************
jpayne@69 8 */
jpayne@69 9
jpayne@69 10 #ifndef REGION_H
jpayne@69 11 #define REGION_H
jpayne@69 12
jpayne@69 13 /**
jpayne@69 14 * \file
jpayne@69 15 * \brief C++ API: Region classes (territory containment)
jpayne@69 16 */
jpayne@69 17
jpayne@69 18 #include "unicode/utypes.h"
jpayne@69 19
jpayne@69 20 #if U_SHOW_CPLUSPLUS_API
jpayne@69 21
jpayne@69 22 #if !UCONFIG_NO_FORMATTING
jpayne@69 23
jpayne@69 24 #include "unicode/uregion.h"
jpayne@69 25 #include "unicode/uobject.h"
jpayne@69 26 #include "unicode/uniset.h"
jpayne@69 27 #include "unicode/unistr.h"
jpayne@69 28 #include "unicode/strenum.h"
jpayne@69 29
jpayne@69 30 U_NAMESPACE_BEGIN
jpayne@69 31
jpayne@69 32 /**
jpayne@69 33 * <code>Region</code> is the class representing a Unicode Region Code, also known as a
jpayne@69 34 * Unicode Region Subtag, which is defined based upon the BCP 47 standard. We often think of
jpayne@69 35 * "regions" as "countries" when defining the characteristics of a locale. Region codes There are different
jpayne@69 36 * types of region codes that are important to distinguish.
jpayne@69 37 * <p>
jpayne@69 38 * Macroregion - A code for a "macro geographical (continental) region, geographical sub-region, or
jpayne@69 39 * selected economic and other grouping" as defined in
jpayne@69 40 * UN M.49 (http://unstats.un.org/unsd/methods/m49/m49regin.htm).
jpayne@69 41 * These are typically 3-digit codes, but contain some 2-letter codes, such as the LDML code QO
jpayne@69 42 * added for Outlying Oceania. Not all UNM.49 codes are defined in LDML, but most of them are.
jpayne@69 43 * Macroregions are represented in ICU by one of three region types: WORLD ( region code 001 ),
jpayne@69 44 * CONTINENTS ( regions contained directly by WORLD ), and SUBCONTINENTS ( things contained directly
jpayne@69 45 * by a continent ).
jpayne@69 46 * <p>
jpayne@69 47 * TERRITORY - A Region that is not a Macroregion. These are typically codes for countries, but also
jpayne@69 48 * include areas that are not separate countries, such as the code "AQ" for Antarctica or the code
jpayne@69 49 * "HK" for Hong Kong (SAR China). Overseas dependencies of countries may or may not have separate
jpayne@69 50 * codes. The codes are typically 2-letter codes aligned with the ISO 3166 standard, but BCP47 allows
jpayne@69 51 * for the use of 3-digit codes in the future.
jpayne@69 52 * <p>
jpayne@69 53 * UNKNOWN - The code ZZ is defined by Unicode LDML for use to indicate that the Region is unknown,
jpayne@69 54 * or that the value supplied as a region was invalid.
jpayne@69 55 * <p>
jpayne@69 56 * DEPRECATED - Region codes that have been defined in the past but are no longer in modern usage,
jpayne@69 57 * usually due to a country splitting into multiple territories or changing its name.
jpayne@69 58 * <p>
jpayne@69 59 * GROUPING - A widely understood grouping of territories that has a well defined membership such
jpayne@69 60 * that a region code has been assigned for it. Some of these are UNM.49 codes that do't fall into
jpayne@69 61 * the world/continent/sub-continent hierarchy, while others are just well known groupings that have
jpayne@69 62 * their own region code. Region "EU" (European Union) is one such region code that is a grouping.
jpayne@69 63 * Groupings will never be returned by the getContainingRegion() API, since a different type of region
jpayne@69 64 * ( WORLD, CONTINENT, or SUBCONTINENT ) will always be the containing region instead.
jpayne@69 65 *
jpayne@69 66 * The Region class is not intended for public subclassing.
jpayne@69 67 *
jpayne@69 68 * @author John Emmons
jpayne@69 69 * @stable ICU 51
jpayne@69 70 */
jpayne@69 71
jpayne@69 72 class U_I18N_API Region : public UObject {
jpayne@69 73 public:
jpayne@69 74 /**
jpayne@69 75 * Destructor.
jpayne@69 76 * @stable ICU 51
jpayne@69 77 */
jpayne@69 78 virtual ~Region();
jpayne@69 79
jpayne@69 80 /**
jpayne@69 81 * Returns true if the two regions are equal.
jpayne@69 82 * @stable ICU 51
jpayne@69 83 */
jpayne@69 84 UBool operator==(const Region &that) const;
jpayne@69 85
jpayne@69 86 /**
jpayne@69 87 * Returns true if the two regions are NOT equal; that is, if operator ==() returns false.
jpayne@69 88 * @stable ICU 51
jpayne@69 89 */
jpayne@69 90 UBool operator!=(const Region &that) const;
jpayne@69 91
jpayne@69 92 /**
jpayne@69 93 * Returns a pointer to a Region using the given region code. The region code can be either 2-letter ISO code,
jpayne@69 94 * 3-letter ISO code, UNM.49 numeric code, or other valid Unicode Region Code as defined by the LDML specification.
jpayne@69 95 * The identifier will be canonicalized internally using the supplemental metadata as defined in the CLDR.
jpayne@69 96 * If the region code is NULL or not recognized, the appropriate error code will be set ( U_ILLEGAL_ARGUMENT_ERROR )
jpayne@69 97 * @stable ICU 51
jpayne@69 98 */
jpayne@69 99 static const Region* U_EXPORT2 getInstance(const char *region_code, UErrorCode &status);
jpayne@69 100
jpayne@69 101 /**
jpayne@69 102 * Returns a pointer to a Region using the given numeric region code. If the numeric region code is not recognized,
jpayne@69 103 * the appropriate error code will be set ( U_ILLEGAL_ARGUMENT_ERROR ).
jpayne@69 104 * @stable ICU 51
jpayne@69 105 */
jpayne@69 106 static const Region* U_EXPORT2 getInstance (int32_t code, UErrorCode &status);
jpayne@69 107
jpayne@69 108 /**
jpayne@69 109 * Returns an enumeration over the IDs of all known regions that match the given type.
jpayne@69 110 * @stable ICU 55
jpayne@69 111 */
jpayne@69 112 static StringEnumeration* U_EXPORT2 getAvailable(URegionType type, UErrorCode &status);
jpayne@69 113
jpayne@69 114 /**
jpayne@69 115 * Returns a pointer to the region that contains this region. Returns NULL if this region is code "001" (World)
jpayne@69 116 * or "ZZ" (Unknown region). For example, calling this method with region "IT" (Italy) returns the
jpayne@69 117 * region "039" (Southern Europe).
jpayne@69 118 * @stable ICU 51
jpayne@69 119 */
jpayne@69 120 const Region* getContainingRegion() const;
jpayne@69 121
jpayne@69 122 /**
jpayne@69 123 * Return a pointer to the region that geographically contains this region and matches the given type,
jpayne@69 124 * moving multiple steps up the containment chain if necessary. Returns NULL if no containing region can be found
jpayne@69 125 * that matches the given type. Note: The URegionTypes = "URGN_GROUPING", "URGN_DEPRECATED", or "URGN_UNKNOWN"
jpayne@69 126 * are not appropriate for use in this API. NULL will be returned in this case. For example, calling this method
jpayne@69 127 * with region "IT" (Italy) for type "URGN_CONTINENT" returns the region "150" ( Europe ).
jpayne@69 128 * @stable ICU 51
jpayne@69 129 */
jpayne@69 130 const Region* getContainingRegion(URegionType type) const;
jpayne@69 131
jpayne@69 132 /**
jpayne@69 133 * Return an enumeration over the IDs of all the regions that are immediate children of this region in the
jpayne@69 134 * region hierarchy. These returned regions could be either macro regions, territories, or a mixture of the two,
jpayne@69 135 * depending on the containment data as defined in CLDR. This API may return NULL if this region doesn't have
jpayne@69 136 * any sub-regions. For example, calling this method with region "150" (Europe) returns an enumeration containing
jpayne@69 137 * the various sub regions of Europe - "039" (Southern Europe) - "151" (Eastern Europe) - "154" (Northern Europe)
jpayne@69 138 * and "155" (Western Europe).
jpayne@69 139 * @stable ICU 55
jpayne@69 140 */
jpayne@69 141 StringEnumeration* getContainedRegions(UErrorCode &status) const;
jpayne@69 142
jpayne@69 143 /**
jpayne@69 144 * Returns an enumeration over the IDs of all the regions that are children of this region anywhere in the region
jpayne@69 145 * hierarchy and match the given type. This API may return an empty enumeration if this region doesn't have any
jpayne@69 146 * sub-regions that match the given type. For example, calling this method with region "150" (Europe) and type
jpayne@69 147 * "URGN_TERRITORY" returns a set containing all the territories in Europe ( "FR" (France) - "IT" (Italy) - "DE" (Germany) etc. )
jpayne@69 148 * @stable ICU 55
jpayne@69 149 */
jpayne@69 150 StringEnumeration* getContainedRegions( URegionType type, UErrorCode &status ) const;
jpayne@69 151
jpayne@69 152 /**
jpayne@69 153 * Returns true if this region contains the supplied other region anywhere in the region hierarchy.
jpayne@69 154 * @stable ICU 51
jpayne@69 155 */
jpayne@69 156 UBool contains(const Region &other) const;
jpayne@69 157
jpayne@69 158 /**
jpayne@69 159 * For deprecated regions, return an enumeration over the IDs of the regions that are the preferred replacement
jpayne@69 160 * regions for this region. Returns null for a non-deprecated region. For example, calling this method with region
jpayne@69 161 * "SU" (Soviet Union) would return a list of the regions containing "RU" (Russia), "AM" (Armenia), "AZ" (Azerbaijan), etc...
jpayne@69 162 * @stable ICU 55
jpayne@69 163 */
jpayne@69 164 StringEnumeration* getPreferredValues(UErrorCode &status) const;
jpayne@69 165
jpayne@69 166 /**
jpayne@69 167 * Return this region's canonical region code.
jpayne@69 168 * @stable ICU 51
jpayne@69 169 */
jpayne@69 170 const char* getRegionCode() const;
jpayne@69 171
jpayne@69 172 /**
jpayne@69 173 * Return this region's numeric code.
jpayne@69 174 * Returns a negative value if the given region does not have a numeric code assigned to it.
jpayne@69 175 * @stable ICU 51
jpayne@69 176 */
jpayne@69 177 int32_t getNumericCode() const;
jpayne@69 178
jpayne@69 179 /**
jpayne@69 180 * Returns the region type of this region.
jpayne@69 181 * @stable ICU 51
jpayne@69 182 */
jpayne@69 183 URegionType getType() const;
jpayne@69 184
jpayne@69 185 #ifndef U_HIDE_INTERNAL_API
jpayne@69 186 /**
jpayne@69 187 * Cleans up statically allocated memory.
jpayne@69 188 * @internal
jpayne@69 189 */
jpayne@69 190 static void cleanupRegionData();
jpayne@69 191 #endif /* U_HIDE_INTERNAL_API */
jpayne@69 192
jpayne@69 193 private:
jpayne@69 194 char id[4];
jpayne@69 195 UnicodeString idStr;
jpayne@69 196 int32_t code;
jpayne@69 197 URegionType fType;
jpayne@69 198 Region *containingRegion;
jpayne@69 199 UVector *containedRegions;
jpayne@69 200 UVector *preferredValues;
jpayne@69 201
jpayne@69 202 /**
jpayne@69 203 * Default Constructor. Internal - use factory methods only.
jpayne@69 204 */
jpayne@69 205 Region();
jpayne@69 206
jpayne@69 207
jpayne@69 208 /*
jpayne@69 209 * Initializes the region data from the ICU resource bundles. The region data
jpayne@69 210 * contains the basic relationships such as which regions are known, what the numeric
jpayne@69 211 * codes are, any known aliases, and the territory containment data.
jpayne@69 212 *
jpayne@69 213 * If the region data has already loaded, then this method simply returns without doing
jpayne@69 214 * anything meaningful.
jpayne@69 215 */
jpayne@69 216
jpayne@69 217 static void U_CALLCONV loadRegionData(UErrorCode &status);
jpayne@69 218
jpayne@69 219 };
jpayne@69 220
jpayne@69 221 U_NAMESPACE_END
jpayne@69 222
jpayne@69 223 #endif /* #if !UCONFIG_NO_FORMATTING */
jpayne@69 224
jpayne@69 225 #endif /* U_SHOW_CPLUSPLUS_API */
jpayne@69 226
jpayne@69 227 #endif // REGION_H
jpayne@69 228
jpayne@69 229 //eof