Changeset 3935

Timestamp:

06/21/10 15:58:31 (14 years ago)

Author:

epitzer

Message:

Add EasyXmlGenerator for easier review of generated XML. (#1139)

Location:

trunk/sources/HeuristicLab.Persistence/3.3

Files:

• Auxiliary/TypeName.cs (modified) (1 diff)
• Default/Xml/EasyXmlGenerator.cs (added)
• Default/Xml/XmlGenerator.cs (modified) (13 diffs)
• HeuristicLab.Persistence-3.3.csproj (modified) (1 diff)
• Tests/UseCases.cs (modified) (10 diffs)

trunk/sources/HeuristicLab.Persistence/3.3/Auxiliary/TypeName.cs

@@ -176 +176 @@
         sb.Append(">");
       }
+      sb.Append(MemoryMagic);
+      return sb.ToString();
+    }
+
+    public string GetTypeNameInCode(bool includeAllNamespaces) {
+      StringBuilder sb = new StringBuilder();
+      if (includeAllNamespaces)
+        sb.Append(Namespace).Append('.');
+      sb.Append(ClassName);
+      if (IsGeneric) {
+        sb.Append("<");
+        sb.Append(
+          string.Join(", ",
+            GenericArgs
+              .Select(a => a.GetTypeNameInCode(includeAllNamespaces))
+              .ToArray()));
+        sb.Append(">");
+      }
+      sb.Append(MemoryMagic);
       return sb.ToString();
     }

trunk/sources/HeuristicLab.Persistence/3.3/Default/Xml/XmlGenerator.cs

