Class: Neovim::Client

Inherits:

Object

• Object
• Neovim::Client

Defined in:

lib/neovim/client.rb

Overview

Client to a running nvim instance. The interface is generated at runtime via the vim_get_api_info RPC call. Some methods return RemoteObject subclasses (i.e. Buffer, Window, or Tabpage), which similarly have dynamically generated interfaces.

See Also:

• Buffer
• Window
• Tabpage

Instance Attribute Summary

• #session ⇒ Object readonly

  Returns the value of attribute session.

Instance Method Summary

• #call_function(fname, args) ⇒ Object
• #change_directory(dir) ⇒ void
• #command(str) ⇒ void
• #command_output(str) ⇒ String
• #current ⇒ Current

  Access to objects belonging to the current nvim context.

• #del_current_line ⇒ void
• #err_write(str) ⇒ void
• #eval(str) ⇒ Object
• #feedkeys(keys, mode, escape_csi) ⇒ void
• #get_api_info ⇒ Array
• #get_buffers ⇒ Array<Buffer>
• #get_color_map ⇒ Dictionary
• #get_current_buffer ⇒ Buffer
• #get_current_line ⇒ String
• #get_current_tabpage ⇒ Tabpage
• #get_current_window ⇒ Window
• #get_option(name) ⇒ Object
• #get_tabpages ⇒ Array<Tabpage>
• #get_var(name) ⇒ Object
• #get_vvar(name) ⇒ Object
• #get_windows ⇒ Array<Window>
• #initialize(session) ⇒ Client constructor

  A new instance of Client.

• #input(keys) ⇒ Fixnum
• #list_runtime_paths ⇒ Array<String>
• #method_missing(method_name, *args) ⇒ Object

  Intercept method calls and delegate to appropriate RPC methods.

• #methods ⇒ Object

  Extend methods to include RPC methods.

• #name_to_color(name) ⇒ Fixnum
• #out_write(str) ⇒ void
• #replace_termcodes(str, from_part, do_lt, special) ⇒ String
• #report_error(str) ⇒ void
• #respond_to?(method_name) ⇒ Boolean

  Extend respond_to? to support RPC methods.

• #set_current_buffer(buffer) ⇒ void
• #set_current_line(line) ⇒ void
• #set_current_tabpage(tabpage) ⇒ void
• #set_current_window(window) ⇒ void
• #set_option(name, value) ⇒ void
• #set_var(name, value) ⇒ Object
• #strwidth(str) ⇒ Fixnum
• #subscribe(event) ⇒ void
• #unsubscribe(event) ⇒ void

Constructor Details

#initialize(session) ⇒ Client

Returns a new instance of Client.

# File 'lib/neovim/client.rb', line 15

def initialize(session)
  session.discover_api

  @session = session
  @api = session.api
end

Dynamic Method Handling

This class handles dynamic methods through the method_missing method

#method_missing(method_name, *args) ⇒ Object

Intercept method calls and delegate to appropriate RPC methods.

# File 'lib/neovim/client.rb', line 23

def method_missing(method_name, *args)
  if func = @api.function("vim_#{method_name}")
    func.call(@session, *args)
  else
    super
  end
end

Instance Attribute Details

#session ⇒ Object (readonly)

Returns the value of attribute session.

# File 'lib/neovim/client.rb', line 13

def session
  @session
end

Instance Method Details

#call_function(fname, args) ⇒ Object

Parameters:

• fname (String)
• args (Array)

Returns:

• (Object)

# File 'lib/neovim/client.rb', line 65

#change_directory(dir) ⇒ void

This method returns an undefined value.

Parameters:

• dir (String)

# File 'lib/neovim/client.rb', line 65

#command(str) ⇒ void

This method returns an undefined value.

Parameters:

• str (String)

# File 'lib/neovim/client.rb', line 65

#command_output(str) ⇒ String

Parameters:

• str (String)

Returns:

• (String)

# File 'lib/neovim/client.rb', line 65

#current ⇒ Current

Access to objects belonging to the current nvim context.

Examples:

Get the current buffer

client.current.buffer

Set the current line

client.current.line = "New line"

Returns:

• (Current)

See Also:

• Neovim::Current

# File 'lib/neovim/client.rb', line 49

def current
  @current ||= Current.new(@session)
end

#del_current_line ⇒ void

This method returns an undefined value.

# File 'lib/neovim/client.rb', line 65

#err_write(str) ⇒ void

This method returns an undefined value.

Parameters:

• str (String)

# File 'lib/neovim/client.rb', line 65

#eval(str) ⇒ Object

Parameters:

• str (String)

Returns:

• (Object)

# File 'lib/neovim/client.rb', line 65

