Sync from the branch.
[MacVim.git] / src / tag.c
blob29893de760262d111468a1f4cfc2e404eb7ff775
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 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.
94 #ifdef HAVE_FTELLO
95 # define ftell ftello
96 #endif
98 #if defined(FEAT_WINDOWS) && defined(FEAT_QUICKFIX)
100 * Tag for preview window is remembered separately, to avoid messing up the
101 * normal tagstack.
103 static taggy_T ptag_entry = {NULL};
104 #endif
107 * Jump to tag; handling of tag commands and tag stack
109 * *tag != NUL: ":tag {tag}", jump to new tag, add to tag stack
111 * type == DT_TAG: ":tag [tag]", jump to newer position or same tag again
112 * type == DT_HELP: like DT_TAG, but don't use regexp.
113 * type == DT_POP: ":pop" or CTRL-T, jump to old position
114 * type == DT_NEXT: jump to next match of same tag
115 * type == DT_PREV: jump to previous match of same tag
116 * type == DT_FIRST: jump to first match of same tag
117 * type == DT_LAST: jump to last match of same tag
118 * type == DT_SELECT: ":tselect [tag]", select tag from a list of all matches
119 * type == DT_JUMP: ":tjump [tag]", jump to tag or select tag from a list
120 * type == DT_CSCOPE: use cscope to find the tag
121 * type == DT_LTAG: use location list for displaying tag matches
122 * type == DT_FREE: free cached matches
124 * for cscope, returns TRUE if we jumped to tag or aborted, FALSE otherwise
127 do_tag(tag, type, count, forceit, verbose)
128 char_u *tag; /* tag (pattern) to jump to */
129 int type;
130 int count;
131 int forceit; /* :ta with ! */
132 int verbose; /* print "tag not found" message */
134 taggy_T *tagstack = curwin->w_tagstack;
135 int tagstackidx = curwin->w_tagstackidx;
136 int tagstacklen = curwin->w_tagstacklen;
137 int cur_match = 0;
138 int cur_fnum = curbuf->b_fnum;
139 int oldtagstackidx = tagstackidx;
140 int prevtagstackidx = tagstackidx;
141 int prev_num_matches;
142 int new_tag = FALSE;
143 int other_name;
144 int i, j, k;
145 int idx;
146 int ic;
147 char_u *p;
148 char_u *name;
149 int no_regexp = FALSE;
150 int error_cur_match = 0;
151 char_u *command_end;
152 int save_pos = FALSE;
153 fmark_T saved_fmark;
154 int taglen;
155 #ifdef FEAT_CSCOPE
156 int jumped_to_tag = FALSE;
157 #endif
158 tagptrs_T tagp, tagp2;
159 int new_num_matches;
160 char_u **new_matches;
161 int attr;
162 int use_tagstack;
163 int skip_msg = FALSE;
164 char_u *buf_ffname = curbuf->b_ffname; /* name to use for
165 priority computation */
167 /* remember the matches for the last used tag */
168 static int num_matches = 0;
169 static int max_num_matches = 0; /* limit used for match search */
170 static char_u **matches = NULL;
171 static int flags;
173 #ifdef EXITFREE
174 if (type == DT_FREE)
176 /* remove the list of matches */
177 FreeWild(num_matches, matches);
178 # ifdef FEAT_CSCOPE
179 cs_free_tags();
180 # endif
181 num_matches = 0;
182 return FALSE;
184 #endif
186 if (type == DT_HELP)
188 type = DT_TAG;
189 no_regexp = TRUE;
192 prev_num_matches = num_matches;
193 free_string_option(nofile_fname);
194 nofile_fname = NULL;
196 clearpos(&saved_fmark.mark); /* shutup gcc 4.0 */
197 saved_fmark.fnum = 0;
200 * Don't add a tag to the tagstack if 'tagstack' has been reset.
202 if ((!p_tgst && *tag != NUL))
204 use_tagstack = FALSE;
205 new_tag = TRUE;
207 else
209 #if defined(FEAT_WINDOWS) && defined(FEAT_QUICKFIX)
210 if (g_do_tagpreview)
211 use_tagstack = FALSE;
212 else
213 #endif
214 use_tagstack = TRUE;
216 /* new pattern, add to the tag stack */
217 if (*tag != NUL
218 && (type == DT_TAG || type == DT_SELECT || type == DT_JUMP
219 #ifdef FEAT_QUICKFIX
220 || type == DT_LTAG
221 #endif
222 #ifdef FEAT_CSCOPE
223 || type == DT_CSCOPE
224 #endif
227 #if defined(FEAT_WINDOWS) && defined(FEAT_QUICKFIX)
228 if (g_do_tagpreview)
230 if (ptag_entry.tagname != NULL
231 && STRCMP(ptag_entry.tagname, tag) == 0)
233 /* Jumping to same tag: keep the current match, so that
234 * the CursorHold autocommand example works. */
235 cur_match = ptag_entry.cur_match;
236 cur_fnum = ptag_entry.cur_fnum;
238 else
240 vim_free(ptag_entry.tagname);
241 if ((ptag_entry.tagname = vim_strsave(tag)) == NULL)
242 goto end_do_tag;
245 else
246 #endif
249 * If the last used entry is not at the top, delete all tag
250 * stack entries above it.
252 while (tagstackidx < tagstacklen)
253 vim_free(tagstack[--tagstacklen].tagname);
255 /* if the tagstack is full: remove oldest entry */
256 if (++tagstacklen > TAGSTACKSIZE)
258 tagstacklen = TAGSTACKSIZE;
259 vim_free(tagstack[0].tagname);
260 for (i = 1; i < tagstacklen; ++i)
261 tagstack[i - 1] = tagstack[i];
262 --tagstackidx;
266 * put the tag name in the tag stack
268 if ((tagstack[tagstackidx].tagname = vim_strsave(tag)) == NULL)
270 curwin->w_tagstacklen = tagstacklen - 1;
271 goto end_do_tag;
273 curwin->w_tagstacklen = tagstacklen;
275 save_pos = TRUE; /* save the cursor position below */
278 new_tag = TRUE;
280 else
282 if (
283 #if defined(FEAT_WINDOWS) && defined(FEAT_QUICKFIX)
284 g_do_tagpreview ? ptag_entry.tagname == NULL :
285 #endif
286 tagstacklen == 0)
288 /* empty stack */
289 EMSG(_(e_tagstack));
290 goto end_do_tag;
293 if (type == DT_POP) /* go to older position */
295 #ifdef FEAT_FOLDING
296 int old_KeyTyped = KeyTyped;
297 #endif
298 if ((tagstackidx -= count) < 0)
300 EMSG(_(bottommsg));
301 if (tagstackidx + count == 0)
303 /* We did [num]^T from the bottom of the stack */
304 tagstackidx = 0;
305 goto end_do_tag;
307 /* We weren't at the bottom of the stack, so jump all the
308 * way to the bottom now.
310 tagstackidx = 0;
312 else if (tagstackidx >= tagstacklen) /* count == 0? */
314 EMSG(_(topmsg));
315 goto end_do_tag;
318 /* Make a copy of the fmark, autocommands may invalidate the
319 * tagstack before it's used. */
320 saved_fmark = tagstack[tagstackidx].fmark;
321 if (saved_fmark.fnum != curbuf->b_fnum)
324 * Jump to other file. If this fails (e.g. because the
325 * file was changed) keep original position in tag stack.
327 if (buflist_getfile(saved_fmark.fnum, saved_fmark.mark.lnum,
328 GETF_SETMARK, forceit) == FAIL)
330 tagstackidx = oldtagstackidx; /* back to old posn */
331 goto end_do_tag;
333 /* An BufReadPost autocommand may jump to the '" mark, but
334 * we don't what that here. */
335 curwin->w_cursor.lnum = saved_fmark.mark.lnum;
337 else
339 setpcmark();
340 curwin->w_cursor.lnum = saved_fmark.mark.lnum;
342 curwin->w_cursor.col = saved_fmark.mark.col;
343 curwin->w_set_curswant = TRUE;
344 check_cursor();
345 #ifdef FEAT_FOLDING
346 if ((fdo_flags & FDO_TAG) && old_KeyTyped)
347 foldOpenCursor();
348 #endif
350 /* remove the old list of matches */
351 FreeWild(num_matches, matches);
352 #ifdef FEAT_CSCOPE
353 cs_free_tags();
354 #endif
355 num_matches = 0;
356 tag_freematch();
357 goto end_do_tag;
360 if (type == DT_TAG
361 #if defined(FEAT_QUICKFIX)
362 || type == DT_LTAG
363 #endif
366 #if defined(FEAT_WINDOWS) && defined(FEAT_QUICKFIX)
367 if (g_do_tagpreview)
369 cur_match = ptag_entry.cur_match;
370 cur_fnum = ptag_entry.cur_fnum;
372 else
373 #endif
375 /* ":tag" (no argument): go to newer pattern */
376 save_pos = TRUE; /* save the cursor position below */
377 if ((tagstackidx += count - 1) >= tagstacklen)
380 * Beyond the last one, just give an error message and
381 * go to the last one. Don't store the cursor
382 * position.
384 tagstackidx = tagstacklen - 1;
385 EMSG(_(topmsg));
386 save_pos = FALSE;
388 else if (tagstackidx < 0) /* must have been count == 0 */
390 EMSG(_(bottommsg));
391 tagstackidx = 0;
392 goto end_do_tag;
394 cur_match = tagstack[tagstackidx].cur_match;
395 cur_fnum = tagstack[tagstackidx].cur_fnum;
397 new_tag = TRUE;
399 else /* go to other matching tag */
401 /* Save index for when selection is cancelled. */
402 prevtagstackidx = tagstackidx;
404 #if defined(FEAT_WINDOWS) && defined(FEAT_QUICKFIX)
405 if (g_do_tagpreview)
407 cur_match = ptag_entry.cur_match;
408 cur_fnum = ptag_entry.cur_fnum;
410 else
411 #endif
413 if (--tagstackidx < 0)
414 tagstackidx = 0;
415 cur_match = tagstack[tagstackidx].cur_match;
416 cur_fnum = tagstack[tagstackidx].cur_fnum;
418 switch (type)
420 case DT_FIRST: cur_match = count - 1; break;
421 case DT_SELECT:
422 case DT_JUMP:
423 #ifdef FEAT_CSCOPE
424 case DT_CSCOPE:
425 #endif
426 case DT_LAST: cur_match = MAXCOL - 1; break;
427 case DT_NEXT: cur_match += count; break;
428 case DT_PREV: cur_match -= count; break;
430 if (cur_match >= MAXCOL)
431 cur_match = MAXCOL - 1;
432 else if (cur_match < 0)
434 EMSG(_("E425: Cannot go before first matching tag"));
435 skip_msg = TRUE;
436 cur_match = 0;
437 cur_fnum = curbuf->b_fnum;
442 #if defined(FEAT_WINDOWS) && defined(FEAT_QUICKFIX)
443 if (g_do_tagpreview)
445 if (type != DT_SELECT && type != DT_JUMP)
447 ptag_entry.cur_match = cur_match;
448 ptag_entry.cur_fnum = cur_fnum;
451 else
452 #endif
455 * For ":tag [arg]" or ":tselect" remember position before the jump.
457 saved_fmark = tagstack[tagstackidx].fmark;
458 if (save_pos)
460 tagstack[tagstackidx].fmark.mark = curwin->w_cursor;
461 tagstack[tagstackidx].fmark.fnum = curbuf->b_fnum;
464 /* Curwin will change in the call to jumpto_tag() if ":stag" was
465 * used or an autocommand jumps to another window; store value of
466 * tagstackidx now. */
467 curwin->w_tagstackidx = tagstackidx;
468 if (type != DT_SELECT && type != DT_JUMP)
470 curwin->w_tagstack[tagstackidx].cur_match = cur_match;
471 curwin->w_tagstack[tagstackidx].cur_fnum = cur_fnum;
476 /* When not using the current buffer get the name of buffer "cur_fnum".
477 * Makes sure that the tag order doesn't change when using a remembered
478 * position for "cur_match". */
479 if (cur_fnum != curbuf->b_fnum)
481 buf_T *buf = buflist_findnr(cur_fnum);
483 if (buf != NULL)
484 buf_ffname = buf->b_ffname;
488 * Repeat searching for tags, when a file has not been found.
490 for (;;)
493 * When desired match not found yet, try to find it (and others).
495 if (use_tagstack)
496 name = tagstack[tagstackidx].tagname;
497 #if defined(FEAT_WINDOWS) && defined(FEAT_QUICKFIX)
498 else if (g_do_tagpreview)
499 name = ptag_entry.tagname;
500 #endif
501 else
502 name = tag;
503 other_name = (tagmatchname == NULL || STRCMP(tagmatchname, name) != 0);
504 if (new_tag
505 || (cur_match >= num_matches && max_num_matches != MAXCOL)
506 || other_name)
508 if (other_name)
510 vim_free(tagmatchname);
511 tagmatchname = vim_strsave(name);
515 * If a count is supplied to the ":tag <name>" command, then
516 * jump to count'th matching tag.
518 if (type == DT_TAG && count > 0)
519 cur_match = count - 1;
521 if (type == DT_SELECT || type == DT_JUMP
522 #if defined(FEAT_QUICKFIX)
523 || type == DT_LTAG
524 #endif
526 cur_match = MAXCOL - 1;
527 max_num_matches = cur_match + 1;
529 /* when the argument starts with '/', use it as a regexp */
530 if (!no_regexp && *name == '/')
532 flags = TAG_REGEXP;
533 ++name;
535 else
536 flags = TAG_NOIC;
538 #ifdef FEAT_CSCOPE
539 if (type == DT_CSCOPE)
540 flags = TAG_CSCOPE;
541 #endif
542 if (verbose)
543 flags |= TAG_VERBOSE;
544 if (find_tags(name, &new_num_matches, &new_matches, flags,
545 max_num_matches, buf_ffname) == OK
546 && new_num_matches < max_num_matches)
547 max_num_matches = MAXCOL; /* If less than max_num_matches
548 found: all matches found. */
550 /* If there already were some matches for the same name, move them
551 * to the start. Avoids that the order changes when using
552 * ":tnext" and jumping to another file. */
553 if (!new_tag && !other_name)
555 /* Find the position of each old match in the new list. Need
556 * to use parse_match() to find the tag line. */
557 idx = 0;
558 for (j = 0; j < num_matches; ++j)
560 parse_match(matches[j], &tagp);
561 for (i = idx; i < new_num_matches; ++i)
563 parse_match(new_matches[i], &tagp2);
564 if (STRCMP(tagp.tagname, tagp2.tagname) == 0)
566 p = new_matches[i];
567 for (k = i; k > idx; --k)
568 new_matches[k] = new_matches[k - 1];
569 new_matches[idx++] = p;
570 break;
575 FreeWild(num_matches, matches);
576 num_matches = new_num_matches;
577 matches = new_matches;
580 if (num_matches <= 0)
582 if (verbose)
583 EMSG2(_("E426: tag not found: %s"), name);
584 #if defined(FEAT_WINDOWS) && defined(FEAT_QUICKFIX)
585 g_do_tagpreview = 0;
586 #endif
588 else
590 int ask_for_selection = FALSE;
592 #ifdef FEAT_CSCOPE
593 if (type == DT_CSCOPE && num_matches > 1)
595 cs_print_tags();
596 ask_for_selection = TRUE;
598 else
599 #endif
600 if (type == DT_SELECT || (type == DT_JUMP && num_matches > 1))
603 * List all the matching tags.
604 * Assume that the first match indicates how long the tags can
605 * be, and align the file names to that.
607 parse_match(matches[0], &tagp);
608 taglen = (int)(tagp.tagname_end - tagp.tagname + 2);
609 if (taglen < 18)
610 taglen = 18;
611 if (taglen > Columns - 25)
612 taglen = MAXCOL;
613 if (msg_col == 0)
614 msg_didout = FALSE; /* overwrite previous message */
615 msg_start();
616 MSG_PUTS_ATTR(_(" # pri kind tag"), hl_attr(HLF_T));
617 msg_clr_eos();
618 taglen_advance(taglen);
619 MSG_PUTS_ATTR(_("file\n"), hl_attr(HLF_T));
621 for (i = 0; i < num_matches; ++i)
623 parse_match(matches[i], &tagp);
624 if (!new_tag && (
625 #if defined(FEAT_WINDOWS) && defined(FEAT_QUICKFIX)
626 (g_do_tagpreview
627 && i == ptag_entry.cur_match) ||
628 #endif
629 (use_tagstack
630 && i == tagstack[tagstackidx].cur_match)))
631 *IObuff = '>';
632 else
633 *IObuff = ' ';
634 vim_snprintf((char *)IObuff + 1, IOSIZE - 1,
635 "%2d %s ", i + 1,
636 mt_names[matches[i][0] & MT_MASK]);
637 msg_puts(IObuff);
638 if (tagp.tagkind != NULL)
639 msg_outtrans_len(tagp.tagkind,
640 (int)(tagp.tagkind_end - tagp.tagkind));
641 msg_advance(13);
642 msg_outtrans_len_attr(tagp.tagname,
643 (int)(tagp.tagname_end - tagp.tagname),
644 hl_attr(HLF_T));
645 msg_putchar(' ');
646 taglen_advance(taglen);
648 /* Find out the actual file name. If it is long, truncate
649 * it and put "..." in the middle */
650 p = tag_full_fname(&tagp);
651 if (p != NULL)
653 msg_puts_long_attr(p, hl_attr(HLF_D));
654 vim_free(p);
656 if (msg_col > 0)
657 msg_putchar('\n');
658 msg_advance(15);
660 /* print any extra fields */
661 command_end = tagp.command_end;
662 if (command_end != NULL)
664 p = command_end + 3;
665 while (*p && *p != '\r' && *p != '\n')
667 while (*p == TAB)
668 ++p;
670 /* skip "file:" without a value (static tag) */
671 if (STRNCMP(p, "file:", 5) == 0
672 && vim_isspace(p[5]))
674 p += 5;
675 continue;
677 /* skip "kind:<kind>" and "<kind>" */
678 if (p == tagp.tagkind
679 || (p + 5 == tagp.tagkind
680 && STRNCMP(p, "kind:", 5) == 0))
682 p = tagp.tagkind_end;
683 continue;
685 /* print all other extra fields */
686 attr = hl_attr(HLF_CM);
687 while (*p && *p != '\r' && *p != '\n')
689 if (msg_col + ptr2cells(p) >= Columns)
691 msg_putchar('\n');
692 msg_advance(15);
694 p = msg_outtrans_one(p, attr);
695 if (*p == TAB)
697 msg_puts_attr((char_u *)" ", attr);
698 break;
700 if (*p == ':')
701 attr = 0;
704 if (msg_col > 15)
706 msg_putchar('\n');
707 msg_advance(15);
710 else
712 for (p = tagp.command;
713 *p && *p != '\r' && *p != '\n'; ++p)
715 command_end = p;
719 * Put the info (in several lines) at column 15.
720 * Don't display "/^" and "?^".
722 p = tagp.command;
723 if (*p == '/' || *p == '?')
725 ++p;
726 if (*p == '^')
727 ++p;
729 /* Remove leading whitespace from pattern */
730 while (p != command_end && vim_isspace(*p))
731 ++p;
733 while (p != command_end)
735 if (msg_col + (*p == TAB ? 1 : ptr2cells(p)) > Columns)
736 msg_putchar('\n');
737 msg_advance(15);
739 /* skip backslash used for escaping command char */
740 if (*p == '\\' && *(p + 1) == *tagp.command)
741 ++p;
743 if (*p == TAB)
745 msg_putchar(' ');
746 ++p;
748 else
749 p = msg_outtrans_one(p, 0);
751 /* don't display the "$/;\"" and "$?;\"" */
752 if (p == command_end - 2 && *p == '$'
753 && *(p + 1) == *tagp.command)
754 break;
755 /* don't display matching '/' or '?' */
756 if (p == command_end - 1 && *p == *tagp.command
757 && (*p == '/' || *p == '?'))
758 break;
760 if (msg_col)
761 msg_putchar('\n');
762 ui_breakcheck();
763 if (got_int)
765 got_int = FALSE; /* only stop the listing */
766 break;
769 ask_for_selection = TRUE;
771 #if defined(FEAT_QUICKFIX) && defined(FEAT_EVAL)
772 else if (type == DT_LTAG)
774 list_T *list;
775 char_u tag_name[128 + 1];
776 char_u fname[MAXPATHL + 1];
777 char_u cmd[CMDBUFFSIZE + 1];
780 * Add the matching tags to the location list for the current
781 * window.
784 list = list_alloc();
785 if (list == NULL)
786 goto end_do_tag;
788 for (i = 0; i < num_matches; ++i)
790 int len, cmd_len;
791 long lnum;
792 dict_T *dict;
794 parse_match(matches[i], &tagp);
796 /* Save the tag name */
797 len = (int)(tagp.tagname_end - tagp.tagname);
798 if (len > 128)
799 len = 128;
800 vim_strncpy(tag_name, tagp.tagname, len);
801 tag_name[len] = NUL;
803 /* Save the tag file name */
804 p = tag_full_fname(&tagp);
805 if (p == NULL)
806 continue;
807 STRCPY(fname, p);
808 vim_free(p);
811 * Get the line number or the search pattern used to locate
812 * the tag.
814 lnum = 0;
815 if (isdigit(*tagp.command))
816 /* Line number is used to locate the tag */
817 lnum = atol((char *)tagp.command);
818 else
820 char_u *cmd_start, *cmd_end;
822 /* Search pattern is used to locate the tag */
824 /* Locate the end of the command */
825 cmd_start = tagp.command;
826 cmd_end = tagp.command_end;
827 if (cmd_end == NULL)
829 for (p = tagp.command;
830 *p && *p != '\r' && *p != '\n'; ++p)
832 cmd_end = p;
836 * Now, cmd_end points to the character after the
837 * command. Adjust it to point to the last
838 * character of the command.
840 cmd_end--;
843 * Skip the '/' and '?' characters at the
844 * beginning and end of the search pattern.
846 if (*cmd_start == '/' || *cmd_start == '?')
847 cmd_start++;
849 if (*cmd_end == '/' || *cmd_end == '?')
850 cmd_end--;
852 len = 0;
853 cmd[0] = NUL;
856 * If "^" is present in the tag search pattern, then
857 * copy it first.
859 if (*cmd_start == '^')
861 STRCPY(cmd, "^");
862 cmd_start++;
863 len++;
867 * Precede the tag pattern with \V to make it very
868 * nomagic.
870 STRCAT(cmd, "\\V");
871 len += 2;
873 cmd_len = (int)(cmd_end - cmd_start + 1);
874 if (cmd_len > (CMDBUFFSIZE - 5))
875 cmd_len = CMDBUFFSIZE - 5;
876 STRNCAT(cmd, cmd_start, cmd_len);
877 len += cmd_len;
879 if (cmd[len - 1] == '$')
882 * Replace '$' at the end of the search pattern
883 * with '\$'
885 cmd[len - 1] = '\\';
886 cmd[len] = '$';
887 len++;
890 cmd[len] = NUL;
893 if ((dict = dict_alloc()) == NULL)
894 continue;
895 if (list_append_dict(list, dict) == FAIL)
897 vim_free(dict);
898 continue;
901 dict_add_nr_str(dict, "text", 0L, tag_name);
902 dict_add_nr_str(dict, "filename", 0L, fname);
903 dict_add_nr_str(dict, "lnum", lnum, NULL);
904 if (lnum == 0)
905 dict_add_nr_str(dict, "pattern", 0L, cmd);
908 set_errorlist(curwin, list, ' ');
910 list_free(list, TRUE);
912 cur_match = 0; /* Jump to the first tag */
914 #endif
916 if (ask_for_selection == TRUE)
919 * Ask to select a tag from the list.
921 i = prompt_for_number(NULL);
922 if (i <= 0 || i > num_matches || got_int)
924 /* no valid choice: don't change anything */
925 if (use_tagstack)
927 tagstack[tagstackidx].fmark = saved_fmark;
928 tagstackidx = prevtagstackidx;
930 #ifdef FEAT_CSCOPE
931 cs_free_tags();
932 jumped_to_tag = TRUE;
933 #endif
934 break;
936 cur_match = i - 1;
939 if (cur_match >= num_matches)
941 /* Avoid giving this error when a file wasn't found and we're
942 * looking for a match in another file, which wasn't found.
943 * There will be an EMSG("file doesn't exist") below then. */
944 if ((type == DT_NEXT || type == DT_FIRST)
945 && nofile_fname == NULL)
947 if (num_matches == 1)
948 EMSG(_("E427: There is only one matching tag"));
949 else
950 EMSG(_("E428: Cannot go beyond last matching tag"));
951 skip_msg = TRUE;
953 cur_match = num_matches - 1;
955 if (use_tagstack)
957 tagstack[tagstackidx].cur_match = cur_match;
958 tagstack[tagstackidx].cur_fnum = cur_fnum;
959 ++tagstackidx;
961 #if defined(FEAT_WINDOWS) && defined(FEAT_QUICKFIX)
962 else if (g_do_tagpreview)
964 ptag_entry.cur_match = cur_match;
965 ptag_entry.cur_fnum = cur_fnum;
967 #endif
970 * Only when going to try the next match, report that the previous
971 * file didn't exist. Otherwise an EMSG() is given below.
973 if (nofile_fname != NULL && error_cur_match != cur_match)
974 smsg((char_u *)_("File \"%s\" does not exist"), nofile_fname);
977 ic = (matches[cur_match][0] & MT_IC_OFF);
978 if (type != DT_SELECT && type != DT_JUMP
979 #ifdef FEAT_CSCOPE
980 && type != DT_CSCOPE
981 #endif
982 && (num_matches > 1 || ic)
983 && !skip_msg)
985 /* Give an indication of the number of matching tags */
986 sprintf((char *)IObuff, _("tag %d of %d%s"),
987 cur_match + 1,
988 num_matches,
989 max_num_matches != MAXCOL ? _(" or more") : "");
990 if (ic)
991 STRCAT(IObuff, _(" Using tag with different case!"));
992 if ((num_matches > prev_num_matches || new_tag)
993 && num_matches > 1)
995 if (ic)
996 msg_attr(IObuff, hl_attr(HLF_W));
997 else
998 msg(IObuff);
999 msg_scroll = TRUE; /* don't overwrite this message */
1001 else
1002 give_warning(IObuff, ic);
1003 if (ic && !msg_scrolled && msg_silent == 0)
1005 out_flush();
1006 ui_delay(1000L, TRUE);
1010 #ifdef FEAT_AUTOCMD
1011 /* Let the SwapExists event know what tag we are jumping to. */
1012 vim_snprintf((char *)IObuff, IOSIZE, ":ta %s\r", name);
1013 set_vim_var_string(VV_SWAPCOMMAND, IObuff, -1);
1014 #endif
1017 * Jump to the desired match.
1019 i = jumpto_tag(matches[cur_match], forceit, type != DT_CSCOPE);
1021 #ifdef FEAT_AUTOCMD
1022 set_vim_var_string(VV_SWAPCOMMAND, NULL, -1);
1023 #endif
1025 if (i == NOTAGFILE)
1027 /* File not found: try again with another matching tag */
1028 if ((type == DT_PREV && cur_match > 0)
1029 || ((type == DT_TAG || type == DT_NEXT
1030 || type == DT_FIRST)
1031 && (max_num_matches != MAXCOL
1032 || cur_match < num_matches - 1)))
1034 error_cur_match = cur_match;
1035 if (use_tagstack)
1036 --tagstackidx;
1037 if (type == DT_PREV)
1038 --cur_match;
1039 else
1041 type = DT_NEXT;
1042 ++cur_match;
1044 continue;
1046 EMSG2(_("E429: File \"%s\" does not exist"), nofile_fname);
1048 else
1050 /* We may have jumped to another window, check that
1051 * tagstackidx is still valid. */
1052 if (use_tagstack && tagstackidx > curwin->w_tagstacklen)
1053 tagstackidx = curwin->w_tagstackidx;
1054 #ifdef FEAT_CSCOPE
1055 jumped_to_tag = TRUE;
1056 #endif
1059 break;
1062 end_do_tag:
1063 /* Only store the new index when using the tagstack and it's valid. */
1064 if (use_tagstack && tagstackidx <= curwin->w_tagstacklen)
1065 curwin->w_tagstackidx = tagstackidx;
1066 #ifdef FEAT_WINDOWS
1067 postponed_split = 0; /* don't split next time */
1068 #endif
1070 #ifdef FEAT_CSCOPE
1071 return jumped_to_tag;
1072 #else
1073 return FALSE;
1074 #endif
1078 * Free cached tags.
1080 void
1081 tag_freematch()
1083 vim_free(tagmatchname);
1084 tagmatchname = NULL;
1087 static void
1088 taglen_advance(l)
1089 int l;
1091 if (l == MAXCOL)
1093 msg_putchar('\n');
1094 msg_advance(24);
1096 else
1097 msg_advance(13 + l);
1101 * Print the tag stack
1103 /*ARGSUSED*/
1104 void
1105 do_tags(eap)
1106 exarg_T *eap;
1108 int i;
1109 char_u *name;
1110 taggy_T *tagstack = curwin->w_tagstack;
1111 int tagstackidx = curwin->w_tagstackidx;
1112 int tagstacklen = curwin->w_tagstacklen;
1114 /* Highlight title */
1115 MSG_PUTS_TITLE(_("\n # TO tag FROM line in file/text"));
1116 for (i = 0; i < tagstacklen; ++i)
1118 if (tagstack[i].tagname != NULL)
1120 name = fm_getname(&(tagstack[i].fmark), 30);
1121 if (name == NULL) /* file name not available */
1122 continue;
1124 msg_putchar('\n');
1125 sprintf((char *)IObuff, "%c%2d %2d %-15s %5ld ",
1126 i == tagstackidx ? '>' : ' ',
1127 i + 1,
1128 tagstack[i].cur_match + 1,
1129 tagstack[i].tagname,
1130 tagstack[i].fmark.mark.lnum);
1131 msg_outtrans(IObuff);
1132 msg_outtrans_attr(name, tagstack[i].fmark.fnum == curbuf->b_fnum
1133 ? hl_attr(HLF_D) : 0);
1134 vim_free(name);
1136 out_flush(); /* show one line at a time */
1138 if (tagstackidx == tagstacklen) /* idx at top of stack */
1139 MSG_PUTS("\n>");
1142 /* When not using a CR for line separator, use vim_fgets() to read tag lines.
1143 * For the Mac use tag_fgets(). It can handle any line separator, but is much
1144 * slower than vim_fgets().
1146 #ifndef USE_CR
1147 # define tag_fgets vim_fgets
1148 #endif
1150 #ifdef FEAT_TAG_BINS
1151 static int tag_strnicmp __ARGS((char_u *s1, char_u *s2, size_t len));
1154 * Compare two strings, for length "len", ignoring case the ASCII way.
1155 * return 0 for match, < 0 for smaller, > 0 for bigger
1156 * Make sure case is folded to uppercase in comparison (like for 'sort -f')
1158 static int
1159 tag_strnicmp(s1, s2, len)
1160 char_u *s1;
1161 char_u *s2;
1162 size_t len;
1164 int i;
1166 while (len > 0)
1168 i = (int)TOUPPER_ASC(*s1) - (int)TOUPPER_ASC(*s2);
1169 if (i != 0)
1170 return i; /* this character different */
1171 if (*s1 == NUL)
1172 break; /* strings match until NUL */
1173 ++s1;
1174 ++s2;
1175 --len;
1177 return 0; /* strings match */
1179 #endif
1182 * Structure to hold info about the tag pattern being used.
1184 typedef struct
1186 char_u *pat; /* the pattern */
1187 int len; /* length of pat[] */
1188 char_u *head; /* start of pattern head */
1189 int headlen; /* length of head[] */
1190 regmatch_T regmatch; /* regexp program, may be NULL */
1191 } pat_T;
1193 static void prepare_pats __ARGS((pat_T *pats, int has_re));
1196 * Extract info from the tag search pattern "pats->pat".
1198 static void
1199 prepare_pats(pats, has_re)
1200 pat_T *pats;
1201 int has_re;
1203 pats->head = pats->pat;
1204 pats->headlen = pats->len;
1205 if (has_re)
1207 /* When the pattern starts with '^' or "\\<", binary searching can be
1208 * used (much faster). */
1209 if (pats->pat[0] == '^')
1210 pats->head = pats->pat + 1;
1211 else if (pats->pat[0] == '\\' && pats->pat[1] == '<')
1212 pats->head = pats->pat + 2;
1213 if (pats->head == pats->pat)
1214 pats->headlen = 0;
1215 else
1216 for (pats->headlen = 0; pats->head[pats->headlen] != NUL;
1217 ++pats->headlen)
1218 if (vim_strchr((char_u *)(p_magic ? ".[~*\\$" : "\\$"),
1219 pats->head[pats->headlen]) != NULL)
1220 break;
1221 if (p_tl != 0 && pats->headlen > p_tl) /* adjust for 'taglength' */
1222 pats->headlen = p_tl;
1225 if (has_re)
1226 pats->regmatch.regprog = vim_regcomp(pats->pat, p_magic ? RE_MAGIC : 0);
1227 else
1228 pats->regmatch.regprog = NULL;
1232 * find_tags() - search for tags in tags files
1234 * Return FAIL if search completely failed (*num_matches will be 0, *matchesp
1235 * will be NULL), OK otherwise.
1237 * There is a priority in which type of tag is recognized.
1239 * 6. A static or global tag with a full matching tag for the current file.
1240 * 5. A global tag with a full matching tag for another file.
1241 * 4. A static tag with a full matching tag for another file.
1242 * 3. A static or global tag with an ignore-case matching tag for the
1243 * current file.
1244 * 2. A global tag with an ignore-case matching tag for another file.
1245 * 1. A static tag with an ignore-case matching tag for another file.
1247 * Tags in an emacs-style tags file are always global.
1249 * flags:
1250 * TAG_HELP only search for help tags
1251 * TAG_NAMES only return name of tag
1252 * TAG_REGEXP use "pat" as a regexp
1253 * TAG_NOIC don't always ignore case
1254 * TAG_KEEP_LANG keep language
1257 find_tags(pat, num_matches, matchesp, flags, mincount, buf_ffname)
1258 char_u *pat; /* pattern to search for */
1259 int *num_matches; /* return: number of matches found */
1260 char_u ***matchesp; /* return: array of matches found */
1261 int flags;
1262 int mincount; /* MAXCOL: find all matches
1263 other: minimal number of matches */
1264 char_u *buf_ffname; /* name of buffer for priority */
1266 FILE *fp;
1267 char_u *lbuf; /* line buffer */
1268 char_u *tag_fname; /* name of tag file */
1269 tagname_T tn; /* info for get_tagfname() */
1270 int first_file; /* trying first tag file */
1271 tagptrs_T tagp;
1272 int did_open = FALSE; /* did open a tag file */
1273 int stop_searching = FALSE; /* stop when match found or error */
1274 int retval = FAIL; /* return value */
1275 int is_static; /* current tag line is static */
1276 int is_current; /* file name matches */
1277 int eof = FALSE; /* found end-of-file */
1278 char_u *p;
1279 char_u *s;
1280 int i;
1281 #ifdef FEAT_TAG_BINS
1282 struct tag_search_info /* Binary search file offsets */
1284 off_t low_offset; /* offset for first char of first line that
1285 could match */
1286 off_t high_offset; /* offset of char after last line that could
1287 match */
1288 off_t curr_offset; /* Current file offset in search range */
1289 off_t curr_offset_used; /* curr_offset used when skipping back */
1290 off_t match_offset; /* Where the binary search found a tag */
1291 int low_char; /* first char at low_offset */
1292 int high_char; /* first char at high_offset */
1293 } search_info;
1294 off_t filesize;
1295 int tagcmp;
1296 off_t offset;
1297 int round;
1298 #endif
1299 enum
1301 TS_START, /* at start of file */
1302 TS_LINEAR /* linear searching forward, till EOF */
1303 #ifdef FEAT_TAG_BINS
1304 , TS_BINARY, /* binary searching */
1305 TS_SKIP_BACK, /* skipping backwards */
1306 TS_STEP_FORWARD /* stepping forwards */
1307 #endif
1308 } state; /* Current search state */
1310 int cmplen;
1311 int match; /* matches */
1312 int match_no_ic = 0;/* matches with rm_ic == FALSE */
1313 int match_re; /* match with regexp */
1314 int matchoff = 0;
1316 #ifdef FEAT_EMACS_TAGS
1318 * Stack for included emacs-tags file.
1319 * It has a fixed size, to truncate cyclic includes. jw
1321 # define INCSTACK_SIZE 42
1322 struct
1324 FILE *fp;
1325 char_u *etag_fname;
1326 } incstack[INCSTACK_SIZE];
1328 int incstack_idx = 0; /* index in incstack */
1329 char_u *ebuf; /* additional buffer for etag fname */
1330 int is_etag; /* current file is emaces style */
1331 #endif
1333 struct match_found
1335 int len; /* nr of chars of match[] to be compared */
1336 char_u match[1]; /* actually longer */
1337 } *mfp, *mfp2;
1338 garray_T ga_match[MT_COUNT];
1339 int match_count = 0; /* number of matches found */
1340 char_u **matches;
1341 int mtt;
1342 int len;
1343 int help_save;
1344 #ifdef FEAT_MULTI_LANG
1345 int help_pri = 0;
1346 char_u *help_lang_find = NULL; /* lang to be found */
1347 char_u help_lang[3]; /* lang of current tags file */
1348 char_u *saved_pat = NULL; /* copy of pat[] */
1349 #endif
1351 /* Use two sets of variables for the pattern: "orgpat" holds the values
1352 * for the original pattern and "convpat" converted from 'encoding' to
1353 * encoding of the tags file. "pats" point to either one of these. */
1354 pat_T *pats;
1355 pat_T orgpat; /* holds unconverted pattern info */
1356 #ifdef FEAT_MBYTE
1357 pat_T convpat; /* holds converted pattern info */
1358 vimconv_T vimconv;
1359 #endif
1361 #ifdef FEAT_TAG_BINS
1362 int findall = (mincount == MAXCOL || mincount == TAG_MANY);
1363 /* find all matching tags */
1364 int sort_error = FALSE; /* tags file not sorted */
1365 int linear; /* do a linear search */
1366 int sortic = FALSE; /* tag file sorted in nocase */
1367 #endif
1368 int line_error = FALSE; /* syntax error */
1369 int has_re = (flags & TAG_REGEXP); /* regexp used */
1370 int help_only = (flags & TAG_HELP);
1371 int name_only = (flags & TAG_NAMES);
1372 int noic = (flags & TAG_NOIC);
1373 int get_it_again = FALSE;
1374 #ifdef FEAT_CSCOPE
1375 int use_cscope = (flags & TAG_CSCOPE);
1376 #endif
1377 int verbose = (flags & TAG_VERBOSE);
1379 help_save = curbuf->b_help;
1380 orgpat.pat = pat;
1381 pats = &orgpat;
1382 #ifdef FEAT_MBYTE
1383 vimconv.vc_type = CONV_NONE;
1384 #endif
1387 * Allocate memory for the buffers that are used
1389 lbuf = alloc(LSIZE);
1390 tag_fname = alloc(MAXPATHL + 1);
1391 #ifdef FEAT_EMACS_TAGS
1392 ebuf = alloc(LSIZE);
1393 #endif
1394 for (mtt = 0; mtt < MT_COUNT; ++mtt)
1395 ga_init2(&ga_match[mtt], (int)sizeof(struct match_found *), 100);
1397 /* check for out of memory situation */
1398 if (lbuf == NULL || tag_fname == NULL
1399 #ifdef FEAT_EMACS_TAGS
1400 || ebuf == NULL
1401 #endif
1403 goto findtag_end;
1405 #ifdef FEAT_CSCOPE
1406 STRCPY(tag_fname, "from cscope"); /* for error messages */
1407 #endif
1410 * Initialize a few variables
1412 if (help_only) /* want tags from help file */
1413 curbuf->b_help = TRUE; /* will be restored later */
1415 pats->len = (int)STRLEN(pat);
1416 #ifdef FEAT_MULTI_LANG
1417 if (curbuf->b_help)
1419 /* When "@ab" is specified use only the "ab" language, otherwise
1420 * search all languages. */
1421 if (pats->len > 3 && pat[pats->len - 3] == '@'
1422 && ASCII_ISALPHA(pat[pats->len - 2])
1423 && ASCII_ISALPHA(pat[pats->len - 1]))
1425 saved_pat = vim_strnsave(pat, pats->len - 3);
1426 if (saved_pat != NULL)
1428 help_lang_find = &pat[pats->len - 2];
1429 pats->pat = saved_pat;
1430 pats->len -= 3;
1434 #endif
1435 if (p_tl != 0 && pats->len > p_tl) /* adjust for 'taglength' */
1436 pats->len = p_tl;
1438 prepare_pats(pats, has_re);
1440 #ifdef FEAT_TAG_BINS
1441 /* This is only to avoid a compiler warning for using search_info
1442 * uninitialised. */
1443 vim_memset(&search_info, 0, (size_t)1);
1444 #endif
1447 * When finding a specified number of matches, first try with matching
1448 * case, so binary search can be used, and try ignore-case matches in a
1449 * second loop.
1450 * When finding all matches, 'tagbsearch' is off, or there is no fixed
1451 * string to look for, ignore case right away to avoid going though the
1452 * tags files twice.
1453 * When the tag file is case-fold sorted, it is either one or the other.
1454 * Only ignore case when TAG_NOIC not used or 'ignorecase' set.
1456 #ifdef FEAT_TAG_BINS
1457 pats->regmatch.rm_ic = ((p_ic || !noic)
1458 && (findall || pats->headlen == 0 || !p_tbs));
1459 for (round = 1; round <= 2; ++round)
1461 linear = (pats->headlen == 0 || !p_tbs || round == 2);
1462 #else
1463 pats->regmatch.rm_ic = (p_ic || !noic);
1464 #endif
1467 * Try tag file names from tags option one by one.
1469 for (first_file = TRUE;
1470 #ifdef FEAT_CSCOPE
1471 use_cscope ||
1472 #endif
1473 get_tagfname(&tn, first_file, tag_fname) == OK;
1474 first_file = FALSE)
1477 * A file that doesn't exist is silently ignored. Only when not a
1478 * single file is found, an error message is given (further on).
1480 #ifdef FEAT_CSCOPE
1481 if (use_cscope)
1482 fp = NULL; /* avoid GCC warning */
1483 else
1484 #endif
1486 #ifdef FEAT_MULTI_LANG
1487 if (curbuf->b_help)
1489 /* Prefer help tags according to 'helplang'. Put the
1490 * two-letter language name in help_lang[]. */
1491 i = (int)STRLEN(tag_fname);
1492 if (i > 3 && tag_fname[i - 3] == '-')
1493 STRCPY(help_lang, tag_fname + i - 2);
1494 else
1495 STRCPY(help_lang, "en");
1497 /* When searching for a specific language skip tags files
1498 * for other languages. */
1499 if (help_lang_find != NULL
1500 && STRICMP(help_lang, help_lang_find) != 0)
1501 continue;
1503 /* For CTRL-] in a help file prefer a match with the same
1504 * language. */
1505 if ((flags & TAG_KEEP_LANG)
1506 && help_lang_find == NULL
1507 && curbuf->b_fname != NULL
1508 && (i = (int)STRLEN(curbuf->b_fname)) > 4
1509 && curbuf->b_fname[i - 1] == 'x'
1510 && curbuf->b_fname[i - 4] == '.'
1511 && STRNICMP(curbuf->b_fname + i - 3, help_lang, 2) == 0)
1512 help_pri = 0;
1513 else
1515 help_pri = 1;
1516 for (s = p_hlg; *s != NUL; ++s)
1518 if (STRNICMP(s, help_lang, 2) == 0)
1519 break;
1520 ++help_pri;
1521 if ((s = vim_strchr(s, ',')) == NULL)
1522 break;
1524 if (s == NULL || *s == NUL)
1526 /* Language not in 'helplang': use last, prefer English,
1527 * unless found already. */
1528 ++help_pri;
1529 if (STRICMP(help_lang, "en") != 0)
1530 ++help_pri;
1534 #endif
1536 if ((fp = mch_fopen((char *)tag_fname, "r")) == NULL)
1537 continue;
1539 if (p_verbose >= 5)
1541 verbose_enter();
1542 smsg((char_u *)_("Searching tags file %s"), tag_fname);
1543 verbose_leave();
1546 did_open = TRUE; /* remember that we found at least one file */
1548 state = TS_START; /* we're at the start of the file */
1549 #ifdef FEAT_EMACS_TAGS
1550 is_etag = 0; /* default is: not emacs style */
1551 #endif
1554 * Read and parse the lines in the file one by one
1556 for (;;)
1558 line_breakcheck(); /* check for CTRL-C typed */
1559 #ifdef FEAT_INS_EXPAND
1560 if ((flags & TAG_INS_COMP)) /* Double brackets for gcc */
1561 ins_compl_check_keys(30);
1562 if (got_int || compl_interrupted)
1563 #else
1564 if (got_int)
1565 #endif
1567 stop_searching = TRUE;
1568 break;
1570 /* When mincount is TAG_MANY, stop when enough matches have been
1571 * found (for completion). */
1572 if (mincount == TAG_MANY && match_count >= TAG_MANY)
1574 stop_searching = TRUE;
1575 retval = OK;
1576 break;
1578 if (get_it_again)
1579 goto line_read_in;
1580 #ifdef FEAT_TAG_BINS
1582 * For binary search: compute the next offset to use.
1584 if (state == TS_BINARY)
1586 offset = search_info.low_offset + ((search_info.high_offset
1587 - search_info.low_offset) / 2);
1588 if (offset == search_info.curr_offset)
1589 break; /* End the binary search without a match. */
1590 else
1591 search_info.curr_offset = offset;
1595 * Skipping back (after a match during binary search).
1597 else if (state == TS_SKIP_BACK)
1599 search_info.curr_offset -= LSIZE * 2;
1600 if (search_info.curr_offset < 0)
1602 search_info.curr_offset = 0;
1603 rewind(fp);
1604 state = TS_STEP_FORWARD;
1609 * When jumping around in the file, first read a line to find the
1610 * start of the next line.
1612 if (state == TS_BINARY || state == TS_SKIP_BACK)
1614 /* Adjust the search file offset to the correct position */
1615 search_info.curr_offset_used = search_info.curr_offset;
1616 #ifdef HAVE_FSEEKO
1617 fseeko(fp, search_info.curr_offset, SEEK_SET);
1618 #else
1619 fseek(fp, (long)search_info.curr_offset, SEEK_SET);
1620 #endif
1621 eof = tag_fgets(lbuf, LSIZE, fp);
1622 if (!eof && search_info.curr_offset != 0)
1624 /* The explicit cast is to work around a bug in gcc 3.4.2
1625 * (repeated below). */
1626 search_info.curr_offset = ftell(fp);
1627 if (search_info.curr_offset == search_info.high_offset)
1629 /* oops, gone a bit too far; try from low offset */
1630 #ifdef HAVE_FSEEKO
1631 fseeko(fp, search_info.low_offset, SEEK_SET);
1632 #else
1633 fseek(fp, (long)search_info.low_offset, SEEK_SET);
1634 #endif
1635 search_info.curr_offset = search_info.low_offset;
1637 eof = tag_fgets(lbuf, LSIZE, fp);
1639 /* skip empty and blank lines */
1640 while (!eof && vim_isblankline(lbuf))
1642 search_info.curr_offset = ftell(fp);
1643 eof = tag_fgets(lbuf, LSIZE, fp);
1645 if (eof)
1647 /* Hit end of file. Skip backwards. */
1648 state = TS_SKIP_BACK;
1649 search_info.match_offset = ftell(fp);
1650 search_info.curr_offset = search_info.curr_offset_used;
1651 continue;
1656 * Not jumping around in the file: Read the next line.
1658 else
1659 #endif
1661 /* skip empty and blank lines */
1664 #ifdef FEAT_CSCOPE
1665 if (use_cscope)
1666 eof = cs_fgets(lbuf, LSIZE);
1667 else
1668 #endif
1669 eof = tag_fgets(lbuf, LSIZE, fp);
1670 } while (!eof && vim_isblankline(lbuf));
1672 if (eof)
1674 #ifdef FEAT_EMACS_TAGS
1675 if (incstack_idx) /* this was an included file */
1677 --incstack_idx;
1678 fclose(fp); /* end of this file ... */
1679 fp = incstack[incstack_idx].fp;
1680 STRCPY(tag_fname, incstack[incstack_idx].etag_fname);
1681 vim_free(incstack[incstack_idx].etag_fname);
1682 is_etag = 1; /* (only etags can include) */
1683 continue; /* ... continue with parent file */
1685 else
1686 #endif
1687 break; /* end of file */
1690 line_read_in:
1692 #ifdef FEAT_EMACS_TAGS
1694 * Emacs tags line with CTRL-L: New file name on next line.
1695 * The file name is followed by a ','.
1697 if (*lbuf == Ctrl_L) /* remember etag file name in ebuf */
1699 is_etag = 1; /* in case at the start */
1700 state = TS_LINEAR;
1701 if (!tag_fgets(ebuf, LSIZE, fp))
1703 for (p = ebuf; *p && *p != ','; p++)
1705 *p = NUL;
1708 * atoi(p+1) is the number of bytes before the next ^L
1709 * unless it is an include statement.
1711 if (STRNCMP(p + 1, "include", 7) == 0
1712 && incstack_idx < INCSTACK_SIZE)
1714 /* Save current "fp" and "tag_fname" in the stack. */
1715 if ((incstack[incstack_idx].etag_fname =
1716 vim_strsave(tag_fname)) != NULL)
1718 char_u *fullpath_ebuf;
1720 incstack[incstack_idx].fp = fp;
1721 fp = NULL;
1723 /* Figure out "tag_fname" and "fp" to use for
1724 * included file. */
1725 fullpath_ebuf = expand_tag_fname(ebuf,
1726 tag_fname, FALSE);
1727 if (fullpath_ebuf != NULL)
1729 fp = mch_fopen((char *)fullpath_ebuf, "r");
1730 if (fp != NULL)
1732 if (STRLEN(fullpath_ebuf) > LSIZE)
1733 EMSG2(_("E430: Tag file path truncated for %s\n"), ebuf);
1734 vim_strncpy(tag_fname, fullpath_ebuf,
1735 MAXPATHL);
1736 ++incstack_idx;
1737 is_etag = 0; /* we can include anything */
1739 vim_free(fullpath_ebuf);
1741 if (fp == NULL)
1743 /* Can't open the included file, skip it and
1744 * restore old value of "fp". */
1745 fp = incstack[incstack_idx].fp;
1746 vim_free(incstack[incstack_idx].etag_fname);
1751 continue;
1753 #endif
1756 * When still at the start of the file, check for Emacs tags file
1757 * format, and for "not sorted" flag.
1759 if (state == TS_START)
1761 #ifdef FEAT_TAG_BINS
1763 * When there is no tag head, or ignoring case, need to do a
1764 * linear search.
1765 * When no "!_TAG_" is found, default to binary search. If
1766 * the tag file isn't sorted, the second loop will find it.
1767 * When "!_TAG_FILE_SORTED" found: start binary search if
1768 * flag set.
1769 * For cscope, it's always linear.
1771 # ifdef FEAT_CSCOPE
1772 if (linear || use_cscope)
1773 # else
1774 if (linear)
1775 # endif
1776 state = TS_LINEAR;
1777 else if (STRNCMP(lbuf, "!_TAG_", 6) > 0)
1778 state = TS_BINARY;
1779 else if (STRNCMP(lbuf, "!_TAG_FILE_SORTED\t", 18) == 0)
1781 /* Check sorted flag */
1782 if (lbuf[18] == '1')
1783 state = TS_BINARY;
1784 else if (lbuf[18] == '2')
1786 state = TS_BINARY;
1787 sortic = TRUE;
1788 pats->regmatch.rm_ic = (p_ic || !noic);
1790 else
1791 state = TS_LINEAR;
1794 if (state == TS_BINARY && pats->regmatch.rm_ic && !sortic)
1796 /* binary search won't work for ignoring case, use linear
1797 * search. */
1798 linear = TRUE;
1799 state = TS_LINEAR;
1801 #else
1802 state = TS_LINEAR;
1803 #endif
1805 #ifdef FEAT_TAG_BINS
1807 * When starting a binary search, get the size of the file and
1808 * compute the first offset.
1810 if (state == TS_BINARY)
1812 /* Get the tag file size (don't use mch_fstat(), it's not
1813 * portable). */
1814 if ((filesize = lseek(fileno(fp),
1815 (off_t)0L, SEEK_END)) <= 0)
1816 state = TS_LINEAR;
1817 else
1819 lseek(fileno(fp), (off_t)0L, SEEK_SET);
1821 /* Calculate the first read offset in the file. Start
1822 * the search in the middle of the file. */
1823 search_info.low_offset = 0;
1824 search_info.low_char = 0;
1825 search_info.high_offset = filesize;
1826 search_info.curr_offset = 0;
1827 search_info.high_char = 0xff;
1829 continue;
1831 #endif
1834 #ifdef FEAT_MBYTE
1835 if (lbuf[0] == '!' && pats == &orgpat
1836 && STRNCMP(lbuf, "!_TAG_FILE_ENCODING\t", 20) == 0)
1838 /* Convert the search pattern from 'encoding' to the
1839 * specified encoding. */
1840 for (p = lbuf + 20; *p > ' ' && *p < 127; ++p)
1842 *p = NUL;
1843 convert_setup(&vimconv, p_enc, lbuf + 20);
1844 if (vimconv.vc_type != CONV_NONE)
1846 convpat.pat = string_convert(&vimconv, pats->pat, NULL);
1847 if (convpat.pat != NULL)
1849 pats = &convpat;
1850 pats->len = (int)STRLEN(pats->pat);
1851 prepare_pats(pats, has_re);
1852 pats->regmatch.rm_ic = orgpat.regmatch.rm_ic;
1856 /* Prepare for converting a match the other way around. */
1857 convert_setup(&vimconv, lbuf + 20, p_enc);
1858 continue;
1860 #endif
1863 * Figure out where the different strings are in this line.
1864 * For "normal" tags: Do a quick check if the tag matches.
1865 * This speeds up tag searching a lot!
1867 if (pats->headlen
1868 #ifdef FEAT_EMACS_TAGS
1869 && !is_etag
1870 #endif
1873 tagp.tagname = lbuf;
1874 #ifdef FEAT_TAG_ANYWHITE
1875 tagp.tagname_end = skiptowhite(lbuf);
1876 if (*tagp.tagname_end == NUL) /* corrupted tag line */
1877 #else
1878 tagp.tagname_end = vim_strchr(lbuf, TAB);
1879 if (tagp.tagname_end == NULL) /* corrupted tag line */
1880 #endif
1882 line_error = TRUE;
1883 break;
1886 #ifdef FEAT_TAG_OLDSTATIC
1888 * Check for old style static tag: "file:tag file .."
1890 tagp.fname = NULL;
1891 for (p = lbuf; p < tagp.tagname_end; ++p)
1893 if (*p == ':')
1895 if (tagp.fname == NULL)
1896 #ifdef FEAT_TAG_ANYWHITE
1897 tagp.fname = skipwhite(tagp.tagname_end);
1898 #else
1899 tagp.fname = tagp.tagname_end + 1;
1900 #endif
1901 if ( fnamencmp(lbuf, tagp.fname, p - lbuf) == 0
1902 #ifdef FEAT_TAG_ANYWHITE
1903 && vim_iswhite(tagp.fname[p - lbuf])
1904 #else
1905 && tagp.fname[p - lbuf] == TAB
1906 #endif
1909 /* found one */
1910 tagp.tagname = p + 1;
1911 break;
1915 #endif
1918 * Skip this line if the length of the tag is different and
1919 * there is no regexp, or the tag is too short.
1921 cmplen = (int)(tagp.tagname_end - tagp.tagname);
1922 if (p_tl != 0 && cmplen > p_tl) /* adjust for 'taglength' */
1923 cmplen = p_tl;
1924 if (has_re && pats->headlen < cmplen)
1925 cmplen = pats->headlen;
1926 else if (state == TS_LINEAR && pats->headlen != cmplen)
1927 continue;
1929 #ifdef FEAT_TAG_BINS
1930 if (state == TS_BINARY)
1933 * Simplistic check for unsorted tags file.
1935 i = (int)tagp.tagname[0];
1936 if (sortic)
1937 i = (int)TOUPPER_ASC(tagp.tagname[0]);
1938 if (i < search_info.low_char || i > search_info.high_char)
1939 sort_error = TRUE;
1942 * Compare the current tag with the searched tag.
1944 if (sortic)
1945 tagcmp = tag_strnicmp(tagp.tagname, pats->head,
1946 (size_t)cmplen);
1947 else
1948 tagcmp = STRNCMP(tagp.tagname, pats->head, cmplen);
1951 * A match with a shorter tag means to search forward.
1952 * A match with a longer tag means to search backward.
1954 if (tagcmp == 0)
1956 if (cmplen < pats->headlen)
1957 tagcmp = -1;
1958 else if (cmplen > pats->headlen)
1959 tagcmp = 1;
1962 if (tagcmp == 0)
1964 /* We've located the tag, now skip back and search
1965 * forward until the first matching tag is found.
1967 state = TS_SKIP_BACK;
1968 search_info.match_offset = search_info.curr_offset;
1969 continue;
1971 if (tagcmp < 0)
1973 search_info.curr_offset = ftell(fp);
1974 if (search_info.curr_offset < search_info.high_offset)
1976 search_info.low_offset = search_info.curr_offset;
1977 if (sortic)
1978 search_info.low_char =
1979 TOUPPER_ASC(tagp.tagname[0]);
1980 else
1981 search_info.low_char = tagp.tagname[0];
1982 continue;
1985 if (tagcmp > 0
1986 && search_info.curr_offset != search_info.high_offset)
1988 search_info.high_offset = search_info.curr_offset;
1989 if (sortic)
1990 search_info.high_char =
1991 TOUPPER_ASC(tagp.tagname[0]);
1992 else
1993 search_info.high_char = tagp.tagname[0];
1994 continue;
1997 /* No match yet and are at the end of the binary search. */
1998 break;
2000 else if (state == TS_SKIP_BACK)
2002 if (MB_STRNICMP(tagp.tagname, pats->head, cmplen) != 0)
2003 state = TS_STEP_FORWARD;
2004 else
2005 /* Have to skip back more. Restore the curr_offset
2006 * used, otherwise we get stuck at a long line. */
2007 search_info.curr_offset = search_info.curr_offset_used;
2008 continue;
2010 else if (state == TS_STEP_FORWARD)
2012 if (MB_STRNICMP(tagp.tagname, pats->head, cmplen) != 0)
2014 if ((off_t)ftell(fp) > search_info.match_offset)
2015 break; /* past last match */
2016 else
2017 continue; /* before first match */
2020 else
2021 #endif
2022 /* skip this match if it can't match */
2023 if (MB_STRNICMP(tagp.tagname, pats->head, cmplen) != 0)
2024 continue;
2027 * Can be a matching tag, isolate the file name and command.
2029 #ifdef FEAT_TAG_OLDSTATIC
2030 if (tagp.fname == NULL)
2031 #endif
2032 #ifdef FEAT_TAG_ANYWHITE
2033 tagp.fname = skipwhite(tagp.tagname_end);
2034 #else
2035 tagp.fname = tagp.tagname_end + 1;
2036 #endif
2037 #ifdef FEAT_TAG_ANYWHITE
2038 tagp.fname_end = skiptowhite(tagp.fname);
2039 tagp.command = skipwhite(tagp.fname_end);
2040 if (*tagp.command == NUL)
2041 #else
2042 tagp.fname_end = vim_strchr(tagp.fname, TAB);
2043 tagp.command = tagp.fname_end + 1;
2044 if (tagp.fname_end == NULL)
2045 #endif
2046 i = FAIL;
2047 else
2048 i = OK;
2050 else
2051 i = parse_tag_line(lbuf,
2052 #ifdef FEAT_EMACS_TAGS
2053 is_etag,
2054 #endif
2055 &tagp);
2056 if (i == FAIL)
2058 line_error = TRUE;
2059 break;
2062 #ifdef FEAT_EMACS_TAGS
2063 if (is_etag)
2064 tagp.fname = ebuf;
2065 #endif
2067 * First try matching with the pattern literally (also when it is
2068 * a regexp).
2070 cmplen = (int)(tagp.tagname_end - tagp.tagname);
2071 if (p_tl != 0 && cmplen > p_tl) /* adjust for 'taglength' */
2072 cmplen = p_tl;
2073 /* if tag length does not match, don't try comparing */
2074 if (pats->len != cmplen)
2075 match = FALSE;
2076 else
2078 if (pats->regmatch.rm_ic)
2080 match = (MB_STRNICMP(tagp.tagname, pats->pat, cmplen) == 0);
2081 if (match)
2082 match_no_ic = (STRNCMP(tagp.tagname, pats->pat,
2083 cmplen) == 0);
2085 else
2086 match = (STRNCMP(tagp.tagname, pats->pat, cmplen) == 0);
2090 * Has a regexp: Also find tags matching regexp.
2092 match_re = FALSE;
2093 if (!match && pats->regmatch.regprog != NULL)
2095 int cc;
2097 cc = *tagp.tagname_end;
2098 *tagp.tagname_end = NUL;
2099 match = vim_regexec(&pats->regmatch, tagp.tagname, (colnr_T)0);
2100 if (match)
2102 matchoff = (int)(pats->regmatch.startp[0] - tagp.tagname);
2103 if (pats->regmatch.rm_ic)
2105 pats->regmatch.rm_ic = FALSE;
2106 match_no_ic = vim_regexec(&pats->regmatch, tagp.tagname,
2107 (colnr_T)0);
2108 pats->regmatch.rm_ic = TRUE;
2111 *tagp.tagname_end = cc;
2112 match_re = TRUE;
2116 * If a match is found, add it to ga_match[].
2118 if (match)
2120 #ifdef FEAT_CSCOPE
2121 if (use_cscope)
2123 /* Don't change the ordering, always use the same table. */
2124 mtt = MT_GL_OTH;
2126 else
2127 #endif
2129 /* Decide in which array to store this match. */
2130 is_current = test_for_current(
2131 #ifdef FEAT_EMACS_TAGS
2132 is_etag,
2133 #endif
2134 tagp.fname, tagp.fname_end, tag_fname,
2135 buf_ffname);
2136 #ifdef FEAT_EMACS_TAGS
2137 is_static = FALSE;
2138 if (!is_etag) /* emacs tags are never static */
2139 #endif
2141 #ifdef FEAT_TAG_OLDSTATIC
2142 if (tagp.tagname != lbuf)
2143 is_static = TRUE; /* detected static tag before */
2144 else
2145 #endif
2146 is_static = test_for_static(&tagp);
2149 /* decide in which of the sixteen tables to store this
2150 * match */
2151 if (is_static)
2153 if (is_current)
2154 mtt = MT_ST_CUR;
2155 else
2156 mtt = MT_ST_OTH;
2158 else
2160 if (is_current)
2161 mtt = MT_GL_CUR;
2162 else
2163 mtt = MT_GL_OTH;
2165 if (pats->regmatch.rm_ic && !match_no_ic)
2166 mtt += MT_IC_OFF;
2167 if (match_re)
2168 mtt += MT_RE_OFF;
2172 * Add the found match in ga_match[mtt], avoiding duplicates.
2173 * Store the info we need later, which depends on the kind of
2174 * tags we are dealing with.
2176 if (ga_grow(&ga_match[mtt], 1) == OK)
2178 #ifdef FEAT_MBYTE
2179 char_u *conv_line = NULL;
2180 char_u *lbuf_line = lbuf;
2182 if (vimconv.vc_type != CONV_NONE)
2184 /* Convert the tag line from the encoding of the tags
2185 * file to 'encoding'. Then parse the line again. */
2186 conv_line = string_convert(&vimconv, lbuf, NULL);
2187 if (conv_line != NULL)
2189 if (parse_tag_line(conv_line,
2190 #ifdef FEAT_EMACS_TAGS
2191 is_etag,
2192 #endif
2193 &tagp) == OK)
2194 lbuf_line = conv_line;
2195 else
2196 /* doesn't work, go back to unconverted line. */
2197 (void)parse_tag_line(lbuf,
2198 #ifdef FEAT_EMACS_TAGS
2199 is_etag,
2200 #endif
2201 &tagp);
2204 #else
2205 # define lbuf_line lbuf
2206 #endif
2207 if (help_only)
2209 #ifdef FEAT_MULTI_LANG
2210 # define ML_EXTRA 3
2211 #else
2212 # define ML_EXTRA 0
2213 #endif
2215 * Append the help-heuristic number after the
2216 * tagname, for sorting it later.
2218 *tagp.tagname_end = NUL;
2219 len = (int)(tagp.tagname_end - tagp.tagname);
2220 mfp = (struct match_found *)
2221 alloc((int)sizeof(struct match_found) + len
2222 + 10 + ML_EXTRA);
2223 if (mfp != NULL)
2225 /* "len" includes the language and the NUL, but
2226 * not the priority. */
2227 mfp->len = len + ML_EXTRA + 1;
2228 #define ML_HELP_LEN 6
2229 p = mfp->match;
2230 STRCPY(p, tagp.tagname);
2231 #ifdef FEAT_MULTI_LANG
2232 p[len] = '@';
2233 STRCPY(p + len + 1, help_lang);
2234 #endif
2235 sprintf((char *)p + len + 1 + ML_EXTRA, "%06d",
2236 help_heuristic(tagp.tagname,
2237 match_re ? matchoff : 0, !match_no_ic)
2238 #ifdef FEAT_MULTI_LANG
2239 + help_pri
2240 #endif
2243 *tagp.tagname_end = TAB;
2245 else if (name_only)
2247 if (get_it_again)
2249 char_u *temp_end = tagp.command;
2251 if (*temp_end == '/')
2252 while (*temp_end && *temp_end != '\r'
2253 && *temp_end != '\n'
2254 && *temp_end != '$')
2255 temp_end++;
2257 if (tagp.command + 2 < temp_end)
2259 len = (int)(temp_end - tagp.command - 2);
2260 mfp = (struct match_found *)alloc(
2261 (int)sizeof(struct match_found) + len);
2262 if (mfp != NULL)
2264 mfp->len = len + 1; /* include the NUL */
2265 p = mfp->match;
2266 vim_strncpy(p, tagp.command + 2, len);
2269 else
2270 mfp = NULL;
2271 get_it_again = FALSE;
2273 else
2275 len = (int)(tagp.tagname_end - tagp.tagname);
2276 mfp = (struct match_found *)alloc(
2277 (int)sizeof(struct match_found) + len);
2278 if (mfp != NULL)
2280 mfp->len = len + 1; /* include the NUL */
2281 p = mfp->match;
2282 vim_strncpy(p, tagp.tagname, len);
2285 /* if wanted, re-read line to get long form too */
2286 if (State & INSERT)
2287 get_it_again = p_sft;
2290 else
2292 /* Save the tag in a buffer.
2293 * Emacs tag: <mtt><tag_fname><NUL><ebuf><NUL><lbuf>
2294 * other tag: <mtt><tag_fname><NUL><NUL><lbuf>
2295 * without Emacs tags: <mtt><tag_fname><NUL><lbuf>
2297 len = (int)STRLEN(tag_fname)
2298 + (int)STRLEN(lbuf_line) + 3;
2299 #ifdef FEAT_EMACS_TAGS
2300 if (is_etag)
2301 len += (int)STRLEN(ebuf) + 1;
2302 else
2303 ++len;
2304 #endif
2305 mfp = (struct match_found *)alloc(
2306 (int)sizeof(struct match_found) + len);
2307 if (mfp != NULL)
2309 mfp->len = len;
2310 p = mfp->match;
2311 p[0] = mtt;
2312 STRCPY(p + 1, tag_fname);
2313 #ifdef BACKSLASH_IN_FILENAME
2314 /* Ignore differences in slashes, avoid adding
2315 * both path/file and path\file. */
2316 slash_adjust(p + 1);
2317 #endif
2318 s = p + 1 + STRLEN(tag_fname) + 1;
2319 #ifdef FEAT_EMACS_TAGS
2320 if (is_etag)
2322 STRCPY(s, ebuf);
2323 s += STRLEN(ebuf) + 1;
2325 else
2326 *s++ = NUL;
2327 #endif
2328 STRCPY(s, lbuf_line);
2332 if (mfp != NULL)
2335 * Don't add identical matches.
2336 * This can take a lot of time when finding many
2337 * matches, check for CTRL-C now and then.
2338 * Add all cscope tags, because they are all listed.
2340 #ifdef FEAT_CSCOPE
2341 if (use_cscope)
2342 i = -1;
2343 else
2344 #endif
2345 for (i = ga_match[mtt].ga_len; --i >= 0 && !got_int; )
2347 mfp2 = ((struct match_found **)
2348 (ga_match[mtt].ga_data))[i];
2349 if (mfp2->len == mfp->len
2350 && vim_memcmp(mfp2->match, mfp->match,
2351 (size_t)mfp->len) == 0)
2352 break;
2353 line_breakcheck();
2355 if (i < 0)
2357 ((struct match_found **)(ga_match[mtt].ga_data))
2358 [ga_match[mtt].ga_len++] = mfp;
2359 ++match_count;
2361 else
2362 vim_free(mfp);
2364 #ifdef FEAT_MBYTE
2365 /* Note: this makes the values in "tagp" invalid! */
2366 vim_free(conv_line);
2367 #endif
2369 else /* Out of memory! Just forget about the rest. */
2371 retval = OK;
2372 stop_searching = TRUE;
2373 break;
2376 #ifdef FEAT_CSCOPE
2377 if (use_cscope && eof)
2378 break;
2379 #endif
2380 } /* forever */
2382 if (line_error)
2384 EMSG2(_("E431: Format error in tags file \"%s\""), tag_fname);
2385 #ifdef FEAT_CSCOPE
2386 if (!use_cscope)
2387 #endif
2388 EMSGN(_("Before byte %ld"), (long)ftell(fp));
2389 stop_searching = TRUE;
2390 line_error = FALSE;
2393 #ifdef FEAT_CSCOPE
2394 if (!use_cscope)
2395 #endif
2396 fclose(fp);
2397 #ifdef FEAT_EMACS_TAGS
2398 while (incstack_idx)
2400 --incstack_idx;
2401 fclose(incstack[incstack_idx].fp);
2402 vim_free(incstack[incstack_idx].etag_fname);
2404 #endif
2405 #ifdef FEAT_MBYTE
2406 if (pats == &convpat)
2408 /* Go back from converted pattern to original pattern. */
2409 vim_free(pats->pat);
2410 vim_free(pats->regmatch.regprog);
2411 orgpat.regmatch.rm_ic = pats->regmatch.rm_ic;
2412 pats = &orgpat;
2414 if (vimconv.vc_type != CONV_NONE)
2415 convert_setup(&vimconv, NULL, NULL);
2416 #endif
2418 #ifdef FEAT_TAG_BINS
2419 if (sort_error)
2421 EMSG2(_("E432: Tags file not sorted: %s"), tag_fname);
2422 sort_error = FALSE;
2424 #endif
2427 * Stop searching if sufficient tags have been found.
2429 if (match_count >= mincount)
2431 retval = OK;
2432 stop_searching = TRUE;
2435 #ifdef FEAT_CSCOPE
2436 if (stop_searching || use_cscope)
2437 #else
2438 if (stop_searching)
2439 #endif
2440 break;
2442 } /* end of for-each-file loop */
2444 #ifdef FEAT_CSCOPE
2445 if (!use_cscope)
2446 #endif
2447 tagname_free(&tn);
2449 #ifdef FEAT_TAG_BINS
2450 /* stop searching when already did a linear search, or when TAG_NOIC
2451 * used, and 'ignorecase' not set or already did case-ignore search */
2452 if (stop_searching || linear || (!p_ic && noic) || pats->regmatch.rm_ic)
2453 break;
2454 # ifdef FEAT_CSCOPE
2455 if (use_cscope)
2456 break;
2457 # endif
2458 pats->regmatch.rm_ic = TRUE; /* try another time while ignoring case */
2460 #endif
2462 if (!stop_searching)
2464 if (!did_open && verbose) /* never opened any tags file */
2465 EMSG(_("E433: No tags file"));
2466 retval = OK; /* It's OK even when no tag found */
2469 findtag_end:
2470 vim_free(lbuf);
2471 vim_free(pats->regmatch.regprog);
2472 vim_free(tag_fname);
2473 #ifdef FEAT_EMACS_TAGS
2474 vim_free(ebuf);
2475 #endif
2478 * Move the matches from the ga_match[] arrays into one list of
2479 * matches. When retval == FAIL, free the matches.
2481 if (retval == FAIL)
2482 match_count = 0;
2484 if (match_count > 0)
2485 matches = (char_u **)lalloc((long_u)(match_count * sizeof(char_u *)),
2486 TRUE);
2487 else
2488 matches = NULL;
2489 match_count = 0;
2490 for (mtt = 0; mtt < MT_COUNT; ++mtt)
2492 for (i = 0; i < ga_match[mtt].ga_len; ++i)
2494 mfp = ((struct match_found **)(ga_match[mtt].ga_data))[i];
2495 if (matches == NULL)
2496 vim_free(mfp);
2497 else
2499 /* To avoid allocating memory again we turn the struct
2500 * match_found into a string. For help the priority was not
2501 * included in the length. */
2502 mch_memmove(mfp, mfp->match,
2503 (size_t)(mfp->len + (help_only ? ML_HELP_LEN : 0)));
2504 matches[match_count++] = (char_u *)mfp;
2507 ga_clear(&ga_match[mtt]);
2510 *matchesp = matches;
2511 *num_matches = match_count;
2513 curbuf->b_help = help_save;
2514 #ifdef FEAT_MULTI_LANG
2515 vim_free(saved_pat);
2516 #endif
2518 return retval;
2521 static garray_T tag_fnames = GA_EMPTY;
2522 static void found_tagfile_cb __ARGS((char_u *fname, void *cookie));
2525 * Callback function for finding all "tags" and "tags-??" files in
2526 * 'runtimepath' doc directories.
2528 /*ARGSUSED*/
2529 static void
2530 found_tagfile_cb(fname, cookie)
2531 char_u *fname;
2532 void *cookie;
2534 if (ga_grow(&tag_fnames, 1) == OK)
2535 ((char_u **)(tag_fnames.ga_data))[tag_fnames.ga_len++] =
2536 vim_strsave(fname);
2539 #if defined(EXITFREE) || defined(PROTO)
2540 void
2541 free_tag_stuff()
2543 ga_clear_strings(&tag_fnames);
2544 do_tag(NULL, DT_FREE, 0, 0, 0);
2546 #endif
2549 * Get the next name of a tag file from the tag file list.
2550 * For help files, use "tags" file only.
2552 * Return FAIL if no more tag file names, OK otherwise.
2555 get_tagfname(tnp, first, buf)
2556 tagname_T *tnp; /* holds status info */
2557 int first; /* TRUE when first file name is wanted */
2558 char_u *buf; /* pointer to buffer of MAXPATHL chars */
2560 char_u *fname = NULL;
2561 char_u *r_ptr;
2563 if (first)
2564 vim_memset(tnp, 0, sizeof(tagname_T));
2566 if (curbuf->b_help)
2569 * For help files it's done in a completely different way:
2570 * Find "doc/tags" and "doc/tags-??" in all directories in
2571 * 'runtimepath'.
2573 if (first)
2575 ga_clear_strings(&tag_fnames);
2576 ga_init2(&tag_fnames, (int)sizeof(char_u *), 10);
2577 do_in_runtimepath((char_u *)
2578 #ifdef FEAT_MULTI_LANG
2579 # ifdef VMS
2580 /* Functions decc$to_vms() and decc$translate_vms() crash
2581 * on some VMS systems with wildcards "??". Seems ECO
2582 * patches do fix the problem in C RTL, but we can't use
2583 * an #ifdef for that. */
2584 "doc/tags doc/tags-*"
2585 # else
2586 "doc/tags doc/tags-??"
2587 # endif
2588 #else
2589 "doc/tags"
2590 #endif
2591 , TRUE, found_tagfile_cb, NULL);
2594 if (tnp->tn_hf_idx >= tag_fnames.ga_len)
2596 /* Not found in 'runtimepath', use 'helpfile', if it exists and
2597 * wasn't used yet, replacing "help.txt" with "tags". */
2598 if (tnp->tn_hf_idx > tag_fnames.ga_len || *p_hf == NUL)
2599 return FAIL;
2600 ++tnp->tn_hf_idx;
2601 STRCPY(buf, p_hf);
2602 STRCPY(gettail(buf), "tags");
2604 else
2605 vim_strncpy(buf, ((char_u **)(tag_fnames.ga_data))[
2606 tnp->tn_hf_idx++], MAXPATHL - 1);
2607 return OK;
2610 if (first)
2612 /* Init. We make a copy of 'tags', because autocommands may change
2613 * the value without notifying us. */
2614 tnp->tn_tags = vim_strsave((*curbuf->b_p_tags != NUL)
2615 ? curbuf->b_p_tags : p_tags);
2616 if (tnp->tn_tags == NULL)
2617 return FAIL;
2618 tnp->tn_np = tnp->tn_tags;
2622 * Loop until we have found a file name that can be used.
2623 * There are two states:
2624 * tnp->tn_did_filefind_init == FALSE: setup for next part in 'tags'.
2625 * tnp->tn_did_filefind_init == TRUE: find next file in this part.
2627 for (;;)
2629 if (tnp->tn_did_filefind_init)
2631 fname = vim_findfile(tnp->tn_search_ctx);
2632 if (fname != NULL)
2633 break;
2635 tnp->tn_did_filefind_init = FALSE;
2637 else
2639 char_u *filename = NULL;
2641 /* Stop when used all parts of 'tags'. */
2642 if (*tnp->tn_np == NUL)
2644 vim_findfile_cleanup(tnp->tn_search_ctx);
2645 tnp->tn_search_ctx = NULL;
2646 return FAIL;
2650 * Copy next file name into buf.
2652 buf[0] = NUL;
2653 (void)copy_option_part(&tnp->tn_np, buf, MAXPATHL - 1, " ,");
2655 #ifdef FEAT_PATH_EXTRA
2656 r_ptr = vim_findfile_stopdir(buf);
2657 #else
2658 r_ptr = NULL;
2659 #endif
2660 /* move the filename one char forward and truncate the
2661 * filepath with a NUL */
2662 filename = gettail(buf);
2663 STRMOVE(filename + 1, filename);
2664 *filename++ = NUL;
2666 tnp->tn_search_ctx = vim_findfile_init(buf, filename,
2667 r_ptr, 100,
2668 FALSE, /* don't free visited list */
2669 FINDFILE_FILE, /* we search for a file */
2670 tnp->tn_search_ctx, TRUE, curbuf->b_ffname);
2671 if (tnp->tn_search_ctx != NULL)
2672 tnp->tn_did_filefind_init = TRUE;
2676 STRCPY(buf, fname);
2677 vim_free(fname);
2678 return OK;
2682 * Free the contents of a tagname_T that was filled by get_tagfname().
2684 void
2685 tagname_free(tnp)
2686 tagname_T *tnp;
2688 vim_free(tnp->tn_tags);
2689 vim_findfile_cleanup(tnp->tn_search_ctx);
2690 tnp->tn_search_ctx = NULL;
2691 ga_clear_strings(&tag_fnames);
2695 * Parse one line from the tags file. Find start/end of tag name, start/end of
2696 * file name and start of search pattern.
2698 * If is_etag is TRUE, tagp->fname and tagp->fname_end are not set.
2700 * Return FAIL if there is a format error in this line, OK otherwise.
2702 static int
2703 parse_tag_line(lbuf,
2704 #ifdef FEAT_EMACS_TAGS
2705 is_etag,
2706 #endif
2707 tagp)
2708 char_u *lbuf; /* line to be parsed */
2709 #ifdef FEAT_EMACS_TAGS
2710 int is_etag;
2711 #endif
2712 tagptrs_T *tagp;
2714 char_u *p;
2716 #ifdef FEAT_EMACS_TAGS
2717 char_u *p_7f;
2719 if (is_etag)
2722 * There are two formats for an emacs tag line:
2723 * 1: struct EnvBase ^?EnvBase^A139,4627
2724 * 2: #define ARPB_WILD_WORLD ^?153,5194
2726 p_7f = vim_strchr(lbuf, 0x7f);
2727 if (p_7f == NULL)
2728 return FAIL;
2730 /* Find ^A. If not found the line number is after the 0x7f */
2731 p = vim_strchr(p_7f, Ctrl_A);
2732 if (p == NULL)
2733 p = p_7f + 1;
2734 else
2735 ++p;
2737 if (!VIM_ISDIGIT(*p)) /* check for start of line number */
2738 return FAIL;
2739 tagp->command = p;
2742 if (p[-1] == Ctrl_A) /* first format: explicit tagname given */
2744 tagp->tagname = p_7f + 1;
2745 tagp->tagname_end = p - 1;
2747 else /* second format: isolate tagname */
2749 /* find end of tagname */
2750 for (p = p_7f - 1; !vim_iswordc(*p); --p)
2751 if (p == lbuf)
2752 return FAIL;
2753 tagp->tagname_end = p + 1;
2754 while (p >= lbuf && vim_iswordc(*p))
2755 --p;
2756 tagp->tagname = p + 1;
2759 else /* not an Emacs tag */
2761 #endif
2762 /* Isolate the tagname, from lbuf up to the first white */
2763 tagp->tagname = lbuf;
2764 #ifdef FEAT_TAG_ANYWHITE
2765 p = skiptowhite(lbuf);
2766 #else
2767 p = vim_strchr(lbuf, TAB);
2768 if (p == NULL)
2769 return FAIL;
2770 #endif
2771 tagp->tagname_end = p;
2773 /* Isolate file name, from first to second white space */
2774 #ifdef FEAT_TAG_ANYWHITE
2775 p = skipwhite(p);
2776 #else
2777 if (*p != NUL)
2778 ++p;
2779 #endif
2780 tagp->fname = p;
2781 #ifdef FEAT_TAG_ANYWHITE
2782 p = skiptowhite(p);
2783 #else
2784 p = vim_strchr(p, TAB);
2785 if (p == NULL)
2786 return FAIL;
2787 #endif
2788 tagp->fname_end = p;
2790 /* find start of search command, after second white space */
2791 #ifdef FEAT_TAG_ANYWHITE
2792 p = skipwhite(p);
2793 #else
2794 if (*p != NUL)
2795 ++p;
2796 #endif
2797 if (*p == NUL)
2798 return FAIL;
2799 tagp->command = p;
2800 #ifdef FEAT_EMACS_TAGS
2802 #endif
2804 return OK;
2808 * Check if tagname is a static tag
2810 * Static tags produced by the older ctags program have the format:
2811 * 'file:tag file /pattern'.
2812 * This is only recognized when both occurrence of 'file' are the same, to
2813 * avoid recognizing "string::string" or ":exit".
2815 * Static tags produced by the new ctags program have the format:
2816 * 'tag file /pattern/;"<Tab>file:' "
2818 * Return TRUE if it is a static tag and adjust *tagname to the real tag.
2819 * Return FALSE if it is not a static tag.
2821 static int
2822 test_for_static(tagp)
2823 tagptrs_T *tagp;
2825 char_u *p;
2827 #ifdef FEAT_TAG_OLDSTATIC
2828 int len;
2831 * Check for old style static tag: "file:tag file .."
2833 len = (int)(tagp->fname_end - tagp->fname);
2834 p = tagp->tagname + len;
2835 if ( p < tagp->tagname_end
2836 && *p == ':'
2837 && fnamencmp(tagp->tagname, tagp->fname, len) == 0)
2839 tagp->tagname = p + 1;
2840 return TRUE;
2842 #endif
2845 * Check for new style static tag ":...<Tab>file:[<Tab>...]"
2847 p = tagp->command;
2848 while ((p = vim_strchr(p, '\t')) != NULL)
2850 ++p;
2851 if (STRNCMP(p, "file:", 5) == 0)
2852 return TRUE;
2855 return FALSE;
2859 * Parse a line from a matching tag. Does not change the line itself.
2861 * The line that we get looks like this:
2862 * Emacs tag: <mtt><tag_fname><NUL><ebuf><NUL><lbuf>
2863 * other tag: <mtt><tag_fname><NUL><NUL><lbuf>
2864 * without Emacs tags: <mtt><tag_fname><NUL><lbuf>
2866 * Return OK or FAIL.
2868 static int
2869 parse_match(lbuf, tagp)
2870 char_u *lbuf; /* input: matching line */
2871 tagptrs_T *tagp; /* output: pointers into the line */
2873 int retval;
2874 char_u *p;
2875 char_u *pc, *pt;
2877 tagp->tag_fname = lbuf + 1;
2878 lbuf += STRLEN(tagp->tag_fname) + 2;
2879 #ifdef FEAT_EMACS_TAGS
2880 if (*lbuf)
2882 tagp->is_etag = TRUE;
2883 tagp->fname = lbuf;
2884 lbuf += STRLEN(lbuf);
2885 tagp->fname_end = lbuf++;
2887 else
2889 tagp->is_etag = FALSE;
2890 ++lbuf;
2892 #endif
2894 /* Find search pattern and the file name for non-etags. */
2895 retval = parse_tag_line(lbuf,
2896 #ifdef FEAT_EMACS_TAGS
2897 tagp->is_etag,
2898 #endif
2899 tagp);
2901 tagp->tagkind = NULL;
2902 tagp->command_end = NULL;
2904 if (retval == OK)
2906 /* Try to find a kind field: "kind:<kind>" or just "<kind>"*/
2907 p = tagp->command;
2908 if (find_extra(&p) == OK)
2910 tagp->command_end = p;
2911 p += 2; /* skip ";\"" */
2912 if (*p++ == TAB)
2913 while (ASCII_ISALPHA(*p))
2915 if (STRNCMP(p, "kind:", 5) == 0)
2917 tagp->tagkind = p + 5;
2918 break;
2920 pc = vim_strchr(p, ':');
2921 pt = vim_strchr(p, '\t');
2922 if (pc == NULL || (pt != NULL && pc > pt))
2924 tagp->tagkind = p;
2925 break;
2927 if (pt == NULL)
2928 break;
2929 p = pt + 1;
2932 if (tagp->tagkind != NULL)
2934 for (p = tagp->tagkind;
2935 *p && *p != '\t' && *p != '\r' && *p != '\n'; ++p)
2937 tagp->tagkind_end = p;
2940 return retval;
2944 * Find out the actual file name of a tag. Concatenate the tags file name
2945 * with the matching tag file name.
2946 * Returns an allocated string or NULL (out of memory).
2948 static char_u *
2949 tag_full_fname(tagp)
2950 tagptrs_T *tagp;
2952 char_u *fullname;
2953 int c;
2955 #ifdef FEAT_EMACS_TAGS
2956 if (tagp->is_etag)
2957 c = 0; /* to shut up GCC */
2958 else
2959 #endif
2961 c = *tagp->fname_end;
2962 *tagp->fname_end = NUL;
2964 fullname = expand_tag_fname(tagp->fname, tagp->tag_fname, FALSE);
2966 #ifdef FEAT_EMACS_TAGS
2967 if (!tagp->is_etag)
2968 #endif
2969 *tagp->fname_end = c;
2971 return fullname;
2975 * Jump to a tag that has been found in one of the tag files
2977 * returns OK for success, NOTAGFILE when file not found, FAIL otherwise.
2979 static int
2980 jumpto_tag(lbuf, forceit, keep_help)
2981 char_u *lbuf; /* line from the tags file for this tag */
2982 int forceit; /* :ta with ! */
2983 int keep_help; /* keep help flag (FALSE for cscope) */
2985 int save_secure;
2986 int save_magic;
2987 int save_p_ws, save_p_scs, save_p_ic;
2988 linenr_T save_lnum;
2989 int csave = 0;
2990 char_u *str;
2991 char_u *pbuf; /* search pattern buffer */
2992 char_u *pbuf_end;
2993 char_u *tofree_fname = NULL;
2994 char_u *fname;
2995 tagptrs_T tagp;
2996 int retval = FAIL;
2997 int getfile_result;
2998 int search_options;
2999 #ifdef FEAT_SEARCH_EXTRA
3000 int save_no_hlsearch;
3001 #endif
3002 #if defined(FEAT_WINDOWS) && defined(FEAT_QUICKFIX)
3003 win_T *curwin_save = NULL;
3004 #endif
3005 char_u *full_fname = NULL;
3006 #ifdef FEAT_FOLDING
3007 int old_KeyTyped = KeyTyped; /* getting the file may reset it */
3008 #endif
3010 pbuf = alloc(LSIZE);
3012 /* parse the match line into the tagp structure */
3013 if (pbuf == NULL || parse_match(lbuf, &tagp) == FAIL)
3015 tagp.fname_end = NULL;
3016 goto erret;
3019 /* truncate the file name, so it can be used as a string */
3020 csave = *tagp.fname_end;
3021 *tagp.fname_end = NUL;
3022 fname = tagp.fname;
3024 /* copy the command to pbuf[], remove trailing CR/NL */
3025 str = tagp.command;
3026 for (pbuf_end = pbuf; *str && *str != '\n' && *str != '\r'; )
3028 #ifdef FEAT_EMACS_TAGS
3029 if (tagp.is_etag && *str == ',')/* stop at ',' after line number */
3030 break;
3031 #endif
3032 *pbuf_end++ = *str++;
3034 *pbuf_end = NUL;
3036 #ifdef FEAT_EMACS_TAGS
3037 if (!tagp.is_etag)
3038 #endif
3041 * Remove the "<Tab>fieldname:value" stuff; we don't need it here.
3043 str = pbuf;
3044 if (find_extra(&str) == OK)
3046 pbuf_end = str;
3047 *pbuf_end = NUL;
3052 * Expand file name, when needed (for environment variables).
3053 * If 'tagrelative' option set, may change file name.
3055 fname = expand_tag_fname(fname, tagp.tag_fname, TRUE);
3056 if (fname == NULL)
3057 goto erret;
3058 tofree_fname = fname; /* free() it later */
3061 * Check if the file with the tag exists before abandoning the current
3062 * file. Also accept a file name for which there is a matching BufReadCmd
3063 * autocommand event (e.g., http://sys/file).
3065 if (mch_getperm(fname) < 0
3066 #ifdef FEAT_AUTOCMD
3067 && !has_autocmd(EVENT_BUFREADCMD, fname, NULL)
3068 #endif
3071 retval = NOTAGFILE;
3072 vim_free(nofile_fname);
3073 nofile_fname = vim_strsave(fname);
3074 if (nofile_fname == NULL)
3075 nofile_fname = empty_option;
3076 goto erret;
3079 ++RedrawingDisabled;
3081 #ifdef FEAT_GUI
3082 need_mouse_correct = TRUE;
3083 #endif
3085 #if defined(FEAT_WINDOWS) && defined(FEAT_QUICKFIX)
3086 if (g_do_tagpreview)
3088 postponed_split = 0; /* don't split again below */
3089 curwin_save = curwin; /* Save current window */
3092 * If we are reusing a window, we may change dir when
3093 * entering it (autocommands) so turn the tag filename
3094 * into a fullpath
3096 if (!curwin->w_p_pvw)
3098 full_fname = FullName_save(fname, FALSE);
3099 fname = full_fname;
3102 * Make the preview window the current window.
3103 * Open a preview window when needed.
3105 prepare_tagpreview(TRUE);
3109 /* If it was a CTRL-W CTRL-] command split window now. For ":tab tag"
3110 * open a new tab page. */
3111 if (postponed_split || cmdmod.tab != 0)
3113 win_split(postponed_split > 0 ? postponed_split : 0,
3114 postponed_split_flags);
3115 # ifdef FEAT_SCROLLBIND
3116 curwin->w_p_scb = FALSE;
3117 # endif
3119 #endif
3121 if (keep_help)
3123 /* A :ta from a help file will keep the b_help flag set. For ":ptag"
3124 * we need to use the flag from the window where we came from. */
3125 #if defined(FEAT_WINDOWS) && defined(FEAT_QUICKFIX)
3126 if (g_do_tagpreview)
3127 keep_help_flag = curwin_save->w_buffer->b_help;
3128 else
3129 #endif
3130 keep_help_flag = curbuf->b_help;
3132 getfile_result = getfile(0, fname, NULL, TRUE, (linenr_T)0, forceit);
3133 keep_help_flag = FALSE;
3135 if (getfile_result <= 0) /* got to the right file */
3137 curwin->w_set_curswant = TRUE;
3138 #ifdef FEAT_WINDOWS
3139 postponed_split = 0;
3140 #endif
3142 save_secure = secure;
3143 secure = 1;
3144 #ifdef HAVE_SANDBOX
3145 ++sandbox;
3146 #endif
3147 save_magic = p_magic;
3148 p_magic = FALSE; /* always execute with 'nomagic' */
3149 #ifdef FEAT_SEARCH_EXTRA
3150 /* Save value of no_hlsearch, jumping to a tag is not a real search */
3151 save_no_hlsearch = no_hlsearch;
3152 #endif
3155 * If 'cpoptions' contains 't', store the search pattern for the "n"
3156 * command. If 'cpoptions' does not contain 't', the search pattern
3157 * is not stored.
3159 if (vim_strchr(p_cpo, CPO_TAGPAT) != NULL)
3160 search_options = 0;
3161 else
3162 search_options = SEARCH_KEEP;
3165 * If the command is a search, try here.
3167 * Reset 'smartcase' for the search, since the search pattern was not
3168 * typed by the user.
3169 * Only use do_search() when there is a full search command, without
3170 * anything following.
3172 str = pbuf;
3173 if (pbuf[0] == '/' || pbuf[0] == '?')
3174 str = skip_regexp(pbuf + 1, pbuf[0], FALSE, NULL) + 1;
3175 if (str > pbuf_end - 1) /* search command with nothing following */
3177 save_p_ws = p_ws;
3178 save_p_ic = p_ic;
3179 save_p_scs = p_scs;
3180 p_ws = TRUE; /* need 'wrapscan' for backward searches */
3181 p_ic = FALSE; /* don't ignore case now */
3182 p_scs = FALSE;
3183 #if 0 /* disabled for now */
3184 #ifdef FEAT_CMDHIST
3185 /* put pattern in search history */
3186 add_to_history(HIST_SEARCH, pbuf + 1, TRUE, pbuf[0]);
3187 #endif
3188 #endif
3189 save_lnum = curwin->w_cursor.lnum;
3190 curwin->w_cursor.lnum = 0; /* start search before first line */
3191 if (do_search(NULL, pbuf[0], pbuf + 1, (long)1,
3192 search_options, NULL))
3193 retval = OK;
3194 else
3196 int found = 1;
3197 int cc;
3200 * try again, ignore case now
3202 p_ic = TRUE;
3203 if (!do_search(NULL, pbuf[0], pbuf + 1, (long)1,
3204 search_options, NULL))
3207 * Failed to find pattern, take a guess: "^func ("
3209 found = 2;
3210 (void)test_for_static(&tagp);
3211 cc = *tagp.tagname_end;
3212 *tagp.tagname_end = NUL;
3213 sprintf((char *)pbuf, "^%s\\s\\*(", tagp.tagname);
3214 if (!do_search(NULL, '/', pbuf, (long)1,
3215 search_options, NULL))
3217 /* Guess again: "^char * \<func (" */
3218 sprintf((char *)pbuf, "^\\[#a-zA-Z_]\\.\\*\\<%s\\s\\*(",
3219 tagp.tagname);
3220 if (!do_search(NULL, '/', pbuf, (long)1,
3221 search_options, NULL))
3222 found = 0;
3224 *tagp.tagname_end = cc;
3226 if (found == 0)
3228 EMSG(_("E434: Can't find tag pattern"));
3229 curwin->w_cursor.lnum = save_lnum;
3231 else
3234 * Only give a message when really guessed, not when 'ic'
3235 * is set and match found while ignoring case.
3237 if (found == 2 || !save_p_ic)
3239 MSG(_("E435: Couldn't find tag, just guessing!"));
3240 if (!msg_scrolled && msg_silent == 0)
3242 out_flush();
3243 ui_delay(1000L, TRUE);
3246 retval = OK;
3249 p_ws = save_p_ws;
3250 p_ic = save_p_ic;
3251 p_scs = save_p_scs;
3253 /* A search command may have positioned the cursor beyond the end
3254 * of the line. May need to correct that here. */
3255 check_cursor();
3257 else
3259 curwin->w_cursor.lnum = 1; /* start command in line 1 */
3260 do_cmdline_cmd(pbuf);
3261 retval = OK;
3265 * When the command has done something that is not allowed make sure
3266 * the error message can be seen.
3268 if (secure == 2)
3269 wait_return(TRUE);
3270 secure = save_secure;
3271 p_magic = save_magic;
3272 #ifdef HAVE_SANDBOX
3273 --sandbox;
3274 #endif
3275 #ifdef FEAT_SEARCH_EXTRA
3276 /* restore no_hlsearch when keeping the old search pattern */
3277 if (search_options)
3278 no_hlsearch = save_no_hlsearch;
3279 #endif
3281 /* Return OK if jumped to another file (at least we found the file!). */
3282 if (getfile_result == -1)
3283 retval = OK;
3285 if (retval == OK)
3288 * For a help buffer: Put the cursor line at the top of the window,
3289 * the help subject will be below it.
3291 if (curbuf->b_help)
3292 set_topline(curwin, curwin->w_cursor.lnum);
3293 #ifdef FEAT_FOLDING
3294 if ((fdo_flags & FDO_TAG) && old_KeyTyped)
3295 foldOpenCursor();
3296 #endif
3299 #if defined(FEAT_WINDOWS) && defined(FEAT_QUICKFIX)
3300 if (g_do_tagpreview && curwin != curwin_save && win_valid(curwin_save))
3302 /* Return cursor to where we were */
3303 validate_cursor();
3304 redraw_later(VALID);
3305 win_enter(curwin_save, TRUE);
3307 #endif
3309 --RedrawingDisabled;
3311 else
3313 --RedrawingDisabled;
3314 #ifdef FEAT_WINDOWS
3315 if (postponed_split) /* close the window */
3317 win_close(curwin, FALSE);
3318 postponed_split = 0;
3320 #endif
3323 erret:
3324 #if defined(FEAT_WINDOWS) && defined(FEAT_QUICKFIX)
3325 g_do_tagpreview = 0; /* For next time */
3326 #endif
3327 if (tagp.fname_end != NULL)
3328 *tagp.fname_end = csave;
3329 vim_free(pbuf);
3330 vim_free(tofree_fname);
3331 vim_free(full_fname);
3333 return retval;
3337 * If "expand" is TRUE, expand wildcards in fname.
3338 * If 'tagrelative' option set, change fname (name of file containing tag)
3339 * according to tag_fname (name of tag file containing fname).
3340 * Returns a pointer to allocated memory (or NULL when out of memory).
3342 static char_u *
3343 expand_tag_fname(fname, tag_fname, expand)
3344 char_u *fname;
3345 char_u *tag_fname;
3346 int expand;
3348 char_u *p;
3349 char_u *retval;
3350 char_u *expanded_fname = NULL;
3351 expand_T xpc;
3354 * Expand file name (for environment variables) when needed.
3356 if (expand && mch_has_wildcard(fname))
3358 ExpandInit(&xpc);
3359 xpc.xp_context = EXPAND_FILES;
3360 expanded_fname = ExpandOne(&xpc, (char_u *)fname, NULL,
3361 WILD_LIST_NOTFOUND|WILD_SILENT, WILD_EXPAND_FREE);
3362 if (expanded_fname != NULL)
3363 fname = expanded_fname;
3366 if ((p_tr || curbuf->b_help)
3367 && !vim_isAbsName(fname)
3368 && (p = gettail(tag_fname)) != tag_fname)
3370 retval = alloc(MAXPATHL);
3371 if (retval != NULL)
3373 STRCPY(retval, tag_fname);
3374 vim_strncpy(retval + (p - tag_fname), fname,
3375 MAXPATHL - (p - tag_fname) - 1);
3377 * Translate names like "src/a/../b/file.c" into "src/b/file.c".
3379 simplify_filename(retval);
3382 else
3383 retval = vim_strsave(fname);
3385 vim_free(expanded_fname);
3387 return retval;
3391 * Converts a file name into a canonical form. It simplifies a file name into
3392 * its simplest form by stripping out unneeded components, if any. The
3393 * resulting file name is simplified in place and will either be the same
3394 * length as that supplied, or shorter.
3396 void
3397 simplify_filename(filename)
3398 char_u *filename;
3400 #ifndef AMIGA /* Amiga doesn't have "..", it uses "/" */
3401 int components = 0;
3402 char_u *p, *tail, *start;
3403 int stripping_disabled = FALSE;
3404 int relative = TRUE;
3406 p = filename;
3407 #ifdef BACKSLASH_IN_FILENAME
3408 if (p[1] == ':') /* skip "x:" */
3409 p += 2;
3410 #endif
3412 if (vim_ispathsep(*p))
3414 relative = FALSE;
3416 ++p;
3417 while (vim_ispathsep(*p));
3419 start = p; /* remember start after "c:/" or "/" or "///" */
3423 /* At this point "p" is pointing to the char following a single "/"
3424 * or "p" is at the "start" of the (absolute or relative) path name. */
3425 #ifdef VMS
3426 /* VMS allows device:[path] - don't strip the [ in directory */
3427 if ((*p == '[' || *p == '<') && p > filename && p[-1] == ':')
3429 /* :[ or :< composition: vms directory component */
3430 ++components;
3431 p = getnextcomp(p + 1);
3433 /* allow remote calls as host"user passwd"::device:[path] */
3434 else if (p[0] == ':' && p[1] == ':' && p > filename && p[-1] == '"' )
3436 /* ":: composition: vms host/passwd component */
3437 ++components;
3438 p = getnextcomp(p + 2);
3440 else
3441 #endif
3442 if (vim_ispathsep(*p))
3443 STRMOVE(p, p + 1); /* remove duplicate "/" */
3444 else if (p[0] == '.' && (vim_ispathsep(p[1]) || p[1] == NUL))
3446 if (p == start && relative)
3447 p += 1 + (p[1] != NUL); /* keep single "." or leading "./" */
3448 else
3450 /* Strip "./" or ".///". If we are at the end of the file name
3451 * and there is no trailing path separator, either strip "/." if
3452 * we are after "start", or strip "." if we are at the beginning
3453 * of an absolute path name . */
3454 tail = p + 1;
3455 if (p[1] != NUL)
3456 while (vim_ispathsep(*tail))
3457 mb_ptr_adv(tail);
3458 else if (p > start)
3459 --p; /* strip preceding path separator */
3460 STRMOVE(p, tail);
3463 else if (p[0] == '.' && p[1] == '.' &&
3464 (vim_ispathsep(p[2]) || p[2] == NUL))
3466 /* Skip to after ".." or "../" or "..///". */
3467 tail = p + 2;
3468 while (vim_ispathsep(*tail))
3469 mb_ptr_adv(tail);
3471 if (components > 0) /* strip one preceding component */
3473 int do_strip = FALSE;
3474 char_u saved_char;
3475 struct stat st;
3477 /* Don't strip for an erroneous file name. */
3478 if (!stripping_disabled)
3480 /* If the preceding component does not exist in the file
3481 * system, we strip it. On Unix, we don't accept a symbolic
3482 * link that refers to a non-existent file. */
3483 saved_char = p[-1];
3484 p[-1] = NUL;
3485 #ifdef UNIX
3486 if (mch_lstat((char *)filename, &st) < 0)
3487 #else
3488 if (mch_stat((char *)filename, &st) < 0)
3489 #endif
3490 do_strip = TRUE;
3491 p[-1] = saved_char;
3493 --p;
3494 /* Skip back to after previous '/'. */
3495 while (p > start && !after_pathsep(start, p))
3496 mb_ptr_back(start, p);
3498 if (!do_strip)
3500 /* If the component exists in the file system, check
3501 * that stripping it won't change the meaning of the
3502 * file name. First get information about the
3503 * unstripped file name. This may fail if the component
3504 * to strip is not a searchable directory (but a regular
3505 * file, for instance), since the trailing "/.." cannot
3506 * be applied then. We don't strip it then since we
3507 * don't want to replace an erroneous file name by
3508 * a valid one, and we disable stripping of later
3509 * components. */
3510 saved_char = *tail;
3511 *tail = NUL;
3512 if (mch_stat((char *)filename, &st) >= 0)
3513 do_strip = TRUE;
3514 else
3515 stripping_disabled = TRUE;
3516 *tail = saved_char;
3517 #ifdef UNIX
3518 if (do_strip)
3520 struct stat new_st;
3522 /* On Unix, the check for the unstripped file name
3523 * above works also for a symbolic link pointing to
3524 * a searchable directory. But then the parent of
3525 * the directory pointed to by the link must be the
3526 * same as the stripped file name. (The latter
3527 * exists in the file system since it is the
3528 * component's parent directory.) */
3529 if (p == start && relative)
3530 (void)mch_stat(".", &new_st);
3531 else
3533 saved_char = *p;
3534 *p = NUL;
3535 (void)mch_stat((char *)filename, &new_st);
3536 *p = saved_char;
3539 if (new_st.st_ino != st.st_ino ||
3540 new_st.st_dev != st.st_dev)
3542 do_strip = FALSE;
3543 /* We don't disable stripping of later
3544 * components since the unstripped path name is
3545 * still valid. */
3548 #endif
3552 if (!do_strip)
3554 /* Skip the ".." or "../" and reset the counter for the
3555 * components that might be stripped later on. */
3556 p = tail;
3557 components = 0;
3559 else
3561 /* Strip previous component. If the result would get empty
3562 * and there is no trailing path separator, leave a single
3563 * "." instead. If we are at the end of the file name and
3564 * there is no trailing path separator and a preceding
3565 * component is left after stripping, strip its trailing
3566 * path separator as well. */
3567 if (p == start && relative && tail[-1] == '.')
3569 *p++ = '.';
3570 *p = NUL;
3572 else
3574 if (p > start && tail[-1] == '.')
3575 --p;
3576 STRMOVE(p, tail); /* strip previous component */
3579 --components;
3582 else if (p == start && !relative) /* leading "/.." or "/../" */
3583 STRMOVE(p, tail); /* strip ".." or "../" */
3584 else
3586 if (p == start + 2 && p[-2] == '.') /* leading "./../" */
3588 STRMOVE(p - 2, p); /* strip leading "./" */
3589 tail -= 2;
3591 p = tail; /* skip to char after ".." or "../" */
3594 else
3596 ++components; /* simple path component */
3597 p = getnextcomp(p);
3599 } while (*p != NUL);
3600 #endif /* !AMIGA */
3604 * Check if we have a tag for the buffer with name "buf_ffname".
3605 * This is a bit slow, because of the full path compare in fullpathcmp().
3606 * Return TRUE if tag for file "fname" if tag file "tag_fname" is for current
3607 * file.
3609 static int
3610 #ifdef FEAT_EMACS_TAGS
3611 test_for_current(is_etag, fname, fname_end, tag_fname, buf_ffname)
3612 int is_etag;
3613 #else
3614 test_for_current(fname, fname_end, tag_fname, buf_ffname)
3615 #endif
3616 char_u *fname;
3617 char_u *fname_end;
3618 char_u *tag_fname;
3619 char_u *buf_ffname;
3621 int c;
3622 int retval = FALSE;
3623 char_u *fullname;
3625 if (buf_ffname != NULL) /* if the buffer has a name */
3627 #ifdef FEAT_EMACS_TAGS
3628 if (is_etag)
3629 c = 0; /* to shut up GCC */
3630 else
3631 #endif
3633 c = *fname_end;
3634 *fname_end = NUL;
3636 fullname = expand_tag_fname(fname, tag_fname, TRUE);
3637 if (fullname != NULL)
3639 retval = (fullpathcmp(fullname, buf_ffname, TRUE) & FPC_SAME);
3640 vim_free(fullname);
3642 #ifdef FEAT_EMACS_TAGS
3643 if (!is_etag)
3644 #endif
3645 *fname_end = c;
3648 return retval;
3652 * Find the end of the tagaddress.
3653 * Return OK if ";\"" is following, FAIL otherwise.
3655 static int
3656 find_extra(pp)
3657 char_u **pp;
3659 char_u *str = *pp;
3661 /* Repeat for addresses separated with ';' */
3662 for (;;)
3664 if (VIM_ISDIGIT(*str))
3665 str = skipdigits(str);
3666 else if (*str == '/' || *str == '?')
3668 str = skip_regexp(str + 1, *str, FALSE, NULL);
3669 if (*str != **pp)
3670 str = NULL;
3671 else
3672 ++str;
3674 else
3675 str = NULL;
3676 if (str == NULL || *str != ';'
3677 || !(VIM_ISDIGIT(str[1]) || str[1] == '/' || str[1] == '?'))
3678 break;
3679 ++str; /* skip ';' */
3682 if (str != NULL && STRNCMP(str, ";\"", 2) == 0)
3684 *pp = str;
3685 return OK;
3687 return FAIL;
3690 #if defined(FEAT_CMDL_COMPL) || defined(PROTO)
3692 expand_tags(tagnames, pat, num_file, file)
3693 int tagnames; /* expand tag names */
3694 char_u *pat;
3695 int *num_file;
3696 char_u ***file;
3698 int i;
3699 int c;
3700 int tagnmflag;
3701 char_u tagnm[100];
3702 tagptrs_T t_p;
3703 int ret;
3705 if (tagnames)
3706 tagnmflag = TAG_NAMES;
3707 else
3708 tagnmflag = 0;
3709 if (pat[0] == '/')
3710 ret = find_tags(pat + 1, num_file, file,
3711 TAG_REGEXP | tagnmflag | TAG_VERBOSE,
3712 TAG_MANY, curbuf->b_ffname);
3713 else
3714 ret = find_tags(pat, num_file, file,
3715 TAG_REGEXP | tagnmflag | TAG_VERBOSE | TAG_NOIC,
3716 TAG_MANY, curbuf->b_ffname);
3717 if (ret == OK && !tagnames)
3719 /* Reorganize the tags for display and matching as strings of:
3720 * "<tagname>\0<kind>\0<filename>\0"
3722 for (i = 0; i < *num_file; i++)
3724 parse_match((*file)[i], &t_p);
3725 c = (int)(t_p.tagname_end - t_p.tagname);
3726 mch_memmove(tagnm, t_p.tagname, (size_t)c);
3727 tagnm[c++] = 0;
3728 tagnm[c++] = (t_p.tagkind != NULL && *t_p.tagkind)
3729 ? *t_p.tagkind : 'f';
3730 tagnm[c++] = 0;
3731 mch_memmove((*file)[i] + c, t_p.fname, t_p.fname_end - t_p.fname);
3732 (*file)[i][c + (t_p.fname_end - t_p.fname)] = 0;
3733 mch_memmove((*file)[i], tagnm, (size_t)c);
3736 return ret;
3738 #endif
3740 #if defined(FEAT_EVAL) || defined(PROTO)
3741 static int add_tag_field __ARGS((dict_T *dict, char *field_name, char_u *start, char_u *end));
3744 * Add a tag field to the dictionary "dict"
3746 static int
3747 add_tag_field(dict, field_name, start, end)
3748 dict_T *dict;
3749 char *field_name;
3750 char_u *start; /* start of the value */
3751 char_u *end; /* after the value; can be NULL */
3753 char_u buf[MAXPATHL];
3754 int len = 0;
3756 if (start != NULL)
3758 if (end == NULL)
3760 end = start + STRLEN(start);
3761 while (end > start && (end[-1] == '\r' || end[-1] == '\n'))
3762 --end;
3764 len = (int)(end - start);
3765 if (len > sizeof(buf) - 1)
3766 len = sizeof(buf) - 1;
3767 vim_strncpy(buf, start, len);
3769 buf[len] = NUL;
3770 return dict_add_nr_str(dict, field_name, 0L, buf);
3774 * Add the tags matching the specified pattern to the list "list"
3775 * as a dictionary
3778 get_tags(list, pat)
3779 list_T *list;
3780 char_u *pat;
3782 int num_matches, i, ret;
3783 char_u **matches, *p;
3784 char_u *full_fname;
3785 dict_T *dict;
3786 tagptrs_T tp;
3787 long is_static;
3789 ret = find_tags(pat, &num_matches, &matches,
3790 TAG_REGEXP | TAG_NOIC, (int)MAXCOL, NULL);
3791 if (ret == OK && num_matches > 0)
3793 for (i = 0; i < num_matches; ++i)
3795 parse_match(matches[i], &tp);
3796 is_static = test_for_static(&tp);
3798 /* Skip pseudo-tag lines. */
3799 if (STRNCMP(tp.tagname, "!_TAG_", 6) == 0)
3800 continue;
3802 if ((dict = dict_alloc()) == NULL)
3803 ret = FAIL;
3804 if (list_append_dict(list, dict) == FAIL)
3805 ret = FAIL;
3807 full_fname = tag_full_fname(&tp);
3808 if (add_tag_field(dict, "name", tp.tagname, tp.tagname_end) == FAIL
3809 || add_tag_field(dict, "filename", full_fname,
3810 NULL) == FAIL
3811 || add_tag_field(dict, "cmd", tp.command,
3812 tp.command_end) == FAIL
3813 || add_tag_field(dict, "kind", tp.tagkind,
3814 tp.tagkind_end) == FAIL
3815 || dict_add_nr_str(dict, "static", is_static, NULL) == FAIL)
3816 ret = FAIL;
3818 vim_free(full_fname);
3820 if (tp.command_end != NULL)
3822 for (p = tp.command_end + 3;
3823 *p != NUL && *p != '\n' && *p != '\r'; ++p)
3825 if (p == tp.tagkind || (p + 5 == tp.tagkind
3826 && STRNCMP(p, "kind:", 5) == 0))
3827 /* skip "kind:<kind>" and "<kind>" */
3828 p = tp.tagkind_end - 1;
3829 else if (STRNCMP(p, "file:", 5) == 0)
3830 /* skip "file:" (static tag) */
3831 p += 4;
3832 else if (!vim_iswhite(*p))
3834 char_u *s, *n;
3835 int len;
3837 /* Add extra field as a dict entry. Fields are
3838 * separated by Tabs. */
3839 n = p;
3840 while (*p != NUL && *p >= ' ' && *p < 127 && *p != ':')
3841 ++p;
3842 len = (int)(p - n);
3843 if (*p == ':' && len > 0)
3845 s = ++p;
3846 while (*p != NUL && *p >= ' ')
3847 ++p;
3848 n[len] = NUL;
3849 if (add_tag_field(dict, (char *)n, s, p) == FAIL)
3850 ret = FAIL;
3851 n[len] = ':';
3853 else
3854 /* Skip field without colon. */
3855 while (*p != NUL && *p >= ' ')
3856 ++p;
3861 vim_free(matches[i]);
3863 vim_free(matches);
3865 return ret;
3867 #endif