Changed to per-save settings files and CSV target locations. ttrefactor
[VOID.git] / API / VOID_Module.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
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
// VOID
//
// VOID_Module.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.
 
// TODO: Remove ToadicusTools. prefixes after refactor is done.
 
using System;
using System.Collections.Generic;
using System.Reflection;
using ToadicusTools.Extensions;
using ToadicusTools.GUIUtils;
using UnityEngine;
 
namespace VOID
{
        public abstract class VOID_Module : IVOID_Module
        {
                /*
                 * Fields
                 * */
                [AVOID_SaveValue("Active")]
                protected VOID_SaveValue<bool> active = (VOID_SaveValue<bool>)false;
 
                protected float lastUpdate = 0;
 
                private GameScenes[] validScenes;
                private Game.Modes[] validModes;
 
                /*
                 * Properties
                 * */
 
                public virtual bool Active
                {
                        get
                        {
                                return this.active && this.InValidGame && this.InValidScene;
                        }
                        set
                        {
                                this.active.value = value && this.InValidGame && this.InValidScene;
                        }
                }
 
                public virtual bool GUIRunning
                {
                        get
                        {
                                if (
                                        RenderingManager.fetch == null ||
                                        RenderingManager.fetch.postDrawQueue == null ||
                                        RenderingManager.fetch.postDrawQueue.Length < 4
                                )
                                {
                                        return false;
                                }
                                else
                                {
                                        Delegate callback = RenderingManager.fetch.postDrawQueue[3];
                                        if (callback == null)
                                        {
                                                return false;
                                        }
 
                                        return callback.GetInvocationList().Contains((Callback)this.DrawGUI);
                                }
                        }
                }
 
                public virtual bool InValidGame
                {
                        get
                        {
                                return this.ValidModes.Contains(HighLogic.CurrentGame.Mode);
                        }
                }
 
                public virtual bool InValidScene
                {
                        get
                        {
                                return this.ValidScenes.Contains(HighLogic.LoadedScene);
                        }
                }
 
                public virtual string Name
                {
                        get;
                        protected set;
                }
 
                public virtual Game.Modes[] ValidModes
                {
                        get
                        {
                                if (this.validModes == null)
                                {
                                        ToadicusTools.Logging.PostDebugMessage(this, "validModes is null when checking inValidGame; fetching attribute.");
 
                                        object[] attributes = this.GetType().GetCustomAttributes(false);
                                        object attr;
                                        for (int idx = 0; idx < attributes.Length; idx++)
                                        {
                                                attr = attributes[idx];
 
                                                if (attr is VOID_GameModesAttribute)
                                                {
                                                        VOID_GameModesAttribute addonAttr = (VOID_GameModesAttribute)attr;
 
                                                        this.validModes = addonAttr.ValidModes;
 
                                                        ToadicusTools.Logging.PostDebugMessage("Found VOID_GameModesAttribute; validScenes set.");
 
                                                        break;
                                                }
                                        }
 
                                        if (this.validModes == null)
                                        {
                                                this.validModes = new Game.Modes[]
                                                {
                                                        Game.Modes.CAREER,
                                                        Game.Modes.SANDBOX,
                                                        Game.Modes.SCENARIO,
                                                        Game.Modes.SCENARIO_NON_RESUMABLE,
                                                        Game.Modes.SCIENCE_SANDBOX
                                                };
 
                                                ToadicusTools.Logging.PostDebugMessage("No VOID_GameModesAttribute found; validScenes defaulted to flight.");
                                        }
                                }
 
                                return this.validModes;
                        }
                }
 
