Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[dotnet] Add nullability to IniFileReader #14929

Merged
merged 4 commits into from
Dec 26, 2024
Merged

[dotnet] Add nullability to IniFileReader #14929

Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
91ced6e
[dotnet] Add nullability to `IniFileReader`
RenderMichael Dec 21, 2024
db3bac4
Add period to XML
RenderMichael Dec 21, 2024
4ee76ef
Fix XMLDoc
RenderMichael Dec 21, 2024
c210a0e
Merge branch 'trunk' into ini-file-reader
RenderMichael Dec 26, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
37 changes: 21 additions & 16 deletions dotnet/src/webdriver/Firefox/Internal/IniFileReader.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -22,19 +22,23 @@
using System.Collections.ObjectModel;
using System.IO;

#nullable enable

namespace OpenQA.Selenium.Firefox.Internal
{
/// <summary>
/// Parses and reads an INI file.
/// </summary>
internal class IniFileReader
internal sealed class IniFileReader
{
private Dictionary<string, Dictionary<string, string>> iniFileStore = new Dictionary<string, Dictionary<string, string>>();
private readonly Dictionary<string, Dictionary<string, string>> iniFileStore = new Dictionary<string, Dictionary<string, string>>();

/// <summary>
/// Initializes a new instance of the <see cref="IniFileReader"/> class.
/// </summary>
/// <param name="fileName">The full path to the .INI file to be read.</param>
/// <exception cref="ArgumentNullException">If <paramref name="fileName"/> is <see langword="null"/> or <see cref="string.Empty"/>.</exception>
/// <exception cref="FileNotFoundException">If no file exists at file path <paramref name="fileName"/>.</exception>
public IniFileReader(string fileName)
{
if (string.IsNullOrEmpty(fileName))
Expand All @@ -53,7 +57,7 @@ public IniFileReader(string fileName)
string[] iniFileContent = File.ReadAllLines(fileName);
foreach (string iniFileLine in iniFileContent)
{
if (!string.IsNullOrEmpty(iniFileLine.Trim()) && !iniFileLine.StartsWith(";", StringComparison.OrdinalIgnoreCase))
if (!string.IsNullOrWhiteSpace(iniFileLine) && !iniFileLine.StartsWith(";", StringComparison.OrdinalIgnoreCase))
{
if (iniFileLine.StartsWith("[", StringComparison.OrdinalIgnoreCase) && iniFileLine.EndsWith("]", StringComparison.OrdinalIgnoreCase))
{
Expand Down Expand Up @@ -86,21 +90,24 @@ public IniFileReader(string fileName)
/// <summary>
/// Gets a <see cref="ReadOnlyCollection{T}"/> containing the names of the sections in the .INI file.
/// </summary>
public ReadOnlyCollection<string> SectionNames
{
get
{
List<string> keyList = new List<string>(this.iniFileStore.Keys);
return new ReadOnlyCollection<string>(keyList);
}
}
public ReadOnlyCollection<string> SectionNames => new ReadOnlyCollection<string>(new List<string>(this.iniFileStore.Keys));

/// <summary>
/// Gets a value from the .INI file.
/// </summary>
/// <param name="sectionName">The section in which to find the key-value pair.</param>
/// <param name="valueName">The key of the key-value pair.</param>
/// <returns>The value associated with the given section and key.</returns>
/// <exception cref="ArgumentNullException">
/// <para>If <paramref name="sectionName"/> is <see langword="null"/> or <see cref="string.Empty"/>.</para>
/// <para>-or-</para>
/// <para>If <paramref name="valueName"/> is <see langword="null"/> or <see cref="string.Empty"/>.</para>
/// </exception>
/// <exception cref="ArgumentException">
/// <para>If no section named <paramref name="sectionName"/> exists.</para>
/// <para>-or-</para>
///<para>If the section does not contain a value named <paramref name="valueName"/>.</para>
/// </exception>
public string GetValue(string sectionName, string valueName)
{
if (string.IsNullOrEmpty(sectionName))
Expand All @@ -117,19 +124,17 @@ public string GetValue(string sectionName, string valueName)

string lowerCaseValueName = valueName.ToUpperInvariant();

if (!this.iniFileStore.ContainsKey(lowerCaseSectionName))
if (!this.iniFileStore.TryGetValue(lowerCaseSectionName, out Dictionary<string, string>? section))
{
throw new ArgumentException("Section does not exist: " + sectionName, nameof(sectionName));
}

Dictionary<string, string> section = this.iniFileStore[lowerCaseSectionName];

if (!section.ContainsKey(lowerCaseValueName))
if (!section.TryGetValue(lowerCaseValueName, out string? value))
{
throw new ArgumentException("Value does not exist: " + valueName, nameof(valueName));
}

return section[lowerCaseValueName];
return value;
}
}
}
Loading
pFad - Phonifier reborn

Pfad - The Proxy pFad of © 2024 Garber Painting. All rights reserved.

Note: This service is not intended for secure transactions such as banking, social media, email, or purchasing. Use at your own risk. We assume no liability whatsoever for broken pages.


Alternative Proxies:

Alternative Proxy

pFad Proxy

pFad v3 Proxy

pFad v4 Proxy