Prp for 1.0.11.0 release.
[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
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
// 
//     Kerbal Engineer Redux
// 
//     Copyright (C) 2014 CYBUTEK
// 
//     This program is free software: you can redistribute it and/or modify
//     it under the terms of the GNU General Public License as published by
//     the Free Software Foundation, either version 3 of the License, or
//     (at your option) any later version.
// 
//     This program is distributed in the hope that it will be useful,
//     but WITHOUT ANY WARRANTY; without even the implied warranty of
//     MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
//     GNU General Public License for more details.
// 
//     You should have received a copy of the GNU General Public License
//     along with this program.  If not, see <http://www.gnu.org/licenses/>.
// 
 
#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 Fields
 
        /// <summary>
        ///     Stores the root settings directory for where all files will be saved.
        /// </summary>
        private static string settingsDirectory;
 
        #endregion
 
        #region Constructors
 
        /// <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>();
        }
 
        /// <summary>
        ///     Sets the root settings directory if statically loaded.
        /// </summary>
        static SettingHandler()
        {
            if (settingsDirectory == null)
            {
                settingsDirectory = Path.Combine(EngineerGlobals.AssemblyPath, "Settings");
            }
        }
 
        #endregion
 
        #region Properties
 
        /// <summary>
        ///     Gets the directory where settings files are saved/loaded.
        /// </summary>
        public static string SettingsDirectory
        {
            get { return settingsDirectory; }
        }
 
        /// <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 GetSet Methods
 
        /// <summary>
        ///     Gets a setting from its name or return the default object. Will add the object to the handler if it does not exist.
        /// </summary>
        public T GetSet<T>(string name, T defaultObject)
        {
            foreach (var item in this.Items)
            {
                if (item.Name == name)
                {
                    return (T)Convert.ChangeType(item.Value, typeof(T));
                }
            }
            if (defaultObject != null)
            {
                this.Items.Add(new SettingItem(name, defaultObject));
            }
            return defaultObject;
        }
 
        /// <summary>
        ///     Gets a setting from its name and inputs it into the output object. Will add the object to the handler if it does
        ///     not exist.
        /// </summary>
        public bool GetSet<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;
                }
            }
            if (outputObject != null)
            {
                this.Items.Add(new SettingItem(name, outputObject));
            }
            return false;
        }
 
        #endregion
 
        #region Saving
 
        #region Methods: public
 
        /// <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);
        }
 
        #endregion
 
        #region Methods: private
 
        /// <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);
            }
        }
 
        /// <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();
            }
        }
 
        #endregion
 
        #endregion
 
        #region Loading
 
        #region Methods: public
 
        /// <summary>
        ///     Deletes all the settings files.
        /// </summary>
        public static void DeleteSettings()
        {
            try
            {
                foreach (var file in Directory.GetFiles(settingsDirectory))
                {
                    File.Delete(file);
                }
            }
            catch (Exception ex)
            {
                Logger.Exception(ex);
            }
        }
 
        /// <summary>
        ///     Gets whether a settings file exists.
        /// </summary>
        public static bool Exists(string fileName)
        {
            return File.Exists(Path.Combine(settingsDirectory, fileName));
        }
 
        /// <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);
        }
 
        #endregion
 
        #region Methods: private
 
        /// <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
 
        #endregion
    }
}