                public virtual GameScenes[] ValidScenes
                {
                        get
                        {
                                if (this.validScenes == null)
                                {
                                        ToadicusTools.Logging.PostDebugMessage(this, "validScenes is null when checking inValidScene; fetching attribute.");
                                        object[] attributes = this.GetType().GetCustomAttributes(false);
                                        object attr;
                                        for (int idx = 0; idx < attributes.Length; idx++)
                                        {
                                                attr = attributes[idx];
 
                                                if (attr is VOID_ScenesAttribute)
                                                {
                                                        VOID_ScenesAttribute addonAttr = (VOID_ScenesAttribute)attr;
 
                                                        this.validScenes = addonAttr.ValidScenes;
 
                                                        ToadicusTools.Logging.PostDebugMessage("Found VOID_ScenesAttribute; validScenes set.");
 
                                                        break;
                                                }
                                        }
 
                                        if (this.validScenes == null)
                                        {
                                                this.validScenes = new GameScenes[] { GameScenes.FLIGHT };
                                                ToadicusTools.Logging.PostDebugMessage("No VOID_ScenesAttribute found; validScenes defaulted to flight.");
                                        }
                                }
 
                                return this.validScenes;
                        }
                }
 
                public virtual Vessel Vessel
                {
                        get
                        {
                                return FlightGlobals.ActiveVessel;
                        }
                }
 
                protected virtual VOIDCore core
                {
                        get
                        {
                                return VOID_Data.Core;
                        }
                }
 
                protected virtual bool timeToUpdate
                {
                        get
                        {
                                return (
                                        (this.core.UpdateTimer - this.lastUpdate) > this.core.UpdatePeriod ||
                                        this.lastUpdate > this.core.UpdateTimer
                                );
                        }
                }
 
                /*
                 * Methods
                 * */
                public virtual void StartGUI()
                {
                        if (!this.Active || this.GUIRunning)
                        {
                                return;
                        }
 
                        ToadicusTools.Logging.PostDebugMessage (string.Format("Adding {0} to the draw queue.", this.GetType().Name));
                        RenderingManager.AddToPostDrawQueue (3, this.DrawGUI);
                }
 
                public virtual void StopGUI()
                {
                        if (!this.GUIRunning)
                        {
                                return;
                        }
                        ToadicusTools.Logging.PostDebugMessage (string.Format("Removing {0} from the draw queue.", this.GetType().Name));
                        RenderingManager.RemoveFromPostDrawQueue (3, this.DrawGUI);
                }
 
                public abstract void DrawGUI();
 
                public virtual void DrawConfigurables() {}
 
                public virtual void LoadConfig(KSP.IO.PluginConfiguration config)
                {
                        config.load ();
 
                        if (this is VOIDCore)
                        {
                                int configVersion = config.GetValue("VOID_Core_configValue", 2);
 
                                if (configVersion < VOIDCore.CONFIG_VERSION)
                                {
                                        ((VOIDCore)this).configNeedsUpdate = true;
                                }
                        }
 
                        MemberInfo[] members = this.GetType().GetMembers(
                                                         BindingFlags.NonPublic |
                                                         BindingFlags.Public |
                                                         BindingFlags.Instance |
                                                         BindingFlags.FlattenHierarchy
                                                 );
                        MemberInfo member;
 
                        for (int fIdx = 0; fIdx < members.Length; fIdx++)
                        {
                                member = members[fIdx];
 
                                if (!(member is FieldInfo || member is PropertyInfo))
                                {
                                        continue;
                                }
 
                                if (member is PropertyInfo && (member as PropertyInfo).GetIndexParameters().Length > 0)
                                {
                                        continue;
                                }
 
                                object[] attrs = member.GetCustomAttributes(typeof(AVOID_SaveValue), false);
 
                                AVOID_SaveValue attr;
 
                                if (attrs.Length > 0)
                                {
                                        attr = (AVOID_SaveValue)attrs[0];
                                }
                                else
                                {
                                        continue;
                                }
 
                                string fieldName = string.Empty;
 
                                if (this is VOIDCore || this.core.configNeedsUpdate)
                                {
                                        string typeName = this.GetType().Name;;
 
                                        if (this is VOIDCore && ((VOIDCore)this).configNeedsUpdate)
                                        {
                                                if (this is VOIDCore_Flight)
                                                {
                                                        typeName = "VOID_Core";
                                                }
                                                else if (this is VOIDCore_Editor)
                                                {
                                                        typeName = "VOID_EditorCore";
                                                }
                                        }
 
                                        fieldName = string.Format("{0}_{1}", typeName, attr.Name);
                                }
                                else
                                {
                                        fieldName = string.Format(
                                                "{0}_{1}_{2}",
                                                this.GetType().Name,
                                                Enum.GetName(typeof(GameScenes), HighLogic.LoadedScene),
                                                attr.Name
                                        );
                                }
 
                                ToadicusTools.Logging.PostDebugMessage(string.Format("{0}: Loading field {1}.", this.GetType().Name, fieldName));
 
                                object fieldValue;
 
                                if (member is FieldInfo)
                                {
                                        fieldValue = (member as FieldInfo).GetValue(this);
                                }
                                else
                                {
                                        fieldValue = (member as PropertyInfo).GetValue(this, null);
                                }
 
                                bool convertBack = false;
                                if (fieldValue is IVOID_SaveValue)
                                {
                                        fieldValue = (fieldValue as IVOID_SaveValue).value;
                                        convertBack = true;
                                }
 
                                fieldValue = config.GetValue(fieldName, fieldValue);
 
                                if (convertBack)
                                {
                                        Type type = typeof(VOID_SaveValue<>).MakeGenericType (fieldValue.GetType ());
                                        IVOID_SaveValue convertValue = Activator.CreateInstance (type) as IVOID_SaveValue;
                                        convertValue.SetValue (fieldValue);
                                        fieldValue = convertValue;
                                }
 
                                if (member is FieldInfo)
                                {
                                        (member as FieldInfo).SetValue(this, fieldValue);
                                }
                                else
                                {
                                        (member as PropertyInfo).SetValue(this, fieldValue, null);
                                }
 
                                ToadicusTools.Logging.PostDebugMessage(string.Format("{0}: Loaded field {1}.", this.GetType().Name, fieldName));
                        }
                }
 
