FastInventoryBook/Source/Sure.cs - master - amironov73/misc

FastInventoryBook/Source/Sure.cs
762 строки25 KB
Alexey Mironov
Add FastInventoryBook application
30 янв 2024, 11:16
30 янв 2024, 11:1678fa326
// This is an open source non-commercial project. Dear PVS-Studio, please check it.
// PVS-Studio Static Code Analyzer for C, C++ and C#: http://www.viva64.com

// ReSharper disable CheckNamespace
// ReSharper disable ClassNeverInstantiated.Global
// ReSharper disable CommentTypo
// ReSharper disable IdentifierTypo
// ReSharper disable InconsistentNaming
// ReSharper disable StringLiteralTypo
// ReSharper disable UnusedMember.Global
// ReSharper disable UnusedParameter.Local

/* Sure.cs -- ассерты на все случаи жизни
 * Ars Magna project, http://arsmagna.ru
 */

#region Using directives

using System;
using System.Collections.Generic;
using System.Diagnostics;
using System.IO;
using System.Runtime.CompilerServices;

using JetBrains.Annotations;

#endregion

namespace FastInventoryBook;

/// <summary>
/// Ассерты на все случаи жизни.
/// </summary>
public static class Sure
{
    #region Public methods

    /// <summary>
    /// Проверка состояния объекта.
    /// </summary>
    [DebuggerHidden]
    [AssertionMethod]
    [MethodImpl (MethodImplOptions.AggressiveInlining)]
    public static void AssertState
        (
            bool condition,
            [CallerArgumentExpression (nameof (condition))]
            string? message = null
        )
    {
        if (!condition)
        {
            if (!string.IsNullOrEmpty (message))
            {
                // .NET 5 SDK подставляет в message значение null, .NET 6 делает по-человечески
                throw new ApplicationException (message);
            }

            throw new ApplicationException();
        }
    }

    /// <summary>
    /// Проверка, определено ли значение <paramref name="value"/> в перечислении.
    /// </summary>
    [DebuggerHidden]
    [AssertionMethod]
    [MethodImpl (MethodImplOptions.AggressiveInlining)]
    public static void Defined<T>
        (
            T value,
            [CallerArgumentExpression ("value")]
            string? argumentName = null
        )
        where T : struct
    {
        if (!Enum.IsDefined (typeof (T), value))
        {
            if (!string.IsNullOrEmpty (argumentName))
            {
                // .NET 5 SDK подставляет в argumentName значение null, .NET 6 делает по-человечески
                throw new ArgumentOutOfRangeException (argumentName);
            }

            throw new ArgumentOutOfRangeException();
        }
    }

    /// <summary>
    /// Проверка существования директории с указанным именем.
    /// </summary>
    [DebuggerHidden]
    [AssertionMethod]
    [MethodImpl (MethodImplOptions.AggressiveInlining)]
    public static void DirectoryExists
        (
            string? path,
            [CallerArgumentExpression ("path")]
            string? argumentName = null
        )
    {
        if (string.IsNullOrEmpty (path))
        {
            if (!string.IsNullOrEmpty (argumentName))
            {
                // .NET 5 SDK подставляет в argumentName значение null, .NET 6 делает по-человечески
                throw new ArgumentNullException (argumentName);
            }

            throw new ArgumentNullException();
        }

        if (!Directory.Exists (path))
        {
            if (!string.IsNullOrEmpty (argumentName))
            {
                // .NET 5 SDK подставляет в argumentName значение null, .NET 6 делает по-человечески
                throw new FileNotFoundException
                    (
                        argumentName
                        + " : "
                        + path
                    );
            }

            throw new FileNotFoundException (path);
        }
    }

    /// <summary>
    /// Проверка существования файла с указанным именем.
    /// </summary>
    [DebuggerHidden]
    [AssertionMethod]
    [MethodImpl (MethodImplOptions.AggressiveInlining)]
    public static void FileExists
        (
            string? path,
            [CallerArgumentExpression ("path")]
            string? argumentName = null
        )
    {
        if (string.IsNullOrEmpty (path))
        {
            if (!string.IsNullOrEmpty (argumentName))
            {
                // .NET 5 SDK подставляет в argumentName значение null, .NET 6 делает по-человечески
                throw new ArgumentNullException (argumentName);
            }

            throw new ArgumentNullException();
        }

        if (!File.Exists (path))
        {
            if (!string.IsNullOrEmpty (argumentName))
            {
                // .NET 5 SDK подставляет в argumentName значение null, .NET 6 делает по-человечески
                throw new FileNotFoundException
                    (
                        argumentName
                        + " : "
                        + path
                    );
            }

            throw new FileNotFoundException (path);
        }
    }

