Merge pull request #41 from tmat/ISymReader5

Add ISymUnmanagedReader5 and ISymUnmanagedEncUpdate

Author: tmat

.gitignore

@@ -6,6 +6,7 @@
 *.user
 *.sln.docstates
 .vs/
+*.VC.db
 
 # Build results
 [Aa]rtifacts/
@@ -21,8 +22,8 @@ x64/
 # NuGet restore semaphore
 build/ToolsetPackages/toolsetpackages.semaphore
 
-# NuGet package
-src/Tools/UploadNugetZip/*.zip
+# NuGet
+nuget.exe
 
 # MSTest test Results
 [Tt]est[Rr]esult*/

SymReader.sln

@@ -1,9 +1,9 @@
 
 Microsoft Visual Studio Solution File, Format Version 12.00
-# Visual Studio 14
-VisualStudioVersion = 14.0.25420.1
+# Visual Studio 15
+VisualStudioVersion = 15.0.26021.0
 MinimumVisualStudioVersion = 10.0.40219.1
-Project("{D954291E-2A0B-460D-934E-DC6B0785DB48}") = "Microsoft.DiaSymReader", "src\Microsoft.DiaSymReader\Microsoft.DiaSymReader.shproj", "{F9127F0F-95C8-4576-8081-96E004C1652F}"
+Project("{D954291E-2A0B-460D-934E-DC6B0785DB48}") = "Microsoft.DiaSymReader", "src\Microsoft.DiaSymReader\Shared\Microsoft.DiaSymReader.shproj", "{F9127F0F-95C8-4576-8081-96E004C1652F}"
 EndProject
 Project("{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}") = "Microsoft.DiaSymReader.NetFX20", "src\Microsoft.DiaSymReader\NetFX20\Microsoft.DiaSymReader.NetFX20.csproj", "{FA2C8969-BD1F-457A-A6E3-CA772135FF73}"
 EndProject
@@ -13,9 +13,9 @@ Project("{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}") = "Microsoft.DiaSymReader.Unit
 EndProject
 Global
 	GlobalSection(SharedMSBuildProjectFiles) = preSolution
-		src\Microsoft.DiaSymReader\Microsoft.DiaSymReader.projitems*{316fd2ad-8514-41bd-98d5-61a821f3320e}*SharedItemsImports = 4
-		src\Microsoft.DiaSymReader\Microsoft.DiaSymReader.projitems*{f9127f0f-95c8-4576-8081-96e004c1652f}*SharedItemsImports = 13
-		src\Microsoft.DiaSymReader\Microsoft.DiaSymReader.projitems*{fa2c8969-bd1f-457a-a6e3-ca772135ff73}*SharedItemsImports = 4
+		src\Microsoft.DiaSymReader\Shared\Microsoft.DiaSymReader.projitems*{316fd2ad-8514-41bd-98d5-61a821f3320e}*SharedItemsImports = 4
+		src\Microsoft.DiaSymReader\Shared\Microsoft.DiaSymReader.projitems*{f9127f0f-95c8-4576-8081-96e004c1652f}*SharedItemsImports = 13
+		src\Microsoft.DiaSymReader\Shared\Microsoft.DiaSymReader.projitems*{fa2c8969-bd1f-457a-a6e3-ca772135ff73}*SharedItemsImports = 4
 	EndGlobalSection
 	GlobalSection(SolutionConfigurationPlatforms) = preSolution
 		Debug|Any CPU = Debug|Any CPU

src/Microsoft.DiaSymReader.Tests/Microsoft.DiaSymReader.UnitTests.csproj

@@ -31,6 +31,9 @@
   <ItemGroup>
     <Reference Include="System" />
   </ItemGroup>
+  <ItemGroup>
+    <Service Include="{82A7F48D-3B50-4B1E-B82E-3ADA8210C358}" />
+  </ItemGroup>
   <ImportGroup>
     <Import Project="..\..\build\Targets\Imports.targets" />
     <Import Project="..\..\build\Toolset\XunitProjectRunAction.targets" />

src/Microsoft.DiaSymReader/Shared/Extensions/SymUnmanagedExtensions.Reader.cs

@@ -76,6 +76,18 @@ public static int GetUserEntryPoint(this ISymUnmanagedReader reader)
             return entryPoint;
         }
 
