feat/tagfunc: 'tagfunc' now takes two arguments.
[vim_extended.git] / src / tag.c
blob1cd3182873b07ce8f1328a704dc558e19c5841be
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;
1257 char_u *args[2];
1259 static int call_level = 0;
1261 args[0] = pat;
1262 args[1] = g_tag_at_cursor? "c": "";
1264 /* Prevent endless loop: */
1265 ++call_level;
1266 if (call_level > 5)
1267 goto done;
1269 if (*curbuf->b_p_tfu == NUL)
1270 goto done;
1272 pos = curwin->w_cursor;
1273 taglist = call_func_retlist(curbuf->b_p_tfu, 2, args, FALSE);
1274 curwin->w_cursor = pos; /* restore the cursor position */
1276 if (taglist == NULL)
1277 goto done;
1279 for (item = taglist->lv_first; item != NULL; item = item->li_next)
1281 struct match_found *mfp;
1282 int len;
1283 if (item->li_tv.v_type != VAR_LIST)
1285 /* FIXME:2010-04-24:llorens: ... */
1286 continue;
1288 if (item->li_tv.vval.v_list->lv_len != nfieds_required)
1290 /* FIXME:2010-04-24:llorens: ... */
1291 continue;
1293 #ifdef FEAT_EMACS_TAGS
1294 len = 3;
1295 #else
1296 len = 2;
1297 #endif
1298 len += nfieds_required;
1300 for (item2 = item->li_tv.vval.v_list->lv_first;
1301 item2 != NULL;
1302 item2 = item2->li_next)
1304 if (item2->li_tv.v_type != VAR_STRING)
1306 /* FIXME:2010-04-24:llorens: ... */
1307 continue;
1309 len += STRLEN(item2->li_tv.vval.v_string);
1312 mfp = (struct match_found *)alloc(
1313 (int)sizeof(struct match_found) + len);
1314 if (mfp != NULL)
1316 char_u *p;
1317 mfp->len = len;
1318 p = mfp->match;
1319 p[0] = 0; /* mtt */
1320 p[1] = NUL; /* no tag file name */
1321 p = p + 2;
1322 #ifdef FEAT_EMACS_TAGS
1323 *p = NUL;
1324 ++p;
1325 #endif
1326 for (item2 = item->li_tv.vval.v_list->lv_first;
1327 item2 != NULL;
1328 item2 = item2->li_next)
1330 STRCPY(p, item2->li_tv.vval.v_string);
1331 p += STRLEN(item2->li_tv.vval.v_string);
1332 if (item2->li_next != NULL)
1334 *p = TAB;
1335 ++p;
1338 /* FIXME:2010-04-24:llorens: Don't add identical matches. */
1339 if (ga_grow(ga, 1) == OK)
1341 ((struct match_found **)(ga->ga_data)) [ga->ga_len++] = mfp;
1342 ++ntags;
1343 result = OK;
1345 else
1346 vim_free(mfp);
1350 list_free(taglist, TRUE);
1351 done:
1352 --call_level;
1353 *match_count = ntags;
1354 return result;
1358 * find_tags() - search for tags in tags files
1360 * Return FAIL if search completely failed (*num_matches will be 0, *matchesp
1361 * will be NULL), OK otherwise.
1363 * There is a priority in which type of tag is recognized.
1365 * 6. A static or global tag with a full matching tag for the current file.
1366 * 5. A global tag with a full matching tag for another file.
1367 * 4. A static tag with a full matching tag for another file.
1368 * 3. A static or global tag with an ignore-case matching tag for the
1369 * current file.
1370 * 2. A global tag with an ignore-case matching tag for another file.
1371 * 1. A static tag with an ignore-case matching tag for another file.
1373 * Tags in an emacs-style tags file are always global.
1375 * flags:
1376 * TAG_HELP only search for help tags
1377 * TAG_NAMES only return name of tag
1378 * TAG_REGEXP use "pat" as a regexp
1379 * TAG_NOIC don't always ignore case
1380 * TAG_KEEP_LANG keep language
1383 find_tags(pat, num_matches, matchesp, flags, mincount, buf_ffname)
1384 char_u *pat; /* pattern to search for */
1385 int *num_matches; /* return: number of matches found */
1386 char_u ***matchesp; /* return: array of matches found */
1387 int flags;
1388 int mincount; /* MAXCOL: find all matches
1389 other: minimal number of matches */
1390 char_u *buf_ffname; /* name of buffer for priority */
1392 FILE *fp;
1393 char_u *lbuf; /* line buffer */
1394 char_u *tag_fname; /* name of tag file */
1395 tagname_T tn; /* info for get_tagfname() */
1396 int first_file; /* trying first tag file */
1397 tagptrs_T tagp;
1398 int did_open = FALSE; /* did open a tag file */
1399 int stop_searching = FALSE; /* stop when match found or error */
1400 int retval = FAIL; /* return value */
1401 int is_static; /* current tag line is static */
1402 int is_current; /* file name matches */
1403 int eof = FALSE; /* found end-of-file */
1404 char_u *p;
1405 char_u *s;
1406 int i;
1407 #ifdef FEAT_TAG_BINS
1408 struct tag_search_info /* Binary search file offsets */
1410 off_t low_offset; /* offset for first char of first line that
1411 could match */
1412 off_t high_offset; /* offset of char after last line that could
1413 match */
1414 off_t curr_offset; /* Current file offset in search range */
1415 off_t curr_offset_used; /* curr_offset used when skipping back */
1416 off_t match_offset; /* Where the binary search found a tag */
1417 int low_char; /* first char at low_offset */
1418 int high_char; /* first char at high_offset */
1419 } search_info;
1420 off_t filesize;
1421 int tagcmp;
1422 off_t offset;
1423 int round;
1424 #endif
1425 enum
1427 TS_START, /* at start of file */
1428 TS_LINEAR /* linear searching forward, till EOF */
1429 #ifdef FEAT_TAG_BINS
1430 , TS_BINARY, /* binary searching */
1431 TS_SKIP_BACK, /* skipping backwards */
1432 TS_STEP_FORWARD /* stepping forwards */
1433 #endif
1434 } state; /* Current search state */
1436 int cmplen;
1437 int match; /* matches */
1438 int match_no_ic = 0;/* matches with rm_ic == FALSE */
1439 int match_re; /* match with regexp */
1440 int matchoff = 0;
1442 #ifdef FEAT_EMACS_TAGS
1444 * Stack for included emacs-tags file.
1445 * It has a fixed size, to truncate cyclic includes. jw
1447 # define INCSTACK_SIZE 42
1448 struct
1450 FILE *fp;
1451 char_u *etag_fname;
1452 } incstack[INCSTACK_SIZE];
1454 int incstack_idx = 0; /* index in incstack */
1455 char_u *ebuf; /* additional buffer for etag fname */
1456 int is_etag; /* current file is emaces style */
1457 #endif
1459 struct match_found *mfp, *mfp2;
1460 garray_T ga_match[MT_COUNT];
1461 int match_count = 0; /* number of matches found */
1462 char_u **matches;
1463 int mtt;
1464 int len;
1465 int help_save;
1466 #ifdef FEAT_MULTI_LANG
1467 int help_pri = 0;
1468 char_u *help_lang_find = NULL; /* lang to be found */
1469 char_u help_lang[3]; /* lang of current tags file */
1470 char_u *saved_pat = NULL; /* copy of pat[] */
1471 #endif
1473 /* Use two sets of variables for the pattern: "orgpat" holds the values
1474 * for the original pattern and "convpat" converted from 'encoding' to
1475 * encoding of the tags file. "pats" point to either one of these. */
1476 pat_T *pats;
1477 pat_T orgpat; /* holds unconverted pattern info */
1478 #ifdef FEAT_MBYTE
1479 pat_T convpat; /* holds converted pattern info */
1480 vimconv_T vimconv;
1481 #endif
1483 #ifdef FEAT_TAG_BINS
1484 int findall = (mincount == MAXCOL || mincount == TAG_MANY);
1485 /* find all matching tags */
1486 int sort_error = FALSE; /* tags file not sorted */
1487 int linear; /* do a linear search */
1488 int sortic = FALSE; /* tag file sorted in nocase */
1489 #endif
1490 int line_error = FALSE; /* syntax error */
1491 int has_re = (flags & TAG_REGEXP); /* regexp used */
1492 int help_only = (flags & TAG_HELP);
1493 int name_only = (flags & TAG_NAMES);
1494 int noic = (flags & TAG_NOIC);
1495 int get_it_again = FALSE;
1496 #ifdef FEAT_CSCOPE
1497 int use_cscope = (flags & TAG_CSCOPE);
1498 #endif
1499 int verbose = (flags & TAG_VERBOSE);
1500 int use_tfu = (flags & TAG_USE_TFU);
1502 help_save = curbuf->b_help;
1503 orgpat.pat = pat;
1504 pats = &orgpat;
1505 #ifdef FEAT_MBYTE
1506 vimconv.vc_type = CONV_NONE;
1507 #endif
1510 * Allocate memory for the buffers that are used
1512 lbuf = alloc(LSIZE);
1513 tag_fname = alloc(MAXPATHL + 1);
1514 #ifdef FEAT_EMACS_TAGS
1515 ebuf = alloc(LSIZE);
1516 #endif
1517 for (mtt = 0; mtt < MT_COUNT; ++mtt)
1518 ga_init2(&ga_match[mtt], (int)sizeof(struct match_found *), 100);
1520 /* check for out of memory situation */
1521 if (lbuf == NULL || tag_fname == NULL
1522 #ifdef FEAT_EMACS_TAGS
1523 || ebuf == NULL
1524 #endif
1526 goto findtag_end;
1528 #ifdef FEAT_CSCOPE
1529 STRCPY(tag_fname, "from cscope"); /* for error messages */
1530 #endif
1533 * Initialize a few variables
1535 if (help_only) /* want tags from help file */
1536 curbuf->b_help = TRUE; /* will be restored later */
1538 pats->len = (int)STRLEN(pat);
1539 #ifdef FEAT_MULTI_LANG
1540 if (curbuf->b_help)
1542 /* When "@ab" is specified use only the "ab" language, otherwise
1543 * search all languages. */
1544 if (pats->len > 3 && pat[pats->len - 3] == '@'
1545 && ASCII_ISALPHA(pat[pats->len - 2])
1546 && ASCII_ISALPHA(pat[pats->len - 1]))
1548 saved_pat = vim_strnsave(pat, pats->len - 3);
1549 if (saved_pat != NULL)
1551 help_lang_find = &pat[pats->len - 2];
1552 pats->pat = saved_pat;
1553 pats->len -= 3;
1557 #endif
1558 if (p_tl != 0 && pats->len > p_tl) /* adjust for 'taglength' */
1559 pats->len = p_tl;
1561 prepare_pats(pats, has_re);
1563 #ifdef FEAT_TAG_BINS
1564 /* This is only to avoid a compiler warning for using search_info
1565 * uninitialised. */
1566 vim_memset(&search_info, 0, (size_t)1);
1567 #endif
1569 if (use_tfu)
1571 retval = find_tfu_tags(pat, &ga_match[0], &match_count);
1572 goto findtag_end;
1576 * When finding a specified number of matches, first try with matching
1577 * case, so binary search can be used, and try ignore-case matches in a
1578 * second loop.
1579 * When finding all matches, 'tagbsearch' is off, or there is no fixed
1580 * string to look for, ignore case right away to avoid going though the
1581 * tags files twice.
1582 * When the tag file is case-fold sorted, it is either one or the other.
1583 * Only ignore case when TAG_NOIC not used or 'ignorecase' set.
1585 #ifdef FEAT_TAG_BINS
1586 pats->regmatch.rm_ic = ((p_ic || !noic)
1587 && (findall || pats->headlen == 0 || !p_tbs));
1588 for (round = 1; round <= 2; ++round)
1590 linear = (pats->headlen == 0 || !p_tbs || round == 2);
1591 #else
1592 pats->regmatch.rm_ic = (p_ic || !noic);
1593 #endif
1596 * Try tag file names from tags option one by one.
1598 for (first_file = TRUE;
1599 #ifdef FEAT_CSCOPE
1600 use_cscope ||
1601 #endif
1602 get_tagfname(&tn, first_file, tag_fname) == OK;
1603 first_file = FALSE)
1606 * A file that doesn't exist is silently ignored. Only when not a
1607 * single file is found, an error message is given (further on).
1609 #ifdef FEAT_CSCOPE
1610 if (use_cscope)
1611 fp = NULL; /* avoid GCC warning */
1612 else
1613 #endif
1615 #ifdef FEAT_MULTI_LANG
1616 if (curbuf->b_help)
1618 /* Prefer help tags according to 'helplang'. Put the
1619 * two-letter language name in help_lang[]. */
1620 i = (int)STRLEN(tag_fname);
1621 if (i > 3 && tag_fname[i - 3] == '-')
1622 STRCPY(help_lang, tag_fname + i - 2);
1623 else
1624 STRCPY(help_lang, "en");
1626 /* When searching for a specific language skip tags files
1627 * for other languages. */
1628 if (help_lang_find != NULL
1629 && STRICMP(help_lang, help_lang_find) != 0)
1630 continue;
1632 /* For CTRL-] in a help file prefer a match with the same
1633 * language. */
1634 if ((flags & TAG_KEEP_LANG)
1635 && help_lang_find == NULL
1636 && curbuf->b_fname != NULL
1637 && (i = (int)STRLEN(curbuf->b_fname)) > 4
1638 && curbuf->b_fname[i - 1] == 'x'
1639 && curbuf->b_fname[i - 4] == '.'
1640 && STRNICMP(curbuf->b_fname + i - 3, help_lang, 2) == 0)
1641 help_pri = 0;
1642 else
1644 help_pri = 1;
1645 for (s = p_hlg; *s != NUL; ++s)
1647 if (STRNICMP(s, help_lang, 2) == 0)
1648 break;
1649 ++help_pri;
1650 if ((s = vim_strchr(s, ',')) == NULL)
1651 break;
1653 if (s == NULL || *s == NUL)
1655 /* Language not in 'helplang': use last, prefer English,
1656 * unless found already. */
1657 ++help_pri;
1658 if (STRICMP(help_lang, "en") != 0)
1659 ++help_pri;
1663 #endif
1665 if ((fp = mch_fopen((char *)tag_fname, "r")) == NULL)
1666 continue;
1668 if (p_verbose >= 5)
1670 verbose_enter();
1671 smsg((char_u *)_("Searching tags file %s"), tag_fname);
1672 verbose_leave();
1675 did_open = TRUE; /* remember that we found at least one file */
1677 state = TS_START; /* we're at the start of the file */
1678 #ifdef FEAT_EMACS_TAGS
1679 is_etag = 0; /* default is: not emacs style */
1680 #endif
1683 * Read and parse the lines in the file one by one
1685 for (;;)
1687 line_breakcheck(); /* check for CTRL-C typed */
1688 #ifdef FEAT_INS_EXPAND
1689 if ((flags & TAG_INS_COMP)) /* Double brackets for gcc */
1690 ins_compl_check_keys(30);
1691 if (got_int || compl_interrupted)
1692 #else
1693 if (got_int)
1694 #endif
1696 stop_searching = TRUE;
1697 break;
1699 /* When mincount is TAG_MANY, stop when enough matches have been
1700 * found (for completion). */
1701 if (mincount == TAG_MANY && match_count >= TAG_MANY)
1703 stop_searching = TRUE;
1704 retval = OK;
1705 break;
1707 if (get_it_again)
1708 goto line_read_in;
1709 #ifdef FEAT_TAG_BINS
1711 * For binary search: compute the next offset to use.
1713 if (state == TS_BINARY)
1715 offset = search_info.low_offset + ((search_info.high_offset
1716 - search_info.low_offset) / 2);
1717 if (offset == search_info.curr_offset)
1718 break; /* End the binary search without a match. */
1719 else
1720 search_info.curr_offset = offset;
1724 * Skipping back (after a match during binary search).
1726 else if (state == TS_SKIP_BACK)
1728 search_info.curr_offset -= LSIZE * 2;
1729 if (search_info.curr_offset < 0)
1731 search_info.curr_offset = 0;
1732 rewind(fp);
1733 state = TS_STEP_FORWARD;
1738 * When jumping around in the file, first read a line to find the
1739 * start of the next line.
1741 if (state == TS_BINARY || state == TS_SKIP_BACK)
1743 /* Adjust the search file offset to the correct position */
1744 search_info.curr_offset_used = search_info.curr_offset;
1745 #ifdef HAVE_FSEEKO
1746 fseeko(fp, search_info.curr_offset, SEEK_SET);
1747 #else
1748 fseek(fp, (long)search_info.curr_offset, SEEK_SET);
1749 #endif
1750 eof = tag_fgets(lbuf, LSIZE, fp);
1751 if (!eof && search_info.curr_offset != 0)
1753 /* The explicit cast is to work around a bug in gcc 3.4.2
1754 * (repeated below). */
1755 search_info.curr_offset = ftell(fp);
1756 if (search_info.curr_offset == search_info.high_offset)
1758 /* oops, gone a bit too far; try from low offset */
1759 #ifdef HAVE_FSEEKO
1760 fseeko(fp, search_info.low_offset, SEEK_SET);
1761 #else
1762 fseek(fp, (long)search_info.low_offset, SEEK_SET);
1763 #endif
1764 search_info.curr_offset = search_info.low_offset;
1766 eof = tag_fgets(lbuf, LSIZE, fp);
1768 /* skip empty and blank lines */
1769 while (!eof && vim_isblankline(lbuf))
1771 search_info.curr_offset = ftell(fp);
1772 eof = tag_fgets(lbuf, LSIZE, fp);
1774 if (eof)
1776 /* Hit end of file. Skip backwards. */
1777 state = TS_SKIP_BACK;
1778 search_info.match_offset = ftell(fp);
1779 search_info.curr_offset = search_info.curr_offset_used;
1780 continue;
1785 * Not jumping around in the file: Read the next line.
1787 else
1788 #endif
1790 /* skip empty and blank lines */
1793 #ifdef FEAT_CSCOPE
1794 if (use_cscope)
1795 eof = cs_fgets(lbuf, LSIZE);
1796 else
1797 #endif
1798 eof = tag_fgets(lbuf, LSIZE, fp);
1799 } while (!eof && vim_isblankline(lbuf));
1801 if (eof)
1803 #ifdef FEAT_EMACS_TAGS
1804 if (incstack_idx) /* this was an included file */
1806 --incstack_idx;
1807 fclose(fp); /* end of this file ... */
1808 fp = incstack[incstack_idx].fp;
1809 STRCPY(tag_fname, incstack[incstack_idx].etag_fname);
1810 vim_free(incstack[incstack_idx].etag_fname);
1811 is_etag = 1; /* (only etags can include) */
1812 continue; /* ... continue with parent file */
1814 else
1815 #endif
1816 break; /* end of file */
1819 line_read_in:
1821 #ifdef FEAT_EMACS_TAGS
1823 * Emacs tags line with CTRL-L: New file name on next line.
1824 * The file name is followed by a ','.
1826 if (*lbuf == Ctrl_L) /* remember etag file name in ebuf */
1828 is_etag = 1; /* in case at the start */
1829 state = TS_LINEAR;
1830 if (!tag_fgets(ebuf, LSIZE, fp))
1832 for (p = ebuf; *p && *p != ','; p++)
1834 *p = NUL;
1837 * atoi(p+1) is the number of bytes before the next ^L
1838 * unless it is an include statement.
1840 if (STRNCMP(p + 1, "include", 7) == 0
1841 && incstack_idx < INCSTACK_SIZE)
1843 /* Save current "fp" and "tag_fname" in the stack. */
1844 if ((incstack[incstack_idx].etag_fname =
1845 vim_strsave(tag_fname)) != NULL)
1847 char_u *fullpath_ebuf;
1849 incstack[incstack_idx].fp = fp;
1850 fp = NULL;
1852 /* Figure out "tag_fname" and "fp" to use for
1853 * included file. */
1854 fullpath_ebuf = expand_tag_fname(ebuf,
1855 tag_fname, FALSE);
1856 if (fullpath_ebuf != NULL)
1858 fp = mch_fopen((char *)fullpath_ebuf, "r");
1859 if (fp != NULL)
1861 if (STRLEN(fullpath_ebuf) > LSIZE)
1862 EMSG2(_("E430: Tag file path truncated for %s\n"), ebuf);
1863 vim_strncpy(tag_fname, fullpath_ebuf,
1864 MAXPATHL);
1865 ++incstack_idx;
1866 is_etag = 0; /* we can include anything */
1868 vim_free(fullpath_ebuf);
1870 if (fp == NULL)
1872 /* Can't open the included file, skip it and
1873 * restore old value of "fp". */
1874 fp = incstack[incstack_idx].fp;
1875 vim_free(incstack[incstack_idx].etag_fname);
1880 continue;
1882 #endif
1885 * When still at the start of the file, check for Emacs tags file
1886 * format, and for "not sorted" flag.
1888 if (state == TS_START)
1890 #ifdef FEAT_TAG_BINS
1892 * When there is no tag head, or ignoring case, need to do a
1893 * linear search.
1894 * When no "!_TAG_" is found, default to binary search. If
1895 * the tag file isn't sorted, the second loop will find it.
1896 * When "!_TAG_FILE_SORTED" found: start binary search if
1897 * flag set.
1898 * For cscope, it's always linear.
1900 # ifdef FEAT_CSCOPE
1901 if (linear || use_cscope)
1902 # else
1903 if (linear)
1904 # endif
1905 state = TS_LINEAR;
1906 else if (STRNCMP(lbuf, "!_TAG_", 6) > 0)
1907 state = TS_BINARY;
1908 else if (STRNCMP(lbuf, "!_TAG_FILE_SORTED\t", 18) == 0)
1910 /* Check sorted flag */
1911 if (lbuf[18] == '1')
1912 state = TS_BINARY;
1913 else if (lbuf[18] == '2')
1915 state = TS_BINARY;
1916 sortic = TRUE;
1917 pats->regmatch.rm_ic = (p_ic || !noic);
1919 else
1920 state = TS_LINEAR;
1923 if (state == TS_BINARY && pats->regmatch.rm_ic && !sortic)
1925 /* binary search won't work for ignoring case, use linear
1926 * search. */
1927 linear = TRUE;
1928 state = TS_LINEAR;
1930 #else
1931 state = TS_LINEAR;
1932 #endif
1934 #ifdef FEAT_TAG_BINS
1936 * When starting a binary search, get the size of the file and
1937 * compute the first offset.
1939 if (state == TS_BINARY)
1941 /* Get the tag file size (don't use mch_fstat(), it's not
1942 * portable). */
1943 if ((filesize = lseek(fileno(fp),
1944 (off_t)0L, SEEK_END)) <= 0)
1945 state = TS_LINEAR;
1946 else
1948 lseek(fileno(fp), (off_t)0L, SEEK_SET);
1950 /* Calculate the first read offset in the file. Start
1951 * the search in the middle of the file. */
1952 search_info.low_offset = 0;
1953 search_info.low_char = 0;
1954 search_info.high_offset = filesize;
1955 search_info.curr_offset = 0;
1956 search_info.high_char = 0xff;
1958 continue;
1960 #endif
1963 #ifdef FEAT_MBYTE
1964 if (lbuf[0] == '!' && pats == &orgpat
1965 && STRNCMP(lbuf, "!_TAG_FILE_ENCODING\t", 20) == 0)
1967 /* Convert the search pattern from 'encoding' to the
1968 * specified encoding. */
1969 for (p = lbuf + 20; *p > ' ' && *p < 127; ++p)
1971 *p = NUL;
1972 convert_setup(&vimconv, p_enc, lbuf + 20);
1973 if (vimconv.vc_type != CONV_NONE)
1975 convpat.pat = string_convert(&vimconv, pats->pat, NULL);
1976 if (convpat.pat != NULL)
1978 pats = &convpat;
1979 pats->len = (int)STRLEN(pats->pat);
1980 prepare_pats(pats, has_re);
1981 pats->regmatch.rm_ic = orgpat.regmatch.rm_ic;
1985 /* Prepare for converting a match the other way around. */
1986 convert_setup(&vimconv, lbuf + 20, p_enc);
1987 continue;
1989 #endif
1992 * Figure out where the different strings are in this line.
1993 * For "normal" tags: Do a quick check if the tag matches.
1994 * This speeds up tag searching a lot!
1996 if (pats->headlen
1997 #ifdef FEAT_EMACS_TAGS
1998 && !is_etag
1999 #endif
2002 tagp.tagname = lbuf;
2003 #ifdef FEAT_TAG_ANYWHITE
2004 tagp.tagname_end = skiptowhite(lbuf);
2005 if (*tagp.tagname_end == NUL) /* corrupted tag line */
2006 #else
2007 tagp.tagname_end = vim_strchr(lbuf, TAB);
2008 if (tagp.tagname_end == NULL) /* corrupted tag line */
2009 #endif
2011 line_error = TRUE;
2012 break;
2015 #ifdef FEAT_TAG_OLDSTATIC
2017 * Check for old style static tag: "file:tag file .."
2019 tagp.fname = NULL;
2020 for (p = lbuf; p < tagp.tagname_end; ++p)
2022 if (*p == ':')
2024 if (tagp.fname == NULL)
2025 #ifdef FEAT_TAG_ANYWHITE
2026 tagp.fname = skipwhite(tagp.tagname_end);
2027 #else
2028 tagp.fname = tagp.tagname_end + 1;
2029 #endif
2030 if ( fnamencmp(lbuf, tagp.fname, p - lbuf) == 0
2031 #ifdef FEAT_TAG_ANYWHITE
2032 && vim_iswhite(tagp.fname[p - lbuf])
2033 #else
2034 && tagp.fname[p - lbuf] == TAB
2035 #endif
2038 /* found one */
2039 tagp.tagname = p + 1;
2040 break;
2044 #endif
2047 * Skip this line if the length of the tag is different and
2048 * there is no regexp, or the tag is too short.
2050 cmplen = (int)(tagp.tagname_end - tagp.tagname);
2051 if (p_tl != 0 && cmplen > p_tl) /* adjust for 'taglength' */
2052 cmplen = p_tl;
2053 if (has_re && pats->headlen < cmplen)
2054 cmplen = pats->headlen;
2055 else if (state == TS_LINEAR && pats->headlen != cmplen)
2056 continue;
2058 #ifdef FEAT_TAG_BINS
2059 if (state == TS_BINARY)
2062 * Simplistic check for unsorted tags file.
2064 i = (int)tagp.tagname[0];
2065 if (sortic)
2066 i = (int)TOUPPER_ASC(tagp.tagname[0]);
2067 if (i < search_info.low_char || i > search_info.high_char)
2068 sort_error = TRUE;
2071 * Compare the current tag with the searched tag.
2073 if (sortic)
2074 tagcmp = tag_strnicmp(tagp.tagname, pats->head,
2075 (size_t)cmplen);
2076 else
2077 tagcmp = STRNCMP(tagp.tagname, pats->head, cmplen);
2080 * A match with a shorter tag means to search forward.
2081 * A match with a longer tag means to search backward.
2083 if (tagcmp == 0)
2085 if (cmplen < pats->headlen)
2086 tagcmp = -1;
2087 else if (cmplen > pats->headlen)
2088 tagcmp = 1;
2091 if (tagcmp == 0)
2093 /* We've located the tag, now skip back and search
2094 * forward until the first matching tag is found.
2096 state = TS_SKIP_BACK;
2097 search_info.match_offset = search_info.curr_offset;
2098 continue;
2100 if (tagcmp < 0)
2102 search_info.curr_offset = ftell(fp);
2103 if (search_info.curr_offset < search_info.high_offset)
2105 search_info.low_offset = search_info.curr_offset;
2106 if (sortic)
2107 search_info.low_char =
2108 TOUPPER_ASC(tagp.tagname[0]);
2109 else
2110 search_info.low_char = tagp.tagname[0];
2111 continue;
2114 if (tagcmp > 0
2115 && search_info.curr_offset != search_info.high_offset)
2117 search_info.high_offset = search_info.curr_offset;
2118 if (sortic)
2119 search_info.high_char =
2120 TOUPPER_ASC(tagp.tagname[0]);
2121 else
2122 search_info.high_char = tagp.tagname[0];
2123 continue;
2126 /* No match yet and are at the end of the binary search. */
2127 break;
2129 else if (state == TS_SKIP_BACK)
2131 if (MB_STRNICMP(tagp.tagname, pats->head, cmplen) != 0)
2132 state = TS_STEP_FORWARD;
2133 else
2134 /* Have to skip back more. Restore the curr_offset
2135 * used, otherwise we get stuck at a long line. */
2136 search_info.curr_offset = search_info.curr_offset_used;
2137 continue;
2139 else if (state == TS_STEP_FORWARD)
2141 if (MB_STRNICMP(tagp.tagname, pats->head, cmplen) != 0)
2143 if ((off_t)ftell(fp) > search_info.match_offset)
2144 break; /* past last match */
2145 else
2146 continue; /* before first match */
2149 else
2150 #endif
2151 /* skip this match if it can't match */
2152 if (MB_STRNICMP(tagp.tagname, pats->head, cmplen) != 0)
2153 continue;
2156 * Can be a matching tag, isolate the file name and command.
2158 #ifdef FEAT_TAG_OLDSTATIC
2159 if (tagp.fname == NULL)
2160 #endif
2161 #ifdef FEAT_TAG_ANYWHITE
2162 tagp.fname = skipwhite(tagp.tagname_end);
2163 #else
2164 tagp.fname = tagp.tagname_end + 1;
2165 #endif
2166 #ifdef FEAT_TAG_ANYWHITE
2167 tagp.fname_end = skiptowhite(tagp.fname);
2168 tagp.command = skipwhite(tagp.fname_end);
2169 if (*tagp.command == NUL)
2170 #else
2171 tagp.fname_end = vim_strchr(tagp.fname, TAB);
2172 tagp.command = tagp.fname_end + 1;
2173 if (tagp.fname_end == NULL)
2174 #endif
2175 i = FAIL;
2176 else
2177 i = OK;
2179 else
2180 i = parse_tag_line(lbuf,
2181 #ifdef FEAT_EMACS_TAGS
2182 is_etag,
2183 #endif
2184 &tagp);
2185 if (i == FAIL)
2187 line_error = TRUE;
2188 break;
2191 #ifdef FEAT_EMACS_TAGS
2192 if (is_etag)
2193 tagp.fname = ebuf;
2194 #endif
2196 * First try matching with the pattern literally (also when it is
2197 * a regexp).
2199 cmplen = (int)(tagp.tagname_end - tagp.tagname);
2200 if (p_tl != 0 && cmplen > p_tl) /* adjust for 'taglength' */
2201 cmplen = p_tl;
2202 /* if tag length does not match, don't try comparing */
2203 if (pats->len != cmplen)
2204 match = FALSE;
2205 else
2207 if (pats->regmatch.rm_ic)
2209 match = (MB_STRNICMP(tagp.tagname, pats->pat, cmplen) == 0);
2210 if (match)
2211 match_no_ic = (STRNCMP(tagp.tagname, pats->pat,
2212 cmplen) == 0);
2214 else
2215 match = (STRNCMP(tagp.tagname, pats->pat, cmplen) == 0);
2219 * Has a regexp: Also find tags matching regexp.
2221 match_re = FALSE;
2222 if (!match && pats->regmatch.regprog != NULL)
2224 int cc;
2226 cc = *tagp.tagname_end;
2227 *tagp.tagname_end = NUL;
2228 match = vim_regexec(&pats->regmatch, tagp.tagname, (colnr_T)0);
2229 if (match)
2231 matchoff = (int)(pats->regmatch.startp[0] - tagp.tagname);
2232 if (pats->regmatch.rm_ic)
2234 pats->regmatch.rm_ic = FALSE;
2235 match_no_ic = vim_regexec(&pats->regmatch, tagp.tagname,
2236 (colnr_T)0);
2237 pats->regmatch.rm_ic = TRUE;
2240 *tagp.tagname_end = cc;
2241 match_re = TRUE;
2245 * If a match is found, add it to ga_match[].
2247 if (match)
2249 #ifdef FEAT_CSCOPE
2250 if (use_cscope)
2252 /* Don't change the ordering, always use the same table. */
2253 mtt = MT_GL_OTH;
2255 else
2256 #endif
2258 /* Decide in which array to store this match. */
2259 is_current = test_for_current(
2260 #ifdef FEAT_EMACS_TAGS
2261 is_etag,
2262 #endif
2263 tagp.fname, tagp.fname_end, tag_fname,
2264 buf_ffname);
2265 #ifdef FEAT_EMACS_TAGS
2266 is_static = FALSE;
2267 if (!is_etag) /* emacs tags are never static */
2268 #endif
2270 #ifdef FEAT_TAG_OLDSTATIC
2271 if (tagp.tagname != lbuf)
2272 is_static = TRUE; /* detected static tag before */
2273 else
2274 #endif
2275 is_static = test_for_static(&tagp);
2278 /* decide in which of the sixteen tables to store this
2279 * match */
2280 if (is_static)
2282 if (is_current)
2283 mtt = MT_ST_CUR;
2284 else
2285 mtt = MT_ST_OTH;
2287 else
2289 if (is_current)
2290 mtt = MT_GL_CUR;
2291 else
2292 mtt = MT_GL_OTH;
2294 if (pats->regmatch.rm_ic && !match_no_ic)
2295 mtt += MT_IC_OFF;
2296 if (match_re)
2297 mtt += MT_RE_OFF;
2301 * Add the found match in ga_match[mtt], avoiding duplicates.
2302 * Store the info we need later, which depends on the kind of
2303 * tags we are dealing with.
2305 if (ga_grow(&ga_match[mtt], 1) == OK)
2307 #ifdef FEAT_MBYTE
2308 char_u *conv_line = NULL;
2309 char_u *lbuf_line = lbuf;
2311 if (vimconv.vc_type != CONV_NONE)
2313 /* Convert the tag line from the encoding of the tags
2314 * file to 'encoding'. Then parse the line again. */
2315 conv_line = string_convert(&vimconv, lbuf, NULL);
2316 if (conv_line != NULL)
2318 if (parse_tag_line(conv_line,
2319 #ifdef FEAT_EMACS_TAGS
2320 is_etag,
2321 #endif
2322 &tagp) == OK)
2323 lbuf_line = conv_line;
2324 else
2325 /* doesn't work, go back to unconverted line. */
2326 (void)parse_tag_line(lbuf,
2327 #ifdef FEAT_EMACS_TAGS
2328 is_etag,
2329 #endif
2330 &tagp);
2333 #else
2334 # define lbuf_line lbuf
2335 #endif
2336 if (help_only)
2338 #ifdef FEAT_MULTI_LANG
2339 # define ML_EXTRA 3
2340 #else
2341 # define ML_EXTRA 0
2342 #endif
2344 * Append the help-heuristic number after the
2345 * tagname, for sorting it later.
2347 *tagp.tagname_end = NUL;
2348 len = (int)(tagp.tagname_end - tagp.tagname);
2349 mfp = (struct match_found *)
2350 alloc((int)sizeof(struct match_found) + len
2351 + 10 + ML_EXTRA);
2352 if (mfp != NULL)
2354 /* "len" includes the language and the NUL, but
2355 * not the priority. */
2356 mfp->len = len + ML_EXTRA + 1;
2357 #define ML_HELP_LEN 6
2358 p = mfp->match;
2359 STRCPY(p, tagp.tagname);
2360 #ifdef FEAT_MULTI_LANG
2361 p[len] = '@';
2362 STRCPY(p + len + 1, help_lang);
2363 #endif
2364 sprintf((char *)p + len + 1 + ML_EXTRA, "%06d",
2365 help_heuristic(tagp.tagname,
2366 match_re ? matchoff : 0, !match_no_ic)
2367 #ifdef FEAT_MULTI_LANG
2368 + help_pri
2369 #endif
2372 *tagp.tagname_end = TAB;
2374 else if (name_only)
2376 if (get_it_again)
2378 char_u *temp_end = tagp.command;
2380 if (*temp_end == '/')
2381 while (*temp_end && *temp_end != '\r'
2382 && *temp_end != '\n'
2383 && *temp_end != '$')
2384 temp_end++;
2386 if (tagp.command + 2 < temp_end)
2388 len = (int)(temp_end - tagp.command - 2);
2389 mfp = (struct match_found *)alloc(
2390 (int)sizeof(struct match_found) + len);
2391 if (mfp != NULL)
2393 mfp->len = len + 1; /* include the NUL */
2394 p = mfp->match;
2395 vim_strncpy(p, tagp.command + 2, len);
2398 else
2399 mfp = NULL;
2400 get_it_again = FALSE;
2402 else
2404 len = (int)(tagp.tagname_end - tagp.tagname);
2405 mfp = (struct match_found *)alloc(
2406 (int)sizeof(struct match_found) + len);
2407 if (mfp != NULL)
2409 mfp->len = len + 1; /* include the NUL */
2410 p = mfp->match;
2411 vim_strncpy(p, tagp.tagname, len);
2414 /* if wanted, re-read line to get long form too */
2415 if (State & INSERT)
2416 get_it_again = p_sft;
2419 else
2421 /* Save the tag in a buffer.
2422 * Emacs tag: <mtt><tag_fname><NUL><ebuf><NUL><lbuf>
2423 * other tag: <mtt><tag_fname><NUL><NUL><lbuf>
2424 * without Emacs tags: <mtt><tag_fname><NUL><lbuf>
2426 len = (int)STRLEN(tag_fname)
2427 + (int)STRLEN(lbuf_line) + 3;
2428 #ifdef FEAT_EMACS_TAGS
2429 if (is_etag)
2430 len += (int)STRLEN(ebuf) + 1;
2431 else
2432 ++len;
2433 #endif
2434 mfp = (struct match_found *)alloc(
2435 (int)sizeof(struct match_found) + len);
2436 if (mfp != NULL)
2438 mfp->len = len;
2439 p = mfp->match;
2440 p[0] = mtt;
2441 STRCPY(p + 1, tag_fname);
2442 #ifdef BACKSLASH_IN_FILENAME
2443 /* Ignore differences in slashes, avoid adding
2444 * both path/file and path\file. */
2445 slash_adjust(p + 1);
2446 #endif
2447 s = p + 1 + STRLEN(tag_fname) + 1;
2448 #ifdef FEAT_EMACS_TAGS
2449 if (is_etag)
2451 STRCPY(s, ebuf);
2452 s += STRLEN(ebuf) + 1;
2454 else
2455 *s++ = NUL;
2456 #endif
2457 STRCPY(s, lbuf_line);
2461 if (mfp != NULL)
2464 * Don't add identical matches.
2465 * This can take a lot of time when finding many
2466 * matches, check for CTRL-C now and then.
2467 * Add all cscope tags, because they are all listed.
2469 #ifdef FEAT_CSCOPE
2470 if (use_cscope)
2471 i = -1;
2472 else
2473 #endif
2474 for (i = ga_match[mtt].ga_len; --i >= 0 && !got_int; )
2476 mfp2 = ((struct match_found **)
2477 (ga_match[mtt].ga_data))[i];
2478 if (mfp2->len == mfp->len
2479 && vim_memcmp(mfp2->match, mfp->match,
2480 (size_t)mfp->len) == 0)
2481 break;
2482 line_breakcheck();
2484 if (i < 0)
2486 ((struct match_found **)(ga_match[mtt].ga_data))
2487 [ga_match[mtt].ga_len++] = mfp;
2488 ++match_count;
2490 else
2491 vim_free(mfp);
2493 #ifdef FEAT_MBYTE
2494 /* Note: this makes the values in "tagp" invalid! */
2495 vim_free(conv_line);
2496 #endif
2498 else /* Out of memory! Just forget about the rest. */
2500 retval = OK;
2501 stop_searching = TRUE;
2502 break;
2505 #ifdef FEAT_CSCOPE
2506 if (use_cscope && eof)
2507 break;
2508 #endif
2509 } /* forever */
2511 if (line_error)
2513 EMSG2(_("E431: Format error in tags file \"%s\""), tag_fname);
2514 #ifdef FEAT_CSCOPE
2515 if (!use_cscope)
2516 #endif
2517 EMSGN(_("Before byte %ld"), (long)ftell(fp));
2518 stop_searching = TRUE;
2519 line_error = FALSE;
2522 #ifdef FEAT_CSCOPE
2523 if (!use_cscope)
2524 #endif
2525 fclose(fp);
2526 #ifdef FEAT_EMACS_TAGS
2527 while (incstack_idx)
2529 --incstack_idx;
2530 fclose(incstack[incstack_idx].fp);
2531 vim_free(incstack[incstack_idx].etag_fname);
2533 #endif
2534 #ifdef FEAT_MBYTE
2535 if (pats == &convpat)
2537 /* Go back from converted pattern to original pattern. */
2538 vim_free(pats->pat);
2539 vim_free(pats->regmatch.regprog);
2540 orgpat.regmatch.rm_ic = pats->regmatch.rm_ic;
2541 pats = &orgpat;
2543 if (vimconv.vc_type != CONV_NONE)
2544 convert_setup(&vimconv, NULL, NULL);
2545 #endif
2547 #ifdef FEAT_TAG_BINS
2548 if (sort_error)
2550 EMSG2(_("E432: Tags file not sorted: %s"), tag_fname);
2551 sort_error = FALSE;
2553 #endif
2556 * Stop searching if sufficient tags have been found.
2558 if (match_count >= mincount)
2560 retval = OK;
2561 stop_searching = TRUE;
2564 #ifdef FEAT_CSCOPE
2565 if (stop_searching || use_cscope)
2566 #else
2567 if (stop_searching)
2568 #endif
2569 break;
2571 } /* end of for-each-file loop */
2573 #ifdef FEAT_CSCOPE
2574 if (!use_cscope)
2575 #endif
2576 tagname_free(&tn);
2578 #ifdef FEAT_TAG_BINS
2579 /* stop searching when already did a linear search, or when TAG_NOIC
2580 * used, and 'ignorecase' not set or already did case-ignore search */
2581 if (stop_searching || linear || (!p_ic && noic) || pats->regmatch.rm_ic)
2582 break;
2583 # ifdef FEAT_CSCOPE
2584 if (use_cscope)
2585 break;
2586 # endif
2587 pats->regmatch.rm_ic = TRUE; /* try another time while ignoring case */
2589 #endif
2591 if (!stop_searching)
2593 if (!did_open && verbose) /* never opened any tags file */
2594 EMSG(_("E433: No tags file"));
2595 retval = OK; /* It's OK even when no tag found */
2598 findtag_end:
2599 vim_free(lbuf);
2600 vim_free(pats->regmatch.regprog);
2601 vim_free(tag_fname);
2602 #ifdef FEAT_EMACS_TAGS
2603 vim_free(ebuf);
2604 #endif
2607 * Move the matches from the ga_match[] arrays into one list of
2608 * matches. When retval == FAIL, free the matches.
2610 if (retval == FAIL)
2611 match_count = 0;
2613 if (match_count > 0)
2614 matches = (char_u **)lalloc((long_u)(match_count * sizeof(char_u *)),
2615 TRUE);
2616 else
2617 matches = NULL;
2618 match_count = 0;
2619 for (mtt = 0; mtt < MT_COUNT; ++mtt)
2621 for (i = 0; i < ga_match[mtt].ga_len; ++i)
2623 mfp = ((struct match_found **)(ga_match[mtt].ga_data))[i];
2624 if (matches == NULL)
2625 vim_free(mfp);
2626 else
2628 /* To avoid allocating memory again we turn the struct
2629 * match_found into a string. For help the priority was not
2630 * included in the length. */
2631 mch_memmove(mfp, mfp->match,
2632 (size_t)(mfp->len + (help_only ? ML_HELP_LEN : 0)));
2633 matches[match_count++] = (char_u *)mfp;
2636 ga_clear(&ga_match[mtt]);
2639 *matchesp = matches;
2640 *num_matches = match_count;
2642 curbuf->b_help = help_save;
2643 #ifdef FEAT_MULTI_LANG
2644 vim_free(saved_pat);
2645 #endif
2647 return retval;
2650 static garray_T tag_fnames = GA_EMPTY;
2651 static void found_tagfile_cb __ARGS((char_u *fname, void *cookie));
2654 * Callback function for finding all "tags" and "tags-??" files in
2655 * 'runtimepath' doc directories.
2657 static void
2658 found_tagfile_cb(fname, cookie)
2659 char_u *fname;
2660 void *cookie UNUSED;
2662 if (ga_grow(&tag_fnames, 1) == OK)
2663 ((char_u **)(tag_fnames.ga_data))[tag_fnames.ga_len++] =
2664 vim_strsave(fname);
2667 #if defined(EXITFREE) || defined(PROTO)
2668 void
2669 free_tag_stuff()
2671 ga_clear_strings(&tag_fnames);
2672 do_tag(NULL, DT_FREE, 0, 0, 0);
2673 tag_freematch();
2675 # if defined(FEAT_WINDOWS) && defined(FEAT_QUICKFIX)
2676 if (ptag_entry.tagname)
2678 vim_free(ptag_entry.tagname);
2679 ptag_entry.tagname = NULL;
2681 # endif
2683 #endif
2686 * Get the next name of a tag file from the tag file list.
2687 * For help files, use "tags" file only.
2689 * Return FAIL if no more tag file names, OK otherwise.
2692 get_tagfname(tnp, first, buf)
2693 tagname_T *tnp; /* holds status info */
2694 int first; /* TRUE when first file name is wanted */
2695 char_u *buf; /* pointer to buffer of MAXPATHL chars */
2697 char_u *fname = NULL;
2698 char_u *r_ptr;
2700 if (first)
2701 vim_memset(tnp, 0, sizeof(tagname_T));
2703 if (curbuf->b_help)
2706 * For help files it's done in a completely different way:
2707 * Find "doc/tags" and "doc/tags-??" in all directories in
2708 * 'runtimepath'.
2710 if (first)
2712 ga_clear_strings(&tag_fnames);
2713 ga_init2(&tag_fnames, (int)sizeof(char_u *), 10);
2714 do_in_runtimepath((char_u *)
2715 #ifdef FEAT_MULTI_LANG
2716 # ifdef VMS
2717 /* Functions decc$to_vms() and decc$translate_vms() crash
2718 * on some VMS systems with wildcards "??". Seems ECO
2719 * patches do fix the problem in C RTL, but we can't use
2720 * an #ifdef for that. */
2721 "doc/tags doc/tags-*"
2722 # else
2723 "doc/tags doc/tags-??"
2724 # endif
2725 #else
2726 "doc/tags"
2727 #endif
2728 , TRUE, found_tagfile_cb, NULL);
2731 if (tnp->tn_hf_idx >= tag_fnames.ga_len)
2733 /* Not found in 'runtimepath', use 'helpfile', if it exists and
2734 * wasn't used yet, replacing "help.txt" with "tags". */
2735 if (tnp->tn_hf_idx > tag_fnames.ga_len || *p_hf == NUL)
2736 return FAIL;
2737 ++tnp->tn_hf_idx;
2738 STRCPY(buf, p_hf);
2739 STRCPY(gettail(buf), "tags");
2741 else
2742 vim_strncpy(buf, ((char_u **)(tag_fnames.ga_data))[
2743 tnp->tn_hf_idx++], MAXPATHL - 1);
2744 return OK;
2747 if (first)
2749 /* Init. We make a copy of 'tags', because autocommands may change
2750 * the value without notifying us. */
2751 tnp->tn_tags = vim_strsave((*curbuf->b_p_tags != NUL)
2752 ? curbuf->b_p_tags : p_tags);
2753 if (tnp->tn_tags == NULL)
2754 return FAIL;
2755 tnp->tn_np = tnp->tn_tags;
2759 * Loop until we have found a file name that can be used.
2760 * There are two states:
2761 * tnp->tn_did_filefind_init == FALSE: setup for next part in 'tags'.
2762 * tnp->tn_did_filefind_init == TRUE: find next file in this part.
2764 for (;;)
2766 if (tnp->tn_did_filefind_init)
2768 fname = vim_findfile(tnp->tn_search_ctx);
2769 if (fname != NULL)
2770 break;
2772 tnp->tn_did_filefind_init = FALSE;
2774 else
2776 char_u *filename = NULL;
2778 /* Stop when used all parts of 'tags'. */
2779 if (*tnp->tn_np == NUL)
2781 vim_findfile_cleanup(tnp->tn_search_ctx);
2782 tnp->tn_search_ctx = NULL;
2783 return FAIL;
2787 * Copy next file name into buf.
2789 buf[0] = NUL;
2790 (void)copy_option_part(&tnp->tn_np, buf, MAXPATHL - 1, " ,");
2792 #ifdef FEAT_PATH_EXTRA
2793 r_ptr = vim_findfile_stopdir(buf);
2794 #else
2795 r_ptr = NULL;
2796 #endif
2797 /* move the filename one char forward and truncate the
2798 * filepath with a NUL */
2799 filename = gettail(buf);
2800 STRMOVE(filename + 1, filename);
2801 *filename++ = NUL;
2803 tnp->tn_search_ctx = vim_findfile_init(buf, filename,
2804 r_ptr, 100,
2805 FALSE, /* don't free visited list */
2806 FINDFILE_FILE, /* we search for a file */
2807 tnp->tn_search_ctx, TRUE, curbuf->b_ffname);
2808 if (tnp->tn_search_ctx != NULL)
2809 tnp->tn_did_filefind_init = TRUE;
2813 STRCPY(buf, fname);
2814 vim_free(fname);
2815 return OK;
2819 * Free the contents of a tagname_T that was filled by get_tagfname().
2821 void
2822 tagname_free(tnp)
2823 tagname_T *tnp;
2825 vim_free(tnp->tn_tags);
2826 vim_findfile_cleanup(tnp->tn_search_ctx);
2827 tnp->tn_search_ctx = NULL;
2828 ga_clear_strings(&tag_fnames);
2832 * Parse one line from the tags file. Find start/end of tag name, start/end of
2833 * file name and start of search pattern.
2835 * If is_etag is TRUE, tagp->fname and tagp->fname_end are not set.
2837 * Return FAIL if there is a format error in this line, OK otherwise.
2839 static int
2840 parse_tag_line(lbuf,
2841 #ifdef FEAT_EMACS_TAGS
2842 is_etag,
2843 #endif
2844 tagp)
2845 char_u *lbuf; /* line to be parsed */
2846 #ifdef FEAT_EMACS_TAGS
2847 int is_etag;
2848 #endif
2849 tagptrs_T *tagp;
2851 char_u *p;
2853 #ifdef FEAT_EMACS_TAGS
2854 char_u *p_7f;
2856 if (is_etag)
2859 * There are two formats for an emacs tag line:
2860 * 1: struct EnvBase ^?EnvBase^A139,4627
2861 * 2: #define ARPB_WILD_WORLD ^?153,5194
2863 p_7f = vim_strchr(lbuf, 0x7f);
2864 if (p_7f == NULL)
2866 etag_fail:
2867 if (vim_strchr(lbuf, '\n') == NULL)
2869 /* Truncated line. Ignore it. */
2870 if (p_verbose >= 5)
2872 verbose_enter();
2873 MSG(_("Ignoring long line in tags file"));
2874 verbose_leave();
2876 tagp->command = lbuf;
2877 tagp->tagname = lbuf;
2878 tagp->tagname_end = lbuf;
2879 return OK;
2881 return FAIL;
2884 /* Find ^A. If not found the line number is after the 0x7f */
2885 p = vim_strchr(p_7f, Ctrl_A);
2886 if (p == NULL)
2887 p = p_7f + 1;
2888 else
2889 ++p;
2891 if (!VIM_ISDIGIT(*p)) /* check for start of line number */
2892 goto etag_fail;
2893 tagp->command = p;
2896 if (p[-1] == Ctrl_A) /* first format: explicit tagname given */
2898 tagp->tagname = p_7f + 1;
2899 tagp->tagname_end = p - 1;
2901 else /* second format: isolate tagname */
2903 /* find end of tagname */
2904 for (p = p_7f - 1; !vim_iswordc(*p); --p)
2905 if (p == lbuf)
2906 goto etag_fail;
2907 tagp->tagname_end = p + 1;
2908 while (p >= lbuf && vim_iswordc(*p))
2909 --p;
2910 tagp->tagname = p + 1;
2913 else /* not an Emacs tag */
2915 #endif
2916 /* Isolate the tagname, from lbuf up to the first white */
2917 tagp->tagname = lbuf;
2918 #ifdef FEAT_TAG_ANYWHITE
2919 p = skiptowhite(lbuf);
2920 #else
2921 p = vim_strchr(lbuf, TAB);
2922 if (p == NULL)
2923 return FAIL;
2924 #endif
2925 tagp->tagname_end = p;
2927 /* Isolate file name, from first to second white space */
2928 #ifdef FEAT_TAG_ANYWHITE
2929 p = skipwhite(p);
2930 #else
2931 if (*p != NUL)
2932 ++p;
2933 #endif
2934 tagp->fname = p;
2935 #ifdef FEAT_TAG_ANYWHITE
2936 p = skiptowhite(p);
2937 #else
2938 p = vim_strchr(p, TAB);
2939 if (p == NULL)
2940 return FAIL;
2941 #endif
2942 tagp->fname_end = p;
2944 /* find start of search command, after second white space */
2945 #ifdef FEAT_TAG_ANYWHITE
2946 p = skipwhite(p);
2947 #else
2948 if (*p != NUL)
2949 ++p;
2950 #endif
2951 if (*p == NUL)
2952 return FAIL;
2953 tagp->command = p;
2954 #ifdef FEAT_EMACS_TAGS
2956 #endif
2958 return OK;
2962 * Check if tagname is a static tag
2964 * Static tags produced by the older ctags program have the format:
2965 * 'file:tag file /pattern'.
2966 * This is only recognized when both occurrence of 'file' are the same, to
2967 * avoid recognizing "string::string" or ":exit".
2969 * Static tags produced by the new ctags program have the format:
2970 * 'tag file /pattern/;"<Tab>file:' "
2972 * Return TRUE if it is a static tag and adjust *tagname to the real tag.
2973 * Return FALSE if it is not a static tag.
2975 static int
2976 test_for_static(tagp)
2977 tagptrs_T *tagp;
2979 char_u *p;
2981 #ifdef FEAT_TAG_OLDSTATIC
2982 int len;
2985 * Check for old style static tag: "file:tag file .."
2987 len = (int)(tagp->fname_end - tagp->fname);
2988 p = tagp->tagname + len;
2989 if ( p < tagp->tagname_end
2990 && *p == ':'
2991 && fnamencmp(tagp->tagname, tagp->fname, len) == 0)
2993 tagp->tagname = p + 1;
2994 return TRUE;
2996 #endif
2999 * Check for new style static tag ":...<Tab>file:[<Tab>...]"
3001 p = tagp->command;
3002 while ((p = vim_strchr(p, '\t')) != NULL)
3004 ++p;
3005 if (STRNCMP(p, "file:", 5) == 0)
3006 return TRUE;
3009 return FALSE;
3013 * Parse a line from a matching tag. Does not change the line itself.
3015 * The line that we get looks like this:
3016 * Emacs tag: <mtt><tag_fname><NUL><ebuf><NUL><lbuf>
3017 * other tag: <mtt><tag_fname><NUL><NUL><lbuf>
3018 * without Emacs tags: <mtt><tag_fname><NUL><lbuf>
3020 * Return OK or FAIL.
3022 static int
3023 parse_match(lbuf, tagp)
3024 char_u *lbuf; /* input: matching line */
3025 tagptrs_T *tagp; /* output: pointers into the line */
3027 int retval;
3028 char_u *p;
3029 char_u *pc, *pt;
3031 tagp->tag_fname = lbuf + 1;
3032 lbuf += STRLEN(tagp->tag_fname) + 2;
3033 #ifdef FEAT_EMACS_TAGS
3034 if (*lbuf)
3036 tagp->is_etag = TRUE;
3037 tagp->fname = lbuf;
3038 lbuf += STRLEN(lbuf);
3039 tagp->fname_end = lbuf++;
3041 else
3043 tagp->is_etag = FALSE;
3044 ++lbuf;
3046 #endif
3048 /* Find search pattern and the file name for non-etags. */
3049 retval = parse_tag_line(lbuf,
3050 #ifdef FEAT_EMACS_TAGS
3051 tagp->is_etag,
3052 #endif
3053 tagp);
3055 tagp->tagkind = NULL;
3056 tagp->command_end = NULL;
3058 if (retval == OK)
3060 /* Try to find a kind field: "kind:<kind>" or just "<kind>"*/
3061 p = tagp->command;
3062 if (find_extra(&p) == OK)
3064 tagp->command_end = p;
3065 p += 2; /* skip ";\"" */
3066 if (*p++ == TAB)
3067 while (ASCII_ISALPHA(*p))
3069 if (STRNCMP(p, "kind:", 5) == 0)
3071 tagp->tagkind = p + 5;
3072 break;
3074 pc = vim_strchr(p, ':');
3075 pt = vim_strchr(p, '\t');
3076 if (pc == NULL || (pt != NULL && pc > pt))
3078 tagp->tagkind = p;
3079 break;
3081 if (pt == NULL)
3082 break;
3083 p = pt + 1;
3086 if (tagp->tagkind != NULL)
3088 for (p = tagp->tagkind;
3089 *p && *p != '\t' && *p != '\r' && *p != '\n'; ++p)
3091 tagp->tagkind_end = p;
3094 return retval;
3098 * Find out the actual file name of a tag. Concatenate the tags file name
3099 * with the matching tag file name.
3100 * Returns an allocated string or NULL (out of memory).
3102 static char_u *
3103 tag_full_fname(tagp)
3104 tagptrs_T *tagp;
3106 char_u *fullname;
3107 int c;
3109 #ifdef FEAT_EMACS_TAGS
3110 if (tagp->is_etag)
3111 c = 0; /* to shut up GCC */
3112 else
3113 #endif
3115 c = *tagp->fname_end;
3116 *tagp->fname_end = NUL;
3118 fullname = expand_tag_fname(tagp->fname, tagp->tag_fname, FALSE);
3120 #ifdef FEAT_EMACS_TAGS
3121 if (!tagp->is_etag)
3122 #endif
3123 *tagp->fname_end = c;
3125 return fullname;
3129 * Jump to a tag that has been found in one of the tag files
3131 * returns OK for success, NOTAGFILE when file not found, FAIL otherwise.
3133 static int
3134 jumpto_tag(lbuf, forceit, keep_help)
3135 char_u *lbuf; /* line from the tags file for this tag */
3136 int forceit; /* :ta with ! */
3137 int keep_help; /* keep help flag (FALSE for cscope) */
3139 int save_secure;
3140 int save_magic;
3141 int save_p_ws, save_p_scs, save_p_ic;
3142 linenr_T save_lnum;
3143 int csave = 0;
3144 char_u *str;
3145 char_u *pbuf; /* search pattern buffer */
3146 char_u *pbuf_end;
3147 char_u *tofree_fname = NULL;
3148 char_u *fname;
3149 tagptrs_T tagp;
3150 int retval = FAIL;
3151 int getfile_result;
3152 int search_options;
3153 #ifdef FEAT_SEARCH_EXTRA
3154 int save_no_hlsearch;
3155 #endif
3156 #if defined(FEAT_WINDOWS) && defined(FEAT_QUICKFIX)
3157 win_T *curwin_save = NULL;
3158 #endif
3159 char_u *full_fname = NULL;
3160 #ifdef FEAT_FOLDING
3161 int old_KeyTyped = KeyTyped; /* getting the file may reset it */
3162 #endif
3164 pbuf = alloc(LSIZE);
3166 /* parse the match line into the tagp structure */
3167 if (pbuf == NULL || parse_match(lbuf, &tagp) == FAIL)
3169 tagp.fname_end = NULL;
3170 goto erret;
3173 /* truncate the file name, so it can be used as a string */
3174 csave = *tagp.fname_end;
3175 *tagp.fname_end = NUL;
3176 fname = tagp.fname;
3178 /* copy the command to pbuf[], remove trailing CR/NL */
3179 str = tagp.command;
3180 for (pbuf_end = pbuf; *str && *str != '\n' && *str != '\r'; )
3182 #ifdef FEAT_EMACS_TAGS
3183 if (tagp.is_etag && *str == ',')/* stop at ',' after line number */
3184 break;
3185 #endif
3186 *pbuf_end++ = *str++;
3188 *pbuf_end = NUL;
3190 #ifdef FEAT_EMACS_TAGS
3191 if (!tagp.is_etag)
3192 #endif
3195 * Remove the "<Tab>fieldname:value" stuff; we don't need it here.
3197 str = pbuf;
3198 if (find_extra(&str) == OK)
3200 pbuf_end = str;
3201 *pbuf_end = NUL;
3206 * Expand file name, when needed (for environment variables).
3207 * If 'tagrelative' option set, may change file name.
3209 fname = expand_tag_fname(fname, tagp.tag_fname, TRUE);
3210 if (fname == NULL)
3211 goto erret;
3212 tofree_fname = fname; /* free() it later */
3215 * Check if the file with the tag exists before abandoning the current
3216 * file. Also accept a file name for which there is a matching BufReadCmd
3217 * autocommand event (e.g., http://sys/file).
3219 if (mch_getperm(fname) < 0
3220 #ifdef FEAT_AUTOCMD
3221 && !has_autocmd(EVENT_BUFREADCMD, fname, NULL)
3222 #endif
3225 retval = NOTAGFILE;
3226 vim_free(nofile_fname);
3227 nofile_fname = vim_strsave(fname);
3228 if (nofile_fname == NULL)
3229 nofile_fname = empty_option;
3230 goto erret;
3233 ++RedrawingDisabled;
3235 #ifdef FEAT_GUI
3236 need_mouse_correct = TRUE;
3237 #endif
3239 #if defined(FEAT_WINDOWS) && defined(FEAT_QUICKFIX)
3240 if (g_do_tagpreview)
3242 postponed_split = 0; /* don't split again below */
3243 curwin_save = curwin; /* Save current window */
3246 * If we are reusing a window, we may change dir when
3247 * entering it (autocommands) so turn the tag filename
3248 * into a fullpath
3250 if (!curwin->w_p_pvw)
3252 full_fname = FullName_save(fname, FALSE);
3253 fname = full_fname;
3256 * Make the preview window the current window.
3257 * Open a preview window when needed.
3259 prepare_tagpreview(TRUE);
3263 /* If it was a CTRL-W CTRL-] command split window now. For ":tab tag"
3264 * open a new tab page. */
3265 if (postponed_split || cmdmod.tab != 0)
3267 win_split(postponed_split > 0 ? postponed_split : 0,
3268 postponed_split_flags);
3269 # ifdef FEAT_SCROLLBIND
3270 curwin->w_p_scb = FALSE;
3271 # endif
3273 #endif
3275 if (keep_help)
3277 /* A :ta from a help file will keep the b_help flag set. For ":ptag"
3278 * we need to use the flag from the window where we came from. */
3279 #if defined(FEAT_WINDOWS) && defined(FEAT_QUICKFIX)
3280 if (g_do_tagpreview)
3281 keep_help_flag = curwin_save->w_buffer->b_help;
3282 else
3283 #endif
3284 keep_help_flag = curbuf->b_help;
3286 getfile_result = getfile(0, fname, NULL, TRUE, (linenr_T)0, forceit);
3287 keep_help_flag = FALSE;
3289 if (getfile_result <= 0) /* got to the right file */
3291 curwin->w_set_curswant = TRUE;
3292 #ifdef FEAT_WINDOWS
3293 postponed_split = 0;
3294 #endif
3296 save_secure = secure;
3297 secure = 1;
3298 #ifdef HAVE_SANDBOX
3299 ++sandbox;
3300 #endif
3301 save_magic = p_magic;
3302 p_magic = FALSE; /* always execute with 'nomagic' */
3303 #ifdef FEAT_SEARCH_EXTRA
3304 /* Save value of no_hlsearch, jumping to a tag is not a real search */
3305 save_no_hlsearch = no_hlsearch;
3306 #endif
3309 * If 'cpoptions' contains 't', store the search pattern for the "n"
3310 * command. If 'cpoptions' does not contain 't', the search pattern
3311 * is not stored.
3313 if (vim_strchr(p_cpo, CPO_TAGPAT) != NULL)
3314 search_options = 0;
3315 else
3316 search_options = SEARCH_KEEP;
3319 * If the command is a search, try here.
3321 * Reset 'smartcase' for the search, since the search pattern was not
3322 * typed by the user.
3323 * Only use do_search() when there is a full search command, without
3324 * anything following.
3326 str = pbuf;
3327 if (pbuf[0] == '/' || pbuf[0] == '?')
3328 str = skip_regexp(pbuf + 1, pbuf[0], FALSE, NULL) + 1;
3329 if (str > pbuf_end - 1) /* search command with nothing following */
3331 save_p_ws = p_ws;
3332 save_p_ic = p_ic;
3333 save_p_scs = p_scs;
3334 p_ws = TRUE; /* need 'wrapscan' for backward searches */
3335 p_ic = FALSE; /* don't ignore case now */
3336 p_scs = FALSE;
3337 #if 0 /* disabled for now */
3338 #ifdef FEAT_CMDHIST
3339 /* put pattern in search history */
3340 add_to_history(HIST_SEARCH, pbuf + 1, TRUE, pbuf[0]);
3341 #endif
3342 #endif
3343 save_lnum = curwin->w_cursor.lnum;
3344 curwin->w_cursor.lnum = 0; /* start search before first line */
3345 if (do_search(NULL, pbuf[0], pbuf + 1, (long)1,
3346 search_options, NULL))
3347 retval = OK;
3348 else
3350 int found = 1;
3351 int cc;
3354 * try again, ignore case now
3356 p_ic = TRUE;
3357 if (!do_search(NULL, pbuf[0], pbuf + 1, (long)1,
3358 search_options, NULL))
3361 * Failed to find pattern, take a guess: "^func ("
3363 found = 2;
3364 (void)test_for_static(&tagp);
3365 cc = *tagp.tagname_end;
3366 *tagp.tagname_end = NUL;
3367 sprintf((char *)pbuf, "^%s\\s\\*(", tagp.tagname);
3368 if (!do_search(NULL, '/', pbuf, (long)1,
3369 search_options, NULL))
3371 /* Guess again: "^char * \<func (" */
3372 sprintf((char *)pbuf, "^\\[#a-zA-Z_]\\.\\*\\<%s\\s\\*(",
3373 tagp.tagname);
3374 if (!do_search(NULL, '/', pbuf, (long)1,
3375 search_options, NULL))
3376 found = 0;
3378 *tagp.tagname_end = cc;
3380 if (found == 0)
3382 EMSG(_("E434: Can't find tag pattern"));
3383 curwin->w_cursor.lnum = save_lnum;
3385 else
3388 * Only give a message when really guessed, not when 'ic'
3389 * is set and match found while ignoring case.
3391 if (found == 2 || !save_p_ic)
3393 MSG(_("E435: Couldn't find tag, just guessing!"));
3394 if (!msg_scrolled && msg_silent == 0)
3396 out_flush();
3397 ui_delay(1000L, TRUE);
3400 retval = OK;
3403 p_ws = save_p_ws;
3404 p_ic = save_p_ic;
3405 p_scs = save_p_scs;
3407 /* A search command may have positioned the cursor beyond the end
3408 * of the line. May need to correct that here. */
3409 check_cursor();
3411 else
3413 curwin->w_cursor.lnum = 1; /* start command in line 1 */
3414 do_cmdline_cmd(pbuf);
3415 retval = OK;
3419 * When the command has done something that is not allowed make sure
3420 * the error message can be seen.
3422 if (secure == 2)
3423 wait_return(TRUE);
3424 secure = save_secure;
3425 p_magic = save_magic;
3426 #ifdef HAVE_SANDBOX
3427 --sandbox;
3428 #endif
3429 #ifdef FEAT_SEARCH_EXTRA
3430 /* restore no_hlsearch when keeping the old search pattern */
3431 if (search_options)
3432 no_hlsearch = save_no_hlsearch;
3433 #endif
3435 /* Return OK if jumped to another file (at least we found the file!). */
3436 if (getfile_result == -1)
3437 retval = OK;
3439 if (retval == OK)
3442 * For a help buffer: Put the cursor line at the top of the window,
3443 * the help subject will be below it.
3445 if (curbuf->b_help)
3446 set_topline(curwin, curwin->w_cursor.lnum);
3447 #ifdef FEAT_FOLDING
3448 if ((fdo_flags & FDO_TAG) && old_KeyTyped)
3449 foldOpenCursor();
3450 #endif
3453 #if defined(FEAT_WINDOWS) && defined(FEAT_QUICKFIX)
3454 if (g_do_tagpreview && curwin != curwin_save && win_valid(curwin_save))
3456 /* Return cursor to where we were */
3457 validate_cursor();
3458 redraw_later(VALID);
3459 win_enter(curwin_save, TRUE);
3461 #endif
3463 --RedrawingDisabled;
3465 else
3467 --RedrawingDisabled;
3468 #ifdef FEAT_WINDOWS
3469 if (postponed_split) /* close the window */
3471 win_close(curwin, FALSE);
3472 postponed_split = 0;
3474 #endif
3477 erret:
3478 #if defined(FEAT_WINDOWS) && defined(FEAT_QUICKFIX)
3479 g_do_tagpreview = 0; /* For next time */
3480 #endif
3481 if (tagp.fname_end != NULL)
3482 *tagp.fname_end = csave;
3483 vim_free(pbuf);
3484 vim_free(tofree_fname);
3485 vim_free(full_fname);
3487 return retval;
3491 * If "expand" is TRUE, expand wildcards in fname.
3492 * If 'tagrelative' option set, change fname (name of file containing tag)
3493 * according to tag_fname (name of tag file containing fname).
3494 * Returns a pointer to allocated memory (or NULL when out of memory).
3496 static char_u *
3497 expand_tag_fname(fname, tag_fname, expand)
3498 char_u *fname;
3499 char_u *tag_fname;
3500 int expand;
3502 char_u *p;
3503 char_u *retval;
3504 char_u *expanded_fname = NULL;
3505 expand_T xpc;
3508 * Expand file name (for environment variables) when needed.
3510 if (expand && mch_has_wildcard(fname))
3512 ExpandInit(&xpc);
3513 xpc.xp_context = EXPAND_FILES;
3514 expanded_fname = ExpandOne(&xpc, (char_u *)fname, NULL,
3515 WILD_LIST_NOTFOUND|WILD_SILENT, WILD_EXPAND_FREE);
3516 if (expanded_fname != NULL)
3517 fname = expanded_fname;
3520 if ((p_tr || curbuf->b_help)
3521 && !vim_isAbsName(fname)
3522 && (p = gettail(tag_fname)) != tag_fname)
3524 retval = alloc(MAXPATHL);
3525 if (retval != NULL)
3527 STRCPY(retval, tag_fname);
3528 vim_strncpy(retval + (p - tag_fname), fname,
3529 MAXPATHL - (p - tag_fname) - 1);
3531 * Translate names like "src/a/../b/file.c" into "src/b/file.c".
3533 simplify_filename(retval);
3536 else
3537 retval = vim_strsave(fname);
3539 vim_free(expanded_fname);
3541 return retval;
3545 * Converts a file name into a canonical form. It simplifies a file name into
3546 * its simplest form by stripping out unneeded components, if any. The
3547 * resulting file name is simplified in place and will either be the same
3548 * length as that supplied, or shorter.
3550 void
3551 simplify_filename(filename)
3552 char_u *filename;
3554 #ifndef AMIGA /* Amiga doesn't have "..", it uses "/" */
3555 int components = 0;
3556 char_u *p, *tail, *start;
3557 int stripping_disabled = FALSE;
3558 int relative = TRUE;
3560 p = filename;
3561 #ifdef BACKSLASH_IN_FILENAME
3562 if (p[1] == ':') /* skip "x:" */
3563 p += 2;
3564 #endif
3566 if (vim_ispathsep(*p))
3568 relative = FALSE;
3570 ++p;
3571 while (vim_ispathsep(*p));
3573 start = p; /* remember start after "c:/" or "/" or "///" */
3577 /* At this point "p" is pointing to the char following a single "/"
3578 * or "p" is at the "start" of the (absolute or relative) path name. */
3579 #ifdef VMS
3580 /* VMS allows device:[path] - don't strip the [ in directory */
3581 if ((*p == '[' || *p == '<') && p > filename && p[-1] == ':')
3583 /* :[ or :< composition: vms directory component */
3584 ++components;
3585 p = getnextcomp(p + 1);
3587 /* allow remote calls as host"user passwd"::device:[path] */
3588 else if (p[0] == ':' && p[1] == ':' && p > filename && p[-1] == '"' )
3590 /* ":: composition: vms host/passwd component */
3591 ++components;
3592 p = getnextcomp(p + 2);
3594 else
3595 #endif
3596 if (vim_ispathsep(*p))
3597 STRMOVE(p, p + 1); /* remove duplicate "/" */
3598 else if (p[0] == '.' && (vim_ispathsep(p[1]) || p[1] == NUL))
3600 if (p == start && relative)
3601 p += 1 + (p[1] != NUL); /* keep single "." or leading "./" */
3602 else
3604 /* Strip "./" or ".///". If we are at the end of the file name
3605 * and there is no trailing path separator, either strip "/." if
3606 * we are after "start", or strip "." if we are at the beginning
3607 * of an absolute path name . */
3608 tail = p + 1;
3609 if (p[1] != NUL)
3610 while (vim_ispathsep(*tail))
3611 mb_ptr_adv(tail);
3612 else if (p > start)
3613 --p; /* strip preceding path separator */
3614 STRMOVE(p, tail);
3617 else if (p[0] == '.' && p[1] == '.' &&
3618 (vim_ispathsep(p[2]) || p[2] == NUL))
3620 /* Skip to after ".." or "../" or "..///". */
3621 tail = p + 2;
3622 while (vim_ispathsep(*tail))
3623 mb_ptr_adv(tail);
3625 if (components > 0) /* strip one preceding component */
3627 int do_strip = FALSE;
3628 char_u saved_char;
3629 struct stat st;
3631 /* Don't strip for an erroneous file name. */
3632 if (!stripping_disabled)
3634 /* If the preceding component does not exist in the file
3635 * system, we strip it. On Unix, we don't accept a symbolic
3636 * link that refers to a non-existent file. */
3637 saved_char = p[-1];
3638 p[-1] = NUL;
3639 #ifdef UNIX
3640 if (mch_lstat((char *)filename, &st) < 0)
3641 #else
3642 if (mch_stat((char *)filename, &st) < 0)
3643 #endif
3644 do_strip = TRUE;
3645 p[-1] = saved_char;
3647 --p;
3648 /* Skip back to after previous '/'. */
3649 while (p > start && !after_pathsep(start, p))
3650 mb_ptr_back(start, p);
3652 if (!do_strip)
3654 /* If the component exists in the file system, check
3655 * that stripping it won't change the meaning of the
3656 * file name. First get information about the
3657 * unstripped file name. This may fail if the component
3658 * to strip is not a searchable directory (but a regular
3659 * file, for instance), since the trailing "/.." cannot
3660 * be applied then. We don't strip it then since we
3661 * don't want to replace an erroneous file name by
3662 * a valid one, and we disable stripping of later
3663 * components. */
3664 saved_char = *tail;
3665 *tail = NUL;
3666 if (mch_stat((char *)filename, &st) >= 0)
3667 do_strip = TRUE;
3668 else
3669 stripping_disabled = TRUE;
3670 *tail = saved_char;
3671 #ifdef UNIX
3672 if (do_strip)
3674 struct stat new_st;
3676 /* On Unix, the check for the unstripped file name
3677 * above works also for a symbolic link pointing to
3678 * a searchable directory. But then the parent of
3679 * the directory pointed to by the link must be the
3680 * same as the stripped file name. (The latter
3681 * exists in the file system since it is the
3682 * component's parent directory.) */
3683 if (p == start && relative)
3684 (void)mch_stat(".", &new_st);
3685 else
3687 saved_char = *p;
3688 *p = NUL;
3689 (void)mch_stat((char *)filename, &new_st);
3690 *p = saved_char;
3693 if (new_st.st_ino != st.st_ino ||
3694 new_st.st_dev != st.st_dev)
3696 do_strip = FALSE;
3697 /* We don't disable stripping of later
3698 * components since the unstripped path name is
3699 * still valid. */
3702 #endif
3706 if (!do_strip)
3708 /* Skip the ".." or "../" and reset the counter for the
3709 * components that might be stripped later on. */
3710 p = tail;
3711 components = 0;
3713 else
3715 /* Strip previous component. If the result would get empty
3716 * and there is no trailing path separator, leave a single
3717 * "." instead. If we are at the end of the file name and
3718 * there is no trailing path separator and a preceding
3719 * component is left after stripping, strip its trailing
3720 * path separator as well. */
3721 if (p == start && relative && tail[-1] == '.')
3723 *p++ = '.';
3724 *p = NUL;
3726 else
3728 if (p > start && tail[-1] == '.')
3729 --p;
3730 STRMOVE(p, tail); /* strip previous component */
3733 --components;
3736 else if (p == start && !relative) /* leading "/.." or "/../" */
3737 STRMOVE(p, tail); /* strip ".." or "../" */
3738 else
3740 if (p == start + 2 && p[-2] == '.') /* leading "./../" */
3742 STRMOVE(p - 2, p); /* strip leading "./" */
3743 tail -= 2;
3745 p = tail; /* skip to char after ".." or "../" */
3748 else
3750 ++components; /* simple path component */
3751 p = getnextcomp(p);
3753 } while (*p != NUL);
3754 #endif /* !AMIGA */
3758 * Check if we have a tag for the buffer with name "buf_ffname".
3759 * This is a bit slow, because of the full path compare in fullpathcmp().
3760 * Return TRUE if tag for file "fname" if tag file "tag_fname" is for current
3761 * file.
3763 static int
3764 #ifdef FEAT_EMACS_TAGS
3765 test_for_current(is_etag, fname, fname_end, tag_fname, buf_ffname)
3766 int is_etag;
3767 #else
3768 test_for_current(fname, fname_end, tag_fname, buf_ffname)
3769 #endif
3770 char_u *fname;
3771 char_u *fname_end;
3772 char_u *tag_fname;
3773 char_u *buf_ffname;
3775 int c;
3776 int retval = FALSE;
3777 char_u *fullname;
3779 if (buf_ffname != NULL) /* if the buffer has a name */
3781 #ifdef FEAT_EMACS_TAGS
3782 if (is_etag)
3783 c = 0; /* to shut up GCC */
3784 else
3785 #endif
3787 c = *fname_end;
3788 *fname_end = NUL;
3790 fullname = expand_tag_fname(fname, tag_fname, TRUE);
3791 if (fullname != NULL)
3793 retval = (fullpathcmp(fullname, buf_ffname, TRUE) & FPC_SAME);
3794 vim_free(fullname);
3796 #ifdef FEAT_EMACS_TAGS
3797 if (!is_etag)
3798 #endif
3799 *fname_end = c;
3802 return retval;
3806 * Find the end of the tagaddress.
3807 * Return OK if ";\"" is following, FAIL otherwise.
3809 static int
3810 find_extra(pp)
3811 char_u **pp;
3813 char_u *str = *pp;
3815 /* Repeat for addresses separated with ';' */
3816 for (;;)
3818 if (VIM_ISDIGIT(*str))
3819 str = skipdigits(str);
3820 else if (*str == '/' || *str == '?')
3822 str = skip_regexp(str + 1, *str, FALSE, NULL);
3823 if (*str != **pp)
3824 str = NULL;
3825 else
3826 ++str;
3828 else
3829 str = NULL;
3830 if (str == NULL || *str != ';'
3831 || !(VIM_ISDIGIT(str[1]) || str[1] == '/' || str[1] == '?'))
3832 break;
3833 ++str; /* skip ';' */
3836 if (str != NULL && STRNCMP(str, ";\"", 2) == 0)
3838 *pp = str;
3839 return OK;
3841 return FAIL;
3844 #if defined(FEAT_CMDL_COMPL) || defined(PROTO)
3846 expand_tags(tagnames, pat, num_file, file)
3847 int tagnames; /* expand tag names */
3848 char_u *pat;
3849 int *num_file;
3850 char_u ***file;
3852 int i;
3853 int c;
3854 int tagnmflag;
3855 char_u tagnm[100];
3856 tagptrs_T t_p;
3857 int ret;
3859 if (tagnames)
3860 tagnmflag = TAG_NAMES;
3861 else
3862 tagnmflag = 0;
3863 if (pat[0] == '/')
3864 ret = find_tags(pat + 1, num_file, file,
3865 TAG_REGEXP | tagnmflag | TAG_VERBOSE,
3866 TAG_MANY, curbuf->b_ffname);
3867 else
3868 ret = find_tags(pat, num_file, file,
3869 TAG_REGEXP | tagnmflag | TAG_VERBOSE | TAG_NOIC,
3870 TAG_MANY, curbuf->b_ffname);
3871 if (ret == OK && !tagnames)
3873 /* Reorganize the tags for display and matching as strings of:
3874 * "<tagname>\0<kind>\0<filename>\0"
3876 for (i = 0; i < *num_file; i++)
3878 parse_match((*file)[i], &t_p);
3879 c = (int)(t_p.tagname_end - t_p.tagname);
3880 mch_memmove(tagnm, t_p.tagname, (size_t)c);
3881 tagnm[c++] = 0;
3882 tagnm[c++] = (t_p.tagkind != NULL && *t_p.tagkind)
3883 ? *t_p.tagkind : 'f';
3884 tagnm[c++] = 0;
3885 mch_memmove((*file)[i] + c, t_p.fname, t_p.fname_end - t_p.fname);
3886 (*file)[i][c + (t_p.fname_end - t_p.fname)] = 0;
3887 mch_memmove((*file)[i], tagnm, (size_t)c);
3890 return ret;
3892 #endif
3894 #if defined(FEAT_EVAL) || defined(PROTO)
3895 static int add_tag_field __ARGS((dict_T *dict, char *field_name, char_u *start, char_u *end));
3898 * Add a tag field to the dictionary "dict"
3900 static int
3901 add_tag_field(dict, field_name, start, end)
3902 dict_T *dict;
3903 char *field_name;
3904 char_u *start; /* start of the value */
3905 char_u *end; /* after the value; can be NULL */
3907 char_u buf[MAXPATHL];
3908 int len = 0;
3910 if (start != NULL)
3912 if (end == NULL)
3914 end = start + STRLEN(start);
3915 while (end > start && (end[-1] == '\r' || end[-1] == '\n'))
3916 --end;
3918 len = (int)(end - start);
3919 if (len > (int)sizeof(buf) - 1)
3920 len = sizeof(buf) - 1;
3921 vim_strncpy(buf, start, len);
3923 buf[len] = NUL;
3924 return dict_add_nr_str(dict, field_name, 0L, buf);
3928 * Add the tags matching the specified pattern to the list "list"
3929 * as a dictionary
3932 get_tags(list, pat)
3933 list_T *list;
3934 char_u *pat;
3936 int num_matches, i, ret;
3937 char_u **matches, *p;
3938 char_u *full_fname;
3939 dict_T *dict;
3940 tagptrs_T tp;
3941 long is_static;
3943 ret = find_tags(pat, &num_matches, &matches,
3944 TAG_REGEXP | TAG_NOIC, (int)MAXCOL, NULL);
3945 if (ret == OK && num_matches > 0)
3947 for (i = 0; i < num_matches; ++i)
3949 parse_match(matches[i], &tp);
3950 is_static = test_for_static(&tp);
3952 /* Skip pseudo-tag lines. */
3953 if (STRNCMP(tp.tagname, "!_TAG_", 6) == 0)
3954 continue;
3956 if ((dict = dict_alloc()) == NULL)
3957 ret = FAIL;
3958 if (list_append_dict(list, dict) == FAIL)
3959 ret = FAIL;
3961 full_fname = tag_full_fname(&tp);
3962 if (add_tag_field(dict, "name", tp.tagname, tp.tagname_end) == FAIL
3963 || add_tag_field(dict, "filename", full_fname,
3964 NULL) == FAIL
3965 || add_tag_field(dict, "cmd", tp.command,
3966 tp.command_end) == FAIL
3967 || add_tag_field(dict, "kind", tp.tagkind,
3968 tp.tagkind_end) == FAIL
3969 || dict_add_nr_str(dict, "static", is_static, NULL) == FAIL)
3970 ret = FAIL;
3972 vim_free(full_fname);
3974 if (tp.command_end != NULL)
3976 for (p = tp.command_end + 3;
3977 *p != NUL && *p != '\n' && *p != '\r'; ++p)
3979 if (p == tp.tagkind || (p + 5 == tp.tagkind
3980 && STRNCMP(p, "kind:", 5) == 0))
3981 /* skip "kind:<kind>" and "<kind>" */
3982 p = tp.tagkind_end - 1;
3983 else if (STRNCMP(p, "file:", 5) == 0)
3984 /* skip "file:" (static tag) */
3985 p += 4;
3986 else if (!vim_iswhite(*p))
3988 char_u *s, *n;
3989 int len;
3991 /* Add extra field as a dict entry. Fields are
3992 * separated by Tabs. */
3993 n = p;
3994 while (*p != NUL && *p >= ' ' && *p < 127 && *p != ':')
3995 ++p;
3996 len = (int)(p - n);
3997 if (*p == ':' && len > 0)
3999 s = ++p;
4000 while (*p != NUL && *p >= ' ')
4001 ++p;
4002 n[len] = NUL;
4003 if (add_tag_field(dict, (char *)n, s, p) == FAIL)
4004 ret = FAIL;
4005 n[len] = ':';
4007 else
4008 /* Skip field without colon. */
4009 while (*p != NUL && *p >= ' ')
4010 ++p;
4011 if (*p == NUL)
4012 break;
4017 vim_free(matches[i]);
4019 vim_free(matches);
4021 return ret;
4023 #endif