annotate RollcallRaceParser.cs @ 10:395f2bf0549e

Re #17 - Complete core Rollcall loading * Resolve warning about deprecated constructor
author IBBoard <dev@ibboard.co.uk>
date Thu, 09 Apr 2009 15:25:31 +0000
parents 35bc86f8c283
children 9d0d40324494
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
6
0509ed2e686a Re #16 - File loading
IBBoard <dev@ibboard.co.uk>
parents:
diff changeset
1 // This file (RollcallRaceParser.cs) is a part of IBBoard.WarFoundry.Plugin.Rollcall library and is copyright 2009 IBBoard.
0509ed2e686a Re #16 - File loading
IBBoard <dev@ibboard.co.uk>
parents:
diff changeset
2 //
0509ed2e686a Re #16 - File loading
IBBoard <dev@ibboard.co.uk>
parents:
diff changeset
3 // The file and the library/program it is in are licensed under the GNU LGPL license. Please see COPYING.LGPL for more information and the full license.
0509ed2e686a Re #16 - File loading
IBBoard <dev@ibboard.co.uk>
parents:
diff changeset
4
0509ed2e686a Re #16 - File loading
IBBoard <dev@ibboard.co.uk>
parents:
diff changeset
5 using System;
0509ed2e686a Re #16 - File loading
IBBoard <dev@ibboard.co.uk>
parents:
diff changeset
6 using IBBoard.CustomMath;
0509ed2e686a Re #16 - File loading
IBBoard <dev@ibboard.co.uk>
parents:
diff changeset
7 using IBBoard.Ini;
8
35bc86f8c283 Re #17 - Load unit data
IBBoard <dev@ibboard.co.uk>
parents: 6
diff changeset
8 using IBBoard.IO;
6
0509ed2e686a Re #16 - File loading
IBBoard <dev@ibboard.co.uk>
parents:
diff changeset
9 using IBBoard.Logging;
0509ed2e686a Re #16 - File loading
IBBoard <dev@ibboard.co.uk>
parents:
diff changeset
10 using IBBoard.WarFoundry.API.Objects;
0509ed2e686a Re #16 - File loading
IBBoard <dev@ibboard.co.uk>
parents:
diff changeset
11
0509ed2e686a Re #16 - File loading
IBBoard <dev@ibboard.co.uk>
parents:
diff changeset
12 namespace IBBoard.WarFoundry.Plugin.Rollcall
0509ed2e686a Re #16 - File loading
IBBoard <dev@ibboard.co.uk>
parents:
diff changeset
13 {
0509ed2e686a Re #16 - File loading
IBBoard <dev@ibboard.co.uk>
parents:
diff changeset
14 /// <summary>
0509ed2e686a Re #16 - File loading
IBBoard <dev@ibboard.co.uk>
parents:
diff changeset
15 /// A helper class to construct a base Race object from an INI file
0509ed2e686a Re #16 - File loading
IBBoard <dev@ibboard.co.uk>
parents:
diff changeset
16 /// </summary>
0509ed2e686a Re #16 - File loading
IBBoard <dev@ibboard.co.uk>
parents:
diff changeset
17 public class RollcallRaceParser
0509ed2e686a Re #16 - File loading
IBBoard <dev@ibboard.co.uk>
parents:
diff changeset
18 {
0509ed2e686a Re #16 - File loading
IBBoard <dev@ibboard.co.uk>
parents:
diff changeset
19 public static Race ReadRaceDetails(IniFile file)
0509ed2e686a Re #16 - File loading
IBBoard <dev@ibboard.co.uk>
parents:
diff changeset
20 {
0509ed2e686a Re #16 - File loading
IBBoard <dev@ibboard.co.uk>
parents:
diff changeset
21 string id = null, name = null;
8
35bc86f8c283 Re #17 - Load unit data
IBBoard <dev@ibboard.co.uk>
parents: 6
diff changeset
22 id = file.GetSectionLineValue("Army", "BitCodeID");
35bc86f8c283 Re #17 - Load unit data
IBBoard <dev@ibboard.co.uk>
parents: 6
diff changeset
23
35bc86f8c283 Re #17 - Load unit data
IBBoard <dev@ibboard.co.uk>
parents: 6
diff changeset
24 if (id == null)
35bc86f8c283 Re #17 - Load unit data
IBBoard <dev@ibboard.co.uk>
parents: 6
diff changeset
25 {
35bc86f8c283 Re #17 - Load unit data
IBBoard <dev@ibboard.co.uk>
parents: 6
diff changeset
26 throw new InvalidFileException("BitCodeID field of Rollcall race did not exist");
35bc86f8c283 Re #17 - Load unit data
IBBoard <dev@ibboard.co.uk>
parents: 6
diff changeset
27 }
35bc86f8c283 Re #17 - Load unit data
IBBoard <dev@ibboard.co.uk>
parents: 6
diff changeset
28
35bc86f8c283 Re #17 - Load unit data
IBBoard <dev@ibboard.co.uk>
parents: 6
diff changeset
29 id = "Rollcall" + id;
35bc86f8c283 Re #17 - Load unit data
IBBoard <dev@ibboard.co.uk>
parents: 6
diff changeset
30 name = file.GetSectionLineValue("Army", "Name");
35bc86f8c283 Re #17 - Load unit data
IBBoard <dev@ibboard.co.uk>
parents: 6
diff changeset
31
35bc86f8c283 Re #17 - Load unit data
IBBoard <dev@ibboard.co.uk>
parents: 6
diff changeset
32 if (name == null)
35bc86f8c283 Re #17 - Load unit data
IBBoard <dev@ibboard.co.uk>
parents: 6
diff changeset
33 {
35bc86f8c283 Re #17 - Load unit data
IBBoard <dev@ibboard.co.uk>
parents: 6
diff changeset
34 throw new InvalidFileException("Name field of Rollcall race did not exist");
35bc86f8c283 Re #17 - Load unit data
IBBoard <dev@ibboard.co.uk>
parents: 6
diff changeset
35 }
35bc86f8c283 Re #17 - Load unit data
IBBoard <dev@ibboard.co.uk>
parents: 6
diff changeset
36
6
0509ed2e686a Re #16 - File loading
IBBoard <dev@ibboard.co.uk>
parents:
diff changeset
37 LogNotifier.Debug(typeof(RollcallRaceParser), "Loading Rollcall race ID "+id);
10
395f2bf0549e Re #17 - Complete core Rollcall loading
IBBoard <dev@ibboard.co.uk>
parents: 8
diff changeset
38 Race race = new Race(id, name, RollcallFactory.GetFactory().RollcallSystem, RollcallFactory.GetFactory());
6
0509ed2e686a Re #16 - File loading
IBBoard <dev@ibboard.co.uk>
parents:
diff changeset
39 race.GameSystem = RollcallFactory.GetFactory().RollcallSystem;
0509ed2e686a Re #16 - File loading
IBBoard <dev@ibboard.co.uk>
parents:
diff changeset
40 return race;
0509ed2e686a Re #16 - File loading
IBBoard <dev@ibboard.co.uk>
parents:
diff changeset
41 }
0509ed2e686a Re #16 - File loading
IBBoard <dev@ibboard.co.uk>
parents:
diff changeset
42
0509ed2e686a Re #16 - File loading
IBBoard <dev@ibboard.co.uk>
parents:
diff changeset
43 public static void ReadCategories(IniFile file, Race race)
0509ed2e686a Re #16 - File loading
IBBoard <dev@ibboard.co.uk>
parents:
diff changeset
44 {
8
35bc86f8c283 Re #17 - Load unit data
IBBoard <dev@ibboard.co.uk>
parents: 6
diff changeset
45 ReadCategories(file["Category"], race);
35bc86f8c283 Re #17 - Load unit data
IBBoard <dev@ibboard.co.uk>
parents: 6
diff changeset
46 }
35bc86f8c283 Re #17 - Load unit data
IBBoard <dev@ibboard.co.uk>
parents: 6
diff changeset
47
35bc86f8c283 Re #17 - Load unit data
IBBoard <dev@ibboard.co.uk>
parents: 6
diff changeset
48 private static void ReadCategories(IniSection categorySection, Race race)
35bc86f8c283 Re #17 - Load unit data
IBBoard <dev@ibboard.co.uk>
parents: 6
diff changeset
49 {
35bc86f8c283 Re #17 - Load unit data
IBBoard <dev@ibboard.co.uk>
parents: 6
diff changeset
50 foreach (string key in categorySection.Keys)
6
0509ed2e686a Re #16 - File loading
IBBoard <dev@ibboard.co.uk>
parents:
diff changeset
51 {
8
35bc86f8c283 Re #17 - Load unit data
IBBoard <dev@ibboard.co.uk>
parents: 6
diff changeset
52 string valueString = categorySection.GetLineValue(key);
6
0509ed2e686a Re #16 - File loading
IBBoard <dev@ibboard.co.uk>
parents:
diff changeset
53 string[] values = valueString.Split(',');
0509ed2e686a Re #16 - File loading
IBBoard <dev@ibboard.co.uk>
parents:
diff changeset
54
0509ed2e686a Re #16 - File loading
IBBoard <dev@ibboard.co.uk>
parents:
diff changeset
55 if (values.Length == 3)
0509ed2e686a Re #16 - File loading
IBBoard <dev@ibboard.co.uk>
parents:
diff changeset
56 {
0509ed2e686a Re #16 - File loading
IBBoard <dev@ibboard.co.uk>
parents:
diff changeset
57 LogNotifier.Debug(typeof(RollcallRaceParser), "Loading category " + values[0]);
0509ed2e686a Re #16 - File loading
IBBoard <dev@ibboard.co.uk>
parents:
diff changeset
58 Category category = new Category(key, values[0]);
0509ed2e686a Re #16 - File loading
IBBoard <dev@ibboard.co.uk>
parents:
diff changeset
59 int minPercent = NumberParser.ParseAsInt(values[1], 0);
0509ed2e686a Re #16 - File loading
IBBoard <dev@ibboard.co.uk>
parents:
diff changeset
60 int maxPercent = NumberParser.ParseAsInt(values[2], 100);
0509ed2e686a Re #16 - File loading
IBBoard <dev@ibboard.co.uk>
parents:
diff changeset
61 maxPercent = Math.Max(0, Math.Min(100, Math.Max(minPercent, maxPercent)));
0509ed2e686a Re #16 - File loading
IBBoard <dev@ibboard.co.uk>
parents:
diff changeset
62 minPercent = Math.Max(0, Math.Min(100, minPercent));
0509ed2e686a Re #16 - File loading
IBBoard <dev@ibboard.co.uk>
parents:
diff changeset
63 category.MaximumPercentage = maxPercent;
0509ed2e686a Re #16 - File loading
IBBoard <dev@ibboard.co.uk>
parents:
diff changeset
64 category.MinimumPercentage = minPercent;
0509ed2e686a Re #16 - File loading
IBBoard <dev@ibboard.co.uk>
parents:
diff changeset
65 race.AddCategory(category);
0509ed2e686a Re #16 - File loading
IBBoard <dev@ibboard.co.uk>
parents:
diff changeset
66
0509ed2e686a Re #16 - File loading
IBBoard <dev@ibboard.co.uk>
parents:
diff changeset
67 }
8
35bc86f8c283 Re #17 - Load unit data
IBBoard <dev@ibboard.co.uk>
parents: 6
diff changeset
68 else
35bc86f8c283 Re #17 - Load unit data
IBBoard <dev@ibboard.co.uk>
parents: 6
diff changeset
69 {
35bc86f8c283 Re #17 - Load unit data
IBBoard <dev@ibboard.co.uk>
parents: 6
diff changeset
70 LogNotifier.Warn(typeof(RollcallRaceParser), "Ignored non-standard category: "+key);
35bc86f8c283 Re #17 - Load unit data
IBBoard <dev@ibboard.co.uk>
parents: 6
diff changeset
71 }
6
0509ed2e686a Re #16 - File loading
IBBoard <dev@ibboard.co.uk>
parents:
diff changeset
72 //Special cases (allies and aliases) need to be handled later
0509ed2e686a Re #16 - File loading
IBBoard <dev@ibboard.co.uk>
parents:
diff changeset
73 }
0509ed2e686a Re #16 - File loading
IBBoard <dev@ibboard.co.uk>
parents:
diff changeset
74 }
0509ed2e686a Re #16 - File loading
IBBoard <dev@ibboard.co.uk>
parents:
diff changeset
75
0509ed2e686a Re #16 - File loading
IBBoard <dev@ibboard.co.uk>
parents:
diff changeset
76 public static void ReadUnitTypeAndEquipmentSections(IniFile file, Race race)
0509ed2e686a Re #16 - File loading
IBBoard <dev@ibboard.co.uk>
parents:
diff changeset
77 {
0509ed2e686a Re #16 - File loading
IBBoard <dev@ibboard.co.uk>
parents:
diff changeset
78 foreach (IniSection section in file)
0509ed2e686a Re #16 - File loading
IBBoard <dev@ibboard.co.uk>
parents:
diff changeset
79 {
8
35bc86f8c283 Re #17 - Load unit data
IBBoard <dev@ibboard.co.uk>
parents: 6
diff changeset
80 try
6
0509ed2e686a Re #16 - File loading
IBBoard <dev@ibboard.co.uk>
parents:
diff changeset
81 {
8
35bc86f8c283 Re #17 - Load unit data
IBBoard <dev@ibboard.co.uk>
parents: 6
diff changeset
82 string sectionName = section.Name;
35bc86f8c283 Re #17 - Load unit data
IBBoard <dev@ibboard.co.uk>
parents: 6
diff changeset
83
35bc86f8c283 Re #17 - Load unit data
IBBoard <dev@ibboard.co.uk>
parents: 6
diff changeset
84 if (sectionName == "Army" || sectionName == "Category")
35bc86f8c283 Re #17 - Load unit data
IBBoard <dev@ibboard.co.uk>
parents: 6
diff changeset
85 {
35bc86f8c283 Re #17 - Load unit data
IBBoard <dev@ibboard.co.uk>
parents: 6
diff changeset
86 continue;
35bc86f8c283 Re #17 - Load unit data
IBBoard <dev@ibboard.co.uk>
parents: 6
diff changeset
87 }
35bc86f8c283 Re #17 - Load unit data
IBBoard <dev@ibboard.co.uk>
parents: 6
diff changeset
88 else if (sectionName.StartsWith("Unit"))
35bc86f8c283 Re #17 - Load unit data
IBBoard <dev@ibboard.co.uk>
parents: 6
diff changeset
89 {
35bc86f8c283 Re #17 - Load unit data
IBBoard <dev@ibboard.co.uk>
parents: 6
diff changeset
90 RollcallUnitTypeParser.ReadUnitTypeSection(file, section, race);
35bc86f8c283 Re #17 - Load unit data
IBBoard <dev@ibboard.co.uk>
parents: 6
diff changeset
91 }
35bc86f8c283 Re #17 - Load unit data
IBBoard <dev@ibboard.co.uk>
parents: 6
diff changeset
92 else
35bc86f8c283 Re #17 - Load unit data
IBBoard <dev@ibboard.co.uk>
parents: 6
diff changeset
93 {
35bc86f8c283 Re #17 - Load unit data
IBBoard <dev@ibboard.co.uk>
parents: 6
diff changeset
94 RollcallUnitTypeParser.ReadEquipmentSection(file, section, race);
35bc86f8c283 Re #17 - Load unit data
IBBoard <dev@ibboard.co.uk>
parents: 6
diff changeset
95 }
6
0509ed2e686a Re #16 - File loading
IBBoard <dev@ibboard.co.uk>
parents:
diff changeset
96 }
8
35bc86f8c283 Re #17 - Load unit data
IBBoard <dev@ibboard.co.uk>
parents: 6
diff changeset
97 catch (InvalidFileException ex)
6
0509ed2e686a Re #16 - File loading
IBBoard <dev@ibboard.co.uk>
parents:
diff changeset
98 {
8
35bc86f8c283 Re #17 - Load unit data
IBBoard <dev@ibboard.co.uk>
parents: 6
diff changeset
99 throw new InvalidFileException("Invalid file exception while loading data", ex);
6
0509ed2e686a Re #16 - File loading
IBBoard <dev@ibboard.co.uk>
parents:
diff changeset
100 }
0509ed2e686a Re #16 - File loading
IBBoard <dev@ibboard.co.uk>
parents:
diff changeset
101 }
0509ed2e686a Re #16 - File loading
IBBoard <dev@ibboard.co.uk>
parents:
diff changeset
102 }
0509ed2e686a Re #16 - File loading
IBBoard <dev@ibboard.co.uk>
parents:
diff changeset
103 }
0509ed2e686a Re #16 - File loading
IBBoard <dev@ibboard.co.uk>
parents:
diff changeset
104 }