root/usr.bin/ctags/ctags.c
/*      $NetBSD: ctags.c,v 1.18 2024/10/31 01:50:20 kre Exp $   */

/*
 * Copyright (c) 1987, 1993, 1994, 1995
 *      The Regents of the University of California.  All rights reserved.
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions
 * are met:
 * 1. Redistributions of source code must retain the above copyright
 *    notice, this list of conditions and the following disclaimer.
 * 2. Redistributions in binary form must reproduce the above copyright
 *    notice, this list of conditions and the following disclaimer in the
 *    documentation and/or other materials provided with the distribution.
 * 3. Neither the name of the University nor the names of its contributors
 *    may be used to endorse or promote products derived from this software
 *    without specific prior written permission.
 *
 * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
 * ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
 * SUCH DAMAGE.
 */

#if HAVE_NBTOOL_CONFIG_H
#include "nbtool_config.h"
#endif

#include <sys/cdefs.h>
#if defined(__COPYRIGHT) && !defined(lint)
__COPYRIGHT("@(#) Copyright (c) 1987, 1993, 1994, 1995\
 The Regents of the University of California.  All rights reserved.");
#endif /* not lint */

#if defined(__RCSID) && !defined(lint)
#if 0
static char sccsid[] = "@(#)ctags.c     8.4 (Berkeley) 2/7/95";
#endif
__RCSID("$NetBSD: ctags.c,v 1.18 2024/10/31 01:50:20 kre Exp $");
#endif /* not lint */

#include <err.h>
#include <limits.h>
#include <stdio.h>
#include <string.h>
#include <stdlib.h>
#include <unistd.h>

#include "ctags.h"

/*
 * ctags: create a tags file
 */

NODE    *head;                  /* head of the sorted binary tree */

                                /* boolean "func" (see init()) */
bool    _wht[256], _etk[256], _itk[256], _btk[256], _gd[256];

FILE    *inf;                   /* ioptr for current input file */
FILE    *outf;                  /* ioptr for tags file */

long    lineftell;              /* ftell after getc( inf ) == '\n' */

int     lineno;                 /* line number of current line */
int     dflag;                  /* -d: non-macro defines */
int     tflag;                  /* -t: create tags for typedefs */
int     vflag;                  /* -v: vgrind style index output */
int     wflag;                  /* -w: suppress warnings */
int     xflag;                  /* -x: cxref style output */

char    *curfile;               /* current input file name */
char    searchar = '/';         /* use /.../ searches by default */
char    lbuf[LINE_MAX];

void    init(void);
void    find_entries(char *);

int
main(int argc, char **argv)
{
        static const char       *outfile = "tags";      /* output file */
        int     aflag;                          /* -a: append to tags */
        int     uflag;                          /* -u: update tags */
        int     exit_val;                       /* exit value */
        int     step;                           /* step through args */
        int     ch;                             /* getopts char */
        char    *cmd;                           /* not nice */
        char    tname[128];                     /* disgusting */
        size_t  sz;

        aflag = uflag = NO;
        while ((ch = getopt(argc, argv, "BFadf:tuwvx")) != -1)
                switch(ch) {
                case 'B':
                        searchar = '?';
                        break;
                case 'F':
                        searchar = '/';
                        break;
                case 'a':
                        aflag++;
                        break;
                case 'd':
                        dflag++;
                        break;
                case 'f':
                        outfile = optarg;
                        break;
                case 't':
                        tflag++;
                        break;
                case 'u':
                        uflag++;
                        break;
                case 'w':
                        wflag++;
                        break;
                case 'v':
                        vflag++;
                        /* FALLTHROUGH */
                case 'x':
                        xflag++;
                        break;
                case '?':
                default:
                        goto usage;
                }
        argv += optind;
        argc -= optind;
        if (!argc) {
 usage:;        (void)fprintf(stderr,
                        "usage: ctags [-BFadtuwvx] [-f tagsfile] file ...\n");
                exit(EXIT_FAILURE);
        }

        if ((sz = shquote(outfile, tname, sizeof tname)) >= sizeof tname) {
                /* nb: (size_t)-1 > sizeof tname */
                if (sz == (size_t)-1)
                        err(EXIT_FAILURE, "Output file name '%s' too long",
                            outfile);
                else
                        errx(EXIT_FAILURE, "Output file name '%s' too long",
                            outfile);
        }

        init();

        exit_val = EXIT_SUCCESS;
        for (step = 0; step < argc; ++step)
                if (!(inf = fopen(argv[step], "r"))) {
                        warn("%s", argv[step]);
                        exit_val = EXIT_FAILURE;
                }
                else {
                        curfile = argv[step];
                        find_entries(argv[step]);
                        (void)fclose(inf);
                }

        if (head) {
                if (xflag)
                        put_entries(head);
                else {
                        if (uflag) {
                                for (step = 0; step < argc; step++) {
                                        char pattern[140];

                                        if (asprintf(&cmd, "\t%s\t",
                                            argv[step]) == -1)
                                                err(EXIT_FAILURE,
                                                   "Cannot generate '\\t%s\\t'",
                                                   argv[step]);

                                        if ((sz = shquote(cmd, pattern,
                                            sizeof pattern)) >= sizeof pattern)
                                        {
                                                if (sz == (size_t)-1)
                                                    err(EXIT_FAILURE, "'%s': "
                                                        "quoting pattern", cmd);
                                                else
                                                    errx(EXIT_FAILURE, "'%s': "
                                                        "failed to quote", cmd);
                                        }
                                        (void)free(cmd);

                                        if (asprintf(&cmd,
                                         "OTAGS=$(mktemp -t tags.$$) || exit\n"
                                         "\ttest -n \"${OTAGS}\" || exit\n"
                                         "\ttrap 'rm -f \"${OTAGS}\"' EXIT\n"
                                         "\tmv %s \"${OTAGS}\" || exit\n"
                                         "\tfgrep -v %s \"${OTAGS}\" >%s\n"
                                         "\tX=$? ; "
                                         "test \"$X\" -le 1 || exit $X",
                                            tname, pattern, tname) == -1)
                                                err(EXIT_FAILURE,
                                                  "Command to update %s for -u"
                                                     " %s",
                                                  argv[step], outfile);

                                        if (system(cmd) != 0)
                                                errx(EXIT_FAILURE,
                                                  "Update (-u) of %s failed.   "
                                                  "Cmd:\n    %s", outfile, cmd);

                                        (void)free(cmd);
                                }
                                ++aflag;
                        }
                        if (!(outf = fopen(outfile, aflag ? "a" : "w")))
                                err(EXIT_FAILURE, "%s", outfile);
                        put_entries(head);
                        (void)fflush(outf);
                        if (ferror(outf))
                                err(EXIT_FAILURE, "output error (%s)", outfile);
                        (void)fclose(outf);
                        if (uflag) {
                                if (asprintf(&cmd, "sort -o %s %s",
                                    tname, tname) == -1)
                                        err(EXIT_FAILURE,
                                            "sort command (-u) for %s",
                                            outfile);
                                if (system(cmd) != 0)
                                        errx(EXIT_FAILURE, "-u: sort %s failed"
                                            "\t[ %s ]", outfile, cmd);
                                (void)free(cmd);
                        }
                }
        }
        if ((vflag || xflag) && (fflush(stdout) != 0 || ferror(stdout) != 0))
                errx(EXIT_FAILURE, "write error (stdout)");
        exit(exit_val);
}

