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 \ CompareInfo

SSCLI

// ==++==
//
//
//
// The use and distribution terms for this software are contained in the file
// named license.txt, which can be found in the root of this distribution.
// By using this software in any fashion, you are agreeing to be bound by the
// terms of this license.
//
// You must not remove this notice, or any other, from this software.
//
//
// ==--==
////////////////////////////////////////////////////////////////////////////
//
// Class: CompareInfo
//
//
// Purpose: This class implements a set of methods for comparing
// strings.
//
// Date: August 12, 1998
//
////////////////////////////////////////////////////////////////////////////
namespace System.Globalization
{
//
// We're dependent on the m_pSortingTable getting created when an instance of the
// class is initialized (through a call to InitializeCompareInfo). When in
// native, we assume that the table has already been allocated. we may decide
// to delay-allocate any of the tables (as we may do for US English)//
// System.Globalization.SortKey also uses the m_pSortingTables. Currently the only
// way to get a SortKey is to call through CompareInfo, which means that the table
// has already been initialized. If this invariant changes, SortKey's constructor
// needs to call InitializedSortingTable (which can safely be called multiple times
// for the same locale.)
//
using System;
using System.Collections;
using System.Reflection;
using System.Runtime.Serialization;
using System.Runtime.CompilerServices;
using System.Runtime.ConstrainedExecution;
using System.Threading;
using System.Security.Permissions;
using System.Runtime.InteropServices;
using Microsoft.Win32;
//
// Options can be used during string comparison.
//
// Native implementation (COMNlsInfo.cpp & SortingTable.cpp) relies on the values of these,
// If you change the values below, be sure to change the values in native part as well.
//
[Flags(), Serializable()]
[System.Runtime.InteropServices.ComVisible(true)]
public enum CompareOptions
{
None = 0,
IgnoreCase = 1,
IgnoreNonSpace = 2,
IgnoreSymbols = 4,
IgnoreKanaType = 8,
// ignore kanatype
IgnoreWidth = 16,
// ignore width
OrdinalIgnoreCase = 268435456,
// This flag can not be used with other flags.
StringSort = 536870912,
// use string sort method
Ordinal = 1073741824
// This flag can not be used with other flags.
// StopOnNull = 0x10000000,
// StopOnNull is defined in SortingTable.h, but we didn't enable this option here.
// Do not use this value for other flags accidentally.
}
[Serializable()]
[System.Runtime.InteropServices.ComVisible(true)]
public class CompareInfo : IDeserializationCallback
{
// Mask used to check if IndexOf()/LastIndexOf()/IsPrefix()/IsPostfix() has the right flags.
private const CompareOptions ValidIndexMaskOffFlags = ~(CompareOptions.IgnoreCase | CompareOptions.IgnoreSymbols | CompareOptions.IgnoreNonSpace | CompareOptions.IgnoreWidth | CompareOptions.IgnoreKanaType);
// Mask used to check if Compare() has the right flags.
private const CompareOptions ValidCompareMaskOffFlags = ~(CompareOptions.IgnoreCase | CompareOptions.IgnoreSymbols | CompareOptions.IgnoreNonSpace | CompareOptions.IgnoreWidth | CompareOptions.IgnoreKanaType | CompareOptions.StringSort);
// Mask used to check if GetHashCodeOfString() has the right flags.
private const CompareOptions ValidHashCodeOfStringMaskOffFlags = ~(CompareOptions.IgnoreCase | CompareOptions.IgnoreSymbols | CompareOptions.IgnoreNonSpace | CompareOptions.IgnoreWidth | CompareOptions.IgnoreKanaType);
[MethodImplAttribute(MethodImplOptions.InternalCall)]
unsafe static internal extern byte[] nativeCreateSortKey(void* pSortingFile, string pString, int dwFlags, int win32LCID);
[MethodImplAttribute(MethodImplOptions.InternalCall)]
unsafe static internal extern int nativeGetGlobalizedHashCode(void* pSortingFile, string pString, int dwFlags, int win32LCID);
[MethodImplAttribute(MethodImplOptions.InternalCall)]
unsafe static internal extern bool nativeIsSortable(void* pSortingFile, string pString);
// <SyntheticSupport/>
[MethodImplAttribute(MethodImplOptions.InternalCall)]
static internal extern int nativeCompareString(int lcid, string string1, int offset1, int length1, string string2, int offset2, int length2, int flags);
// Private object for locking instead of locking on a public type for SQL reliability work.
private static object s_InternalSyncObject;
private static object InternalSyncObject {
get {
if (s_InternalSyncObject == null) {
object o = new object();
Interlocked.CompareExchange(ref s_InternalSyncObject, o, null);
}
return s_InternalSyncObject;
}
}
/*=================================GetCompareInfo==========================
**Action: Get the CompareInfo constructed from the data table in the specified assembly for the specified culture.
** The purpose of this method is to provide versioning for CompareInfo tables.
** If you pass Assembly which contains different sorting table, you will sort your strings using the data
** in the assembly.
**Returns: The CompareInfo for the specified culture.
**Arguments:
** culture the ID of the culture
** assembly the assembly which contains the sorting table.
**Exceptions:
** ArugmentNullException when the assembly is null
** ArgumentException if culture is invalid.
============================================================================*/
/* The design goal here is that we can still provide version even when the underlying algorithm for CompareInfo
is totally changed in the future.
In the case that the algorithm for CompareInfo is changed, we can use this method to
provide the old algorithm for the old tables. The idea is to change the implementation for GetCompareInfo()
to something like:
1. Check the ID of the assembly.
2. If the assembly needs old code, create an instance of the old CompareInfo class. The name of CompareInfo
will be like CompareInfoVersion1 and extends from CompareInfo.
3. Otherwise, create an instance of the current CompareInfo.
The CompareInfo ctor always provides the implementation for the current data table.
*/
public static CompareInfo GetCompareInfo(int culture, Assembly assembly)
{
// Parameter checking.
if (assembly == null) {
throw new ArgumentNullException("assembly");
}
if (CultureTableRecord.IsCustomCultureId(culture)) {
// Customized culture cannot be created by the LCID.
throw new ArgumentException(Environment.GetResourceString("Argument_CustomCultureCannotBePassedByNumber", "culture"));
}
if (assembly != typeof(object).Module.Assembly) {
throw new ArgumentException(Environment.GetResourceString("Argument_OnlyMscorlib"));
}
// culture is verified to see if it is valid when CompareInfo is constructed.
GlobalizationAssembly ga = GlobalizationAssembly.GetGlobalizationAssembly(assembly);
object compInfo = ga.compareInfoCache[culture];
if (compInfo == null) {
lock (InternalSyncObject) {
//
// Re-check again to make sure that no one has created the CompareInfo for the culture yet before the current
// thread enters this sync block.
//
if ((compInfo = ga.compareInfoCache[culture]) == null) {
compInfo = new CompareInfo(ga, culture);
System.Threading.Thread.MemoryBarrier();
ga.compareInfoCache[culture] = compInfo;
}
}
}
return ((CompareInfo)compInfo);
}
//
// GetCompareInfoByName get CompareInfo object using the name. it is the shared code
// between GetCompareInfo(name) and GetCompareInfo(name, assembly)
//
private const int TraditionalChineseCultureId = 31748;
private const int HongKongCultureId = 3076;
private static CompareInfo GetCompareInfoByName(string name, Assembly assembly)
{
CultureInfo cultureInfo = CultureInfo.GetCultureInfo(name);
if (cultureInfo.IsNeutralCulture && !CultureTableRecord.IsCustomCultureId(cultureInfo.cultureID)) {
if (cultureInfo.cultureID == TraditionalChineseCultureId)
cultureInfo = CultureInfo.GetCultureInfo(HongKongCultureId);
else
cultureInfo = CultureInfo.GetCultureInfo(cultureInfo.CompareInfoId);
}
CompareInfo compareInfo;
if (assembly != null)
compareInfo = GetCompareInfo(cultureInfo.CompareInfoId, assembly);
else
compareInfo = GetCompareInfo(cultureInfo.CompareInfoId);
// Compare info name is known by the cultureInfo
compareInfo.m_name = cultureInfo.SortName;
return compareInfo;
}
/*=================================GetCompareInfo==========================
**Action: Get the CompareInfo constructed from the data table in the specified assembly for the specified culture.
** The purpose of this method is to provide version for CompareInfo tables.
**Returns: The CompareInfo for the specified culture.
**Arguments:
** name the name of the culture
** assembly the assembly which contains the sorting table.
**Exceptions:
** ArugmentNullException when the assembly is null
** ArgumentException if name is invalid.
============================================================================*/
public static CompareInfo GetCompareInfo(string name, Assembly assembly)
{
if (name == null || assembly == null) {
throw new ArgumentNullException(name == null ? "name" : "assembly");
}
if (assembly != typeof(object).Module.Assembly) {
throw new ArgumentException(Environment.GetResourceString("Argument_OnlyMscorlib"));
}
return GetCompareInfoByName(name, assembly);
}
/*=================================GetCompareInfo==========================
**Action: Get the CompareInfo for the specified culture.
** This method is provided for ease of integration with NLS-based software.
**Returns: The CompareInfo for the specified culture.
**Arguments:
** culture the ID of the culture.
**Exceptions:
** ArgumentException if culture is invalid.
**Notes:
** We optimize in the default case. We don't go thru the GlobalizationAssembly hashtable.
** Instead, we access the m_defaultInstance directly.
============================================================================*/
public static CompareInfo GetCompareInfo(int culture)
{
if (CultureTableRecord.IsCustomCultureId(culture)) {
// Customized culture cannot be created by the LCID.
throw new ArgumentException(Environment.GetResourceString("Argument_CustomCultureCannotBePassedByNumber", "culture"));
}
// culture is verified to see if it is valid when CompareInfo is constructed.
object compInfo = GlobalizationAssembly.DefaultInstance.compareInfoCache[culture];
if (compInfo == null) {
lock (InternalSyncObject) {
//
// Re-check again to make sure that no one has created the CompareInfo for the culture yet before the current
// thread enters this sync block.
//
if ((compInfo = GlobalizationAssembly.DefaultInstance.compareInfoCache[culture]) == null) {
compInfo = new CompareInfo(GlobalizationAssembly.DefaultInstance, culture);
System.Threading.Thread.MemoryBarrier();
GlobalizationAssembly.DefaultInstance.compareInfoCache[culture] = compInfo;
}
}
}
return ((CompareInfo)compInfo);
}
/*=================================GetCompareInfo==========================
**Action: Get the CompareInfo for the specified culture.
**Returns: The CompareInfo for the specified culture.
**Arguments:
** name the name of the culture.
**Exceptions:
** ArgumentException if name is invalid.
============================================================================*/
public static CompareInfo GetCompareInfo(string name)
{
if (name == null) {
throw new ArgumentNullException("name");
}
return GetCompareInfoByName(name, null);
}
[System.Runtime.InteropServices.ComVisible(false)]
public static bool IsSortable(char ch)
{
return (IsSortable(ch.ToString()));
}
[System.Runtime.InteropServices.ComVisible(false)]
public static bool IsSortable(string text)
{
if (text == null) {
// A null param is invalid here.
throw new ArgumentNullException("text");
}
if (0 == text.Length) {
// A zero length string is not invalid, but it is also not sortable.
return (false);
}
unsafe {
return (nativeIsSortable(CultureInfo.InvariantCulture.CompareInfo.m_pSortingTable, text));
}
}
#region Serialization
private int win32LCID;
// mapped sort culture id of this instance
private int culture;
// the culture ID used to create this instance.
[OnDeserializing()]
private void OnDeserializing(StreamingContext ctx)
{
this.culture = -1;
this.m_sortingLCID = -1;
}
unsafe private void OnDeserialized()
{
BCLDebug.Assert(this.culture >= 0, "[CompareInfo.OnDeserialized] - culture >= 0");
// Get the Win32 LCID used to create NativeCompareInfo, which only takes Win32 LCID.
if (m_sortingLCID <= 0) {
m_sortingLCID = GetSortingLCID(this.culture);
}
if (m_pSortingTable == null && !IsSynthetic) {
m_pSortingTable = InitializeCompareInfo(GlobalizationAssembly.DefaultInstance.pNativeGlobalizationAssembly, this.m_sortingLCID);
}
BCLDebug.Assert(IsSynthetic || m_pSortingTable != null, "m_pSortingTable != null");
// m_name is intialized later if it not exist in the serialization stream
}
[OnDeserialized()]
private void OnDeserialized(StreamingContext ctx)
{
OnDeserialized();
}
[OnSerializing()]
private void OnSerializing(StreamingContext ctx)
{
win32LCID = m_sortingLCID;
}
#endregion Serialization
///////////////////////////----- Name -----/////////////////////////////////
//
// Returns the name of the culture (well actually, of the sort).
// Very important for providing a non-LCID way of identifying
// what the sort is.
//
////////////////////////////////////////////////////////////////////////
[System.Runtime.InteropServices.ComVisible(false)]
public virtual string Name {
get {
if (m_name == null) {
m_name = CultureInfo.GetCultureInfo(culture).SortName;
}
return (m_name);
}
}
internal void SetName(string name)
{
m_name = name;
}
static internal void ClearDefaultAssemblyCache()
{
lock (InternalSyncObject) {
GlobalizationAssembly.DefaultInstance.compareInfoCache = new Hashtable(4);
}
}
internal CultureTableRecord CultureTableRecord {
get {
if (m_cultureTableRecord == null) {
m_cultureTableRecord = CultureInfo.GetCultureInfo(this.m_sortingLCID).m_cultureTableRecord;
}
return m_cultureTableRecord;
}
}
// <SyntheticSupport/>
private bool IsSynthetic {
get { return CultureTableRecord.IsSynthetic; }
}
//
// pSortingTable is a 32-bit pointer value pointing to a native C++ SortingTable object.
//
[NonSerialized()]
unsafe internal void* m_pSortingTable;
[NonSerialized()]
private int m_sortingLCID;
// mapped sort culture id of this instance
[NonSerialized()]
private CultureTableRecord m_cultureTableRecord;
[OptionalField(VersionAdded = 2)]
private string m_name = null;
// The name of the culture of this instance
////////////////////////////////////////////////////////////////////////
//
// CompareInfo Constructor
//
//
////////////////////////////////////////////////////////////////////////
// Constructs an instance that most closely corresponds to the NLS locale
// identifier.
unsafe internal CompareInfo(GlobalizationAssembly ga, int culture)
{
if (culture < 0) {
throw new ArgumentOutOfRangeException("culture", Environment.GetResourceString("ArgumentOutOfRange_NeedPosNum"));
}
// Get the Win32 LCID used to create NativeCompareInfo, which only takes Win32 LCID.
this.m_sortingLCID = GetSortingLCID(culture);
// If version support is enabled, InitializeCompareInfo should use ga instead of getting the default
// instance.
// Call to the native side to create/get the corresponding native C++ SortingTable for this culture.
// The returned value is a 32-bit pointer to the native C++ SortingTable instance.
// We cache this pointer so that we can call methods of the SortingTable directly.
if (!IsSynthetic) {
m_pSortingTable = InitializeCompareInfo(GlobalizationAssembly.DefaultInstance.pNativeGlobalizationAssembly, this.m_sortingLCID);
}
// Since this.m_sortingLCID can be different from the passed-in culture in the case of neutral cultures, store the culture ID in a different place.
this.culture = culture;
}
internal int GetSortingLCID(int culture)
{
int sortingLCID = 0;
//
// Verify that this is a valid culture.
//
CultureInfo cultureObj = CultureInfo.GetCultureInfo(culture);
sortingLCID = cultureObj.CompareInfoId;
int sortID = CultureInfo.GetSortID(culture);
if (sortID != 0) {
// Need to verify if the Sort ID is valid.
if (!cultureObj.m_cultureTableRecord.IsValidSortID(sortID)) {
throw new ArgumentException(String.Format(CultureInfo.CurrentCulture, Environment.GetResourceString("Argument_CultureNotSupported"), culture), "culture");
}
// This is an alterinative sort LCID. Hey man, don't forget to take your SORTID with you.
sortingLCID |= sortID << 16;
}
return (sortingLCID);
}
////////////////////////////////////////////////////////////////////////
//
// Compare
//
// Compares the two strings with the given options. Returns 0 if the
// two strings are equal, a number less than 0 if string1 is less
// than string2, and a number greater than 0 if string1 is greater
// than string2.
//
////////////////////////////////////////////////////////////////////////
public virtual int Compare(string string1, string string2)
{
return (Compare(string1, string2, CompareOptions.None));
}
unsafe public virtual int Compare(string string1, string string2, CompareOptions options)
{
if (options == CompareOptions.OrdinalIgnoreCase) {
return String.Compare(string1, string2, StringComparison.OrdinalIgnoreCase);
}
// Verify the options before we do any real comparison.
if ((options & CompareOptions.Ordinal) != 0) {
if (options == CompareOptions.Ordinal) {
//Our paradigm is that null sorts less than any other string and
//that two nulls sort as equal.
if (string1 == null) {
if (string2 == null) {
return (0);
// Equal
}
return (-1);
// null < non-null
}
if (string2 == null) {
return (1);
// non-null > null
}
return String.nativeCompareOrdinal(string1, string2, false);
}
else {
throw new ArgumentException(Environment.GetResourceString("Argument_CompareOptionOrdinal"), "options");
}
}
if ((options & ValidCompareMaskOffFlags) != 0) {
throw new ArgumentException(Environment.GetResourceString("Argument_InvalidFlag"), "options");
}
//Our paradigm is that null sorts less than any other string and
//that two nulls sort as equal.
if (string1 == null) {
if (string2 == null) {
return (0);
// Equal
}
return (-1);
// null < non-null
}
if (string2 == null) {
return (1);
// non-null > null
}
return (Compare(m_pSortingTable, this.m_sortingLCID, string1, string2, options));
}
// This native method will check the parameters and validate them accordingly.
// COMNlsInfo::Compare
[MethodImplAttribute(MethodImplOptions.InternalCall)]
unsafe private static extern int Compare(void* pSortingTable, int sortingLCID, string string1, string string2, CompareOptions options);
////////////////////////////////////////////////////////////////////////
//
// Compare
//
// Compares the specified regions of the two strings with the given
// options.
// Returns 0 if the two strings are equal, a number less than 0 if
// string1 is less than string2, and a number greater than 0 if
// string1 is greater than string2.
//
////////////////////////////////////////////////////////////////////////
unsafe public virtual int Compare(string string1, int offset1, int length1, string string2, int offset2, int length2)
{
return Compare(string1, offset1, length1, string2, offset2, length2, 0);
}
unsafe public virtual int Compare(string string1, int offset1, string string2, int offset2, CompareOptions options)
{
return Compare(string1, offset1, string1 == null ? 0 : string1.Length - offset1, string2, offset2, string2 == null ? 0 : string2.Length - offset2, options);
}
unsafe public virtual int Compare(string string1, int offset1, string string2, int offset2)
{
return Compare(string1, offset1, string2, offset2, 0);
}
unsafe public virtual int Compare(string string1, int offset1, int length1, string string2, int offset2, int length2, CompareOptions options)
{
if (options == CompareOptions.OrdinalIgnoreCase) {
int result = String.Compare(string1, offset1, string2, offset2, length1 < length2 ? length1 : length2, StringComparison.OrdinalIgnoreCase);
if ((length1 != length2) && result == 0)
return (length1 > length2 ? 1 : -1);
return (result);
}
// Verifiy inputs
if (length1 < 0 || length2 < 0) {
throw new ArgumentOutOfRangeException((length1 < 0) ? "length1" : "length2", Environment.GetResourceString("ArgumentOutOfRange_NeedPosNum"));
}
if (offset1 < 0 || offset2 < 0) {
throw new ArgumentOutOfRangeException((offset1 < 0) ? "offset1" : "offset2", Environment.GetResourceString("ArgumentOutOfRange_NeedPosNum"));
}
if (offset1 > (string1 == null ? 0 : string1.Length) - length1) {
throw new ArgumentOutOfRangeException("string1", Environment.GetResourceString("ArgumentOutOfRange_OffsetLength"));
}
if (offset2 > (string2 == null ? 0 : string2.Length) - length2) {
throw new ArgumentOutOfRangeException("string2", Environment.GetResourceString("ArgumentOutOfRange_OffsetLength"));
}
if ((options & CompareOptions.Ordinal) != 0) {
if (options == CompareOptions.Ordinal) {
//
// Check for the null case.
//
if (string1 == null) {
if (string2 == null) {
return (0);
}
return (-1);
}
if (string2 == null) {
return (1);
}
int result = String.nativeCompareOrdinalEx(string1, offset1, string2, offset2, (length1 < length2 ? length1 : length2));
if ((length1 != length2) && result == 0) {
return (length1 > length2 ? 1 : -1);
}
return (result);
}
else {
throw new ArgumentException(Environment.GetResourceString("Argument_CompareOptionOrdinal"), "options");
}
}
if ((options & ValidCompareMaskOffFlags) != 0) {
throw new ArgumentException(Environment.GetResourceString("Argument_InvalidFlag"), "options");
}
//
// Check for the null case.
//
if (string1 == null) {
if (string2 == null) {
return (0);
}
return (-1);
}
if (string2 == null) {
return (1);
}
// Call native code to do comparison
return (CompareRegion(m_pSortingTable, this.m_sortingLCID, string1, offset1, length1, string2, offset2, length2, options));
}
// This native method will check the parameters and validate them accordingly.
// Native method: COMNlsInfo::CompareRegion
[MethodImplAttribute(MethodImplOptions.InternalCall)]
unsafe private static extern int CompareRegion(void* pSortingTable, int sortingLCID, string string1, int offset1, int length1, string string2, int offset2, int length2, CompareOptions options);
////////////////////////////////////////////////////////////////////////
//
// IsPrefix
//
// Determines whether prefix is a prefix of string. If prefix equals
// String.Empty, true is returned.
//
////////////////////////////////////////////////////////////////////////
unsafe public virtual bool IsPrefix(string source, string prefix, CompareOptions options)
{
if (source == null || prefix == null) {
throw new ArgumentNullException((source == null ? "source" : "prefix"), Environment.GetResourceString("ArgumentNull_String"));
}
int prefixLen = prefix.Length;
if (prefixLen == 0) {
return (true);
}
if (options == CompareOptions.OrdinalIgnoreCase) {
return source.StartsWith(prefix, StringComparison.OrdinalIgnoreCase);
}
if ((options & ValidIndexMaskOffFlags) != 0 && (options != CompareOptions.Ordinal)) {
throw new ArgumentException(Environment.GetResourceString("Argument_InvalidFlag"), "options");
}
return (nativeIsPrefix(m_pSortingTable, this.m_sortingLCID, source, prefix, options));
}
[MethodImplAttribute(MethodImplOptions.InternalCall)]
unsafe private static extern bool nativeIsPrefix(void* pSortingTable, int sortingLCID, string source, string prefix, CompareOptions options);
public virtual bool IsPrefix(string source, string prefix)
{
return (IsPrefix(source, prefix, 0));
}
////////////////////////////////////////////////////////////////////////
//
// IsSuffix
//
// Determines whether suffix is a suffix of string. If suffix equals
// String.Empty, true is returned.
//
////////////////////////////////////////////////////////////////////////
unsafe public virtual bool IsSuffix(string source, string suffix, CompareOptions options)
{
if (source == null || suffix == null) {
throw new ArgumentNullException((source == null ? "source" : "suffix"), Environment.GetResourceString("ArgumentNull_String"));
}
int suffixLen = suffix.Length;
if (suffixLen == 0) {
return (true);
}
if (options == CompareOptions.OrdinalIgnoreCase) {
return source.EndsWith(suffix, StringComparison.OrdinalIgnoreCase);
}
if ((options & ValidIndexMaskOffFlags) != 0 && (options != CompareOptions.Ordinal)) {
throw new ArgumentException(Environment.GetResourceString("Argument_InvalidFlag"), "options");
}
return (nativeIsSuffix(m_pSortingTable, this.m_sortingLCID, source, suffix, options));
}
public virtual bool IsSuffix(string source, string suffix)
{
return (IsSuffix(source, suffix, 0));
}
[MethodImplAttribute(MethodImplOptions.InternalCall)]
unsafe private static extern bool nativeIsSuffix(void* pSortingTable, int sortingLCID, string source, string prefix, CompareOptions options);
////////////////////////////////////////////////////////////////////////
//
// IndexOf
//
// Returns the first index where value is found in string. The
// search starts from startIndex and ends at endIndex. Returns -1 if
// the specified value is not found. If value equals String.Empty,
// startIndex is returned. Throws IndexOutOfRange if startIndex or
// endIndex is less than zero or greater than the length of string.
// Throws ArgumentException if value is null.
//
////////////////////////////////////////////////////////////////////////
unsafe public virtual int IndexOf(string source, char value)
{
if (source == null)
throw new ArgumentNullException("source");
return IndexOf(source, value, 0, source.Length, CompareOptions.None);
}
unsafe public virtual int IndexOf(string source, string value)
{
if (source == null)
throw new ArgumentNullException("source");
return IndexOf(source, value, 0, source.Length, CompareOptions.None);
}
unsafe public virtual int IndexOf(string source, char value, CompareOptions options)
{
if (source == null)
throw new ArgumentNullException("source");
return IndexOf(source, value, 0, source.Length, options);
}
unsafe public virtual int IndexOf(string source, string value, CompareOptions options)
{
if (source == null)
throw new ArgumentNullException("source");
return IndexOf(source, value, 0, source.Length, options);
}
unsafe public virtual int IndexOf(string source, char value, int startIndex)
{
if (source == null)
throw new ArgumentNullException("source");
return IndexOf(source, value, startIndex, source.Length - startIndex, CompareOptions.None);
}
unsafe public virtual int IndexOf(string source, string value, int startIndex)
{
if (source == null)
throw new ArgumentNullException("source");
return IndexOf(source, value, startIndex, source.Length - startIndex, CompareOptions.None);
}
unsafe public virtual int IndexOf(string source, char value, int startIndex, CompareOptions options)
{
if (source == null)
throw new ArgumentNullException("source");
return IndexOf(source, value, startIndex, source.Length - startIndex, options);
}
unsafe public virtual int IndexOf(string source, string value, int startIndex, CompareOptions options)
{
if (source == null)
throw new ArgumentNullException("source");
return IndexOf(source, value, startIndex, source.Length - startIndex, options);
}
unsafe public virtual int IndexOf(string source, char value, int startIndex, int count)
{
return IndexOf(source, value, startIndex, count, CompareOptions.None);
}
unsafe public virtual int IndexOf(string source, string value, int startIndex, int count)
{
return IndexOf(source, value, startIndex, count, CompareOptions.None);
}
unsafe public virtual int IndexOf(string source, char value, int startIndex, int count, CompareOptions options)
{
// Validate inputs
if (source == null)
throw new ArgumentNullException("source");
if (startIndex < 0 || startIndex > source.Length)
throw new ArgumentOutOfRangeException("startIndex", Environment.GetResourceString("ArgumentOutOfRange_Index"));
if (count < 0 || startIndex > source.Length - count)
throw new ArgumentOutOfRangeException("count", Environment.GetResourceString("ArgumentOutOfRange_Count"));
if (options == CompareOptions.OrdinalIgnoreCase) {
return TextInfo.nativeIndexOfCharOrdinalIgnoreCase(TextInfo.InvariantNativeTextInfo, source, value, startIndex, count);
}
// Validate CompareOptions
// Ordinal can't be selected with other flags
if ((options & ValidIndexMaskOffFlags) != 0 && (options != CompareOptions.Ordinal))
throw new ArgumentException(Environment.GetResourceString("Argument_InvalidFlag"), "options");
return IndexOfChar(m_pSortingTable, this.m_sortingLCID, source, value, startIndex, count, (int)options);
}
unsafe public virtual int IndexOf(string source, string value, int startIndex, int count, CompareOptions options)
{
// Validate inputs
if (source == null)
throw new ArgumentNullException("source");
if (value == null)
throw new ArgumentNullException("value");
if (startIndex > source.Length) {
throw new ArgumentOutOfRangeException("startIndex", Environment.GetResourceString("ArgumentOutOfRange_Index"));
}
if (source.Length == 0) {
if (value.Length == 0) {
return 0;
}
return -1;
}
if (startIndex < 0) {
throw new ArgumentOutOfRangeException("startIndex", Environment.GetResourceString("ArgumentOutOfRange_Index"));
}
if (count < 0 || startIndex > source.Length - count)
throw new ArgumentOutOfRangeException("count", Environment.GetResourceString("ArgumentOutOfRange_Count"));
if (options == CompareOptions.OrdinalIgnoreCase) {
return TextInfo.IndexOfStringOrdinalIgnoreCase(source, value, startIndex, count);
}
// Validate CompareOptions
// Ordinal can't be selected with other flags
if ((options & ValidIndexMaskOffFlags) != 0 && (options != CompareOptions.Ordinal))
throw new ArgumentException(Environment.GetResourceString("Argument_InvalidFlag"), "options");
return IndexOfString(m_pSortingTable, this.m_sortingLCID, source, value, startIndex, count, (int)options);
}
// This native method will check the parameters and validate them accordingly.
// Native method: COMNlsInfo::IndexOfChar
[MethodImplAttribute(MethodImplOptions.InternalCall)]
unsafe private static extern int IndexOfChar(void* pSortingTable, int sortingLCID, string source, char value, int startIndex, int count, int options);
// This native method will check the parameters and validate them accordingly.
// Native method: COMNlsInfo::IndexOfString
[MethodImplAttribute(MethodImplOptions.InternalCall)]
unsafe private static extern int IndexOfString(void* pSortingTable, int sortingLCID, string source, string value, int startIndex, int count, int options);
////////////////////////////////////////////////////////////////////////
//
// LastIndexOf
//
// Returns the last index where value is found in string. The
// search starts from startIndex and ends at endIndex. Returns -1 if
// the specified value is not found. If value equals String.Empty,
// endIndex is returned. Throws IndexOutOfRange if startIndex or
// endIndex is less than zero or greater than the length of string.
// Throws ArgumentException if value is null.
//
////////////////////////////////////////////////////////////////////////
unsafe public virtual int LastIndexOf(string source, char value)
{
if (source == null)
throw new ArgumentNullException("source");
// Can't start at negative index, so make sure we check for the length == 0 case.
return LastIndexOf(source, value, source.Length - 1, source.Length, CompareOptions.None);
}
unsafe public virtual int LastIndexOf(string source, string value)
{
if (source == null)
throw new ArgumentNullException("source");
// Can't start at negative index, so make sure we check for the length == 0 case.
return LastIndexOf(source, value, source.Length - 1, source.Length, CompareOptions.None);
}
unsafe public virtual int LastIndexOf(string source, char value, CompareOptions options)
{
if (source == null)
throw new ArgumentNullException("source");
// Can't start at negative index, so make sure we check for the length == 0 case.
return LastIndexOf(source, value, source.Length - 1, source.Length, options);
}
unsafe public virtual int LastIndexOf(string source, string value, CompareOptions options)
{
if (source == null)
throw new ArgumentNullException("source");
// Can't start at negative index, so make sure we check for the length == 0 case.
return LastIndexOf(source, value, source.Length - 1, source.Length, options);
}
unsafe public virtual int LastIndexOf(string source, char value, int startIndex)
{
return LastIndexOf(source, value, startIndex, startIndex + 1, CompareOptions.None);
}
unsafe public virtual int LastIndexOf(string source, string value, int startIndex)
{
return LastIndexOf(source, value, startIndex, startIndex + 1, CompareOptions.None);
}
unsafe public virtual int LastIndexOf(string source, char value, int startIndex, CompareOptions options)
{
return LastIndexOf(source, value, startIndex, startIndex + 1, options);
}
unsafe public virtual int LastIndexOf(string source, string value, int startIndex, CompareOptions options)
{
return LastIndexOf(source, value, startIndex, startIndex + 1, options);
}
unsafe public virtual int LastIndexOf(string source, char value, int startIndex, int count)
{
return LastIndexOf(source, value, startIndex, count, CompareOptions.None);
}
unsafe public virtual int LastIndexOf(string source, string value, int startIndex, int count)
{
return LastIndexOf(source, value, startIndex, count, CompareOptions.None);
}
unsafe public virtual int LastIndexOf(string source, char value, int startIndex, int count, CompareOptions options)
{
// Verify Arguments
if (source == null)
throw new ArgumentNullException("source");
// Validate CompareOptions
// Ordinal can't be selected with other flags
if ((options & ValidIndexMaskOffFlags) != 0 && (options != CompareOptions.Ordinal) && (options != CompareOptions.OrdinalIgnoreCase))
throw new ArgumentException(Environment.GetResourceString("Argument_InvalidFlag"), "options");
// Special case for 0 length input strings
if (source.Length == 0 && (startIndex == -1 || startIndex == 0))
return -1;
// Make sure we're not out of range
if (startIndex < 0 || startIndex > source.Length)
throw new ArgumentOutOfRangeException("startIndex", Environment.GetResourceString("ArgumentOutOfRange_Index"));
// Make sure that we allow startIndex == source.Length
if (startIndex == source.Length) {
startIndex--;
if (count > 0)
count--;
}
// 2nd have of this also catches when startIndex == MAXINT, so MAXINT - 0 + 1 == -1, which is < 0.
if (count < 0 || startIndex - count + 1 < 0)
throw new ArgumentOutOfRangeException("count", Environment.GetResourceString("ArgumentOutOfRange_Count"));
if (options == CompareOptions.OrdinalIgnoreCase) {
return TextInfo.nativeLastIndexOfCharOrdinalIgnoreCase(TextInfo.InvariantNativeTextInfo, source, value, startIndex, count);
}
return (LastIndexOfChar(m_pSortingTable, this.m_sortingLCID, source, value, startIndex, count, (int)options));
}
unsafe public virtual int LastIndexOf(string source, string value, int startIndex, int count, CompareOptions options)
{
// Verify Arguments
if (source == null)
throw new ArgumentNullException("source");
if (value == null)
throw new ArgumentNullException("value");
// Validate CompareOptions
// Ordinal can't be selected with other flags
if ((options & ValidIndexMaskOffFlags) != 0 && (options != CompareOptions.Ordinal) && (options != CompareOptions.OrdinalIgnoreCase))
throw new ArgumentException(Environment.GetResourceString("Argument_InvalidFlag"), "options");
// Special case for 0 length input strings
if (source.Length == 0 && (startIndex == -1 || startIndex == 0))
return (value.Length == 0) ? 0 : -1;
// Make sure we're not out of range
if (startIndex < 0 || startIndex > source.Length)
throw new ArgumentOutOfRangeException("startIndex", Environment.GetResourceString("ArgumentOutOfRange_Index"));
// Make sure that we allow startIndex == source.Length
if (startIndex == source.Length) {
startIndex--;
if (count > 0)
count--;
// If we are looking for nothing, just return 0
if (value.Length == 0 && count >= 0 && startIndex - count + 1 >= 0)
return startIndex;
}
// 2nd have of this also catches when startIndex == MAXINT, so MAXINT - 0 + 1 == -1, which is < 0.
if (count < 0 || startIndex - count + 1 < 0)
throw new ArgumentOutOfRangeException("count", Environment.GetResourceString("ArgumentOutOfRange_Count"));
if (options == CompareOptions.OrdinalIgnoreCase) {
return TextInfo.LastIndexOfStringOrdinalIgnoreCase(source, value, startIndex, count);
}
return (LastIndexOfString(m_pSortingTable, this.m_sortingLCID, source, value, startIndex, count, (int)options));
}
// This native method will check the parameters and validate them accordingly.
// Native method: COMNlsInfo::LastIndexOfChar
[MethodImplAttribute(MethodImplOptions.InternalCall)]
unsafe static internal extern int LastIndexOfChar(void* pSortingTable, int sortingLCID, string source, char value, int startIndex, int count, int options);
// This native method will check the parameters and validate them accordingly.
// Native method: COMNlsInfo::LastIndexOfString
[MethodImplAttribute(MethodImplOptions.InternalCall)]
unsafe static internal extern int LastIndexOfString(void* pSortingTable, int sortingLCID, string source, string value, int startIndex, int count, int options);
////////////////////////////////////////////////////////////////////////
//
// GetSortKey
//
// Gets the SortKey for the given string with the given options.
//
////////////////////////////////////////////////////////////////////////
unsafe public virtual SortKey GetSortKey(string source, CompareOptions options)
{
// SortKey() will check the parameters and validate them accordingly.
return (new SortKey(m_pSortingTable, this.m_sortingLCID, source, options));
}
unsafe public virtual SortKey GetSortKey(string source)
{
return (new SortKey(m_pSortingTable, this.m_sortingLCID, source, CompareOptions.None));
}
////////////////////////////////////////////////////////////////////////
//
// Equals
//
// Implements Object.Equals(). Returns a boolean indicating whether
// or not object refers to the same CompareInfo as the current
// instance.
//
////////////////////////////////////////////////////////////////////////
public override bool Equals(object value)
{
CompareInfo that = value as CompareInfo;
if (that != null) {
return this.m_sortingLCID == that.m_sortingLCID && this.Name.Equals(that.Name);
}
return (false);
}
////////////////////////////////////////////////////////////////////////
//
// GetHashCode
//
// Implements Object.GetHashCode(). Returns the hash code for the
// CompareInfo. The hash code is guaranteed to be the same for
// CompareInfo A and B where A.Equals(B) is true.
//
////////////////////////////////////////////////////////////////////////
public override int GetHashCode()
{
return (this.Name.GetHashCode());
}
////////////////////////////////////////////////////////////////////////
//
// GetHashCodeOfString
//
// This internal method allows a method that allows the equivalent of creating a Sortkey for a
// string from CompareInfo, and generate a hashcode value from it. It is not very convenient
// to use this method as is and it creates an unnecessary Sortkey object that will be GC'ed.
//
// The hash code is guaranteed to be the same for string A and B where A.Equals(B) is true and both
// the CompareInfo and the CompareOptions are the same. If two different CompareInfo objects
// treat the string the same way, this implementation will treat them differently (the same way that
// Sortkey does at the moment).
//
// This method will never be made public itself, but public consumers of it could be created, e.g.:
//
// string.GetHashCode(CultureInfo)
// string.GetHashCode(CompareInfo)
// string.GetHashCode(CultureInfo, CompareOptions)
// string.GetHashCode(CompareInfo, CompareOptions)
// etc.
//
// (the methods above that take a CultureInfo would use CultureInfo.CompareInfo)
//
////////////////////////////////////////////////////////////////////////
unsafe internal int GetHashCodeOfString(string source, CompareOptions options)
{
//
// Parameter validation
//
if (null == source) {
throw new ArgumentNullException("source");
}
if ((options & ValidHashCodeOfStringMaskOffFlags) != 0) {
throw new ArgumentException(Environment.GetResourceString("Argument_InvalidFlag"), "options");
}
if (0 == source.Length) {
return (0);
}
//
////////////////////////////////////////////////////////////////////////
return (nativeGetGlobalizedHashCode(m_pSortingTable, source, (int)options, this.m_sortingLCID));
}
////////////////////////////////////////////////////////////////////////
//
// ToString
//
// Implements Object.ToString(). Returns a string describing the
// CompareInfo.
//
////////////////////////////////////////////////////////////////////////
public override string ToString()
{
return ("CompareInfo - " + this.culture);
}
public int LCID {
get { return (this.culture); }
}
// This is a thin wrapper for InitializeNativeCompareInfo() to provide the necessary
// synchronization.
/*=================================InitializeCompareInfo==========================
**Action: Makes a native C++ SortingTable pointer using the specified assembly and Win32 LCID.
**Returns: a 32-bit pointer value to native C++ SrotingTable instance.
**
** This method shouldn't be called when having synthetic culture (ELK)
** Couldn't assert her because this is a static method and cannot detect the synthetic cultures case.
**
**Arguments:
** pNativeGlobalizationAssembly the 32-bit pointer value to a native C++ NLSAssembly instance.
** sortingLCID the Win32 LCID.
**Exceptions:
** None.
============================================================================*/
unsafe private static void* InitializeCompareInfo(void* pNativeGlobalizationAssembly, int sortingLCID)
{
}
void* pTemp = null;
bool tookLock = false;
}
}