Merge pull request #114 from TheDavSmasher/modded-option-list-enumeration-fix

Changed IModdedOptionList structure to actually allow typed iteration
This commit is contained in:
AS authored and GitHub committed 2026-11-11 00:28:36 -05:00
commit a8f129f0ce
10 files changed
+58 -42

No files matched your search

+6
View File
@@ -105,6 +105,12 @@ dotnet_diagnostic.S1244.severity = none
# S2325: Methods and properties that don't access instance data should be static
dotnet_diagnostic.S2325.severity = none
# CA1710: Identifiers should have correct suffix
dotnet_diagnostic.CA1710.severity = silent
# CA1010: Generic interface should also be implemented
dotnet_diagnostic.CA1010.severity = silent
# IDE0005: Using directive is unnecessary.
dotnet_diagnostic.IDE0005.severity = warning
@@ -15,7 +15,7 @@ namespace MiraAPI.GameOptions.Attributes;
public class ModdedEnumOptionListAttribute(string title, Type enumType, string[]? values = null)
: ModdedOptionListAttribute(title)
{
internal override IModdedOptionList CreateOptionList(IList value, PropertyInfo property)
internal override IBaseModdedOptionList CreateOptionList(IList value, PropertyInfo property)
{
var optList = new ModdedOptionList<ModdedEnumOption>(
value.Count, idx => new(GetFormattedTitle(idx), (int)(value[idx] ?? 0), enumType, values));
@@ -25,14 +25,14 @@ public class ModdedEnumOptionListAttribute(string title, Type enumType, string[]
/// <inheritdoc />
public override void SetValue(int idx, object value)
{
var opt = HolderOptionList?[idx] as ModdedEnumOption;
var opt = HolderOptionList?.ElementAt(idx) as ModdedEnumOption;
opt?.SetValue((int)value);
}
/// <inheritdoc />
public override object GetValue(int idx)
{
return HolderOptionList?[idx] is ModdedEnumOption opt
return HolderOptionList?.ElementAt(idx) is ModdedEnumOption opt
? Enum.ToObject(enumType, opt.Value)
: throw new InvalidOperationException($"HolderOption for option \"{GetFormattedTitle(idx)}\" with EnumType {enumType.FullName} is not a ModdedEnumOption");
}
@@ -49,7 +49,7 @@ public class ModdedEnumOptionListAttribute<T>(string title, string[]? values = n
: ModdedOptionListAttribute(title)
where T : struct, Enum
{
internal override IModdedOptionList CreateOptionList(IList value, PropertyInfo property)
internal override IBaseModdedOptionList CreateOptionList(IList value, PropertyInfo property)
{
var optList = new ModdedOptionList<ModdedEnumOption<T>>(
value.Count, idx => new(GetFormattedTitle(idx), (T)(value[idx] ?? 0), values));
@@ -59,14 +59,14 @@ public class ModdedEnumOptionListAttribute<T>(string title, string[]? values = n
/// <inheritdoc />
public override void SetValue(int idx, object value)
{
var opt = HolderOptionList?[idx] as ModdedEnumOption<T>;
var opt = HolderOptionList?.ElementAt(idx) as ModdedEnumOption<T>;
opt?.SetValue((T)value);
}
/// <inheritdoc />
public override object GetValue(int idx)
{
return HolderOptionList?[idx] is ModdedEnumOption<T> opt
return HolderOptionList?.ElementAt(idx) is ModdedEnumOption<T> opt
? opt.Value
: throw new InvalidOperationException($"HolderOption for option \"{GetFormattedTitle(idx)}\" with EnumType {typeof(T).FullName} is not a ModdedEnumOption<{typeof(T).FullName}>");
}
@@ -53,7 +53,7 @@ public class ModdedNumberOptionListAttribute(
{
}
internal override IModdedOptionList CreateOptionList(IList value, PropertyInfo property)
internal override IBaseModdedOptionList CreateOptionList(IList value, PropertyInfo property)
{
return new ModdedOptionList<ModdedNumberOption>(value.Count, idx =>
{
@@ -81,7 +81,7 @@ public class ModdedNumberOptionListAttribute(
/// <inheritdoc />
public override void SetValue(int idx, object value)
{
if (HolderOptionList?[idx] is not ModdedNumberOption opt)
if (HolderOptionList?.ElementAt(idx) is not ModdedNumberOption opt)
return;
var final = value switch
@@ -95,7 +95,7 @@ public class ModdedNumberOptionListAttribute(
/// <inheritdoc />
public override object GetValue(int idx)
{
if (HolderOptionList?[idx] is not ModdedNumberOption opt)
if (HolderOptionList?.ElementAt(idx) is not ModdedNumberOption opt)
throw new InvalidOperationException($"HolderOption for option \"{GetFormattedTitle(idx)}\" is not a ModdedNumberOption");
var value = opt.Value;
@@ -16,7 +16,7 @@ namespace MiraAPI.GameOptions.Attributes;
[SuppressMessage("StyleCop.CSharp.MaintainabilityRules", "SA1401:Fields should be private", Justification = "Read above.")]
public abstract class ModdedOptionListAttribute(string title) : PropertyOptionAttribute
{
internal IModdedOptionList? HolderOptionList;
internal IBaseModdedOptionList? HolderOptionList;
internal IList? Value;
internal Type ValueType;
@@ -70,7 +70,7 @@ public abstract class ModdedOptionListAttribute(string title) : PropertyOptionAt
/// <returns>The value of the option as an object.</returns>
public abstract object GetValue(int idx);
internal abstract IModdedOptionList? CreateOptionList(IList value, PropertyInfo property);
internal abstract IBaseModdedOptionList? CreateOptionList(IList value, PropertyInfo property);
/// <summary>
/// Gets the <see cref="Title"/> formatted with the option's index.
@@ -16,7 +16,7 @@ public class ModdedPlayerOptionListAttribute(
bool allowNone = true)
: ModdedOptionListAttribute(title)
{
internal override IModdedOptionList CreateOptionList(IList value, PropertyInfo property)
internal override IBaseModdedOptionList CreateOptionList(IList value, PropertyInfo property)
{
return new ModdedOptionList<ModdedPlayerOption>(value.Count, idx => new(GetFormattedTitle(idx), allowNone));
}
@@ -24,7 +24,7 @@ public class ModdedPlayerOptionListAttribute(
/// <inheritdoc />
public override void SetValue(int idx, object value)
{
if (HolderOptionList?[idx] is not ModdedPlayerOption opt)
if (HolderOptionList?.ElementAt(idx) is not ModdedPlayerOption opt)
return;
var final = value switch
@@ -38,7 +38,7 @@ public class ModdedPlayerOptionListAttribute(
/// <inheritdoc />
public override object GetValue(int idx)
{
if (HolderOptionList?[idx] is not ModdedPlayerOption opt)
if (HolderOptionList?.ElementAt(idx) is not ModdedPlayerOption opt)
throw new InvalidOperationException($"HolderOption for option \"{GetFormattedTitle(idx)}\" is not a ModdedPlayerOption");
if (ValueType == typeof(int))
@@ -17,7 +17,7 @@ public class ModdedStringOptionListAttribute(
string[] values)
: ModdedOptionListAttribute(title)
{
internal override IModdedOptionList CreateOptionList(IList value, PropertyInfo property)
internal override IBaseModdedOptionList CreateOptionList(IList value, PropertyInfo property)
{
return new ModdedOptionList<ModdedStringOption>(value.Count, idx =>
new ModdedStringOption(Title.Translate(), (string)(value[idx] ?? string.Empty), values));
@@ -26,14 +26,14 @@ public class ModdedStringOptionListAttribute(
/// <inheritdoc />
public override void SetValue(int idx, object value)
{
var opt = HolderOptionList?[idx] as ModdedStringOption;
var opt = HolderOptionList?.ElementAt(idx) as ModdedStringOption;
opt?.SetValue((string)value);
}
/// <inheritdoc />
public override object GetValue(int idx)
{
return HolderOptionList?[idx] is ModdedStringOption opt
return HolderOptionList?.ElementAt(idx) is ModdedStringOption opt
? opt.Value
: throw new InvalidOperationException($"HolderOption for option \"{GetFormattedTitle(idx)}\" is not a ModdedStringOption");
}
@@ -28,7 +28,7 @@ public class ModdedToggleOptionListAttribute(
{
}
internal override IModdedOptionList CreateOptionList(IList value, PropertyInfo property)
internal override IBaseModdedOptionList CreateOptionList(IList value, PropertyInfo property)
{
var optList = new ModdedOptionList<ModdedToggleOption>(
value.Count, idx => new(GetFormattedTitle(idx), (bool)(value[idx] ?? false), on, off));
@@ -38,14 +38,14 @@ public class ModdedToggleOptionListAttribute(
/// <inheritdoc />
public override void SetValue(int idx, object value)
{
var opt = HolderOptionList?[idx] as ModdedToggleOption;
var opt = HolderOptionList?.ElementAt(idx) as ModdedToggleOption;
opt?.SetValue((bool)value);
}
/// <inheritdoc />
public override object GetValue(int idx)
{
return HolderOptionList?[idx] is ModdedToggleOption opt
return HolderOptionList?.ElementAt(idx) is ModdedToggleOption opt
? opt.Value
: throw new InvalidOperationException($"Holder option for {GetFormattedTitle(idx)} is not a ModdedToggleOption.");
}
+27 -8
View File
@@ -1,4 +1,5 @@
using System;
using System.Collections;
using System.Collections.Generic;
using BepInEx.Configuration;
using MiraAPI.Networking;
@@ -143,9 +144,11 @@ public interface IModdedOption
}
/// <summary>
/// Interface for list of modded options.
/// Base interface for list of modded options.
/// <para/>
/// Do not implement directly, implement <see cref="IModdedOptionList"/> or <see cref="IModdedOptionList{T}"/> instead.
/// </summary>
public interface IModdedOptionList : IReadOnlyList<IModdedOption>
public interface IBaseModdedOptionList : IEnumerable
{
/// <summary>
/// Gets the function to name the keys of the individual options in the configuration file.
@@ -153,18 +156,34 @@ public interface IModdedOptionList : IReadOnlyList<IModdedOption>
/// Return <see langword="null"/> to use the default of the property's name with its index appended.
/// </summary>
Func<int, string>? ConfigName { get; init; }
/// <inheritdoc cref="IReadOnlyCollection{T}.Count"/>
int Count { get; }
/// <inheritdoc cref="System.Linq.Enumerable.ElementAt{TSource}(IEnumerable{TSource}, int)"/>
IModdedOption ElementAt(int index);
}
/// <summary>
/// Interface for list of modded options.
/// </summary>
public interface IModdedOptionList : IBaseModdedOptionList, IReadOnlyList<IModdedOption>
{
IModdedOption IBaseModdedOptionList.ElementAt(int index)
{
return this[index];
}
}
/// <summary>
/// Interface for list of <typeparamref name="T"/> options.
/// </summary>
/// <typeparam name="T">The type of <see cref="IModdedOption"/>.</typeparam>
public interface IModdedOptionList<out T> : IModdedOptionList
public interface IModdedOptionList<out T> : IBaseModdedOptionList, IReadOnlyList<T>
where T : IModdedOption
{
/// <inheritdoc cref="IReadOnlyList{T}.this[int]"/>
new T this[int index] { get; }
/// <inheritdoc cref="IEnumerable{T}.GetEnumerator"/>
new IEnumerator<T> GetEnumerator();
IModdedOption IBaseModdedOptionList.ElementAt(int index)
{
return this[index];
}
}
+5 -5
View File
@@ -116,7 +116,7 @@ public static class ModdedOptionsManager
continue;
}
if (property.PropertyType.IsAssignableTo(typeof(IModdedOptionList)))
if (property.PropertyType.IsAssignableTo(typeof(IBaseModdedOptionList)))
{
RegisterPropertyOptionList(type, property, pluginInfo);
continue;
@@ -136,7 +136,7 @@ public static class ModdedOptionsManager
foreach (var field in type.GetFields(MiraPluginManager.DeclaredInstanceMembers)
.Where(f => !MiraPluginManager.IsAutoPropertyBackingField(f)
&& (f.FieldType.IsAssignableTo(typeof(IModdedOption)) || f.FieldType.IsAssignableTo(typeof(IModdedOptionList)))))
&& (f.FieldType.IsAssignableTo(typeof(IModdedOption)) || f.FieldType.IsAssignableTo(typeof(IBaseModdedOptionList)))))
{
Error($"{field.Name} is a field, not a property. Use properties for options.");
}
@@ -234,7 +234,7 @@ public static class ModdedOptionsManager
return;
}
if (property.GetValue(group) is not IModdedOptionList optionList)
if (property.GetValue(group) is not IBaseModdedOptionList optionList)
{
Error($"Failed to get option list for {property.Name}");
return;
@@ -244,7 +244,7 @@ public static class ModdedOptionsManager
for (var i = 0; i < optionList.Count; i++)
{
RegisterOption(optionList[i], group, configName(i), pluginInfo);
RegisterOption(optionList.ElementAt(i), group, configName(i), pluginInfo);
}
}
@@ -341,7 +341,7 @@ public static class ModdedOptionsManager
for (var i = 0; i < optionList.Count; i++)
{
var option = optionList[i];
var option = optionList.ElementAt(i);
if (visibilityFactory != null)
option.Visible = (Func<bool>)(visibilityFactory(i) ?? DelegateUtilities.AlwaysTrue);
@@ -62,13 +62,4 @@ public class ModdedOptionList<T> : IModdedOptionList<T>
{
return Options.GetEnumerator();
}
/// <inheritdoc cref="IEnumerable{T}.GetEnumerator"/>
IEnumerator<IModdedOption> IEnumerable<IModdedOption>.GetEnumerator()
{
return ((IEnumerable<IModdedOption>)Options).GetEnumerator();
}
/// <inheritdoc cref="IReadOnlyList{T}.this"/>
IModdedOption IReadOnlyList<IModdedOption>.this[int index] => this[index];
}