| | | 1 | | #if !CHRONICLER_DISABLE_MEMORYPACK |
| | | 2 | | |
| | | 3 | | using MemoryPack; |
| | | 4 | | using System; |
| | | 5 | | using System.Collections.Generic; |
| | | 6 | | using System.Diagnostics.CodeAnalysis; |
| | | 7 | | |
| | | 8 | | namespace Chronicler; |
| | | 9 | | |
| | | 10 | | /// <summary> |
| | | 11 | | /// Serializes <see cref="IRecordable"/> state graphs to and from MemoryPack through the chronicler API. |
| | | 12 | | /// </summary> |
| | | 13 | | public static class MemoryPackRecordSerializer |
| | | 14 | | { |
| | 1 | 15 | | private static readonly byte[] EmptyRecordBytes = MemoryPackSerializer.Serialize(new MemoryPackRecordEnvelope()); |
| | | 16 | | |
| | | 17 | | /// <summary> |
| | | 18 | | /// Serializes the current state of a recordable instance into MemoryPack bytes. |
| | | 19 | | /// </summary> |
| | | 20 | | public static byte[] Serialize(IRecordable target) |
| | 7 | 21 | | => Serialize(target, context: null); |
| | | 22 | | |
| | | 23 | | /// <summary> |
| | | 24 | | /// Serializes the current state of a recordable instance into MemoryPack bytes. |
| | | 25 | | /// </summary> |
| | | 26 | | public static byte[] Serialize(IRecordable target, ChronicleContext? context) |
| | | 27 | | { |
| | 31 | 28 | | if (target == null) |
| | 1 | 29 | | throw new ArgumentNullException(nameof(target)); |
| | | 30 | | |
| | 30 | 31 | | context ??= new ChronicleContext(); |
| | | 32 | | |
| | 30 | 33 | | var chronicler = new MemoryPackRecordWriter(context); |
| | 30 | 34 | | target.RecordData(chronicler); |
| | 29 | 35 | | return chronicler.ToArray(); |
| | | 36 | | } |
| | | 37 | | |
| | | 38 | | /// <summary> |
| | | 39 | | /// Loads MemoryPack state into an existing recordable instance. |
| | | 40 | | /// </summary> |
| | | 41 | | public static void Populate(IRecordable target, byte[] data) |
| | 5 | 42 | | => Populate(target, data, context: null); |
| | | 43 | | |
| | | 44 | | /// <summary> |
| | | 45 | | /// Loads MemoryPack state into an existing recordable instance. |
| | | 46 | | /// </summary> |
| | | 47 | | public static void Populate(IRecordable target, byte[] data, ChronicleContext? context) |
| | | 48 | | { |
| | 27 | 49 | | if (data == null) |
| | 1 | 50 | | throw new ArgumentNullException(nameof(data)); |
| | | 51 | | |
| | 26 | 52 | | Populate(target, data.AsSpan(), context); |
| | 20 | 53 | | } |
| | | 54 | | |
| | | 55 | | /// <summary> |
| | | 56 | | /// Loads MemoryPack state into an existing recordable instance. |
| | | 57 | | /// </summary> |
| | | 58 | | public static void Populate(IRecordable target, ReadOnlySpan<byte> data) |
| | 2 | 59 | | => Populate(target, data, context: null); |
| | | 60 | | |
| | | 61 | | /// <summary> |
| | | 62 | | /// Loads MemoryPack state into an existing recordable instance. |
| | | 63 | | /// </summary> |
| | | 64 | | public static void Populate(IRecordable target, ReadOnlySpan<byte> data, ChronicleContext? context) |
| | | 65 | | { |
| | 28 | 66 | | if (target == null) |
| | 1 | 67 | | throw new ArgumentNullException(nameof(target)); |
| | 27 | 68 | | if (data.IsEmpty) |
| | 1 | 69 | | throw new ArgumentException("Serialized bytes must not be empty.", nameof(data)); |
| | | 70 | | |
| | 26 | 71 | | context ??= new ChronicleContext(); |
| | | 72 | | |
| | 26 | 73 | | var chronicler = new MemoryPackRecordReader(data, context); |
| | 26 | 74 | | target.RecordData(chronicler); |
| | 23 | 75 | | context.ResolveDeferredLinks(); |
| | 21 | 76 | | } |
| | | 77 | | |
| | | 78 | | private sealed class MemoryPackRecordWriter : IChronicler |
| | | 79 | | { |
| | 49 | 80 | | private readonly OrderedStringMap<byte[]?> _entries = new(8, StringComparer.Ordinal); |
| | | 81 | | |
| | 49 | 82 | | public MemoryPackRecordWriter(ChronicleContext context) |
| | | 83 | | { |
| | 49 | 84 | | Context = context ?? throw new ArgumentNullException(nameof(context)); |
| | 49 | 85 | | } |
| | | 86 | | |
| | | 87 | | public ChronicleContext Context { get; } |
| | | 88 | | |
| | 17 | 89 | | public SerializationMode Mode => SerializationMode.Saving; |
| | | 90 | | |
| | | 91 | | public void LookValue<T>(ref T value, string name, T? defaultValue = default) |
| | | 92 | | { |
| | 50 | 93 | | if (value is null || EqualityComparer<T>.Default.Equals(value, defaultValue!)) |
| | 10 | 94 | | return; |
| | | 95 | | |
| | 40 | 96 | | _entries[name] = MemoryPackSerializer.Serialize(value); |
| | 40 | 97 | | } |
| | | 98 | | |
| | | 99 | | public void LookDeep<T>(ref T value, string name) where T : class, IRecordable |
| | | 100 | | { |
| | 12 | 101 | | if (value == null) |
| | | 102 | | { |
| | 1 | 103 | | _entries[name] = null; |
| | 1 | 104 | | return; |
| | | 105 | | } |
| | | 106 | | |
| | 11 | 107 | | var nested = new MemoryPackRecordWriter(Context); |
| | 11 | 108 | | value.RecordData(nested); |
| | 11 | 109 | | _entries[name] = nested.ToArray(); |
| | 11 | 110 | | } |
| | | 111 | | |
| | | 112 | | public void LookDeepStruct<T>(ref T value, string name) where T : struct, IRecordable |
| | | 113 | | { |
| | 5 | 114 | | var nested = new MemoryPackRecordWriter(Context); |
| | 5 | 115 | | value.RecordData(nested); |
| | 5 | 116 | | _entries[name] = nested.ToArray(); |
| | 5 | 117 | | } |
| | | 118 | | |
| | | 119 | | public void LookNullableDeep<T>(ref T? value, string name) where T : struct, IRecordable |
| | | 120 | | { |
| | 5 | 121 | | if (!value.HasValue) |
| | 2 | 122 | | return; |
| | | 123 | | |
| | 3 | 124 | | T nestedValue = value.Value; |
| | 3 | 125 | | var nested = new MemoryPackRecordWriter(Context); |
| | 3 | 126 | | nestedValue.RecordData(nested); |
| | 3 | 127 | | _entries[name] = nested.ToArray(); |
| | 3 | 128 | | } |
| | | 129 | | |
| | | 130 | | public void LookLink<T>( |
| | | 131 | | ref T value, |
| | | 132 | | string name, |
| | | 133 | | string? slot = null, |
| | | 134 | | RecordLinkResolveMode resolveMode = RecordLinkResolveMode.Immediate, |
| | | 135 | | Action<T>? assignLoadedValue = null) |
| | | 136 | | { |
| | 12 | 137 | | string? id = null; |
| | 12 | 138 | | if (value is not null |
| | 12 | 139 | | && !Context.Links.TryGetReferenceId(value, out id, slot)) |
| | | 140 | | { |
| | 1 | 141 | | throw new InvalidOperationException( |
| | 1 | 142 | | $"Unable to save link '{name}' of type {typeof(T).Name} because no stable id could be produced{Forma |
| | | 143 | | } |
| | | 144 | | |
| | 11 | 145 | | _entries[name] = MemoryPackSerializer.Serialize(id); |
| | 11 | 146 | | } |
| | | 147 | | |
| | | 148 | | public byte[] ToArray() |
| | | 149 | | { |
| | 48 | 150 | | return MemoryPackSerializer.Serialize(MemoryPackRecordEnvelope.FromEntries(_entries)); |
| | | 151 | | } |
| | | 152 | | } |
| | | 153 | | |
| | | 154 | | private sealed class MemoryPackRecordReader : IChronicler |
| | | 155 | | { |
| | | 156 | | private readonly OrderedStringMap<byte[]?> _entries; |
| | | 157 | | |
| | 47 | 158 | | public MemoryPackRecordReader(ReadOnlySpan<byte> data, ChronicleContext context) |
| | | 159 | | { |
| | 47 | 160 | | MemoryPackRecordEnvelope? envelope = MemoryPackSerializer.Deserialize<MemoryPackRecordEnvelope>(data); |
| | 47 | 161 | | _entries = envelope?.ToEntryMap() ?? new OrderedStringMap<byte[]?>(8, StringComparer.Ordinal); |
| | 47 | 162 | | Context = context ?? throw new ArgumentNullException(nameof(context)); |
| | 47 | 163 | | } |
| | | 164 | | |
| | | 165 | | public ChronicleContext Context { get; } |
| | | 166 | | |
| | 13 | 167 | | public SerializationMode Mode => SerializationMode.Loading; |
| | | 168 | | |
| | | 169 | | public void LookValue<T>(ref T value, string name, T? defaultValue = default) |
| | | 170 | | { |
| | 50 | 171 | | if (!_entries.TryGetValue(name, out byte[]? entry) |
| | 50 | 172 | | || entry == null) |
| | | 173 | | { |
| | 24 | 174 | | value = defaultValue!; |
| | 24 | 175 | | return; |
| | | 176 | | } |
| | | 177 | | |
| | 26 | 178 | | T? loadedValue = MemoryPackSerializer.Deserialize<T>(entry); |
| | 26 | 179 | | if (loadedValue is null) |
| | | 180 | | { |
| | 1 | 181 | | value = defaultValue!; |
| | 1 | 182 | | return; |
| | | 183 | | } |
| | | 184 | | |
| | 25 | 185 | | value = loadedValue; |
| | 25 | 186 | | } |
| | | 187 | | |
| | | 188 | | public void LookDeep<T>(ref T value, string name) where T : class, IRecordable |
| | | 189 | | { |
| | 11 | 190 | | if (!_entries.TryGetValue(name, out byte[]? entry) |
| | 11 | 191 | | || entry == null) |
| | 2 | 192 | | return; |
| | | 193 | | |
| | 9 | 194 | | if (value == null) |
| | 1 | 195 | | throw new InvalidOperationException( |
| | 1 | 196 | | $"Unable to load '{name}' because {typeof(T).Name} must already be instantiated for a deep chronicle |
| | | 197 | | |
| | 8 | 198 | | var nested = new MemoryPackRecordReader(entry, Context); |
| | 8 | 199 | | value.RecordData(nested); |
| | 8 | 200 | | } |
| | | 201 | | |
| | | 202 | | public void LookDeepStruct<T>(ref T value, string name) where T : struct, IRecordable |
| | | 203 | | { |
| | 5 | 204 | | value = CreateDefaultDeepStruct<T>(); |
| | | 205 | | |
| | 5 | 206 | | if (!_entries.TryGetValue(name, out byte[]? entry) |
| | 5 | 207 | | || entry == null) |
| | 1 | 208 | | return; |
| | | 209 | | |
| | 4 | 210 | | var nested = new MemoryPackRecordReader(entry, Context); |
| | 4 | 211 | | value.RecordData(nested); |
| | 4 | 212 | | } |
| | | 213 | | |
| | | 214 | | public void LookNullableDeep<T>(ref T? value, string name) where T : struct, IRecordable |
| | | 215 | | { |
| | 5 | 216 | | if (!_entries.TryGetValue(name, out byte[]? entry) |
| | 5 | 217 | | || entry == null) |
| | | 218 | | { |
| | 3 | 219 | | value = null; |
| | 3 | 220 | | return; |
| | | 221 | | } |
| | | 222 | | |
| | 2 | 223 | | T nestedValue = CreateDefaultDeepStruct<T>(); |
| | 2 | 224 | | var nested = new MemoryPackRecordReader(entry, Context); |
| | 2 | 225 | | nestedValue.RecordData(nested); |
| | 2 | 226 | | value = nestedValue; |
| | 2 | 227 | | } |
| | | 228 | | |
| | | 229 | | public void LookLink<T>( |
| | | 230 | | ref T value, |
| | | 231 | | string name, |
| | | 232 | | string? slot = null, |
| | | 233 | | RecordLinkResolveMode resolveMode = RecordLinkResolveMode.Immediate, |
| | | 234 | | Action<T>? assignLoadedValue = null) |
| | | 235 | | { |
| | 10 | 236 | | if (!TryReadLinkId(name, out string? id)) |
| | | 237 | | { |
| | 2 | 238 | | value = default!; |
| | 2 | 239 | | return; |
| | | 240 | | } |
| | | 241 | | |
| | 8 | 242 | | if (resolveMode == RecordLinkResolveMode.Deferred) |
| | | 243 | | { |
| | 5 | 244 | | LoadDeferredLink(ref value, name, id, slot, assignLoadedValue); |
| | 4 | 245 | | return; |
| | | 246 | | } |
| | | 247 | | |
| | 3 | 248 | | LoadImmediateLink(ref value, name, id, slot, assignLoadedValue); |
| | 2 | 249 | | } |
| | | 250 | | |
| | | 251 | | private bool TryReadLinkId(string name, [NotNullWhen(true)] out string? id) |
| | | 252 | | { |
| | 10 | 253 | | if (!_entries.TryGetValue(name, out byte[]? entry) |
| | 10 | 254 | | || entry == null) |
| | | 255 | | { |
| | 1 | 256 | | id = null; |
| | 1 | 257 | | return false; |
| | | 258 | | } |
| | | 259 | | |
| | 9 | 260 | | id = MemoryPackSerializer.Deserialize<string>(entry); |
| | 9 | 261 | | return id != null; |
| | | 262 | | } |
| | | 263 | | |
| | | 264 | | private void LoadDeferredLink<T>( |
| | | 265 | | ref T value, |
| | | 266 | | string name, |
| | | 267 | | string id, |
| | | 268 | | string? slot, |
| | | 269 | | Action<T>? assignLoadedValue) |
| | | 270 | | { |
| | 5 | 271 | | if (assignLoadedValue == null) |
| | 1 | 272 | | throw new InvalidOperationException( |
| | 1 | 273 | | $"Deferred link '{name}' of type {typeof(T).Name} requires an assignment callback."); |
| | | 274 | | |
| | 4 | 275 | | if (Context.Links.TryResolve(id, out T? deferredValue, slot)) |
| | | 276 | | { |
| | 1 | 277 | | value = deferredValue!; |
| | 1 | 278 | | assignLoadedValue(deferredValue!); |
| | 1 | 279 | | return; |
| | | 280 | | } |
| | | 281 | | |
| | 3 | 282 | | Context.QueueDeferredLink(name, id, slot, assignLoadedValue); |
| | 3 | 283 | | value = default!; |
| | 3 | 284 | | } |
| | | 285 | | |
| | | 286 | | private void LoadImmediateLink<T>( |
| | | 287 | | ref T value, |
| | | 288 | | string name, |
| | | 289 | | string id, |
| | | 290 | | string? slot, |
| | | 291 | | Action<T>? assignLoadedValue) |
| | | 292 | | { |
| | 3 | 293 | | if (!Context.Links.TryResolve(id, out T? resolvedValue, slot)) |
| | 1 | 294 | | throw new InvalidOperationException( |
| | 1 | 295 | | $"Unable to load link '{name}' of type {typeof(T).Name} with id '{id}'{FormatSlot(slot)}."); |
| | | 296 | | |
| | 2 | 297 | | value = resolvedValue!; |
| | 2 | 298 | | assignLoadedValue?.Invoke(resolvedValue!); |
| | 2 | 299 | | } |
| | | 300 | | |
| | | 301 | | private T CreateDefaultDeepStruct<T>() where T : struct, IRecordable |
| | | 302 | | { |
| | 7 | 303 | | T defaultValue = new(); |
| | 7 | 304 | | var nested = new MemoryPackRecordReader(EmptyRecordBytes, Context); |
| | 7 | 305 | | defaultValue.RecordData(nested); |
| | 7 | 306 | | return defaultValue; |
| | | 307 | | } |
| | | 308 | | } |
| | | 309 | | |
| | | 310 | | private static string FormatSlot(string? slot) |
| | | 311 | | { |
| | 2 | 312 | | return string.IsNullOrEmpty(slot) |
| | 2 | 313 | | ? string.Empty |
| | 2 | 314 | | : $" in slot '{slot}'"; |
| | | 315 | | } |
| | | 316 | | } |
| | | 317 | | |
| | | 318 | | #endif |