Gecko [ v99win.today ]

Name	Size	Permission
alphaindex.h	26.52 KB	-rw-r--r--
appendable.h	8.53 KB	-rw-r--r--
basictz.h	9.92 KB	-rw-r--r--
brkiter.h	27.81 KB	-rw-r--r--
bytestream.h	10.75 KB	-rw-r--r--
bytestrie.h	20.77 KB	-rw-r--r--
bytestriebuilder.h	7.46 KB	-rw-r--r--
calendar.h	105.88 KB	-rw-r--r--
caniter.h	7.44 KB	-rw-r--r--
casemap.h	25.33 KB	-rw-r--r--
char16ptr.h	7.22 KB	-rw-r--r--
chariter.h	24.06 KB	-rw-r--r--
choicfmt.h	23.97 KB	-rw-r--r--
coleitr.h	13.77 KB	-rw-r--r--
coll.h	56.26 KB	-rw-r--r--
compactdecimalformat.h	6.88 KB	-rw-r--r--
curramt.h	3.78 KB	-rw-r--r--
currpinf.h	7.3 KB	-rw-r--r--
currunit.h	4.02 KB	-rw-r--r--
datefmt.h	40.71 KB	-rw-r--r--
dbbi.h	1.19 KB	-rw-r--r--
dcfmtsym.h	20.61 KB	-rw-r--r--
decimfmt.h	87.57 KB	-rw-r--r--
docmain.h	7.21 KB	-rw-r--r--
dtfmtsym.h	38.21 KB	-rw-r--r--
dtintrv.h	3.84 KB	-rw-r--r--
dtitvfmt.h	49.27 KB	-rw-r--r--
dtitvinf.h	18.63 KB	-rw-r--r--
dtptngen.h	26.07 KB	-rw-r--r--
dtrule.h	8.69 KB	-rw-r--r--
edits.h	20.74 KB	-rw-r--r--
enumset.h	2.08 KB	-rw-r--r--
errorcode.h	4.84 KB	-rw-r--r--
fieldpos.h	8.7 KB	-rw-r--r--
filteredbrk.h	5.37 KB	-rw-r--r--
fmtable.h	24.43 KB	-rw-r--r--
format.h	12.5 KB	-rw-r--r--
formattedvalue.h	9.75 KB	-rw-r--r--
fpositer.h	3.03 KB	-rw-r--r--
gender.h	3.33 KB	-rw-r--r--
gregocal.h	31.88 KB	-rw-r--r--
icudataver.h	1.02 KB	-rw-r--r--
icuplug.h	11.83 KB	-rw-r--r--
idna.h	12.7 KB	-rw-r--r--
listformatter.h	8.79 KB	-rw-r--r--
localebuilder.h	11.08 KB	-rw-r--r--
localematcher.h	26.82 KB	-rw-r--r--
localpointer.h	19.36 KB	-rw-r--r--
locdspnm.h	7.12 KB	-rw-r--r--
locid.h	47.66 KB	-rw-r--r--
measfmt.h	11.42 KB	-rw-r--r--
measunit.h	105.09 KB	-rw-r--r--
measure.h	4.33 KB	-rw-r--r--
messagepattern.h	33.71 KB	-rw-r--r--
msgfmt.h	44.22 KB	-rw-r--r--
normalizer2.h	33.66 KB	-rw-r--r--
normlzr.h	30.95 KB	-rw-r--r--
nounit.h	2.25 KB	-rw-r--r--
numberformatter.h	92.29 KB	-rw-r--r--
numberrangeformatter.h	25.19 KB	-rw-r--r--
numfmt.h	49.84 KB	-rw-r--r--
numsys.h	7.33 KB	-rw-r--r--
parseerr.h	3.08 KB	-rw-r--r--
parsepos.h	5.57 KB	-rw-r--r--
platform.h	28.09 KB	-rw-r--r--
plurfmt.h	25.24 KB	-rw-r--r--
plurrule.h	20.82 KB	-rw-r--r--
ptypes.h	3.49 KB	-rw-r--r--
putil.h	6.32 KB	-rw-r--r--
rbbi.h	27.75 KB	-rw-r--r--
rbnf.h	48.85 KB	-rw-r--r--
rbtz.h	15.83 KB	-rw-r--r--
regex.h	84.36 KB	-rw-r--r--
region.h	9.18 KB	-rw-r--r--
reldatefmt.h	22.22 KB	-rw-r--r--
rep.h	9.37 KB	-rw-r--r--
resbund.h	18.08 KB	-rw-r--r--
schriter.h	6.36 KB	-rw-r--r--
scientificnumberformatter.h	6.43 KB	-rw-r--r--
search.h	22.22 KB	-rw-r--r--
selfmt.h	14.34 KB	-rw-r--r--
simpleformatter.h	12.59 KB	-rw-r--r--
simpletz.h	45.7 KB	-rw-r--r--
smpdtfmt.h	71.07 KB	-rw-r--r--
sortkey.h	11.18 KB	-rw-r--r--
std_string.h	1.05 KB	-rw-r--r--
strenum.h	9.92 KB	-rw-r--r--
stringoptions.h	5.79 KB	-rw-r--r--
stringpiece.h	10.05 KB	-rw-r--r--
stringtriebuilder.h	15.47 KB	-rw-r--r--
stsearch.h	21.41 KB	-rw-r--r--
symtable.h	4.27 KB	-rw-r--r--
tblcoll.h	36.92 KB	-rw-r--r--
timezone.h	43.81 KB	-rw-r--r--
tmunit.h	3.4 KB	-rw-r--r--
tmutamt.h	4.91 KB	-rw-r--r--
tmutfmt.h	7.42 KB	-rw-r--r--
translit.h	65.82 KB	-rw-r--r--
tzfmt.h	42.93 KB	-rw-r--r--
tznames.h	16.85 KB	-rw-r--r--
tzrule.h	35.6 KB	-rw-r--r--
tztrans.h	6.13 KB	-rw-r--r--
ubidi.h	89.61 KB	-rw-r--r--
ubiditransform.h	12.7 KB	-rw-r--r--
ubrk.h	24.46 KB	-rw-r--r--
ucal.h	61 KB	-rw-r--r--
ucasemap.h	15.21 KB	-rw-r--r--
ucat.h	5.35 KB	-rw-r--r--
uchar.h	144.64 KB	-rw-r--r--
ucharstrie.h	22.53 KB	-rw-r--r--
ucharstriebuilder.h	7.47 KB	-rw-r--r--
uchriter.h	13.42 KB	-rw-r--r--
uclean.h	11.2 KB	-rw-r--r--
ucnv.h	83.06 KB	-rw-r--r--
ucnv_cb.h	6.58 KB	-rw-r--r--
ucnv_err.h	20.98 KB	-rw-r--r--
ucnvsel.h	6.19 KB	-rw-r--r--
ucol.h	61.51 KB	-rw-r--r--
ucoleitr.h	9.82 KB	-rw-r--r--
uconfig.h	12.07 KB	-rw-r--r--
ucpmap.h	5.53 KB	-rw-r--r--
ucptrie.h	22.5 KB	-rw-r--r--
ucsdet.h	14.69 KB	-rw-r--r--
ucurr.h	16.72 KB	-rw-r--r--
udat.h	62.4 KB	-rw-r--r--
udata.h	15.63 KB	-rw-r--r--
udateintervalformat.h	11.93 KB	-rw-r--r--
udatpg.h	26.76 KB	-rw-r--r--
udisplaycontext.h	5.94 KB	-rw-r--r--
uenum.h	7.79 KB	-rw-r--r--
ufieldpositer.h	4.41 KB	-rw-r--r--
uformattable.h	10.97 KB	-rw-r--r--
uformattedvalue.h	12.3 KB	-rw-r--r--
ugender.h	2.06 KB	-rw-r--r--
uidna.h	33.43 KB	-rw-r--r--
uiter.h	22.75 KB	-rw-r--r--
uldnames.h	10.48 KB	-rw-r--r--
ulistformatter.h	10.78 KB	-rw-r--r--
uloc.h	54.63 KB	-rw-r--r--
ulocdata.h	11.3 KB	-rw-r--r--
umachine.h	16.05 KB	-rw-r--r--
umisc.h	1.33 KB	-rw-r--r--
umsg.h	24.25 KB	-rw-r--r--
umutablecptrie.h	8.29 KB	-rw-r--r--
unifilt.h	4 KB	-rw-r--r--
unifunct.h	4.05 KB	-rw-r--r--
unimatch.h	6.1 KB	-rw-r--r--
unirepl.h	3.38 KB	-rw-r--r--
uniset.h	66.51 KB	-rw-r--r--
unistr.h	170.53 KB	-rw-r--r--
unorm.h	20.55 KB	-rw-r--r--
unorm2.h	24.68 KB	-rw-r--r--
unum.h	54.95 KB	-rw-r--r--
unumberformatter.h	30.45 KB	-rw-r--r--
unumberrangeformatter.h	15.37 KB	-rw-r--r--
unumsys.h	7.26 KB	-rw-r--r--
uobject.h	10.68 KB	-rw-r--r--
upluralrules.h	8.79 KB	-rw-r--r--
uregex.h	71.99 KB	-rw-r--r--
uregion.h	9.81 KB	-rw-r--r--
ureldatefmt.h	17.04 KB	-rw-r--r--
urename.h	134.62 KB	-rw-r--r--
urep.h	5.38 KB	-rw-r--r--
ures.h	36.54 KB	-rw-r--r--
uscript.h	27.63 KB	-rw-r--r--
usearch.h	39.21 KB	-rw-r--r--
uset.h	44.44 KB	-rw-r--r--
usetiter.h	9.68 KB	-rw-r--r--
ushape.h	18 KB	-rw-r--r--
uspoof.h	65.84 KB	-rw-r--r--
usprep.h	8.19 KB	-rw-r--r--
ustdio.h	38.56 KB	-rw-r--r--
ustream.h	1.89 KB	-rw-r--r--
ustring.h	72.36 KB	-rw-r--r--
ustringtrie.h	3.15 KB	-rw-r--r--
utext.h	58.08 KB	-rw-r--r--
utf.h	7.87 KB	-rw-r--r--
utf16.h	23.35 KB	-rw-r--r--
utf32.h	763 B	-rw-r--r--
utf8.h	30.83 KB	-rw-r--r--
utf_old.h	45.83 KB	-rw-r--r--
utmscale.h	13.78 KB	-rw-r--r--
utrace.h	17.18 KB	-rw-r--r--
utrans.h	25.54 KB	-rw-r--r--
utypes.h	31.06 KB	-rw-r--r--
uvernum.h	6.68 KB	-rw-r--r--
uversion.h	5.99 KB	-rw-r--r--
vtzone.h	20.8 KB	-rw-r--r--