/*
 * init --
 *      this routine sets up the boolean pseudo-functions which work by
 *      setting boolean flags dependent upon the corresponding character.
 *      Every char which is NOT in that string is false with respect to
 *      the pseudo-function.  Therefore, all of the array "_wht" is NO
 *      by default and then the elements subscripted by the chars in
 *      CWHITE are set to YES.  Thus, "_wht" of a char is YES if it is in
 *      the string CWHITE, else NO.
 */
void
init(void)
{
        int             i;
        const char      *sp;

        for (i = 0; i < 256; i++) {
                _wht[i] = _etk[i] = _itk[i] = _btk[i] = NO;
                _gd[i] = YES;
        }
#define CWHITE  " \f\t\n"
        for (sp = CWHITE; *sp; sp++)    /* white space chars */
                _wht[(unsigned)*sp] = YES;
#define CTOKEN  " \t\n\"'#()[]{}=-+%*/&|^~!<>;,.:?"
        for (sp = CTOKEN; *sp; sp++)    /* token ending chars */
                _etk[(unsigned)*sp] = YES;
#define CINTOK  "ABCDEFGHIJKLMNOPQRSTUVWXYZ_abcdefghijklmnopqrstuvwxyz0123456789"
        for (sp = CINTOK; *sp; sp++)    /* valid in-token chars */
                _itk[(unsigned)*sp] = YES;
#define CBEGIN  "ABCDEFGHIJKLMNOPQRSTUVWXYZ_abcdefghijklmnopqrstuvwxyz"
        for (sp = CBEGIN; *sp; sp++)    /* token starting chars */
                _btk[(unsigned)*sp] = YES;
#define CNOTGD  ",;"
        for (sp = CNOTGD; *sp; sp++)    /* invalid after-function chars */
                _gd[(unsigned)*sp] = NO;
}

/*
 * find_entries --
 *      this routine opens the specified file and calls the function
 *      which searches the file.
 */
void
find_entries(char *file)
{
        char    *cp;

        lineno = 0;                             /* should be 1 ?? KB */
        if ((cp = strrchr(file, '.')) != NULL) {
                if (cp[1] == 'l' && !cp[2]) {
                        int     c;

                        for (;;) {
                                if (GETC(==, EOF))
                                        return;
                                if (!iswhite(c)) {
                                        rewind(inf);
                                        break;
                                }
                        }
#define LISPCHR ";(["
/* lisp */              if (strchr(LISPCHR, c)) {
                                l_entries();
                                return;
                        }
/* lex */               else {
                                /*
                                 * we search all 3 parts of a lex file
                                 * for C references.  This may be wrong.
                                 */
                                toss_yysec();
                                (void)strlcpy(lbuf, "%%$", sizeof(lbuf));
                                pfnote("yylex", lineno);
                                rewind(inf);
                        }
                }
/* yacc */      else if (cp[1] == 'y' && !cp[2]) {
                        /*
                         * we search only the 3rd part of a yacc file
                         * for C references.  This may be wrong.
                         */
                        toss_yysec();
                        (void)strlcpy(lbuf, "%%$", sizeof(lbuf));
                        pfnote("yyparse", lineno);
                        y_entries();
                }
/* fortran */   else if ((cp[1] != 'c' && cp[1] != 'h') && !cp[2]) {
                        if (PF_funcs())
                                return;
                        rewind(inf);
                }
        }
/* C */ c_entries();
}