Class: Neovim::Client

Inherits:
Object
  • Object
show all
Defined in:
lib/neovim/client.rb

Overview

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

The methods documented here were generated using NVIM v0.2.2

See Also:

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(session, api) ⇒ Client

Returns a new instance of Client.



26
27
28
29
 
# File 'lib/neovim/client.rb', line 26

def initialize(session, api)
  @session = session
  @api = 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.



32
33
34
35
36
37
38
 
# File 'lib/neovim/client.rb', line 32

def method_missing(method_name, *args)
  if func = @api.function_for_object_method(self, method_name)
    func.call(@session, *args)
  else
    super
  end
end

Instance Attribute Details

#api ⇒ Object (readonly)

Returns the value of attribute api.



17
18
19
 
# File 'lib/neovim/client.rb', line 17

def api
  @api
end

#session ⇒ Object (readonly)

Returns the value of attribute session.



17
18
19
 
# File 'lib/neovim/client.rb', line 17

def session
  @session
end

Class Method Details

.from_event_loop(event_loop, session = Session.new(event_loop)) ⇒ Object 



19
20
21
22
23
24
 
# File 'lib/neovim/client.rb', line 19

def self.from_event_loop(event_loop, session=Session.new(event_loop))
  api = API.new(session.request(:nvim_get_api_info))
  event_loop.register_types(api, session)

  new(session, api)
end

Instance Method Details

#call_atomic ⇒ Array

See :h nvim_call_atomic()

Returns:

  • (Array) 



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

#call_function(args) ⇒ Object

See :h nvim_call_function()

Parameters:

  • args (Array)

Returns:

  • (Object) 



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

#command ⇒ void

This method returns an undefined value.

See :h nvim_command()




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

#command_output ⇒ String

See :h nvim_command_output()

Returns:

  • (String) 



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

#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:

See Also:



58
59
60
 
# File 'lib/neovim/client.rb', line 58

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

#del_current_line ⇒ void

This method returns an undefined value.

See :h nvim_del_current_line()




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

#del_var ⇒ void

This method returns an undefined value.

See :h nvim_del_var()




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

#err_write ⇒ void

This method returns an undefined value.

See :h nvim_err_write()




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

#err_writeln ⇒ void

This method returns an undefined value.

See :h nvim_err_writeln()




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

#eval ⇒ Object

See :h nvim_eval()

Returns:

  • (Object) 



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

#evaluate(expr) ⇒ Object

Evaluate the VimL expression (alias for nvim_eval).

Examples:

Return a list from VimL

client.evaluate('[1, 2]') # => [1, 2]

Parameters:

  • expr (String) —

    A VimL expression.

Returns:

  • (Object) 


68
69
70
 
# File 'lib/neovim/client.rb', line 68

def evaluate(expr)
  @api.function_for_object_method(self, :eval).call(@session, expr)
end

#execute_lua(args) ⇒ Object

See :h nvim_execute_lua()

Parameters:

  • args (Array)

Returns:

  • (Object) 



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

#feedkeys(mode, escape_csi) ⇒ void

This method returns an undefined value.

See :h nvim_feedkeys()

Parameters:

  • mode (String)
  • escape_csi (Boolean) 



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

#get_api_info ⇒ Array

See :h nvim_get_api_info()

Returns:

  • (Array) 



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

#get_color_by_name ⇒ Integer

See :h nvim_get_color_by_name()

Returns:

  • (Integer) 



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

#get_color_map ⇒ Hash

See :h nvim_get_color_map()

Returns:

  • (Hash) 



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

#get_current_buf ⇒ Buffer

See :h nvim_get_current_buf()

Returns:




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

#get_current_line ⇒ String

See :h nvim_get_current_line()

Returns:

  • (String) 



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

#get_current_tabpage ⇒ Tabpage

See :h nvim_get_current_tabpage()

Returns:




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

#get_current_win ⇒ Window

See :h nvim_get_current_win()

Returns:




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

#get_hl_by_id(rgb) ⇒ Hash

See :h nvim_get_hl_by_id()

Parameters:

  • rgb (Boolean)

Returns:

  • (Hash) 



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

#get_hl_by_name(rgb) ⇒ Hash

See :h nvim_get_hl_by_name()

Parameters:

  • rgb (Boolean)

Returns:

  • (Hash) 



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

#get_keymap ⇒ Array<Hash>

See :h nvim_get_keymap()

