Changeset 1779 for trunk/sources/HeuristicLab.Persistence

Timestamp:

05/11/09 13:35:32 (16 years ago)

Author:

epitzer

Message:

Better type name parser. Replace reflection based type name generation, better exceptions during deserialization. (#613)

Location:

trunk/sources/HeuristicLab.Persistence

Files:

• 3.3/Auxiliary/TypeExtensions.cs (modified) (1 diff)
• 3.3/Auxiliary/TypeStringBuilder.cs (modified) (12 diffs)
• 3.3/Core/DeSerializer.cs (modified) (2 diffs)
• 3.3/Default/Xml/XmlParser.cs (modified) (1 diff)
• UnitTests/UseCases.cs (modified) (1 diff)

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

@@ -7 +7 @@
 
     public static string VersionInvariantName(this Type type) {
-      StringBuilder sb = new StringBuilder();
-      TypeStringBuilder.BuildVersionInvariantName(type, sb);
-      return sb.ToString();
+      return TypeNameParser.Parse(type.AssemblyQualifiedName).ToString(false);
     }
 

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

@@ -40 +40 @@
           {"&", "AMPERSAND"},
           {".", "DOT"},
+          {"-", "DASH"},
           {"+", "PLUS"},
           {",", "COMMA"},
@@ -49 +50 @@
           {"`", "BACKTICK"} };
       private static Regex NumberRegex = new Regex("^\\d+$");
-      private static Regex TokenRegex = new Regex("[&.+,\\[\\]* =`]|\\d+|[a-zA-Z][a-zA-Z0-9]*");
+      private static Regex TokenRegex = new Regex("[-&.+,\\[\\]* =`]|\\d+|[a-zA-Z][a-zA-Z0-9]*");
       public string Name { get; private set; }
       public string Value { get; private set; }
       public int? Number { get; private set; }
