class Prism::Location
This represents a location in the source.
Attributes
The length of this location in bytes.
A Source
object that is used to determine more information from the given offset and length.
The byte offset from the beginning of the source where this location starts.
Public Class Methods
Create a new location object with the given source, start byte offset, and byte length.
# File lib/prism/parse_result.rb, line 125 def initialize(source, start_offset, length) @source = source @start_offset = start_offset @length = length # These are used to store comments that are associated with this location. # They are initialized to `nil` to save on memory when there are no # comments to be attached and/or the comment-related APIs are not used. @leading_comments = nil @trailing_comments = nil end
Public Instance Methods
Returns true if the given other location is equal to this location.
# File lib/prism/parse_result.rb, line 284 def ==(other) Location === other && other.start_offset == start_offset && other.end_offset == end_offset end
Returns a new location that is the result of chopping off the last byte.
# File lib/prism/parse_result.rb, line 171 def chop copy(length: length == 0 ? length : length - 1) end
Returns all comments that are associated with this location (both leading and trailing comments).
# File lib/prism/parse_result.rb, line 161 def comments [*@leading_comments, *@trailing_comments] end
Create a new location object with the given options.
# File lib/prism/parse_result.rb, line 166 def copy(source: self.source, start_offset: self.start_offset, length: self.length) Location.new(source, start_offset, length) end
Implement the hash pattern matching interface for Location
.
# File lib/prism/parse_result.rb, line 274 def deconstruct_keys(keys) { start_offset: start_offset, end_offset: end_offset } end
The column number in characters where this location ends from the start of the line.
# File lib/prism/parse_result.rb, line 263 def end_character_column source.character_column(end_offset) end
The character offset from the beginning of the source where this location ends.
# File lib/prism/parse_result.rb, line 212 def end_character_offset source.character_offset(end_offset) end
The column number in code units of the given encoding where this location ends from the start of the line.
# File lib/prism/parse_result.rb, line 269 def end_code_units_column(encoding = Encoding::UTF_16LE) source.code_units_column(end_offset, encoding) end
The offset from the start of the file in code units of the given encoding.
# File lib/prism/parse_result.rb, line 217 def end_code_units_offset(encoding = Encoding::UTF_16LE) source.code_units_offset(end_offset, encoding) end
The column number in bytes where this location ends from the start of the line.
# File lib/prism/parse_result.rb, line 257 def end_column source.column(end_offset) end
The line number where this location ends.
# File lib/prism/parse_result.rb, line 233 def end_line source.line(end_offset) end
The byte offset from the beginning of the source where this location ends.
# File lib/prism/parse_result.rb, line 206 def end_offset start_offset + length end
Returns a string representation of this location.
# File lib/prism/parse_result.rb, line 176 def inspect "#<Prism::Location @start_offset=#{@start_offset} @length=#{@length} start_line=#{start_line}>" end
Returns a new location that stretches from this location to the given other location. Raises an error if this location is not before the other location or if they don’t share the same source.
# File lib/prism/parse_result.rb, line 293 def join(other) raise "Incompatible sources" if source != other.source raise "Incompatible locations" if start_offset > other.start_offset Location.new(source, start_offset, other.end_offset - start_offset) end
Attach a comment to the leading comments of this location.
# File lib/prism/parse_result.rb, line 144 def leading_comment(comment) leading_comments << comment end
These are the comments that are associated with this location that exist before the start of this location.
# File lib/prism/parse_result.rb, line 139 def leading_comments @leading_comments ||= [] end
Implement the pretty print interface for Location
.
# File lib/prism/parse_result.rb, line 279 def pretty_print(q) q.text("(#{start_line},#{start_column})-(#{end_line},#{end_column})") end
The source code that this location represents.
# File lib/prism/parse_result.rb, line 181 def slice source.slice(start_offset, length) end
The source code that this location represents starting from the beginning of the line that this location starts on to the end of the line that this location ends on.
# File lib/prism/parse_result.rb, line 188 def slice_lines line_start = source.line_start(start_offset) line_end = source.line_end(end_offset) source.slice(line_start, line_end - line_start) end
The column number in characters where this location ends from the start of the line.
# File lib/prism/parse_result.rb, line 245 def start_character_column source.character_column(start_offset) end
The character offset from the beginning of the source where this location starts.
# File lib/prism/parse_result.rb, line 196 def start_character_offset source.character_offset(start_offset) end
The column number in code units of the given encoding where this location starts from the start of the line.
# File lib/prism/parse_result.rb, line 251 def start_code_units_column(encoding = Encoding::UTF_16LE) source.code_units_column(start_offset, encoding) end
The offset from the start of the file in code units of the given encoding.
# File lib/prism/parse_result.rb, line 201 def start_code_units_offset(encoding = Encoding::UTF_16LE) source.code_units_offset(start_offset, encoding) end
The column number in bytes where this location starts from the start of the line.
# File lib/prism/parse_result.rb, line 239 def start_column source.column(start_offset) end
The line number where this location starts.
# File lib/prism/parse_result.rb, line 222 def start_line source.line(start_offset) end
The content of the line where this location starts before this location.
# File lib/prism/parse_result.rb, line 227 def start_line_slice offset = source.line_start(start_offset) source.slice(offset, start_offset - offset) end
Attach a comment to the trailing comments of this location.
# File lib/prism/parse_result.rb, line 155 def trailing_comment(comment) trailing_comments << comment end
These are the comments that are associated with this location that exist after the end of this location.
# File lib/prism/parse_result.rb, line 150 def trailing_comments @trailing_comments ||= [] end