648 lines · 29.7 KB · C#
RawDownload
//******************************************************************************************************//  Common.cs - Gbtc////  Copyright © 2010, Grid Protection Alliance.  All Rights Reserved.////  Licensed to the Grid Protection Alliance (GPA) under one or more contributor license agreements. See//  the NOTICE file distributed with this work for additional information regarding copyright ownership.//  The GPA licenses this file to you under the Eclipse Public License -v 1.0 (the "License"); you may//  not use this file except in compliance with the License. You may obtain a copy of the License at:////      http://www.opensource.org/licenses/eclipse-1.0.php////  Unless agreed to in writing, the subject software distributed under the License is distributed on an//  "AS-IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. Refer to the//  License for the specific language governing permissions and limitations.////  Code Modification History://  ----------------------------------------------------------------------------------------------------//  04/03/2006 - J. Ritchie Carroll//       Generated original version of source code.//  12/13/2007 - Darrell Zuercher//       Edited code comments.//  09/08/2008 - J. Ritchie Carroll//       Converted to C#.//  02/13/2009 - Josh L. Patterson//       Edited Code Comments.//  09/14/2009 - Stephen C. Wills//       Added new header and license agreement.//  09/17/2009 - Pinal C. Patel//       Modified GetApplicationType() to remove dependency on HttpContext.Current.//  09/28/2010 - Pinal C. Patel//       Cached the current ApplicationType returned by GetApplicationType() for better performance.//  12/05/2010 - Pinal C. Patel//       Added an overload for TypeConvertToString() that takes CultureInfo as a parameter.//  12/07/2010 - Pinal C. Patel//       Updated TypeConvertToString() to return an empty string if the passed in value is null.//  03/09/2011 - Pinal C. Patel//       Moved UpdateType enumeration from GSF.Services.ServiceProcess namespace for broader usage.//  04/07/2011 - J. Ritchie Carroll//       Added ToNonNullNorEmptyString() and ToNonNullNorWhiteSpace() extensions.//  10/8/2012 - Danyelle Gilliam//        Modified Header////******************************************************************************************************    #region [ Contributor License Agreements ] //******************************************************************************************************////  Copyright © 2011, Grid Protection Alliance.  All Rights Reserved.////  The GPA licenses this file to you under the Eclipse Public License -v 1.0 (the "License"); you may//  not use this file except in compliance with the License. You may obtain a copy of the License at:////      http://www.opensource.org/licenses/eclipse-1.0.php////  Unless agreed to in writing, the subject software distributed under the License is distributed on an//  "AS-IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. Refer to the//  License for the specific language governing permissions and limitations.////****************************************************************************************************** #endregion using GSF.Reflection;using System;using System.ComponentModel;using System.Globalization;using System.IO;using System.Linq;//using System.Web.Hosting; namespace GSF{    #region [ Enumerations ]     /// <summary>Specifies the type of the application.</summary>    public enum ApplicationType    {        /// <summary>        /// Application is of unknown type.        /// </summary>        Unknown = 0,        /// <summary>        /// Application doesn't require a subsystem.        /// </summary>        Native = 1,        /// <summary>        /// Application runs in the Windows GUI subsystem.        /// </summary>        WindowsGui = 2,        /// <summary>        /// Application runs in the Windows character subsystem.        /// </summary>        WindowsCui = 3,        /// <summary>        /// Application runs in the OS/2 character subsystem.        /// </summary>        OS2Cui = 5,        /// <summary>        /// Application runs in the Posix character subsystem.        /// </summary>        PosixCui = 7,        /// <summary>        /// Application is a native Win9x driver.        /// </summary>        NativeWindows = 8,        /// <summary>        /// Application runs in the Windows CE subsystem.        /// </summary>        WindowsCEGui = 9,        /// <summary>        /// The application is a web site or web application.        /// </summary>        Web = 100    }     /// <summary>    /// Indicates the type of update.    /// </summary>    public enum UpdateType    {        /// <summary>        /// Update is informational.        /// </summary>        Information,        /// <summary>        /// Update is a warning.        /// </summary>        Warning,        /// <summary>        /// Update is an alarm.        /// </summary>        Alarm    }     #endregion     // This is the location for handy miscellaneous functions that are difficult to categorize elsewhere. For the most    // part these functions may have the most value in a Visual Basic application which supports importing functions    // down to a class level, e.g.: Imports GSF.Common     /// <summary>    /// Defines common global functions.    /// </summary>    public static class Common    {        private static Nullable<ApplicationType> s_applicationType;         /// <summary>        /// Attempts to parse a <see cref="Guid "/> from given string <paramref name="value"/>.        /// </summary>        /// <param name="value">String value to attempt to parse as a <see cref="Guid"/>.</param>        /// <param name="result">Parsed <see cref="Guid"/> value.</param>        /// <returns>true if <paramref name="value"/> was successfully parsed as a <see cref="Guid"/>; otherwise, false.</returns>        public static bool TryParseGuid(string value, out Guid result)        {            try            {                result = new Guid(value);                return true;            }            catch            {                result = Guid.Empty;                return false;            }        }         /// <summary>Returns one of two strongly-typed objects.</summary>        /// <returns>One of two objects, depending on the evaluation of given expression.</returns>        /// <param name="expression">The expression you want to evaluate.</param>        /// <param name="truePart">Returned if expression evaluates to True.</param>        /// <param name="falsePart">Returned if expression evaluates to False.</param>        /// <typeparam name="T">Return type used for immediate expression</typeparam>        /// <remarks>        /// <para>This function acts as a strongly-typed immediate if (a.k.a. inline if).</para>        /// <para>It is expected that this function will only be used in Visual Basic.NET as a strongly-typed IIf replacement.</para>        /// </remarks>        public static T IIf<T>(bool expression, T truePart, T falsePart)        {            return (expression ? truePart : falsePart);        }         /// <summary>Creates a strongly-typed Array.</summary>        /// <returns>New array of specified type.</returns>        /// <param name="length">Desired length of new array.</param>        /// <typeparam name="T">Return type for new array.</typeparam>        /// <remarks>        /// <para>It is expected that this function will only be used in Visual Basic.NET.</para>        /// <para>        /// The Array.CreateInstance provides better performance and more direct CLR access for array creation (not to        /// mention less confusion on the matter of array lengths) in VB.NET, however the returned System.Array is not        /// typed properly. This function properly casts the return array based on the the type specification helping        /// when Option Strict is enabled.        /// </para>        /// </remarks>        /// <example>        /// <code language="VB">        ///     Dim buffer As Byte() = CreateArray(Of Byte)(12)        ///     Dim matrix As Integer()() = CreateArray(Of Integer())(10)        /// </code>        /// </example>        public static T[] CreateArray<T>(int length)        {            // The following provides better performance than "Return New T(length) {}".            return (T[])Array.CreateInstance(typeof(T), length);        }         /// <summary>Creates a strongly-typed Array with an initial value parameter.</summary>        /// <returns>New array of specified type.</returns>        /// <param name="length">Desired length of new array.</param>        /// <param name="initialValue">Value used to initialize all array elements.</param>        /// <typeparam name="T">Return type for new array.</typeparam>        /// <remarks>        /// It is expected that this function will only be used in Visual Basic.NET.        /// </remarks>        /// <example>        /// <code language="VB">        ///     Dim elements As Integer() = CreateArray(12, -1)        ///     Dim names As String() = CreateArray(100, "undefined")        /// </code>        /// </example>        public static T[] CreateArray<T>(int length, T initialValue)        {            T[] typedArray = CreateArray<T>(length);             // Initializes all elements with the default value.            for (int x = 0; x < typedArray.Length; x++)            {                typedArray[x] = initialValue;            }             return typedArray;        }          /// <summary>        /// Gets the type of the currently executing application.        /// </summary>        /// <returns>One of the <see cref="ApplicationType"/> values.</returns>        public static ApplicationType GetApplicationType()        {            if ((object)s_applicationType != null)                return s_applicationType.Value;             //if ((object)HostingEnvironment.ApplicationVirtualPath != null)            //{            //    s_applicationType = ApplicationType.Web;            //}            //else            //{            try            {                // References:                // - http://support.microsoft.com/kb/65122                // - http://support.microsoft.com/kb/90493/en-us                // - http://www.codeguru.com/cpp/w-p/system/misc/article.php/c2897/                // We will always have an entry assembly for windows application.                FileStream exe = new FileStream(AssemblyInfo.EntryAssembly.Location, FileMode.Open, FileAccess.Read, FileShare.ReadWrite);                byte[] dosHeader = new byte[64];                byte[] exeHeader = new byte[248];                byte[] subSystem = new byte[2];                exe.Read(dosHeader, 0, dosHeader.Length);                exe.Seek(BitConverter.ToInt16(dosHeader, 60), SeekOrigin.Begin);                exe.Read(exeHeader, 0, exeHeader.Length);                exe.Close();                 Buffer.BlockCopy(exeHeader, 92, subSystem, 0, 2);                 s_applicationType = ((ApplicationType)(BitConverter.ToInt16(subSystem, 0)));            }            catch            {                // We are unable to determine the application type.                s_applicationType = ApplicationType.Unknown;            }            //}             return s_applicationType.Value;        }         // The following "ToNonNullString" methods extend all class based objects. Note that these extension methods can be        // called even if the base object is null, hence the value of these methods. Our philosophy for this project has been        // "not" to apply extensions to all objects (this to avoid general namespace pollution) and make sure extensions are        // grouped together in their own source file (e.g., StringExtensions.cs); however these items do apply to all items        // and are essentially type-less hence their location in the "Common" class. These extension methods are at least        // limited to classes and won't show up on native types and custom structs.         /// <summary>        /// Converts value to string; null objects (or DBNull objects) will return an empty string ("").         /// </summary>        /// <typeparam name="T"><see cref="Type"/> of <see cref="Object"/> to convert to string.</typeparam>        /// <param name="value">Value to convert to string.</param>        /// <returns><paramref name="value"/> as a string; if <paramref name="value"/> is null, empty string ("") will be returned. </returns>        public static string ToNonNullString<T>(this T value) where T : class        {            return ((object)value == null || value == DBNull.Value ? "" : value.ToString());        }         /// <summary>        /// Converts value to string; null objects (or DBNull objects) will return specified <paramref name="nonNullValue"/>.        /// </summary>        /// <typeparam name="T"><see cref="Type"/> of <see cref="Object"/> to convert to string.</typeparam>        /// <param name="value">Value to convert to string.</param>        /// <param name="nonNullValue"><see cref="String"/> to return if <paramref name="value"/> is null.</param>        /// <returns><paramref name="value"/> as a string; if <paramref name="value"/> is null, <paramref name="nonNullValue"/> will be returned.</returns>        /// <exception cref="ArgumentNullException"><paramref name="nonNullValue"/> cannot be null.</exception>        public static string ToNonNullString<T>(this T value, string nonNullValue) where T : class        {            if ((object)nonNullValue == null)                throw new ArgumentNullException("nonNullValue");             return ((object)value == null || value == DBNull.Value ? nonNullValue : value.ToString());        }         // We handle strings as a special version of the ToNullNullString extension to handle documentation a little differently         /// <summary>        /// Makes sure returned string value is not null; if this string is null, empty string ("") will be returned.         /// </summary>        /// <param name="value"><see cref="String"/> to verify is not null.</param>        /// <returns><see cref="String"/> value; if <paramref name="value"/> is null, empty string ("") will be returned.</returns>        public static string ToNonNullString(this string value)        {            return ((object)value == null ? "" : value);        }         /// <summary>        /// Converts value to string; null objects, DBNull objects or empty strings will return specified <paramref name="nonNullNorEmptyValue"/>.        /// </summary>        /// <typeparam name="T"><see cref="Type"/> of <see cref="Object"/> to convert to string.</typeparam>        /// <param name="value">Value to convert to string.</param>        /// <param name="nonNullNorEmptyValue"><see cref="String"/> to return if <paramref name="value"/> is null.</param>        /// <returns><paramref name="value"/> as a string; if <paramref name="value"/> is null, DBNull or an empty string <paramref name="nonNullNorEmptyValue"/> will be returned.</returns>        /// <exception cref="ArgumentException"><paramref name="nonNullNorEmptyValue"/> must not be null or an empty string.</exception>        public static string ToNonNullNorEmptyString<T>(this T value, string nonNullNorEmptyValue) where T : class        {            if (string.IsNullOrEmpty(nonNullNorEmptyValue))                throw new ArgumentException("Must not be null or an empty string", "nonNullNorEmptyValue");             if ((object)value == null || value == DBNull.Value)                return nonNullNorEmptyValue;             string valueAsString = value.ToString();             return (string.IsNullOrEmpty(valueAsString) ? nonNullNorEmptyValue : valueAsString);        }         /// <summary>        /// Converts value to string; null objects, DBNull objects, empty strings or all white space strings will return specified <paramref name="nonNullNorWhiteSpaceValue"/>.        /// </summary>        /// <typeparam name="T"><see cref="Type"/> of <see cref="Object"/> to convert to string.</typeparam>        /// <param name="value">Value to convert to string.</param>        /// <param name="nonNullNorWhiteSpaceValue"><see cref="String"/> to return if <paramref name="value"/> is null.</param>        /// <returns><paramref name="value"/> as a string; if <paramref name="value"/> is null, DBNull, empty or all white space, <paramref name="nonNullNorWhiteSpaceValue"/> will be returned.</returns>        /// <exception cref="ArgumentException"><paramref name="nonNullNorWhiteSpaceValue"/> must not be null, an empty string or white space.</exception>        public static string ToNonNullNorWhiteSpace<T>(this T value, string nonNullNorWhiteSpaceValue) where T : class        {            if (nonNullNorWhiteSpaceValue.IsNullOrWhiteSpace())                throw new ArgumentException("Must not be null, an empty string or white space", "nonNullNorWhiteSpaceValue");             if ((object)value == null || value == DBNull.Value)                return nonNullNorWhiteSpaceValue;             string valueAsString = value.ToString();             return (valueAsString.IsNullOrWhiteSpace() ? nonNullNorWhiteSpaceValue : valueAsString);        }         /// <summary>        /// Converts <paramref name="value"/> to a <see cref="String"/> using an appropriate <see cref="TypeConverter"/>.        /// </summary>        /// <param name="value">Value to convert to a <see cref="String"/>.</param>        /// <returns><paramref name="value"/> converted to a <see cref="String"/>.</returns>        /// <remarks>        /// <para>        /// If <see cref="TypeConverter"/> fails, the value's <c>ToString()</c> value will be returned.        /// Returned value will never be null, if no value exists an empty string ("") will be returned.        /// </para>        /// <para>        /// You can use the <see cref="StringExtensions.ConvertToType{T}(string)"/> string extension method to        /// convert the string back to its original <see cref="Type"/>.        /// </para>        /// </remarks>        public static string TypeConvertToString(object value)        {            return TypeConvertToString(value, null);        }         /// <summary>        /// Converts <paramref name="value"/> to a <see cref="String"/> using an appropriate <see cref="TypeConverter"/>.        /// </summary>        /// <param name="value">Value to convert to a <see cref="String"/>.</param>        /// <param name="culture"><see cref="CultureInfo"/> to use for the conversion.</param>        /// <returns><paramref name="value"/> converted to a <see cref="String"/>.</returns>        /// <remarks>        /// <para>        /// If <see cref="TypeConverter"/> fails, the value's <c>ToString()</c> value will be returned.        /// Returned value will never be null, if no value exists an empty string ("") will be returned.        /// </para>        /// <para>        /// You can use the <see cref="StringExtensions.ConvertToType{T}(string)"/> string extension method to        /// convert the string back to its original <see cref="Type"/>.        /// </para>        /// </remarks>        public static string TypeConvertToString(object value, CultureInfo culture)        {            // Don't proceed further if value is null.            if ((object)value == null)                return string.Empty;             // If value is already a string, no need to attempt conversion            if (value is string)                return value as string;             // Initialize culture info if not specified.            if ((object)culture == null)                culture = CultureInfo.InvariantCulture;             try            {                // Attempt to use type converter to set field value                TypeConverter converter = TypeDescriptor.GetConverter(value);                return converter.ConvertToString(null, culture, value).ToNonNullString();            }            catch            {                // Otherwise just call object's ToString method                return value.ToNonNullString();            }        }         /// <summary>Gets a high-resolution number of seconds, including fractional seconds, that have        /// elapsed since 12:00:00 midnight, January 1, 0001.</summary>        public static double SystemTimer        {            get            {                return Ticks.ToSeconds(PrecisionTimer.Now.Ticks);            }        }         /// <summary>Determines if given item is equal to its default value (e.g., null or 0.0).</summary>        /// <param name="item">Object to evaluate.</param>        /// <returns>Result of evaluation as a <see cref="bool"/>.</returns>        /// <remarks>        /// Native types default to zero, not null, therefore this can be used to evaulate if an item is its default (i.e., uninitialized) value.        /// </remarks>        public static bool IsDefaultValue(object item)        {            // Only reference types can be null, therefore null is its default value            if ((object)item == null)                return true;             Type itemType = item.GetType();             if (itemType.IsValueType)            {                // Handle common types                IConvertible convertible = item as IConvertible;                 if ((object)convertible != null)                {                    switch (convertible.GetTypeCode())                    {                        case TypeCode.Boolean:                            return ((bool)item == default(bool));                        case TypeCode.SByte:                            return ((sbyte)item == default(sbyte));                        case TypeCode.Byte:                            return ((byte)item == default(byte));                        case TypeCode.Int16:                            return ((short)item == default(short));                        case TypeCode.UInt16:                            return ((ushort)item == default(ushort));                        case TypeCode.Int32:                            return ((int)item == default(int));                        case TypeCode.UInt32:                            return ((uint)item == default(uint));                        case TypeCode.Int64:                            return ((long)item == default(long));                        case TypeCode.UInt64:                            return ((ulong)item == default(ulong));                        case TypeCode.Single:                            return ((float)item == default(float));                        case TypeCode.Double:                            return ((double)item == default(double));                        case TypeCode.Decimal:                            return ((decimal)item == default(decimal));                        case TypeCode.Char:                            return ((char)item == default(char));                        case TypeCode.DateTime:                            return ((DateTime)item == default(DateTime));                    }                } 

Lines 1–500 of 648.

Keyboard shortcuts

General

Show keyboard shortcuts
?
Focus the current search
/

Issues and pull requests

Open filters
f

Issues, pull requests and Inbox

Select next item
j↓
Select previous item
k↑
Open selected item
Enter
Dismiss filters or clear selection
Esc

Repository code

Go to file
t