Merge branch 'vim' into fix/fast-join
[vim_extended.git] / src / if_cscope.c
bloba9a0506b80dd85fba66f150b85c22565ce788a45
1 /* vi:set ts=8 sts=4 sw=4:
3 * CSCOPE support for Vim added by Andy Kahn <kahn@zk3.dec.com>
4 * Ported to Win32 by Sergey Khorev <sergey.khorev@gmail.com>
6 * The basic idea/structure of cscope for Vim was borrowed from Nvi. There
7 * might be a few lines of code that look similar to what Nvi has.
9 * See README.txt for an overview of the Vim source code.
12 #include "vim.h"
14 #if defined(FEAT_CSCOPE) || defined(PROTO)
16 #include <string.h>
17 #include <errno.h>
18 #include <assert.h>
19 #include <sys/types.h>
20 #include <sys/stat.h>
21 #if defined(UNIX)
22 # include <sys/wait.h>
23 #else
24 /* not UNIX, must be WIN32 */
25 # include "vimio.h"
26 #endif
27 #include "if_cscope.h"
29 static void cs_usage_msg __ARGS((csid_e x));
30 static int cs_add __ARGS((exarg_T *eap));
31 static void cs_stat_emsg __ARGS((char *fname));
32 static int cs_add_common __ARGS((char *, char *, char *));
33 static int cs_check_for_connections __ARGS((void));
34 static int cs_check_for_tags __ARGS((void));
35 static int cs_cnt_connections __ARGS((void));
36 static void cs_reading_emsg __ARGS((int idx));
37 static int cs_cnt_matches __ARGS((int idx));
38 static char * cs_create_cmd __ARGS((char *csoption, char *pattern));
39 static int cs_create_connection __ARGS((int i));
40 static void do_cscope_general __ARGS((exarg_T *eap, int make_split));
41 #ifdef FEAT_QUICKFIX
42 static void cs_file_results __ARGS((FILE *, int *));
43 #endif
44 static void cs_fill_results __ARGS((char *, int , int *, char ***,
45 char ***, int *));
46 static int cs_find __ARGS((exarg_T *eap));
47 static int cs_find_common __ARGS((char *opt, char *pat, int, int, int));
48 static int cs_help __ARGS((exarg_T *eap));
49 static void cs_init __ARGS((void));
50 static void clear_csinfo __ARGS((int i));
51 static int cs_insert_filelist __ARGS((char *, char *, char *,
52 struct stat *));
53 static int cs_kill __ARGS((exarg_T *eap));
54 static void cs_kill_execute __ARGS((int, char *));
55 static cscmd_T * cs_lookup_cmd __ARGS((exarg_T *eap));
56 static char * cs_make_vim_style_matches __ARGS((char *, char *,
57 char *, char *));
58 static char * cs_manage_matches __ARGS((char **, char **, int, mcmd_e));
59 static char * cs_parse_results __ARGS((int cnumber, char *buf, int bufsize, char **context, char **linenumber, char **search));
60 static char * cs_pathcomponents __ARGS((char *path));
61 static void cs_print_tags_priv __ARGS((char **, char **, int));
62 static int cs_read_prompt __ARGS((int));
63 static void cs_release_csp __ARGS((int, int freefnpp));
64 static int cs_reset __ARGS((exarg_T *eap));
65 static char * cs_resolve_file __ARGS((int, char *));
66 static int cs_show __ARGS((exarg_T *eap));
69 static csinfo_T csinfo[CSCOPE_MAX_CONNECTIONS];
70 static int eap_arg_len; /* length of eap->arg, set in
71 cs_lookup_cmd() */
72 static cscmd_T cs_cmds[] =
74 { "add", cs_add,
75 N_("Add a new database"), "add file|dir [pre-path] [flags]", 0 },
76 { "find", cs_find,
77 N_("Query for a pattern"), "find c|d|e|f|g|i|s|t name", 1 },
78 { "help", cs_help,
79 N_("Show this message"), "help", 0 },
80 { "kill", cs_kill,
81 N_("Kill a connection"), "kill #", 0 },
82 { "reset", cs_reset,
83 N_("Reinit all connections"), "reset", 0 },
84 { "show", cs_show,
85 N_("Show connections"), "show", 0 },
86 { NULL }
89 static void
90 cs_usage_msg(x)
91 csid_e x;
93 (void)EMSG2(_("E560: Usage: cs[cope] %s"), cs_cmds[(int)x].usage);
97 * PRIVATE: do_cscope_general
99 * find the command, print help if invalid, and the then call the
100 * corresponding command function,
101 * called from do_cscope and do_scscope
103 static void
104 do_cscope_general(eap, make_split)
105 exarg_T *eap;
106 int make_split; /* whether to split window */
108 cscmd_T *cmdp;
110 cs_init();
111 if ((cmdp = cs_lookup_cmd(eap)) == NULL)
113 cs_help(eap);
114 return;
117 #ifdef FEAT_WINDOWS
118 if (make_split)
120 if (!cmdp->cansplit)
122 (void)MSG_PUTS(_("This cscope command does not support splitting the window.\n"));
123 return;
125 postponed_split = -1;
126 postponed_split_flags = cmdmod.split;
127 postponed_split_tab = cmdmod.tab;
129 #endif
131 cmdp->func(eap);
133 #ifdef FEAT_WINDOWS
134 postponed_split_flags = 0;
135 postponed_split_tab = 0;
136 #endif
140 * PUBLIC: do_cscope
142 void
143 do_cscope(eap)
144 exarg_T *eap;
146 do_cscope_general(eap, FALSE);
150 * PUBLIC: do_scscope
152 * same as do_cscope, but splits window, too.
154 void
155 do_scscope(eap)
156 exarg_T *eap;
158 do_cscope_general(eap, TRUE);
162 * PUBLIC: do_cstag
165 void
166 do_cstag(eap)
167 exarg_T *eap;
169 int ret = FALSE;
171 cs_init();
173 if (*eap->arg == NUL)
175 (void)EMSG(_("E562: Usage: cstag <ident>"));
176 return;
179 switch (p_csto)
181 case 0 :
182 if (cs_check_for_connections())
184 ret = cs_find_common("g", (char *)(eap->arg), eap->forceit, FALSE,
185 FALSE);
186 if (ret == FALSE)
188 cs_free_tags();
189 if (msg_col)
190 msg_putchar('\n');
192 if (cs_check_for_tags())
193 ret = do_tag(eap->arg, DT_JUMP, 0, eap->forceit, FALSE);
196 else if (cs_check_for_tags())
198 ret = do_tag(eap->arg, DT_JUMP, 0, eap->forceit, FALSE);
200 break;
201 case 1 :
202 if (cs_check_for_tags())
204 ret = do_tag(eap->arg, DT_JUMP, 0, eap->forceit, FALSE);
205 if (ret == FALSE)
207 if (msg_col)
208 msg_putchar('\n');
210 if (cs_check_for_connections())
212 ret = cs_find_common("g", (char *)(eap->arg), eap->forceit,
213 FALSE, FALSE);
214 if (ret == FALSE)
215 cs_free_tags();
219 else if (cs_check_for_connections())
221 ret = cs_find_common("g", (char *)(eap->arg), eap->forceit, FALSE,
222 FALSE);
223 if (ret == FALSE)
224 cs_free_tags();
226 break;
227 default :
228 break;
231 if (!ret)
233 (void)EMSG(_("E257: cstag: tag not found"));
234 #if defined(FEAT_WINDOWS) && defined(FEAT_QUICKFIX)
235 g_do_tagpreview = 0;
236 #endif
239 } /* do_cscope */
243 * PUBLIC: cs_find
245 * this simulates a vim_fgets(), but for cscope, returns the next line
246 * from the cscope output. should only be called from find_tags()
248 * returns TRUE if eof, FALSE otherwise
251 cs_fgets(buf, size)
252 char_u *buf;
253 int size;
255 char *p;
257 if ((p = cs_manage_matches(NULL, NULL, -1, Get)) == NULL)
258 return TRUE;
259 vim_strncpy(buf, (char_u *)p, size - 1);
261 return FALSE;
262 } /* cs_fgets */
266 * PUBLIC: cs_free_tags
268 * called only from do_tag(), when popping the tag stack
270 void
271 cs_free_tags()
273 cs_manage_matches(NULL, NULL, -1, Free);
278 * PUBLIC: cs_print_tags
280 * called from do_tag()
282 void
283 cs_print_tags()
285 cs_manage_matches(NULL, NULL, -1, Print);
290 * "cscope_connection([{num} , {dbpath} [, {prepend}]])" function
292 * Checks for the existence of a |cscope| connection. If no
293 * parameters are specified, then the function returns:
295 * 0, if cscope was not available (not compiled in), or if there
296 * are no cscope connections; or
297 * 1, if there is at least one cscope connection.
299 * If parameters are specified, then the value of {num}
300 * determines how existence of a cscope connection is checked:
302 * {num} Description of existence check
303 * ----- ------------------------------
304 * 0 Same as no parameters (e.g., "cscope_connection()").
305 * 1 Ignore {prepend}, and use partial string matches for
306 * {dbpath}.
307 * 2 Ignore {prepend}, and use exact string matches for
308 * {dbpath}.
309 * 3 Use {prepend}, use partial string matches for both
310 * {dbpath} and {prepend}.
311 * 4 Use {prepend}, use exact string matches for both
312 * {dbpath} and {prepend}.
314 * Note: All string comparisons are case sensitive!
316 #if defined(FEAT_EVAL) || defined(PROTO)
318 cs_connection(num, dbpath, ppath)
319 int num;
320 char_u *dbpath;
321 char_u *ppath;
323 int i;
325 if (num < 0 || num > 4 || (num > 0 && !dbpath))
326 return FALSE;
328 for (i = 0; i < CSCOPE_MAX_CONNECTIONS; i++)
330 if (!csinfo[i].fname)
331 continue;
333 if (num == 0)
334 return TRUE;
336 switch (num)
338 case 1:
339 if (strstr(csinfo[i].fname, (char *)dbpath))
340 return TRUE;
341 break;
342 case 2:
343 if (strcmp(csinfo[i].fname, (char *)dbpath) == 0)
344 return TRUE;
345 break;
346 case 3:
347 if (strstr(csinfo[i].fname, (char *)dbpath)
348 && ((!ppath && !csinfo[i].ppath)
349 || (ppath
350 && csinfo[i].ppath
351 && strstr(csinfo[i].ppath, (char *)ppath))))
352 return TRUE;
353 break;
354 case 4:
355 if ((strcmp(csinfo[i].fname, (char *)dbpath) == 0)
356 && ((!ppath && !csinfo[i].ppath)
357 || (ppath
358 && csinfo[i].ppath
359 && (strcmp(csinfo[i].ppath, (char *)ppath) == 0))))
360 return TRUE;
361 break;
365 return FALSE;
366 } /* cs_connection */
367 #endif
371 * PRIVATE functions
372 ****************************************************************************/
375 * PRIVATE: cs_add
377 * add cscope database or a directory name (to look for cscope.out)
378 * to the cscope connection list
380 * MAXPATHL 256
382 /* ARGSUSED */
383 static int
384 cs_add(eap)
385 exarg_T *eap;
387 char *fname, *ppath, *flags = NULL;
389 if ((fname = strtok((char *)NULL, (const char *)" ")) == NULL)
391 cs_usage_msg(Add);
392 return CSCOPE_FAILURE;
394 if ((ppath = strtok((char *)NULL, (const char *)" ")) != NULL)
395 flags = strtok((char *)NULL, (const char *)" ");
397 return cs_add_common(fname, ppath, flags);
400 static void
401 cs_stat_emsg(fname)
402 char *fname;
404 char *stat_emsg = _("E563: stat(%s) error: %d");
405 char *buf = (char *)alloc((unsigned)strlen(stat_emsg) + MAXPATHL + 10);
407 if (buf != NULL)
409 (void)sprintf(buf, stat_emsg, fname, errno);
410 (void)EMSG(buf);
411 vim_free(buf);
413 else
414 (void)EMSG(_("E563: stat error"));
419 * PRIVATE: cs_add_common
421 * the common routine to add a new cscope connection. called by
422 * cs_add() and cs_reset(). i really don't like to do this, but this
423 * routine uses a number of goto statements.
425 static int
426 cs_add_common(arg1, arg2, flags)
427 char *arg1; /* filename - may contain environment variables */
428 char *arg2; /* prepend path - may contain environment variables */
429 char *flags;
431 struct stat statbuf;
432 int ret;
433 char *fname = NULL;
434 char *fname2 = NULL;
435 char *ppath = NULL;
436 int i;
438 /* get the filename (arg1), expand it, and try to stat it */
439 if ((fname = (char *)alloc(MAXPATHL + 1)) == NULL)
440 goto add_err;
442 expand_env((char_u *)arg1, (char_u *)fname, MAXPATHL);
443 ret = stat(fname, &statbuf);
444 if (ret < 0)
446 staterr:
447 if (p_csverbose)
448 cs_stat_emsg(fname);
449 goto add_err;
452 /* get the prepend path (arg2), expand it, and try to stat it */
453 if (arg2 != NULL)
455 struct stat statbuf2;
457 if ((ppath = (char *)alloc(MAXPATHL + 1)) == NULL)
458 goto add_err;
460 expand_env((char_u *)arg2, (char_u *)ppath, MAXPATHL);
461 ret = stat(ppath, &statbuf2);
462 if (ret < 0)
463 goto staterr;
466 /* if filename is a directory, append the cscope database name to it */
467 if ((statbuf.st_mode & S_IFMT) == S_IFDIR)
469 fname2 = (char *)alloc((unsigned)(strlen(CSCOPE_DBFILE) + strlen(fname) + 2));
470 if (fname2 == NULL)
471 goto add_err;
473 while (fname[strlen(fname)-1] == '/'
474 #ifdef WIN32
475 || fname[strlen(fname)-1] == '\\'
476 #endif
479 fname[strlen(fname)-1] = '\0';
480 if (strlen(fname) == 0)
481 break;
483 if (fname[0] == '\0')
484 (void)sprintf(fname2, "/%s", CSCOPE_DBFILE);
485 else
486 (void)sprintf(fname2, "%s/%s", fname, CSCOPE_DBFILE);
488 ret = stat(fname2, &statbuf);
489 if (ret < 0)
491 if (p_csverbose)
492 cs_stat_emsg(fname2);
493 goto add_err;
496 i = cs_insert_filelist(fname2, ppath, flags, &statbuf);
498 #if defined(UNIX)
499 else if (S_ISREG(statbuf.st_mode) || S_ISLNK(statbuf.st_mode))
500 #else
501 /* WIN32 - substitute define S_ISREG from os_unix.h */
502 else if (((statbuf.st_mode) & S_IFMT) == S_IFREG)
503 #endif
505 i = cs_insert_filelist(fname, ppath, flags, &statbuf);
507 else
509 if (p_csverbose)
510 (void)EMSG2(
511 _("E564: %s is not a directory or a valid cscope database"),
512 fname);
513 goto add_err;
516 if (i != -1)
518 if (cs_create_connection(i) == CSCOPE_FAILURE
519 || cs_read_prompt(i) == CSCOPE_FAILURE)
521 cs_release_csp(i, TRUE);
522 goto add_err;
525 if (p_csverbose)
527 msg_clr_eos();
528 (void)smsg_attr(hl_attr(HLF_R),
529 (char_u *)_("Added cscope database %s"),
530 csinfo[i].fname);
534 vim_free(fname);
535 vim_free(fname2);
536 vim_free(ppath);
537 return CSCOPE_SUCCESS;
539 add_err:
540 vim_free(fname2);
541 vim_free(fname);
542 vim_free(ppath);
543 return CSCOPE_FAILURE;
544 } /* cs_add_common */
547 static int
548 cs_check_for_connections()
550 return (cs_cnt_connections() > 0);
551 } /* cs_check_for_connections */
554 static int
555 cs_check_for_tags()
557 return (p_tags[0] != NUL && curbuf->b_p_tags != NULL);
558 } /* cs_check_for_tags */
562 * PRIVATE: cs_cnt_connections
564 * count the number of cscope connections
566 static int
567 cs_cnt_connections()
569 short i;
570 short cnt = 0;
572 for (i = 0; i < CSCOPE_MAX_CONNECTIONS; i++)
574 if (csinfo[i].fname != NULL)
575 cnt++;
577 return cnt;
578 } /* cs_cnt_connections */
580 static void
581 cs_reading_emsg(idx)
582 int idx; /* connection index */
584 EMSGN(_("E262: error reading cscope connection %ld"), idx);
587 #define CSREAD_BUFSIZE 2048
589 * PRIVATE: cs_cnt_matches
591 * count the number of matches for a given cscope connection.
593 static int
594 cs_cnt_matches(idx)
595 int idx;
597 char *stok;
598 char *buf;
599 int nlines;
601 buf = (char *)alloc(CSREAD_BUFSIZE);
602 if (buf == NULL)
603 return 0;
604 for (;;)
606 if (!fgets(buf, CSREAD_BUFSIZE, csinfo[idx].fr_fp))
608 if (feof(csinfo[idx].fr_fp))
609 errno = EIO;
611 cs_reading_emsg(idx);
613 vim_free(buf);
614 return -1;
618 * If the database is out of date, or there's some other problem,
619 * cscope will output error messages before the number-of-lines output.
620 * Display/discard any output that doesn't match what we want.
621 * Accept "\S*cscope: X lines", also matches "mlcscope".
623 if ((stok = strtok(buf, (const char *)" ")) == NULL)
624 continue;
625 if (strstr((const char *)stok, "cscope:") == NULL)
626 continue;
628 if ((stok = strtok(NULL, (const char *)" ")) == NULL)
629 continue;
630 nlines = atoi(stok);
631 if (nlines < 0)
633 nlines = 0;
634 break;
637 if ((stok = strtok(NULL, (const char *)" ")) == NULL)
638 continue;
639 if (strncmp((const char *)stok, "lines", 5))
640 continue;
642 break;
645 vim_free(buf);
646 return nlines;
647 } /* cs_cnt_matches */
651 * PRIVATE: cs_create_cmd
653 * Creates the actual cscope command query from what the user entered.
655 static char *
656 cs_create_cmd(csoption, pattern)
657 char *csoption;
658 char *pattern;
660 char *cmd;
661 short search;
663 switch (csoption[0])
665 case '0' : case 's' :
666 search = 0;
667 break;
668 case '1' : case 'g' :
669 search = 1;
670 break;
671 case '2' : case 'd' :
672 search = 2;
673 break;
674 case '3' : case 'c' :
675 search = 3;
676 break;
677 case '4' : case 't' :
678 search = 4;
679 break;
680 case '6' : case 'e' :
681 search = 6;
682 break;
683 case '7' : case 'f' :
684 search = 7;
685 break;
686 case '8' : case 'i' :
687 search = 8;
688 break;
689 default :
690 (void)EMSG(_("E561: unknown cscope search type"));
691 cs_usage_msg(Find);
692 return NULL;
695 if ((cmd = (char *)alloc((unsigned)(strlen(pattern) + 2))) == NULL)
696 return NULL;
698 (void)sprintf(cmd, "%d%s", search, pattern);
700 return cmd;
701 } /* cs_create_cmd */
705 * PRIVATE: cs_create_connection
707 * This piece of code was taken/adapted from nvi. do we need to add
708 * the BSD license notice?
710 static int
711 cs_create_connection(i)
712 int i;
714 #ifdef UNIX
715 int to_cs[2], from_cs[2];
716 #endif
717 int len;
718 char *prog, *cmd, *ppath = NULL;
719 #ifdef WIN32
720 int fd;
721 SECURITY_ATTRIBUTES sa;
722 PROCESS_INFORMATION pi;
723 STARTUPINFO si;
724 BOOL pipe_stdin = FALSE, pipe_stdout = FALSE;
725 HANDLE stdin_rd, stdout_rd;
726 HANDLE stdout_wr, stdin_wr;
727 BOOL created;
728 # ifdef __BORLANDC__
729 # define OPEN_OH_ARGTYPE long
730 # else
731 # if (_MSC_VER >= 1300)
732 # define OPEN_OH_ARGTYPE intptr_t
733 # else
734 # define OPEN_OH_ARGTYPE long
735 # endif
736 # endif
737 #endif
739 #if defined(UNIX)
741 * Cscope reads from to_cs[0] and writes to from_cs[1]; vi reads from
742 * from_cs[0] and writes to to_cs[1].
744 to_cs[0] = to_cs[1] = from_cs[0] = from_cs[1] = -1;
745 if (pipe(to_cs) < 0 || pipe(from_cs) < 0)
747 (void)EMSG(_("E566: Could not create cscope pipes"));
748 err_closing:
749 if (to_cs[0] != -1)
750 (void)close(to_cs[0]);
751 if (to_cs[1] != -1)
752 (void)close(to_cs[1]);
753 if (from_cs[0] != -1)
754 (void)close(from_cs[0]);
755 if (from_cs[1] != -1)
756 (void)close(from_cs[1]);
757 return CSCOPE_FAILURE;
760 switch (csinfo[i].pid = fork())
762 case -1:
763 (void)EMSG(_("E622: Could not fork for cscope"));
764 goto err_closing;
765 case 0: /* child: run cscope. */
766 if (dup2(to_cs[0], STDIN_FILENO) == -1)
767 PERROR("cs_create_connection 1");
768 if (dup2(from_cs[1], STDOUT_FILENO) == -1)
769 PERROR("cs_create_connection 2");
770 if (dup2(from_cs[1], STDERR_FILENO) == -1)
771 PERROR("cs_create_connection 3");
773 /* close unused */
774 (void)close(to_cs[1]);
775 (void)close(from_cs[0]);
776 #else
777 /* WIN32 */
778 /* Create pipes to communicate with cscope */
779 sa.nLength = sizeof(SECURITY_ATTRIBUTES);
780 sa.bInheritHandle = TRUE;
781 sa.lpSecurityDescriptor = NULL;
783 if (!(pipe_stdin = CreatePipe(&stdin_rd, &stdin_wr, &sa, 0))
784 || !(pipe_stdout = CreatePipe(&stdout_rd, &stdout_wr, &sa, 0)))
786 (void)EMSG(_("E566: Could not create cscope pipes"));
787 err_closing:
788 if (pipe_stdin)
790 CloseHandle(stdin_rd);
791 CloseHandle(stdin_wr);
793 if (pipe_stdout)
795 CloseHandle(stdout_rd);
796 CloseHandle(stdout_wr);
798 return CSCOPE_FAILURE;
800 #endif
801 /* expand the cscope exec for env var's */
802 if ((prog = (char *)alloc(MAXPATHL + 1)) == NULL)
804 #ifdef UNIX
805 return CSCOPE_FAILURE;
806 #else
807 /* WIN32 */
808 goto err_closing;
809 #endif
811 expand_env((char_u *)p_csprg, (char_u *)prog, MAXPATHL);
813 /* alloc space to hold the cscope command */
814 len = (int)(strlen(prog) + strlen(csinfo[i].fname) + 32);
815 if (csinfo[i].ppath)
817 /* expand the prepend path for env var's */
818 if ((ppath = (char *)alloc(MAXPATHL + 1)) == NULL)
820 vim_free(prog);
821 #ifdef UNIX
822 return CSCOPE_FAILURE;
823 #else
824 /* WIN32 */
825 goto err_closing;
826 #endif
828 expand_env((char_u *)csinfo[i].ppath, (char_u *)ppath, MAXPATHL);
830 len += (int)strlen(ppath);
833 if (csinfo[i].flags)
834 len += (int)strlen(csinfo[i].flags);
836 if ((cmd = (char *)alloc(len)) == NULL)
838 vim_free(prog);
839 vim_free(ppath);
840 #ifdef UNIX
841 return CSCOPE_FAILURE;
842 #else
843 /* WIN32 */
844 goto err_closing;
845 #endif
848 /* run the cscope command; is there execl for non-unix systems? */
849 #if defined(UNIX)
850 (void)sprintf(cmd, "exec %s -dl -f %s", prog, csinfo[i].fname);
851 #else
852 /* WIN32 */
853 (void)sprintf(cmd, "%s -dl -f %s", prog, csinfo[i].fname);
854 #endif
855 if (csinfo[i].ppath != NULL)
857 (void)strcat(cmd, " -P");
858 (void)strcat(cmd, csinfo[i].ppath);
860 if (csinfo[i].flags != NULL)
862 (void)strcat(cmd, " ");
863 (void)strcat(cmd, csinfo[i].flags);
865 # ifdef UNIX
866 /* on Win32 we still need prog */
867 vim_free(prog);
868 # endif
869 vim_free(ppath);
871 #if defined(UNIX)
872 if (execl("/bin/sh", "sh", "-c", cmd, NULL) == -1)
873 PERROR(_("cs_create_connection exec failed"));
875 exit(127);
876 /* NOTREACHED */
877 default: /* parent. */
879 * Save the file descriptors for later duplication, and
880 * reopen as streams.
882 if ((csinfo[i].to_fp = fdopen(to_cs[1], "w")) == NULL)
883 PERROR(_("cs_create_connection: fdopen for to_fp failed"));
884 if ((csinfo[i].fr_fp = fdopen(from_cs[0], "r")) == NULL)
885 PERROR(_("cs_create_connection: fdopen for fr_fp failed"));
887 /* close unused */
888 (void)close(to_cs[0]);
889 (void)close(from_cs[1]);
891 break;
894 #else
895 /* WIN32 */
896 /* Create a new process to run cscope and use pipes to talk with it */
897 GetStartupInfo(&si);
898 si.dwFlags = STARTF_USESTDHANDLES | STARTF_USESHOWWINDOW;
899 si.wShowWindow = SW_HIDE; /* Hide child application window */
900 si.hStdOutput = stdout_wr;
901 si.hStdError = stdout_wr;
902 si.hStdInput = stdin_rd;
903 created = CreateProcess(NULL, cmd, NULL, NULL, TRUE, CREATE_NEW_CONSOLE,
904 NULL, NULL, &si, &pi);
905 vim_free(prog);
906 vim_free(cmd);
908 if (!created)
910 PERROR(_("cs_create_connection exec failed"));
911 (void)EMSG(_("E623: Could not spawn cscope process"));
912 goto err_closing;
914 /* else */
915 csinfo[i].pid = pi.dwProcessId;
916 csinfo[i].hProc = pi.hProcess;
917 CloseHandle(pi.hThread);
919 /* TODO - tidy up after failure to create files on pipe handles. */
920 if (((fd = _open_osfhandle((OPEN_OH_ARGTYPE)stdin_wr,
921 _O_TEXT|_O_APPEND)) < 0)
922 || ((csinfo[i].to_fp = _fdopen(fd, "w")) == NULL))
923 PERROR(_("cs_create_connection: fdopen for to_fp failed"));
924 if (((fd = _open_osfhandle((OPEN_OH_ARGTYPE)stdout_rd,
925 _O_TEXT|_O_RDONLY)) < 0)
926 || ((csinfo[i].fr_fp = _fdopen(fd, "r")) == NULL))
927 PERROR(_("cs_create_connection: fdopen for fr_fp failed"));
929 /* Close handles for file descriptors inherited by the cscope process */
930 CloseHandle(stdin_rd);
931 CloseHandle(stdout_wr);
933 #endif /* !UNIX */
935 return CSCOPE_SUCCESS;
936 } /* cs_create_connection */
940 * PRIVATE: cs_find
942 * query cscope using command line interface. parse the output and use tselect
943 * to allow choices. like Nvi, creates a pipe to send to/from query/cscope.
945 * returns TRUE if we jump to a tag or abort, FALSE if not.
947 static int
948 cs_find(eap)
949 exarg_T *eap;
951 char *opt, *pat;
953 if (cs_check_for_connections() == FALSE)
955 (void)EMSG(_("E567: no cscope connections"));
956 return FALSE;
959 if ((opt = strtok((char *)NULL, (const char *)" ")) == NULL)
961 cs_usage_msg(Find);
962 return FALSE;
965 pat = opt + strlen(opt) + 1;
966 if (pat >= (char *)eap->arg + eap_arg_len)
968 cs_usage_msg(Find);
969 return FALSE;
972 return cs_find_common(opt, pat, eap->forceit, TRUE,
973 eap->cmdidx == CMD_lcscope);
974 } /* cs_find */
978 * PRIVATE: cs_find_common
980 * common code for cscope find, shared by cs_find() and do_cstag()
982 static int
983 cs_find_common(opt, pat, forceit, verbose, use_ll)
984 char *opt;
985 char *pat;
986 int forceit;
987 int verbose;
988 int use_ll;
990 int i;
991 char *cmd;
992 int nummatches[CSCOPE_MAX_CONNECTIONS], totmatches;
993 #ifdef FEAT_QUICKFIX
994 char cmdletter;
995 char *qfpos;
996 #endif
998 /* create the actual command to send to cscope */
999 cmd = cs_create_cmd(opt, pat);
1000 if (cmd == NULL)
1001 return FALSE;
1003 /* send query to all open connections, then count the total number
1004 * of matches so we can alloc matchesp all in one swell foop
1006 for (i = 0; i < CSCOPE_MAX_CONNECTIONS; i++)
1007 nummatches[i] = 0;
1008 totmatches = 0;
1009 for (i = 0; i < CSCOPE_MAX_CONNECTIONS; i++)
1011 if (csinfo[i].fname == NULL || csinfo[i].to_fp == NULL)
1012 continue;
1014 /* send cmd to cscope */
1015 (void)fprintf(csinfo[i].to_fp, "%s\n", cmd);
1016 (void)fflush(csinfo[i].to_fp);
1018 nummatches[i] = cs_cnt_matches(i);
1020 if (nummatches[i] > -1)
1021 totmatches += nummatches[i];
1023 if (nummatches[i] == 0)
1024 (void)cs_read_prompt(i);
1026 vim_free(cmd);
1028 if (totmatches == 0)
1030 char *nf = _("E259: no matches found for cscope query %s of %s");
1031 char *buf;
1033 if (!verbose)
1034 return FALSE;
1036 buf = (char *)alloc((unsigned)(strlen(opt) + strlen(pat) + strlen(nf)));
1037 if (buf == NULL)
1038 (void)EMSG(nf);
1039 else
1041 sprintf(buf, nf, opt, pat);
1042 (void)EMSG(buf);
1043 vim_free(buf);
1045 return FALSE;
1048 #ifdef FEAT_QUICKFIX
1049 /* get cmd letter */
1050 switch (opt[0])
1052 case '0' :
1053 cmdletter = 's';
1054 break;
1055 case '1' :
1056 cmdletter = 'g';
1057 break;
1058 case '2' :
1059 cmdletter = 'd';
1060 break;
1061 case '3' :
1062 cmdletter = 'c';
1063 break;
1064 case '4' :
1065 cmdletter = 't';
1066 break;
1067 case '6' :
1068 cmdletter = 'e';
1069 break;
1070 case '7' :
1071 cmdletter = 'f';
1072 break;
1073 case '8' :
1074 cmdletter = 'i';
1075 break;
1076 default :
1077 cmdletter = opt[0];
1080 qfpos = (char *)vim_strchr(p_csqf, cmdletter);
1081 if (qfpos != NULL)
1083 qfpos++;
1084 /* next symbol must be + or - */
1085 if (strchr(CSQF_FLAGS, *qfpos) == NULL)
1087 char *nf = _("E469: invalid cscopequickfix flag %c for %c");
1088 char *buf = (char *)alloc((unsigned)strlen(nf));
1090 /* strlen will be enough because we use chars */
1091 if (buf != NULL)
1093 sprintf(buf, nf, *qfpos, *(qfpos-1));
1094 (void)EMSG(buf);
1095 vim_free(buf);
1097 return FALSE;
1100 if (qfpos != NULL && *qfpos != '0' && totmatches > 0)
1102 /* fill error list */
1103 FILE *f;
1104 char_u *tmp = vim_tempname('c');
1105 qf_info_T *qi = NULL;
1106 win_T *wp = NULL;
1108 f = mch_fopen((char *)tmp, "w");
1109 if (f == NULL)
1110 EMSG2(_(e_notopen), tmp);
1111 else
1113 cs_file_results(f, nummatches);
1114 fclose(f);
1115 if (use_ll) /* Use location list */
1116 wp = curwin;
1117 /* '-' starts a new error list */
1118 if (qf_init(wp, tmp, (char_u *)"%f%*\\t%l%*\\t%m",
1119 *qfpos == '-') > 0)
1121 # ifdef FEAT_WINDOWS
1122 if (postponed_split != 0)
1124 win_split(postponed_split > 0 ? postponed_split : 0,
1125 postponed_split_flags);
1126 # ifdef FEAT_SCROLLBIND
1127 curwin->w_p_scb = FALSE;
1128 # endif
1129 postponed_split = 0;
1131 # endif
1132 if (use_ll)
1134 * In the location list window, use the displayed location
1135 * list. Otherwise, use the location list for the window.
1137 qi = (bt_quickfix(wp->w_buffer) && wp->w_llist_ref != NULL)
1138 ? wp->w_llist_ref : wp->w_llist;
1139 qf_jump(qi, 0, 0, forceit);
1142 mch_remove(tmp);
1143 vim_free(tmp);
1144 return TRUE;
1146 else
1147 #endif /* FEAT_QUICKFIX */
1149 char **matches = NULL, **contexts = NULL;
1150 int matched = 0;
1152 /* read output */
1153 cs_fill_results((char *)pat, totmatches, nummatches, &matches,
1154 &contexts, &matched);
1155 if (matches == NULL)
1156 return FALSE;
1158 (void)cs_manage_matches(matches, contexts, matched, Store);
1160 return do_tag((char_u *)pat, DT_CSCOPE, 0, forceit, verbose);
1163 } /* cs_find_common */
1166 * PRIVATE: cs_help
1168 * print help
1170 /* ARGSUSED */
1171 static int
1172 cs_help(eap)
1173 exarg_T *eap;
1175 cscmd_T *cmdp = cs_cmds;
1177 (void)MSG_PUTS(_("cscope commands:\n"));
1178 while (cmdp->name != NULL)
1180 char *help = _(cmdp->help);
1181 int space_cnt = 30 - vim_strsize((char_u *)help);
1183 /* Use %*s rather than %30s to ensure proper alignment in utf-8 */
1184 if (space_cnt < 0)
1185 space_cnt = 0;
1186 (void)smsg((char_u *)_("%-5s: %s%*s (Usage: %s)"),
1187 cmdp->name,
1188 help, space_cnt, " ",
1189 cmdp->usage);
1190 if (strcmp(cmdp->name, "find") == 0)
1191 MSG_PUTS(_("\n"
1192 " c: Find functions calling this function\n"
1193 " d: Find functions called by this function\n"
1194 " e: Find this egrep pattern\n"
1195 " f: Find this file\n"
1196 " g: Find this definition\n"
1197 " i: Find files #including this file\n"
1198 " s: Find this C symbol\n"
1199 " t: Find assignments to\n"));
1201 cmdp++;
1204 wait_return(TRUE);
1205 return 0;
1206 } /* cs_help */
1210 * PRIVATE: cs_init
1212 * initialize cscope structure if not already
1214 static void
1215 cs_init()
1217 short i;
1218 static int init_already = FALSE;
1220 if (init_already)
1221 return;
1223 for (i = 0; i < CSCOPE_MAX_CONNECTIONS; i++)
1224 clear_csinfo(i);
1226 init_already = TRUE;
1227 } /* cs_init */
1229 static void
1230 clear_csinfo(i)
1231 int i;
1233 csinfo[i].fname = NULL;
1234 csinfo[i].ppath = NULL;
1235 csinfo[i].flags = NULL;
1236 #if defined(UNIX)
1237 csinfo[i].st_dev = (dev_t)0;
1238 csinfo[i].st_ino = (ino_t)0;
1239 #else
1240 csinfo[i].nVolume = 0;
1241 csinfo[i].nIndexHigh = 0;
1242 csinfo[i].nIndexLow = 0;
1243 #endif
1244 csinfo[i].pid = 0;
1245 csinfo[i].fr_fp = NULL;
1246 csinfo[i].to_fp = NULL;
1247 #if defined(WIN32)
1248 csinfo[i].hProc = NULL;
1249 #endif
1252 #ifndef UNIX
1253 static char *GetWin32Error __ARGS((void));
1255 static char *
1256 GetWin32Error()
1258 char *msg = NULL;
1259 FormatMessage(FORMAT_MESSAGE_ALLOCATE_BUFFER|FORMAT_MESSAGE_FROM_SYSTEM,
1260 NULL, GetLastError(), 0, (LPSTR)&msg, 0, NULL);
1261 if (msg != NULL)
1263 /* remove trailing \r\n */
1264 char *pcrlf = strstr(msg, "\r\n");
1265 if (pcrlf != NULL)
1266 *pcrlf = '\0';
1268 return msg;
1270 #endif
1273 * PRIVATE: cs_insert_filelist
1275 * insert a new cscope database filename into the filelist
1277 /*ARGSUSED*/
1278 static int
1279 cs_insert_filelist(fname, ppath, flags, sb)
1280 char *fname;
1281 char *ppath;
1282 char *flags;
1283 struct stat *sb;
1285 short i, j;
1286 #ifndef UNIX
1287 HANDLE hFile;
1288 BY_HANDLE_FILE_INFORMATION bhfi;
1290 vim_memset(&bhfi, 0, sizeof(bhfi));
1291 /* On windows 9x GetFileInformationByHandle doesn't work, so skip it */
1292 if (!mch_windows95())
1294 hFile = CreateFile(fname, FILE_READ_ATTRIBUTES, 0, NULL, OPEN_EXISTING,
1295 FILE_ATTRIBUTE_NORMAL, NULL);
1296 if (hFile == INVALID_HANDLE_VALUE)
1298 if (p_csverbose)
1300 char *cant_msg = _("E625: cannot open cscope database: %s");
1301 char *winmsg = GetWin32Error();
1303 if (winmsg != NULL)
1305 (void)EMSG2(cant_msg, winmsg);
1306 LocalFree(winmsg);
1308 else
1309 /* subst filename if can't get error text */
1310 (void)EMSG2(cant_msg, fname);
1312 return -1;
1314 if (!GetFileInformationByHandle(hFile, &bhfi))
1316 CloseHandle(hFile);
1317 if (p_csverbose)
1318 (void)EMSG(_("E626: cannot get cscope database information"));
1319 return -1;
1321 CloseHandle(hFile);
1323 #endif
1325 i = -1; /* can be set to the index of an empty item in csinfo */
1326 for (j = 0; j < CSCOPE_MAX_CONNECTIONS; j++)
1328 if (csinfo[j].fname != NULL
1329 #if defined(UNIX)
1330 && csinfo[j].st_dev == sb->st_dev && csinfo[j].st_ino == sb->st_ino
1331 #else
1332 /* compare pathnames first */
1333 && ((fullpathcmp(csinfo[j].fname, fname, FALSE) & FPC_SAME)
1334 /* if not Windows 9x, test index file attributes too */
1335 || (!mch_windows95()
1336 && csinfo[j].nVolume == bhfi.dwVolumeSerialNumber
1337 && csinfo[j].nIndexHigh == bhfi.nFileIndexHigh
1338 && csinfo[j].nIndexLow == bhfi.nFileIndexLow))
1339 #endif
1342 if (p_csverbose)
1343 (void)EMSG(_("E568: duplicate cscope database not added"));
1344 return -1;
1347 if (csinfo[j].fname == NULL && i == -1)
1348 i = j; /* remember first empty entry */
1351 if (i == -1)
1353 if (p_csverbose)
1354 (void)EMSG(_("E569: maximum number of cscope connections reached"));
1355 return -1;
1358 if ((csinfo[i].fname = (char *)alloc((unsigned)strlen(fname)+1)) == NULL)
1359 return -1;
1361 (void)strcpy(csinfo[i].fname, (const char *)fname);
1363 if (ppath != NULL)
1365 if ((csinfo[i].ppath = (char *)alloc((unsigned)strlen(ppath) + 1)) == NULL)
1367 vim_free(csinfo[i].fname);
1368 csinfo[i].fname = NULL;
1369 return -1;
1371 (void)strcpy(csinfo[i].ppath, (const char *)ppath);
1372 } else
1373 csinfo[i].ppath = NULL;
1375 if (flags != NULL)
1377 if ((csinfo[i].flags = (char *)alloc((unsigned)strlen(flags) + 1)) == NULL)
1379 vim_free(csinfo[i].fname);
1380 vim_free(csinfo[i].ppath);
1381 csinfo[i].fname = NULL;
1382 csinfo[i].ppath = NULL;
1383 return -1;
1385 (void)strcpy(csinfo[i].flags, (const char *)flags);
1386 } else
1387 csinfo[i].flags = NULL;
1389 #if defined(UNIX)
1390 csinfo[i].st_dev = sb->st_dev;
1391 csinfo[i].st_ino = sb->st_ino;
1393 #else
1394 csinfo[i].nVolume = bhfi.dwVolumeSerialNumber;
1395 csinfo[i].nIndexLow = bhfi.nFileIndexLow;
1396 csinfo[i].nIndexHigh = bhfi.nFileIndexHigh;
1397 #endif
1398 return i;
1399 } /* cs_insert_filelist */
1403 * PRIVATE: cs_lookup_cmd
1405 * find cscope command in command table
1407 static cscmd_T *
1408 cs_lookup_cmd(eap)
1409 exarg_T *eap;
1411 cscmd_T *cmdp;
1412 char *stok;
1413 size_t len;
1415 if (eap->arg == NULL)
1416 return NULL;
1418 /* Store length of eap->arg before it gets modified by strtok(). */
1419 eap_arg_len = (int)STRLEN(eap->arg);
1421 if ((stok = strtok((char *)(eap->arg), (const char *)" ")) == NULL)
1422 return NULL;
1424 len = strlen(stok);
1425 for (cmdp = cs_cmds; cmdp->name != NULL; ++cmdp)
1427 if (strncmp((const char *)(stok), cmdp->name, len) == 0)
1428 return (cmdp);
1430 return NULL;
1431 } /* cs_lookup_cmd */
1435 * PRIVATE: cs_kill
1437 * nuke em
1439 /* ARGSUSED */
1440 static int
1441 cs_kill(eap)
1442 exarg_T *eap;
1444 char *stok;
1445 short i;
1447 if ((stok = strtok((char *)NULL, (const char *)" ")) == NULL)
1449 cs_usage_msg(Kill);
1450 return CSCOPE_FAILURE;
1453 /* only single digit positive and negative integers are allowed */
1454 if ((strlen(stok) < 2 && VIM_ISDIGIT((int)(stok[0])))
1455 || (strlen(stok) < 3 && stok[0] == '-'
1456 && VIM_ISDIGIT((int)(stok[1]))))
1457 i = atoi(stok);
1458 else
1460 /* It must be part of a name. We will try to find a match
1461 * within all the names in the csinfo data structure
1463 for (i = 0; i < CSCOPE_MAX_CONNECTIONS; i++)
1465 if (csinfo[i].fname != NULL && strstr(csinfo[i].fname, stok))
1466 break;
1470 if ((i >= CSCOPE_MAX_CONNECTIONS || i < -1 || csinfo[i].fname == NULL)
1471 && i != -1)
1473 if (p_csverbose)
1474 (void)EMSG2(_("E261: cscope connection %s not found"), stok);
1476 else
1478 if (i == -1)
1480 for (i = 0; i < CSCOPE_MAX_CONNECTIONS; i++)
1482 if (csinfo[i].fname)
1483 cs_kill_execute(i, csinfo[i].fname);
1486 else
1487 cs_kill_execute(i, stok);
1490 return 0;
1491 } /* cs_kill */
1495 * PRIVATE: cs_kill_execute
1497 * Actually kills a specific cscope connection.
1499 static void
1500 cs_kill_execute(i, cname)
1501 int i; /* cscope table index */
1502 char *cname; /* cscope database name */
1504 if (p_csverbose)
1506 msg_clr_eos();
1507 (void)smsg_attr(hl_attr(HLF_R) | MSG_HIST,
1508 (char_u *)_("cscope connection %s closed"), cname);
1510 cs_release_csp(i, TRUE);
1515 * PRIVATE: cs_make_vim_style_matches
1517 * convert the cscope output into into a ctags style entry (as might be found
1518 * in a ctags tags file). there's one catch though: cscope doesn't tell you
1519 * the type of the tag you are looking for. for example, in Darren Hiebert's
1520 * ctags (the one that comes with vim), #define's use a line number to find the
1521 * tag in a file while function definitions use a regexp search pattern.
1523 * i'm going to always use the line number because cscope does something
1524 * quirky (and probably other things i don't know about):
1526 * if you have "# define" in your source file, which is
1527 * perfectly legal, cscope thinks you have "#define". this
1528 * will result in a failed regexp search. :(
1530 * besides, even if this particular case didn't happen, the search pattern
1531 * would still have to be modified to escape all the special regular expression
1532 * characters to comply with ctags formatting.
1534 static char *
1535 cs_make_vim_style_matches(fname, slno, search, tagstr)
1536 char *fname;
1537 char *slno;
1538 char *search;
1539 char *tagstr;
1541 /* vim style is ctags:
1543 * <tagstr>\t<filename>\t<linenum_or_search>"\t<extra>
1545 * but as mentioned above, we'll always use the line number and
1546 * put the search pattern (if one exists) as "extra"
1548 * buf is used as part of vim's method of handling tags, and
1549 * (i think) vim frees it when you pop your tags and get replaced
1550 * by new ones on the tag stack.
1552 char *buf;
1553 int amt;
1555 if (search != NULL)
1557 amt = (int)(strlen(fname) + strlen(slno) + strlen(tagstr) + strlen(search)+6);
1558 if ((buf = (char *)alloc(amt)) == NULL)
1559 return NULL;
1561 (void)sprintf(buf, "%s\t%s\t%s;\"\t%s", tagstr, fname, slno, search);
1563 else
1565 amt = (int)(strlen(fname) + strlen(slno) + strlen(tagstr) + 5);
1566 if ((buf = (char *)alloc(amt)) == NULL)
1567 return NULL;
1569 (void)sprintf(buf, "%s\t%s\t%s;\"", tagstr, fname, slno);
1572 return buf;
1573 } /* cs_make_vim_style_matches */
1577 * PRIVATE: cs_manage_matches
1579 * this is kind of hokey, but i don't see an easy way round this..
1581 * Store: keep a ptr to the (malloc'd) memory of matches originally
1582 * generated from cs_find(). the matches are originally lines directly
1583 * from cscope output, but transformed to look like something out of a
1584 * ctags. see cs_make_vim_style_matches for more details.
1586 * Get: used only from cs_fgets(), this simulates a vim_fgets() to return
1587 * the next line from the cscope output. it basically keeps track of which
1588 * lines have been "used" and returns the next one.
1590 * Free: frees up everything and resets
1592 * Print: prints the tags
1594 static char *
1595 cs_manage_matches(matches, contexts, totmatches, cmd)
1596 char **matches;
1597 char **contexts;
1598 int totmatches;
1599 mcmd_e cmd;
1601 static char **mp = NULL;
1602 static char **cp = NULL;
1603 static int cnt = -1;
1604 static int next = -1;
1605 char *p = NULL;
1607 switch (cmd)
1609 case Store:
1610 assert(matches != NULL);
1611 assert(totmatches > 0);
1612 if (mp != NULL || cp != NULL)
1613 (void)cs_manage_matches(NULL, NULL, -1, Free);
1614 mp = matches;
1615 cp = contexts;
1616 cnt = totmatches;
1617 next = 0;
1618 break;
1619 case Get:
1620 if (next >= cnt)
1621 return NULL;
1623 p = mp[next];
1624 next++;
1625 break;
1626 case Free:
1627 if (mp != NULL)
1629 if (cnt > 0)
1630 while (cnt--)
1632 vim_free(mp[cnt]);
1633 if (cp != NULL)
1634 vim_free(cp[cnt]);
1636 vim_free(mp);
1637 vim_free(cp);
1639 mp = NULL;
1640 cp = NULL;
1641 cnt = 0;
1642 next = 0;
1643 break;
1644 case Print:
1645 cs_print_tags_priv(mp, cp, cnt);
1646 break;
1647 default: /* should not reach here */
1648 (void)EMSG(_("E570: fatal error in cs_manage_matches"));
1649 return NULL;
1652 return p;
1653 } /* cs_manage_matches */
1657 * PRIVATE: cs_parse_results
1659 * parse cscope output
1661 static char *
1662 cs_parse_results(cnumber, buf, bufsize, context, linenumber, search)
1663 int cnumber;
1664 char *buf;
1665 int bufsize;
1666 char **context;
1667 char **linenumber;
1668 char **search;
1670 int ch;
1671 char *p;
1672 char *name;
1674 if (fgets(buf, bufsize, csinfo[cnumber].fr_fp) == NULL)
1676 if (feof(csinfo[cnumber].fr_fp))
1677 errno = EIO;
1679 cs_reading_emsg(cnumber);
1681 return NULL;
1684 /* If the line's too long for the buffer, discard it. */
1685 if ((p = strchr(buf, '\n')) == NULL)
1687 while ((ch = getc(csinfo[cnumber].fr_fp)) != EOF && ch != '\n')
1689 return NULL;
1691 *p = '\0';
1694 * cscope output is in the following format:
1696 * <filename> <context> <line number> <pattern>
1698 if ((name = strtok((char *)buf, (const char *)" ")) == NULL)
1699 return NULL;
1700 if ((*context = strtok(NULL, (const char *)" ")) == NULL)
1701 return NULL;
1702 if ((*linenumber = strtok(NULL, (const char *)" ")) == NULL)
1703 return NULL;
1704 *search = *linenumber + strlen(*linenumber) + 1; /* +1 to skip \0 */
1706 /* --- nvi ---
1707 * If the file is older than the cscope database, that is,
1708 * the database was built since the file was last modified,
1709 * or there wasn't a search string, use the line number.
1711 if (strcmp(*search, "<unknown>") == 0)
1712 *search = NULL;
1714 name = cs_resolve_file(cnumber, name);
1715 return name;
1718 #ifdef FEAT_QUICKFIX
1720 * PRIVATE: cs_file_results
1722 * write cscope find results to file
1724 static void
1725 cs_file_results(f, nummatches_a)
1726 FILE *f;
1727 int *nummatches_a;
1729 int i, j;
1730 char *buf;
1731 char *search, *slno;
1732 char *fullname;
1733 char *cntx;
1734 char *context;
1736 buf = (char *)alloc(CSREAD_BUFSIZE);
1737 if (buf == NULL)
1738 return;
1740 for (i = 0; i < CSCOPE_MAX_CONNECTIONS; i++)
1742 if (nummatches_a[i] < 1)
1743 continue;
1745 for (j = 0; j < nummatches_a[i]; j++)
1747 if ((fullname = cs_parse_results(i, buf, CSREAD_BUFSIZE, &cntx,
1748 &slno, &search)) == NULL)
1749 continue;
1751 context = (char *)alloc((unsigned)strlen(cntx)+5);
1752 if (context == NULL)
1753 continue;
1755 if (strcmp(cntx, "<global>")==0)
1756 strcpy(context, "<<global>>");
1757 else
1758 sprintf(context, "<<%s>>", cntx);
1760 if (search == NULL)
1761 fprintf(f, "%s\t%s\t%s\n", fullname, slno, context);
1762 else
1763 fprintf(f, "%s\t%s\t%s %s\n", fullname, slno, context, search);
1765 vim_free(context);
1766 vim_free(fullname);
1767 } /* for all matches */
1769 (void)cs_read_prompt(i);
1771 } /* for all cscope connections */
1772 vim_free(buf);
1774 #endif
1777 * PRIVATE: cs_fill_results
1779 * get parsed cscope output and calls cs_make_vim_style_matches to convert
1780 * into ctags format
1781 * When there are no matches sets "*matches_p" to NULL.
1783 static void
1784 cs_fill_results(tagstr, totmatches, nummatches_a, matches_p, cntxts_p, matched)
1785 char *tagstr;
1786 int totmatches;
1787 int *nummatches_a;
1788 char ***matches_p;
1789 char ***cntxts_p;
1790 int *matched;
1792 int i, j;
1793 char *buf;
1794 char *search, *slno;
1795 int totsofar = 0;
1796 char **matches = NULL;
1797 char **cntxts = NULL;
1798 char *fullname;
1799 char *cntx;
1801 assert(totmatches > 0);
1803 buf = (char *)alloc(CSREAD_BUFSIZE);
1804 if (buf == NULL)
1805 return;
1807 if ((matches = (char **)alloc(sizeof(char *) * totmatches)) == NULL)
1808 goto parse_out;
1809 if ((cntxts = (char **)alloc(sizeof(char *) * totmatches)) == NULL)
1810 goto parse_out;
1812 for (i = 0; i < CSCOPE_MAX_CONNECTIONS; i++)
1814 if (nummatches_a[i] < 1)
1815 continue;
1817 for (j = 0; j < nummatches_a[i]; j++)
1819 if ((fullname = cs_parse_results(i, buf, CSREAD_BUFSIZE, &cntx,
1820 &slno, &search)) == NULL)
1821 continue;
1823 matches[totsofar] = cs_make_vim_style_matches(fullname, slno,
1824 search, tagstr);
1826 vim_free(fullname);
1828 if (strcmp(cntx, "<global>") == 0)
1829 cntxts[totsofar] = NULL;
1830 else
1831 /* note: if vim_strsave returns NULL, then the context
1832 * will be "<global>", which is misleading.
1834 cntxts[totsofar] = (char *)vim_strsave((char_u *)cntx);
1836 if (matches[totsofar] != NULL)
1837 totsofar++;
1839 } /* for all matches */
1841 (void)cs_read_prompt(i);
1843 } /* for all cscope connections */
1845 parse_out:
1846 if (totsofar == 0)
1848 /* No matches, free the arrays and return NULL in "*matches_p". */
1849 vim_free(matches);
1850 matches = NULL;
1851 vim_free(cntxts);
1852 cntxts = NULL;
1854 *matched = totsofar;
1855 *matches_p = matches;
1856 *cntxts_p = cntxts;
1858 vim_free(buf);
1859 } /* cs_fill_results */
1862 /* get the requested path components */
1863 static char *
1864 cs_pathcomponents(path)
1865 char *path;
1867 int i;
1868 char *s;
1870 if (p_cspc == 0)
1871 return path;
1873 s = path + strlen(path) - 1;
1874 for (i = 0; i < p_cspc; ++i)
1875 while (s > path && *--s != '/'
1876 #ifdef WIN32
1877 && *--s != '\\'
1878 #endif
1881 if ((s > path && *s == '/')
1882 #ifdef WIN32
1883 || (s > path && *s == '\\')
1884 #endif
1886 ++s;
1887 return s;
1891 * PRIVATE: cs_print_tags_priv
1893 * called from cs_manage_matches()
1895 static void
1896 cs_print_tags_priv(matches, cntxts, num_matches)
1897 char **matches;
1898 char **cntxts;
1899 int num_matches;
1901 char *buf = NULL;
1902 int bufsize = 0; /* Track available bufsize */
1903 int newsize = 0;
1904 char *ptag;
1905 char *fname, *lno, *extra, *tbuf;
1906 int i, idx, num;
1907 char *globalcntx = "GLOBAL";
1908 char *cntxformat = " <<%s>>";
1909 char *context;
1910 char *cstag_msg = _("Cscope tag: %s");
1911 char *csfmt_str = "%4d %6s ";
1913 assert (num_matches > 0);
1915 if ((tbuf = (char *)alloc((unsigned)strlen(matches[0]) + 1)) == NULL)
1916 return;
1918 strcpy(tbuf, matches[0]);
1919 ptag = strtok(tbuf, "\t");
1921 newsize = (int)(strlen(cstag_msg) + strlen(ptag));
1922 buf = (char *)alloc(newsize);
1923 if (buf != NULL)
1925 bufsize = newsize;
1926 (void)sprintf(buf, cstag_msg, ptag);
1927 MSG_PUTS_ATTR(buf, hl_attr(HLF_T));
1930 vim_free(tbuf);
1932 MSG_PUTS_ATTR(_("\n # line"), hl_attr(HLF_T)); /* strlen is 7 */
1933 msg_advance(msg_col + 2);
1934 MSG_PUTS_ATTR(_("filename / context / line\n"), hl_attr(HLF_T));
1936 num = 1;
1937 for (i = 0; i < num_matches; i++)
1939 idx = i;
1941 /* if we really wanted to, we could avoid this malloc and strcpy
1942 * by parsing matches[i] on the fly and placing stuff into buf
1943 * directly, but that's too much of a hassle
1945 if ((tbuf = (char *)alloc((unsigned)strlen(matches[idx]) + 1)) == NULL)
1946 continue;
1947 (void)strcpy(tbuf, matches[idx]);
1949 if ((fname = strtok(tbuf, (const char *)"\t")) == NULL)
1950 continue;
1951 if ((fname = strtok(NULL, (const char *)"\t")) == NULL)
1952 continue;
1953 if ((lno = strtok(NULL, (const char *)"\t")) == NULL)
1954 continue;
1955 extra = strtok(NULL, (const char *)"\t");
1957 lno[strlen(lno)-2] = '\0'; /* ignore ;" at the end */
1959 /* hopefully 'num' (num of matches) will be less than 10^16 */
1960 newsize = (int)(strlen(csfmt_str) + 16 + strlen(lno));
1961 if (bufsize < newsize)
1963 buf = (char *)vim_realloc(buf, newsize);
1964 if (buf == NULL)
1965 bufsize = 0;
1966 else
1967 bufsize = newsize;
1969 if (buf != NULL)
1971 /* csfmt_str = "%4d %6s "; */
1972 (void)sprintf(buf, csfmt_str, num, lno);
1973 MSG_PUTS_ATTR(buf, hl_attr(HLF_CM));
1975 MSG_PUTS_LONG_ATTR(cs_pathcomponents(fname), hl_attr(HLF_CM));
1977 /* compute the required space for the context */
1978 if (cntxts[idx] != NULL)
1979 context = cntxts[idx];
1980 else
1981 context = globalcntx;
1982 newsize = (int)(strlen(context) + strlen(cntxformat));
1984 if (bufsize < newsize)
1986 buf = (char *)vim_realloc(buf, newsize);
1987 if (buf == NULL)
1988 bufsize = 0;
1989 else
1990 bufsize = newsize;
1992 if (buf != NULL)
1994 (void)sprintf(buf, cntxformat, context);
1996 /* print the context only if it fits on the same line */
1997 if (msg_col + (int)strlen(buf) >= (int)Columns)
1998 msg_putchar('\n');
1999 msg_advance(12);
2000 MSG_PUTS_LONG(buf);
2001 msg_putchar('\n');
2003 if (extra != NULL)
2005 msg_advance(13);
2006 MSG_PUTS_LONG(extra);
2009 vim_free(tbuf); /* only after printing extra due to strtok use */
2011 if (msg_col)
2012 msg_putchar('\n');
2014 ui_breakcheck();
2015 if (got_int)
2017 got_int = FALSE; /* don't print any more matches */
2018 break;
2021 num++;
2022 } /* for all matches */
2024 vim_free(buf);
2025 } /* cs_print_tags_priv */
2029 * PRIVATE: cs_read_prompt
2031 * read a cscope prompt (basically, skip over the ">> ")
2033 static int
2034 cs_read_prompt(i)
2035 int i;
2037 int ch;
2038 char *buf = NULL; /* buffer for possible error message from cscope */
2039 int bufpos = 0;
2040 char *cs_emsg;
2041 int maxlen;
2042 static char *eprompt = "Press the RETURN key to continue:";
2043 int epromptlen = (int)strlen(eprompt);
2044 int n;
2046 cs_emsg = _("E609: Cscope error: %s");
2047 /* compute maximum allowed len for Cscope error message */
2048 maxlen = (int)(IOSIZE - strlen(cs_emsg));
2050 for (;;)
2052 while ((ch = getc(csinfo[i].fr_fp)) != EOF && ch != CSCOPE_PROMPT[0])
2053 /* if there is room and char is printable */
2054 if (bufpos < maxlen - 1 && vim_isprintc(ch))
2056 if (buf == NULL) /* lazy buffer allocation */
2057 buf = (char *)alloc(maxlen);
2058 if (buf != NULL)
2060 /* append character to the message */
2061 buf[bufpos++] = ch;
2062 buf[bufpos] = NUL;
2063 if (bufpos >= epromptlen
2064 && strcmp(&buf[bufpos - epromptlen], eprompt) == 0)
2066 /* remove eprompt from buf */
2067 buf[bufpos - epromptlen] = NUL;
2069 /* print message to user */
2070 (void)EMSG2(cs_emsg, buf);
2072 /* send RETURN to cscope */
2073 (void)putc('\n', csinfo[i].to_fp);
2074 (void)fflush(csinfo[i].to_fp);
2076 /* clear buf */
2077 bufpos = 0;
2078 buf[bufpos] = NUL;
2083 for (n = 0; n < (int)strlen(CSCOPE_PROMPT); ++n)
2085 if (n > 0)
2086 ch = getc(csinfo[i].fr_fp);
2087 if (ch == EOF)
2089 PERROR("cs_read_prompt EOF");
2090 if (buf != NULL && buf[0] != NUL)
2091 (void)EMSG2(cs_emsg, buf);
2092 else if (p_csverbose)
2093 cs_reading_emsg(i); /* don't have additional information */
2094 cs_release_csp(i, TRUE);
2095 vim_free(buf);
2096 return CSCOPE_FAILURE;
2099 if (ch != CSCOPE_PROMPT[n])
2101 ch = EOF;
2102 break;
2106 if (ch == EOF)
2107 continue; /* didn't find the prompt */
2108 break; /* did find the prompt */
2111 vim_free(buf);
2112 return CSCOPE_SUCCESS;
2115 #if defined(UNIX) && defined(SIGALRM)
2117 * Used to catch and ignore SIGALRM below.
2119 /* ARGSUSED */
2120 static RETSIGTYPE
2121 sig_handler SIGDEFARG(sigarg)
2123 /* do nothing */
2124 SIGRETURN;
2126 #endif
2129 * PRIVATE: cs_release_csp
2131 * Does the actual free'ing for the cs ptr with an optional flag of whether
2132 * or not to free the filename. Called by cs_kill and cs_reset.
2134 static void
2135 cs_release_csp(i, freefnpp)
2136 int i;
2137 int freefnpp;
2140 * Trying to exit normally (not sure whether it is fit to UNIX cscope
2142 if (csinfo[i].to_fp != NULL)
2144 (void)fputs("q\n", csinfo[i].to_fp);
2145 (void)fflush(csinfo[i].to_fp);
2147 #if defined(UNIX)
2149 int waitpid_errno;
2150 int pstat;
2151 pid_t pid;
2153 # if defined(HAVE_SIGACTION)
2154 struct sigaction sa, old;
2156 /* Use sigaction() to limit the waiting time to two seconds. */
2157 sigemptyset(&sa.sa_mask);
2158 sa.sa_handler = sig_handler;
2159 sa.sa_flags = SA_NODEFER;
2160 sigaction(SIGALRM, &sa, &old);
2161 alarm(2); /* 2 sec timeout */
2163 /* Block until cscope exits or until timer expires */
2164 pid = waitpid(csinfo[i].pid, &pstat, 0);
2165 waitpid_errno = errno;
2167 /* cancel pending alarm if still there and restore signal */
2168 alarm(0);
2169 sigaction(SIGALRM, &old, NULL);
2170 # else
2171 int waited;
2173 /* Can't use sigaction(), loop for two seconds. First yield the CPU
2174 * to give cscope a chance to exit quickly. */
2175 sleep(0);
2176 for (waited = 0; waited < 40; ++waited)
2178 pid = waitpid(csinfo[i].pid, &pstat, WNOHANG);
2179 waitpid_errno = errno;
2180 if (pid != 0)
2181 break; /* break unless the process is still running */
2182 mch_delay(50L, FALSE); /* sleep 50 ms */
2184 # endif
2186 * If the cscope process is still running: kill it.
2187 * Safety check: If the PID would be zero here, the entire X session
2188 * would be killed. -1 and 1 are dangerous as well.
2190 if (pid < 0 && csinfo[i].pid > 1)
2192 # ifdef ECHILD
2193 int alive = TRUE;
2195 if (waitpid_errno == ECHILD)
2198 * When using 'vim -g', vim is forked and cscope process is
2199 * no longer a child process but a sibling. So waitpid()
2200 * fails with errno being ECHILD (No child processes).
2201 * Don't send SIGKILL to cscope immediately but wait
2202 * (polling) for it to exit normally as result of sending
2203 * the "q" command, hence giving it a chance to clean up
2204 * its temporary files.
2206 int waited;
2208 sleep(0);
2209 for (waited = 0; waited < 40; ++waited)
2211 /* Check whether cscope process is still alive */
2212 if (kill(csinfo[i].pid, 0) != 0)
2214 alive = FALSE; /* cscope process no longer exists */
2215 break;
2217 mch_delay(50L, FALSE); /* sleep 50ms */
2220 if (alive)
2221 # endif
2223 kill(csinfo[i].pid, SIGKILL);
2224 (void)waitpid(csinfo[i].pid, &pstat, 0);
2228 #else /* !UNIX */
2229 if (csinfo[i].hProc != NULL)
2231 /* Give cscope a chance to exit normally */
2232 if (WaitForSingleObject(csinfo[i].hProc, 1000) == WAIT_TIMEOUT)
2233 TerminateProcess(csinfo[i].hProc, 0);
2234 CloseHandle(csinfo[i].hProc);
2236 #endif
2238 if (csinfo[i].fr_fp != NULL)
2239 (void)fclose(csinfo[i].fr_fp);
2240 if (csinfo[i].to_fp != NULL)
2241 (void)fclose(csinfo[i].to_fp);
2243 if (freefnpp)
2245 vim_free(csinfo[i].fname);
2246 vim_free(csinfo[i].ppath);
2247 vim_free(csinfo[i].flags);
2250 clear_csinfo(i);
2251 } /* cs_release_csp */
2255 * PRIVATE: cs_reset
2257 * calls cs_kill on all cscope connections then reinits
2259 /* ARGSUSED */
2260 static int
2261 cs_reset(eap)
2262 exarg_T *eap;
2264 char **dblist = NULL, **pplist = NULL, **fllist = NULL;
2265 int i;
2266 char buf[20]; /* for sprintf " (#%d)" */
2268 /* malloc our db and ppath list */
2269 dblist = (char **)alloc(CSCOPE_MAX_CONNECTIONS * sizeof(char *));
2270 pplist = (char **)alloc(CSCOPE_MAX_CONNECTIONS * sizeof(char *));
2271 fllist = (char **)alloc(CSCOPE_MAX_CONNECTIONS * sizeof(char *));
2272 if (dblist == NULL || pplist == NULL || fllist == NULL)
2274 vim_free(dblist);
2275 vim_free(pplist);
2276 vim_free(fllist);
2277 return CSCOPE_FAILURE;
2280 for (i = 0; i < CSCOPE_MAX_CONNECTIONS; i++)
2282 dblist[i] = csinfo[i].fname;
2283 pplist[i] = csinfo[i].ppath;
2284 fllist[i] = csinfo[i].flags;
2285 if (csinfo[i].fname != NULL)
2286 cs_release_csp(i, FALSE);
2289 /* rebuild the cscope connection list */
2290 for (i = 0; i < CSCOPE_MAX_CONNECTIONS; i++)
2292 if (dblist[i] != NULL)
2294 cs_add_common(dblist[i], pplist[i], fllist[i]);
2295 if (p_csverbose)
2297 /* don't use smsg_attr() because we want to display the
2298 * connection number in the same line as
2299 * "Added cscope database..."
2301 sprintf(buf, " (#%d)", i);
2302 MSG_PUTS_ATTR(buf, hl_attr(HLF_R));
2305 vim_free(dblist[i]);
2306 vim_free(pplist[i]);
2307 vim_free(fllist[i]);
2309 vim_free(dblist);
2310 vim_free(pplist);
2311 vim_free(fllist);
2313 if (p_csverbose)
2314 MSG_ATTR(_("All cscope databases reset"), hl_attr(HLF_R) | MSG_HIST);
2315 return CSCOPE_SUCCESS;
2316 } /* cs_reset */
2320 * PRIVATE: cs_resolve_file
2322 * construct the full pathname to a file found in the cscope database.
2323 * (Prepends ppath, if there is one and if it's not already prepended,
2324 * otherwise just uses the name found.)
2326 * we need to prepend the prefix because on some cscope's (e.g., the one that
2327 * ships with Solaris 2.6), the output never has the prefix prepended.
2328 * contrast this with my development system (Digital Unix), which does.
2330 static char *
2331 cs_resolve_file(i, name)
2332 int i;
2333 char *name;
2335 char *fullname;
2336 int len;
2339 * ppath is freed when we destroy the cscope connection.
2340 * fullname is freed after cs_make_vim_style_matches, after it's been
2341 * copied into the tag buffer used by vim
2343 len = (int)(strlen(name) + 2);
2344 if (csinfo[i].ppath != NULL)
2345 len += (int)strlen(csinfo[i].ppath);
2347 if ((fullname = (char *)alloc(len)) == NULL)
2348 return NULL;
2351 * note/example: this won't work if the cscope output already starts
2352 * "../.." and the prefix path is also "../..". if something like this
2353 * happens, you are screwed up and need to fix how you're using cscope.
2355 if (csinfo[i].ppath != NULL &&
2356 (strncmp(name, csinfo[i].ppath, strlen(csinfo[i].ppath)) != 0) &&
2357 (name[0] != '/')
2358 #ifdef WIN32
2359 && name[0] != '\\' && name[1] != ':'
2360 #endif
2362 (void)sprintf(fullname, "%s/%s", csinfo[i].ppath, name);
2363 else
2364 (void)sprintf(fullname, "%s", name);
2366 return fullname;
2367 } /* cs_resolve_file */
2371 * PRIVATE: cs_show
2373 * show all cscope connections
2375 /* ARGSUSED */
2376 static int
2377 cs_show(eap)
2378 exarg_T *eap;
2380 short i;
2381 if (cs_cnt_connections() == 0)
2382 MSG_PUTS(_("no cscope connections\n"));
2383 else
2385 MSG_PUTS_ATTR(
2386 _(" # pid database name prepend path\n"),
2387 hl_attr(HLF_T));
2388 for (i = 0; i < CSCOPE_MAX_CONNECTIONS; i++)
2390 if (csinfo[i].fname == NULL)
2391 continue;
2393 if (csinfo[i].ppath != NULL)
2394 (void)smsg((char_u *)"%2d %-5ld %-34s %-32s",
2395 i, (long)csinfo[i].pid, csinfo[i].fname, csinfo[i].ppath);
2396 else
2397 (void)smsg((char_u *)"%2d %-5ld %-34s <none>",
2398 i, (long)csinfo[i].pid, csinfo[i].fname);
2402 wait_return(TRUE);
2403 return CSCOPE_SUCCESS;
2404 } /* cs_show */
2408 * PUBLIC: cs_end
2410 * Only called when VIM exits to quit any cscope sessions.
2412 void
2413 cs_end()
2415 int i;
2417 for (i = 0; i < CSCOPE_MAX_CONNECTIONS; i++)
2418 cs_release_csp(i, TRUE);
2421 #endif /* FEAT_CSCOPE */
2423 /* the end */