Mercurial > repos > IBBoard.WarFoundry.API
annotate api/Factories/AbstractNativeWarFoundryFactory.cs @ 27:e7de5c96f5c2
Re #44 - Fix API tests
* Make AbstractNative factory silently dispose of IOExceptions - test data triggers one on the SharpZipLib DLL
* Remove unused MakeZipFile method
* Rename GetGameSystemLoadingFactoryForFile to remove reference to Race
author | IBBoard <dev@ibboard.co.uk> |
---|---|
date | Sat, 14 Mar 2009 17:10:26 +0000 |
parents | 306558904c2a |
children | 3ea0ab04352b |
rev | line source |
---|---|
15 | 1 // This file (AbstractNativeWarFoundryFactory.cs) is a part of the IBBoard.WarFoundry.API project and is copyright 2009 IBBoard. |
0 | 2 // |
15 | 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.IO; | |
7 using System.Xml; | |
8 using System.Xml.Schema; | |
9 using System.Collections.Generic; | |
10 using System.Text; | |
11 using IBBoard; | |
12 using IBBoard.IO; | |
13 using IBBoard.Lang; | |
14 using IBBoard.Logging; | |
15 using IBBoard.Xml; | |
16 using IBBoard.WarFoundry.API.Objects; | |
17 using ICSharpCode.SharpZipLib.Zip; | |
18 | |
19 namespace IBBoard.WarFoundry.API.Factories | |
20 { | |
21 /// <summary> | |
22 /// Base abstract class for all factories that load native WarFoundry data. | |
23 /// </summary> | |
24 public abstract class AbstractNativeWarFoundryFactory : AbstractWarFoundryFactory<ZipFile>, INativeWarFoundryFactory | |
25 { | |
26 protected static readonly string SYSTEM_ZIP_IDENTIFIER = "WarFoundry_System"; | |
27 protected static readonly string RACE_ZIP_IDENTIFIER = "WarFoundry_Race"; | |
28 protected static readonly string ARMY_ZIP_IDENTIFIER = "WarFoundry_Army"; | |
29 | |
30 protected AbstractNativeWarFoundryFactory() | |
31 { | |
32 //Do nothing - just make the constructor non-public | |
33 } | |
8
613bc5eaac59
Re #9 - Make WarFoundry loading granular
IBBoard <dev@ibboard.co.uk>
parents:
7
diff
changeset
|
34 |
0 | 35 protected override ZipFile GetFileAsSupportedType (FileInfo file) |
36 { | |
37 ZipFile zip = null; | |
38 | |
39 try | |
40 { | |
41 zip = new ZipFile(file.FullName); | |
42 } | |
7
895c8a2378a1
Code cleanup - remove warning about unused exception
IBBoard <dev@ibboard.co.uk>
parents:
0
diff
changeset
|
43 catch(ZipException) |
0 | 44 { |
14
0770e5cbba7c
Closes #21 - File loading in order
IBBoard <dev@ibboard.co.uk>
parents:
8
diff
changeset
|
45 //Silently dispose as per spec for the method |
0 | 46 } |
27 | 47 catch (IOException) |
48 { | |
49 //Silently dispose as per spec for the method | |
50 } | |
0 | 51 |
52 return zip; | |
53 } | |
54 | |
55 protected override bool CheckCanHandleFileFormat (ZipFile file) | |
14
0770e5cbba7c
Closes #21 - File loading in order
IBBoard <dev@ibboard.co.uk>
parents:
8
diff
changeset
|
56 { |
0770e5cbba7c
Closes #21 - File loading in order
IBBoard <dev@ibboard.co.uk>
parents:
8
diff
changeset
|
57 return CheckCanHandleFileAsGameSystem(file) || CheckCanHandleFileAsRace(file) || CheckCanHandleFileAsArmy(file); |
0 | 58 } |
59 | |
14
0770e5cbba7c
Closes #21 - File loading in order
IBBoard <dev@ibboard.co.uk>
parents:
8
diff
changeset
|
60 protected override bool CheckCanHandleFileAsGameSystem(ZipFile file) |
0 | 61 { |
62 return file.ZipFileComment.StartsWith(SYSTEM_ZIP_IDENTIFIER) && CheckCanFindSystemFileContent(file); | |
63 } | |
64 | |
65 protected abstract bool CheckCanFindSystemFileContent(ZipFile file); | |
66 | |
14
0770e5cbba7c
Closes #21 - File loading in order
IBBoard <dev@ibboard.co.uk>
parents:
8
diff
changeset
|
67 protected override bool CheckCanHandleFileAsRace(ZipFile file) |
0 | 68 { |
69 return file.ZipFileComment.StartsWith(RACE_ZIP_IDENTIFIER) && CheckCanFindRaceFileContent(file); | |
70 } | |
71 | |
72 protected abstract bool CheckCanFindRaceFileContent(ZipFile file); | |
73 | |
14
0770e5cbba7c
Closes #21 - File loading in order
IBBoard <dev@ibboard.co.uk>
parents:
8
diff
changeset
|
74 protected override bool CheckCanHandleFileAsArmy(ZipFile file) |
0 | 75 { |
76 return file.ZipFileComment.StartsWith(ARMY_ZIP_IDENTIFIER) && CheckCanFindArmyFileContent(file); | |
77 } | |
78 | |
79 protected abstract bool CheckCanFindArmyFileContent(ZipFile file); | |
80 | |
81 protected override ICollection<IWarFoundryObject> DoCreateObjectsFromFile (ZipFile file) | |
82 { | |
83 ICollection<IWarFoundryObject> objects = null; | |
84 string comment = file.ZipFileComment; | |
85 IWarFoundryObject obj = null; | |
86 | |
87 if (comment.StartsWith(SYSTEM_ZIP_IDENTIFIER)) | |
88 { | |
89 obj = CreateGameSystemFromFile(file); | |
90 } | |
91 else if (comment.StartsWith(RACE_ZIP_IDENTIFIER)) | |
92 { | |
93 obj = CreateRaceFromFile(file); | |
94 } | |
95 else if (comment.StartsWith(ARMY_ZIP_IDENTIFIER)) | |
96 { | |
97 obj = CreateArmyFromFile(file); | |
98 } | |
99 | |
100 if (obj!=null) | |
101 { | |
102 objects = new List<IWarFoundryObject>(); | |
103 objects.Add(obj); | |
104 } | |
105 | |
106 return objects; | |
107 } | |
108 | |
109 protected Army CreateArmyFromFile(ZipFile file) | |
110 { | |
14
0770e5cbba7c
Closes #21 - File loading in order
IBBoard <dev@ibboard.co.uk>
parents:
8
diff
changeset
|
111 return CreateArmyFromStream(file, GetArmyDataStream(file)); |
0 | 112 } |
113 | |
114 protected abstract Stream GetArmyDataStream(ZipFile file); | |
115 protected abstract Army CreateArmyFromStream(ZipFile file, Stream dataStream); | |
116 | |
117 protected Race CreateRaceFromFile(ZipFile file) | |
118 { | |
119 try | |
120 { | |
14
0770e5cbba7c
Closes #21 - File loading in order
IBBoard <dev@ibboard.co.uk>
parents:
8
diff
changeset
|
121 return CreateRaceFromStream(file, GetRaceDataStream(file)); |
0 | 122 } |
123 catch (InvalidFileException ex) | |
124 { | |
125 throw new InvalidFileException("Data file "+file.Name+" was not a valid race file", ex); | |
126 } | |
127 } | |
128 | |
129 protected abstract Stream GetRaceDataStream(ZipFile file); | |
130 protected abstract Race CreateRaceFromStream(ZipFile file, Stream dataStream); | |
131 | |
132 protected GameSystem CreateGameSystemFromFile(ZipFile file) | |
133 { | |
14
0770e5cbba7c
Closes #21 - File loading in order
IBBoard <dev@ibboard.co.uk>
parents:
8
diff
changeset
|
134 return CreateGameSystemFromStream(file, GetGameSystemDataStream(file)); |
0 | 135 } |
136 | |
137 protected abstract Stream GetGameSystemDataStream(ZipFile file); | |
138 protected abstract GameSystem CreateGameSystemFromStream(ZipFile file, Stream dataStream); | |
139 | |
140 public override bool Equals (object o) | |
141 { | |
142 if (o == this) | |
143 { | |
144 return true; | |
145 } | |
146 else if (o == null || !(this.GetType().Equals(o.GetType()))) | |
147 { | |
148 return false; | |
149 } | |
150 | |
151 return true; | |
152 } | |
153 | |
154 public override int GetHashCode () | |
155 { | |
156 return GetType().FullName.GetHashCode(); | |
157 } | |
158 } | |
159 } |