    /// <summary>
    /// Проверка, попадает ли <paramref name="argument"/> в диапазон
    /// индексов, допустимых для данного фрагмента.
    /// </summary>
    [DebuggerHidden]
    [AssertionMethod]
    [MethodImpl (MethodImplOptions.AggressiveInlining)]
    public static void InRange<T>
        (
            int argument,
            Memory<T> span,
            [CallerArgumentExpression ("argument")]
            string? argumentName = null
        )
    {
        if (argument < 0 || argument >= span.Length)
        {
            if (!string.IsNullOrEmpty (argumentName))
            {
                // .NET 5 SDK подставляет в argumentName значение null, .NET 6 делает по-человечески
                throw new ArgumentOutOfRangeException (argumentName);
            }

            throw new ArgumentOutOfRangeException();
        }
    }

    /// <summary>
    /// Проверка, попадает ли <paramref name="argument"/> в диапазон
    /// индексов, допустимых для данного фрагмента.
    /// </summary>
    [DebuggerHidden]
    [AssertionMethod]
    [MethodImpl (MethodImplOptions.AggressiveInlining)]
    public static void InRange<T>
        (
            int argument,
            ReadOnlyMemory<T> span,
            [CallerArgumentExpression ("argument")]
            string? argumentName = null
        )
    {
        if (argument < 0 || argument >= span.Length)
        {
            if (!string.IsNullOrEmpty (argumentName))
            {
                // .NET 5 SDK подставляет в argumentName значение null, .NET 6 делает по-человечески
                throw new ArgumentOutOfRangeException (argumentName);
            }

            throw new ArgumentOutOfRangeException();
        }
    }

    /// <summary>
    /// Проверка, попадает ли <paramref name="argument"/> в диапазон
    /// индексов, допустимых для данного фрагмента.
    /// </summary>
    [DebuggerHidden]
    [AssertionMethod]
    [MethodImpl (MethodImplOptions.AggressiveInlining)]
    public static void InRange<T>
        (
            int argument,
            Span<T> span,
            [CallerArgumentExpression ("argument")]
            string? argumentName = null
        )
    {
        if (argument < 0 || argument >= span.Length)
        {
            if (!string.IsNullOrEmpty (argumentName))
            {
                // .NET 5 SDK подставляет в argumentName значение null, .NET 6 делает по-человечески
                throw new ArgumentOutOfRangeException (argumentName);
            }

            throw new ArgumentOutOfRangeException();
        }
    }

    /// <summary>
    /// Проверка, попадает ли <paramref name="argument"/> в диапазон
    /// индексов, допустимых для данного фрагмента.
    /// </summary>
    [DebuggerHidden]
    [AssertionMethod]
    [MethodImpl (MethodImplOptions.AggressiveInlining)]
    public static void InRange<T>
        (
            int argument,
            ReadOnlySpan<T> span,
            [CallerArgumentExpression ("argument")]
            string? argumentName = null
        )
    {
        if (argument < 0 || argument >= span.Length)
        {
            if (!string.IsNullOrEmpty (argumentName))
            {
                // .NET 5 SDK подставляет в argumentName значение null, .NET 6 делает по-человечески
                throw new ArgumentOutOfRangeException (argumentName);
            }

            throw new ArgumentOutOfRangeException();
        }
    }

    /// <summary>
    /// Проверка, попадает ли <paramref name="argument"/> в диапазон
    /// индексов, допустимых для данного списка.
    /// </summary>
    [DebuggerHidden]
    [AssertionMethod]
    [MethodImpl (MethodImplOptions.AggressiveInlining)]
    public static void InRange<T>
        (
            int argument,
            IReadOnlyList<T> list,
            [CallerArgumentExpression (nameof (argument))]
            string? argumentName = null
        )
    {
        NotNull (list);

        if (argument < 0 || argument >= list.Count)
        {
            if (!string.IsNullOrEmpty (argumentName))
            {
                // .NET 5 SDK подставляет в argumentName значение null, .NET 6 делает по-человечески
                throw new ArgumentOutOfRangeException (argumentName);
            }

            throw new ArgumentOutOfRangeException();
        }
    }