-      private Token(string value) {
+      public int Position { get; private set; }
+      private Token(string value, int pos) {
+        Position = pos;
         if (tokens.ContainsKey(value)) {
           Name = tokens[value];
@@ -63 +66 @@
       }
       public static IEnumerable<Token> Tokenize(string s) {
+        int pos = 0;
         foreach (Match m in TokenRegex.Matches(s)) {
-          yield return new Token(m.Value);
+          yield return new Token(m.Value, pos);
+          pos += m.Length;
         }
       }
@@ -78 +83 @@
     }
 
-    Queue<Token> tokens;
+    private Queue<Token> tokens;
+    private int Position {
+      get {
+        if (tokens.Count == 0)
+          return -1;
+        else
+          return tokens.Peek().Position;
+      }
+    }
 
     private TypeNameParser(string s) {
@@ -84 +97 @@
     }
 
-    public static string StripVersion(string s) {
+    public static TypeName Parse(string s) {
       TypeNameParser p = new TypeNameParser(s);
-      return p.TransformTypeSpec();
-    }
-
-
-    private string TransformTypeSpec() {
-      string result = TransformSimpleTypeSpec();
-      if (ConsumeToken("AMPERSAND")) {
-        return result + "&";
-      } else {
-        return result;
-      }
-    }
-
-    private string TransformSimpleTypeSpec() {
+      try {
+        return p.TransformTypeSpec();
+      } catch (ParseError x) {
+        if (p.Position > 0)
+          throw new ParseError(String.Format(
+            "Could not parse typename: {0}\n\"{1}====>{2}<===={3}",
+            x.Message,
+            s.Substring(0, p.Position),
+            s[p.Position],
+            s.Substring(p.Position, s.Length - p.Position)));
+        else
+          throw new ParseError(String.Format(
+            "Could not parse typenname \"{0}\" at end of input: {1}",
+            s,
+            x.Message));
+      }
+    }
+
+    private TypeName TransformTypeSpec() {
+      TypeName t = TransformSimpleTypeSpec();
+      t.IsReference = ConsumeToken("AMPERSAND");
+      return t;
+    }
+
+    private TypeName TransformSimpleTypeSpec() {
       List<string> nameSpace = new List<string>();
       nameSpace.Add(ConsumeIdentifier());
       while (ConsumeToken("DOT"))
         nameSpace.Add(ConsumeIdentifier());
-      List<string> typeName = new List<string>();
+      List<string> className = new List<string>();
       if (nameSpace.Count > 0) {
-        typeName.Add(nameSpace[nameSpace.Count - 1]);
+        className.Add(nameSpace[nameSpace.Count - 1]);
         nameSpace.RemoveAt(nameSpace.Count - 1);
       }
       while (ConsumeToken("PLUS"))
-        typeName.Add(ConsumeIdentifier());
-      string genericString = "";
+        className.Add(ConsumeIdentifier());
+      TypeName typeName = new TypeName(
+        string.Join(".", nameSpace.ToArray()),
+        string.Join("+", className.ToArray()));
       if (ConsumeToken("BACKTICK")) {
-        string number = ConsumeNumber().ToString();
-        ConsumeToken("OPEN_BRACKET", true);
-        string generics = TransformGenerics();
-        ConsumeToken("CLOSE_BRACKET", true);
-        genericString = "`" + number + "[" + generics + "]";
+        int nGenericArgs = ConsumeNumber();
+        if (ConsumeToken("OPEN_BRACKET") &&
+          CanConsumeToken("OPEN_BRACKET")) {
+          typeName.GenericArgs.AddRange(TransformGenerics());
+          ConsumeToken("CLOSE_BRACKET", true);
+        }
       }
       StringBuilder pointerOrArray = new StringBuilder();
@@ -124 +151 @@
           pointerOrArray.Append("*");
         } else if (ConsumeToken("OPEN_BRACKET")) {
+          pointerOrArray.Append('[');
           ParseDimension(pointerOrArray);
           while (ConsumeToken("COMMA")) {
@@ -130 +158 @@
           }
           ConsumeToken("CLOSE_BRACKET", true);
+          pointerOrArray.Append(']');
         } else {
           break;
         }
       }
-      string assembly = "";
+      typeName.MemoryMagic = pointerOrArray.ToString();
       if (ConsumeComma()) {
-        assembly = ConsumeIdentifier();
+        StringBuilder sb = new StringBuilder();
+        sb.Append(ConsumeIdentifier());
+        while (CanConsumeToken("DOT") ||
+          CanConsumeToken("DASH") ||
+          CanConsumeNumber() ||
+          CanConsumeIdentifier()) {
+          if (ConsumeToken("DOT"))
+            sb.Append('.');
+          else if (ConsumeToken("DASH"))
+            sb.Append('-');
+          else if (CanConsumeNumber())
+            sb.Append(ConsumeNumber());
+          else
+            sb.Append(ConsumeIdentifier());
+        }
+        typeName.AssemblyName = sb.ToString();
         while (ConsumeComma()) {
-          TransformAssemblyProperty();
-        }
-      }
-      return string.Join(".", nameSpace.ToArray()) + "." +
-        string.Join("+", typeName.ToArray()) +
-        genericString +
-        pointerOrArray.ToString() +
-        ", " +
-        assembly;
+          KeyValuePair<string, string> property =
+            TransformAssemblyProperty();
+          typeName.AssemblyAttribues.Add(property.Key, property.Value);
+        }
+      }
+      return typeName;
     }
 
@@ -164 +205 @@
     }
 
