1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
|
/*
* Copyright (c) 2024 Vaughn Nugent
*
* Library: VNLib
* Package: VNLib.Plugins.Extensions.Loading
* File: Validate.cs
*
* Validate.cs is part of VNLib.Plugins.Extensions.Loading which is part of the larger
* VNLib collection of libraries and utilities.
*
* VNLib.Plugins.Extensions.Loading is free software: you can redistribute it and/or modify
* it under the terms of the GNU Affero General Public License as
* published by the Free Software Foundation, either version 3 of the
* License, or (at your option) any later version.
*
* VNLib.Plugins.Extensions.Loading is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU Affero General Public License for more details.
*
* You should have received a copy of the GNU Affero General Public License
* along with this program. If not, see https://www.gnu.org/licenses/.
*/
using System;
using System.Diagnostics.CodeAnalysis;
using System.Runtime.CompilerServices;
using VNLib.Utils.IO;
namespace VNLib.Plugins.Extensions.Loading.Configuration
{
/// <summary>
/// A class that allows for easy configuration validation
/// </summary>
public sealed class Validate
{
/// <summary>
/// Ensures the object is not null and not an empty string,
/// otherwise a <see cref="ConfigurationValidationException"/> is raised
/// </summary>
/// <typeparam name="T"></typeparam>
/// <param name="obj">The object to test</param>
/// <param name="message">The message to display to the user on loading</param>
/// <exception cref="ConfigurationValidationException"></exception>
[DoesNotReturn]
public static void NotNull<T>(T? obj, string message) where T : class
{
if (obj is null)
{
throw new ConfigurationValidationException(message);
}
if (obj is string s && string.IsNullOrWhiteSpace(s))
{
throw new ConfigurationValidationException(message);
}
}
/// <summary>
///
/// </summary>
/// <param name="condition"></param>
/// <param name="message"></param>
/// <exception cref="ConfigurationValidationException"></exception>
public static void Assert([DoesNotReturnIf(false)] bool condition, string message)
{
if (!condition)
{
throw new ConfigurationValidationException(message);
}
}
public static void NotEqual<T>(T a, T b, string message)
{
if (a is null || b is null)
{
throw new ConfigurationValidationException(message);
}
if (a.Equals(b))
{
throw new ConfigurationValidationException(message);
}
}
public static void Range2<T>(T value, T min, T max, string message)
where T : IComparable<T>
{
//Compare the value against min/max calues and raise exception if it is
if (value.CompareTo(min) < 0 || value.CompareTo(max) > 0)
{
throw new ConfigurationValidationException(message);
}
}
public static void Range<T>(T value, T min, T max, [CallerArgumentExpression(nameof(value))] string? paramName = null)
where T : IComparable<T>
{
Range2(value, min, max, $"Value for {paramName} must be between {min} and {max}. Value: {value}");
}
public static void FileExists(string path)
{
if (!FileOperations.FileExists(path))
{
throw new ConfigurationValidationException($"Required file: {path} not found");
}
}
}
}
|
