Fixes and improvements for AppLauncher buttons.
[AntennaRange.git] / RelayDatabase.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
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
// AntennaRange
//
// RelayDatabase.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.
//
// 3. Neither the name of the copyright holder nor the names of its contributors may be used
//    to endorse or promote products derived from this software without specific prior written permission.
//
// 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 System.Text;
using ToadicusTools;
using UnityEngine;
 
namespace AntennaRange
{
        public class RelayDatabase
        {
                /*
                 * Static members
                 * */
                // Singleton storage
                protected static RelayDatabase _instance;
                // Gets the singleton
                public static RelayDatabase Instance
                {
                        get
                        {       
                                if (_instance == null)
                                {
                                        _instance = new RelayDatabase();
                                }
 
                                return _instance;
                        }
                }
 
                /*
                 * Instance members
                 * */
 
                /*
                 * Fields
                 * */
                // Vessel.id-keyed hash table of Part.GetHashCode()-keyed tables of relay objects.
                protected Dictionary<Guid, Dictionary<int, IAntennaRelay>> relayDatabase;
 
                // Vessel.id-keyed hash table of part counts, used for caching
                protected Dictionary<Guid, int> vesselPartCountTable;
 
                // Vessel.id-keyed hash table of booleans to track what vessels have been checked so far this time.
                public Dictionary<Guid, bool> CheckedVesselsTable;
 
                protected int cacheHits;
                protected int cacheMisses;
 
                /*
                 * Properties
                 * */
                // Gets the Part-hashed table of relays in a given vessel
                public Dictionary<int, IAntennaRelay> this [Vessel vessel]
                {
                        get
                        {
                                // If we don't have an entry for this vessel...
                                if (!this.ContainsKey(vessel.id))
                                {
                                        // ...Generate an entry for this vessel.
                                        this.AddVessel(vessel);
                                        this.cacheMisses++;
                                }
                                // If our part count disagrees with the vessel's part count...
                                else if (this.vesselPartCountTable[vessel.id] != vessel.Parts.Count)
                                {
                                        // ...Update the our vessel in the cache
                                        this.UpdateVessel(vessel);
                                        this.cacheMisses++;
                                }
                                // Otherwise, it's a hit
                                else
                                {
                                        this.cacheHits++;
                                }
 
                                // Return the Part-hashed table of relays for this vessel
                                return relayDatabase[vessel.id];
                        }
                }
 
                /* 
                 * Methods
                 * */
                // Adds a vessel to the database
                // The return for this function isn't used yet, but seems useful for potential future API-uses
                public bool AddVessel(Vessel vessel)
                {
                        // If this vessel is already here...
                        if (this.ContainsKey(vessel))
                        {
                                // ...post an error
                                Debug.LogWarning(string.Format(
                                        "{0}: Cannot add vessel '{1}' (id: {2}): Already in database.",
                                        this.GetType().Name,
                                        vessel.vesselName,
                                        vessel.id
                                ));
 
                                // ...and refuse to add
                                return false;
                        }
                        // otherwise, add the vessel to our tables...
                        else
                        {
                                // Build an empty table...
                                this.relayDatabase[vessel.id] = new Dictionary<int, IAntennaRelay>();
 
                                // Update the empty index
                                this.UpdateVessel(vessel);
 
                                // Return success
                                return true;
                        }
                }
 
                // Update the vessel's entry in the table
                public void UpdateVessel(Vessel vessel)
                {
                        // Squak if the database doesn't have the vessel
                        if (!this.ContainsKey(vessel))
                        {
                                throw new InvalidOperationException(string.Format(
                                        "{0}: Update called for vessel '{1}' (id: {2}) not in database: vessel will be added.",
                                        this.GetType().Name,
                                        vessel.vesselName,
                                        vessel.id
                                ));
                        }
 
                        Dictionary<int, IAntennaRelay> vesselTable = this.relayDatabase[vessel.id];
 
                        // Actually build and assign the table
                        this.getVesselRelays(vessel, ref vesselTable);
                        // Set the part count
                        this.vesselPartCountTable[vessel.id] = vessel.Parts.Count;
                }
 
