1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326
|
# frozen_string_literal: true
module Parser
module Source
##
# A range of characters in a particular source buffer.
#
# The range is always exclusive, i.e. a range with `begin_pos` of 3 and
# `end_pos` of 5 will contain the following characters:
#
# example
# ^^
#
# @!attribute [r] source_buffer
# @return [Parser::Source::Buffer]
#
# @!attribute [r] begin_pos
# @return [Integer] index of the first character in the range
#
# @!attribute [r] end_pos
# @return [Integer] index of the character after the last character in the range
#
# @api public
#
class Range
include Comparable
attr_reader :source_buffer
attr_reader :begin_pos, :end_pos
##
# @param [Buffer] source_buffer
# @param [Integer] begin_pos
# @param [Integer] end_pos
#
def initialize(source_buffer, begin_pos, end_pos)
if end_pos < begin_pos
raise ArgumentError, 'Parser::Source::Range: end_pos must not be less than begin_pos'
end
if source_buffer.nil?
raise ArgumentError, 'Parser::Source::Range: source_buffer must not be nil'
end
@source_buffer = source_buffer
@begin_pos, @end_pos = begin_pos, end_pos
freeze
end
##
# @return [Range] a zero-length range located just before the beginning
# of this range.
#
def begin
with(end_pos: @begin_pos)
end
##
# @return [Range] a zero-length range located just after the end
# of this range.
#
def end
with(begin_pos: @end_pos)
end
##
# @return [Integer] amount of characters included in this range.
#
def size
@end_pos - @begin_pos
end
alias length size
##
# Line number of the beginning of this range. By default, the first line
# of a buffer is 1; as such, line numbers are most commonly one-based.
#
# @see Buffer
# @return [Integer] line number of the beginning of this range.
#
def line
@source_buffer.line_for_position(@begin_pos)
end
alias_method :first_line, :line
##
# @return [Integer] zero-based column number of the beginning of this range.
#
def column
@source_buffer.column_for_position(@begin_pos)
end
##
# @return [Integer] line number of the end of this range.
#
def last_line
@source_buffer.line_for_position(@end_pos)
end
##
# @return [Integer] zero-based column number of the end of this range.
#
def last_column
@source_buffer.column_for_position(@end_pos)
end
##
# @return [::Range] a range of columns spanned by this range.
# @raise RangeError
#
def column_range
if line != last_line
raise RangeError, "#{self.inspect} spans more than one line"
end
column...last_column
end
##
# @return [String] a line of source code containing the beginning of this range.
#
def source_line
@source_buffer.source_line(line)
end
##
# @return [String] all source code covered by this range.
#
def source
@source_buffer.slice(@begin_pos, @end_pos - @begin_pos)
end
##
# `is?` provides a concise way to compare the source corresponding to this range.
# For example, `r.source == '(' || r.source == 'begin'` is equivalent to
# `r.is?('(', 'begin')`.
#
def is?(*what)
what.include?(source)
end
##
# @return [Array<Integer>] a set of character indexes contained in this range.
#
def to_a
(@begin_pos...@end_pos).to_a
end
##
# @return [Range] a Ruby range with the same `begin_pos` and `end_pos`
#
def to_range
self.begin_pos...self.end_pos
end
##
# Composes a GNU/Clang-style string representation of the beginning of this
# range.
#
# For example, for the following range in file `foo.rb`,
#
# def foo
# ^^^
#
# `to_s` will return `foo.rb:1:5`.
# Note that the column index is one-based.
#
# @return [String]
#
def to_s
line, column = @source_buffer.decompose_position(@begin_pos)
[@source_buffer.name, line, column + 1].join(':')
end
##
# @param [Hash] Endpoint(s) to change, any combination of :begin_pos or :end_pos
# @return [Range] the same range as this range but with the given end point(s) changed
# to the given value(s).
#
def with(begin_pos: @begin_pos, end_pos: @end_pos)
Range.new(@source_buffer, begin_pos, end_pos)
end
##
# @param [Hash] Endpoint(s) to change, any combination of :begin_pos or :end_pos
# @return [Range] the same range as this range but with the given end point(s) adjusted
# by the given amount(s)
#
def adjust(begin_pos: 0, end_pos: 0)
Range.new(@source_buffer, @begin_pos + begin_pos, @end_pos + end_pos)
end
##
# @param [Integer] new_size
# @return [Range] a range beginning at the same point as this range and length `new_size`.
#
def resize(new_size)
with(end_pos: @begin_pos + new_size)
end
##
# @param [Range] other
# @return [Range] smallest possible range spanning both this range and `other`.
#
def join(other)
Range.new(@source_buffer,
[@begin_pos, other.begin_pos].min,
[@end_pos, other.end_pos].max)
end
##
# @param [Range] other
# @return [Range] overlapping region of this range and `other`, or `nil`
# if they do not overlap
#
def intersect(other)
unless disjoint?(other)
Range.new(@source_buffer,
[@begin_pos, other.begin_pos].max,
[@end_pos, other.end_pos].min)
end
end
##
# Return `true` iff this range and `other` are disjoint.
#
# Two ranges must be one and only one of ==, disjoint?, contains?, contained? or crossing?
#
# @param [Range] other
# @return [Boolean]
#
def disjoint?(other)
if empty? && other.empty?
@begin_pos != other.begin_pos
else
@begin_pos >= other.end_pos || other.begin_pos >= @end_pos
end
end
##
# Return `true` iff this range is not disjoint from `other`.
#
# @param [Range] other
# @return [Boolean] `true` if this range and `other` overlap
#
def overlaps?(other)
!disjoint?(other)
end
##
# Returns true iff this range contains (strictly) `other`.
#
# Two ranges must be one and only one of ==, disjoint?, contains?, contained? or crossing?
#
# @param [Range] other
# @return [Boolean]
#
def contains?(other)
(other.begin_pos <=> @begin_pos) + (@end_pos <=> other.end_pos) >= (other.empty? ? 2 : 1)
end
##
# Return `other.contains?(self)`
#
# Two ranges must be one and only one of ==, disjoint?, contains?, contained? or crossing?
#
# @param [Range] other
# @return [Boolean]
#
def contained?(other)
other.contains?(self)
end
##
# Returns true iff both ranges intersect and also have different elements from one another.
#
# Two ranges must be one and only one of ==, disjoint?, contains?, contained? or crossing?
#
# @param [Range] other
# @return [Boolean]
#
def crossing?(other)
return false unless overlaps?(other)
(@begin_pos <=> other.begin_pos) * (@end_pos <=> other.end_pos) == 1
end
##
# Checks if a range is empty; if it contains no characters
# @return [Boolean]
def empty?
@begin_pos == @end_pos
end
##
# Compare ranges, first by begin_pos, then by end_pos.
#
def <=>(other)
return nil unless other.is_a?(::Parser::Source::Range) &&
@source_buffer == other.source_buffer
(@begin_pos <=> other.begin_pos).nonzero? ||
(@end_pos <=> other.end_pos)
end
alias_method :eql?, :==
##
# Support for Ranges be used in as Hash indices and in Sets.
#
def hash
[@source_buffer, @begin_pos, @end_pos].hash
end
##
# @return [String] a human-readable representation of this range.
#
def inspect
"#<Parser::Source::Range #{@source_buffer.name} #{@begin_pos}...#{@end_pos}>"
end
end
end
end
|