1 # This file is part of NIT ( http://www.nitlanguage.org ).
3 # Copyright 2009 Jean-Sebastien Gelinas <calestar@gmail.com>
5 # Licensed under the Apache License, Version 2.0 (the "License");
6 # you may not use this file except in compliance with the License.
7 # You may obtain a copy of the License at
9 # http://www.apache.org/licenses/LICENSE-2.0
11 # Unless required by applicable law or agreed to in writing, software
12 # distributed under the License is distributed on an "AS IS" BASIS,
13 # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
14 # See the License for the specific language governing permissions and
15 # limitations under the License.
17 # Nit source-file and locations in source-file
20 # A raw text Nit source file
22 # The path of the source
25 # The content of the source
26 var string
: String is noinit
28 # The original stream used to initialize `string`
33 string
= stream
.read_all
37 # Create a new sourcefile using a dummy filename and a given content
38 init from_string
(filename
: String, string
: String)
40 self.filename
= filename
45 # Position of each line start
46 var line_starts
= new Array[Int]
49 # A location inside a source file
52 redef type OTHER: Location
54 # The associated source-file
55 var file
: nullable SourceFile
57 # The starting line number (starting from 1)
59 # If `line_start==0` then the whole file is considered
62 # The stopping line number (starting from 1)
65 # Start of this location on `line_start`
67 # A `column_start` of 1 means the first column or character.
69 # If `column_start == 0` this location concerns the whole line.
71 # Require: `column_start >= 0`
74 # End of this location on `line_end`
77 # Builds a location instance from its string representation.
82 # var loc = new Location.from_string("location.nit:82,2--105,8")
83 # assert loc.to_s == "location.nit:82,2--105,8"
85 # loc = new Location.from_string("location.nit")
86 # assert loc.to_s == "location.nit"
88 # loc = new Location.from_string("location.nit:82,2")
89 # assert loc.to_s == "location.nit:82,2--0,0"
91 # loc = new Location.from_string("location.nit:82--105")
92 # assert loc.to_s == "location.nit:82,0--105,0"
94 # loc = new Location.from_string("location.nit:82,2--105")
95 # assert loc.to_s == "location.nit:82,2--105,0"
97 # loc = new Location.from_string("location.nit:82--105,8")
98 # assert loc.to_s == "location.nit:82,0--105,8"
100 init from_string
(string
: String) do
103 self.column_start
= 0
105 # parses the location string and init position vars
106 var parts
= string
.split_with
(":")
107 var filename
= parts
.shift
108 self.file
= new SourceFile(filename
, new FileReader.open
(filename
))
110 if parts
.is_empty
then return
111 var pos
= parts
.first
.split_with
("--")
112 # split start position
113 if pos
.first
.has
(",") then
114 var pos1
= pos
.first
.split_with
(",")
115 self.line_start
= pos1
[0].to_i
116 if pos1
.length
> 1 then
117 self.column_start
= pos1
[1].to_i
120 self.line_start
= pos
.first
.to_i
123 if pos
.length
<= 1 then return
124 if pos
[1].has
(",") then
125 var pos2
= pos
[1].split_with
(",")
126 if pos2
.length
> 1 then
127 self.line_end
= pos2
[0].to_i
128 self.column_end
= pos2
[1].to_i
130 self.line_end
= self.line_start
131 self.column_end
= pos2
[0].to_i
134 self.line_end
= pos
[1].to_i
138 # The index in the start character in the source
139 fun pstart
: Int do return file
.line_starts
[line_start-1
] + column_start-1
141 # The index on the end character in the source
142 fun pend
: Int do return file
.line_starts
[line_end-1
] + column_end-1
144 # The verbatim associated text in the source-file
147 var res
= self.text_cache
148 if res
!= null then return res
150 var pstart
= self.pstart
152 res
= l
.file
.string
.substring
(pstart
, pend-pstart
+1)
153 self.text_cache
= res
157 private var text_cache
: nullable String = null
159 redef fun ==(other
: nullable Object): Bool do
160 if other
== null then return false
161 if not other
isa Location then return false
163 if other
.file
!= file
then return false
164 if other
.line_start
!= line_start
then return false
165 if other
.line_end
!= line_end
then return false
166 if other
.column_start
!= column_start
then return false
167 if other
.column_end
!= column_end
then return false
172 # Is `self` included (or equals) to `loc`?
173 fun located_in
(loc
: nullable Location): Bool do
174 if loc
== null then return false
176 if line_start
< loc
.line_start
then return false
177 if line_start
> loc
.line_end
then return false
179 if line_end
> loc
.line_end
then return false
181 if line_start
== loc
.line_start
then
182 if column_start
< loc
.column_start
then return false
183 if column_start
> loc
.column_end
then return false
186 if line_end
== loc
.line_end
and column_end
> loc
.column_end
then return false
191 redef fun to_s
: String do
194 file_part
= file
.filename
197 if line_start
<= 0 then return file_part
199 if file
!= null and file
.filename
.length
> 0 then file_part
+= ":"
201 if line_start
== line_end
then
202 if column_start
== column_end
then
203 return "{file_part}{line_start},{column_start}"
205 return "{file_part}{line_start},{column_start}--{column_end}"
208 return "{file_part}{line_start},{column_start}--{line_end},{column_end}"
212 # Return a location message according to an observer.
214 # Currently, if both are in the same file, the file information is not present in the result.
215 fun relative_to
(loc
: nullable Location): String do
216 var relative
: Location
217 if loc
!= null and loc
.file
== self.file
then
218 relative
= new Location(null, self.line_start
, self.line_end
, self.column_start
, self.column_end
)
220 relative
= new Location(self.file
, self.line_start
, self.line_end
, self.column_start
, self.column_end
)
225 redef fun <(other
: OTHER): Bool do
226 if self == other
then return false
227 if self.located_in
(other
) then return true
228 if other
.located_in
(self) then return false
230 if line_start
!= other
.line_start
then return line_start
< other
.line_start
231 if column_start
!= other
.column_start
then return column_start
< other
.column_start
232 if line_end
!= other
.line_end
then return line_end
< other
.line_end
234 return column_end
< other
.column_end
237 # Return the associated line with the location highlighted with color and a caret under the starting position
238 # `color` must be and terminal escape sequence used as `"{escape}[{color}m;"`
240 # * `"1;31"` for bright red
241 # * `"0;32"` for green
242 fun colored_line
(color
: String): String
246 var col
= "{esc}[{color}m"
250 if i
<= 0 then return ""
252 var line_start
= l
.file
.line_starts
[i-1
]
253 var line_end
= line_start
254 var string
= l
.file
.string
255 while line_end
+1 < string
.length
and string
.chars
[line_end
+1] != '\n' and string
.chars
[line_end
+1] != '\r' do
259 if l
.column_start
> 0 then
260 lstart
= string
.substring
(line_start
, l
.column_start
- 1)
265 if i
!= l
.line_end
then
266 cend
= line_end
- line_start
+ 1
272 if line_start
+ cend
<= string
.length
then
273 lmid
= string
.substring
(line_start
+ l
.column_start
- 1, cend
- l
.column_start
+ 1)
274 lend
= string
.substring
(line_start
+ cend
, line_end
- line_start
- cend
+ 1)
279 var indent
= new FlatBuffer
280 for j
in [line_start
..line_start
+l
.column_start-1
[ do
281 if string
.chars
[j
] == '\t' then
287 return "\t{lstart}{col}{lmid}{def}{lend}\n\t{indent}^"