Overhauled Flight Engineer
[VesselSimulator.git] / KerbalEngineer / Settings / SettingHandler.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
// Project:  KerbalEngineer
// Author:      CYBUTEK
// License:     Attribution-NonCommercial-ShareAlike 3.0 Unported
 
#region Using Directives
 
using System;
using System.Collections.Generic;
using System.IO;
using System.Linq;
using System.Xml.Serialization;
 
#endregion
 
namespace KerbalEngineer.Settings
{
    /// <summary>
    ///     Handles the management of setting items.
    /// </summary>
    public class SettingHandler
    {
        #region Static Fields
 
        /// <summary>
        ///     Stores the root settings directory for where all files will be saved.
        /// </summary>
        private static string settingsDirectory;
 
        #endregion
 
        #region Constructors
 
        /// <summary>
        ///     Sets the root settings directory if statically loaded.
        /// </summary>
        static SettingHandler()
        {
            if (settingsDirectory == null)
            {
                settingsDirectory = Path.Combine(EngineerGlobals.AssemblyPath, "Settings");
            }
        }
 
        /// <summary>
        ///     Creates an empty handler for managing setting items.
        /// </summary>
        public SettingHandler()
        {
            if (settingsDirectory == null)
            {
                settingsDirectory = Path.Combine(EngineerGlobals.AssemblyPath, "Settings");
            }
 
            this.Items = new List<SettingItem>();
        }
 
        #endregion
 
        #region Properties
 
        /// <summary>
        ///     Gets and sets the list of items.
        /// </summary>
        public List<SettingItem> Items { get; set; }
 
        #endregion
 
        #region Get Methods
 
        /// <summary>
        ///     Gets a setting object from its name or returns the default object.
        /// </summary>
        public T Get<T>(string name, T defaultObject)
        {
            foreach (var item in this.Items)
            {
                if (item.Name == name)
                {
                    return (T)Convert.ChangeType(item.Value, typeof(T));
                }
            }
            return defaultObject;
        }
 
        /// <summary>
        ///     Gets a setting object from its name and inputs it into the output object.  Returns true if a setting was found,
        ///     false if not.
        /// </summary>
        public bool Get<T>(string name, ref T outputObject)
        {
            foreach (var item in this.Items)
            {
                if (item.Name == name)
                {
                    outputObject = (T)Convert.ChangeType(item.Value, typeof(T));
                    return true;
                }
            }
            return false;
        }
 
        #endregion
 
        #region Set Methods
 
        /// <summary>
        ///     Sets a setting object from its name or creates one if it does not already exist.
        /// </summary>
        public void Set(string name, object value)
        {
            foreach (var item in this.Items)
            {
                if (item.Name == name)
                {
                    item.Value = value;
                    return;
                }
            }
            this.Items.Add(new SettingItem(name, value));
        }
 
        #endregion
 
        #region Saving
 
        /// <summary>
        ///     Saves all the items in the handler into the specified file.
        /// </summary>
        public void Save(string fileName)
        {
            fileName = Path.Combine(settingsDirectory, fileName);
 
            this.Serialise(fileName);
        }
 
        /// <summary>
        ///     Serialises all the items into an xml file.
        /// </summary>
        private void Serialise(string fileName)
        {
            this.CreateDirectory(fileName);
            using (var stream = new FileStream(fileName, FileMode.Create))
            {
                new XmlSerializer(typeof(List<SettingItem>), this.Items.Select(s => s.Value.GetType()).ToArray()).Serialize(stream, this.Items);
                stream.Close();
            }
        }
 
        /// <summary>
        ///     Creates a directory if it does not already exist.
        /// </summary>
        private void CreateDirectory(string fileName)
        {
            var filePath = new FileInfo(fileName).DirectoryName;
            if (!Directory.Exists(filePath))
            {
                Directory.CreateDirectory(filePath);
            }
        }
 
        #endregion
 
        #region Loading
 
        /// <summary>
        ///     Returns a SettingHandler object created from the specified file. (Optional extra types are required for
        ///     non-primitive items.)
        /// </summary>
        public static SettingHandler Load(string fileName, Type[] extraTypes = null)
        {
            fileName = Path.Combine(settingsDirectory, fileName);
 
            return Deserialise(fileName, extraTypes);
        }
 
        /// <summary>
        ///     Returns a SettingHandler object containing items deserialized from the specified file.
        /// </summary>
        private static SettingHandler Deserialise(string fileName, Type[] extraTypes)
        {
            if (!File.Exists(fileName))
            {
                return new SettingHandler();
            }
 
            var handler = new SettingHandler();
            using (var stream = new FileStream(fileName, FileMode.Open))
            {
                handler.Items = new XmlSerializer(typeof(List<SettingItem>), extraTypes).Deserialize(stream) as List<SettingItem>;
                stream.Close();
            }
            return handler;
        }
 
        #endregion
    }
}