2 // location.cs: Keeps track of the location of source code entity
6 // Atsushi Enomoto <atsushi@ximian.com>
7 // Marek Safar (marek.safar@gmail.com)
9 // Copyright 2001 Ximian, Inc.
10 // Copyright 2005 Novell, Inc.
15 using System.Collections.Generic;
16 using Mono.CompilerServices.SymbolWriter;
17 using System.Diagnostics;
20 namespace Mono.CSharp {
22 /// This is one single source file.
25 /// This is intentionally a class and not a struct since we need
26 /// to pass this by reference.
28 public class SourceFile : ISourceFile {
29 public readonly string Name;
30 public readonly string Path;
31 public readonly int Index;
32 public bool AutoGenerated;
33 public bool IsIncludeFile;
36 byte[] guid, checksum;
38 public SourceFile (string name, string path, int index, bool is_include)
43 this.IsIncludeFile = is_include;
46 public SourceFileEntry SourceFileEntry {
50 SourceFileEntry ISourceFile.Entry {
54 public void SetChecksum (byte[] guid, byte[] checksum)
57 this.checksum = checksum;
60 public virtual void DefineSymbolInfo (MonoSymbolWriter symwriter)
63 file = symwriter.DefineDocument (Path, guid, checksum);
65 file = symwriter.DefineDocument (Path);
67 file.SetAutoGenerated ();
71 public override string ToString ()
73 return String.Format ("SourceFile ({0}:{1}:{2}:{3})",
74 Name, Path, Index, SourceFileEntry);
78 public class CompilationUnit : SourceFile, ICompileUnit
80 CompileUnitEntry comp_unit;
81 Dictionary<string, SourceFile> include_files;
82 Dictionary<string, bool> conditionals;
84 public CompilationUnit (string name, string path, int index)
85 : base (name, path, index, false)
88 public void AddFile (SourceFile file)
93 if (include_files == null)
94 include_files = new Dictionary<string, SourceFile> ();
96 if (!include_files.ContainsKey (file.Path))
97 include_files.Add (file.Path, file);
100 public void AddDefine (string value)
102 if (conditionals == null)
103 conditionals = new Dictionary<string, bool> (2);
105 conditionals [value] = true;
108 public void AddUndefine (string value)
110 if (conditionals == null)
111 conditionals = new Dictionary<string, bool> (2);
113 conditionals [value] = false;
116 CompileUnitEntry ICompileUnit.Entry {
117 get { return comp_unit; }
120 public CompileUnitEntry CompileUnitEntry {
121 get { return comp_unit; }
124 public override void DefineSymbolInfo (MonoSymbolWriter symwriter)
126 base.DefineSymbolInfo (symwriter);
128 comp_unit = symwriter.DefineCompilationUnit (SourceFileEntry);
130 if (include_files != null) {
131 foreach (SourceFile include in include_files.Values) {
132 include.DefineSymbolInfo (symwriter);
133 comp_unit.AddFile (include.SourceFileEntry);
138 public bool IsConditionalDefined (string value)
140 if (conditionals != null) {
142 if (conditionals.TryGetValue (value, out res))
145 // When conditional was undefined
146 if (conditionals.ContainsKey (value))
150 return RootContext.IsConditionalDefined (value);
155 /// Keeps track of the location in the program
159 /// This uses a compact representation and a couple of auxiliary
160 /// structures to keep track of tokens to (file,line and column)
161 /// mappings. The usage of the bits is:
163 /// - 16 bits for "checkpoint" which is a mixed concept of
164 /// file and "line segment"
165 /// - 8 bits for line delta (offset) from the line segment
166 /// - 8 bits for column number.
168 /// http://lists.ximian.com/pipermail/mono-devel-list/2004-December/009508.html
170 public struct Location : IEquatable<Location>
173 public readonly int LineOffset;
174 public readonly int CompilationUnit;
175 public readonly int File;
177 public Checkpoint (int compile_unit, int file, int line)
180 CompilationUnit = compile_unit;
181 LineOffset = line - (int) (line % (1 << line_delta_bits));
188 const int column_bits = 24;
189 const int line_delta_bits = 24;
193 const int column_bits = 8;
194 const int line_delta_bits = 8;
196 const int checkpoint_bits = 16;
198 // -2 because the last one is used for hidden
199 const int max_column = (1 << column_bits) - 2;
200 const int column_mask = (1 << column_bits) - 1;
202 static List<SourceFile> source_list;
203 static List<CompilationUnit> compile_units;
204 static Dictionary<string, int> source_files;
205 static int source_count;
206 static int current_source;
207 static int current_compile_unit;
208 static Checkpoint [] checkpoints;
209 static int checkpoint_index;
211 public readonly static Location Null = new Location (-1);
212 public static bool InEmacs;
219 public static void Reset ()
221 source_files = new Dictionary<string, int> ();
222 source_list = new List<SourceFile> ();
223 compile_units = new List<CompilationUnit> ();
225 current_compile_unit = 0;
227 checkpoint_index = 0;
231 // This must be called before parsing/tokenizing any files.
233 static public void AddFile (Report r, string name)
235 string path = Path.GetFullPath (name);
237 if (source_files.TryGetValue (path, out id)){
238 string other_name = source_list [id - 1].Name;
239 if (name.Equals (other_name))
240 r.Warning (2002, 1, "Source file `{0}' specified multiple times", other_name);
242 r.Warning (2002, 1, "Source filenames `{0}' and `{1}' both refer to the same file: {2}", name, other_name, path);
246 source_files.Add (path, ++source_count);
247 CompilationUnit unit = new CompilationUnit (name, path, source_count);
248 source_list.Add (unit);
249 compile_units.Add (unit);
252 public static string FirstFile {
254 return compile_units.Count == 0 ? null : compile_units[0].Name;
258 public static IList<CompilationUnit> SourceFiles {
260 return compile_units;
265 // After adding all source files we want to compile with AddFile(), this method
266 // must be called to `reserve' an appropriate number of bits in the token for the
267 // source file. We reserve some extra space for files we encounter via #line
268 // directives while parsing.
270 static public void Initialize ()
272 checkpoints = new Checkpoint [source_list.Count * 2];
273 if (checkpoints.Length > 0)
274 checkpoints [0] = new Checkpoint (0, 0, 0);
278 // This is used when we encounter a #line preprocessing directive.
280 static public SourceFile LookupFile (CompilationUnit comp_unit, string name)
283 if (!Path.IsPathRooted (name)) {
284 string root = Path.GetDirectoryName (comp_unit.Path);
285 path = Path.Combine (root, name);
289 if (!source_files.ContainsKey (path)) {
290 if (source_count >= (1 << checkpoint_bits))
291 return new SourceFile (name, path, 0, true);
293 source_files.Add (path, ++source_count);
294 SourceFile retval = new SourceFile (name, path, source_count, true);
295 source_list.Add (retval);
299 int index = source_files [path];
300 return source_list [index - 1];
303 static public void Push (CompilationUnit compile_unit, SourceFile file)
305 current_source = file != null ? file.Index : -1;
306 current_compile_unit = compile_unit != null ? compile_unit.Index : -1;
307 // File is always pushed before being changed.
311 // If we're compiling with debugging support, this is called between parsing
312 // and code generation to register all the source files with the
315 static public void DefineSymbolDocuments (MonoSymbolWriter symwriter)
317 foreach (CompilationUnit unit in compile_units)
318 unit.DefineSymbolInfo (symwriter);
321 public Location (int row)
326 public Location (int row, int column)
331 if (column > max_column)
334 column = max_column + 1;
339 // FIXME: This value is certainly wrong but what was the intension
340 int max = checkpoint_index < 10 ?
341 checkpoint_index : 10;
342 for (int i = 0; i < max; i++) {
343 int offset = checkpoints [checkpoint_index - i].LineOffset;
344 delta = row - offset;
346 delta < (1 << line_delta_bits) &&
347 checkpoints [checkpoint_index - i].File == current_source) {
348 target = checkpoint_index - i;
353 AddCheckpoint (current_compile_unit, current_source, row);
354 target = checkpoint_index;
355 delta = row % (1 << line_delta_bits);
359 (delta << column_bits) +
360 (target << (line_delta_bits + column_bits));
364 token = l > 0xFFFFFFFF ? 0 : (int) l;
369 public static Location operator - (Location loc, int columns)
371 return new Location (loc.Row, loc.Column - columns);
374 static void AddCheckpoint (int compile_unit, int file, int row)
376 if (checkpoints.Length == ++checkpoint_index) {
377 Array.Resize (ref checkpoints, checkpoint_index + 2);
379 checkpoints [checkpoint_index] = new Checkpoint (compile_unit, file, row);
382 string FormatLocation (string fileName)
384 if (column_bits == 0 || InEmacs)
385 return fileName + "(" + Row.ToString () + "):";
387 return fileName + "(" + Row.ToString () + "," + Column.ToString () +
388 (Column == max_column ? "+):" : "):");
391 public override string ToString ()
393 return FormatLocation (Name);
396 public string ToStringFullName ()
398 return FormatLocation (NameFullPath);
402 /// Whether the Location is Null
405 get { return token == 0; }
411 if (token == 0 || index == 0)
414 SourceFile file = source_list [index - 1];
419 public string NameFullPath {
422 if (token == 0 || index == 0)
425 return source_list [index - 1].Path;
429 int CheckpointIndex {
431 const int checkpoint_mask = (1 << checkpoint_bits) - 1;
432 return ((int) (token >> (line_delta_bits + column_bits))) & checkpoint_mask;
441 int offset = checkpoints[CheckpointIndex].LineOffset;
443 const int line_delta_mask = (1 << column_bits) - 1;
444 return offset + (((int)(token >> column_bits)) & line_delta_mask);
452 int col = (int) (token & column_mask);
453 return col > max_column ? 1 : col;
459 return (int) (token & column_mask) == max_column + 1;
463 public int CompilationUnitIndex {
467 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));
468 return checkpoints [CheckpointIndex].CompilationUnit;
476 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));
477 return checkpoints [CheckpointIndex].File;
481 // The ISymbolDocumentWriter interface is used by the symbol writer to
482 // describe a single source file - for each source file there's exactly
483 // one corresponding ISymbolDocumentWriter instance.
485 // This class has an internal hash table mapping source document names
486 // to such ISymbolDocumentWriter instances - so there's exactly one
487 // instance per document.
489 // This property returns the ISymbolDocumentWriter instance which belongs
490 // to the location's source file.
492 // If we don't have a symbol writer, this property is always null.
493 public SourceFile SourceFile {
498 return (SourceFile) source_list [index - 1];
502 public CompilationUnit CompilationUnit {
504 int index = CompilationUnitIndex;
507 return (CompilationUnit) source_list [index - 1];
511 #region IEquatable<Location> Members
513 public bool Equals (Location other)
515 return this.token == other.token;
522 // A bag of additional locations to support full ast tree
524 public class LocationsBag
526 public class MemberLocations
528 public readonly IList<Tuple<Modifiers, Location>> Modifiers;
529 Location[] locations;
531 public MemberLocations (IList<Tuple<Modifiers, Location>> mods, Location[] locs)
539 public Location this [int index] {
541 return locations [index];
547 return locations.Length;
553 public void AddLocations (params Location[] additional)
555 if (locations == null) {
556 locations = additional;
558 int pos = locations.Length;
559 Array.Resize (ref locations, pos + additional.Length);
560 additional.CopyTo (locations, pos);
565 Dictionary<object, Location[]> simple_locs = new Dictionary<object, Location[]> (ReferenceEquality<object>.Default);
566 Dictionary<MemberCore, MemberLocations> member_locs = new Dictionary<MemberCore, MemberLocations> (ReferenceEquality<MemberCore>.Default);
568 [Conditional ("FULL_AST")]
569 public void AddLocation (object element, params Location[] locations)
571 simple_locs.Add (element, locations);
574 [Conditional ("FULL_AST")]
575 public void AddStatement (object element, params Location[] locations)
577 if (locations.Length == 0)
578 throw new ArgumentException ("Statement is missing semicolon location");
580 simple_locs.Add (element, locations);
583 [Conditional ("FULL_AST")]
584 public void AddMember (MemberCore member, IList<Tuple<Modifiers, Location>> modLocations, params Location[] locations)
586 member_locs.Add (member, new MemberLocations (modLocations, locations));
589 [Conditional ("FULL_AST")]
590 public void AppendTo (object existing, params Location[] locations)
593 if (simple_locs.TryGetValue (existing, out locs)) {
594 simple_locs [existing] = locs.Concat (locations).ToArray ();
599 [Conditional ("FULL_AST")]
600 public void AppendToMember (MemberCore existing, params Location[] locations)
602 MemberLocations member;
603 if (member_locs.TryGetValue (existing, out member)) {
604 member.AddLocations (locations);
609 public Location[] GetLocations (object element)
612 simple_locs.TryGetValue (element, out found);
616 public MemberLocations GetMemberLocation (MemberCore element)
618 MemberLocations found;
619 member_locs.TryGetValue (element, out found);