Code Editor : region.h

// © 2016 and later: Unicode, Inc. and others.
// License & terms of use: http://www.unicode.org/copyright.html
/*
 *******************************************************************************
 * Copyright (C) 2014-2016, International Business Machines Corporation and others.
 * All Rights Reserved.
 *******************************************************************************
 */

#ifndef REGION_H
#define REGION_H

/**
 * \file 
 * \brief C++ API: Region classes (territory containment)
 */

#include "unicode/utypes.h"

#if U_SHOW_CPLUSPLUS_API

#if !UCONFIG_NO_FORMATTING

#include "unicode/uregion.h"
#include "unicode/uobject.h"
#include "unicode/uniset.h"
#include "unicode/unistr.h"
#include "unicode/strenum.h"

U_NAMESPACE_BEGIN

/**
 * <code>Region</code> is the class representing a Unicode Region Code, also known as a 
 * Unicode Region Subtag, which is defined based upon the BCP 47 standard. We often think of
 * "regions" as "countries" when defining the characteristics of a locale. Region codes There are different
 * types of region codes that are important to distinguish.
 * 
 * Macroregion - A code for a "macro geographical (continental) region, geographical sub-region, or 
 * selected economic and other grouping" as defined in 
 * UN M.49 (http://unstats.un.org/unsd/methods/m49/m49regin.htm). 
 * These are typically 3-digit codes, but contain some 2-letter codes, such as the LDML code QO 
 * added for Outlying Oceania. Not all UNM.49 codes are defined in LDML, but most of them are.
 * Macroregions are represented in ICU by one of three region types: WORLD ( region code 001 ),
 * CONTINENTS ( regions contained directly by WORLD ), and SUBCONTINENTS ( things contained directly
 * by a continent ).
 * 
 * TERRITORY - A Region that is not a Macroregion. These are typically codes for countries, but also
 * include areas that are not separate countries, such as the code "AQ" for Antarctica or the code 
 * "HK" for Hong Kong (SAR China). Overseas dependencies of countries may or may not have separate 
 * codes. The codes are typically 2-letter codes aligned with the ISO 3166 standard, but BCP47 allows
 * for the use of 3-digit codes in the future.
 * 
 * UNKNOWN - The code ZZ is defined by Unicode LDML for use to indicate that the Region is unknown,
 * or that the value supplied as a region was invalid.
 * 
 * DEPRECATED - Region codes that have been defined in the past but are no longer in modern usage,
 * usually due to a country splitting into multiple territories or changing its name.
 * 
 * GROUPING - A widely understood grouping of territories that has a well defined membership such
 * that a region code has been assigned for it. Some of these are UNM.49 codes that do't fall into 
 * the world/continent/sub-continent hierarchy, while others are just well known groupings that have
 * their own region code. Region "EU" (European Union) is one such region code that is a grouping.
 * Groupings will never be returned by the getContainingRegion() API, since a different type of region
 * ( WORLD, CONTINENT, or SUBCONTINENT ) will always be the containing region instead.
 *
 * The Region class is not intended for public subclassing.
 *
 * @author John Emmons
 * @stable ICU 51
 */

