summaryrefslogtreecommitdiff
path: root/src/testdir/test_tagfunc.vim
blob: 8573ea588c23b1c035f0cfd1c6ee21cb9f8ee0a1 (plain)
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
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
" Test 'tagfunc'

source vim9.vim

func TagFunc(pat, flag, info)
  let g:tagfunc_args = [a:pat, a:flag, a:info]
  let tags = []
  for num in range(1,10)
    let tags += [{
          \ 'cmd': '2', 'name': 'nothing'.num, 'kind': 'm',
          \ 'filename': 'Xfile1', 'user_data': 'somedata'.num,
          \}]
  endfor
  return tags
endfunc

func Test_tagfunc()
  set tagfunc=TagFunc
  new Xfile1
  call setline(1, ['empty', 'one()', 'empty'])
  write

  call assert_equal({'cmd': '2', 'static': 0,
        \ 'name': 'nothing2', 'user_data': 'somedata2',
        \ 'kind': 'm', 'filename': 'Xfile1'}, taglist('.')[1])

  call settagstack(win_getid(), {'items': []})

  tag arbitrary
  call assert_equal('arbitrary', g:tagfunc_args[0])
  call assert_equal('', g:tagfunc_args[1])
  call assert_equal('somedata1', gettagstack().items[0].user_data)
  5tag arbitrary
  call assert_equal('arbitrary', g:tagfunc_args[0])
  call assert_equal('', g:tagfunc_args[1])
  call assert_equal('somedata5', gettagstack().items[1].user_data)
  pop
  tag
  call assert_equal('arbitrary', g:tagfunc_args[0])
  call assert_equal('', g:tagfunc_args[1])
  call assert_equal('somedata5', gettagstack().items[1].user_data)

  let g:tagfunc_args=[]
  execute "normal! \<c-]>"
  call assert_equal('one', g:tagfunc_args[0])
  call assert_equal('c', g:tagfunc_args[1])

  let g:tagfunc_args=[]
  execute "tag /foo$"
  call assert_equal('foo$', g:tagfunc_args[0])
  call assert_equal('r', g:tagfunc_args[1])

  set cpt=t
  let g:tagfunc_args=[]
  execute "normal! i\<c-n>\<c-y>"
  call assert_equal('\<\k\k', g:tagfunc_args[0])
  call assert_equal('cir', g:tagfunc_args[1])
  call assert_equal('nothing1', getline('.')[0:7])

  let g:tagfunc_args=[]
  execute "normal! ono\<c-n>\<c-n>\<c-y>"
  call assert_equal('\<no', g:tagfunc_args[0])
  call assert_equal('cir', g:tagfunc_args[1])
  call assert_equal('nothing2', getline('.')[0:7])

  func BadTagFunc1(...)
    return 0
  endfunc
  func BadTagFunc2(...)
    return [1]
  endfunc
  func BadTagFunc3(...)
    return [{'name': 'foo'}]
  endfunc

  for &tagfunc in ['BadTagFunc1', 'BadTagFunc2', 'BadTagFunc3']
    try
      tag nothing
      call assert_false(1, 'tag command should have failed')
    catch
      call assert_exception('E987:')
    endtry
    exe 'delf' &tagfunc
  endfor

  func NullTagFunc(...)
    return v:null
  endfunc
  set tags= tfu=NullTagFunc
  call assert_fails('tag nothing', 'E433:')
  delf NullTagFunc

  bwipe!
  set tags& tfu& cpt& 
  call delete('Xfile1')
endfunc

" Test for modifying the tag stack from a tag function and jumping to a tag
" from a tag function
func Test_tagfunc_settagstack()
  func Mytagfunc1(pat, flags, info)
    call settagstack(1, {'tagname' : 'mytag', 'from' : [0, 10, 1, 0]})
    return [{'name' : 'mytag', 'filename' : 'Xtest', 'cmd' : '1'}]
  endfunc
  set tagfunc=Mytagfunc1
  call writefile([''], 'Xtest')
  call assert_fails('tag xyz', 'E986:')

  func Mytagfunc2(pat, flags, info)
    tag test_tag
    return [{'name' : 'mytag', 'filename' : 'Xtest', 'cmd' : '1'}]
  endfunc
  set tagfunc=Mytagfunc2
  call assert_fails('tag xyz', 'E986:')

  call delete('Xtest')
  set tagfunc&
  delfunc Mytagfunc1
  delfunc Mytagfunc2
