1 /* vi:set ts=8 sts=4 sw=4 noet:
2 *
3 * VIM - Vi IMproved by Bram Moolenaar
4 *
5 * Do ":help uganda" in Vim to read copying and usage conditions.
6 * Do ":help credits" in Vim to see a list of people who contributed.
7 * See README.txt for an overview of the Vim source code.
8 */
9
10 /*
11 * debugger.c: Vim script debugger functions
12 */
13
14 #include "vim.h"
15
16 #if defined(FEAT_EVAL) || defined(PROTO)
17 static int debug_greedy = FALSE; // batch mode debugging: don't save
18 // and restore typeahead.
19 static void do_setdebugtracelevel(char_u *arg);
20 static void do_checkbacktracelevel(void);
21 static void do_showbacktrace(char_u *cmd);
22
23 static char_u *debug_oldval = NULL; // old and newval for debug expressions
24 static char_u *debug_newval = NULL;
25 static int debug_expr = 0; // use debug_expr
26
27 int
has_watchexpr(void)28 has_watchexpr(void)
29 {
30 return debug_expr;
31 }
32
33 /*
34 * do_debug(): Debug mode.
35 * Repeatedly get Ex commands, until told to continue normal execution.
36 */
37 void
do_debug(char_u * cmd)38 do_debug(char_u *cmd)
39 {
40 int save_msg_scroll = msg_scroll;
41 int save_State = State;
42 int save_did_emsg = did_emsg;
43 int save_cmd_silent = cmd_silent;
44 int save_msg_silent = msg_silent;
45 int save_emsg_silent = emsg_silent;
46 int save_redir_off = redir_off;
47 tasave_T typeaheadbuf;
48 int typeahead_saved = FALSE;
49 int save_ignore_script = 0;
50 int save_ex_normal_busy;
51 int n;
52 char_u *cmdline = NULL;
53 char_u *p;
54 char_u *sname;
55 char *tail = NULL;
56 static int last_cmd = 0;
57 #define CMD_CONT 1
58 #define CMD_NEXT 2
59 #define CMD_STEP 3
60 #define CMD_FINISH 4
61 #define CMD_QUIT 5
62 #define CMD_INTERRUPT 6
63 #define CMD_BACKTRACE 7
64 #define CMD_FRAME 8
65 #define CMD_UP 9
66 #define CMD_DOWN 10
67
68 #ifdef ALWAYS_USE_GUI
69 // Can't do this when there is no terminal for input/output.
70 if (!gui.in_use)
71 {
72 // Break as soon as possible.
73 debug_break_level = 9999;
74 return;
75 }
76 #endif
77
78 // Make sure we are in raw mode and start termcap mode. Might have side
79 // effects...
80 settmode(TMODE_RAW);
81 starttermcap();
82
83 ++RedrawingDisabled; // don't redisplay the window
84 ++no_wait_return; // don't wait for return
85 did_emsg = FALSE; // don't use error from debugged stuff
86 cmd_silent = FALSE; // display commands
87 msg_silent = FALSE; // display messages
88 emsg_silent = FALSE; // display error messages
89 redir_off = TRUE; // don't redirect debug commands
90
91 State = NORMAL;
92 debug_mode = TRUE;
93
94 if (!debug_did_msg)
95 msg(_("Entering Debug mode. Type \"cont\" to continue."));
96 if (debug_oldval != NULL)
97 {
98 smsg(_("Oldval = \"%s\""), debug_oldval);
99 vim_free(debug_oldval);
100 debug_oldval = NULL;
101 }
102 if (debug_newval != NULL)
103 {
104 smsg(_("Newval = \"%s\""), debug_newval);
105 vim_free(debug_newval);
106 debug_newval = NULL;
107 }
108 sname = estack_sfile(ESTACK_NONE);
109 if (sname != NULL)
110 msg((char *)sname);
111 vim_free(sname);
112 if (SOURCING_LNUM != 0)
113 smsg(_("line %ld: %s"), SOURCING_LNUM, cmd);
114 else
115 smsg(_("cmd: %s"), cmd);
116
117 // Repeat getting a command and executing it.
118 for (;;)
119 {
120 msg_scroll = TRUE;
121 need_wait_return = FALSE;
122
123 // Save the current typeahead buffer and replace it with an empty one.
124 // This makes sure we get input from the user here and don't interfere
125 // with the commands being executed. Reset "ex_normal_busy" to avoid
126 // the side effects of using ":normal". Save the stuff buffer and make
127 // it empty. Set ignore_script to avoid reading from script input.
128 save_ex_normal_busy = ex_normal_busy;
129 ex_normal_busy = 0;
130 if (!debug_greedy)
131 {
132 save_typeahead(&typeaheadbuf);
133 typeahead_saved = TRUE;
134 save_ignore_script = ignore_script;
135 ignore_script = TRUE;
136 }
137
138 vim_free(cmdline);
139 cmdline = getcmdline_prompt('>', NULL, 0, EXPAND_NOTHING, NULL);
140
141 if (typeahead_saved)
142 {
143 restore_typeahead(&typeaheadbuf, TRUE);
144 ignore_script = save_ignore_script;
145 }
146 ex_normal_busy = save_ex_normal_busy;
147
148 cmdline_row = msg_row;
149 msg_starthere();
150 if (cmdline != NULL)
151 {
152 // If this is a debug command, set "last_cmd".
153 // If not, reset "last_cmd".
154 // For a blank line use previous command.
155 p = skipwhite(cmdline);
156 if (*p != NUL)
157 {
158 switch (*p)
159 {
160 case 'c': last_cmd = CMD_CONT;
161 tail = "ont";
162 break;
163 case 'n': last_cmd = CMD_NEXT;
164 tail = "ext";
165 break;
166 case 's': last_cmd = CMD_STEP;
167 tail = "tep";
168 break;
169 case 'f':
170 last_cmd = 0;
171 if (p[1] == 'r')
172 {
173 last_cmd = CMD_FRAME;
174 tail = "rame";
175 }
176 else
177 {
178 last_cmd = CMD_FINISH;
179 tail = "inish";
180 }
181 break;
182 case 'q': last_cmd = CMD_QUIT;
183 tail = "uit";
184 break;
185 case 'i': last_cmd = CMD_INTERRUPT;
186 tail = "nterrupt";
187 break;
188 case 'b': last_cmd = CMD_BACKTRACE;
189 if (p[1] == 't')
190 tail = "t";
191 else
192 tail = "acktrace";
193 break;
194 case 'w': last_cmd = CMD_BACKTRACE;
195 tail = "here";
196 break;
197 case 'u': last_cmd = CMD_UP;
198 tail = "p";
199 break;
200 case 'd': last_cmd = CMD_DOWN;
201 tail = "own";
202 break;
203 default: last_cmd = 0;
204 }
205 if (last_cmd != 0)
206 {
207 // Check that the tail matches.
208 ++p;
209 while (*p != NUL && *p == *tail)
210 {
211 ++p;
212 ++tail;
213 }
214 if (ASCII_ISALPHA(*p) && last_cmd != CMD_FRAME)
215 last_cmd = 0;
216 }
217 }
218
219 if (last_cmd != 0)
220 {
221 // Execute debug command: decide where to break next and
222 // return.
223 switch (last_cmd)
224 {
225 case CMD_CONT:
226 debug_break_level = -1;
227 break;
228 case CMD_NEXT:
229 debug_break_level = ex_nesting_level;
230 break;
231 case CMD_STEP:
232 debug_break_level = 9999;
233 break;
234 case CMD_FINISH:
235 debug_break_level = ex_nesting_level - 1;
236 break;
237 case CMD_QUIT:
238 got_int = TRUE;
239 debug_break_level = -1;
240 break;
241 case CMD_INTERRUPT:
242 got_int = TRUE;
243 debug_break_level = 9999;
244 // Do not repeat ">interrupt" cmd, continue stepping.
245 last_cmd = CMD_STEP;
246 break;
247 case CMD_BACKTRACE:
248 do_showbacktrace(cmd);
249 continue;
250 case CMD_FRAME:
251 if (*p == NUL)
252 {
253 do_showbacktrace(cmd);
254 }
255 else
256 {
257 p = skipwhite(p);
258 do_setdebugtracelevel(p);
259 }
260 continue;
261 case CMD_UP:
262 debug_backtrace_level++;
263 do_checkbacktracelevel();
264 continue;
265 case CMD_DOWN:
266 debug_backtrace_level--;
267 do_checkbacktracelevel();
268 continue;
269 }
270 // Going out reset backtrace_level
271 debug_backtrace_level = 0;
272 break;
273 }
274
275 // don't debug this command
276 n = debug_break_level;
277 debug_break_level = -1;
278 (void)do_cmdline(cmdline, getexline, NULL,
279 DOCMD_VERBOSE|DOCMD_EXCRESET);
280 debug_break_level = n;
281 }
282 lines_left = Rows - 1;
283 }
284 vim_free(cmdline);
285
286 --RedrawingDisabled;
287 --no_wait_return;
288 redraw_all_later(NOT_VALID);
289 need_wait_return = FALSE;
290 msg_scroll = save_msg_scroll;
291 lines_left = Rows - 1;
292 State = save_State;
293 debug_mode = FALSE;
294 did_emsg = save_did_emsg;
295 cmd_silent = save_cmd_silent;
296 msg_silent = save_msg_silent;
297 emsg_silent = save_emsg_silent;
298 redir_off = save_redir_off;
299
300 // Only print the message again when typing a command before coming back
301 // here.
302 debug_did_msg = TRUE;
303 }
304
305 static int
get_maxbacktrace_level(char_u * sname)306 get_maxbacktrace_level(char_u *sname)
307 {
308 char *p, *q;
309 int maxbacktrace = 0;
310
311 if (sname != NULL)
312 {
313 p = (char *)sname;
314 while ((q = strstr(p, "..")) != NULL)
315 {
316 p = q + 2;
317 maxbacktrace++;
318 }
319 }
320 return maxbacktrace;
321 }
322
323 static void
do_setdebugtracelevel(char_u * arg)324 do_setdebugtracelevel(char_u *arg)
325 {
326 int level;
327
328 level = atoi((char *)arg);
329 if (*arg == '+' || level < 0)
330 debug_backtrace_level += level;
331 else
332 debug_backtrace_level = level;
333
334 do_checkbacktracelevel();
335 }
336
337 static void
do_checkbacktracelevel(void)338 do_checkbacktracelevel(void)
339 {
340 if (debug_backtrace_level < 0)
341 {
342 debug_backtrace_level = 0;
343 msg(_("frame is zero"));
344 }
345 else
346 {
347 char_u *sname = estack_sfile(ESTACK_NONE);
348 int max = get_maxbacktrace_level(sname);
349
350 if (debug_backtrace_level > max)
351 {
352 debug_backtrace_level = max;
353 smsg(_("frame at highest level: %d"), max);
354 }
355 vim_free(sname);
356 }
357 }
358
359 static void
do_showbacktrace(char_u * cmd)360 do_showbacktrace(char_u *cmd)
361 {
362 char_u *sname;
363 char *cur;
364 char *next;
365 int i = 0;
366 int max;
367
368 sname = estack_sfile(ESTACK_NONE);
369 max = get_maxbacktrace_level(sname);
370 if (sname != NULL)
371 {
372 cur = (char *)sname;
373 while (!got_int)
374 {
375 next = strstr(cur, "..");
376 if (next != NULL)
377 *next = NUL;
378 if (i == max - debug_backtrace_level)
379 smsg("->%d %s", max - i, cur);
380 else
381 smsg(" %d %s", max - i, cur);
382 ++i;
383 if (next == NULL)
384 break;
385 *next = '.';
386 cur = next + 2;
387 }
388 vim_free(sname);
389 }
390
391 if (SOURCING_LNUM != 0)
392 smsg(_("line %ld: %s"), (long)SOURCING_LNUM, cmd);
393 else
394 smsg(_("cmd: %s"), cmd);
395 }
396
397 /*
398 * ":debug".
399 */
400 void
ex_debug(exarg_T * eap)401 ex_debug(exarg_T *eap)
402 {
403 int debug_break_level_save = debug_break_level;
404
405 debug_break_level = 9999;
406 do_cmdline_cmd(eap->arg);
407 debug_break_level = debug_break_level_save;
408 }
409
410 static char_u *debug_breakpoint_name = NULL;
411 static linenr_T debug_breakpoint_lnum;
412
413 /*
414 * When debugging or a breakpoint is set on a skipped command, no debug prompt
415 * is shown by do_one_cmd(). This situation is indicated by debug_skipped, and
416 * debug_skipped_name is then set to the source name in the breakpoint case. If
417 * a skipped command decides itself that a debug prompt should be displayed, it
418 * can do so by calling dbg_check_skipped().
419 */
420 static int debug_skipped;
421 static char_u *debug_skipped_name;
422
423 /*
424 * Go to debug mode when a breakpoint was encountered or "ex_nesting_level" is
425 * at or below the break level. But only when the line is actually
426 * executed. Return TRUE and set breakpoint_name for skipped commands that
427 * decide to execute something themselves.
428 * Called from do_one_cmd() before executing a command.
429 */
430 void
dbg_check_breakpoint(exarg_T * eap)431 dbg_check_breakpoint(exarg_T *eap)
432 {
433 char_u *p;
434
435 debug_skipped = FALSE;
436 if (debug_breakpoint_name != NULL)
437 {
438 if (!eap->skip)
439 {
440 // replace K_SNR with "<SNR>"
441 if (debug_breakpoint_name[0] == K_SPECIAL
442 && debug_breakpoint_name[1] == KS_EXTRA
443 && debug_breakpoint_name[2] == KE_SNR)
444 p = (char_u *)"<SNR>";
445 else
446 p = (char_u *)"";
447 smsg(_("Breakpoint in \"%s%s\" line %ld"),
448 p,
449 debug_breakpoint_name + (*p == NUL ? 0 : 3),
450 (long)debug_breakpoint_lnum);
451 debug_breakpoint_name = NULL;
452 do_debug(eap->cmd);
453 }
454 else
455 {
456 debug_skipped = TRUE;
457 debug_skipped_name = debug_breakpoint_name;
458 debug_breakpoint_name = NULL;
459 }
460 }
461 else if (ex_nesting_level <= debug_break_level)
462 {
463 if (!eap->skip)
464 do_debug(eap->cmd);
465 else
466 {
467 debug_skipped = TRUE;
468 debug_skipped_name = NULL;
469 }
470 }
471 }
472
473 /*
474 * Go to debug mode if skipped by dbg_check_breakpoint() because eap->skip was
475 * set. Return TRUE when the debug mode is entered this time.
476 */
477 int
dbg_check_skipped(exarg_T * eap)478 dbg_check_skipped(exarg_T *eap)
479 {
480 int prev_got_int;
481
482 if (debug_skipped)
483 {
484 // Save the value of got_int and reset it. We don't want a previous
485 // interruption cause flushing the input buffer.
486 prev_got_int = got_int;
487 got_int = FALSE;
488 debug_breakpoint_name = debug_skipped_name;
489 // eap->skip is TRUE
490 eap->skip = FALSE;
491 (void)dbg_check_breakpoint(eap);
492 eap->skip = TRUE;
493 got_int |= prev_got_int;
494 return TRUE;
495 }
496 return FALSE;
497 }
498
499 /*
500 * The list of breakpoints: dbg_breakp.
501 * This is a grow-array of structs.
502 */
503 struct debuggy
504 {
505 int dbg_nr; // breakpoint number
506 int dbg_type; // DBG_FUNC, DBG_FILE or DBG_EXPR
507 char_u *dbg_name; // function, expression or file name
508 regprog_T *dbg_prog; // regexp program
509 linenr_T dbg_lnum; // line number in function or file
510 int dbg_forceit; // ! used
511 #ifdef FEAT_EVAL
512 typval_T *dbg_val; // last result of watchexpression
513 #endif
514 int dbg_level; // stored nested level for expr
515 };
516
517 static garray_T dbg_breakp = {0, 0, sizeof(struct debuggy), 4, NULL};
518 #define BREAKP(idx) (((struct debuggy *)dbg_breakp.ga_data)[idx])
519 #define DEBUGGY(gap, idx) (((struct debuggy *)gap->ga_data)[idx])
520 static int last_breakp = 0; // nr of last defined breakpoint
521 static int has_expr_breakpoint = FALSE;
522
523 #ifdef FEAT_PROFILE
524 // Profiling uses file and func names similar to breakpoints.
525 static garray_T prof_ga = {0, 0, sizeof(struct debuggy), 4, NULL};
526 #endif
527 #define DBG_FUNC 1
528 #define DBG_FILE 2
529 #define DBG_EXPR 3
530
531 static linenr_T debuggy_find(int file,char_u *fname, linenr_T after, garray_T *gap, int *fp);
532
533 /*
534 * Evaluate the "bp->dbg_name" expression and return the result.
535 * Disables error messages.
536 */
537 static typval_T *
eval_expr_no_emsg(struct debuggy * bp)538 eval_expr_no_emsg(struct debuggy *bp)
539 {
540 typval_T *tv;
541
542 // Disable error messages, a bad expression would make Vim unusable.
543 ++emsg_off;
544 tv = eval_expr(bp->dbg_name, NULL);
545 --emsg_off;
546
547 return tv;
548 }
549
550 /*
551 * Parse the arguments of ":profile", ":breakadd" or ":breakdel" and put them
552 * in the entry just after the last one in dbg_breakp. Note that "dbg_name"
553 * is allocated.
554 * Returns FAIL for failure.
555 */
556 static int
dbg_parsearg(char_u * arg,garray_T * gap)557 dbg_parsearg(
558 char_u *arg,
559 garray_T *gap) // either &dbg_breakp or &prof_ga
560 {
561 char_u *p = arg;
562 char_u *q;
563 struct debuggy *bp;
564 int here = FALSE;
565
566 if (ga_grow(gap, 1) == FAIL)
567 return FAIL;
568 bp = &DEBUGGY(gap, gap->ga_len);
569
570 // Find "func" or "file".
571 if (STRNCMP(p, "func", 4) == 0)
572 bp->dbg_type = DBG_FUNC;
573 else if (STRNCMP(p, "file", 4) == 0)
574 bp->dbg_type = DBG_FILE;
575 else if (
576 #ifdef FEAT_PROFILE
577 gap != &prof_ga &&
578 #endif
579 STRNCMP(p, "here", 4) == 0)
580 {
581 if (curbuf->b_ffname == NULL)
582 {
583 emsg(_(e_no_file_name));
584 return FAIL;
585 }
586 bp->dbg_type = DBG_FILE;
587 here = TRUE;
588 }
589 else if (
590 #ifdef FEAT_PROFILE
591 gap != &prof_ga &&
592 #endif
593 STRNCMP(p, "expr", 4) == 0)
594 bp->dbg_type = DBG_EXPR;
595 else
596 {
597 semsg(_(e_invarg2), p);
598 return FAIL;
599 }
600 p = skipwhite(p + 4);
601
602 // Find optional line number.
603 if (here)
604 bp->dbg_lnum = curwin->w_cursor.lnum;
605 else if (
606 #ifdef FEAT_PROFILE
607 gap != &prof_ga &&
608 #endif
609 VIM_ISDIGIT(*p))
610 {
611 bp->dbg_lnum = getdigits(&p);
612 p = skipwhite(p);
613 }
614 else
615 bp->dbg_lnum = 0;
616
617 // Find the function or file name. Don't accept a function name with ().
618 if ((!here && *p == NUL)
619 || (here && *p != NUL)
620 || (bp->dbg_type == DBG_FUNC && strstr((char *)p, "()") != NULL))
621 {
622 semsg(_(e_invarg2), arg);
623 return FAIL;
624 }
625
626 if (bp->dbg_type == DBG_FUNC)
627 bp->dbg_name = vim_strsave(STRNCMP(p, "g:", 2) == 0 ? p + 2 : p);
628 else if (here)
629 bp->dbg_name = vim_strsave(curbuf->b_ffname);
630 else if (bp->dbg_type == DBG_EXPR)
631 {
632 bp->dbg_name = vim_strsave(p);
633 if (bp->dbg_name != NULL)
634 bp->dbg_val = eval_expr_no_emsg(bp);
635 }
636 else
637 {
638 // Expand the file name in the same way as do_source(). This means
639 // doing it twice, so that $DIR/file gets expanded when $DIR is
640 // "~/dir".
641 q = expand_env_save(p);
642 if (q == NULL)
643 return FAIL;
644 p = expand_env_save(q);
645 vim_free(q);
646 if (p == NULL)
647 return FAIL;
648 if (*p != '*')
649 {
650 bp->dbg_name = fix_fname(p);
651 vim_free(p);
652 }
653 else
654 bp->dbg_name = p;
655 }
656
657 if (bp->dbg_name == NULL)
658 return FAIL;
659 return OK;
660 }
661
662 /*
663 * ":breakadd". Also used for ":profile".
664 */
665 void
ex_breakadd(exarg_T * eap)666 ex_breakadd(exarg_T *eap)
667 {
668 struct debuggy *bp;
669 char_u *pat;
670 garray_T *gap;
671
672 gap = &dbg_breakp;
673 #ifdef FEAT_PROFILE
674 if (eap->cmdidx == CMD_profile)
675 gap = &prof_ga;
676 #endif
677
678 if (dbg_parsearg(eap->arg, gap) == OK)
679 {
680 bp = &DEBUGGY(gap, gap->ga_len);
681 bp->dbg_forceit = eap->forceit;
682
683 if (bp->dbg_type != DBG_EXPR)
684 {
685 pat = file_pat_to_reg_pat(bp->dbg_name, NULL, NULL, FALSE);
686 if (pat != NULL)
687 {
688 bp->dbg_prog = vim_regcomp(pat, RE_MAGIC + RE_STRING);
689 vim_free(pat);
690 }
691 if (pat == NULL || bp->dbg_prog == NULL)
692 vim_free(bp->dbg_name);
693 else
694 {
695 if (bp->dbg_lnum == 0) // default line number is 1
696 bp->dbg_lnum = 1;
697 #ifdef FEAT_PROFILE
698 if (eap->cmdidx != CMD_profile)
699 #endif
700 {
701 DEBUGGY(gap, gap->ga_len).dbg_nr = ++last_breakp;
702 ++debug_tick;
703 }
704 ++gap->ga_len;
705 }
706 }
707 else
708 {
709 // DBG_EXPR
710 DEBUGGY(gap, gap->ga_len++).dbg_nr = ++last_breakp;
711 ++debug_tick;
712 if (gap == &dbg_breakp)
713 has_expr_breakpoint = TRUE;
714 }
715 }
716 }
717
718 /*
719 * ":debuggreedy".
720 */
721 void
ex_debuggreedy(exarg_T * eap)722 ex_debuggreedy(exarg_T *eap)
723 {
724 if (eap->addr_count == 0 || eap->line2 != 0)
725 debug_greedy = TRUE;
726 else
727 debug_greedy = FALSE;
728 }
729
730 static void
update_has_expr_breakpoint()731 update_has_expr_breakpoint()
732 {
733 int i;
734
735 has_expr_breakpoint = FALSE;
736 for (i = 0; i < dbg_breakp.ga_len; ++i)
737 if (BREAKP(i).dbg_type == DBG_EXPR)
738 {
739 has_expr_breakpoint = TRUE;
740 break;
741 }
742 }
743
744 /*
745 * Return TRUE if there is any expression breakpoint.
746 */
747 int
debug_has_expr_breakpoint()748 debug_has_expr_breakpoint()
749 {
750 return has_expr_breakpoint;
751 }
752
753 /*
754 * ":breakdel" and ":profdel".
755 */
756 void
ex_breakdel(exarg_T * eap)757 ex_breakdel(exarg_T *eap)
758 {
759 struct debuggy *bp, *bpi;
760 int nr;
761 int todel = -1;
762 int del_all = FALSE;
763 int i;
764 linenr_T best_lnum = 0;
765 garray_T *gap;
766
767 gap = &dbg_breakp;
768 if (eap->cmdidx == CMD_profdel)
769 {
770 #ifdef FEAT_PROFILE
771 gap = &prof_ga;
772 #else
773 ex_ni(eap);
774 return;
775 #endif
776 }
777
778 if (vim_isdigit(*eap->arg))
779 {
780 // ":breakdel {nr}"
781 nr = atol((char *)eap->arg);
782 for (i = 0; i < gap->ga_len; ++i)
783 if (DEBUGGY(gap, i).dbg_nr == nr)
784 {
785 todel = i;
786 break;
787 }
788 }
789 else if (*eap->arg == '*')
790 {
791 todel = 0;
792 del_all = TRUE;
793 }
794 else
795 {
796 // ":breakdel {func|file|expr} [lnum] {name}"
797 if (dbg_parsearg(eap->arg, gap) == FAIL)
798 return;
799 bp = &DEBUGGY(gap, gap->ga_len);
800 for (i = 0; i < gap->ga_len; ++i)
801 {
802 bpi = &DEBUGGY(gap, i);
803 if (bp->dbg_type == bpi->dbg_type
804 && STRCMP(bp->dbg_name, bpi->dbg_name) == 0
805 && (bp->dbg_lnum == bpi->dbg_lnum
806 || (bp->dbg_lnum == 0
807 && (best_lnum == 0
808 || bpi->dbg_lnum < best_lnum))))
809 {
810 todel = i;
811 best_lnum = bpi->dbg_lnum;
812 }
813 }
814 vim_free(bp->dbg_name);
815 }
816
817 if (todel < 0)
818 semsg(_("E161: Breakpoint not found: %s"), eap->arg);
819 else
820 {
821 while (gap->ga_len > 0)
822 {
823 vim_free(DEBUGGY(gap, todel).dbg_name);
824 #ifdef FEAT_EVAL
825 if (DEBUGGY(gap, todel).dbg_type == DBG_EXPR
826 && DEBUGGY(gap, todel).dbg_val != NULL)
827 free_tv(DEBUGGY(gap, todel).dbg_val);
828 #endif
829 vim_regfree(DEBUGGY(gap, todel).dbg_prog);
830 --gap->ga_len;
831 if (todel < gap->ga_len)
832 mch_memmove(&DEBUGGY(gap, todel), &DEBUGGY(gap, todel + 1),
833 (gap->ga_len - todel) * sizeof(struct debuggy));
834 #ifdef FEAT_PROFILE
835 if (eap->cmdidx == CMD_breakdel)
836 #endif
837 ++debug_tick;
838 if (!del_all)
839 break;
840 }
841
842 // If all breakpoints were removed clear the array.
843 if (gap->ga_len == 0)
844 ga_clear(gap);
845 if (gap == &dbg_breakp)
846 update_has_expr_breakpoint();
847 }
848 }
849
850 /*
851 * ":breaklist".
852 */
853 void
ex_breaklist(exarg_T * eap UNUSED)854 ex_breaklist(exarg_T *eap UNUSED)
855 {
856 struct debuggy *bp;
857 int i;
858
859 if (dbg_breakp.ga_len == 0)
860 msg(_("No breakpoints defined"));
861 else
862 for (i = 0; i < dbg_breakp.ga_len; ++i)
863 {
864 bp = &BREAKP(i);
865 if (bp->dbg_type == DBG_FILE)
866 home_replace(NULL, bp->dbg_name, NameBuff, MAXPATHL, TRUE);
867 if (bp->dbg_type != DBG_EXPR)
868 smsg(_("%3d %s %s line %ld"),
869 bp->dbg_nr,
870 bp->dbg_type == DBG_FUNC ? "func" : "file",
871 bp->dbg_type == DBG_FUNC ? bp->dbg_name : NameBuff,
872 (long)bp->dbg_lnum);
873 else
874 smsg(_("%3d expr %s"),
875 bp->dbg_nr, bp->dbg_name);
876 }
877 }
878
879 /*
880 * Find a breakpoint for a function or sourced file.
881 * Returns line number at which to break; zero when no matching breakpoint.
882 */
883 linenr_T
dbg_find_breakpoint(int file,char_u * fname,linenr_T after)884 dbg_find_breakpoint(
885 int file, // TRUE for a file, FALSE for a function
886 char_u *fname, // file or function name
887 linenr_T after) // after this line number
888 {
889 return debuggy_find(file, fname, after, &dbg_breakp, NULL);
890 }
891
892 #if defined(FEAT_PROFILE) || defined(PROTO)
893 /*
894 * Return TRUE if profiling is on for a function or sourced file.
895 */
896 int
has_profiling(int file,char_u * fname,int * fp)897 has_profiling(
898 int file, // TRUE for a file, FALSE for a function
899 char_u *fname, // file or function name
900 int *fp) // return: forceit
901 {
902 return (debuggy_find(file, fname, (linenr_T)0, &prof_ga, fp)
903 != (linenr_T)0);
904 }
905 #endif
906
907 /*
908 * Common code for dbg_find_breakpoint() and has_profiling().
909 */
910 static linenr_T
debuggy_find(int is_file,char_u * fname,linenr_T after,garray_T * gap,int * fp)911 debuggy_find(
912 int is_file, // TRUE for a file, FALSE for a function
913 char_u *fname, // file or function name
914 linenr_T after, // after this line number
915 garray_T *gap, // either &dbg_breakp or &prof_ga
916 int *fp) // if not NULL: return forceit
917 {
918 struct debuggy *bp;
919 int i;
920 linenr_T lnum = 0;
921 char_u *name = NULL;
922 char_u *short_name = fname;
923 int prev_got_int;
924
925 // Return quickly when there are no breakpoints.
926 if (gap->ga_len == 0)
927 return (linenr_T)0;
928
929 // For a script-local function remove the prefix, so that
930 // "profile func Func" matches "Func" in any script. Otherwise it's very
931 // difficult to profile/debug a script-local function. It may match a
932 // function in the wrong script, but that is much better than not being
933 // able to profile/debug a function in a script with unknown ID.
934 // Also match a script-specific name.
935 if (!is_file && fname[0] == K_SPECIAL)
936 {
937 short_name = vim_strchr(fname, '_') + 1;
938 name = alloc(STRLEN(fname) + 3);
939 if (name != NULL)
940 {
941 STRCPY(name, "<SNR>");
942 STRCPY(name + 5, fname + 3);
943 }
944 }
945
946 for (i = 0; i < gap->ga_len; ++i)
947 {
948 // Skip entries that are not useful or are for a line that is beyond
949 // an already found breakpoint.
950 bp = &DEBUGGY(gap, i);
951 if (((bp->dbg_type == DBG_FILE) == is_file
952 && bp->dbg_type != DBG_EXPR && (
953 #ifdef FEAT_PROFILE
954 gap == &prof_ga ||
955 #endif
956 (bp->dbg_lnum > after && (lnum == 0 || bp->dbg_lnum < lnum)))))
957 {
958 // Save the value of got_int and reset it. We don't want a
959 // previous interruption cancel matching, only hitting CTRL-C
960 // while matching should abort it.
961 prev_got_int = got_int;
962 got_int = FALSE;
963 if ((name != NULL
964 && vim_regexec_prog(&bp->dbg_prog, FALSE, name, (colnr_T)0))
965 || vim_regexec_prog(&bp->dbg_prog, FALSE,
966 short_name, (colnr_T)0))
967 {
968 lnum = bp->dbg_lnum;
969 if (fp != NULL)
970 *fp = bp->dbg_forceit;
971 }
972 got_int |= prev_got_int;
973 }
974 #ifdef FEAT_EVAL
975 else if (bp->dbg_type == DBG_EXPR)
976 {
977 typval_T *tv;
978 int line = FALSE;
979
980 tv = eval_expr_no_emsg(bp);
981 if (tv != NULL)
982 {
983 if (bp->dbg_val == NULL)
984 {
985 debug_oldval = typval_tostring(NULL, TRUE);
986 bp->dbg_val = tv;
987 debug_newval = typval_tostring(bp->dbg_val, TRUE);
988 line = TRUE;
989 }
990 else
991 {
992 if (typval_compare(tv, bp->dbg_val, EXPR_IS, FALSE) == OK
993 && tv->vval.v_number == FALSE)
994 {
995 typval_T *v;
996
997 line = TRUE;
998 debug_oldval = typval_tostring(bp->dbg_val, TRUE);
999 // Need to evaluate again, typval_compare() overwrites
1000 // "tv".
1001 v = eval_expr_no_emsg(bp);
1002 debug_newval = typval_tostring(v, TRUE);
1003 free_tv(bp->dbg_val);
1004 bp->dbg_val = v;
1005 }
1006 free_tv(tv);
1007 }
1008 }
1009 else if (bp->dbg_val != NULL)
1010 {
1011 debug_oldval = typval_tostring(bp->dbg_val, TRUE);
1012 debug_newval = typval_tostring(NULL, TRUE);
1013 free_tv(bp->dbg_val);
1014 bp->dbg_val = NULL;
1015 line = TRUE;
1016 }
1017
1018 if (line)
1019 {
1020 lnum = after > 0 ? after : 1;
1021 break;
1022 }
1023 }
1024 #endif
1025 }
1026 if (name != fname)
1027 vim_free(name);
1028
1029 return lnum;
1030 }
1031
1032 /*
1033 * Called when a breakpoint was encountered.
1034 */
1035 void
dbg_breakpoint(char_u * name,linenr_T lnum)1036 dbg_breakpoint(char_u *name, linenr_T lnum)
1037 {
1038 // We need to check if this line is actually executed in do_one_cmd()
1039 debug_breakpoint_name = name;
1040 debug_breakpoint_lnum = lnum;
1041 }
1042 #endif
1043