Merge pull request #5947 from hvitved/csharp/encode-display-name

hvitved · web-flow · commit 8cbb3caaa421 · 2021-05-25T10:58:31.000+02:00
C#: Encode `"` in `BuildDisplayName`
diff --git a/csharp/extractor/Semmle.Extraction.CSharp/SymbolExtensions.cs b/csharp/extractor/Semmle.Extraction.CSharp/SymbolExtensions.cs
@@ -373,7 +373,7 @@ public static void BuildDisplayName(this ITypeSymbol type, Context cx, TextWrite
                         var elementType = array.ElementType;
                         if (elementType.MetadataName.Contains("`"))
                         {
-                            trapFile.Write(elementType.Name);
+                            trapFile.Write(TrapExtensions.EncodeString(elementType.Name));
                             return;
                         }
                         elementType.BuildDisplayName(cx, trapFile);
@@ -480,7 +480,7 @@ private static void BuildNamedTypeDisplayName(this INamedTypeSymbol namedType, C
             }
             else
             {
-                trapFile.Write(namedType.Name);
+                trapFile.Write(TrapExtensions.EncodeString(namedType.Name));
             }
 
             if (namedType.IsGenericType && namedType.TypeKind != TypeKind.Error && namedType.TypeArguments.Any())
diff --git a/csharp/extractor/Semmle.Extraction/TrapExtensions.cs b/csharp/extractor/Semmle.Extraction/TrapExtensions.cs
@@ -117,7 +117,7 @@ private static string TruncateString(string s, ref int bytesRemaining)
             return s;
         }
 
-        private static string EncodeString(string s) => s.Replace("\"", "\"\"");
+        public static string EncodeString(string s) => s.Replace("\"", "\"\"");
 
         /// <summary>
         /// Output a string to the trap file, such that the encoded output does not exceed

Original file line number	Diff line number	Diff line change
`@@ -373,7 +373,7 @@ public static void BuildDisplayName(this ITypeSymbol type, Context cx, TextWrite`
`373`	`373`	`var elementType = array.ElementType;`
`374`	`374`	if (elementType.MetadataName.Contains("`"))
`375`	`375`	`{`
`376`		`- trapFile.Write(elementType.Name);`
	`376`	`+ trapFile.Write(TrapExtensions.EncodeString(elementType.Name));`
`377`	`377`	`return;`
`378`	`378`	`}`
`379`	`379`	`elementType.BuildDisplayName(cx, trapFile);`
`@@ -480,7 +480,7 @@ private static void BuildNamedTypeDisplayName(this INamedTypeSymbol namedType, C`
`480`	`480`	`}`
`481`	`481`	`else`
`482`	`482`	`{`
`483`		`- trapFile.Write(namedType.Name);`
	`483`	`+ trapFile.Write(TrapExtensions.EncodeString(namedType.Name));`
`484`	`484`	`}`
`485`	`485`
`486`	`486`	`if (namedType.IsGenericType && namedType.TypeKind != TypeKind.Error && namedType.TypeArguments.Any())`
Original file line number	Diff line number	Diff line change
`@@ -117,7 +117,7 @@ private static string TruncateString(string s, ref int bytesRemaining)`
`117`	`117`	`return s;`
`118`	`118`	`}`
`119`	`119`
`120`		`- private static string EncodeString(string s) => s.Replace("\"", "\"\"");`
	`120`	`+ public static string EncodeString(string s) => s.Replace("\"", "\"\"");`
`121`	`121`
`122`	`122`	`/// <summary>`
`123`	`123`	`/// Output a string to the trap file, such that the encoded output does not exceed`