                public virtual void Save(KSP.IO.PluginConfiguration config, string sceneKey)
                {
                        if (config == null)
                        {
                                ToadicusTools.Logging.PostErrorMessage(
                                        "{0}: config argument was null, bailing out.",
                                        this.GetType().Name
                                );
                        }
 
                        if (sceneKey == null)
                        {
                                ToadicusTools.Logging.PostErrorMessage(
                                        "{0}: sceneKey argument was null, bailing out.",
                                        this.GetType().Name
                                );
                        }
 
                        MemberInfo[] members = this.GetType().GetMembers(
                                BindingFlags.NonPublic |
                                BindingFlags.Public |
                                BindingFlags.Instance |
                                BindingFlags.FlattenHierarchy
                        );
                        MemberInfo member;
 
                        for (int fIdx = 0; fIdx < members.Length; fIdx++)
                        {
                                member = members[fIdx];
 
                                object[] attrs = member.GetCustomAttributes(typeof(AVOID_SaveValue), false);
 
                                AVOID_SaveValue attr;
 
                                if (attrs.Length > 0)
                                {
                                        attr = (AVOID_SaveValue)attrs[0];
                                }
                                else
                                {
                                        continue;
                                }
 
                                string fieldName;
 
                                if (this is VOIDCore)
                                {
                                        fieldName = string.Format("{0}_{1}", this.GetType().Name, attr.Name);
                                }
                                else
                                {
                                        fieldName = string.Format(
                                                "{0}_{1}_{2}",
                                                this.GetType().Name,
                                                sceneKey,
                                                attr.Name
                                        );
                                }
 
                                object fieldValue;
 
                                if (member is FieldInfo)
                                {
                                        fieldValue = (member as FieldInfo).GetValue(this);
                                }
                                else
                                {
                                        fieldValue = (member as PropertyInfo).GetValue(this, null);
                                }
 
                                if (fieldValue is IVOID_SaveValue)
                                {
                                        fieldValue = (fieldValue as IVOID_SaveValue).value;
                                }
 
                                config.SetValue(fieldName, fieldValue);
 
                                ToadicusTools.Logging.PostDebugMessage(string.Format("{0}: Saved field {1}.", this.GetType().Name, fieldName));
                        }
                }
        }
 
        public abstract class VOID_WindowModule : VOID_Module
        {
                [AVOID_SaveValue("WindowPos")]
                protected Rect WindowPos;
                protected float defWidth;
                protected float defHeight;
 
