{{ message }}
Repository navigation
Expand file tree
/
Copy pathUnitParser.cs
More file actions
217 lines (191 loc) · 11 KB
/
Copy pathUnitParser.cs
File metadata and controls
217 lines (191 loc) · 11 KB
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
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
// Licensed under MIT No Attribution, see LICENSE file at the root.
// Copyright 2013 Andreas Gullberg Larsen (andreas.larsen84@gmail.com). Maintained at https://github.com/angularsen/UnitsNet.
using System;
using System.Diagnostics.CodeAnalysis;
using System.Globalization;
using System.Linq;
using UnitsNet.Units;
// ReSharper disable once CheckNamespace
namespace UnitsNet
{
/// <summary>
/// Parses units given a unit abbreviations cache.
/// The static instance <see cref="Default"/> is used internally to parse quantities and units using the
/// default abbreviations cache for all units and abbreviations defined in the library.
/// </summary>
public sealed class UnitParser
{
private readonly UnitAbbreviationsCache _unitAbbreviationsCache;
/// <summary>
/// The default static instance used internally to parse quantities and units using the
/// default abbreviations cache for all units and abbreviations defined in the library.
/// </summary>
[Obsolete("Use UnitsNetSetup.Default.UnitParser instead.")]
public static UnitParser Default => UnitsNetSetup.Default.UnitParser;
/// <summary>
/// Create a parser using the given unit abbreviations cache.
/// </summary>
/// <param name="unitAbbreviationsCache"></param>
// TODO Change this to not fallback to built-in units abbreviations when given null, in v6: https://github.com/angularsen/UnitsNet/issues/1200
public UnitParser(UnitAbbreviationsCache? unitAbbreviationsCache)
{
_unitAbbreviationsCache = unitAbbreviationsCache ?? UnitAbbreviationsCache.Default;
}
/// <summary>
/// Parses a unit abbreviation for a given unit enumeration type.
/// Example: Parse<LengthUnit>("km") => LengthUnit.Kilometer
/// </summary>
/// <param name="unitAbbreviation"></param>
/// <param name="formatProvider">The format provider to use for lookup. Defaults to <see cref="CultureInfo.CurrentCulture" /> if null.</param>
/// <typeparam name="TUnitType"></typeparam>
/// <returns></returns>
public TUnitType Parse<TUnitType>(string unitAbbreviation, IFormatProvider? formatProvider = null) where TUnitType : Enum
{
return (TUnitType)Parse(unitAbbreviation, typeof(TUnitType), formatProvider);
}
/// <summary>
/// Parse a unit abbreviation, such as "kg" or "m", to the unit enum value of the enum type
/// <paramref name="unitType" />.
/// </summary>
/// <param name="unitAbbreviation">
/// Unit abbreviation, such as "kg" or "m" for <see cref="MassUnit.Kilogram" /> and
/// <see cref="LengthUnit.Meter" /> respectively.
/// </param>
/// <param name="unitType">Unit enum type, such as <see cref="MassUnit" /> and <see cref="LengthUnit" />.</param>
/// <param name="formatProvider">The format provider to use for lookup. Defaults to <see cref="CultureInfo.CurrentCulture" /> if null.</param>
/// <returns>Unit enum value, such as <see cref="MassUnit.Kilogram" />.</returns>
/// <exception cref="UnitNotFoundException">No units match the abbreviation.</exception>
/// <exception cref="AmbiguousUnitParseException">More than one unit matches the abbreviation.</exception>
public Enum Parse(string? unitAbbreviation, Type unitType, IFormatProvider? formatProvider = null)
{
if (unitAbbreviation == null) throw new ArgumentNullException(nameof(unitAbbreviation));
unitAbbreviation = unitAbbreviation.Trim();
var enumValues = Enum.GetValues(unitType).Cast<Enum>();
var stringUnitPairs = _unitAbbreviationsCache.GetStringUnitPairs(enumValues, formatProvider);
var matches = stringUnitPairs.Where(pair => pair.Item1.Equals(unitAbbreviation, StringComparison.OrdinalIgnoreCase)).ToArray();
if(matches.Length == 0)
{
unitAbbreviation = NormalizeUnitString(unitAbbreviation);
matches = stringUnitPairs.Where(pair => pair.Item1.Equals(unitAbbreviation, StringComparison.OrdinalIgnoreCase)).ToArray();
}
// Narrow the search if too many hits, for example Megabar "Mbar" and Millibar "mbar" need to be distinguished
if(matches.Length > 1)
matches = stringUnitPairs.Where(pair => pair.Item1.Equals(unitAbbreviation)).ToArray();
switch(matches.Length)
{
case 1:
return (Enum)Enum.ToObject(unitType, matches[0].Unit);
case 0:
// Retry with fallback culture, if different.
if(!Equals(formatProvider, UnitAbbreviationsCache.FallbackCulture))
{
return Parse(unitAbbreviation, unitType, UnitAbbreviationsCache.FallbackCulture);
}
throw new UnitNotFoundException($"Unit not found with abbreviation [{unitAbbreviation}] for unit type [{unitType}].");
default:
string unitsCsv = string.Join(", ", matches.Select(x => Enum.GetName(unitType, x.Unit)).ToArray());
throw new AmbiguousUnitParseException(
$"Cannot parse \"{unitAbbreviation}\" since it could be either of these: {unitsCsv}");
}
}
internal static string NormalizeUnitString(string unitAbbreviation)
{
// remove all whitespace in the string
unitAbbreviation = new string(unitAbbreviation.Where(c => !char.IsWhiteSpace(c)).ToArray());
unitAbbreviation = unitAbbreviation.Replace("^-9", "⁻⁹");
unitAbbreviation = unitAbbreviation.Replace("^-8", "⁻⁸");
unitAbbreviation = unitAbbreviation.Replace("^-7", "⁻⁷");
unitAbbreviation = unitAbbreviation.Replace("^-6", "⁻⁶");
unitAbbreviation = unitAbbreviation.Replace("^-5", "⁻⁵");
unitAbbreviation = unitAbbreviation.Replace("^-4", "⁻⁴");
unitAbbreviation = unitAbbreviation.Replace("^-3", "⁻³");
unitAbbreviation = unitAbbreviation.Replace("^-2", "⁻²");
unitAbbreviation = unitAbbreviation.Replace("^-1", "⁻¹");
unitAbbreviation = unitAbbreviation.Replace("^1", "");
unitAbbreviation = unitAbbreviation.Replace("^2", "²");
unitAbbreviation = unitAbbreviation.Replace("^3", "³");
unitAbbreviation = unitAbbreviation.Replace("^4", "⁴");
unitAbbreviation = unitAbbreviation.Replace("^5", "⁵");
unitAbbreviation = unitAbbreviation.Replace("^6", "⁶");
unitAbbreviation = unitAbbreviation.Replace("^7", "⁷");
unitAbbreviation = unitAbbreviation.Replace("^8", "⁸");
unitAbbreviation = unitAbbreviation.Replace("^9", "⁹");
unitAbbreviation = unitAbbreviation.Replace("*", "·");
// "\u03bc" = Lower case Greek letter 'Mu'
// "\u00b5" = Micro sign
unitAbbreviation = unitAbbreviation.Replace("\u03bc", "\u00b5");
return unitAbbreviation;
}
/// <summary>
/// Try to parse a unit abbreviation.
/// </summary>
/// <param name="unitAbbreviation">The string value.</param>
/// <param name="unit">The unit enum value as out result.</param>
/// <typeparam name="TUnitType">Type of unit enum.</typeparam>
/// <returns>True if successful.</returns>
public bool TryParse<TUnitType>(string unitAbbreviation, out TUnitType unit) where TUnitType : struct, Enum
{
return TryParse(unitAbbreviation, null, out unit);
}
/// <summary>
/// Try to parse a unit abbreviation.
/// </summary>
/// <param name="unitAbbreviation">The string value.</param>
/// <param name="formatProvider">The format provider to use for lookup. Defaults to <see cref="CultureInfo.CurrentCulture" /> if null.</param>
/// <param name="unit">The unit enum value as out result.</param>
/// <typeparam name="TUnitType">Type of unit enum.</typeparam>
/// <returns>True if successful.</returns>
public bool TryParse<TUnitType>(string? unitAbbreviation, IFormatProvider? formatProvider, out TUnitType unit) where TUnitType : struct, Enum
{
unit = default;
if (!TryParse(unitAbbreviation, typeof(TUnitType), formatProvider, out var unitObj))
return false;
unit = (TUnitType)unitObj;
return true;
}
/// <summary>
/// Try to parse a unit abbreviation.
/// </summary>
/// <param name="unitAbbreviation">The string value.</param>
/// <param name="unitType">Type of unit enum.</param>
/// <param name="unit">The unit enum value as out result.</param>
/// <returns>True if successful.</returns>
public bool TryParse(string unitAbbreviation, Type unitType, [NotNullWhen(true)] out Enum? unit)
{
return TryParse(unitAbbreviation, unitType, null, out unit);
}
/// <summary>
/// Try to parse a unit abbreviation.
/// </summary>
/// <param name="unitAbbreviation">The string value.</param>
/// <param name="unitType">Type of unit enum.</param>
/// <param name="formatProvider">The format provider to use for lookup. Defaults to <see cref="CultureInfo.CurrentCulture" /> if null.</param>
/// <param name="unit">The unit enum value as out result.</param>
/// <returns>True if successful.</returns>
public bool TryParse(string? unitAbbreviation, Type unitType, IFormatProvider? formatProvider, [NotNullWhen(true)] out Enum? unit)
{
if (unitAbbreviation == null)
{
unit = default;
return false;
}
unitAbbreviation = unitAbbreviation.Trim();
unit = default;
var enumValues = Enum.GetValues(unitType).Cast<Enum>();
var stringUnitPairs = _unitAbbreviationsCache.GetStringUnitPairs(enumValues, formatProvider);
var matches = stringUnitPairs.Where(pair => pair.Item1.Equals(unitAbbreviation, StringComparison.OrdinalIgnoreCase)).ToArray();
if(matches.Length == 0)
{
unitAbbreviation = NormalizeUnitString(unitAbbreviation);
matches = stringUnitPairs.Where(pair => pair.Item1.Equals(unitAbbreviation, StringComparison.OrdinalIgnoreCase)).ToArray();
}
// Narrow the search if too many hits, for example Megabar "Mbar" and Millibar "mbar" need to be distinguished
if(matches.Length > 1)
matches = stringUnitPairs.Where(pair => pair.Item1.Equals(unitAbbreviation)).ToArray();
if(matches.Length != 1)
return false;
unit = (Enum)Enum.ToObject(unitType, matches[ 0 ].Unit);
return true;
}
}
}
You can’t perform that action at this time.