Returns:

  • (Array<Hash>) 



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

#get_mode ⇒ Hash

See :h nvim_get_mode()

Returns:

  • (Hash) 



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

#get_option ⇒ Object

See :h nvim_get_option()

Returns:

  • (Object) 



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

#get_var ⇒ Object

See :h nvim_get_var()

Returns:

  • (Object) 



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

#get_vvar ⇒ Object

See :h nvim_get_vvar()

Returns:

  • (Object) 



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

#input ⇒ Integer

See :h nvim_input()

Returns:

  • (Integer) 



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

#list_bufs ⇒ Array<Buffer>

See :h nvim_list_bufs()

Returns:




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

#list_runtime_paths ⇒ Array<String>

See :h nvim_list_runtime_paths()

Returns:

  • (Array<String>) 



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

#list_tabpages ⇒ Array<Tabpage>

See :h nvim_list_tabpages()

Returns:




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

#list_wins ⇒ Array<Window>

See :h nvim_list_wins()

Returns:




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

#message(string) ⇒ void

This method returns an undefined value.

Display a message.

Parameters:

  • string (String) —

    The message.



76
77
78
 
# File 'lib/neovim/client.rb', line 76

def message(string)
  out_write(string)
end

#methods(*args) ⇒ Object

Extend methods to include RPC methods.



46
47
48
 
# File 'lib/neovim/client.rb', line 46

def methods(*args)
  super | rpc_methods
end

#out_write ⇒ void

This method returns an undefined value.

See :h nvim_out_write()




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

#replace_termcodes(from_part, do_lt, special) ⇒ String

See :h nvim_replace_termcodes()

Parameters:

  • from_part (Boolean)
  • do_lt (Boolean)
  • special (Boolean)

Returns:

  • (String) 



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

#respond_to?(method_name) ⇒ Boolean

Extend respond_to? to support RPC methods.

Returns:

  • (Boolean) 


41
42
43
 
# File 'lib/neovim/client.rb', line 41

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

#set_current_buf ⇒ void

This method returns an undefined value.

See :h nvim_set_current_buf()




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

#set_current_dir ⇒ void

This method returns an undefined value.

See :h nvim_set_current_dir()




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

#set_current_line ⇒ void

This method returns an undefined value.

See :h nvim_set_current_line()




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

#set_current_tabpage ⇒ void

This method returns an undefined value.

See :h nvim_set_current_tabpage()




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

#set_current_win ⇒ void

This method returns an undefined value.

See :h nvim_set_current_win()




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

#set_option(key, value) ⇒ Object #set_option(optstr) ⇒ Object

Set an option.

Examples:

Set the timeoutlen option

client.set_option("timeoutlen", 0)
client.set_option("timeoutlen=0")

Overloads:

  • #set_option(key, value) ⇒ Object

    Parameters:

    • key (String)
    • value (String)
  • #set_option(optstr) ⇒ Object

    Parameters:

    • optstr (String) 


92
93
94
95
96
97
98
 
# File 'lib/neovim/client.rb', line 92

def set_option(*args)
  if args.size > 1
    @api.function_for_object_method(self, :set_option).call(@session, *args)
  else
    @api.function_for_object_method(self, :command).call(@session, "set #{args.first}")
  end
end

#set_var(value) ⇒ void

This method returns an undefined value.

See :h nvim_set_var()

Parameters:

  • value (Object) 



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

#shutdown ⇒ Object 



100
101
102
 
# File 'lib/neovim/client.rb', line 100

def shutdown
  @session.shutdown
end

#strwidth ⇒ Integer

See :h nvim_strwidth()

Returns:

  • (Integer) 



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

#subscribe ⇒ void

This method returns an undefined value.

See :h nvim_subscribe()




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

#ui_attach(height, options) ⇒ void

This method returns an undefined value.

See :h nvim_ui_attach()

Parameters:

  • height (Integer)
  • options (Hash) 



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

#ui_detach ⇒ void

This method returns an undefined value.

See :h nvim_ui_detach()




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

#ui_set_option(value) ⇒ void

This method returns an undefined value.

See :h nvim_ui_set_option()

Parameters:

  • value (Object) 



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

#ui_try_resize(height) ⇒ void

This method returns an undefined value.

See :h nvim_ui_try_resize()

Parameters:

  • height (Integer) 



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

#unsubscribe ⇒ void

This method returns an undefined value.

See :h nvim_unsubscribe()




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