icuSources/i18n/unicode/region.h

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