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 # This module is used to model 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 var file
: nullable SourceFile
58 # Start of this location on `line_start`
60 # A `column_start` of 1 means the first column or character.
62 # If `column_start == 0` this location concerns the whole line.
64 # Require: `column_start >= 0`
69 # The index in the start character in the source
70 fun pstart
: Int do return file
.line_starts
[line_start-1
] + column_start-1
72 # The index on the end character in the source
73 fun pend
: Int do return file
.line_starts
[line_end-1
] + column_end-1
75 # The verbatim associated text in the source-file
78 var res
= self.text_cache
79 if res
!= null then return res
81 var pstart
= self.pstart
83 res
= l
.file
.string
.substring
(pstart
, pend-pstart
+1)
88 private var text_cache
: nullable String = null
90 init with_file
(f
: SourceFile) do init(f
,0,0,0,0)
92 redef fun ==(other
: nullable Object): Bool do
93 if other
== null then return false
94 if not other
isa Location then return false
96 if other
.file
!= file
then return false
97 if other
.line_start
!= line_start
then return false
98 if other
.line_end
!= line_end
then return false
99 if other
.column_start
!= column_start
then return false
100 if other
.column_end
!= column_end
then return false
105 # Is `self` included (or equals) to `loc`?
106 fun located_in
(loc
: nullable Location): Bool do
107 if loc
== null then return false
109 if line_start
< loc
.line_start
then return false
110 if line_start
> loc
.line_end
then return false
112 if line_end
> loc
.line_end
then return false
114 if line_start
== loc
.line_start
then
115 if column_start
< loc
.column_start
then return false
116 if column_start
> loc
.column_end
then return false
119 if line_end
== loc
.line_end
and column_end
> loc
.column_end
then return false
124 redef fun to_s
: String do
127 file_part
= file
.filename
128 if file
.filename
.length
> 0 then file_part
+= ":"
131 if line_start
== line_end
then
132 if column_start
== column_end
then
133 return "{file_part}{line_start},{column_start}"
135 return "{file_part}{line_start},{column_start}--{column_end}"
138 return "{file_part}{line_start},{column_start}--{line_end},{column_end}"
142 # Return a location message according to an observer.
144 # Currently, if both are in the same file, the file information is not present in the result.
145 fun relative_to
(loc
: nullable Location): String do
146 var relative
: Location
147 if loc
!= null and loc
.file
== self.file
then
148 relative
= new Location(null, self.line_start
, self.line_end
, self.column_start
, self.column_end
)
150 relative
= new Location(self.file
, self.line_start
, self.line_end
, self.column_start
, self.column_end
)
155 redef fun <(other
: OTHER): Bool do
156 if self == other
then return false
157 if self.located_in
(other
) then return true
158 if other
.located_in
(self) then return false
160 if line_start
!= other
.line_start
then return line_start
< other
.line_start
161 if column_start
!= other
.column_start
then return column_start
< other
.column_start
162 if line_end
!= other
.line_end
then return line_end
< other
.line_end
164 return column_end
< other
.column_end
167 # Return the associated line with the location highlighted with color and a caret under the starting position
168 # `color` must be and terminal escape sequence used as `"{escape}[{color}m;"`
170 # * `"1;31"` for bright red
171 # * `"0;32"` for green
172 fun colored_line
(color
: String): String
176 var col
= "{esc}[{color}m"
180 var line_start
= l
.file
.line_starts
[i-1
]
181 var line_end
= line_start
182 var string
= l
.file
.string
183 while line_end
+1 < string
.length
and string
.chars
[line_end
+1] != '\n' and string
.chars
[line_end
+1] != '\r' do
187 if l
.column_start
> 0 then
188 lstart
= string
.substring
(line_start
, l
.column_start
- 1)
193 if i
!= l
.line_end
then
194 cend
= line_end
- line_start
+ 1
200 if line_start
+ cend
<= string
.length
then
201 lmid
= string
.substring
(line_start
+ l
.column_start
- 1, cend
- l
.column_start
+ 1)
202 lend
= string
.substring
(line_start
+ cend
, line_end
- line_start
- cend
+ 1)
207 var indent
= new FlatBuffer
208 for j
in [line_start
..line_start
+l
.column_start-1
[ do
209 if string
.chars
[j
] == '\t' then
215 return "\t{lstart}{col}{lmid}{def}{lend}\n\t{indent}^"