-    private string TransformGenerics() {
+    private IEnumerable<TypeName> TransformGenerics() {
       ConsumeToken("OPEN_BRACKET", true);
-      List<string> typenames = new List<string>();
-      typenames.Add(TransformSimpleTypeSpec());
+      yield return TransformSimpleTypeSpec();
       ConsumeToken("CLOSE_BRACKET", true);
       while (ConsumeToken("COMMA")) {
         ConsumeToken("OPEN_BRACKET", true);
-        typenames.Add(TransformSimpleTypeSpec());
+        yield return TransformSimpleTypeSpec();
         ConsumeToken("CLOSE_BRACKET", true);
       }
-      return "[" + string.Join("],[", typenames.ToArray()) + "]";
-    }
-
-    private string TransformAssemblyProperty() {
+    }
+
+    private KeyValuePair<string, string> TransformAssemblyProperty() {
       if (ConsumeIdentifier("Version")) {
         ConsumeToken("EQUALS", true);
-        TransformVersion();
+        return new KeyValuePair<string, string>(
+          "Version",
+          TransformVersion());
       } else if (ConsumeIdentifier("PublicKey")) {
         ConsumeToken("EQUALS", true);
-        ConsumeIdentifier();
+        return new KeyValuePair<string, string>(
+          "PublicKey",
+          ConsumeIdentifier());
       } else if (ConsumeIdentifier("PublicKeyToken")) {
         ConsumeToken("EQUALS", true);
-        ConsumeIdentifier();
+        return new KeyValuePair<string, string>(
+          "PublicKeyToken",
+          ConsumeIdentifier());
       } else if (ConsumeIdentifier("Culture")) {
         ConsumeToken("EQUALS", true);
-        ConsumeIdentifier();
+        return new KeyValuePair<string, string>(
+          "Culture",
+          ConsumeIdentifier());
       } else if (ConsumeIdentifier("Custom")) {
         ConsumeToken("EQUALS", true);
-        ConsumeIdentifier();
+        return new KeyValuePair<string, string>(
+          "Custom",
+          ConsumeIdentifier());
       } else {
         throw new ParseError(String.Format(
@@ -198 +247 @@
           tokens.Peek().ToString()));
       }
-      return "";
     }
     private string TransformVersion() {
-      ConsumeNumber();
+      StringBuilder version = new StringBuilder();
+      version.Append(ConsumeNumber());
       ConsumeToken("DOT");
-      ConsumeNumber();
+      version.Append('.').Append(ConsumeNumber());
       ConsumeToken("DOT");
-      ConsumeNumber();
+      version.Append('.').Append(ConsumeNumber());
       ConsumeToken("DOT");
-      ConsumeNumber();
-      return "";
+      version.Append('.').Append(ConsumeNumber());
+      return version.ToString();
     }
 
@@ -238 +287 @@
     }
 
+    private bool CanConsumeIdentifier() {
+      return tokens.Count > 0 && tokens.Peek().Value != null;
+    }
+
     private string ConsumeIdentifier() {
       if (tokens.Count == 0)
@@ -259 +312 @@
     private bool ConsumeToken(string name) {
       return ConsumeToken(name, false);
+    }
+
+    private bool CanConsumeToken(string name) {
+      if (tokens.Count == 0)
+        return false;
+      if (tokens.Peek().Name == name)
+        return true;
+      return false;
     }
 
@@ -282 +343 @@
     }
 
+
   }
 
   public class TypeName {
-    public bool IsReference { get; private set; }
-    public bool IsArray { get { return Dimension.Length > 0; } }
-    public bool IsPointer { get; private set; }
+    public string Namespace { get; private set; }
+    public string ClassName { get; private set; }
+    public List<TypeName> GenericArgs { get; internal set; }
     public bool IsGeneric { get { return GenericArgs.Count > 0; } }
-    public List<TypeName> GenericArgs { get; private set; }
-    public string Dimension { get; private set; }
-    public string ClassName { get; private set; }
-    public string Namespace { get; private set; }
-    public string AssemblyNmae { get; private set; }
-    public string AssemblyAttribues { get; private set; }
-    public TypeName(string typeName) {
+    public string MemoryMagic { get; internal set; }
+    public string AssemblyName { get; internal set; }
+    public Dictionary<string, string> AssemblyAttribues { get; internal set; }
+    public bool IsReference { get; internal set; }
+
+    internal TypeName(string nameSpace, string className) {
+      Namespace = nameSpace;
+      ClassName = className;
+      GenericArgs = new List<TypeName>();
+      MemoryMagic = "";
+      AssemblyAttribues = new Dictionary<string, string>();
+    }
+
+    public string ToString(bool full) {
+      StringBuilder sb = new StringBuilder();
+      sb.Append(Namespace).Append('.').Append(ClassName);
+      if (IsGeneric) {
+        sb.Append('`').Append(GenericArgs.Count).Append('[');
+        bool first = true;
+        foreach (TypeName t in GenericArgs) {
+          if (first)
+            first = false;
+          else
+            sb.Append(',');
+          sb.Append('[').Append(t.ToString(full)).Append(']');
+        }
+        sb.Append(']');
+      }
+      sb.Append(MemoryMagic);
+      if (AssemblyName != null)
+        sb.Append(", ").Append(AssemblyName);
+      if (full)
+        foreach (var property in AssemblyAttribues)
+          sb.Append(", ").Append(property.Key).Append('=').Append(property.Value);
+      return sb.ToString();
+    }
+
+    public override string ToString() {
+      return ToString(true);
+    }
+
+    public bool IsOlderThan(TypeName t) {
+      if (this.ClassName != t.ClassName ||
+        this.Namespace != t.Namespace ||
+        this.AssemblyName != t.AssemblyName)
+        throw new Exception("Cannot compare versions of different types");
+      if (CompareVersions(
+        this.AssemblyAttribues["Version"],
+        t.AssemblyAttribues["Version"]) < 0)
+        return true;
+      IEnumerator<TypeName> thisIt = this.GenericArgs.GetEnumerator();
+      IEnumerator<TypeName> tIt = t.GenericArgs.GetEnumerator();
+      while (thisIt.MoveNext()) {
+        tIt.MoveNext();
+        if (thisIt.Current.IsOlderThan(tIt.Current))
+          return true;
+      }
+      return false;
+    }
+
+    private static int CompareVersions(string v1string, string v2string) {
+      return new Version(v1string).CompareTo(new Version(v2string));
     }
   }
-
-  public static class TypeStringBuilder {
-
-    internal static void BuildDeclaringTypeChain(Type type, StringBuilder sb) {
-      if (type.DeclaringType != null) {
-        BuildDeclaringTypeChain(type.DeclaringType, sb);
-        sb.Append(type.DeclaringType.Name).Append('+');
-      }
-    }
-
-    internal static void BuildVersionInvariantName(Type type, StringBuilder sb) {
-      sb.Append(type.Namespace).Append('.');
-      BuildDeclaringTypeChain(type, sb);
-      sb.Append(type.Name);
-      if (type.IsGenericType) {
-        sb.Append("[");
-        Type[] args = type.GetGenericArguments();
-        for (int i = 0; i < args.Length; i++) {
-          sb.Append("[");
-          BuildVersionInvariantName(args[i], sb);
-          sb.Append("],");
-        }
-        if (args.Length > 0)
-          sb.Remove(sb.Length - 1, 1);
-        sb.Append("]");
-      }
-      sb.Append(", ").Append(type.Assembly.GetName().Name);
-    }
-
-    public static string StripVersion(string typename) {
-      return TypeNameParser.StripVersion(typename);
-    }
-
-  }
-
 }