    /// <summary>
    /// Проверка, попадают ли <paramref name="index"/>
    /// и <param name="count"></param> в допустимые диапазоны
    /// для данного списка.
    /// </summary>
    /// <param name="index">Стартовый индекс.</param>
    /// <param name="count">Количество выбираемых элементов.</param>
    /// <param name="list">Список, из которого выбираются элементы.</param>
    /// <param name="argumentName">Имя аргумента.</param>
    [DebuggerHidden]
    [AssertionMethod]
    [MethodImpl (MethodImplOptions.AggressiveInlining)]
    public static void InRange<T>
        (
            int index,
            int count,
            IReadOnlyList<T> list,
            [CallerArgumentExpression (nameof (index))]
            string? argumentName = null
        )
    {
        NotNull (list);

        if (index < 0 || index >= list.Count || count < 0 || count >= list.Count
            || (list.Count - index < count))
        {
            if (!string.IsNullOrEmpty (argumentName))
            {
                // .NET 5 SDK подставляет в argumentName значение null, .NET 6 делает по-человечески
                throw new ArgumentOutOfRangeException (argumentName);
            }

            throw new ArgumentOutOfRangeException();
        }
    }

    /// <summary>
    /// Проверка, попадает ли <paramref name="argument"/> в указанный
    /// диапазон от <paramref name="fromValue"/>
    /// до <paramref name="toValue"/> (включительно).
    /// </summary>
    [DebuggerHidden]
    [AssertionMethod]
    [MethodImpl (MethodImplOptions.AggressiveInlining)]
    public static void InRange
        (
            int argument,
            int fromValue,
            int toValue,
            [CallerArgumentExpression (nameof (argument))]
            string? argumentName = null
        )
    {
        if (argument < fromValue || argument > toValue)
        {
            if (!string.IsNullOrEmpty (argumentName))
            {
                // .NET 5 SDK подставляет в argumentName значение null, .NET 6 делает по-человечески
                throw new ArgumentOutOfRangeException (argumentName);
            }

            throw new ArgumentOutOfRangeException();
        }
    }

    /// <summary>
    /// Проверка, попадает ли <paramref name="argument"/> в указанный
    /// диапазон от <paramref name="fromValue"/>
    /// до <paramref name="toValue"/> (включительно).
    /// </summary>
    [DebuggerHidden]
    [AssertionMethod]
    [MethodImpl (MethodImplOptions.AggressiveInlining)]
    public static void InRange
        (
            long argument,
            long fromValue,
            long toValue,
            [CallerArgumentExpression (nameof (argument))]
            string? argumentName = null
        )
    {
        if (argument < fromValue || argument > toValue)
        {
            if (!string.IsNullOrEmpty (argumentName))
            {
                // .NET 5 SDK подставляет в argumentName значение null, .NET 6 делает по-человечески
                throw new ArgumentOutOfRangeException (argumentName);
            }

            throw new ArgumentOutOfRangeException();
        }
    }

    /// <summary>
    /// Проврека, попадает ли <paramref name="argument"/> в указанный
    /// диапазон от <paramref name="fromValue"/>
    /// до <paramref name="toValue"/> (включительно).
    /// </summary>
    [DebuggerHidden]
    [AssertionMethod]
    [MethodImpl (MethodImplOptions.AggressiveInlining)]
    public static void InRange
        (
            double argument,
            double fromValue,
            double toValue,
            [CallerArgumentExpression (nameof (argument))]
            string? argumentName = null
        )
    {
        if (argument < fromValue || argument > toValue)
        {
            if (!string.IsNullOrEmpty (argumentName))
            {
                // .NET 5 SDK подставляет в argumentName значение null, .NET 6 делает по-человечески
                throw new ArgumentOutOfRangeException (argumentName);
            }

            throw new ArgumentOutOfRangeException();
        }
    }

    /// <summary>
    /// Проверка, что <paramref name="argument"/> не является отрицательным числом.
    /// </summary>
    [DebuggerHidden]
    [AssertionMethod]
    [MethodImpl (MethodImplOptions.AggressiveInlining)]
    public static void NonNegative
        (
            int argument,
            [CallerArgumentExpression (nameof (argument))]
            string? argumentName = null
        )
    {
        if (argument < 0)
        {
            if (!string.IsNullOrEmpty (argumentName))
            {
                // .NET 5 SDK подставляет в argumentName значение null, .NET 6 делает по-человечески
                throw new ArgumentOutOfRangeException (argumentName);
            }

            throw new ArgumentOutOfRangeException();
        }
    }

