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
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
|
" Tests for the Vim script debug commands
source shared.vim
source screendump.vim
source check.vim
CheckRunVimInTerminal
func CheckCWD()
" Check that the longer lines don't wrap due to the length of the script name
" in cwd
let script_len = len( getcwd() .. '/Xtest1.vim' )
let longest_line = len( 'Breakpoint in "" line 1' )
if script_len > ( 75 - longest_line )
throw 'Skipped: Your CWD has too many characters'
endif
endfunc
command! -nargs=0 -bar CheckCWD call CheckCWD()
func CheckDbgOutput(buf, lines, options = {})
" Verify the expected output
let lnum = 20 - len(a:lines)
for l in a:lines
if get(a:options, 'match', 'equal') ==# 'pattern'
call WaitForAssert({-> assert_match(l, term_getline(a:buf, lnum))}, 200)
else
call WaitForAssert({-> assert_equal(l, term_getline(a:buf, lnum))}, 200)
endif
let lnum += 1
endfor
endfunc
" Run a Vim debugger command
" If the expected output argument is supplied, then check for it.
func RunDbgCmd(buf, cmd, ...)
call term_sendkeys(a:buf, a:cmd . "\r")
call TermWait(a:buf)
if a:0 != 0
let options = #{match: 'equal'}
if a:0 > 1
call extend(options, a:2)
endif
call CheckDbgOutput(a:buf, a:1, options)
endif
endfunc
" Debugger tests
func Test_Debugger()
" Create a Vim script with some functions
let lines =<< trim END
func Foo()
let var1 = 1
let var2 = Bar(var1) + 9
return var2
endfunc
func Bar(var)
let var1 = 2 + a:var
let var2 = Bazz(var1) + 4
return var2
endfunc
func Bazz(var)
try
let var1 = 3 + a:var
let var3 = "another var"
let var3 = "value2"
catch
let var4 = "exception"
endtry
return var1
endfunc
END
call writefile(lines, 'Xtest.vim')
" Start Vim in a terminal
let buf = RunVimInTerminal('-S Xtest.vim', {})
" Start the Vim debugger
call RunDbgCmd(buf, ':debug echo Foo()', ['cmd: echo Foo()'])
" Create a few stack frames by stepping through functions
call RunDbgCmd(buf, 'step', ['line 1: let var1 = 1'])
call RunDbgCmd(buf, 'step', ['line 2: let var2 = Bar(var1) + 9'])
call RunDbgCmd(buf, 'step', ['line 1: let var1 = 2 + a:var'])
call RunDbgCmd(buf, 'step', ['line 2: let var2 = Bazz(var1) + 4'])
call RunDbgCmd(buf, 'step', ['line 1: try'])
call RunDbgCmd(buf, 'step', ['line 2: let var1 = 3 + a:var'])
call RunDbgCmd(buf, 'step', ['line 3: let var3 = "another var"'])
" check backtrace
call RunDbgCmd(buf, 'backtrace', [
\ ' 2 function Foo[2]',
\ ' 1 Bar[2]',
\ '->0 Bazz',
\ 'line 3: let var3 = "another var"'])
" Check variables in different stack frames
call RunDbgCmd(buf, 'echo var1', ['6'])
call RunDbgCmd(buf, 'up')
call RunDbgCmd(buf, 'back', [
\ ' 2 function Foo[2]',
\ '->1 Bar[2]',
\ ' 0 Bazz',
\ 'line 3: let var3 = "another var"'])
call RunDbgCmd(buf, 'echo var1', ['3'])
call RunDbgCmd(buf, 'u')
call RunDbgCmd(buf, 'bt', [
\ '->2 function Foo[2]',
\ ' 1 Bar[2]',
\ ' 0 Bazz',
\ 'line 3: let var3 = "another var"'])
call RunDbgCmd(buf, 'echo var1', ['1'])
" Undefined variables
call RunDbgCmd(buf, 'step')
call RunDbgCmd(buf, 'frame 2')
call RunDbgCmd(buf, 'echo var3', [
\ 'Error detected while processing function Foo[2]..Bar[2]..Bazz:',
\ 'line 4:',
\ 'E121: Undefined variable: var3'])
" var3 is defined in this level with some other value
call RunDbgCmd(buf, 'fr 0')
call RunDbgCmd(buf, 'echo var3', ['another var'])
call RunDbgCmd(buf, 'step')
call RunDbgCmd(buf, '')
call RunDbgCmd(buf, '')
call RunDbgCmd(buf, '')
call RunDbgCmd(buf, '')
call RunDbgCmd(buf, 'step', [
\ 'function Foo[2]..Bar',
\ 'line 3: End of function'])
call RunDbgCmd(buf, 'up')
" Undefined var2
call RunDbgCmd(buf, 'echo var2', [
\ 'Error detected while processing function Foo[2]..Bar:',
\ 'line 3:',
\ 'E121: Undefined variable: var2'])
" Var2 is defined with 10
call RunDbgCmd(buf, 'down')
call RunDbgCmd(buf, 'echo var2', ['10'])
" Backtrace movements
call RunDbgCmd(buf, 'b', [
\ ' 1 function Foo[2]',
\ '->0 Bar',
\ 'line 3: End of function'])
" next command cannot go down, we are on bottom
call RunDbgCmd(buf, 'down', ['frame is zero'])
call RunDbgCmd(buf, 'up')
" next command cannot go up, we are on top
call RunDbgCmd(buf, 'up', ['frame at highest level: 1'])
call RunDbgCmd(buf, 'where', [
\ '->1 function Foo[2]',
\ ' 0 Bar',
\ 'line 3: End of function'])
" fil is not frame or finish, it is file
call RunDbgCmd(buf, 'fil', ['"[No Name]" --No lines in buffer--'])
" relative backtrace movement
call RunDbgCmd(buf, 'fr -1')
call RunDbgCmd(buf, 'frame', [
\ ' 1 function Foo[2]',
\ '->0 Bar',
\ 'line 3: End of function'])
call RunDbgCmd(buf, 'fr +1')
call RunDbgCmd(buf, 'fram', [
\ '->1 function Foo[2]',
\ ' 0 Bar',
\ 'line 3: End of function'])
" go beyond limits does not crash
call RunDbgCmd(buf, 'fr 100', ['frame at highest level: 1'])
call RunDbgCmd(buf, 'fra', [
\ '->1 function Foo[2]',
\ ' 0 Bar',
\ 'line 3: End of function'])
call RunDbgCmd(buf, 'frame -40', ['frame is zero'])
call RunDbgCmd(buf, 'fram', [
\ ' 1 function Foo[2]',
\ '->0 Bar',
\ 'line 3: End of function'])
" final result 19
call RunDbgCmd(buf, 'cont', ['19'])
" breakpoints tests
" Start a debug session, so that reading the last line from the terminal
" works properly.
call RunDbgCmd(buf, ':debug echo Foo()')
" No breakpoints
call RunDbgCmd(buf, 'breakl', ['No breakpoints defined'])
" Place some breakpoints
call RunDbgCmd(buf, 'breaka func Bar')
call RunDbgCmd(buf, 'breaklis', [' 1 func Bar line 1'])
call RunDbgCmd(buf, 'breakadd func 3 Bazz')
call RunDbgCmd(buf, 'breaklist', [' 1 func Bar line 1',
\ ' 2 func Bazz line 3'])
" Check whether the breakpoints are hit
call RunDbgCmd(buf, 'cont', [
\ 'Breakpoint in "Bar" line 1',
\ 'function Foo[2]..Bar',
\ 'line 1: let var1 = 2 + a:var'])
call RunDbgCmd(buf, 'cont', [
\ 'Breakpoint in "Bazz" line 3',
\ 'function Foo[2]..Bar[2]..Bazz',
\ 'line 3: let var3 = "another var"'])
" Delete the breakpoints
call RunDbgCmd(buf, 'breakd 1')
call RunDbgCmd(buf, 'breakli', [' 2 func Bazz line 3'])
call RunDbgCmd(buf, 'breakdel func 3 Bazz')
call RunDbgCmd(buf, 'breakl', ['No breakpoints defined'])
call RunDbgCmd(buf, 'cont')
" Make sure the breakpoints are removed
call RunDbgCmd(buf, ':echo Foo()', ['19'])
" Delete a non-existing breakpoint
call RunDbgCmd(buf, ':breakdel 2', ['E161: Breakpoint not found: 2'])
" Expression breakpoint
call RunDbgCmd(buf, ':breakadd func 2 Bazz')
call RunDbgCmd(buf, ':echo Bazz(1)', [
\ 'Entering Debug mode. Type "cont" to continue.',
\ 'function Bazz',
\ 'line 2: let var1 = 3 + a:var'])
call RunDbgCmd(buf, 'step')
call RunDbgCmd(buf, 'step')
call RunDbgCmd(buf, 'breaka expr var3')
call RunDbgCmd(buf, 'breakl', [' 3 func Bazz line 2',
\ ' 4 expr var3'])
call RunDbgCmd(buf, 'cont', ['Breakpoint in "Bazz" line 5',
\ 'Oldval = "''another var''"',
\ 'Newval = "''value2''"',
\ 'function Bazz',
\ 'line 5: catch'])
call RunDbgCmd(buf, 'breakdel *')
call RunDbgCmd(buf, 'breakl', ['No breakpoints defined'])
" Check for error cases
call RunDbgCmd(buf, 'breakadd abcd', [
\ 'Error detected while processing function Bazz:',
\ 'line 5:',
\ 'E475: Invalid argument: abcd'])
call RunDbgCmd(buf, 'breakadd func', ['E475: Invalid argument: func'])
call RunDbgCmd(buf, 'breakadd func 2', ['E475: Invalid argument: func 2'])
call RunDbgCmd(buf, 'breaka func a()', ['E475: Invalid argument: func a()'])
call RunDbgCmd(buf, 'breakd abcd', ['E475: Invalid argument: abcd'])
call RunDbgCmd(buf, 'breakd func', ['E475: Invalid argument: func'])
call RunDbgCmd(buf, 'breakd func a()', ['E475: Invalid argument: func a()'])
call RunDbgCmd(buf, 'breakd func a', ['E161: Breakpoint not found: func a'])
call RunDbgCmd(buf, 'breakd expr', ['E475: Invalid argument: expr'])
call RunDbgCmd(buf, 'breakd expr x', [
\ 'E121: Undefined variable: x',
\ 'E161: Breakpoint not found: expr x'])
" finish the current function
call RunDbgCmd(buf, 'finish', [
\ 'function Bazz',
\ 'line 8: End of function'])
call RunDbgCmd(buf, 'cont')
" Test for :next
call RunDbgCmd(buf, ':debug echo Bar(1)')
call RunDbgCmd(buf, 'step')
call RunDbgCmd(buf, 'next')
call RunDbgCmd(buf, '', [
\ 'function Bar',
\ 'line 3: return var2'])
call RunDbgCmd(buf, 'c')
" Test for :interrupt
call RunDbgCmd(buf, ':debug echo Bazz(1)')
call RunDbgCmd(buf, 'step')
call RunDbgCmd(buf, 'step')
call RunDbgCmd(buf, 'interrupt', [
\ 'Exception thrown: Vim:Interrupt',
\ 'function Bazz',
\ 'line 5: catch'])
call RunDbgCmd(buf, 'c')
" Test for :quit
call RunDbgCmd(buf, ':debug echo Foo()')
call RunDbgCmd(buf, 'breakdel *')
call RunDbgCmd(buf, 'breakadd func 3 Foo')
call RunDbgCmd(buf, 'breakadd func 3 Bazz')
call RunDbgCmd(buf, 'cont', [
\ 'Breakpoint in "Bazz" line 3',
\ 'function Foo[2]..Bar[2]..Bazz',
\ 'line 3: let var3 = "another var"'])
call RunDbgCmd(buf, 'quit', [
\ 'Breakpoint in "Foo" line 3',
\ 'function Foo',
\ 'line 3: return var2'])
call RunDbgCmd(buf, 'breakdel *')
call RunDbgCmd(buf, 'quit')
call RunDbgCmd(buf, 'enew! | only!')
call StopVimInTerminal(buf)
" Tests for :breakadd file and :breakadd here
" Breakpoints should be set before sourcing the file
let lines =<< trim END
let var1 = 10
let var2 = 20
let var3 = 30
let var4 = 40
END
call writefile(lines, 'Xtest.vim')
" Start Vim in a terminal
let buf = RunVimInTerminal('Xtest.vim', {})
call RunDbgCmd(buf, ':breakadd file 2 Xtest.vim')
call RunDbgCmd(buf, ':4 | breakadd here')
call RunDbgCmd(buf, ':source Xtest.vim', ['line 2: let var2 = 20'])
call RunDbgCmd(buf, 'cont', ['line 4: let var4 = 40'])
call RunDbgCmd(buf, 'cont')
call StopVimInTerminal(buf)
call delete('Xtest.vim')
endfunc
func Test_Backtrace_Through_Source()
CheckCWD
let file1 =<< trim END
func SourceAnotherFile()
source Xtest2.vim
endfunc
func CallAFunction()
call SourceAnotherFile()
call File2Function()
endfunc
func GlobalFunction()
call CallAFunction()
endfunc
END
call writefile(file1, 'Xtest1.vim')
let file2 =<< trim END
func DoAThing()
echo "DoAThing"
endfunc
func File2Function()
call DoAThing()
endfunc
call File2Function()
END
call writefile(file2, 'Xtest2.vim')
let buf = RunVimInTerminal('-S Xtest1.vim', {})
call RunDbgCmd(buf,
\ ':debug call GlobalFunction()',
\ ['cmd: call GlobalFunction()'])
call RunDbgCmd(buf, 'step', ['line 1: call CallAFunction()'])
call RunDbgCmd(buf, 'backtrace', ['>backtrace',
\ '->0 function GlobalFunction',
\ 'line 1: call CallAFunction()'])
call RunDbgCmd(buf, 'step', ['line 1: call SourceAnotherFile()'])
call RunDbgCmd(buf, 'step', ['line 1: source Xtest2.vim'])
call RunDbgCmd(buf, 'backtrace', ['>backtrace',
\ ' 2 function GlobalFunction[1]',
\ ' 1 CallAFunction[1]',
\ '->0 SourceAnotherFile',
\ 'line 1: source Xtest2.vim'])
" Step into the 'source' command. Note that we print the full trace all the
" way though the source command.
call RunDbgCmd(buf, 'step', ['line 1: func DoAThing()'])
call RunDbgCmd(buf, 'backtrace', [
\ '>backtrace',
\ ' 3 function GlobalFunction[1]',
\ ' 2 CallAFunction[1]',
\ ' 1 SourceAnotherFile[1]',
\ '->0 script ' .. getcwd() .. '/Xtest2.vim',
\ 'line 1: func DoAThing()'])
call RunDbgCmd( buf, 'up' )
call RunDbgCmd( buf, 'backtrace', [
\ '>backtrace',
\ ' 3 function GlobalFunction[1]',
\ ' 2 CallAFunction[1]',
\ '->1 SourceAnotherFile[1]',
\ ' 0 script ' .. getcwd() .. '/Xtest2.vim',
\ 'line 1: func DoAThing()' ] )
call RunDbgCmd( buf, 'up' )
call RunDbgCmd( buf, 'backtrace', [
\ '>backtrace',
\ ' 3 function GlobalFunction[1]',
\ '->2 CallAFunction[1]',
\ ' 1 SourceAnotherFile[1]',
\ ' 0 script ' .. getcwd() .. '/Xtest2.vim',
\ 'line 1: func DoAThing()' ] )
call RunDbgCmd( buf, 'up' )
call RunDbgCmd( buf, 'backtrace', [
\ '>backtrace',
\ '->3 function GlobalFunction[1]',
\ ' 2 CallAFunction[1]',
\ ' 1 SourceAnotherFile[1]',
\ ' 0 script ' .. getcwd() .. '/Xtest2.vim',
\ 'line 1: func DoAThing()' ] )
call RunDbgCmd( buf, 'up', [ 'frame at highest level: 3' ] )
call RunDbgCmd( buf, 'backtrace', [
\ '>backtrace',
\ '->3 function GlobalFunction[1]',
\ ' 2 CallAFunction[1]',
\ ' 1 SourceAnotherFile[1]',
\ ' 0 script ' .. getcwd() .. '/Xtest2.vim',
\ 'line 1: func DoAThing()' ] )
call RunDbgCmd( buf, 'down' )
call RunDbgCmd( buf, 'backtrace', [
\ '>backtrace',
\ ' 3 function GlobalFunction[1]',
\ '->2 CallAFunction[1]',
\ ' 1 SourceAnotherFile[1]',
\ ' 0 script ' .. getcwd() .. '/Xtest2.vim',
\ 'line 1: func DoAThing()' ] )
call RunDbgCmd( buf, 'down' )
call RunDbgCmd( buf, 'backtrace', [
\ '>backtrace',
\ ' 3 function GlobalFunction[1]',
\ ' 2 CallAFunction[1]',
\ '->1 SourceAnotherFile[1]',
\ ' 0 script ' .. getcwd() .. '/Xtest2.vim',
\ 'line 1: func DoAThing()' ] )
call RunDbgCmd( buf, 'down' )
call RunDbgCmd( buf, 'backtrace', [
\ '>backtrace',
\ ' 3 function GlobalFunction[1]',
\ ' 2 CallAFunction[1]',
\ ' 1 SourceAnotherFile[1]',
\ '->0 script ' .. getcwd() .. '/Xtest2.vim',
\ 'line 1: func DoAThing()' ] )
call RunDbgCmd( buf, 'down', [ 'frame is zero' ] )
" step until we have another meaninfgul trace
call RunDbgCmd(buf, 'step', ['line 5: func File2Function()'])
call RunDbgCmd(buf, 'step', ['line 9: call File2Function()'])
call RunDbgCmd(buf, 'backtrace', [
\ '>backtrace',
\ ' 3 function GlobalFunction[1]',
\ ' 2 CallAFunction[1]',
\ ' 1 SourceAnotherFile[1]',
\ '->0 script ' .. getcwd() .. '/Xtest2.vim',
\ 'line 9: call File2Function()'])
call RunDbgCmd(buf, 'step', ['line 1: call DoAThing()'])
call RunDbgCmd(buf, 'step', ['line 1: echo "DoAThing"'])
call RunDbgCmd(buf, 'backtrace', [
\ '>backtrace',
\ ' 5 function GlobalFunction[1]',
\ ' 4 CallAFunction[1]',
\ ' 3 SourceAnotherFile[1]',
\ ' 2 script ' .. getcwd() .. '/Xtest2.vim[9]',
\ ' 1 function File2Function[1]',
\ '->0 DoAThing',
\ 'line 1: echo "DoAThing"'])
" Now, step (back to Xfile1.vim), and call the function _in_ Xfile2.vim
call RunDbgCmd(buf, 'step', ['line 1: End of function'])
call RunDbgCmd(buf, 'step', ['line 1: End of function'])
call RunDbgCmd(buf, 'step', ['line 10: End of sourced file'])
call RunDbgCmd(buf, 'step', ['line 1: End of function'])
call RunDbgCmd(buf, 'step', ['line 2: call File2Function()'])
call RunDbgCmd(buf, 'backtrace', [
\ '>backtrace',
\ ' 1 function GlobalFunction[1]',
\ '->0 CallAFunction',
\ 'line 2: call File2Function()'])
call RunDbgCmd(buf, 'step', ['line 1: call DoAThing()'])
call RunDbgCmd(buf, 'backtrace', [
\ '>backtrace',
\ ' 2 function GlobalFunction[1]',
\ ' 1 CallAFunction[2]',
\ '->0 File2Function',
\ 'line 1: call DoAThing()'])
call StopVimInTerminal(buf)
call delete('Xtest1.vim')
call delete('Xtest2.vim')
endfunc
func Test_Backtrace_Autocmd()
CheckCWD
let file1 =<< trim END
func SourceAnotherFile()
source Xtest2.vim
endfunc
func CallAFunction()
call SourceAnotherFile()
call File2Function()
endfunc
func GlobalFunction()
call CallAFunction()
endfunc
au User TestGlobalFunction :call GlobalFunction() | echo "Done"
END
call writefile(file1, 'Xtest1.vim')
let file2 =<< trim END
func DoAThing()
echo "DoAThing"
endfunc
func File2Function()
call DoAThing()
endfunc
call File2Function()
END
call writefile(file2, 'Xtest2.vim')
let buf = RunVimInTerminal('-S Xtest1.vim', {})
call RunDbgCmd(buf,
\ ':debug doautocmd User TestGlobalFunction',
\ ['cmd: doautocmd User TestGlobalFunction'])
call RunDbgCmd(buf, 'step', ['cmd: call GlobalFunction() | echo "Done"'])
" At this point the ontly thing in the stack is the autocommand
call RunDbgCmd(buf, 'backtrace', [
\ '>backtrace',
\ '->0 User Autocommands for "TestGlobalFunction"',
\ 'cmd: call GlobalFunction() | echo "Done"'])
" And now we're back into the call stack
call RunDbgCmd(buf, 'step', ['line 1: call CallAFunction()'])
call RunDbgCmd(buf, 'backtrace', [
\ '>backtrace',
\ ' 1 User Autocommands for "TestGlobalFunction"',
\ '->0 function GlobalFunction',
\ 'line 1: call CallAFunction()'])
call RunDbgCmd(buf, 'step', ['line 1: call SourceAnotherFile()'])
call RunDbgCmd(buf, 'step', ['line 1: source Xtest2.vim'])
call RunDbgCmd(buf, 'backtrace', [
\ '>backtrace',
\ ' 3 User Autocommands for "TestGlobalFunction"',
\ ' 2 function GlobalFunction[1]',
\ ' 1 CallAFunction[1]',
\ '->0 SourceAnotherFile',
\ 'line 1: source Xtest2.vim'])
" Step into the 'source' command. Note that we print the full trace all the
" way though the source command.
call RunDbgCmd(buf, 'step', ['line 1: func DoAThing()'])
call RunDbgCmd(buf, 'backtrace', [
\ '>backtrace',
\ ' 4 User Autocommands for "TestGlobalFunction"',
\ ' 3 function GlobalFunction[1]',
\ ' 2 CallAFunction[1]',
\ ' 1 SourceAnotherFile[1]',
\ '->0 script ' .. getcwd() .. '/Xtest2.vim',
\ 'line 1: func DoAThing()'])
" step until we have another meaninfgul trace
call RunDbgCmd(buf, 'step', ['line 5: func File2Function()'])
call RunDbgCmd(buf, 'step', ['line 9: call File2Function()'])
call RunDbgCmd(buf, 'backtrace', [
\ '>backtrace',
\ ' 4 User Autocommands for "TestGlobalFunction"',
\ ' 3 function GlobalFunction[1]',
\ ' 2 CallAFunction[1]',
\ ' 1 SourceAnotherFile[1]',
\ '->0 script ' .. getcwd() .. '/Xtest2.vim',
\ 'line 9: call File2Function()'])
call RunDbgCmd(buf, 'step', ['line 1: call DoAThing()'])
call RunDbgCmd(buf, 'step', ['line 1: echo "DoAThing"'])
call RunDbgCmd(buf, 'backtrace', [
\ '>backtrace',
\ ' 6 User Autocommands for "TestGlobalFunction"',
\ ' 5 function GlobalFunction[1]',
\ ' 4 CallAFunction[1]',
\ ' 3 SourceAnotherFile[1]',
\ ' 2 script ' .. getcwd() .. '/Xtest2.vim[9]',
\ ' 1 function File2Function[1]',
\ '->0 DoAThing',
\ 'line 1: echo "DoAThing"'])
" Now, step (back to Xfile1.vim), and call the function _in_ Xfile2.vim
call RunDbgCmd(buf, 'step', ['line 1: End of function'])
call RunDbgCmd(buf, 'step', ['line 1: End of function'])
call RunDbgCmd(buf, 'step', ['line 10: End of sourced file'])
call RunDbgCmd(buf, 'step', ['line 1: End of function'])
call RunDbgCmd(buf, 'step', ['line 2: call File2Function()'])
call RunDbgCmd(buf, 'backtrace', [
\ '>backtrace',
\ ' 2 User Autocommands for "TestGlobalFunction"',
\ ' 1 function GlobalFunction[1]',
\ '->0 CallAFunction',
\ 'line 2: call File2Function()'])
call RunDbgCmd(buf, 'step', ['line 1: call DoAThing()'])
call RunDbgCmd(buf, 'backtrace', [
\ '>backtrace',
\ ' 3 User Autocommands for "TestGlobalFunction"',
\ ' 2 function GlobalFunction[1]',
\ ' 1 CallAFunction[2]',
\ '->0 File2Function',
\ 'line 1: call DoAThing()'])
" Now unwind so that we get back to the original autocommand (and the second
" cmd echo "Done")
call RunDbgCmd(buf, 'finish', ['line 1: End of function'])
call RunDbgCmd(buf, 'backtrace', [
\ '>backtrace',
\ ' 3 User Autocommands for "TestGlobalFunction"',
\ ' 2 function GlobalFunction[1]',
\ ' 1 CallAFunction[2]',
\ '->0 File2Function',
\ 'line 1: End of function'])
call RunDbgCmd(buf, 'finish', ['line 2: End of function'])
call RunDbgCmd(buf, 'backtrace', [
\ '>backtrace',
\ ' 2 User Autocommands for "TestGlobalFunction"',
\ ' 1 function GlobalFunction[1]',
\ '->0 CallAFunction',
\ 'line 2: End of function'])
call RunDbgCmd(buf, 'finish', ['line 1: End of function'])
call RunDbgCmd(buf, 'backtrace', [
\ '>backtrace',
\ ' 1 User Autocommands for "TestGlobalFunction"',
\ '->0 function GlobalFunction',
\ 'line 1: End of function'])
call RunDbgCmd(buf, 'step', ['cmd: echo "Done"'])
call RunDbgCmd(buf, 'backtrace', [
\ '>backtrace',
\ '->0 User Autocommands for "TestGlobalFunction"',
\ 'cmd: echo "Done"'])
call StopVimInTerminal(buf)
call delete('Xtest1.vim')
call delete('Xtest2.vim')
endfunc
func Test_Backtrace_CmdLine()
CheckCWD
let file1 =<< trim END
func SourceAnotherFile()
source Xtest2.vim
endfunc
func CallAFunction()
call SourceAnotherFile()
call File2Function()
endfunc
func GlobalFunction()
call CallAFunction()
endfunc
au User TestGlobalFunction :call GlobalFunction() | echo "Done"
END
call writefile(file1, 'Xtest1.vim')
let file2 =<< trim END
func DoAThing()
echo "DoAThing"
endfunc
func File2Function()
call DoAThing()
endfunc
call File2Function()
END
call writefile(file2, 'Xtest2.vim')
let buf = RunVimInTerminal(
\ '-S Xtest1.vim -c "debug call GlobalFunction()"',
\ {'wait_for_ruler': 0})
" Need to wait for the vim-in-terminal to be ready
call CheckDbgOutput(buf, ['command line',
\ 'cmd: call GlobalFunction()'])
" At this point the ontly thing in the stack is the cmdline
call RunDbgCmd(buf, 'backtrace', [
\ '>backtrace',
\ '->0 command line',
\ 'cmd: call GlobalFunction()'])
" And now we're back into the call stack
call RunDbgCmd(buf, 'step', ['line 1: call CallAFunction()'])
call RunDbgCmd(buf, 'backtrace', [
\ '>backtrace',
\ ' 1 command line',
\ '->0 function GlobalFunction',
\ 'line 1: call CallAFunction()'])
call StopVimInTerminal(buf)
call delete('Xtest1.vim')
call delete('Xtest2.vim')
endfunc
func Test_Backtrace_DefFunction()
CheckCWD
let file1 =<< trim END
vim9script
import File2Function from './Xtest2.vim'
def SourceAnotherFile()
source Xtest2.vim
enddef
def CallAFunction()
SourceAnotherFile()
File2Function()
enddef
def g:GlobalFunction()
CallAFunction()
enddef
defcompile
END
call writefile(file1, 'Xtest1.vim')
let file2 =<< trim END
vim9script
def DoAThing(): number
let a = 100 * 2
a += 3
return a
enddef
export def File2Function()
DoAThing()
enddef
defcompile
File2Function()
END
call writefile(file2, 'Xtest2.vim')
let buf = RunVimInTerminal('-S Xtest1.vim', {})
call RunDbgCmd(buf,
\ ':debug call GlobalFunction()',
\ ['cmd: call GlobalFunction()'])
" FIXME: Vim9 lines are not debugged!
call RunDbgCmd(buf, 'step', ['line 1: source Xtest2.vim'])
" But they do appear in the backtrace
call RunDbgCmd(buf, 'backtrace', [
\ '\V>backtrace',
\ '\V 2 function GlobalFunction[1]',
\ '\V 1 <SNR>\.\*_CallAFunction[1]',
\ '\V->0 <SNR>\.\*_SourceAnotherFile',
\ '\Vline 1: source Xtest2.vim'],
\ #{match: 'pattern'})
call RunDbgCmd(buf, 'step', ['line 1: vim9script'])
call RunDbgCmd(buf, 'step', ['line 3: def DoAThing(): number'])
call RunDbgCmd(buf, 'step', ['line 9: export def File2Function()'])
call RunDbgCmd(buf, 'step', ['line 9: def File2Function()'])
call RunDbgCmd(buf, 'step', ['line 13: defcompile'])
call RunDbgCmd(buf, 'step', ['line 14: File2Function()'])
call RunDbgCmd(buf, 'backtrace', [
\ '\V>backtrace',
\ '\V 3 function GlobalFunction[1]',
\ '\V 2 <SNR>\.\*_CallAFunction[1]',
\ '\V 1 <SNR>\.\*_SourceAnotherFile[1]',
\ '\V->0 script ' .. getcwd() .. '/Xtest2.vim',
\ '\Vline 14: File2Function()'],
\ #{match: 'pattern'})
" Don't step into compiled functions...
call RunDbgCmd(buf, 'step', ['line 15: End of sourced file'])
call RunDbgCmd(buf, 'backtrace', [
\ '\V>backtrace',
\ '\V 3 function GlobalFunction[1]',
\ '\V 2 <SNR>\.\*_CallAFunction[1]',
\ '\V 1 <SNR>\.\*_SourceAnotherFile[1]',
\ '\V->0 script ' .. getcwd() .. '/Xtest2.vim',
\ '\Vline 15: End of sourced file'],
\ #{match: 'pattern'})
call StopVimInTerminal(buf)
call delete('Xtest1.vim')
call delete('Xtest2.vim')
endfunc
func Test_debug_backtrace_level()
CheckCWD
let lines =<< trim END
let s:file1_var = 'file1'
let g:global_var = 'global'
func s:File1Func( arg )
let s:file1_var .= a:arg
let local_var = s:file1_var .. ' test1'
let g:global_var .= local_var
source Xtest2.vim
endfunc
call s:File1Func( 'arg1' )
END
call writefile(lines, 'Xtest1.vim')
let lines =<< trim END
let s:file2_var = 'file2'
func s:File2Func( arg )
let s:file2_var .= a:arg
let local_var = s:file2_var .. ' test2'
let g:global_var .= local_var
endfunc
call s:File2Func( 'arg2' )
END
call writefile(lines, 'Xtest2.vim')
let file1 = getcwd() .. '/Xtest1.vim'
let file2 = getcwd() .. '/Xtest2.vim'
" set a breakpoint and source file1.vim
let buf = RunVimInTerminal(
\ '-c "breakadd file 1 Xtest1.vim" -S Xtest1.vim',
\ #{ wait_for_ruler: 0 } )
call CheckDbgOutput(buf, [
\ 'Breakpoint in "' .. file1 .. '" line 1',
\ 'Entering Debug mode. Type "cont" to continue.',
\ 'command line..script ' .. file1,
\ 'line 1: let s:file1_var = ''file1'''
\ ])
" step throught the initial declarations
call RunDbgCmd(buf, 'step', [ 'line 2: let g:global_var = ''global''' ] )
call RunDbgCmd(buf, 'step', [ 'line 4: func s:File1Func( arg )' ] )
call RunDbgCmd(buf, 'echo s:file1_var', [ 'file1' ] )
call RunDbgCmd(buf, 'echo g:global_var', [ 'global' ] )
call RunDbgCmd(buf, 'echo global_var', [ 'global' ] )
" step in to the first function
call RunDbgCmd(buf, 'step', [ 'line 11: call s:File1Func( ''arg1'' )' ] )
call RunDbgCmd(buf, 'step', [ 'line 1: let s:file1_var .= a:arg' ] )
call RunDbgCmd(buf, 'echo a:arg', [ 'arg1' ] )
call RunDbgCmd(buf, 'echo s:file1_var', [ 'file1' ] )
call RunDbgCmd(buf, 'echo g:global_var', [ 'global' ] )
call RunDbgCmd(buf,
\'echo global_var',
\[ 'E121: Undefined variable: global_var' ] )
call RunDbgCmd(buf,
\'echo local_var',
\[ 'E121: Undefined variable: local_var' ] )
call RunDbgCmd(buf,
\'echo l:local_var',
\[ 'E121: Undefined variable: l:local_var' ] )
" backtrace up
call RunDbgCmd(buf, 'backtrace', [
\ '\V>backtrace',
\ '\V 2 command line',
\ '\V 1 script ' .. file1 .. '[11]',
\ '\V->0 function <SNR>\.\*_File1Func',
\ '\Vline 1: let s:file1_var .= a:arg',
\ ],
\ #{ match: 'pattern' } )
call RunDbgCmd(buf, 'up', [ '>up' ] )
call RunDbgCmd(buf, 'backtrace', [
\ '\V>backtrace',
\ '\V 2 command line',
\ '\V->1 script ' .. file1 .. '[11]',
\ '\V 0 function <SNR>\.\*_File1Func',
\ '\Vline 1: let s:file1_var .= a:arg',
\ ],
\ #{ match: 'pattern' } )
" Expression evaluation in the script frame (not the function frame)
" FIXME: Unexpected in this scope (a: should not be visibnle)
call RunDbgCmd(buf, 'echo a:arg', [ 'arg1' ] )
call RunDbgCmd(buf, 'echo s:file1_var', [ 'file1' ] )
call RunDbgCmd(buf, 'echo g:global_var', [ 'global' ] )
" FIXME: Unexpected in this scope (global should be found)
call RunDbgCmd(buf,
\'echo global_var',
\[ 'E121: Undefined variable: global_var' ] )
call RunDbgCmd(buf,
\'echo local_var',
\[ 'E121: Undefined variable: local_var' ] )
call RunDbgCmd(buf,
\'echo l:local_var',
\[ 'E121: Undefined variable: l:local_var' ] )
" step while backtraced jumps to the latest frame
call RunDbgCmd(buf, 'step', [
\ 'line 2: let local_var = s:file1_var .. '' test1''' ] )
call RunDbgCmd(buf, 'backtrace', [
\ '\V>backtrace',
\ '\V 2 command line',
\ '\V 1 script ' .. file1 .. '[11]',
\ '\V->0 function <SNR>\.\*_File1Func',
\ '\Vline 2: let local_var = s:file1_var .. '' test1''',
\ ],
\ #{ match: 'pattern' } )
call RunDbgCmd(buf, 'step', [ 'line 3: let g:global_var .= local_var' ] )
call RunDbgCmd(buf, 'echo local_var', [ 'file1arg1 test1' ] )
call RunDbgCmd(buf, 'echo l:local_var', [ 'file1arg1 test1' ] )
call RunDbgCmd(buf, 'step', [ 'line 4: source Xtest2.vim' ] )
call RunDbgCmd(buf, 'step', [ 'line 1: let s:file2_var = ''file2''' ] )
call RunDbgCmd(buf, 'backtrace', [
\ '\V>backtrace',
\ '\V 3 command line',
\ '\V 2 script ' .. file1 .. '[11]',
\ '\V 1 function <SNR>\.\*_File1Func[4]',
\ '\V->0 script ' .. file2,
\ '\Vline 1: let s:file2_var = ''file2''',
\ ],
\ #{ match: 'pattern' } )
" Expression evaluation in the script frame file2 (not the function frame)
call RunDbgCmd(buf, 'echo a:arg', [ 'E121: Undefined variable: a:arg' ] )
call RunDbgCmd(buf,
\ 'echo s:file1_var',
\ [ 'E121: Undefined variable: s:file1_var' ] )
call RunDbgCmd(buf, 'echo g:global_var', [ 'globalfile1arg1 test1' ] )
call RunDbgCmd(buf, 'echo global_var', [ 'globalfile1arg1 test1' ] )
call RunDbgCmd(buf,
\'echo local_var',
\[ 'E121: Undefined variable: local_var' ] )
call RunDbgCmd(buf,
\'echo l:local_var',
\[ 'E121: Undefined variable: l:local_var' ] )
call RunDbgCmd(buf,
\ 'echo s:file2_var',
\ [ 'E121: Undefined variable: s:file2_var' ] )
call RunDbgCmd(buf, 'step', [ 'line 3: func s:File2Func( arg )' ] )
call RunDbgCmd(buf, 'echo s:file2_var', [ 'file2' ] )
" Up the stack to the other script context
call RunDbgCmd(buf, 'up')
call RunDbgCmd(buf, 'backtrace', [
\ '\V>backtrace',
\ '\V 3 command line',
\ '\V 2 script ' .. file1 .. '[11]',
\ '\V->1 function <SNR>\.\*_File1Func[4]',
\ '\V 0 script ' .. file2,
\ '\Vline 3: func s:File2Func( arg )',
\ ],
\ #{ match: 'pattern' } )
" FIXME: Unexpected. Should see the a: and l: dicts from File1Func
call RunDbgCmd(buf, 'echo a:arg', [ 'E121: Undefined variable: a:arg' ] )
call RunDbgCmd(buf,
\ 'echo l:local_var',
\ [ 'E121: Undefined variable: l:local_var' ] )
call RunDbgCmd(buf, 'up')
call RunDbgCmd(buf, 'backtrace', [
\ '\V>backtrace',
\ '\V 3 command line',
\ '\V->2 script ' .. file1 .. '[11]',
\ '\V 1 function <SNR>\.\*_File1Func[4]',
\ '\V 0 script ' .. file2,
\ '\Vline 3: func s:File2Func( arg )',
\ ],
\ #{ match: 'pattern' } )
" FIXME: Unexpected (wrong script vars are used)
call RunDbgCmd(buf,
\ 'echo s:file1_var',
\ [ 'E121: Undefined variable: s:file1_var' ] )
call RunDbgCmd(buf, 'echo s:file2_var', [ 'file2' ] )
call StopVimInTerminal(buf)
call delete('Xtest1.vim')
call delete('Xtest2.vim')
endfunc
|