class U_I18N_API Region : public UObject {
public:
    /**
     * Destructor.
     * @stable ICU 51
     */
    virtual ~Region();

/**
     * Returns true if the two regions are equal.
     * @stable ICU 51
     */
    bool operator==(const Region &that) const;

/**
     * Returns true if the two regions are NOT equal; that is, if operator ==() returns false.
     * @stable ICU 51
     */
    bool operator!=(const Region &that) const;
 
    /**
     * Returns a pointer to a Region using the given region code.  The region code can be either 2-letter ISO code,
     * 3-letter ISO code,  UNM.49 numeric code, or other valid Unicode Region Code as defined by the LDML specification.
     * The identifier will be canonicalized internally using the supplemental metadata as defined in the CLDR.
     * If the region code is NULL or not recognized, the appropriate error code will be set ( U_ILLEGAL_ARGUMENT_ERROR )
     * @stable ICU 51 
     */
    static const Region* U_EXPORT2 getInstance(const char *region_code, UErrorCode &status);

/**
     * Returns a pointer to a Region using the given numeric region code. If the numeric region code is not recognized,
     * the appropriate error code will be set ( U_ILLEGAL_ARGUMENT_ERROR ).
     * @stable ICU 51 
     */
    static const Region* U_EXPORT2 getInstance (int32_t code, UErrorCode &status);

/**
     * Returns an enumeration over the IDs of all known regions that match the given type.
     * @stable ICU 55
     */
    static StringEnumeration* U_EXPORT2 getAvailable(URegionType type, UErrorCode &status);
   