                protected bool decorateWindow;
 
                protected string inputLockName;
 
                public VOID_WindowModule() : base()
                {
                        this.defWidth = 250f;
                        this.defHeight = 50f;
 
                        this.decorateWindow = true;
 
                        this.inputLockName = string.Concat(this.Name, "_edlock");
 
                        this.WindowPos = new Rect(Screen.width / 2, Screen.height / 2, this.defWidth, this.defHeight);
                }
 
                public virtual void ModuleWindow(int id)
                {
                        GUIStyle buttonStyle = this.core.Skin.button;
                        RectOffset padding = buttonStyle.padding;
                        RectOffset border = buttonStyle.border;
 
                        Rect closeRect = new Rect(
                                0f,
                                0f,
                                border.left + border.right,
                                border.top + border.bottom
                        );
 
                        closeRect.width = Mathf.Max(closeRect.width, 16f);
                        closeRect.height = Mathf.Max(closeRect.height, 16f);
 
                        closeRect.x = this.WindowPos.width - closeRect.width - 2f;
                        closeRect.y = 2f;
 
                        GUI.Button(closeRect, GUIContent.none, buttonStyle);
 
                        if (Event.current.type == EventType.repaint && Input.GetMouseButtonUp(0))
                        {
                                if (closeRect.Contains(Event.current.mousePosition))
                                {
                                        this.Active = false;
                                        this.removeUILock();
                                }
                        }
 
                        GUI.DragWindow();
                }
 
                public override void DrawGUI()
                {
                        GUI.skin = this.core.Skin;
 
                        Rect _Pos = this.WindowPos;
 
                        _Pos = GUILayout.Window(
                                this.core.WindowID,
                                _Pos,
                                VOID_Tools.GetWindowHandler(this.ModuleWindow),
                                this.Name,
                                GUILayout.Width(this.defWidth),
                                GUILayout.Height(this.defHeight)
                        );
 
                        bool cursorInWindow = _Pos.Contains(Mouse.screenPos);
 
                        if (cursorInWindow)
                        {
                                this.setUILock();
                        }
                        else
                        {
                                this.removeUILock();
                        }
 
                        if (HighLogic.LoadedSceneIsEditor)
                        {
                                _Pos = WindowTools.ClampRectToEditorPad(_Pos);
                        }
                        else
                        {
                                _Pos = WindowTools.ClampRectToScreen(_Pos);
                        }
 
                        if (_Pos != this.WindowPos)
                        {
                                this.WindowPos = _Pos;
                                this.core.configDirty = true;
                        }
                }
 
                protected void setUILock()
                {
                        switch (HighLogic.LoadedScene)
                        {
                                case GameScenes.EDITOR:
                                        InputLockManager.SetControlLock(
                                                ControlTypes.EDITOR_ICON_HOVER | ControlTypes.EDITOR_ICON_PICK |
                                                ControlTypes.EDITOR_PAD_PICK_COPY | ControlTypes.EDITOR_PAD_PICK_COPY,
                                                this.inputLockName
                                        );
                                        EditorLogic.fetch.Lock(false, false, false, this.inputLockName);
                                        break;
                                case GameScenes.FLIGHT:
                                        InputLockManager.SetControlLock(ControlTypes.CAMERACONTROLS, this.inputLockName);
                                        break;
                                case GameScenes.SPACECENTER:
                                        InputLockManager.SetControlLock(
                                                ControlTypes.KSC_FACILITIES | ControlTypes.CAMERACONTROLS,
                                                this.inputLockName
                                        );
                                        break;
                        }
                }
 
                protected void removeUILock()
                {
                        switch (HighLogic.LoadedScene)
                        {
                                case GameScenes.EDITOR:
                                        EditorLogic.fetch.Unlock(this.inputLockName);
                                        break;
                                case GameScenes.FLIGHT:
                                        InputLockManager.RemoveControlLock(this.inputLockName);
                                        break;
                                case GameScenes.SPACECENTER:
                                        InputLockManager.RemoveControlLock(this.inputLockName);
                                        break;
                        }
                }
        }
}