Merge pull request #819 from brendanzagaeski/patch-1
[mono.git] / mcs / mcs / location.cs
index 895ffab86ac010cbeca6a065e4b238a1fea64f9d..e7daa53ce0bd98a5f86aeba6f18d632b7f65690f 100644 (file)
 // Author:
 //   Miguel de Icaza
 //   Atsushi Enomoto  <atsushi@ximian.com>
+//   Marek Safar (marek.safar@gmail.com)
 //
 // Copyright 2001 Ximian, Inc.
 // Copyright 2005 Novell, Inc.
 //
 
 using System;
-using System.IO;
-using System.Collections;
+using System.Collections.Generic;
 using Mono.CompilerServices.SymbolWriter;
+using System.Diagnostics;
+using System.Linq;
+
+namespace Mono.CSharp
+{
+       //
+       //  This is one single source file.
+       //
+       public class SourceFile : IEquatable<SourceFile>
+       {
+               //
+               // Used by #line directive to track hidden sequence point
+               // regions
+               //
+               struct LocationRegion : IComparable<LocationRegion>
+               {
+                       public readonly Location Start;
+                       public readonly Location End;
+
+                       public LocationRegion (Location start, Location end)
+                       {
+                               this.Start = start;
+                               this.End = end;
+                       }
+
+                       public int CompareTo (LocationRegion other)
+                       {
+                               if (Start.Row == other.Start.Row)
+                                       return Start.Column.CompareTo (other.Start.Column);
+
+                               return Start.Row.CompareTo (other.Start.Row);
+                       }
+
+                       public override string ToString ()
+                       {
+                               return Start.ToString () + " - " + End.ToString ();
+                       }
+               }
+
+               static readonly byte[] MD5Algorith = { 96, 166, 110, 64, 207, 100, 130, 76, 182, 240, 66, 212, 129, 114, 167, 153 };
 
-namespace Mono.CSharp {
-       /// <summary>
-       ///   This is one single source file.
-       /// </summary>
-       /// <remarks>
-       ///   This is intentionally a class and not a struct since we need
-       ///   to pass this by reference.
-       /// </remarks>
-       public class SourceFile : ISourceFile {
                public readonly string Name;
-               public readonly string Path;
+               public readonly string FullPathName;
                public readonly int Index;
                public bool AutoGenerated;
-               public bool IsIncludeFile;
 
                SourceFileEntry file;
-               byte[] guid, checksum;
+               byte[] algGuid, checksum;
+               List<LocationRegion> hidden_lines;
 
-               public SourceFile (string name, string path, int index, bool is_include)
+               public SourceFile (string name, string path, int index)
                {
                        this.Index = index;
                        this.Name = name;
-                       this.Path = path;
-                       this.IsIncludeFile = is_include;
-               }
-
-               public SourceFileEntry SourceFileEntry {
-                       get { return file; }
+                       this.FullPathName = path;
                }
 
-               SourceFileEntry ISourceFile.Entry {
-                       get { return file; }
+               public byte[] Checksum {
+                       get {
+                               return checksum;
+                       }
                }
 
-               public void SetChecksum (byte[] guid, byte[] checksum)
-               {
-                       this.guid = guid;
-                       this.checksum = checksum;
+               public bool HasChecksum {
+                       get {
+                               return checksum != null;
+                       }
                }
 
-               public virtual void DefineSymbolInfo (MonoSymbolWriter symwriter)
-               {
-                       if (guid != null)
-                               file = symwriter.DefineDocument (Path, guid, checksum);
-                       else {
-                               file = symwriter.DefineDocument (Path);
-                               if (AutoGenerated)
-                                       file.SetAutoGenerated ();
+               public SourceFileEntry SourceFileEntry {
+                       get {
+                               return file;
                        }
                }
 
-               public override string ToString ()
+               public void SetChecksum (byte[] checksum)
                {
-                       return String.Format ("SourceFile ({0}:{1}:{2}:{3})",
-                                             Name, Path, Index, SourceFileEntry);
+                       SetChecksum (MD5Algorith, checksum);
                }
-       }
-
-       public class CompilationUnit : SourceFile, ICompileUnit
-       {
-               CompileUnitEntry comp_unit;
-               Hashtable include_files;
-               Hashtable conditionals;
-
-               public CompilationUnit (string name, string path, int index)
-                       : base (name, path, index, false)
-               { }
 
-               public void AddFile (SourceFile file)
+               public void SetChecksum (byte[] algorithmGuid, byte[] checksum)
                {
-                       if (include_files == null)
-                               include_files = new Hashtable ();
-
-                       if (!include_files.Contains (file.Path))
-                               include_files.Add (file.Path, file);
+                       this.algGuid = algorithmGuid;
+                       this.checksum = checksum;
                }
 
-               public void AddDefine (string value)
+               public SourceFileEntry CreateSymbolInfo (MonoSymbolFile symwriter)
                {
-                       if (conditionals == null)
-                               conditionals = new Hashtable (2);
+                       if (hidden_lines != null)
+                               hidden_lines.Sort ();
+
+                       file = new SourceFileEntry (symwriter, FullPathName, algGuid, checksum);
+                       if (AutoGenerated)
+                               file.SetAutoGenerated ();
 
-                       conditionals [value] = true;
+                       return file;
                }
 
-               public void AddUndefine (string value)
+               public bool Equals (SourceFile other)
                {
-                       if (conditionals == null)
-                               conditionals = new Hashtable (2);
-
-                       conditionals [value] = null;
+                       return FullPathName == other.FullPathName;
                }
 
-               CompileUnitEntry ICompileUnit.Entry {
-                       get { return comp_unit; }
-               }
+               public bool IsHiddenLocation (Location loc)
+               {
+                       if (hidden_lines == null)
+                               return false;
+
+                       int index = hidden_lines.BinarySearch (new LocationRegion (loc, loc));
+                       index = ~index;
+                       if (index > 0) {
+                               var found = hidden_lines[index - 1];
+                               if (loc.Row < found.End.Row)
+                                       return true;
+                       }
 
-               public CompileUnitEntry CompileUnitEntry {
-                       get { return comp_unit; }
+                       return false;
                }
 
-               public override void DefineSymbolInfo (MonoSymbolWriter symwriter)
+               public void RegisterHiddenScope (Location start, Location end)
                {
-                       base.DefineSymbolInfo (symwriter);
-
-                       comp_unit = symwriter.DefineCompilationUnit (SourceFileEntry);
+                       if (hidden_lines == null)
+                               hidden_lines = new List<LocationRegion> ();
 
-                       if (include_files != null) {
-                               foreach (SourceFile include in include_files.Values) {
-                                       include.DefineSymbolInfo (symwriter);
-                                       comp_unit.AddFile (include.SourceFileEntry);
-                               }
-                       }
+                       hidden_lines.Add (new LocationRegion (start, end));
                }
 
-               public bool IsConditionalDefined (string value)
+               public override string ToString ()
                {
-                       if (conditionals != null) {
-                               object res = conditionals [value];
-                               if (res != null)
-                                       return (bool)res;
-                               
-                               // When conditional was undefined
-                               if (conditionals.Contains (value))
-                                       return false;                                   
-                       }
-
-                       return RootContext.IsConditionalDefined (value);
+                       return String.Format ("SourceFile ({0}:{1}:{2})", Name, FullPathName, Index);
                }
        }
 
@@ -161,87 +162,56 @@ namespace Mono.CSharp {
        ///
        ///   http://lists.ximian.com/pipermail/mono-devel-list/2004-December/009508.html
        /// </remarks>
-       public struct Location {
-               int token; 
-
+       public struct Location : IEquatable<Location>
+       {
                struct Checkpoint {
                        public readonly int LineOffset;
-                       public readonly int CompilationUnit;
                        public readonly int File;
 
-                       public Checkpoint (int compile_unit, int file, int line)
+                       public Checkpoint (int file, int line)
                        {
                                File = file;
-                               CompilationUnit = compile_unit;
                                LineOffset = line - (int) (line % (1 << line_delta_bits));
                        }
                }
 
-               static ArrayList source_list;
-               static ArrayList compile_units;
-               static Hashtable source_files;
-               static int checkpoint_bits;
-               static int source_count;
-               static int current_source;
-               static int current_compile_unit;
-               static int line_delta_bits;
-               static int line_delta_mask;
-               static int column_bits;
-               static int column_mask;
+#if FULL_AST
+               readonly long token;
+
+               const int column_bits = 24;
+               const int line_delta_bits = 24;
+#else
+               readonly int token;
+
+               const int column_bits = 8;
+               const int line_delta_bits = 8;
+#endif
+               const int checkpoint_bits = 16;
+
+               const int column_mask = (1 << column_bits) - 1;
+               const int max_column = column_mask;
+
+               static List<SourceFile> source_list;
                static Checkpoint [] checkpoints;
                static int checkpoint_index;
                
-               public readonly static Location Null = new Location (-1);
+               public readonly static Location Null = new Location ();
                public static bool InEmacs;
                
                static Location ()
                {
-                       source_files = new Hashtable ();
-                       source_list = new ArrayList ();
-                       compile_units = new ArrayList ();
-                       current_source = 0;
-                       current_compile_unit = 0;
-                       checkpoints = new Checkpoint [10];
+                       Reset ();
                }
 
                public static void Reset ()
                {
-                       source_files = new Hashtable ();
-                       source_list = new ArrayList ();
-                       compile_units = new ArrayList ();
-                       current_source = 0;
-                       current_compile_unit = 0;
-                       source_count = 0;
+                       source_list = new List<SourceFile> ();
+                       checkpoint_index = 0;
                }
 
-               // <summary>
-               //   This must be called before parsing/tokenizing any files.
-               // </summary>
-               static public void AddFile (string name)
+               public static void AddFile (SourceFile file)
                {
-                       string path = Path.GetFullPath (name);
-
-                       if (source_files.Contains (path)){
-                               int id = (int) source_files [path];
-                               string other_name = ((SourceFile) source_list [id - 1]).Name;
-                               if (name.Equals (other_name))
-                                       Report.Warning (2002, 1, "Source file `{0}' specified multiple times", other_name);
-                               else
-                                       Report.Warning (2002, 1, "Source filenames `{0}' and `{1}' both refer to the same file: {2}", name, other_name, path);
-                               return;
-                       }
-
-                       source_files.Add (path, ++source_count);
-                       CompilationUnit unit = new CompilationUnit (name, path, source_count);
-                       source_list.Add (unit);
-                       compile_units.Add (unit);
-               }
-
-               // IList<CompilationUnit>
-               static public ArrayList SourceFiles {
-                       get {
-                               return compile_units;
-                       }
+                       source_list.Add (file);
                }
 
                // <summary>
@@ -250,80 +220,34 @@ namespace Mono.CSharp {
                //   source file.  We reserve some extra space for files we encounter via #line
                //   directives while parsing.
                // </summary>
-               static public void Initialize ()
-               {
-                       checkpoints = new Checkpoint [source_list.Count * 2];
-                       if (checkpoints.Length > 0)
-                               checkpoints [0] = new Checkpoint (0, 0, 0);
-
-                       column_bits = 8;
-                       column_mask = 0xFF;
-                       line_delta_bits = 8;
-                       line_delta_mask = 0xFF00;
-                       checkpoint_index = 0;
-                       checkpoint_bits = 16;
-               }
-
-               // <remarks>
-               //   This is used when we encounter a #line preprocessing directive.
-               // </remarks>
-               static public SourceFile LookupFile (CompilationUnit comp_unit, string name)
+               static public void Initialize (List<SourceFile> files)
                {
-                       string path;
-                       if (!Path.IsPathRooted (name)) {
-                               string root = Path.GetDirectoryName (comp_unit.Path);
-                               path = Path.Combine (root, name);
-                       } else
-                               path = name;
-
-                       if (!source_files.Contains (path)) {
-                               if (source_count >= (1 << checkpoint_bits))
-                                       return new SourceFile (name, path, 0, true);
+#if NET_4_0 || MOBILE_DYNAMIC
+                       source_list.AddRange (files);
+#else
+                       source_list.AddRange (files.ToArray ());
+#endif
 
-                               source_files.Add (path, ++source_count);
-                               SourceFile retval = new SourceFile (name, path, source_count, true);
-                               source_list.Add (retval);
-                               return retval;
-                       }
-
-                       int index = (int) source_files [path];
-                       return (SourceFile) source_list [index - 1];
-               }
-
-               static public void Push (CompilationUnit compile_unit, SourceFile file)
-               {
-                       current_source = file != null ? file.Index : -1;
-                       current_compile_unit = compile_unit != null ? compile_unit.Index : -1;
-                       // File is always pushed before being changed.
-               }
-
-               // <remarks>
-               //   If we're compiling with debugging support, this is called between parsing
-               //   and code generation to register all the source files with the
-               //   symbol writer.
-               // </remarks>
-               static public void DefineSymbolDocuments (MonoSymbolWriter symwriter)
-               {
-                       foreach (CompilationUnit unit in compile_units)
-                               unit.DefineSymbolInfo (symwriter);
-               }
-               
-               public Location (int row)
-                       : this (row, 0)
-               {
+                       checkpoints = new Checkpoint [System.Math.Max (1, source_list.Count * 2)];
+                       if (checkpoints.Length > 0)
+                               checkpoints [0] = new Checkpoint (0, 0);
                }
 
-               public Location (int row, int column)
+               public Location (SourceFile file, int row, int column)
                {
                        if (row <= 0)
                                token = 0;
                        else {
-                               if (column > 254)
-                                       column = 254;
-                               if (column < 0)
-                                       column = 255;
-                               int target = -1;
-                               int delta = 0;
+                               if (column > max_column)
+                                       column = max_column;
+
+                               long target = -1;
+                               long delta = 0;
+
+                               // TODO: For eval only, need better handling of empty
+                               int file_index = file == null ? 0 : file.Index;
+
+                               // FIXME: This value is certainly wrong but what was the intension
                                int max = checkpoint_index < 10 ?
                                        checkpoint_index : 10;
                                for (int i = 0; i < max; i++) {
@@ -331,40 +255,58 @@ namespace Mono.CSharp {
                                        delta = row - offset;
                                        if (delta >= 0 &&
                                                delta < (1 << line_delta_bits) &&
-                                               checkpoints [checkpoint_index - i].File == current_source) {
+                                               checkpoints[checkpoint_index - i].File == file_index) {
                                                target = checkpoint_index - i;
                                                break;
                                        }
                                }
                                if (target == -1) {
-                                       AddCheckpoint (current_compile_unit, current_source, row);
+                                       AddCheckpoint (file_index, row);
                                        target = checkpoint_index;
                                        delta = row % (1 << line_delta_bits);
                                }
+
                                long l = column +
-                                       (long) (delta << column_bits) +
-                                       (long) (target << (line_delta_bits + column_bits));
+                                       (delta << column_bits) +
+                                       (target << (line_delta_bits + column_bits));
+#if FULL_AST
+                               token = l;
+#else
                                token = l > 0xFFFFFFFF ? 0 : (int) l;
+#endif
                        }
                }
 
-               static void AddCheckpoint (int compile_unit, int file, int row)
+               public static Location operator - (Location loc, int columns)
+               {
+                       return new Location (loc.SourceFile, loc.Row, loc.Column - columns);
+               }
+
+               static void AddCheckpoint (int file, int row)
                {
                        if (checkpoints.Length == ++checkpoint_index) {
-                               Checkpoint [] tmp = new Checkpoint [checkpoint_index * 2];
-                               Array.Copy (checkpoints, tmp, checkpoints.Length);
-                               checkpoints = tmp;
+                               Array.Resize (ref checkpoints, checkpoint_index * 2);
                        }
-                       checkpoints [checkpoint_index] = new Checkpoint (compile_unit, file, row);
+                       checkpoints [checkpoint_index] = new Checkpoint (file, row);
+               }
+
+               string FormatLocation (string fileName)
+               {
+                       if (column_bits == 0 || InEmacs)
+                               return fileName + "(" + Row.ToString () + "):";
+
+                       return fileName + "(" + Row.ToString () + "," + Column.ToString () +
+                               (Column == max_column ? "+):" : "):");
                }
                
                public override string ToString ()
                {
-                       if (column_bits == 0 || InEmacs)
-                               return Name + "(" + Row.ToString () + "):";
-                       else
-                               return Name + "(" + Row.ToString () + "," + Column.ToString () +
-                                       (Column == column_mask ? "+):" : "):");
+                       return FormatLocation (Name);
+               }
+
+               public string ToStringFullName ()
+               {
+                       return FormatLocation (NameFullPath);
                }
                
                /// <summary>
@@ -377,47 +319,48 @@ namespace Mono.CSharp {
                public string Name {
                        get {
                                int index = File;
-                               if (token == 0 || index == 0)
-                                       return "Internal";
+                               if (token == 0 || index <= 0)
+                                       return null;
 
-                               SourceFile file = (SourceFile) source_list [index - 1];
+                               SourceFile file = source_list [index - 1];
                                return file.Name;
                        }
                }
 
-               int CheckpointIndex {
-                       get { return (int) ((token & 0xFFFF0000) >> (line_delta_bits + column_bits)); }
+               public string NameFullPath {
+                       get {
+                               int index = File;
+                               if (token == 0 || index <= 0)
+                                       return null;
+
+                               return source_list[index - 1].FullPathName;
+                       }
                }
 
-               public int Row {
+               int CheckpointIndex {
                        get {
-                               if (token == 0)
-                                       return 1;
-                               return checkpoints [CheckpointIndex].LineOffset + ((token & line_delta_mask) >> column_bits);
+                               const int checkpoint_mask = (1 << checkpoint_bits) - 1;
+                               return ((int) (token >> (line_delta_bits + column_bits))) & checkpoint_mask;
                        }
                }
 
-               public int Column {
+               public int Row {
                        get {
                                if (token == 0)
                                        return 1;
-                               int col = (int) (token & column_mask);
-                               return col == 255 ? 1 : col;
-                       }
-               }
 
-               public bool Hidden {
-                       get {
-                               return (int) (token & column_mask) == 255;
+                               int offset = checkpoints[CheckpointIndex].LineOffset;
+
+                               const int line_delta_mask = (1 << column_bits) - 1;
+                               return offset + (((int)(token >> column_bits)) & line_delta_mask);
                        }
                }
 
-               public int CompilationUnitIndex {
+               public int Column {
                        get {
                                if (token == 0)
-                                       return 0;
-if (checkpoints.Length <= CheckpointIndex) throw new Exception (String.Format ("Should not happen. Token is {0:X04}, checkpoints are {1}, index is {2}", token, checkpoints.Length, CheckpointIndex));
-                               return checkpoints [CheckpointIndex].CompilationUnit;
+                                       return 1;
+                               return (int) (token & column_mask);
                        }
                }
 
@@ -447,34 +390,176 @@ if (checkpoints.Length <= CheckpointIndex) throw new Exception (String.Format ("
                                int index = File;
                                if (index == 0)
                                        return null;
-                               return (SourceFile) source_list [index - 1];
+                               return source_list [index - 1];
                        }
                }
 
-               public CompilationUnit CompilationUnit {
-                       get {
-                               int index = CompilationUnitIndex;
-                               if (index == 0)
-                                       return null;
-                               return (CompilationUnit) source_list [index - 1];
-                       }
+               #region IEquatable<Location> Members
+
+               public bool Equals (Location other)
+               {
+                       return this.token == other.token;
                }
+
+               #endregion
        }
 
-       public class LocatedToken
+       //
+       // A bag of additional locations to support full ast tree
+       //
+       public class LocationsBag
        {
-               public readonly Location Location;
-               public readonly string Value;
+               public class MemberLocations
+               {
+                       public readonly IList<Tuple<Modifiers, Location>> Modifiers;
+                       List<Location> locations;
+
+                       public MemberLocations (IList<Tuple<Modifiers, Location>> mods)
+                       {
+                               Modifiers = mods;
+                       }
+
+                       public MemberLocations (IList<Tuple<Modifiers, Location>> mods, Location loc)
+                               : this (mods)
+                       {
+                               AddLocations (loc);
+                       }
+
+                       public MemberLocations (IList<Tuple<Modifiers, Location>> mods, Location[] locs)
+                               : this (mods)
+                       {
+                               AddLocations (locs);
+                       }
+
+                       public MemberLocations (IList<Tuple<Modifiers, Location>> mods, List<Location> locs)
+                               : this (mods)
+                       {
+                               locations = locs;
+                       }
+
+                       #region Properties
+
+                       public Location this [int index] {
+                               get {
+                                       return locations [index];
+                               }
+                       }
+                       
+                       public int Count {
+                               get {
+                                       return locations.Count;
+                               }
+                       }
+
+                       #endregion
+
+                       public void AddLocations (Location loc)
+                       {
+                               if (locations == null) {
+                                       locations = new List<Location> ();
+                               }
+
+                               locations.Add (loc);
+                       }
+
+                       public void AddLocations (params Location[] additional)
+                       {
+                               if (locations == null) {
+                                       locations = new List<Location> (additional);
+                               } else {
+                                       locations.AddRange (additional);
+                               }
+                       }
+               }
 
-               public LocatedToken (Location loc, string value)
+               Dictionary<object, List<Location>> simple_locs = new Dictionary<object, List<Location>> (ReferenceEquality<object>.Default);
+               Dictionary<MemberCore, MemberLocations> member_locs = new Dictionary<MemberCore, MemberLocations> (ReferenceEquality<MemberCore>.Default);
+
+               [Conditional ("FULL_AST")]
+               public void AddLocation (object element, params Location[] locations)
                {
-                       Location = loc;
-                       Value = value;
+                       simple_locs.Add (element, new List<Location> (locations));
                }
 
-               public override string ToString ()
+               [Conditional ("FULL_AST")]
+               public void InsertLocation (object element, int index, Location location)
+               {
+                       List<Location> found;
+                       if (!simple_locs.TryGetValue (element, out found)) {
+                               found = new List<Location> ();
+                               simple_locs.Add (element, found);
+                       }
+
+                       found.Insert (index, location);
+               }
+
+               [Conditional ("FULL_AST")]
+               public void AddStatement (object element, params Location[] locations)
+               {
+                       if (locations.Length == 0)
+                               throw new ArgumentException ("Statement is missing semicolon location");
+
+                       AddLocation (element, locations);
+               }
+
+               [Conditional ("FULL_AST")]
+               public void AddMember (MemberCore member, IList<Tuple<Modifiers, Location>> modLocations)
+               {
+                       member_locs.Add (member, new MemberLocations (modLocations));
+               }
+
+               [Conditional ("FULL_AST")]
+               public void AddMember (MemberCore member, IList<Tuple<Modifiers, Location>> modLocations, Location location)
+               {
+                       member_locs.Add (member, new MemberLocations (modLocations, location));
+               }
+
+               [Conditional ("FULL_AST")]
+               public void AddMember (MemberCore member, IList<Tuple<Modifiers, Location>> modLocations, params Location[] locations)
+               {
+                       member_locs.Add (member, new MemberLocations (modLocations, locations));
+               }
+
+               [Conditional ("FULL_AST")]
+               public void AddMember (MemberCore member, IList<Tuple<Modifiers, Location>> modLocations, List<Location> locations)
+               {
+                       member_locs.Add (member, new MemberLocations (modLocations, locations));
+               }
+
+               [Conditional ("FULL_AST")]
+               public void AppendTo (object element, Location location)
+               {
+                       List<Location> found;
+                       if (!simple_locs.TryGetValue (element, out found)) {
+                               found = new List<Location> ();
+                               simple_locs.Add (element, found);
+                       }
+
+                       found.Add (location);
+               }
+
+               [Conditional ("FULL_AST")]
+               public void AppendToMember (MemberCore existing, params Location[] locations)
+               {
+                       MemberLocations member;
+                       if (member_locs.TryGetValue (existing, out member)) {
+                               member.AddLocations (locations);
+                               return;
+                       }
+               }
+
+               public List<Location> GetLocations (object element)
+               {
+                       List<Location> found;
+                       simple_locs.TryGetValue (element, out found);
+                       return found;
+               }
+
+               public MemberLocations GetMemberLocation (MemberCore element)
                {
-                       return Location.ToString () + Value;
+                       MemberLocations found;
+                       member_locs.TryGetValue (element, out found);
+                       return found;
                }
        }
 }