    /// <summary>
    /// Проверка, что <paramref name="argument"/> не является отрицательным числом.
    /// </summary>
    [DebuggerHidden]
    [AssertionMethod]
    [MethodImpl (MethodImplOptions.AggressiveInlining)]
    public static void NonNegative
        (
            long argument,
            [CallerArgumentExpression (nameof (argument))]
            string? argumentName = null
        )
    {
        if (argument < 0)
        {
            if (!string.IsNullOrEmpty (argumentName))
            {
                // .NET 5 SDK подставляет в argumentName значение null, .NET 6 делает по-человечески
                throw new ArgumentOutOfRangeException (argumentName);
            }

            throw new ArgumentOutOfRangeException();
        }
    }

    /// <summary>
    /// Проверка, что <paramref name="argument"/> не является отрицательным числом.
    /// </summary>
    [DebuggerHidden]
    [AssertionMethod]
    [MethodImpl (MethodImplOptions.AggressiveInlining)]
    public static void NonNegative
        (
            double argument,
            [CallerArgumentExpression (nameof (argument))]
            string? argumentName = null
        )
    {
        if (argument < 0.0)
        {
            if (!string.IsNullOrEmpty (argumentName))
            {
                // .NET 5 SDK подставляет в argumentName значение null, .NET 6 делает по-человечески
                throw new ArgumentOutOfRangeException (argumentName);
            }

            throw new ArgumentOutOfRangeException();
        }
    }

    /// <summary>
    /// Проверка, что переданный в качестве аргумента фрагмент не пустой.
    /// </summary>
    [DebuggerHidden]
    [AssertionMethod]
    [MethodImpl (MethodImplOptions.AggressiveInlining)]
    public static void NotEmpty<T>
        (
            ReadOnlySpan<T> span,
            [CallerArgumentExpression (nameof (span))]
            string? argumentName = null
        )
        where T : struct
    {
        if (span.IsEmpty)
        {
            if (!string.IsNullOrEmpty (argumentName))
            {
                // .NET 5 SDK подставляет в argumentName значение null, .NET 6 делает по-человечески
                throw new ArgumentOutOfRangeException (argumentName);
            }

            throw new ArgumentOutOfRangeException();
        }
    }

    /// <summary>
    /// Проверка, что указатель <paramref name="argument"/> не <c>null</c>.
    /// </summary>
    [DebuggerHidden]
    [AssertionMethod]
    [MethodImpl (MethodImplOptions.AggressiveInlining)]
    public static void NotNull
        (
            IntPtr argument,
            [CallerArgumentExpression (nameof (argument))]
            string? argumentName = null
        )
    {
        if (argument.Equals (IntPtr.Zero))
        {
            if (!string.IsNullOrEmpty (argumentName))
            {
                // .NET 5 SDK подставляет в argumentName значение null, .NET 6 делает по-человечески
                throw new ArgumentNullException (argumentName);
            }

            throw new ArgumentNullException();
        }
    }

    /// <summary>
    /// Проверка, что указатель <paramref name="argument"/> не <c>null</c>.
    /// </summary>
    [DebuggerHidden]
    [AssertionMethod]
    [MethodImpl (MethodImplOptions.AggressiveInlining)]
    public static void NotNull
        (
            UIntPtr argument,
            [CallerArgumentExpression (nameof (argument))]
            string? argumentName = null
        )
    {
        if (argument.Equals (UIntPtr.Zero))
        {
            if (!string.IsNullOrEmpty (argumentName))
            {
                // .NET 5 SDK подставляет в argumentName значение null, .NET 6 делает по-человечески
                throw new ArgumentNullException (argumentName);
            }

            throw new ArgumentNullException();
        }
    }

    /// <summary>
    /// Проверка, что указатель <paramref name="argument" /> не <c>null</c>.
    /// </summary>
    [DebuggerHidden]
    [AssertionMethod]
    [MethodImpl (MethodImplOptions.AggressiveInlining)]
    public static void NotNull<T>
        (
            [NoEnumeration] T? argument,
            [CallerArgumentExpression (nameof (argument))]
            string? argumentName = null
        )
        where T : class
    {
        if (argument is null)
        {
            if (!string.IsNullOrEmpty (argumentName))
            {
                // .NET 5 SDK подставляет в argumentName значение null, .NET 6 делает по-человечески
                throw new ArgumentNullException (argumentName);
            }

            throw new ArgumentNullException();
        }
    }

