Mercurial > repos > IBBoard.WarFoundry.API
annotate api/Factories/Xml/WarFoundryXmlFactory.cs @ 10:607c3232d689
Re #11 - Documentation
* Document Stats and SystemStats at class level to explain the difference
* Document WarFoundryXmlFactory at class level
Re #13 - XPath for XML loading
* Load categories using XPath - needs fixing so we can do a proper "categories/cat" query
Re #10 - Refactoring for readability
* Fix method signature for getting number from attribute added in r19
* Refactor more code in to GetExtraData method
* Separate out loading of categories for GameSystem
| author | IBBoard <dev@ibboard.co.uk> |
|---|---|
| date | Sun, 04 Jan 2009 20:43:36 +0000 |
| parents | 6ad505b6c36e |
| children | 5a1df00b0359 |
| rev | line source |
|---|---|
| 0 | 1 // WarFoundryXmlFactory.cs |
| 2 // | |
| 3 // Copyright (C) 2007 IBBoard | |
| 4 // | |
| 5 // This library is free software; you can redistribute it and/or | |
| 6 // modify it under the terms of the GNU Lesser General Public | |
| 7 // License version 2.1 of the License as published by the Free | |
| 8 // Software Foundation. | |
| 9 // | |
| 10 // This library is distributed in the hope that it will be useful, | |
| 11 // but WITHOUT ANY WARRANTY; without even the implied warranty of | |
| 12 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU | |
| 13 // Lesser General Public License for more details. | |
| 14 // | |
| 15 // You should have received a copy of the GNU Lesser General Public | |
| 16 // License along with this library; if not, write to the Free Software | |
| 17 // Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA | |
| 18 // | |
| 19 // | |
| 20 | |
| 21 using System; | |
| 22 using System.IO; | |
| 23 using System.Xml; | |
| 24 using System.Xml.Schema; | |
| 25 using System.Collections.Generic; | |
| 26 using System.Text; | |
| 27 using IBBoard; | |
| 28 using IBBoard.IO; | |
| 29 using IBBoard.Lang; | |
| 30 using IBBoard.Logging; | |
| 31 using IBBoard.Xml; | |
| 32 using IBBoard.WarFoundry.API.Requirements; | |
| 33 using IBBoard.WarFoundry.API.Objects; | |
| 34 using ICSharpCode.SharpZipLib.Zip; | |
| 35 | |
| 36 namespace IBBoard.WarFoundry.API.Factories.Xml | |
| 37 { | |
| 38 /// <summary> | |
| 10 | 39 /// The WarFoundryXmlFactory loads WarFoundry classes from the native "XML in a zip" file format. Files are validated using the schema for the file type, so structurally invalid files should be identified at initial load. |
| 0 | 40 /// </summary> |
| 41 public class WarFoundryXmlFactory : AbstractNativeWarFoundryFactory | |
| 42 { | |
| 43 private Dictionary<IWarFoundryObject, XmlDocument> extraData = new Dictionary<IWarFoundryObject, XmlDocument>(); | |
| 44 private XmlResolver xmlResolver; | |
| 45 | |
| 46 public static AbstractNativeWarFoundryFactory CreateFactory() | |
| 47 { | |
| 48 return new WarFoundryXmlFactory(); | |
| 49 } | |
| 50 | |
| 51 protected WarFoundryXmlFactory() : base() | |
| 52 { | |
| 53 xmlResolver = new IBBXmlResolver(Constants.ExecutablePath); | |
| 54 } | |
| 55 | |
| 56 protected override bool CheckCanFindArmyFileContent(ZipFile file) | |
| 57 { | |
| 58 return file.FindEntry("data.armyx", true) > -1; | |
| 59 } | |
| 60 | |
| 61 protected override bool CheckCanFindSystemFileContent(ZipFile file) | |
| 62 { | |
| 63 return file.FindEntry("data.systemx", true) > -1; | |
| 64 } | |
| 65 | |
| 66 protected override bool CheckCanFindRaceFileContent(ZipFile file) | |
| 67 { | |
| 68 return file.FindEntry("data.racex", true) > -1; | |
| 69 } | |
| 70 | |
| 71 protected XmlElement GetRootElementFromStream(Stream stream, WarFoundryXmlElementName elementName) | |
| 72 { | |
| 73 XmlDocument doc = CreateXmlDocumentFromStream(stream); | |
| 74 XmlElement elem = (XmlElement)doc.LastChild; | |
| 75 | |
| 76 if (!elem.Name.Equals(elementName.Value)) | |
| 77 { | |
| 78 throw new InvalidFileException(String.Format("Root element of XML was not valid. Expected {0} but got {1}", elementName.Value, elem.Name)); | |
| 79 } | |
| 80 | |
| 81 return elem; | |
| 82 } | |
| 83 | |
| 84 protected override Stream GetArmyDataStream(ZipFile file) | |
| 85 { | |
| 86 return file.GetInputStream(file.FindEntry("data.armyx", true)); | |
| 87 } | |
| 88 | |
| 89 protected override Army CreateArmyFromStream (ZipFile file, Stream dataStream) | |
| 90 { | |
| 91 XmlElement elem = GetRootElementFromStream(dataStream, WarFoundryXmlElementName.ARMY_ELEMENT); | |
| 92 return CreateArmyFromElement(file, elem); | |
| 93 } | |
| 94 | |
| 95 private Army CreateArmyFromElement(ZipFile file, XmlElement elem) | |
| 96 { | |
| 97 string name = elem.GetAttribute("name"); | |
| 98 string systemID = elem.GetAttribute("gameSystem"); | |
| 99 GameSystem system = WarFoundryLoader.GetDefault().GetGameSystem(systemID); | |
| 100 string raceID = elem.GetAttribute("race"); | |
| 101 Race race = WarFoundryLoader.GetDefault().GetRace(system, raceID); | |
| 102 string pointsString = elem.GetAttribute("maxPoints"); | |
| 103 int points = 0; | |
| 104 | |
| 105 try | |
| 106 { | |
| 107 points = int.Parse(pointsString); | |
| 108 } | |
| 109 catch(FormatException) | |
| 110 { | |
| 111 throw new FormatException("Attribute 'maxPoints' of army '"+name+"' was not a valid number"); | |
| 112 } | |
| 113 | |
| 10 | 114 Army army = new Army(race, name, points, file); |
| 0 | 115 extraData[army] = elem.OwnerDocument; |
| 116 return army; | |
| 117 } | |
| 118 | |
| 119 protected override Stream GetGameSystemDataStream (ZipFile file) | |
| 120 { | |
| 121 return file.GetInputStream(file.FindEntry("data.systemx", true)); | |
| 122 } | |
| 123 | |
| 124 protected override GameSystem CreateGameSystemFromStream (ZipFile file, Stream dataStream) | |
| 125 { | |
| 126 XmlElement elem = GetRootElementFromStream(dataStream, WarFoundryXmlElementName.SYSTEM_ELEMENT); | |
| 127 LogNotifier.Debug(GetType(), "Create GameSystem"); | |
| 128 return CreateSystemFromElement(file, elem); | |
| 129 } | |
| 130 | |
| 131 private GameSystem CreateSystemFromElement(ZipFile file, XmlElement elem) | |
| 132 { | |
| 133 string id = elem.GetAttribute("id"); | |
| 134 string name = elem.GetAttribute("name"); | |
|
8
613bc5eaac59
Re #9 - Make WarFoundry loading granular
IBBoard <dev@ibboard.co.uk>
parents:
6
diff
changeset
|
135 GameSystem system = new GameSystem(id, name, this); |
| 0 | 136 extraData[system] = elem.OwnerDocument; |
| 137 return system; | |
| 138 } | |
| 139 | |
| 140 protected override Stream GetRaceDataStream (ZipFile file) | |
| 141 { | |
| 142 return file.GetInputStream(file.FindEntry("data.racex", true)); | |
| 143 } | |
| 144 | |
| 145 protected override Race CreateRaceFromStream (ZipFile file, Stream dataStream) | |
| 146 { | |
| 147 XmlElement elem = GetRootElementFromStream(dataStream, WarFoundryXmlElementName.RACE_ELEMENT); | |
| 148 LogNotifier.Debug(GetType(), "Create Race"); | |
| 149 return CreateRaceFromElement(file, elem); | |
| 150 } | |
| 151 | |
| 152 private Race CreateRaceFromElement(ZipFile file, XmlElement elem) | |
| 153 { | |
| 154 string id = elem.GetAttribute("id"); | |
| 155 string subid = elem.GetAttribute("subid"); | |
| 156 string systemID = elem.GetAttribute("system"); | |
| 157 string name = elem.GetAttribute("name"); | |
|
8
613bc5eaac59
Re #9 - Make WarFoundry loading granular
IBBoard <dev@ibboard.co.uk>
parents:
6
diff
changeset
|
158 Race race = new Race(id, subid, name, systemID, this); |
| 0 | 159 extraData[race] = elem.OwnerDocument; |
| 160 return race; | |
|
8
613bc5eaac59
Re #9 - Make WarFoundry loading granular
IBBoard <dev@ibboard.co.uk>
parents:
6
diff
changeset
|
161 } |
| 0 | 162 |
|
8
613bc5eaac59
Re #9 - Make WarFoundry loading granular
IBBoard <dev@ibboard.co.uk>
parents:
6
diff
changeset
|
163 public override void CompleteLoading(IWarFoundryStagedLoadObject obj) |
|
613bc5eaac59
Re #9 - Make WarFoundry loading granular
IBBoard <dev@ibboard.co.uk>
parents:
6
diff
changeset
|
164 { |
|
613bc5eaac59
Re #9 - Make WarFoundry loading granular
IBBoard <dev@ibboard.co.uk>
parents:
6
diff
changeset
|
165 LogNotifier.DebugFormat(GetType(), "Complete loading of {0} with ID {1}", obj.GetType().Name, obj.ID); |
|
613bc5eaac59
Re #9 - Make WarFoundry loading granular
IBBoard <dev@ibboard.co.uk>
parents:
6
diff
changeset
|
166 |
|
613bc5eaac59
Re #9 - Make WarFoundry loading granular
IBBoard <dev@ibboard.co.uk>
parents:
6
diff
changeset
|
167 if (obj is GameSystem) |
|
613bc5eaac59
Re #9 - Make WarFoundry loading granular
IBBoard <dev@ibboard.co.uk>
parents:
6
diff
changeset
|
168 { |
|
613bc5eaac59
Re #9 - Make WarFoundry loading granular
IBBoard <dev@ibboard.co.uk>
parents:
6
diff
changeset
|
169 CompleteLoading((GameSystem)obj); |
|
613bc5eaac59
Re #9 - Make WarFoundry loading granular
IBBoard <dev@ibboard.co.uk>
parents:
6
diff
changeset
|
170 } |
|
613bc5eaac59
Re #9 - Make WarFoundry loading granular
IBBoard <dev@ibboard.co.uk>
parents:
6
diff
changeset
|
171 else if (obj is Race) |
| 0 | 172 { |
|
8
613bc5eaac59
Re #9 - Make WarFoundry loading granular
IBBoard <dev@ibboard.co.uk>
parents:
6
diff
changeset
|
173 CompleteLoading((Race)obj); |
|
613bc5eaac59
Re #9 - Make WarFoundry loading granular
IBBoard <dev@ibboard.co.uk>
parents:
6
diff
changeset
|
174 } |
|
613bc5eaac59
Re #9 - Make WarFoundry loading granular
IBBoard <dev@ibboard.co.uk>
parents:
6
diff
changeset
|
175 } |
|
613bc5eaac59
Re #9 - Make WarFoundry loading granular
IBBoard <dev@ibboard.co.uk>
parents:
6
diff
changeset
|
176 |
| 10 | 177 public XmlNode GetExtraData(IWarFoundryObject obj) |
|
8
613bc5eaac59
Re #9 - Make WarFoundry loading granular
IBBoard <dev@ibboard.co.uk>
parents:
6
diff
changeset
|
178 { |
|
613bc5eaac59
Re #9 - Make WarFoundry loading granular
IBBoard <dev@ibboard.co.uk>
parents:
6
diff
changeset
|
179 XmlDocument extra = null; |
|
613bc5eaac59
Re #9 - Make WarFoundry loading granular
IBBoard <dev@ibboard.co.uk>
parents:
6
diff
changeset
|
180 extraData.TryGetValue(obj, out extra); |
| 10 | 181 XmlNode node = null; |
| 182 | |
| 183 if (extra !=null) | |
| 184 { | |
| 185 node = extra.LastChild; | |
| 186 } | |
| 187 | |
| 188 return node; | |
|
8
613bc5eaac59
Re #9 - Make WarFoundry loading granular
IBBoard <dev@ibboard.co.uk>
parents:
6
diff
changeset
|
189 } |
|
613bc5eaac59
Re #9 - Make WarFoundry loading granular
IBBoard <dev@ibboard.co.uk>
parents:
6
diff
changeset
|
190 |
|
613bc5eaac59
Re #9 - Make WarFoundry loading granular
IBBoard <dev@ibboard.co.uk>
parents:
6
diff
changeset
|
191 public void CompleteLoading(GameSystem system) |
|
613bc5eaac59
Re #9 - Make WarFoundry loading granular
IBBoard <dev@ibboard.co.uk>
parents:
6
diff
changeset
|
192 { |
|
613bc5eaac59
Re #9 - Make WarFoundry loading granular
IBBoard <dev@ibboard.co.uk>
parents:
6
diff
changeset
|
193 if (system.IsFullyLoaded) |
|
613bc5eaac59
Re #9 - Make WarFoundry loading granular
IBBoard <dev@ibboard.co.uk>
parents:
6
diff
changeset
|
194 { |
|
613bc5eaac59
Re #9 - Make WarFoundry loading granular
IBBoard <dev@ibboard.co.uk>
parents:
6
diff
changeset
|
195 LogNotifier.DebugFormat(GetType(), "Object of type GameSystem with ID {0} is already fully loaded", system.ID); |
|
613bc5eaac59
Re #9 - Make WarFoundry loading granular
IBBoard <dev@ibboard.co.uk>
parents:
6
diff
changeset
|
196 return; |
|
613bc5eaac59
Re #9 - Make WarFoundry loading granular
IBBoard <dev@ibboard.co.uk>
parents:
6
diff
changeset
|
197 } |
|
613bc5eaac59
Re #9 - Make WarFoundry loading granular
IBBoard <dev@ibboard.co.uk>
parents:
6
diff
changeset
|
198 |
| 10 | 199 XmlNode elem = GetExtraData(system); |
|
8
613bc5eaac59
Re #9 - Make WarFoundry loading granular
IBBoard <dev@ibboard.co.uk>
parents:
6
diff
changeset
|
200 XmlNode catsElem = elem.FirstChild; |
| 10 | 201 LoadCategoriesForSystem(system, elem); |
| 202 | |
| 203 XmlElement statsElem = (XmlElement)catsElem.NextSibling; | |
| 204 LoadSystemStatsFromElement(statsElem, system); | |
| 205 string defaultStatsID = statsElem.GetAttribute("defaultStats"); | |
| 206 | |
| 207 LogNotifier.DebugFormat(GetType(), "Completed loading of GameSystem with ID {0}", system.Name); | |
| 208 system.StandardSystemStatsID = defaultStatsID; | |
| 209 system.SetAsFullyLoaded(); | |
| 210 } | |
| 211 | |
| 212 private void LoadCategoriesForSystem(GameSystem system, XmlNode elem) | |
| 213 { | |
|
8
613bc5eaac59
Re #9 - Make WarFoundry loading granular
IBBoard <dev@ibboard.co.uk>
parents:
6
diff
changeset
|
214 WarFoundryObject tempObj; |
| 10 | 215 |
| 216 foreach (XmlElement cat in elem.SelectNodes("//"+WarFoundryXmlElementName.CATEGORY_ELEMENT.Value)) | |
|
8
613bc5eaac59
Re #9 - Make WarFoundry loading granular
IBBoard <dev@ibboard.co.uk>
parents:
6
diff
changeset
|
217 { |
|
613bc5eaac59
Re #9 - Make WarFoundry loading granular
IBBoard <dev@ibboard.co.uk>
parents:
6
diff
changeset
|
218 tempObj = CreateObjectFromElement(cat); |
| 0 | 219 |
|
8
613bc5eaac59
Re #9 - Make WarFoundry loading granular
IBBoard <dev@ibboard.co.uk>
parents:
6
diff
changeset
|
220 if (tempObj is Category) |
|
613bc5eaac59
Re #9 - Make WarFoundry loading granular
IBBoard <dev@ibboard.co.uk>
parents:
6
diff
changeset
|
221 { |
|
613bc5eaac59
Re #9 - Make WarFoundry loading granular
IBBoard <dev@ibboard.co.uk>
parents:
6
diff
changeset
|
222 system.AddCategory((Category)tempObj); |
| 0 | 223 } |
| 224 else | |
| 225 { | |
|
8
613bc5eaac59
Re #9 - Make WarFoundry loading granular
IBBoard <dev@ibboard.co.uk>
parents:
6
diff
changeset
|
226 LogNotifier.WarnFormat(GetType(), "Object for string {0} was not of type Category", cat.OuterXml); |
| 0 | 227 } |
| 228 } | |
| 229 } | |
| 230 | |
|
8
613bc5eaac59
Re #9 - Make WarFoundry loading granular
IBBoard <dev@ibboard.co.uk>
parents:
6
diff
changeset
|
231 public void CompleteLoading(Race race) |
| 0 | 232 { |
|
8
613bc5eaac59
Re #9 - Make WarFoundry loading granular
IBBoard <dev@ibboard.co.uk>
parents:
6
diff
changeset
|
233 if (race.IsFullyLoaded) |
| 0 | 234 { |
|
8
613bc5eaac59
Re #9 - Make WarFoundry loading granular
IBBoard <dev@ibboard.co.uk>
parents:
6
diff
changeset
|
235 LogNotifier.DebugFormat(GetType(), "Object of type Race with ID {0} is already fully loaded", race.ID); |
|
613bc5eaac59
Re #9 - Make WarFoundry loading granular
IBBoard <dev@ibboard.co.uk>
parents:
6
diff
changeset
|
236 return; |
| 0 | 237 } |
| 238 | |
| 10 | 239 XmlNode elem = GetExtraData(race); |
|
8
613bc5eaac59
Re #9 - Make WarFoundry loading granular
IBBoard <dev@ibboard.co.uk>
parents:
6
diff
changeset
|
240 XmlNode colNode = elem.FirstChild; |
|
613bc5eaac59
Re #9 - Make WarFoundry loading granular
IBBoard <dev@ibboard.co.uk>
parents:
6
diff
changeset
|
241 |
|
613bc5eaac59
Re #9 - Make WarFoundry loading granular
IBBoard <dev@ibboard.co.uk>
parents:
6
diff
changeset
|
242 Dictionary<string, UnitType> unitTypes = new Dictionary<string, UnitType>(); |
|
613bc5eaac59
Re #9 - Make WarFoundry loading granular
IBBoard <dev@ibboard.co.uk>
parents:
6
diff
changeset
|
243 |
|
613bc5eaac59
Re #9 - Make WarFoundry loading granular
IBBoard <dev@ibboard.co.uk>
parents:
6
diff
changeset
|
244 foreach (XmlElement node in colNode.ChildNodes) |
|
613bc5eaac59
Re #9 - Make WarFoundry loading granular
IBBoard <dev@ibboard.co.uk>
parents:
6
diff
changeset
|
245 { |
|
613bc5eaac59
Re #9 - Make WarFoundry loading granular
IBBoard <dev@ibboard.co.uk>
parents:
6
diff
changeset
|
246 UnitType type = CreateUnitTypeFromElement(node, race, race.GameSystem); |
|
613bc5eaac59
Re #9 - Make WarFoundry loading granular
IBBoard <dev@ibboard.co.uk>
parents:
6
diff
changeset
|
247 unitTypes.Add(type.ID, type); |
|
613bc5eaac59
Re #9 - Make WarFoundry loading granular
IBBoard <dev@ibboard.co.uk>
parents:
6
diff
changeset
|
248 } |
|
613bc5eaac59
Re #9 - Make WarFoundry loading granular
IBBoard <dev@ibboard.co.uk>
parents:
6
diff
changeset
|
249 |
|
613bc5eaac59
Re #9 - Make WarFoundry loading granular
IBBoard <dev@ibboard.co.uk>
parents:
6
diff
changeset
|
250 colNode = colNode.NextSibling; |
|
613bc5eaac59
Re #9 - Make WarFoundry loading granular
IBBoard <dev@ibboard.co.uk>
parents:
6
diff
changeset
|
251 |
|
613bc5eaac59
Re #9 - Make WarFoundry loading granular
IBBoard <dev@ibboard.co.uk>
parents:
6
diff
changeset
|
252 if (colNode!=null && colNode.Name == WarFoundryXmlElementName.CATEGORIES_ELEMENT.Value) |
|
613bc5eaac59
Re #9 - Make WarFoundry loading granular
IBBoard <dev@ibboard.co.uk>
parents:
6
diff
changeset
|
253 { |
|
613bc5eaac59
Re #9 - Make WarFoundry loading granular
IBBoard <dev@ibboard.co.uk>
parents:
6
diff
changeset
|
254 foreach (XmlElement node in colNode.ChildNodes) |
| 0 | 255 { |
|
8
613bc5eaac59
Re #9 - Make WarFoundry loading granular
IBBoard <dev@ibboard.co.uk>
parents:
6
diff
changeset
|
256 race.AddCategory(CreateCategoryFromElement(node)); |
| 0 | 257 } |
|
8
613bc5eaac59
Re #9 - Make WarFoundry loading granular
IBBoard <dev@ibboard.co.uk>
parents:
6
diff
changeset
|
258 |
|
613bc5eaac59
Re #9 - Make WarFoundry loading granular
IBBoard <dev@ibboard.co.uk>
parents:
6
diff
changeset
|
259 colNode = colNode.NextSibling; |
|
613bc5eaac59
Re #9 - Make WarFoundry loading granular
IBBoard <dev@ibboard.co.uk>
parents:
6
diff
changeset
|
260 } |
|
613bc5eaac59
Re #9 - Make WarFoundry loading granular
IBBoard <dev@ibboard.co.uk>
parents:
6
diff
changeset
|
261 |
|
613bc5eaac59
Re #9 - Make WarFoundry loading granular
IBBoard <dev@ibboard.co.uk>
parents:
6
diff
changeset
|
262 Dictionary<string, EquipmentItem> raceEquipment = new Dictionary<string, EquipmentItem>(); |
|
613bc5eaac59
Re #9 - Make WarFoundry loading granular
IBBoard <dev@ibboard.co.uk>
parents:
6
diff
changeset
|
263 |
|
613bc5eaac59
Re #9 - Make WarFoundry loading granular
IBBoard <dev@ibboard.co.uk>
parents:
6
diff
changeset
|
264 if (colNode!=null && colNode.Name == WarFoundryXmlElementName.RACE_EQUIPMENT_ITEMS_ELEMENT.Value) |
|
613bc5eaac59
Re #9 - Make WarFoundry loading granular
IBBoard <dev@ibboard.co.uk>
parents:
6
diff
changeset
|
265 { |
|
613bc5eaac59
Re #9 - Make WarFoundry loading granular
IBBoard <dev@ibboard.co.uk>
parents:
6
diff
changeset
|
266 foreach (XmlElement node in colNode.ChildNodes) |
| 0 | 267 { |
|
8
613bc5eaac59
Re #9 - Make WarFoundry loading granular
IBBoard <dev@ibboard.co.uk>
parents:
6
diff
changeset
|
268 EquipmentItem item = CreateEquipmentItemFromElement(node, race); |
|
613bc5eaac59
Re #9 - Make WarFoundry loading granular
IBBoard <dev@ibboard.co.uk>
parents:
6
diff
changeset
|
269 raceEquipment.Add(item.ID, item); |
| 0 | 270 } |
| 271 } | |
|
8
613bc5eaac59
Re #9 - Make WarFoundry loading granular
IBBoard <dev@ibboard.co.uk>
parents:
6
diff
changeset
|
272 |
|
613bc5eaac59
Re #9 - Make WarFoundry loading granular
IBBoard <dev@ibboard.co.uk>
parents:
6
diff
changeset
|
273 Dictionary<string, Ability> raceAbilities = new Dictionary<string, Ability>(); |
|
613bc5eaac59
Re #9 - Make WarFoundry loading granular
IBBoard <dev@ibboard.co.uk>
parents:
6
diff
changeset
|
274 //TODO: Load abilities |
|
613bc5eaac59
Re #9 - Make WarFoundry loading granular
IBBoard <dev@ibboard.co.uk>
parents:
6
diff
changeset
|
275 |
|
613bc5eaac59
Re #9 - Make WarFoundry loading granular
IBBoard <dev@ibboard.co.uk>
parents:
6
diff
changeset
|
276 race.SetUnitTypes(unitTypes); |
|
613bc5eaac59
Re #9 - Make WarFoundry loading granular
IBBoard <dev@ibboard.co.uk>
parents:
6
diff
changeset
|
277 race.SetEquipmentItems(raceEquipment); |
|
613bc5eaac59
Re #9 - Make WarFoundry loading granular
IBBoard <dev@ibboard.co.uk>
parents:
6
diff
changeset
|
278 race.SetAbilities(raceAbilities); |
|
613bc5eaac59
Re #9 - Make WarFoundry loading granular
IBBoard <dev@ibboard.co.uk>
parents:
6
diff
changeset
|
279 race.SetAsFullyLoaded(); |
|
613bc5eaac59
Re #9 - Make WarFoundry loading granular
IBBoard <dev@ibboard.co.uk>
parents:
6
diff
changeset
|
280 LogNotifier.DebugFormat(GetType(), "Completed loading of Race with ID {0}", race.Name); |
| 0 | 281 } |
| 282 | |
| 283 protected XmlDocument CreateXmlDocumentFromStream(Stream stream) | |
| 284 { | |
| 285 XmlDocument doc = new XmlDocument(); | |
| 286 XmlReaderSettings settings = new XmlReaderSettings(); | |
| 287 settings.XmlResolver = xmlResolver; | |
| 288 settings.ValidationType = ValidationType.DTD; | |
| 289 settings.ProhibitDtd = false; | |
| 290 settings.ValidationEventHandler+= new ValidationEventHandler(ValidationEventMethod); | |
| 291 XmlReader reader = XmlReader.Create(stream, settings); | |
| 292 | |
| 293 try | |
| 294 { | |
| 295 doc.Load(reader); | |
| 296 } | |
| 297 //Don't catch XMLSchemaExceptions - let them get thrown out | |
| 298 finally | |
| 299 { | |
| 300 reader.Close(); | |
| 301 } | |
| 302 | |
| 303 if (doc.ChildNodes.Count!=3) | |
| 304 { | |
| 305 throw new InvalidFileException(Translation.GetTranslation("ErrorInvalidXmlFile", "XML file was not a valid XML file. It should contain three child nodes - XML definition, DocType and root node.")); | |
| 306 } | |
| 307 | |
| 308 return doc; | |
| 309 } | |
| 310 | |
| 311 protected XmlDocument CreateXmlDocumentFromString(string xmlString) | |
| 312 { | |
| 313 XmlReaderSettings settings = new XmlReaderSettings(); | |
| 314 settings.XmlResolver = xmlResolver; | |
| 315 settings.ValidationType = ValidationType.DTD; | |
| 316 settings.ProhibitDtd = false; | |
| 317 settings.ValidationEventHandler+= new ValidationEventHandler(ValidationEventMethod); | |
| 318 XmlReader reader = XmlReader.Create(new MemoryStream(Encoding.UTF8.GetBytes(xmlString)), settings); | |
| 319 XmlDocument doc = new XmlDocument(); | |
| 320 | |
| 321 try | |
| 322 { | |
| 323 doc.Load(reader); | |
| 324 } | |
| 325 catch(XmlSchemaException ex) | |
| 326 { | |
| 327 throw new InvalidFileException(Translation.GetTranslation("ErrorInvalidXmlString", "Failed to parse invalid XML string"), ex); | |
| 328 } | |
| 329 finally | |
| 330 { | |
| 331 //We might not need to make sure the memory stream is closed, but do it just in case | |
| 332 reader.Close(); | |
| 333 } | |
| 334 | |
| 335 if (doc.ChildNodes.Count!=3) | |
| 336 { | |
| 337 throw new InvalidFileException(String.Format(Translation.GetTranslation("ErrorInvalidXmlFile", "XML string was not a valid XML file. It should contain three child nodes - XML definition, DocType and root node."))); | |
| 338 } | |
| 339 | |
| 340 return doc; | |
| 341 } | |
| 342 | |
| 343 private WarFoundryObject CreateObjectFromElement(XmlElement elem) | |
| 344 { | |
| 345 WarFoundryObject obj = null; | |
| 346 LogNotifier.DebugFormat(GetType(), "Create object for <{0}>", elem.Name); | |
| 347 | |
| 348 if (elem.Name.Equals(WarFoundryXmlElementName.CATEGORY_ELEMENT.Value)) | |
| 349 { | |
| 350 LogNotifier.Debug(GetType(), "Create Category"); | |
| 351 obj = CreateCategoryFromElement(elem); | |
| 352 } | |
| 353 else | |
| 354 { | |
| 355 LogNotifier.Debug(GetType(), "No match"); | |
| 356 } | |
| 357 | |
| 358 return obj; | |
| 359 } | |
| 360 | |
| 361 private Category CreateCategoryFromElement(XmlElement elem) | |
| 362 { | |
| 363 string id = elem.GetAttribute("id"); | |
| 364 string name = elem.GetAttribute("name"); | |
|
9
6ad505b6c36e
Re #10 - Refactor for readability
IBBoard <dev@ibboard.co.uk>
parents:
8
diff
changeset
|
365 int minPc, maxPc, minPts, maxPts, minChoices, maxChoices, baseValue, incValue, incAmount; |
|
6ad505b6c36e
Re #10 - Refactor for readability
IBBoard <dev@ibboard.co.uk>
parents:
8
diff
changeset
|
366 minPc = GetIntValueFromAttribute(elem, "minPercentage"); |
|
6ad505b6c36e
Re #10 - Refactor for readability
IBBoard <dev@ibboard.co.uk>
parents:
8
diff
changeset
|
367 maxPc = GetIntValueFromAttribute(elem, "maxPercentage"); |
|
6ad505b6c36e
Re #10 - Refactor for readability
IBBoard <dev@ibboard.co.uk>
parents:
8
diff
changeset
|
368 minPts = GetIntValueFromAttribute(elem, "minPoints"); |
|
6ad505b6c36e
Re #10 - Refactor for readability
IBBoard <dev@ibboard.co.uk>
parents:
8
diff
changeset
|
369 maxPts = GetIntValueFromAttribute(elem, "maxPoints"); |
|
6ad505b6c36e
Re #10 - Refactor for readability
IBBoard <dev@ibboard.co.uk>
parents:
8
diff
changeset
|
370 minChoices = GetIntValueFromAttribute(elem, "minChoices"); |
|
6ad505b6c36e
Re #10 - Refactor for readability
IBBoard <dev@ibboard.co.uk>
parents:
8
diff
changeset
|
371 maxChoices = GetIntValueFromAttribute(elem, "maxChoices"); |
|
6ad505b6c36e
Re #10 - Refactor for readability
IBBoard <dev@ibboard.co.uk>
parents:
8
diff
changeset
|
372 baseValue = GetIntValueFromAttribute(elem, "baseValue"); |
|
6ad505b6c36e
Re #10 - Refactor for readability
IBBoard <dev@ibboard.co.uk>
parents:
8
diff
changeset
|
373 incValue = GetIntValueFromAttribute(elem, "incValue"); |
|
6ad505b6c36e
Re #10 - Refactor for readability
IBBoard <dev@ibboard.co.uk>
parents:
8
diff
changeset
|
374 incAmount = GetIntValueFromAttribute(elem, "incAmount"); |
|
6ad505b6c36e
Re #10 - Refactor for readability
IBBoard <dev@ibboard.co.uk>
parents:
8
diff
changeset
|
375 |
|
6ad505b6c36e
Re #10 - Refactor for readability
IBBoard <dev@ibboard.co.uk>
parents:
8
diff
changeset
|
376 return new Category(id, name, minPts, maxPts, minPc, maxPc, minChoices, maxChoices, baseValue, incValue, incAmount); |
|
6ad505b6c36e
Re #10 - Refactor for readability
IBBoard <dev@ibboard.co.uk>
parents:
8
diff
changeset
|
377 } |
|
6ad505b6c36e
Re #10 - Refactor for readability
IBBoard <dev@ibboard.co.uk>
parents:
8
diff
changeset
|
378 |
| 10 | 379 private int GetIntValueFromAttribute(XmlElement elem, string attributeName) |
|
9
6ad505b6c36e
Re #10 - Refactor for readability
IBBoard <dev@ibboard.co.uk>
parents:
8
diff
changeset
|
380 { |
| 0 | 381 try |
| 382 { | |
|
9
6ad505b6c36e
Re #10 - Refactor for readability
IBBoard <dev@ibboard.co.uk>
parents:
8
diff
changeset
|
383 return int.Parse(elem.GetAttribute(attributeName)); |
| 0 | 384 } |
| 385 catch(FormatException) | |
| 386 { | |
|
9
6ad505b6c36e
Re #10 - Refactor for readability
IBBoard <dev@ibboard.co.uk>
parents:
8
diff
changeset
|
387 throw new FormatException(String.Format("Attribute '{0}' of {1} with ID {2} was not a valid number", attributeName, elem.Name, elem.GetAttribute("id"))); |
| 0 | 388 } |
| 389 } | |
| 390 | |
| 391 private UnitType CreateUnitTypeFromElement(XmlElement elem, Race parentRace, GameSystem system) | |
| 392 { | |
| 393 string id = elem.GetAttribute("id"); | |
| 394 string name = elem.GetAttribute("typeName"); | |
| 395 string mainCatID = elem.GetAttribute("cat"); | |
| 396 int minNum, maxNum, minSize, maxSize, baseSize;//TODO: Add base size | |
| 397 float points, unitPoints; | |
| 398 Stats stats; | |
| 399 List<UnitRequirement> unitRequirements = new List<UnitRequirement>(); | |
| 400 bool found = false; | |
| 401 List<string> catIDs = new List<string>(); | |
| 402 string catID; | |
|
9
6ad505b6c36e
Re #10 - Refactor for readability
IBBoard <dev@ibboard.co.uk>
parents:
8
diff
changeset
|
403 minNum = GetIntValueFromAttribute(elem, "minNum"); |
|
6ad505b6c36e
Re #10 - Refactor for readability
IBBoard <dev@ibboard.co.uk>
parents:
8
diff
changeset
|
404 maxNum = GetIntValueFromAttribute(elem, "maxNum"); |
|
6ad505b6c36e
Re #10 - Refactor for readability
IBBoard <dev@ibboard.co.uk>
parents:
8
diff
changeset
|
405 minSize = GetIntValueFromAttribute(elem, "minSize"); |
|
6ad505b6c36e
Re #10 - Refactor for readability
IBBoard <dev@ibboard.co.uk>
parents:
8
diff
changeset
|
406 maxSize = GetIntValueFromAttribute(elem, "maxSize"); |
| 0 | 407 |
| 408 if (minSize > maxSize && maxSize!=-1) | |
| 409 { | |
| 410 minSize = maxSize; | |
| 411 } | |
| 412 | |
|
9
6ad505b6c36e
Re #10 - Refactor for readability
IBBoard <dev@ibboard.co.uk>
parents:
8
diff
changeset
|
413 points = GetIntValueFromAttribute(elem, "points"); |
|
6ad505b6c36e
Re #10 - Refactor for readability
IBBoard <dev@ibboard.co.uk>
parents:
8
diff
changeset
|
414 unitPoints = GetIntValueFromAttribute(elem, "unitPoints"); |
| 0 | 415 |
| 416 XmlNode node = elem.FirstChild; | |
| 417 | |
| 418 foreach(XmlElement cat in node.ChildNodes) | |
| 419 { | |
| 420 catID = cat.GetAttribute("catID"); | |
| 421 catIDs.Add(catID); | |
| 422 | |
| 423 if (catID == mainCatID) | |
| 424 { | |
| 425 found = true; | |
| 426 } | |
| 427 } | |
| 428 | |
| 429 if (!found) | |
| 430 { | |
| 431 throw new InvalidFileException("The main cat "+mainCatID+" was not found in the list of categories for unit "+id); | |
| 432 } | |
| 433 | |
| 434 node = node.NextSibling; | |
| 435 stats = ParseUnitStats((XmlElement)node, system); | |
| 436 //TODO: Add unit requirements | |
| 437 UnitType type = new UnitType(id, name, mainCatID, catIDs.ToArray(), minNum, maxNum, minSize, maxSize, unitPoints, points, stats, unitRequirements.ToArray(), parentRace); | |
| 438 | |
| 439 return type; | |
| 440 } | |
| 441 | |
| 442 private Stats ParseUnitStats(XmlElement elem, GameSystem system) | |
| 443 { | |
| 444 List<Stat> statsList = new List<Stat>(); | |
| 445 String statsID = elem.GetAttribute("statSet"); | |
| 446 SystemStats statsSet; | |
| 447 | |
| 448 if (statsID == "") | |
| 449 { | |
| 450 statsSet = system.StandardSystemStats; | |
| 451 } | |
| 452 else | |
| 453 { | |
| 6 | 454 statsSet = system.GetSystemStatsForID(statsID); |
| 0 | 455 } |
| 456 | |
| 457 Stats stats = new Stats(statsSet); | |
| 458 | |
| 459 foreach (XmlElement stat in elem.ChildNodes) | |
| 460 { | |
| 461 String statID = stat.GetAttribute("name"); | |
| 462 StatSlot slot = statsSet[statID]; | |
| 463 | |
| 464 if (slot!=null) | |
| 465 { | |
| 466 statsList.Add(new Stat(slot, stat.InnerText)); | |
| 467 } | |
| 468 else | |
| 469 { | |
| 470 throw new InvalidFileException("The stat "+statID+" was not found in stats set "+statsID); | |
| 471 } | |
| 472 } | |
| 473 | |
| 474 stats.SetStats(statsList); | |
| 475 | |
| 476 return stats; | |
| 477 } | |
| 478 | |
| 6 | 479 private void LoadSystemStatsFromElement(XmlElement elem, GameSystem system) |
| 0 | 480 { |
| 481 foreach (XmlElement stats in elem.ChildNodes) | |
| 482 { | |
| 483 SystemStats sysStats = CreateSystemStatsFromElement(stats); | |
| 6 | 484 system.AddSystemStats(sysStats); |
| 0 | 485 } |
| 486 } | |
| 487 | |
| 488 private SystemStats CreateSystemStatsFromElement(XmlElement elem) | |
| 489 { | |
| 490 List<StatSlot> slots = new List<StatSlot>(); | |
| 491 string id = elem.GetAttribute("id"); | |
| 492 | |
| 493 foreach (XmlElement slot in elem.ChildNodes) | |
| 494 { | |
| 495 StatSlot statSlot = new StatSlot(slot.GetAttribute("name")); | |
| 496 slots.Add(statSlot); | |
| 497 } | |
| 498 | |
| 499 return new SystemStats(id, slots.ToArray()); | |
| 500 } | |
| 501 | |
| 502 private EquipmentItem CreateEquipmentItemFromElement(XmlElement elem, Race race) | |
| 503 { | |
| 504 string id = elem.GetAttribute("id"); | |
| 505 string name = elem.GetAttribute("name"); | |
| 506 float cost = 0, min = 0, max = 0; | |
| 507 ArmourType armourType; | |
| 508 | |
| 509 try | |
| 510 { | |
| 511 cost = float.Parse(elem.GetAttribute("cost")); | |
| 512 } | |
| 513 catch(FormatException) | |
| 514 { | |
| 515 throw new FormatException("Attribute 'cost' of equipment item "+id+" was not a valid number"); | |
| 516 } | |
| 517 | |
| 518 try | |
| 519 { | |
| 520 min = float.Parse(elem.GetAttribute("min")); | |
| 521 } | |
| 522 catch(FormatException) | |
| 523 { | |
| 524 throw new FormatException("Attribute 'min' of equipment item "+id+" was not a valid number"); | |
| 525 } | |
| 526 | |
| 527 try | |
| 528 { | |
| 529 max = float.Parse(elem.GetAttribute("max")); | |
| 530 } | |
| 531 catch(FormatException) | |
| 532 { | |
| 533 throw new FormatException("Attribute 'max' of equipment item "+id+" was not a valid number"); | |
| 534 } | |
| 535 | |
| 536 try | |
| 537 { | |
| 538 armourType = (ArmourType)Enum.Parse(typeof(ArmourType), elem.GetAttribute("armourType")); | |
| 539 } | |
| 540 catch(FormatException) | |
| 541 { | |
| 542 throw new InvalidFileException("Attribute 'armourType' of equipment "+id+" was not a valid value from the enumeration"); | |
| 543 } | |
| 544 | |
| 545 if (elem.ChildNodes.Count>0) | |
| 546 { | |
| 547 //It has stats! | |
| 548 //TODO: Parse equipment stats | |
| 549 } | |
| 550 | |
| 551 return new EquipmentItem(id, name, cost, min, max, armourType, race); | |
| 552 } | |
| 553 | |
| 554 private void ValidationEventMethod(object sender, ValidationEventArgs e) | |
| 555 { | |
| 556 //TODO: Fire a validation failure event | |
| 557 LogNotifier.WarnFormat(GetType(), "Validation Error: {0}", e.Message); | |
| 558 } | |
| 559 } | |
| 560 } |