feat/tagfunc: preventing too deep recursion in calls to 'tagfunc'.
[vim_extended.git] / src / tag.c
blob52da97035a5f54308808cd407583a6372b55bd98
1 /* vi:set ts=8 sts=4 sw=4:
3 * VIM - Vi IMproved by Bram Moolenaar
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 */
11 * Code to handle tags and the tag stack
14 #if defined(MSDOS) || defined(WIN16) || defined(WIN32) || defined(_WIN64)
15 # include "vimio.h" /* for lseek(), must be before vim.h */
16 #endif
18 #include "vim.h"
21 * Structure to hold pointers to various items in a tag line.
23 typedef struct tag_pointers
25 /* filled in by parse_tag_line(): */
26 char_u *tagname; /* start of tag name (skip "file:") */
27 char_u *tagname_end; /* char after tag name */
28 char_u *fname; /* first char of file name */
29 char_u *fname_end; /* char after file name */
30 char_u *command; /* first char of command */
31 /* filled in by parse_match(): */
32 char_u *command_end; /* first char after command */
33 char_u *tag_fname; /* file name of the tags file. This is used
34 * when 'tr' is set. */
35 #ifdef FEAT_EMACS_TAGS
36 int is_etag; /* TRUE for emacs tag */
37 #endif
38 char_u *tagkind; /* "kind:" value */
39 char_u *tagkind_end; /* end of tagkind */
40 } tagptrs_T;
43 * The matching tags are first stored in ga_match[]. In which one depends on
44 * the priority of the match.
45 * At the end, the matches from ga_match[] are concatenated, to make a list
46 * sorted on priority.
48 #define MT_ST_CUR 0 /* static match in current file */
49 #define MT_GL_CUR 1 /* global match in current file */
50 #define MT_GL_OTH 2 /* global match in other file */
51 #define MT_ST_OTH 3 /* static match in other file */
52 #define MT_IC_ST_CUR 4 /* icase static match in current file */
53 #define MT_IC_GL_CUR 5 /* icase global match in current file */
54 #define MT_IC_GL_OTH 6 /* icase global match in other file */
55 #define MT_IC_ST_OTH 7 /* icase static match in other file */
56 #define MT_IC_OFF 4 /* add for icase match */
57 #define MT_RE_OFF 8 /* add for regexp match */
58 #define MT_MASK 7 /* mask for printing priority */
59 #define MT_COUNT 16
61 static char *mt_names[MT_COUNT/2] =
62 {"FSC", "F C", "F ", "FS ", " SC", " C", " ", " S "};
64 #define NOTAGFILE 99 /* return value for jumpto_tag */
65 static char_u *nofile_fname = NULL; /* fname for NOTAGFILE error */
67 static void taglen_advance __ARGS((int l));
69 static int jumpto_tag __ARGS((char_u *lbuf, int forceit, int keep_help));
70 #ifdef FEAT_EMACS_TAGS
71 static int parse_tag_line __ARGS((char_u *lbuf, int is_etag, tagptrs_T *tagp));
72 #else
73 static int parse_tag_line __ARGS((char_u *lbuf, tagptrs_T *tagp));
74 #endif
75 static int test_for_static __ARGS((tagptrs_T *));
76 static int parse_match __ARGS((char_u *lbuf, tagptrs_T *tagp));
77 static char_u *tag_full_fname __ARGS((tagptrs_T *tagp));
78 static char_u *expand_tag_fname __ARGS((char_u *fname, char_u *tag_fname, int expand));
79 #ifdef FEAT_EMACS_TAGS
80 static int test_for_current __ARGS((int, char_u *, char_u *, char_u *, char_u *));
81 #else
82 static int test_for_current __ARGS((char_u *, char_u *, char_u *, char_u *));
83 #endif
84 static int find_extra __ARGS((char_u **pp));
86 static char_u *bottommsg = (char_u *)N_("E555: at bottom of tag stack");
87 static char_u *topmsg = (char_u *)N_("E556: at top of tag stack");
89 static char_u *tagmatchname = NULL; /* name of last used tag */
92 * We use ftello() here, if available. It returns off_t instead of long,
93 * which helps if long is 32 bit and off_t is 64 bit.
94 * We assume that when fseeko() is available then ftello() is too.
96 #ifdef HAVE_FSEEKO
97 # define ftell ftello
98 #endif
100 #if defined(FEAT_WINDOWS) && defined(FEAT_QUICKFIX)
102 * Tag for preview window is remembered separately, to avoid messing up the
103 * normal tagstack.
105 static taggy_T ptag_entry = {NULL, {INIT_POS_T(0, 0, 0), 0}, 0, 0};
106 #endif
109 * Jump to tag; handling of tag commands and tag stack
111 * *tag != NUL: ":tag {tag}", jump to new tag, add to tag stack
113 * type == DT_TAG: ":tag [tag]", jump to newer position or same tag again
114 * type == DT_HELP: like DT_TAG, but don't use regexp.
115 * type == DT_POP: ":pop" or CTRL-T, jump to old position
116 * type == DT_NEXT: jump to next match of same tag
117 * type == DT_PREV: jump to previous match of same tag
118 * type == DT_FIRST: jump to first match of same tag
119 * type == DT_LAST: jump to last match of same tag
120 * type == DT_SELECT: ":tselect [tag]", select tag from a list of all matches
121 * type == DT_JUMP: ":tjump [tag]", jump to tag or select tag from a list
122 * type == DT_CSCOPE: use cscope to find the tag
123 * type == DT_LTAG: use location list for displaying tag matches
124 * type == DT_FREE: free cached matches
126 * for cscope, returns TRUE if we jumped to tag or aborted, FALSE otherwise
129 do_tag(tag, type, count, forceit, verbose)
130 char_u *tag; /* tag (pattern) to jump to */
131 int type;
132 int count;
133 int forceit; /* :ta with ! */
134 int verbose; /* print "tag not found" message */
136 taggy_T *tagstack = curwin->w_tagstack;
137 int tagstackidx = curwin->w_tagstackidx;
138 int tagstacklen = curwin->w_tagstacklen;
139 int cur_match = 0;
140 int cur_fnum = curbuf->b_fnum;
141 int oldtagstackidx = tagstackidx;
142 int prevtagstackidx = tagstackidx;
143 int prev_num_matches;
144 int new_tag = FALSE;
145 int other_name;
146 int i, j, k;
147 int idx;
148 int ic;
149 char_u *p;
150 char_u *name;
151 int no_regexp = FALSE;
152 int error_cur_match = 0;
153 char_u *command_end;
154 int save_pos = FALSE;
155 fmark_T saved_fmark;
156 int taglen;
157 #ifdef FEAT_CSCOPE
158 int jumped_to_tag = FALSE;
159 #endif
160 tagptrs_T tagp, tagp2;
161 int new_num_matches;
162 char_u **new_matches;
163 int attr;
164 int use_tagstack;
165 int skip_msg = FALSE;
166 char_u *buf_ffname = curbuf->b_ffname; /* name to use for
167 priority computation */
169 /* remember the matches for the last used tag */
170 static int num_matches = 0;
171 static int max_num_matches = 0; /* limit used for match search */
172 static char_u **matches = NULL;
173 static int flags;
175 #ifdef EXITFREE
176 if (type == DT_FREE)
178 /* remove the list of matches */
179 FreeWild(num_matches, matches);
180 # ifdef FEAT_CSCOPE
181 cs_free_tags();
182 # endif
183 num_matches = 0;
184 return FALSE;
186 #endif
188 if (type == DT_HELP)
190 type = DT_TAG;
191 no_regexp = TRUE;
194 prev_num_matches = num_matches;
195 free_string_option(nofile_fname);
196 nofile_fname = NULL;
198 clearpos(&saved_fmark.mark); /* shutup gcc 4.0 */
199 saved_fmark.fnum = 0;
202 * Don't add a tag to the tagstack if 'tagstack' has been reset.
204 if ((!p_tgst && *tag != NUL))
206 use_tagstack = FALSE;
207 new_tag = TRUE;
209 else
211 #if defined(FEAT_WINDOWS) && defined(FEAT_QUICKFIX)
212 if (g_do_tagpreview)
213 use_tagstack = FALSE;
214 else
215 #endif
216 use_tagstack = TRUE;
218 /* new pattern, add to the tag stack */
219 if (*tag != NUL
220 && (type == DT_TAG || type == DT_SELECT || type == DT_JUMP
221 #ifdef FEAT_QUICKFIX
222 || type == DT_LTAG
223 #endif
224 #ifdef FEAT_CSCOPE
225 || type == DT_CSCOPE
226 #endif
229 #if defined(FEAT_WINDOWS) && defined(FEAT_QUICKFIX)
230 if (g_do_tagpreview)
232 if (ptag_entry.tagname != NULL
233 && STRCMP(ptag_entry.tagname, tag) == 0)
235 /* Jumping to same tag: keep the current match, so that
236 * the CursorHold autocommand example works. */
237 cur_match = ptag_entry.cur_match;
238 cur_fnum = ptag_entry.cur_fnum;
240 else
242 vim_free(ptag_entry.tagname);
243 if ((ptag_entry.tagname = vim_strsave(tag)) == NULL)
244 goto end_do_tag;
247 else
248 #endif
251 * If the last used entry is not at the top, delete all tag
252 * stack entries above it.
254 while (tagstackidx < tagstacklen)
255 vim_free(tagstack[--tagstacklen].tagname);
257 /* if the tagstack is full: remove oldest entry */
258 if (++tagstacklen > TAGSTACKSIZE)
260 tagstacklen = TAGSTACKSIZE;
261 vim_free(tagstack[0].tagname);
262 for (i = 1; i < tagstacklen; ++i)
263 tagstack[i - 1] = tagstack[i];
264 --tagstackidx;
268 * put the tag name in the tag stack
270 if ((tagstack[tagstackidx].tagname = vim_strsave(tag)) == NULL)
272 curwin->w_tagstacklen = tagstacklen - 1;
273 goto end_do_tag;
275 curwin->w_tagstacklen = tagstacklen;
277 save_pos = TRUE; /* save the cursor position below */
280 new_tag = TRUE;
282 else
284 if (
285 #if defined(FEAT_WINDOWS) && defined(FEAT_QUICKFIX)
286 g_do_tagpreview ? ptag_entry.tagname == NULL :
287 #endif
288 tagstacklen == 0)
290 /* empty stack */
291 EMSG(_(e_tagstack));
292 goto end_do_tag;
295 if (type == DT_POP) /* go to older position */
297 #ifdef FEAT_FOLDING
298 int old_KeyTyped = KeyTyped;
299 #endif
300 if ((tagstackidx -= count) < 0)
302 EMSG(_(bottommsg));
303 if (tagstackidx + count == 0)
305 /* We did [num]^T from the bottom of the stack */
306 tagstackidx = 0;
307 goto end_do_tag;
309 /* We weren't at the bottom of the stack, so jump all the
310 * way to the bottom now.
312 tagstackidx = 0;
314 else if (tagstackidx >= tagstacklen) /* count == 0? */
316 EMSG(_(topmsg));
317 goto end_do_tag;
320 /* Make a copy of the fmark, autocommands may invalidate the
321 * tagstack before it's used. */
322 saved_fmark = tagstack[tagstackidx].fmark;
323 if (saved_fmark.fnum != curbuf->b_fnum)
326 * Jump to other file. If this fails (e.g. because the
327 * file was changed) keep original position in tag stack.
329 if (buflist_getfile(saved_fmark.fnum, saved_fmark.mark.lnum,
330 GETF_SETMARK, forceit) == FAIL)
332 tagstackidx = oldtagstackidx; /* back to old posn */
333 goto end_do_tag;
335 /* An BufReadPost autocommand may jump to the '" mark, but
336 * we don't what that here. */
337 curwin->w_cursor.lnum = saved_fmark.mark.lnum;
339 else
341 setpcmark();
342 curwin->w_cursor.lnum = saved_fmark.mark.lnum;
344 curwin->w_cursor.col = saved_fmark.mark.col;
345 curwin->w_set_curswant = TRUE;
346 check_cursor();
347 #ifdef FEAT_FOLDING
348 if ((fdo_flags & FDO_TAG) && old_KeyTyped)
349 foldOpenCursor();
350 #endif
352 /* remove the old list of matches */
353 FreeWild(num_matches, matches);
354 #ifdef FEAT_CSCOPE
355 cs_free_tags();
356 #endif
357 num_matches = 0;
358 tag_freematch();
359 goto end_do_tag;
362 if (type == DT_TAG
363 #if defined(FEAT_QUICKFIX)
364 || type == DT_LTAG
365 #endif
368 #if defined(FEAT_WINDOWS) && defined(FEAT_QUICKFIX)
369 if (g_do_tagpreview)
371 cur_match = ptag_entry.cur_match;
372 cur_fnum = ptag_entry.cur_fnum;
374 else
375 #endif
377 /* ":tag" (no argument): go to newer pattern */
378 save_pos = TRUE; /* save the cursor position below */
379 if ((tagstackidx += count - 1) >= tagstacklen)
382 * Beyond the last one, just give an error message and
383 * go to the last one. Don't store the cursor
384 * position.
386 tagstackidx = tagstacklen - 1;
387 EMSG(_(topmsg));
388 save_pos = FALSE;
390 else if (tagstackidx < 0) /* must have been count == 0 */
392 EMSG(_(bottommsg));
393 tagstackidx = 0;
394 goto end_do_tag;
396 cur_match = tagstack[tagstackidx].cur_match;
397 cur_fnum = tagstack[tagstackidx].cur_fnum;
399 new_tag = TRUE;
401 else /* go to other matching tag */
403 /* Save index for when selection is cancelled. */
404 prevtagstackidx = tagstackidx;
406 #if defined(FEAT_WINDOWS) && defined(FEAT_QUICKFIX)
407 if (g_do_tagpreview)
409 cur_match = ptag_entry.cur_match;
410 cur_fnum = ptag_entry.cur_fnum;
412 else
413 #endif
415 if (--tagstackidx < 0)
416 tagstackidx = 0;
417 cur_match = tagstack[tagstackidx].cur_match;
418 cur_fnum = tagstack[tagstackidx].cur_fnum;
420 switch (type)
422 case DT_FIRST: cur_match = count - 1; break;
423 case DT_SELECT:
424 case DT_JUMP:
425 #ifdef FEAT_CSCOPE
426 case DT_CSCOPE:
427 #endif
428 case DT_LAST: cur_match = MAXCOL - 1; break;
429 case DT_NEXT: cur_match += count; break;
430 case DT_PREV: cur_match -= count; break;
432 if (cur_match >= MAXCOL)
433 cur_match = MAXCOL - 1;
434 else if (cur_match < 0)
436 EMSG(_("E425: Cannot go before first matching tag"));
437 skip_msg = TRUE;
438 cur_match = 0;
439 cur_fnum = curbuf->b_fnum;
444 #if defined(FEAT_WINDOWS) && defined(FEAT_QUICKFIX)
445 if (g_do_tagpreview)
447 if (type != DT_SELECT && type != DT_JUMP)
449 ptag_entry.cur_match = cur_match;
450 ptag_entry.cur_fnum = cur_fnum;
453 else
454 #endif
457 * For ":tag [arg]" or ":tselect" remember position before the jump.
459 saved_fmark = tagstack[tagstackidx].fmark;
460 if (save_pos)
462 tagstack[tagstackidx].fmark.mark = curwin->w_cursor;
463 tagstack[tagstackidx].fmark.fnum = curbuf->b_fnum;
466 /* Curwin will change in the call to jumpto_tag() if ":stag" was
467 * used or an autocommand jumps to another window; store value of
468 * tagstackidx now. */
469 curwin->w_tagstackidx = tagstackidx;
470 if (type != DT_SELECT && type != DT_JUMP)
472 curwin->w_tagstack[tagstackidx].cur_match = cur_match;
473 curwin->w_tagstack[tagstackidx].cur_fnum = cur_fnum;
478 /* When not using the current buffer get the name of buffer "cur_fnum".
479 * Makes sure that the tag order doesn't change when using a remembered
480 * position for "cur_match". */
481 if (cur_fnum != curbuf->b_fnum)
483 buf_T *buf = buflist_findnr(cur_fnum);
485 if (buf != NULL)
486 buf_ffname = buf->b_ffname;
490 * Repeat searching for tags, when a file has not been found.
492 for (;;)
495 * When desired match not found yet, try to find it (and others).
497 if (use_tagstack)
498 name = tagstack[tagstackidx].tagname;
499 #if defined(FEAT_WINDOWS) && defined(FEAT_QUICKFIX)
500 else if (g_do_tagpreview)
501 name = ptag_entry.tagname;
502 #endif
503 else
504 name = tag;
505 other_name = (tagmatchname == NULL || STRCMP(tagmatchname, name) != 0);
506 if (new_tag
507 || (cur_match >= num_matches && max_num_matches != MAXCOL)
508 || other_name)
510 if (other_name)
512 vim_free(tagmatchname);
513 tagmatchname = vim_strsave(name);
517 * If a count is supplied to the ":tag <name>" command, then
518 * jump to count'th matching tag.
520 if (type == DT_TAG && *tag != NUL && count > 0)
521 cur_match = count - 1;
523 if (type == DT_SELECT || type == DT_JUMP
524 #if defined(FEAT_QUICKFIX)
525 || type == DT_LTAG
526 #endif
528 cur_match = MAXCOL - 1;
529 max_num_matches = cur_match + 1;
531 /* when the argument starts with '/', use it as a regexp */
532 if (!no_regexp && *name == '/')
534 flags = TAG_REGEXP;
535 ++name;
537 else
538 flags = TAG_NOIC;
540 #ifdef FEAT_CSCOPE
541 if (type == DT_CSCOPE)
542 flags = TAG_CSCOPE;
543 #endif
544 if (verbose)
545 flags |= TAG_VERBOSE;
546 if (type == DT_TAG)
547 flags |= TAG_USE_TFU;
549 if (find_tags(name, &new_num_matches, &new_matches, flags,
550 max_num_matches, buf_ffname) == OK
551 && new_num_matches < max_num_matches)
552 max_num_matches = MAXCOL; /* If less than max_num_matches
553 found: all matches found. */
555 /* If there already were some matches for the same name, move them
556 * to the start. Avoids that the order changes when using
557 * ":tnext" and jumping to another file. */
558 if (!new_tag && !other_name)
560 /* Find the position of each old match in the new list. Need
561 * to use parse_match() to find the tag line. */
562 idx = 0;
563 for (j = 0; j < num_matches; ++j)
565 parse_match(matches[j], &tagp);
566 for (i = idx; i < new_num_matches; ++i)
568 parse_match(new_matches[i], &tagp2);
569 if (STRCMP(tagp.tagname, tagp2.tagname) == 0)
571 p = new_matches[i];
572 for (k = i; k > idx; --k)
573 new_matches[k] = new_matches[k - 1];
574 new_matches[idx++] = p;
575 break;
580 FreeWild(num_matches, matches);
581 num_matches = new_num_matches;
582 matches = new_matches;
585 if (num_matches <= 0)
587 if (verbose)
588 EMSG2(_("E426: tag not found: %s"), name);
589 #if defined(FEAT_WINDOWS) && defined(FEAT_QUICKFIX)
590 g_do_tagpreview = 0;
591 #endif
593 else
595 int ask_for_selection = FALSE;
597 #ifdef FEAT_CSCOPE
598 if (type == DT_CSCOPE && num_matches > 1)
600 cs_print_tags();
601 ask_for_selection = TRUE;
603 else
604 #endif
605 if (type == DT_SELECT || (type == DT_JUMP && num_matches > 1))
608 * List all the matching tags.
609 * Assume that the first match indicates how long the tags can
610 * be, and align the file names to that.
612 parse_match(matches[0], &tagp);
613 taglen = (int)(tagp.tagname_end - tagp.tagname + 2);
614 if (taglen < 18)
615 taglen = 18;
616 if (taglen > Columns - 25)
617 taglen = MAXCOL;
618 if (msg_col == 0)
619 msg_didout = FALSE; /* overwrite previous message */
620 msg_start();
621 MSG_PUTS_ATTR(_(" # pri kind tag"), hl_attr(HLF_T));
622 msg_clr_eos();
623 taglen_advance(taglen);
624 MSG_PUTS_ATTR(_("file\n"), hl_attr(HLF_T));
626 for (i = 0; i < num_matches && !got_int; ++i)
628 parse_match(matches[i], &tagp);
629 if (!new_tag && (
630 #if defined(FEAT_WINDOWS) && defined(FEAT_QUICKFIX)
631 (g_do_tagpreview
632 && i == ptag_entry.cur_match) ||
633 #endif
634 (use_tagstack
635 && i == tagstack[tagstackidx].cur_match)))
636 *IObuff = '>';
637 else
638 *IObuff = ' ';
639 vim_snprintf((char *)IObuff + 1, IOSIZE - 1,
640 "%2d %s ", i + 1,
641 mt_names[matches[i][0] & MT_MASK]);
642 msg_puts(IObuff);
643 if (tagp.tagkind != NULL)
644 msg_outtrans_len(tagp.tagkind,
645 (int)(tagp.tagkind_end - tagp.tagkind));
646 msg_advance(13);
647 msg_outtrans_len_attr(tagp.tagname,
648 (int)(tagp.tagname_end - tagp.tagname),
649 hl_attr(HLF_T));
650 msg_putchar(' ');
651 taglen_advance(taglen);
653 /* Find out the actual file name. If it is long, truncate
654 * it and put "..." in the middle */
655 p = tag_full_fname(&tagp);
656 if (p != NULL)
658 msg_puts_long_attr(p, hl_attr(HLF_D));
659 vim_free(p);
661 if (msg_col > 0)
662 msg_putchar('\n');
663 if (got_int)
664 break;
665 msg_advance(15);
667 /* print any extra fields */
668 command_end = tagp.command_end;
669 if (command_end != NULL)
671 p = command_end + 3;
672 while (*p && *p != '\r' && *p != '\n')
674 while (*p == TAB)
675 ++p;
677 /* skip "file:" without a value (static tag) */
678 if (STRNCMP(p, "file:", 5) == 0
679 && vim_isspace(p[5]))
681 p += 5;
682 continue;
684 /* skip "kind:<kind>" and "<kind>" */
685 if (p == tagp.tagkind
686 || (p + 5 == tagp.tagkind
687 && STRNCMP(p, "kind:", 5) == 0))
689 p = tagp.tagkind_end;
690 continue;
692 /* print all other extra fields */
693 attr = hl_attr(HLF_CM);
694 while (*p && *p != '\r' && *p != '\n')
696 if (msg_col + ptr2cells(p) >= Columns)
698 msg_putchar('\n');
699 if (got_int)
700 break;
701 msg_advance(15);
703 p = msg_outtrans_one(p, attr);
704 if (*p == TAB)
706 msg_puts_attr((char_u *)" ", attr);
707 break;
709 if (*p == ':')
710 attr = 0;
713 if (msg_col > 15)
715 msg_putchar('\n');
716 if (got_int)
717 break;
718 msg_advance(15);
721 else
723 for (p = tagp.command;
724 *p && *p != '\r' && *p != '\n'; ++p)
726 command_end = p;
730 * Put the info (in several lines) at column 15.
731 * Don't display "/^" and "?^".
733 p = tagp.command;
734 if (*p == '/' || *p == '?')
736 ++p;
737 if (*p == '^')
738 ++p;
740 /* Remove leading whitespace from pattern */
741 while (p != command_end && vim_isspace(*p))
742 ++p;
744 while (p != command_end)
746 if (msg_col + (*p == TAB ? 1 : ptr2cells(p)) > Columns)
747 msg_putchar('\n');
748 if (got_int)
749 break;
750 msg_advance(15);
752 /* skip backslash used for escaping command char */
753 if (*p == '\\' && *(p + 1) == *tagp.command)
754 ++p;
756 if (*p == TAB)
758 msg_putchar(' ');
759 ++p;
761 else
762 p = msg_outtrans_one(p, 0);
764 /* don't display the "$/;\"" and "$?;\"" */
765 if (p == command_end - 2 && *p == '$'
766 && *(p + 1) == *tagp.command)
767 break;
768 /* don't display matching '/' or '?' */
769 if (p == command_end - 1 && *p == *tagp.command
770 && (*p == '/' || *p == '?'))
771 break;
773 if (msg_col)
774 msg_putchar('\n');
775 ui_breakcheck();
777 if (got_int)
778 got_int = FALSE; /* only stop the listing */
779 ask_for_selection = TRUE;
781 #if defined(FEAT_QUICKFIX) && defined(FEAT_EVAL)
782 else if (type == DT_LTAG)
784 list_T *list;
785 char_u tag_name[128 + 1];
786 char_u fname[MAXPATHL + 1];
787 char_u cmd[CMDBUFFSIZE + 1];
790 * Add the matching tags to the location list for the current
791 * window.
794 list = list_alloc();
795 if (list == NULL)
796 goto end_do_tag;
798 for (i = 0; i < num_matches; ++i)
800 int len, cmd_len;
801 long lnum;
802 dict_T *dict;
804 parse_match(matches[i], &tagp);
806 /* Save the tag name */
807 len = (int)(tagp.tagname_end - tagp.tagname);
808 if (len > 128)
809 len = 128;
810 vim_strncpy(tag_name, tagp.tagname, len);
811 tag_name[len] = NUL;
813 /* Save the tag file name */
814 p = tag_full_fname(&tagp);
815 if (p == NULL)
816 continue;
817 STRCPY(fname, p);
818 vim_free(p);
821 * Get the line number or the search pattern used to locate
822 * the tag.
824 lnum = 0;
825 if (isdigit(*tagp.command))
826 /* Line number is used to locate the tag */
827 lnum = atol((char *)tagp.command);
828 else
830 char_u *cmd_start, *cmd_end;
832 /* Search pattern is used to locate the tag */
834 /* Locate the end of the command */
835 cmd_start = tagp.command;
836 cmd_end = tagp.command_end;
837 if (cmd_end == NULL)
839 for (p = tagp.command;
840 *p && *p != '\r' && *p != '\n'; ++p)
842 cmd_end = p;
846 * Now, cmd_end points to the character after the
847 * command. Adjust it to point to the last
848 * character of the command.
850 cmd_end--;
853 * Skip the '/' and '?' characters at the
854 * beginning and end of the search pattern.
856 if (*cmd_start == '/' || *cmd_start == '?')
857 cmd_start++;
859 if (*cmd_end == '/' || *cmd_end == '?')
860 cmd_end--;
862 len = 0;
863 cmd[0] = NUL;
866 * If "^" is present in the tag search pattern, then
867 * copy it first.
869 if (*cmd_start == '^')
871 STRCPY(cmd, "^");
872 cmd_start++;
873 len++;
877 * Precede the tag pattern with \V to make it very
878 * nomagic.
880 STRCAT(cmd, "\\V");
881 len += 2;
883 cmd_len = (int)(cmd_end - cmd_start + 1);
884 if (cmd_len > (CMDBUFFSIZE - 5))
885 cmd_len = CMDBUFFSIZE - 5;
886 STRNCAT(cmd, cmd_start, cmd_len);
887 len += cmd_len;
889 if (cmd[len - 1] == '$')
892 * Replace '$' at the end of the search pattern
893 * with '\$'
895 cmd[len - 1] = '\\';
896 cmd[len] = '$';
897 len++;
900 cmd[len] = NUL;
903 if ((dict = dict_alloc()) == NULL)
904 continue;
905 if (list_append_dict(list, dict) == FAIL)
907 vim_free(dict);
908 continue;
911 dict_add_nr_str(dict, "text", 0L, tag_name);
912 dict_add_nr_str(dict, "filename", 0L, fname);
913 dict_add_nr_str(dict, "lnum", lnum, NULL);
914 if (lnum == 0)
915 dict_add_nr_str(dict, "pattern", 0L, cmd);
918 set_errorlist(curwin, list, ' ');
920 list_free(list, TRUE);
922 cur_match = 0; /* Jump to the first tag */
924 #endif
926 if (ask_for_selection == TRUE)
929 * Ask to select a tag from the list.
931 i = prompt_for_number(NULL);
932 if (i <= 0 || i > num_matches || got_int)
934 /* no valid choice: don't change anything */
935 if (use_tagstack)
937 tagstack[tagstackidx].fmark = saved_fmark;
938 tagstackidx = prevtagstackidx;
940 #ifdef FEAT_CSCOPE
941 cs_free_tags();
942 jumped_to_tag = TRUE;
943 #endif
944 break;
946 cur_match = i - 1;
949 if (cur_match >= num_matches)
951 /* Avoid giving this error when a file wasn't found and we're
952 * looking for a match in another file, which wasn't found.
953 * There will be an EMSG("file doesn't exist") below then. */
954 if ((type == DT_NEXT || type == DT_FIRST)
955 && nofile_fname == NULL)
957 if (num_matches == 1)
958 EMSG(_("E427: There is only one matching tag"));
959 else
960 EMSG(_("E428: Cannot go beyond last matching tag"));
961 skip_msg = TRUE;
963 cur_match = num_matches - 1;
965 if (use_tagstack)
967 tagstack[tagstackidx].cur_match = cur_match;
968 tagstack[tagstackidx].cur_fnum = cur_fnum;
969 ++tagstackidx;
971 #if defined(FEAT_WINDOWS) && defined(FEAT_QUICKFIX)
972 else if (g_do_tagpreview)
974 ptag_entry.cur_match = cur_match;
975 ptag_entry.cur_fnum = cur_fnum;
977 #endif
980 * Only when going to try the next match, report that the previous
981 * file didn't exist. Otherwise an EMSG() is given below.
983 if (nofile_fname != NULL && error_cur_match != cur_match)
984 smsg((char_u *)_("File \"%s\" does not exist"), nofile_fname);
987 ic = (matches[cur_match][0] & MT_IC_OFF);
988 if (type != DT_SELECT && type != DT_JUMP
989 #ifdef FEAT_CSCOPE
990 && type != DT_CSCOPE
991 #endif
992 && (num_matches > 1 || ic)
993 && !skip_msg)
995 /* Give an indication of the number of matching tags */
996 sprintf((char *)IObuff, _("tag %d of %d%s"),
997 cur_match + 1,
998 num_matches,
999 max_num_matches != MAXCOL ? _(" or more") : "");
1000 if (ic)
1001 STRCAT(IObuff, _(" Using tag with different case!"));
1002 if ((num_matches > prev_num_matches || new_tag)
1003 && num_matches > 1)
1005 if (ic)
1006 msg_attr(IObuff, hl_attr(HLF_W));
1007 else
1008 msg(IObuff);
1009 msg_scroll = TRUE; /* don't overwrite this message */
1011 else
1012 give_warning(IObuff, ic);
1013 if (ic && !msg_scrolled && msg_silent == 0)
1015 out_flush();
1016 ui_delay(1000L, TRUE);
1020 #ifdef FEAT_AUTOCMD
1021 /* Let the SwapExists event know what tag we are jumping to. */
1022 vim_snprintf((char *)IObuff, IOSIZE, ":ta %s\r", name);
1023 set_vim_var_string(VV_SWAPCOMMAND, IObuff, -1);
1024 #endif
1027 * Jump to the desired match.
1029 i = jumpto_tag(matches[cur_match], forceit, type != DT_CSCOPE);
1031 #ifdef FEAT_AUTOCMD
1032 set_vim_var_string(VV_SWAPCOMMAND, NULL, -1);
1033 #endif
1035 if (i == NOTAGFILE)
1037 /* File not found: try again with another matching tag */
1038 if ((type == DT_PREV && cur_match > 0)
1039 || ((type == DT_TAG || type == DT_NEXT
1040 || type == DT_FIRST)
1041 && (max_num_matches != MAXCOL
1042 || cur_match < num_matches - 1)))
1044 error_cur_match = cur_match;
1045 if (use_tagstack)
1046 --tagstackidx;
1047 if (type == DT_PREV)
1048 --cur_match;
1049 else
1051 type = DT_NEXT;
1052 ++cur_match;
1054 continue;
1056 EMSG2(_("E429: File \"%s\" does not exist"), nofile_fname);
1058 else
1060 /* We may have jumped to another window, check that
1061 * tagstackidx is still valid. */
1062 if (use_tagstack && tagstackidx > curwin->w_tagstacklen)
1063 tagstackidx = curwin->w_tagstackidx;
1064 #ifdef FEAT_CSCOPE
1065 jumped_to_tag = TRUE;
1066 #endif
1069 break;
1072 end_do_tag:
1073 /* Only store the new index when using the tagstack and it's valid. */
1074 if (use_tagstack && tagstackidx <= curwin->w_tagstacklen)
1075 curwin->w_tagstackidx = tagstackidx;
1076 #ifdef FEAT_WINDOWS
1077 postponed_split = 0; /* don't split next time */
1078 #endif
1080 #ifdef FEAT_CSCOPE
1081 return jumped_to_tag;
1082 #else
1083 return FALSE;
1084 #endif
1088 * Free cached tags.
1090 void
1091 tag_freematch()
1093 vim_free(tagmatchname);
1094 tagmatchname = NULL;
1097 static void
1098 taglen_advance(l)
1099 int l;
1101 if (l == MAXCOL)
1103 msg_putchar('\n');
1104 msg_advance(24);
1106 else
1107 msg_advance(13 + l);
1111 * Print the tag stack
1113 void
1114 do_tags(eap)
1115 exarg_T *eap UNUSED;
1117 int i;
1118 char_u *name;
1119 taggy_T *tagstack = curwin->w_tagstack;
1120 int tagstackidx = curwin->w_tagstackidx;
1121 int tagstacklen = curwin->w_tagstacklen;
1123 /* Highlight title */
1124 MSG_PUTS_TITLE(_("\n # TO tag FROM line in file/text"));
1125 for (i = 0; i < tagstacklen; ++i)
1127 if (tagstack[i].tagname != NULL)
1129 name = fm_getname(&(tagstack[i].fmark), 30);
1130 if (name == NULL) /* file name not available */
1131 continue;
1133 msg_putchar('\n');
1134 sprintf((char *)IObuff, "%c%2d %2d %-15s %5ld ",
1135 i == tagstackidx ? '>' : ' ',
1136 i + 1,
1137 tagstack[i].cur_match + 1,
1138 tagstack[i].tagname,
1139 tagstack[i].fmark.mark.lnum);
1140 msg_outtrans(IObuff);
1141 msg_outtrans_attr(name, tagstack[i].fmark.fnum == curbuf->b_fnum
1142 ? hl_attr(HLF_D) : 0);
1143 vim_free(name);
1145 out_flush(); /* show one line at a time */
1147 if (tagstackidx == tagstacklen) /* idx at top of stack */
1148 MSG_PUTS("\n>");
1151 /* When not using a CR for line separator, use vim_fgets() to read tag lines.
1152 * For the Mac use tag_fgets(). It can handle any line separator, but is much
1153 * slower than vim_fgets().
1155 #ifndef USE_CR
1156 # define tag_fgets vim_fgets
1157 #endif
1159 #ifdef FEAT_TAG_BINS
1160 static int tag_strnicmp __ARGS((char_u *s1, char_u *s2, size_t len));
1163 * Compare two strings, for length "len", ignoring case the ASCII way.
1164 * return 0 for match, < 0 for smaller, > 0 for bigger
1165 * Make sure case is folded to uppercase in comparison (like for 'sort -f')
1167 static int
1168 tag_strnicmp(s1, s2, len)
1169 char_u *s1;
1170 char_u *s2;
1171 size_t len;
1173 int i;
1175 while (len > 0)
1177 i = (int)TOUPPER_ASC(*s1) - (int)TOUPPER_ASC(*s2);
1178 if (i != 0)
1179 return i; /* this character different */
1180 if (*s1 == NUL)
1181 break; /* strings match until NUL */
1182 ++s1;
1183 ++s2;
1184 --len;
1186 return 0; /* strings match */
1188 #endif
1191 * Structure to hold info about the tag pattern being used.
1193 typedef struct
1195 char_u *pat; /* the pattern */
1196 int len; /* length of pat[] */
1197 char_u *head; /* start of pattern head */
1198 int headlen; /* length of head[] */
1199 regmatch_T regmatch; /* regexp program, may be NULL */
1200 } pat_T;
1202 static void prepare_pats __ARGS((pat_T *pats, int has_re));
1205 * Extract info from the tag search pattern "pats->pat".
1207 static void
1208 prepare_pats(pats, has_re)
1209 pat_T *pats;
1210 int has_re;
1212 pats->head = pats->pat;
1213 pats->headlen = pats->len;
1214 if (has_re)
1216 /* When the pattern starts with '^' or "\\<", binary searching can be
1217 * used (much faster). */
1218 if (pats->pat[0] == '^')
1219 pats->head = pats->pat + 1;
1220 else if (pats->pat[0] == '\\' && pats->pat[1] == '<')
1221 pats->head = pats->pat + 2;
1222 if (pats->head == pats->pat)
1223 pats->headlen = 0;
1224 else
1225 for (pats->headlen = 0; pats->head[pats->headlen] != NUL;
1226 ++pats->headlen)
1227 if (vim_strchr((char_u *)(p_magic ? ".[~*\\$" : "\\$"),
1228 pats->head[pats->headlen]) != NULL)
1229 break;
1230 if (p_tl != 0 && pats->headlen > p_tl) /* adjust for 'taglength' */
1231 pats->headlen = p_tl;
1234 if (has_re)
1235 pats->regmatch.regprog = vim_regcomp(pats->pat, p_magic ? RE_MAGIC : 0);
1236 else
1237 pats->regmatch.regprog = NULL;
1240 struct match_found
1242 int len; /* nr of chars of match[] to be compared */
1243 char_u match[1]; /* actually longer */
1246 static int
1247 find_tfu_tags(char_u *pat, garray_T *ga, int *match_count)
1249 pos_T pos;
1250 list_T *taglist;
1251 listitem_T *item, *item2;
1252 int ntags = 0;
1253 const int nfieds_required = 3;
1254 int result = FAIL;
1256 static int call_level = 0;
1258 /* Prevent endless loop: */
1259 ++call_level;
1260 if (call_level > 5)
1261 goto done;
1263 if (*curbuf->b_p_tfu == NUL)
1264 goto done;
1266 pos = curwin->w_cursor;
1267 taglist = call_func_retlist(curbuf->b_p_tfu, 1, &pat, FALSE);
1268 curwin->w_cursor = pos; /* restore the cursor position */
1270 if (taglist == NULL)
1271 goto done;
1273 for (item = taglist->lv_first; item != NULL; item = item->li_next)
1275 struct match_found *mfp;
1276 int len;
1277 if (item->li_tv.v_type != VAR_LIST)
1279 /* FIXME:2010-04-24:llorens: ... */
1280 continue;
1282 if (item->li_tv.vval.v_list->lv_len != nfieds_required)
1284 /* FIXME:2010-04-24:llorens: ... */
1285 continue;
1287 #ifdef FEAT_EMACS_TAGS
1288 len = 3;
1289 #else
1290 len = 2;
1291 #endif
1292 len += nfieds_required;
1294 for (item2 = item->li_tv.vval.v_list->lv_first;
1295 item2 != NULL;
1296 item2 = item2->li_next)
1298 if (item2->li_tv.v_type != VAR_STRING)
1300 /* FIXME:2010-04-24:llorens: ... */
1301 continue;
1303 len += STRLEN(item2->li_tv.vval.v_string);
1306 mfp = (struct match_found *)alloc(
1307 (int)sizeof(struct match_found) + len);
1308 if (mfp != NULL)
1310 char_u *p;
1311 mfp->len = len;
1312 p = mfp->match;
1313 p[0] = 0; /* mtt */
1314 p[1] = NUL; /* no tag file name */
1315 p = p + 2;
1316 #ifdef FEAT_EMACS_TAGS
1317 *p = NUL;
1318 ++p;
1319 #endif
1320 for (item2 = item->li_tv.vval.v_list->lv_first;
1321 item2 != NULL;
1322 item2 = item2->li_next)
1324 STRCPY(p, item2->li_tv.vval.v_string);
1325 p += STRLEN(item2->li_tv.vval.v_string);
1326 if (item2->li_next != NULL)
1328 *p = TAB;
1329 ++p;
1332 /* FIXME:2010-04-24:llorens: Don't add identical matches. */
1333 if (ga_grow(ga, 1) == OK)
1335 ((struct match_found **)(ga->ga_data)) [ga->ga_len++] = mfp;
1336 ++ntags;
1337 result = OK;
1339 else
1340 vim_free(mfp);
1344 list_free(taglist, TRUE);
1345 done:
1346 --call_level;
1347 *match_count = ntags;
1348 return result;
1352 * find_tags() - search for tags in tags files
1354 * Return FAIL if search completely failed (*num_matches will be 0, *matchesp
1355 * will be NULL), OK otherwise.
1357 * There is a priority in which type of tag is recognized.
1359 * 6. A static or global tag with a full matching tag for the current file.
1360 * 5. A global tag with a full matching tag for another file.
1361 * 4. A static tag with a full matching tag for another file.
1362 * 3. A static or global tag with an ignore-case matching tag for the
1363 * current file.
1364 * 2. A global tag with an ignore-case matching tag for another file.
1365 * 1. A static tag with an ignore-case matching tag for another file.
1367 * Tags in an emacs-style tags file are always global.
1369 * flags:
1370 * TAG_HELP only search for help tags
1371 * TAG_NAMES only return name of tag
1372 * TAG_REGEXP use "pat" as a regexp
1373 * TAG_NOIC don't always ignore case
1374 * TAG_KEEP_LANG keep language
1377 find_tags(pat, num_matches, matchesp, flags, mincount, buf_ffname)
1378 char_u *pat; /* pattern to search for */
1379 int *num_matches; /* return: number of matches found */
1380 char_u ***matchesp; /* return: array of matches found */
1381 int flags;
1382 int mincount; /* MAXCOL: find all matches
1383 other: minimal number of matches */
1384 char_u *buf_ffname; /* name of buffer for priority */
1386 FILE *fp;
1387 char_u *lbuf; /* line buffer */
1388 char_u *tag_fname; /* name of tag file */
1389 tagname_T tn; /* info for get_tagfname() */
1390 int first_file; /* trying first tag file */
1391 tagptrs_T tagp;
1392 int did_open = FALSE; /* did open a tag file */
1393 int stop_searching = FALSE; /* stop when match found or error */
1394 int retval = FAIL; /* return value */
1395 int is_static; /* current tag line is static */
1396 int is_current; /* file name matches */
1397 int eof = FALSE; /* found end-of-file */
1398 char_u *p;
1399 char_u *s;
1400 int i;
1401 #ifdef FEAT_TAG_BINS
1402 struct tag_search_info /* Binary search file offsets */
1404 off_t low_offset; /* offset for first char of first line that
1405 could match */
1406 off_t high_offset; /* offset of char after last line that could
1407 match */
1408 off_t curr_offset; /* Current file offset in search range */
1409 off_t curr_offset_used; /* curr_offset used when skipping back */
1410 off_t match_offset; /* Where the binary search found a tag */
1411 int low_char; /* first char at low_offset */
1412 int high_char; /* first char at high_offset */
1413 } search_info;
1414 off_t filesize;
1415 int tagcmp;
1416 off_t offset;
1417 int round;
1418 #endif
1419 enum
1421 TS_START, /* at start of file */
1422 TS_LINEAR /* linear searching forward, till EOF */
1423 #ifdef FEAT_TAG_BINS
1424 , TS_BINARY, /* binary searching */
1425 TS_SKIP_BACK, /* skipping backwards */
1426 TS_STEP_FORWARD /* stepping forwards */
1427 #endif
1428 } state; /* Current search state */
1430 int cmplen;
1431 int match; /* matches */
1432 int match_no_ic = 0;/* matches with rm_ic == FALSE */
1433 int match_re; /* match with regexp */
1434 int matchoff = 0;
1436 #ifdef FEAT_EMACS_TAGS
1438 * Stack for included emacs-tags file.
1439 * It has a fixed size, to truncate cyclic includes. jw
1441 # define INCSTACK_SIZE 42
1442 struct
1444 FILE *fp;
1445 char_u *etag_fname;
1446 } incstack[INCSTACK_SIZE];
1448 int incstack_idx = 0; /* index in incstack */
1449 char_u *ebuf; /* additional buffer for etag fname */
1450 int is_etag; /* current file is emaces style */
1451 #endif
1453 struct match_found *mfp, *mfp2;
1454 garray_T ga_match[MT_COUNT];
1455 int match_count = 0; /* number of matches found */
1456 char_u **matches;
1457 int mtt;
1458 int len;
1459 int help_save;
1460 #ifdef FEAT_MULTI_LANG
1461 int help_pri = 0;
1462 char_u *help_lang_find = NULL; /* lang to be found */
1463 char_u help_lang[3]; /* lang of current tags file */
1464 char_u *saved_pat = NULL; /* copy of pat[] */
1465 #endif
1467 /* Use two sets of variables for the pattern: "orgpat" holds the values
1468 * for the original pattern and "convpat" converted from 'encoding' to
1469 * encoding of the tags file. "pats" point to either one of these. */
1470 pat_T *pats;
1471 pat_T orgpat; /* holds unconverted pattern info */
1472 #ifdef FEAT_MBYTE
1473 pat_T convpat; /* holds converted pattern info */
1474 vimconv_T vimconv;
1475 #endif
1477 #ifdef FEAT_TAG_BINS
1478 int findall = (mincount == MAXCOL || mincount == TAG_MANY);
1479 /* find all matching tags */
1480 int sort_error = FALSE; /* tags file not sorted */
1481 int linear; /* do a linear search */
1482 int sortic = FALSE; /* tag file sorted in nocase */
1483 #endif
1484 int line_error = FALSE; /* syntax error */
1485 int has_re = (flags & TAG_REGEXP); /* regexp used */
1486 int help_only = (flags & TAG_HELP);
1487 int name_only = (flags & TAG_NAMES);
1488 int noic = (flags & TAG_NOIC);
1489 int get_it_again = FALSE;
1490 #ifdef FEAT_CSCOPE
1491 int use_cscope = (flags & TAG_CSCOPE);
1492 #endif
1493 int verbose = (flags & TAG_VERBOSE);
1494 int use_tfu = (flags & TAG_USE_TFU);
1496 help_save = curbuf->b_help;
1497 orgpat.pat = pat;
1498 pats = &orgpat;
1499 #ifdef FEAT_MBYTE
1500 vimconv.vc_type = CONV_NONE;
1501 #endif
1504 * Allocate memory for the buffers that are used
1506 lbuf = alloc(LSIZE);
1507 tag_fname = alloc(MAXPATHL + 1);
1508 #ifdef FEAT_EMACS_TAGS
1509 ebuf = alloc(LSIZE);
1510 #endif
1511 for (mtt = 0; mtt < MT_COUNT; ++mtt)
1512 ga_init2(&ga_match[mtt], (int)sizeof(struct match_found *), 100);
1514 /* check for out of memory situation */
1515 if (lbuf == NULL || tag_fname == NULL
1516 #ifdef FEAT_EMACS_TAGS
1517 || ebuf == NULL
1518 #endif
1520 goto findtag_end;
1522 #ifdef FEAT_CSCOPE
1523 STRCPY(tag_fname, "from cscope"); /* for error messages */
1524 #endif
1527 * Initialize a few variables
1529 if (help_only) /* want tags from help file */
1530 curbuf->b_help = TRUE; /* will be restored later */
1532 pats->len = (int)STRLEN(pat);
1533 #ifdef FEAT_MULTI_LANG
1534 if (curbuf->b_help)
1536 /* When "@ab" is specified use only the "ab" language, otherwise
1537 * search all languages. */
1538 if (pats->len > 3 && pat[pats->len - 3] == '@'
1539 && ASCII_ISALPHA(pat[pats->len - 2])
1540 && ASCII_ISALPHA(pat[pats->len - 1]))
1542 saved_pat = vim_strnsave(pat, pats->len - 3);
1543 if (saved_pat != NULL)
1545 help_lang_find = &pat[pats->len - 2];
1546 pats->pat = saved_pat;
1547 pats->len -= 3;
1551 #endif
1552 if (p_tl != 0 && pats->len > p_tl) /* adjust for 'taglength' */
1553 pats->len = p_tl;
1555 prepare_pats(pats, has_re);
1557 #ifdef FEAT_TAG_BINS
1558 /* This is only to avoid a compiler warning for using search_info
1559 * uninitialised. */
1560 vim_memset(&search_info, 0, (size_t)1);
1561 #endif
1563 if (use_tfu)
1565 retval = find_tfu_tags(pat, &ga_match[0], &match_count);
1566 goto findtag_end;
1570 * When finding a specified number of matches, first try with matching
1571 * case, so binary search can be used, and try ignore-case matches in a
1572 * second loop.
1573 * When finding all matches, 'tagbsearch' is off, or there is no fixed
1574 * string to look for, ignore case right away to avoid going though the
1575 * tags files twice.
1576 * When the tag file is case-fold sorted, it is either one or the other.
1577 * Only ignore case when TAG_NOIC not used or 'ignorecase' set.
1579 #ifdef FEAT_TAG_BINS
1580 pats->regmatch.rm_ic = ((p_ic || !noic)
1581 && (findall || pats->headlen == 0 || !p_tbs));
1582 for (round = 1; round <= 2; ++round)
1584 linear = (pats->headlen == 0 || !p_tbs || round == 2);
1585 #else
1586 pats->regmatch.rm_ic = (p_ic || !noic);
1587 #endif
1590 * Try tag file names from tags option one by one.
1592 for (first_file = TRUE;
1593 #ifdef FEAT_CSCOPE
1594 use_cscope ||
1595 #endif
1596 get_tagfname(&tn, first_file, tag_fname) == OK;
1597 first_file = FALSE)
1600 * A file that doesn't exist is silently ignored. Only when not a
1601 * single file is found, an error message is given (further on).
1603 #ifdef FEAT_CSCOPE
1604 if (use_cscope)
1605 fp = NULL; /* avoid GCC warning */
1606 else
1607 #endif
1609 #ifdef FEAT_MULTI_LANG
1610 if (curbuf->b_help)
1612 /* Prefer help tags according to 'helplang'. Put the
1613 * two-letter language name in help_lang[]. */
1614 i = (int)STRLEN(tag_fname);
1615 if (i > 3 && tag_fname[i - 3] == '-')
1616 STRCPY(help_lang, tag_fname + i - 2);
1617 else
1618 STRCPY(help_lang, "en");
1620 /* When searching for a specific language skip tags files
1621 * for other languages. */
1622 if (help_lang_find != NULL
1623 && STRICMP(help_lang, help_lang_find) != 0)
1624 continue;
1626 /* For CTRL-] in a help file prefer a match with the same
1627 * language. */
1628 if ((flags & TAG_KEEP_LANG)
1629 && help_lang_find == NULL
1630 && curbuf->b_fname != NULL
1631 && (i = (int)STRLEN(curbuf->b_fname)) > 4
1632 && curbuf->b_fname[i - 1] == 'x'
1633 && curbuf->b_fname[i - 4] == '.'
1634 && STRNICMP(curbuf->b_fname + i - 3, help_lang, 2) == 0)
1635 help_pri = 0;
1636 else
1638 help_pri = 1;
1639 for (s = p_hlg; *s != NUL; ++s)
1641 if (STRNICMP(s, help_lang, 2) == 0)
1642 break;
1643 ++help_pri;
1644 if ((s = vim_strchr(s, ',')) == NULL)
1645 break;
1647 if (s == NULL || *s == NUL)
1649 /* Language not in 'helplang': use last, prefer English,
1650 * unless found already. */
1651 ++help_pri;
1652 if (STRICMP(help_lang, "en") != 0)
1653 ++help_pri;
1657 #endif
1659 if ((fp = mch_fopen((char *)tag_fname, "r")) == NULL)
1660 continue;
1662 if (p_verbose >= 5)
1664 verbose_enter();
1665 smsg((char_u *)_("Searching tags file %s"), tag_fname);
1666 verbose_leave();
1669 did_open = TRUE; /* remember that we found at least one file */
1671 state = TS_START; /* we're at the start of the file */
1672 #ifdef FEAT_EMACS_TAGS
1673 is_etag = 0; /* default is: not emacs style */
1674 #endif
1677 * Read and parse the lines in the file one by one
1679 for (;;)
1681 line_breakcheck(); /* check for CTRL-C typed */
1682 #ifdef FEAT_INS_EXPAND
1683 if ((flags & TAG_INS_COMP)) /* Double brackets for gcc */
1684 ins_compl_check_keys(30);
1685 if (got_int || compl_interrupted)
1686 #else
1687 if (got_int)
1688 #endif
1690 stop_searching = TRUE;
1691 break;
1693 /* When mincount is TAG_MANY, stop when enough matches have been
1694 * found (for completion). */
1695 if (mincount == TAG_MANY && match_count >= TAG_MANY)
1697 stop_searching = TRUE;
1698 retval = OK;
1699 break;
1701 if (get_it_again)
1702 goto line_read_in;
1703 #ifdef FEAT_TAG_BINS
1705 * For binary search: compute the next offset to use.
1707 if (state == TS_BINARY)
1709 offset = search_info.low_offset + ((search_info.high_offset
1710 - search_info.low_offset) / 2);
1711 if (offset == search_info.curr_offset)
1712 break; /* End the binary search without a match. */
1713 else
1714 search_info.curr_offset = offset;
1718 * Skipping back (after a match during binary search).
1720 else if (state == TS_SKIP_BACK)
1722 search_info.curr_offset -= LSIZE * 2;
1723 if (search_info.curr_offset < 0)
1725 search_info.curr_offset = 0;
1726 rewind(fp);
1727 state = TS_STEP_FORWARD;
1732 * When jumping around in the file, first read a line to find the
1733 * start of the next line.
1735 if (state == TS_BINARY || state == TS_SKIP_BACK)
1737 /* Adjust the search file offset to the correct position */
1738 search_info.curr_offset_used = search_info.curr_offset;
1739 #ifdef HAVE_FSEEKO
1740 fseeko(fp, search_info.curr_offset, SEEK_SET);
1741 #else
1742 fseek(fp, (long)search_info.curr_offset, SEEK_SET);
1743 #endif
1744 eof = tag_fgets(lbuf, LSIZE, fp);
1745 if (!eof && search_info.curr_offset != 0)
1747 /* The explicit cast is to work around a bug in gcc 3.4.2
1748 * (repeated below). */
1749 search_info.curr_offset = ftell(fp);
1750 if (search_info.curr_offset == search_info.high_offset)
1752 /* oops, gone a bit too far; try from low offset */
1753 #ifdef HAVE_FSEEKO
1754 fseeko(fp, search_info.low_offset, SEEK_SET);
1755 #else
1756 fseek(fp, (long)search_info.low_offset, SEEK_SET);
1757 #endif
1758 search_info.curr_offset = search_info.low_offset;
1760 eof = tag_fgets(lbuf, LSIZE, fp);
1762 /* skip empty and blank lines */
1763 while (!eof && vim_isblankline(lbuf))
1765 search_info.curr_offset = ftell(fp);
1766 eof = tag_fgets(lbuf, LSIZE, fp);
1768 if (eof)
1770 /* Hit end of file. Skip backwards. */
1771 state = TS_SKIP_BACK;
1772 search_info.match_offset = ftell(fp);
1773 search_info.curr_offset = search_info.curr_offset_used;
1774 continue;
1779 * Not jumping around in the file: Read the next line.
1781 else
1782 #endif
1784 /* skip empty and blank lines */
1787 #ifdef FEAT_CSCOPE
1788 if (use_cscope)
1789 eof = cs_fgets(lbuf, LSIZE);
1790 else
1791 #endif
1792 eof = tag_fgets(lbuf, LSIZE, fp);
1793 } while (!eof && vim_isblankline(lbuf));
1795 if (eof)
1797 #ifdef FEAT_EMACS_TAGS
1798 if (incstack_idx) /* this was an included file */
1800 --incstack_idx;
1801 fclose(fp); /* end of this file ... */
1802 fp = incstack[incstack_idx].fp;
1803 STRCPY(tag_fname, incstack[incstack_idx].etag_fname);
1804 vim_free(incstack[incstack_idx].etag_fname);
1805 is_etag = 1; /* (only etags can include) */
1806 continue; /* ... continue with parent file */
1808 else
1809 #endif
1810 break; /* end of file */
1813 line_read_in:
1815 #ifdef FEAT_EMACS_TAGS
1817 * Emacs tags line with CTRL-L: New file name on next line.
1818 * The file name is followed by a ','.
1820 if (*lbuf == Ctrl_L) /* remember etag file name in ebuf */
1822 is_etag = 1; /* in case at the start */
1823 state = TS_LINEAR;
1824 if (!tag_fgets(ebuf, LSIZE, fp))
1826 for (p = ebuf; *p && *p != ','; p++)
1828 *p = NUL;
1831 * atoi(p+1) is the number of bytes before the next ^L
1832 * unless it is an include statement.
1834 if (STRNCMP(p + 1, "include", 7) == 0
1835 && incstack_idx < INCSTACK_SIZE)
1837 /* Save current "fp" and "tag_fname" in the stack. */
1838 if ((incstack[incstack_idx].etag_fname =
1839 vim_strsave(tag_fname)) != NULL)
1841 char_u *fullpath_ebuf;
1843 incstack[incstack_idx].fp = fp;
1844 fp = NULL;
1846 /* Figure out "tag_fname" and "fp" to use for
1847 * included file. */
1848 fullpath_ebuf = expand_tag_fname(ebuf,
1849 tag_fname, FALSE);
1850 if (fullpath_ebuf != NULL)
1852 fp = mch_fopen((char *)fullpath_ebuf, "r");
1853 if (fp != NULL)
1855 if (STRLEN(fullpath_ebuf) > LSIZE)
1856 EMSG2(_("E430: Tag file path truncated for %s\n"), ebuf);
1857 vim_strncpy(tag_fname, fullpath_ebuf,
1858 MAXPATHL);
1859 ++incstack_idx;
1860 is_etag = 0; /* we can include anything */
1862 vim_free(fullpath_ebuf);
1864 if (fp == NULL)
1866 /* Can't open the included file, skip it and
1867 * restore old value of "fp". */
1868 fp = incstack[incstack_idx].fp;
1869 vim_free(incstack[incstack_idx].etag_fname);
1874 continue;
1876 #endif
1879 * When still at the start of the file, check for Emacs tags file
1880 * format, and for "not sorted" flag.
1882 if (state == TS_START)
1884 #ifdef FEAT_TAG_BINS
1886 * When there is no tag head, or ignoring case, need to do a
1887 * linear search.
1888 * When no "!_TAG_" is found, default to binary search. If
1889 * the tag file isn't sorted, the second loop will find it.
1890 * When "!_TAG_FILE_SORTED" found: start binary search if
1891 * flag set.
1892 * For cscope, it's always linear.
1894 # ifdef FEAT_CSCOPE
1895 if (linear || use_cscope)
1896 # else
1897 if (linear)
1898 # endif
1899 state = TS_LINEAR;
1900 else if (STRNCMP(lbuf, "!_TAG_", 6) > 0)
1901 state = TS_BINARY;
1902 else if (STRNCMP(lbuf, "!_TAG_FILE_SORTED\t", 18) == 0)
1904 /* Check sorted flag */
1905 if (lbuf[18] == '1')
1906 state = TS_BINARY;
1907 else if (lbuf[18] == '2')
1909 state = TS_BINARY;
1910 sortic = TRUE;
1911 pats->regmatch.rm_ic = (p_ic || !noic);
1913 else
1914 state = TS_LINEAR;
1917 if (state == TS_BINARY && pats->regmatch.rm_ic && !sortic)
1919 /* binary search won't work for ignoring case, use linear
1920 * search. */
1921 linear = TRUE;
1922 state = TS_LINEAR;
1924 #else
1925 state = TS_LINEAR;
1926 #endif
1928 #ifdef FEAT_TAG_BINS
1930 * When starting a binary search, get the size of the file and
1931 * compute the first offset.
1933 if (state == TS_BINARY)
1935 /* Get the tag file size (don't use mch_fstat(), it's not
1936 * portable). */
1937 if ((filesize = lseek(fileno(fp),
1938 (off_t)0L, SEEK_END)) <= 0)
1939 state = TS_LINEAR;
1940 else
1942 lseek(fileno(fp), (off_t)0L, SEEK_SET);
1944 /* Calculate the first read offset in the file. Start
1945 * the search in the middle of the file. */
1946 search_info.low_offset = 0;
1947 search_info.low_char = 0;
1948 search_info.high_offset = filesize;
1949 search_info.curr_offset = 0;
1950 search_info.high_char = 0xff;
1952 continue;
1954 #endif
1957 #ifdef FEAT_MBYTE
1958 if (lbuf[0] == '!' && pats == &orgpat
1959 && STRNCMP(lbuf, "!_TAG_FILE_ENCODING\t", 20) == 0)
1961 /* Convert the search pattern from 'encoding' to the
1962 * specified encoding. */
1963 for (p = lbuf + 20; *p > ' ' && *p < 127; ++p)
1965 *p = NUL;
1966 convert_setup(&vimconv, p_enc, lbuf + 20);
1967 if (vimconv.vc_type != CONV_NONE)
1969 convpat.pat = string_convert(&vimconv, pats->pat, NULL);
1970 if (convpat.pat != NULL)
1972 pats = &convpat;
1973 pats->len = (int)STRLEN(pats->pat);
1974 prepare_pats(pats, has_re);
1975 pats->regmatch.rm_ic = orgpat.regmatch.rm_ic;
1979 /* Prepare for converting a match the other way around. */
1980 convert_setup(&vimconv, lbuf + 20, p_enc);
1981 continue;
1983 #endif
1986 * Figure out where the different strings are in this line.
1987 * For "normal" tags: Do a quick check if the tag matches.
1988 * This speeds up tag searching a lot!
1990 if (pats->headlen
1991 #ifdef FEAT_EMACS_TAGS
1992 && !is_etag
1993 #endif
1996 tagp.tagname = lbuf;
1997 #ifdef FEAT_TAG_ANYWHITE
1998 tagp.tagname_end = skiptowhite(lbuf);
1999 if (*tagp.tagname_end == NUL) /* corrupted tag line */
2000 #else
2001 tagp.tagname_end = vim_strchr(lbuf, TAB);
2002 if (tagp.tagname_end == NULL) /* corrupted tag line */
2003 #endif
2005 line_error = TRUE;
2006 break;
2009 #ifdef FEAT_TAG_OLDSTATIC
2011 * Check for old style static tag: "file:tag file .."
2013 tagp.fname = NULL;
2014 for (p = lbuf; p < tagp.tagname_end; ++p)
2016 if (*p == ':')
2018 if (tagp.fname == NULL)
2019 #ifdef FEAT_TAG_ANYWHITE
2020 tagp.fname = skipwhite(tagp.tagname_end);
2021 #else
2022 tagp.fname = tagp.tagname_end + 1;
2023 #endif
2024 if ( fnamencmp(lbuf, tagp.fname, p - lbuf) == 0
2025 #ifdef FEAT_TAG_ANYWHITE
2026 && vim_iswhite(tagp.fname[p - lbuf])
2027 #else
2028 && tagp.fname[p - lbuf] == TAB
2029 #endif
2032 /* found one */
2033 tagp.tagname = p + 1;
2034 break;
2038 #endif
2041 * Skip this line if the length of the tag is different and
2042 * there is no regexp, or the tag is too short.
2044 cmplen = (int)(tagp.tagname_end - tagp.tagname);
2045 if (p_tl != 0 && cmplen > p_tl) /* adjust for 'taglength' */
2046 cmplen = p_tl;
2047 if (has_re && pats->headlen < cmplen)
2048 cmplen = pats->headlen;
2049 else if (state == TS_LINEAR && pats->headlen != cmplen)
2050 continue;
2052 #ifdef FEAT_TAG_BINS
2053 if (state == TS_BINARY)
2056 * Simplistic check for unsorted tags file.
2058 i = (int)tagp.tagname[0];
2059 if (sortic)
2060 i = (int)TOUPPER_ASC(tagp.tagname[0]);
2061 if (i < search_info.low_char || i > search_info.high_char)
2062 sort_error = TRUE;
2065 * Compare the current tag with the searched tag.
2067 if (sortic)
2068 tagcmp = tag_strnicmp(tagp.tagname, pats->head,
2069 (size_t)cmplen);
2070 else
2071 tagcmp = STRNCMP(tagp.tagname, pats->head, cmplen);
2074 * A match with a shorter tag means to search forward.
2075 * A match with a longer tag means to search backward.
2077 if (tagcmp == 0)
2079 if (cmplen < pats->headlen)
2080 tagcmp = -1;
2081 else if (cmplen > pats->headlen)
2082 tagcmp = 1;
2085 if (tagcmp == 0)
2087 /* We've located the tag, now skip back and search
2088 * forward until the first matching tag is found.
2090 state = TS_SKIP_BACK;
2091 search_info.match_offset = search_info.curr_offset;
2092 continue;
2094 if (tagcmp < 0)
2096 search_info.curr_offset = ftell(fp);
2097 if (search_info.curr_offset < search_info.high_offset)
2099 search_info.low_offset = search_info.curr_offset;
2100 if (sortic)
2101 search_info.low_char =
2102 TOUPPER_ASC(tagp.tagname[0]);
2103 else
2104 search_info.low_char = tagp.tagname[0];
2105 continue;
2108 if (tagcmp > 0
2109 && search_info.curr_offset != search_info.high_offset)
2111 search_info.high_offset = search_info.curr_offset;
2112 if (sortic)
2113 search_info.high_char =
2114 TOUPPER_ASC(tagp.tagname[0]);
2115 else
2116 search_info.high_char = tagp.tagname[0];
2117 continue;
2120 /* No match yet and are at the end of the binary search. */
2121 break;
2123 else if (state == TS_SKIP_BACK)
2125 if (MB_STRNICMP(tagp.tagname, pats->head, cmplen) != 0)
2126 state = TS_STEP_FORWARD;
2127 else
2128 /* Have to skip back more. Restore the curr_offset
2129 * used, otherwise we get stuck at a long line. */
2130 search_info.curr_offset = search_info.curr_offset_used;
2131 continue;
2133 else if (state == TS_STEP_FORWARD)
2135 if (MB_STRNICMP(tagp.tagname, pats->head, cmplen) != 0)
2137 if ((off_t)ftell(fp) > search_info.match_offset)
2138 break; /* past last match */
2139 else
2140 continue; /* before first match */
2143 else
2144 #endif
2145 /* skip this match if it can't match */
2146 if (MB_STRNICMP(tagp.tagname, pats->head, cmplen) != 0)
2147 continue;
2150 * Can be a matching tag, isolate the file name and command.
2152 #ifdef FEAT_TAG_OLDSTATIC
2153 if (tagp.fname == NULL)
2154 #endif
2155 #ifdef FEAT_TAG_ANYWHITE
2156 tagp.fname = skipwhite(tagp.tagname_end);
2157 #else
2158 tagp.fname = tagp.tagname_end + 1;
2159 #endif
2160 #ifdef FEAT_TAG_ANYWHITE
2161 tagp.fname_end = skiptowhite(tagp.fname);
2162 tagp.command = skipwhite(tagp.fname_end);
2163 if (*tagp.command == NUL)
2164 #else
2165 tagp.fname_end = vim_strchr(tagp.fname, TAB);
2166 tagp.command = tagp.fname_end + 1;
2167 if (tagp.fname_end == NULL)
2168 #endif
2169 i = FAIL;
2170 else
2171 i = OK;
2173 else
2174 i = parse_tag_line(lbuf,
2175 #ifdef FEAT_EMACS_TAGS
2176 is_etag,
2177 #endif
2178 &tagp);
2179 if (i == FAIL)
2181 line_error = TRUE;
2182 break;
2185 #ifdef FEAT_EMACS_TAGS
2186 if (is_etag)
2187 tagp.fname = ebuf;
2188 #endif
2190 * First try matching with the pattern literally (also when it is
2191 * a regexp).
2193 cmplen = (int)(tagp.tagname_end - tagp.tagname);
2194 if (p_tl != 0 && cmplen > p_tl) /* adjust for 'taglength' */
2195 cmplen = p_tl;
2196 /* if tag length does not match, don't try comparing */
2197 if (pats->len != cmplen)
2198 match = FALSE;
2199 else
2201 if (pats->regmatch.rm_ic)
2203 match = (MB_STRNICMP(tagp.tagname, pats->pat, cmplen) == 0);
2204 if (match)
2205 match_no_ic = (STRNCMP(tagp.tagname, pats->pat,
2206 cmplen) == 0);
2208 else
2209 match = (STRNCMP(tagp.tagname, pats->pat, cmplen) == 0);
2213 * Has a regexp: Also find tags matching regexp.
2215 match_re = FALSE;
2216 if (!match && pats->regmatch.regprog != NULL)
2218 int cc;
2220 cc = *tagp.tagname_end;
2221 *tagp.tagname_end = NUL;
2222 match = vim_regexec(&pats->regmatch, tagp.tagname, (colnr_T)0);
2223 if (match)
2225 matchoff = (int)(pats->regmatch.startp[0] - tagp.tagname);
2226 if (pats->regmatch.rm_ic)
2228 pats->regmatch.rm_ic = FALSE;
2229 match_no_ic = vim_regexec(&pats->regmatch, tagp.tagname,
2230 (colnr_T)0);
2231 pats->regmatch.rm_ic = TRUE;
2234 *tagp.tagname_end = cc;
2235 match_re = TRUE;
2239 * If a match is found, add it to ga_match[].
2241 if (match)
2243 #ifdef FEAT_CSCOPE
2244 if (use_cscope)
2246 /* Don't change the ordering, always use the same table. */
2247 mtt = MT_GL_OTH;
2249 else
2250 #endif
2252 /* Decide in which array to store this match. */
2253 is_current = test_for_current(
2254 #ifdef FEAT_EMACS_TAGS
2255 is_etag,
2256 #endif
2257 tagp.fname, tagp.fname_end, tag_fname,
2258 buf_ffname);
2259 #ifdef FEAT_EMACS_TAGS
2260 is_static = FALSE;
2261 if (!is_etag) /* emacs tags are never static */
2262 #endif
2264 #ifdef FEAT_TAG_OLDSTATIC
2265 if (tagp.tagname != lbuf)
2266 is_static = TRUE; /* detected static tag before */
2267 else
2268 #endif
2269 is_static = test_for_static(&tagp);
2272 /* decide in which of the sixteen tables to store this
2273 * match */
2274 if (is_static)
2276 if (is_current)
2277 mtt = MT_ST_CUR;
2278 else
2279 mtt = MT_ST_OTH;
2281 else
2283 if (is_current)
2284 mtt = MT_GL_CUR;
2285 else
2286 mtt = MT_GL_OTH;
2288 if (pats->regmatch.rm_ic && !match_no_ic)
2289 mtt += MT_IC_OFF;
2290 if (match_re)
2291 mtt += MT_RE_OFF;
2295 * Add the found match in ga_match[mtt], avoiding duplicates.
2296 * Store the info we need later, which depends on the kind of
2297 * tags we are dealing with.
2299 if (ga_grow(&ga_match[mtt], 1) == OK)
2301 #ifdef FEAT_MBYTE
2302 char_u *conv_line = NULL;
2303 char_u *lbuf_line = lbuf;
2305 if (vimconv.vc_type != CONV_NONE)
2307 /* Convert the tag line from the encoding of the tags
2308 * file to 'encoding'. Then parse the line again. */
2309 conv_line = string_convert(&vimconv, lbuf, NULL);
2310 if (conv_line != NULL)
2312 if (parse_tag_line(conv_line,
2313 #ifdef FEAT_EMACS_TAGS
2314 is_etag,
2315 #endif
2316 &tagp) == OK)
2317 lbuf_line = conv_line;
2318 else
2319 /* doesn't work, go back to unconverted line. */
2320 (void)parse_tag_line(lbuf,
2321 #ifdef FEAT_EMACS_TAGS
2322 is_etag,
2323 #endif
2324 &tagp);
2327 #else
2328 # define lbuf_line lbuf
2329 #endif
2330 if (help_only)
2332 #ifdef FEAT_MULTI_LANG
2333 # define ML_EXTRA 3
2334 #else
2335 # define ML_EXTRA 0
2336 #endif
2338 * Append the help-heuristic number after the
2339 * tagname, for sorting it later.
2341 *tagp.tagname_end = NUL;
2342 len = (int)(tagp.tagname_end - tagp.tagname);
2343 mfp = (struct match_found *)
2344 alloc((int)sizeof(struct match_found) + len
2345 + 10 + ML_EXTRA);
2346 if (mfp != NULL)
2348 /* "len" includes the language and the NUL, but
2349 * not the priority. */
2350 mfp->len = len + ML_EXTRA + 1;
2351 #define ML_HELP_LEN 6
2352 p = mfp->match;
2353 STRCPY(p, tagp.tagname);
2354 #ifdef FEAT_MULTI_LANG
2355 p[len] = '@';
2356 STRCPY(p + len + 1, help_lang);
2357 #endif
2358 sprintf((char *)p + len + 1 + ML_EXTRA, "%06d",
2359 help_heuristic(tagp.tagname,
2360 match_re ? matchoff : 0, !match_no_ic)
2361 #ifdef FEAT_MULTI_LANG
2362 + help_pri
2363 #endif
2366 *tagp.tagname_end = TAB;
2368 else if (name_only)
2370 if (get_it_again)
2372 char_u *temp_end = tagp.command;
2374 if (*temp_end == '/')
2375 while (*temp_end && *temp_end != '\r'
2376 && *temp_end != '\n'
2377 && *temp_end != '$')
2378 temp_end++;
2380 if (tagp.command + 2 < temp_end)
2382 len = (int)(temp_end - tagp.command - 2);
2383 mfp = (struct match_found *)alloc(
2384 (int)sizeof(struct match_found) + len);
2385 if (mfp != NULL)
2387 mfp->len = len + 1; /* include the NUL */
2388 p = mfp->match;
2389 vim_strncpy(p, tagp.command + 2, len);
2392 else
2393 mfp = NULL;
2394 get_it_again = FALSE;
2396 else
2398 len = (int)(tagp.tagname_end - tagp.tagname);
2399 mfp = (struct match_found *)alloc(
2400 (int)sizeof(struct match_found) + len);
2401 if (mfp != NULL)
2403 mfp->len = len + 1; /* include the NUL */
2404 p = mfp->match;
2405 vim_strncpy(p, tagp.tagname, len);
2408 /* if wanted, re-read line to get long form too */
2409 if (State & INSERT)
2410 get_it_again = p_sft;
2413 else
2415 /* Save the tag in a buffer.
2416 * Emacs tag: <mtt><tag_fname><NUL><ebuf><NUL><lbuf>
2417 * other tag: <mtt><tag_fname><NUL><NUL><lbuf>
2418 * without Emacs tags: <mtt><tag_fname><NUL><lbuf>
2420 len = (int)STRLEN(tag_fname)
2421 + (int)STRLEN(lbuf_line) + 3;
2422 #ifdef FEAT_EMACS_TAGS
2423 if (is_etag)
2424 len += (int)STRLEN(ebuf) + 1;
2425 else
2426 ++len;
2427 #endif
2428 mfp = (struct match_found *)alloc(
2429 (int)sizeof(struct match_found) + len);
2430 if (mfp != NULL)
2432 mfp->len = len;
2433 p = mfp->match;
2434 p[0] = mtt;
2435 STRCPY(p + 1, tag_fname);
2436 #ifdef BACKSLASH_IN_FILENAME
2437 /* Ignore differences in slashes, avoid adding
2438 * both path/file and path\file. */
2439 slash_adjust(p + 1);
2440 #endif
2441 s = p + 1 + STRLEN(tag_fname) + 1;
2442 #ifdef FEAT_EMACS_TAGS
2443 if (is_etag)
2445 STRCPY(s, ebuf);
2446 s += STRLEN(ebuf) + 1;
2448 else
2449 *s++ = NUL;
2450 #endif
2451 STRCPY(s, lbuf_line);
2455 if (mfp != NULL)
2458 * Don't add identical matches.
2459 * This can take a lot of time when finding many
2460 * matches, check for CTRL-C now and then.
2461 * Add all cscope tags, because they are all listed.
2463 #ifdef FEAT_CSCOPE
2464 if (use_cscope)
2465 i = -1;
2466 else
2467 #endif
2468 for (i = ga_match[mtt].ga_len; --i >= 0 && !got_int; )
2470 mfp2 = ((struct match_found **)
2471 (ga_match[mtt].ga_data))[i];
2472 if (mfp2->len == mfp->len
2473 && vim_memcmp(mfp2->match, mfp->match,
2474 (size_t)mfp->len) == 0)
2475 break;
2476 line_breakcheck();
2478 if (i < 0)
2480 ((struct match_found **)(ga_match[mtt].ga_data))
2481 [ga_match[mtt].ga_len++] = mfp;
2482 ++match_count;
2484 else
2485 vim_free(mfp);
2487 #ifdef FEAT_MBYTE
2488 /* Note: this makes the values in "tagp" invalid! */
2489 vim_free(conv_line);
2490 #endif
2492 else /* Out of memory! Just forget about the rest. */
2494 retval = OK;
2495 stop_searching = TRUE;
2496 break;
2499 #ifdef FEAT_CSCOPE
2500 if (use_cscope && eof)
2501 break;
2502 #endif
2503 } /* forever */
2505 if (line_error)
2507 EMSG2(_("E431: Format error in tags file \"%s\""), tag_fname);
2508 #ifdef FEAT_CSCOPE
2509 if (!use_cscope)
2510 #endif
2511 EMSGN(_("Before byte %ld"), (long)ftell(fp));
2512 stop_searching = TRUE;
2513 line_error = FALSE;
2516 #ifdef FEAT_CSCOPE
2517 if (!use_cscope)
2518 #endif
2519 fclose(fp);
2520 #ifdef FEAT_EMACS_TAGS
2521 while (incstack_idx)
2523 --incstack_idx;
2524 fclose(incstack[incstack_idx].fp);
2525 vim_free(incstack[incstack_idx].etag_fname);
2527 #endif
2528 #ifdef FEAT_MBYTE
2529 if (pats == &convpat)
2531 /* Go back from converted pattern to original pattern. */
2532 vim_free(pats->pat);
2533 vim_free(pats->regmatch.regprog);
2534 orgpat.regmatch.rm_ic = pats->regmatch.rm_ic;
2535 pats = &orgpat;
2537 if (vimconv.vc_type != CONV_NONE)
2538 convert_setup(&vimconv, NULL, NULL);
2539 #endif
2541 #ifdef FEAT_TAG_BINS
2542 if (sort_error)
2544 EMSG2(_("E432: Tags file not sorted: %s"), tag_fname);
2545 sort_error = FALSE;
2547 #endif
2550 * Stop searching if sufficient tags have been found.
2552 if (match_count >= mincount)
2554 retval = OK;
2555 stop_searching = TRUE;
2558 #ifdef FEAT_CSCOPE
2559 if (stop_searching || use_cscope)
2560 #else
2561 if (stop_searching)
2562 #endif
2563 break;
2565 } /* end of for-each-file loop */
2567 #ifdef FEAT_CSCOPE
2568 if (!use_cscope)
2569 #endif
2570 tagname_free(&tn);
2572 #ifdef FEAT_TAG_BINS
2573 /* stop searching when already did a linear search, or when TAG_NOIC
2574 * used, and 'ignorecase' not set or already did case-ignore search */
2575 if (stop_searching || linear || (!p_ic && noic) || pats->regmatch.rm_ic)
2576 break;
2577 # ifdef FEAT_CSCOPE
2578 if (use_cscope)
2579 break;
2580 # endif
2581 pats->regmatch.rm_ic = TRUE; /* try another time while ignoring case */
2583 #endif
2585 if (!stop_searching)
2587 if (!did_open && verbose) /* never opened any tags file */
2588 EMSG(_("E433: No tags file"));
2589 retval = OK; /* It's OK even when no tag found */
2592 findtag_end:
2593 vim_free(lbuf);
2594 vim_free(pats->regmatch.regprog);
2595 vim_free(tag_fname);
2596 #ifdef FEAT_EMACS_TAGS
2597 vim_free(ebuf);
2598 #endif
2601 * Move the matches from the ga_match[] arrays into one list of
2602 * matches. When retval == FAIL, free the matches.
2604 if (retval == FAIL)
2605 match_count = 0;
2607 if (match_count > 0)
2608 matches = (char_u **)lalloc((long_u)(match_count * sizeof(char_u *)),
2609 TRUE);
2610 else
2611 matches = NULL;
2612 match_count = 0;
2613 for (mtt = 0; mtt < MT_COUNT; ++mtt)
2615 for (i = 0; i < ga_match[mtt].ga_len; ++i)
2617 mfp = ((struct match_found **)(ga_match[mtt].ga_data))[i];
2618 if (matches == NULL)
2619 vim_free(mfp);
2620 else
2622 /* To avoid allocating memory again we turn the struct
2623 * match_found into a string. For help the priority was not
2624 * included in the length. */
2625 mch_memmove(mfp, mfp->match,
2626 (size_t)(mfp->len + (help_only ? ML_HELP_LEN : 0)));
2627 matches[match_count++] = (char_u *)mfp;
2630 ga_clear(&ga_match[mtt]);
2633 *matchesp = matches;
2634 *num_matches = match_count;
2636 curbuf->b_help = help_save;
2637 #ifdef FEAT_MULTI_LANG
2638 vim_free(saved_pat);
2639 #endif
2641 return retval;
2644 static garray_T tag_fnames = GA_EMPTY;
2645 static void found_tagfile_cb __ARGS((char_u *fname, void *cookie));
2648 * Callback function for finding all "tags" and "tags-??" files in
2649 * 'runtimepath' doc directories.
2651 static void
2652 found_tagfile_cb(fname, cookie)
2653 char_u *fname;
2654 void *cookie UNUSED;
2656 if (ga_grow(&tag_fnames, 1) == OK)
2657 ((char_u **)(tag_fnames.ga_data))[tag_fnames.ga_len++] =
2658 vim_strsave(fname);
2661 #if defined(EXITFREE) || defined(PROTO)
2662 void
2663 free_tag_stuff()
2665 ga_clear_strings(&tag_fnames);
2666 do_tag(NULL, DT_FREE, 0, 0, 0);
2667 tag_freematch();
2669 # if defined(FEAT_WINDOWS) && defined(FEAT_QUICKFIX)
2670 if (ptag_entry.tagname)
2672 vim_free(ptag_entry.tagname);
2673 ptag_entry.tagname = NULL;
2675 # endif
2677 #endif
2680 * Get the next name of a tag file from the tag file list.
2681 * For help files, use "tags" file only.
2683 * Return FAIL if no more tag file names, OK otherwise.
2686 get_tagfname(tnp, first, buf)
2687 tagname_T *tnp; /* holds status info */
2688 int first; /* TRUE when first file name is wanted */
2689 char_u *buf; /* pointer to buffer of MAXPATHL chars */
2691 char_u *fname = NULL;
2692 char_u *r_ptr;
2694 if (first)
2695 vim_memset(tnp, 0, sizeof(tagname_T));
2697 if (curbuf->b_help)
2700 * For help files it's done in a completely different way:
2701 * Find "doc/tags" and "doc/tags-??" in all directories in
2702 * 'runtimepath'.
2704 if (first)
2706 ga_clear_strings(&tag_fnames);
2707 ga_init2(&tag_fnames, (int)sizeof(char_u *), 10);
2708 do_in_runtimepath((char_u *)
2709 #ifdef FEAT_MULTI_LANG
2710 # ifdef VMS
2711 /* Functions decc$to_vms() and decc$translate_vms() crash
2712 * on some VMS systems with wildcards "??". Seems ECO
2713 * patches do fix the problem in C RTL, but we can't use
2714 * an #ifdef for that. */
2715 "doc/tags doc/tags-*"
2716 # else
2717 "doc/tags doc/tags-??"
2718 # endif
2719 #else
2720 "doc/tags"
2721 #endif
2722 , TRUE, found_tagfile_cb, NULL);
2725 if (tnp->tn_hf_idx >= tag_fnames.ga_len)
2727 /* Not found in 'runtimepath', use 'helpfile', if it exists and
2728 * wasn't used yet, replacing "help.txt" with "tags". */
2729 if (tnp->tn_hf_idx > tag_fnames.ga_len || *p_hf == NUL)
2730 return FAIL;
2731 ++tnp->tn_hf_idx;
2732 STRCPY(buf, p_hf);
2733 STRCPY(gettail(buf), "tags");
2735 else
2736 vim_strncpy(buf, ((char_u **)(tag_fnames.ga_data))[
2737 tnp->tn_hf_idx++], MAXPATHL - 1);
2738 return OK;
2741 if (first)
2743 /* Init. We make a copy of 'tags', because autocommands may change
2744 * the value without notifying us. */
2745 tnp->tn_tags = vim_strsave((*curbuf->b_p_tags != NUL)
2746 ? curbuf->b_p_tags : p_tags);
2747 if (tnp->tn_tags == NULL)
2748 return FAIL;
2749 tnp->tn_np = tnp->tn_tags;
2753 * Loop until we have found a file name that can be used.
2754 * There are two states:
2755 * tnp->tn_did_filefind_init == FALSE: setup for next part in 'tags'.
2756 * tnp->tn_did_filefind_init == TRUE: find next file in this part.
2758 for (;;)
2760 if (tnp->tn_did_filefind_init)
2762 fname = vim_findfile(tnp->tn_search_ctx);
2763 if (fname != NULL)
2764 break;
2766 tnp->tn_did_filefind_init = FALSE;
2768 else
2770 char_u *filename = NULL;
2772 /* Stop when used all parts of 'tags'. */
2773 if (*tnp->tn_np == NUL)
2775 vim_findfile_cleanup(tnp->tn_search_ctx);
2776 tnp->tn_search_ctx = NULL;
2777 return FAIL;
2781 * Copy next file name into buf.
2783 buf[0] = NUL;
2784 (void)copy_option_part(&tnp->tn_np, buf, MAXPATHL - 1, " ,");
2786 #ifdef FEAT_PATH_EXTRA
2787 r_ptr = vim_findfile_stopdir(buf);
2788 #else
2789 r_ptr = NULL;
2790 #endif
2791 /* move the filename one char forward and truncate the
2792 * filepath with a NUL */
2793 filename = gettail(buf);
2794 STRMOVE(filename + 1, filename);
2795 *filename++ = NUL;
2797 tnp->tn_search_ctx = vim_findfile_init(buf, filename,
2798 r_ptr, 100,
2799 FALSE, /* don't free visited list */
2800 FINDFILE_FILE, /* we search for a file */
2801 tnp->tn_search_ctx, TRUE, curbuf->b_ffname);
2802 if (tnp->tn_search_ctx != NULL)
2803 tnp->tn_did_filefind_init = TRUE;
2807 STRCPY(buf, fname);
2808 vim_free(fname);
2809 return OK;
2813 * Free the contents of a tagname_T that was filled by get_tagfname().
2815 void
2816 tagname_free(tnp)
2817 tagname_T *tnp;
2819 vim_free(tnp->tn_tags);
2820 vim_findfile_cleanup(tnp->tn_search_ctx);
2821 tnp->tn_search_ctx = NULL;
2822 ga_clear_strings(&tag_fnames);
2826 * Parse one line from the tags file. Find start/end of tag name, start/end of
2827 * file name and start of search pattern.
2829 * If is_etag is TRUE, tagp->fname and tagp->fname_end are not set.
2831 * Return FAIL if there is a format error in this line, OK otherwise.
2833 static int
2834 parse_tag_line(lbuf,
2835 #ifdef FEAT_EMACS_TAGS
2836 is_etag,
2837 #endif
2838 tagp)
2839 char_u *lbuf; /* line to be parsed */
2840 #ifdef FEAT_EMACS_TAGS
2841 int is_etag;
2842 #endif
2843 tagptrs_T *tagp;
2845 char_u *p;
2847 #ifdef FEAT_EMACS_TAGS
2848 char_u *p_7f;
2850 if (is_etag)
2853 * There are two formats for an emacs tag line:
2854 * 1: struct EnvBase ^?EnvBase^A139,4627
2855 * 2: #define ARPB_WILD_WORLD ^?153,5194
2857 p_7f = vim_strchr(lbuf, 0x7f);
2858 if (p_7f == NULL)
2860 etag_fail:
2861 if (vim_strchr(lbuf, '\n') == NULL)
2863 /* Truncated line. Ignore it. */
2864 if (p_verbose >= 5)
2866 verbose_enter();
2867 MSG(_("Ignoring long line in tags file"));
2868 verbose_leave();
2870 tagp->command = lbuf;
2871 tagp->tagname = lbuf;
2872 tagp->tagname_end = lbuf;
2873 return OK;
2875 return FAIL;
2878 /* Find ^A. If not found the line number is after the 0x7f */
2879 p = vim_strchr(p_7f, Ctrl_A);
2880 if (p == NULL)
2881 p = p_7f + 1;
2882 else
2883 ++p;
2885 if (!VIM_ISDIGIT(*p)) /* check for start of line number */
2886 goto etag_fail;
2887 tagp->command = p;
2890 if (p[-1] == Ctrl_A) /* first format: explicit tagname given */
2892 tagp->tagname = p_7f + 1;
2893 tagp->tagname_end = p - 1;
2895 else /* second format: isolate tagname */
2897 /* find end of tagname */
2898 for (p = p_7f - 1; !vim_iswordc(*p); --p)
2899 if (p == lbuf)
2900 goto etag_fail;
2901 tagp->tagname_end = p + 1;
2902 while (p >= lbuf && vim_iswordc(*p))
2903 --p;
2904 tagp->tagname = p + 1;
2907 else /* not an Emacs tag */
2909 #endif
2910 /* Isolate the tagname, from lbuf up to the first white */
2911 tagp->tagname = lbuf;
2912 #ifdef FEAT_TAG_ANYWHITE
2913 p = skiptowhite(lbuf);
2914 #else
2915 p = vim_strchr(lbuf, TAB);
2916 if (p == NULL)
2917 return FAIL;
2918 #endif
2919 tagp->tagname_end = p;
2921 /* Isolate file name, from first to second white space */
2922 #ifdef FEAT_TAG_ANYWHITE
2923 p = skipwhite(p);
2924 #else
2925 if (*p != NUL)
2926 ++p;
2927 #endif
2928 tagp->fname = p;
2929 #ifdef FEAT_TAG_ANYWHITE
2930 p = skiptowhite(p);
2931 #else
2932 p = vim_strchr(p, TAB);
2933 if (p == NULL)
2934 return FAIL;
2935 #endif
2936 tagp->fname_end = p;
2938 /* find start of search command, after second white space */
2939 #ifdef FEAT_TAG_ANYWHITE
2940 p = skipwhite(p);
2941 #else
2942 if (*p != NUL)
2943 ++p;
2944 #endif
2945 if (*p == NUL)
2946 return FAIL;
2947 tagp->command = p;
2948 #ifdef FEAT_EMACS_TAGS
2950 #endif
2952 return OK;
2956 * Check if tagname is a static tag
2958 * Static tags produced by the older ctags program have the format:
2959 * 'file:tag file /pattern'.
2960 * This is only recognized when both occurrence of 'file' are the same, to
2961 * avoid recognizing "string::string" or ":exit".
2963 * Static tags produced by the new ctags program have the format:
2964 * 'tag file /pattern/;"<Tab>file:' "
2966 * Return TRUE if it is a static tag and adjust *tagname to the real tag.
2967 * Return FALSE if it is not a static tag.
2969 static int
2970 test_for_static(tagp)
2971 tagptrs_T *tagp;
2973 char_u *p;
2975 #ifdef FEAT_TAG_OLDSTATIC
2976 int len;
2979 * Check for old style static tag: "file:tag file .."
2981 len = (int)(tagp->fname_end - tagp->fname);
2982 p = tagp->tagname + len;
2983 if ( p < tagp->tagname_end
2984 && *p == ':'
2985 && fnamencmp(tagp->tagname, tagp->fname, len) == 0)
2987 tagp->tagname = p + 1;
2988 return TRUE;
2990 #endif
2993 * Check for new style static tag ":...<Tab>file:[<Tab>...]"
2995 p = tagp->command;
2996 while ((p = vim_strchr(p, '\t')) != NULL)
2998 ++p;
2999 if (STRNCMP(p, "file:", 5) == 0)
3000 return TRUE;
3003 return FALSE;
3007 * Parse a line from a matching tag. Does not change the line itself.
3009 * The line that we get looks like this:
3010 * Emacs tag: <mtt><tag_fname><NUL><ebuf><NUL><lbuf>
3011 * other tag: <mtt><tag_fname><NUL><NUL><lbuf>
3012 * without Emacs tags: <mtt><tag_fname><NUL><lbuf>
3014 * Return OK or FAIL.
3016 static int
3017 parse_match(lbuf, tagp)
3018 char_u *lbuf; /* input: matching line */
3019 tagptrs_T *tagp; /* output: pointers into the line */
3021 int retval;
3022 char_u *p;
3023 char_u *pc, *pt;
3025 tagp->tag_fname = lbuf + 1;
3026 lbuf += STRLEN(tagp->tag_fname) + 2;
3027 #ifdef FEAT_EMACS_TAGS
3028 if (*lbuf)
3030 tagp->is_etag = TRUE;
3031 tagp->fname = lbuf;
3032 lbuf += STRLEN(lbuf);
3033 tagp->fname_end = lbuf++;
3035 else
3037 tagp->is_etag = FALSE;
3038 ++lbuf;
3040 #endif
3042 /* Find search pattern and the file name for non-etags. */
3043 retval = parse_tag_line(lbuf,
3044 #ifdef FEAT_EMACS_TAGS
3045 tagp->is_etag,
3046 #endif
3047 tagp);
3049 tagp->tagkind = NULL;
3050 tagp->command_end = NULL;
3052 if (retval == OK)
3054 /* Try to find a kind field: "kind:<kind>" or just "<kind>"*/
3055 p = tagp->command;
3056 if (find_extra(&p) == OK)
3058 tagp->command_end = p;
3059 p += 2; /* skip ";\"" */
3060 if (*p++ == TAB)
3061 while (ASCII_ISALPHA(*p))
3063 if (STRNCMP(p, "kind:", 5) == 0)
3065 tagp->tagkind = p + 5;
3066 break;
3068 pc = vim_strchr(p, ':');
3069 pt = vim_strchr(p, '\t');
3070 if (pc == NULL || (pt != NULL && pc > pt))
3072 tagp->tagkind = p;
3073 break;
3075 if (pt == NULL)
3076 break;
3077 p = pt + 1;
3080 if (tagp->tagkind != NULL)
3082 for (p = tagp->tagkind;
3083 *p && *p != '\t' && *p != '\r' && *p != '\n'; ++p)
3085 tagp->tagkind_end = p;
3088 return retval;
3092 * Find out the actual file name of a tag. Concatenate the tags file name
3093 * with the matching tag file name.
3094 * Returns an allocated string or NULL (out of memory).
3096 static char_u *
3097 tag_full_fname(tagp)
3098 tagptrs_T *tagp;
3100 char_u *fullname;
3101 int c;
3103 #ifdef FEAT_EMACS_TAGS
3104 if (tagp->is_etag)
3105 c = 0; /* to shut up GCC */
3106 else
3107 #endif
3109 c = *tagp->fname_end;
3110 *tagp->fname_end = NUL;
3112 fullname = expand_tag_fname(tagp->fname, tagp->tag_fname, FALSE);
3114 #ifdef FEAT_EMACS_TAGS
3115 if (!tagp->is_etag)
3116 #endif
3117 *tagp->fname_end = c;
3119 return fullname;
3123 * Jump to a tag that has been found in one of the tag files
3125 * returns OK for success, NOTAGFILE when file not found, FAIL otherwise.
3127 static int
3128 jumpto_tag(lbuf, forceit, keep_help)
3129 char_u *lbuf; /* line from the tags file for this tag */
3130 int forceit; /* :ta with ! */
3131 int keep_help; /* keep help flag (FALSE for cscope) */
3133 int save_secure;
3134 int save_magic;
3135 int save_p_ws, save_p_scs, save_p_ic;
3136 linenr_T save_lnum;
3137 int csave = 0;
3138 char_u *str;
3139 char_u *pbuf; /* search pattern buffer */
3140 char_u *pbuf_end;
3141 char_u *tofree_fname = NULL;
3142 char_u *fname;
3143 tagptrs_T tagp;
3144 int retval = FAIL;
3145 int getfile_result;
3146 int search_options;
3147 #ifdef FEAT_SEARCH_EXTRA
3148 int save_no_hlsearch;
3149 #endif
3150 #if defined(FEAT_WINDOWS) && defined(FEAT_QUICKFIX)
3151 win_T *curwin_save = NULL;
3152 #endif
3153 char_u *full_fname = NULL;
3154 #ifdef FEAT_FOLDING
3155 int old_KeyTyped = KeyTyped; /* getting the file may reset it */
3156 #endif
3158 pbuf = alloc(LSIZE);
3160 /* parse the match line into the tagp structure */
3161 if (pbuf == NULL || parse_match(lbuf, &tagp) == FAIL)
3163 tagp.fname_end = NULL;
3164 goto erret;
3167 /* truncate the file name, so it can be used as a string */
3168 csave = *tagp.fname_end;
3169 *tagp.fname_end = NUL;
3170 fname = tagp.fname;
3172 /* copy the command to pbuf[], remove trailing CR/NL */
3173 str = tagp.command;
3174 for (pbuf_end = pbuf; *str && *str != '\n' && *str != '\r'; )
3176 #ifdef FEAT_EMACS_TAGS
3177 if (tagp.is_etag && *str == ',')/* stop at ',' after line number */
3178 break;
3179 #endif
3180 *pbuf_end++ = *str++;
3182 *pbuf_end = NUL;
3184 #ifdef FEAT_EMACS_TAGS
3185 if (!tagp.is_etag)
3186 #endif
3189 * Remove the "<Tab>fieldname:value" stuff; we don't need it here.
3191 str = pbuf;
3192 if (find_extra(&str) == OK)
3194 pbuf_end = str;
3195 *pbuf_end = NUL;
3200 * Expand file name, when needed (for environment variables).
3201 * If 'tagrelative' option set, may change file name.
3203 fname = expand_tag_fname(fname, tagp.tag_fname, TRUE);
3204 if (fname == NULL)
3205 goto erret;
3206 tofree_fname = fname; /* free() it later */
3209 * Check if the file with the tag exists before abandoning the current
3210 * file. Also accept a file name for which there is a matching BufReadCmd
3211 * autocommand event (e.g., http://sys/file).
3213 if (mch_getperm(fname) < 0
3214 #ifdef FEAT_AUTOCMD
3215 && !has_autocmd(EVENT_BUFREADCMD, fname, NULL)
3216 #endif
3219 retval = NOTAGFILE;
3220 vim_free(nofile_fname);
3221 nofile_fname = vim_strsave(fname);
3222 if (nofile_fname == NULL)
3223 nofile_fname = empty_option;
3224 goto erret;
3227 ++RedrawingDisabled;
3229 #ifdef FEAT_GUI
3230 need_mouse_correct = TRUE;
3231 #endif
3233 #if defined(FEAT_WINDOWS) && defined(FEAT_QUICKFIX)
3234 if (g_do_tagpreview)
3236 postponed_split = 0; /* don't split again below */
3237 curwin_save = curwin; /* Save current window */
3240 * If we are reusing a window, we may change dir when
3241 * entering it (autocommands) so turn the tag filename
3242 * into a fullpath
3244 if (!curwin->w_p_pvw)
3246 full_fname = FullName_save(fname, FALSE);
3247 fname = full_fname;
3250 * Make the preview window the current window.
3251 * Open a preview window when needed.
3253 prepare_tagpreview(TRUE);
3257 /* If it was a CTRL-W CTRL-] command split window now. For ":tab tag"
3258 * open a new tab page. */
3259 if (postponed_split || cmdmod.tab != 0)
3261 win_split(postponed_split > 0 ? postponed_split : 0,
3262 postponed_split_flags);
3263 # ifdef FEAT_SCROLLBIND
3264 curwin->w_p_scb = FALSE;
3265 # endif
3267 #endif
3269 if (keep_help)
3271 /* A :ta from a help file will keep the b_help flag set. For ":ptag"
3272 * we need to use the flag from the window where we came from. */
3273 #if defined(FEAT_WINDOWS) && defined(FEAT_QUICKFIX)
3274 if (g_do_tagpreview)
3275 keep_help_flag = curwin_save->w_buffer->b_help;
3276 else
3277 #endif
3278 keep_help_flag = curbuf->b_help;
3280 getfile_result = getfile(0, fname, NULL, TRUE, (linenr_T)0, forceit);
3281 keep_help_flag = FALSE;
3283 if (getfile_result <= 0) /* got to the right file */
3285 curwin->w_set_curswant = TRUE;
3286 #ifdef FEAT_WINDOWS
3287 postponed_split = 0;
3288 #endif
3290 save_secure = secure;
3291 secure = 1;
3292 #ifdef HAVE_SANDBOX
3293 ++sandbox;
3294 #endif
3295 save_magic = p_magic;
3296 p_magic = FALSE; /* always execute with 'nomagic' */
3297 #ifdef FEAT_SEARCH_EXTRA
3298 /* Save value of no_hlsearch, jumping to a tag is not a real search */
3299 save_no_hlsearch = no_hlsearch;
3300 #endif
3303 * If 'cpoptions' contains 't', store the search pattern for the "n"
3304 * command. If 'cpoptions' does not contain 't', the search pattern
3305 * is not stored.
3307 if (vim_strchr(p_cpo, CPO_TAGPAT) != NULL)
3308 search_options = 0;
3309 else
3310 search_options = SEARCH_KEEP;
3313 * If the command is a search, try here.
3315 * Reset 'smartcase' for the search, since the search pattern was not
3316 * typed by the user.
3317 * Only use do_search() when there is a full search command, without
3318 * anything following.
3320 str = pbuf;
3321 if (pbuf[0] == '/' || pbuf[0] == '?')
3322 str = skip_regexp(pbuf + 1, pbuf[0], FALSE, NULL) + 1;
3323 if (str > pbuf_end - 1) /* search command with nothing following */
3325 save_p_ws = p_ws;
3326 save_p_ic = p_ic;
3327 save_p_scs = p_scs;
3328 p_ws = TRUE; /* need 'wrapscan' for backward searches */
3329 p_ic = FALSE; /* don't ignore case now */
3330 p_scs = FALSE;
3331 #if 0 /* disabled for now */
3332 #ifdef FEAT_CMDHIST
3333 /* put pattern in search history */
3334 add_to_history(HIST_SEARCH, pbuf + 1, TRUE, pbuf[0]);
3335 #endif
3336 #endif
3337 save_lnum = curwin->w_cursor.lnum;
3338 curwin->w_cursor.lnum = 0; /* start search before first line */
3339 if (do_search(NULL, pbuf[0], pbuf + 1, (long)1,
3340 search_options, NULL))
3341 retval = OK;
3342 else
3344 int found = 1;
3345 int cc;
3348 * try again, ignore case now
3350 p_ic = TRUE;
3351 if (!do_search(NULL, pbuf[0], pbuf + 1, (long)1,
3352 search_options, NULL))
3355 * Failed to find pattern, take a guess: "^func ("
3357 found = 2;
3358 (void)test_for_static(&tagp);
3359 cc = *tagp.tagname_end;
3360 *tagp.tagname_end = NUL;
3361 sprintf((char *)pbuf, "^%s\\s\\*(", tagp.tagname);
3362 if (!do_search(NULL, '/', pbuf, (long)1,
3363 search_options, NULL))
3365 /* Guess again: "^char * \<func (" */
3366 sprintf((char *)pbuf, "^\\[#a-zA-Z_]\\.\\*\\<%s\\s\\*(",
3367 tagp.tagname);
3368 if (!do_search(NULL, '/', pbuf, (long)1,
3369 search_options, NULL))
3370 found = 0;
3372 *tagp.tagname_end = cc;
3374 if (found == 0)
3376 EMSG(_("E434: Can't find tag pattern"));
3377 curwin->w_cursor.lnum = save_lnum;
3379 else
3382 * Only give a message when really guessed, not when 'ic'
3383 * is set and match found while ignoring case.
3385 if (found == 2 || !save_p_ic)
3387 MSG(_("E435: Couldn't find tag, just guessing!"));
3388 if (!msg_scrolled && msg_silent == 0)
3390 out_flush();
3391 ui_delay(1000L, TRUE);
3394 retval = OK;
3397 p_ws = save_p_ws;
3398 p_ic = save_p_ic;
3399 p_scs = save_p_scs;
3401 /* A search command may have positioned the cursor beyond the end
3402 * of the line. May need to correct that here. */
3403 check_cursor();
3405 else
3407 curwin->w_cursor.lnum = 1; /* start command in line 1 */
3408 do_cmdline_cmd(pbuf);
3409 retval = OK;
3413 * When the command has done something that is not allowed make sure
3414 * the error message can be seen.
3416 if (secure == 2)
3417 wait_return(TRUE);
3418 secure = save_secure;
3419 p_magic = save_magic;
3420 #ifdef HAVE_SANDBOX
3421 --sandbox;
3422 #endif
3423 #ifdef FEAT_SEARCH_EXTRA
3424 /* restore no_hlsearch when keeping the old search pattern */
3425 if (search_options)
3426 no_hlsearch = save_no_hlsearch;
3427 #endif
3429 /* Return OK if jumped to another file (at least we found the file!). */
3430 if (getfile_result == -1)
3431 retval = OK;
3433 if (retval == OK)
3436 * For a help buffer: Put the cursor line at the top of the window,
3437 * the help subject will be below it.
3439 if (curbuf->b_help)
3440 set_topline(curwin, curwin->w_cursor.lnum);
3441 #ifdef FEAT_FOLDING
3442 if ((fdo_flags & FDO_TAG) && old_KeyTyped)
3443 foldOpenCursor();
3444 #endif
3447 #if defined(FEAT_WINDOWS) && defined(FEAT_QUICKFIX)
3448 if (g_do_tagpreview && curwin != curwin_save && win_valid(curwin_save))
3450 /* Return cursor to where we were */
3451 validate_cursor();
3452 redraw_later(VALID);
3453 win_enter(curwin_save, TRUE);
3455 #endif
3457 --RedrawingDisabled;
3459 else
3461 --RedrawingDisabled;
3462 #ifdef FEAT_WINDOWS
3463 if (postponed_split) /* close the window */
3465 win_close(curwin, FALSE);
3466 postponed_split = 0;
3468 #endif
3471 erret:
3472 #if defined(FEAT_WINDOWS) && defined(FEAT_QUICKFIX)
3473 g_do_tagpreview = 0; /* For next time */
3474 #endif
3475 if (tagp.fname_end != NULL)
3476 *tagp.fname_end = csave;
3477 vim_free(pbuf);
3478 vim_free(tofree_fname);
3479 vim_free(full_fname);
3481 return retval;
3485 * If "expand" is TRUE, expand wildcards in fname.
3486 * If 'tagrelative' option set, change fname (name of file containing tag)
3487 * according to tag_fname (name of tag file containing fname).
3488 * Returns a pointer to allocated memory (or NULL when out of memory).
3490 static char_u *
3491 expand_tag_fname(fname, tag_fname, expand)
3492 char_u *fname;
3493 char_u *tag_fname;
3494 int expand;
3496 char_u *p;
3497 char_u *retval;
3498 char_u *expanded_fname = NULL;
3499 expand_T xpc;
3502 * Expand file name (for environment variables) when needed.
3504 if (expand && mch_has_wildcard(fname))
3506 ExpandInit(&xpc);
3507 xpc.xp_context = EXPAND_FILES;
3508 expanded_fname = ExpandOne(&xpc, (char_u *)fname, NULL,
3509 WILD_LIST_NOTFOUND|WILD_SILENT, WILD_EXPAND_FREE);
3510 if (expanded_fname != NULL)
3511 fname = expanded_fname;
3514 if ((p_tr || curbuf->b_help)
3515 && !vim_isAbsName(fname)
3516 && (p = gettail(tag_fname)) != tag_fname)
3518 retval = alloc(MAXPATHL);
3519 if (retval != NULL)
3521 STRCPY(retval, tag_fname);
3522 vim_strncpy(retval + (p - tag_fname), fname,
3523 MAXPATHL - (p - tag_fname) - 1);
3525 * Translate names like "src/a/../b/file.c" into "src/b/file.c".
3527 simplify_filename(retval);
3530 else
3531 retval = vim_strsave(fname);
3533 vim_free(expanded_fname);
3535 return retval;
3539 * Converts a file name into a canonical form. It simplifies a file name into
3540 * its simplest form by stripping out unneeded components, if any. The
3541 * resulting file name is simplified in place and will either be the same
3542 * length as that supplied, or shorter.
3544 void
3545 simplify_filename(filename)
3546 char_u *filename;
3548 #ifndef AMIGA /* Amiga doesn't have "..", it uses "/" */
3549 int components = 0;
3550 char_u *p, *tail, *start;
3551 int stripping_disabled = FALSE;
3552 int relative = TRUE;
3554 p = filename;
3555 #ifdef BACKSLASH_IN_FILENAME
3556 if (p[1] == ':') /* skip "x:" */
3557 p += 2;
3558 #endif
3560 if (vim_ispathsep(*p))
3562 relative = FALSE;
3564 ++p;
3565 while (vim_ispathsep(*p));
3567 start = p; /* remember start after "c:/" or "/" or "///" */
3571 /* At this point "p" is pointing to the char following a single "/"
3572 * or "p" is at the "start" of the (absolute or relative) path name. */
3573 #ifdef VMS
3574 /* VMS allows device:[path] - don't strip the [ in directory */
3575 if ((*p == '[' || *p == '<') && p > filename && p[-1] == ':')
3577 /* :[ or :< composition: vms directory component */
3578 ++components;
3579 p = getnextcomp(p + 1);
3581 /* allow remote calls as host"user passwd"::device:[path] */
3582 else if (p[0] == ':' && p[1] == ':' && p > filename && p[-1] == '"' )
3584 /* ":: composition: vms host/passwd component */
3585 ++components;
3586 p = getnextcomp(p + 2);
3588 else
3589 #endif
3590 if (vim_ispathsep(*p))
3591 STRMOVE(p, p + 1); /* remove duplicate "/" */
3592 else if (p[0] == '.' && (vim_ispathsep(p[1]) || p[1] == NUL))
3594 if (p == start && relative)
3595 p += 1 + (p[1] != NUL); /* keep single "." or leading "./" */
3596 else
3598 /* Strip "./" or ".///". If we are at the end of the file name
3599 * and there is no trailing path separator, either strip "/." if
3600 * we are after "start", or strip "." if we are at the beginning
3601 * of an absolute path name . */
3602 tail = p + 1;
3603 if (p[1] != NUL)
3604 while (vim_ispathsep(*tail))
3605 mb_ptr_adv(tail);
3606 else if (p > start)
3607 --p; /* strip preceding path separator */
3608 STRMOVE(p, tail);
3611 else if (p[0] == '.' && p[1] == '.' &&
3612 (vim_ispathsep(p[2]) || p[2] == NUL))
3614 /* Skip to after ".." or "../" or "..///". */
3615 tail = p + 2;
3616 while (vim_ispathsep(*tail))
3617 mb_ptr_adv(tail);
3619 if (components > 0) /* strip one preceding component */
3621 int do_strip = FALSE;
3622 char_u saved_char;
3623 struct stat st;
3625 /* Don't strip for an erroneous file name. */
3626 if (!stripping_disabled)
3628 /* If the preceding component does not exist in the file
3629 * system, we strip it. On Unix, we don't accept a symbolic
3630 * link that refers to a non-existent file. */
3631 saved_char = p[-1];
3632 p[-1] = NUL;
3633 #ifdef UNIX
3634 if (mch_lstat((char *)filename, &st) < 0)
3635 #else
3636 if (mch_stat((char *)filename, &st) < 0)
3637 #endif
3638 do_strip = TRUE;
3639 p[-1] = saved_char;
3641 --p;
3642 /* Skip back to after previous '/'. */
3643 while (p > start && !after_pathsep(start, p))
3644 mb_ptr_back(start, p);
3646 if (!do_strip)
3648 /* If the component exists in the file system, check
3649 * that stripping it won't change the meaning of the
3650 * file name. First get information about the
3651 * unstripped file name. This may fail if the component
3652 * to strip is not a searchable directory (but a regular
3653 * file, for instance), since the trailing "/.." cannot
3654 * be applied then. We don't strip it then since we
3655 * don't want to replace an erroneous file name by
3656 * a valid one, and we disable stripping of later
3657 * components. */
3658 saved_char = *tail;
3659 *tail = NUL;
3660 if (mch_stat((char *)filename, &st) >= 0)
3661 do_strip = TRUE;
3662 else
3663 stripping_disabled = TRUE;
3664 *tail = saved_char;
3665 #ifdef UNIX
3666 if (do_strip)
3668 struct stat new_st;
3670 /* On Unix, the check for the unstripped file name
3671 * above works also for a symbolic link pointing to
3672 * a searchable directory. But then the parent of
3673 * the directory pointed to by the link must be the
3674 * same as the stripped file name. (The latter
3675 * exists in the file system since it is the
3676 * component's parent directory.) */
3677 if (p == start && relative)
3678 (void)mch_stat(".", &new_st);
3679 else
3681 saved_char = *p;
3682 *p = NUL;
3683 (void)mch_stat((char *)filename, &new_st);
3684 *p = saved_char;
3687 if (new_st.st_ino != st.st_ino ||
3688 new_st.st_dev != st.st_dev)
3690 do_strip = FALSE;
3691 /* We don't disable stripping of later
3692 * components since the unstripped path name is
3693 * still valid. */
3696 #endif
3700 if (!do_strip)
3702 /* Skip the ".." or "../" and reset the counter for the
3703 * components that might be stripped later on. */
3704 p = tail;
3705 components = 0;
3707 else
3709 /* Strip previous component. If the result would get empty
3710 * and there is no trailing path separator, leave a single
3711 * "." instead. If we are at the end of the file name and
3712 * there is no trailing path separator and a preceding
3713 * component is left after stripping, strip its trailing
3714 * path separator as well. */
3715 if (p == start && relative && tail[-1] == '.')
3717 *p++ = '.';
3718 *p = NUL;
3720 else
3722 if (p > start && tail[-1] == '.')
3723 --p;
3724 STRMOVE(p, tail); /* strip previous component */
3727 --components;
3730 else if (p == start && !relative) /* leading "/.." or "/../" */
3731 STRMOVE(p, tail); /* strip ".." or "../" */
3732 else
3734 if (p == start + 2 && p[-2] == '.') /* leading "./../" */
3736 STRMOVE(p - 2, p); /* strip leading "./" */
3737 tail -= 2;
3739 p = tail; /* skip to char after ".." or "../" */
3742 else
3744 ++components; /* simple path component */
3745 p = getnextcomp(p);
3747 } while (*p != NUL);
3748 #endif /* !AMIGA */
3752 * Check if we have a tag for the buffer with name "buf_ffname".
3753 * This is a bit slow, because of the full path compare in fullpathcmp().
3754 * Return TRUE if tag for file "fname" if tag file "tag_fname" is for current
3755 * file.
3757 static int
3758 #ifdef FEAT_EMACS_TAGS
3759 test_for_current(is_etag, fname, fname_end, tag_fname, buf_ffname)
3760 int is_etag;
3761 #else
3762 test_for_current(fname, fname_end, tag_fname, buf_ffname)
3763 #endif
3764 char_u *fname;
3765 char_u *fname_end;
3766 char_u *tag_fname;
3767 char_u *buf_ffname;
3769 int c;
3770 int retval = FALSE;
3771 char_u *fullname;
3773 if (buf_ffname != NULL) /* if the buffer has a name */
3775 #ifdef FEAT_EMACS_TAGS
3776 if (is_etag)
3777 c = 0; /* to shut up GCC */
3778 else
3779 #endif
3781 c = *fname_end;
3782 *fname_end = NUL;
3784 fullname = expand_tag_fname(fname, tag_fname, TRUE);
3785 if (fullname != NULL)
3787 retval = (fullpathcmp(fullname, buf_ffname, TRUE) & FPC_SAME);
3788 vim_free(fullname);
3790 #ifdef FEAT_EMACS_TAGS
3791 if (!is_etag)
3792 #endif
3793 *fname_end = c;
3796 return retval;
3800 * Find the end of the tagaddress.
3801 * Return OK if ";\"" is following, FAIL otherwise.
3803 static int
3804 find_extra(pp)
3805 char_u **pp;
3807 char_u *str = *pp;
3809 /* Repeat for addresses separated with ';' */
3810 for (;;)
3812 if (VIM_ISDIGIT(*str))
3813 str = skipdigits(str);
3814 else if (*str == '/' || *str == '?')
3816 str = skip_regexp(str + 1, *str, FALSE, NULL);
3817 if (*str != **pp)
3818 str = NULL;
3819 else
3820 ++str;
3822 else
3823 str = NULL;
3824 if (str == NULL || *str != ';'
3825 || !(VIM_ISDIGIT(str[1]) || str[1] == '/' || str[1] == '?'))
3826 break;
3827 ++str; /* skip ';' */
3830 if (str != NULL && STRNCMP(str, ";\"", 2) == 0)
3832 *pp = str;
3833 return OK;
3835 return FAIL;
3838 #if defined(FEAT_CMDL_COMPL) || defined(PROTO)
3840 expand_tags(tagnames, pat, num_file, file)
3841 int tagnames; /* expand tag names */
3842 char_u *pat;
3843 int *num_file;
3844 char_u ***file;
3846 int i;
3847 int c;
3848 int tagnmflag;
3849 char_u tagnm[100];
3850 tagptrs_T t_p;
3851 int ret;
3853 if (tagnames)
3854 tagnmflag = TAG_NAMES;
3855 else
3856 tagnmflag = 0;
3857 if (pat[0] == '/')
3858 ret = find_tags(pat + 1, num_file, file,
3859 TAG_REGEXP | tagnmflag | TAG_VERBOSE,
3860 TAG_MANY, curbuf->b_ffname);
3861 else
3862 ret = find_tags(pat, num_file, file,
3863 TAG_REGEXP | tagnmflag | TAG_VERBOSE | TAG_NOIC,
3864 TAG_MANY, curbuf->b_ffname);
3865 if (ret == OK && !tagnames)
3867 /* Reorganize the tags for display and matching as strings of:
3868 * "<tagname>\0<kind>\0<filename>\0"
3870 for (i = 0; i < *num_file; i++)
3872 parse_match((*file)[i], &t_p);
3873 c = (int)(t_p.tagname_end - t_p.tagname);
3874 mch_memmove(tagnm, t_p.tagname, (size_t)c);
3875 tagnm[c++] = 0;
3876 tagnm[c++] = (t_p.tagkind != NULL && *t_p.tagkind)
3877 ? *t_p.tagkind : 'f';
3878 tagnm[c++] = 0;
3879 mch_memmove((*file)[i] + c, t_p.fname, t_p.fname_end - t_p.fname);
3880 (*file)[i][c + (t_p.fname_end - t_p.fname)] = 0;
3881 mch_memmove((*file)[i], tagnm, (size_t)c);
3884 return ret;
3886 #endif
3888 #if defined(FEAT_EVAL) || defined(PROTO)
3889 static int add_tag_field __ARGS((dict_T *dict, char *field_name, char_u *start, char_u *end));
3892 * Add a tag field to the dictionary "dict"
3894 static int
3895 add_tag_field(dict, field_name, start, end)
3896 dict_T *dict;
3897 char *field_name;
3898 char_u *start; /* start of the value */
3899 char_u *end; /* after the value; can be NULL */
3901 char_u buf[MAXPATHL];
3902 int len = 0;
3904 if (start != NULL)
3906 if (end == NULL)
3908 end = start + STRLEN(start);
3909 while (end > start && (end[-1] == '\r' || end[-1] == '\n'))
3910 --end;
3912 len = (int)(end - start);
3913 if (len > (int)sizeof(buf) - 1)
3914 len = sizeof(buf) - 1;
3915 vim_strncpy(buf, start, len);
3917 buf[len] = NUL;
3918 return dict_add_nr_str(dict, field_name, 0L, buf);
3922 * Add the tags matching the specified pattern to the list "list"
3923 * as a dictionary
3926 get_tags(list, pat)
3927 list_T *list;
3928 char_u *pat;
3930 int num_matches, i, ret;
3931 char_u **matches, *p;
3932 char_u *full_fname;
3933 dict_T *dict;
3934 tagptrs_T tp;
3935 long is_static;
3937 ret = find_tags(pat, &num_matches, &matches,
3938 TAG_REGEXP | TAG_NOIC, (int)MAXCOL, NULL);
3939 if (ret == OK && num_matches > 0)
3941 for (i = 0; i < num_matches; ++i)
3943 parse_match(matches[i], &tp);
3944 is_static = test_for_static(&tp);
3946 /* Skip pseudo-tag lines. */
3947 if (STRNCMP(tp.tagname, "!_TAG_", 6) == 0)
3948 continue;
3950 if ((dict = dict_alloc()) == NULL)
3951 ret = FAIL;
3952 if (list_append_dict(list, dict) == FAIL)
3953 ret = FAIL;
3955 full_fname = tag_full_fname(&tp);
3956 if (add_tag_field(dict, "name", tp.tagname, tp.tagname_end) == FAIL
3957 || add_tag_field(dict, "filename", full_fname,
3958 NULL) == FAIL
3959 || add_tag_field(dict, "cmd", tp.command,
3960 tp.command_end) == FAIL
3961 || add_tag_field(dict, "kind", tp.tagkind,
3962 tp.tagkind_end) == FAIL
3963 || dict_add_nr_str(dict, "static", is_static, NULL) == FAIL)
3964 ret = FAIL;
3966 vim_free(full_fname);
3968 if (tp.command_end != NULL)
3970 for (p = tp.command_end + 3;
3971 *p != NUL && *p != '\n' && *p != '\r'; ++p)
3973 if (p == tp.tagkind || (p + 5 == tp.tagkind
3974 && STRNCMP(p, "kind:", 5) == 0))
3975 /* skip "kind:<kind>" and "<kind>" */
3976 p = tp.tagkind_end - 1;
3977 else if (STRNCMP(p, "file:", 5) == 0)
3978 /* skip "file:" (static tag) */
3979 p += 4;
3980 else if (!vim_iswhite(*p))
3982 char_u *s, *n;
3983 int len;
3985 /* Add extra field as a dict entry. Fields are
3986 * separated by Tabs. */
3987 n = p;
3988 while (*p != NUL && *p >= ' ' && *p < 127 && *p != ':')
3989 ++p;
3990 len = (int)(p - n);
3991 if (*p == ':' && len > 0)
3993 s = ++p;
3994 while (*p != NUL && *p >= ' ')
3995 ++p;
3996 n[len] = NUL;
3997 if (add_tag_field(dict, (char *)n, s, p) == FAIL)
3998 ret = FAIL;
3999 n[len] = ':';
4001 else
4002 /* Skip field without colon. */
4003 while (*p != NUL && *p >= ' ')
4004 ++p;
4005 if (*p == NUL)
4006 break;
4011 vim_free(matches[i]);
4013 vim_free(matches);
4015 return ret;
4017 #endif