error/common/errormain.c

/*
 * CDDL HEADER START
 *
 * The contents of this file are subject to the terms of the
 * Common Development and Distribution License, Version 1.0 only
 * (the "License").  You may not use this file except in compliance
 * with the License.
 *
 * You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE
 * or http://www.opensolaris.org/os/licensing.
 * See the License for the specific language governing permissions
 * and limitations under the License.
 *
 * When distributing Covered Code, include this CDDL HEADER in each
 * file and include the License file at usr/src/OPENSOLARIS.LICENSE.
 * If applicable, add the following below this CDDL HEADER, with the
 * fields enclosed by brackets "[]" replaced with your own identifying
 * information: Portions Copyright [yyyy] [name of copyright owner]
 *
 * CDDL HEADER END
 */

/*
 * Copyright 2005 Sun Microsystems, Inc.  All rights reserved.
 * Use is subject to license terms.
 */

#pragma ident   "%Z%%M% %I% %E% SMI"

#include <stdio.h>
#include <ctype.h>
#include <signal.h>
#include <stdlib.h>
#include <unistd.h>
#include <string.h>
#include "error.h"

int nerrors = 0;
Eptr    er_head;
Eptr    *errors;

int nfiles = 0;
Eptr    **files;    /* array of pointers into errors */
int language = INCC;

char    *currentfilename = "????";
char    *processname;
char    im_on[] = "/dev/tty";   /* my tty name */

boolean query = FALSE;      /* query the operator if touch files */
boolean notouch = FALSE;    /* don't touch ANY files */
boolean terse   = FALSE;    /* Terse output */

char    *suffixlist = ".*"; /* initially, can touch any file */

static void try(char *name, int argc, char **argv);
static void forkvi(int argc, char **argv);
static int errorsort(const void *arg1, const void *arg2);


/*
 *  error [-I ignorename] [-n] [-q] [-t suffixlist] [-s] [-v] [infile]
 *
 *  -T: terse output
 *
 *  -I: the following name, `ignorename' contains a list of
 *      function names that are not to be treated as hard errors.
 *      Default: ~/.errorsrc
 *
 *  -n: don't touch ANY files!
 *
 *  -q: The user is to be queried before touching each
 *      file; if not specified, all files with hard, non
 *      ignorable errors are touched (assuming they can be).
 *
 *  -t: touch only files ending with the list of suffices, each
 *      suffix preceded by a dot.
 *      eg, -t .c.y.l
 *      will touch only files ending with .c, .y or .l
 *
 *  -s: print a summary of the error's categories.
 *
 *  -v: after touching all files, overlay vi(1), ex(1) or ed(1)
 *      on top of error, entered in the first file with
 *      an error in it, with the appropriate editor
 *      set up to use the "next" command to get the other
 *      files containing errors.
 *
 *  -p: (obsolete: for older versions of pi without bug
 *      fix regarding printing out the name of the main file
 *      with an error in it)
 *      Take the following argument and use it as the name of
 *      the pascal source file, suffix .p
 *
 *  -E: show the errors in sorted order; intended for
 *      debugging.
 *
 *  -S: show the errors in unsorted order
 *      (as they come from the error file)
 *
 *  infile: The error messages come from this file.
 *      Default: stdin
 */