trunk/sources/HeuristicLab.Persistence/3.3/Core/DeSerializer.cs

@@ -74 +74 @@
           try {
             type = Type.GetType(typeMapping.TypeName, true);
-          } catch (Exception e) {
+          } catch (Exception) {
             Logger.Error(String.Format(
               "Cannot load type \"{0}\", falling back to loading with partial name", typeMapping.TypeName));
             string[] typeNameParts = typeMapping.TypeName.Split(new[] { ',' });
-            Assembly a = Assembly.LoadWithPartialName(typeNameParts[typeNameParts.Length - 1].Trim());
-            Array.Resize(ref typeNameParts, typeNameParts.Length - 1);
-            type = a.GetType(string.Join(",", typeNameParts), true);
+            try {
+              Assembly a = Assembly.LoadWithPartialName(typeNameParts[typeNameParts.Length - 1].Trim());
+              Array.Resize(ref typeNameParts, typeNameParts.Length - 1);
+              type = a.GetType(string.Join(",", typeNameParts), true);
+            } catch (Exception) {
+              throw new PersistenceException(String.Format(
+                "Could not load type \"{0}\"",
+                typeMapping.TypeName));
+            }
           }
           typeIds.Add(typeMapping.Id, type);
@@ -87 +93 @@
         }
         return map;
+      } catch (PersistenceException) {
+        throw;
       } catch (Exception e) {
         throw new PersistenceException(

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

@@ -131 +131 @@
 
     private static object Deserialize(ZipFile zipFile) {
-      try {        
+      try {
         Deserializer deSerializer = new Deserializer(
           ParseTypeCache(

trunk/sources/HeuristicLab.Persistence/UnitTests/UseCases.cs

@@ -525 +525 @@
     [TestMethod]
     public void TestTypeStringConversion() {
-      string version = TypeStringBuilder.StripVersion(typeof(List<int>[]).AssemblyQualifiedName);
-      Assert.AreEqual(version, typeof(List<int>[]).VersionInvariantName());
+      string name = typeof(List<int>[]).AssemblyQualifiedName;
+      string shortName =
+        "System.Collections.Generic.List`1[[System.Int32, mscorlib]][], mscorlib";
+      Assert.AreEqual(name, TypeNameParser.Parse(name).ToString());        
+      Assert.AreEqual(shortName, TypeNameParser.Parse(name).ToString(false));
+      Assert.AreEqual(shortName, typeof(List<int>[]).VersionInvariantName());
     }