Merged from the latest developing branch.
[MacVim.git] / src / tag.c
blobd46239ca1afa7b099696bd73ebcc6fb2a9b451c3
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"
20 #ifdef HAVE_FCNTL_H
21 # include <fcntl.h> /* for lseek() */
22 #endif
25 * Structure to hold pointers to various items in a tag line.
27 typedef struct tag_pointers
29 /* filled in by parse_tag_line(): */
30 char_u *tagname; /* start of tag name (skip "file:") */
31 char_u *tagname_end; /* char after tag name */
32 char_u *fname; /* first char of file name */
33 char_u *fname_end; /* char after file name */
34 char_u *command; /* first char of command */
35 /* filled in by parse_match(): */
36 char_u *command_end; /* first char after command */
37 char_u *tag_fname; /* file name of the tags file */
38 #ifdef FEAT_EMACS_TAGS
39 int is_etag; /* TRUE for emacs tag */
40 #endif
41 char_u *tagkind; /* "kind:" value */
42 char_u *tagkind_end; /* end of tagkind */
43 } tagptrs_T;
46 * The matching tags are first stored in ga_match[]. In which one depends on
47 * the priority of the match.
48 * At the end, the matches from ga_match[] are concatenated, to make a list
49 * sorted on priority.
51 #define MT_ST_CUR 0 /* static match in current file */
52 #define MT_GL_CUR 1 /* global match in current file */
53 #define MT_GL_OTH 2 /* global match in other file */
54 #define MT_ST_OTH 3 /* static match in other file */
55 #define MT_IC_ST_CUR 4 /* icase static match in current file */
56 #define MT_IC_GL_CUR 5 /* icase global match in current file */
57 #define MT_IC_GL_OTH 6 /* icase global match in other file */
58 #define MT_IC_ST_OTH 7 /* icase static match in other file */
59 #define MT_IC_OFF 4 /* add for icase match */
60 #define MT_RE_OFF 8 /* add for regexp match */
61 #define MT_MASK 7 /* mask for printing priority */
62 #define MT_COUNT 16
64 static char *mt_names[MT_COUNT/2] =
65 {"FSC", "F C", "F ", "FS ", " SC", " C", " ", " S "};
67 #define NOTAGFILE 99 /* return value for jumpto_tag */
68 static char_u *nofile_fname = NULL; /* fname for NOTAGFILE error */
70 static void taglen_advance __ARGS((int l));
72 static int jumpto_tag __ARGS((char_u *lbuf, int forceit, int keep_help));
73 #ifdef FEAT_EMACS_TAGS
74 static int parse_tag_line __ARGS((char_u *lbuf, int is_etag, tagptrs_T *tagp));
75 #else
76 static int parse_tag_line __ARGS((char_u *lbuf, tagptrs_T *tagp));
77 #endif
78 static int test_for_static __ARGS((tagptrs_T *));
79 static int parse_match __ARGS((char_u *lbuf, tagptrs_T *tagp));
80 static char_u *tag_full_fname __ARGS((tagptrs_T *tagp));
81 static char_u *expand_tag_fname __ARGS((char_u *fname, char_u *tag_fname, int expand));
82 #ifdef FEAT_EMACS_TAGS
83 static int test_for_current __ARGS((int, char_u *, char_u *, char_u *, char_u *));
84 #else
85 static int test_for_current __ARGS((char_u *, char_u *, char_u *, char_u *));
86 #endif
87 static int find_extra __ARGS((char_u **pp));
89 static char_u *bottommsg = (char_u *)N_("E555: at bottom of tag stack");
90 static char_u *topmsg = (char_u *)N_("E556: at top of tag stack");
92 static char_u *tagmatchname = NULL; /* name of last used tag */
95 * We use ftello() here, if available. It returns off_t instead of long,
96 * which helps if long is 32 bit and off_t is 64 bit.
98 #ifdef HAVE_FTELLO
99 # define ftell ftello
100 #endif
102 #if defined(FEAT_WINDOWS) && defined(FEAT_QUICKFIX)
104 * Tag for preview window is remembered separately, to avoid messing up the
105 * normal tagstack.
107 static taggy_T ptag_entry = {NULL};
108 #endif
111 * Jump to tag; handling of tag commands and tag stack
113 * *tag != NUL: ":tag {tag}", jump to new tag, add to tag stack
115 * type == DT_TAG: ":tag [tag]", jump to newer position or same tag again
116 * type == DT_HELP: like DT_TAG, but don't use regexp.
117 * type == DT_POP: ":pop" or CTRL-T, jump to old position
118 * type == DT_NEXT: jump to next match of same tag
119 * type == DT_PREV: jump to previous match of same tag
120 * type == DT_FIRST: jump to first match of same tag
121 * type == DT_LAST: jump to last match of same tag
122 * type == DT_SELECT: ":tselect [tag]", select tag from a list of all matches
123 * type == DT_JUMP: ":tjump [tag]", jump to tag or select tag from a list
124 * type == DT_CSCOPE: use cscope to find the tag
125 * type == DT_LTAG: use location list for displaying tag matches
126 * type == DT_FREE: free cached matches
128 * for cscope, returns TRUE if we jumped to tag or aborted, FALSE otherwise
131 do_tag(tag, type, count, forceit, verbose)
132 char_u *tag; /* tag (pattern) to jump to */
133 int type;
134 int count;
135 int forceit; /* :ta with ! */
136 int verbose; /* print "tag not found" message */
138 taggy_T *tagstack = curwin->w_tagstack;
139 int tagstackidx = curwin->w_tagstackidx;
140 int tagstacklen = curwin->w_tagstacklen;
141 int cur_match = 0;
142 int cur_fnum = curbuf->b_fnum;
143 int oldtagstackidx = tagstackidx;
144 int prevtagstackidx = tagstackidx;
145 int prev_num_matches;
146 int new_tag = FALSE;
147 int other_name;
148 int i, j, k;
149 int idx;
150 int ic;
151 char_u *p;
152 char_u *name;
153 int no_regexp = FALSE;
154 int error_cur_match = 0;
155 char_u *command_end;
156 int save_pos = FALSE;
157 fmark_T saved_fmark;
158 int taglen;
159 #ifdef FEAT_CSCOPE
160 int jumped_to_tag = FALSE;
161 #endif
162 tagptrs_T tagp, tagp2;
163 int new_num_matches;
164 char_u **new_matches;
165 int attr;
166 int use_tagstack;
167 int skip_msg = FALSE;
168 char_u *buf_ffname = curbuf->b_ffname; /* name to use for
169 priority computation */
171 /* remember the matches for the last used tag */
172 static int num_matches = 0;
173 static int max_num_matches = 0; /* limit used for match search */
174 static char_u **matches = NULL;
175 static int flags;
177 #ifdef EXITFREE
178 if (type == DT_FREE)
180 /* remove the list of matches */
181 FreeWild(num_matches, matches);
182 # ifdef FEAT_CSCOPE
183 cs_free_tags();
184 # endif
185 num_matches = 0;
186 return FALSE;
188 #endif
190 if (type == DT_HELP)
192 type = DT_TAG;
193 no_regexp = TRUE;
196 prev_num_matches = num_matches;
197 free_string_option(nofile_fname);
198 nofile_fname = NULL;
200 clearpos(&saved_fmark.mark); /* shutup gcc 4.0 */
201 saved_fmark.fnum = 0;
204 * Don't add a tag to the tagstack if 'tagstack' has been reset.
206 if ((!p_tgst && *tag != NUL))
208 use_tagstack = FALSE;
209 new_tag = TRUE;
211 else
213 #if defined(FEAT_WINDOWS) && defined(FEAT_QUICKFIX)
214 if (g_do_tagpreview)
215 use_tagstack = FALSE;
216 else
217 #endif
218 use_tagstack = TRUE;
220 /* new pattern, add to the tag stack */
221 if (*tag != NUL
222 && (type == DT_TAG || type == DT_SELECT || type == DT_JUMP
223 #ifdef FEAT_QUICKFIX
224 || type == DT_LTAG
225 #endif
226 #ifdef FEAT_CSCOPE
227 || type == DT_CSCOPE
228 #endif
231 #if defined(FEAT_WINDOWS) && defined(FEAT_QUICKFIX)
232 if (g_do_tagpreview)
234 if (ptag_entry.tagname != NULL
235 && STRCMP(ptag_entry.tagname, tag) == 0)
237 /* Jumping to same tag: keep the current match, so that
238 * the CursorHold autocommand example works. */
239 cur_match = ptag_entry.cur_match;
240 cur_fnum = ptag_entry.cur_fnum;
242 else
244 vim_free(ptag_entry.tagname);
245 if ((ptag_entry.tagname = vim_strsave(tag)) == NULL)
246 goto end_do_tag;
249 else
250 #endif
253 * If the last used entry is not at the top, delete all tag
254 * stack entries above it.
256 while (tagstackidx < tagstacklen)
257 vim_free(tagstack[--tagstacklen].tagname);
259 /* if the tagstack is full: remove oldest entry */
260 if (++tagstacklen > TAGSTACKSIZE)
262 tagstacklen = TAGSTACKSIZE;
263 vim_free(tagstack[0].tagname);
264 for (i = 1; i < tagstacklen; ++i)
265 tagstack[i - 1] = tagstack[i];
266 --tagstackidx;
270 * put the tag name in the tag stack
272 if ((tagstack[tagstackidx].tagname = vim_strsave(tag)) == NULL)
274 curwin->w_tagstacklen = tagstacklen - 1;
275 goto end_do_tag;
277 curwin->w_tagstacklen = tagstacklen;
279 save_pos = TRUE; /* save the cursor position below */
282 new_tag = TRUE;
284 else
286 if (
287 #if defined(FEAT_WINDOWS) && defined(FEAT_QUICKFIX)
288 g_do_tagpreview ? ptag_entry.tagname == NULL :
289 #endif
290 tagstacklen == 0)
292 /* empty stack */
293 EMSG(_(e_tagstack));
294 goto end_do_tag;
297 if (type == DT_POP) /* go to older position */
299 #ifdef FEAT_FOLDING
300 int old_KeyTyped = KeyTyped;
301 #endif
302 if ((tagstackidx -= count) < 0)
304 EMSG(_(bottommsg));
305 if (tagstackidx + count == 0)
307 /* We did [num]^T from the bottom of the stack */
308 tagstackidx = 0;
309 goto end_do_tag;
311 /* We weren't at the bottom of the stack, so jump all the
312 * way to the bottom now.
314 tagstackidx = 0;
316 else if (tagstackidx >= tagstacklen) /* count == 0? */
318 EMSG(_(topmsg));
319 goto end_do_tag;
322 /* Make a copy of the fmark, autocommands may invalidate the
323 * tagstack before it's used. */
324 saved_fmark = tagstack[tagstackidx].fmark;
325 if (saved_fmark.fnum != curbuf->b_fnum)
328 * Jump to other file. If this fails (e.g. because the
329 * file was changed) keep original position in tag stack.
331 if (buflist_getfile(saved_fmark.fnum, saved_fmark.mark.lnum,
332 GETF_SETMARK, forceit) == FAIL)
334 tagstackidx = oldtagstackidx; /* back to old posn */
335 goto end_do_tag;
337 /* An BufReadPost autocommand may jump to the '" mark, but
338 * we don't what that here. */
339 curwin->w_cursor.lnum = saved_fmark.mark.lnum;
341 else
343 setpcmark();
344 curwin->w_cursor.lnum = saved_fmark.mark.lnum;
346 curwin->w_cursor.col = saved_fmark.mark.col;
347 curwin->w_set_curswant = TRUE;
348 check_cursor();
349 #ifdef FEAT_FOLDING
350 if ((fdo_flags & FDO_TAG) && old_KeyTyped)
351 foldOpenCursor();
352 #endif
354 /* remove the old list of matches */
355 FreeWild(num_matches, matches);
356 #ifdef FEAT_CSCOPE
357 cs_free_tags();
358 #endif
359 num_matches = 0;
360 tag_freematch();
361 goto end_do_tag;
364 if (type == DT_TAG
365 #if defined(FEAT_QUICKFIX)
366 || type == DT_LTAG
367 #endif
370 #if defined(FEAT_WINDOWS) && defined(FEAT_QUICKFIX)
371 if (g_do_tagpreview)
373 cur_match = ptag_entry.cur_match;
374 cur_fnum = ptag_entry.cur_fnum;
376 else
377 #endif
379 /* ":tag" (no argument): go to newer pattern */
380 save_pos = TRUE; /* save the cursor position below */
381 if ((tagstackidx += count - 1) >= tagstacklen)
384 * Beyond the last one, just give an error message and
385 * go to the last one. Don't store the cursor
386 * position.
388 tagstackidx = tagstacklen - 1;
389 EMSG(_(topmsg));
390 save_pos = FALSE;
392 else if (tagstackidx < 0) /* must have been count == 0 */
394 EMSG(_(bottommsg));
395 tagstackidx = 0;
396 goto end_do_tag;
398 cur_match = tagstack[tagstackidx].cur_match;
399 cur_fnum = tagstack[tagstackidx].cur_fnum;
401 new_tag = TRUE;
403 else /* go to other matching tag */
405 /* Save index for when selection is cancelled. */
406 prevtagstackidx = tagstackidx;
408 #if defined(FEAT_WINDOWS) && defined(FEAT_QUICKFIX)
409 if (g_do_tagpreview)
411 cur_match = ptag_entry.cur_match;
412 cur_fnum = ptag_entry.cur_fnum;
414 else
415 #endif
417 if (--tagstackidx < 0)
418 tagstackidx = 0;
419 cur_match = tagstack[tagstackidx].cur_match;
420 cur_fnum = tagstack[tagstackidx].cur_fnum;
422 switch (type)
424 case DT_FIRST: cur_match = count - 1; break;
425 case DT_SELECT:
426 case DT_JUMP:
427 #ifdef FEAT_CSCOPE
428 case DT_CSCOPE:
429 #endif
430 case DT_LAST: cur_match = MAXCOL - 1; break;
431 case DT_NEXT: cur_match += count; break;
432 case DT_PREV: cur_match -= count; break;
434 if (cur_match >= MAXCOL)
435 cur_match = MAXCOL - 1;
436 else if (cur_match < 0)
438 EMSG(_("E425: Cannot go before first matching tag"));
439 skip_msg = TRUE;
440 cur_match = 0;
441 cur_fnum = curbuf->b_fnum;
446 #if defined(FEAT_WINDOWS) && defined(FEAT_QUICKFIX)
447 if (g_do_tagpreview)
449 if (type != DT_SELECT && type != DT_JUMP)
451 ptag_entry.cur_match = cur_match;
452 ptag_entry.cur_fnum = cur_fnum;
455 else
456 #endif
459 * For ":tag [arg]" or ":tselect" remember position before the jump.
461 saved_fmark = tagstack[tagstackidx].fmark;
462 if (save_pos)
464 tagstack[tagstackidx].fmark.mark = curwin->w_cursor;
465 tagstack[tagstackidx].fmark.fnum = curbuf->b_fnum;
468 /* Curwin will change in the call to jumpto_tag() if ":stag" was
469 * used or an autocommand jumps to another window; store value of
470 * tagstackidx now. */
471 curwin->w_tagstackidx = tagstackidx;
472 if (type != DT_SELECT && type != DT_JUMP)
474 curwin->w_tagstack[tagstackidx].cur_match = cur_match;
475 curwin->w_tagstack[tagstackidx].cur_fnum = cur_fnum;
480 /* When not using the current buffer get the name of buffer "cur_fnum".
481 * Makes sure that the tag order doesn't change when using a remembered
482 * position for "cur_match". */
483 if (cur_fnum != curbuf->b_fnum)
485 buf_T *buf = buflist_findnr(cur_fnum);
487 if (buf != NULL)
488 buf_ffname = buf->b_ffname;
492 * Repeat searching for tags, when a file has not been found.
494 for (;;)
497 * When desired match not found yet, try to find it (and others).
499 if (use_tagstack)
500 name = tagstack[tagstackidx].tagname;
501 #if defined(FEAT_WINDOWS) && defined(FEAT_QUICKFIX)
502 else if (g_do_tagpreview)
503 name = ptag_entry.tagname;
504 #endif
505 else
506 name = tag;
507 other_name = (tagmatchname == NULL || STRCMP(tagmatchname, name) != 0);
508 if (new_tag
509 || (cur_match >= num_matches && max_num_matches != MAXCOL)
510 || other_name)
512 if (other_name)
514 vim_free(tagmatchname);
515 tagmatchname = vim_strsave(name);
519 * If a count is supplied to the ":tag <name>" command, then
520 * jump to count'th matching tag.
522 if (type == DT_TAG && count > 0)
523 cur_match = count - 1;
525 if (type == DT_SELECT || type == DT_JUMP
526 #if defined(FEAT_QUICKFIX)
527 || type == DT_LTAG
528 #endif
530 cur_match = MAXCOL - 1;
531 max_num_matches = cur_match + 1;
533 /* when the argument starts with '/', use it as a regexp */
534 if (!no_regexp && *name == '/')
536 flags = TAG_REGEXP;
537 ++name;
539 else
540 flags = TAG_NOIC;
542 #ifdef FEAT_CSCOPE
543 if (type == DT_CSCOPE)
544 flags = TAG_CSCOPE;
545 #endif
546 if (verbose)
547 flags |= TAG_VERBOSE;
548 if (find_tags(name, &new_num_matches, &new_matches, flags,
549 max_num_matches, buf_ffname) == OK
550 && new_num_matches < max_num_matches)
551 max_num_matches = MAXCOL; /* If less than max_num_matches
552 found: all matches found. */
554 /* If there already were some matches for the same name, move them
555 * to the start. Avoids that the order changes when using
556 * ":tnext" and jumping to another file. */
557 if (!new_tag && !other_name)
559 /* Find the position of each old match in the new list. Need
560 * to use parse_match() to find the tag line. */
561 idx = 0;
562 for (j = 0; j < num_matches; ++j)
564 parse_match(matches[j], &tagp);
565 for (i = idx; i < new_num_matches; ++i)
567 parse_match(new_matches[i], &tagp2);
568 if (STRCMP(tagp.tagname, tagp2.tagname) == 0)
570 p = new_matches[i];
571 for (k = i; k > idx; --k)
572 new_matches[k] = new_matches[k - 1];
573 new_matches[idx++] = p;
574 break;
579 FreeWild(num_matches, matches);
580 num_matches = new_num_matches;
581 matches = new_matches;
584 if (num_matches <= 0)
586 if (verbose)
587 EMSG2(_("E426: tag not found: %s"), name);
588 #if defined(FEAT_WINDOWS) && defined(FEAT_QUICKFIX)
589 g_do_tagpreview = 0;
590 #endif
592 else
594 int ask_for_selection = FALSE;
596 #ifdef FEAT_CSCOPE
597 if (type == DT_CSCOPE && num_matches > 1)
599 cs_print_tags();
600 ask_for_selection = TRUE;
602 else
603 #endif
604 if (type == DT_SELECT || (type == DT_JUMP && num_matches > 1))
607 * List all the matching tags.
608 * Assume that the first match indicates how long the tags can
609 * be, and align the file names to that.
611 parse_match(matches[0], &tagp);
612 taglen = (int)(tagp.tagname_end - tagp.tagname + 2);
613 if (taglen < 18)
614 taglen = 18;
615 if (taglen > Columns - 25)
616 taglen = MAXCOL;
617 if (msg_col == 0)
618 msg_didout = FALSE; /* overwrite previous message */
619 msg_start();
620 MSG_PUTS_ATTR(_(" # pri kind tag"), hl_attr(HLF_T));
621 msg_clr_eos();
622 taglen_advance(taglen);
623 MSG_PUTS_ATTR(_("file\n"), hl_attr(HLF_T));
625 for (i = 0; i < num_matches; ++i)
627 parse_match(matches[i], &tagp);
628 if (!new_tag && (
629 #if defined(FEAT_WINDOWS) && defined(FEAT_QUICKFIX)
630 (g_do_tagpreview
631 && i == ptag_entry.cur_match) ||
632 #endif
633 (use_tagstack
634 && i == tagstack[tagstackidx].cur_match)))
635 *IObuff = '>';
636 else
637 *IObuff = ' ';
638 vim_snprintf((char *)IObuff + 1, IOSIZE - 1,
639 "%2d %s ", i + 1,
640 mt_names[matches[i][0] & MT_MASK]);
641 msg_puts(IObuff);
642 if (tagp.tagkind != NULL)
643 msg_outtrans_len(tagp.tagkind,
644 (int)(tagp.tagkind_end - tagp.tagkind));
645 msg_advance(13);
646 msg_outtrans_len_attr(tagp.tagname,
647 (int)(tagp.tagname_end - tagp.tagname),
648 hl_attr(HLF_T));
649 msg_putchar(' ');
650 taglen_advance(taglen);
652 /* Find out the actual file name. If it is long, truncate
653 * it and put "..." in the middle */
654 p = tag_full_fname(&tagp);
655 if (p != NULL)
657 msg_puts_long_attr(p, hl_attr(HLF_D));
658 vim_free(p);
660 if (msg_col > 0)
661 msg_putchar('\n');
662 msg_advance(15);
664 /* print any extra fields */
665 command_end = tagp.command_end;
666 if (command_end != NULL)
668 p = command_end + 3;
669 while (*p && *p != '\r' && *p != '\n')
671 while (*p == TAB)
672 ++p;
674 /* skip "file:" without a value (static tag) */
675 if (STRNCMP(p, "file:", 5) == 0
676 && vim_isspace(p[5]))
678 p += 5;
679 continue;
681 /* skip "kind:<kind>" and "<kind>" */
682 if (p == tagp.tagkind
683 || (p + 5 == tagp.tagkind
684 && STRNCMP(p, "kind:", 5) == 0))
686 p = tagp.tagkind_end;
687 continue;
689 /* print all other extra fields */
690 attr = hl_attr(HLF_CM);
691 while (*p && *p != '\r' && *p != '\n')
693 if (msg_col + ptr2cells(p) >= Columns)
695 msg_putchar('\n');
696 msg_advance(15);
698 p = msg_outtrans_one(p, attr);
699 if (*p == TAB)
701 msg_puts_attr((char_u *)" ", attr);
702 break;
704 if (*p == ':')
705 attr = 0;
708 if (msg_col > 15)
710 msg_putchar('\n');
711 msg_advance(15);
714 else
716 for (p = tagp.command;
717 *p && *p != '\r' && *p != '\n'; ++p)
719 command_end = p;
723 * Put the info (in several lines) at column 15.
724 * Don't display "/^" and "?^".
726 p = tagp.command;
727 if (*p == '/' || *p == '?')
729 ++p;
730 if (*p == '^')
731 ++p;
733 /* Remove leading whitespace from pattern */
734 while (p != command_end && vim_isspace(*p))
735 ++p;
737 while (p != command_end)
739 if (msg_col + (*p == TAB ? 1 : ptr2cells(p)) > Columns)
740 msg_putchar('\n');
741 msg_advance(15);
743 /* skip backslash used for escaping command char */
744 if (*p == '\\' && *(p + 1) == *tagp.command)
745 ++p;
747 if (*p == TAB)
749 msg_putchar(' ');
750 ++p;
752 else
753 p = msg_outtrans_one(p, 0);
755 /* don't display the "$/;\"" and "$?;\"" */
756 if (p == command_end - 2 && *p == '$'
757 && *(p + 1) == *tagp.command)
758 break;
759 /* don't display matching '/' or '?' */
760 if (p == command_end - 1 && *p == *tagp.command
761 && (*p == '/' || *p == '?'))
762 break;
764 if (msg_col)
765 msg_putchar('\n');
766 ui_breakcheck();
767 if (got_int)
769 got_int = FALSE; /* only stop the listing */
770 break;
773 ask_for_selection = TRUE;
775 #if defined(FEAT_QUICKFIX) && defined(FEAT_EVAL)
776 else if (type == DT_LTAG)
778 list_T *list;
779 char_u tag_name[128 + 1];
780 char_u fname[MAXPATHL + 1];
781 char_u cmd[CMDBUFFSIZE + 1];
784 * Add the matching tags to the location list for the current
785 * window.
788 list = list_alloc();
789 if (list == NULL)
790 goto end_do_tag;
792 for (i = 0; i < num_matches; ++i)
794 int len, cmd_len;
795 long lnum;
796 dict_T *dict;
798 parse_match(matches[i], &tagp);
800 /* Save the tag name */
801 len = (int)(tagp.tagname_end - tagp.tagname);
802 if (len > 128)
803 len = 128;
804 vim_strncpy(tag_name, tagp.tagname, len);
805 tag_name[len] = NUL;
807 /* Save the tag file name */
808 p = tag_full_fname(&tagp);
809 if (p == NULL)
810 continue;
811 STRCPY(fname, p);
812 vim_free(p);
815 * Get the line number or the search pattern used to locate
816 * the tag.
818 lnum = 0;
819 if (isdigit(*tagp.command))
820 /* Line number is used to locate the tag */
821 lnum = atol((char *)tagp.command);
822 else
824 char_u *cmd_start, *cmd_end;
826 /* Search pattern is used to locate the tag */
828 /* Locate the end of the command */
829 cmd_start = tagp.command;
830 cmd_end = tagp.command_end;
831 if (cmd_end == NULL)
833 for (p = tagp.command;
834 *p && *p != '\r' && *p != '\n'; ++p)
836 cmd_end = p;
840 * Now, cmd_end points to the character after the
841 * command. Adjust it to point to the last
842 * character of the command.
844 cmd_end--;
847 * Skip the '/' and '?' characters at the
848 * beginning and end of the search pattern.
850 if (*cmd_start == '/' || *cmd_start == '?')
851 cmd_start++;
853 if (*cmd_end == '/' || *cmd_end == '?')
854 cmd_end--;
856 len = 0;
857 cmd[0] = NUL;
860 * If "^" is present in the tag search pattern, then
861 * copy it first.
863 if (*cmd_start == '^')
865 STRCPY(cmd, "^");
866 cmd_start++;
867 len++;
871 * Precede the tag pattern with \V to make it very
872 * nomagic.
874 STRCAT(cmd, "\\V");
875 len += 2;
877 cmd_len = (int)(cmd_end - cmd_start + 1);
878 if (cmd_len > (CMDBUFFSIZE - 5))
879 cmd_len = CMDBUFFSIZE - 5;
880 STRNCAT(cmd, cmd_start, cmd_len);
881 len += cmd_len;
883 if (cmd[len - 1] == '$')
886 * Replace '$' at the end of the search pattern
887 * with '\$'
889 cmd[len - 1] = '\\';
890 cmd[len] = '$';
891 len++;
894 cmd[len] = NUL;
897 if ((dict = dict_alloc()) == NULL)
898 continue;
899 if (list_append_dict(list, dict) == FAIL)
901 vim_free(dict);
902 continue;
905 dict_add_nr_str(dict, "text", 0L, tag_name);
906 dict_add_nr_str(dict, "filename", 0L, fname);
907 dict_add_nr_str(dict, "lnum", lnum, NULL);
908 if (lnum == 0)
909 dict_add_nr_str(dict, "pattern", 0L, cmd);
912 set_errorlist(curwin, list, ' ');
914 list_free(list, TRUE);
916 cur_match = 0; /* Jump to the first tag */
918 #endif
920 if (ask_for_selection == TRUE)
923 * Ask to select a tag from the list.
925 i = prompt_for_number(NULL);
926 if (i <= 0 || i > num_matches || got_int)
928 /* no valid choice: don't change anything */
929 if (use_tagstack)
931 tagstack[tagstackidx].fmark = saved_fmark;
932 tagstackidx = prevtagstackidx;
934 #ifdef FEAT_CSCOPE
935 cs_free_tags();
936 jumped_to_tag = TRUE;
937 #endif
938 break;
940 cur_match = i - 1;
943 if (cur_match >= num_matches)
945 /* Avoid giving this error when a file wasn't found and we're
946 * looking for a match in another file, which wasn't found.
947 * There will be an EMSG("file doesn't exist") below then. */
948 if ((type == DT_NEXT || type == DT_FIRST)
949 && nofile_fname == NULL)
951 if (num_matches == 1)
952 EMSG(_("E427: There is only one matching tag"));
953 else
954 EMSG(_("E428: Cannot go beyond last matching tag"));
955 skip_msg = TRUE;
957 cur_match = num_matches - 1;
959 if (use_tagstack)
961 tagstack[tagstackidx].cur_match = cur_match;
962 tagstack[tagstackidx].cur_fnum = cur_fnum;
963 ++tagstackidx;
965 #if defined(FEAT_WINDOWS) && defined(FEAT_QUICKFIX)
966 else if (g_do_tagpreview)
968 ptag_entry.cur_match = cur_match;
969 ptag_entry.cur_fnum = cur_fnum;
971 #endif
974 * Only when going to try the next match, report that the previous
975 * file didn't exist. Otherwise an EMSG() is given below.
977 if (nofile_fname != NULL && error_cur_match != cur_match)
978 smsg((char_u *)_("File \"%s\" does not exist"), nofile_fname);
981 ic = (matches[cur_match][0] & MT_IC_OFF);
982 if (type != DT_SELECT && type != DT_JUMP
983 #ifdef FEAT_CSCOPE
984 && type != DT_CSCOPE
985 #endif
986 && (num_matches > 1 || ic)
987 && !skip_msg)
989 /* Give an indication of the number of matching tags */
990 sprintf((char *)IObuff, _("tag %d of %d%s"),
991 cur_match + 1,
992 num_matches,
993 max_num_matches != MAXCOL ? _(" or more") : "");
994 if (ic)
995 STRCAT(IObuff, _(" Using tag with different case!"));
996 if ((num_matches > prev_num_matches || new_tag)
997 && num_matches > 1)
999 if (ic)
1000 msg_attr(IObuff, hl_attr(HLF_W));
1001 else
1002 msg(IObuff);
1003 msg_scroll = TRUE; /* don't overwrite this message */
1005 else
1006 give_warning(IObuff, ic);
1007 if (ic && !msg_scrolled && msg_silent == 0)
1009 out_flush();
1010 ui_delay(1000L, TRUE);
1014 #ifdef FEAT_AUTOCMD
1015 /* Let the SwapExists event know what tag we are jumping to. */
1016 vim_snprintf((char *)IObuff, IOSIZE, ":ta %s\r", name);
1017 set_vim_var_string(VV_SWAPCOMMAND, IObuff, -1);
1018 #endif
1021 * Jump to the desired match.
1023 i = jumpto_tag(matches[cur_match], forceit, type != DT_CSCOPE);
1025 #ifdef FEAT_AUTOCMD
1026 set_vim_var_string(VV_SWAPCOMMAND, NULL, -1);
1027 #endif
1029 if (i == NOTAGFILE)
1031 /* File not found: try again with another matching tag */
1032 if ((type == DT_PREV && cur_match > 0)
1033 || ((type == DT_TAG || type == DT_NEXT
1034 || type == DT_FIRST)
1035 && (max_num_matches != MAXCOL
1036 || cur_match < num_matches - 1)))
1038 error_cur_match = cur_match;
1039 if (use_tagstack)
1040 --tagstackidx;
1041 if (type == DT_PREV)
1042 --cur_match;
1043 else
1045 type = DT_NEXT;
1046 ++cur_match;
1048 continue;
1050 EMSG2(_("E429: File \"%s\" does not exist"), nofile_fname);
1052 else
1054 /* We may have jumped to another window, check that
1055 * tagstackidx is still valid. */
1056 if (use_tagstack && tagstackidx > curwin->w_tagstacklen)
1057 tagstackidx = curwin->w_tagstackidx;
1058 #ifdef FEAT_CSCOPE
1059 jumped_to_tag = TRUE;
1060 #endif
1063 break;
1066 end_do_tag:
1067 /* Only store the new index when using the tagstack and it's valid. */
1068 if (use_tagstack && tagstackidx <= curwin->w_tagstacklen)
1069 curwin->w_tagstackidx = tagstackidx;
1070 #ifdef FEAT_WINDOWS
1071 postponed_split = 0; /* don't split next time */
1072 #endif
1074 #ifdef FEAT_CSCOPE
1075 return jumped_to_tag;
1076 #else
1077 return FALSE;
1078 #endif
1082 * Free cached tags.
1084 void
1085 tag_freematch()
1087 vim_free(tagmatchname);
1088 tagmatchname = NULL;
1091 static void
1092 taglen_advance(l)
1093 int l;
1095 if (l == MAXCOL)
1097 msg_putchar('\n');
1098 msg_advance(24);
1100 else
1101 msg_advance(13 + l);
1105 * Print the tag stack
1107 /*ARGSUSED*/
1108 void
1109 do_tags(eap)
1110 exarg_T *eap;
1112 int i;
1113 char_u *name;
1114 taggy_T *tagstack = curwin->w_tagstack;
1115 int tagstackidx = curwin->w_tagstackidx;
1116 int tagstacklen = curwin->w_tagstacklen;
1118 /* Highlight title */
1119 MSG_PUTS_TITLE(_("\n # TO tag FROM line in file/text"));
1120 for (i = 0; i < tagstacklen; ++i)
1122 if (tagstack[i].tagname != NULL)
1124 name = fm_getname(&(tagstack[i].fmark), 30);
1125 if (name == NULL) /* file name not available */
1126 continue;
1128 msg_putchar('\n');
1129 sprintf((char *)IObuff, "%c%2d %2d %-15s %5ld ",
1130 i == tagstackidx ? '>' : ' ',
1131 i + 1,
1132 tagstack[i].cur_match + 1,
1133 tagstack[i].tagname,
1134 tagstack[i].fmark.mark.lnum);
1135 msg_outtrans(IObuff);
1136 msg_outtrans_attr(name, tagstack[i].fmark.fnum == curbuf->b_fnum
1137 ? hl_attr(HLF_D) : 0);
1138 vim_free(name);
1140 out_flush(); /* show one line at a time */
1142 if (tagstackidx == tagstacklen) /* idx at top of stack */
1143 MSG_PUTS("\n>");
1146 /* When not using a CR for line separator, use vim_fgets() to read tag lines.
1147 * For the Mac use tag_fgets(). It can handle any line separator, but is much
1148 * slower than vim_fgets().
1150 #ifndef USE_CR
1151 # define tag_fgets vim_fgets
1152 #endif
1154 #ifdef FEAT_TAG_BINS
1155 static int tag_strnicmp __ARGS((char_u *s1, char_u *s2, size_t len));
1158 * Compare two strings, for length "len", ignoring case the ASCII way.
1159 * return 0 for match, < 0 for smaller, > 0 for bigger
1160 * Make sure case is folded to uppercase in comparison (like for 'sort -f')
1162 static int
1163 tag_strnicmp(s1, s2, len)
1164 char_u *s1;
1165 char_u *s2;
1166 size_t len;
1168 int i;
1170 while (len > 0)
1172 i = (int)TOUPPER_ASC(*s1) - (int)TOUPPER_ASC(*s2);
1173 if (i != 0)
1174 return i; /* this character different */
1175 if (*s1 == NUL)
1176 break; /* strings match until NUL */
1177 ++s1;
1178 ++s2;
1179 --len;
1181 return 0; /* strings match */
1183 #endif
1186 * Structure to hold info about the tag pattern being used.
1188 typedef struct
1190 char_u *pat; /* the pattern */
1191 int len; /* length of pat[] */
1192 char_u *head; /* start of pattern head */
1193 int headlen; /* length of head[] */
1194 regmatch_T regmatch; /* regexp program, may be NULL */
1195 } pat_T;
1197 static void prepare_pats __ARGS((pat_T *pats, int has_re));
1200 * Extract info from the tag search pattern "pats->pat".
1202 static void
1203 prepare_pats(pats, has_re)
1204 pat_T *pats;
1205 int has_re;
1207 pats->head = pats->pat;
1208 pats->headlen = pats->len;
1209 if (has_re)
1211 /* When the pattern starts with '^' or "\\<", binary searching can be
1212 * used (much faster). */
1213 if (pats->pat[0] == '^')
1214 pats->head = pats->pat + 1;
1215 else if (pats->pat[0] == '\\' && pats->pat[1] == '<')
1216 pats->head = pats->pat + 2;
1217 if (pats->head == pats->pat)
1218 pats->headlen = 0;
1219 else
1220 for (pats->headlen = 0; pats->head[pats->headlen] != NUL;
1221 ++pats->headlen)
1222 if (vim_strchr((char_u *)(p_magic ? ".[~*\\$" : "\\$"),
1223 pats->head[pats->headlen]) != NULL)
1224 break;
1225 if (p_tl != 0 && pats->headlen > p_tl) /* adjust for 'taglength' */
1226 pats->headlen = p_tl;
1229 if (has_re)
1230 pats->regmatch.regprog = vim_regcomp(pats->pat, p_magic ? RE_MAGIC : 0);
1231 else
1232 pats->regmatch.regprog = NULL;
1236 * find_tags() - search for tags in tags files
1238 * Return FAIL if search completely failed (*num_matches will be 0, *matchesp
1239 * will be NULL), OK otherwise.
1241 * There is a priority in which type of tag is recognized.
1243 * 6. A static or global tag with a full matching tag for the current file.
1244 * 5. A global tag with a full matching tag for another file.
1245 * 4. A static tag with a full matching tag for another file.
1246 * 3. A static or global tag with an ignore-case matching tag for the
1247 * current file.
1248 * 2. A global tag with an ignore-case matching tag for another file.
1249 * 1. A static tag with an ignore-case matching tag for another file.
1251 * Tags in an emacs-style tags file are always global.
1253 * flags:
1254 * TAG_HELP only search for help tags
1255 * TAG_NAMES only return name of tag
1256 * TAG_REGEXP use "pat" as a regexp
1257 * TAG_NOIC don't always ignore case
1258 * TAG_KEEP_LANG keep language
1261 find_tags(pat, num_matches, matchesp, flags, mincount, buf_ffname)
1262 char_u *pat; /* pattern to search for */
1263 int *num_matches; /* return: number of matches found */
1264 char_u ***matchesp; /* return: array of matches found */
1265 int flags;
1266 int mincount; /* MAXCOL: find all matches
1267 other: minimal number of matches */
1268 char_u *buf_ffname; /* name of buffer for priority */
1270 FILE *fp;
1271 char_u *lbuf; /* line buffer */
1272 char_u *tag_fname; /* name of tag file */
1273 tagname_T tn; /* info for get_tagfname() */
1274 int first_file; /* trying first tag file */
1275 tagptrs_T tagp;
1276 int did_open = FALSE; /* did open a tag file */
1277 int stop_searching = FALSE; /* stop when match found or error */
1278 int retval = FAIL; /* return value */
1279 int is_static; /* current tag line is static */
1280 int is_current; /* file name matches */
1281 int eof = FALSE; /* found end-of-file */
1282 char_u *p;
1283 char_u *s;
1284 int i;
1285 #ifdef FEAT_TAG_BINS
1286 struct tag_search_info /* Binary search file offsets */
1288 off_t low_offset; /* offset for first char of first line that
1289 could match */
1290 off_t high_offset; /* offset of char after last line that could
1291 match */
1292 off_t curr_offset; /* Current file offset in search range */
1293 off_t curr_offset_used; /* curr_offset used when skipping back */
1294 off_t match_offset; /* Where the binary search found a tag */
1295 int low_char; /* first char at low_offset */
1296 int high_char; /* first char at high_offset */
1297 } search_info;
1298 off_t filesize;
1299 int tagcmp;
1300 off_t offset;
1301 int round;
1302 #endif
1303 enum
1305 TS_START, /* at start of file */
1306 TS_LINEAR /* linear searching forward, till EOF */
1307 #ifdef FEAT_TAG_BINS
1308 , TS_BINARY, /* binary searching */
1309 TS_SKIP_BACK, /* skipping backwards */
1310 TS_STEP_FORWARD /* stepping forwards */
1311 #endif
1312 } state; /* Current search state */
1314 int cmplen;
1315 int match; /* matches */
1316 int match_no_ic = 0;/* matches with rm_ic == FALSE */
1317 int match_re; /* match with regexp */
1318 int matchoff = 0;
1320 #ifdef FEAT_EMACS_TAGS
1322 * Stack for included emacs-tags file.
1323 * It has a fixed size, to truncate cyclic includes. jw
1325 # define INCSTACK_SIZE 42
1326 struct
1328 FILE *fp;
1329 char_u *etag_fname;
1330 } incstack[INCSTACK_SIZE];
1332 int incstack_idx = 0; /* index in incstack */
1333 char_u *ebuf; /* additional buffer for etag fname */
1334 int is_etag; /* current file is emaces style */
1335 #endif
1337 struct match_found
1339 int len; /* nr of chars of match[] to be compared */
1340 char_u match[1]; /* actually longer */
1341 } *mfp, *mfp2;
1342 garray_T ga_match[MT_COUNT];
1343 int match_count = 0; /* number of matches found */
1344 char_u **matches;
1345 int mtt;
1346 int len;
1347 int help_save;
1348 #ifdef FEAT_MULTI_LANG
1349 int help_pri = 0;
1350 char_u *help_lang_find = NULL; /* lang to be found */
1351 char_u help_lang[3]; /* lang of current tags file */
1352 char_u *saved_pat = NULL; /* copy of pat[] */
1353 #endif
1355 /* Use two sets of variables for the pattern: "orgpat" holds the values
1356 * for the original pattern and "convpat" converted from 'encoding' to
1357 * encoding of the tags file. "pats" point to either one of these. */
1358 pat_T *pats;
1359 pat_T orgpat; /* holds unconverted pattern info */
1360 #ifdef FEAT_MBYTE
1361 pat_T convpat; /* holds converted pattern info */
1362 vimconv_T vimconv;
1363 #endif
1365 #ifdef FEAT_TAG_BINS
1366 int findall = (mincount == MAXCOL || mincount == TAG_MANY);
1367 /* find all matching tags */
1368 int sort_error = FALSE; /* tags file not sorted */
1369 int linear; /* do a linear search */
1370 int sortic = FALSE; /* tag file sorted in nocase */
1371 #endif
1372 int line_error = FALSE; /* syntax error */
1373 int has_re = (flags & TAG_REGEXP); /* regexp used */
1374 int help_only = (flags & TAG_HELP);
1375 int name_only = (flags & TAG_NAMES);
1376 int noic = (flags & TAG_NOIC);
1377 int get_it_again = FALSE;
1378 #ifdef FEAT_CSCOPE
1379 int use_cscope = (flags & TAG_CSCOPE);
1380 #endif
1381 int verbose = (flags & TAG_VERBOSE);
1383 help_save = curbuf->b_help;
1384 orgpat.pat = pat;
1385 pats = &orgpat;
1386 #ifdef FEAT_MBYTE
1387 vimconv.vc_type = CONV_NONE;
1388 #endif
1391 * Allocate memory for the buffers that are used
1393 lbuf = alloc(LSIZE);
1394 tag_fname = alloc(MAXPATHL + 1);
1395 #ifdef FEAT_EMACS_TAGS
1396 ebuf = alloc(LSIZE);
1397 #endif
1398 for (mtt = 0; mtt < MT_COUNT; ++mtt)
1399 ga_init2(&ga_match[mtt], (int)sizeof(struct match_found *), 100);
1401 /* check for out of memory situation */
1402 if (lbuf == NULL || tag_fname == NULL
1403 #ifdef FEAT_EMACS_TAGS
1404 || ebuf == NULL
1405 #endif
1407 goto findtag_end;
1409 #ifdef FEAT_CSCOPE
1410 STRCPY(tag_fname, "from cscope"); /* for error messages */
1411 #endif
1414 * Initialize a few variables
1416 if (help_only) /* want tags from help file */
1417 curbuf->b_help = TRUE; /* will be restored later */
1419 pats->len = (int)STRLEN(pat);
1420 #ifdef FEAT_MULTI_LANG
1421 if (curbuf->b_help)
1423 /* When "@ab" is specified use only the "ab" language, otherwise
1424 * search all languages. */
1425 if (pats->len > 3 && pat[pats->len - 3] == '@'
1426 && ASCII_ISALPHA(pat[pats->len - 2])
1427 && ASCII_ISALPHA(pat[pats->len - 1]))
1429 saved_pat = vim_strnsave(pat, pats->len - 3);
1430 if (saved_pat != NULL)
1432 help_lang_find = &pat[pats->len - 2];
1433 pats->pat = saved_pat;
1434 pats->len -= 3;
1438 #endif
1439 if (p_tl != 0 && pats->len > p_tl) /* adjust for 'taglength' */
1440 pats->len = p_tl;
1442 prepare_pats(pats, has_re);
1444 #ifdef FEAT_TAG_BINS
1445 /* This is only to avoid a compiler warning for using search_info
1446 * uninitialised. */
1447 vim_memset(&search_info, 0, (size_t)1);
1448 #endif
1451 * When finding a specified number of matches, first try with matching
1452 * case, so binary search can be used, and try ignore-case matches in a
1453 * second loop.
1454 * When finding all matches, 'tagbsearch' is off, or there is no fixed
1455 * string to look for, ignore case right away to avoid going though the
1456 * tags files twice.
1457 * When the tag file is case-fold sorted, it is either one or the other.
1458 * Only ignore case when TAG_NOIC not used or 'ignorecase' set.
1460 #ifdef FEAT_TAG_BINS
1461 pats->regmatch.rm_ic = ((p_ic || !noic)
1462 && (findall || pats->headlen == 0 || !p_tbs));
1463 for (round = 1; round <= 2; ++round)
1465 linear = (pats->headlen == 0 || !p_tbs || round == 2);
1466 #else
1467 pats->regmatch.rm_ic = (p_ic || !noic);
1468 #endif
1471 * Try tag file names from tags option one by one.
1473 for (first_file = TRUE;
1474 #ifdef FEAT_CSCOPE
1475 use_cscope ||
1476 #endif
1477 get_tagfname(&tn, first_file, tag_fname) == OK;
1478 first_file = FALSE)
1481 * A file that doesn't exist is silently ignored. Only when not a
1482 * single file is found, an error message is given (further on).
1484 #ifdef FEAT_CSCOPE
1485 if (use_cscope)
1486 fp = NULL; /* avoid GCC warning */
1487 else
1488 #endif
1490 #ifdef FEAT_MULTI_LANG
1491 if (curbuf->b_help)
1493 /* Prefer help tags according to 'helplang'. Put the
1494 * two-letter language name in help_lang[]. */
1495 i = (int)STRLEN(tag_fname);
1496 if (i > 3 && tag_fname[i - 3] == '-')
1497 STRCPY(help_lang, tag_fname + i - 2);
1498 else
1499 STRCPY(help_lang, "en");
1501 /* When searching for a specific language skip tags files
1502 * for other languages. */
1503 if (help_lang_find != NULL
1504 && STRICMP(help_lang, help_lang_find) != 0)
1505 continue;
1507 /* For CTRL-] in a help file prefer a match with the same
1508 * language. */
1509 if ((flags & TAG_KEEP_LANG)
1510 && help_lang_find == NULL
1511 && curbuf->b_fname != NULL
1512 && (i = (int)STRLEN(curbuf->b_fname)) > 4
1513 && curbuf->b_fname[i - 1] == 'x'
1514 && curbuf->b_fname[i - 4] == '.'
1515 && STRNICMP(curbuf->b_fname + i - 3, help_lang, 2) == 0)
1516 help_pri = 0;
1517 else
1519 help_pri = 1;
1520 for (s = p_hlg; *s != NUL; ++s)
1522 if (STRNICMP(s, help_lang, 2) == 0)
1523 break;
1524 ++help_pri;
1525 if ((s = vim_strchr(s, ',')) == NULL)
1526 break;
1528 if (s == NULL || *s == NUL)
1530 /* Language not in 'helplang': use last, prefer English,
1531 * unless found already. */
1532 ++help_pri;
1533 if (STRICMP(help_lang, "en") != 0)
1534 ++help_pri;
1538 #endif
1540 if ((fp = mch_fopen((char *)tag_fname, "r")) == NULL)
1541 continue;
1543 if (p_verbose >= 5)
1545 verbose_enter();
1546 smsg((char_u *)_("Searching tags file %s"), tag_fname);
1547 verbose_leave();
1550 did_open = TRUE; /* remember that we found at least one file */
1552 state = TS_START; /* we're at the start of the file */
1553 #ifdef FEAT_EMACS_TAGS
1554 is_etag = 0; /* default is: not emacs style */
1555 #endif
1558 * Read and parse the lines in the file one by one
1560 for (;;)
1562 line_breakcheck(); /* check for CTRL-C typed */
1563 #ifdef FEAT_INS_EXPAND
1564 if ((flags & TAG_INS_COMP)) /* Double brackets for gcc */
1565 ins_compl_check_keys(30);
1566 if (got_int || compl_interrupted)
1567 #else
1568 if (got_int)
1569 #endif
1571 stop_searching = TRUE;
1572 break;
1574 /* When mincount is TAG_MANY, stop when enough matches have been
1575 * found (for completion). */
1576 if (mincount == TAG_MANY && match_count >= TAG_MANY)
1578 stop_searching = TRUE;
1579 retval = OK;
1580 break;
1582 if (get_it_again)
1583 goto line_read_in;
1584 #ifdef FEAT_TAG_BINS
1586 * For binary search: compute the next offset to use.
1588 if (state == TS_BINARY)
1590 offset = search_info.low_offset + ((search_info.high_offset
1591 - search_info.low_offset) / 2);
1592 if (offset == search_info.curr_offset)
1593 break; /* End the binary search without a match. */
1594 else
1595 search_info.curr_offset = offset;
1599 * Skipping back (after a match during binary search).
1601 else if (state == TS_SKIP_BACK)
1603 search_info.curr_offset -= LSIZE * 2;
1604 if (search_info.curr_offset < 0)
1606 search_info.curr_offset = 0;
1607 rewind(fp);
1608 state = TS_STEP_FORWARD;
1613 * When jumping around in the file, first read a line to find the
1614 * start of the next line.
1616 if (state == TS_BINARY || state == TS_SKIP_BACK)
1618 /* Adjust the search file offset to the correct position */
1619 search_info.curr_offset_used = search_info.curr_offset;
1620 #ifdef HAVE_FSEEKO
1621 fseeko(fp, search_info.curr_offset, SEEK_SET);
1622 #else
1623 fseek(fp, (long)search_info.curr_offset, SEEK_SET);
1624 #endif
1625 eof = tag_fgets(lbuf, LSIZE, fp);
1626 if (!eof && search_info.curr_offset != 0)
1628 /* The explicit cast is to work around a bug in gcc 3.4.2
1629 * (repeated below). */
1630 search_info.curr_offset = ftell(fp);
1631 if (search_info.curr_offset == search_info.high_offset)
1633 /* oops, gone a bit too far; try from low offset */
1634 #ifdef HAVE_FSEEKO
1635 fseeko(fp, search_info.low_offset, SEEK_SET);
1636 #else
1637 fseek(fp, (long)search_info.low_offset, SEEK_SET);
1638 #endif
1639 search_info.curr_offset = search_info.low_offset;
1641 eof = tag_fgets(lbuf, LSIZE, fp);
1643 /* skip empty and blank lines */
1644 while (!eof && vim_isblankline(lbuf))
1646 search_info.curr_offset = ftell(fp);
1647 eof = tag_fgets(lbuf, LSIZE, fp);
1649 if (eof)
1651 /* Hit end of file. Skip backwards. */
1652 state = TS_SKIP_BACK;
1653 search_info.match_offset = ftell(fp);
1654 search_info.curr_offset = search_info.curr_offset_used;
1655 continue;
1660 * Not jumping around in the file: Read the next line.
1662 else
1663 #endif
1665 /* skip empty and blank lines */
1668 #ifdef FEAT_CSCOPE
1669 if (use_cscope)
1670 eof = cs_fgets(lbuf, LSIZE);
1671 else
1672 #endif
1673 eof = tag_fgets(lbuf, LSIZE, fp);
1674 } while (!eof && vim_isblankline(lbuf));
1676 if (eof)
1678 #ifdef FEAT_EMACS_TAGS
1679 if (incstack_idx) /* this was an included file */
1681 --incstack_idx;
1682 fclose(fp); /* end of this file ... */
1683 fp = incstack[incstack_idx].fp;
1684 STRCPY(tag_fname, incstack[incstack_idx].etag_fname);
1685 vim_free(incstack[incstack_idx].etag_fname);
1686 is_etag = 1; /* (only etags can include) */
1687 continue; /* ... continue with parent file */
1689 else
1690 #endif
1691 break; /* end of file */
1694 line_read_in:
1696 #ifdef FEAT_EMACS_TAGS
1698 * Emacs tags line with CTRL-L: New file name on next line.
1699 * The file name is followed by a ','.
1701 if (*lbuf == Ctrl_L) /* remember etag file name in ebuf */
1703 is_etag = 1; /* in case at the start */
1704 state = TS_LINEAR;
1705 if (!tag_fgets(ebuf, LSIZE, fp))
1707 for (p = ebuf; *p && *p != ','; p++)
1709 *p = NUL;
1712 * atoi(p+1) is the number of bytes before the next ^L
1713 * unless it is an include statement.
1715 if (STRNCMP(p + 1, "include", 7) == 0
1716 && incstack_idx < INCSTACK_SIZE)
1718 /* Save current "fp" and "tag_fname" in the stack. */
1719 if ((incstack[incstack_idx].etag_fname =
1720 vim_strsave(tag_fname)) != NULL)
1722 char_u *fullpath_ebuf;
1724 incstack[incstack_idx].fp = fp;
1725 fp = NULL;
1727 /* Figure out "tag_fname" and "fp" to use for
1728 * included file. */
1729 fullpath_ebuf = expand_tag_fname(ebuf,
1730 tag_fname, FALSE);
1731 if (fullpath_ebuf != NULL)
1733 fp = mch_fopen((char *)fullpath_ebuf, "r");
1734 if (fp != NULL)
1736 if (STRLEN(fullpath_ebuf) > LSIZE)
1737 EMSG2(_("E430: Tag file path truncated for %s\n"), ebuf);
1738 vim_strncpy(tag_fname, fullpath_ebuf,
1739 MAXPATHL);
1740 ++incstack_idx;
1741 is_etag = 0; /* we can include anything */
1743 vim_free(fullpath_ebuf);
1745 if (fp == NULL)
1747 /* Can't open the included file, skip it and
1748 * restore old value of "fp". */
1749 fp = incstack[incstack_idx].fp;
1750 vim_free(incstack[incstack_idx].etag_fname);
1755 continue;
1757 #endif
1760 * When still at the start of the file, check for Emacs tags file
1761 * format, and for "not sorted" flag.
1763 if (state == TS_START)
1765 #ifdef FEAT_TAG_BINS
1767 * When there is no tag head, or ignoring case, need to do a
1768 * linear search.
1769 * When no "!_TAG_" is found, default to binary search. If
1770 * the tag file isn't sorted, the second loop will find it.
1771 * When "!_TAG_FILE_SORTED" found: start binary search if
1772 * flag set.
1773 * For cscope, it's always linear.
1775 # ifdef FEAT_CSCOPE
1776 if (linear || use_cscope)
1777 # else
1778 if (linear)
1779 # endif
1780 state = TS_LINEAR;
1781 else if (STRNCMP(lbuf, "!_TAG_", 6) > 0)
1782 state = TS_BINARY;
1783 else if (STRNCMP(lbuf, "!_TAG_FILE_SORTED\t", 18) == 0)
1785 /* Check sorted flag */
1786 if (lbuf[18] == '1')
1787 state = TS_BINARY;
1788 else if (lbuf[18] == '2')
1790 state = TS_BINARY;
1791 sortic = TRUE;
1792 pats->regmatch.rm_ic = (p_ic || !noic);
1794 else
1795 state = TS_LINEAR;
1798 if (state == TS_BINARY && pats->regmatch.rm_ic && !sortic)
1800 /* binary search won't work for ignoring case, use linear
1801 * search. */
1802 linear = TRUE;
1803 state = TS_LINEAR;
1805 #else
1806 state = TS_LINEAR;
1807 #endif
1809 #ifdef FEAT_TAG_BINS
1811 * When starting a binary search, get the size of the file and
1812 * compute the first offset.
1814 if (state == TS_BINARY)
1816 /* Get the tag file size (don't use mch_fstat(), it's not
1817 * portable). */
1818 if ((filesize = lseek(fileno(fp),
1819 (off_t)0L, SEEK_END)) <= 0)
1820 state = TS_LINEAR;
1821 else
1823 lseek(fileno(fp), (off_t)0L, SEEK_SET);
1825 /* Calculate the first read offset in the file. Start
1826 * the search in the middle of the file. */
1827 search_info.low_offset = 0;
1828 search_info.low_char = 0;
1829 search_info.high_offset = filesize;
1830 search_info.curr_offset = 0;
1831 search_info.high_char = 0xff;
1833 continue;
1835 #endif
1838 #ifdef FEAT_MBYTE
1839 if (lbuf[0] == '!' && pats == &orgpat
1840 && STRNCMP(lbuf, "!_TAG_FILE_ENCODING\t", 20) == 0)
1842 /* Convert the search pattern from 'encoding' to the
1843 * specified encoding. */
1844 for (p = lbuf + 20; *p > ' ' && *p < 127; ++p)
1846 *p = NUL;
1847 convert_setup(&vimconv, p_enc, lbuf + 20);
1848 if (vimconv.vc_type != CONV_NONE)
1850 convpat.pat = string_convert(&vimconv, pats->pat, NULL);
1851 if (convpat.pat != NULL)
1853 pats = &convpat;
1854 pats->len = (int)STRLEN(pats->pat);
1855 prepare_pats(pats, has_re);
1856 pats->regmatch.rm_ic = orgpat.regmatch.rm_ic;
1860 /* Prepare for converting a match the other way around. */
1861 convert_setup(&vimconv, lbuf + 20, p_enc);
1862 continue;
1864 #endif
1867 * Figure out where the different strings are in this line.
1868 * For "normal" tags: Do a quick check if the tag matches.
1869 * This speeds up tag searching a lot!
1871 if (pats->headlen
1872 #ifdef FEAT_EMACS_TAGS
1873 && !is_etag
1874 #endif
1877 tagp.tagname = lbuf;
1878 #ifdef FEAT_TAG_ANYWHITE
1879 tagp.tagname_end = skiptowhite(lbuf);
1880 if (*tagp.tagname_end == NUL) /* corrupted tag line */
1881 #else
1882 tagp.tagname_end = vim_strchr(lbuf, TAB);
1883 if (tagp.tagname_end == NULL) /* corrupted tag line */
1884 #endif
1886 line_error = TRUE;
1887 break;
1890 #ifdef FEAT_TAG_OLDSTATIC
1892 * Check for old style static tag: "file:tag file .."
1894 tagp.fname = NULL;
1895 for (p = lbuf; p < tagp.tagname_end; ++p)
1897 if (*p == ':')
1899 if (tagp.fname == NULL)
1900 #ifdef FEAT_TAG_ANYWHITE
1901 tagp.fname = skipwhite(tagp.tagname_end);
1902 #else
1903 tagp.fname = tagp.tagname_end + 1;
1904 #endif
1905 if ( fnamencmp(lbuf, tagp.fname, p - lbuf) == 0
1906 #ifdef FEAT_TAG_ANYWHITE
1907 && vim_iswhite(tagp.fname[p - lbuf])
1908 #else
1909 && tagp.fname[p - lbuf] == TAB
1910 #endif
1913 /* found one */
1914 tagp.tagname = p + 1;
1915 break;
1919 #endif
1922 * Skip this line if the length of the tag is different and
1923 * there is no regexp, or the tag is too short.
1925 cmplen = (int)(tagp.tagname_end - tagp.tagname);
1926 if (p_tl != 0 && cmplen > p_tl) /* adjust for 'taglength' */
1927 cmplen = p_tl;
1928 if (has_re && pats->headlen < cmplen)
1929 cmplen = pats->headlen;
1930 else if (state == TS_LINEAR && pats->headlen != cmplen)
1931 continue;
1933 #ifdef FEAT_TAG_BINS
1934 if (state == TS_BINARY)
1937 * Simplistic check for unsorted tags file.
1939 i = (int)tagp.tagname[0];
1940 if (sortic)
1941 i = (int)TOUPPER_ASC(tagp.tagname[0]);
1942 if (i < search_info.low_char || i > search_info.high_char)
1943 sort_error = TRUE;
1946 * Compare the current tag with the searched tag.
1948 if (sortic)
1949 tagcmp = tag_strnicmp(tagp.tagname, pats->head,
1950 (size_t)cmplen);
1951 else
1952 tagcmp = STRNCMP(tagp.tagname, pats->head, cmplen);
1955 * A match with a shorter tag means to search forward.
1956 * A match with a longer tag means to search backward.
1958 if (tagcmp == 0)
1960 if (cmplen < pats->headlen)
1961 tagcmp = -1;
1962 else if (cmplen > pats->headlen)
1963 tagcmp = 1;
1966 if (tagcmp == 0)
1968 /* We've located the tag, now skip back and search
1969 * forward until the first matching tag is found.
1971 state = TS_SKIP_BACK;
1972 search_info.match_offset = search_info.curr_offset;
1973 continue;
1975 if (tagcmp < 0)
1977 search_info.curr_offset = ftell(fp);
1978 if (search_info.curr_offset < search_info.high_offset)
1980 search_info.low_offset = search_info.curr_offset;
1981 if (sortic)
1982 search_info.low_char =
1983 TOUPPER_ASC(tagp.tagname[0]);
1984 else
1985 search_info.low_char = tagp.tagname[0];
1986 continue;
1989 if (tagcmp > 0
1990 && search_info.curr_offset != search_info.high_offset)
1992 search_info.high_offset = search_info.curr_offset;
1993 if (sortic)
1994 search_info.high_char =
1995 TOUPPER_ASC(tagp.tagname[0]);
1996 else
1997 search_info.high_char = tagp.tagname[0];
1998 continue;
2001 /* No match yet and are at the end of the binary search. */
2002 break;
2004 else if (state == TS_SKIP_BACK)
2006 if (MB_STRNICMP(tagp.tagname, pats->head, cmplen) != 0)
2007 state = TS_STEP_FORWARD;
2008 else
2009 /* Have to skip back more. Restore the curr_offset
2010 * used, otherwise we get stuck at a long line. */
2011 search_info.curr_offset = search_info.curr_offset_used;
2012 continue;
2014 else if (state == TS_STEP_FORWARD)
2016 if (MB_STRNICMP(tagp.tagname, pats->head, cmplen) != 0)
2018 if ((off_t)ftell(fp) > search_info.match_offset)
2019 break; /* past last match */
2020 else
2021 continue; /* before first match */
2024 else
2025 #endif
2026 /* skip this match if it can't match */
2027 if (MB_STRNICMP(tagp.tagname, pats->head, cmplen) != 0)
2028 continue;
2031 * Can be a matching tag, isolate the file name and command.
2033 #ifdef FEAT_TAG_OLDSTATIC
2034 if (tagp.fname == NULL)
2035 #endif
2036 #ifdef FEAT_TAG_ANYWHITE
2037 tagp.fname = skipwhite(tagp.tagname_end);
2038 #else
2039 tagp.fname = tagp.tagname_end + 1;
2040 #endif
2041 #ifdef FEAT_TAG_ANYWHITE
2042 tagp.fname_end = skiptowhite(tagp.fname);
2043 tagp.command = skipwhite(tagp.fname_end);
2044 if (*tagp.command == NUL)
2045 #else
2046 tagp.fname_end = vim_strchr(tagp.fname, TAB);
2047 tagp.command = tagp.fname_end + 1;
2048 if (tagp.fname_end == NULL)
2049 #endif
2050 i = FAIL;
2051 else
2052 i = OK;
2054 else
2055 i = parse_tag_line(lbuf,
2056 #ifdef FEAT_EMACS_TAGS
2057 is_etag,
2058 #endif
2059 &tagp);
2060 if (i == FAIL)
2062 line_error = TRUE;
2063 break;
2066 #ifdef FEAT_EMACS_TAGS
2067 if (is_etag)
2068 tagp.fname = ebuf;
2069 #endif
2071 * First try matching with the pattern literally (also when it is
2072 * a regexp).
2074 cmplen = (int)(tagp.tagname_end - tagp.tagname);
2075 if (p_tl != 0 && cmplen > p_tl) /* adjust for 'taglength' */
2076 cmplen = p_tl;
2077 /* if tag length does not match, don't try comparing */
2078 if (pats->len != cmplen)
2079 match = FALSE;
2080 else
2082 if (pats->regmatch.rm_ic)
2084 match = (MB_STRNICMP(tagp.tagname, pats->pat, cmplen) == 0);
2085 if (match)
2086 match_no_ic = (STRNCMP(tagp.tagname, pats->pat,
2087 cmplen) == 0);
2089 else
2090 match = (STRNCMP(tagp.tagname, pats->pat, cmplen) == 0);
2094 * Has a regexp: Also find tags matching regexp.
2096 match_re = FALSE;
2097 if (!match && pats->regmatch.regprog != NULL)
2099 int cc;
2101 cc = *tagp.tagname_end;
2102 *tagp.tagname_end = NUL;
2103 match = vim_regexec(&pats->regmatch, tagp.tagname, (colnr_T)0);
2104 if (match)
2106 matchoff = (int)(pats->regmatch.startp[0] - tagp.tagname);
2107 if (pats->regmatch.rm_ic)
2109 pats->regmatch.rm_ic = FALSE;
2110 match_no_ic = vim_regexec(&pats->regmatch, tagp.tagname,
2111 (colnr_T)0);
2112 pats->regmatch.rm_ic = TRUE;
2115 *tagp.tagname_end = cc;
2116 match_re = TRUE;
2120 * If a match is found, add it to ga_match[].
2122 if (match)
2124 #ifdef FEAT_CSCOPE
2125 if (use_cscope)
2127 /* Don't change the ordering, always use the same table. */
2128 mtt = MT_GL_OTH;
2130 else
2131 #endif
2133 /* Decide in which array to store this match. */
2134 is_current = test_for_current(
2135 #ifdef FEAT_EMACS_TAGS
2136 is_etag,
2137 #endif
2138 tagp.fname, tagp.fname_end, tag_fname,
2139 buf_ffname);
2140 #ifdef FEAT_EMACS_TAGS
2141 is_static = FALSE;
2142 if (!is_etag) /* emacs tags are never static */
2143 #endif
2145 #ifdef FEAT_TAG_OLDSTATIC
2146 if (tagp.tagname != lbuf)
2147 is_static = TRUE; /* detected static tag before */
2148 else
2149 #endif
2150 is_static = test_for_static(&tagp);
2153 /* decide in which of the sixteen tables to store this
2154 * match */
2155 if (is_static)
2157 if (is_current)
2158 mtt = MT_ST_CUR;
2159 else
2160 mtt = MT_ST_OTH;
2162 else
2164 if (is_current)
2165 mtt = MT_GL_CUR;
2166 else
2167 mtt = MT_GL_OTH;
2169 if (pats->regmatch.rm_ic && !match_no_ic)
2170 mtt += MT_IC_OFF;
2171 if (match_re)
2172 mtt += MT_RE_OFF;
2176 * Add the found match in ga_match[mtt], avoiding duplicates.
2177 * Store the info we need later, which depends on the kind of
2178 * tags we are dealing with.
2180 if (ga_grow(&ga_match[mtt], 1) == OK)
2182 #ifdef FEAT_MBYTE
2183 char_u *conv_line = NULL;
2184 char_u *lbuf_line = lbuf;
2186 if (vimconv.vc_type != CONV_NONE)
2188 /* Convert the tag line from the encoding of the tags
2189 * file to 'encoding'. Then parse the line again. */
2190 conv_line = string_convert(&vimconv, lbuf, NULL);
2191 if (conv_line != NULL)
2193 if (parse_tag_line(conv_line,
2194 #ifdef FEAT_EMACS_TAGS
2195 is_etag,
2196 #endif
2197 &tagp) == OK)
2198 lbuf_line = conv_line;
2199 else
2200 /* doesn't work, go back to unconverted line. */
2201 (void)parse_tag_line(lbuf,
2202 #ifdef FEAT_EMACS_TAGS
2203 is_etag,
2204 #endif
2205 &tagp);
2208 #else
2209 # define lbuf_line lbuf
2210 #endif
2211 if (help_only)
2213 #ifdef FEAT_MULTI_LANG
2214 # define ML_EXTRA 3
2215 #else
2216 # define ML_EXTRA 0
2217 #endif
2219 * Append the help-heuristic number after the
2220 * tagname, for sorting it later.
2222 *tagp.tagname_end = NUL;
2223 len = (int)(tagp.tagname_end - tagp.tagname);
2224 mfp = (struct match_found *)
2225 alloc((int)sizeof(struct match_found) + len
2226 + 10 + ML_EXTRA);
2227 if (mfp != NULL)
2229 /* "len" includes the language and the NUL, but
2230 * not the priority. */
2231 mfp->len = len + ML_EXTRA + 1;
2232 #define ML_HELP_LEN 6
2233 p = mfp->match;
2234 STRCPY(p, tagp.tagname);
2235 #ifdef FEAT_MULTI_LANG
2236 p[len] = '@';
2237 STRCPY(p + len + 1, help_lang);
2238 #endif
2239 sprintf((char *)p + len + 1 + ML_EXTRA, "%06d",
2240 help_heuristic(tagp.tagname,
2241 match_re ? matchoff : 0, !match_no_ic)
2242 #ifdef FEAT_MULTI_LANG
2243 + help_pri
2244 #endif
2247 *tagp.tagname_end = TAB;
2249 else if (name_only)
2251 if (get_it_again)
2253 char_u *temp_end = tagp.command;
2255 if (*temp_end == '/')
2256 while (*temp_end && *temp_end != '\r'
2257 && *temp_end != '\n'
2258 && *temp_end != '$')
2259 temp_end++;
2261 if (tagp.command + 2 < temp_end)
2263 len = (int)(temp_end - tagp.command - 2);
2264 mfp = (struct match_found *)alloc(
2265 (int)sizeof(struct match_found) + len);
2266 if (mfp != NULL)
2268 mfp->len = len + 1; /* include the NUL */
2269 p = mfp->match;
2270 vim_strncpy(p, tagp.command + 2, len);
2273 else
2274 mfp = NULL;
2275 get_it_again = FALSE;
2277 else
2279 len = (int)(tagp.tagname_end - tagp.tagname);
2280 mfp = (struct match_found *)alloc(
2281 (int)sizeof(struct match_found) + len);
2282 if (mfp != NULL)
2284 mfp->len = len + 1; /* include the NUL */
2285 p = mfp->match;
2286 vim_strncpy(p, tagp.tagname, len);
2289 /* if wanted, re-read line to get long form too */
2290 if (State & INSERT)
2291 get_it_again = p_sft;
2294 else
2296 /* Save the tag in a buffer.
2297 * Emacs tag: <mtt><tag_fname><NUL><ebuf><NUL><lbuf>
2298 * other tag: <mtt><tag_fname><NUL><NUL><lbuf>
2299 * without Emacs tags: <mtt><tag_fname><NUL><lbuf>
2301 len = (int)STRLEN(tag_fname)
2302 + (int)STRLEN(lbuf_line) + 3;
2303 #ifdef FEAT_EMACS_TAGS
2304 if (is_etag)
2305 len += (int)STRLEN(ebuf) + 1;
2306 else
2307 ++len;
2308 #endif
2309 mfp = (struct match_found *)alloc(
2310 (int)sizeof(struct match_found) + len);
2311 if (mfp != NULL)
2313 mfp->len = len;
2314 p = mfp->match;
2315 p[0] = mtt;
2316 STRCPY(p + 1, tag_fname);
2317 #ifdef BACKSLASH_IN_FILENAME
2318 /* Ignore differences in slashes, avoid adding
2319 * both path/file and path\file. */
2320 slash_adjust(p + 1);
2321 #endif
2322 s = p + 1 + STRLEN(tag_fname) + 1;
2323 #ifdef FEAT_EMACS_TAGS
2324 if (is_etag)
2326 STRCPY(s, ebuf);
2327 s += STRLEN(ebuf) + 1;
2329 else
2330 *s++ = NUL;
2331 #endif
2332 STRCPY(s, lbuf_line);
2336 if (mfp != NULL)
2339 * Don't add identical matches.
2340 * This can take a lot of time when finding many
2341 * matches, check for CTRL-C now and then.
2342 * Add all cscope tags, because they are all listed.
2344 #ifdef FEAT_CSCOPE
2345 if (use_cscope)
2346 i = -1;
2347 else
2348 #endif
2349 for (i = ga_match[mtt].ga_len; --i >= 0 && !got_int; )
2351 mfp2 = ((struct match_found **)
2352 (ga_match[mtt].ga_data))[i];
2353 if (mfp2->len == mfp->len
2354 && vim_memcmp(mfp2->match, mfp->match,
2355 (size_t)mfp->len) == 0)
2356 break;
2357 line_breakcheck();
2359 if (i < 0)
2361 ((struct match_found **)(ga_match[mtt].ga_data))
2362 [ga_match[mtt].ga_len++] = mfp;
2363 ++match_count;
2365 else
2366 vim_free(mfp);
2368 #ifdef FEAT_MBYTE
2369 /* Note: this makes the values in "tagp" invalid! */
2370 vim_free(conv_line);
2371 #endif
2373 else /* Out of memory! Just forget about the rest. */
2375 retval = OK;
2376 stop_searching = TRUE;
2377 break;
2380 #ifdef FEAT_CSCOPE
2381 if (use_cscope && eof)
2382 break;
2383 #endif
2384 } /* forever */
2386 if (line_error)
2388 EMSG2(_("E431: Format error in tags file \"%s\""), tag_fname);
2389 #ifdef FEAT_CSCOPE
2390 if (!use_cscope)
2391 #endif
2392 EMSGN(_("Before byte %ld"), (long)ftell(fp));
2393 stop_searching = TRUE;
2394 line_error = FALSE;
2397 #ifdef FEAT_CSCOPE
2398 if (!use_cscope)
2399 #endif
2400 fclose(fp);
2401 #ifdef FEAT_EMACS_TAGS
2402 while (incstack_idx)
2404 --incstack_idx;
2405 fclose(incstack[incstack_idx].fp);
2406 vim_free(incstack[incstack_idx].etag_fname);
2408 #endif
2409 #ifdef FEAT_MBYTE
2410 if (pats == &convpat)
2412 /* Go back from converted pattern to original pattern. */
2413 vim_free(pats->pat);
2414 vim_free(pats->regmatch.regprog);
2415 orgpat.regmatch.rm_ic = pats->regmatch.rm_ic;
2416 pats = &orgpat;
2418 if (vimconv.vc_type != CONV_NONE)
2419 convert_setup(&vimconv, NULL, NULL);
2420 #endif
2422 #ifdef FEAT_TAG_BINS
2423 if (sort_error)
2425 EMSG2(_("E432: Tags file not sorted: %s"), tag_fname);
2426 sort_error = FALSE;
2428 #endif
2431 * Stop searching if sufficient tags have been found.
2433 if (match_count >= mincount)
2435 retval = OK;
2436 stop_searching = TRUE;
2439 #ifdef FEAT_CSCOPE
2440 if (stop_searching || use_cscope)
2441 #else
2442 if (stop_searching)
2443 #endif
2444 break;
2446 } /* end of for-each-file loop */
2448 #ifdef FEAT_CSCOPE
2449 if (!use_cscope)
2450 #endif
2451 tagname_free(&tn);
2453 #ifdef FEAT_TAG_BINS
2454 /* stop searching when already did a linear search, or when TAG_NOIC
2455 * used, and 'ignorecase' not set or already did case-ignore search */
2456 if (stop_searching || linear || (!p_ic && noic) || pats->regmatch.rm_ic)
2457 break;
2458 # ifdef FEAT_CSCOPE
2459 if (use_cscope)
2460 break;
2461 # endif
2462 pats->regmatch.rm_ic = TRUE; /* try another time while ignoring case */
2464 #endif
2466 if (!stop_searching)
2468 if (!did_open && verbose) /* never opened any tags file */
2469 EMSG(_("E433: No tags file"));
2470 retval = OK; /* It's OK even when no tag found */
2473 findtag_end:
2474 vim_free(lbuf);
2475 vim_free(pats->regmatch.regprog);
2476 vim_free(tag_fname);
2477 #ifdef FEAT_EMACS_TAGS
2478 vim_free(ebuf);
2479 #endif
2482 * Move the matches from the ga_match[] arrays into one list of
2483 * matches. When retval == FAIL, free the matches.
2485 if (retval == FAIL)
2486 match_count = 0;
2488 if (match_count > 0)
2489 matches = (char_u **)lalloc((long_u)(match_count * sizeof(char_u *)),
2490 TRUE);
2491 else
2492 matches = NULL;
2493 match_count = 0;
2494 for (mtt = 0; mtt < MT_COUNT; ++mtt)
2496 for (i = 0; i < ga_match[mtt].ga_len; ++i)
2498 mfp = ((struct match_found **)(ga_match[mtt].ga_data))[i];
2499 if (matches == NULL)
2500 vim_free(mfp);
2501 else
2503 /* To avoid allocating memory again we turn the struct
2504 * match_found into a string. For help the priority was not
2505 * included in the length. */
2506 mch_memmove(mfp, mfp->match,
2507 (size_t)(mfp->len + (help_only ? ML_HELP_LEN : 0)));
2508 matches[match_count++] = (char_u *)mfp;
2511 ga_clear(&ga_match[mtt]);
2514 *matchesp = matches;
2515 *num_matches = match_count;
2517 curbuf->b_help = help_save;
2518 #ifdef FEAT_MULTI_LANG
2519 vim_free(saved_pat);
2520 #endif
2522 return retval;
2525 static garray_T tag_fnames = GA_EMPTY;
2526 static void found_tagfile_cb __ARGS((char_u *fname, void *cookie));
2529 * Callback function for finding all "tags" and "tags-??" files in
2530 * 'runtimepath' doc directories.
2532 /*ARGSUSED*/
2533 static void
2534 found_tagfile_cb(fname, cookie)
2535 char_u *fname;
2536 void *cookie;
2538 if (ga_grow(&tag_fnames, 1) == OK)
2539 ((char_u **)(tag_fnames.ga_data))[tag_fnames.ga_len++] =
2540 vim_strsave(fname);
2543 #if defined(EXITFREE) || defined(PROTO)
2544 void
2545 free_tag_stuff()
2547 ga_clear_strings(&tag_fnames);
2548 do_tag(NULL, DT_FREE, 0, 0, 0);
2550 #endif
2553 * Get the next name of a tag file from the tag file list.
2554 * For help files, use "tags" file only.
2556 * Return FAIL if no more tag file names, OK otherwise.
2559 get_tagfname(tnp, first, buf)
2560 tagname_T *tnp; /* holds status info */
2561 int first; /* TRUE when first file name is wanted */
2562 char_u *buf; /* pointer to buffer of MAXPATHL chars */
2564 char_u *fname = NULL;
2565 char_u *r_ptr;
2567 if (first)
2568 vim_memset(tnp, 0, sizeof(tagname_T));
2570 if (curbuf->b_help)
2573 * For help files it's done in a completely different way:
2574 * Find "doc/tags" and "doc/tags-??" in all directories in
2575 * 'runtimepath'.
2577 if (first)
2579 ga_clear_strings(&tag_fnames);
2580 ga_init2(&tag_fnames, (int)sizeof(char_u *), 10);
2581 do_in_runtimepath((char_u *)
2582 #ifdef FEAT_MULTI_LANG
2583 # ifdef VMS
2584 /* Functions decc$to_vms() and decc$translate_vms() crash
2585 * on some VMS systems with wildcards "??". Seems ECO
2586 * patches do fix the problem in C RTL, but we can't use
2587 * an #ifdef for that. */
2588 "doc/tags doc/tags-*"
2589 # else
2590 "doc/tags doc/tags-??"
2591 # endif
2592 #else
2593 "doc/tags"
2594 #endif
2595 , TRUE, found_tagfile_cb, NULL);
2598 if (tnp->tn_hf_idx >= tag_fnames.ga_len)
2600 /* Not found in 'runtimepath', use 'helpfile', if it exists and
2601 * wasn't used yet, replacing "help.txt" with "tags". */
2602 if (tnp->tn_hf_idx > tag_fnames.ga_len || *p_hf == NUL)
2603 return FAIL;
2604 ++tnp->tn_hf_idx;
2605 STRCPY(buf, p_hf);
2606 STRCPY(gettail(buf), "tags");
2608 else
2609 vim_strncpy(buf, ((char_u **)(tag_fnames.ga_data))[
2610 tnp->tn_hf_idx++], MAXPATHL - 1);
2611 return OK;
2614 if (first)
2616 /* Init. We make a copy of 'tags', because autocommands may change
2617 * the value without notifying us. */
2618 tnp->tn_tags = vim_strsave((*curbuf->b_p_tags != NUL)
2619 ? curbuf->b_p_tags : p_tags);
2620 if (tnp->tn_tags == NULL)
2621 return FAIL;
2622 tnp->tn_np = tnp->tn_tags;
2626 * Loop until we have found a file name that can be used.
2627 * There are two states:
2628 * tnp->tn_did_filefind_init == FALSE: setup for next part in 'tags'.
2629 * tnp->tn_did_filefind_init == TRUE: find next file in this part.
2631 for (;;)
2633 if (tnp->tn_did_filefind_init)
2635 fname = vim_findfile(tnp->tn_search_ctx);
2636 if (fname != NULL)
2637 break;
2639 tnp->tn_did_filefind_init = FALSE;
2641 else
2643 char_u *filename = NULL;
2645 /* Stop when used all parts of 'tags'. */
2646 if (*tnp->tn_np == NUL)
2648 vim_findfile_cleanup(tnp->tn_search_ctx);
2649 tnp->tn_search_ctx = NULL;
2650 return FAIL;
2654 * Copy next file name into buf.
2656 buf[0] = NUL;
2657 (void)copy_option_part(&tnp->tn_np, buf, MAXPATHL - 1, " ,");
2659 #ifdef FEAT_PATH_EXTRA
2660 r_ptr = vim_findfile_stopdir(buf);
2661 #else
2662 r_ptr = NULL;
2663 #endif
2664 /* move the filename one char forward and truncate the
2665 * filepath with a NUL */
2666 filename = gettail(buf);
2667 mch_memmove(filename + 1, filename, STRLEN(filename) + 1);
2668 *filename++ = NUL;
2670 tnp->tn_search_ctx = vim_findfile_init(buf, filename,
2671 r_ptr, 100,
2672 FALSE, /* don't free visited list */
2673 FALSE, /* we search for a file */
2674 tnp->tn_search_ctx, TRUE, curbuf->b_ffname);
2675 if (tnp->tn_search_ctx != NULL)
2676 tnp->tn_did_filefind_init = TRUE;
2680 STRCPY(buf, fname);
2681 vim_free(fname);
2682 return OK;
2686 * Free the contents of a tagname_T that was filled by get_tagfname().
2688 void
2689 tagname_free(tnp)
2690 tagname_T *tnp;
2692 vim_free(tnp->tn_tags);
2693 vim_findfile_cleanup(tnp->tn_search_ctx);
2694 ga_clear_strings(&tag_fnames);
2698 * Parse one line from the tags file. Find start/end of tag name, start/end of
2699 * file name and start of search pattern.
2701 * If is_etag is TRUE, tagp->fname and tagp->fname_end are not set.
2703 * Return FAIL if there is a format error in this line, OK otherwise.
2705 static int
2706 parse_tag_line(lbuf,
2707 #ifdef FEAT_EMACS_TAGS
2708 is_etag,
2709 #endif
2710 tagp)
2711 char_u *lbuf; /* line to be parsed */
2712 #ifdef FEAT_EMACS_TAGS
2713 int is_etag;
2714 #endif
2715 tagptrs_T *tagp;
2717 char_u *p;
2719 #ifdef FEAT_EMACS_TAGS
2720 char_u *p_7f;
2722 if (is_etag)
2725 * There are two formats for an emacs tag line:
2726 * 1: struct EnvBase ^?EnvBase^A139,4627
2727 * 2: #define ARPB_WILD_WORLD ^?153,5194
2729 p_7f = vim_strchr(lbuf, 0x7f);
2730 if (p_7f == NULL)
2731 return FAIL;
2733 /* Find ^A. If not found the line number is after the 0x7f */
2734 p = vim_strchr(p_7f, Ctrl_A);
2735 if (p == NULL)
2736 p = p_7f + 1;
2737 else
2738 ++p;
2740 if (!VIM_ISDIGIT(*p)) /* check for start of line number */
2741 return FAIL;
2742 tagp->command = p;
2745 if (p[-1] == Ctrl_A) /* first format: explicit tagname given */
2747 tagp->tagname = p_7f + 1;
2748 tagp->tagname_end = p - 1;
2750 else /* second format: isolate tagname */
2752 /* find end of tagname */
2753 for (p = p_7f - 1; !vim_iswordc(*p); --p)
2754 if (p == lbuf)
2755 return FAIL;
2756 tagp->tagname_end = p + 1;
2757 while (p >= lbuf && vim_iswordc(*p))
2758 --p;
2759 tagp->tagname = p + 1;
2762 else /* not an Emacs tag */
2764 #endif
2765 /* Isolate the tagname, from lbuf up to the first white */
2766 tagp->tagname = lbuf;
2767 #ifdef FEAT_TAG_ANYWHITE
2768 p = skiptowhite(lbuf);
2769 #else
2770 p = vim_strchr(lbuf, TAB);
2771 if (p == NULL)
2772 return FAIL;
2773 #endif
2774 tagp->tagname_end = p;
2776 /* Isolate file name, from first to second white space */
2777 #ifdef FEAT_TAG_ANYWHITE
2778 p = skipwhite(p);
2779 #else
2780 if (*p != NUL)
2781 ++p;
2782 #endif
2783 tagp->fname = p;
2784 #ifdef FEAT_TAG_ANYWHITE
2785 p = skiptowhite(p);
2786 #else
2787 p = vim_strchr(p, TAB);
2788 if (p == NULL)
2789 return FAIL;
2790 #endif
2791 tagp->fname_end = p;
2793 /* find start of search command, after second white space */
2794 #ifdef FEAT_TAG_ANYWHITE
2795 p = skipwhite(p);
2796 #else
2797 if (*p != NUL)
2798 ++p;
2799 #endif
2800 if (*p == NUL)
2801 return FAIL;
2802 tagp->command = p;
2803 #ifdef FEAT_EMACS_TAGS
2805 #endif
2807 return OK;
2811 * Check if tagname is a static tag
2813 * Static tags produced by the older ctags program have the format:
2814 * 'file:tag file /pattern'.
2815 * This is only recognized when both occurrence of 'file' are the same, to
2816 * avoid recognizing "string::string" or ":exit".
2818 * Static tags produced by the new ctags program have the format:
2819 * 'tag file /pattern/;"<Tab>file:' "
2821 * Return TRUE if it is a static tag and adjust *tagname to the real tag.
2822 * Return FALSE if it is not a static tag.
2824 static int
2825 test_for_static(tagp)
2826 tagptrs_T *tagp;
2828 char_u *p;
2830 #ifdef FEAT_TAG_OLDSTATIC
2831 int len;
2834 * Check for old style static tag: "file:tag file .."
2836 len = (int)(tagp->fname_end - tagp->fname);
2837 p = tagp->tagname + len;
2838 if ( p < tagp->tagname_end
2839 && *p == ':'
2840 && fnamencmp(tagp->tagname, tagp->fname, len) == 0)
2842 tagp->tagname = p + 1;
2843 return TRUE;
2845 #endif
2848 * Check for new style static tag ":...<Tab>file:[<Tab>...]"
2850 p = tagp->command;
2851 while ((p = vim_strchr(p, '\t')) != NULL)
2853 ++p;
2854 if (STRNCMP(p, "file:", 5) == 0)
2855 return TRUE;
2858 return FALSE;
2862 * Parse a line from a matching tag. Does not change the line itself.
2864 * The line that we get looks like this:
2865 * Emacs tag: <mtt><tag_fname><NUL><ebuf><NUL><lbuf>
2866 * other tag: <mtt><tag_fname><NUL><NUL><lbuf>
2867 * without Emacs tags: <mtt><tag_fname><NUL><lbuf>
2869 * Return OK or FAIL.
2871 static int
2872 parse_match(lbuf, tagp)
2873 char_u *lbuf; /* input: matching line */
2874 tagptrs_T *tagp; /* output: pointers into the line */
2876 int retval;
2877 char_u *p;
2878 char_u *pc, *pt;
2880 tagp->tag_fname = lbuf + 1;
2881 lbuf += STRLEN(tagp->tag_fname) + 2;
2882 #ifdef FEAT_EMACS_TAGS
2883 if (*lbuf)
2885 tagp->is_etag = TRUE;
2886 tagp->fname = lbuf;
2887 lbuf += STRLEN(lbuf);
2888 tagp->fname_end = lbuf++;
2890 else
2892 tagp->is_etag = FALSE;
2893 ++lbuf;
2895 #endif
2897 /* Find search pattern and the file name for non-etags. */
2898 retval = parse_tag_line(lbuf,
2899 #ifdef FEAT_EMACS_TAGS
2900 tagp->is_etag,
2901 #endif
2902 tagp);
2904 tagp->tagkind = NULL;
2905 tagp->command_end = NULL;
2907 if (retval == OK)
2909 /* Try to find a kind field: "kind:<kind>" or just "<kind>"*/
2910 p = tagp->command;
2911 if (find_extra(&p) == OK)
2913 tagp->command_end = p;
2914 p += 2; /* skip ";\"" */
2915 if (*p++ == TAB)
2916 while (ASCII_ISALPHA(*p))
2918 if (STRNCMP(p, "kind:", 5) == 0)
2920 tagp->tagkind = p + 5;
2921 break;
2923 pc = vim_strchr(p, ':');
2924 pt = vim_strchr(p, '\t');
2925 if (pc == NULL || (pt != NULL && pc > pt))
2927 tagp->tagkind = p;
2928 break;
2930 if (pt == NULL)
2931 break;
2932 p = pt + 1;
2935 if (tagp->tagkind != NULL)
2937 for (p = tagp->tagkind;
2938 *p && *p != '\t' && *p != '\r' && *p != '\n'; ++p)
2940 tagp->tagkind_end = p;
2943 return retval;
2947 * Find out the actual file name of a tag. Concatenate the tags file name
2948 * with the matching tag file name.
2949 * Returns an allocated string or NULL (out of memory).
2951 static char_u *
2952 tag_full_fname(tagp)
2953 tagptrs_T *tagp;
2955 char_u *fullname;
2956 int c;
2958 #ifdef FEAT_EMACS_TAGS
2959 if (tagp->is_etag)
2960 c = 0; /* to shut up GCC */
2961 else
2962 #endif
2964 c = *tagp->fname_end;
2965 *tagp->fname_end = NUL;
2967 fullname = expand_tag_fname(tagp->fname, tagp->tag_fname, FALSE);
2969 #ifdef FEAT_EMACS_TAGS
2970 if (!tagp->is_etag)
2971 #endif
2972 *tagp->fname_end = c;
2974 return fullname;
2978 * Jump to a tag that has been found in one of the tag files
2980 * returns OK for success, NOTAGFILE when file not found, FAIL otherwise.
2982 static int
2983 jumpto_tag(lbuf, forceit, keep_help)
2984 char_u *lbuf; /* line from the tags file for this tag */
2985 int forceit; /* :ta with ! */
2986 int keep_help; /* keep help flag (FALSE for cscope) */
2988 int save_secure;
2989 int save_magic;
2990 int save_p_ws, save_p_scs, save_p_ic;
2991 linenr_T save_lnum;
2992 int csave = 0;
2993 char_u *str;
2994 char_u *pbuf; /* search pattern buffer */
2995 char_u *pbuf_end;
2996 char_u *tofree_fname = NULL;
2997 char_u *fname;
2998 tagptrs_T tagp;
2999 int retval = FAIL;
3000 int getfile_result;
3001 int search_options;
3002 #ifdef FEAT_SEARCH_EXTRA
3003 int save_no_hlsearch;
3004 #endif
3005 #if defined(FEAT_WINDOWS) && defined(FEAT_QUICKFIX)
3006 win_T *curwin_save = NULL;
3007 #endif
3008 char_u *full_fname = NULL;
3009 #ifdef FEAT_FOLDING
3010 int old_KeyTyped = KeyTyped; /* getting the file may reset it */
3011 #endif
3013 pbuf = alloc(LSIZE);
3015 /* parse the match line into the tagp structure */
3016 if (pbuf == NULL || parse_match(lbuf, &tagp) == FAIL)
3018 tagp.fname_end = NULL;
3019 goto erret;
3022 /* truncate the file name, so it can be used as a string */
3023 csave = *tagp.fname_end;
3024 *tagp.fname_end = NUL;
3025 fname = tagp.fname;
3027 /* copy the command to pbuf[], remove trailing CR/NL */
3028 str = tagp.command;
3029 for (pbuf_end = pbuf; *str && *str != '\n' && *str != '\r'; )
3031 #ifdef FEAT_EMACS_TAGS
3032 if (tagp.is_etag && *str == ',')/* stop at ',' after line number */
3033 break;
3034 #endif
3035 *pbuf_end++ = *str++;
3037 *pbuf_end = NUL;
3039 #ifdef FEAT_EMACS_TAGS
3040 if (!tagp.is_etag)
3041 #endif
3044 * Remove the "<Tab>fieldname:value" stuff; we don't need it here.
3046 str = pbuf;
3047 if (find_extra(&str) == OK)
3049 pbuf_end = str;
3050 *pbuf_end = NUL;
3055 * Expand file name, when needed (for environment variables).
3056 * If 'tagrelative' option set, may change file name.
3058 fname = expand_tag_fname(fname, tagp.tag_fname, TRUE);
3059 if (fname == NULL)
3060 goto erret;
3061 tofree_fname = fname; /* free() it later */
3064 * Check if the file with the tag exists before abandoning the current
3065 * file. Also accept a file name for which there is a matching BufReadCmd
3066 * autocommand event (e.g., http://sys/file).
3068 if (mch_getperm(fname) < 0
3069 #ifdef FEAT_AUTOCMD
3070 && !has_autocmd(EVENT_BUFREADCMD, fname, NULL)
3071 #endif
3074 retval = NOTAGFILE;
3075 vim_free(nofile_fname);
3076 nofile_fname = vim_strsave(fname);
3077 if (nofile_fname == NULL)
3078 nofile_fname = empty_option;
3079 goto erret;
3082 ++RedrawingDisabled;
3084 #ifdef FEAT_GUI
3085 need_mouse_correct = TRUE;
3086 #endif
3088 #if defined(FEAT_WINDOWS) && defined(FEAT_QUICKFIX)
3089 if (g_do_tagpreview)
3091 postponed_split = 0; /* don't split again below */
3092 curwin_save = curwin; /* Save current window */
3095 * If we are reusing a window, we may change dir when
3096 * entering it (autocommands) so turn the tag filename
3097 * into a fullpath
3099 if (!curwin->w_p_pvw)
3101 full_fname = FullName_save(fname, FALSE);
3102 fname = full_fname;
3105 * Make the preview window the current window.
3106 * Open a preview window when needed.
3108 prepare_tagpreview(TRUE);
3112 /* If it was a CTRL-W CTRL-] command split window now. For ":tab tag"
3113 * open a new tab page. */
3114 if (postponed_split || cmdmod.tab != 0)
3116 win_split(postponed_split > 0 ? postponed_split : 0,
3117 postponed_split_flags);
3118 # ifdef FEAT_SCROLLBIND
3119 curwin->w_p_scb = FALSE;
3120 # endif
3122 #endif
3124 if (keep_help)
3126 /* A :ta from a help file will keep the b_help flag set. For ":ptag"
3127 * we need to use the flag from the window where we came from. */
3128 #if defined(FEAT_WINDOWS) && defined(FEAT_QUICKFIX)
3129 if (g_do_tagpreview)
3130 keep_help_flag = curwin_save->w_buffer->b_help;
3131 else
3132 #endif
3133 keep_help_flag = curbuf->b_help;
3135 getfile_result = getfile(0, fname, NULL, TRUE, (linenr_T)0, forceit);
3136 keep_help_flag = FALSE;
3138 if (getfile_result <= 0) /* got to the right file */
3140 curwin->w_set_curswant = TRUE;
3141 #ifdef FEAT_WINDOWS
3142 postponed_split = 0;
3143 #endif
3145 save_secure = secure;
3146 secure = 1;
3147 #ifdef HAVE_SANDBOX
3148 ++sandbox;
3149 #endif
3150 save_magic = p_magic;
3151 p_magic = FALSE; /* always execute with 'nomagic' */
3152 #ifdef FEAT_SEARCH_EXTRA
3153 /* Save value of no_hlsearch, jumping to a tag is not a real search */
3154 save_no_hlsearch = no_hlsearch;
3155 #endif
3158 * If 'cpoptions' contains 't', store the search pattern for the "n"
3159 * command. If 'cpoptions' does not contain 't', the search pattern
3160 * is not stored.
3162 if (vim_strchr(p_cpo, CPO_TAGPAT) != NULL)
3163 search_options = 0;
3164 else
3165 search_options = SEARCH_KEEP;
3168 * If the command is a search, try here.
3170 * Reset 'smartcase' for the search, since the search pattern was not
3171 * typed by the user.
3172 * Only use do_search() when there is a full search command, without
3173 * anything following.
3175 str = pbuf;
3176 if (pbuf[0] == '/' || pbuf[0] == '?')
3177 str = skip_regexp(pbuf + 1, pbuf[0], FALSE, NULL) + 1;
3178 if (str > pbuf_end - 1) /* search command with nothing following */
3180 save_p_ws = p_ws;
3181 save_p_ic = p_ic;
3182 save_p_scs = p_scs;
3183 p_ws = TRUE; /* need 'wrapscan' for backward searches */
3184 p_ic = FALSE; /* don't ignore case now */
3185 p_scs = FALSE;
3186 #if 0 /* disabled for now */
3187 #ifdef FEAT_CMDHIST
3188 /* put pattern in search history */
3189 add_to_history(HIST_SEARCH, pbuf + 1, TRUE, pbuf[0]);
3190 #endif
3191 #endif
3192 save_lnum = curwin->w_cursor.lnum;
3193 curwin->w_cursor.lnum = 0; /* start search before first line */
3194 if (do_search(NULL, pbuf[0], pbuf + 1, (long)1, search_options))
3195 retval = OK;
3196 else
3198 int found = 1;
3199 int cc;
3202 * try again, ignore case now
3204 p_ic = TRUE;
3205 if (!do_search(NULL, pbuf[0], pbuf + 1, (long)1,
3206 search_options))
3209 * Failed to find pattern, take a guess: "^func ("
3211 found = 2;
3212 (void)test_for_static(&tagp);
3213 cc = *tagp.tagname_end;
3214 *tagp.tagname_end = NUL;
3215 sprintf((char *)pbuf, "^%s\\s\\*(", tagp.tagname);
3216 if (!do_search(NULL, '/', pbuf, (long)1, search_options))
3218 /* Guess again: "^char * \<func (" */
3219 sprintf((char *)pbuf, "^\\[#a-zA-Z_]\\.\\*\\<%s\\s\\*(",
3220 tagp.tagname);
3221 if (!do_search(NULL, '/', pbuf, (long)1,
3222 search_options))
3223 found = 0;
3225 *tagp.tagname_end = cc;
3227 if (found == 0)
3229 EMSG(_("E434: Can't find tag pattern"));
3230 curwin->w_cursor.lnum = save_lnum;
3232 else
3235 * Only give a message when really guessed, not when 'ic'
3236 * is set and match found while ignoring case.
3238 if (found == 2 || !save_p_ic)
3240 MSG(_("E435: Couldn't find tag, just guessing!"));
3241 if (!msg_scrolled && msg_silent == 0)
3243 out_flush();
3244 ui_delay(1000L, TRUE);
3247 retval = OK;
3250 p_ws = save_p_ws;
3251 p_ic = save_p_ic;
3252 p_scs = save_p_scs;
3254 /* A search command may have positioned the cursor beyond the end
3255 * of the line. May need to correct that here. */
3256 check_cursor();
3258 else
3260 curwin->w_cursor.lnum = 1; /* start command in line 1 */
3261 do_cmdline_cmd(pbuf);
3262 retval = OK;
3266 * When the command has done something that is not allowed make sure
3267 * the error message can be seen.
3269 if (secure == 2)
3270 wait_return(TRUE);
3271 secure = save_secure;
3272 p_magic = save_magic;
3273 #ifdef HAVE_SANDBOX
3274 --sandbox;
3275 #endif
3276 #ifdef FEAT_SEARCH_EXTRA
3277 /* restore no_hlsearch when keeping the old search pattern */
3278 if (search_options)
3279 no_hlsearch = save_no_hlsearch;
3280 #endif
3282 /* Return OK if jumped to another file (at least we found the file!). */
3283 if (getfile_result == -1)
3284 retval = OK;
3286 if (retval == OK)
3289 * For a help buffer: Put the cursor line at the top of the window,
3290 * the help subject will be below it.
3292 if (curbuf->b_help)
3293 set_topline(curwin, curwin->w_cursor.lnum);
3294 #ifdef FEAT_FOLDING
3295 if ((fdo_flags & FDO_TAG) && old_KeyTyped)
3296 foldOpenCursor();
3297 #endif
3300 #if defined(FEAT_WINDOWS) && defined(FEAT_QUICKFIX)
3301 if (g_do_tagpreview && curwin != curwin_save && win_valid(curwin_save))
3303 /* Return cursor to where we were */
3304 validate_cursor();
3305 redraw_later(VALID);
3306 win_enter(curwin_save, TRUE);
3308 #endif
3310 --RedrawingDisabled;
3312 else
3314 --RedrawingDisabled;
3315 #ifdef FEAT_WINDOWS
3316 if (postponed_split) /* close the window */
3318 win_close(curwin, FALSE);
3319 postponed_split = 0;
3321 #endif
3324 erret:
3325 #if defined(FEAT_WINDOWS) && defined(FEAT_QUICKFIX)
3326 g_do_tagpreview = 0; /* For next time */
3327 #endif
3328 if (tagp.fname_end != NULL)
3329 *tagp.fname_end = csave;
3330 vim_free(pbuf);
3331 vim_free(tofree_fname);
3332 vim_free(full_fname);
3334 return retval;
3338 * If "expand" is TRUE, expand wildcards in fname.
3339 * If 'tagrelative' option set, change fname (name of file containing tag)
3340 * according to tag_fname (name of tag file containing fname).
3341 * Returns a pointer to allocated memory (or NULL when out of memory).
3343 static char_u *
3344 expand_tag_fname(fname, tag_fname, expand)
3345 char_u *fname;
3346 char_u *tag_fname;
3347 int expand;
3349 char_u *p;
3350 char_u *retval;
3351 char_u *expanded_fname = NULL;
3352 expand_T xpc;
3355 * Expand file name (for environment variables) when needed.
3357 if (expand && mch_has_wildcard(fname))
3359 ExpandInit(&xpc);
3360 xpc.xp_context = EXPAND_FILES;
3361 expanded_fname = ExpandOne(&xpc, (char_u *)fname, NULL,
3362 WILD_LIST_NOTFOUND|WILD_SILENT, WILD_EXPAND_FREE);
3363 if (expanded_fname != NULL)
3364 fname = expanded_fname;
3367 if ((p_tr || curbuf->b_help)
3368 && !vim_isAbsName(fname)
3369 && (p = gettail(tag_fname)) != tag_fname)
3371 retval = alloc(MAXPATHL);
3372 if (retval != NULL)
3374 STRCPY(retval, tag_fname);
3375 vim_strncpy(retval + (p - tag_fname), fname,
3376 MAXPATHL - (p - tag_fname) - 1);
3378 * Translate names like "src/a/../b/file.c" into "src/b/file.c".
3380 simplify_filename(retval);
3383 else
3384 retval = vim_strsave(fname);
3386 vim_free(expanded_fname);
3388 return retval;
3392 * Moves the tail part of the path (including the terminating NUL) pointed to
3393 * by "tail" to the new location pointed to by "here". This should accomodate
3394 * an overlapping move.
3396 #define movetail(here, tail) mch_memmove(here, tail, STRLEN(tail) + (size_t)1)
3399 * Converts a file name into a canonical form. It simplifies a file name into
3400 * its simplest form by stripping out unneeded components, if any. The
3401 * resulting file name is simplified in place and will either be the same
3402 * length as that supplied, or shorter.
3404 void
3405 simplify_filename(filename)
3406 char_u *filename;
3408 #ifndef AMIGA /* Amiga doesn't have "..", it uses "/" */
3409 int components = 0;
3410 char_u *p, *tail, *start;
3411 int stripping_disabled = FALSE;
3412 int relative = TRUE;
3414 p = filename;
3415 #ifdef BACKSLASH_IN_FILENAME
3416 if (p[1] == ':') /* skip "x:" */
3417 p += 2;
3418 #endif
3420 if (vim_ispathsep(*p))
3422 relative = FALSE;
3424 ++p;
3425 while (vim_ispathsep(*p));
3427 start = p; /* remember start after "c:/" or "/" or "///" */
3431 /* At this point "p" is pointing to the char following a single "/"
3432 * or "p" is at the "start" of the (absolute or relative) path name. */
3433 #ifdef VMS
3434 /* VMS allows device:[path] - don't strip the [ in directory */
3435 if ((*p == '[' || *p == '<') && p > filename && p[-1] == ':')
3437 /* :[ or :< composition: vms directory component */
3438 ++components;
3439 p = getnextcomp(p + 1);
3441 /* allow remote calls as host"user passwd"::device:[path] */
3442 else if (p[0] == ':' && p[1] == ':' && p > filename && p[-1] == '"' )
3444 /* ":: composition: vms host/passwd component */
3445 ++components;
3446 p = getnextcomp(p + 2);
3448 else
3449 #endif
3450 if (vim_ispathsep(*p))
3451 movetail(p, p + 1); /* remove duplicate "/" */
3452 else if (p[0] == '.' && (vim_ispathsep(p[1]) || p[1] == NUL))
3454 if (p == start && relative)
3455 p += 1 + (p[1] != NUL); /* keep single "." or leading "./" */
3456 else
3458 /* Strip "./" or ".///". If we are at the end of the file name
3459 * and there is no trailing path separator, either strip "/." if
3460 * we are after "start", or strip "." if we are at the beginning
3461 * of an absolute path name . */
3462 tail = p + 1;
3463 if (p[1] != NUL)
3464 while (vim_ispathsep(*tail))
3465 mb_ptr_adv(tail);
3466 else if (p > start)
3467 --p; /* strip preceding path separator */
3468 movetail(p, tail);
3471 else if (p[0] == '.' && p[1] == '.' &&
3472 (vim_ispathsep(p[2]) || p[2] == NUL))
3474 /* Skip to after ".." or "../" or "..///". */
3475 tail = p + 2;
3476 while (vim_ispathsep(*tail))
3477 mb_ptr_adv(tail);
3479 if (components > 0) /* strip one preceding component */
3481 int do_strip = FALSE;
3482 char_u saved_char;
3483 struct stat st;
3485 /* Don't strip for an erroneous file name. */
3486 if (!stripping_disabled)
3488 /* If the preceding component does not exist in the file
3489 * system, we strip it. On Unix, we don't accept a symbolic
3490 * link that refers to a non-existent file. */
3491 saved_char = p[-1];
3492 p[-1] = NUL;
3493 #ifdef UNIX
3494 if (mch_lstat((char *)filename, &st) < 0)
3495 #else
3496 if (mch_stat((char *)filename, &st) < 0)
3497 #endif
3498 do_strip = TRUE;
3499 p[-1] = saved_char;
3501 --p;
3502 /* Skip back to after previous '/'. */
3503 while (p > start && !after_pathsep(start, p))
3504 mb_ptr_back(start, p);
3506 if (!do_strip)
3508 /* If the component exists in the file system, check
3509 * that stripping it won't change the meaning of the
3510 * file name. First get information about the
3511 * unstripped file name. This may fail if the component
3512 * to strip is not a searchable directory (but a regular
3513 * file, for instance), since the trailing "/.." cannot
3514 * be applied then. We don't strip it then since we
3515 * don't want to replace an erroneous file name by
3516 * a valid one, and we disable stripping of later
3517 * components. */
3518 saved_char = *tail;
3519 *tail = NUL;
3520 if (mch_stat((char *)filename, &st) >= 0)
3521 do_strip = TRUE;
3522 else
3523 stripping_disabled = TRUE;
3524 *tail = saved_char;
3525 #ifdef UNIX
3526 if (do_strip)
3528 struct stat new_st;
3530 /* On Unix, the check for the unstripped file name
3531 * above works also for a symbolic link pointing to
3532 * a searchable directory. But then the parent of
3533 * the directory pointed to by the link must be the
3534 * same as the stripped file name. (The latter
3535 * exists in the file system since it is the
3536 * component's parent directory.) */
3537 if (p == start && relative)
3538 (void)mch_stat(".", &new_st);
3539 else
3541 saved_char = *p;
3542 *p = NUL;
3543 (void)mch_stat((char *)filename, &new_st);
3544 *p = saved_char;
3547 if (new_st.st_ino != st.st_ino ||
3548 new_st.st_dev != st.st_dev)
3550 do_strip = FALSE;
3551 /* We don't disable stripping of later
3552 * components since the unstripped path name is
3553 * still valid. */
3556 #endif
3560 if (!do_strip)
3562 /* Skip the ".." or "../" and reset the counter for the
3563 * components that might be stripped later on. */
3564 p = tail;
3565 components = 0;
3567 else
3569 /* Strip previous component. If the result would get empty
3570 * and there is no trailing path separator, leave a single
3571 * "." instead. If we are at the end of the file name and
3572 * there is no trailing path separator and a preceding
3573 * component is left after stripping, strip its trailing
3574 * path separator as well. */
3575 if (p == start && relative && tail[-1] == '.')
3577 *p++ = '.';
3578 *p = NUL;
3580 else
3582 if (p > start && tail[-1] == '.')
3583 --p;
3584 movetail(p, tail); /* strip previous component */
3587 --components;
3590 else if (p == start && !relative) /* leading "/.." or "/../" */
3591 movetail(p, tail); /* strip ".." or "../" */
3592 else
3594 if (p == start + 2 && p[-2] == '.') /* leading "./../" */
3596 movetail(p - 2, p); /* strip leading "./" */
3597 tail -= 2;
3599 p = tail; /* skip to char after ".." or "../" */
3602 else
3604 ++components; /* simple path component */
3605 p = getnextcomp(p);
3607 } while (*p != NUL);
3608 #endif /* !AMIGA */
3612 * Check if we have a tag for the buffer with name "buf_ffname".
3613 * This is a bit slow, because of the full path compare in fullpathcmp().
3614 * Return TRUE if tag for file "fname" if tag file "tag_fname" is for current
3615 * file.
3617 static int
3618 #ifdef FEAT_EMACS_TAGS
3619 test_for_current(is_etag, fname, fname_end, tag_fname, buf_ffname)
3620 int is_etag;
3621 #else
3622 test_for_current(fname, fname_end, tag_fname, buf_ffname)
3623 #endif
3624 char_u *fname;
3625 char_u *fname_end;
3626 char_u *tag_fname;
3627 char_u *buf_ffname;
3629 int c;
3630 int retval = FALSE;
3631 char_u *fullname;
3633 if (buf_ffname != NULL) /* if the buffer has a name */
3635 #ifdef FEAT_EMACS_TAGS
3636 if (is_etag)
3637 c = 0; /* to shut up GCC */
3638 else
3639 #endif
3641 c = *fname_end;
3642 *fname_end = NUL;
3644 fullname = expand_tag_fname(fname, tag_fname, TRUE);
3645 if (fullname != NULL)
3647 retval = (fullpathcmp(fullname, buf_ffname, TRUE) & FPC_SAME);
3648 vim_free(fullname);
3650 #ifdef FEAT_EMACS_TAGS
3651 if (!is_etag)
3652 #endif
3653 *fname_end = c;
3656 return retval;
3660 * Find the end of the tagaddress.
3661 * Return OK if ";\"" is following, FAIL otherwise.
3663 static int
3664 find_extra(pp)
3665 char_u **pp;
3667 char_u *str = *pp;
3669 /* Repeat for addresses separated with ';' */
3670 for (;;)
3672 if (VIM_ISDIGIT(*str))
3673 str = skipdigits(str);
3674 else if (*str == '/' || *str == '?')
3676 str = skip_regexp(str + 1, *str, FALSE, NULL);
3677 if (*str != **pp)
3678 str = NULL;
3679 else
3680 ++str;
3682 else
3683 str = NULL;
3684 if (str == NULL || *str != ';'
3685 || !(VIM_ISDIGIT(str[1]) || str[1] == '/' || str[1] == '?'))
3686 break;
3687 ++str; /* skip ';' */
3690 if (str != NULL && STRNCMP(str, ";\"", 2) == 0)
3692 *pp = str;
3693 return OK;
3695 return FAIL;
3698 #if defined(FEAT_CMDL_COMPL) || defined(PROTO)
3700 expand_tags(tagnames, pat, num_file, file)
3701 int tagnames; /* expand tag names */
3702 char_u *pat;
3703 int *num_file;
3704 char_u ***file;
3706 int i;
3707 int c;
3708 int tagnmflag;
3709 char_u tagnm[100];
3710 tagptrs_T t_p;
3711 int ret;
3713 if (tagnames)
3714 tagnmflag = TAG_NAMES;
3715 else
3716 tagnmflag = 0;
3717 if (pat[0] == '/')
3718 ret = find_tags(pat + 1, num_file, file,
3719 TAG_REGEXP | tagnmflag | TAG_VERBOSE,
3720 TAG_MANY, curbuf->b_ffname);
3721 else
3722 ret = find_tags(pat, num_file, file,
3723 TAG_REGEXP | tagnmflag | TAG_VERBOSE | TAG_NOIC,
3724 TAG_MANY, curbuf->b_ffname);
3725 if (ret == OK && !tagnames)
3727 /* Reorganize the tags for display and matching as strings of:
3728 * "<tagname>\0<kind>\0<filename>\0"
3730 for (i = 0; i < *num_file; i++)
3732 parse_match((*file)[i], &t_p);
3733 c = (int)(t_p.tagname_end - t_p.tagname);
3734 mch_memmove(tagnm, t_p.tagname, (size_t)c);
3735 tagnm[c++] = 0;
3736 tagnm[c++] = (t_p.tagkind != NULL && *t_p.tagkind)
3737 ? *t_p.tagkind : 'f';
3738 tagnm[c++] = 0;
3739 mch_memmove((*file)[i] + c, t_p.fname, t_p.fname_end - t_p.fname);
3740 (*file)[i][c + (t_p.fname_end - t_p.fname)] = 0;
3741 mch_memmove((*file)[i], tagnm, (size_t)c);
3744 return ret;
3746 #endif
3748 #if defined(FEAT_EVAL) || defined(PROTO)
3749 static int add_tag_field __ARGS((dict_T *dict, char *field_name, char_u *start, char_u *end));
3752 * Add a tag field to the dictionary "dict"
3754 static int
3755 add_tag_field(dict, field_name, start, end)
3756 dict_T *dict;
3757 char *field_name;
3758 char_u *start; /* start of the value */
3759 char_u *end; /* after the value; can be NULL */
3761 char_u buf[MAXPATHL];
3762 int len = 0;
3764 if (start != NULL)
3766 if (end == NULL)
3768 end = start + STRLEN(start);
3769 while (end > start && (end[-1] == '\r' || end[-1] == '\n'))
3770 --end;
3772 len = (int)(end - start);
3773 if (len > sizeof(buf) - 1)
3774 len = sizeof(buf) - 1;
3775 vim_strncpy(buf, start, len);
3777 buf[len] = NUL;
3778 return dict_add_nr_str(dict, field_name, 0L, buf);
3782 * Add the tags matching the specified pattern to the list "list"
3783 * as a dictionary
3786 get_tags(list, pat)
3787 list_T *list;
3788 char_u *pat;
3790 int num_matches, i, ret;
3791 char_u **matches, *p;
3792 char_u *full_fname;
3793 dict_T *dict;
3794 tagptrs_T tp;
3795 long is_static;
3797 ret = find_tags(pat, &num_matches, &matches,
3798 TAG_REGEXP | TAG_NOIC, (int)MAXCOL, NULL);
3799 if (ret == OK && num_matches > 0)
3801 for (i = 0; i < num_matches; ++i)
3803 parse_match(matches[i], &tp);
3804 is_static = test_for_static(&tp);
3806 /* Skip pseudo-tag lines. */
3807 if (STRNCMP(tp.tagname, "!_TAG_", 6) == 0)
3808 continue;
3810 if ((dict = dict_alloc()) == NULL)
3811 ret = FAIL;
3812 if (list_append_dict(list, dict) == FAIL)
3813 ret = FAIL;
3815 full_fname = tag_full_fname(&tp);
3816 if (add_tag_field(dict, "name", tp.tagname, tp.tagname_end) == FAIL
3817 || add_tag_field(dict, "filename", full_fname,
3818 NULL) == FAIL
3819 || add_tag_field(dict, "cmd", tp.command,
3820 tp.command_end) == FAIL
3821 || add_tag_field(dict, "kind", tp.tagkind,
3822 tp.tagkind_end) == FAIL
3823 || dict_add_nr_str(dict, "static", is_static, NULL) == FAIL)
3824 ret = FAIL;
3826 vim_free(full_fname);
3828 if (tp.command_end != NULL)
3830 for (p = tp.command_end + 3;
3831 *p != NUL && *p != '\n' && *p != '\r'; ++p)
3833 if (p == tp.tagkind || (p + 5 == tp.tagkind
3834 && STRNCMP(p, "kind:", 5) == 0))
3835 /* skip "kind:<kind>" and "<kind>" */
3836 p = tp.tagkind_end - 1;
3837 else if (STRNCMP(p, "file:", 5) == 0)
3838 /* skip "file:" (static tag) */
3839 p += 4;
3840 else if (!vim_iswhite(*p))
3842 char_u *s, *n;
3843 int len;
3845 /* Add extra field as a dict entry. Fields are
3846 * separated by Tabs. */
3847 n = p;
3848 while (*p != NUL && *p >= ' ' && *p < 127 && *p != ':')
3849 ++p;
3850 len = (int)(p - n);
3851 if (*p == ':' && len > 0)
3853 s = ++p;
3854 while (*p != NUL && *p >= ' ')
3855 ++p;
3856 n[len] = NUL;
3857 if (add_tag_field(dict, (char *)n, s, p) == FAIL)
3858 ret = FAIL;
3859 n[len] = ':';
3861 else
3862 /* Skip field without colon. */
3863 while (*p != NUL && *p >= ' ')
3864 ++p;
3869 vim_free(matches[i]);
3871 vim_free(matches);
3873 return ret;
3875 #endif