                // Remove a vessel from the cache, if it exists.
                public void DirtyVessel(Vessel vessel)
                {
                        if (this.relayDatabase.ContainsKey(vessel.id))
                        {
                                this.relayDatabase.Remove(vessel.id);
                        }
                        if (this.vesselPartCountTable.ContainsKey(vessel.id))
                        {
                                this.vesselPartCountTable.Remove(vessel.id);
                        }
                }
 
                // Returns true if both the relayDatabase and the vesselPartCountDB contain the vessel id.
                public bool ContainsKey(Guid key)
                {
                        return this.relayDatabase.ContainsKey(key);
                }
 
                // Returns true if both the relayDatabase and the vesselPartCountDB contain the vessel.
                public bool ContainsKey(Vessel vessel)
                {
                        return this.ContainsKey(vessel.id);
                }
 
                // Runs when a vessel is modified (or when we switch to one, to catch docking events)
                public void onVesselEvent(Vessel vessel)
                {
                        // If we have this vessel in our cache...
                        if (this.ContainsKey(vessel))
                        {
                                // If our part counts disagree (such as if a part has been added or broken off,
                                // or if we've just docked or undocked)...
                                if (this.vesselPartCountTable[vessel.id] != vessel.Parts.Count || vessel.loaded)
                                {
                                        Tools.PostDebugMessage(string.Format(
                                                "{0}: dirtying cache for vessel '{1}' ({2}).",
                                                this.GetType().Name,
                                                vessel.vesselName,
                                                vessel.id
                                        ));
 
                                        // Dirty the cache (real vessels will never have negative part counts)
                                        this.DirtyVessel(vessel);
                                }
                        }
                }
 
                // Runs when the player requests a scene change, such as when changing vessels or leaving flight.
                public void onSceneChange(GameScenes scene)
                {
                        // If the active vessel is a real thing...
                        if (FlightGlobals.ActiveVessel != null)
                        {
                                // ... dirty its cache
                                this.onVesselEvent(FlightGlobals.ActiveVessel);
                        }
                }
 
                // Runs when parts are undocked
                public void onPartEvent(Part part)
                {
                        if (part != null && part.vessel != null)
                        {
                                this.onVesselEvent(part.vessel);
                        }
                }
 
                // Runs when parts are coupled, as in docking
                public void onFromPartToPartEvent(GameEvents.FromToAction<Part, Part> data)
                {
                        this.onPartEvent(data.from);
                        this.onPartEvent(data.to);
                }
 
                // Produce a Part-hashed table of relays for the given vessel
                protected void getVesselRelays(Vessel vessel, ref Dictionary<int, IAntennaRelay> relays)
                {
                        // We're going to completely regen this table, so dump the current contents.
                        relays.Clear();
 
                        Tools.PostDebugMessage(string.Format(
                                "{0}: Getting antenna relays from vessel {1}.",
                                "IAntennaRelay",
                                vessel.vesselName
                        ));
 
                        // If the vessel is loaded, we can fetch modules implementing IAntennaRelay directly.
                        if (vessel.loaded) {
                                Tools.PostDebugMessage(string.Format(
                                        "{0}: vessel {1} is loaded, searching for modules in loaded parts.",
                                        "IAntennaRelay",
                                        vessel.vesselName
                                ));
 
                                // Loop through the Parts in the Vessel...
                                foreach (Part part in vessel.Parts)
                                {
                                        // ...loop through the PartModules in the Part...
                                        foreach (PartModule module in part.Modules)
                                        {
                                                // ...if the module is a relay...
                                                if (module is IAntennaRelay)
                                                {
                                                        // ...add the module to the table
                                                        relays.Add(part.GetHashCode(), module as IAntennaRelay);
                                                        // ...neglect relay objects after the first in each part.
                                                        break;
                                                }
                                        }
                                }
                        }
                        // If the vessel is not loaded, we need to build ProtoAntennaRelays when we find relay ProtoPartSnapshots.
                        else
                        {
                                Tools.PostDebugMessage(string.Format(
                                        "{0}: vessel {1} is not loaded, searching for modules in prototype parts.",
                                        this.GetType().Name,
                                        vessel.vesselName
                                ));
 
                                // Loop through the ProtoPartModuleSnapshots in the Vessel...
                                foreach (ProtoPartSnapshot pps in vessel.protoVessel.protoPartSnapshots)
                                {
                                        Tools.PostDebugMessage(string.Format(
                                                "{0}: Searching in protopartsnapshot {1}",
                                                this.GetType().Name,
                                                pps
                                        ));
 
                                        // ...Fetch the prefab, because it's more useful for what we're doing.
                                        Part partPrefab = PartLoader.getPartInfoByName(pps.partName).partPrefab;
 
                                        Tools.PostDebugMessage(string.Format(
                                                "{0}: Got partPrefab {1} in protopartsnapshot {2}",
                                                this.GetType().Name,
                                                partPrefab,
                                                pps
                                        ));
 
                                        // ...loop through the PartModules in the prefab...
                                        foreach (PartModule module in partPrefab.Modules)
                                        {
                                                Tools.PostDebugMessage(string.Format(
                                                        "{0}: Searching in partmodule {1}",
                                                        this.GetType().Name,
                                                        module
                                                ));
 
                                                // ...if the module is a relay...
                                                if (module is IAntennaRelay)
                                                {
                                                        Tools.PostDebugMessage(string.Format(
                                                                "{0}: partmodule {1} is antennarelay",
                                                                this.GetType().Name,
                                                                module
                                                        ));
 
                                                        // ...build a new ProtoAntennaRelay and add it to the table
                                                        relays.Add(pps.GetHashCode(), new ProtoAntennaRelay(module as IAntennaRelay, pps));
                                                        // ...neglect relay objects after the first in each part.
                                                        break;
                                                }
                                        }
                                }
                        }
 
                        Tools.PostDebugMessage(string.Format(
                                "{0}: vessel '{1}' ({2}) has {3} transmitters.",
                                "IAntennaRelay",
                                vessel.vesselName,
                                vessel.id,
                                relays.Count
                        ));
                }
 
