1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
|
require "neovim/plugin/handler"
module Neovim
class Plugin
# The DSL exposed in +Neovim.plugin+ blocks.
#
# @api public
class DSL < BasicObject
def initialize(plugin)
@plugin = plugin
end
# Register an +nvim+ command. See +:h command+.
#
# @param name [String] The name of the command.
# @param options [Hash] Command options.
# @param &block [Proc, nil] The body of the command.
#
# @option options [Integer] :nargs The number of arguments to accept. See
# +:h command-nargs+.
# @option options [String, Boolean] :range The range argument.
# See +:h command-range+.
# @option options [Integer] :count The default count argument.
# See +:h command-count+.
# @option options [Boolean] :bang Whether the command can take a +!+
# modifier. See +:h command-bang+.
# @option options [Boolean] :register Whether the command can accept a
# register name. See +:h command-register+.
# @option options [String] :complete Set the completion attributes of the
# command. See +:h command-completion+.
# @option options [String] :eval An +nvim+ expression. Gets evaluated and
# passed as an argument to the block.
# @option options [Boolean] :sync (false) Whether +nvim+ should receive
# the return value of the block.
def command(name, options={}, &block)
register_handler(:command, name, options, block)
end
# Register an +nvim+ function. See +:h function+.
#
# @param name [String] The name of the function.
# @param options [Hash] Function options.
# @param &block [Proc, nil] The body of the function.
#
# @option options [String, Boolean] :range The range argument.
# See +:h func-range+.
# @option options [String] :eval An +nvim+ expression. Gets evaluated and
# passed as an argument to the block.
# @option options [Boolean] :sync (false) Whether +nvim+ should receive
# the return value of the block.
def function(name, options={}, &block)
register_handler(:function, name, options, block)
end
# Register an +nvim+ autocmd. See +:h autocmd+.
#
# @param event [String] The event type. See +:h autocmd-events+
# @param options [Hash] Autocmd options.
# @param &block [Proc, nil] The body of the autocmd.
#
# @option options [String] :pattern The buffer name pattern.
# See +:h autocmd-patterns+.
# @option options [String] :eval An +nvim+ expression. Gets evaluated and
# passed as an argument to the block.
def autocmd(event, options={}, &block)
register_handler(:autocmd, event, options, block)
end
private
# Mark this plugin as the Ruby script host started by nvim. Should only
# be used in +Neovim::RubyProvider+.
def script_host!
@plugin.script_host = true
end
# Register a setup block to run once before the host starts. The block
# should expect to receive a single argument, a +Neovim::Client+.
#
# This is used for bootstrapping the ruby provider, and not meant to be
# used publicly in plugin definitions.
def setup(&block)
@plugin.setup_blocks << block
end
# Directly define a synchronous RPC call without a namespace.
#
# This is used for exposing ruby provider calls, and not meant to be used
# publicly in plugin definitions.
def rpc(name, &block)
@plugin.handlers.push(Handler.unqualified(name, block))
end
def register_handler(type, name, options, block)
if type == :autocmd
options = options.dup
else
options = standardize(options.dup)
end
sync = !!options.delete(:sync)
@plugin.handlers.push(
Handler.new(@plugin.source, type, name, sync, options, block)
)
end
def standardize(options)
if options.key?(:range)
options[:range] = "" if options[:range] == true
options[:range] = ::Kernel.String(options[:range])
end
[:bang, :register].each do |opt|
if options[opt]
options[opt] = ""
elsif options.key?(opt)
options.delete(opt)
end
end
options
end
end
end
end
|
