src: reduce warnings and spelling errors

[nit.git] / src / location.nit

diff --git a/src/location.nit b/src/location.nit
index 3128902..c092b28 100644 (file)
--- a/src/location.nit
+++ b/src/location.nit
@@ -15,7 +15,7 @@
 # limitations under the License.
 
 # This module is used to model Nit source-file and locations in source-file
-package location
+module location
 
 # A raw text Nit source file
 class SourceFile
@@ -42,7 +42,7 @@ class SourceFile
        end
 
        # Position of each line start
-       var line_starts: Array[Int] = new Array[Int]
+       var line_starts = new Array[Int]
 end
 
 # A location inside a source file
@@ -50,28 +50,34 @@ class Location
        super Comparable
        redef type OTHER: Location
 
-       readable var _file: nullable SourceFile
-       readable var _line_start: Int
-       readable var _line_end: Int
-       readable var _column_start: Int
-       readable var _column_end: Int
+       var file: nullable SourceFile
+       var line_start: Int
+       var line_end: Int
+       var column_start: Int
+       var column_end: Int
 
        init(f: nullable SourceFile, line_s: Int, line_e: Int, column_s: Int, column_e: Int) do
-               _file = f
-               _line_start = line_s
-               _line_end = line_e
-               _column_start = column_s
-               _column_end = column_e
+               file = f
+               line_start = line_s
+               line_end = line_e
+               column_start = column_s
+               column_end = column_e
        end
 
+       # The index in the start character in the source
+       fun pstart: Int do return file.line_starts[line_start-1] + column_start-1
+
+       # The index on the end character in the source
+       fun pend: Int do return file.line_starts[line_end-1] + column_end-1
+
        # The verbatim associated text in the source-file
        fun text: String
        do
                var res = self.text_cache
                if res != null then return res
                var l = self
-               var pstart = l.file.line_starts[l.line_start-1] + l.column_start-1
-               var pend = l.file.line_starts[l.line_end-1] + l.column_end-1
+               var pstart = self.pstart
+               var pend = self.pend
                res = l.file.string.substring(pstart, pend-pstart+1)
                self.text_cache = res
                return res
@@ -94,6 +100,7 @@ class Location
                return true
        end
 
+       # Is `self` included (or equals) to `loc`?
        fun located_in(loc: nullable Location): Bool do
                if loc == null then return false
 
@@ -130,6 +137,9 @@ class Location
                end
        end
 
+       # Return a location message according to an observer.
+       #
+       # Currently, if both are in the same file, the file information is not present in the result.
        fun relative_to(loc: nullable Location): String do
                var relative: Location
                if loc != null and loc.file == self.file then
@@ -152,7 +162,7 @@ class Location
                return column_end < other.column_end
        end
 
-       # Return the associated line with the location highlihted with color and a carret under the starting position
+       # Return the associated line with the location highlighted with color and a caret under the starting position
        # `color` must be and terminal escape sequence used as `"{escape}[{color}m;"`
        # * `"0;31"` for red
        # * `"1;31"` for bright red
@@ -168,7 +178,7 @@ class Location
                var line_start = l.file.line_starts[i-1]
                var line_end = line_start
                var string = l.file.string
-               while line_end+1 < string.length and string[line_end+1] != '\n' and string[line_end+1] != '\r' do
+               while line_end+1 < string.length and string.chars[line_end+1] != '\n' and string.chars[line_end+1] != '\r' do
                        line_end += 1
                end
                var lstart = string.substring(line_start, l.column_start - 1)
@@ -187,9 +197,9 @@ class Location
                        lmid = ""
                        lend = ""
                end
-               var indent = new Buffer
+               var indent = new FlatBuffer
                for j in [line_start..line_start+l.column_start-1[ do
-                       if string[j] == '\t' then
+                       if string.chars[j] == '\t' then
                                indent.add '\t'
                        else
                                indent.add ' '
@@ -198,4 +208,3 @@ class Location
                return "\t{lstart}{col}{lmid}{def}{lend}\n\t{indent}^"
        end
 end
-