Merge: doc: fixed some typos and other misc. corrections
[nit.git] / src / location.nit
index e82775a..448d17d 100644 (file)
@@ -14,7 +14,7 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 
-# This module is used to model Nit source-file and locations in source-file
+# Nit source-file and locations in source-file
 module location
 
 # A raw text Nit source file
@@ -26,7 +26,7 @@ class SourceFile
        var string: String is noinit
 
        # The original stream used to initialize `string`
-       var stream: IStream
+       var stream: Reader
 
        init
        do
@@ -35,15 +35,32 @@ class SourceFile
        end
 
        # Create a new sourcefile using a dummy filename and a given content
-       init from_string(filename: String, string: String)
+       init from_string(filename: String, string: String) is
+               nosuper
        do
                self.filename = filename
                self.string = string
                line_starts[0] = 0
        end
 
-       # Position of each line start
+       # Offset of each line start in the content `string`.
+       #
+       # Used for fast access to each line when rendering parts of the `string`.
        var line_starts = new Array[Int]
+
+       # Extract a given line excluding the line-terminators characters.
+       #
+       # `line_number` starts at 1 for the first line.
+       fun get_line(line_number: Int): String do
+               if line_number > line_starts.length then return ""
+               var line_start = line_starts[line_number-1]
+               var line_end = line_start
+               var string = self.string
+               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
+               return string.substring(line_start, line_end-line_start+1)
+       end
 end
 
 # A location inside a source file
@@ -51,8 +68,15 @@ class Location
        super Comparable
        redef type OTHER: Location
 
+       # The associated source-file
        var file: nullable SourceFile
+
+       # The starting line number (starting from 1)
+       #
+       # If `line_start==0` then the whole file is considered
        var line_start: Int
+
+       # The stopping line number (starting from 1)
        var line_end: Int
 
        # Start of this location on `line_start`
@@ -64,8 +88,81 @@ class Location
        # Require: `column_start >= 0`
        var column_start: Int
 
+       # End of this location on `line_end`
        var column_end: Int
 
+       # Builds a location instance from its string representation.
+       #
+       # Examples:
+       #
+       # ~~~
+       # var loc = new Location.from_string("location.nit:82,2--105,8")
+       # assert loc.to_s == "location.nit:82,2--105,8"
+       #
+       # loc = new Location.from_string("location.nit")
+       # assert loc.to_s == "location.nit"
+       #
+       # loc = new Location.from_string("location.nit:82,2")
+       # assert loc.to_s == "location.nit:82,2--0,0"
+       #
+       # loc = new Location.from_string("location.nit:82--105")
+       # assert loc.to_s == "location.nit:82,0--105,0"
+       #
+       # loc = new Location.from_string("location.nit:82,2--105")
+       # assert loc.to_s == "location.nit:82,2--105,0"
+       #
+       # loc = new Location.from_string("location.nit:82--105,8")
+       # assert loc.to_s == "location.nit:82,0--105,8"
+       # ~~~
+       init from_string(string: String) is
+               nosuper
+       do
+               self.line_start = 0
+               self.line_end = 0
+               self.column_start = 0
+               self.column_end = 0
+               # parses the location string and init position vars
+               var parts = string.split_with(":")
+               var filename = parts.shift
+               self.file = new SourceFile(filename, new FileReader.open(filename))
+               # split position
+               if parts.is_empty then return
+               var pos = parts.first.split_with("--")
+               # split start position
+               if pos.first.has(",") then
+                       var pos1 = pos.first.split_with(",")
+                       self.line_start = pos1[0].to_i
+                       if pos1.length > 1 then
+                               self.column_start = pos1[1].to_i
+                       end
+               else
+                       self.line_start = pos.first.to_i
+               end
+               # split end position
+               if pos.length <= 1 then return
+               if pos[1].has(",") then
+                       var pos2 = pos[1].split_with(",")
+                       if pos2.length > 1 then
+                               self.line_end = pos2[0].to_i
+                               self.column_end = pos2[1].to_i
+                       else
+                               self.line_end = self.line_start
+                               self.column_end = pos2[0].to_i
+                       end
+               else
+                       self.line_end = pos[1].to_i
+               end
+       end
+
+       # Initialize a location corresponding to an opaque file.
+       #
+       # The path is used as is and is not open nor read.
+       init opaque_file(path: String)
+       do
+               var source = new SourceFile.from_string(path, "")
+               init(source, 0, 0, 0, 0)
+       end
+
        # The index in the start character in the source
        fun pstart: Int do return file.line_starts[line_start-1] + column_start-1
 
@@ -87,8 +184,6 @@ class Location
 
        private var text_cache: nullable String = null
 
-       init with_file(f: SourceFile) do init(f,0,0,0,0)
-
        redef fun ==(other: nullable Object): Bool do
                if other == null then return false
                if not other isa Location then return false
@@ -113,7 +208,7 @@ class Location
 
                if line_start == loc.line_start then
                        if column_start < loc.column_start then return false
-                       if column_start > loc.column_end then return false
+                       if line_start == loc.line_end and column_start > loc.column_end then return false
                end
 
                if line_end == loc.line_end and column_end > loc.column_end then return false
@@ -125,9 +220,12 @@ class Location
                var file_part = ""
                if file != null then
                        file_part = file.filename
-                       if file.filename.length > 0 then file_part += ":"
                end
 
+               if line_start <= 0 then return file_part
+
+               if file != null and file.filename.length > 0 then file_part += ":"
+
                if line_start == line_end then
                        if column_start == column_end then
                                return "{file_part}{line_start},{column_start}"
@@ -171,12 +269,14 @@ class Location
        # * `"0;32"` for green
        fun colored_line(color: String): String
        do
-               var esc = 27.ascii
+               var esc = 27.code_point
                var def = "{esc}[0m"
                var col = "{esc}[{color}m"
 
                var l = self
                var i = l.line_start
+               if i <= 0 then return ""
+
                var line_start = l.file.line_starts[i-1]
                var line_end = line_start
                var string = l.file.string