0
|
1 /**
|
|
2 * Copyright: Copyright (c) 2010 Jacob Carlborg.
|
|
3 * Authors: Jacob Carlborg
|
|
4 * Version: Initial created: Jan 26, 2010
|
|
5 * License: $(LINK2 http://www.boost.org/LICENSE_1_0.txt, Boost Software License 1.0)
|
|
6 */
|
|
7 module orange.serialization.Serializer;
|
|
8
|
|
9 version (Tango)
|
|
10 {
|
|
11 import tango.util.Convert : to, ConversionException;
|
|
12 }
|
|
13
|
|
14 import orange.serialization._;
|
|
15 import orange.serialization.archives._;
|
|
16 import orange.util._;
|
|
17
|
|
18 private
|
|
19 {
|
|
20 alias orange.util.CTFE.contains ctfeContains;
|
|
21
|
|
22 private enum Mode
|
|
23 {
|
|
24 serializing,
|
|
25 deserializing
|
|
26 }
|
|
27
|
|
28 alias Mode.serializing serializing;
|
|
29 alias Mode.deserializing deserializing;
|
|
30 }
|
|
31
|
|
32 class Serializer (ArchiveType : IArchive)
|
|
33 {
|
|
34 static assert(isArchive!(ArchiveType), format!(`The type "`, ArchiveType, `" does not implement the necessary methods to be an archive.`));
|
|
35
|
|
36 private
|
|
37 {
|
|
38 ArchiveType archive;
|
|
39 alias ArchiveType.DataType DataType;
|
|
40
|
|
41 RegisterBase[string] serializers;
|
|
42 RegisterBase[string] deserializers;
|
|
43
|
|
44 size_t keyCounter;
|
|
45
|
|
46 bool hasBegunSerializing;
|
|
47 bool hasBegunDeserializing;
|
|
48 }
|
|
49
|
|
50 this ()
|
|
51 {
|
|
52 archive = new ArchiveType;
|
|
53 }
|
|
54
|
|
55 void registerSerializer (T) (string type, void delegate (T, Serializer, DataType) dg)
|
|
56 {
|
|
57 serializers[type] = toSerializeRegisterWrapper(dg);
|
|
58 }
|
|
59
|
|
60 void registerSerializer (T) (string type, void function (T, Serializer, DataType) func)
|
|
61 {
|
|
62 serializers[type] = toSerializeRegisterWrapper(func);
|
|
63 }
|
|
64
|
|
65 void registerDeserializer (T) (string type, void delegate (ref T, Serializer, DataType) dg)
|
|
66 {
|
|
67 deserializers[type] = toDeserializeRegisterWrapper(dg);
|
|
68 }
|
|
69
|
|
70 void registerDeserializer (T) (string type, void function (ref T, Serializer, DataType) func)
|
|
71 {
|
|
72 deserializers[type] = toDeserializeRegisterWrapper(func);
|
|
73 }
|
|
74
|
|
75 void reset ()
|
|
76 {
|
|
77 hasBegunSerializing = false;
|
|
78 hasBegunDeserializing = false;
|
|
79 resetCounters();
|
|
80
|
|
81 archive.reset;
|
|
82 }
|
|
83
|
|
84 DataType serialize (T) (T value, DataType key = null)
|
|
85 {
|
|
86 if (!hasBegunSerializing)
|
|
87 hasBegunSerializing = true;
|
|
88
|
|
89 if (!key)
|
|
90 key = nextKey;
|
|
91
|
|
92 archive.beginArchiving();
|
|
93
|
|
94 static if (isTypeDef!(T))
|
|
95 serializeTypeDef(value, key);
|
|
96
|
|
97 static if (isObject!(T))
|
|
98 serializeObject(value, key);
|
|
99
|
|
100 else static if (isStruct!(T))
|
|
101 serializeStruct(value, key);
|
|
102
|
|
103 else static if (isString!(T))
|
|
104 serializeString(value, key);
|
|
105
|
|
106 else static if (isArray!(T))
|
|
107 serializeArray(value, key);
|
|
108
|
|
109 else static if (isAssociativeArray!(T))
|
|
110 serializeAssociativeArray(value, key);
|
|
111
|
|
112 else static if (isPrimitive!(T))
|
|
113 serializePrimitive(value, key);
|
|
114
|
|
115 else static if (isPointer!(T))
|
|
116 {
|
|
117 static if (isFunctionPointer!(T))
|
2
|
118 goto error;
|
0
|
119
|
|
120 else
|
|
121 serializePointer(value, key);
|
2
|
122 }
|
0
|
123
|
|
124 else static if (isEnum!(T))
|
|
125 serializeEnum(value, key);
|
|
126
|
|
127 else
|
2
|
128 {
|
|
129 error:
|
|
130 throw new SerializationException(format!(`The type "`, T, `" cannot be serialized.`), __FILE__, __LINE__);
|
|
131 }
|
0
|
132
|
|
133 return archive.data;
|
|
134 }
|
|
135
|
|
136 private void serializeObject (T) (T value, DataType key)
|
2
|
137 {
|
0
|
138 triggerEvents(serializing, value, {
|
|
139 archive.archive(value, key, {
|
|
140 auto runtimeType = value.classinfo.name;
|
|
141
|
|
142 if (runtimeType in serializers)
|
|
143 {
|
|
144 auto wrapper = getSerializerWrapper!(T)(runtimeType);
|
|
145 wrapper(value, this, key);
|
|
146 }
|
|
147
|
|
148 else static if (isSerializable!(T, ArchiveType))
|
|
149 value.toData(this, key);
|
|
150
|
|
151 else
|
|
152 {
|
|
153 if (isBaseClass(value))
|
|
154 throw new SerializationException(`The object of the static type "` ~ T.stringof ~ `" have a different runtime type (` ~ runtimeType ~ `) and therefore needs to register a serializer for its type "` ~ runtimeType ~ `".`, __FILE__, __LINE__);
|
|
155
|
2
|
156 objectStructSerializeHelper(value);
|
0
|
157 }
|
|
158 });
|
|
159 });
|
|
160 }
|
|
161
|
|
162 private void serializeStruct (T) (T value, DataType key)
|
|
163 {
|
|
164 triggerEvents(serializing, value, {
|
|
165 archive.archive(value, key, {
|
|
166 auto type = toDataType(T.stringof);
|
|
167
|
|
168 if (type in serializers)
|
|
169 {
|
|
170 auto wrapper = getSerializerWrapper!(T)(type);
|
|
171 wrapper(value, this, key);
|
|
172 }
|
|
173
|
|
174 else
|
|
175 {
|
|
176 static if (isSerializable!(T, ArchiveType))
|
|
177 value.toData(this, key);
|
|
178
|
|
179 else
|
2
|
180 objectStructSerializeHelper(value);
|
0
|
181 }
|
|
182 });
|
|
183 });
|
|
184 }
|
|
185
|
|
186 private void serializeString (T) (T value, DataType key)
|
|
187 {
|
|
188 archive.archive(value, key);
|
|
189 }
|
|
190
|
|
191 private void serializeArray (T) (T value, DataType key)
|
|
192 {
|
|
193 archive.archive(value, key, {
|
|
194 foreach (i, e ; value)
|
|
195 archive.archive(e, toDataType(i));
|
|
196 });
|
|
197 }
|
|
198
|
|
199 private void serializeAssociativeArray (T) (T value, DataType key)
|
|
200 {
|
|
201 archive.archive(value, key, {
|
|
202 foreach(k, v ; value)
|
|
203 archive.archive(v, toDataType(k));
|
|
204 });
|
|
205 }
|
|
206
|
|
207 private void serializePointer (T) (T value, DataType key)
|
|
208 {
|
|
209 archive.archive(value, key, {
|
|
210 if (key in serializers)
|
|
211 {
|
|
212 auto wrapper = getSerializerWrapper!(T)(key);
|
|
213 wrapper(value, this, key);
|
|
214 }
|
|
215
|
|
216 else static if (isSerializable!(T, ArchiveType))
|
|
217 value.toData(this, key);
|
|
218
|
|
219 else
|
|
220 {
|
|
221 static if (isVoid!(BaseTypeOfPointer!(T)))
|
|
222 throw new SerializationException(`The value with the key "` ~ to!(string)(key) ~ `"` ~ format!(` of the type "`, T, `" cannot be serialized on its own, either implement orange.serialization.Serializable.isSerializable or register a serializer.`), __FILE__, __LINE__);
|
|
223
|
|
224 else
|
|
225 serialize(*value, key);
|
|
226 }
|
|
227 });
|
|
228 }
|
|
229
|
|
230 private void serializeEnum (T) (T value, DataType key)
|
|
231 {
|
|
232 archive.archive(value, key);
|
|
233 }
|
|
234
|
|
235 private void serializePrimitive (T) (T value, DataType key)
|
|
236 {
|
|
237 archive.archive(value, key);
|
|
238 }
|
|
239
|
|
240 private void serializeTypeDef (T) (T value, DataType key)
|
|
241 {
|
|
242 archive.archive(value, key, {
|
|
243 serialize!(BaseTypeOfTypeDef!(T))(value, key);
|
|
244 });
|
|
245 }
|
|
246
|
|
247 T deserialize (T) (DataType data, DataType key = null)
|
|
248 {
|
|
249 if (hasBegunSerializing && !hasBegunDeserializing)
|
|
250 resetCounters();
|
|
251
|
|
252 if (!hasBegunDeserializing)
|
|
253 hasBegunDeserializing = true;
|
|
254
|
|
255 if (!key)
|
|
256 key = nextKey;
|
|
257
|
|
258 archive.beginUnarchiving(data);
|
|
259 return deserializeInternal!(T)(key);
|
|
260 }
|
|
261
|
|
262 private T deserializeInternal (T) (DataType key)
|
|
263 {
|
|
264 static if (isTypeDef!(T))
|
|
265 return deserializeTypeDef!(T)(key);
|
|
266
|
|
267 else static if (isObject!(T))
|
|
268 return deserializeObject!(T)(key);
|
|
269
|
|
270 else static if (isStruct!(T))
|
|
271 return deserializeStruct!(T)(key);
|
|
272
|
|
273 else static if (isString!(T))
|
|
274 return deserializeString!(T)(key);
|
|
275
|
|
276 else static if (isArray!(T))
|
|
277 return deserializeArray!(T)(key);
|
|
278
|
|
279 else static if (isAssociativeArray!(T))
|
|
280 return deserializeAssociativeArray!(T)(key);
|
|
281
|
|
282 else static if (isPrimitive!(T))
|
|
283 return deserializePrimitive!(T)(key);
|
|
284
|
|
285 else static if (isPointer!(T))
|
2
|
286 {
|
|
287 static if (isFunctionPointer!(T))
|
|
288 goto error;
|
|
289
|
0
|
290 return deserializePointer!(T)(key);
|
2
|
291 }
|
0
|
292
|
|
293 else static if (isEnum!(T))
|
|
294 return deserializeEnum!(T)(key);
|
|
295
|
|
296 else
|
2
|
297 {
|
|
298 error:
|
|
299 throw new SerializationException(format!(`The type "`, T, `" cannot be deserialized.`), __FILE__, __LINE__);
|
|
300 }
|
0
|
301 }
|
|
302
|
|
303 private T deserializeObject (T) (DataType key)
|
|
304 {
|
2
|
305 T value = archive.unarchive!(T)(key, (T value) {
|
0
|
306 triggerEvents(deserializing, value, {
|
|
307 auto runtimeType = value.classinfo.name;
|
|
308
|
|
309 if (runtimeType in deserializers)
|
|
310 {
|
|
311 auto wrapper = getDeserializerWrapper!(T)(runtimeType);
|
|
312 wrapper(value, this, key);
|
|
313 }
|
|
314
|
|
315 else static if (isSerializable!(T, ArchiveType))
|
|
316 value.fromData(this, key);
|
|
317
|
|
318 else
|
|
319 {
|
|
320 if (isBaseClass(value))
|
|
321 throw new SerializationException(`The object of the static type "` ~ T.stringof ~ `" have a different runtime type (` ~ runtimeType ~ `) and therefore needs to register a deserializer for its type "` ~ runtimeType ~ `".`, __FILE__, __LINE__);
|
|
322
|
2
|
323 objectStructDeserializeHelper(value);
|
0
|
324 }
|
|
325 });
|
|
326
|
|
327 return value;
|
|
328 });
|
|
329
|
|
330 return value;
|
|
331 }
|
|
332
|
|
333 private T deserializeStruct (T) (DataType key)
|
|
334 {
|
|
335 return archive.unarchive!(T)(key, (T value) {
|
|
336 triggerEvents(deserializing, value, {
|
|
337 auto type = toDataType(T.stringof);
|
|
338
|
|
339 if (type in deserializers)
|
|
340 {
|
|
341 auto wrapper = getDeserializerWrapper!(T)(type);
|
|
342 wrapper(value, this, key);
|
|
343 }
|
|
344
|
|
345 else
|
|
346 {
|
|
347 static if (isSerializable!(T, ArchiveType))
|
|
348 value.fromData(this, key);
|
|
349
|
|
350 else
|
2
|
351 objectStructDeserializeHelper(value);
|
0
|
352 }
|
|
353 });
|
|
354
|
|
355 return value;
|
|
356 });
|
|
357 }
|
|
358
|
|
359 private T deserializeString (T) (DataType key)
|
|
360 {
|
|
361 return archive.unarchive!(T)(key);
|
|
362 }
|
|
363
|
|
364 private T deserializeArray (T) (DataType key)
|
|
365 {
|
|
366 return archive.unarchive!(T)(key, (T value) {
|
|
367 foreach (i, ref e ; value)
|
|
368 e = archive.unarchive!(typeof(e))(toDataType(i));
|
|
369
|
|
370 return value;
|
|
371 });
|
|
372 }
|
|
373
|
|
374 private T deserializeAssociativeArray (T) (DataType key)
|
|
375 {
|
|
376 return archive.unarchive!(T)(key, (T value) {
|
|
377 foreach (k, v ; archive.unarchiveAssociativeArrayVisitor!(T))
|
|
378 value[k] = v;
|
|
379
|
|
380 return value;
|
|
381 });
|
|
382 }
|
|
383
|
|
384 private T deserializePointer (T) (DataType key)
|
|
385 {
|
|
386 return archive.unarchive!(T)(key, (T value) {
|
|
387 if (key in deserializers)
|
|
388 {
|
|
389 auto wrapper = getDeserializerWrapper!(T)(key);
|
|
390 wrapper(value, this, key);
|
|
391 }
|
|
392
|
|
393 else static if (isSerializable!(T, ArchiveType))
|
|
394 value.fromData(this, key);
|
|
395
|
|
396 else
|
|
397 {
|
|
398 static if (isVoid!(BaseTypeOfPointer!(T)))
|
|
399 throw new SerializationException(`The value with the key "` ~ to!(string)(key) ~ `"` ~ format!(` of the type "`, T, `" cannot be deserialized on its own, either implement orange.serialization.Serializable.isSerializable or register a deserializer.`), __FILE__, __LINE__);
|
|
400
|
|
401 else
|
|
402 *value = deserializeInternal!(BaseTypeOfPointer!(T))(key);
|
|
403 }
|
|
404
|
|
405 return value;
|
|
406 });
|
|
407 }
|
|
408
|
|
409 private T deserializeEnum (T) (DataType key)
|
|
410 {
|
|
411 return archive.unarchive!(T)(key);
|
|
412 }
|
|
413
|
|
414 private T deserializePrimitive (T) (DataType key)
|
|
415 {
|
|
416 return archive.unarchive!(T)(key);
|
|
417 }
|
|
418
|
|
419 private T deserializeTypeDef (T) (DataType key)
|
|
420 {
|
|
421 return archive.unarchive!(T)(key, (T value) {
|
|
422 return deserializeInternal!(BaseTypeOfTypeDef!(T))(key);
|
|
423 });
|
|
424 }
|
|
425
|
2
|
426 private void objectStructSerializeHelper (T) (T value)
|
0
|
427 {
|
2
|
428 const nonSerializedFields = collectAnnotations!(nonSerializedField)(value);
|
|
429
|
0
|
430 foreach (i, dummy ; typeof(T.tupleof))
|
|
431 {
|
|
432 const field = nameOfFieldAt!(T, i);
|
|
433
|
2
|
434 static if (!internalFields.ctfeContains(field) && !nonSerializedFields.ctfeContains(field))
|
0
|
435 {
|
2
|
436 alias typeof(T.tupleof[i]) Type;
|
0
|
437 Type v = value.tupleof[i];
|
|
438 serialize(v, toDataType(field));
|
|
439 }
|
|
440 }
|
|
441
|
|
442 static if (is(T : Object) && !is(T == Object))
|
2
|
443 serializeBaseTypes(value);
|
0
|
444 }
|
|
445
|
2
|
446 private void objectStructDeserializeHelper (T) (T value)
|
0
|
447 {
|
2
|
448 const nonSerializedFields = collectAnnotations!(nonSerializedField)(value);
|
|
449
|
0
|
450 foreach (i, dummy ; typeof(T.tupleof))
|
|
451 {
|
|
452 const field = nameOfFieldAt!(T, i);
|
|
453
|
2
|
454 static if (!internalFields.ctfeContains(field) && !nonSerializedFields.ctfeContains(field))
|
|
455 {
|
0
|
456 alias TypeOfField!(T, field) Type;
|
2
|
457 auto fieldValue = deserializeInternal!(Type)(toDataType(field));
|
|
458 value.tupleof[i] = fieldValue;
|
0
|
459 }
|
|
460 }
|
|
461
|
|
462 static if (is(T : Object) && !is(T == Object))
|
2
|
463 deserializeBaseTypes(value);
|
0
|
464 }
|
|
465
|
2
|
466 private void serializeBaseTypes (T : Object) (T value)
|
0
|
467 {
|
|
468 alias BaseTypeTupleOf!(T)[0] Base;
|
|
469
|
|
470 static if (!is(Base == Object))
|
|
471 {
|
|
472 archive.archiveBaseClass!(Base)(nextKey);
|
2
|
473 objectStructSerializeHelper!(Base)(value);
|
0
|
474 }
|
|
475 }
|
|
476
|
2
|
477 private void deserializeBaseTypes (T : Object) (T value)
|
0
|
478 {
|
|
479 alias BaseTypeTupleOf!(T)[0] Base;
|
|
480
|
|
481 static if (!is(Base == Object))
|
|
482 {
|
|
483 archive.unarchiveBaseClass!(Base)(nextKey);
|
2
|
484 objectStructDeserializeHelper!(Base)(value);
|
0
|
485 }
|
|
486 }
|
|
487
|
|
488 private SerializeRegisterWrapper!(T, ArchiveType) getSerializerWrapper (T) (string type)
|
|
489 {
|
|
490 auto wrapper = cast(SerializeRegisterWrapper!(T, ArchiveType)) serializers[type];
|
|
491
|
|
492 if (wrapper)
|
|
493 return wrapper;
|
|
494
|
|
495 assert(false, "throw exception here");
|
|
496 }
|
|
497
|
|
498 private DeserializeRegisterWrapper!(T, ArchiveType) getDeserializerWrapper (T) (string type)
|
|
499 {
|
|
500 auto wrapper = cast(DeserializeRegisterWrapper!(T, ArchiveType)) deserializers[type];
|
|
501
|
|
502 if (wrapper)
|
|
503 return wrapper;
|
|
504
|
|
505 assert(false, "throw exception here");
|
|
506 }
|
|
507
|
|
508 private SerializeRegisterWrapper!(T, ArchiveType) toSerializeRegisterWrapper (T) (void delegate (T, Serializer, DataType) dg)
|
|
509 {
|
|
510 return new SerializeRegisterWrapper!(T, ArchiveType)(dg);
|
|
511 }
|
|
512
|
|
513 private SerializeRegisterWrapper!(T, ArchiveType) toSerializeRegisterWrapper (T) (void function (T, Serializer, DataType) func)
|
|
514 {
|
|
515 return new SerializeRegisterWrapper!(T, ArchiveType)(func);
|
|
516 }
|
|
517
|
|
518 private DeserializeRegisterWrapper!(T, ArchiveType) toDeserializeRegisterWrapper (T) (void delegate (ref T, Serializer, DataType) dg)
|
|
519 {
|
|
520 return new DeserializeRegisterWrapper!(T, ArchiveType)(dg);
|
|
521 }
|
|
522
|
|
523 private DeserializeRegisterWrapper!(T, ArchiveType) toDeserializeRegisterWrapper (T) (void function (ref T, Serializer, DataType) func)
|
|
524 {
|
|
525 return new DeserializeRegisterWrapper!(T, ArchiveType)(func);
|
|
526 }
|
|
527
|
|
528 private DataType toDataType (T) (T value)
|
|
529 {
|
|
530 try
|
|
531 return to!(DataType)(value);
|
|
532
|
|
533 catch (ConversionException e)
|
|
534 throw new SerializationException(e);
|
|
535 }
|
|
536
|
|
537 private bool isBaseClass (T) (T value)
|
|
538 {
|
|
539 auto name = value.classinfo.name;
|
|
540 auto index = name.lastIndexOf('.');
|
|
541
|
|
542 return T.stringof != name[index + 1 .. $];
|
|
543 }
|
|
544
|
|
545 private DataType nextKey ()
|
|
546 {
|
|
547 return toDataType(keyCounter++);
|
|
548 }
|
|
549
|
|
550 private void resetCounters ()
|
|
551 {
|
|
552 keyCounter = 0;
|
|
553 }
|
|
554
|
|
555 private void triggerEvent (string name, T) (T value)
|
|
556 {
|
|
557 static assert (is(T == class) || is(T == struct), format!(`The given value of the type "`, T, `" is not a valid type, the only valid types for this method are classes and structs.`));
|
|
558
|
|
559 foreach (i, dummy ; typeof(T.tupleof))
|
|
560 {
|
|
561 const field = nameOfFieldAt!(T, i);
|
|
562
|
|
563 static if (field == name)
|
|
564 {
|
|
565 alias TypeOfField!(T, field) Type;
|
|
566 auto event = getValueOfField!(T, Type, field)(value);
|
|
567 event(value);
|
|
568 }
|
|
569 }
|
|
570 }
|
|
571
|
|
572 private void triggerEvents (T) (Mode mode, T value, void delegate () dg)
|
|
573 {
|
|
574 if (mode == serializing)
|
|
575 triggerEvent!(onSerializingField)(value);
|
|
576
|
|
577 else
|
|
578 triggerEvent!(onDeserializingField)(value);
|
|
579
|
|
580 dg();
|
|
581
|
|
582 if (mode == serializing)
|
|
583 triggerEvent!(onSerializedField)(value);
|
|
584
|
|
585 else
|
|
586 triggerEvent!(onDeserializedField)(value);
|
|
587 }
|
|
588
|
2
|
589 private static string[] collectAnnotations (string name, T) (T value)
|
0
|
590 {
|
|
591 static assert (is(T == class) || is(T == struct), format!(`The given value of the type "`, T, `" is not a valid type, the only valid types for this method are classes and structs.`));
|
|
592
|
|
593 string[] annotations;
|
|
594
|
|
595 foreach (i, dummy ; typeof(T.tupleof))
|
|
596 {
|
|
597 const field = nameOfFieldAt!(T, i);
|
|
598
|
|
599 static if (field == name)
|
|
600 {
|
2
|
601 typeof(value.tupleof[i]) f;
|
0
|
602 annotations ~= f.field;
|
|
603 }
|
|
604 }
|
|
605
|
|
606 return annotations;
|
|
607 }
|
|
608 } |