Class: Solargraph::Range

Inherits:
Object
  • Object
show all
Defined in:
lib/solargraph/range.rb

Overview

A pair of positions that compose a section of text.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(start, ending) ⇒ Range

Returns a new instance of Range

Parameters:


13
14
15
16
# File 'lib/solargraph/range.rb', line 13

def initialize start, ending
  @start = start
  @ending = ending
end

Instance Attribute Details

#endingPosition (readonly)

Returns:


9
10
11
# File 'lib/solargraph/range.rb', line 9

def ending
  @ending
end

#startPosition (readonly)

Returns:


6
7
8
# File 'lib/solargraph/range.rb', line 6

def start
  @start
end

Class Method Details

.from_expr(expr) ⇒ Range

Get a range from a Parser range, usually found in Parser::AST::Node#location#expression.

Parameters:

  • expr (Parser::Source::Range)

Returns:


74
75
76
# File 'lib/solargraph/range.rb', line 74

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.

Parameters:

  • node (Parser::AST::Node)

Returns:


65
66
67
# File 'lib/solargraph/range.rb', line 65

def self.from_node node
  from_expr(node.loc.expression)
end

.from_to(l1, c1, l2, c2) ⇒ Range

Create a range from a pair of lines and characters.

Parameters:

  • l1 (Integer)

    Starting line

  • c1 (Integer)

    Starting character

  • l2 (Integer)

    Ending line

  • c2 (Integer)

    Ending character

Returns:


57
58
59
# File 'lib/solargraph/range.rb', line 57

def self.from_to l1, c1, l2, c2
  Range.new(Position.new(l1, c1), Position.new(l2, c2))
end

Instance Method Details

#==(other) ⇒ Object


78
79
80
81
# File 'lib/solargraph/range.rb', line 78

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.

Parameters:

  • position (Position, Array(Integer, Integer))

Returns:

  • (Boolean)

33
34
35
36
37
38
39
# File 'lib/solargraph/range.rb', line 33

def contain? position
  position = Position.normalize(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.

Parameters:

  • position (Position, Array(Integer, Integer))

Returns:

  • (Boolean)

45
46
47
48
# File 'lib/solargraph/range.rb', line 45

def include? position
  position = Position.normalize(position)
  contain?(position) && !(position.line == start.line && position.character == start.character)
end

#inspectObject


83
84
85
# File 'lib/solargraph/range.rb', line 83

def inspect
  "#<#{self.class} #{start.inspect} to #{ending.inspect}>"
end

#to_hashHash<Symbol, Position>

Get a hash of the range. This representation is suitable for use in the language server protocol.

Returns:


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