                // Construct the singleton
                protected RelayDatabase()
                {
                        // Initialize the databases
                        this.relayDatabase = new Dictionary<Guid, Dictionary<int, IAntennaRelay>>();
                        this.vesselPartCountTable = new Dictionary<Guid, int>();
                        this.CheckedVesselsTable = new Dictionary<Guid, bool>();
 
                        this.cacheHits = 0;
                        this.cacheMisses = 0;
 
                        // Subscribe to some events
                        GameEvents.onVesselWasModified.Add(this.onVesselEvent);
                        GameEvents.onVesselChange.Add(this.onVesselEvent);
                        GameEvents.onVesselDestroy.Add(this.onVesselEvent);
                        GameEvents.onGameSceneLoadRequested.Add(this.onSceneChange);
                        GameEvents.onPartCouple.Add(this.onFromPartToPartEvent);
                        GameEvents.onPartUndock.Add(this.onPartEvent);
                }
 
                ~RelayDatabase()
                {
                        // Unsubscribe from the events
                        GameEvents.onVesselWasModified.Remove(this.onVesselEvent);
                        GameEvents.onVesselChange.Remove(this.onVesselEvent);
                        GameEvents.onVesselDestroy.Remove(this.onVesselEvent);
                        GameEvents.onGameSceneLoadRequested.Remove(this.onSceneChange);
                        GameEvents.onPartCouple.Remove(this.onFromPartToPartEvent);
                        GameEvents.onPartUndock.Remove(this.onPartEvent);
 
                        Tools.PostDebugMessage(this.GetType().Name + " destroyed.");
 
                        KSPLog.print(string.Format(
                                "{0} destructed.  Cache hits: {1}, misses: {2}, hit rate: {3:P1}",
                                this.GetType().Name,
                                this.cacheHits,
                                this.cacheMisses,
                                (float)this.cacheHits / (float)(this.cacheMisses + this.cacheHits)
                        ));
                }
 
                #if DEBUG
                public void Dump()
                {
                        StringBuilder sb = new StringBuilder();
 
                        sb.Append("Dumping RelayDatabase:");
 
                        foreach (Guid id in this.relayDatabase.Keys)
                        {
                                sb.AppendFormat("\nVessel {0}:", id);
 
                                foreach (IAntennaRelay relay in this.relayDatabase[id].Values)
                                {
                                        sb.AppendFormat("\n\t{0}", relay.ToString());
                                }
                        }
 
                        Tools.PostDebugMessage(sb.ToString());
                }
                #endif
        }
}