    /**
     * Returns a pointer to the region that contains this region.  Returns NULL if this region is code "001" (World)
     * or "ZZ" (Unknown region). For example, calling this method with region "IT" (Italy) returns the
     * region "039" (Southern Europe).
     * @stable ICU 51 
     */
    const Region* getContainingRegion() const;

/**
     * Return a pointer to the region that geographically contains this region and matches the given type,
     * moving multiple steps up the containment chain if necessary.  Returns NULL if no containing region can be found
     * that matches the given type. Note: The URegionTypes = "URGN_GROUPING", "URGN_DEPRECATED", or "URGN_UNKNOWN"
     * are not appropriate for use in this API. NULL will be returned in this case. For example, calling this method
     * with region "IT" (Italy) for type "URGN_CONTINENT" returns the region "150" ( Europe ).
     * @stable ICU 51 
     */
    const Region* getContainingRegion(URegionType type) const;

/**
     * Return an enumeration over the IDs of all the regions that are immediate children of this region in the
     * region hierarchy. These returned regions could be either macro regions, territories, or a mixture of the two,
     * depending on the containment data as defined in CLDR.  This API may return NULL if this region doesn't have
     * any sub-regions. For example, calling this method with region "150" (Europe) returns an enumeration containing
     * the various sub regions of Europe - "039" (Southern Europe) - "151" (Eastern Europe) - "154" (Northern Europe)
     * and "155" (Western Europe).
     * @stable ICU 55
     */
    StringEnumeration* getContainedRegions(UErrorCode &status) const;

/**
     * Returns an enumeration over the IDs of all the regions that are children of this region anywhere in the region
     * hierarchy and match the given type.  This API may return an empty enumeration if this region doesn't have any
     * sub-regions that match the given type. For example, calling this method with region "150" (Europe) and type
     * "URGN_TERRITORY" returns a set containing all the territories in Europe ( "FR" (France) - "IT" (Italy) - "DE" (Germany) etc. )
     * @stable ICU 55
     */
    StringEnumeration* getContainedRegions( URegionType type, UErrorCode &status ) const;
 
