feat/tagfunc: Fixed problem with using ":help" when 'tfu' set.
[vim_extended.git] / src / tag.c
blob930032163ad0864a33552c9409629f7f24d57218
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 */
168 int use_tfu = 1;
170 /* remember the matches for the last used tag */
171 static int num_matches = 0;
172 static int max_num_matches = 0; /* limit used for match search */
173 static char_u **matches = NULL;
174 static int flags;
176 #ifdef EXITFREE
177 if (type == DT_FREE)
179 /* remove the list of matches */
180 FreeWild(num_matches, matches);
181 # ifdef FEAT_CSCOPE
182 cs_free_tags();
183 # endif
184 num_matches = 0;
185 return FALSE;
187 #endif
189 if (type == DT_HELP)
191 type = DT_TAG;
192 no_regexp = TRUE;
193 use_tfu = 0;
196 prev_num_matches = num_matches;
197 free_string_option(nofile_fname);
198 nofile_fname = NULL;
200 clearpos(&saved_fmark.mark); /* shutup gcc 4.0 */
201 saved_fmark.fnum = 0;
204 * Don't add a tag to the tagstack if 'tagstack' has been reset.
206 if ((!p_tgst && *tag != NUL))
208 use_tagstack = FALSE;
209 new_tag = TRUE;
211 else
213 #if defined(FEAT_WINDOWS) && defined(FEAT_QUICKFIX)
214 if (g_do_tagpreview)
215 use_tagstack = FALSE;
216 else
217 #endif
218 use_tagstack = TRUE;
220 /* new pattern, add to the tag stack */
221 if (*tag != NUL
222 && (type == DT_TAG || type == DT_SELECT || type == DT_JUMP
223 #ifdef FEAT_QUICKFIX
224 || type == DT_LTAG
225 #endif
226 #ifdef FEAT_CSCOPE
227 || type == DT_CSCOPE
228 #endif
231 #if defined(FEAT_WINDOWS) && defined(FEAT_QUICKFIX)
232 if (g_do_tagpreview)
234 if (ptag_entry.tagname != NULL
235 && STRCMP(ptag_entry.tagname, tag) == 0)
237 /* Jumping to same tag: keep the current match, so that
238 * the CursorHold autocommand example works. */
239 cur_match = ptag_entry.cur_match;
240 cur_fnum = ptag_entry.cur_fnum;
242 else
244 vim_free(ptag_entry.tagname);
245 if ((ptag_entry.tagname = vim_strsave(tag)) == NULL)
246 goto end_do_tag;
249 else
250 #endif
253 * If the last used entry is not at the top, delete all tag
254 * stack entries above it.
256 while (tagstackidx < tagstacklen)
257 vim_free(tagstack[--tagstacklen].tagname);
259 /* if the tagstack is full: remove oldest entry */
260 if (++tagstacklen > TAGSTACKSIZE)
262 tagstacklen = TAGSTACKSIZE;
263 vim_free(tagstack[0].tagname);
264 for (i = 1; i < tagstacklen; ++i)
265 tagstack[i - 1] = tagstack[i];
266 --tagstackidx;
270 * put the tag name in the tag stack
272 if ((tagstack[tagstackidx].tagname = vim_strsave(tag)) == NULL)
274 curwin->w_tagstacklen = tagstacklen - 1;
275 goto end_do_tag;
277 curwin->w_tagstacklen = tagstacklen;
279 save_pos = TRUE; /* save the cursor position below */
282 new_tag = TRUE;
284 else
286 if (
287 #if defined(FEAT_WINDOWS) && defined(FEAT_QUICKFIX)
288 g_do_tagpreview ? ptag_entry.tagname == NULL :
289 #endif
290 tagstacklen == 0)
292 /* empty stack */
293 EMSG(_(e_tagstack));
294 goto end_do_tag;
297 if (type == DT_POP) /* go to older position */
299 #ifdef FEAT_FOLDING
300 int old_KeyTyped = KeyTyped;
301 #endif
302 if ((tagstackidx -= count) < 0)
304 EMSG(_(bottommsg));
305 if (tagstackidx + count == 0)
307 /* We did [num]^T from the bottom of the stack */
308 tagstackidx = 0;
309 goto end_do_tag;
311 /* We weren't at the bottom of the stack, so jump all the
312 * way to the bottom now.
314 tagstackidx = 0;
316 else if (tagstackidx >= tagstacklen) /* count == 0? */
318 EMSG(_(topmsg));
319 goto end_do_tag;
322 /* Make a copy of the fmark, autocommands may invalidate the
323 * tagstack before it's used. */
324 saved_fmark = tagstack[tagstackidx].fmark;
325 if (saved_fmark.fnum != curbuf->b_fnum)
328 * Jump to other file. If this fails (e.g. because the
329 * file was changed) keep original position in tag stack.
331 if (buflist_getfile(saved_fmark.fnum, saved_fmark.mark.lnum,
332 GETF_SETMARK, forceit) == FAIL)
334 tagstackidx = oldtagstackidx; /* back to old posn */
335 goto end_do_tag;
337 /* An BufReadPost autocommand may jump to the '" mark, but
338 * we don't what that here. */
339 curwin->w_cursor.lnum = saved_fmark.mark.lnum;
341 else
343 setpcmark();
344 curwin->w_cursor.lnum = saved_fmark.mark.lnum;
346 curwin->w_cursor.col = saved_fmark.mark.col;
347 curwin->w_set_curswant = TRUE;
348 check_cursor();
349 #ifdef FEAT_FOLDING
350 if ((fdo_flags & FDO_TAG) && old_KeyTyped)
351 foldOpenCursor();
352 #endif
354 /* remove the old list of matches */
355 FreeWild(num_matches, matches);
356 #ifdef FEAT_CSCOPE
357 cs_free_tags();
358 #endif
359 num_matches = 0;
360 tag_freematch();
361 goto end_do_tag;
364 if (type == DT_TAG
365 #if defined(FEAT_QUICKFIX)
366 || type == DT_LTAG
367 #endif
370 #if defined(FEAT_WINDOWS) && defined(FEAT_QUICKFIX)
371 if (g_do_tagpreview)
373 cur_match = ptag_entry.cur_match;
374 cur_fnum = ptag_entry.cur_fnum;
376 else
377 #endif
379 /* ":tag" (no argument): go to newer pattern */
380 save_pos = TRUE; /* save the cursor position below */
381 if ((tagstackidx += count - 1) >= tagstacklen)
384 * Beyond the last one, just give an error message and
385 * go to the last one. Don't store the cursor
386 * position.
388 tagstackidx = tagstacklen - 1;
389 EMSG(_(topmsg));
390 save_pos = FALSE;
392 else if (tagstackidx < 0) /* must have been count == 0 */
394 EMSG(_(bottommsg));
395 tagstackidx = 0;
396 goto end_do_tag;
398 cur_match = tagstack[tagstackidx].cur_match;
399 cur_fnum = tagstack[tagstackidx].cur_fnum;
401 new_tag = TRUE;
403 else /* go to other matching tag */
405 /* Save index for when selection is cancelled. */
406 prevtagstackidx = tagstackidx;
408 #if defined(FEAT_WINDOWS) && defined(FEAT_QUICKFIX)
409 if (g_do_tagpreview)
411 cur_match = ptag_entry.cur_match;
412 cur_fnum = ptag_entry.cur_fnum;
414 else
415 #endif
417 if (--tagstackidx < 0)
418 tagstackidx = 0;
419 cur_match = tagstack[tagstackidx].cur_match;
420 cur_fnum = tagstack[tagstackidx].cur_fnum;
422 switch (type)
424 case DT_FIRST: cur_match = count - 1; break;
425 case DT_SELECT:
426 case DT_JUMP:
427 #ifdef FEAT_CSCOPE
428 case DT_CSCOPE:
429 #endif
430 case DT_LAST: cur_match = MAXCOL - 1; break;
431 case DT_NEXT: cur_match += count; break;
432 case DT_PREV: cur_match -= count; break;
434 if (cur_match >= MAXCOL)
435 cur_match = MAXCOL - 1;
436 else if (cur_match < 0)
438 EMSG(_("E425: Cannot go before first matching tag"));
439 skip_msg = TRUE;
440 cur_match = 0;
441 cur_fnum = curbuf->b_fnum;
446 #if defined(FEAT_WINDOWS) && defined(FEAT_QUICKFIX)
447 if (g_do_tagpreview)
449 if (type != DT_SELECT && type != DT_JUMP)
451 ptag_entry.cur_match = cur_match;
452 ptag_entry.cur_fnum = cur_fnum;
455 else
456 #endif
459 * For ":tag [arg]" or ":tselect" remember position before the jump.
461 saved_fmark = tagstack[tagstackidx].fmark;
462 if (save_pos)
464 tagstack[tagstackidx].fmark.mark = curwin->w_cursor;
465 tagstack[tagstackidx].fmark.fnum = curbuf->b_fnum;
468 /* Curwin will change in the call to jumpto_tag() if ":stag" was
469 * used or an autocommand jumps to another window; store value of
470 * tagstackidx now. */
471 curwin->w_tagstackidx = tagstackidx;
472 if (type != DT_SELECT && type != DT_JUMP)
474 curwin->w_tagstack[tagstackidx].cur_match = cur_match;
475 curwin->w_tagstack[tagstackidx].cur_fnum = cur_fnum;
480 /* When not using the current buffer get the name of buffer "cur_fnum".
481 * Makes sure that the tag order doesn't change when using a remembered
482 * position for "cur_match". */
483 if (cur_fnum != curbuf->b_fnum)
485 buf_T *buf = buflist_findnr(cur_fnum);
487 if (buf != NULL)
488 buf_ffname = buf->b_ffname;
492 * Repeat searching for tags, when a file has not been found.
494 for (;;)
497 * When desired match not found yet, try to find it (and others).
499 if (use_tagstack)
500 name = tagstack[tagstackidx].tagname;
501 #if defined(FEAT_WINDOWS) && defined(FEAT_QUICKFIX)
502 else if (g_do_tagpreview)
503 name = ptag_entry.tagname;
504 #endif
505 else
506 name = tag;
507 other_name = (tagmatchname == NULL || STRCMP(tagmatchname, name) != 0);
508 if (new_tag
509 || (cur_match >= num_matches && max_num_matches != MAXCOL)
510 || other_name)
512 if (other_name)
514 vim_free(tagmatchname);
515 tagmatchname = vim_strsave(name);
519 * If a count is supplied to the ":tag <name>" command, then
520 * jump to count'th matching tag.
522 if (type == DT_TAG && *tag != NUL && count > 0)
523 cur_match = count - 1;
525 if (type == DT_SELECT || type == DT_JUMP
526 #if defined(FEAT_QUICKFIX)
527 || type == DT_LTAG
528 #endif
530 cur_match = MAXCOL - 1;
531 max_num_matches = cur_match + 1;
533 /* when the argument starts with '/', use it as a regexp */
534 if (!no_regexp && *name == '/')
536 flags = TAG_REGEXP;
537 ++name;
539 else
540 flags = TAG_NOIC;
542 #ifdef FEAT_CSCOPE
543 if (type == DT_CSCOPE)
544 flags = TAG_CSCOPE;
545 #endif
546 if (verbose)
547 flags |= TAG_VERBOSE;
548 if (type == DT_TAG && use_tfu)
549 flags |= TAG_USE_TFU;
551 if (find_tags(name, &new_num_matches, &new_matches, flags,
552 max_num_matches, buf_ffname) == OK
553 && new_num_matches < max_num_matches)
554 max_num_matches = MAXCOL; /* If less than max_num_matches
555 found: all matches found. */
557 /* If there already were some matches for the same name, move them
558 * to the start. Avoids that the order changes when using
559 * ":tnext" and jumping to another file. */
560 if (!new_tag && !other_name)
562 /* Find the position of each old match in the new list. Need
563 * to use parse_match() to find the tag line. */
564 idx = 0;
565 for (j = 0; j < num_matches; ++j)
567 parse_match(matches[j], &tagp);
568 for (i = idx; i < new_num_matches; ++i)
570 parse_match(new_matches[i], &tagp2);
571 if (STRCMP(tagp.tagname, tagp2.tagname) == 0)
573 p = new_matches[i];
574 for (k = i; k > idx; --k)
575 new_matches[k] = new_matches[k - 1];
576 new_matches[idx++] = p;
577 break;
582 FreeWild(num_matches, matches);
583 num_matches = new_num_matches;
584 matches = new_matches;
587 if (num_matches <= 0)
589 if (verbose)
590 EMSG2(_("E426: tag not found: %s"), name);
591 #if defined(FEAT_WINDOWS) && defined(FEAT_QUICKFIX)
592 g_do_tagpreview = 0;
593 #endif
595 else
597 int ask_for_selection = FALSE;
599 #ifdef FEAT_CSCOPE
600 if (type == DT_CSCOPE && num_matches > 1)
602 cs_print_tags();
603 ask_for_selection = TRUE;
605 else
606 #endif
607 if (type == DT_SELECT || (type == DT_JUMP && num_matches > 1))
610 * List all the matching tags.
611 * Assume that the first match indicates how long the tags can
612 * be, and align the file names to that.
614 parse_match(matches[0], &tagp);
615 taglen = (int)(tagp.tagname_end - tagp.tagname + 2);
616 if (taglen < 18)
617 taglen = 18;
618 if (taglen > Columns - 25)
619 taglen = MAXCOL;
620 if (msg_col == 0)
621 msg_didout = FALSE; /* overwrite previous message */
622 msg_start();
623 MSG_PUTS_ATTR(_(" # pri kind tag"), hl_attr(HLF_T));
624 msg_clr_eos();
625 taglen_advance(taglen);
626 MSG_PUTS_ATTR(_("file\n"), hl_attr(HLF_T));
628 for (i = 0; i < num_matches && !got_int; ++i)
630 parse_match(matches[i], &tagp);
631 if (!new_tag && (
632 #if defined(FEAT_WINDOWS) && defined(FEAT_QUICKFIX)
633 (g_do_tagpreview
634 && i == ptag_entry.cur_match) ||
635 #endif
636 (use_tagstack
637 && i == tagstack[tagstackidx].cur_match)))
638 *IObuff = '>';
639 else
640 *IObuff = ' ';
641 vim_snprintf((char *)IObuff + 1, IOSIZE - 1,
642 "%2d %s ", i + 1,
643 mt_names[matches[i][0] & MT_MASK]);
644 msg_puts(IObuff);
645 if (tagp.tagkind != NULL)
646 msg_outtrans_len(tagp.tagkind,
647 (int)(tagp.tagkind_end - tagp.tagkind));
648 msg_advance(13);
649 msg_outtrans_len_attr(tagp.tagname,
650 (int)(tagp.tagname_end - tagp.tagname),
651 hl_attr(HLF_T));
652 msg_putchar(' ');
653 taglen_advance(taglen);
655 /* Find out the actual file name. If it is long, truncate
656 * it and put "..." in the middle */
657 p = tag_full_fname(&tagp);
658 if (p != NULL)
660 msg_puts_long_attr(p, hl_attr(HLF_D));
661 vim_free(p);
663 if (msg_col > 0)
664 msg_putchar('\n');
665 if (got_int)
666 break;
667 msg_advance(15);
669 /* print any extra fields */
670 command_end = tagp.command_end;
671 if (command_end != NULL)
673 p = command_end + 3;
674 while (*p && *p != '\r' && *p != '\n')
676 while (*p == TAB)
677 ++p;
679 /* skip "file:" without a value (static tag) */
680 if (STRNCMP(p, "file:", 5) == 0
681 && vim_isspace(p[5]))
683 p += 5;
684 continue;
686 /* skip "kind:<kind>" and "<kind>" */
687 if (p == tagp.tagkind
688 || (p + 5 == tagp.tagkind
689 && STRNCMP(p, "kind:", 5) == 0))
691 p = tagp.tagkind_end;
692 continue;
694 /* print all other extra fields */
695 attr = hl_attr(HLF_CM);
696 while (*p && *p != '\r' && *p != '\n')
698 if (msg_col + ptr2cells(p) >= Columns)
700 msg_putchar('\n');
701 if (got_int)
702 break;
703 msg_advance(15);
705 p = msg_outtrans_one(p, attr);
706 if (*p == TAB)
708 msg_puts_attr((char_u *)" ", attr);
709 break;
711 if (*p == ':')
712 attr = 0;
715 if (msg_col > 15)
717 msg_putchar('\n');
718 if (got_int)
719 break;
720 msg_advance(15);
723 else
725 for (p = tagp.command;
726 *p && *p != '\r' && *p != '\n'; ++p)
728 command_end = p;
732 * Put the info (in several lines) at column 15.
733 * Don't display "/^" and "?^".
735 p = tagp.command;
736 if (*p == '/' || *p == '?')
738 ++p;
739 if (*p == '^')
740 ++p;
742 /* Remove leading whitespace from pattern */
743 while (p != command_end && vim_isspace(*p))
744 ++p;
746 while (p != command_end)
748 if (msg_col + (*p == TAB ? 1 : ptr2cells(p)) > Columns)
749 msg_putchar('\n');
750 if (got_int)
751 break;
752 msg_advance(15);
754 /* skip backslash used for escaping command char */
755 if (*p == '\\' && *(p + 1) == *tagp.command)
756 ++p;
758 if (*p == TAB)
760 msg_putchar(' ');
761 ++p;
763 else
764 p = msg_outtrans_one(p, 0);
766 /* don't display the "$/;\"" and "$?;\"" */
767 if (p == command_end - 2 && *p == '$'
768 && *(p + 1) == *tagp.command)
769 break;
770 /* don't display matching '/' or '?' */
771 if (p == command_end - 1 && *p == *tagp.command
772 && (*p == '/' || *p == '?'))
773 break;
775 if (msg_col)
776 msg_putchar('\n');
777 ui_breakcheck();
779 if (got_int)
780 got_int = FALSE; /* only stop the listing */
781 ask_for_selection = TRUE;
783 #if defined(FEAT_QUICKFIX) && defined(FEAT_EVAL)
784 else if (type == DT_LTAG)
786 list_T *list;
787 char_u tag_name[128 + 1];
788 char_u fname[MAXPATHL + 1];
789 char_u cmd[CMDBUFFSIZE + 1];
792 * Add the matching tags to the location list for the current
793 * window.
796 list = list_alloc();
797 if (list == NULL)
798 goto end_do_tag;
800 for (i = 0; i < num_matches; ++i)
802 int len, cmd_len;
803 long lnum;
804 dict_T *dict;
806 parse_match(matches[i], &tagp);
808 /* Save the tag name */
809 len = (int)(tagp.tagname_end - tagp.tagname);
810 if (len > 128)
811 len = 128;
812 vim_strncpy(tag_name, tagp.tagname, len);
813 tag_name[len] = NUL;
815 /* Save the tag file name */
816 p = tag_full_fname(&tagp);
817 if (p == NULL)
818 continue;
819 STRCPY(fname, p);
820 vim_free(p);
823 * Get the line number or the search pattern used to locate
824 * the tag.
826 lnum = 0;
827 if (isdigit(*tagp.command))
828 /* Line number is used to locate the tag */
829 lnum = atol((char *)tagp.command);
830 else
832 char_u *cmd_start, *cmd_end;
834 /* Search pattern is used to locate the tag */
836 /* Locate the end of the command */
837 cmd_start = tagp.command;
838 cmd_end = tagp.command_end;
839 if (cmd_end == NULL)
841 for (p = tagp.command;
842 *p && *p != '\r' && *p != '\n'; ++p)
844 cmd_end = p;
848 * Now, cmd_end points to the character after the
849 * command. Adjust it to point to the last
850 * character of the command.
852 cmd_end--;
855 * Skip the '/' and '?' characters at the
856 * beginning and end of the search pattern.
858 if (*cmd_start == '/' || *cmd_start == '?')
859 cmd_start++;
861 if (*cmd_end == '/' || *cmd_end == '?')
862 cmd_end--;
864 len = 0;
865 cmd[0] = NUL;
868 * If "^" is present in the tag search pattern, then
869 * copy it first.
871 if (*cmd_start == '^')
873 STRCPY(cmd, "^");
874 cmd_start++;
875 len++;
879 * Precede the tag pattern with \V to make it very
880 * nomagic.
882 STRCAT(cmd, "\\V");
883 len += 2;
885 cmd_len = (int)(cmd_end - cmd_start + 1);
886 if (cmd_len > (CMDBUFFSIZE - 5))
887 cmd_len = CMDBUFFSIZE - 5;
888 STRNCAT(cmd, cmd_start, cmd_len);
889 len += cmd_len;
891 if (cmd[len - 1] == '$')
894 * Replace '$' at the end of the search pattern
895 * with '\$'
897 cmd[len - 1] = '\\';
898 cmd[len] = '$';
899 len++;
902 cmd[len] = NUL;
905 if ((dict = dict_alloc()) == NULL)
906 continue;
907 if (list_append_dict(list, dict) == FAIL)
909 vim_free(dict);
910 continue;
913 dict_add_nr_str(dict, "text", 0L, tag_name);
914 dict_add_nr_str(dict, "filename", 0L, fname);
915 dict_add_nr_str(dict, "lnum", lnum, NULL);
916 if (lnum == 0)
917 dict_add_nr_str(dict, "pattern", 0L, cmd);
920 set_errorlist(curwin, list, ' ');
922 list_free(list, TRUE);
924 cur_match = 0; /* Jump to the first tag */
926 #endif
928 if (ask_for_selection == TRUE)
931 * Ask to select a tag from the list.
933 i = prompt_for_number(NULL);
934 if (i <= 0 || i > num_matches || got_int)
936 /* no valid choice: don't change anything */
937 if (use_tagstack)
939 tagstack[tagstackidx].fmark = saved_fmark;
940 tagstackidx = prevtagstackidx;
942 #ifdef FEAT_CSCOPE
943 cs_free_tags();
944 jumped_to_tag = TRUE;
945 #endif
946 break;
948 cur_match = i - 1;
951 if (cur_match >= num_matches)
953 /* Avoid giving this error when a file wasn't found and we're
954 * looking for a match in another file, which wasn't found.
955 * There will be an EMSG("file doesn't exist") below then. */
956 if ((type == DT_NEXT || type == DT_FIRST)
957 && nofile_fname == NULL)
959 if (num_matches == 1)
960 EMSG(_("E427: There is only one matching tag"));
961 else
962 EMSG(_("E428: Cannot go beyond last matching tag"));
963 skip_msg = TRUE;
965 cur_match = num_matches - 1;
967 if (use_tagstack)
969 tagstack[tagstackidx].cur_match = cur_match;
970 tagstack[tagstackidx].cur_fnum = cur_fnum;
971 ++tagstackidx;
973 #if defined(FEAT_WINDOWS) && defined(FEAT_QUICKFIX)
974 else if (g_do_tagpreview)
976 ptag_entry.cur_match = cur_match;
977 ptag_entry.cur_fnum = cur_fnum;
979 #endif
982 * Only when going to try the next match, report that the previous
983 * file didn't exist. Otherwise an EMSG() is given below.
985 if (nofile_fname != NULL && error_cur_match != cur_match)
986 smsg((char_u *)_("File \"%s\" does not exist"), nofile_fname);
989 ic = (matches[cur_match][0] & MT_IC_OFF);
990 if (type != DT_SELECT && type != DT_JUMP
991 #ifdef FEAT_CSCOPE
992 && type != DT_CSCOPE
993 #endif
994 && (num_matches > 1 || ic)
995 && !skip_msg)
997 /* Give an indication of the number of matching tags */
998 sprintf((char *)IObuff, _("tag %d of %d%s"),
999 cur_match + 1,
1000 num_matches,
1001 max_num_matches != MAXCOL ? _(" or more") : "");
1002 if (ic)
1003 STRCAT(IObuff, _(" Using tag with different case!"));
1004 if ((num_matches > prev_num_matches || new_tag)
1005 && num_matches > 1)
1007 if (ic)
1008 msg_attr(IObuff, hl_attr(HLF_W));
1009 else
1010 msg(IObuff);
1011 msg_scroll = TRUE; /* don't overwrite this message */
1013 else
1014 give_warning(IObuff, ic);
1015 if (ic && !msg_scrolled && msg_silent == 0)
1017 out_flush();
1018 ui_delay(1000L, TRUE);
1022 #ifdef FEAT_AUTOCMD
1023 /* Let the SwapExists event know what tag we are jumping to. */
1024 vim_snprintf((char *)IObuff, IOSIZE, ":ta %s\r", name);
1025 set_vim_var_string(VV_SWAPCOMMAND, IObuff, -1);
1026 #endif
1029 * Jump to the desired match.
1031 i = jumpto_tag(matches[cur_match], forceit, type != DT_CSCOPE);
1033 #ifdef FEAT_AUTOCMD
1034 set_vim_var_string(VV_SWAPCOMMAND, NULL, -1);
1035 #endif
1037 if (i == NOTAGFILE)
1039 /* File not found: try again with another matching tag */
1040 if ((type == DT_PREV && cur_match > 0)
1041 || ((type == DT_TAG || type == DT_NEXT
1042 || type == DT_FIRST)
1043 && (max_num_matches != MAXCOL
1044 || cur_match < num_matches - 1)))
1046 error_cur_match = cur_match;
1047 if (use_tagstack)
1048 --tagstackidx;
1049 if (type == DT_PREV)
1050 --cur_match;
1051 else
1053 type = DT_NEXT;
1054 ++cur_match;
1056 continue;
1058 EMSG2(_("E429: File \"%s\" does not exist"), nofile_fname);
1060 else
1062 /* We may have jumped to another window, check that
1063 * tagstackidx is still valid. */
1064 if (use_tagstack && tagstackidx > curwin->w_tagstacklen)
1065 tagstackidx = curwin->w_tagstackidx;
1066 #ifdef FEAT_CSCOPE
1067 jumped_to_tag = TRUE;
1068 #endif
1071 break;
1074 end_do_tag:
1075 /* Only store the new index when using the tagstack and it's valid. */
1076 if (use_tagstack && tagstackidx <= curwin->w_tagstacklen)
1077 curwin->w_tagstackidx = tagstackidx;
1078 #ifdef FEAT_WINDOWS
1079 postponed_split = 0; /* don't split next time */
1080 #endif
1082 #ifdef FEAT_CSCOPE
1083 return jumped_to_tag;
1084 #else
1085 return FALSE;
1086 #endif
1090 * Free cached tags.
1092 void
1093 tag_freematch()
1095 vim_free(tagmatchname);
1096 tagmatchname = NULL;
1099 static void
1100 taglen_advance(l)
1101 int l;
1103 if (l == MAXCOL)
1105 msg_putchar('\n');
1106 msg_advance(24);
1108 else
1109 msg_advance(13 + l);
1113 * Print the tag stack
1115 void
1116 do_tags(eap)
1117 exarg_T *eap UNUSED;
1119 int i;
1120 char_u *name;
1121 taggy_T *tagstack = curwin->w_tagstack;
1122 int tagstackidx = curwin->w_tagstackidx;
1123 int tagstacklen = curwin->w_tagstacklen;
1125 /* Highlight title */
1126 MSG_PUTS_TITLE(_("\n # TO tag FROM line in file/text"));
1127 for (i = 0; i < tagstacklen; ++i)
1129 if (tagstack[i].tagname != NULL)
1131 name = fm_getname(&(tagstack[i].fmark), 30);
1132 if (name == NULL) /* file name not available */
1133 continue;
1135 msg_putchar('\n');
1136 sprintf((char *)IObuff, "%c%2d %2d %-15s %5ld ",
1137 i == tagstackidx ? '>' : ' ',
1138 i + 1,
1139 tagstack[i].cur_match + 1,
1140 tagstack[i].tagname,
1141 tagstack[i].fmark.mark.lnum);
1142 msg_outtrans(IObuff);
1143 msg_outtrans_attr(name, tagstack[i].fmark.fnum == curbuf->b_fnum
1144 ? hl_attr(HLF_D) : 0);
1145 vim_free(name);
1147 out_flush(); /* show one line at a time */
1149 if (tagstackidx == tagstacklen) /* idx at top of stack */
1150 MSG_PUTS("\n>");
1153 /* When not using a CR for line separator, use vim_fgets() to read tag lines.
1154 * For the Mac use tag_fgets(). It can handle any line separator, but is much
1155 * slower than vim_fgets().
1157 #ifndef USE_CR
1158 # define tag_fgets vim_fgets
1159 #endif
1161 #ifdef FEAT_TAG_BINS
1162 static int tag_strnicmp __ARGS((char_u *s1, char_u *s2, size_t len));
1165 * Compare two strings, for length "len", ignoring case the ASCII way.
1166 * return 0 for match, < 0 for smaller, > 0 for bigger
1167 * Make sure case is folded to uppercase in comparison (like for 'sort -f')
1169 static int
1170 tag_strnicmp(s1, s2, len)
1171 char_u *s1;
1172 char_u *s2;
1173 size_t len;
1175 int i;
1177 while (len > 0)
1179 i = (int)TOUPPER_ASC(*s1) - (int)TOUPPER_ASC(*s2);
1180 if (i != 0)
1181 return i; /* this character different */
1182 if (*s1 == NUL)
1183 break; /* strings match until NUL */
1184 ++s1;
1185 ++s2;
1186 --len;
1188 return 0; /* strings match */
1190 #endif
1193 * Structure to hold info about the tag pattern being used.
1195 typedef struct
1197 char_u *pat; /* the pattern */
1198 int len; /* length of pat[] */
1199 char_u *head; /* start of pattern head */
1200 int headlen; /* length of head[] */
1201 regmatch_T regmatch; /* regexp program, may be NULL */
1202 } pat_T;
1204 static void prepare_pats __ARGS((pat_T *pats, int has_re));
1207 * Extract info from the tag search pattern "pats->pat".
1209 static void
1210 prepare_pats(pats, has_re)
1211 pat_T *pats;
1212 int has_re;
1214 pats->head = pats->pat;
1215 pats->headlen = pats->len;
1216 if (has_re)
1218 /* When the pattern starts with '^' or "\\<", binary searching can be
1219 * used (much faster). */
1220 if (pats->pat[0] == '^')
1221 pats->head = pats->pat + 1;
1222 else if (pats->pat[0] == '\\' && pats->pat[1] == '<')
1223 pats->head = pats->pat + 2;
1224 if (pats->head == pats->pat)
1225 pats->headlen = 0;
1226 else
1227 for (pats->headlen = 0; pats->head[pats->headlen] != NUL;
1228 ++pats->headlen)
1229 if (vim_strchr((char_u *)(p_magic ? ".[~*\\$" : "\\$"),
1230 pats->head[pats->headlen]) != NULL)
1231 break;
1232 if (p_tl != 0 && pats->headlen > p_tl) /* adjust for 'taglength' */
1233 pats->headlen = p_tl;
1236 if (has_re)
1237 pats->regmatch.regprog = vim_regcomp(pats->pat, p_magic ? RE_MAGIC : 0);
1238 else
1239 pats->regmatch.regprog = NULL;
1242 struct match_found
1244 int len; /* nr of chars of match[] to be compared */
1245 char_u match[1]; /* actually longer */
1248 static int
1249 find_tfu_tags(char_u *pat, garray_T *ga, int *match_count)
1251 pos_T pos;
1252 list_T *taglist;
1253 listitem_T *item, *item2;
1254 int ntags = 0;
1255 const int nfieds_required = 3;
1256 int result = FAIL;
1258 static int call_level = 0;
1260 /* Prevent endless loop: */
1261 ++call_level;
1262 if (call_level > 5)
1263 goto done;
1265 if (*curbuf->b_p_tfu == NUL)
1266 goto done;
1268 pos = curwin->w_cursor;
1269 taglist = call_func_retlist(curbuf->b_p_tfu, 1, &pat, FALSE);
1270 curwin->w_cursor = pos; /* restore the cursor position */
1272 if (taglist == NULL)
1273 goto done;
1275 for (item = taglist->lv_first; item != NULL; item = item->li_next)
1277 struct match_found *mfp;
1278 int len;
1279 if (item->li_tv.v_type != VAR_LIST)
1281 /* FIXME:2010-04-24:llorens: ... */
1282 continue;
1284 if (item->li_tv.vval.v_list->lv_len != nfieds_required)
1286 /* FIXME:2010-04-24:llorens: ... */
1287 continue;
1289 #ifdef FEAT_EMACS_TAGS
1290 len = 3;
1291 #else
1292 len = 2;
1293 #endif
1294 len += nfieds_required;
1296 for (item2 = item->li_tv.vval.v_list->lv_first;
1297 item2 != NULL;
1298 item2 = item2->li_next)
1300 if (item2->li_tv.v_type != VAR_STRING)
1302 /* FIXME:2010-04-24:llorens: ... */
1303 continue;
1305 len += STRLEN(item2->li_tv.vval.v_string);
1308 mfp = (struct match_found *)alloc(
1309 (int)sizeof(struct match_found) + len);
1310 if (mfp != NULL)
1312 char_u *p;
1313 mfp->len = len;
1314 p = mfp->match;
1315 p[0] = 0; /* mtt */
1316 p[1] = NUL; /* no tag file name */
1317 p = p + 2;
1318 #ifdef FEAT_EMACS_TAGS
1319 *p = NUL;
1320 ++p;
1321 #endif
1322 for (item2 = item->li_tv.vval.v_list->lv_first;
1323 item2 != NULL;
1324 item2 = item2->li_next)
1326 STRCPY(p, item2->li_tv.vval.v_string);
1327 p += STRLEN(item2->li_tv.vval.v_string);
1328 if (item2->li_next != NULL)
1330 *p = TAB;
1331 ++p;
1334 /* FIXME:2010-04-24:llorens: Don't add identical matches. */
1335 if (ga_grow(ga, 1) == OK)
1337 ((struct match_found **)(ga->ga_data)) [ga->ga_len++] = mfp;
1338 ++ntags;
1339 result = OK;
1341 else
1342 vim_free(mfp);
1346 list_free(taglist, TRUE);
1347 done:
1348 --call_level;
1349 *match_count = ntags;
1350 return result;
1354 * find_tags() - search for tags in tags files
1356 * Return FAIL if search completely failed (*num_matches will be 0, *matchesp
1357 * will be NULL), OK otherwise.
1359 * There is a priority in which type of tag is recognized.
1361 * 6. A static or global tag with a full matching tag for the current file.
1362 * 5. A global tag with a full matching tag for another file.
1363 * 4. A static tag with a full matching tag for another file.
1364 * 3. A static or global tag with an ignore-case matching tag for the
1365 * current file.
1366 * 2. A global tag with an ignore-case matching tag for another file.
1367 * 1. A static tag with an ignore-case matching tag for another file.
1369 * Tags in an emacs-style tags file are always global.
1371 * flags:
1372 * TAG_HELP only search for help tags
1373 * TAG_NAMES only return name of tag
1374 * TAG_REGEXP use "pat" as a regexp
1375 * TAG_NOIC don't always ignore case
1376 * TAG_KEEP_LANG keep language
1379 find_tags(pat, num_matches, matchesp, flags, mincount, buf_ffname)
1380 char_u *pat; /* pattern to search for */
1381 int *num_matches; /* return: number of matches found */
1382 char_u ***matchesp; /* return: array of matches found */
1383 int flags;
1384 int mincount; /* MAXCOL: find all matches
1385 other: minimal number of matches */
1386 char_u *buf_ffname; /* name of buffer for priority */
1388 FILE *fp;
1389 char_u *lbuf; /* line buffer */
1390 char_u *tag_fname; /* name of tag file */
1391 tagname_T tn; /* info for get_tagfname() */
1392 int first_file; /* trying first tag file */
1393 tagptrs_T tagp;
1394 int did_open = FALSE; /* did open a tag file */
1395 int stop_searching = FALSE; /* stop when match found or error */
1396 int retval = FAIL; /* return value */
1397 int is_static; /* current tag line is static */
1398 int is_current; /* file name matches */
1399 int eof = FALSE; /* found end-of-file */
1400 char_u *p;
1401 char_u *s;
1402 int i;
1403 #ifdef FEAT_TAG_BINS
1404 struct tag_search_info /* Binary search file offsets */
1406 off_t low_offset; /* offset for first char of first line that
1407 could match */
1408 off_t high_offset; /* offset of char after last line that could
1409 match */
1410 off_t curr_offset; /* Current file offset in search range */
1411 off_t curr_offset_used; /* curr_offset used when skipping back */
1412 off_t match_offset; /* Where the binary search found a tag */
1413 int low_char; /* first char at low_offset */
1414 int high_char; /* first char at high_offset */
1415 } search_info;
1416 off_t filesize;
1417 int tagcmp;
1418 off_t offset;
1419 int round;
1420 #endif
1421 enum
1423 TS_START, /* at start of file */
1424 TS_LINEAR /* linear searching forward, till EOF */
1425 #ifdef FEAT_TAG_BINS
1426 , TS_BINARY, /* binary searching */
1427 TS_SKIP_BACK, /* skipping backwards */
1428 TS_STEP_FORWARD /* stepping forwards */
1429 #endif
1430 } state; /* Current search state */
1432 int cmplen;
1433 int match; /* matches */
1434 int match_no_ic = 0;/* matches with rm_ic == FALSE */
1435 int match_re; /* match with regexp */
1436 int matchoff = 0;
1438 #ifdef FEAT_EMACS_TAGS
1440 * Stack for included emacs-tags file.
1441 * It has a fixed size, to truncate cyclic includes. jw
1443 # define INCSTACK_SIZE 42
1444 struct
1446 FILE *fp;
1447 char_u *etag_fname;
1448 } incstack[INCSTACK_SIZE];
1450 int incstack_idx = 0; /* index in incstack */
1451 char_u *ebuf; /* additional buffer for etag fname */
1452 int is_etag; /* current file is emaces style */
1453 #endif
1455 struct match_found *mfp, *mfp2;
1456 garray_T ga_match[MT_COUNT];
1457 int match_count = 0; /* number of matches found */
1458 char_u **matches;
1459 int mtt;
1460 int len;
1461 int help_save;
1462 #ifdef FEAT_MULTI_LANG
1463 int help_pri = 0;
1464 char_u *help_lang_find = NULL; /* lang to be found */
1465 char_u help_lang[3]; /* lang of current tags file */
1466 char_u *saved_pat = NULL; /* copy of pat[] */
1467 #endif
1469 /* Use two sets of variables for the pattern: "orgpat" holds the values
1470 * for the original pattern and "convpat" converted from 'encoding' to
1471 * encoding of the tags file. "pats" point to either one of these. */
1472 pat_T *pats;
1473 pat_T orgpat; /* holds unconverted pattern info */
1474 #ifdef FEAT_MBYTE
1475 pat_T convpat; /* holds converted pattern info */
1476 vimconv_T vimconv;
1477 #endif
1479 #ifdef FEAT_TAG_BINS
1480 int findall = (mincount == MAXCOL || mincount == TAG_MANY);
1481 /* find all matching tags */
1482 int sort_error = FALSE; /* tags file not sorted */
1483 int linear; /* do a linear search */
1484 int sortic = FALSE; /* tag file sorted in nocase */
1485 #endif
1486 int line_error = FALSE; /* syntax error */
1487 int has_re = (flags & TAG_REGEXP); /* regexp used */
1488 int help_only = (flags & TAG_HELP);
1489 int name_only = (flags & TAG_NAMES);
1490 int noic = (flags & TAG_NOIC);
1491 int get_it_again = FALSE;
1492 #ifdef FEAT_CSCOPE
1493 int use_cscope = (flags & TAG_CSCOPE);
1494 #endif
1495 int verbose = (flags & TAG_VERBOSE);
1496 int use_tfu = (flags & TAG_USE_TFU);
1498 help_save = curbuf->b_help;
1499 orgpat.pat = pat;
1500 pats = &orgpat;
1501 #ifdef FEAT_MBYTE
1502 vimconv.vc_type = CONV_NONE;
1503 #endif
1506 * Allocate memory for the buffers that are used
1508 lbuf = alloc(LSIZE);
1509 tag_fname = alloc(MAXPATHL + 1);
1510 #ifdef FEAT_EMACS_TAGS
1511 ebuf = alloc(LSIZE);
1512 #endif
1513 for (mtt = 0; mtt < MT_COUNT; ++mtt)
1514 ga_init2(&ga_match[mtt], (int)sizeof(struct match_found *), 100);
1516 /* check for out of memory situation */
1517 if (lbuf == NULL || tag_fname == NULL
1518 #ifdef FEAT_EMACS_TAGS
1519 || ebuf == NULL
1520 #endif
1522 goto findtag_end;
1524 #ifdef FEAT_CSCOPE
1525 STRCPY(tag_fname, "from cscope"); /* for error messages */
1526 #endif
1529 * Initialize a few variables
1531 if (help_only) /* want tags from help file */
1532 curbuf->b_help = TRUE; /* will be restored later */
1534 pats->len = (int)STRLEN(pat);
1535 #ifdef FEAT_MULTI_LANG
1536 if (curbuf->b_help)
1538 /* When "@ab" is specified use only the "ab" language, otherwise
1539 * search all languages. */
1540 if (pats->len > 3 && pat[pats->len - 3] == '@'
1541 && ASCII_ISALPHA(pat[pats->len - 2])
1542 && ASCII_ISALPHA(pat[pats->len - 1]))
1544 saved_pat = vim_strnsave(pat, pats->len - 3);
1545 if (saved_pat != NULL)
1547 help_lang_find = &pat[pats->len - 2];
1548 pats->pat = saved_pat;
1549 pats->len -= 3;
1553 #endif
1554 if (p_tl != 0 && pats->len > p_tl) /* adjust for 'taglength' */
1555 pats->len = p_tl;
1557 prepare_pats(pats, has_re);
1559 #ifdef FEAT_TAG_BINS
1560 /* This is only to avoid a compiler warning for using search_info
1561 * uninitialised. */
1562 vim_memset(&search_info, 0, (size_t)1);
1563 #endif
1565 if (use_tfu)
1567 retval = find_tfu_tags(pat, &ga_match[0], &match_count);
1568 goto findtag_end;
1572 * When finding a specified number of matches, first try with matching
1573 * case, so binary search can be used, and try ignore-case matches in a
1574 * second loop.
1575 * When finding all matches, 'tagbsearch' is off, or there is no fixed
1576 * string to look for, ignore case right away to avoid going though the
1577 * tags files twice.
1578 * When the tag file is case-fold sorted, it is either one or the other.
1579 * Only ignore case when TAG_NOIC not used or 'ignorecase' set.
1581 #ifdef FEAT_TAG_BINS
1582 pats->regmatch.rm_ic = ((p_ic || !noic)
1583 && (findall || pats->headlen == 0 || !p_tbs));
1584 for (round = 1; round <= 2; ++round)
1586 linear = (pats->headlen == 0 || !p_tbs || round == 2);
1587 #else
1588 pats->regmatch.rm_ic = (p_ic || !noic);
1589 #endif
1592 * Try tag file names from tags option one by one.
1594 for (first_file = TRUE;
1595 #ifdef FEAT_CSCOPE
1596 use_cscope ||
1597 #endif
1598 get_tagfname(&tn, first_file, tag_fname) == OK;
1599 first_file = FALSE)
1602 * A file that doesn't exist is silently ignored. Only when not a
1603 * single file is found, an error message is given (further on).
1605 #ifdef FEAT_CSCOPE
1606 if (use_cscope)
1607 fp = NULL; /* avoid GCC warning */
1608 else
1609 #endif
1611 #ifdef FEAT_MULTI_LANG
1612 if (curbuf->b_help)
1614 /* Prefer help tags according to 'helplang'. Put the
1615 * two-letter language name in help_lang[]. */
1616 i = (int)STRLEN(tag_fname);
1617 if (i > 3 && tag_fname[i - 3] == '-')
1618 STRCPY(help_lang, tag_fname + i - 2);
1619 else
1620 STRCPY(help_lang, "en");
1622 /* When searching for a specific language skip tags files
1623 * for other languages. */
1624 if (help_lang_find != NULL
1625 && STRICMP(help_lang, help_lang_find) != 0)
1626 continue;
1628 /* For CTRL-] in a help file prefer a match with the same
1629 * language. */
1630 if ((flags & TAG_KEEP_LANG)
1631 && help_lang_find == NULL
1632 && curbuf->b_fname != NULL
1633 && (i = (int)STRLEN(curbuf->b_fname)) > 4
1634 && curbuf->b_fname[i - 1] == 'x'
1635 && curbuf->b_fname[i - 4] == '.'
1636 && STRNICMP(curbuf->b_fname + i - 3, help_lang, 2) == 0)
1637 help_pri = 0;
1638 else
1640 help_pri = 1;
1641 for (s = p_hlg; *s != NUL; ++s)
1643 if (STRNICMP(s, help_lang, 2) == 0)
1644 break;
1645 ++help_pri;
1646 if ((s = vim_strchr(s, ',')) == NULL)
1647 break;
1649 if (s == NULL || *s == NUL)
1651 /* Language not in 'helplang': use last, prefer English,
1652 * unless found already. */
1653 ++help_pri;
1654 if (STRICMP(help_lang, "en") != 0)
1655 ++help_pri;
1659 #endif
1661 if ((fp = mch_fopen((char *)tag_fname, "r")) == NULL)
1662 continue;
1664 if (p_verbose >= 5)
1666 verbose_enter();
1667 smsg((char_u *)_("Searching tags file %s"), tag_fname);
1668 verbose_leave();
1671 did_open = TRUE; /* remember that we found at least one file */
1673 state = TS_START; /* we're at the start of the file */
1674 #ifdef FEAT_EMACS_TAGS
1675 is_etag = 0; /* default is: not emacs style */
1676 #endif
1679 * Read and parse the lines in the file one by one
1681 for (;;)
1683 line_breakcheck(); /* check for CTRL-C typed */
1684 #ifdef FEAT_INS_EXPAND
1685 if ((flags & TAG_INS_COMP)) /* Double brackets for gcc */
1686 ins_compl_check_keys(30);
1687 if (got_int || compl_interrupted)
1688 #else
1689 if (got_int)
1690 #endif
1692 stop_searching = TRUE;
1693 break;
1695 /* When mincount is TAG_MANY, stop when enough matches have been
1696 * found (for completion). */
1697 if (mincount == TAG_MANY && match_count >= TAG_MANY)
1699 stop_searching = TRUE;
1700 retval = OK;
1701 break;
1703 if (get_it_again)
1704 goto line_read_in;
1705 #ifdef FEAT_TAG_BINS
1707 * For binary search: compute the next offset to use.
1709 if (state == TS_BINARY)
1711 offset = search_info.low_offset + ((search_info.high_offset
1712 - search_info.low_offset) / 2);
1713 if (offset == search_info.curr_offset)
1714 break; /* End the binary search without a match. */
1715 else
1716 search_info.curr_offset = offset;
1720 * Skipping back (after a match during binary search).
1722 else if (state == TS_SKIP_BACK)
1724 search_info.curr_offset -= LSIZE * 2;
1725 if (search_info.curr_offset < 0)
1727 search_info.curr_offset = 0;
1728 rewind(fp);
1729 state = TS_STEP_FORWARD;
1734 * When jumping around in the file, first read a line to find the
1735 * start of the next line.
1737 if (state == TS_BINARY || state == TS_SKIP_BACK)
1739 /* Adjust the search file offset to the correct position */
1740 search_info.curr_offset_used = search_info.curr_offset;
1741 #ifdef HAVE_FSEEKO
1742 fseeko(fp, search_info.curr_offset, SEEK_SET);
1743 #else
1744 fseek(fp, (long)search_info.curr_offset, SEEK_SET);
1745 #endif
1746 eof = tag_fgets(lbuf, LSIZE, fp);
1747 if (!eof && search_info.curr_offset != 0)
1749 /* The explicit cast is to work around a bug in gcc 3.4.2
1750 * (repeated below). */
1751 search_info.curr_offset = ftell(fp);
1752 if (search_info.curr_offset == search_info.high_offset)
1754 /* oops, gone a bit too far; try from low offset */
1755 #ifdef HAVE_FSEEKO
1756 fseeko(fp, search_info.low_offset, SEEK_SET);
1757 #else
1758 fseek(fp, (long)search_info.low_offset, SEEK_SET);
1759 #endif
1760 search_info.curr_offset = search_info.low_offset;
1762 eof = tag_fgets(lbuf, LSIZE, fp);
1764 /* skip empty and blank lines */
1765 while (!eof && vim_isblankline(lbuf))
1767 search_info.curr_offset = ftell(fp);
1768 eof = tag_fgets(lbuf, LSIZE, fp);
1770 if (eof)
1772 /* Hit end of file. Skip backwards. */
1773 state = TS_SKIP_BACK;
1774 search_info.match_offset = ftell(fp);
1775 search_info.curr_offset = search_info.curr_offset_used;
1776 continue;
1781 * Not jumping around in the file: Read the next line.
1783 else
1784 #endif
1786 /* skip empty and blank lines */
1789 #ifdef FEAT_CSCOPE
1790 if (use_cscope)
1791 eof = cs_fgets(lbuf, LSIZE);
1792 else
1793 #endif
1794 eof = tag_fgets(lbuf, LSIZE, fp);
1795 } while (!eof && vim_isblankline(lbuf));
1797 if (eof)
1799 #ifdef FEAT_EMACS_TAGS
1800 if (incstack_idx) /* this was an included file */
1802 --incstack_idx;
1803 fclose(fp); /* end of this file ... */
1804 fp = incstack[incstack_idx].fp;
1805 STRCPY(tag_fname, incstack[incstack_idx].etag_fname);
1806 vim_free(incstack[incstack_idx].etag_fname);
1807 is_etag = 1; /* (only etags can include) */
1808 continue; /* ... continue with parent file */
1810 else
1811 #endif
1812 break; /* end of file */
1815 line_read_in:
1817 #ifdef FEAT_EMACS_TAGS
1819 * Emacs tags line with CTRL-L: New file name on next line.
1820 * The file name is followed by a ','.
1822 if (*lbuf == Ctrl_L) /* remember etag file name in ebuf */
1824 is_etag = 1; /* in case at the start */
1825 state = TS_LINEAR;
1826 if (!tag_fgets(ebuf, LSIZE, fp))
1828 for (p = ebuf; *p && *p != ','; p++)
1830 *p = NUL;
1833 * atoi(p+1) is the number of bytes before the next ^L
1834 * unless it is an include statement.
1836 if (STRNCMP(p + 1, "include", 7) == 0
1837 && incstack_idx < INCSTACK_SIZE)
1839 /* Save current "fp" and "tag_fname" in the stack. */
1840 if ((incstack[incstack_idx].etag_fname =
1841 vim_strsave(tag_fname)) != NULL)
1843 char_u *fullpath_ebuf;
1845 incstack[incstack_idx].fp = fp;
1846 fp = NULL;
1848 /* Figure out "tag_fname" and "fp" to use for
1849 * included file. */
1850 fullpath_ebuf = expand_tag_fname(ebuf,
1851 tag_fname, FALSE);
1852 if (fullpath_ebuf != NULL)
1854 fp = mch_fopen((char *)fullpath_ebuf, "r");
1855 if (fp != NULL)
1857 if (STRLEN(fullpath_ebuf) > LSIZE)
1858 EMSG2(_("E430: Tag file path truncated for %s\n"), ebuf);
1859 vim_strncpy(tag_fname, fullpath_ebuf,
1860 MAXPATHL);
1861 ++incstack_idx;
1862 is_etag = 0; /* we can include anything */
1864 vim_free(fullpath_ebuf);
1866 if (fp == NULL)
1868 /* Can't open the included file, skip it and
1869 * restore old value of "fp". */
1870 fp = incstack[incstack_idx].fp;
1871 vim_free(incstack[incstack_idx].etag_fname);
1876 continue;
1878 #endif
1881 * When still at the start of the file, check for Emacs tags file
1882 * format, and for "not sorted" flag.
1884 if (state == TS_START)
1886 #ifdef FEAT_TAG_BINS
1888 * When there is no tag head, or ignoring case, need to do a
1889 * linear search.
1890 * When no "!_TAG_" is found, default to binary search. If
1891 * the tag file isn't sorted, the second loop will find it.
1892 * When "!_TAG_FILE_SORTED" found: start binary search if
1893 * flag set.
1894 * For cscope, it's always linear.
1896 # ifdef FEAT_CSCOPE
1897 if (linear || use_cscope)
1898 # else
1899 if (linear)
1900 # endif
1901 state = TS_LINEAR;
1902 else if (STRNCMP(lbuf, "!_TAG_", 6) > 0)
1903 state = TS_BINARY;
1904 else if (STRNCMP(lbuf, "!_TAG_FILE_SORTED\t", 18) == 0)
1906 /* Check sorted flag */
1907 if (lbuf[18] == '1')
1908 state = TS_BINARY;
1909 else if (lbuf[18] == '2')
1911 state = TS_BINARY;
1912 sortic = TRUE;
1913 pats->regmatch.rm_ic = (p_ic || !noic);
1915 else
1916 state = TS_LINEAR;
1919 if (state == TS_BINARY && pats->regmatch.rm_ic && !sortic)
1921 /* binary search won't work for ignoring case, use linear
1922 * search. */
1923 linear = TRUE;
1924 state = TS_LINEAR;
1926 #else
1927 state = TS_LINEAR;
1928 #endif
1930 #ifdef FEAT_TAG_BINS
1932 * When starting a binary search, get the size of the file and
1933 * compute the first offset.
1935 if (state == TS_BINARY)
1937 /* Get the tag file size (don't use mch_fstat(), it's not
1938 * portable). */
1939 if ((filesize = lseek(fileno(fp),
1940 (off_t)0L, SEEK_END)) <= 0)
1941 state = TS_LINEAR;
1942 else
1944 lseek(fileno(fp), (off_t)0L, SEEK_SET);
1946 /* Calculate the first read offset in the file. Start
1947 * the search in the middle of the file. */
1948 search_info.low_offset = 0;
1949 search_info.low_char = 0;
1950 search_info.high_offset = filesize;
1951 search_info.curr_offset = 0;
1952 search_info.high_char = 0xff;
1954 continue;
1956 #endif
1959 #ifdef FEAT_MBYTE
1960 if (lbuf[0] == '!' && pats == &orgpat
1961 && STRNCMP(lbuf, "!_TAG_FILE_ENCODING\t", 20) == 0)
1963 /* Convert the search pattern from 'encoding' to the
1964 * specified encoding. */
1965 for (p = lbuf + 20; *p > ' ' && *p < 127; ++p)
1967 *p = NUL;
1968 convert_setup(&vimconv, p_enc, lbuf + 20);
1969 if (vimconv.vc_type != CONV_NONE)
1971 convpat.pat = string_convert(&vimconv, pats->pat, NULL);
1972 if (convpat.pat != NULL)
1974 pats = &convpat;
1975 pats->len = (int)STRLEN(pats->pat);
1976 prepare_pats(pats, has_re);
1977 pats->regmatch.rm_ic = orgpat.regmatch.rm_ic;
1981 /* Prepare for converting a match the other way around. */
1982 convert_setup(&vimconv, lbuf + 20, p_enc);
1983 continue;
1985 #endif
1988 * Figure out where the different strings are in this line.
1989 * For "normal" tags: Do a quick check if the tag matches.
1990 * This speeds up tag searching a lot!
1992 if (pats->headlen
1993 #ifdef FEAT_EMACS_TAGS
1994 && !is_etag
1995 #endif
1998 tagp.tagname = lbuf;
1999 #ifdef FEAT_TAG_ANYWHITE
2000 tagp.tagname_end = skiptowhite(lbuf);
2001 if (*tagp.tagname_end == NUL) /* corrupted tag line */
2002 #else
2003 tagp.tagname_end = vim_strchr(lbuf, TAB);
2004 if (tagp.tagname_end == NULL) /* corrupted tag line */
2005 #endif
2007 line_error = TRUE;
2008 break;
2011 #ifdef FEAT_TAG_OLDSTATIC
2013 * Check for old style static tag: "file:tag file .."
2015 tagp.fname = NULL;
2016 for (p = lbuf; p < tagp.tagname_end; ++p)
2018 if (*p == ':')
2020 if (tagp.fname == NULL)
2021 #ifdef FEAT_TAG_ANYWHITE
2022 tagp.fname = skipwhite(tagp.tagname_end);
2023 #else
2024 tagp.fname = tagp.tagname_end + 1;
2025 #endif
2026 if ( fnamencmp(lbuf, tagp.fname, p - lbuf) == 0
2027 #ifdef FEAT_TAG_ANYWHITE
2028 && vim_iswhite(tagp.fname[p - lbuf])
2029 #else
2030 && tagp.fname[p - lbuf] == TAB
2031 #endif
2034 /* found one */
2035 tagp.tagname = p + 1;
2036 break;
2040 #endif
2043 * Skip this line if the length of the tag is different and
2044 * there is no regexp, or the tag is too short.
2046 cmplen = (int)(tagp.tagname_end - tagp.tagname);
2047 if (p_tl != 0 && cmplen > p_tl) /* adjust for 'taglength' */
2048 cmplen = p_tl;
2049 if (has_re && pats->headlen < cmplen)
2050 cmplen = pats->headlen;
2051 else if (state == TS_LINEAR && pats->headlen != cmplen)
2052 continue;
2054 #ifdef FEAT_TAG_BINS
2055 if (state == TS_BINARY)
2058 * Simplistic check for unsorted tags file.
2060 i = (int)tagp.tagname[0];
2061 if (sortic)
2062 i = (int)TOUPPER_ASC(tagp.tagname[0]);
2063 if (i < search_info.low_char || i > search_info.high_char)
2064 sort_error = TRUE;
2067 * Compare the current tag with the searched tag.
2069 if (sortic)
2070 tagcmp = tag_strnicmp(tagp.tagname, pats->head,
2071 (size_t)cmplen);
2072 else
2073 tagcmp = STRNCMP(tagp.tagname, pats->head, cmplen);
2076 * A match with a shorter tag means to search forward.
2077 * A match with a longer tag means to search backward.
2079 if (tagcmp == 0)
2081 if (cmplen < pats->headlen)
2082 tagcmp = -1;
2083 else if (cmplen > pats->headlen)
2084 tagcmp = 1;
2087 if (tagcmp == 0)
2089 /* We've located the tag, now skip back and search
2090 * forward until the first matching tag is found.
2092 state = TS_SKIP_BACK;
2093 search_info.match_offset = search_info.curr_offset;
2094 continue;
2096 if (tagcmp < 0)
2098 search_info.curr_offset = ftell(fp);
2099 if (search_info.curr_offset < search_info.high_offset)
2101 search_info.low_offset = search_info.curr_offset;
2102 if (sortic)
2103 search_info.low_char =
2104 TOUPPER_ASC(tagp.tagname[0]);
2105 else
2106 search_info.low_char = tagp.tagname[0];
2107 continue;
2110 if (tagcmp > 0
2111 && search_info.curr_offset != search_info.high_offset)
2113 search_info.high_offset = search_info.curr_offset;
2114 if (sortic)
2115 search_info.high_char =
2116 TOUPPER_ASC(tagp.tagname[0]);
2117 else
2118 search_info.high_char = tagp.tagname[0];
2119 continue;
2122 /* No match yet and are at the end of the binary search. */
2123 break;
2125 else if (state == TS_SKIP_BACK)
2127 if (MB_STRNICMP(tagp.tagname, pats->head, cmplen) != 0)
2128 state = TS_STEP_FORWARD;
2129 else
2130 /* Have to skip back more. Restore the curr_offset
2131 * used, otherwise we get stuck at a long line. */
2132 search_info.curr_offset = search_info.curr_offset_used;
2133 continue;
2135 else if (state == TS_STEP_FORWARD)
2137 if (MB_STRNICMP(tagp.tagname, pats->head, cmplen) != 0)
2139 if ((off_t)ftell(fp) > search_info.match_offset)
2140 break; /* past last match */
2141 else
2142 continue; /* before first match */
2145 else
2146 #endif
2147 /* skip this match if it can't match */
2148 if (MB_STRNICMP(tagp.tagname, pats->head, cmplen) != 0)
2149 continue;
2152 * Can be a matching tag, isolate the file name and command.
2154 #ifdef FEAT_TAG_OLDSTATIC
2155 if (tagp.fname == NULL)
2156 #endif
2157 #ifdef FEAT_TAG_ANYWHITE
2158 tagp.fname = skipwhite(tagp.tagname_end);
2159 #else
2160 tagp.fname = tagp.tagname_end + 1;
2161 #endif
2162 #ifdef FEAT_TAG_ANYWHITE
2163 tagp.fname_end = skiptowhite(tagp.fname);
2164 tagp.command = skipwhite(tagp.fname_end);
2165 if (*tagp.command == NUL)
2166 #else
2167 tagp.fname_end = vim_strchr(tagp.fname, TAB);
2168 tagp.command = tagp.fname_end + 1;
2169 if (tagp.fname_end == NULL)
2170 #endif
2171 i = FAIL;
2172 else
2173 i = OK;
2175 else
2176 i = parse_tag_line(lbuf,
2177 #ifdef FEAT_EMACS_TAGS
2178 is_etag,
2179 #endif
2180 &tagp);
2181 if (i == FAIL)
2183 line_error = TRUE;
2184 break;
2187 #ifdef FEAT_EMACS_TAGS
2188 if (is_etag)
2189 tagp.fname = ebuf;
2190 #endif
2192 * First try matching with the pattern literally (also when it is
2193 * a regexp).
2195 cmplen = (int)(tagp.tagname_end - tagp.tagname);
2196 if (p_tl != 0 && cmplen > p_tl) /* adjust for 'taglength' */
2197 cmplen = p_tl;
2198 /* if tag length does not match, don't try comparing */
2199 if (pats->len != cmplen)
2200 match = FALSE;
2201 else
2203 if (pats->regmatch.rm_ic)
2205 match = (MB_STRNICMP(tagp.tagname, pats->pat, cmplen) == 0);
2206 if (match)
2207 match_no_ic = (STRNCMP(tagp.tagname, pats->pat,
2208 cmplen) == 0);
2210 else
2211 match = (STRNCMP(tagp.tagname, pats->pat, cmplen) == 0);
2215 * Has a regexp: Also find tags matching regexp.
2217 match_re = FALSE;
2218 if (!match && pats->regmatch.regprog != NULL)
2220 int cc;
2222 cc = *tagp.tagname_end;
2223 *tagp.tagname_end = NUL;
2224 match = vim_regexec(&pats->regmatch, tagp.tagname, (colnr_T)0);
2225 if (match)
2227 matchoff = (int)(pats->regmatch.startp[0] - tagp.tagname);
2228 if (pats->regmatch.rm_ic)
2230 pats->regmatch.rm_ic = FALSE;
2231 match_no_ic = vim_regexec(&pats->regmatch, tagp.tagname,
2232 (colnr_T)0);
2233 pats->regmatch.rm_ic = TRUE;
2236 *tagp.tagname_end = cc;
2237 match_re = TRUE;
2241 * If a match is found, add it to ga_match[].
2243 if (match)
2245 #ifdef FEAT_CSCOPE
2246 if (use_cscope)
2248 /* Don't change the ordering, always use the same table. */
2249 mtt = MT_GL_OTH;
2251 else
2252 #endif
2254 /* Decide in which array to store this match. */
2255 is_current = test_for_current(
2256 #ifdef FEAT_EMACS_TAGS
2257 is_etag,
2258 #endif
2259 tagp.fname, tagp.fname_end, tag_fname,
2260 buf_ffname);
2261 #ifdef FEAT_EMACS_TAGS
2262 is_static = FALSE;
2263 if (!is_etag) /* emacs tags are never static */
2264 #endif
2266 #ifdef FEAT_TAG_OLDSTATIC
2267 if (tagp.tagname != lbuf)
2268 is_static = TRUE; /* detected static tag before */
2269 else
2270 #endif
2271 is_static = test_for_static(&tagp);
2274 /* decide in which of the sixteen tables to store this
2275 * match */
2276 if (is_static)
2278 if (is_current)
2279 mtt = MT_ST_CUR;
2280 else
2281 mtt = MT_ST_OTH;
2283 else
2285 if (is_current)
2286 mtt = MT_GL_CUR;
2287 else
2288 mtt = MT_GL_OTH;
2290 if (pats->regmatch.rm_ic && !match_no_ic)
2291 mtt += MT_IC_OFF;
2292 if (match_re)
2293 mtt += MT_RE_OFF;
2297 * Add the found match in ga_match[mtt], avoiding duplicates.
2298 * Store the info we need later, which depends on the kind of
2299 * tags we are dealing with.
2301 if (ga_grow(&ga_match[mtt], 1) == OK)
2303 #ifdef FEAT_MBYTE
2304 char_u *conv_line = NULL;
2305 char_u *lbuf_line = lbuf;
2307 if (vimconv.vc_type != CONV_NONE)
2309 /* Convert the tag line from the encoding of the tags
2310 * file to 'encoding'. Then parse the line again. */
2311 conv_line = string_convert(&vimconv, lbuf, NULL);
2312 if (conv_line != NULL)
2314 if (parse_tag_line(conv_line,
2315 #ifdef FEAT_EMACS_TAGS
2316 is_etag,
2317 #endif
2318 &tagp) == OK)
2319 lbuf_line = conv_line;
2320 else
2321 /* doesn't work, go back to unconverted line. */
2322 (void)parse_tag_line(lbuf,
2323 #ifdef FEAT_EMACS_TAGS
2324 is_etag,
2325 #endif
2326 &tagp);
2329 #else
2330 # define lbuf_line lbuf
2331 #endif
2332 if (help_only)
2334 #ifdef FEAT_MULTI_LANG
2335 # define ML_EXTRA 3
2336 #else
2337 # define ML_EXTRA 0
2338 #endif
2340 * Append the help-heuristic number after the
2341 * tagname, for sorting it later.
2343 *tagp.tagname_end = NUL;
2344 len = (int)(tagp.tagname_end - tagp.tagname);
2345 mfp = (struct match_found *)
2346 alloc((int)sizeof(struct match_found) + len
2347 + 10 + ML_EXTRA);
2348 if (mfp != NULL)
2350 /* "len" includes the language and the NUL, but
2351 * not the priority. */
2352 mfp->len = len + ML_EXTRA + 1;
2353 #define ML_HELP_LEN 6
2354 p = mfp->match;
2355 STRCPY(p, tagp.tagname);
2356 #ifdef FEAT_MULTI_LANG
2357 p[len] = '@';
2358 STRCPY(p + len + 1, help_lang);
2359 #endif
2360 sprintf((char *)p + len + 1 + ML_EXTRA, "%06d",
2361 help_heuristic(tagp.tagname,
2362 match_re ? matchoff : 0, !match_no_ic)
2363 #ifdef FEAT_MULTI_LANG
2364 + help_pri
2365 #endif
2368 *tagp.tagname_end = TAB;
2370 else if (name_only)
2372 if (get_it_again)
2374 char_u *temp_end = tagp.command;
2376 if (*temp_end == '/')
2377 while (*temp_end && *temp_end != '\r'
2378 && *temp_end != '\n'
2379 && *temp_end != '$')
2380 temp_end++;
2382 if (tagp.command + 2 < temp_end)
2384 len = (int)(temp_end - tagp.command - 2);
2385 mfp = (struct match_found *)alloc(
2386 (int)sizeof(struct match_found) + len);
2387 if (mfp != NULL)
2389 mfp->len = len + 1; /* include the NUL */
2390 p = mfp->match;
2391 vim_strncpy(p, tagp.command + 2, len);
2394 else
2395 mfp = NULL;
2396 get_it_again = FALSE;
2398 else
2400 len = (int)(tagp.tagname_end - tagp.tagname);
2401 mfp = (struct match_found *)alloc(
2402 (int)sizeof(struct match_found) + len);
2403 if (mfp != NULL)
2405 mfp->len = len + 1; /* include the NUL */
2406 p = mfp->match;
2407 vim_strncpy(p, tagp.tagname, len);
2410 /* if wanted, re-read line to get long form too */
2411 if (State & INSERT)
2412 get_it_again = p_sft;
2415 else
2417 /* Save the tag in a buffer.
2418 * Emacs tag: <mtt><tag_fname><NUL><ebuf><NUL><lbuf>
2419 * other tag: <mtt><tag_fname><NUL><NUL><lbuf>
2420 * without Emacs tags: <mtt><tag_fname><NUL><lbuf>
2422 len = (int)STRLEN(tag_fname)
2423 + (int)STRLEN(lbuf_line) + 3;
2424 #ifdef FEAT_EMACS_TAGS
2425 if (is_etag)
2426 len += (int)STRLEN(ebuf) + 1;
2427 else
2428 ++len;
2429 #endif
2430 mfp = (struct match_found *)alloc(
2431 (int)sizeof(struct match_found) + len);
2432 if (mfp != NULL)
2434 mfp->len = len;
2435 p = mfp->match;
2436 p[0] = mtt;
2437 STRCPY(p + 1, tag_fname);
2438 #ifdef BACKSLASH_IN_FILENAME
2439 /* Ignore differences in slashes, avoid adding
2440 * both path/file and path\file. */
2441 slash_adjust(p + 1);
2442 #endif
2443 s = p + 1 + STRLEN(tag_fname) + 1;
2444 #ifdef FEAT_EMACS_TAGS
2445 if (is_etag)
2447 STRCPY(s, ebuf);
2448 s += STRLEN(ebuf) + 1;
2450 else
2451 *s++ = NUL;
2452 #endif
2453 STRCPY(s, lbuf_line);
2457 if (mfp != NULL)
2460 * Don't add identical matches.
2461 * This can take a lot of time when finding many
2462 * matches, check for CTRL-C now and then.
2463 * Add all cscope tags, because they are all listed.
2465 #ifdef FEAT_CSCOPE
2466 if (use_cscope)
2467 i = -1;
2468 else
2469 #endif
2470 for (i = ga_match[mtt].ga_len; --i >= 0 && !got_int; )
2472 mfp2 = ((struct match_found **)
2473 (ga_match[mtt].ga_data))[i];
2474 if (mfp2->len == mfp->len
2475 && vim_memcmp(mfp2->match, mfp->match,
2476 (size_t)mfp->len) == 0)
2477 break;
2478 line_breakcheck();
2480 if (i < 0)
2482 ((struct match_found **)(ga_match[mtt].ga_data))
2483 [ga_match[mtt].ga_len++] = mfp;
2484 ++match_count;
2486 else
2487 vim_free(mfp);
2489 #ifdef FEAT_MBYTE
2490 /* Note: this makes the values in "tagp" invalid! */
2491 vim_free(conv_line);
2492 #endif
2494 else /* Out of memory! Just forget about the rest. */
2496 retval = OK;
2497 stop_searching = TRUE;
2498 break;
2501 #ifdef FEAT_CSCOPE
2502 if (use_cscope && eof)
2503 break;
2504 #endif
2505 } /* forever */
2507 if (line_error)
2509 EMSG2(_("E431: Format error in tags file \"%s\""), tag_fname);
2510 #ifdef FEAT_CSCOPE
2511 if (!use_cscope)
2512 #endif
2513 EMSGN(_("Before byte %ld"), (long)ftell(fp));
2514 stop_searching = TRUE;
2515 line_error = FALSE;
2518 #ifdef FEAT_CSCOPE
2519 if (!use_cscope)
2520 #endif
2521 fclose(fp);
2522 #ifdef FEAT_EMACS_TAGS
2523 while (incstack_idx)
2525 --incstack_idx;
2526 fclose(incstack[incstack_idx].fp);
2527 vim_free(incstack[incstack_idx].etag_fname);
2529 #endif
2530 #ifdef FEAT_MBYTE
2531 if (pats == &convpat)
2533 /* Go back from converted pattern to original pattern. */
2534 vim_free(pats->pat);
2535 vim_free(pats->regmatch.regprog);
2536 orgpat.regmatch.rm_ic = pats->regmatch.rm_ic;
2537 pats = &orgpat;
2539 if (vimconv.vc_type != CONV_NONE)
2540 convert_setup(&vimconv, NULL, NULL);
2541 #endif
2543 #ifdef FEAT_TAG_BINS
2544 if (sort_error)
2546 EMSG2(_("E432: Tags file not sorted: %s"), tag_fname);
2547 sort_error = FALSE;
2549 #endif
2552 * Stop searching if sufficient tags have been found.
2554 if (match_count >= mincount)
2556 retval = OK;
2557 stop_searching = TRUE;
2560 #ifdef FEAT_CSCOPE
2561 if (stop_searching || use_cscope)
2562 #else
2563 if (stop_searching)
2564 #endif
2565 break;
2567 } /* end of for-each-file loop */
2569 #ifdef FEAT_CSCOPE
2570 if (!use_cscope)
2571 #endif
2572 tagname_free(&tn);
2574 #ifdef FEAT_TAG_BINS
2575 /* stop searching when already did a linear search, or when TAG_NOIC
2576 * used, and 'ignorecase' not set or already did case-ignore search */
2577 if (stop_searching || linear || (!p_ic && noic) || pats->regmatch.rm_ic)
2578 break;
2579 # ifdef FEAT_CSCOPE
2580 if (use_cscope)
2581 break;
2582 # endif
2583 pats->regmatch.rm_ic = TRUE; /* try another time while ignoring case */
2585 #endif
2587 if (!stop_searching)
2589 if (!did_open && verbose) /* never opened any tags file */
2590 EMSG(_("E433: No tags file"));
2591 retval = OK; /* It's OK even when no tag found */
2594 findtag_end:
2595 vim_free(lbuf);
2596 vim_free(pats->regmatch.regprog);
2597 vim_free(tag_fname);
2598 #ifdef FEAT_EMACS_TAGS
2599 vim_free(ebuf);
2600 #endif
2603 * Move the matches from the ga_match[] arrays into one list of
2604 * matches. When retval == FAIL, free the matches.
2606 if (retval == FAIL)
2607 match_count = 0;
2609 if (match_count > 0)
2610 matches = (char_u **)lalloc((long_u)(match_count * sizeof(char_u *)),
2611 TRUE);
2612 else
2613 matches = NULL;
2614 match_count = 0;
2615 for (mtt = 0; mtt < MT_COUNT; ++mtt)
2617 for (i = 0; i < ga_match[mtt].ga_len; ++i)
2619 mfp = ((struct match_found **)(ga_match[mtt].ga_data))[i];
2620 if (matches == NULL)
2621 vim_free(mfp);
2622 else
2624 /* To avoid allocating memory again we turn the struct
2625 * match_found into a string. For help the priority was not
2626 * included in the length. */
2627 mch_memmove(mfp, mfp->match,
2628 (size_t)(mfp->len + (help_only ? ML_HELP_LEN : 0)));
2629 matches[match_count++] = (char_u *)mfp;
2632 ga_clear(&ga_match[mtt]);
2635 *matchesp = matches;
2636 *num_matches = match_count;
2638 curbuf->b_help = help_save;
2639 #ifdef FEAT_MULTI_LANG
2640 vim_free(saved_pat);
2641 #endif
2643 return retval;
2646 static garray_T tag_fnames = GA_EMPTY;
2647 static void found_tagfile_cb __ARGS((char_u *fname, void *cookie));
2650 * Callback function for finding all "tags" and "tags-??" files in
2651 * 'runtimepath' doc directories.
2653 static void
2654 found_tagfile_cb(fname, cookie)
2655 char_u *fname;
2656 void *cookie UNUSED;
2658 if (ga_grow(&tag_fnames, 1) == OK)
2659 ((char_u **)(tag_fnames.ga_data))[tag_fnames.ga_len++] =
2660 vim_strsave(fname);
2663 #if defined(EXITFREE) || defined(PROTO)
2664 void
2665 free_tag_stuff()
2667 ga_clear_strings(&tag_fnames);
2668 do_tag(NULL, DT_FREE, 0, 0, 0);
2669 tag_freematch();
2671 # if defined(FEAT_WINDOWS) && defined(FEAT_QUICKFIX)
2672 if (ptag_entry.tagname)
2674 vim_free(ptag_entry.tagname);
2675 ptag_entry.tagname = NULL;
2677 # endif
2679 #endif
2682 * Get the next name of a tag file from the tag file list.
2683 * For help files, use "tags" file only.
2685 * Return FAIL if no more tag file names, OK otherwise.
2688 get_tagfname(tnp, first, buf)
2689 tagname_T *tnp; /* holds status info */
2690 int first; /* TRUE when first file name is wanted */
2691 char_u *buf; /* pointer to buffer of MAXPATHL chars */
2693 char_u *fname = NULL;
2694 char_u *r_ptr;
2696 if (first)
2697 vim_memset(tnp, 0, sizeof(tagname_T));
2699 if (curbuf->b_help)
2702 * For help files it's done in a completely different way:
2703 * Find "doc/tags" and "doc/tags-??" in all directories in
2704 * 'runtimepath'.
2706 if (first)
2708 ga_clear_strings(&tag_fnames);
2709 ga_init2(&tag_fnames, (int)sizeof(char_u *), 10);
2710 do_in_runtimepath((char_u *)
2711 #ifdef FEAT_MULTI_LANG
2712 # ifdef VMS
2713 /* Functions decc$to_vms() and decc$translate_vms() crash
2714 * on some VMS systems with wildcards "??". Seems ECO
2715 * patches do fix the problem in C RTL, but we can't use
2716 * an #ifdef for that. */
2717 "doc/tags doc/tags-*"
2718 # else
2719 "doc/tags doc/tags-??"
2720 # endif
2721 #else
2722 "doc/tags"
2723 #endif
2724 , TRUE, found_tagfile_cb, NULL);
2727 if (tnp->tn_hf_idx >= tag_fnames.ga_len)
2729 /* Not found in 'runtimepath', use 'helpfile', if it exists and
2730 * wasn't used yet, replacing "help.txt" with "tags". */
2731 if (tnp->tn_hf_idx > tag_fnames.ga_len || *p_hf == NUL)
2732 return FAIL;
2733 ++tnp->tn_hf_idx;
2734 STRCPY(buf, p_hf);
2735 STRCPY(gettail(buf), "tags");
2737 else
2738 vim_strncpy(buf, ((char_u **)(tag_fnames.ga_data))[
2739 tnp->tn_hf_idx++], MAXPATHL - 1);
2740 return OK;
2743 if (first)
2745 /* Init. We make a copy of 'tags', because autocommands may change
2746 * the value without notifying us. */
2747 tnp->tn_tags = vim_strsave((*curbuf->b_p_tags != NUL)
2748 ? curbuf->b_p_tags : p_tags);
2749 if (tnp->tn_tags == NULL)
2750 return FAIL;
2751 tnp->tn_np = tnp->tn_tags;
2755 * Loop until we have found a file name that can be used.
2756 * There are two states:
2757 * tnp->tn_did_filefind_init == FALSE: setup for next part in 'tags'.
2758 * tnp->tn_did_filefind_init == TRUE: find next file in this part.
2760 for (;;)
2762 if (tnp->tn_did_filefind_init)
2764 fname = vim_findfile(tnp->tn_search_ctx);
2765 if (fname != NULL)
2766 break;
2768 tnp->tn_did_filefind_init = FALSE;
2770 else
2772 char_u *filename = NULL;
2774 /* Stop when used all parts of 'tags'. */
2775 if (*tnp->tn_np == NUL)
2777 vim_findfile_cleanup(tnp->tn_search_ctx);
2778 tnp->tn_search_ctx = NULL;
2779 return FAIL;
2783 * Copy next file name into buf.
2785 buf[0] = NUL;
2786 (void)copy_option_part(&tnp->tn_np, buf, MAXPATHL - 1, " ,");
2788 #ifdef FEAT_PATH_EXTRA
2789 r_ptr = vim_findfile_stopdir(buf);
2790 #else
2791 r_ptr = NULL;
2792 #endif
2793 /* move the filename one char forward and truncate the
2794 * filepath with a NUL */
2795 filename = gettail(buf);
2796 STRMOVE(filename + 1, filename);
2797 *filename++ = NUL;
2799 tnp->tn_search_ctx = vim_findfile_init(buf, filename,
2800 r_ptr, 100,
2801 FALSE, /* don't free visited list */
2802 FINDFILE_FILE, /* we search for a file */
2803 tnp->tn_search_ctx, TRUE, curbuf->b_ffname);
2804 if (tnp->tn_search_ctx != NULL)
2805 tnp->tn_did_filefind_init = TRUE;
2809 STRCPY(buf, fname);
2810 vim_free(fname);
2811 return OK;
2815 * Free the contents of a tagname_T that was filled by get_tagfname().
2817 void
2818 tagname_free(tnp)
2819 tagname_T *tnp;
2821 vim_free(tnp->tn_tags);
2822 vim_findfile_cleanup(tnp->tn_search_ctx);
2823 tnp->tn_search_ctx = NULL;
2824 ga_clear_strings(&tag_fnames);
2828 * Parse one line from the tags file. Find start/end of tag name, start/end of
2829 * file name and start of search pattern.
2831 * If is_etag is TRUE, tagp->fname and tagp->fname_end are not set.
2833 * Return FAIL if there is a format error in this line, OK otherwise.
2835 static int
2836 parse_tag_line(lbuf,
2837 #ifdef FEAT_EMACS_TAGS
2838 is_etag,
2839 #endif
2840 tagp)
2841 char_u *lbuf; /* line to be parsed */
2842 #ifdef FEAT_EMACS_TAGS
2843 int is_etag;
2844 #endif
2845 tagptrs_T *tagp;
2847 char_u *p;
2849 #ifdef FEAT_EMACS_TAGS
2850 char_u *p_7f;
2852 if (is_etag)
2855 * There are two formats for an emacs tag line:
2856 * 1: struct EnvBase ^?EnvBase^A139,4627
2857 * 2: #define ARPB_WILD_WORLD ^?153,5194
2859 p_7f = vim_strchr(lbuf, 0x7f);
2860 if (p_7f == NULL)
2862 etag_fail:
2863 if (vim_strchr(lbuf, '\n') == NULL)
2865 /* Truncated line. Ignore it. */
2866 if (p_verbose >= 5)
2868 verbose_enter();
2869 MSG(_("Ignoring long line in tags file"));
2870 verbose_leave();
2872 tagp->command = lbuf;
2873 tagp->tagname = lbuf;
2874 tagp->tagname_end = lbuf;
2875 return OK;
2877 return FAIL;
2880 /* Find ^A. If not found the line number is after the 0x7f */
2881 p = vim_strchr(p_7f, Ctrl_A);
2882 if (p == NULL)
2883 p = p_7f + 1;
2884 else
2885 ++p;
2887 if (!VIM_ISDIGIT(*p)) /* check for start of line number */
2888 goto etag_fail;
2889 tagp->command = p;
2892 if (p[-1] == Ctrl_A) /* first format: explicit tagname given */
2894 tagp->tagname = p_7f + 1;
2895 tagp->tagname_end = p - 1;
2897 else /* second format: isolate tagname */
2899 /* find end of tagname */
2900 for (p = p_7f - 1; !vim_iswordc(*p); --p)
2901 if (p == lbuf)
2902 goto etag_fail;
2903 tagp->tagname_end = p + 1;
2904 while (p >= lbuf && vim_iswordc(*p))
2905 --p;
2906 tagp->tagname = p + 1;
2909 else /* not an Emacs tag */
2911 #endif
2912 /* Isolate the tagname, from lbuf up to the first white */
2913 tagp->tagname = lbuf;
2914 #ifdef FEAT_TAG_ANYWHITE
2915 p = skiptowhite(lbuf);
2916 #else
2917 p = vim_strchr(lbuf, TAB);
2918 if (p == NULL)
2919 return FAIL;
2920 #endif
2921 tagp->tagname_end = p;
2923 /* Isolate file name, from first to second white space */
2924 #ifdef FEAT_TAG_ANYWHITE
2925 p = skipwhite(p);
2926 #else
2927 if (*p != NUL)
2928 ++p;
2929 #endif
2930 tagp->fname = p;
2931 #ifdef FEAT_TAG_ANYWHITE
2932 p = skiptowhite(p);
2933 #else
2934 p = vim_strchr(p, TAB);
2935 if (p == NULL)
2936 return FAIL;
2937 #endif
2938 tagp->fname_end = p;
2940 /* find start of search command, after second white space */
2941 #ifdef FEAT_TAG_ANYWHITE
2942 p = skipwhite(p);
2943 #else
2944 if (*p != NUL)
2945 ++p;
2946 #endif
2947 if (*p == NUL)
2948 return FAIL;
2949 tagp->command = p;
2950 #ifdef FEAT_EMACS_TAGS
2952 #endif
2954 return OK;
2958 * Check if tagname is a static tag
2960 * Static tags produced by the older ctags program have the format:
2961 * 'file:tag file /pattern'.
2962 * This is only recognized when both occurrence of 'file' are the same, to
2963 * avoid recognizing "string::string" or ":exit".
2965 * Static tags produced by the new ctags program have the format:
2966 * 'tag file /pattern/;"<Tab>file:' "
2968 * Return TRUE if it is a static tag and adjust *tagname to the real tag.
2969 * Return FALSE if it is not a static tag.
2971 static int
2972 test_for_static(tagp)
2973 tagptrs_T *tagp;
2975 char_u *p;
2977 #ifdef FEAT_TAG_OLDSTATIC
2978 int len;
2981 * Check for old style static tag: "file:tag file .."
2983 len = (int)(tagp->fname_end - tagp->fname);
2984 p = tagp->tagname + len;
2985 if ( p < tagp->tagname_end
2986 && *p == ':'
2987 && fnamencmp(tagp->tagname, tagp->fname, len) == 0)
2989 tagp->tagname = p + 1;
2990 return TRUE;
2992 #endif
2995 * Check for new style static tag ":...<Tab>file:[<Tab>...]"
2997 p = tagp->command;
2998 while ((p = vim_strchr(p, '\t')) != NULL)
3000 ++p;
3001 if (STRNCMP(p, "file:", 5) == 0)
3002 return TRUE;
3005 return FALSE;
3009 * Parse a line from a matching tag. Does not change the line itself.
3011 * The line that we get looks like this:
3012 * Emacs tag: <mtt><tag_fname><NUL><ebuf><NUL><lbuf>
3013 * other tag: <mtt><tag_fname><NUL><NUL><lbuf>
3014 * without Emacs tags: <mtt><tag_fname><NUL><lbuf>
3016 * Return OK or FAIL.
3018 static int
3019 parse_match(lbuf, tagp)
3020 char_u *lbuf; /* input: matching line */
3021 tagptrs_T *tagp; /* output: pointers into the line */
3023 int retval;
3024 char_u *p;
3025 char_u *pc, *pt;
3027 tagp->tag_fname = lbuf + 1;
3028 lbuf += STRLEN(tagp->tag_fname) + 2;
3029 #ifdef FEAT_EMACS_TAGS
3030 if (*lbuf)
3032 tagp->is_etag = TRUE;
3033 tagp->fname = lbuf;
3034 lbuf += STRLEN(lbuf);
3035 tagp->fname_end = lbuf++;
3037 else
3039 tagp->is_etag = FALSE;
3040 ++lbuf;
3042 #endif
3044 /* Find search pattern and the file name for non-etags. */
3045 retval = parse_tag_line(lbuf,
3046 #ifdef FEAT_EMACS_TAGS
3047 tagp->is_etag,
3048 #endif
3049 tagp);
3051 tagp->tagkind = NULL;
3052 tagp->command_end = NULL;
3054 if (retval == OK)
3056 /* Try to find a kind field: "kind:<kind>" or just "<kind>"*/
3057 p = tagp->command;
3058 if (find_extra(&p) == OK)
3060 tagp->command_end = p;
3061 p += 2; /* skip ";\"" */
3062 if (*p++ == TAB)
3063 while (ASCII_ISALPHA(*p))
3065 if (STRNCMP(p, "kind:", 5) == 0)
3067 tagp->tagkind = p + 5;
3068 break;
3070 pc = vim_strchr(p, ':');
3071 pt = vim_strchr(p, '\t');
3072 if (pc == NULL || (pt != NULL && pc > pt))
3074 tagp->tagkind = p;
3075 break;
3077 if (pt == NULL)
3078 break;
3079 p = pt + 1;
3082 if (tagp->tagkind != NULL)
3084 for (p = tagp->tagkind;
3085 *p && *p != '\t' && *p != '\r' && *p != '\n'; ++p)
3087 tagp->tagkind_end = p;
3090 return retval;
3094 * Find out the actual file name of a tag. Concatenate the tags file name
3095 * with the matching tag file name.
3096 * Returns an allocated string or NULL (out of memory).
3098 static char_u *
3099 tag_full_fname(tagp)
3100 tagptrs_T *tagp;
3102 char_u *fullname;
3103 int c;
3105 #ifdef FEAT_EMACS_TAGS
3106 if (tagp->is_etag)
3107 c = 0; /* to shut up GCC */
3108 else
3109 #endif
3111 c = *tagp->fname_end;
3112 *tagp->fname_end = NUL;
3114 fullname = expand_tag_fname(tagp->fname, tagp->tag_fname, FALSE);
3116 #ifdef FEAT_EMACS_TAGS
3117 if (!tagp->is_etag)
3118 #endif
3119 *tagp->fname_end = c;
3121 return fullname;
3125 * Jump to a tag that has been found in one of the tag files
3127 * returns OK for success, NOTAGFILE when file not found, FAIL otherwise.
3129 static int
3130 jumpto_tag(lbuf, forceit, keep_help)
3131 char_u *lbuf; /* line from the tags file for this tag */
3132 int forceit; /* :ta with ! */
3133 int keep_help; /* keep help flag (FALSE for cscope) */
3135 int save_secure;
3136 int save_magic;
3137 int save_p_ws, save_p_scs, save_p_ic;
3138 linenr_T save_lnum;
3139 int csave = 0;
3140 char_u *str;
3141 char_u *pbuf; /* search pattern buffer */
3142 char_u *pbuf_end;
3143 char_u *tofree_fname = NULL;
3144 char_u *fname;
3145 tagptrs_T tagp;
3146 int retval = FAIL;
3147 int getfile_result;
3148 int search_options;
3149 #ifdef FEAT_SEARCH_EXTRA
3150 int save_no_hlsearch;
3151 #endif
3152 #if defined(FEAT_WINDOWS) && defined(FEAT_QUICKFIX)
3153 win_T *curwin_save = NULL;
3154 #endif
3155 char_u *full_fname = NULL;
3156 #ifdef FEAT_FOLDING
3157 int old_KeyTyped = KeyTyped; /* getting the file may reset it */
3158 #endif
3160 pbuf = alloc(LSIZE);
3162 /* parse the match line into the tagp structure */
3163 if (pbuf == NULL || parse_match(lbuf, &tagp) == FAIL)
3165 tagp.fname_end = NULL;
3166 goto erret;
3169 /* truncate the file name, so it can be used as a string */
3170 csave = *tagp.fname_end;
3171 *tagp.fname_end = NUL;
3172 fname = tagp.fname;
3174 /* copy the command to pbuf[], remove trailing CR/NL */
3175 str = tagp.command;
3176 for (pbuf_end = pbuf; *str && *str != '\n' && *str != '\r'; )
3178 #ifdef FEAT_EMACS_TAGS
3179 if (tagp.is_etag && *str == ',')/* stop at ',' after line number */
3180 break;
3181 #endif
3182 *pbuf_end++ = *str++;
3184 *pbuf_end = NUL;
3186 #ifdef FEAT_EMACS_TAGS
3187 if (!tagp.is_etag)
3188 #endif
3191 * Remove the "<Tab>fieldname:value" stuff; we don't need it here.
3193 str = pbuf;
3194 if (find_extra(&str) == OK)
3196 pbuf_end = str;
3197 *pbuf_end = NUL;
3202 * Expand file name, when needed (for environment variables).
3203 * If 'tagrelative' option set, may change file name.
3205 fname = expand_tag_fname(fname, tagp.tag_fname, TRUE);
3206 if (fname == NULL)
3207 goto erret;
3208 tofree_fname = fname; /* free() it later */
3211 * Check if the file with the tag exists before abandoning the current
3212 * file. Also accept a file name for which there is a matching BufReadCmd
3213 * autocommand event (e.g., http://sys/file).
3215 if (mch_getperm(fname) < 0
3216 #ifdef FEAT_AUTOCMD
3217 && !has_autocmd(EVENT_BUFREADCMD, fname, NULL)
3218 #endif
3221 retval = NOTAGFILE;
3222 vim_free(nofile_fname);
3223 nofile_fname = vim_strsave(fname);
3224 if (nofile_fname == NULL)
3225 nofile_fname = empty_option;
3226 goto erret;
3229 ++RedrawingDisabled;
3231 #ifdef FEAT_GUI
3232 need_mouse_correct = TRUE;
3233 #endif
3235 #if defined(FEAT_WINDOWS) && defined(FEAT_QUICKFIX)
3236 if (g_do_tagpreview)
3238 postponed_split = 0; /* don't split again below */
3239 curwin_save = curwin; /* Save current window */
3242 * If we are reusing a window, we may change dir when
3243 * entering it (autocommands) so turn the tag filename
3244 * into a fullpath
3246 if (!curwin->w_p_pvw)
3248 full_fname = FullName_save(fname, FALSE);
3249 fname = full_fname;
3252 * Make the preview window the current window.
3253 * Open a preview window when needed.
3255 prepare_tagpreview(TRUE);
3259 /* If it was a CTRL-W CTRL-] command split window now. For ":tab tag"
3260 * open a new tab page. */
3261 if (postponed_split || cmdmod.tab != 0)
3263 win_split(postponed_split > 0 ? postponed_split : 0,
3264 postponed_split_flags);
3265 # ifdef FEAT_SCROLLBIND
3266 curwin->w_p_scb = FALSE;
3267 # endif
3269 #endif
3271 if (keep_help)
3273 /* A :ta from a help file will keep the b_help flag set. For ":ptag"
3274 * we need to use the flag from the window where we came from. */
3275 #if defined(FEAT_WINDOWS) && defined(FEAT_QUICKFIX)
3276 if (g_do_tagpreview)
3277 keep_help_flag = curwin_save->w_buffer->b_help;
3278 else
3279 #endif
3280 keep_help_flag = curbuf->b_help;
3282 getfile_result = getfile(0, fname, NULL, TRUE, (linenr_T)0, forceit);
3283 keep_help_flag = FALSE;
3285 if (getfile_result <= 0) /* got to the right file */
3287 curwin->w_set_curswant = TRUE;
3288 #ifdef FEAT_WINDOWS
3289 postponed_split = 0;
3290 #endif
3292 save_secure = secure;
3293 secure = 1;
3294 #ifdef HAVE_SANDBOX
3295 ++sandbox;
3296 #endif
3297 save_magic = p_magic;
3298 p_magic = FALSE; /* always execute with 'nomagic' */
3299 #ifdef FEAT_SEARCH_EXTRA
3300 /* Save value of no_hlsearch, jumping to a tag is not a real search */
3301 save_no_hlsearch = no_hlsearch;
3302 #endif
3305 * If 'cpoptions' contains 't', store the search pattern for the "n"
3306 * command. If 'cpoptions' does not contain 't', the search pattern
3307 * is not stored.
3309 if (vim_strchr(p_cpo, CPO_TAGPAT) != NULL)
3310 search_options = 0;
3311 else
3312 search_options = SEARCH_KEEP;
3315 * If the command is a search, try here.
3317 * Reset 'smartcase' for the search, since the search pattern was not
3318 * typed by the user.
3319 * Only use do_search() when there is a full search command, without
3320 * anything following.
3322 str = pbuf;
3323 if (pbuf[0] == '/' || pbuf[0] == '?')
3324 str = skip_regexp(pbuf + 1, pbuf[0], FALSE, NULL) + 1;
3325 if (str > pbuf_end - 1) /* search command with nothing following */
3327 save_p_ws = p_ws;
3328 save_p_ic = p_ic;
3329 save_p_scs = p_scs;
3330 p_ws = TRUE; /* need 'wrapscan' for backward searches */
3331 p_ic = FALSE; /* don't ignore case now */
3332 p_scs = FALSE;
3333 #if 0 /* disabled for now */
3334 #ifdef FEAT_CMDHIST
3335 /* put pattern in search history */
3336 add_to_history(HIST_SEARCH, pbuf + 1, TRUE, pbuf[0]);
3337 #endif
3338 #endif
3339 save_lnum = curwin->w_cursor.lnum;
3340 curwin->w_cursor.lnum = 0; /* start search before first line */
3341 if (do_search(NULL, pbuf[0], pbuf + 1, (long)1,
3342 search_options, NULL))
3343 retval = OK;
3344 else
3346 int found = 1;
3347 int cc;
3350 * try again, ignore case now
3352 p_ic = TRUE;
3353 if (!do_search(NULL, pbuf[0], pbuf + 1, (long)1,
3354 search_options, NULL))
3357 * Failed to find pattern, take a guess: "^func ("
3359 found = 2;
3360 (void)test_for_static(&tagp);
3361 cc = *tagp.tagname_end;
3362 *tagp.tagname_end = NUL;
3363 sprintf((char *)pbuf, "^%s\\s\\*(", tagp.tagname);
3364 if (!do_search(NULL, '/', pbuf, (long)1,
3365 search_options, NULL))
3367 /* Guess again: "^char * \<func (" */
3368 sprintf((char *)pbuf, "^\\[#a-zA-Z_]\\.\\*\\<%s\\s\\*(",
3369 tagp.tagname);
3370 if (!do_search(NULL, '/', pbuf, (long)1,
3371 search_options, NULL))
3372 found = 0;
3374 *tagp.tagname_end = cc;
3376 if (found == 0)
3378 EMSG(_("E434: Can't find tag pattern"));
3379 curwin->w_cursor.lnum = save_lnum;
3381 else
3384 * Only give a message when really guessed, not when 'ic'
3385 * is set and match found while ignoring case.
3387 if (found == 2 || !save_p_ic)
3389 MSG(_("E435: Couldn't find tag, just guessing!"));
3390 if (!msg_scrolled && msg_silent == 0)
3392 out_flush();
3393 ui_delay(1000L, TRUE);
3396 retval = OK;
3399 p_ws = save_p_ws;
3400 p_ic = save_p_ic;
3401 p_scs = save_p_scs;
3403 /* A search command may have positioned the cursor beyond the end
3404 * of the line. May need to correct that here. */
3405 check_cursor();
3407 else
3409 curwin->w_cursor.lnum = 1; /* start command in line 1 */
3410 do_cmdline_cmd(pbuf);
3411 retval = OK;
3415 * When the command has done something that is not allowed make sure
3416 * the error message can be seen.
3418 if (secure == 2)
3419 wait_return(TRUE);
3420 secure = save_secure;
3421 p_magic = save_magic;
3422 #ifdef HAVE_SANDBOX
3423 --sandbox;
3424 #endif
3425 #ifdef FEAT_SEARCH_EXTRA
3426 /* restore no_hlsearch when keeping the old search pattern */
3427 if (search_options)
3428 no_hlsearch = save_no_hlsearch;
3429 #endif
3431 /* Return OK if jumped to another file (at least we found the file!). */
3432 if (getfile_result == -1)
3433 retval = OK;
3435 if (retval == OK)
3438 * For a help buffer: Put the cursor line at the top of the window,
3439 * the help subject will be below it.
3441 if (curbuf->b_help)
3442 set_topline(curwin, curwin->w_cursor.lnum);
3443 #ifdef FEAT_FOLDING
3444 if ((fdo_flags & FDO_TAG) && old_KeyTyped)
3445 foldOpenCursor();
3446 #endif
3449 #if defined(FEAT_WINDOWS) && defined(FEAT_QUICKFIX)
3450 if (g_do_tagpreview && curwin != curwin_save && win_valid(curwin_save))
3452 /* Return cursor to where we were */
3453 validate_cursor();
3454 redraw_later(VALID);
3455 win_enter(curwin_save, TRUE);
3457 #endif
3459 --RedrawingDisabled;
3461 else
3463 --RedrawingDisabled;
3464 #ifdef FEAT_WINDOWS
3465 if (postponed_split) /* close the window */
3467 win_close(curwin, FALSE);
3468 postponed_split = 0;
3470 #endif
3473 erret:
3474 #if defined(FEAT_WINDOWS) && defined(FEAT_QUICKFIX)
3475 g_do_tagpreview = 0; /* For next time */
3476 #endif
3477 if (tagp.fname_end != NULL)
3478 *tagp.fname_end = csave;
3479 vim_free(pbuf);
3480 vim_free(tofree_fname);
3481 vim_free(full_fname);
3483 return retval;
3487 * If "expand" is TRUE, expand wildcards in fname.
3488 * If 'tagrelative' option set, change fname (name of file containing tag)
3489 * according to tag_fname (name of tag file containing fname).
3490 * Returns a pointer to allocated memory (or NULL when out of memory).
3492 static char_u *
3493 expand_tag_fname(fname, tag_fname, expand)
3494 char_u *fname;
3495 char_u *tag_fname;
3496 int expand;
3498 char_u *p;
3499 char_u *retval;
3500 char_u *expanded_fname = NULL;
3501 expand_T xpc;
3504 * Expand file name (for environment variables) when needed.
3506 if (expand && mch_has_wildcard(fname))
3508 ExpandInit(&xpc);
3509 xpc.xp_context = EXPAND_FILES;
3510 expanded_fname = ExpandOne(&xpc, (char_u *)fname, NULL,
3511 WILD_LIST_NOTFOUND|WILD_SILENT, WILD_EXPAND_FREE);
3512 if (expanded_fname != NULL)
3513 fname = expanded_fname;
3516 if ((p_tr || curbuf->b_help)
3517 && !vim_isAbsName(fname)
3518 && (p = gettail(tag_fname)) != tag_fname)
3520 retval = alloc(MAXPATHL);
3521 if (retval != NULL)
3523 STRCPY(retval, tag_fname);
3524 vim_strncpy(retval + (p - tag_fname), fname,
3525 MAXPATHL - (p - tag_fname) - 1);
3527 * Translate names like "src/a/../b/file.c" into "src/b/file.c".
3529 simplify_filename(retval);
3532 else
3533 retval = vim_strsave(fname);
3535 vim_free(expanded_fname);
3537 return retval;
3541 * Converts a file name into a canonical form. It simplifies a file name into
3542 * its simplest form by stripping out unneeded components, if any. The
3543 * resulting file name is simplified in place and will either be the same
3544 * length as that supplied, or shorter.
3546 void
3547 simplify_filename(filename)
3548 char_u *filename;
3550 #ifndef AMIGA /* Amiga doesn't have "..", it uses "/" */
3551 int components = 0;
3552 char_u *p, *tail, *start;
3553 int stripping_disabled = FALSE;
3554 int relative = TRUE;
3556 p = filename;
3557 #ifdef BACKSLASH_IN_FILENAME
3558 if (p[1] == ':') /* skip "x:" */
3559 p += 2;
3560 #endif
3562 if (vim_ispathsep(*p))
3564 relative = FALSE;
3566 ++p;
3567 while (vim_ispathsep(*p));
3569 start = p; /* remember start after "c:/" or "/" or "///" */
3573 /* At this point "p" is pointing to the char following a single "/"
3574 * or "p" is at the "start" of the (absolute or relative) path name. */
3575 #ifdef VMS
3576 /* VMS allows device:[path] - don't strip the [ in directory */
3577 if ((*p == '[' || *p == '<') && p > filename && p[-1] == ':')
3579 /* :[ or :< composition: vms directory component */
3580 ++components;
3581 p = getnextcomp(p + 1);
3583 /* allow remote calls as host"user passwd"::device:[path] */
3584 else if (p[0] == ':' && p[1] == ':' && p > filename && p[-1] == '"' )
3586 /* ":: composition: vms host/passwd component */
3587 ++components;
3588 p = getnextcomp(p + 2);
3590 else
3591 #endif
3592 if (vim_ispathsep(*p))
3593 STRMOVE(p, p + 1); /* remove duplicate "/" */
3594 else if (p[0] == '.' && (vim_ispathsep(p[1]) || p[1] == NUL))
3596 if (p == start && relative)
3597 p += 1 + (p[1] != NUL); /* keep single "." or leading "./" */
3598 else
3600 /* Strip "./" or ".///". If we are at the end of the file name
3601 * and there is no trailing path separator, either strip "/." if
3602 * we are after "start", or strip "." if we are at the beginning
3603 * of an absolute path name . */
3604 tail = p + 1;
3605 if (p[1] != NUL)
3606 while (vim_ispathsep(*tail))
3607 mb_ptr_adv(tail);
3608 else if (p > start)
3609 --p; /* strip preceding path separator */
3610 STRMOVE(p, tail);
3613 else if (p[0] == '.' && p[1] == '.' &&
3614 (vim_ispathsep(p[2]) || p[2] == NUL))
3616 /* Skip to after ".." or "../" or "..///". */
3617 tail = p + 2;
3618 while (vim_ispathsep(*tail))
3619 mb_ptr_adv(tail);
3621 if (components > 0) /* strip one preceding component */
3623 int do_strip = FALSE;
3624 char_u saved_char;
3625 struct stat st;
3627 /* Don't strip for an erroneous file name. */
3628 if (!stripping_disabled)
3630 /* If the preceding component does not exist in the file
3631 * system, we strip it. On Unix, we don't accept a symbolic
3632 * link that refers to a non-existent file. */
3633 saved_char = p[-1];
3634 p[-1] = NUL;
3635 #ifdef UNIX
3636 if (mch_lstat((char *)filename, &st) < 0)
3637 #else
3638 if (mch_stat((char *)filename, &st) < 0)
3639 #endif
3640 do_strip = TRUE;
3641 p[-1] = saved_char;
3643 --p;
3644 /* Skip back to after previous '/'. */
3645 while (p > start && !after_pathsep(start, p))
3646 mb_ptr_back(start, p);
3648 if (!do_strip)
3650 /* If the component exists in the file system, check
3651 * that stripping it won't change the meaning of the
3652 * file name. First get information about the
3653 * unstripped file name. This may fail if the component
3654 * to strip is not a searchable directory (but a regular
3655 * file, for instance), since the trailing "/.." cannot
3656 * be applied then. We don't strip it then since we
3657 * don't want to replace an erroneous file name by
3658 * a valid one, and we disable stripping of later
3659 * components. */
3660 saved_char = *tail;
3661 *tail = NUL;
3662 if (mch_stat((char *)filename, &st) >= 0)
3663 do_strip = TRUE;
3664 else
3665 stripping_disabled = TRUE;
3666 *tail = saved_char;
3667 #ifdef UNIX
3668 if (do_strip)
3670 struct stat new_st;
3672 /* On Unix, the check for the unstripped file name
3673 * above works also for a symbolic link pointing to
3674 * a searchable directory. But then the parent of
3675 * the directory pointed to by the link must be the
3676 * same as the stripped file name. (The latter
3677 * exists in the file system since it is the
3678 * component's parent directory.) */
3679 if (p == start && relative)
3680 (void)mch_stat(".", &new_st);
3681 else
3683 saved_char = *p;
3684 *p = NUL;
3685 (void)mch_stat((char *)filename, &new_st);
3686 *p = saved_char;
3689 if (new_st.st_ino != st.st_ino ||
3690 new_st.st_dev != st.st_dev)
3692 do_strip = FALSE;
3693 /* We don't disable stripping of later
3694 * components since the unstripped path name is
3695 * still valid. */
3698 #endif
3702 if (!do_strip)
3704 /* Skip the ".." or "../" and reset the counter for the
3705 * components that might be stripped later on. */
3706 p = tail;
3707 components = 0;
3709 else
3711 /* Strip previous component. If the result would get empty
3712 * and there is no trailing path separator, leave a single
3713 * "." instead. If we are at the end of the file name and
3714 * there is no trailing path separator and a preceding
3715 * component is left after stripping, strip its trailing
3716 * path separator as well. */
3717 if (p == start && relative && tail[-1] == '.')
3719 *p++ = '.';
3720 *p = NUL;
3722 else
3724 if (p > start && tail[-1] == '.')
3725 --p;
3726 STRMOVE(p, tail); /* strip previous component */
3729 --components;
3732 else if (p == start && !relative) /* leading "/.." or "/../" */
3733 STRMOVE(p, tail); /* strip ".." or "../" */
3734 else
3736 if (p == start + 2 && p[-2] == '.') /* leading "./../" */
3738 STRMOVE(p - 2, p); /* strip leading "./" */
3739 tail -= 2;
3741 p = tail; /* skip to char after ".." or "../" */
3744 else
3746 ++components; /* simple path component */
3747 p = getnextcomp(p);
3749 } while (*p != NUL);
3750 #endif /* !AMIGA */
3754 * Check if we have a tag for the buffer with name "buf_ffname".
3755 * This is a bit slow, because of the full path compare in fullpathcmp().
3756 * Return TRUE if tag for file "fname" if tag file "tag_fname" is for current
3757 * file.
3759 static int
3760 #ifdef FEAT_EMACS_TAGS
3761 test_for_current(is_etag, fname, fname_end, tag_fname, buf_ffname)
3762 int is_etag;
3763 #else
3764 test_for_current(fname, fname_end, tag_fname, buf_ffname)
3765 #endif
3766 char_u *fname;
3767 char_u *fname_end;
3768 char_u *tag_fname;
3769 char_u *buf_ffname;
3771 int c;
3772 int retval = FALSE;
3773 char_u *fullname;
3775 if (buf_ffname != NULL) /* if the buffer has a name */
3777 #ifdef FEAT_EMACS_TAGS
3778 if (is_etag)
3779 c = 0; /* to shut up GCC */
3780 else
3781 #endif
3783 c = *fname_end;
3784 *fname_end = NUL;
3786 fullname = expand_tag_fname(fname, tag_fname, TRUE);
3787 if (fullname != NULL)
3789 retval = (fullpathcmp(fullname, buf_ffname, TRUE) & FPC_SAME);
3790 vim_free(fullname);
3792 #ifdef FEAT_EMACS_TAGS
3793 if (!is_etag)
3794 #endif
3795 *fname_end = c;
3798 return retval;
3802 * Find the end of the tagaddress.
3803 * Return OK if ";\"" is following, FAIL otherwise.
3805 static int
3806 find_extra(pp)
3807 char_u **pp;
3809 char_u *str = *pp;
3811 /* Repeat for addresses separated with ';' */
3812 for (;;)
3814 if (VIM_ISDIGIT(*str))
3815 str = skipdigits(str);
3816 else if (*str == '/' || *str == '?')
3818 str = skip_regexp(str + 1, *str, FALSE, NULL);
3819 if (*str != **pp)
3820 str = NULL;
3821 else
3822 ++str;
3824 else
3825 str = NULL;
3826 if (str == NULL || *str != ';'
3827 || !(VIM_ISDIGIT(str[1]) || str[1] == '/' || str[1] == '?'))
3828 break;
3829 ++str; /* skip ';' */
3832 if (str != NULL && STRNCMP(str, ";\"", 2) == 0)
3834 *pp = str;
3835 return OK;
3837 return FAIL;
3840 #if defined(FEAT_CMDL_COMPL) || defined(PROTO)
3842 expand_tags(tagnames, pat, num_file, file)
3843 int tagnames; /* expand tag names */
3844 char_u *pat;
3845 int *num_file;
3846 char_u ***file;
3848 int i;
3849 int c;
3850 int tagnmflag;
3851 char_u tagnm[100];
3852 tagptrs_T t_p;
3853 int ret;
3855 if (tagnames)
3856 tagnmflag = TAG_NAMES;
3857 else
3858 tagnmflag = 0;
3859 if (pat[0] == '/')
3860 ret = find_tags(pat + 1, num_file, file,
3861 TAG_REGEXP | tagnmflag | TAG_VERBOSE,
3862 TAG_MANY, curbuf->b_ffname);
3863 else
3864 ret = find_tags(pat, num_file, file,
3865 TAG_REGEXP | tagnmflag | TAG_VERBOSE | TAG_NOIC,
3866 TAG_MANY, curbuf->b_ffname);
3867 if (ret == OK && !tagnames)
3869 /* Reorganize the tags for display and matching as strings of:
3870 * "<tagname>\0<kind>\0<filename>\0"
3872 for (i = 0; i < *num_file; i++)
3874 parse_match((*file)[i], &t_p);
3875 c = (int)(t_p.tagname_end - t_p.tagname);
3876 mch_memmove(tagnm, t_p.tagname, (size_t)c);
3877 tagnm[c++] = 0;
3878 tagnm[c++] = (t_p.tagkind != NULL && *t_p.tagkind)
3879 ? *t_p.tagkind : 'f';
3880 tagnm[c++] = 0;
3881 mch_memmove((*file)[i] + c, t_p.fname, t_p.fname_end - t_p.fname);
3882 (*file)[i][c + (t_p.fname_end - t_p.fname)] = 0;
3883 mch_memmove((*file)[i], tagnm, (size_t)c);
3886 return ret;
3888 #endif
3890 #if defined(FEAT_EVAL) || defined(PROTO)
3891 static int add_tag_field __ARGS((dict_T *dict, char *field_name, char_u *start, char_u *end));
3894 * Add a tag field to the dictionary "dict"
3896 static int
3897 add_tag_field(dict, field_name, start, end)
3898 dict_T *dict;
3899 char *field_name;
3900 char_u *start; /* start of the value */
3901 char_u *end; /* after the value; can be NULL */
3903 char_u buf[MAXPATHL];
3904 int len = 0;
3906 if (start != NULL)
3908 if (end == NULL)
3910 end = start + STRLEN(start);
3911 while (end > start && (end[-1] == '\r' || end[-1] == '\n'))
3912 --end;
3914 len = (int)(end - start);
3915 if (len > (int)sizeof(buf) - 1)
3916 len = sizeof(buf) - 1;
3917 vim_strncpy(buf, start, len);
3919 buf[len] = NUL;
3920 return dict_add_nr_str(dict, field_name, 0L, buf);
3924 * Add the tags matching the specified pattern to the list "list"
3925 * as a dictionary
3928 get_tags(list, pat)
3929 list_T *list;
3930 char_u *pat;
3932 int num_matches, i, ret;
3933 char_u **matches, *p;
3934 char_u *full_fname;
3935 dict_T *dict;
3936 tagptrs_T tp;
3937 long is_static;
3939 ret = find_tags(pat, &num_matches, &matches,
3940 TAG_REGEXP | TAG_NOIC, (int)MAXCOL, NULL);
3941 if (ret == OK && num_matches > 0)
3943 for (i = 0; i < num_matches; ++i)
3945 parse_match(matches[i], &tp);
3946 is_static = test_for_static(&tp);
3948 /* Skip pseudo-tag lines. */
3949 if (STRNCMP(tp.tagname, "!_TAG_", 6) == 0)
3950 continue;
3952 if ((dict = dict_alloc()) == NULL)
3953 ret = FAIL;
3954 if (list_append_dict(list, dict) == FAIL)
3955 ret = FAIL;
3957 full_fname = tag_full_fname(&tp);
3958 if (add_tag_field(dict, "name", tp.tagname, tp.tagname_end) == FAIL
3959 || add_tag_field(dict, "filename", full_fname,
3960 NULL) == FAIL
3961 || add_tag_field(dict, "cmd", tp.command,
3962 tp.command_end) == FAIL
3963 || add_tag_field(dict, "kind", tp.tagkind,
3964 tp.tagkind_end) == FAIL
3965 || dict_add_nr_str(dict, "static", is_static, NULL) == FAIL)
3966 ret = FAIL;
3968 vim_free(full_fname);
3970 if (tp.command_end != NULL)
3972 for (p = tp.command_end + 3;
3973 *p != NUL && *p != '\n' && *p != '\r'; ++p)
3975 if (p == tp.tagkind || (p + 5 == tp.tagkind
3976 && STRNCMP(p, "kind:", 5) == 0))
3977 /* skip "kind:<kind>" and "<kind>" */
3978 p = tp.tagkind_end - 1;
3979 else if (STRNCMP(p, "file:", 5) == 0)
3980 /* skip "file:" (static tag) */
3981 p += 4;
3982 else if (!vim_iswhite(*p))
3984 char_u *s, *n;
3985 int len;
3987 /* Add extra field as a dict entry. Fields are
3988 * separated by Tabs. */
3989 n = p;
3990 while (*p != NUL && *p >= ' ' && *p < 127 && *p != ':')
3991 ++p;
3992 len = (int)(p - n);
3993 if (*p == ':' && len > 0)
3995 s = ++p;
3996 while (*p != NUL && *p >= ' ')
3997 ++p;
3998 n[len] = NUL;
3999 if (add_tag_field(dict, (char *)n, s, p) == FAIL)
4000 ret = FAIL;
4001 n[len] = ':';
4003 else
4004 /* Skip field without colon. */
4005 while (*p != NUL && *p >= ' ')
4006 ++p;
4007 if (*p == NUL)
4008 break;
4013 vim_free(matches[i]);
4015 vim_free(matches);
4017 return ret;
4019 #endif