File: SourceLocation.cs

package info (click to toggle)
mono 6.8.0.105%2Bdfsg-3.3
  • links: PTS, VCS
  • area: main
  • in suites: bookworm
  • size: 1,284,512 kB
  • sloc: cs: 11,172,132; xml: 2,850,069; ansic: 671,653; cpp: 122,091; perl: 59,366; javascript: 30,841; asm: 22,168; makefile: 20,093; sh: 15,020; python: 4,827; pascal: 925; sql: 859; sed: 16; php: 1
file content (198 lines) | stat: -rw-r--r-- 6,767 bytes parent folder | download | duplicates (7)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
//-----------------------------------------------------------------------------
// Copyright (c) Microsoft Corporation.  All rights reserved.
//-----------------------------------------------------------------------------

namespace System.Activities.Debugger
{
    using System;
    using System.Activities.Debugger.Symbol;
    using System.Diagnostics;
    using System.Linq;
    using System.Runtime;

    // Identifies a specific location in the target source code.
    //
    // This source information is used in creating PDBs, which will be passed to the debugger,
    // which will resolve the source file based off its own source paths.
    // Source ranges can:
    // * refer to just an entire single line.
    // * can be a subset within a single line (when StartLine == EndLine)
    // * can also span multiple lines.
    // When column info is provided, the debugger will highlight the characters starting at the start line and start column,
    // and going up to but not including the character specified by the end line and end column.
    [Fx.Tag.SecurityNote(Miscellaneous = "RequiresReview - Our partial trust mechanisms require that this class remain Immutable. Do not add code that allows an instance of this class to change after creation without strict review.")]
    [DebuggerNonUserCode]
    [Serializable]
    [Fx.Tag.XamlVisible(false)]
    public class SourceLocation
    {
        string fileName;
        int startLine;
        int endLine;
        int startColumn;
        int endColumn;
        byte[] checksum;

        // Define a source location from a filename and line-number (1-based).
        // This is a convenience constructor to specify the entire line.
        // This does not load the source file to determine column ranges.
        public SourceLocation(string fileName, int line)
            : this(fileName, line, 1, line, int.MaxValue)
        {
        }

        public SourceLocation(
           string fileName,
           int startLine,
           int startColumn,
           int endLine,
           int endColumn)
            : this(fileName, null, startLine, startColumn, endLine, endColumn)
        {
        }

        // Define a source location in a file.
        // Line/Column are 1-based.
        internal SourceLocation(
            string fileName,
            byte[] checksum,
            int startLine,
            int startColumn,
            int endLine,
            int endColumn)
        {
            if (startLine <= 0)
            {
                throw FxTrace.Exception.Argument("startLine", SR.InvalidSourceLocationLineNumber("startLine", startLine));
            }

            if (startColumn <= 0)
            {
                throw FxTrace.Exception.Argument("startColumn", SR.InvalidSourceLocationColumn("startColumn", startColumn));
            }

            if (endLine <= 0)
            {
                throw FxTrace.Exception.Argument("endLine", SR.InvalidSourceLocationLineNumber("endLine", endLine));
            }

            if (endColumn <= 0)
            {
                throw FxTrace.Exception.Argument("endColumn", SR.InvalidSourceLocationColumn("endColumn", endColumn));
            }

            if (startLine > endLine)
            {
                throw FxTrace.Exception.ArgumentOutOfRange("endLine", endLine, SR.OutOfRangeSourceLocationEndLine(startLine));
            }

            if ((startLine == endLine) && (startColumn > endColumn))
            {
                throw FxTrace.Exception.ArgumentOutOfRange("endColumn", endColumn, SR.OutOfRangeSourceLocationEndColumn(startColumn));
            }

            this.fileName = (fileName != null) ? fileName.ToUpperInvariant() : null;
            this.startLine = startLine;
            this.endLine = endLine;
            this.startColumn = startColumn;
            this.endColumn = endColumn;
            this.checksum = checksum;
        }

        public string FileName
        {
            get { return this.fileName; }
        }

        // Get the 1-based start line.
        public int StartLine
        {
            get { return this.startLine; }
        }

        // Get the 1-based starting column.
        public int StartColumn
        {
            get { return this.startColumn; }
        }

        // Get the 1-based end line. This should be greater or equal to StartLine.
        public int EndLine
        {
            get { return this.endLine; }
        }

        // Get the 1-based ending column.
        public int EndColumn
        {
            get { return this.endColumn; }
        }

        // get the checksum of the source file
        internal byte[] Checksum
        {
            get { return this.checksum; }
        }

        public bool IsSingleWholeLine
        {
            get
            {
                return this.endColumn == int.MaxValue && this.startLine == this.endLine && this.startColumn == 1;
            }
        }

        // Equality comparison function. This checks for strict equality and
        // not for superset or subset relationships.
        public override bool Equals(object obj)
        {
            SourceLocation rsl = obj as SourceLocation;
            if (rsl == null)
            {
                return false;
            }

            if (this.FileName != rsl.FileName)
            {
                return false;
            }            

            if (this.StartLine != rsl.StartLine ||
                this.StartColumn != rsl.StartColumn ||
                this.EndLine != rsl.EndLine ||
                this.EndColumn != rsl.EndColumn)
            {
                return false;
            }

            if (this.Checksum == null ^ rsl.Checksum == null)
            {
                return false;
            }
            else if ((this.Checksum != null && rsl.Checksum != null) && !this.Checksum.SequenceEqual(rsl.Checksum))
            {
                return false;
            }

            // everything matches
            return true;
        }

        // Get a hash code.
        public override int GetHashCode()
        {
            return (string.IsNullOrEmpty(this.FileName) ? 0 : this.FileName.GetHashCode()) ^
                    this.StartLine.GetHashCode() ^
                    this.StartColumn.GetHashCode() ^
                    ((this.Checksum == null) ? 0 : SymbolHelper.GetHexStringFromChecksum(this.Checksum).GetHashCode());
        }

        internal static bool IsValidRange(int startLine, int startColumn, int endLine, int endColumn)
        {
            return
                (startLine > 0) && (startColumn > 0) && (endLine > 0) && (endColumn > 0) &&
                ((startLine < endLine) || (startLine == endLine) && (startColumn < endColumn));

        }
    }
}