    /**
     * Returns true if this region contains the supplied other region anywhere in the region hierarchy.
     * @stable ICU 51 
     */
    UBool contains(const Region &other) const;

/**
     * For deprecated regions, return an enumeration over the IDs of the regions that are the preferred replacement
     * regions for this region.  Returns null for a non-deprecated region.  For example, calling this method with region
     * "SU" (Soviet Union) would return a list of the regions containing "RU" (Russia), "AM" (Armenia), "AZ" (Azerbaijan), etc...
     * @stable ICU 55 
     */
    StringEnumeration* getPreferredValues(UErrorCode &status) const;

/**
     * Return this region's canonical region code.
     * @stable ICU 51 
     */
    const char* getRegionCode() const;

/**
     * Return this region's numeric code.
     * Returns a negative value if the given region does not have a numeric code assigned to it.
     * @stable ICU 51 
     */
    int32_t getNumericCode() const;

/**
     * Returns the region type of this region.
     * @stable ICU 51 
     */
    URegionType getType() const;

#ifndef U_HIDE_INTERNAL_API
    /**
     * Cleans up statically allocated memory.
     * @internal 
     */
    static void cleanupRegionData();
#endif  /* U_HIDE_INTERNAL_API */

private:
    char id[4];
    UnicodeString idStr;
    int32_t code;
    URegionType fType;
    Region *containingRegion;
    UVector *containedRegions;
    UVector *preferredValues;

/**
     * Default Constructor. Internal - use factory methods only.
     */
    Region();

/*
     * Initializes the region data from the ICU resource bundles.  The region data
     * contains the basic relationships such as which regions are known, what the numeric
     * codes are, any known aliases, and the territory containment data.
     * 
     * If the region data has already loaded, then this method simply returns without doing
     * anything meaningful.
     */

static void U_CALLCONV loadRegionData(UErrorCode &status);

};

U_NAMESPACE_END

#endif /* #if !UCONFIG_NO_FORMATTING */

#endif /* U_SHOW_CPLUSPLUS_API */

#endif // REGION_H

//eof

${this.title}

Code Editor : region.h