+        public static ISymUnmanagedDocument GetDocument(this ISymUnmanagedReader reader, string name)
+        {
+            if (reader == null)
+            {
+                throw new ArgumentNullException(nameof(reader));
+            }
+
+            ISymUnmanagedDocument document;
+            ThrowExceptionForHR(reader.GetDocument(name, default(Guid), default(Guid), default(Guid), out document));
+            return document;
+        }
+
         public static ISymUnmanagedDocument[] GetDocuments(this ISymUnmanagedReader reader)
         {
             if (reader == null)
@@ -100,7 +112,27 @@ public static ISymUnmanagedMethod[] GetMethodsInDocument(this ISymUnmanagedReade
 
         public static ISymUnmanagedMethod GetMethod(this ISymUnmanagedReader reader, int methodToken)
         {
-            return GetMethodByVersion(reader, methodToken, methodVersion: 1);
+            if (reader == null)
+            {
+                throw new ArgumentNullException(nameof(reader));
+            }
+
+            ISymUnmanagedMethod method;
+            int hr = reader.GetMethod(methodToken, out method);
+            ThrowExceptionForHR(hr);
+
+            if (hr < 0)
+            {
+                // method has no symbol info
+                return null;
+            }
+
+            if (method == null)
+            {
+                throw new InvalidOperationException();
+            }
+
+            return method;
         }
 
         public static ISymUnmanagedMethod GetMethodByVersion(this ISymUnmanagedReader reader, int methodToken, int methodVersion)
@@ -110,7 +142,7 @@ public static ISymUnmanagedMethod GetMethodByVersion(this ISymUnmanagedReader re
                 throw new ArgumentNullException(nameof(reader));
             }
 
-            ISymUnmanagedMethod method = null;
+            ISymUnmanagedMethod method;
             int hr = reader.GetMethodByVersion(methodToken, methodVersion, out method);
             ThrowExceptionForHR(hr);
 
@@ -127,5 +159,17 @@ public static ISymUnmanagedMethod GetMethodByVersion(this ISymUnmanagedReader re
 
             return method;
         }
+
+        public static int GetMethodVersion(this ISymUnmanagedReader reader, ISymUnmanagedMethod method)
+        {
+            if (reader == null)
+            {
+                throw new ArgumentNullException(nameof(reader));
+            }
+
+            int version;
+            ThrowExceptionForHR(reader.GetMethodVersion(method, out version));
+            return version;
+        }
     }
 }

src/Microsoft.DiaSymReader/Shared/ISymUnmanagedEncUpdate.cs

@@ -0,0 +1,53 @@
+// Copyright (c) Microsoft.  All Rights Reserved.  Licensed under the Apache License, Version 2.0.  See License.txt in the project root for license information.
+
+using System;
+using System.Runtime.InteropServices;
+using System.Runtime.InteropServices.ComTypes;
+
+namespace Microsoft.DiaSymReader
+{
+    [ComImport]
+    [Guid("E502D2DD-8671-4338-8F2A-FC08229628C4")]
+    [InterfaceType(ComInterfaceType.InterfaceIsIUnknown)]
+    [ComVisible(false)]
+    public interface ISymUnmanagedEncUpdate
+    {
+        /// <summary>
+        /// Applies EnC edit.
+        /// </summary>
+        [PreserveSig]
+        int UpdateSymbolStore2(
+            IStream stream,
+            [In, MarshalAs(UnmanagedType.LPArray, SizeParamIndex = 2)]SymUnmanagedLineDelta[] lineDeltas,
+            int lineDeltaCount);
+
+        /// <summary>
+        /// Gets the number of local variables of the latest version of the specified method.
+        /// </summary>
+        [PreserveSig]
+        int GetLocalVariableCount(int methodToken, out int count);
+
+        /// <summary>
+        /// Gets local variables of the latest version of the specified method.
+        /// </summary>
+        [PreserveSig]
+        int GetLocalVariables(
+            int methodToken,
+            int bufferLength,
+            [In, Out, MarshalAs(UnmanagedType.LPArray, SizeParamIndex = 1)] ISymUnmanagedVariable[] variables,
+            out int count);
+
+        [PreserveSig]
+        int InitializeForEnc();
+
+        /// <summary>
+        /// Allows updating the line info for a method that has not been recompiled,
+        /// but whose lines have moved independently.  A delta for each statement is allowed.
+        /// </summary>
+        [PreserveSig]
+        int UpdateMethodLines(
+            int methodToken,
+            [In, MarshalAs(UnmanagedType.LPArray, SizeParamIndex = 2)] int[] deltas,
+            int count);
+    }
+}

src/Microsoft.DiaSymReader/Shared/ISymUnmanagedReader4.cs

@@ -185,7 +185,7 @@ public interface ISymUnmanagedReader4 : ISymUnmanagedReader3
         unsafe int GetPortableDebugMetadata(out byte* metadata, out int size);
 
         /// <summary>
-        /// Returns a pointer to Source Server data stored in the PDB.
+        /// Returns a pointer to Source Server data stored in the PDB (source link data for Portable PDB or srcsvr section for Windows PDB).
         /// </summary>
         /// <param name="data">
         /// A pointer to memory where Source Server data start. The memory is owned by the SymReader and 
@@ -194,6 +194,13 @@ public interface ISymUnmanagedReader4 : ISymUnmanagedReader3
         /// Null if the PDB doesn't contain Source Server data.
         /// </param>
         /// <param name="size">Size of the data in bytes.</param>
+        /// <remarks>
+        /// This method is a replacement for <see cref="M:ISymUnmanagedSourceServerModule.GetSourceServerData"/>. 
+        /// The reader doesn't implement <see cref="M:ISymUnmanagedSourceServerModule.GetSourceServerData"/> since 
+        /// the format of the returned data is completely different for Portable PDBs, which the callers wouldn't expect.
+        /// The native diasymreader may implement <see cref="GetSourceServerData(out byte*, out int)"/> by simply calling 
+        /// to <see cref="M:ISymUnmanagedSourceServerModule.GetSourceServerData"/>. 
+        /// </remarks>
         [PreserveSig]
         unsafe int GetSourceServerData(out byte* data, out int size);