endfunc

" Script local tagfunc callback function
func s:ScriptLocalTagFunc(pat, flags, info)
  let g:ScriptLocalFuncArgs = [a:pat, a:flags, a:info]
  return v:null
endfunc

" Test for different ways of setting the 'tagfunc' option
func Test_tagfunc_callback()
  func MytagFunc1(val, pat, flags, info)
    let g:MytagFunc1_args = [a:val, a:pat, a:flags, a:info]
    return v:null
  endfunc

  " Test for using a function()
  set tagfunc=function('MytagFunc1',[10])
  new | only
  let g:MytagFunc1_args = []
  call assert_fails('tag a11', 'E433:')
  call assert_equal([10, 'a11', '', {}], g:MytagFunc1_args)

  " Using a funcref variable to set 'tagfunc'
  let Fn = function('MytagFunc1', [11])
  let &tagfunc = Fn
  new | only
  let g:MytagFunc1_args = []
  call assert_fails('tag a12', 'E433:')
  call assert_equal([11, 'a12', '', {}], g:MytagFunc1_args)

  " Using a string(funcref_variable) to set 'tagfunc'
  let Fn = function('MytagFunc1', [12])
  let &tagfunc = string(Fn)
  new | only
  let g:MytagFunc1_args = []
  call assert_fails('tag a12', 'E433:')
  call assert_equal([12, 'a12', '', {}], g:MytagFunc1_args)

  " Test for using a funcref()
  func MytagFunc2(pat, flags, info)
    let g:MytagFunc2_args = [a:pat, a:flags, a:info]
    return v:null
  endfunc
  set tagfunc=funcref('MytagFunc1',[13])
  new | only
  let g:MytagFunc1_args = []
  call assert_fails('tag a13', 'E433:')
  call assert_equal([13, 'a13', '', {}], g:MytagFunc1_args)

  " Using a funcref variable to set 'tagfunc'
  let Fn = funcref('MytagFunc1', [14])
  let &tagfunc = Fn
  new | only
  let g:MytagFunc1_args = []
  call assert_fails('tag a14', 'E433:')
  call assert_equal([14, 'a14', '', {}], g:MytagFunc1_args)

  " Using a string(funcref_variable) to set 'tagfunc'
  let Fn = funcref('MytagFunc1', [15])
  let &tagfunc = string(Fn)
  new | only
  let g:MytagFunc1_args = []
  call assert_fails('tag a14', 'E433:')
  call assert_equal([15, 'a14', '', {}], g:MytagFunc1_args)

  " Test for using a script local function
  set tagfunc=<SID>ScriptLocalTagFunc
  new | only
  let g:ScriptLocalFuncArgs = []
  call assert_fails('tag a15', 'E433:')
  call assert_equal(['a15', '', {}], g:ScriptLocalFuncArgs)

  " Test for using a script local funcref variable
  let Fn = function("s:ScriptLocalTagFunc")
  let &tagfunc= Fn
  new | only
  let g:ScriptLocalFuncArgs = []
  call assert_fails('tag a16', 'E433:')
  call assert_equal(['a16', '', {}], g:ScriptLocalFuncArgs)

  " Test for using a string(script local funcref variable)
  let Fn = function("s:ScriptLocalTagFunc")
  let &tagfunc= string(Fn)
  new | only
  let g:ScriptLocalFuncArgs = []
  call assert_fails('tag a16', 'E433:')
  call assert_equal(['a16', '', {}], g:ScriptLocalFuncArgs)

  " Test for using a lambda function
  set tagfunc={a,\ b,\ c\ ->\ MytagFunc1(16,\ a,\ b,\ c)}
  new | only
  let g:MytagFunc1_args = []
  call assert_fails('tag a17', 'E433:')
  call assert_equal([16, 'a17', '', {}], g:MytagFunc1_args)

  " Set 'tagfunc' to a lambda expression
  let &tagfunc = {a, b, c -> MytagFunc1(17, a, b, c)}
  new | only
  let g:MytagFunc1_args = []
  call assert_fails('tag a18', 'E433:')
  call assert_equal([17, 'a18', '', {}], g:MytagFunc1_args)

  " Set 'tagfunc' to a string(lambda expression)
  let &tagfunc = '{a, b, c -> MytagFunc1(18, a, b, c)}'
  new | only
  let g:MytagFunc1_args = []
  call assert_fails('tag a18', 'E433:')
  call assert_equal([18, 'a18', '', {}], g:MytagFunc1_args)

  " Set 'tagfunc' to a variable with a lambda expression
  let Lambda = {a, b, c -> MytagFunc1(19, a, b, c)}
  let &tagfunc = Lambda
  new | only
  let g:MytagFunc1_args = []
  call assert_fails("tag a19", "E433:")
  call assert_equal([19, 'a19', '', {}], g:MytagFunc1_args)

  " Set 'tagfunc' to a string(variable with a lambda expression)
  let Lambda = {a, b, c -> MytagFunc1(20, a, b, c)}
  let &tagfunc = string(Lambda)
  new | only
  let g:MytagFunc1_args = []
  call assert_fails("tag a19", "E433:")
  call assert_equal([20, 'a19', '', {}], g:MytagFunc1_args)

  " Test for using a lambda function with incorrect return value
  let Lambda = {s -> strlen(s)}
  let &tagfunc = string(Lambda)
  new | only
  call assert_fails("tag a20", "E987:")

  " Test for clearing the 'tagfunc' option
  set tagfunc=''
  set tagfunc&

  call assert_fails("set tagfunc=function('abc')", "E700:")
  call assert_fails("set tagfunc=funcref('abc')", "E700:")
  let &tagfunc = "{a -> 'abc'}"
  call assert_fails("echo taglist('a')", "E987:")

  " Using Vim9 lambda expression in legacy context should fail
  set tagfunc=(a,\ b,\ c)\ =>\ g:MytagFunc1(21,\ a,\ b,\ c)
  new | only
  let g:MytagFunc1_args = []
  call assert_fails("tag a17", "E117:")
  call assert_equal([], g:MytagFunc1_args)

  " set 'tagfunc' to a non-existing function
  call assert_fails("set tagfunc=function('NonExistingFunc')", 'E700:')
  call assert_fails("let &tagfunc = function('NonExistingFunc')", 'E700:')
  call assert_fails("tag axb123", 'E426:')
  bw!

  " Vim9 tests
  let lines =<< trim END
    vim9script

    # Test for using function()
    def Vim9tagFunc(val: number, pat: string, flags: string, info: dict<any>): any
      g:Vim9tagFuncArgs = [val, pat, flags, info]
      return null
    enddef
    set tagfunc=function('Vim9tagFunc',\ [60])
    new | only
    g:Vim9tagFuncArgs = []
    assert_fails('tag a10', 'E433:')
    assert_equal([60, 'a10', '', {}], g:Vim9tagFuncArgs)

    # Test for using a lambda
    &tagfunc = (a, b, c) => MytagFunc1(61, a, b, c)
    new | only
    g:MytagFunc1_args = []
    assert_fails('tag a20', 'E433:')
    assert_equal([61, 'a20', '', {}], g:MytagFunc1_args)

    # Test for using a string(lambda)
    &tagfunc = '(a, b, c) => MytagFunc1(62, a, b, c)'
    new | only
    g:MytagFunc1_args = []
    assert_fails('tag a20', 'E433:')
    assert_equal([62, 'a20', '', {}], g:MytagFunc1_args)

    # Test for using a variable with a lambda expression
    var Fn: func = (a, b, c) => MytagFunc1(63, a, b, c)
    &tagfunc = Fn
    new | only
    g:MytagFunc1_args = []
    assert_fails('tag a30', 'E433:')
    assert_equal([63, 'a30', '', {}], g:MytagFunc1_args)

    # Test for using a variable with a lambda expression
    Fn = (a, b, c) => MytagFunc1(64, a, b, c)
    &tagfunc = string(Fn)
    new | only
    g:MytagFunc1_args = []
    assert_fails('tag a30', 'E433:')
    assert_equal([64, 'a30', '', {}], g:MytagFunc1_args)
  END
  call CheckScriptSuccess(lines)

  " cleanup
  delfunc MytagFunc1
  delfunc MytagFunc2
  set tagfunc&
  %bw!
endfunc

" vim: shiftwidth=2 sts=2 expandtab