Class: Parser::Source::Range
- Inherits:
-
Object
- Object
- Parser::Source::Range
- Defined in:
- lib/parser/source/range.rb
Overview
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
^^
Instance Attribute Summary collapse
-
#begin_pos ⇒ Integer
readonly
Index of the first character in the range.
-
#end_pos ⇒ Integer
readonly
Index of the character after the last character in the range.
- #source_buffer ⇒ Parser::Diagnostic::Engine readonly
Instance Method Summary collapse
-
#==(other) ⇒ Boolean
Compares ranges.
-
#begin ⇒ Range
A zero-length range located just before the beginning of this range.
-
#column ⇒ Integer
Zero-based column number of the beginning of this range.
-
#column_range ⇒ ::Range
A range of columns spanned by this range.
-
#disjoint?(other) ⇒ Boolean
true
if this range andother
do not overlap. -
#empty? ⇒ Boolean
Checks if a range is empty; if it contains no characters.
-
#end ⇒ Range
A zero-length range located just after the end of this range.
-
#initialize(source_buffer, begin_pos, end_pos) ⇒ Range
constructor
A new instance of Range.
-
#inspect ⇒ String
A human-readable representation of this range.
-
#intersect(other) ⇒ Range
Overlapping region of this range and
other
, ornil
if they do not overlap. -
#is?(*what) ⇒ Boolean
is?
provides a concise way to compare the source corresponding to this range. -
#join(other) ⇒ Range
Smallest possible range spanning both this range and
other
. -
#last_column ⇒ Integer
Zero-based column number of the end of this range.
-
#last_line ⇒ Integer
Line number of the end of this range.
-
#line ⇒ Integer
(also: #first_line)
Line number of the beginning of this range.
-
#overlaps?(other) ⇒ Boolean
true
if this range andother
overlap. -
#resize(new_size) ⇒ Range
A range beginning at the same point as this range and length
new_size
. -
#size ⇒ Integer
(also: #length)
Amount of characters included in this range.
-
#source ⇒ String
All source code covered by this range.
-
#source_line ⇒ String
A line of source code containing the beginning of this range.
-
#to_a ⇒ Array(Integer)
A set of character indexes contained in this range.
-
#to_s ⇒ String
Composes a GNU/Clang-style string representation of the beginning of this range.
Constructor Details
#initialize(source_buffer, begin_pos, end_pos) ⇒ Range
Returns a new instance of Range.
33 34 35 36 37 38 39 40 41 42 43 44 45 |
# File 'lib/parser/source/range.rb', line 33 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 |
Instance Attribute Details
#begin_pos ⇒ Integer (readonly)
Returns index of the first character in the range.
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 |
# File 'lib/parser/source/range.rb', line 24 class Range 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 Range.new(@source_buffer, @begin_pos, @begin_pos) end ## # @return [Range] a zero-length range located just after the end # of this range. # def end Range.new(@source_buffer, @end_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 self.begin.line != self.end.line raise RangeError, "#{self.inspect} spans more than one line" end self.begin.column...self.end.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(self.begin_pos...self.end_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 ## # 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 [Integer] new_size # @return [Range] a range beginning at the same point as this range and length `new_size`. # def resize(new_size) Range.new(@source_buffer, @begin_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 ## # @param [Range] other # @return [Boolean] `true` if this range and `other` do not overlap # def disjoint?(other) @begin_pos >= other.end_pos || other.begin_pos >= @end_pos end ## # @param [Range] other # @return [Boolean] `true` if this range and `other` overlap # def overlaps?(other) @begin_pos < other.end_pos && other.begin_pos < @end_pos end ## # Checks if a range is empty; if it contains no characters # @return [Boolean] def empty? @begin_pos == @end_pos end ## # Compares ranges. # @return [Boolean] # def ==(other) other.is_a?(Range) && @source_buffer == other.source_buffer && @begin_pos == other.begin_pos && @end_pos == other.end_pos 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_pos ⇒ Integer (readonly)
Returns index of the character after the last character in the range.
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 |
# File 'lib/parser/source/range.rb', line 24 class Range 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 Range.new(@source_buffer, @begin_pos, @begin_pos) end ## # @return [Range] a zero-length range located just after the end # of this range. # def end Range.new(@source_buffer, @end_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 self.begin.line != self.end.line raise RangeError, "#{self.inspect} spans more than one line" end self.begin.column...self.end.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(self.begin_pos...self.end_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 ## # 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 [Integer] new_size # @return [Range] a range beginning at the same point as this range and length `new_size`. # def resize(new_size) Range.new(@source_buffer, @begin_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 ## # @param [Range] other # @return [Boolean] `true` if this range and `other` do not overlap # def disjoint?(other) @begin_pos >= other.end_pos || other.begin_pos >= @end_pos end ## # @param [Range] other # @return [Boolean] `true` if this range and `other` overlap # def overlaps?(other) @begin_pos < other.end_pos && other.begin_pos < @end_pos end ## # Checks if a range is empty; if it contains no characters # @return [Boolean] def empty? @begin_pos == @end_pos end ## # Compares ranges. # @return [Boolean] # def ==(other) other.is_a?(Range) && @source_buffer == other.source_buffer && @begin_pos == other.begin_pos && @end_pos == other.end_pos end ## # @return [String] a human-readable representation of this range. # def inspect "#<Parser::Source::Range #{@source_buffer.name} #{@begin_pos}...#{@end_pos}>" end end |
#source_buffer ⇒ Parser::Diagnostic::Engine (readonly)
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 |
# File 'lib/parser/source/range.rb', line 24 class Range 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 Range.new(@source_buffer, @begin_pos, @begin_pos) end ## # @return [Range] a zero-length range located just after the end # of this range. # def end Range.new(@source_buffer, @end_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 self.begin.line != self.end.line raise RangeError, "#{self.inspect} spans more than one line" end self.begin.column...self.end.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(self.begin_pos...self.end_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 ## # 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 [Integer] new_size # @return [Range] a range beginning at the same point as this range and length `new_size`. # def resize(new_size) Range.new(@source_buffer, @begin_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 ## # @param [Range] other # @return [Boolean] `true` if this range and `other` do not overlap # def disjoint?(other) @begin_pos >= other.end_pos || other.begin_pos >= @end_pos end ## # @param [Range] other # @return [Boolean] `true` if this range and `other` overlap # def overlaps?(other) @begin_pos < other.end_pos && other.begin_pos < @end_pos end ## # Checks if a range is empty; if it contains no characters # @return [Boolean] def empty? @begin_pos == @end_pos end ## # Compares ranges. # @return [Boolean] # def ==(other) other.is_a?(Range) && @source_buffer == other.source_buffer && @begin_pos == other.begin_pos && @end_pos == other.end_pos end ## # @return [String] a human-readable representation of this range. # def inspect "#<Parser::Source::Range #{@source_buffer.name} #{@begin_pos}...#{@end_pos}>" end end |
Instance Method Details
#==(other) ⇒ Boolean
Compares ranges.
226 227 228 229 230 231 |
# File 'lib/parser/source/range.rb', line 226 def ==(other) other.is_a?(Range) && @source_buffer == other.source_buffer && @begin_pos == other.begin_pos && @end_pos == other.end_pos end |
#begin ⇒ Range
Returns a zero-length range located just before the beginning of this range.
51 52 53 |
# File 'lib/parser/source/range.rb', line 51 def begin Range.new(@source_buffer, @begin_pos, @begin_pos) end |
#column ⇒ Integer
Returns zero-based column number of the beginning of this range.
88 89 90 |
# File 'lib/parser/source/range.rb', line 88 def column @source_buffer.column_for_position(@begin_pos) end |
#column_range ⇒ ::Range
Returns a range of columns spanned by this range.
110 111 112 113 114 115 116 |
# File 'lib/parser/source/range.rb', line 110 def column_range if self.begin.line != self.end.line raise RangeError, "#{self.inspect} spans more than one line" end self.begin.column...self.end.column end |
#disjoint?(other) ⇒ Boolean
Returns true
if this range and other
do not overlap.
203 204 205 |
# File 'lib/parser/source/range.rb', line 203 def disjoint?(other) @begin_pos >= other.end_pos || other.begin_pos >= @end_pos end |
#empty? ⇒ Boolean
Checks if a range is empty; if it contains no characters
218 219 220 |
# File 'lib/parser/source/range.rb', line 218 def empty? @begin_pos == @end_pos end |
#end ⇒ Range
Returns a zero-length range located just after the end of this range.
59 60 61 |
# File 'lib/parser/source/range.rb', line 59 def end Range.new(@source_buffer, @end_pos, @end_pos) end |
#inspect ⇒ String
Returns a human-readable representation of this range.
236 237 238 |
# File 'lib/parser/source/range.rb', line 236 def inspect "#<Parser::Source::Range #{@source_buffer.name} #{@begin_pos}...#{@end_pos}>" end |
#intersect(other) ⇒ Range
Returns overlapping region of this range and other
, or nil
if they do not overlap.
191 192 193 194 195 196 197 |
# File 'lib/parser/source/range.rb', line 191 def intersect(other) unless disjoint?(other) Range.new(@source_buffer, [@begin_pos, other.begin_pos].max, [@end_pos, other.end_pos].min) end end |
#is?(*what) ⇒ Boolean
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')
.
137 138 139 |
# File 'lib/parser/source/range.rb', line 137 def is?(*what) what.include?(source) end |
#join(other) ⇒ Range
Returns smallest possible range spanning both this range and other
.
180 181 182 183 184 |
# File 'lib/parser/source/range.rb', line 180 def join(other) Range.new(@source_buffer, [@begin_pos, other.begin_pos].min, [@end_pos, other.end_pos].max) end |
#last_column ⇒ Integer
Returns zero-based column number of the end of this range.
102 103 104 |
# File 'lib/parser/source/range.rb', line 102 def last_column @source_buffer.column_for_position(@end_pos) end |
#last_line ⇒ Integer
Returns line number of the end of this range.
95 96 97 |
# File 'lib/parser/source/range.rb', line 95 def last_line @source_buffer.line_for_position(@end_pos) end |
#line ⇒ Integer Also known as: first_line
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.
79 80 81 |
# File 'lib/parser/source/range.rb', line 79 def line @source_buffer.line_for_position(@begin_pos) end |
#overlaps?(other) ⇒ Boolean
Returns true
if this range and other
overlap.
211 212 213 |
# File 'lib/parser/source/range.rb', line 211 def overlaps?(other) @begin_pos < other.end_pos && other.begin_pos < @end_pos end |
#resize(new_size) ⇒ Range
Returns a range beginning at the same point as this range and length new_size
.
172 173 174 |
# File 'lib/parser/source/range.rb', line 172 def resize(new_size) Range.new(@source_buffer, @begin_pos, @begin_pos + new_size) end |
#size ⇒ Integer Also known as: length
Returns amount of characters included in this range.
66 67 68 |
# File 'lib/parser/source/range.rb', line 66 def size @end_pos - @begin_pos end |
#source ⇒ String
Returns all source code covered by this range.
128 129 130 |
# File 'lib/parser/source/range.rb', line 128 def source @source_buffer.slice(self.begin_pos...self.end_pos) end |
#source_line ⇒ String
Returns a line of source code containing the beginning of this range.
121 122 123 |
# File 'lib/parser/source/range.rb', line 121 def source_line @source_buffer.source_line(line) end |
#to_a ⇒ Array(Integer)
Returns a set of character indexes contained in this range.
144 145 146 |
# File 'lib/parser/source/range.rb', line 144 def to_a (@begin_pos...@end_pos).to_a end |
#to_s ⇒ String
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.
162 163 164 165 166 |
# File 'lib/parser/source/range.rb', line 162 def to_s line, column = @source_buffer.decompose_position(@begin_pos) [@source_buffer.name, line, column + 1].join(':') end |