    /// <summary>
    /// Проверка, что указатель <paramref name="argument" /> не <c>null</c>.
    /// </summary>
    [DebuggerHidden]
    [AssertionMethod]
    [MethodImpl (MethodImplOptions.AggressiveInlining)]
    public static void NotNull<T>
        (
            T? argument,
            [CallerArgumentExpression (nameof (argument))]
            string? argumentName = null
        )
        where T : struct
    {
        if (!argument.HasValue)
        {
            if (!string.IsNullOrEmpty (argumentName))
            {
                // .NET 5 SDK подставляет в argumentName значение null, .NET 6 делает по-человечески
                throw new ArgumentException (argumentName);
            }

            throw new ArgumentException();
        }
    }

    /// <summary>
    /// Проверка, что строка <paramref name="argument" />
    /// не <c>null</c> и не пустая.
    /// </summary>
    [DebuggerHidden]
    [AssertionMethod]
    [MethodImpl (MethodImplOptions.AggressiveInlining)]
    public static void NotNullNorEmpty
        (
            string? argument,
            [CallerArgumentExpression (nameof (argument))]
            string? argumentName = null
        )
    {
        if (string.IsNullOrEmpty (argument))
        {
            if (!string.IsNullOrEmpty (argumentName))
            {
                // .NET 5 SDK подставляет в argumentName значение null, .NET 6 делает по-человечески
                throw new ArgumentNullException (argumentName);
            }

            throw new ArgumentNullException();
        }
    }

    /// <summary>
    /// Проверка, что аргумент <paramref name="argument" />
    /// имеет правильный тип <typeparamref name="TType"/>.
    /// </summary>
    [DebuggerHidden]
    [AssertionMethod]
    [MethodImpl (MethodImplOptions.AggressiveInlining)]
    public static void OfType<TType>
        (
            object? argument,
            [CallerArgumentExpression (nameof (argument))]
            string? argumentName = null
        )
    {
        if (argument is not TType)
        {
            if (!string.IsNullOrEmpty (argumentName))
            {
                // .NET 5 SDK подставляет в argumentName значение null, .NET 6 делает по-человечески
                throw new ArgumentException (argumentName);
            }

            throw new ArgumentException();
        }
    }

    /// <summary>
    /// Проверка, что число <paramref name="argument"/> положительное.
    /// </summary>
    [DebuggerHidden]
    [AssertionMethod]
    [MethodImpl (MethodImplOptions.AggressiveInlining)]
    public static void Positive
        (
            int argument,
            [CallerArgumentExpression (nameof (argument))]
            string? argumentName = null
        )
    {
        if (argument <= 0)
        {
            if (!string.IsNullOrEmpty (argumentName))
            {
                // .NET 5 SDK подставляет в argumentName значение null, .NET 6 делает по-человечески
                throw new ArgumentOutOfRangeException (argumentName);
            }

            throw new ArgumentOutOfRangeException();
        }
    }

    /// <summary>
    /// Проверка, что число <paramref name="argument"/> положительное.
    /// </summary>
    [DebuggerHidden]
    [AssertionMethod]
    [MethodImpl (MethodImplOptions.AggressiveInlining)]
    public static void Positive
        (
            long argument,
            [CallerArgumentExpression (nameof (argument))]
            string? argumentName = null
        )
    {
        if (argument <= 0.0)
        {
            if (!string.IsNullOrEmpty (argumentName))
            {
                // .NET 5 SDK подставляет в argumentName значение null, .NET 6 делает по-человечески
                throw new ArgumentOutOfRangeException (argumentName);
            }

            throw new ArgumentOutOfRangeException();
        }
    }

    /// <summary>
    /// Проверка, что число <paramref name="argument"/> положительное.
    /// </summary>
    [DebuggerHidden]
    [AssertionMethod]
    [MethodImpl (MethodImplOptions.AggressiveInlining)]
    public static void Positive
        (
            double argument,
            [CallerArgumentExpression (nameof (argument))]
            string? argumentName = null
        )
    {
        if (argument <= 0.0)
        {
            if (!string.IsNullOrEmpty (argumentName))
            {
                // .NET 5 SDK подставляет в argumentName значение null, .NET 6 делает по-человечески
                throw new ArgumentOutOfRangeException (argumentName);
            }

            throw new ArgumentOutOfRangeException();
        }
    }

    #endregion
}