We need you! We're working hard on the next version of Developer Fusion - Let us know what you think we should be up to!

The Labs \ Source Viewer \ SSCLI \ System.Globalization \ RegionInfo

SSCLI
  1. // ==++==
  2. //
  3. //
  4. // Copyright (c) 2006 Microsoft Corporation. All rights reserved.
  5. //
  6. // The use and distribution terms for this software are contained in the file
  7. // named license.txt, which can be found in the root of this distribution.
  8. // By using this software in any fashion, you are agreeing to be bound by the
  9. // terms of this license.
  10. //
  11. // You must not remove this notice, or any other, from this software.
  12. //
  13. //
  14. // ==--==
  16. ////////////////////////////////////////////////////////////////////////////
  17. //
  18. // Class: RegionInfo
  19. //
  20. // Purpose: This class represents settings specified by de jure or
  21. // de facto standards for a particular country or region. In
  22. // contrast to CultureInfo, the RegionInfo does not represent
  23. // preferences of the user and does not depend on the user's
  24. // language or culture.
  25. //
  26. // Date: March 31, 1999
  27. //
  28. ////////////////////////////////////////////////////////////////////////////
  30. namespace System.Globalization
  31. {
  32.    
  33.     using System;
  34.     using System.Runtime.Serialization;
  35.    
  36.     [Serializable()]
  37.     [System.Runtime.InteropServices.ComVisible(true)]
  38.     public class RegionInfo
  39.     {
  40.         //--------------------------------------------------------------------//
  41.         // Internal Information //
  42.         //--------------------------------------------------------------------//
  43.        
  44.         //
  45.         // Variables.
  46.         //
  47.         internal string m_name;
  48.        
  49.         //
  50.         // m_cultureId only used for serialization to detect if we have created the Region using LCID.
  51.         // When creating region using culture Id we fake the name (for compatibility) so during the
  52.         // deserialization we need to detect if we have faked name or real name.
  53.         //
  54.         [OptionalField(VersionAdded = 2)]
  55.         int m_cultureId;
  56.        
  57.         //
  58.         // The CultureTable instance that we are going to read data from.
  59.         // For supported culture, this will be the CultureTable instance that read data from mscorlib assembly.
  60.         // For customized culture, this will be the CultureTable instance that read data from user customized culture binary file.
  61.         //
  62.         [NonSerialized()]
  63.         internal CultureTableRecord m_cultureTableRecord;
  64.        
  65.         static internal RegionInfo m_currentRegionInfo;
  66.        
  67.        
  68.         ////////////////////////////////////////////////////////////////////////
  69.         //
  70.         // RegionInfo Constructors
  71.         //
  72.         ////////////////////////////////////////////////////////////////////////
  73.        
  74.        
  75.         public RegionInfo(string name)
  76.         {
  77.             if (name == null)
  78.                 throw new ArgumentNullException("name");
  79.             if (name.Length == 0)
  80.                 throw new ArgumentException(Environment.GetResourceString("Argument_InvalidRegionName", name), "name");
  81.             this.m_name = name.ToUpper(CultureInfo.InvariantCulture);
  82.            
  83.             m_cultureId = 0;
  84.            
  85.             //
  86.             // First try it as an entire culture. We must have user override as true here so
  87.             // that we can pick up custom cultures *before* built-in ones (if they want to
  88.             // prefer built-in cultures they will pass "us" instead of "en-US").
  89.             //
  90.             this.m_cultureTableRecord = CultureTableRecord.GetCultureTableRecordForRegion(name, true);
  91.            
  92.             if (this.m_cultureTableRecord.IsNeutralCulture) {
  93.                 // Not supposed to be neutral
  94.                 throw new ArgumentException(Environment.GetResourceString("Argument_InvalidNeutralRegionName", name), "name");
  95.             }
  96.         }
  97.        
  98.        
  99.         public RegionInfo(int culture)
  100.         {
  101.             // Get the culture data item.
  102.            
  103.             if (culture == CultureInfo.LOCALE_INVARIANT) {
  104.                 //The InvariantCulture has no matching region
  105.                 throw new ArgumentException(Environment.GetResourceString("Argument_NoRegionInvariantCulture"));
  106.             }
  107.            
  108.             if (CultureTableRecord.IsCustomCultureId(culture)) {
  109.                 // Customized culture
  110.                 throw new ArgumentException(Environment.GetResourceString("Argument_CustomCultureCannotBePassedByNumber", "culture"));
  111.             }
  112.             if (CultureInfo.GetSubLangID(culture) == 0) {
  113.                 // Supposed to have sublang (region) info
  114.                 throw new ArgumentException(Environment.GetResourceString("Argument_CultureIsNeutral", culture), "culture");
  115.             }
  116.            
  117.             //
  118.             // From this region data item, get the region data item.
  119.             // Several culture ID may map to the same region.
  120.             // For example, 0x1009 (English (Canada)) and 0x0c0c (French (Canada)) all map to
  121.             // the same region "CA" (Canada).
  122.             //
  123.             this.m_cultureTableRecord = CultureTableRecord.GetCultureTableRecord(culture, true);
  124.            
  125.             if (this.m_cultureTableRecord.IsNeutralCulture) {
  126.                 // Not supposed to be neutral
  127.                 throw new ArgumentException(Environment.GetResourceString("Argument_CultureIsNeutral", culture), "culture");
  128.             }
  129.            
  130.             // Make sure that we initialize m_name since it will be used in deserialization.
  131.             this.m_name = this.m_cultureTableRecord.SREGIONNAME;
  132.            
  133.             m_cultureId = culture;
  134.         }
  135.        
  136.         internal RegionInfo(CultureTableRecord table)
  137.         {
  138.             this.m_cultureTableRecord = table;
  139.             // Make sure that we initialize m_name since it will be used in deserialization.
  140.             this.m_name = this.m_cultureTableRecord.SREGIONNAME;
  141.         }
  142.        
  143.         #region Serialization
  144.         internal int m_dataItem;
  145.        
  146.         [OnDeserialized()]
  147.         private void OnDeserialized(StreamingContext ctx)
  148.         {
  149.             if (m_name == null) {
  150.                 BCLDebug.Assert(m_dataItem >= 0, "[RegionInfo.OnDeserialized] null name and invalid dataItem");
  151.                 m_cultureTableRecord = CultureTableRecord.GetCultureTableRecord(CultureTableRecord.IdFromEverettRegionInfoDataItem(m_dataItem), true);
  152.                 m_name = m_cultureTableRecord.SREGIONNAME;
  153.             }
  154.             else {
  155.                 if (m_cultureId != 0)
  156.                     m_cultureTableRecord = CultureTableRecord.GetCultureTableRecord(m_cultureId, true);
  157.                 else
  158.                     m_cultureTableRecord = CultureTableRecord.GetCultureTableRecordForRegion(m_name, true);
  159.             }
  160.         }
  161.        
  162.         [OnSerializing()]
  163.         private void OnSerializing(StreamingContext ctx)
  164.         {
  165.             m_dataItem = m_cultureTableRecord.EverettRegionDataItem();
  166.         }
  167.         #endregion Serialization
  168.        
  169.         ////////////////////////////////////////////////////////////////////////
  170.         //
  171.         // GetCurrentRegion
  172.         //
  173.         // This instance provides methods based on the current user settings.
  174.         // These settings are volatile and may change over the lifetime of the
  175.         // thread.
  176.         //
  177.         ////////////////////////////////////////////////////////////////////////
  178.        
  179.        
  180.         unsafe public static RegionInfo CurrentRegion {
  181.             get {
  182.                 RegionInfo temp = m_currentRegionInfo;
  183.                 if (temp == null) {
  184.                     temp = new RegionInfo(CultureInfo.CurrentCulture.m_cultureTableRecord);
  185.                    
  186.                     // Need full name for custom cultures
  187.                     if (temp.m_cultureTableRecord.IsCustomCulture) {
  188.                         temp.m_name = temp.m_cultureTableRecord.SNAME;
  189.                     }
  190.                     m_currentRegionInfo = temp;
  191.                 }
  192.                 return temp;
  193.             }
  194.         }
  195.        
  196.         ////////////////////////////////////////////////////////////////////////
  197.         //
  198.         // GetName
  199.         //
  200.         // Returns the name of the region in the UI language.
  201.         //
  202.         ////////////////////////////////////////////////////////////////////////
  203.        
  204.        
  205.         public virtual string Name {
  206.             get {
  207.                 if (m_name == null) {
  208.                     m_name = this.m_cultureTableRecord.SREGIONNAME;
  209.                 }
  210.                 return (m_name);
  211.             }
  212.         }
  213.        
  214.         ////////////////////////////////////////////////////////////////////////
  215.         //
  216.         // GetEnglishName
  217.         //
  218.         // Returns the name of the region in English.
  219.         //
  220.         ////////////////////////////////////////////////////////////////////////
  221.        
  222.        
  223.         public virtual string EnglishName {
  224.             get { return (this.m_cultureTableRecord.SENGCOUNTRY); }
  225.         }
  226.        
  227.        
  228.         public virtual string DisplayName {
  229.             get {
  230.                 if (m_cultureTableRecord.IsCustomCulture) {
  231.                     if (m_cultureTableRecord.IsReplacementCulture) {
  232.                         // <SyntheticSupport/>
  233.                         if (m_cultureTableRecord.IsSynthetic)
  234.                             return m_cultureTableRecord.RegionNativeDisplayName;
  235.                         else
  236.                             return (Environment.GetResourceString("Globalization.ri_" + this.m_cultureTableRecord.SREGIONNAME));
  237.                     }
  238.                     else {
  239.                         return this.m_cultureTableRecord.SNATIVECOUNTRY;
  240.                     }
  241.                 }
  242.                 else {
  243.                     // <SyntheticSupport/>
  244.                     if (m_cultureTableRecord.IsSynthetic)
  245.                         return m_cultureTableRecord.RegionNativeDisplayName;
  246.                     else
  247.                         return (Environment.GetResourceString("Globalization.ri_" + this.m_cultureTableRecord.SREGIONNAME));
  248.                 }
  249.             }
  250.         }
  251.        
  252.        
  253.         [System.Runtime.InteropServices.ComVisible(false)]
  254.         public virtual string NativeName {
  255.             get { return (this.m_cultureTableRecord.SNATIVECOUNTRY); }
  256.         }
  257.        
  258.        
  259.         public virtual string TwoLetterISORegionName {
  260.             get { return (this.m_cultureTableRecord.SISO3166CTRYNAME); }
  261.         }
  262.        
  263.        
  264.         public virtual string ThreeLetterISORegionName {
  265.             get { return (this.m_cultureTableRecord.SISO3166CTRYNAME2); }
  266.         }
  267.        
  268.        
  269.         public virtual bool IsMetric {
  270.             get {
  271.                 int value = this.m_cultureTableRecord.IMEASURE;
  272.                 return (value == 0);
  273.             }
  274.         }
  275.        
  276.        
  277.         [System.Runtime.InteropServices.ComVisible(false)]
  278.         public virtual int GeoId {
  279.             get { return (this.m_cultureTableRecord.IGEOID); }
  280.         }
  281.        
  282.        
  283.         public virtual string ThreeLetterWindowsRegionName {
  284.             get { return (this.m_cultureTableRecord.SABBREVCTRYNAME); }
  285.         }
  286.        
  287.        
  288.         [System.Runtime.InteropServices.ComVisible(false)]
  289.         public virtual string CurrencyEnglishName {
  290.             get { return (this.m_cultureTableRecord.SENGLISHCURRENCY); }
  291.         }
  292.        
  293.        
  294.         [System.Runtime.InteropServices.ComVisible(false)]
  295.         public virtual string CurrencyNativeName {
  296.             get { return (this.m_cultureTableRecord.SNATIVECURRENCY); }
  297.         }
  298.        
  299. /*================================ CurrencySymbol =============================
  300.         **Property: CurrencySymbol
  301.         **Exceptions: None
  302.         ==============================================================================*/       
  303.        
  304.        
  305.         public virtual string CurrencySymbol {
  306.             get { return (this.m_cultureTableRecord.SCURRENCY); }
  307.         }
  308.        
  309. /*================================ ISOCurrencySymbol ==========================
  310.         **Property: Three characters of the international monetary symbol specified in ISO 4217.
  311.         **Exceptions: None
  312.         ==============================================================================*/       
  313.        
  314.        
  315.         public virtual string ISOCurrencySymbol {
  316.             get { return (this.m_cultureTableRecord.SINTLSYMBOL); }
  317.         }
  318.        
  319.         ////////////////////////////////////////////////////////////////////////
  320.         //
  321.         // Equals
  322.         //
  323.         // Implements Object.Equals(). Returns a boolean indicating whether
  324.         // or not object refers to the same CultureInfo as the current instance.
  325.         //
  326.         ////////////////////////////////////////////////////////////////////////
  327.        
  328.        
  329.         public override bool Equals(object value)
  330.         {
  331.             RegionInfo that = value as RegionInfo;
  332.             if (that != null) {
  333.                 return this.Name.Equals(that.Name);
  334.             }
  335.            
  336.             return (false);
  337.         }
  338.        
  339.         ////////////////////////////////////////////////////////////////////////
  340.         //
  341.         // GetHashCode
  342.         //
  343.         // Implements Object.GetHashCode(). Returns the hash code for the
  344.         // CultureInfo. The hash code is guaranteed to be the same for RegionInfo
  345.         // A and B where A.Equals(B) is true.
  346.         //
  347.         ////////////////////////////////////////////////////////////////////////
  348.        
  349.        
  350.         public override int GetHashCode()
  351.         {
  352.             return (this.Name.GetHashCode());
  353.         }
  354.        
  355.        
  356.         ////////////////////////////////////////////////////////////////////////
  357.         //
  358.         // ToString
  359.         //
  360.         // Implements Object.ToString(). Returns the name of the Region,
  361.         // eg. "United States".
  362.         //
  363.         ////////////////////////////////////////////////////////////////////////
  364.        
  365.        
  366.         public override string ToString()
  367.         {
  368.             return (Name);
  369.         }
  370.     }
  371. }

Developer Fusion