Merge branch 'vim'
[vim_extended.git] / src / tag.c
blobdb00c2e1f60b87ae9041ef0e1a97c9e3832566e5
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 */
34 #ifdef FEAT_EMACS_TAGS
35 int is_etag; /* TRUE for emacs tag */
36 #endif
37 char_u *tagkind; /* "kind:" value */
38 char_u *tagkind_end; /* end of tagkind */
39 } tagptrs_T;
42 * The matching tags are first stored in ga_match[]. In which one depends on
43 * the priority of the match.
44 * At the end, the matches from ga_match[] are concatenated, to make a list
45 * sorted on priority.
47 #define MT_ST_CUR 0 /* static match in current file */
48 #define MT_GL_CUR 1 /* global match in current file */
49 #define MT_GL_OTH 2 /* global match in other file */
50 #define MT_ST_OTH 3 /* static match in other file */
51 #define MT_IC_ST_CUR 4 /* icase static match in current file */
52 #define MT_IC_GL_CUR 5 /* icase global match in current file */
53 #define MT_IC_GL_OTH 6 /* icase global match in other file */
54 #define MT_IC_ST_OTH 7 /* icase static match in other file */
55 #define MT_IC_OFF 4 /* add for icase match */
56 #define MT_RE_OFF 8 /* add for regexp match */
57 #define MT_MASK 7 /* mask for printing priority */
58 #define MT_COUNT 16
60 static char *mt_names[MT_COUNT/2] =
61 {"FSC", "F C", "F ", "FS ", " SC", " C", " ", " S "};
63 #define NOTAGFILE 99 /* return value for jumpto_tag */
64 static char_u *nofile_fname = NULL; /* fname for NOTAGFILE error */
66 static void taglen_advance __ARGS((int l));
68 static int jumpto_tag __ARGS((char_u *lbuf, int forceit, int keep_help));
69 #ifdef FEAT_EMACS_TAGS
70 static int parse_tag_line __ARGS((char_u *lbuf, int is_etag, tagptrs_T *tagp));
71 #else
72 static int parse_tag_line __ARGS((char_u *lbuf, tagptrs_T *tagp));
73 #endif
74 static int test_for_static __ARGS((tagptrs_T *));
75 static int parse_match __ARGS((char_u *lbuf, tagptrs_T *tagp));
76 static char_u *tag_full_fname __ARGS((tagptrs_T *tagp));
77 static char_u *expand_tag_fname __ARGS((char_u *fname, char_u *tag_fname, int expand));
78 #ifdef FEAT_EMACS_TAGS
79 static int test_for_current __ARGS((int, char_u *, char_u *, char_u *, char_u *));
80 #else
81 static int test_for_current __ARGS((char_u *, char_u *, char_u *, char_u *));
82 #endif
83 static int find_extra __ARGS((char_u **pp));
85 static char_u *bottommsg = (char_u *)N_("E555: at bottom of tag stack");
86 static char_u *topmsg = (char_u *)N_("E556: at top of tag stack");
88 static char_u *tagmatchname = NULL; /* name of last used tag */
91 * We use ftello() here, if available. It returns off_t instead of long,
92 * which helps if long is 32 bit and off_t is 64 bit.
93 * We assume that when fseeko() is available then ftello() is too.
95 #ifdef HAVE_FSEEKO
96 # define ftell ftello
97 #endif
99 #if defined(FEAT_WINDOWS) && defined(FEAT_QUICKFIX)
101 * Tag for preview window is remembered separately, to avoid messing up the
102 * normal tagstack.
104 static taggy_T ptag_entry = {NULL, {INIT_POS_T(0, 0, 0), 0}, 0, 0};
105 #endif
108 * Jump to tag; handling of tag commands and tag stack
110 * *tag != NUL: ":tag {tag}", jump to new tag, add to tag stack
112 * type == DT_TAG: ":tag [tag]", jump to newer position or same tag again
113 * type == DT_HELP: like DT_TAG, but don't use regexp.
114 * type == DT_POP: ":pop" or CTRL-T, jump to old position
115 * type == DT_NEXT: jump to next match of same tag
116 * type == DT_PREV: jump to previous match of same tag
117 * type == DT_FIRST: jump to first match of same tag
118 * type == DT_LAST: jump to last match of same tag
119 * type == DT_SELECT: ":tselect [tag]", select tag from a list of all matches
120 * type == DT_JUMP: ":tjump [tag]", jump to tag or select tag from a list
121 * type == DT_CSCOPE: use cscope to find the tag
122 * type == DT_LTAG: use location list for displaying tag matches
123 * type == DT_FREE: free cached matches
125 * for cscope, returns TRUE if we jumped to tag or aborted, FALSE otherwise
128 do_tag(tag, type, count, forceit, verbose)
129 char_u *tag; /* tag (pattern) to jump to */
130 int type;
131 int count;
132 int forceit; /* :ta with ! */
133 int verbose; /* print "tag not found" message */
135 taggy_T *tagstack = curwin->w_tagstack;
136 int tagstackidx = curwin->w_tagstackidx;
137 int tagstacklen = curwin->w_tagstacklen;
138 int cur_match = 0;
139 int cur_fnum = curbuf->b_fnum;
140 int oldtagstackidx = tagstackidx;
141 int prevtagstackidx = tagstackidx;
142 int prev_num_matches;
143 int new_tag = FALSE;
144 int other_name;
145 int i, j, k;
146 int idx;
147 int ic;
148 char_u *p;
149 char_u *name;
150 int no_regexp = FALSE;
151 int error_cur_match = 0;
152 char_u *command_end;
153 int save_pos = FALSE;
154 fmark_T saved_fmark;
155 int taglen;
156 #ifdef FEAT_CSCOPE
157 int jumped_to_tag = FALSE;
158 #endif
159 tagptrs_T tagp, tagp2;
160 int new_num_matches;
161 char_u **new_matches;
162 int attr;
163 int use_tagstack;
164 int skip_msg = FALSE;
165 char_u *buf_ffname = curbuf->b_ffname; /* name to use for
166 priority computation */
168 /* remember the matches for the last used tag */
169 static int num_matches = 0;
170 static int max_num_matches = 0; /* limit used for match search */
171 static char_u **matches = NULL;
172 static int flags;
174 #ifdef EXITFREE
175 if (type == DT_FREE)
177 /* remove the list of matches */
178 FreeWild(num_matches, matches);
179 # ifdef FEAT_CSCOPE
180 cs_free_tags();
181 # endif
182 num_matches = 0;
183 return FALSE;
185 #endif
187 if (type == DT_HELP)
189 type = DT_TAG;
190 no_regexp = TRUE;
193 prev_num_matches = num_matches;
194 free_string_option(nofile_fname);
195 nofile_fname = NULL;
197 clearpos(&saved_fmark.mark); /* shutup gcc 4.0 */
198 saved_fmark.fnum = 0;
201 * Don't add a tag to the tagstack if 'tagstack' has been reset.
203 if ((!p_tgst && *tag != NUL))
205 use_tagstack = FALSE;
206 new_tag = TRUE;
208 else
210 #if defined(FEAT_WINDOWS) && defined(FEAT_QUICKFIX)
211 if (g_do_tagpreview)
212 use_tagstack = FALSE;
213 else
214 #endif
215 use_tagstack = TRUE;
217 /* new pattern, add to the tag stack */
218 if (*tag != NUL
219 && (type == DT_TAG || type == DT_SELECT || type == DT_JUMP
220 #ifdef FEAT_QUICKFIX
221 || type == DT_LTAG
222 #endif
223 #ifdef FEAT_CSCOPE
224 || type == DT_CSCOPE
225 #endif
228 #if defined(FEAT_WINDOWS) && defined(FEAT_QUICKFIX)
229 if (g_do_tagpreview)
231 if (ptag_entry.tagname != NULL
232 && STRCMP(ptag_entry.tagname, tag) == 0)
234 /* Jumping to same tag: keep the current match, so that
235 * the CursorHold autocommand example works. */
236 cur_match = ptag_entry.cur_match;
237 cur_fnum = ptag_entry.cur_fnum;
239 else
241 vim_free(ptag_entry.tagname);
242 if ((ptag_entry.tagname = vim_strsave(tag)) == NULL)
243 goto end_do_tag;
246 else
247 #endif
250 * If the last used entry is not at the top, delete all tag
251 * stack entries above it.
253 while (tagstackidx < tagstacklen)
254 vim_free(tagstack[--tagstacklen].tagname);
256 /* if the tagstack is full: remove oldest entry */
257 if (++tagstacklen > TAGSTACKSIZE)
259 tagstacklen = TAGSTACKSIZE;
260 vim_free(tagstack[0].tagname);
261 for (i = 1; i < tagstacklen; ++i)
262 tagstack[i - 1] = tagstack[i];
263 --tagstackidx;
267 * put the tag name in the tag stack
269 if ((tagstack[tagstackidx].tagname = vim_strsave(tag)) == NULL)
271 curwin->w_tagstacklen = tagstacklen - 1;
272 goto end_do_tag;
274 curwin->w_tagstacklen = tagstacklen;
276 save_pos = TRUE; /* save the cursor position below */
279 new_tag = TRUE;
281 else
283 if (
284 #if defined(FEAT_WINDOWS) && defined(FEAT_QUICKFIX)
285 g_do_tagpreview ? ptag_entry.tagname == NULL :
286 #endif
287 tagstacklen == 0)
289 /* empty stack */
290 EMSG(_(e_tagstack));
291 goto end_do_tag;
294 if (type == DT_POP) /* go to older position */
296 #ifdef FEAT_FOLDING
297 int old_KeyTyped = KeyTyped;
298 #endif
299 if ((tagstackidx -= count) < 0)
301 EMSG(_(bottommsg));
302 if (tagstackidx + count == 0)
304 /* We did [num]^T from the bottom of the stack */
305 tagstackidx = 0;
306 goto end_do_tag;
308 /* We weren't at the bottom of the stack, so jump all the
309 * way to the bottom now.
311 tagstackidx = 0;
313 else if (tagstackidx >= tagstacklen) /* count == 0? */
315 EMSG(_(topmsg));
316 goto end_do_tag;
319 /* Make a copy of the fmark, autocommands may invalidate the
320 * tagstack before it's used. */
321 saved_fmark = tagstack[tagstackidx].fmark;
322 if (saved_fmark.fnum != curbuf->b_fnum)
325 * Jump to other file. If this fails (e.g. because the
326 * file was changed) keep original position in tag stack.
328 if (buflist_getfile(saved_fmark.fnum, saved_fmark.mark.lnum,
329 GETF_SETMARK, forceit) == FAIL)
331 tagstackidx = oldtagstackidx; /* back to old posn */
332 goto end_do_tag;
334 /* An BufReadPost autocommand may jump to the '" mark, but
335 * we don't what that here. */
336 curwin->w_cursor.lnum = saved_fmark.mark.lnum;
338 else
340 setpcmark();
341 curwin->w_cursor.lnum = saved_fmark.mark.lnum;
343 curwin->w_cursor.col = saved_fmark.mark.col;
344 curwin->w_set_curswant = TRUE;
345 check_cursor();
346 #ifdef FEAT_FOLDING
347 if ((fdo_flags & FDO_TAG) && old_KeyTyped)
348 foldOpenCursor();
349 #endif
351 /* remove the old list of matches */
352 FreeWild(num_matches, matches);
353 #ifdef FEAT_CSCOPE
354 cs_free_tags();
355 #endif
356 num_matches = 0;
357 tag_freematch();
358 goto end_do_tag;
361 if (type == DT_TAG
362 #if defined(FEAT_QUICKFIX)
363 || type == DT_LTAG
364 #endif
367 #if defined(FEAT_WINDOWS) && defined(FEAT_QUICKFIX)
368 if (g_do_tagpreview)
370 cur_match = ptag_entry.cur_match;
371 cur_fnum = ptag_entry.cur_fnum;
373 else
374 #endif
376 /* ":tag" (no argument): go to newer pattern */
377 save_pos = TRUE; /* save the cursor position below */
378 if ((tagstackidx += count - 1) >= tagstacklen)
381 * Beyond the last one, just give an error message and
382 * go to the last one. Don't store the cursor
383 * position.
385 tagstackidx = tagstacklen - 1;
386 EMSG(_(topmsg));
387 save_pos = FALSE;
389 else if (tagstackidx < 0) /* must have been count == 0 */
391 EMSG(_(bottommsg));
392 tagstackidx = 0;
393 goto end_do_tag;
395 cur_match = tagstack[tagstackidx].cur_match;
396 cur_fnum = tagstack[tagstackidx].cur_fnum;
398 new_tag = TRUE;
400 else /* go to other matching tag */
402 /* Save index for when selection is cancelled. */
403 prevtagstackidx = tagstackidx;
405 #if defined(FEAT_WINDOWS) && defined(FEAT_QUICKFIX)
406 if (g_do_tagpreview)
408 cur_match = ptag_entry.cur_match;
409 cur_fnum = ptag_entry.cur_fnum;
411 else
412 #endif
414 if (--tagstackidx < 0)
415 tagstackidx = 0;
416 cur_match = tagstack[tagstackidx].cur_match;
417 cur_fnum = tagstack[tagstackidx].cur_fnum;
419 switch (type)
421 case DT_FIRST: cur_match = count - 1; break;
422 case DT_SELECT:
423 case DT_JUMP:
424 #ifdef FEAT_CSCOPE
425 case DT_CSCOPE:
426 #endif
427 case DT_LAST: cur_match = MAXCOL - 1; break;
428 case DT_NEXT: cur_match += count; break;
429 case DT_PREV: cur_match -= count; break;
431 if (cur_match >= MAXCOL)
432 cur_match = MAXCOL - 1;
433 else if (cur_match < 0)
435 EMSG(_("E425: Cannot go before first matching tag"));
436 skip_msg = TRUE;
437 cur_match = 0;
438 cur_fnum = curbuf->b_fnum;
443 #if defined(FEAT_WINDOWS) && defined(FEAT_QUICKFIX)
444 if (g_do_tagpreview)
446 if (type != DT_SELECT && type != DT_JUMP)
448 ptag_entry.cur_match = cur_match;
449 ptag_entry.cur_fnum = cur_fnum;
452 else
453 #endif
456 * For ":tag [arg]" or ":tselect" remember position before the jump.
458 saved_fmark = tagstack[tagstackidx].fmark;
459 if (save_pos)
461 tagstack[tagstackidx].fmark.mark = curwin->w_cursor;
462 tagstack[tagstackidx].fmark.fnum = curbuf->b_fnum;
465 /* Curwin will change in the call to jumpto_tag() if ":stag" was
466 * used or an autocommand jumps to another window; store value of
467 * tagstackidx now. */
468 curwin->w_tagstackidx = tagstackidx;
469 if (type != DT_SELECT && type != DT_JUMP)
471 curwin->w_tagstack[tagstackidx].cur_match = cur_match;
472 curwin->w_tagstack[tagstackidx].cur_fnum = cur_fnum;
477 /* When not using the current buffer get the name of buffer "cur_fnum".
478 * Makes sure that the tag order doesn't change when using a remembered
479 * position for "cur_match". */
480 if (cur_fnum != curbuf->b_fnum)
482 buf_T *buf = buflist_findnr(cur_fnum);
484 if (buf != NULL)
485 buf_ffname = buf->b_ffname;
489 * Repeat searching for tags, when a file has not been found.
491 for (;;)
494 * When desired match not found yet, try to find it (and others).
496 if (use_tagstack)
497 name = tagstack[tagstackidx].tagname;
498 #if defined(FEAT_WINDOWS) && defined(FEAT_QUICKFIX)
499 else if (g_do_tagpreview)
500 name = ptag_entry.tagname;
501 #endif
502 else
503 name = tag;
504 other_name = (tagmatchname == NULL || STRCMP(tagmatchname, name) != 0);
505 if (new_tag
506 || (cur_match >= num_matches && max_num_matches != MAXCOL)
507 || other_name)
509 if (other_name)
511 vim_free(tagmatchname);
512 tagmatchname = vim_strsave(name);
516 * If a count is supplied to the ":tag <name>" command, then
517 * jump to count'th matching tag.
519 if (type == DT_TAG && *tag != NUL && count > 0)
520 cur_match = count - 1;
522 if (type == DT_SELECT || type == DT_JUMP
523 #if defined(FEAT_QUICKFIX)
524 || type == DT_LTAG
525 #endif
527 cur_match = MAXCOL - 1;
528 max_num_matches = cur_match + 1;
530 /* when the argument starts with '/', use it as a regexp */
531 if (!no_regexp && *name == '/')
533 flags = TAG_REGEXP;
534 ++name;
536 else
537 flags = TAG_NOIC;
539 #ifdef FEAT_CSCOPE
540 if (type == DT_CSCOPE)
541 flags = TAG_CSCOPE;
542 #endif
543 if (verbose)
544 flags |= TAG_VERBOSE;
545 if (find_tags(name, &new_num_matches, &new_matches, flags,
546 max_num_matches, buf_ffname) == OK
547 && new_num_matches < max_num_matches)
548 max_num_matches = MAXCOL; /* If less than max_num_matches
549 found: all matches found. */
551 /* If there already were some matches for the same name, move them
552 * to the start. Avoids that the order changes when using
553 * ":tnext" and jumping to another file. */
554 if (!new_tag && !other_name)
556 /* Find the position of each old match in the new list. Need
557 * to use parse_match() to find the tag line. */
558 idx = 0;
559 for (j = 0; j < num_matches; ++j)
561 parse_match(matches[j], &tagp);
562 for (i = idx; i < new_num_matches; ++i)
564 parse_match(new_matches[i], &tagp2);
565 if (STRCMP(tagp.tagname, tagp2.tagname) == 0)
567 p = new_matches[i];
568 for (k = i; k > idx; --k)
569 new_matches[k] = new_matches[k - 1];
570 new_matches[idx++] = p;
571 break;
576 FreeWild(num_matches, matches);
577 num_matches = new_num_matches;
578 matches = new_matches;
581 if (num_matches <= 0)
583 if (verbose)
584 EMSG2(_("E426: tag not found: %s"), name);
585 #if defined(FEAT_WINDOWS) && defined(FEAT_QUICKFIX)
586 g_do_tagpreview = 0;
587 #endif
589 else
591 int ask_for_selection = FALSE;
593 #ifdef FEAT_CSCOPE
594 if (type == DT_CSCOPE && num_matches > 1)
596 cs_print_tags();
597 ask_for_selection = TRUE;
599 else
600 #endif
601 if (type == DT_SELECT || (type == DT_JUMP && num_matches > 1))
604 * List all the matching tags.
605 * Assume that the first match indicates how long the tags can
606 * be, and align the file names to that.
608 parse_match(matches[0], &tagp);
609 taglen = (int)(tagp.tagname_end - tagp.tagname + 2);
610 if (taglen < 18)
611 taglen = 18;
612 if (taglen > Columns - 25)
613 taglen = MAXCOL;
614 if (msg_col == 0)
615 msg_didout = FALSE; /* overwrite previous message */
616 msg_start();
617 MSG_PUTS_ATTR(_(" # pri kind tag"), hl_attr(HLF_T));
618 msg_clr_eos();
619 taglen_advance(taglen);
620 MSG_PUTS_ATTR(_("file\n"), hl_attr(HLF_T));
622 for (i = 0; i < num_matches && !got_int; ++i)
624 parse_match(matches[i], &tagp);
625 if (!new_tag && (
626 #if defined(FEAT_WINDOWS) && defined(FEAT_QUICKFIX)
627 (g_do_tagpreview
628 && i == ptag_entry.cur_match) ||
629 #endif
630 (use_tagstack
631 && i == tagstack[tagstackidx].cur_match)))
632 *IObuff = '>';
633 else
634 *IObuff = ' ';
635 vim_snprintf((char *)IObuff + 1, IOSIZE - 1,
636 "%2d %s ", i + 1,
637 mt_names[matches[i][0] & MT_MASK]);
638 msg_puts(IObuff);
639 if (tagp.tagkind != NULL)
640 msg_outtrans_len(tagp.tagkind,
641 (int)(tagp.tagkind_end - tagp.tagkind));
642 msg_advance(13);
643 msg_outtrans_len_attr(tagp.tagname,
644 (int)(tagp.tagname_end - tagp.tagname),
645 hl_attr(HLF_T));
646 msg_putchar(' ');
647 taglen_advance(taglen);
649 /* Find out the actual file name. If it is long, truncate
650 * it and put "..." in the middle */
651 p = tag_full_fname(&tagp);
652 if (p != NULL)
654 msg_puts_long_attr(p, hl_attr(HLF_D));
655 vim_free(p);
657 if (msg_col > 0)
658 msg_putchar('\n');
659 if (got_int)
660 break;
661 msg_advance(15);
663 /* print any extra fields */
664 command_end = tagp.command_end;
665 if (command_end != NULL)
667 p = command_end + 3;
668 while (*p && *p != '\r' && *p != '\n')
670 while (*p == TAB)
671 ++p;
673 /* skip "file:" without a value (static tag) */
674 if (STRNCMP(p, "file:", 5) == 0
675 && vim_isspace(p[5]))
677 p += 5;
678 continue;
680 /* skip "kind:<kind>" and "<kind>" */
681 if (p == tagp.tagkind
682 || (p + 5 == tagp.tagkind
683 && STRNCMP(p, "kind:", 5) == 0))
685 p = tagp.tagkind_end;
686 continue;
688 /* print all other extra fields */
689 attr = hl_attr(HLF_CM);
690 while (*p && *p != '\r' && *p != '\n')
692 if (msg_col + ptr2cells(p) >= Columns)
694 msg_putchar('\n');
695 if (got_int)
696 break;
697 msg_advance(15);
699 p = msg_outtrans_one(p, attr);
700 if (*p == TAB)
702 msg_puts_attr((char_u *)" ", attr);
703 break;
705 if (*p == ':')
706 attr = 0;
709 if (msg_col > 15)
711 msg_putchar('\n');
712 if (got_int)
713 break;
714 msg_advance(15);
717 else
719 for (p = tagp.command;
720 *p && *p != '\r' && *p != '\n'; ++p)
722 command_end = p;
726 * Put the info (in several lines) at column 15.
727 * Don't display "/^" and "?^".
729 p = tagp.command;
730 if (*p == '/' || *p == '?')
732 ++p;
733 if (*p == '^')
734 ++p;
736 /* Remove leading whitespace from pattern */
737 while (p != command_end && vim_isspace(*p))
738 ++p;
740 while (p != command_end)
742 if (msg_col + (*p == TAB ? 1 : ptr2cells(p)) > Columns)
743 msg_putchar('\n');
744 if (got_int)
745 break;
746 msg_advance(15);
748 /* skip backslash used for escaping command char */
749 if (*p == '\\' && *(p + 1) == *tagp.command)
750 ++p;
752 if (*p == TAB)
754 msg_putchar(' ');
755 ++p;
757 else
758 p = msg_outtrans_one(p, 0);
760 /* don't display the "$/;\"" and "$?;\"" */
761 if (p == command_end - 2 && *p == '$'
762 && *(p + 1) == *tagp.command)
763 break;
764 /* don't display matching '/' or '?' */
765 if (p == command_end - 1 && *p == *tagp.command
766 && (*p == '/' || *p == '?'))
767 break;
769 if (msg_col)
770 msg_putchar('\n');
771 ui_breakcheck();
773 if (got_int)
774 got_int = FALSE; /* only stop the listing */
775 ask_for_selection = TRUE;
777 #if defined(FEAT_QUICKFIX) && defined(FEAT_EVAL)
778 else if (type == DT_LTAG)
780 list_T *list;
781 char_u tag_name[128 + 1];
782 char_u fname[MAXPATHL + 1];
783 char_u cmd[CMDBUFFSIZE + 1];
786 * Add the matching tags to the location list for the current
787 * window.
790 list = list_alloc();
791 if (list == NULL)
792 goto end_do_tag;
794 for (i = 0; i < num_matches; ++i)
796 int len, cmd_len;
797 long lnum;
798 dict_T *dict;
800 parse_match(matches[i], &tagp);
802 /* Save the tag name */
803 len = (int)(tagp.tagname_end - tagp.tagname);
804 if (len > 128)
805 len = 128;
806 vim_strncpy(tag_name, tagp.tagname, len);
807 tag_name[len] = NUL;
809 /* Save the tag file name */
810 p = tag_full_fname(&tagp);
811 if (p == NULL)
812 continue;
813 STRCPY(fname, p);
814 vim_free(p);
817 * Get the line number or the search pattern used to locate
818 * the tag.
820 lnum = 0;
821 if (isdigit(*tagp.command))
822 /* Line number is used to locate the tag */
823 lnum = atol((char *)tagp.command);
824 else
826 char_u *cmd_start, *cmd_end;
828 /* Search pattern is used to locate the tag */
830 /* Locate the end of the command */
831 cmd_start = tagp.command;
832 cmd_end = tagp.command_end;
833 if (cmd_end == NULL)
835 for (p = tagp.command;
836 *p && *p != '\r' && *p != '\n'; ++p)
838 cmd_end = p;
842 * Now, cmd_end points to the character after the
843 * command. Adjust it to point to the last
844 * character of the command.
846 cmd_end--;
849 * Skip the '/' and '?' characters at the
850 * beginning and end of the search pattern.
852 if (*cmd_start == '/' || *cmd_start == '?')
853 cmd_start++;
855 if (*cmd_end == '/' || *cmd_end == '?')
856 cmd_end--;
858 len = 0;
859 cmd[0] = NUL;
862 * If "^" is present in the tag search pattern, then
863 * copy it first.
865 if (*cmd_start == '^')
867 STRCPY(cmd, "^");
868 cmd_start++;
869 len++;
873 * Precede the tag pattern with \V to make it very
874 * nomagic.
876 STRCAT(cmd, "\\V");
877 len += 2;
879 cmd_len = (int)(cmd_end - cmd_start + 1);
880 if (cmd_len > (CMDBUFFSIZE - 5))
881 cmd_len = CMDBUFFSIZE - 5;
882 STRNCAT(cmd, cmd_start, cmd_len);
883 len += cmd_len;
885 if (cmd[len - 1] == '$')
888 * Replace '$' at the end of the search pattern
889 * with '\$'
891 cmd[len - 1] = '\\';
892 cmd[len] = '$';
893 len++;
896 cmd[len] = NUL;
899 if ((dict = dict_alloc()) == NULL)
900 continue;
901 if (list_append_dict(list, dict) == FAIL)
903 vim_free(dict);
904 continue;
907 dict_add_nr_str(dict, "text", 0L, tag_name);
908 dict_add_nr_str(dict, "filename", 0L, fname);
909 dict_add_nr_str(dict, "lnum", lnum, NULL);
910 if (lnum == 0)
911 dict_add_nr_str(dict, "pattern", 0L, cmd);
914 set_errorlist(curwin, list, ' ');
916 list_free(list, TRUE);
918 cur_match = 0; /* Jump to the first tag */
920 #endif
922 if (ask_for_selection == TRUE)
925 * Ask to select a tag from the list.
927 i = prompt_for_number(NULL);
928 if (i <= 0 || i > num_matches || got_int)
930 /* no valid choice: don't change anything */
931 if (use_tagstack)
933 tagstack[tagstackidx].fmark = saved_fmark;
934 tagstackidx = prevtagstackidx;
936 #ifdef FEAT_CSCOPE
937 cs_free_tags();
938 jumped_to_tag = TRUE;
939 #endif
940 break;
942 cur_match = i - 1;
945 if (cur_match >= num_matches)
947 /* Avoid giving this error when a file wasn't found and we're
948 * looking for a match in another file, which wasn't found.
949 * There will be an EMSG("file doesn't exist") below then. */
950 if ((type == DT_NEXT || type == DT_FIRST)
951 && nofile_fname == NULL)
953 if (num_matches == 1)
954 EMSG(_("E427: There is only one matching tag"));
955 else
956 EMSG(_("E428: Cannot go beyond last matching tag"));
957 skip_msg = TRUE;
959 cur_match = num_matches - 1;
961 if (use_tagstack)
963 tagstack[tagstackidx].cur_match = cur_match;
964 tagstack[tagstackidx].cur_fnum = cur_fnum;
965 ++tagstackidx;
967 #if defined(FEAT_WINDOWS) && defined(FEAT_QUICKFIX)
968 else if (g_do_tagpreview)
970 ptag_entry.cur_match = cur_match;
971 ptag_entry.cur_fnum = cur_fnum;
973 #endif
976 * Only when going to try the next match, report that the previous
977 * file didn't exist. Otherwise an EMSG() is given below.
979 if (nofile_fname != NULL && error_cur_match != cur_match)
980 smsg((char_u *)_("File \"%s\" does not exist"), nofile_fname);
983 ic = (matches[cur_match][0] & MT_IC_OFF);
984 if (type != DT_SELECT && type != DT_JUMP
985 #ifdef FEAT_CSCOPE
986 && type != DT_CSCOPE
987 #endif
988 && (num_matches > 1 || ic)
989 && !skip_msg)
991 /* Give an indication of the number of matching tags */
992 sprintf((char *)IObuff, _("tag %d of %d%s"),
993 cur_match + 1,
994 num_matches,
995 max_num_matches != MAXCOL ? _(" or more") : "");
996 if (ic)
997 STRCAT(IObuff, _(" Using tag with different case!"));
998 if ((num_matches > prev_num_matches || new_tag)
999 && num_matches > 1)
1001 if (ic)
1002 msg_attr(IObuff, hl_attr(HLF_W));
1003 else
1004 msg(IObuff);
1005 msg_scroll = TRUE; /* don't overwrite this message */
1007 else
1008 give_warning(IObuff, ic);
1009 if (ic && !msg_scrolled && msg_silent == 0)
1011 out_flush();
1012 ui_delay(1000L, TRUE);
1016 #ifdef FEAT_AUTOCMD
1017 /* Let the SwapExists event know what tag we are jumping to. */
1018 vim_snprintf((char *)IObuff, IOSIZE, ":ta %s\r", name);
1019 set_vim_var_string(VV_SWAPCOMMAND, IObuff, -1);
1020 #endif
1023 * Jump to the desired match.
1025 i = jumpto_tag(matches[cur_match], forceit, type != DT_CSCOPE);
1027 #ifdef FEAT_AUTOCMD
1028 set_vim_var_string(VV_SWAPCOMMAND, NULL, -1);
1029 #endif
1031 if (i == NOTAGFILE)
1033 /* File not found: try again with another matching tag */
1034 if ((type == DT_PREV && cur_match > 0)
1035 || ((type == DT_TAG || type == DT_NEXT
1036 || type == DT_FIRST)
1037 && (max_num_matches != MAXCOL
1038 || cur_match < num_matches - 1)))
1040 error_cur_match = cur_match;
1041 if (use_tagstack)
1042 --tagstackidx;
1043 if (type == DT_PREV)
1044 --cur_match;
1045 else
1047 type = DT_NEXT;
1048 ++cur_match;
1050 continue;
1052 EMSG2(_("E429: File \"%s\" does not exist"), nofile_fname);
1054 else
1056 /* We may have jumped to another window, check that
1057 * tagstackidx is still valid. */
1058 if (use_tagstack && tagstackidx > curwin->w_tagstacklen)
1059 tagstackidx = curwin->w_tagstackidx;
1060 #ifdef FEAT_CSCOPE
1061 jumped_to_tag = TRUE;
1062 #endif
1065 break;
1068 end_do_tag:
1069 /* Only store the new index when using the tagstack and it's valid. */
1070 if (use_tagstack && tagstackidx <= curwin->w_tagstacklen)
1071 curwin->w_tagstackidx = tagstackidx;
1072 #ifdef FEAT_WINDOWS
1073 postponed_split = 0; /* don't split next time */
1074 #endif
1076 #ifdef FEAT_CSCOPE
1077 return jumped_to_tag;
1078 #else
1079 return FALSE;
1080 #endif
1084 * Free cached tags.
1086 void
1087 tag_freematch()
1089 vim_free(tagmatchname);
1090 tagmatchname = NULL;
1093 static void
1094 taglen_advance(l)
1095 int l;
1097 if (l == MAXCOL)
1099 msg_putchar('\n');
1100 msg_advance(24);
1102 else
1103 msg_advance(13 + l);
1107 * Print the tag stack
1109 void
1110 do_tags(eap)
1111 exarg_T *eap UNUSED;
1113 int i;
1114 char_u *name;
1115 taggy_T *tagstack = curwin->w_tagstack;
1116 int tagstackidx = curwin->w_tagstackidx;
1117 int tagstacklen = curwin->w_tagstacklen;
1119 /* Highlight title */
1120 MSG_PUTS_TITLE(_("\n # TO tag FROM line in file/text"));
1121 for (i = 0; i < tagstacklen; ++i)
1123 if (tagstack[i].tagname != NULL)
1125 name = fm_getname(&(tagstack[i].fmark), 30);
1126 if (name == NULL) /* file name not available */
1127 continue;
1129 msg_putchar('\n');
1130 sprintf((char *)IObuff, "%c%2d %2d %-15s %5ld ",
1131 i == tagstackidx ? '>' : ' ',
1132 i + 1,
1133 tagstack[i].cur_match + 1,
1134 tagstack[i].tagname,
1135 tagstack[i].fmark.mark.lnum);
1136 msg_outtrans(IObuff);
1137 msg_outtrans_attr(name, tagstack[i].fmark.fnum == curbuf->b_fnum
1138 ? hl_attr(HLF_D) : 0);
1139 vim_free(name);
1141 out_flush(); /* show one line at a time */
1143 if (tagstackidx == tagstacklen) /* idx at top of stack */
1144 MSG_PUTS("\n>");
1147 /* When not using a CR for line separator, use vim_fgets() to read tag lines.
1148 * For the Mac use tag_fgets(). It can handle any line separator, but is much
1149 * slower than vim_fgets().
1151 #ifndef USE_CR
1152 # define tag_fgets vim_fgets
1153 #endif
1155 #ifdef FEAT_TAG_BINS
1156 static int tag_strnicmp __ARGS((char_u *s1, char_u *s2, size_t len));
1159 * Compare two strings, for length "len", ignoring case the ASCII way.
1160 * return 0 for match, < 0 for smaller, > 0 for bigger
1161 * Make sure case is folded to uppercase in comparison (like for 'sort -f')
1163 static int
1164 tag_strnicmp(s1, s2, len)
1165 char_u *s1;
1166 char_u *s2;
1167 size_t len;
1169 int i;
1171 while (len > 0)
1173 i = (int)TOUPPER_ASC(*s1) - (int)TOUPPER_ASC(*s2);
1174 if (i != 0)
1175 return i; /* this character different */
1176 if (*s1 == NUL)
1177 break; /* strings match until NUL */
1178 ++s1;
1179 ++s2;
1180 --len;
1182 return 0; /* strings match */
1184 #endif
1187 * Structure to hold info about the tag pattern being used.
1189 typedef struct
1191 char_u *pat; /* the pattern */
1192 int len; /* length of pat[] */
1193 char_u *head; /* start of pattern head */
1194 int headlen; /* length of head[] */
1195 regmatch_T regmatch; /* regexp program, may be NULL */
1196 } pat_T;
1198 static void prepare_pats __ARGS((pat_T *pats, int has_re));
1201 * Extract info from the tag search pattern "pats->pat".
1203 static void
1204 prepare_pats(pats, has_re)
1205 pat_T *pats;
1206 int has_re;
1208 pats->head = pats->pat;
1209 pats->headlen = pats->len;
1210 if (has_re)
1212 /* When the pattern starts with '^' or "\\<", binary searching can be
1213 * used (much faster). */
1214 if (pats->pat[0] == '^')
1215 pats->head = pats->pat + 1;
1216 else if (pats->pat[0] == '\\' && pats->pat[1] == '<')
1217 pats->head = pats->pat + 2;
1218 if (pats->head == pats->pat)
1219 pats->headlen = 0;
1220 else
1221 for (pats->headlen = 0; pats->head[pats->headlen] != NUL;
1222 ++pats->headlen)
1223 if (vim_strchr((char_u *)(p_magic ? ".[~*\\$" : "\\$"),
1224 pats->head[pats->headlen]) != NULL)
1225 break;
1226 if (p_tl != 0 && pats->headlen > p_tl) /* adjust for 'taglength' */
1227 pats->headlen = p_tl;
1230 if (has_re)
1231 pats->regmatch.regprog = vim_regcomp(pats->pat, p_magic ? RE_MAGIC : 0);
1232 else
1233 pats->regmatch.regprog = NULL;
1237 * find_tags() - search for tags in tags files
1239 * Return FAIL if search completely failed (*num_matches will be 0, *matchesp
1240 * will be NULL), OK otherwise.
1242 * There is a priority in which type of tag is recognized.
1244 * 6. A static or global tag with a full matching tag for the current file.
1245 * 5. A global tag with a full matching tag for another file.
1246 * 4. A static tag with a full matching tag for another file.
1247 * 3. A static or global tag with an ignore-case matching tag for the
1248 * current file.
1249 * 2. A global tag with an ignore-case matching tag for another file.
1250 * 1. A static tag with an ignore-case matching tag for another file.
1252 * Tags in an emacs-style tags file are always global.
1254 * flags:
1255 * TAG_HELP only search for help tags
1256 * TAG_NAMES only return name of tag
1257 * TAG_REGEXP use "pat" as a regexp
1258 * TAG_NOIC don't always ignore case
1259 * TAG_KEEP_LANG keep language
1262 find_tags(pat, num_matches, matchesp, flags, mincount, buf_ffname)
1263 char_u *pat; /* pattern to search for */
1264 int *num_matches; /* return: number of matches found */
1265 char_u ***matchesp; /* return: array of matches found */
1266 int flags;
1267 int mincount; /* MAXCOL: find all matches
1268 other: minimal number of matches */
1269 char_u *buf_ffname; /* name of buffer for priority */
1271 FILE *fp;
1272 char_u *lbuf; /* line buffer */
1273 char_u *tag_fname; /* name of tag file */
1274 tagname_T tn; /* info for get_tagfname() */
1275 int first_file; /* trying first tag file */
1276 tagptrs_T tagp;
1277 int did_open = FALSE; /* did open a tag file */
1278 int stop_searching = FALSE; /* stop when match found or error */
1279 int retval = FAIL; /* return value */
1280 int is_static; /* current tag line is static */
1281 int is_current; /* file name matches */
1282 int eof = FALSE; /* found end-of-file */
1283 char_u *p;
1284 char_u *s;
1285 int i;
1286 #ifdef FEAT_TAG_BINS
1287 struct tag_search_info /* Binary search file offsets */
1289 off_t low_offset; /* offset for first char of first line that
1290 could match */
1291 off_t high_offset; /* offset of char after last line that could
1292 match */
1293 off_t curr_offset; /* Current file offset in search range */
1294 off_t curr_offset_used; /* curr_offset used when skipping back */
1295 off_t match_offset; /* Where the binary search found a tag */
1296 int low_char; /* first char at low_offset */
1297 int high_char; /* first char at high_offset */
1298 } search_info;
1299 off_t filesize;
1300 int tagcmp;
1301 off_t offset;
1302 int round;
1303 #endif
1304 enum
1306 TS_START, /* at start of file */
1307 TS_LINEAR /* linear searching forward, till EOF */
1308 #ifdef FEAT_TAG_BINS
1309 , TS_BINARY, /* binary searching */
1310 TS_SKIP_BACK, /* skipping backwards */
1311 TS_STEP_FORWARD /* stepping forwards */
1312 #endif
1313 } state; /* Current search state */
1315 int cmplen;
1316 int match; /* matches */
1317 int match_no_ic = 0;/* matches with rm_ic == FALSE */
1318 int match_re; /* match with regexp */
1319 int matchoff = 0;
1321 #ifdef FEAT_EMACS_TAGS
1323 * Stack for included emacs-tags file.
1324 * It has a fixed size, to truncate cyclic includes. jw
1326 # define INCSTACK_SIZE 42
1327 struct
1329 FILE *fp;
1330 char_u *etag_fname;
1331 } incstack[INCSTACK_SIZE];
1333 int incstack_idx = 0; /* index in incstack */
1334 char_u *ebuf; /* additional buffer for etag fname */
1335 int is_etag; /* current file is emaces style */
1336 #endif
1338 struct match_found
1340 int len; /* nr of chars of match[] to be compared */
1341 char_u match[1]; /* actually longer */
1342 } *mfp, *mfp2;
1343 garray_T ga_match[MT_COUNT];
1344 int match_count = 0; /* number of matches found */
1345 char_u **matches;
1346 int mtt;
1347 int len;
1348 int help_save;
1349 #ifdef FEAT_MULTI_LANG
1350 int help_pri = 0;
1351 char_u *help_lang_find = NULL; /* lang to be found */
1352 char_u help_lang[3]; /* lang of current tags file */
1353 char_u *saved_pat = NULL; /* copy of pat[] */
1354 #endif
1356 /* Use two sets of variables for the pattern: "orgpat" holds the values
1357 * for the original pattern and "convpat" converted from 'encoding' to
1358 * encoding of the tags file. "pats" point to either one of these. */
1359 pat_T *pats;
1360 pat_T orgpat; /* holds unconverted pattern info */
1361 #ifdef FEAT_MBYTE
1362 pat_T convpat; /* holds converted pattern info */
1363 vimconv_T vimconv;
1364 #endif
1366 #ifdef FEAT_TAG_BINS
1367 int findall = (mincount == MAXCOL || mincount == TAG_MANY);
1368 /* find all matching tags */
1369 int sort_error = FALSE; /* tags file not sorted */
1370 int linear; /* do a linear search */
1371 int sortic = FALSE; /* tag file sorted in nocase */
1372 #endif
1373 int line_error = FALSE; /* syntax error */
1374 int has_re = (flags & TAG_REGEXP); /* regexp used */
1375 int help_only = (flags & TAG_HELP);
1376 int name_only = (flags & TAG_NAMES);
1377 int noic = (flags & TAG_NOIC);
1378 int get_it_again = FALSE;
1379 #ifdef FEAT_CSCOPE
1380 int use_cscope = (flags & TAG_CSCOPE);
1381 #endif
1382 int verbose = (flags & TAG_VERBOSE);
1384 help_save = curbuf->b_help;
1385 orgpat.pat = pat;
1386 pats = &orgpat;
1387 #ifdef FEAT_MBYTE
1388 vimconv.vc_type = CONV_NONE;
1389 #endif
1392 * Allocate memory for the buffers that are used
1394 lbuf = alloc(LSIZE);
1395 tag_fname = alloc(MAXPATHL + 1);
1396 #ifdef FEAT_EMACS_TAGS
1397 ebuf = alloc(LSIZE);
1398 #endif
1399 for (mtt = 0; mtt < MT_COUNT; ++mtt)
1400 ga_init2(&ga_match[mtt], (int)sizeof(struct match_found *), 100);
1402 /* check for out of memory situation */
1403 if (lbuf == NULL || tag_fname == NULL
1404 #ifdef FEAT_EMACS_TAGS
1405 || ebuf == NULL
1406 #endif
1408 goto findtag_end;
1410 #ifdef FEAT_CSCOPE
1411 STRCPY(tag_fname, "from cscope"); /* for error messages */
1412 #endif
1415 * Initialize a few variables
1417 if (help_only) /* want tags from help file */
1418 curbuf->b_help = TRUE; /* will be restored later */
1420 pats->len = (int)STRLEN(pat);
1421 #ifdef FEAT_MULTI_LANG
1422 if (curbuf->b_help)
1424 /* When "@ab" is specified use only the "ab" language, otherwise
1425 * search all languages. */
1426 if (pats->len > 3 && pat[pats->len - 3] == '@'
1427 && ASCII_ISALPHA(pat[pats->len - 2])
1428 && ASCII_ISALPHA(pat[pats->len - 1]))
1430 saved_pat = vim_strnsave(pat, pats->len - 3);
1431 if (saved_pat != NULL)
1433 help_lang_find = &pat[pats->len - 2];
1434 pats->pat = saved_pat;
1435 pats->len -= 3;
1439 #endif
1440 if (p_tl != 0 && pats->len > p_tl) /* adjust for 'taglength' */
1441 pats->len = p_tl;
1443 prepare_pats(pats, has_re);
1445 #ifdef FEAT_TAG_BINS
1446 /* This is only to avoid a compiler warning for using search_info
1447 * uninitialised. */
1448 vim_memset(&search_info, 0, (size_t)1);
1449 #endif
1452 * When finding a specified number of matches, first try with matching
1453 * case, so binary search can be used, and try ignore-case matches in a
1454 * second loop.
1455 * When finding all matches, 'tagbsearch' is off, or there is no fixed
1456 * string to look for, ignore case right away to avoid going though the
1457 * tags files twice.
1458 * When the tag file is case-fold sorted, it is either one or the other.
1459 * Only ignore case when TAG_NOIC not used or 'ignorecase' set.
1461 #ifdef FEAT_TAG_BINS
1462 pats->regmatch.rm_ic = ((p_ic || !noic)
1463 && (findall || pats->headlen == 0 || !p_tbs));
1464 for (round = 1; round <= 2; ++round)
1466 linear = (pats->headlen == 0 || !p_tbs || round == 2);
1467 #else
1468 pats->regmatch.rm_ic = (p_ic || !noic);
1469 #endif
1472 * Try tag file names from tags option one by one.
1474 for (first_file = TRUE;
1475 #ifdef FEAT_CSCOPE
1476 use_cscope ||
1477 #endif
1478 get_tagfname(&tn, first_file, tag_fname) == OK;
1479 first_file = FALSE)
1482 * A file that doesn't exist is silently ignored. Only when not a
1483 * single file is found, an error message is given (further on).
1485 #ifdef FEAT_CSCOPE
1486 if (use_cscope)
1487 fp = NULL; /* avoid GCC warning */
1488 else
1489 #endif
1491 #ifdef FEAT_MULTI_LANG
1492 if (curbuf->b_help)
1494 /* Prefer help tags according to 'helplang'. Put the
1495 * two-letter language name in help_lang[]. */
1496 i = (int)STRLEN(tag_fname);
1497 if (i > 3 && tag_fname[i - 3] == '-')
1498 STRCPY(help_lang, tag_fname + i - 2);
1499 else
1500 STRCPY(help_lang, "en");
1502 /* When searching for a specific language skip tags files
1503 * for other languages. */
1504 if (help_lang_find != NULL
1505 && STRICMP(help_lang, help_lang_find) != 0)
1506 continue;
1508 /* For CTRL-] in a help file prefer a match with the same
1509 * language. */
1510 if ((flags & TAG_KEEP_LANG)
1511 && help_lang_find == NULL
1512 && curbuf->b_fname != NULL
1513 && (i = (int)STRLEN(curbuf->b_fname)) > 4
1514 && curbuf->b_fname[i - 1] == 'x'
1515 && curbuf->b_fname[i - 4] == '.'
1516 && STRNICMP(curbuf->b_fname + i - 3, help_lang, 2) == 0)
1517 help_pri = 0;
1518 else
1520 help_pri = 1;
1521 for (s = p_hlg; *s != NUL; ++s)
1523 if (STRNICMP(s, help_lang, 2) == 0)
1524 break;
1525 ++help_pri;
1526 if ((s = vim_strchr(s, ',')) == NULL)
1527 break;
1529 if (s == NULL || *s == NUL)
1531 /* Language not in 'helplang': use last, prefer English,
1532 * unless found already. */
1533 ++help_pri;
1534 if (STRICMP(help_lang, "en") != 0)
1535 ++help_pri;
1539 #endif
1541 if ((fp = mch_fopen((char *)tag_fname, "r")) == NULL)
1542 continue;
1544 if (p_verbose >= 5)
1546 verbose_enter();
1547 smsg((char_u *)_("Searching tags file %s"), tag_fname);
1548 verbose_leave();
1551 did_open = TRUE; /* remember that we found at least one file */
1553 state = TS_START; /* we're at the start of the file */
1554 #ifdef FEAT_EMACS_TAGS
1555 is_etag = 0; /* default is: not emacs style */
1556 #endif
1559 * Read and parse the lines in the file one by one
1561 for (;;)
1563 line_breakcheck(); /* check for CTRL-C typed */
1564 #ifdef FEAT_INS_EXPAND
1565 if ((flags & TAG_INS_COMP)) /* Double brackets for gcc */
1566 ins_compl_check_keys(30);
1567 if (got_int || compl_interrupted)
1568 #else
1569 if (got_int)
1570 #endif
1572 stop_searching = TRUE;
1573 break;
1575 /* When mincount is TAG_MANY, stop when enough matches have been
1576 * found (for completion). */
1577 if (mincount == TAG_MANY && match_count >= TAG_MANY)
1579 stop_searching = TRUE;
1580 retval = OK;
1581 break;
1583 if (get_it_again)
1584 goto line_read_in;
1585 #ifdef FEAT_TAG_BINS
1587 * For binary search: compute the next offset to use.
1589 if (state == TS_BINARY)
1591 offset = search_info.low_offset + ((search_info.high_offset
1592 - search_info.low_offset) / 2);
1593 if (offset == search_info.curr_offset)
1594 break; /* End the binary search without a match. */
1595 else
1596 search_info.curr_offset = offset;
1600 * Skipping back (after a match during binary search).
1602 else if (state == TS_SKIP_BACK)
1604 search_info.curr_offset -= LSIZE * 2;
1605 if (search_info.curr_offset < 0)
1607 search_info.curr_offset = 0;
1608 rewind(fp);
1609 state = TS_STEP_FORWARD;
1614 * When jumping around in the file, first read a line to find the
1615 * start of the next line.
1617 if (state == TS_BINARY || state == TS_SKIP_BACK)
1619 /* Adjust the search file offset to the correct position */
1620 search_info.curr_offset_used = search_info.curr_offset;
1621 #ifdef HAVE_FSEEKO
1622 fseeko(fp, search_info.curr_offset, SEEK_SET);
1623 #else
1624 fseek(fp, (long)search_info.curr_offset, SEEK_SET);
1625 #endif
1626 eof = tag_fgets(lbuf, LSIZE, fp);
1627 if (!eof && search_info.curr_offset != 0)
1629 /* The explicit cast is to work around a bug in gcc 3.4.2
1630 * (repeated below). */
1631 search_info.curr_offset = ftell(fp);
1632 if (search_info.curr_offset == search_info.high_offset)
1634 /* oops, gone a bit too far; try from low offset */
1635 #ifdef HAVE_FSEEKO
1636 fseeko(fp, search_info.low_offset, SEEK_SET);
1637 #else
1638 fseek(fp, (long)search_info.low_offset, SEEK_SET);
1639 #endif
1640 search_info.curr_offset = search_info.low_offset;
1642 eof = tag_fgets(lbuf, LSIZE, fp);
1644 /* skip empty and blank lines */
1645 while (!eof && vim_isblankline(lbuf))
1647 search_info.curr_offset = ftell(fp);
1648 eof = tag_fgets(lbuf, LSIZE, fp);
1650 if (eof)
1652 /* Hit end of file. Skip backwards. */
1653 state = TS_SKIP_BACK;
1654 search_info.match_offset = ftell(fp);
1655 search_info.curr_offset = search_info.curr_offset_used;
1656 continue;
1661 * Not jumping around in the file: Read the next line.
1663 else
1664 #endif
1666 /* skip empty and blank lines */
1669 #ifdef FEAT_CSCOPE
1670 if (use_cscope)
1671 eof = cs_fgets(lbuf, LSIZE);
1672 else
1673 #endif
1674 eof = tag_fgets(lbuf, LSIZE, fp);
1675 } while (!eof && vim_isblankline(lbuf));
1677 if (eof)
1679 #ifdef FEAT_EMACS_TAGS
1680 if (incstack_idx) /* this was an included file */
1682 --incstack_idx;
1683 fclose(fp); /* end of this file ... */
1684 fp = incstack[incstack_idx].fp;
1685 STRCPY(tag_fname, incstack[incstack_idx].etag_fname);
1686 vim_free(incstack[incstack_idx].etag_fname);
1687 is_etag = 1; /* (only etags can include) */
1688 continue; /* ... continue with parent file */
1690 else
1691 #endif
1692 break; /* end of file */
1695 line_read_in:
1697 #ifdef FEAT_EMACS_TAGS
1699 * Emacs tags line with CTRL-L: New file name on next line.
1700 * The file name is followed by a ','.
1702 if (*lbuf == Ctrl_L) /* remember etag file name in ebuf */
1704 is_etag = 1; /* in case at the start */
1705 state = TS_LINEAR;
1706 if (!tag_fgets(ebuf, LSIZE, fp))
1708 for (p = ebuf; *p && *p != ','; p++)
1710 *p = NUL;
1713 * atoi(p+1) is the number of bytes before the next ^L
1714 * unless it is an include statement.
1716 if (STRNCMP(p + 1, "include", 7) == 0
1717 && incstack_idx < INCSTACK_SIZE)
1719 /* Save current "fp" and "tag_fname" in the stack. */
1720 if ((incstack[incstack_idx].etag_fname =
1721 vim_strsave(tag_fname)) != NULL)
1723 char_u *fullpath_ebuf;
1725 incstack[incstack_idx].fp = fp;
1726 fp = NULL;
1728 /* Figure out "tag_fname" and "fp" to use for
1729 * included file. */
1730 fullpath_ebuf = expand_tag_fname(ebuf,
1731 tag_fname, FALSE);
1732 if (fullpath_ebuf != NULL)
1734 fp = mch_fopen((char *)fullpath_ebuf, "r");
1735 if (fp != NULL)
1737 if (STRLEN(fullpath_ebuf) > LSIZE)
1738 EMSG2(_("E430: Tag file path truncated for %s\n"), ebuf);
1739 vim_strncpy(tag_fname, fullpath_ebuf,
1740 MAXPATHL);
1741 ++incstack_idx;
1742 is_etag = 0; /* we can include anything */
1744 vim_free(fullpath_ebuf);
1746 if (fp == NULL)
1748 /* Can't open the included file, skip it and
1749 * restore old value of "fp". */
1750 fp = incstack[incstack_idx].fp;
1751 vim_free(incstack[incstack_idx].etag_fname);
1756 continue;
1758 #endif
1761 * When still at the start of the file, check for Emacs tags file
1762 * format, and for "not sorted" flag.
1764 if (state == TS_START)
1766 #ifdef FEAT_TAG_BINS
1768 * When there is no tag head, or ignoring case, need to do a
1769 * linear search.
1770 * When no "!_TAG_" is found, default to binary search. If
1771 * the tag file isn't sorted, the second loop will find it.
1772 * When "!_TAG_FILE_SORTED" found: start binary search if
1773 * flag set.
1774 * For cscope, it's always linear.
1776 # ifdef FEAT_CSCOPE
1777 if (linear || use_cscope)
1778 # else
1779 if (linear)
1780 # endif
1781 state = TS_LINEAR;
1782 else if (STRNCMP(lbuf, "!_TAG_", 6) > 0)
1783 state = TS_BINARY;
1784 else if (STRNCMP(lbuf, "!_TAG_FILE_SORTED\t", 18) == 0)
1786 /* Check sorted flag */
1787 if (lbuf[18] == '1')
1788 state = TS_BINARY;
1789 else if (lbuf[18] == '2')
1791 state = TS_BINARY;
1792 sortic = TRUE;
1793 pats->regmatch.rm_ic = (p_ic || !noic);
1795 else
1796 state = TS_LINEAR;
1799 if (state == TS_BINARY && pats->regmatch.rm_ic && !sortic)
1801 /* binary search won't work for ignoring case, use linear
1802 * search. */
1803 linear = TRUE;
1804 state = TS_LINEAR;
1806 #else
1807 state = TS_LINEAR;
1808 #endif
1810 #ifdef FEAT_TAG_BINS
1812 * When starting a binary search, get the size of the file and
1813 * compute the first offset.
1815 if (state == TS_BINARY)
1817 /* Get the tag file size (don't use mch_fstat(), it's not
1818 * portable). */
1819 if ((filesize = lseek(fileno(fp),
1820 (off_t)0L, SEEK_END)) <= 0)
1821 state = TS_LINEAR;
1822 else
1824 lseek(fileno(fp), (off_t)0L, SEEK_SET);
1826 /* Calculate the first read offset in the file. Start
1827 * the search in the middle of the file. */
1828 search_info.low_offset = 0;
1829 search_info.low_char = 0;
1830 search_info.high_offset = filesize;
1831 search_info.curr_offset = 0;
1832 search_info.high_char = 0xff;
1834 continue;
1836 #endif
1839 #ifdef FEAT_MBYTE
1840 if (lbuf[0] == '!' && pats == &orgpat
1841 && STRNCMP(lbuf, "!_TAG_FILE_ENCODING\t", 20) == 0)
1843 /* Convert the search pattern from 'encoding' to the
1844 * specified encoding. */
1845 for (p = lbuf + 20; *p > ' ' && *p < 127; ++p)
1847 *p = NUL;
1848 convert_setup(&vimconv, p_enc, lbuf + 20);
1849 if (vimconv.vc_type != CONV_NONE)
1851 convpat.pat = string_convert(&vimconv, pats->pat, NULL);
1852 if (convpat.pat != NULL)
1854 pats = &convpat;
1855 pats->len = (int)STRLEN(pats->pat);
1856 prepare_pats(pats, has_re);
1857 pats->regmatch.rm_ic = orgpat.regmatch.rm_ic;
1861 /* Prepare for converting a match the other way around. */
1862 convert_setup(&vimconv, lbuf + 20, p_enc);
1863 continue;
1865 #endif
1868 * Figure out where the different strings are in this line.
1869 * For "normal" tags: Do a quick check if the tag matches.
1870 * This speeds up tag searching a lot!
1872 if (pats->headlen
1873 #ifdef FEAT_EMACS_TAGS
1874 && !is_etag
1875 #endif
1878 tagp.tagname = lbuf;
1879 #ifdef FEAT_TAG_ANYWHITE
1880 tagp.tagname_end = skiptowhite(lbuf);
1881 if (*tagp.tagname_end == NUL) /* corrupted tag line */
1882 #else
1883 tagp.tagname_end = vim_strchr(lbuf, TAB);
1884 if (tagp.tagname_end == NULL) /* corrupted tag line */
1885 #endif
1887 line_error = TRUE;
1888 break;
1891 #ifdef FEAT_TAG_OLDSTATIC
1893 * Check for old style static tag: "file:tag file .."
1895 tagp.fname = NULL;
1896 for (p = lbuf; p < tagp.tagname_end; ++p)
1898 if (*p == ':')
1900 if (tagp.fname == NULL)
1901 #ifdef FEAT_TAG_ANYWHITE
1902 tagp.fname = skipwhite(tagp.tagname_end);
1903 #else
1904 tagp.fname = tagp.tagname_end + 1;
1905 #endif
1906 if ( fnamencmp(lbuf, tagp.fname, p - lbuf) == 0
1907 #ifdef FEAT_TAG_ANYWHITE
1908 && vim_iswhite(tagp.fname[p - lbuf])
1909 #else
1910 && tagp.fname[p - lbuf] == TAB
1911 #endif
1914 /* found one */
1915 tagp.tagname = p + 1;
1916 break;
1920 #endif
1923 * Skip this line if the length of the tag is different and
1924 * there is no regexp, or the tag is too short.
1926 cmplen = (int)(tagp.tagname_end - tagp.tagname);
1927 if (p_tl != 0 && cmplen > p_tl) /* adjust for 'taglength' */
1928 cmplen = p_tl;
1929 if (has_re && pats->headlen < cmplen)
1930 cmplen = pats->headlen;
1931 else if (state == TS_LINEAR && pats->headlen != cmplen)
1932 continue;
1934 #ifdef FEAT_TAG_BINS
1935 if (state == TS_BINARY)
1938 * Simplistic check for unsorted tags file.
1940 i = (int)tagp.tagname[0];
1941 if (sortic)
1942 i = (int)TOUPPER_ASC(tagp.tagname[0]);
1943 if (i < search_info.low_char || i > search_info.high_char)
1944 sort_error = TRUE;
1947 * Compare the current tag with the searched tag.
1949 if (sortic)
1950 tagcmp = tag_strnicmp(tagp.tagname, pats->head,
1951 (size_t)cmplen);
1952 else
1953 tagcmp = STRNCMP(tagp.tagname, pats->head, cmplen);
1956 * A match with a shorter tag means to search forward.
1957 * A match with a longer tag means to search backward.
1959 if (tagcmp == 0)
1961 if (cmplen < pats->headlen)
1962 tagcmp = -1;
1963 else if (cmplen > pats->headlen)
1964 tagcmp = 1;
1967 if (tagcmp == 0)
1969 /* We've located the tag, now skip back and search
1970 * forward until the first matching tag is found.
1972 state = TS_SKIP_BACK;
1973 search_info.match_offset = search_info.curr_offset;
1974 continue;
1976 if (tagcmp < 0)
1978 search_info.curr_offset = ftell(fp);
1979 if (search_info.curr_offset < search_info.high_offset)
1981 search_info.low_offset = search_info.curr_offset;
1982 if (sortic)
1983 search_info.low_char =
1984 TOUPPER_ASC(tagp.tagname[0]);
1985 else
1986 search_info.low_char = tagp.tagname[0];
1987 continue;
1990 if (tagcmp > 0
1991 && search_info.curr_offset != search_info.high_offset)
1993 search_info.high_offset = search_info.curr_offset;
1994 if (sortic)
1995 search_info.high_char =
1996 TOUPPER_ASC(tagp.tagname[0]);
1997 else
1998 search_info.high_char = tagp.tagname[0];
1999 continue;
2002 /* No match yet and are at the end of the binary search. */
2003 break;
2005 else if (state == TS_SKIP_BACK)
2007 if (MB_STRNICMP(tagp.tagname, pats->head, cmplen) != 0)
2008 state = TS_STEP_FORWARD;
2009 else
2010 /* Have to skip back more. Restore the curr_offset
2011 * used, otherwise we get stuck at a long line. */
2012 search_info.curr_offset = search_info.curr_offset_used;
2013 continue;
2015 else if (state == TS_STEP_FORWARD)
2017 if (MB_STRNICMP(tagp.tagname, pats->head, cmplen) != 0)
2019 if ((off_t)ftell(fp) > search_info.match_offset)
2020 break; /* past last match */
2021 else
2022 continue; /* before first match */
2025 else
2026 #endif
2027 /* skip this match if it can't match */
2028 if (MB_STRNICMP(tagp.tagname, pats->head, cmplen) != 0)
2029 continue;
2032 * Can be a matching tag, isolate the file name and command.
2034 #ifdef FEAT_TAG_OLDSTATIC
2035 if (tagp.fname == NULL)
2036 #endif
2037 #ifdef FEAT_TAG_ANYWHITE
2038 tagp.fname = skipwhite(tagp.tagname_end);
2039 #else
2040 tagp.fname = tagp.tagname_end + 1;
2041 #endif
2042 #ifdef FEAT_TAG_ANYWHITE
2043 tagp.fname_end = skiptowhite(tagp.fname);
2044 tagp.command = skipwhite(tagp.fname_end);
2045 if (*tagp.command == NUL)
2046 #else
2047 tagp.fname_end = vim_strchr(tagp.fname, TAB);
2048 tagp.command = tagp.fname_end + 1;
2049 if (tagp.fname_end == NULL)
2050 #endif
2051 i = FAIL;
2052 else
2053 i = OK;
2055 else
2056 i = parse_tag_line(lbuf,
2057 #ifdef FEAT_EMACS_TAGS
2058 is_etag,
2059 #endif
2060 &tagp);
2061 if (i == FAIL)
2063 line_error = TRUE;
2064 break;
2067 #ifdef FEAT_EMACS_TAGS
2068 if (is_etag)
2069 tagp.fname = ebuf;
2070 #endif
2072 * First try matching with the pattern literally (also when it is
2073 * a regexp).
2075 cmplen = (int)(tagp.tagname_end - tagp.tagname);
2076 if (p_tl != 0 && cmplen > p_tl) /* adjust for 'taglength' */
2077 cmplen = p_tl;
2078 /* if tag length does not match, don't try comparing */
2079 if (pats->len != cmplen)
2080 match = FALSE;
2081 else
2083 if (pats->regmatch.rm_ic)
2085 match = (MB_STRNICMP(tagp.tagname, pats->pat, cmplen) == 0);
2086 if (match)
2087 match_no_ic = (STRNCMP(tagp.tagname, pats->pat,
2088 cmplen) == 0);
2090 else
2091 match = (STRNCMP(tagp.tagname, pats->pat, cmplen) == 0);
2095 * Has a regexp: Also find tags matching regexp.
2097 match_re = FALSE;
2098 if (!match && pats->regmatch.regprog != NULL)
2100 int cc;
2102 cc = *tagp.tagname_end;
2103 *tagp.tagname_end = NUL;
2104 match = vim_regexec(&pats->regmatch, tagp.tagname, (colnr_T)0);
2105 if (match)
2107 matchoff = (int)(pats->regmatch.startp[0] - tagp.tagname);
2108 if (pats->regmatch.rm_ic)
2110 pats->regmatch.rm_ic = FALSE;
2111 match_no_ic = vim_regexec(&pats->regmatch, tagp.tagname,
2112 (colnr_T)0);
2113 pats->regmatch.rm_ic = TRUE;
2116 *tagp.tagname_end = cc;
2117 match_re = TRUE;
2121 * If a match is found, add it to ga_match[].
2123 if (match)
2125 #ifdef FEAT_CSCOPE
2126 if (use_cscope)
2128 /* Don't change the ordering, always use the same table. */
2129 mtt = MT_GL_OTH;
2131 else
2132 #endif
2134 /* Decide in which array to store this match. */
2135 is_current = test_for_current(
2136 #ifdef FEAT_EMACS_TAGS
2137 is_etag,
2138 #endif
2139 tagp.fname, tagp.fname_end, tag_fname,
2140 buf_ffname);
2141 #ifdef FEAT_EMACS_TAGS
2142 is_static = FALSE;
2143 if (!is_etag) /* emacs tags are never static */
2144 #endif
2146 #ifdef FEAT_TAG_OLDSTATIC
2147 if (tagp.tagname != lbuf)
2148 is_static = TRUE; /* detected static tag before */
2149 else
2150 #endif
2151 is_static = test_for_static(&tagp);
2154 /* decide in which of the sixteen tables to store this
2155 * match */
2156 if (is_static)
2158 if (is_current)
2159 mtt = MT_ST_CUR;
2160 else
2161 mtt = MT_ST_OTH;
2163 else
2165 if (is_current)
2166 mtt = MT_GL_CUR;
2167 else
2168 mtt = MT_GL_OTH;
2170 if (pats->regmatch.rm_ic && !match_no_ic)
2171 mtt += MT_IC_OFF;
2172 if (match_re)
2173 mtt += MT_RE_OFF;
2177 * Add the found match in ga_match[mtt], avoiding duplicates.
2178 * Store the info we need later, which depends on the kind of
2179 * tags we are dealing with.
2181 if (ga_grow(&ga_match[mtt], 1) == OK)
2183 #ifdef FEAT_MBYTE
2184 char_u *conv_line = NULL;
2185 char_u *lbuf_line = lbuf;
2187 if (vimconv.vc_type != CONV_NONE)
2189 /* Convert the tag line from the encoding of the tags
2190 * file to 'encoding'. Then parse the line again. */
2191 conv_line = string_convert(&vimconv, lbuf, NULL);
2192 if (conv_line != NULL)
2194 if (parse_tag_line(conv_line,
2195 #ifdef FEAT_EMACS_TAGS
2196 is_etag,
2197 #endif
2198 &tagp) == OK)
2199 lbuf_line = conv_line;
2200 else
2201 /* doesn't work, go back to unconverted line. */
2202 (void)parse_tag_line(lbuf,
2203 #ifdef FEAT_EMACS_TAGS
2204 is_etag,
2205 #endif
2206 &tagp);
2209 #else
2210 # define lbuf_line lbuf
2211 #endif
2212 if (help_only)
2214 #ifdef FEAT_MULTI_LANG
2215 # define ML_EXTRA 3
2216 #else
2217 # define ML_EXTRA 0
2218 #endif
2220 * Append the help-heuristic number after the
2221 * tagname, for sorting it later.
2223 *tagp.tagname_end = NUL;
2224 len = (int)(tagp.tagname_end - tagp.tagname);
2225 mfp = (struct match_found *)
2226 alloc((int)sizeof(struct match_found) + len
2227 + 10 + ML_EXTRA);
2228 if (mfp != NULL)
2230 /* "len" includes the language and the NUL, but
2231 * not the priority. */
2232 mfp->len = len + ML_EXTRA + 1;
2233 #define ML_HELP_LEN 6
2234 p = mfp->match;
2235 STRCPY(p, tagp.tagname);
2236 #ifdef FEAT_MULTI_LANG
2237 p[len] = '@';
2238 STRCPY(p + len + 1, help_lang);
2239 #endif
2240 sprintf((char *)p + len + 1 + ML_EXTRA, "%06d",
2241 help_heuristic(tagp.tagname,
2242 match_re ? matchoff : 0, !match_no_ic)
2243 #ifdef FEAT_MULTI_LANG
2244 + help_pri
2245 #endif
2248 *tagp.tagname_end = TAB;
2250 else if (name_only)
2252 if (get_it_again)
2254 char_u *temp_end = tagp.command;
2256 if (*temp_end == '/')
2257 while (*temp_end && *temp_end != '\r'
2258 && *temp_end != '\n'
2259 && *temp_end != '$')
2260 temp_end++;
2262 if (tagp.command + 2 < temp_end)
2264 len = (int)(temp_end - tagp.command - 2);
2265 mfp = (struct match_found *)alloc(
2266 (int)sizeof(struct match_found) + len);
2267 if (mfp != NULL)
2269 mfp->len = len + 1; /* include the NUL */
2270 p = mfp->match;
2271 vim_strncpy(p, tagp.command + 2, len);
2274 else
2275 mfp = NULL;
2276 get_it_again = FALSE;
2278 else
2280 len = (int)(tagp.tagname_end - tagp.tagname);
2281 mfp = (struct match_found *)alloc(
2282 (int)sizeof(struct match_found) + len);
2283 if (mfp != NULL)
2285 mfp->len = len + 1; /* include the NUL */
2286 p = mfp->match;
2287 vim_strncpy(p, tagp.tagname, len);
2290 /* if wanted, re-read line to get long form too */
2291 if (State & INSERT)
2292 get_it_again = p_sft;
2295 else
2297 /* Save the tag in a buffer.
2298 * Emacs tag: <mtt><tag_fname><NUL><ebuf><NUL><lbuf>
2299 * other tag: <mtt><tag_fname><NUL><NUL><lbuf>
2300 * without Emacs tags: <mtt><tag_fname><NUL><lbuf>
2302 len = (int)STRLEN(tag_fname)
2303 + (int)STRLEN(lbuf_line) + 3;
2304 #ifdef FEAT_EMACS_TAGS
2305 if (is_etag)
2306 len += (int)STRLEN(ebuf) + 1;
2307 else
2308 ++len;
2309 #endif
2310 mfp = (struct match_found *)alloc(
2311 (int)sizeof(struct match_found) + len);
2312 if (mfp != NULL)
2314 mfp->len = len;
2315 p = mfp->match;
2316 p[0] = mtt;
2317 STRCPY(p + 1, tag_fname);
2318 #ifdef BACKSLASH_IN_FILENAME
2319 /* Ignore differences in slashes, avoid adding
2320 * both path/file and path\file. */
2321 slash_adjust(p + 1);
2322 #endif
2323 s = p + 1 + STRLEN(tag_fname) + 1;
2324 #ifdef FEAT_EMACS_TAGS
2325 if (is_etag)
2327 STRCPY(s, ebuf);
2328 s += STRLEN(ebuf) + 1;
2330 else
2331 *s++ = NUL;
2332 #endif
2333 STRCPY(s, lbuf_line);
2337 if (mfp != NULL)
2340 * Don't add identical matches.
2341 * This can take a lot of time when finding many
2342 * matches, check for CTRL-C now and then.
2343 * Add all cscope tags, because they are all listed.
2345 #ifdef FEAT_CSCOPE
2346 if (use_cscope)
2347 i = -1;
2348 else
2349 #endif
2350 for (i = ga_match[mtt].ga_len; --i >= 0 && !got_int; )
2352 mfp2 = ((struct match_found **)
2353 (ga_match[mtt].ga_data))[i];
2354 if (mfp2->len == mfp->len
2355 && vim_memcmp(mfp2->match, mfp->match,
2356 (size_t)mfp->len) == 0)
2357 break;
2358 line_breakcheck();
2360 if (i < 0)
2362 ((struct match_found **)(ga_match[mtt].ga_data))
2363 [ga_match[mtt].ga_len++] = mfp;
2364 ++match_count;
2366 else
2367 vim_free(mfp);
2369 #ifdef FEAT_MBYTE
2370 /* Note: this makes the values in "tagp" invalid! */
2371 vim_free(conv_line);
2372 #endif
2374 else /* Out of memory! Just forget about the rest. */
2376 retval = OK;
2377 stop_searching = TRUE;
2378 break;
2381 #ifdef FEAT_CSCOPE
2382 if (use_cscope && eof)
2383 break;
2384 #endif
2385 } /* forever */
2387 if (line_error)
2389 EMSG2(_("E431: Format error in tags file \"%s\""), tag_fname);
2390 #ifdef FEAT_CSCOPE
2391 if (!use_cscope)
2392 #endif
2393 EMSGN(_("Before byte %ld"), (long)ftell(fp));
2394 stop_searching = TRUE;
2395 line_error = FALSE;
2398 #ifdef FEAT_CSCOPE
2399 if (!use_cscope)
2400 #endif
2401 fclose(fp);
2402 #ifdef FEAT_EMACS_TAGS
2403 while (incstack_idx)
2405 --incstack_idx;
2406 fclose(incstack[incstack_idx].fp);
2407 vim_free(incstack[incstack_idx].etag_fname);
2409 #endif
2410 #ifdef FEAT_MBYTE
2411 if (pats == &convpat)
2413 /* Go back from converted pattern to original pattern. */
2414 vim_free(pats->pat);
2415 vim_free(pats->regmatch.regprog);
2416 orgpat.regmatch.rm_ic = pats->regmatch.rm_ic;
2417 pats = &orgpat;
2419 if (vimconv.vc_type != CONV_NONE)
2420 convert_setup(&vimconv, NULL, NULL);
2421 #endif
2423 #ifdef FEAT_TAG_BINS
2424 if (sort_error)
2426 EMSG2(_("E432: Tags file not sorted: %s"), tag_fname);
2427 sort_error = FALSE;
2429 #endif
2432 * Stop searching if sufficient tags have been found.
2434 if (match_count >= mincount)
2436 retval = OK;
2437 stop_searching = TRUE;
2440 #ifdef FEAT_CSCOPE
2441 if (stop_searching || use_cscope)
2442 #else
2443 if (stop_searching)
2444 #endif
2445 break;
2447 } /* end of for-each-file loop */
2449 #ifdef FEAT_CSCOPE
2450 if (!use_cscope)
2451 #endif
2452 tagname_free(&tn);
2454 #ifdef FEAT_TAG_BINS
2455 /* stop searching when already did a linear search, or when TAG_NOIC
2456 * used, and 'ignorecase' not set or already did case-ignore search */
2457 if (stop_searching || linear || (!p_ic && noic) || pats->regmatch.rm_ic)
2458 break;
2459 # ifdef FEAT_CSCOPE
2460 if (use_cscope)
2461 break;
2462 # endif
2463 pats->regmatch.rm_ic = TRUE; /* try another time while ignoring case */
2465 #endif
2467 if (!stop_searching)
2469 if (!did_open && verbose) /* never opened any tags file */
2470 EMSG(_("E433: No tags file"));
2471 retval = OK; /* It's OK even when no tag found */
2474 findtag_end:
2475 vim_free(lbuf);
2476 vim_free(pats->regmatch.regprog);
2477 vim_free(tag_fname);
2478 #ifdef FEAT_EMACS_TAGS
2479 vim_free(ebuf);
2480 #endif
2483 * Move the matches from the ga_match[] arrays into one list of
2484 * matches. When retval == FAIL, free the matches.
2486 if (retval == FAIL)
2487 match_count = 0;
2489 if (match_count > 0)
2490 matches = (char_u **)lalloc((long_u)(match_count * sizeof(char_u *)),
2491 TRUE);
2492 else
2493 matches = NULL;
2494 match_count = 0;
2495 for (mtt = 0; mtt < MT_COUNT; ++mtt)
2497 for (i = 0; i < ga_match[mtt].ga_len; ++i)
2499 mfp = ((struct match_found **)(ga_match[mtt].ga_data))[i];
2500 if (matches == NULL)
2501 vim_free(mfp);
2502 else
2504 /* To avoid allocating memory again we turn the struct
2505 * match_found into a string. For help the priority was not
2506 * included in the length. */
2507 mch_memmove(mfp, mfp->match,
2508 (size_t)(mfp->len + (help_only ? ML_HELP_LEN : 0)));
2509 matches[match_count++] = (char_u *)mfp;
2512 ga_clear(&ga_match[mtt]);
2515 *matchesp = matches;
2516 *num_matches = match_count;
2518 curbuf->b_help = help_save;
2519 #ifdef FEAT_MULTI_LANG
2520 vim_free(saved_pat);
2521 #endif
2523 return retval;
2526 static garray_T tag_fnames = GA_EMPTY;
2527 static void found_tagfile_cb __ARGS((char_u *fname, void *cookie));
2530 * Callback function for finding all "tags" and "tags-??" files in
2531 * 'runtimepath' doc directories.
2533 static void
2534 found_tagfile_cb(fname, cookie)
2535 char_u *fname;
2536 void *cookie UNUSED;
2538 if (ga_grow(&tag_fnames, 1) == OK)
2539 ((char_u **)(tag_fnames.ga_data))[tag_fnames.ga_len++] =
2540 vim_strsave(fname);
2543 #if defined(EXITFREE) || defined(PROTO)
2544 void
2545 free_tag_stuff()
2547 ga_clear_strings(&tag_fnames);
2548 do_tag(NULL, DT_FREE, 0, 0, 0);
2549 tag_freematch();
2551 # if defined(FEAT_WINDOWS) && defined(FEAT_QUICKFIX)
2552 if (ptag_entry.tagname)
2554 vim_free(ptag_entry.tagname);
2555 ptag_entry.tagname = NULL;
2557 # endif
2559 #endif
2562 * Get the next name of a tag file from the tag file list.
2563 * For help files, use "tags" file only.
2565 * Return FAIL if no more tag file names, OK otherwise.
2568 get_tagfname(tnp, first, buf)
2569 tagname_T *tnp; /* holds status info */
2570 int first; /* TRUE when first file name is wanted */
2571 char_u *buf; /* pointer to buffer of MAXPATHL chars */
2573 char_u *fname = NULL;
2574 char_u *r_ptr;
2576 if (first)
2577 vim_memset(tnp, 0, sizeof(tagname_T));
2579 if (curbuf->b_help)
2582 * For help files it's done in a completely different way:
2583 * Find "doc/tags" and "doc/tags-??" in all directories in
2584 * 'runtimepath'.
2586 if (first)
2588 ga_clear_strings(&tag_fnames);
2589 ga_init2(&tag_fnames, (int)sizeof(char_u *), 10);
2590 do_in_runtimepath((char_u *)
2591 #ifdef FEAT_MULTI_LANG
2592 # ifdef VMS
2593 /* Functions decc$to_vms() and decc$translate_vms() crash
2594 * on some VMS systems with wildcards "??". Seems ECO
2595 * patches do fix the problem in C RTL, but we can't use
2596 * an #ifdef for that. */
2597 "doc/tags doc/tags-*"
2598 # else
2599 "doc/tags doc/tags-??"
2600 # endif
2601 #else
2602 "doc/tags"
2603 #endif
2604 , TRUE, found_tagfile_cb, NULL);
2607 if (tnp->tn_hf_idx >= tag_fnames.ga_len)
2609 /* Not found in 'runtimepath', use 'helpfile', if it exists and
2610 * wasn't used yet, replacing "help.txt" with "tags". */
2611 if (tnp->tn_hf_idx > tag_fnames.ga_len || *p_hf == NUL)
2612 return FAIL;
2613 ++tnp->tn_hf_idx;
2614 STRCPY(buf, p_hf);
2615 STRCPY(gettail(buf), "tags");
2617 else
2618 vim_strncpy(buf, ((char_u **)(tag_fnames.ga_data))[
2619 tnp->tn_hf_idx++], MAXPATHL - 1);
2620 return OK;
2623 if (first)
2625 /* Init. We make a copy of 'tags', because autocommands may change
2626 * the value without notifying us. */
2627 tnp->tn_tags = vim_strsave((*curbuf->b_p_tags != NUL)
2628 ? curbuf->b_p_tags : p_tags);
2629 if (tnp->tn_tags == NULL)
2630 return FAIL;
2631 tnp->tn_np = tnp->tn_tags;
2635 * Loop until we have found a file name that can be used.
2636 * There are two states:
2637 * tnp->tn_did_filefind_init == FALSE: setup for next part in 'tags'.
2638 * tnp->tn_did_filefind_init == TRUE: find next file in this part.
2640 for (;;)
2642 if (tnp->tn_did_filefind_init)
2644 fname = vim_findfile(tnp->tn_search_ctx);
2645 if (fname != NULL)
2646 break;
2648 tnp->tn_did_filefind_init = FALSE;
2650 else
2652 char_u *filename = NULL;
2654 /* Stop when used all parts of 'tags'. */
2655 if (*tnp->tn_np == NUL)
2657 vim_findfile_cleanup(tnp->tn_search_ctx);
2658 tnp->tn_search_ctx = NULL;
2659 return FAIL;
2663 * Copy next file name into buf.
2665 buf[0] = NUL;
2666 (void)copy_option_part(&tnp->tn_np, buf, MAXPATHL - 1, " ,");
2668 #ifdef FEAT_PATH_EXTRA
2669 r_ptr = vim_findfile_stopdir(buf);
2670 #else
2671 r_ptr = NULL;
2672 #endif
2673 /* move the filename one char forward and truncate the
2674 * filepath with a NUL */
2675 filename = gettail(buf);
2676 STRMOVE(filename + 1, filename);
2677 *filename++ = NUL;
2679 tnp->tn_search_ctx = vim_findfile_init(buf, filename,
2680 r_ptr, 100,
2681 FALSE, /* don't free visited list */
2682 FINDFILE_FILE, /* we search for a file */
2683 tnp->tn_search_ctx, TRUE, curbuf->b_ffname);
2684 if (tnp->tn_search_ctx != NULL)
2685 tnp->tn_did_filefind_init = TRUE;
2689 STRCPY(buf, fname);
2690 vim_free(fname);
2691 return OK;
2695 * Free the contents of a tagname_T that was filled by get_tagfname().
2697 void
2698 tagname_free(tnp)
2699 tagname_T *tnp;
2701 vim_free(tnp->tn_tags);
2702 vim_findfile_cleanup(tnp->tn_search_ctx);
2703 tnp->tn_search_ctx = NULL;
2704 ga_clear_strings(&tag_fnames);
2708 * Parse one line from the tags file. Find start/end of tag name, start/end of
2709 * file name and start of search pattern.
2711 * If is_etag is TRUE, tagp->fname and tagp->fname_end are not set.
2713 * Return FAIL if there is a format error in this line, OK otherwise.
2715 static int
2716 parse_tag_line(lbuf,
2717 #ifdef FEAT_EMACS_TAGS
2718 is_etag,
2719 #endif
2720 tagp)
2721 char_u *lbuf; /* line to be parsed */
2722 #ifdef FEAT_EMACS_TAGS
2723 int is_etag;
2724 #endif
2725 tagptrs_T *tagp;
2727 char_u *p;
2729 #ifdef FEAT_EMACS_TAGS
2730 char_u *p_7f;
2732 if (is_etag)
2735 * There are two formats for an emacs tag line:
2736 * 1: struct EnvBase ^?EnvBase^A139,4627
2737 * 2: #define ARPB_WILD_WORLD ^?153,5194
2739 p_7f = vim_strchr(lbuf, 0x7f);
2740 if (p_7f == NULL)
2742 etag_fail:
2743 if (vim_strchr(lbuf, '\n') == NULL)
2745 /* Truncated line. Ignore it. */
2746 if (p_verbose >= 5)
2748 verbose_enter();
2749 MSG(_("Ignoring long line in tags file"));
2750 verbose_leave();
2752 tagp->command = lbuf;
2753 tagp->tagname = lbuf;
2754 tagp->tagname_end = lbuf;
2755 return OK;
2757 return FAIL;
2760 /* Find ^A. If not found the line number is after the 0x7f */
2761 p = vim_strchr(p_7f, Ctrl_A);
2762 if (p == NULL)
2763 p = p_7f + 1;
2764 else
2765 ++p;
2767 if (!VIM_ISDIGIT(*p)) /* check for start of line number */
2768 goto etag_fail;
2769 tagp->command = p;
2772 if (p[-1] == Ctrl_A) /* first format: explicit tagname given */
2774 tagp->tagname = p_7f + 1;
2775 tagp->tagname_end = p - 1;
2777 else /* second format: isolate tagname */
2779 /* find end of tagname */
2780 for (p = p_7f - 1; !vim_iswordc(*p); --p)
2781 if (p == lbuf)
2782 goto etag_fail;
2783 tagp->tagname_end = p + 1;
2784 while (p >= lbuf && vim_iswordc(*p))
2785 --p;
2786 tagp->tagname = p + 1;
2789 else /* not an Emacs tag */
2791 #endif
2792 /* Isolate the tagname, from lbuf up to the first white */
2793 tagp->tagname = lbuf;
2794 #ifdef FEAT_TAG_ANYWHITE
2795 p = skiptowhite(lbuf);
2796 #else
2797 p = vim_strchr(lbuf, TAB);
2798 if (p == NULL)
2799 return FAIL;
2800 #endif
2801 tagp->tagname_end = p;
2803 /* Isolate file name, from first to second white space */
2804 #ifdef FEAT_TAG_ANYWHITE
2805 p = skipwhite(p);
2806 #else
2807 if (*p != NUL)
2808 ++p;
2809 #endif
2810 tagp->fname = p;
2811 #ifdef FEAT_TAG_ANYWHITE
2812 p = skiptowhite(p);
2813 #else
2814 p = vim_strchr(p, TAB);
2815 if (p == NULL)
2816 return FAIL;
2817 #endif
2818 tagp->fname_end = p;
2820 /* find start of search command, after second white space */
2821 #ifdef FEAT_TAG_ANYWHITE
2822 p = skipwhite(p);
2823 #else
2824 if (*p != NUL)
2825 ++p;
2826 #endif
2827 if (*p == NUL)
2828 return FAIL;
2829 tagp->command = p;
2830 #ifdef FEAT_EMACS_TAGS
2832 #endif
2834 return OK;
2838 * Check if tagname is a static tag
2840 * Static tags produced by the older ctags program have the format:
2841 * 'file:tag file /pattern'.
2842 * This is only recognized when both occurrence of 'file' are the same, to
2843 * avoid recognizing "string::string" or ":exit".
2845 * Static tags produced by the new ctags program have the format:
2846 * 'tag file /pattern/;"<Tab>file:' "
2848 * Return TRUE if it is a static tag and adjust *tagname to the real tag.
2849 * Return FALSE if it is not a static tag.
2851 static int
2852 test_for_static(tagp)
2853 tagptrs_T *tagp;
2855 char_u *p;
2857 #ifdef FEAT_TAG_OLDSTATIC
2858 int len;
2861 * Check for old style static tag: "file:tag file .."
2863 len = (int)(tagp->fname_end - tagp->fname);
2864 p = tagp->tagname + len;
2865 if ( p < tagp->tagname_end
2866 && *p == ':'
2867 && fnamencmp(tagp->tagname, tagp->fname, len) == 0)
2869 tagp->tagname = p + 1;
2870 return TRUE;
2872 #endif
2875 * Check for new style static tag ":...<Tab>file:[<Tab>...]"
2877 p = tagp->command;
2878 while ((p = vim_strchr(p, '\t')) != NULL)
2880 ++p;
2881 if (STRNCMP(p, "file:", 5) == 0)
2882 return TRUE;
2885 return FALSE;
2889 * Parse a line from a matching tag. Does not change the line itself.
2891 * The line that we get looks like this:
2892 * Emacs tag: <mtt><tag_fname><NUL><ebuf><NUL><lbuf>
2893 * other tag: <mtt><tag_fname><NUL><NUL><lbuf>
2894 * without Emacs tags: <mtt><tag_fname><NUL><lbuf>
2896 * Return OK or FAIL.
2898 static int
2899 parse_match(lbuf, tagp)
2900 char_u *lbuf; /* input: matching line */
2901 tagptrs_T *tagp; /* output: pointers into the line */
2903 int retval;
2904 char_u *p;
2905 char_u *pc, *pt;
2907 tagp->tag_fname = lbuf + 1;
2908 lbuf += STRLEN(tagp->tag_fname) + 2;
2909 #ifdef FEAT_EMACS_TAGS
2910 if (*lbuf)
2912 tagp->is_etag = TRUE;
2913 tagp->fname = lbuf;
2914 lbuf += STRLEN(lbuf);
2915 tagp->fname_end = lbuf++;
2917 else
2919 tagp->is_etag = FALSE;
2920 ++lbuf;
2922 #endif
2924 /* Find search pattern and the file name for non-etags. */
2925 retval = parse_tag_line(lbuf,
2926 #ifdef FEAT_EMACS_TAGS
2927 tagp->is_etag,
2928 #endif
2929 tagp);
2931 tagp->tagkind = NULL;
2932 tagp->command_end = NULL;
2934 if (retval == OK)
2936 /* Try to find a kind field: "kind:<kind>" or just "<kind>"*/
2937 p = tagp->command;
2938 if (find_extra(&p) == OK)
2940 tagp->command_end = p;
2941 p += 2; /* skip ";\"" */
2942 if (*p++ == TAB)
2943 while (ASCII_ISALPHA(*p))
2945 if (STRNCMP(p, "kind:", 5) == 0)
2947 tagp->tagkind = p + 5;
2948 break;
2950 pc = vim_strchr(p, ':');
2951 pt = vim_strchr(p, '\t');
2952 if (pc == NULL || (pt != NULL && pc > pt))
2954 tagp->tagkind = p;
2955 break;
2957 if (pt == NULL)
2958 break;
2959 p = pt + 1;
2962 if (tagp->tagkind != NULL)
2964 for (p = tagp->tagkind;
2965 *p && *p != '\t' && *p != '\r' && *p != '\n'; ++p)
2967 tagp->tagkind_end = p;
2970 return retval;
2974 * Find out the actual file name of a tag. Concatenate the tags file name
2975 * with the matching tag file name.
2976 * Returns an allocated string or NULL (out of memory).
2978 static char_u *
2979 tag_full_fname(tagp)
2980 tagptrs_T *tagp;
2982 char_u *fullname;
2983 int c;
2985 #ifdef FEAT_EMACS_TAGS
2986 if (tagp->is_etag)
2987 c = 0; /* to shut up GCC */
2988 else
2989 #endif
2991 c = *tagp->fname_end;
2992 *tagp->fname_end = NUL;
2994 fullname = expand_tag_fname(tagp->fname, tagp->tag_fname, FALSE);
2996 #ifdef FEAT_EMACS_TAGS
2997 if (!tagp->is_etag)
2998 #endif
2999 *tagp->fname_end = c;
3001 return fullname;
3005 * Jump to a tag that has been found in one of the tag files
3007 * returns OK for success, NOTAGFILE when file not found, FAIL otherwise.
3009 static int
3010 jumpto_tag(lbuf, forceit, keep_help)
3011 char_u *lbuf; /* line from the tags file for this tag */
3012 int forceit; /* :ta with ! */
3013 int keep_help; /* keep help flag (FALSE for cscope) */
3015 int save_secure;
3016 int save_magic;
3017 int save_p_ws, save_p_scs, save_p_ic;
3018 linenr_T save_lnum;
3019 int csave = 0;
3020 char_u *str;
3021 char_u *pbuf; /* search pattern buffer */
3022 char_u *pbuf_end;
3023 char_u *tofree_fname = NULL;
3024 char_u *fname;
3025 tagptrs_T tagp;
3026 int retval = FAIL;
3027 int getfile_result;
3028 int search_options;
3029 #ifdef FEAT_SEARCH_EXTRA
3030 int save_no_hlsearch;
3031 #endif
3032 #if defined(FEAT_WINDOWS) && defined(FEAT_QUICKFIX)
3033 win_T *curwin_save = NULL;
3034 #endif
3035 char_u *full_fname = NULL;
3036 #ifdef FEAT_FOLDING
3037 int old_KeyTyped = KeyTyped; /* getting the file may reset it */
3038 #endif
3040 pbuf = alloc(LSIZE);
3042 /* parse the match line into the tagp structure */
3043 if (pbuf == NULL || parse_match(lbuf, &tagp) == FAIL)
3045 tagp.fname_end = NULL;
3046 goto erret;
3049 /* truncate the file name, so it can be used as a string */
3050 csave = *tagp.fname_end;
3051 *tagp.fname_end = NUL;
3052 fname = tagp.fname;
3054 /* copy the command to pbuf[], remove trailing CR/NL */
3055 str = tagp.command;
3056 for (pbuf_end = pbuf; *str && *str != '\n' && *str != '\r'; )
3058 #ifdef FEAT_EMACS_TAGS
3059 if (tagp.is_etag && *str == ',')/* stop at ',' after line number */
3060 break;
3061 #endif
3062 *pbuf_end++ = *str++;
3064 *pbuf_end = NUL;
3066 #ifdef FEAT_EMACS_TAGS
3067 if (!tagp.is_etag)
3068 #endif
3071 * Remove the "<Tab>fieldname:value" stuff; we don't need it here.
3073 str = pbuf;
3074 if (find_extra(&str) == OK)
3076 pbuf_end = str;
3077 *pbuf_end = NUL;
3082 * Expand file name, when needed (for environment variables).
3083 * If 'tagrelative' option set, may change file name.
3085 fname = expand_tag_fname(fname, tagp.tag_fname, TRUE);
3086 if (fname == NULL)
3087 goto erret;
3088 tofree_fname = fname; /* free() it later */
3091 * Check if the file with the tag exists before abandoning the current
3092 * file. Also accept a file name for which there is a matching BufReadCmd
3093 * autocommand event (e.g., http://sys/file).
3095 if (mch_getperm(fname) < 0
3096 #ifdef FEAT_AUTOCMD
3097 && !has_autocmd(EVENT_BUFREADCMD, fname, NULL)
3098 #endif
3101 retval = NOTAGFILE;
3102 vim_free(nofile_fname);
3103 nofile_fname = vim_strsave(fname);
3104 if (nofile_fname == NULL)
3105 nofile_fname = empty_option;
3106 goto erret;
3109 ++RedrawingDisabled;
3111 #ifdef FEAT_GUI
3112 need_mouse_correct = TRUE;
3113 #endif
3115 #if defined(FEAT_WINDOWS) && defined(FEAT_QUICKFIX)
3116 if (g_do_tagpreview)
3118 postponed_split = 0; /* don't split again below */
3119 curwin_save = curwin; /* Save current window */
3122 * If we are reusing a window, we may change dir when
3123 * entering it (autocommands) so turn the tag filename
3124 * into a fullpath
3126 if (!curwin->w_p_pvw)
3128 full_fname = FullName_save(fname, FALSE);
3129 fname = full_fname;
3132 * Make the preview window the current window.
3133 * Open a preview window when needed.
3135 prepare_tagpreview(TRUE);
3139 /* If it was a CTRL-W CTRL-] command split window now. For ":tab tag"
3140 * open a new tab page. */
3141 if (postponed_split || cmdmod.tab != 0)
3143 win_split(postponed_split > 0 ? postponed_split : 0,
3144 postponed_split_flags);
3145 # ifdef FEAT_SCROLLBIND
3146 curwin->w_p_scb = FALSE;
3147 # endif
3149 #endif
3151 if (keep_help)
3153 /* A :ta from a help file will keep the b_help flag set. For ":ptag"
3154 * we need to use the flag from the window where we came from. */
3155 #if defined(FEAT_WINDOWS) && defined(FEAT_QUICKFIX)
3156 if (g_do_tagpreview)
3157 keep_help_flag = curwin_save->w_buffer->b_help;
3158 else
3159 #endif
3160 keep_help_flag = curbuf->b_help;
3162 getfile_result = getfile(0, fname, NULL, TRUE, (linenr_T)0, forceit);
3163 keep_help_flag = FALSE;
3165 if (getfile_result <= 0) /* got to the right file */
3167 curwin->w_set_curswant = TRUE;
3168 #ifdef FEAT_WINDOWS
3169 postponed_split = 0;
3170 #endif
3172 save_secure = secure;
3173 secure = 1;
3174 #ifdef HAVE_SANDBOX
3175 ++sandbox;
3176 #endif
3177 save_magic = p_magic;
3178 p_magic = FALSE; /* always execute with 'nomagic' */
3179 #ifdef FEAT_SEARCH_EXTRA
3180 /* Save value of no_hlsearch, jumping to a tag is not a real search */
3181 save_no_hlsearch = no_hlsearch;
3182 #endif
3185 * If 'cpoptions' contains 't', store the search pattern for the "n"
3186 * command. If 'cpoptions' does not contain 't', the search pattern
3187 * is not stored.
3189 if (vim_strchr(p_cpo, CPO_TAGPAT) != NULL)
3190 search_options = 0;
3191 else
3192 search_options = SEARCH_KEEP;
3195 * If the command is a search, try here.
3197 * Reset 'smartcase' for the search, since the search pattern was not
3198 * typed by the user.
3199 * Only use do_search() when there is a full search command, without
3200 * anything following.
3202 str = pbuf;
3203 if (pbuf[0] == '/' || pbuf[0] == '?')
3204 str = skip_regexp(pbuf + 1, pbuf[0], FALSE, NULL) + 1;
3205 if (str > pbuf_end - 1) /* search command with nothing following */
3207 save_p_ws = p_ws;
3208 save_p_ic = p_ic;
3209 save_p_scs = p_scs;
3210 p_ws = TRUE; /* need 'wrapscan' for backward searches */
3211 p_ic = FALSE; /* don't ignore case now */
3212 p_scs = FALSE;
3213 #if 0 /* disabled for now */
3214 #ifdef FEAT_CMDHIST
3215 /* put pattern in search history */
3216 add_to_history(HIST_SEARCH, pbuf + 1, TRUE, pbuf[0]);
3217 #endif
3218 #endif
3219 save_lnum = curwin->w_cursor.lnum;
3220 curwin->w_cursor.lnum = 0; /* start search before first line */
3221 if (do_search(NULL, pbuf[0], pbuf + 1, (long)1,
3222 search_options, NULL))
3223 retval = OK;
3224 else
3226 int found = 1;
3227 int cc;
3230 * try again, ignore case now
3232 p_ic = TRUE;
3233 if (!do_search(NULL, pbuf[0], pbuf + 1, (long)1,
3234 search_options, NULL))
3237 * Failed to find pattern, take a guess: "^func ("
3239 found = 2;
3240 (void)test_for_static(&tagp);
3241 cc = *tagp.tagname_end;
3242 *tagp.tagname_end = NUL;
3243 sprintf((char *)pbuf, "^%s\\s\\*(", tagp.tagname);
3244 if (!do_search(NULL, '/', pbuf, (long)1,
3245 search_options, NULL))
3247 /* Guess again: "^char * \<func (" */
3248 sprintf((char *)pbuf, "^\\[#a-zA-Z_]\\.\\*\\<%s\\s\\*(",
3249 tagp.tagname);
3250 if (!do_search(NULL, '/', pbuf, (long)1,
3251 search_options, NULL))
3252 found = 0;
3254 *tagp.tagname_end = cc;
3256 if (found == 0)
3258 EMSG(_("E434: Can't find tag pattern"));
3259 curwin->w_cursor.lnum = save_lnum;
3261 else
3264 * Only give a message when really guessed, not when 'ic'
3265 * is set and match found while ignoring case.
3267 if (found == 2 || !save_p_ic)
3269 MSG(_("E435: Couldn't find tag, just guessing!"));
3270 if (!msg_scrolled && msg_silent == 0)
3272 out_flush();
3273 ui_delay(1000L, TRUE);
3276 retval = OK;
3279 p_ws = save_p_ws;
3280 p_ic = save_p_ic;
3281 p_scs = save_p_scs;
3283 /* A search command may have positioned the cursor beyond the end
3284 * of the line. May need to correct that here. */
3285 check_cursor();
3287 else
3289 curwin->w_cursor.lnum = 1; /* start command in line 1 */
3290 do_cmdline_cmd(pbuf);
3291 retval = OK;
3295 * When the command has done something that is not allowed make sure
3296 * the error message can be seen.
3298 if (secure == 2)
3299 wait_return(TRUE);
3300 secure = save_secure;
3301 p_magic = save_magic;
3302 #ifdef HAVE_SANDBOX
3303 --sandbox;
3304 #endif
3305 #ifdef FEAT_SEARCH_EXTRA
3306 /* restore no_hlsearch when keeping the old search pattern */
3307 if (search_options)
3308 no_hlsearch = save_no_hlsearch;
3309 #endif
3311 /* Return OK if jumped to another file (at least we found the file!). */
3312 if (getfile_result == -1)
3313 retval = OK;
3315 if (retval == OK)
3318 * For a help buffer: Put the cursor line at the top of the window,
3319 * the help subject will be below it.
3321 if (curbuf->b_help)
3322 set_topline(curwin, curwin->w_cursor.lnum);
3323 #ifdef FEAT_FOLDING
3324 if ((fdo_flags & FDO_TAG) && old_KeyTyped)
3325 foldOpenCursor();
3326 #endif
3329 #if defined(FEAT_WINDOWS) && defined(FEAT_QUICKFIX)
3330 if (g_do_tagpreview && curwin != curwin_save && win_valid(curwin_save))
3332 /* Return cursor to where we were */
3333 validate_cursor();
3334 redraw_later(VALID);
3335 win_enter(curwin_save, TRUE);
3337 #endif
3339 --RedrawingDisabled;
3341 else
3343 --RedrawingDisabled;
3344 #ifdef FEAT_WINDOWS
3345 if (postponed_split) /* close the window */
3347 win_close(curwin, FALSE);
3348 postponed_split = 0;
3350 #endif
3353 erret:
3354 #if defined(FEAT_WINDOWS) && defined(FEAT_QUICKFIX)
3355 g_do_tagpreview = 0; /* For next time */
3356 #endif
3357 if (tagp.fname_end != NULL)
3358 *tagp.fname_end = csave;
3359 vim_free(pbuf);
3360 vim_free(tofree_fname);
3361 vim_free(full_fname);
3363 return retval;
3367 * If "expand" is TRUE, expand wildcards in fname.
3368 * If 'tagrelative' option set, change fname (name of file containing tag)
3369 * according to tag_fname (name of tag file containing fname).
3370 * Returns a pointer to allocated memory (or NULL when out of memory).
3372 static char_u *
3373 expand_tag_fname(fname, tag_fname, expand)
3374 char_u *fname;
3375 char_u *tag_fname;
3376 int expand;
3378 char_u *p;
3379 char_u *retval;
3380 char_u *expanded_fname = NULL;
3381 expand_T xpc;
3384 * Expand file name (for environment variables) when needed.
3386 if (expand && mch_has_wildcard(fname))
3388 ExpandInit(&xpc);
3389 xpc.xp_context = EXPAND_FILES;
3390 expanded_fname = ExpandOne(&xpc, (char_u *)fname, NULL,
3391 WILD_LIST_NOTFOUND|WILD_SILENT, WILD_EXPAND_FREE);
3392 if (expanded_fname != NULL)
3393 fname = expanded_fname;
3396 if ((p_tr || curbuf->b_help)
3397 && !vim_isAbsName(fname)
3398 && (p = gettail(tag_fname)) != tag_fname)
3400 retval = alloc(MAXPATHL);
3401 if (retval != NULL)
3403 STRCPY(retval, tag_fname);
3404 vim_strncpy(retval + (p - tag_fname), fname,
3405 MAXPATHL - (p - tag_fname) - 1);
3407 * Translate names like "src/a/../b/file.c" into "src/b/file.c".
3409 simplify_filename(retval);
3412 else
3413 retval = vim_strsave(fname);
3415 vim_free(expanded_fname);
3417 return retval;
3421 * Converts a file name into a canonical form. It simplifies a file name into
3422 * its simplest form by stripping out unneeded components, if any. The
3423 * resulting file name is simplified in place and will either be the same
3424 * length as that supplied, or shorter.
3426 void
3427 simplify_filename(filename)
3428 char_u *filename;
3430 #ifndef AMIGA /* Amiga doesn't have "..", it uses "/" */
3431 int components = 0;
3432 char_u *p, *tail, *start;
3433 int stripping_disabled = FALSE;
3434 int relative = TRUE;
3436 p = filename;
3437 #ifdef BACKSLASH_IN_FILENAME
3438 if (p[1] == ':') /* skip "x:" */
3439 p += 2;
3440 #endif
3442 if (vim_ispathsep(*p))
3444 relative = FALSE;
3446 ++p;
3447 while (vim_ispathsep(*p));
3449 start = p; /* remember start after "c:/" or "/" or "///" */
3453 /* At this point "p" is pointing to the char following a single "/"
3454 * or "p" is at the "start" of the (absolute or relative) path name. */
3455 #ifdef VMS
3456 /* VMS allows device:[path] - don't strip the [ in directory */
3457 if ((*p == '[' || *p == '<') && p > filename && p[-1] == ':')
3459 /* :[ or :< composition: vms directory component */
3460 ++components;
3461 p = getnextcomp(p + 1);
3463 /* allow remote calls as host"user passwd"::device:[path] */
3464 else if (p[0] == ':' && p[1] == ':' && p > filename && p[-1] == '"' )
3466 /* ":: composition: vms host/passwd component */
3467 ++components;
3468 p = getnextcomp(p + 2);
3470 else
3471 #endif
3472 if (vim_ispathsep(*p))
3473 STRMOVE(p, p + 1); /* remove duplicate "/" */
3474 else if (p[0] == '.' && (vim_ispathsep(p[1]) || p[1] == NUL))
3476 if (p == start && relative)
3477 p += 1 + (p[1] != NUL); /* keep single "." or leading "./" */
3478 else
3480 /* Strip "./" or ".///". If we are at the end of the file name
3481 * and there is no trailing path separator, either strip "/." if
3482 * we are after "start", or strip "." if we are at the beginning
3483 * of an absolute path name . */
3484 tail = p + 1;
3485 if (p[1] != NUL)
3486 while (vim_ispathsep(*tail))
3487 mb_ptr_adv(tail);
3488 else if (p > start)
3489 --p; /* strip preceding path separator */
3490 STRMOVE(p, tail);
3493 else if (p[0] == '.' && p[1] == '.' &&
3494 (vim_ispathsep(p[2]) || p[2] == NUL))
3496 /* Skip to after ".." or "../" or "..///". */
3497 tail = p + 2;
3498 while (vim_ispathsep(*tail))
3499 mb_ptr_adv(tail);
3501 if (components > 0) /* strip one preceding component */
3503 int do_strip = FALSE;
3504 char_u saved_char;
3505 struct stat st;
3507 /* Don't strip for an erroneous file name. */
3508 if (!stripping_disabled)
3510 /* If the preceding component does not exist in the file
3511 * system, we strip it. On Unix, we don't accept a symbolic
3512 * link that refers to a non-existent file. */
3513 saved_char = p[-1];
3514 p[-1] = NUL;
3515 #ifdef UNIX
3516 if (mch_lstat((char *)filename, &st) < 0)
3517 #else
3518 if (mch_stat((char *)filename, &st) < 0)
3519 #endif
3520 do_strip = TRUE;
3521 p[-1] = saved_char;
3523 --p;
3524 /* Skip back to after previous '/'. */
3525 while (p > start && !after_pathsep(start, p))
3526 mb_ptr_back(start, p);
3528 if (!do_strip)
3530 /* If the component exists in the file system, check
3531 * that stripping it won't change the meaning of the
3532 * file name. First get information about the
3533 * unstripped file name. This may fail if the component
3534 * to strip is not a searchable directory (but a regular
3535 * file, for instance), since the trailing "/.." cannot
3536 * be applied then. We don't strip it then since we
3537 * don't want to replace an erroneous file name by
3538 * a valid one, and we disable stripping of later
3539 * components. */
3540 saved_char = *tail;
3541 *tail = NUL;
3542 if (mch_stat((char *)filename, &st) >= 0)
3543 do_strip = TRUE;
3544 else
3545 stripping_disabled = TRUE;
3546 *tail = saved_char;
3547 #ifdef UNIX
3548 if (do_strip)
3550 struct stat new_st;
3552 /* On Unix, the check for the unstripped file name
3553 * above works also for a symbolic link pointing to
3554 * a searchable directory. But then the parent of
3555 * the directory pointed to by the link must be the
3556 * same as the stripped file name. (The latter
3557 * exists in the file system since it is the
3558 * component's parent directory.) */
3559 if (p == start && relative)
3560 (void)mch_stat(".", &new_st);
3561 else
3563 saved_char = *p;
3564 *p = NUL;
3565 (void)mch_stat((char *)filename, &new_st);
3566 *p = saved_char;
3569 if (new_st.st_ino != st.st_ino ||
3570 new_st.st_dev != st.st_dev)
3572 do_strip = FALSE;
3573 /* We don't disable stripping of later
3574 * components since the unstripped path name is
3575 * still valid. */
3578 #endif
3582 if (!do_strip)
3584 /* Skip the ".." or "../" and reset the counter for the
3585 * components that might be stripped later on. */
3586 p = tail;
3587 components = 0;
3589 else
3591 /* Strip previous component. If the result would get empty
3592 * and there is no trailing path separator, leave a single
3593 * "." instead. If we are at the end of the file name and
3594 * there is no trailing path separator and a preceding
3595 * component is left after stripping, strip its trailing
3596 * path separator as well. */
3597 if (p == start && relative && tail[-1] == '.')
3599 *p++ = '.';
3600 *p = NUL;
3602 else
3604 if (p > start && tail[-1] == '.')
3605 --p;
3606 STRMOVE(p, tail); /* strip previous component */
3609 --components;
3612 else if (p == start && !relative) /* leading "/.." or "/../" */
3613 STRMOVE(p, tail); /* strip ".." or "../" */
3614 else
3616 if (p == start + 2 && p[-2] == '.') /* leading "./../" */
3618 STRMOVE(p - 2, p); /* strip leading "./" */
3619 tail -= 2;
3621 p = tail; /* skip to char after ".." or "../" */
3624 else
3626 ++components; /* simple path component */
3627 p = getnextcomp(p);
3629 } while (*p != NUL);
3630 #endif /* !AMIGA */
3634 * Check if we have a tag for the buffer with name "buf_ffname".
3635 * This is a bit slow, because of the full path compare in fullpathcmp().
3636 * Return TRUE if tag for file "fname" if tag file "tag_fname" is for current
3637 * file.
3639 static int
3640 #ifdef FEAT_EMACS_TAGS
3641 test_for_current(is_etag, fname, fname_end, tag_fname, buf_ffname)
3642 int is_etag;
3643 #else
3644 test_for_current(fname, fname_end, tag_fname, buf_ffname)
3645 #endif
3646 char_u *fname;
3647 char_u *fname_end;
3648 char_u *tag_fname;
3649 char_u *buf_ffname;
3651 int c;
3652 int retval = FALSE;
3653 char_u *fullname;
3655 if (buf_ffname != NULL) /* if the buffer has a name */
3657 #ifdef FEAT_EMACS_TAGS
3658 if (is_etag)
3659 c = 0; /* to shut up GCC */
3660 else
3661 #endif
3663 c = *fname_end;
3664 *fname_end = NUL;
3666 fullname = expand_tag_fname(fname, tag_fname, TRUE);
3667 if (fullname != NULL)
3669 retval = (fullpathcmp(fullname, buf_ffname, TRUE) & FPC_SAME);
3670 vim_free(fullname);
3672 #ifdef FEAT_EMACS_TAGS
3673 if (!is_etag)
3674 #endif
3675 *fname_end = c;
3678 return retval;
3682 * Find the end of the tagaddress.
3683 * Return OK if ";\"" is following, FAIL otherwise.
3685 static int
3686 find_extra(pp)
3687 char_u **pp;
3689 char_u *str = *pp;
3691 /* Repeat for addresses separated with ';' */
3692 for (;;)
3694 if (VIM_ISDIGIT(*str))
3695 str = skipdigits(str);
3696 else if (*str == '/' || *str == '?')
3698 str = skip_regexp(str + 1, *str, FALSE, NULL);
3699 if (*str != **pp)
3700 str = NULL;
3701 else
3702 ++str;
3704 else
3705 str = NULL;
3706 if (str == NULL || *str != ';'
3707 || !(VIM_ISDIGIT(str[1]) || str[1] == '/' || str[1] == '?'))
3708 break;
3709 ++str; /* skip ';' */
3712 if (str != NULL && STRNCMP(str, ";\"", 2) == 0)
3714 *pp = str;
3715 return OK;
3717 return FAIL;
3720 #if defined(FEAT_CMDL_COMPL) || defined(PROTO)
3722 expand_tags(tagnames, pat, num_file, file)
3723 int tagnames; /* expand tag names */
3724 char_u *pat;
3725 int *num_file;
3726 char_u ***file;
3728 int i;
3729 int c;
3730 int tagnmflag;
3731 char_u tagnm[100];
3732 tagptrs_T t_p;
3733 int ret;
3735 if (tagnames)
3736 tagnmflag = TAG_NAMES;
3737 else
3738 tagnmflag = 0;
3739 if (pat[0] == '/')
3740 ret = find_tags(pat + 1, num_file, file,
3741 TAG_REGEXP | tagnmflag | TAG_VERBOSE,
3742 TAG_MANY, curbuf->b_ffname);
3743 else
3744 ret = find_tags(pat, num_file, file,
3745 TAG_REGEXP | tagnmflag | TAG_VERBOSE | TAG_NOIC,
3746 TAG_MANY, curbuf->b_ffname);
3747 if (ret == OK && !tagnames)
3749 /* Reorganize the tags for display and matching as strings of:
3750 * "<tagname>\0<kind>\0<filename>\0"
3752 for (i = 0; i < *num_file; i++)
3754 parse_match((*file)[i], &t_p);
3755 c = (int)(t_p.tagname_end - t_p.tagname);
3756 mch_memmove(tagnm, t_p.tagname, (size_t)c);
3757 tagnm[c++] = 0;
3758 tagnm[c++] = (t_p.tagkind != NULL && *t_p.tagkind)
3759 ? *t_p.tagkind : 'f';
3760 tagnm[c++] = 0;
3761 mch_memmove((*file)[i] + c, t_p.fname, t_p.fname_end - t_p.fname);
3762 (*file)[i][c + (t_p.fname_end - t_p.fname)] = 0;
3763 mch_memmove((*file)[i], tagnm, (size_t)c);
3766 return ret;
3768 #endif
3770 #if defined(FEAT_EVAL) || defined(PROTO)
3771 static int add_tag_field __ARGS((dict_T *dict, char *field_name, char_u *start, char_u *end));
3774 * Add a tag field to the dictionary "dict".
3775 * Return OK or FAIL.
3777 static int
3778 add_tag_field(dict, field_name, start, end)
3779 dict_T *dict;
3780 char *field_name;
3781 char_u *start; /* start of the value */
3782 char_u *end; /* after the value; can be NULL */
3784 char_u buf[MAXPATHL];
3785 int len = 0;
3787 /* check that the field name doesn't exist yet */
3788 if (dict_find(dict, (char_u *)field_name, -1) != NULL)
3790 if (p_verbose > 0)
3792 verbose_enter();
3793 smsg((char_u *)_("Duplicate field name: %s"), field_name);
3794 verbose_leave();
3796 return FAIL;
3798 if (start != NULL)
3800 if (end == NULL)
3802 end = start + STRLEN(start);
3803 while (end > start && (end[-1] == '\r' || end[-1] == '\n'))
3804 --end;
3806 len = (int)(end - start);
3807 if (len > (int)sizeof(buf) - 1)
3808 len = sizeof(buf) - 1;
3809 vim_strncpy(buf, start, len);
3811 buf[len] = NUL;
3812 return dict_add_nr_str(dict, field_name, 0L, buf);
3816 * Add the tags matching the specified pattern to the list "list"
3817 * as a dictionary
3820 get_tags(list, pat)
3821 list_T *list;
3822 char_u *pat;
3824 int num_matches, i, ret;
3825 char_u **matches, *p;
3826 char_u *full_fname;
3827 dict_T *dict;
3828 tagptrs_T tp;
3829 long is_static;
3831 ret = find_tags(pat, &num_matches, &matches,
3832 TAG_REGEXP | TAG_NOIC, (int)MAXCOL, NULL);
3833 if (ret == OK && num_matches > 0)
3835 for (i = 0; i < num_matches; ++i)
3837 parse_match(matches[i], &tp);
3838 is_static = test_for_static(&tp);
3840 /* Skip pseudo-tag lines. */
3841 if (STRNCMP(tp.tagname, "!_TAG_", 6) == 0)
3842 continue;
3844 if ((dict = dict_alloc()) == NULL)
3845 ret = FAIL;
3846 if (list_append_dict(list, dict) == FAIL)
3847 ret = FAIL;
3849 full_fname = tag_full_fname(&tp);
3850 if (add_tag_field(dict, "name", tp.tagname, tp.tagname_end) == FAIL
3851 || add_tag_field(dict, "filename", full_fname,
3852 NULL) == FAIL
3853 || add_tag_field(dict, "cmd", tp.command,
3854 tp.command_end) == FAIL
3855 || add_tag_field(dict, "kind", tp.tagkind,
3856 tp.tagkind_end) == FAIL
3857 || dict_add_nr_str(dict, "static", is_static, NULL) == FAIL)
3858 ret = FAIL;
3860 vim_free(full_fname);
3862 if (tp.command_end != NULL)
3864 for (p = tp.command_end + 3;
3865 *p != NUL && *p != '\n' && *p != '\r'; ++p)
3867 if (p == tp.tagkind || (p + 5 == tp.tagkind
3868 && STRNCMP(p, "kind:", 5) == 0))
3869 /* skip "kind:<kind>" and "<kind>" */
3870 p = tp.tagkind_end - 1;
3871 else if (STRNCMP(p, "file:", 5) == 0)
3872 /* skip "file:" (static tag) */
3873 p += 4;
3874 else if (!vim_iswhite(*p))
3876 char_u *s, *n;
3877 int len;
3879 /* Add extra field as a dict entry. Fields are
3880 * separated by Tabs. */
3881 n = p;
3882 while (*p != NUL && *p >= ' ' && *p < 127 && *p != ':')
3883 ++p;
3884 len = (int)(p - n);
3885 if (*p == ':' && len > 0)
3887 s = ++p;
3888 while (*p != NUL && *p >= ' ')
3889 ++p;
3890 n[len] = NUL;
3891 if (add_tag_field(dict, (char *)n, s, p) == FAIL)
3892 ret = FAIL;
3893 n[len] = ':';
3895 else
3896 /* Skip field without colon. */
3897 while (*p != NUL && *p >= ' ')
3898 ++p;
3899 if (*p == NUL)
3900 break;
3905 vim_free(matches[i]);
3907 vim_free(matches);
3909 return ret;
3911 #endif