#feedkeys(keys, mode, escape_csi) ⇒ void

This method returns an undefined value.

Parameters:

• keys (String)
• mode (String)
• escape_csi (Boolean)

# File 'lib/neovim/client.rb', line 65

#get_api_info ⇒ Array

Returns:

• (Array)

# File 'lib/neovim/client.rb', line 65

#get_buffers ⇒ Array<Buffer>

Returns:

• (Array<Buffer>)

# File 'lib/neovim/client.rb', line 65

#get_color_map ⇒ Dictionary

Returns:

• (Dictionary)

# File 'lib/neovim/client.rb', line 65

#get_current_buffer ⇒ Buffer

Returns:

• (Buffer)

# File 'lib/neovim/client.rb', line 65

#get_current_line ⇒ String

Returns:

• (String)

# File 'lib/neovim/client.rb', line 65

#get_current_tabpage ⇒ Tabpage

Returns:

• (Tabpage)

# File 'lib/neovim/client.rb', line 65

#get_current_window ⇒ Window

Returns:

• (Window)

# File 'lib/neovim/client.rb', line 65

#get_option(name) ⇒ Object

Parameters:

• name (String)

Returns:

• (Object)

# File 'lib/neovim/client.rb', line 65

#get_tabpages ⇒ Array<Tabpage>

Returns:

• (Array<Tabpage>)

# File 'lib/neovim/client.rb', line 65

#get_var(name) ⇒ Object

Parameters:

• name (String)

Returns:

• (Object)

# File 'lib/neovim/client.rb', line 65

#get_vvar(name) ⇒ Object

Parameters:

• name (String)

Returns:

• (Object)

# File 'lib/neovim/client.rb', line 65

#get_windows ⇒ Array<Window>

Returns:

• (Array<Window>)

# File 'lib/neovim/client.rb', line 65

#input(keys) ⇒ Fixnum

Parameters:

• keys (String)

Returns:

• (Fixnum)

# File 'lib/neovim/client.rb', line 65

#list_runtime_paths ⇒ Array<String>

Returns:

• (Array<String>)

# File 'lib/neovim/client.rb', line 65

#methods ⇒ Object

Extend methods to include RPC methods.

# File 'lib/neovim/client.rb', line 37

def methods
  super | rpc_methods
end

#name_to_color(name) ⇒ Fixnum

Parameters:

• name (String)

Returns:

• (Fixnum)

# File 'lib/neovim/client.rb', line 65

#out_write(str) ⇒ void

This method returns an undefined value.

Parameters:

• str (String)

# File 'lib/neovim/client.rb', line 65

#replace_termcodes(str, from_part, do_lt, special) ⇒ String

Parameters:

• str (String)
• from_part (Boolean)
• do_lt (Boolean)
• special (Boolean)

Returns:

• (String)

# File 'lib/neovim/client.rb', line 65

#report_error(str) ⇒ void

This method returns an undefined value.

Parameters:

• str (String)

# File 'lib/neovim/client.rb', line 65

#respond_to?(method_name) ⇒ Boolean

Extend respond_to? to support RPC methods.

Returns:

• (Boolean)

# File 'lib/neovim/client.rb', line 32

def respond_to?(method_name)
  super || rpc_methods.include?(method_name.to_sym)
end

#set_current_buffer(buffer) ⇒ void

This method returns an undefined value.

Parameters:

• buffer (Buffer)

# File 'lib/neovim/client.rb', line 65

#set_current_line(line) ⇒ void

This method returns an undefined value.

Parameters:

• line (String)

# File 'lib/neovim/client.rb', line 65

#set_current_tabpage(tabpage) ⇒ void

This method returns an undefined value.

Parameters:

• tabpage (Tabpage)

# File 'lib/neovim/client.rb', line 65

#set_current_window(window) ⇒ void

This method returns an undefined value.

Parameters:

• window (Window)

# File 'lib/neovim/client.rb', line 65

#set_option(name, value) ⇒ void

This method returns an undefined value.

Parameters:

• name (String)
• value (Object)

# File 'lib/neovim/client.rb', line 65

#set_var(name, value) ⇒ Object

Parameters:

• name (String)
• value (Object)

Returns:

• (Object)

# File 'lib/neovim/client.rb', line 65

#strwidth(str) ⇒ Fixnum

Parameters:

• str (String)

Returns:

• (Fixnum)

# File 'lib/neovim/client.rb', line 65

#subscribe(event) ⇒ void

This method returns an undefined value.

Parameters:

• event (String)

# File 'lib/neovim/client.rb', line 65

#unsubscribe(event) ⇒ void

This method returns an undefined value.

Parameters:

• event (String)

# File 'lib/neovim/client.rb', line 65