source: trunk/HeuristicLab.ExtLibs/HeuristicLab.NRefactory/5.5.0/NRefactory.CSharp-5.5.0/Parser/mcs/location.cs @ 16240

//
// location.cs: Keeps track of the location of source code entity
//
// 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.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 };

    public readonly string Name;
    public readonly string FullPathName;
    public readonly int Index;
    public bool AutoGenerated;

    SourceFileEntry file;
    byte[] algGuid, checksum;
    List<LocationRegion> hidden_lines;

    public SourceFile (string name, string path, int index)
    {
      this.Index = index;
      this.Name = name;
      this.FullPathName = path;
    }

    public byte[] Checksum {
      get {
        return checksum;
      }
    }

    public bool HasChecksum {
      get {
        return checksum != null;
      }
    }

    public SourceFileEntry SourceFileEntry {
      get {
        return file;
      }
    }

    public void SetChecksum (byte[] checksum)
    {
      SetChecksum (MD5Algorith, checksum);
    }

    public void SetChecksum (byte[] algorithmGuid, byte[] checksum)
    {
      this.algGuid = algorithmGuid;
      this.checksum = checksum;
    }

    public SourceFileEntry CreateSymbolInfo (MonoSymbolFile symwriter)
    {
      if (hidden_lines != null)
        hidden_lines.Sort ();

      file = new SourceFileEntry (symwriter, FullPathName, algGuid, checksum);
      if (AutoGenerated)
        file.SetAutoGenerated ();

      return file;
    }

    public bool Equals (SourceFile other)
    {
      return FullPathName == other.FullPathName;
    }

    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;
      }

      return false;
    }

    public void RegisterHiddenScope (Location start, Location end)
    {
      if (hidden_lines == null)
        hidden_lines = new List<LocationRegion> ();

      hidden_lines.Add (new LocationRegion (start, end));
    }

    public override string ToString ()
    {
      return String.Format ("SourceFile ({0}:{1}:{2})", Name, FullPathName, Index);
    }
  }

  /// <summary>
  ///   Keeps track of the location in the program
  /// </summary>
  ///
  /// <remarks>
  ///   This uses a compact representation and a couple of auxiliary
  ///   structures to keep track of tokens to (file,line and column) 
  ///   mappings. The usage of the bits is:
  ///   
  ///     - 16 bits for "checkpoint" which is a mixed concept of
  ///       file and "line segment"
  ///     - 8 bits for line delta (offset) from the line segment
  ///     - 8 bits for column number.
  ///
  ///   http://lists.ximian.com/pipermail/mono-devel-list/2004-December/009508.html
  /// </remarks>
  public struct Location : IEquatable<Location>
  {
    struct Checkpoint {
      public readonly int LineOffset;
      public readonly int File;

      public Checkpoint (int file, int line)
      {
        File = file;
        LineOffset = line - (int) (line % (1 << line_delta_bits));
      }
    }

#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 ();
    public static bool InEmacs;
    
    static Location ()
    {
      Reset ();
    }

    public static void Reset ()
    {
      source_list = new List<SourceFile> ();
      checkpoint_index = 0;
    }

    public static void AddFile (SourceFile file)
    {
      source_list.Add (file);
    }

    // <summary>
    //   After adding all source files we want to compile with AddFile(), this method
    //   must be called to `reserve' an appropriate number of bits in the token for the
    //   source file.  We reserve some extra space for files we encounter via #line
    //   directives while parsing.
    // </summary>
    static public void Initialize (List<SourceFile> files)
    {
#if NET_4_0 || MOBILE_DYNAMIC
      source_list.AddRange (files);
#else
      source_list.AddRange (files.ToArray ());
#endif

      checkpoints = new Checkpoint [System.Math.Max (1, source_list.Count * 2)];
      if (checkpoints.Length > 0)
        checkpoints [0] = new Checkpoint (0, 0);
    }

    public Location (SourceFile file, int row, int column)
    {
      if (row <= 0)
        token = 0;
      else {
        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++) {
          int offset = checkpoints [checkpoint_index - i].LineOffset;
          delta = row - offset;
          if (delta >= 0 &&
            delta < (1 << line_delta_bits) &&
            checkpoints[checkpoint_index - i].File == file_index) {
            target = checkpoint_index - i;
            break;
          }
        }
        if (target == -1) {
          AddCheckpoint (file_index, row);
          target = checkpoint_index;
          delta = row % (1 << line_delta_bits);
        }

        long l = column +
          (delta << column_bits) +
          (target << (line_delta_bits + column_bits));
#if FULL_AST
        token = l;
#else
        token = l > 0xFFFFFFFF ? 0 : (int) l;
#endif
      }
    }

    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) {
        Array.Resize (ref checkpoints, checkpoint_index * 2);
      }
      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 ()
    {
      return FormatLocation (Name);
    }

    public string ToStringFullName ()
    {
      return FormatLocation (NameFullPath);
    }
    
    /// <summary>
    ///   Whether the Location is Null
    /// </summary>
    public bool IsNull {
      get { return token == 0; }
    }

    public string Name {
      get {
        int index = File;

        if (token == 0 || index <= 0)
          return null;

        SourceFile file = source_list [index - 1];
        return file.Name;
      }
    }

    public string NameFullPath {
      get {
        int index = File;
        if (token == 0 || index <= 0)
          return null;

        return source_list[index - 1].FullPathName;
      }
    }

    int CheckpointIndex {
      get {
        const int checkpoint_mask = (1 << checkpoint_bits) - 1;
        return ((int) (token >> (line_delta_bits + column_bits))) & checkpoint_mask;
      }
    }

    public int Row {
      get {
        if (token == 0)
          return 1;

        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 Column {
      get {
        if (token == 0)
          return 1;
        return (int) (token & column_mask);
      }
    }

    public int File {
      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].File;
      }
    }

    // The ISymbolDocumentWriter interface is used by the symbol writer to
    // describe a single source file - for each source file there's exactly
    // one corresponding ISymbolDocumentWriter instance.
    //
    // This class has an internal hash table mapping source document names
    // to such ISymbolDocumentWriter instances - so there's exactly one
    // instance per document.
    //
    // This property returns the ISymbolDocumentWriter instance which belongs
    // to the location's source file.
    //
    // If we don't have a symbol writer, this property is always null.
    public SourceFile SourceFile {
      get {
        int index = File;
        if (index == 0)
          return null;
        return source_list [index - 1];
      }
    }

    #region IEquatable<Location> Members

    public bool Equals (Location other)
    {
      return this.token == other.token;
    }

    #endregion
  }
  
  public class SpecialsBag
  {
    public enum CommentType
    {
      Single,
      Multi,
      Documentation,
      InactiveCode
    }

    public bool Suppress {
      get;
      set;
    }

    public class SpecialVisitor
    {
      public virtual void Visit (Comment comment)
      {
      }
      public virtual void Visit (NewLineToken newLineToken)
      {
      }
      public virtual void Visit (PreProcessorDirective preProcessorDirective)
      {
      }
    }
    public abstract class SpecialBase
    {
      public abstract void Accept (SpecialVisitor visitor);
    }
    
    public class Comment : SpecialBase
    {
      public readonly CommentType CommentType;
      public readonly bool StartsLine;
      public readonly int Line;
      public readonly int Col;
      public readonly int EndLine;
      public readonly int EndCol;
      public readonly string Content;
      
      public Comment (CommentType commentType, bool startsLine, int line, int col, int endLine, int endCol, string content)
      {
        this.CommentType = commentType;
        this.StartsLine = startsLine;
        this.Line = line;
        this.Col = col;
        this.EndLine = endLine;
        this.EndCol = endCol;
        this.Content = content;
      }

      public override string ToString ()
      {
        return string.Format ("[Comment: CommentType={0}, Line={1}, Col={2}, EndLine={3}, EndCol={4}, Content={5}]", CommentType, Line, Col, EndLine, EndCol, Content);
      }

      public override void Accept (SpecialVisitor visitor)
      {
        visitor.Visit (this);
      }
    }

    public class NewLineToken : SpecialBase
    {
      public readonly int Line;
      public readonly int Col;
      public readonly NewLine NewLine;

      public NewLineToken (int line, int col, NewLine newLine)
      {
        this.Line = line;
        this.Col = col;
        this.NewLine = newLine;
      }

      public override void Accept (SpecialVisitor visitor)
      {
        visitor.Visit (this);
      }
    }

    public class PragmaPreProcessorDirective : PreProcessorDirective
    {
      public bool Disalbe { get; set; }

      public int WarningColumn {
        get;
        set;
      }

      public int DisableRestoreColumn {
        get;
        set;
      }

      public List<Constant> Codes = new List<Constant> ();

      public PragmaPreProcessorDirective (int line, int col, int endLine, int endCol, Tokenizer.PreprocessorDirective cmd, string arg) : base (line, col, endLine, endCol, cmd, arg)
      {
      }
    }

    public class LineProcessorDirective : PreProcessorDirective
    {
      public int LineNumber { get; set; }
      public string FileName { get; set; }

      public LineProcessorDirective (int line, int col, int endLine, int endCol, Tokenizer.PreprocessorDirective cmd, string arg) : base (line, col, endLine, endCol, cmd, arg)
      {
      }
    }

    public class PreProcessorDirective : SpecialBase
    {
      public readonly int Line;
      public readonly int Col;
      public readonly int EndLine;
      public readonly int EndCol;

      public readonly Tokenizer.PreprocessorDirective Cmd;
      public readonly string Arg;
      
      public bool Take = true;
      
      public PreProcessorDirective (int line, int col, int endLine, int endCol, Tokenizer.PreprocessorDirective cmd, string arg)
      {
        this.Line = line;
        this.Col = col;
        this.EndLine = endLine;
        this.EndCol = endCol;
        this.Cmd = cmd;
        this.Arg = arg;
      }
      
      public override void Accept (SpecialVisitor visitor)
      {
        visitor.Visit (this);
      }

      public override string ToString ()
      {
        return string.Format ("[PreProcessorDirective: Line={0}, Col={1}, EndLine={2}, EndCol={3}, Cmd={4}, Arg={5}]", Line, Col, EndLine, EndCol, Cmd, Arg);
      }
    }
    
    public readonly List<SpecialBase> Specials = new List<SpecialBase> ();
    
    CommentType curComment;
    bool startsLine;
    int startLine, startCol;
    System.Text.StringBuilder contentBuilder = new System.Text.StringBuilder ();
    
    [Conditional ("FULL_AST")]
    public void StartComment (CommentType type, bool startsLine, int startLine, int startCol)
    {
      if (Suppress)
        return;
      inComment = true;
      curComment = type;
      this.startsLine = startsLine;
      this.startLine = startLine;
      this.startCol = startCol;
      contentBuilder.Length = 0;
    }
    
    [Conditional ("FULL_AST")]
    public void PushCommentChar (int ch)
    {
      if (Suppress)
        return;
      if (ch < 0)
        return;
      contentBuilder.Append ((char)ch);
    }
    [Conditional ("FULL_AST")]
    public void PushCommentString (string str)
    {
      if (Suppress)
        return;
      contentBuilder.Append (str);
    }
    
    bool inComment;
    [Conditional ("FULL_AST")]
    public void EndComment (int endLine, int endColumn)
    {
      if (Suppress)
        return;
      if (!inComment)
        return;
      inComment = false;
      // Ignore empty comments
      if (startLine == endLine && startCol == endColumn)
        return;
      Specials.Add (new Comment (curComment, startsLine, startLine, startCol, endLine, endColumn, contentBuilder.ToString ()));
    }
    
    [Conditional ("FULL_AST")]
    public void AddPreProcessorDirective (int startLine, int startCol, int endLine, int endColumn, Tokenizer.PreprocessorDirective cmd, string arg)
    {
      if (Suppress)
        return;
      if (inComment)
        EndComment (startLine, startCol);
      switch (cmd) {
      case Tokenizer.PreprocessorDirective.Pragma:
        Specials.Add (new PragmaPreProcessorDirective (startLine, startCol, endLine, endColumn, cmd, arg));
        break;
      case Tokenizer.PreprocessorDirective.Line:
        Specials.Add (new LineProcessorDirective (startLine, startCol, endLine, endColumn, cmd, arg));
        break;
      default:
        Specials.Add (new PreProcessorDirective (startLine, startCol, endLine, endColumn, cmd, arg));
        break;
      }
    }

    #if FULL_AST
    public PragmaPreProcessorDirective SetPragmaDisable(bool disable)
    {
      if (Suppress)
        return null;
      var pragmaDirective = Specials [Specials.Count - 1] as PragmaPreProcessorDirective;
      if (pragmaDirective == null)
        return null;
      pragmaDirective.Disalbe = disable;
      return pragmaDirective;
    }
    #endif

    public PragmaPreProcessorDirective GetPragmaPreProcessorDirective()
    {
      if (Suppress)
        return null;
      return Specials [Specials.Count - 1] as PragmaPreProcessorDirective;
    }


    public LineProcessorDirective GetCurrentLineProcessorDirective()
    {
      if (Suppress)
        return null;
      return Specials [Specials.Count - 1] as LineProcessorDirective;
    }

    public enum NewLine { Unix, Windows }

    int lastNewLine = -1;
    int lastNewCol = -1;
    [Conditional ("FULL_AST")]
    public void AddNewLine (int line, int col, NewLine newLine)
    {
      if (Suppress)
        return;
      if (line == lastNewLine && col == lastNewCol)
        return;
      lastNewLine = line;
      lastNewCol = col;
      Specials.Add (new NewLineToken (line, col, newLine));
    }

    public void SkipIf ()
    {
      if (Specials.Count > 0) {
        var directive = Specials[Specials.Count - 1] as PreProcessorDirective;
        if (directive != null)
          directive.Take = false;
      }
    }
  }

  //
  // A bag of additional locations to support full ast tree
  //
  public class LocationsBag
  {
    public class MemberLocations
    {
      public IList<Tuple<Modifiers, Location>> Modifiers { get; internal set; }
      List<Location> locations;
      
      public MemberLocations (IList<Tuple<Modifiers, Location>> mods, IEnumerable<Location> locs)
      {
        Modifiers = mods;
        locations = locs != null ?  new List<Location> (locs) : null;
/*
      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 != null ? locations.Count : 0;
        }
      }

      #endregion

      public void AddLocations (Location loc)
      {
        if (locations == null) {
          locations = new List<Location> ();
        }

        locations.Add (loc);
      }

      public void AddLocations (params Location[] additional)

      {

        AddLocations ((IEnumerable<Location>)additional);

      }
      public void AddLocations (IEnumerable<Location> additional)
      {
        if (additional == null)
          return;
        if (locations == null) {
          locations = new List<Location> (additional);
        } else {
          locations.AddRange (additional);
        }
      }
    }
    
    public MemberCore LastMember {
      get;
      private set;
    }

    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)
    {
      AddLocation (element, (IEnumerable<Location>)locations);
    }

    [Conditional ("FULL_AST")]
    public void AddLocation (object element, IEnumerable<Location> locations)
    {
      if (element == null || locations == null)
        return;
      List<Location> found;
      if (!simple_locs.TryGetValue (element, out found)) {
        simple_locs.Add (element, new List<Location> (locations));
        return;
      }
      found.AddRange(locations);
    }

    [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 (element == null)
        return;
      if (locations.Length == 0)
        throw new ArgumentException ("Statement is missing semicolon location");
      simple_locs.Add (element, new List<Location>(locations));
    }

    [Conditional ("FULL_AST")]
    public void AddMember (MemberCore member, IList<Tuple<Modifiers, Location>> modLocations, params Location[] locations)
    {
      LastMember = member;
      if (member == null)
        return;
      
      MemberLocations existing;
      if (member_locs.TryGetValue (member, out existing)) {
        existing.Modifiers = modLocations;
        existing.AddLocations (locations);
        return;
      }
      member_locs.Add (member, new MemberLocations (modLocations, locations));
    }

    [Conditional ("FULL_AST")]
    public void AddMember (MemberCore member, IList<Tuple<Modifiers, Location>> modLocations, IEnumerable<Location> locations)
    {
      LastMember = member;
      if (member == null)
        return;
      
      MemberLocations existing;
      if (member_locs.TryGetValue (member, out existing)) {
        existing.Modifiers = modLocations;
        existing.AddLocations (locations);
        return;
      }
      member_locs.Add (member, new MemberLocations (modLocations, locations));
    }

    [Conditional ("FULL_AST")]
    public void AppendToMember (MemberCore existing, params Location[] locations)
    {
      AppendToMember (existing, (IEnumerable<Location>)locations);

    }
    
    [Conditional ("FULL_AST")]
    public void AppendToMember (MemberCore existing, IEnumerable<Location> locations)
    {
      if (existing == null)
        return;
      MemberLocations member;
      if (member_locs.TryGetValue (existing, out member)) {
        member.AddLocations (locations);
        return;
      }
      member_locs.Add (existing, new MemberLocations (null, locations));
    }

    public List<Location> GetLocations (object element)
    {
      if (element == null)
        return null;
      List<Location> found;
      simple_locs.TryGetValue (element, out found);
      return found;
    }

    public MemberLocations GetMemberLocation (MemberCore element)
    {
      MemberLocations found;
      member_locs.TryGetValue (element, out found);
      return found;
    }
  }
}