DSInternals/Src/Microsoft.Isam.Esent.Interop/jet_unicodeindex.cs

//-----------------------------------------------------------------------
// <copyright file="jet_unicodeindex.cs" company="Microsoft Corporation">
//     Copyright (c) Microsoft Corporation.
// </copyright>
//-----------------------------------------------------------------------

namespace Microsoft.Isam.Esent.Interop
{
    using System;
    using System.Diagnostics;
    using System.Diagnostics.CodeAnalysis;
    using System.Globalization;
    using System.Runtime.InteropServices;

    /// <summary>
    /// The native version of the JET_UNICODEINDEX structure.
    /// </summary>
    [StructLayout(LayoutKind.Sequential)]
    [SuppressMessage("Microsoft.StyleCop.CSharp.NamingRules",
        "SA1305:FieldNamesMustNotUseHungarianNotation",
        Justification = "This should match the unmanaged API, which isn't capitalized.")]
    [SuppressMessage(
        "Microsoft.StyleCop.CSharp.NamingRules",
        "SA1307:AccessibleFieldsMustBeginWithUpperCaseLetter",
        Justification = "This should match the unmanaged API, which isn't capitalized.")]
    internal struct NATIVE_UNICODEINDEX
    {
        /// <summary>
        /// The LCID to be used when normalizing unicode data.
        /// </summary>
        public uint lcid;

        /// <summary>
        /// The flags for LCMapString.
        /// </summary>
        public uint dwMapFlags;
    }

    /// <summary>
    /// Customizes how Unicode data gets normalized when an index is created over a Unicode column.
    /// </summary>
    [SuppressMessage(
        "Microsoft.StyleCop.CSharp.NamingRules",
        "SA1300:ElementMustBeginWithUpperCaseLetter",
        Justification = "This should match the unmanaged API, which isn't capitalized.")]
    [Serializable]
    public sealed partial class JET_UNICODEINDEX : IContentEquatable<JET_UNICODEINDEX>, IDeepCloneable<JET_UNICODEINDEX>
    {
        /// <summary>
        /// The LCID to be used when normalizing unicode data.
        /// </summary>
        private int localeId;

        /// <summary>
        /// The LocaleName to be used when normalizing unicode data.
        /// </summary>
        private string localeName;

        /// <summary>
        /// Sets the flags to be used with LCMapString when normalizing unicode data.
        /// </summary>
        private uint mapStringFlags;

        /// <summary>
        /// Gets or sets the LCID to be used when normalizing unicode data.
        /// </summary>
        public int lcid
        {
            [DebuggerStepThrough]
            get { return this.localeId; }
            set { this.localeId = value; }
        }

        /// <summary>
        /// Gets or sets the LocaleName to be used when normalizing unicode data.
        /// </summary>
        public string szLocaleName
        {
            [DebuggerStepThrough]
            get { return this.localeName; }
            set { this.localeName = value; }
        }

        /// <summary>
        /// Gets or sets the flags to be used with LCMapString when normalizing unicode data.
        /// </summary>
        [CLSCompliant(false)]
        public uint dwMapFlags
        {
            [DebuggerStepThrough]
            get { return this.mapStringFlags; }
            set { this.mapStringFlags = value; }
        }

        /// <summary>
        /// Returns a deep copy of the object.
        /// </summary>
        /// <returns>A deep copy of the object.</returns>
        public JET_UNICODEINDEX DeepClone()
        {
            return (JET_UNICODEINDEX)this.MemberwiseClone();
        }

        /// <summary>
        /// Generate a string representation of the instance.
        /// </summary>
        /// <returns>The structure as a string.</returns>
        public override string ToString()
        {
            return string.Format(
                CultureInfo.InvariantCulture,
                "JET_UNICODEINDEX({0}:{1}:0x{2:X})",
                this.localeId,
                this.localeName,
                this.mapStringFlags);
        }

        /// <summary>
        /// Returns a value indicating whether this instance is equal
        /// to another instance.
        /// </summary>
        /// <param name="other">An instance to compare with this instance.</param>
        /// <returns>True if the two instances are equal.</returns>
        public bool ContentEquals(JET_UNICODEINDEX other)
        {
            if (null == other)
            {
                return false;
            }

            return this.localeId == other.localeId && this.mapStringFlags == other.mapStringFlags && string.Compare(this.localeName, other.localeName, StringComparison.Ordinal) == 0;
        }

        /// <summary>
        /// Gets the native version of this object.
        /// </summary>
        /// <returns>The native version of this object.</returns>
        internal NATIVE_UNICODEINDEX GetNativeUnicodeIndex()
        {
            if (!string.IsNullOrEmpty(this.localeName))
            {
                throw new ArgumentException("localeName was specified, but this version of the API does not accept locale names. Use LCIDs or a different API.");
            }

            var native = new NATIVE_UNICODEINDEX
            {
                lcid = (uint)this.lcid,
                dwMapFlags = this.dwMapFlags,
            };
            return native;
        }
    }
}