int
main(int argc, char *argv[])
{
    char    *cp;
    char    *ignorename = 0;
    int ed_argc;
    char    **ed_argv;      /* return from touchfiles */
    boolean show_errors = FALSE;
    boolean Show_Errors = FALSE;
    boolean pr_summary = FALSE;
    boolean edit_files = FALSE;

    processname = argv[0];

    errorfile = stdin;
    if (argc > 1) {
        for (; (argc > 1) && (argv[1][0] == '-'); argc--, argv++) {
            for (cp = argv[1] + 1; *cp; cp++) {
                switch (*cp) {
                default:
                    (void) fprintf(stderr,
                        "%s: -%c: Unknown flag\n",
                        processname, *cp);
                    break;
                case 'n':
                    notouch = TRUE;
                    break;
                case 'q':
                    query = TRUE;
                    break;
                case 'S':
                    Show_Errors = TRUE;
                    break;
                case 's':
                    pr_summary = TRUE;
                    break;
                case 'v':
                    edit_files = TRUE;
                    break;
                case 'T':
                    terse = TRUE;
                    break;
                case 't':
                    *cp-- = 0;
                    argv++;
                    argc--;
                    if (argc > 1) {
                        suffixlist = argv[1];
                    }
                    break;
                case 'I':   /* ignore file name */
                    *cp-- = 0;
                    argv++;
                    argc--;
                    if (argc > 1)
                        ignorename = argv[1];
                    break;
                }
            }
        }
    }
    if (notouch)
        suffixlist = 0;
    if (argc > 1) {
        if (argc > 3) {
            (void) fprintf(stderr,
                "%s: Only takes 0 or 1 arguments\n",
                processname);
            exit(3);
        }
        if ((errorfile = fopen(argv[1], "r")) == NULL) {
            (void) fprintf(stderr,
                "%s: %s: No such file or directory for "
                "reading errors.\n", processname, argv[1]);
            exit(4);
        }
    }
    if ((queryfile = fopen(im_on, "r")) == NULL) {
        if (query) {
            (void) fprintf(stderr,
                "%s: Can't open \"%s\" to query the user.\n",
                processname, im_on);
            exit(9);
        }
    }
    if (signal(SIGINT, onintr) == SIG_IGN)
        (void) signal(SIGINT, SIG_IGN);
    if (signal(SIGTERM, onintr) == SIG_IGN)
        (void) signal(SIGTERM, SIG_IGN);
    getignored(ignorename);
    eaterrors(&nerrors, &errors);
    if (Show_Errors)
        printerrors(TRUE, nerrors, errors);
    qsort(errors, nerrors, sizeof (Eptr), errorsort);
    if (show_errors)
        printerrors(FALSE, nerrors, errors);
    findfiles(nerrors, errors, &nfiles, &files);
    if (pr_summary) {
        if (nunknown)
            (void) fprintf(stdout,
                "%d Errors are unclassifiable.\n",
                nunknown);
        if (nignore)
            (void) fprintf(stdout,
                "%d Errors are classifiable, but totally "
                "discarded.\n", nignore);
        if (nsyncerrors)
            (void) fprintf(stdout,
                "%d Errors are synchronization errors.\n",
                nsyncerrors);
        if (nignore)
            (void) fprintf(stdout,
                "%d Errors are discarded because they "
                "refer to sacrosanct files.\n", ndiscard);
        if (nnulled)
            (void) fprintf(stdout,
                "%d Errors are nulled because they refer "
                "to specific functions.\n", nnulled);
        if (nnonspec)
            (void) fprintf(stdout,
                "%d Errors are not specific to any file.\n",
                nnonspec);
        if (nthisfile)
            (void) fprintf(stdout,
                "%d Errors are specific to a given file, "
                "but not to a line.\n", nthisfile);
        if (ntrue)
            (void) fprintf(stdout,
                "%d Errors are true errors, and can be "
                "inserted into the files.\n", ntrue);
    }
    filenames(nfiles, files);
    (void) fflush(stdout);
    if (touchfiles(nfiles, files, &ed_argc, &ed_argv) && edit_files)
        forkvi(ed_argc, ed_argv);
    return (0);
}

static void
forkvi(int argc, char **argv)
{
    if (query) {
        switch (inquire(terse
            ? "Edit? "
            : "Do you still want to edit the files you touched? ")) {
        case Q_NO:
        case Q_no:
            return;
        default:
            break;
        }
    }
    /*
     *  ed_agument's first argument is
     *  a vi/ex compatabile search argument
     *  to find the first occurance of ###
     */
    try("vi", argc, argv);
    try("ex", argc, argv);
    try("ed", argc-1, argv+1);
    (void) fprintf(stdout, "Can't find any editors.\n");
}

static void
try(char *name, int argc, char **argv)
{
    argv[0] = name;
    wordvprint(stdout, argc, argv);
    (void) fprintf(stdout, "\n");
    (void) fflush(stderr);
    (void) fflush(stdout);
    (void) sleep(2);
    if (freopen(im_on, "r", stdin) == NULL)
        return;
    if (freopen(im_on, "w", stdout) == NULL)
        return;
    (void) execvp(name, argv);
}

static int
errorsort(const void *arg1, const void *arg2)
{
    Eptr    *epp1 = (Eptr *)arg1;
    Eptr    *epp2 = (Eptr *)arg2;
    Eptr    ep1, ep2;
    int order;

    /*
     *  Sort by:
     *  1)  synchronization, non specific, discarded errors first;
     *  2)  nulled and true errors last
     *      a)  grouped by similar file names
     *          1)  grouped in ascending line number
     */
    ep1 = *epp1; ep2 = *epp2;
    if (ep1 == 0 || ep2 == 0)
        return (0);
    if ((NOTSORTABLE(ep1->error_e_class)) ^
        (NOTSORTABLE(ep2->error_e_class))) {
        return (NOTSORTABLE(ep1->error_e_class) ? -1 : 1);
    }
    if (NOTSORTABLE(ep1->error_e_class))    /* then both are */
        return (ep1->error_no - ep2->error_no);
    order = strcmp(ep1->error_text[0], ep2->error_text[0]);
    if (order == 0) {
        return (ep1->error_line - ep2->error_line);
    }
    return (order);
}