Mercurial > repos > IBBoard.WarFoundry.API
annotate api/WarFoundryLoader.cs @ 19:57451981545c
Re #10 and re #11 - Refactor code and document code
* Split LoadFile method out in to smaller methods
* Document possible exception from IWarFoundryFactory object loading method
* Catch exception in WarFoundryLoader file loading
| author | IBBoard <dev@ibboard.co.uk> |
|---|---|
| date | Sat, 21 Feb 2009 14:39:15 +0000 |
| parents | bf518618eb69 |
| children | b7c93a5821cd |
| rev | line source |
|---|---|
| 15 | 1 // This file (WarFoundryLoader.cs) is a part of the IBBoard.WarFoundry.API project and is copyright 2009 IBBoard. |
| 0 | 2 // |
| 16 | 3 // The file and the library/program it is in are licensed under the GNU LGPL license, either version 3 of the License or (at your option) any later version. Please see COPYING.LGPL for more information and the full license. |
| 0 | 4 |
| 5 using System; | |
| 6 using System.Collections.Generic; | |
| 7 using System.IO; | |
| 8 using IBBoard.Collections; | |
| 9 using IBBoard.IO; | |
| 10 using IBBoard.Logging; | |
| 11 using IBBoard.WarFoundry.API.Factories; | |
| 12 using IBBoard.WarFoundry.API.Objects; | |
| 13 using ICSharpCode.SharpZipLib.Zip; | |
| 14 | |
| 15 namespace IBBoard.WarFoundry.API | |
| 16 { | |
| 17 public class WarFoundryLoader | |
| 18 { | |
| 19 private static WarFoundryLoader loader; | |
| 20 | |
| 21 /// <summary> | |
| 22 /// Gets the default <see cref="WarFoundryLoader"/> used to load WarFoundry data files. | |
| 23 /// </summary> | |
| 24 /// <returns> | |
| 25 /// The default <see cref="WarFoundryLoader"/> | |
| 26 /// </returns> | |
| 27 public static WarFoundryLoader GetDefault() | |
| 28 { | |
| 29 if (loader == null) | |
| 30 { | |
| 31 loader = new WarFoundryLoader(); | |
| 32 } | |
| 33 | |
| 34 return loader; | |
| 35 } | |
| 36 | |
| 37 private ICollection<DirectoryInfo> directories; | |
| 38 private ICollection<INativeWarFoundryFactory> factories; | |
| 39 private ICollection<INonNativeWarFoundryFactory> nonNativeFactories; | |
| 40 private Dictionary<string, GameSystem> systemsTable; | |
| 41 private Dictionary<string, Dictionary<string, Dictionary<string, Race>>> racesTable; //Keys are: System, Race, SubRace | |
| 42 private Dictionary<IWarFoundryFactory, SimpleSet<IWarFoundryObject>> loadedObjects; | |
| 43 | |
| 44 protected WarFoundryLoader() | |
| 45 { | |
| 46 directories = new List<DirectoryInfo>(); | |
| 47 factories = new List<INativeWarFoundryFactory>(); | |
| 48 nonNativeFactories = new List<INonNativeWarFoundryFactory>(); | |
| 49 loadedObjects = new Dictionary<IWarFoundryFactory,SimpleSet<IWarFoundryObject>>(); | |
| 50 } | |
| 51 | |
| 52 /// <summary> | |
| 53 /// Adds a directory to the collection of directories that will be searched for WarFoundry data files. | |
| 54 /// </summary> | |
| 55 /// <param name="directory"> | |
| 56 /// The <see cref="DirectoryInfo"/> to add to the list for searching for data files | |
| 57 /// </param> | |
| 58 public void AddLoadDirectory(DirectoryInfo directory) | |
| 59 { | |
| 60 if (!directories.Contains(directory)) | |
| 61 { | |
| 62 directories.Add(directory); | |
| 63 } | |
| 64 } | |
| 65 | |
| 66 /// <summary> | |
| 67 /// Removes a directory from the collection of directories that will be searched for WarFoundry data files. | |
| 68 /// </summary> | |
| 69 /// <param name="directory"> | |
| 70 /// A <see cref="DirectoryInfo"/> | |
| 71 /// </param> | |
| 72 public void RemoveLoadDirectory(DirectoryInfo directory) | |
| 73 { | |
| 74 if (directories.Contains(directory)) | |
| 75 { | |
| 76 directories.Remove(directory); | |
| 77 } | |
| 78 } | |
| 79 | |
| 80 /// <summary> | |
| 81 /// Registers a <see cref="INativeWarFoundryFactory"/> as a factory that can parse native data files. | |
| 82 /// </summary> | |
| 83 /// <param name="factory"> | |
| 84 /// The <see cref="INativeWarFoundryFactory"/> to register to parse native data files. | |
| 85 /// </param> | |
| 86 public void RegisterFactory(INativeWarFoundryFactory factory) | |
| 87 { | |
| 88 if (!factories.Contains(factory)) | |
| 89 { | |
| 90 factories.Add(factory); | |
| 91 } | |
| 92 } | |
| 93 | |
| 94 /// <summary> | |
| 95 /// Unregisters a <see cref="INativeWarFoundryFactory"/> so that it will no longer be used to try to parse native data files. | |
| 96 /// </summary> | |
| 97 /// <param name="factory"> | |
| 98 /// The <see cref="INativeWarFoundryFactory"/> to remove from the collection of factories that are used to try to parse native data files. | |
| 99 /// </param> | |
| 100 public void UnregisterFactory(INativeWarFoundryFactory factory) | |
| 101 { | |
| 102 if (factories.Contains(factory)) | |
| 103 { | |
| 104 factories.Remove(factory); | |
| 105 } | |
| 106 } | |
| 107 | |
| 108 /// <summary> | |
| 109 /// Registers a <see cref="INonNativeWarFoundryFactory"/> so that it will be used to try to parse non-native data files from other applications. | |
| 110 /// </summary> | |
| 111 /// <param name="factory"> | |
| 112 /// The <see cref="INonNativeWarFoundryFactory"/> to register to parse non-native data files. | |
| 113 /// </param> | |
| 114 public void RegisterNonNativeFactory(INonNativeWarFoundryFactory factory) | |
| 115 { | |
| 116 if (!nonNativeFactories.Contains(factory)) | |
| 117 { | |
| 118 nonNativeFactories.Add(factory); | |
| 119 } | |
| 120 } | |
| 121 | |
| 122 /// <summary> | |
| 123 /// Unregisters a <see cref="INonNativeWarFoundryFactory"/> so that it will no longer be used to try to parse non-native data files from other applications. | |
| 124 /// </summary> | |
| 125 /// <param name="factory"> | |
| 126 /// The <see cref="INonNativeWarFoundryFactory"/> to remove from the collection of factories that are used to try to parse non-native data files. | |
| 127 /// </param> | |
| 128 public void UnregisterNonNativeFactory(INonNativeWarFoundryFactory factory) | |
| 129 { | |
| 130 if (nonNativeFactories.Contains(factory)) | |
| 131 { | |
| 132 nonNativeFactories.Remove(factory); | |
| 133 } | |
| 134 } | |
| 135 | |
| 136 /// <summary> | |
| 137 /// Loads all of the data files in the registered directories. | |
| 138 /// </summary> | |
|
14
0770e5cbba7c
Closes #21 - File loading in order
IBBoard <dev@ibboard.co.uk>
parents:
8
diff
changeset
|
139 /// <returns> |
|
0770e5cbba7c
Closes #21 - File loading in order
IBBoard <dev@ibboard.co.uk>
parents:
8
diff
changeset
|
140 /// A <see cref="Dictionary"/> of files that failed to load mapped against the message that their failure returned |
|
0770e5cbba7c
Closes #21 - File loading in order
IBBoard <dev@ibboard.co.uk>
parents:
8
diff
changeset
|
141 /// </returns> |
|
0770e5cbba7c
Closes #21 - File loading in order
IBBoard <dev@ibboard.co.uk>
parents:
8
diff
changeset
|
142 public List<FileLoadFailure> LoadFiles() |
| 0 | 143 { |
| 144 LogNotifier.Debug(GetType(), "Load files"); | |
| 145 PrepareForFileLoad(); | |
|
14
0770e5cbba7c
Closes #21 - File loading in order
IBBoard <dev@ibboard.co.uk>
parents:
8
diff
changeset
|
146 Dictionary<FileInfo, IWarFoundryFactory> loadableRaces = new Dictionary<FileInfo, IWarFoundryFactory>(); |
|
0770e5cbba7c
Closes #21 - File loading in order
IBBoard <dev@ibboard.co.uk>
parents:
8
diff
changeset
|
147 Dictionary<FileInfo, IWarFoundryFactory> loadableGameSystems = new Dictionary<FileInfo, IWarFoundryFactory>(); |
|
0770e5cbba7c
Closes #21 - File loading in order
IBBoard <dev@ibboard.co.uk>
parents:
8
diff
changeset
|
148 List<FileLoadFailure> failedLoads = FillLoadableFiles(loadableRaces, loadableGameSystems); |
|
0770e5cbba7c
Closes #21 - File loading in order
IBBoard <dev@ibboard.co.uk>
parents:
8
diff
changeset
|
149 failedLoads.AddRange(LoadGameSystems(loadableGameSystems)); |
|
0770e5cbba7c
Closes #21 - File loading in order
IBBoard <dev@ibboard.co.uk>
parents:
8
diff
changeset
|
150 failedLoads.AddRange(LoadRaces(loadableRaces)); |
|
0770e5cbba7c
Closes #21 - File loading in order
IBBoard <dev@ibboard.co.uk>
parents:
8
diff
changeset
|
151 |
|
0770e5cbba7c
Closes #21 - File loading in order
IBBoard <dev@ibboard.co.uk>
parents:
8
diff
changeset
|
152 LogNotifier.Debug(GetType(), failedLoads.Count + " failed file loads"); |
| 0 | 153 |
|
14
0770e5cbba7c
Closes #21 - File loading in order
IBBoard <dev@ibboard.co.uk>
parents:
8
diff
changeset
|
154 return failedLoads; |
| 0 | 155 } |
| 156 | |
| 157 protected void PrepareForFileLoad() | |
| 158 { | |
| 159 //Just set up blank dictionaries for now - may try different and more complex handling in future | |
| 160 systemsTable = new Dictionary<string,GameSystem>(); | |
| 161 racesTable = new Dictionary<string,Dictionary<string,Dictionary<string,Race>>>(); | |
| 162 } | |
|
14
0770e5cbba7c
Closes #21 - File loading in order
IBBoard <dev@ibboard.co.uk>
parents:
8
diff
changeset
|
163 |
|
0770e5cbba7c
Closes #21 - File loading in order
IBBoard <dev@ibboard.co.uk>
parents:
8
diff
changeset
|
164 private List<FileLoadFailure> FillLoadableFiles(Dictionary<FileInfo, IWarFoundryFactory> loadableRaces, Dictionary<FileInfo, IWarFoundryFactory> loadableGameSystems) |
|
0770e5cbba7c
Closes #21 - File loading in order
IBBoard <dev@ibboard.co.uk>
parents:
8
diff
changeset
|
165 { |
|
0770e5cbba7c
Closes #21 - File loading in order
IBBoard <dev@ibboard.co.uk>
parents:
8
diff
changeset
|
166 List<FileLoadFailure> fails = new List<FileLoadFailure>(); |
|
0770e5cbba7c
Closes #21 - File loading in order
IBBoard <dev@ibboard.co.uk>
parents:
8
diff
changeset
|
167 |
|
0770e5cbba7c
Closes #21 - File loading in order
IBBoard <dev@ibboard.co.uk>
parents:
8
diff
changeset
|
168 foreach (DirectoryInfo directory in directories) |
|
0770e5cbba7c
Closes #21 - File loading in order
IBBoard <dev@ibboard.co.uk>
parents:
8
diff
changeset
|
169 { |
|
0770e5cbba7c
Closes #21 - File loading in order
IBBoard <dev@ibboard.co.uk>
parents:
8
diff
changeset
|
170 if (directory.Exists) |
|
0770e5cbba7c
Closes #21 - File loading in order
IBBoard <dev@ibboard.co.uk>
parents:
8
diff
changeset
|
171 { |
|
0770e5cbba7c
Closes #21 - File loading in order
IBBoard <dev@ibboard.co.uk>
parents:
8
diff
changeset
|
172 List<FileLoadFailure> directoryFails = FillLoadableFilesForDirectory(loadableRaces, loadableGameSystems, directory); |
|
0770e5cbba7c
Closes #21 - File loading in order
IBBoard <dev@ibboard.co.uk>
parents:
8
diff
changeset
|
173 fails.AddRange(directoryFails); |
|
0770e5cbba7c
Closes #21 - File loading in order
IBBoard <dev@ibboard.co.uk>
parents:
8
diff
changeset
|
174 } |
|
0770e5cbba7c
Closes #21 - File loading in order
IBBoard <dev@ibboard.co.uk>
parents:
8
diff
changeset
|
175 else |
|
0770e5cbba7c
Closes #21 - File loading in order
IBBoard <dev@ibboard.co.uk>
parents:
8
diff
changeset
|
176 { |
|
0770e5cbba7c
Closes #21 - File loading in order
IBBoard <dev@ibboard.co.uk>
parents:
8
diff
changeset
|
177 LogNotifier.WarnFormat(GetType(), "Load for {0} failed because directory didn't exist", directory.FullName); |
|
0770e5cbba7c
Closes #21 - File loading in order
IBBoard <dev@ibboard.co.uk>
parents:
8
diff
changeset
|
178 } |
|
0770e5cbba7c
Closes #21 - File loading in order
IBBoard <dev@ibboard.co.uk>
parents:
8
diff
changeset
|
179 } |
|
0770e5cbba7c
Closes #21 - File loading in order
IBBoard <dev@ibboard.co.uk>
parents:
8
diff
changeset
|
180 |
|
0770e5cbba7c
Closes #21 - File loading in order
IBBoard <dev@ibboard.co.uk>
parents:
8
diff
changeset
|
181 return fails; |
|
0770e5cbba7c
Closes #21 - File loading in order
IBBoard <dev@ibboard.co.uk>
parents:
8
diff
changeset
|
182 } |
|
0770e5cbba7c
Closes #21 - File loading in order
IBBoard <dev@ibboard.co.uk>
parents:
8
diff
changeset
|
183 |
|
0770e5cbba7c
Closes #21 - File loading in order
IBBoard <dev@ibboard.co.uk>
parents:
8
diff
changeset
|
184 private List<FileLoadFailure> FillLoadableFilesForDirectory(Dictionary<FileInfo, IWarFoundryFactory> loadableRaces, Dictionary<FileInfo, IWarFoundryFactory> loadableGameSystems, DirectoryInfo directory) |
|
0770e5cbba7c
Closes #21 - File loading in order
IBBoard <dev@ibboard.co.uk>
parents:
8
diff
changeset
|
185 { |
|
0770e5cbba7c
Closes #21 - File loading in order
IBBoard <dev@ibboard.co.uk>
parents:
8
diff
changeset
|
186 List<FileLoadFailure> fails = new List<FileLoadFailure>(); |
|
0770e5cbba7c
Closes #21 - File loading in order
IBBoard <dev@ibboard.co.uk>
parents:
8
diff
changeset
|
187 LogNotifier.Debug(GetType(), "Load from "+directory.FullName); |
|
0770e5cbba7c
Closes #21 - File loading in order
IBBoard <dev@ibboard.co.uk>
parents:
8
diff
changeset
|
188 |
|
0770e5cbba7c
Closes #21 - File loading in order
IBBoard <dev@ibboard.co.uk>
parents:
8
diff
changeset
|
189 foreach (FileInfo file in directory.GetFiles()) |
|
0770e5cbba7c
Closes #21 - File loading in order
IBBoard <dev@ibboard.co.uk>
parents:
8
diff
changeset
|
190 { |
|
0770e5cbba7c
Closes #21 - File loading in order
IBBoard <dev@ibboard.co.uk>
parents:
8
diff
changeset
|
191 IWarFoundryFactory factory = GetGameSystemRaceLoadingFactoryForFile(file); |
|
0770e5cbba7c
Closes #21 - File loading in order
IBBoard <dev@ibboard.co.uk>
parents:
8
diff
changeset
|
192 |
|
0770e5cbba7c
Closes #21 - File loading in order
IBBoard <dev@ibboard.co.uk>
parents:
8
diff
changeset
|
193 if (factory != null) |
|
0770e5cbba7c
Closes #21 - File loading in order
IBBoard <dev@ibboard.co.uk>
parents:
8
diff
changeset
|
194 { |
|
0770e5cbba7c
Closes #21 - File loading in order
IBBoard <dev@ibboard.co.uk>
parents:
8
diff
changeset
|
195 loadableGameSystems.Add(file, factory); |
|
0770e5cbba7c
Closes #21 - File loading in order
IBBoard <dev@ibboard.co.uk>
parents:
8
diff
changeset
|
196 } |
|
0770e5cbba7c
Closes #21 - File loading in order
IBBoard <dev@ibboard.co.uk>
parents:
8
diff
changeset
|
197 else |
|
0770e5cbba7c
Closes #21 - File loading in order
IBBoard <dev@ibboard.co.uk>
parents:
8
diff
changeset
|
198 { |
|
0770e5cbba7c
Closes #21 - File loading in order
IBBoard <dev@ibboard.co.uk>
parents:
8
diff
changeset
|
199 factory = GetRaceLoadingFactoryForFile(file); |
|
0770e5cbba7c
Closes #21 - File loading in order
IBBoard <dev@ibboard.co.uk>
parents:
8
diff
changeset
|
200 |
|
0770e5cbba7c
Closes #21 - File loading in order
IBBoard <dev@ibboard.co.uk>
parents:
8
diff
changeset
|
201 if (factory!=null) |
|
0770e5cbba7c
Closes #21 - File loading in order
IBBoard <dev@ibboard.co.uk>
parents:
8
diff
changeset
|
202 { |
|
0770e5cbba7c
Closes #21 - File loading in order
IBBoard <dev@ibboard.co.uk>
parents:
8
diff
changeset
|
203 loadableRaces.Add(file, factory); |
|
0770e5cbba7c
Closes #21 - File loading in order
IBBoard <dev@ibboard.co.uk>
parents:
8
diff
changeset
|
204 } |
|
0770e5cbba7c
Closes #21 - File loading in order
IBBoard <dev@ibboard.co.uk>
parents:
8
diff
changeset
|
205 else |
|
0770e5cbba7c
Closes #21 - File loading in order
IBBoard <dev@ibboard.co.uk>
parents:
8
diff
changeset
|
206 { |
|
0770e5cbba7c
Closes #21 - File loading in order
IBBoard <dev@ibboard.co.uk>
parents:
8
diff
changeset
|
207 fails.Add(new FileLoadFailure(file, "FileNotHandled", "File not handled as a Race or Game System definition: {0}")); |
|
0770e5cbba7c
Closes #21 - File loading in order
IBBoard <dev@ibboard.co.uk>
parents:
8
diff
changeset
|
208 } |
|
0770e5cbba7c
Closes #21 - File loading in order
IBBoard <dev@ibboard.co.uk>
parents:
8
diff
changeset
|
209 } |
|
0770e5cbba7c
Closes #21 - File loading in order
IBBoard <dev@ibboard.co.uk>
parents:
8
diff
changeset
|
210 } |
|
0770e5cbba7c
Closes #21 - File loading in order
IBBoard <dev@ibboard.co.uk>
parents:
8
diff
changeset
|
211 |
|
0770e5cbba7c
Closes #21 - File loading in order
IBBoard <dev@ibboard.co.uk>
parents:
8
diff
changeset
|
212 return fails; |
|
0770e5cbba7c
Closes #21 - File loading in order
IBBoard <dev@ibboard.co.uk>
parents:
8
diff
changeset
|
213 } |
|
0770e5cbba7c
Closes #21 - File loading in order
IBBoard <dev@ibboard.co.uk>
parents:
8
diff
changeset
|
214 |
|
0770e5cbba7c
Closes #21 - File loading in order
IBBoard <dev@ibboard.co.uk>
parents:
8
diff
changeset
|
215 private IWarFoundryFactory GetGameSystemRaceLoadingFactoryForFile(FileInfo file) |
|
0770e5cbba7c
Closes #21 - File loading in order
IBBoard <dev@ibboard.co.uk>
parents:
8
diff
changeset
|
216 { |
|
0770e5cbba7c
Closes #21 - File loading in order
IBBoard <dev@ibboard.co.uk>
parents:
8
diff
changeset
|
217 IWarFoundryFactory loadingFactory = null; |
|
0770e5cbba7c
Closes #21 - File loading in order
IBBoard <dev@ibboard.co.uk>
parents:
8
diff
changeset
|
218 |
|
0770e5cbba7c
Closes #21 - File loading in order
IBBoard <dev@ibboard.co.uk>
parents:
8
diff
changeset
|
219 foreach (INonNativeWarFoundryFactory factory in nonNativeFactories) |
|
0770e5cbba7c
Closes #21 - File loading in order
IBBoard <dev@ibboard.co.uk>
parents:
8
diff
changeset
|
220 { |
|
0770e5cbba7c
Closes #21 - File loading in order
IBBoard <dev@ibboard.co.uk>
parents:
8
diff
changeset
|
221 if (factory.CanHandleFileAsGameSystem(file)) |
|
0770e5cbba7c
Closes #21 - File loading in order
IBBoard <dev@ibboard.co.uk>
parents:
8
diff
changeset
|
222 { |
|
0770e5cbba7c
Closes #21 - File loading in order
IBBoard <dev@ibboard.co.uk>
parents:
8
diff
changeset
|
223 loadingFactory = factory; |
|
0770e5cbba7c
Closes #21 - File loading in order
IBBoard <dev@ibboard.co.uk>
parents:
8
diff
changeset
|
224 break; |
|
0770e5cbba7c
Closes #21 - File loading in order
IBBoard <dev@ibboard.co.uk>
parents:
8
diff
changeset
|
225 } |
|
0770e5cbba7c
Closes #21 - File loading in order
IBBoard <dev@ibboard.co.uk>
parents:
8
diff
changeset
|
226 } |
|
0770e5cbba7c
Closes #21 - File loading in order
IBBoard <dev@ibboard.co.uk>
parents:
8
diff
changeset
|
227 |
|
0770e5cbba7c
Closes #21 - File loading in order
IBBoard <dev@ibboard.co.uk>
parents:
8
diff
changeset
|
228 if (loadingFactory == null) |
|
0770e5cbba7c
Closes #21 - File loading in order
IBBoard <dev@ibboard.co.uk>
parents:
8
diff
changeset
|
229 { |
|
0770e5cbba7c
Closes #21 - File loading in order
IBBoard <dev@ibboard.co.uk>
parents:
8
diff
changeset
|
230 foreach (INativeWarFoundryFactory factory in factories) |
|
0770e5cbba7c
Closes #21 - File loading in order
IBBoard <dev@ibboard.co.uk>
parents:
8
diff
changeset
|
231 { |
|
0770e5cbba7c
Closes #21 - File loading in order
IBBoard <dev@ibboard.co.uk>
parents:
8
diff
changeset
|
232 if (factory.CanHandleFileAsGameSystem(file)) |
|
0770e5cbba7c
Closes #21 - File loading in order
IBBoard <dev@ibboard.co.uk>
parents:
8
diff
changeset
|
233 { |
|
0770e5cbba7c
Closes #21 - File loading in order
IBBoard <dev@ibboard.co.uk>
parents:
8
diff
changeset
|
234 loadingFactory = factory; |
|
0770e5cbba7c
Closes #21 - File loading in order
IBBoard <dev@ibboard.co.uk>
parents:
8
diff
changeset
|
235 break; |
|
0770e5cbba7c
Closes #21 - File loading in order
IBBoard <dev@ibboard.co.uk>
parents:
8
diff
changeset
|
236 } |
|
0770e5cbba7c
Closes #21 - File loading in order
IBBoard <dev@ibboard.co.uk>
parents:
8
diff
changeset
|
237 } |
|
0770e5cbba7c
Closes #21 - File loading in order
IBBoard <dev@ibboard.co.uk>
parents:
8
diff
changeset
|
238 } |
|
0770e5cbba7c
Closes #21 - File loading in order
IBBoard <dev@ibboard.co.uk>
parents:
8
diff
changeset
|
239 |
|
0770e5cbba7c
Closes #21 - File loading in order
IBBoard <dev@ibboard.co.uk>
parents:
8
diff
changeset
|
240 return loadingFactory; |
|
0770e5cbba7c
Closes #21 - File loading in order
IBBoard <dev@ibboard.co.uk>
parents:
8
diff
changeset
|
241 } |
|
0770e5cbba7c
Closes #21 - File loading in order
IBBoard <dev@ibboard.co.uk>
parents:
8
diff
changeset
|
242 |
|
0770e5cbba7c
Closes #21 - File loading in order
IBBoard <dev@ibboard.co.uk>
parents:
8
diff
changeset
|
243 private IWarFoundryFactory GetRaceLoadingFactoryForFile(FileInfo file) |
|
0770e5cbba7c
Closes #21 - File loading in order
IBBoard <dev@ibboard.co.uk>
parents:
8
diff
changeset
|
244 { |
|
0770e5cbba7c
Closes #21 - File loading in order
IBBoard <dev@ibboard.co.uk>
parents:
8
diff
changeset
|
245 IWarFoundryFactory loadingFactory = null; |
|
0770e5cbba7c
Closes #21 - File loading in order
IBBoard <dev@ibboard.co.uk>
parents:
8
diff
changeset
|
246 |
|
0770e5cbba7c
Closes #21 - File loading in order
IBBoard <dev@ibboard.co.uk>
parents:
8
diff
changeset
|
247 foreach (INonNativeWarFoundryFactory factory in nonNativeFactories) |
|
0770e5cbba7c
Closes #21 - File loading in order
IBBoard <dev@ibboard.co.uk>
parents:
8
diff
changeset
|
248 { |
|
0770e5cbba7c
Closes #21 - File loading in order
IBBoard <dev@ibboard.co.uk>
parents:
8
diff
changeset
|
249 if (factory.CanHandleFileAsRace(file)) |
|
0770e5cbba7c
Closes #21 - File loading in order
IBBoard <dev@ibboard.co.uk>
parents:
8
diff
changeset
|
250 { |
|
0770e5cbba7c
Closes #21 - File loading in order
IBBoard <dev@ibboard.co.uk>
parents:
8
diff
changeset
|
251 loadingFactory = factory; |
|
0770e5cbba7c
Closes #21 - File loading in order
IBBoard <dev@ibboard.co.uk>
parents:
8
diff
changeset
|
252 break; |
|
0770e5cbba7c
Closes #21 - File loading in order
IBBoard <dev@ibboard.co.uk>
parents:
8
diff
changeset
|
253 } |
|
0770e5cbba7c
Closes #21 - File loading in order
IBBoard <dev@ibboard.co.uk>
parents:
8
diff
changeset
|
254 } |
|
0770e5cbba7c
Closes #21 - File loading in order
IBBoard <dev@ibboard.co.uk>
parents:
8
diff
changeset
|
255 |
|
0770e5cbba7c
Closes #21 - File loading in order
IBBoard <dev@ibboard.co.uk>
parents:
8
diff
changeset
|
256 if (loadingFactory == null) |
|
0770e5cbba7c
Closes #21 - File loading in order
IBBoard <dev@ibboard.co.uk>
parents:
8
diff
changeset
|
257 { |
|
0770e5cbba7c
Closes #21 - File loading in order
IBBoard <dev@ibboard.co.uk>
parents:
8
diff
changeset
|
258 foreach (INativeWarFoundryFactory factory in factories) |
|
0770e5cbba7c
Closes #21 - File loading in order
IBBoard <dev@ibboard.co.uk>
parents:
8
diff
changeset
|
259 { |
|
0770e5cbba7c
Closes #21 - File loading in order
IBBoard <dev@ibboard.co.uk>
parents:
8
diff
changeset
|
260 if (factory.CanHandleFileAsRace(file)) |
|
0770e5cbba7c
Closes #21 - File loading in order
IBBoard <dev@ibboard.co.uk>
parents:
8
diff
changeset
|
261 { |
|
0770e5cbba7c
Closes #21 - File loading in order
IBBoard <dev@ibboard.co.uk>
parents:
8
diff
changeset
|
262 loadingFactory = factory; |
|
0770e5cbba7c
Closes #21 - File loading in order
IBBoard <dev@ibboard.co.uk>
parents:
8
diff
changeset
|
263 break; |
|
0770e5cbba7c
Closes #21 - File loading in order
IBBoard <dev@ibboard.co.uk>
parents:
8
diff
changeset
|
264 } |
|
0770e5cbba7c
Closes #21 - File loading in order
IBBoard <dev@ibboard.co.uk>
parents:
8
diff
changeset
|
265 } |
|
0770e5cbba7c
Closes #21 - File loading in order
IBBoard <dev@ibboard.co.uk>
parents:
8
diff
changeset
|
266 } |
|
0770e5cbba7c
Closes #21 - File loading in order
IBBoard <dev@ibboard.co.uk>
parents:
8
diff
changeset
|
267 |
|
0770e5cbba7c
Closes #21 - File loading in order
IBBoard <dev@ibboard.co.uk>
parents:
8
diff
changeset
|
268 return loadingFactory; |
|
0770e5cbba7c
Closes #21 - File loading in order
IBBoard <dev@ibboard.co.uk>
parents:
8
diff
changeset
|
269 } |
|
0770e5cbba7c
Closes #21 - File loading in order
IBBoard <dev@ibboard.co.uk>
parents:
8
diff
changeset
|
270 |
|
0770e5cbba7c
Closes #21 - File loading in order
IBBoard <dev@ibboard.co.uk>
parents:
8
diff
changeset
|
271 private List<FileLoadFailure> LoadGameSystems(Dictionary<FileInfo, IWarFoundryFactory> gameSystemFiles) |
|
0770e5cbba7c
Closes #21 - File loading in order
IBBoard <dev@ibboard.co.uk>
parents:
8
diff
changeset
|
272 { |
|
0770e5cbba7c
Closes #21 - File loading in order
IBBoard <dev@ibboard.co.uk>
parents:
8
diff
changeset
|
273 List<FileLoadFailure> fails = new List<FileLoadFailure>(); |
|
0770e5cbba7c
Closes #21 - File loading in order
IBBoard <dev@ibboard.co.uk>
parents:
8
diff
changeset
|
274 |
|
0770e5cbba7c
Closes #21 - File loading in order
IBBoard <dev@ibboard.co.uk>
parents:
8
diff
changeset
|
275 |
|
0770e5cbba7c
Closes #21 - File loading in order
IBBoard <dev@ibboard.co.uk>
parents:
8
diff
changeset
|
276 foreach (FileInfo file in gameSystemFiles.Keys) |
|
0770e5cbba7c
Closes #21 - File loading in order
IBBoard <dev@ibboard.co.uk>
parents:
8
diff
changeset
|
277 { |
|
0770e5cbba7c
Closes #21 - File loading in order
IBBoard <dev@ibboard.co.uk>
parents:
8
diff
changeset
|
278 try |
|
0770e5cbba7c
Closes #21 - File loading in order
IBBoard <dev@ibboard.co.uk>
parents:
8
diff
changeset
|
279 { |
|
0770e5cbba7c
Closes #21 - File loading in order
IBBoard <dev@ibboard.co.uk>
parents:
8
diff
changeset
|
280 bool loaded = LoadObject(file, gameSystemFiles[file]); |
|
0770e5cbba7c
Closes #21 - File loading in order
IBBoard <dev@ibboard.co.uk>
parents:
8
diff
changeset
|
281 |
|
0770e5cbba7c
Closes #21 - File loading in order
IBBoard <dev@ibboard.co.uk>
parents:
8
diff
changeset
|
282 if (!loaded) |
|
0770e5cbba7c
Closes #21 - File loading in order
IBBoard <dev@ibboard.co.uk>
parents:
8
diff
changeset
|
283 { |
|
0770e5cbba7c
Closes #21 - File loading in order
IBBoard <dev@ibboard.co.uk>
parents:
8
diff
changeset
|
284 fails.Add(new FileLoadFailure(file, "FileLoadFailed", "Failed to load {0} as Race using {1}")); |
|
0770e5cbba7c
Closes #21 - File loading in order
IBBoard <dev@ibboard.co.uk>
parents:
8
diff
changeset
|
285 } |
|
0770e5cbba7c
Closes #21 - File loading in order
IBBoard <dev@ibboard.co.uk>
parents:
8
diff
changeset
|
286 } |
|
0770e5cbba7c
Closes #21 - File loading in order
IBBoard <dev@ibboard.co.uk>
parents:
8
diff
changeset
|
287 catch (Exception ex) |
|
0770e5cbba7c
Closes #21 - File loading in order
IBBoard <dev@ibboard.co.uk>
parents:
8
diff
changeset
|
288 { |
|
0770e5cbba7c
Closes #21 - File loading in order
IBBoard <dev@ibboard.co.uk>
parents:
8
diff
changeset
|
289 fails.Add(new FileLoadFailure(file, ex.Message)); |
|
0770e5cbba7c
Closes #21 - File loading in order
IBBoard <dev@ibboard.co.uk>
parents:
8
diff
changeset
|
290 } |
|
0770e5cbba7c
Closes #21 - File loading in order
IBBoard <dev@ibboard.co.uk>
parents:
8
diff
changeset
|
291 } |
|
0770e5cbba7c
Closes #21 - File loading in order
IBBoard <dev@ibboard.co.uk>
parents:
8
diff
changeset
|
292 |
|
0770e5cbba7c
Closes #21 - File loading in order
IBBoard <dev@ibboard.co.uk>
parents:
8
diff
changeset
|
293 return fails; |
|
0770e5cbba7c
Closes #21 - File loading in order
IBBoard <dev@ibboard.co.uk>
parents:
8
diff
changeset
|
294 } |
|
0770e5cbba7c
Closes #21 - File loading in order
IBBoard <dev@ibboard.co.uk>
parents:
8
diff
changeset
|
295 |
|
0770e5cbba7c
Closes #21 - File loading in order
IBBoard <dev@ibboard.co.uk>
parents:
8
diff
changeset
|
296 private List<FileLoadFailure> LoadRaces(Dictionary<FileInfo, IWarFoundryFactory> raceFiles) |
|
0770e5cbba7c
Closes #21 - File loading in order
IBBoard <dev@ibboard.co.uk>
parents:
8
diff
changeset
|
297 { |
|
0770e5cbba7c
Closes #21 - File loading in order
IBBoard <dev@ibboard.co.uk>
parents:
8
diff
changeset
|
298 List<FileLoadFailure> fails = new List<FileLoadFailure>(); |
|
0770e5cbba7c
Closes #21 - File loading in order
IBBoard <dev@ibboard.co.uk>
parents:
8
diff
changeset
|
299 |
|
0770e5cbba7c
Closes #21 - File loading in order
IBBoard <dev@ibboard.co.uk>
parents:
8
diff
changeset
|
300 foreach (FileInfo file in raceFiles.Keys) |
|
0770e5cbba7c
Closes #21 - File loading in order
IBBoard <dev@ibboard.co.uk>
parents:
8
diff
changeset
|
301 { |
|
0770e5cbba7c
Closes #21 - File loading in order
IBBoard <dev@ibboard.co.uk>
parents:
8
diff
changeset
|
302 try |
|
0770e5cbba7c
Closes #21 - File loading in order
IBBoard <dev@ibboard.co.uk>
parents:
8
diff
changeset
|
303 { |
|
0770e5cbba7c
Closes #21 - File loading in order
IBBoard <dev@ibboard.co.uk>
parents:
8
diff
changeset
|
304 bool loaded = LoadObject(file, raceFiles[file]); |
|
0770e5cbba7c
Closes #21 - File loading in order
IBBoard <dev@ibboard.co.uk>
parents:
8
diff
changeset
|
305 |
|
0770e5cbba7c
Closes #21 - File loading in order
IBBoard <dev@ibboard.co.uk>
parents:
8
diff
changeset
|
306 if (!loaded) |
|
0770e5cbba7c
Closes #21 - File loading in order
IBBoard <dev@ibboard.co.uk>
parents:
8
diff
changeset
|
307 { |
|
0770e5cbba7c
Closes #21 - File loading in order
IBBoard <dev@ibboard.co.uk>
parents:
8
diff
changeset
|
308 fails.Add(new FileLoadFailure(file, "FileLoadFailed", "Failed to load {0} as Race using {1}")); |
|
0770e5cbba7c
Closes #21 - File loading in order
IBBoard <dev@ibboard.co.uk>
parents:
8
diff
changeset
|
309 } |
|
0770e5cbba7c
Closes #21 - File loading in order
IBBoard <dev@ibboard.co.uk>
parents:
8
diff
changeset
|
310 } |
|
0770e5cbba7c
Closes #21 - File loading in order
IBBoard <dev@ibboard.co.uk>
parents:
8
diff
changeset
|
311 catch (Exception ex) |
|
0770e5cbba7c
Closes #21 - File loading in order
IBBoard <dev@ibboard.co.uk>
parents:
8
diff
changeset
|
312 { |
|
0770e5cbba7c
Closes #21 - File loading in order
IBBoard <dev@ibboard.co.uk>
parents:
8
diff
changeset
|
313 fails.Add(new FileLoadFailure(file, ex.Message)); |
|
0770e5cbba7c
Closes #21 - File loading in order
IBBoard <dev@ibboard.co.uk>
parents:
8
diff
changeset
|
314 } |
|
0770e5cbba7c
Closes #21 - File loading in order
IBBoard <dev@ibboard.co.uk>
parents:
8
diff
changeset
|
315 } |
|
0770e5cbba7c
Closes #21 - File loading in order
IBBoard <dev@ibboard.co.uk>
parents:
8
diff
changeset
|
316 |
|
0770e5cbba7c
Closes #21 - File loading in order
IBBoard <dev@ibboard.co.uk>
parents:
8
diff
changeset
|
317 return fails; |
|
0770e5cbba7c
Closes #21 - File loading in order
IBBoard <dev@ibboard.co.uk>
parents:
8
diff
changeset
|
318 } |
|
0770e5cbba7c
Closes #21 - File loading in order
IBBoard <dev@ibboard.co.uk>
parents:
8
diff
changeset
|
319 |
|
0770e5cbba7c
Closes #21 - File loading in order
IBBoard <dev@ibboard.co.uk>
parents:
8
diff
changeset
|
320 private bool LoadObject(FileInfo file, IWarFoundryFactory factory) |
|
0770e5cbba7c
Closes #21 - File loading in order
IBBoard <dev@ibboard.co.uk>
parents:
8
diff
changeset
|
321 { |
|
0770e5cbba7c
Closes #21 - File loading in order
IBBoard <dev@ibboard.co.uk>
parents:
8
diff
changeset
|
322 bool loaded = false; |
|
0770e5cbba7c
Closes #21 - File loading in order
IBBoard <dev@ibboard.co.uk>
parents:
8
diff
changeset
|
323 |
|
0770e5cbba7c
Closes #21 - File loading in order
IBBoard <dev@ibboard.co.uk>
parents:
8
diff
changeset
|
324 LogNotifier.DebugFormat(GetType(), "Loading {0} using {1}", file.FullName, factory.GetType().Name); |
|
0770e5cbba7c
Closes #21 - File loading in order
IBBoard <dev@ibboard.co.uk>
parents:
8
diff
changeset
|
325 ICollection<IWarFoundryObject> objects = factory.CreateObjectsFromFile(file); |
|
0770e5cbba7c
Closes #21 - File loading in order
IBBoard <dev@ibboard.co.uk>
parents:
8
diff
changeset
|
326 |
|
0770e5cbba7c
Closes #21 - File loading in order
IBBoard <dev@ibboard.co.uk>
parents:
8
diff
changeset
|
327 if (objects.Count > 0) |
|
0770e5cbba7c
Closes #21 - File loading in order
IBBoard <dev@ibboard.co.uk>
parents:
8
diff
changeset
|
328 { |
|
0770e5cbba7c
Closes #21 - File loading in order
IBBoard <dev@ibboard.co.uk>
parents:
8
diff
changeset
|
329 AddLoadedObjects(objects, factory); |
|
0770e5cbba7c
Closes #21 - File loading in order
IBBoard <dev@ibboard.co.uk>
parents:
8
diff
changeset
|
330 loaded = true; |
|
0770e5cbba7c
Closes #21 - File loading in order
IBBoard <dev@ibboard.co.uk>
parents:
8
diff
changeset
|
331 } |
|
0770e5cbba7c
Closes #21 - File loading in order
IBBoard <dev@ibboard.co.uk>
parents:
8
diff
changeset
|
332 |
|
0770e5cbba7c
Closes #21 - File loading in order
IBBoard <dev@ibboard.co.uk>
parents:
8
diff
changeset
|
333 return loaded; |
|
0770e5cbba7c
Closes #21 - File loading in order
IBBoard <dev@ibboard.co.uk>
parents:
8
diff
changeset
|
334 } |
|
0770e5cbba7c
Closes #21 - File loading in order
IBBoard <dev@ibboard.co.uk>
parents:
8
diff
changeset
|
335 |
| 0 | 336 |
| 337 /// <summary> | |
| 338 /// Loads a single file through the registered WarFoundryFactories, if a factory exists that supports the file format. | |
| 339 /// </summary> | |
| 340 /// <param name="file"> | |
| 341 /// A <see cref="FileInfo"/> for the file to attempt to load | |
| 342 /// </param> | |
|
14
0770e5cbba7c
Closes #21 - File loading in order
IBBoard <dev@ibboard.co.uk>
parents:
8
diff
changeset
|
343 /// <returns> |
|
0770e5cbba7c
Closes #21 - File loading in order
IBBoard <dev@ibboard.co.uk>
parents:
8
diff
changeset
|
344 /// An ICollection of IWarFoundryObjects loaded from <code>file</code> |
|
0770e5cbba7c
Closes #21 - File loading in order
IBBoard <dev@ibboard.co.uk>
parents:
8
diff
changeset
|
345 /// </returns> |
|
0770e5cbba7c
Closes #21 - File loading in order
IBBoard <dev@ibboard.co.uk>
parents:
8
diff
changeset
|
346 public ICollection<IWarFoundryObject> LoadFile(FileInfo file) |
| 0 | 347 { |
|
19
57451981545c
Re #10 and re #11 - Refactor code and document code
IBBoard <dev@ibboard.co.uk>
parents:
16
diff
changeset
|
348 ICollection<IWarFoundryObject> objs = null; |
|
14
0770e5cbba7c
Closes #21 - File loading in order
IBBoard <dev@ibboard.co.uk>
parents:
8
diff
changeset
|
349 IWarFoundryFactory loadFactory = null; |
| 0 | 350 |
|
19
57451981545c
Re #10 and re #11 - Refactor code and document code
IBBoard <dev@ibboard.co.uk>
parents:
16
diff
changeset
|
351 try |
|
57451981545c
Re #10 and re #11 - Refactor code and document code
IBBoard <dev@ibboard.co.uk>
parents:
16
diff
changeset
|
352 { |
|
57451981545c
Re #10 and re #11 - Refactor code and document code
IBBoard <dev@ibboard.co.uk>
parents:
16
diff
changeset
|
353 objs = LoadFileWithNonNativeFactories(file, out loadFactory); |
|
57451981545c
Re #10 and re #11 - Refactor code and document code
IBBoard <dev@ibboard.co.uk>
parents:
16
diff
changeset
|
354 |
|
57451981545c
Re #10 and re #11 - Refactor code and document code
IBBoard <dev@ibboard.co.uk>
parents:
16
diff
changeset
|
355 if (objs == null) |
|
57451981545c
Re #10 and re #11 - Refactor code and document code
IBBoard <dev@ibboard.co.uk>
parents:
16
diff
changeset
|
356 { |
|
57451981545c
Re #10 and re #11 - Refactor code and document code
IBBoard <dev@ibboard.co.uk>
parents:
16
diff
changeset
|
357 objs = LoadFileWithNativeFactories(file, out loadFactory); |
|
57451981545c
Re #10 and re #11 - Refactor code and document code
IBBoard <dev@ibboard.co.uk>
parents:
16
diff
changeset
|
358 } |
|
57451981545c
Re #10 and re #11 - Refactor code and document code
IBBoard <dev@ibboard.co.uk>
parents:
16
diff
changeset
|
359 } |
|
57451981545c
Re #10 and re #11 - Refactor code and document code
IBBoard <dev@ibboard.co.uk>
parents:
16
diff
changeset
|
360 catch (InvalidFileException ex) |
|
57451981545c
Re #10 and re #11 - Refactor code and document code
IBBoard <dev@ibboard.co.uk>
parents:
16
diff
changeset
|
361 { |
|
57451981545c
Re #10 and re #11 - Refactor code and document code
IBBoard <dev@ibboard.co.uk>
parents:
16
diff
changeset
|
362 LogNotifier.Error(GetType(), file.FullName+" failed to load: "+ex.Message); |
|
57451981545c
Re #10 and re #11 - Refactor code and document code
IBBoard <dev@ibboard.co.uk>
parents:
16
diff
changeset
|
363 } |
|
57451981545c
Re #10 and re #11 - Refactor code and document code
IBBoard <dev@ibboard.co.uk>
parents:
16
diff
changeset
|
364 |
|
57451981545c
Re #10 and re #11 - Refactor code and document code
IBBoard <dev@ibboard.co.uk>
parents:
16
diff
changeset
|
365 if (objs!=null) |
|
57451981545c
Re #10 and re #11 - Refactor code and document code
IBBoard <dev@ibboard.co.uk>
parents:
16
diff
changeset
|
366 { |
|
57451981545c
Re #10 and re #11 - Refactor code and document code
IBBoard <dev@ibboard.co.uk>
parents:
16
diff
changeset
|
367 AddLoadedObjects(objs, loadFactory); |
|
57451981545c
Re #10 and re #11 - Refactor code and document code
IBBoard <dev@ibboard.co.uk>
parents:
16
diff
changeset
|
368 } |
|
57451981545c
Re #10 and re #11 - Refactor code and document code
IBBoard <dev@ibboard.co.uk>
parents:
16
diff
changeset
|
369 else |
|
57451981545c
Re #10 and re #11 - Refactor code and document code
IBBoard <dev@ibboard.co.uk>
parents:
16
diff
changeset
|
370 { |
|
57451981545c
Re #10 and re #11 - Refactor code and document code
IBBoard <dev@ibboard.co.uk>
parents:
16
diff
changeset
|
371 LogNotifier.Debug(GetType(), "Could not load "+file.FullName); |
|
57451981545c
Re #10 and re #11 - Refactor code and document code
IBBoard <dev@ibboard.co.uk>
parents:
16
diff
changeset
|
372 objs = new List<IWarFoundryObject>(); |
|
57451981545c
Re #10 and re #11 - Refactor code and document code
IBBoard <dev@ibboard.co.uk>
parents:
16
diff
changeset
|
373 } |
|
57451981545c
Re #10 and re #11 - Refactor code and document code
IBBoard <dev@ibboard.co.uk>
parents:
16
diff
changeset
|
374 |
|
57451981545c
Re #10 and re #11 - Refactor code and document code
IBBoard <dev@ibboard.co.uk>
parents:
16
diff
changeset
|
375 return objs; |
|
57451981545c
Re #10 and re #11 - Refactor code and document code
IBBoard <dev@ibboard.co.uk>
parents:
16
diff
changeset
|
376 } |
|
57451981545c
Re #10 and re #11 - Refactor code and document code
IBBoard <dev@ibboard.co.uk>
parents:
16
diff
changeset
|
377 |
|
57451981545c
Re #10 and re #11 - Refactor code and document code
IBBoard <dev@ibboard.co.uk>
parents:
16
diff
changeset
|
378 private ICollection<IWarFoundryObject> LoadFileWithNonNativeFactories(FileInfo file, out IWarFoundryFactory loadFactory) |
|
57451981545c
Re #10 and re #11 - Refactor code and document code
IBBoard <dev@ibboard.co.uk>
parents:
16
diff
changeset
|
379 { |
|
57451981545c
Re #10 and re #11 - Refactor code and document code
IBBoard <dev@ibboard.co.uk>
parents:
16
diff
changeset
|
380 ICollection<IWarFoundryObject> objs = null; |
|
57451981545c
Re #10 and re #11 - Refactor code and document code
IBBoard <dev@ibboard.co.uk>
parents:
16
diff
changeset
|
381 loadFactory = null; |
|
57451981545c
Re #10 and re #11 - Refactor code and document code
IBBoard <dev@ibboard.co.uk>
parents:
16
diff
changeset
|
382 |
|
14
0770e5cbba7c
Closes #21 - File loading in order
IBBoard <dev@ibboard.co.uk>
parents:
8
diff
changeset
|
383 if (nonNativeFactories.Count > 0) |
| 0 | 384 { |
|
14
0770e5cbba7c
Closes #21 - File loading in order
IBBoard <dev@ibboard.co.uk>
parents:
8
diff
changeset
|
385 LogNotifier.Debug(GetType(), "Attempting to load "+file.FullName+" as a non-native file"); |
| 0 | 386 |
|
14
0770e5cbba7c
Closes #21 - File loading in order
IBBoard <dev@ibboard.co.uk>
parents:
8
diff
changeset
|
387 foreach (INonNativeWarFoundryFactory factory in nonNativeFactories) |
| 0 | 388 { |
|
14
0770e5cbba7c
Closes #21 - File loading in order
IBBoard <dev@ibboard.co.uk>
parents:
8
diff
changeset
|
389 bool canLoad = factory.CanHandleFileFormat(file); |
|
0770e5cbba7c
Closes #21 - File loading in order
IBBoard <dev@ibboard.co.uk>
parents:
8
diff
changeset
|
390 LogNotifier.Debug(GetType(), "Load using "+factory.GetType().FullName+"? " + (canLoad ? "yes" : "no")); |
| 0 | 391 |
|
14
0770e5cbba7c
Closes #21 - File loading in order
IBBoard <dev@ibboard.co.uk>
parents:
8
diff
changeset
|
392 if (canLoad) |
| 0 | 393 { |
|
14
0770e5cbba7c
Closes #21 - File loading in order
IBBoard <dev@ibboard.co.uk>
parents:
8
diff
changeset
|
394 objs = factory.CreateObjectsFromFile(file); |
| 0 | 395 |
|
14
0770e5cbba7c
Closes #21 - File loading in order
IBBoard <dev@ibboard.co.uk>
parents:
8
diff
changeset
|
396 if (objs!=null) |
| 0 | 397 { |
|
14
0770e5cbba7c
Closes #21 - File loading in order
IBBoard <dev@ibboard.co.uk>
parents:
8
diff
changeset
|
398 loadFactory = factory; |
|
0770e5cbba7c
Closes #21 - File loading in order
IBBoard <dev@ibboard.co.uk>
parents:
8
diff
changeset
|
399 break; |
|
0770e5cbba7c
Closes #21 - File loading in order
IBBoard <dev@ibboard.co.uk>
parents:
8
diff
changeset
|
400 } |
|
0770e5cbba7c
Closes #21 - File loading in order
IBBoard <dev@ibboard.co.uk>
parents:
8
diff
changeset
|
401 } |
| 0 | 402 } |
|
14
0770e5cbba7c
Closes #21 - File loading in order
IBBoard <dev@ibboard.co.uk>
parents:
8
diff
changeset
|
403 } |
|
0770e5cbba7c
Closes #21 - File loading in order
IBBoard <dev@ibboard.co.uk>
parents:
8
diff
changeset
|
404 |
|
19
57451981545c
Re #10 and re #11 - Refactor code and document code
IBBoard <dev@ibboard.co.uk>
parents:
16
diff
changeset
|
405 return objs; |
|
57451981545c
Re #10 and re #11 - Refactor code and document code
IBBoard <dev@ibboard.co.uk>
parents:
16
diff
changeset
|
406 } |
|
57451981545c
Re #10 and re #11 - Refactor code and document code
IBBoard <dev@ibboard.co.uk>
parents:
16
diff
changeset
|
407 |
|
57451981545c
Re #10 and re #11 - Refactor code and document code
IBBoard <dev@ibboard.co.uk>
parents:
16
diff
changeset
|
408 private ICollection<IWarFoundryObject> LoadFileWithNativeFactories(FileInfo file, out IWarFoundryFactory loadFactory) |
|
57451981545c
Re #10 and re #11 - Refactor code and document code
IBBoard <dev@ibboard.co.uk>
parents:
16
diff
changeset
|
409 { |
|
57451981545c
Re #10 and re #11 - Refactor code and document code
IBBoard <dev@ibboard.co.uk>
parents:
16
diff
changeset
|
410 ICollection<IWarFoundryObject> objs = null; |
|
57451981545c
Re #10 and re #11 - Refactor code and document code
IBBoard <dev@ibboard.co.uk>
parents:
16
diff
changeset
|
411 loadFactory = null; |
|
57451981545c
Re #10 and re #11 - Refactor code and document code
IBBoard <dev@ibboard.co.uk>
parents:
16
diff
changeset
|
412 |
|
57451981545c
Re #10 and re #11 - Refactor code and document code
IBBoard <dev@ibboard.co.uk>
parents:
16
diff
changeset
|
413 if (factories.Count > 0) |
|
14
0770e5cbba7c
Closes #21 - File loading in order
IBBoard <dev@ibboard.co.uk>
parents:
8
diff
changeset
|
414 { |
|
0770e5cbba7c
Closes #21 - File loading in order
IBBoard <dev@ibboard.co.uk>
parents:
8
diff
changeset
|
415 LogNotifier.Debug(GetType(), "Attempting to load "+file.FullName+" as native file"); |
|
19
57451981545c
Re #10 and re #11 - Refactor code and document code
IBBoard <dev@ibboard.co.uk>
parents:
16
diff
changeset
|
416 |
|
14
0770e5cbba7c
Closes #21 - File loading in order
IBBoard <dev@ibboard.co.uk>
parents:
8
diff
changeset
|
417 foreach (INativeWarFoundryFactory factory in factories) |
| 0 | 418 { |
|
14
0770e5cbba7c
Closes #21 - File loading in order
IBBoard <dev@ibboard.co.uk>
parents:
8
diff
changeset
|
419 if (factory.CanHandleFileFormat(file)) |
| 0 | 420 { |
|
14
0770e5cbba7c
Closes #21 - File loading in order
IBBoard <dev@ibboard.co.uk>
parents:
8
diff
changeset
|
421 objs = factory.CreateObjectsFromFile(file); |
|
0770e5cbba7c
Closes #21 - File loading in order
IBBoard <dev@ibboard.co.uk>
parents:
8
diff
changeset
|
422 |
|
0770e5cbba7c
Closes #21 - File loading in order
IBBoard <dev@ibboard.co.uk>
parents:
8
diff
changeset
|
423 if (objs!=null) |
| 0 | 424 { |
|
14
0770e5cbba7c
Closes #21 - File loading in order
IBBoard <dev@ibboard.co.uk>
parents:
8
diff
changeset
|
425 loadFactory = factory; |
|
0770e5cbba7c
Closes #21 - File loading in order
IBBoard <dev@ibboard.co.uk>
parents:
8
diff
changeset
|
426 break; |
| 0 | 427 } |
| 428 } | |
| 429 } | |
|
14
0770e5cbba7c
Closes #21 - File loading in order
IBBoard <dev@ibboard.co.uk>
parents:
8
diff
changeset
|
430 } |
|
19
57451981545c
Re #10 and re #11 - Refactor code and document code
IBBoard <dev@ibboard.co.uk>
parents:
16
diff
changeset
|
431 |
|
14
0770e5cbba7c
Closes #21 - File loading in order
IBBoard <dev@ibboard.co.uk>
parents:
8
diff
changeset
|
432 return objs; |
| 0 | 433 } |
| 434 | |
| 435 private void AddLoadedObjects(ICollection<IWarFoundryObject> loadedObjs, IWarFoundryFactory factory) | |
| 436 { | |
| 437 SimpleSet<IWarFoundryObject> objs; | |
| 438 loadedObjects.TryGetValue(factory, out objs); | |
| 439 | |
| 440 if (objs == null) | |
| 441 { | |
| 442 objs = new SimpleSet<IWarFoundryObject>(); | |
| 443 loadedObjects.Add(factory, objs); | |
| 444 } | |
| 445 | |
| 446 objs.AddRange(loadedObjs); | |
|
14
0770e5cbba7c
Closes #21 - File loading in order
IBBoard <dev@ibboard.co.uk>
parents:
8
diff
changeset
|
447 StoreObjects(loadedObjs); |
| 0 | 448 } |
|
14
0770e5cbba7c
Closes #21 - File loading in order
IBBoard <dev@ibboard.co.uk>
parents:
8
diff
changeset
|
449 |
|
0770e5cbba7c
Closes #21 - File loading in order
IBBoard <dev@ibboard.co.uk>
parents:
8
diff
changeset
|
450 private void StoreObjects(ICollection<IWarFoundryObject> loadedObjects) |
| 0 | 451 { |
|
14
0770e5cbba7c
Closes #21 - File loading in order
IBBoard <dev@ibboard.co.uk>
parents:
8
diff
changeset
|
452 foreach (IWarFoundryObject loadedObject in loadedObjects) |
| 0 | 453 { |
|
14
0770e5cbba7c
Closes #21 - File loading in order
IBBoard <dev@ibboard.co.uk>
parents:
8
diff
changeset
|
454 if (loadedObject is GameSystem) |
|
0770e5cbba7c
Closes #21 - File loading in order
IBBoard <dev@ibboard.co.uk>
parents:
8
diff
changeset
|
455 { |
|
0770e5cbba7c
Closes #21 - File loading in order
IBBoard <dev@ibboard.co.uk>
parents:
8
diff
changeset
|
456 StoreGameSystem((GameSystem)loadedObject); |
|
0770e5cbba7c
Closes #21 - File loading in order
IBBoard <dev@ibboard.co.uk>
parents:
8
diff
changeset
|
457 } |
|
0770e5cbba7c
Closes #21 - File loading in order
IBBoard <dev@ibboard.co.uk>
parents:
8
diff
changeset
|
458 else if (loadedObject is Race) |
|
0770e5cbba7c
Closes #21 - File loading in order
IBBoard <dev@ibboard.co.uk>
parents:
8
diff
changeset
|
459 { |
|
0770e5cbba7c
Closes #21 - File loading in order
IBBoard <dev@ibboard.co.uk>
parents:
8
diff
changeset
|
460 StoreRace((Race)loadedObject); |
|
0770e5cbba7c
Closes #21 - File loading in order
IBBoard <dev@ibboard.co.uk>
parents:
8
diff
changeset
|
461 } |
| 0 | 462 } |
| 463 } | |
| 464 | |
| 465 protected virtual ZipFile MakeZipFile(FileInfo file) | |
| 466 { | |
| 467 return new ZipFile(file.FullName); | |
| 468 } | |
| 469 | |
| 470 protected void StoreGameSystem(GameSystem system) | |
| 471 { | |
| 472 string sysid = system.ID.ToLower(); | |
| 473 | |
| 474 if (systemsTable.ContainsKey(sysid)) | |
| 475 { | |
| 476 LogNotifier.WarnFormat(GetType(), "System {0} ({1}) has already been loaded. Duplicate file ({3}) discarded", system.Name, system.ID, system.SourceFile.FullName); | |
| 477 } | |
| 478 else | |
| 479 { | |
| 480 systemsTable.Add(sysid, (GameSystem)system); | |
| 481 } | |
| 482 } | |
| 483 | |
| 484 protected void StoreRace(Race race) | |
| 485 { | |
| 486 Dictionary<string, Dictionary<string, Race>> systemRaces; | |
| 487 | |
| 488 if (race.GameSystem == null) | |
| 489 { | |
| 490 throw new InvalidOperationException("Race cannot have null game system. Game system should be loaded before race."); | |
| 491 } | |
| 492 | |
| 493 string systemID = race.GameSystem.ID.ToLower(); | |
| 494 racesTable.TryGetValue(systemID, out systemRaces); | |
| 495 | |
| 496 if (systemRaces==null) | |
| 497 { | |
| 498 systemRaces = new Dictionary<string,Dictionary<string,Race>>(); | |
| 499 racesTable.Add(systemID, systemRaces); | |
| 500 } | |
| 501 | |
| 502 Dictionary<string, Race> subRaces; | |
| 503 systemRaces.TryGetValue(race.ID.ToLower(), out subRaces); | |
| 504 | |
| 505 if (subRaces==null) | |
| 506 { | |
| 507 subRaces = new Dictionary<string,Race>(); | |
| 508 systemRaces.Add(race.ID.ToLower(), subRaces); | |
| 509 } | |
| 510 | |
| 511 if (subRaces.ContainsKey(race.SubID.ToLower())) | |
| 512 { | |
| 513 LogNotifier.WarnFormat(GetType(), "Race {0} ({1} - {2}) for system {3} ({4}) has already been loaded. Duplicate file ({5}) discarded", race.Name, race.ID, race.SubID, race.GameSystem.ID, race.GameSystem.Name, race.SourceFile.Name); | |
| 514 race = null; | |
| 515 } | |
| 516 else | |
| 517 { | |
| 518 subRaces.Add(race.SubID.ToLower(), race); | |
| 519 } | |
| 520 } | |
| 521 | |
| 522 /// <summary> | |
| 523 /// Gets all <see cref="GameSystem"/>s that are currently available, determined by those that can be loaded with the current <see cref="IWarFoundryFactory"/>s. | |
| 524 /// </summary> | |
| 525 /// <returns> | |
| 526 /// An array of <see cref="GameSystem"/>s that are currently available. | |
| 527 /// </returns> | |
| 528 public GameSystem[] GetGameSystems() | |
| 529 { | |
| 530 if (systemsTable==null) | |
| 531 { | |
| 532 LoadFiles(); | |
| 533 } | |
| 534 | |
|
14
0770e5cbba7c
Closes #21 - File loading in order
IBBoard <dev@ibboard.co.uk>
parents:
8
diff
changeset
|
535 return DictionaryUtils.ToArray<string, GameSystem>(systemsTable); |
| 0 | 536 } |
| 537 | |
| 538 /// <summary> | |
| 539 /// Gets a single <see cref="GameSystem"/> with a given ID. | |
| 540 /// </summary> | |
| 541 /// <param name="systemID"> | |
| 542 /// The ID of the <see cref="GameSystem"/> to get, as a <see cref="System.String"/>. | |
| 543 /// </param> | |
| 544 /// <returns> | |
| 545 /// The <see cref="GameSystem"/> with the given ID, or <code>null</code> if one doesn't exist. | |
| 546 /// </returns> | |
| 547 public GameSystem GetGameSystem(string systemID) | |
| 548 { | |
| 549 if (systemsTable==null) | |
| 550 { | |
| 551 LoadFiles(); | |
| 552 } | |
| 553 | |
| 554 GameSystem system; | |
| 555 systemsTable.TryGetValue(systemID.ToLower(), out system); | |
| 556 return system; | |
| 557 } | |
| 558 | |
| 559 /// <summary> | |
| 560 /// Gets an array of the races for the specified <see cref="GameSystem"/>. | |
| 561 /// </summary> | |
| 562 /// <param name="system"> | |
| 563 /// The <see cref="GameSystem"/> to get the available races for. | |
| 564 /// </param> | |
| 565 /// <returns> | |
| 566 /// An array of <see cref="Race"/>s for the <see cref="GameSystem"/> | |
| 567 /// </returns> | |
| 568 public Race[] GetRaces(GameSystem system) | |
| 569 { | |
| 570 return GetRaces(system.ID); | |
| 571 } | |
| 572 | |
| 573 /// <summary> | |
| 574 /// Gets an array of the races for a game system by ID. | |
| 575 /// </summary> | |
| 576 /// <param name="systemID"> | |
| 577 /// The <see cref="System.String"/> ID of the game system to get races for | |
| 578 /// </param> | |
| 579 /// <returns> | |
| 580 /// An array of <see cref="Race"/>s for the specified game system | |
| 581 /// </returns> | |
| 582 public Race[] GetRaces(string systemID) | |
| 583 { | |
| 584 if (racesTable==null) | |
| 585 { | |
| 586 LoadFiles(); | |
| 587 } | |
| 588 | |
|
8
613bc5eaac59
Re #9 - Make WarFoundry loading granular
IBBoard <dev@ibboard.co.uk>
parents:
5
diff
changeset
|
589 systemID = systemID.ToLower(); |
| 0 | 590 Dictionary<string, Dictionary<string, Race>> system; |
| 591 racesTable.TryGetValue(systemID, out system); | |
| 592 | |
| 593 if (system==null) | |
| 594 { | |
| 595 return new Race[0]; | |
| 596 } | |
| 597 | |
| 598 int count = 0; | |
| 599 | |
| 600 foreach (Dictionary<string, Race> racesDict in system.Values) | |
| 601 { | |
| 602 count+= racesDict.Count; | |
| 603 } | |
| 604 | |
| 605 Race[] races = new Race[count]; | |
| 606 int i = 0; | |
| 607 | |
| 608 foreach (string raceID in system.Keys) | |
| 609 { | |
| 610 foreach (string raceSubId in system[raceID].Keys) | |
| 611 { | |
| 612 races[i++] = GetRace(systemID, raceID, raceSubId); | |
| 613 } | |
| 614 } | |
| 615 | |
| 616 return races; | |
| 617 } | |
| 618 | |
| 619 /// <summary> | |
| 620 /// Gets a single race for a given <see cref="GameSystem"/> by ID of the race. | |
| 621 /// </summary> | |
| 622 /// <param name="system"> | |
| 623 /// The <see cref="GameSystem"/> that the race is part of. | |
| 624 /// </param> | |
| 625 /// <param name="raceID"> | |
| 626 /// A <see cref="System.String"/> ID for the race to load. | |
| 627 /// </param> | |
| 628 /// <returns> | |
| 629 /// A <see cref="Race"/> with the specified ID from the <see cref="GameSystem"/>, or <code>null</code> if one doesn't exist. | |
| 630 /// </returns> | |
| 631 public Race GetRace(GameSystem system, string raceID) | |
| 632 { | |
| 633 return GetRace(system.ID, raceID); | |
| 634 } | |
| 635 | |
| 636 /// <summary> | |
| 637 /// Gets a single race for a given game system by ID of the game system and race. | |
| 638 /// </summary> | |
| 639 /// <param name="systemID"> | |
| 640 /// The <see cref="System.String"/> ID of the game system that the race is part of. | |
| 641 /// </param> | |
| 642 /// <param name="raceID"> | |
| 643 /// The <see cref="System.String"/> ID for the race to load. | |
| 644 /// </param> | |
| 645 /// <returns> | |
| 646 /// A <see cref="Race"/> with the specified ID from the game system with the specified ID, or <code>null</code> if there is no race or game system with those IDs. | |
| 647 /// </returns> | |
| 648 public Race GetRace(string systemID, string raceID) | |
| 649 { | |
| 650 return GetRace(systemID, raceID, ""); | |
| 651 } | |
| 652 | |
| 653 /// <summary> | |
| 654 /// Gets a single race for a given <see cref="GameSystem"/> by the race's ID and sub-race ID. | |
| 655 /// </summary> | |
| 656 /// <param name="system"> | |
| 657 /// The <see cref="GameSystem"/> that the race is part of. | |
| 658 /// </param> | |
| 659 /// <param name="raceID"> | |
| 660 /// The <see cref="System.String"/> ID for the race to load. | |
| 661 /// </param> | |
| 662 /// <param name="raceSubID"> | |
| 663 /// A <see cref="System.String"/> | |
| 664 /// </param> | |
| 665 /// <returns> | |
| 666 /// A <see cref="Race"/> | |
| 667 /// </returns> | |
| 668 public Race GetRace(GameSystem system, string raceID, string raceSubID) | |
| 669 { | |
| 670 return GetRace(system.ID, raceID, raceSubID); | |
| 671 } | |
| 672 | |
| 673 /// <summary> | |
| 674 /// Gets a single race for a given game system by the game system's ID and the race's ID and sub-race ID. | |
| 675 /// </summary> | |
| 676 /// <param name="systemID"> | |
| 677 /// The <see cref="System.String"/> ID of the game system that the race is part of. | |
| 678 /// </param> | |
| 679 /// <param name="raceID"> | |
| 680 /// The <see cref="System.String"/> ID for the race to load. | |
| 681 /// </param> | |
| 682 /// <param name="raceSubID"> | |
| 683 /// A <see cref="System.String"/> | |
| 684 /// </param> | |
| 685 /// <returns> | |
| 686 /// A <see cref="Race"/> | |
| 687 /// </returns> | |
| 688 public Race GetRace(string systemID, string raceID, string raceSubID) | |
| 689 { | |
| 690 if (racesTable==null) | |
| 691 { | |
| 692 LoadFiles(); | |
| 693 } | |
| 694 | |
| 695 Race race = null; | |
| 696 | |
| 697 systemID = systemID.ToLower(); | |
| 698 | |
| 699 Dictionary<string, Dictionary<string, Race>> races; | |
| 700 racesTable.TryGetValue(systemID, out races); | |
| 701 | |
| 702 if (races!=null) | |
| 703 { | |
| 704 Dictionary<string, Race> subraces; | |
| 705 races.TryGetValue(raceID, out subraces); | |
| 706 | |
| 707 if (subraces!=null) | |
| 708 { | |
| 709 subraces.TryGetValue(raceSubID, out race); | |
| 710 } | |
| 711 } | |
| 712 | |
| 713 return race; | |
| 714 } | |
| 715 | |
| 716 /// <summary> | |
| 717 /// Gets the IDs of all of the game systems currently available. | |
| 718 /// </summary> | |
| 719 /// <returns> | |
| 720 /// An array of <see cref="System.String"/>s representing the IDs of the game systems. | |
| 721 /// </returns> | |
| 722 public string[] GetGameSystemIDs() | |
| 723 { | |
| 724 if (systemsTable==null) | |
| 725 { | |
| 726 LoadFiles(); | |
| 727 } | |
| 728 | |
| 729 string[] keys = new string[systemsTable.Keys.Count]; | |
| 730 int i = 0; | |
| 731 | |
| 732 foreach (string key in systemsTable.Keys) | |
| 733 { | |
| 734 keys[i++] = key; | |
| 735 } | |
| 736 | |
| 737 return keys; | |
| 738 } | |
| 739 | |
| 740 /// <summary> | |
| 741 /// Gets the IDs of all of the races of a specified game system. | |
| 742 /// </summary> | |
| 743 /// <param name="system"> | |
| 744 /// The <see cref="GameSystem"/> to get the available races for. | |
| 745 /// </param> | |
| 746 /// <returns> | |
| 747 /// An array of <see cref="System.String"/>s representing the IDs of the races of the specified game system. | |
| 748 /// </returns> | |
| 749 public string[] GetSystemRaceIDs(GameSystem system) | |
| 750 { | |
| 751 return GetSystemRaceIDs(system.ID); | |
| 752 } | |
| 753 | |
| 754 /// <summary> | |
| 755 /// Gets the IDs of all of the races of a specified game system. | |
| 756 /// </summary> | |
| 757 /// <param name="systemID"> | |
| 758 /// The <see cref="System.String"/> ID of the game system to get the available races for. | |
| 759 /// </param> | |
| 760 /// <returns> | |
| 761 /// An array of <see cref="System.String"/>s representing the IDs of the races of the specified game system. | |
| 762 /// </returns> | |
| 763 public string[] GetSystemRaceIDs(string systemID) | |
| 764 { | |
| 765 if (racesTable == null) | |
| 766 { | |
| 767 LoadFiles(); | |
| 768 } | |
| 769 | |
| 770 Dictionary<string, Dictionary<string, Race>> races = racesTable[systemID.ToLower()]; | |
| 771 | |
| 772 if (races==null) | |
| 773 { | |
| 774 return new string[0]; | |
| 775 } | |
| 776 else | |
| 777 { | |
| 778 string[] keys = new string[races.Keys.Count]; | |
| 779 int i = 0; | |
| 780 | |
| 781 foreach (string key in races.Keys) | |
| 782 { | |
| 783 keys[i++] = key; | |
| 784 } | |
| 785 | |
| 786 return keys; | |
| 787 } | |
| 788 } | |
| 789 } | |
| 790 } |