File size: 11,475 Bytes
18a519f | 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 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 | using System;
using System.Collections.Generic;
using System.Linq;
using UnityEngine;
namespace UnityEditor.SettingsManagement
{
/// <summary>
/// Settings manages a collection of <see cref="ISettingsRepository"/>.
/// </summary>
public sealed class Settings
{
ISettingsRepository[] m_SettingsRepositories;
/// <value>
/// An event that is raised prior to an `ISettingsRepository` serializing it's current state.
/// </value>
public event Action beforeSettingsSaved;
/// <value>
/// An event that is raised after an `ISettingsRepository` has serialized it's current state.
/// </value>
public event Action afterSettingsSaved;
Settings()
{
}
/// <summary>
/// Create a new Settings instance with a <see cref="UserSettingsRepository"/> and <see cref="PackageSettingsRepository"/>.
/// </summary>
/// <param name="package">The package name. Ex, `com.unity.my-package`.</param>
/// <param name="settingsFileName">The name of the settings file. Defaults to "Settings."</param>
public Settings(string package, string settingsFileName = "Settings")
{
m_SettingsRepositories = new ISettingsRepository[]
{
new PackageSettingsRepository(package, settingsFileName),
new UserSettingsRepository()
};
}
/// <summary>
/// Create a new Settings instance with a collection of <see cref="ISettingsRepository"/>.
/// </summary>
public Settings(IEnumerable<ISettingsRepository> repositories)
{
m_SettingsRepositories = repositories.ToArray();
}
/// <summary>
/// Find a settings repository that matches the requested scope.
/// </summary>
/// <param name="scope">The scope of the settings repository to match.</param>
/// <returns>
/// An ISettingsRepository instance that is implementing the requested scope. May return null if no
/// matching repository is found.
/// </returns>
public ISettingsRepository GetRepository(SettingsScope scope)
{
foreach (var repo in m_SettingsRepositories)
if (repo.scope == scope)
return repo;
return null;
}
/// <summary>
/// Find a settings repository that matches the requested scope and name.
/// </summary>
/// <param name="scope">The scope of the settings repository to match.</param>
/// <param name="name">The name of the <see cref="ISettingsRepository"/> to match.</param>
/// <returns>
/// An <see cref="ISettingsRepository"/> instance that is implementing the requested scope, and matches name.
/// May return null if no matching repository is found.
/// </returns>
public ISettingsRepository GetRepository(SettingsScope scope, string name)
{
foreach (var repo in m_SettingsRepositories)
if (repo.scope == scope && string.Equals(repo.name, name))
return repo;
return null;
}
/// <summary>
/// Serialize the state of all settings repositories.
/// </summary>
public void Save()
{
if (beforeSettingsSaved != null)
beforeSettingsSaved();
foreach (var repo in m_SettingsRepositories)
repo.Save();
if (afterSettingsSaved != null)
afterSettingsSaved();
}
/// <summary>
/// Set a value for key of type T.
/// </summary>
/// <param name="key">The settings key.</param>
/// <param name="value">The value to set. Must be serializable.</param>
/// <param name="scope">Which scope this settings should be saved in.</param>
/// <typeparam name="T">Type of value.</typeparam>
public void Set<T>(string key, T value, SettingsScope scope = SettingsScope.Project)
{
bool foundScopeRepository = false;
foreach (var repo in m_SettingsRepositories)
{
if (repo.scope == scope)
{
repo.Set<T>(key, value);
foundScopeRepository = true;
}
}
if (!foundScopeRepository)
Debug.LogWarning("No repository for scope " + scope + " found!");
}
/// <summary>
/// Set a value for key of type T.
/// </summary>
/// <param name="key">The settings key.</param>
/// <param name="value">The value to set. Must be serializable.</param>
/// <param name="repositoryName">The repository name to match.</param>
/// <param name="scope">Which scope this settings should be saved in.</param>
/// <typeparam name="T">Type of value.</typeparam>
public void Set<T>(string key, T value, string repositoryName, SettingsScope scope = SettingsScope.Project)
{
bool foundScopeRepository = false;
foreach (var repo in m_SettingsRepositories)
{
if (repo.scope == scope && string.Equals(repo.name, repositoryName))
{
repo.Set<T>(key, value);
foundScopeRepository = true;
}
}
if (!foundScopeRepository)
Debug.LogWarning("No repository matching name \"" + repositoryName + "\" and scope " + scope + " found in settings.");
}
/// <summary>
/// Get a value with key of type T, or return the fallback value if no matching key is found.
/// </summary>
/// <param name="key">The settings key.</param>
/// <param name="scope">Which scope this settings should be retrieved from.</param>
/// <param name="fallback">If no key with a value of type T is found, this value is returned.</param>
/// <typeparam name="T">Type of value to search for.</typeparam>
public T Get<T>(string key, SettingsScope scope = SettingsScope.Project, T fallback = default(T))
{
foreach (var repo in m_SettingsRepositories)
{
if (repo.scope == scope)
return repo.Get<T>(key, fallback);
}
Debug.LogWarning("No repository for scope " + scope + " found!");
return fallback;
}
/// <summary>
/// Get a value with key of type T, or return the fallback value if no matching key is found.
/// </summary>
/// <param name="key">The settings key.</param>
/// <param name="repositoryName">The repository name to match.</param>
/// <param name="scope">Which scope this settings should be retrieved from.</param>
/// <param name="fallback">If no key with a value of type T is found, this value is returned.</param>
/// <typeparam name="T">Type of value to search for.</typeparam>
public T Get<T>(string key, string repositoryName, SettingsScope scope = SettingsScope.Project, T fallback = default(T))
{
foreach (var repo in m_SettingsRepositories)
{
if (repo.scope == scope && string.Equals(repo.name, repositoryName))
return repo.Get<T>(key, fallback);
}
Debug.LogWarning("No repository matching name \"" + repositoryName + "\" and scope " + scope + " found in settings.");
return fallback;
}
/// <summary>
/// Does the repository contain a setting with key and type.
/// </summary>
/// <param name="key">The settings key.</param>
/// <typeparam name="T">The type of value to search for.</typeparam>
/// <param name="scope">Which scope should be searched for matching key.</param>
/// <returns>True if a setting matching both key and type is found, false if no entry is found.</returns>
public bool ContainsKey<T>(string key, SettingsScope scope = SettingsScope.Project)
{
foreach (var repo in m_SettingsRepositories)
{
if (repo.scope == scope)
return repo.ContainsKey<T>(key);
}
Debug.LogWarning("No repository for scope " + scope + " found!");
return false;
}
/// <summary>
/// Does the repository contain a setting with key and type.
/// </summary>
/// <param name="key">The settings key.</param>
/// <param name="repositoryName">The repository name to match.</param>
/// <typeparam name="T">The type of value to search for.</typeparam>
/// <param name="scope">Which scope should be searched for matching key.</param>
/// <returns>True if a setting matching both key and type is found, false if no entry is found.</returns>
public bool ContainsKey<T>(string key, string repositoryName, SettingsScope scope = SettingsScope.Project)
{
foreach (var repo in m_SettingsRepositories)
{
if (repo.scope == scope && string.Equals(repo.name, repositoryName))
return repo.ContainsKey<T>(key);
}
Debug.LogWarning("No repository matching name \"" + repositoryName + "\" and scope " + scope + " found in settings.");
return false;
}
/// <summary>
/// Remove a key value pair from a settings repository.
/// </summary>
/// <param name="key">The key to remove.</param>
/// <param name="scope">Which scope should be searched for matching key.</param>
/// <typeparam name="T">The type that this key is pointing to.</typeparam>
public void DeleteKey<T>(string key, SettingsScope scope = SettingsScope.Project)
{
bool foundScopeRepository = false;
foreach (var repo in m_SettingsRepositories)
{
if (repo.scope == scope)
{
foundScopeRepository = true;
repo.Remove<T>(key);
}
}
if (!foundScopeRepository)
Debug.LogWarning("No repository for scope " + scope + " found!");
}
/// <summary>
/// Remove a key value pair from a settings repository.
/// </summary>
/// <param name="key">The key to remove.</param>
/// <param name="repositoryName">The repository name to match.</param>
/// <param name="scope">Which scope should be searched for matching key.</param>
/// <typeparam name="T">The type that this key is pointing to.</typeparam>
public void DeleteKey<T>(string key, string repositoryName, SettingsScope scope = SettingsScope.Project)
{
bool foundScopeRepository = false;
foreach (var repo in m_SettingsRepositories)
{
if (repo.scope == scope && string.Equals(repo.name, repositoryName))
{
foundScopeRepository = true;
repo.Remove<T>(key);
}
}
if (!foundScopeRepository)
Debug.LogWarning("No repository matching name \"" + repositoryName + "\" and scope " + scope + " found in settings.");
}
}
}
|