Class: Solargraph::Range
- Inherits:
-
Object
- Object
- Solargraph::Range
- Defined in:
- lib/solargraph/range.rb
Overview
A pair of positions that compose a section of text.
Instance Attribute Summary collapse
- #ending ⇒ Position readonly
- #start ⇒ Position readonly
Class Method Summary collapse
-
.from_expr(expr) ⇒ Range
Get a range from a Parser range, usually found in Parser::AST::Node#location#expression.
-
.from_node(node) ⇒ Range
Get a range from a node.
-
.from_to(l1, c1, l2, c2) ⇒ Range
Create a range from a pair of lines and characters.
Instance Method Summary collapse
- #==(other) ⇒ Object
-
#contain?(position) ⇒ Boolean
True if the specified position is inside the range.
-
#include?(position) ⇒ Boolean
True if the range contains the specified position and the position does not precede it.
-
#initialize(start, ending) ⇒ Range
constructor
A new instance of Range.
-
#to_hash ⇒ Hash<Symbol, Position>
Get a hash of the range.
Constructor Details
#initialize(start, ending) ⇒ Range
Returns a new instance of Range.
13 14 15 16 |
# File 'lib/solargraph/range.rb', line 13 def initialize start, ending @start = start @ending = ending end |
Instance Attribute Details
#ending ⇒ Position (readonly)
9 10 11 |
# File 'lib/solargraph/range.rb', line 9 def ending @ending end |
Class Method Details
.from_expr(expr) ⇒ Range
Get a range from a Parser range, usually found in Parser::AST::Node#location#expression.
72 73 74 |
# File 'lib/solargraph/range.rb', line 72 def self.from_expr expr from_to(expr.line, expr.column, expr.last_line, expr.last_column) end |
.from_node(node) ⇒ Range
Get a range from a node.
63 64 65 |
# File 'lib/solargraph/range.rb', line 63 def self.from_node node from_expr(node.loc.expression) end |
Instance Method Details
#==(other) ⇒ Object
76 77 78 79 |
# File 'lib/solargraph/range.rb', line 76 def == other return false unless other.is_a?(Range) start == other.start && ending == other.ending end |
#contain?(position) ⇒ Boolean
True if the specified position is inside the range.
33 34 35 36 37 38 |
# File 'lib/solargraph/range.rb', line 33 def contain? position return false if position.line < start.line || position.line > ending.line return false if position.line == start.line && position.character < start.character return false if position.line == ending.line && position.character > ending.character true end |
#include?(position) ⇒ Boolean
True if the range contains the specified position and the position does not precede it.
44 45 46 |
# File 'lib/solargraph/range.rb', line 44 def include? position contain?(position) && !(position.line == start.line && position.character == start.character) end |
#to_hash ⇒ Hash<Symbol, Position>
Get a hash of the range. This representation is suitable for use in the language server protocol.
22 23 24 25 26 27 |
# File 'lib/solargraph/range.rb', line 22 def to_hash { start: start.to_hash, end: ending.to_hash } end |