// Copyright (c) AlphaSierraPapa for the SharpDevelop Team (for details please see \doc\copyright.txt) // This code is distributed under MIT X11 license (for details please see \doc\license.txt) using System; using System.Collections.Concurrent; using System.Collections.Generic; using System.Linq; using ICSharpCode.Decompiler.Ast; using ICSharpCode.Decompiler.Disassembler; using ICSharpCode.Decompiler.ILAst; using Mono.Cecil; namespace ICSharpCode.Decompiler { public enum DecompiledLanguages { IL, CSharp } /// /// Maps the source code to IL. /// public class SourceCodeMapping { /// /// Gets or sets the source code line number in the output. /// public int SourceCodeLine { get; set; } /// /// Gets or sets IL Range offset for the source code line. E.g.: 13-19 <-> 135. /// public ILRange ILInstructionOffset { get; set; } /// /// Gets or sets the member mapping this source code mapping belongs to. /// public MemberMapping MemberMapping { get; set; } /// /// Retrieves the array that contains the IL range and the missing gaps between ranges. /// /// The array representation of the step aranges. public int[] ToArray(bool isMatch) { var currentList = new List(); // add list for the current source code line currentList.AddRange(ILRange.OrderAndJoint(MemberMapping.MemberCodeMappings .FindAll(m => m.SourceCodeLine == this.SourceCodeLine) .ConvertAll(m => m.ILInstructionOffset))); if (!isMatch) { // add inverted currentList.AddRange(MemberMapping.InvertedList); } else { // if the current list contains the last mapping, add also the last gap if (currentList.Count == 1) currentList.Add(MemberMapping.InvertedList.LastOrDefault()); } // set the output var resultList = new List(); foreach (var element in ILRange.OrderAndJoint(currentList)) { resultList.Add(element.From); resultList.Add(element.To); } return resultList.ToArray(); } } /// /// Stores the method information and its source code mappings. /// public sealed class MemberMapping { IEnumerable invertedList; /// /// Gets or sets the type of the mapping. /// public TypeDefinition Type { get; set; } /// /// Metadata token of the method. /// public uint MetadataToken { get; set; } /// /// Gets or sets the code size for the member mapping. /// public int CodeSize { get; set; } /// /// Gets or sets the source code mappings. /// public List MemberCodeMappings { get; set; } /// /// Gets the inverted IL Ranges.
/// E.g.: for (0-9, 11-14, 14-18, 21-25) => (9-11,18-21). ///
/// IL Range inverted list. public IEnumerable InvertedList { get { if (invertedList == null) { var list = MemberCodeMappings.ConvertAll( s => new ILRange { From = s.ILInstructionOffset.From, To = s.ILInstructionOffset.To }); invertedList = ILRange.OrderAndJoint(ILRange.Invert(list, CodeSize)); } return invertedList; } } } public static class CodeMappings { public static ConcurrentDictionary> GetStorage(DecompiledLanguages language) { ConcurrentDictionary> storage = null; switch (language) { case DecompiledLanguages.IL: storage = ILCodeMapping.SourceCodeMappings; break; case DecompiledLanguages.CSharp: storage = CSharpCodeMapping.SourceCodeMappings; break; default: throw new System.Exception("Invalid value for DecompiledLanguages"); } return storage; } /// /// Create code mapping for a method. /// /// Method to create the mapping for. /// Source code mapping storage. public static MemberMapping CreateCodeMapping( this MethodDefinition member, ConcurrentDictionary> codeMappings) { if (member == null || !member.HasBody) return null; if (codeMappings == null) throw new ArgumentNullException("CodeMappings storage must be valid!"); // create IL/CSharp code mappings - used in debugger MemberMapping currentMemberMapping = null; if (codeMappings.ContainsKey(member.DeclaringType.FullName)) { var mapping = codeMappings[member.DeclaringType.FullName]; if (mapping.Find(map => (int)map.MetadataToken == member.MetadataToken.ToInt32()) == null) { currentMemberMapping = new MemberMapping() { MetadataToken = (uint)member.MetadataToken.ToInt32(), Type = member.DeclaringType.Resolve(), MemberCodeMappings = new List(), CodeSize = member.Body.CodeSize }; mapping.Add(currentMemberMapping); } } return currentMemberMapping; } /// /// Gets source code mapping and metadata token based on type name and line number. /// /// Code mappings storage. /// Type name. /// Line number. /// Metadata token. /// public static SourceCodeMapping GetInstructionByTypeAndLine( this ConcurrentDictionary> codeMappings, string typeName, int lineNumber, out uint metadataToken) { if (codeMappings == null) throw new ArgumentNullException("CodeMappings storage must be valid!"); if (!codeMappings.ContainsKey(typeName)) { metadataToken = 0; return null; } if (lineNumber <= 0) { metadataToken = 0; return null; } var methodMappings = codeMappings[typeName]; foreach (var maping in methodMappings) { var map = maping.MemberCodeMappings.Find(m => m.SourceCodeLine == lineNumber); if (map != null) { metadataToken = maping.MetadataToken; return map; } } metadataToken = 0; return null; } public static SourceCodeMapping GetInstructionByTypeAndLine( this ConcurrentDictionary> codeMappings, string typeName, uint token, int ilOffset, out bool isMatch) { isMatch = false; if (codeMappings == null) throw new ArgumentNullException("CodeMappings storage must be valid!"); if (!codeMappings.ContainsKey(typeName)) { return null; } var methodMappings = codeMappings[typeName]; var maping = methodMappings.Find(m => m.MetadataToken == token); // try find an exact match var map = maping.MemberCodeMappings.Find(m => m.ILInstructionOffset.From <= ilOffset && ilOffset < m.ILInstructionOffset.To); if (map == null) { // get the immediate next one map = maping.MemberCodeMappings.Find(m => m.ILInstructionOffset.From >= ilOffset); isMatch = false; if (map == null) map = maping.MemberCodeMappings.LastOrDefault(); // get the last return map; } isMatch = true; return map; } /// /// Gets the source code and type name from metadata token and offset. /// /// Code mappings storage. /// Metadata token. /// IL offset. /// Type definition. /// Line number. public static bool GetSourceCodeFromMetadataTokenAndOffset( this ConcurrentDictionary> codeMappings, uint token, int ilOffset, out TypeDefinition type, out int line) { type = null; line = 0; foreach (var typename in codeMappings.Keys) { var mapping = codeMappings[typename].Find(m => m.MetadataToken == token); if (mapping == null) continue; var codeMapping = mapping.MemberCodeMappings.Find( cm => cm.ILInstructionOffset.From <= ilOffset && ilOffset <= cm.ILInstructionOffset.To - 1); if (codeMapping == null) { codeMapping = mapping.MemberCodeMappings.Find(cm => (cm.ILInstructionOffset.From >= ilOffset)); if (codeMapping == null) { codeMapping = mapping.MemberCodeMappings.LastOrDefault(); if (codeMapping == null) continue; } } type = mapping.Type; line = codeMapping.SourceCodeLine; return true; } return false; } } }