In general, moved XML comments to IModuleDB, but enabled their generation here.
[ModuleDB.git] / ModuleDB.cs
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
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
// ModuleDB
//
// ModuleDB.cs
//
// Copyright © 2014, toadicus
// All rights reserved.
//
// Redistribution and use in source and binary forms, with or without modification,
// are permitted provided that the following conditions are met:
//
// 1. Redistributions of source code must retain the above copyright notice,
//    this list of conditions and the following disclaimer.
//
// 2. Redistributions in binary form must reproduce the above copyright notice,
//    this list of conditions and the following disclaimer in the documentation and/or other
//    materials provided with the distribution.
//
// THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES,
// INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
// DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
// SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
// SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY,
// WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
// OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 
using KSP;
using System;
using System.Collections.Generic;
using ToadicusTools;
using UnityEngine;
 
namespace ModuleDB
{
        /// <summary>
        /// A generic, caching database of PartModule derivatives keyed by Vessel and Part.
        /// </summary>
        public class ModuleDB<T> : IModuleDB<T>
                where T : PartModule
        {
                private static IModuleDB<T> _instance;
 
                /// <summary>
                /// Gets the ModuleDB instance for the specified type
                /// </summary>
                /// <value>The ModuleDB instance for the specified type</value>
                public static IModuleDB<T> Instance
                {
                        get
                        {
                                if (_instance == null)
                                {
                                        _instance = new ModuleDB<T>();
                                }
 
                                return _instance;
                        }
                }
 
                private Dictionary<Guid, Dictionary<uint, List<T>>> vesselPartModuleDB;
 
                private Dictionary<Guid, List<T>> vesselModuleTable;
 
                private Guid editorVesselID;
 
                #if BENCH
                public int cacheHits { get; protected set; }
                public int cacheMisses { get; protected set; }
                #endif
 
                private ModuleDB()
                {
                        // Initialize the caches.
                        vesselPartModuleDB = new Dictionary<Guid, Dictionary<uint, List<T>>>();
                        vesselModuleTable = new Dictionary<Guid, List<T>>();
 
                        editorVesselID = new Guid(
                                new byte[] { 209, 101, 40, 249, 114, 36, 27, 95, 191, 207, 7, 197, 51, 109, 223, 212 }
                        );
 
                        // Subscribe to events to keep the cache fresh.
                        GameEvents.onVesselWasModified.Add(onVesselEvent);
                        GameEvents.onVesselChange.Add(onVesselEvent);
                        GameEvents.onVesselDestroy.Add(onVesselEvent);
                        GameEvents.onGameSceneLoadRequested.Add(onSceneChange);
                        GameEvents.onPartUndock.Add(onPartEvent);
                        GameEvents.onPartCouple.Add(onFromPartToPartEvent);
 
                        #if BENCH
                        this.cacheHits = 0;
                        this.cacheMisses = 0;
                        #endif
                }
 
                // Called for a subject Vessel when destroyed, changed, or modified
                private void onVesselEvent(Vessel vessel)
                {
                        // If the deep cache contains the Vessel...
                        if (vesselPartModuleDB.ContainsKey(vessel.id))
                        {
                                // ...remove it from the deep cache.
                                vesselPartModuleDB.Remove(vessel.id);
                        }
 
                        // If the shallow cache contains the Vessel...
                        if (vesselModuleTable.ContainsKey(vessel.id))
                        {
                                // ..remove it fromt he shallow cache.
                                vesselModuleTable.Remove(vessel.id);
                        }
                }
 
                // Called when a scene changed is requested
                private void onSceneChange(GameScenes scene)
                {
                        // If there is an active vessel when changing scenes...
                        if (FlightGlobals.ActiveVessel != null)
                        {
                                // ...remove it from the caches.
                                onVesselEvent(FlightGlobals.ActiveVessel);
                        }
 
                        if (HighLogic.LoadedSceneIsEditor)
                        {
                                if (vesselPartModuleDB.ContainsKey(this.editorVesselID))
                                {
                                        vesselPartModuleDB.Remove(this.editorVesselID);
                                }
 
                                if (vesselModuleTable.ContainsKey(this.editorVesselID))
                                {
                                        vesselModuleTable.Remove(this.editorVesselID);
                                }
                        }
                                
                        #if BENCH
                        if (scene == GameScenes.MAINMENU)
                        {
                                int cacheSwings = this.cacheHits + this.cacheMisses;
                                KSPLog.print(string.Format("ModuleDB<{4}> Destructing.  Cache hits: {0} ({1}%), cache misses: {2} ({3}%).",
                                        this.cacheHits, (float)this.cacheHits / (float)cacheSwings * 100f,
                                        this.cacheMisses, (float)this.cacheMisses / (float)cacheSwings * 100f,
                                        typeof(T).Name
                                ));
                        }
                        #endif
                }
 
                // Called for a subject Part when undocked
                private void onPartEvent(Part part)
                {
                        // If the Part's Vessel is defined...
                        if (part.vessel != null)
                        {
                                // ...remove it from the caches.
                                onVesselEvent(part.vessel);
                        }
                }
 
                // Called for two subject Parts when coupled
                private void onFromPartToPartEvent(GameEvents.FromToAction<Part, Part> data)
                {
                        // Remove both the from and the to Parts fromt he caches.
                        onPartEvent(data.from);
                        onPartEvent(data.to);
                }
 
 
                // Gets a flat list of all modules of type T in the given Vessel.  Returns an empty list if none exist.
                public List<T> getModules(Vessel vessel)
                {
                        // If the vessel's Parts list is defined and includes any Parts...
                        if (vessel.Parts != null && vessel.Parts.Count > 0)
                        {
                                // ...and if the vessel is not in the shallow cache...
                                if (!vesselModuleTable.ContainsKey(vessel.id))
                                {
                                        #if BENCH
                                        this.cacheMisses++;
                                        #endif
                                        // ...create a list flat list of modules
                                        List<T> modulesInVessel = new List<T>();
 
                                        // ...loop through the Vessel's Parts...
                                        foreach (Part part in vessel.Parts)
                                        {
                                                // ...loop through each Part's Modules...
                                                foreach (T module in getModules(part))
                                                {
                                                        // ...and add each matching Module to the new list
                                                        modulesInVessel.Add(module);
                                                }
                                        }
 
                                        // ...set the shallow cache entry to the new list
                                        vesselModuleTable[vessel.id] = modulesInVessel;
                                }
                                #if BENCH
                                else
                                {
                                        this.cacheHits++;
                                }
                                #endif
 
                                // ...return the shallow cache for the queried Vessel
                                return vesselModuleTable[vessel.id];
                        }
 
                        // Otherwise, return an empty list.
                        return new List<T>();
                }
 
                // Gets a flat list of all modules of type T in the given Part.  Returns an empty list if none exist.
                public List<T> getModules(Part part)
                {
                        Guid id;
 
                        if (HighLogic.LoadedSceneIsEditor)
                        {
                                id = this.editorVesselID;
                        }
                        // If the Part's Vessel is defined...
                        else if (part.vessel != null)
                        {
                                id = part.vessel.id;
                        }
                        else
                        {
                                // Otherwise, return an empty list
                                return new List<T>();
                        }
 
                        // ...and if the Vessel is not in the deep cache...
                        if (!vesselPartModuleDB.ContainsKey(id))
                        {
                                // ...create a new table for the Vessel in the deep cache.
                                vesselPartModuleDB[id] = new Dictionary<uint, List<T>>();
                        }
 
                        // ...and if the Part is not in the Vessel's table in the deep cache...
                        if (!vesselPartModuleDB[id].ContainsKey(part.uid))
                        {
                                #if BENCH
                                this.cacheMisses++;
                                #endif
 
                                // ...create a flat list of modules
                                List<T> modulesInPart = new List<T>();
 
                                // ...loop through the Part's modules...
                                foreach (PartModule module in part.Modules)
                                {
                                        // ...if any module matches...
                                        if (module is T)
                                        {
                                                // ...add it to the list
                                                modulesInPart.Add((T)module);
                                        }
                                }
 
                                // ...set the deep cache entry to the new list
                                vesselPartModuleDB[id][part.uid] = modulesInPart;
                        }
                        #if BENCH
                        else
                        {
                                this.cacheHits++;
                        }
                        #endif
 
                        // ...return the deep cache entry for the queried Part.
                        return vesselPartModuleDB[id][part.uid];
                }
 
                // Returns true if the given Vessel exists in the deep cache, false otherwise.
                public bool inDeepCache(Vessel vessel)
                {
                        return vesselPartModuleDB.ContainsKey(HighLogic.LoadedSceneIsEditor ? this.editorVesselID : vessel.id);
                }
 
                // Returns true if the given Part exists in the deep cache, false otherwise.
                public bool inDeepCache(Part part)
                {
                        if (HighLogic.LoadedSceneIsEditor)
                        {
                                return vesselPartModuleDB.ContainsKey(this.editorVesselID) &&
                                        vesselPartModuleDB[this.editorVesselID].ContainsKey(part.uid);
                        }
                        else
                        {
                                if (part.vessel == null)
                                {
                                        return false;
                                }
 
                                return inDeepCache(part.vessel) && vesselPartModuleDB[part.vessel.id].ContainsKey(part.uid);
                        }
                }
 
                // Returns true if the given Vessel exists in the shallow cache, false otherwise.
                public bool inShallowCache(Vessel vessel)
                {
                        return vesselModuleTable.ContainsKey(HighLogic.LoadedSceneIsEditor ? this.editorVesselID : vessel.id);
                }
 
                #if BENCH
                ~ModuleDB()
                {
                        int cacheSwings = this.cacheHits + this.cacheMisses;
                        KSPLog.print(string.Format("ModuleDB<{4}> Destructing.  Cache hits: {0} ({1}%), cache misses: {2} ({3}%).",
                                this.cacheHits, (float)this.cacheHits / (float)cacheSwings * 100f,
                                this.cacheMisses, (float)this.cacheMisses / (float)cacheSwings * 100f,
                                typeof(T).Name
                        ));
                }
                #endif
        }
}