class Solargraph::Source::Cursor

Information about a single Position in a Source, including the word located there.

Attributes

position [R]

@return [Position]

source [R]

@return [Source]

Public Class Methods

new (source, position)

Source

# File lib/solargraph/source/cursor.rb, line 17
def initialize source, position
  @source = source
  @position = Position.normalize(position)
end

@param source [Source] @param position [Position, Array(Integer, Integer)]

Public Instance Methods

argument? ()

Source

# File lib/solargraph/source/cursor.rb, line 91
def argument?
  # @argument ||= !signature_position.nil?
  @argument ||= !recipient.nil?
end

True if the statement at the cursor is an argument to a previous method.

Given the code ‘process(foo)`, a cursor pointing at `foo` would identify it as an argument being passed to the `process` method.

If argument? is true, the recipient method will return a cursor that points to the method receiving the argument.

@return [Boolean]

chain ()

Source

# File lib/solargraph/source/cursor.rb, line 77
def chain
  @chain ||= SourceChainer.chain(source, position)
end

@return [Chain]

comment? ()

Source

# File lib/solargraph/source/cursor.rb, line 97
def comment?
  @comment ||= source.comment_at?(position)
end

@return [Boolean]

end_of_word ()

Source

# File lib/solargraph/source/cursor.rb, line 53
def end_of_word
  @end_of_word ||= begin
    match = source.code[offset..-1].to_s.match(end_word_pattern)
    match ? match[0] : ''
  end
end

The part of the word after the current position. Given the text ‘foo.bar`, the end_of_word at position (0,6) is `r`.

@return [String]

filename ()

Source

# File lib/solargraph/source/cursor.rb, line 23
def filename
  source.filename
end

@return [String]

node ()

Source

# File lib/solargraph/source/cursor.rb, line 119
def node
  @node ||= source.node_at(position.line, position.column)
end

@return [AST::Node]

node_position ()

Source

# File lib/solargraph/source/cursor.rb, line 124
def node_position
  @node_position ||= begin
    if start_of_word.empty?
      match = source.code[0, offset].match(/\s*(\.|:+)\s*$/)
      if match
        Position.from_offset(source.code, offset - match[0].length)
      else
        position
      end
    else
      position
    end
  end
end

@return [Position]

offset ()

Source

# File lib/solargraph/source/cursor.rb, line 145
def offset
  @offset ||= Position.to_offset(source.code, position)
end

@return [Integer]

range ()

Source

# File lib/solargraph/source/cursor.rb, line 68
def range
  @range ||= begin
    s = Position.from_offset(source.code, offset - start_of_word.length)
    e = Position.from_offset(source.code, offset + end_of_word.length)
    Solargraph::Range.new(s, e)
  end
end

The range of the word at the current position.

@return [Range]

receiver ()

Alias for: recipient

recipient ()

Source

# File lib/solargraph/source/cursor.rb, line 110
def recipient
  @recipient ||= begin
    node = recipient_node
    node ? Cursor.new(source, Range.from_node(node).ending) : nil
  end
end

Get a cursor pointing to the method that receives the current statement as an argument.

@return [Cursor, nil]

Also aliased as: receiver

recipient_node ()

Source

# File lib/solargraph/source/cursor.rb, line 140
def recipient_node
  @recipient_node ||= Solargraph::Parser::NodeMethods.find_recipient_node(self)
end

@return [Parser::AST::Node, nil]

start_of_constant? ()

Source

# File lib/solargraph/source/cursor.rb, line 61
def start_of_constant?
  source.code[offset-2, 2] == '::'
end

@return [Boolean]

start_of_word ()

Source

# File lib/solargraph/source/cursor.rb, line 39
def start_of_word
  @start_of_word ||= begin
    match = source.code[0..offset-1].to_s.match(start_word_pattern)
    result = (match ? match[0] : '')
    # Including the preceding colon if the word appears to be a symbol
    result = ":#{result}" if source.code[0..offset-result.length-1].end_with?(':') and !source.code[0..offset-result.length-1].end_with?('::')
    result
  end
end

The part of the word before the current position. Given the text ‘foo.bar`, the start_of_word at position(0, 6) is `ba`.

@return [String]

string? ()

Source

# File lib/solargraph/source/cursor.rb, line 102
def string?
  @string ||= source.string_at?(position)
end

@return [Boolean]

word ()

Source

# File lib/solargraph/source/cursor.rb, line 31
def word
  @word ||= start_of_word + end_of_word
end

The whole word at the current position. Given the text ‘foo.bar`, the word at position(0,6) is `bar`.

@return [String]

Private Instance Methods

end_word_pattern ()

Source

# File lib/solargraph/source/cursor.rb, line 161
def end_word_pattern
  /^([a-z0-9_]|[^\u0000-\u007F])*[?!]?/i
end

A regular expression to find the end of a word from an offset.

@return [Regexp]

start_word_pattern ()

Source

# File lib/solargraph/source/cursor.rb, line 154
def start_word_pattern
  /(@{1,2}|\$)?([a-z0-9_]|[^\u0000-\u007F])*\z/i
end

A regular expression to find the start of a word from an offset.

@return [Regexp]