using System;
using System.Linq;
namespace BepInEx.Configuration
{
///
/// Section and key of a setting. Used as a unique key for identification within a .
/// The same definition can be used in multiple config files, it will point to different settings then.
///
///
public class ConfigDefinition : IEquatable
{
///
/// Group of the setting. All settings within a config file are grouped by this.
///
public string Section { get; }
///
/// Name of the setting.
///
public string Key { get; }
///
/// Create a new definition. Definitions with same section and key are equal.
///
/// Group of the setting, case sensitive.
/// Name of the setting, case sensitive.
public ConfigDefinition(string section, string key)
{
CheckInvalidConfigChars(section, nameof(section));
CheckInvalidConfigChars(key, nameof(key));
Key = key;
Section = section;
}
private static readonly char[] _invalidConfigChars = { '=', '\n', '\t', '\\', '"', '\'', '[', ']' };
private static void CheckInvalidConfigChars(string val, string name)
{
if (val == null) throw new ArgumentNullException(name);
if (val != val.Trim()) throw new ArgumentException("Cannot use whitespace characters at start or end of section and key names", name);
if (val.Any(c => _invalidConfigChars.Contains(c))) throw new ArgumentException(@"Cannot use any of the following characters in section and key names: = \n \t \ "" ' [ ]", name);
}
///
[Obsolete("description argument is no longer used, put it in a ConfigDescription instead")]
public ConfigDefinition(string section, string key, string description)
{
Key = key ?? "";
Section = section ?? "";
}
///
/// Check if the definitions are the same.
///
///
public bool Equals(ConfigDefinition other)
{
if (other == null) return false;
return string.Equals(Key, other.Key)
&& string.Equals(Section, other.Section);
}
///
/// Check if the definitions are the same.
///
public override bool Equals(object obj)
{
if (ReferenceEquals(null, obj))
return false;
if (ReferenceEquals(this, obj))
return true;
return Equals(obj as ConfigDefinition);
}
///
public override int GetHashCode()
{
unchecked
{
int hashCode = Key != null ? Key.GetHashCode() : 0;
hashCode = (hashCode * 397) ^ (Section != null ? Section.GetHashCode() : 0);
return hashCode;
}
}
///
/// Check if the definitions are the same.
///
public static bool operator ==(ConfigDefinition left, ConfigDefinition right)
=> Equals(left, right);
///
/// Check if the definitions are the same.
///
public static bool operator !=(ConfigDefinition left, ConfigDefinition right)
=> !Equals(left, right);
///
public override string ToString()
{
return Section + "." + Key;
}
}
}