xref: /netbsd/usr.bin/error/main.c (revision 6550d01e)
1 /*	$NetBSD: main.c,v 1.17 2009/08/13 06:59:37 dholland Exp $	*/
2 
3 /*
4  * Copyright (c) 1980, 1993
5  *	The Regents of the University of California.  All rights reserved.
6  *
7  * Redistribution and use in source and binary forms, with or without
8  * modification, are permitted provided that the following conditions
9  * are met:
10  * 1. Redistributions of source code must retain the above copyright
11  *    notice, this list of conditions and the following disclaimer.
12  * 2. Redistributions in binary form must reproduce the above copyright
13  *    notice, this list of conditions and the following disclaimer in the
14  *    documentation and/or other materials provided with the distribution.
15  * 3. Neither the name of the University nor the names of its contributors
16  *    may be used to endorse or promote products derived from this software
17  *    without specific prior written permission.
18  *
19  * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
20  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
21  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
22  * ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
23  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
24  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
25  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
26  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
27  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
28  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
29  * SUCH DAMAGE.
30  */
31 
32 #include <sys/cdefs.h>
33 #ifndef lint
34 __COPYRIGHT("@(#) Copyright (c) 1980, 1993\
35  The Regents of the University of California.  All rights reserved.");
36 #endif /* not lint */
37 
38 #ifndef lint
39 #if 0
40 static char sccsid[] = "@(#)main.c	8.1 (Berkeley) 6/6/93";
41 #endif
42 __RCSID("$NetBSD: main.c,v 1.17 2009/08/13 06:59:37 dholland Exp $");
43 #endif /* not lint */
44 
45 #include <signal.h>
46 #include <unistd.h>
47 #include <stdio.h>
48 #include <ctype.h>
49 #include <stdlib.h>
50 #include <string.h>
51 #include "error.h"
52 #include "pathnames.h"
53 
54 FILE *errorfile;     /* where error file comes from */
55 FILE *queryfile;     /* where the query responses from the user come from*/
56 
57 int nignored;
58 char **names_ignored;
59 
60 int nerrors = 0;
61 Eptr er_head;
62 static Eptr *errors;
63 
64 int nfiles = 0;
65 Eptr **files;		/* array of pointers into errors*/
66 boolean *touchedfiles;  /* which files we touched */
67 int language = INCC;
68 
69 static char default_currentfilename[] = "????";
70 char *currentfilename = default_currentfilename;
71 char *processname;
72 
73 boolean query = false;	/* query the operator if touch files */
74 boolean terse = false;	/* Terse output */
75 
76 static char im_on[] = _PATH_TTY;	/* my tty name */
77 static boolean notouch = false;		/* don't touch ANY files */
78 
79 const char *suffixlist = ".*";	/* initially, can touch any file */
80 
81 static int errorsort(const void *, const void *);
82 static void forkvi(int, char **);
83 static void try(const char *, int, char **);
84 
85 /*
86  * error [-I ignorename] [-n] [-q] [-t suffixlist] [-s] [-v] [infile]
87  *
88  *	-T:	terse output
89  *
90  *	-I:	the following name, `ignorename' contains a list of
91  *		function names that are not to be treated as hard errors.
92  *		Default: ~/.errorsrc
93  *
94  *	-n:	don't touch ANY files!
95  *
96  *	-q:	The user is to be queried before touching each
97  *		file; if not specified, all files with hard, non
98  *		ignorable errors are touched (assuming they can be).
99  *
100  *	-t:	touch only files ending with the list of suffixes, each
101  *		suffix preceded by a dot.
102  *		eg, -t .c.y.l
103  *		will touch only files ending with .c, .y or .l
104  *
105  *	-s:	print a summary of the error's categories.
106  *
107  *	-v:	after touching all files, overlay vi(1), ex(1) or ed(1)
108  *		on top of error, entered in the first file with
109  *		an error in it, with the appropriate editor
110  *		set up to use the "next" command to get the other
111  *		files containing errors.
112  *
113  *	-p:	(obsolete: for older versions of pi without bug
114  *		fix regarding printing out the name of the main file
115  *		with an error in it)
116  *		Take the following argument and use it as the name of
117  *		the pascal source file, suffix .p
118  *
119  *	-E:	show the errors in sorted order; intended for
120  *		debugging.
121  *
122  *	-S:	show the errors in unsorted order
123  *		(as they come from the error file)
124  *
125  *	infile:	The error messages come from this file.
126  *		Default: stdin
127  */
128 int
129 main(int argc, char **argv)
130 {
131 	char *cp;
132 	char *ignorename = 0;
133 	int ed_argc;
134 	char **ed_argv;		/* return from touchfiles */
135 	boolean show_errors = false;
136 	boolean Show_Errors = false;
137 	boolean pr_summary = false;
138 	boolean edit_files = false;
139 
140 	processname = argv[0];
141 
142 	errorfile = stdin;
143 	if (argc > 1)
144 		for (; argc > 1 && argv[1][0] == '-'; argc--, argv++) {
145 			for (cp = argv[1] + 1; *cp; cp++)
146 				switch (*cp) {
147 				default:
148 					fprintf(stderr, "%s: -%c: Unknown flag\n",
149 						processname, *cp);
150 					break;
151 
152 				case 'n': notouch = true; break;
153 				case 'q': query = true; break;
154 				case 'S': Show_Errors = true; break;
155 				case 's': pr_summary = true; break;
156 				case 'v': edit_files = true; break;
157 				case 'T': terse = true; break;
158 				case 't':
159 					*cp-- = 0; argv++; argc--;
160 					if (argc > 1) {
161 						suffixlist = argv[1];
162 					}
163 					break;
164 				case 'I':	/*ignore file name*/
165 					*cp-- = 0;
166 					argv++;
167 					argc--;
168 					if (argc > 1)
169 						ignorename = argv[1];
170 					break;
171 				}
172 		}
173 	if (notouch)
174 		suffixlist = 0;
175 	if (argc > 1) {
176 		if (argc > 3) {
177 			fprintf(stderr, "%s: Only takes 0 or 1 arguments\n",
178 				processname);
179 			exit(3);
180 		}
181 		if ((errorfile = fopen(argv[1], "r")) == NULL) {
182 			fprintf(stderr, "%s: %s: No such file or directory for reading errors.\n",
183 				processname, argv[1]);
184 			exit(4);
185 		}
186 	}
187 	if ((queryfile = fopen(im_on, "r")) == NULL) {
188 		if (query) {
189 			fprintf(stderr,
190 				"%s: Can't open \"%s\" to query the user.\n",
191 				processname, im_on);
192 			exit(9);
193 		}
194 	}
195 	if (signal(SIGINT, onintr) == SIG_IGN)
196 		signal(SIGINT, SIG_IGN);
197 	if (signal(SIGTERM, onintr) == SIG_IGN)
198 		signal(SIGTERM, SIG_IGN);
199 	getignored(ignorename);
200 	eaterrors(&nerrors, &errors);
201 	if (Show_Errors)
202 		printerrors(true, nerrors, errors);
203 	qsort(errors, nerrors, sizeof(Eptr), errorsort);
204 	if (show_errors)
205 		printerrors(false, nerrors, errors);
206 	findfiles(nerrors, errors, &nfiles, &files);
207 #define P(msg, arg) fprintf(stdout, msg, arg)
208 	if (pr_summary) {
209 	    if (nunknown)
210 	      P("%d Errors are unclassifiable.\n", nunknown);
211 	    if (nignore)
212 	      P("%d Errors are classifiable, but totally discarded.\n",nignore);
213 	    if (nsyncerrors)
214 	      P("%d Errors are synchronization errors.\n", nsyncerrors);
215 	    if (nignore)
216 	      P("%d Errors are discarded because they refer to sacrosinct files.\n", ndiscard);
217 	    if (nnulled)
218 	      P("%d Errors are nulled because they refer to specific functions.\n", nnulled);
219 	    if (nnonspec)
220 	      P("%d Errors are not specific to any file.\n", nnonspec);
221 	    if (nthisfile)
222 	      P("%d Errors are specific to a given file, but not to a line.\n", nthisfile);
223 	    if (ntrue)
224 	      P("%d Errors are true errors, and can be inserted into the files.\n", ntrue);
225 	}
226 	filenames(nfiles, files);
227 	fflush(stdout);
228 	if (touchfiles(nfiles, files, &ed_argc, &ed_argv) && edit_files)
229 		forkvi(ed_argc, ed_argv);
230 	return (0);
231 }
232 
233 static void
234 forkvi(int argc, char **argv)
235 {
236 	if (query) {
237 		switch (inquire(terse
238 		    ? "Edit? "
239 		    : "Do you still want to edit the files you touched? ")) {
240 		case Q_error:
241 		case Q_NO:
242 		case Q_no:
243 			return;
244 		default:
245 			break;
246 		}
247 	}
248 	/*
249 	 *	ed_agument's first argument is
250 	 *	a vi/ex compatible search argument
251 	 *	to find the first occurrence of ###
252 	 */
253 	try("vi", argc, argv);
254 	try("ex", argc, argv);
255 	try("ed", argc-1, argv+1);
256 	fprintf(stdout, "Can't find any editors.\n");
257 }
258 
259 static void
260 try(const char *name, int argc, char **argv)
261 {
262 	argv[0] = __UNCONST(name);
263 	wordvprint(stdout, argc, argv);
264 	fprintf(stdout, "\n");
265 	fflush(stderr);
266 	fflush(stdout);
267 	sleep(2);
268 	if (freopen(im_on, "r", stdin) == NULL)
269 		return;
270 	if (freopen(im_on, "w", stdout) == NULL)
271 		return;
272 	execvp(name, argv);
273 }
274 
275 static int
276 errorsort(const void *x1, const void *x2)
277 {
278 	const Eptr *epp1 = x1;
279 	const Eptr *epp2 = x2;
280 	Eptr ep1, ep2;
281 	int order;
282 
283 	/*
284 	 * Sort by:
285 	 *	1) synchronization, non specific, discarded errors first;
286 	 *	2) nulled and true errors last
287 	 *	   a) grouped by similar file names
288 	 *	       1) grouped in ascending line number
289 	 */
290 	ep1 = *epp1; ep2 = *epp2;
291 	if (ep1 == 0 || ep2 == 0)
292 		return (0);
293 	if ((NOTSORTABLE(ep1->error_e_class)) ^ (NOTSORTABLE(ep2->error_e_class))) {
294 		return (NOTSORTABLE(ep1->error_e_class) ? -1 : 1);
295 	}
296 	if (NOTSORTABLE(ep1->error_e_class))	/* then both are */
297 		return (ep1->error_no - ep2->error_no);
298 	order = strcmp(ep1->error_text[0], ep2->error_text[0]);
299 	if (order == 0) {
300 		return (ep1->error_line - ep2->error_line);
301 	}
302 	return (order);
303 }
304