summaryrefslogtreecommitdiff
path: root/src/SMAPI/Framework/StateTracking/FieldWatchers/NetListWatcher.cs
blob: 5b6a3e1f4c67ca6ec8e9cd54d9b01b203e738fa5 (plain)
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
using System.Collections.Generic;
using Netcode;
using StardewModdingAPI.Framework.StateTracking.Comparers;

namespace StardewModdingAPI.Framework.StateTracking.FieldWatchers
{
    /// <summary>A watcher which detects changes to a net list field.</summary>
    /// <typeparam name="TValue">The list value type.</typeparam>
    internal class NetListWatcher<TValue> : BaseDisposableWatcher, ICollectionWatcher<TValue>
        where TValue : class, INetObject<INetSerializable>
    {
        /*********
        ** Fields
        *********/
        /// <summary>The field being watched.</summary>
        private readonly NetList<TValue, NetRef<TValue>> Field;

        /// <summary>The pairs added since the last reset.</summary>
        private readonly ISet<TValue> AddedImpl = new HashSet<TValue>(new ObjectReferenceComparer<TValue>());

        /// <summary>The pairs removed since the last reset.</summary>
        private readonly ISet<TValue> RemovedImpl = new HashSet<TValue>(new ObjectReferenceComparer<TValue>());


        /*********
        ** Accessors
        *********/
        /// <inheritdoc />
        public string Name { get; }

        /// <inheritdoc />
        public bool IsChanged => this.AddedImpl.Count > 0 || this.RemovedImpl.Count > 0;

        /// <inheritdoc />
        public IEnumerable<TValue> Added => this.AddedImpl;

        /// <inheritdoc />
        public IEnumerable<TValue> Removed => this.RemovedImpl;


        /*********
        ** Public methods
        *********/
        /// <summary>Construct an instance.</summary>
        /// <param name="name">A name which identifies what the watcher is watching, used for troubleshooting.</param>
        /// <param name="field">The field to watch.</param>
        public NetListWatcher(string name, NetList<TValue, NetRef<TValue>> field)
        {
            this.Name = name;
            this.Field = field;
            field.OnElementChanged += this.OnElementChanged;
            field.OnArrayReplaced += this.OnArrayReplaced;
        }

        /// <inheritdoc />
        public void Reset()
        {
            this.AddedImpl.Clear();
            this.RemovedImpl.Clear();
        }

        /// <inheritdoc />
        public void Update()
        {
            this.AssertNotDisposed();
        }

        /// <inheritdoc />
        public override void Dispose()
        {
            if (!this.IsDisposed)
            {
                this.Field.OnElementChanged -= this.OnElementChanged;
                this.Field.OnArrayReplaced -= this.OnArrayReplaced;
            }

            base.Dispose();
        }


        /*********
        ** Private methods
        *********/
        /// <summary>A callback invoked when the value list is replaced.</summary>
        /// <param name="list">The net field whose values changed.</param>
        /// <param name="oldValues">The previous list of values.</param>
        /// <param name="newValues">The new list of values.</param>
        private void OnArrayReplaced(NetList<TValue, NetRef<TValue>> list, IList<TValue> oldValues, IList<TValue> newValues)
        {
            ISet<TValue> oldSet = new HashSet<TValue>(oldValues, new ObjectReferenceComparer<TValue>());
            ISet<TValue> changed = new HashSet<TValue>(newValues, new ObjectReferenceComparer<TValue>());

            foreach (TValue value in oldSet)
            {
                if (!changed.Contains(value))
                    this.Remove(value);
            }
            foreach (TValue value in changed)
            {
                if (!oldSet.Contains(value))
                    this.Add(value);
            }
        }

        /// <summary>A callback invoked when an entry is replaced.</summary>
        /// <param name="list">The net field whose values changed.</param>
        /// <param name="index">The list index which changed.</param>
        /// <param name="oldValue">The previous value.</param>
        /// <param name="newValue">The new value.</param>
        private void OnElementChanged(NetList<TValue, NetRef<TValue>> list, int index, TValue? oldValue, TValue? newValue)
        {
            this.Remove(oldValue);
            this.Add(newValue);
        }

        /// <summary>Track an added item.</summary>
        /// <param name="value">The value that was added.</param>
        private void Add(TValue? value)
        {
            if (value == null)
                return;

            if (this.RemovedImpl.Contains(value))
            {
                this.AddedImpl.Remove(value);
                this.RemovedImpl.Remove(value);
            }
            else
                this.AddedImpl.Add(value);
        }

        /// <summary>Track a removed item.</summary>
        /// <param name="value">The value that was removed.</param>
        private void Remove(TValue? value)
        {
            if (value == null)
                return;

            if (this.AddedImpl.Contains(value))
            {
                this.AddedImpl.Remove(value);
                this.RemovedImpl.Remove(value);
            }
            else
                this.RemovedImpl.Add(value);
        }
    }
}