@@ -40 +40 @@
   public class XmlGenerator : GeneratorBase<string> {
 
-    private int depth;
-    private int Depth {
+    protected int depth;
+    protected int Depth {
       get {
         return depth;
@@ -51 +51 @@
     }
 
-    private string prefix;
+    protected string prefix;
 
 
@@ -61 +61 @@
     }
 
-    private enum NodeType { Start, End, Inline } ;
-
-    private static void AddXmlTagContent(StringBuilder sb, string name, Dictionary<string, object> attributes) {
+    protected enum NodeType { Start, End, Inline } ;
+
+    protected static void AddXmlTagContent(StringBuilder sb, string name, Dictionary<string, object> attributes) {
       sb.Append(name);
       foreach (var attribute in attributes) {
@@ -76 +76 @@
     }
 
-    private static void AddXmlStartTag(StringBuilder sb, string name, Dictionary<string, object> attributes) {
+    protected static void AddXmlStartTag(StringBuilder sb, string name, Dictionary<string, object> attributes) {
       sb.Append('<');
       AddXmlTagContent(sb, name, attributes);
@@ -82 +82 @@
     }
 
-    private static void AddXmlInlineTag(StringBuilder sb, string name, Dictionary<string, object> attributes) {
+    protected static void AddXmlInlineTag(StringBuilder sb, string name, Dictionary<string, object> attributes) {
       sb.Append('<');
       AddXmlTagContent(sb, name, attributes);
@@ -88 +88 @@
     }
 
-    private static void AddXmlEndTag(StringBuilder sb, string name) {
+    protected static void AddXmlEndTag(StringBuilder sb, string name) {
       sb.Append("</");
       sb.Append(name);
@@ -94 +94 @@
     }
 
-    private string CreateNodeStart(string name, Dictionary<string, object> attributes) {
+    protected string CreateNodeStart(string name, Dictionary<string, object> attributes) {
       StringBuilder sb = new StringBuilder();
       sb.Append(prefix);
@@ -103 +103 @@
     }
 
-    private string CreateNodeStart(string name) {
+    protected string CreateNodeStart(string name) {
       return CreateNodeStart(name, new Dictionary<string, object>());
     }
 
-    private string CreateNodeEnd(string name) {
+    protected string CreateNodeEnd(string name) {
       Depth -= 1;
       StringBuilder sb = new StringBuilder();
@@ -116 +116 @@
     }
 
-    private string CreateNode(string name, Dictionary<string, object> attributes) {
+    protected string CreateNode(string name, Dictionary<string, object> attributes) {
       StringBuilder sb = new StringBuilder();
       sb.Append(prefix);
@@ -124 +124 @@
     }
 
-    private string CreateNode(string name, Dictionary<string, object> attributes, string content) {
+    protected string CreateNode(string name, Dictionary<string, object> attributes, string content) {
       StringBuilder sb = new StringBuilder();
       sb.Append(prefix);
@@ -148 +148 @@
     }
 
-    private void AddTypeInfo(int typeId, Dictionary<string, object> dict) {
+    protected void AddTypeInfo(int typeId, Dictionary<string, object> dict) {
       if (lastTypeToken != null) {
         if (typeId == lastTypeToken.Id) {
@@ -225 +225 @@
     }
 
-    private TypeToken lastTypeToken;
+    protected TypeToken lastTypeToken;
     /// <summary>
     /// Formats the specified token.
@@ -236 +236 @@
     }
 
-    private string FlushTypeToken() {
+    protected string FlushTypeToken() {
       if (lastTypeToken == null)
         return "";

trunk/sources/HeuristicLab.Persistence/3.3/HeuristicLab.Persistence-3.3.csproj

@@ -158 +158 @@
     <Compile Include="Default\Xml\Compact\NumberArray2XmlSerializerBase.cs" />
     <Compile Include="Default\Xml\Compact\NumberEnumeration2XmlSerializerBase.cs" />
+    <Compile Include="Default\Xml\EasyXmlGenerator.cs" />
     <Compile Include="Default\Xml\Primitive\System.Drawing\Bitmap2XmlSerializer.cs" />
     <Compile Include="Default\Xml\Primitive\Bool2XmlSerializer.cs" />

trunk/sources/HeuristicLab.Persistence/3.3/Tests/UseCases.cs

@@ -42 +42 @@
 namespace HeuristicLab.Persistence_33.Tests {
 
-  [StorableClass]  
+  [StorableClass]
   public class NumberTest {
     [Storable]
@@ -288 +288 @@
       Root newR = (Root)XmlParser.Deserialize(tempFile);
       CompareComplexStorables(r, newR);
+    }
+
+    [TestMethod]
+    public void ComplexEasyStorable() {
+      Root r = InitializeComplexStorable();
+      ReadableXmlGenerator.Serialize(r, tempFile);
+      using (var reader = new StreamReader(tempFile)) {
+        string text = reader.ReadToEnd();
+        Assert.IsTrue(text.StartsWith("<Root"));
+      }
     }
 
@@ -774 +784 @@
 
       Assert.AreEqual(bitmap.Size, newBitmap.Size);
-      for(int i=0; i< bitmap.Size.Width; i++)
-        for(int j =0; j< bitmap.Size.Height; j++)
-          Assert.AreEqual(bitmap.GetPixel(i,j),newBitmap.GetPixel(i,j));
+      for (int i = 0; i < bitmap.Size.Width; i++)
+        for (int j = 0; j < bitmap.Size.Height; j++)
+          Assert.AreEqual(bitmap.GetPixel(i, j), newBitmap.GetPixel(i, j));
     }
 
@@ -813 +823 @@
       Assert.IsFalse(newHookTest.WasSerialized);
     }
-    
+
     [StorableClass]
     private class CustomConstructor {
@@ -858 +868 @@
 
     [TestMethod]
-    public void TestRejectionJustifications() { 
+    public void TestRejectionJustifications() {
       NonSerializable ns = new NonSerializable();
       try {
@@ -864 +874 @@
         Assert.Fail("PersistenceException expected");
       } catch (PersistenceException x) {
-        Assert.IsTrue(x.Message.Contains(new StorableSerializer().JustifyRejection(typeof(NonSerializable))));        
+        Assert.IsTrue(x.Message.Contains(new StorableSerializer().JustifyRejection(typeof(NonSerializable))));
       }
     }
@@ -967 +977 @@
       Assert.AreEqual(afs.Value3, newAfs.Value3);
       Assert.AreEqual(afs.Value4, newAfs.Value4);
-      
+
     }
 
@@ -996 +1006 @@
       Assert.AreEqual(afs.Value2, newAfs.Value2);
       Assert.AreEqual(afs.Value3, newAfs.Value3);
-      Assert.AreEqual(afs.Value4, newAfs.Value4);      
+      Assert.AreEqual(afs.Value4, newAfs.Value4);
     }
 
@@ -1022 +1032 @@
       XmlGenerator.Serialize(afs, tempFile);
       MarkedOnlyStorable newAfs = (MarkedOnlyStorable)XmlParser.Deserialize(tempFile);
-      Assert.AreEqual(1, newAfs.Value1);      
+      Assert.AreEqual(1, newAfs.Value1);
       Assert.AreEqual(afs.Value2, newAfs.Value2);
       Assert.AreEqual(0, newAfs.Value3);
@@ -1054 +1064 @@
       Assert.IsTrue(double.IsNaN(newSpecials[2]));
     }
-    
+
 
     [ClassInitialize]