root/usr.bin/indent/args.c
/*-
 * SPDX-License-Identifier: BSD-4-Clause
 *
 * Copyright (c) 1985 Sun Microsystems, Inc.
 * Copyright (c) 1980, 1993
 *      The Regents of the University of California.  All rights reserved.
 * 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. All advertising materials mentioning features or use of this software
 *    must display the following acknowledgement:
 *      This product includes software developed by the University of
 *      California, Berkeley and its contributors.
 * 4. 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.
 */

#include <sys/cdefs.h>
/*
 * Argument scanning and profile reading code.  Default parameters are set
 * here as well.
 */

#include <ctype.h>
#include <err.h>
#include <limits.h>
#include <stdio.h>
#include <stdlib.h>
#include <string.h>
#include "indent_globs.h"
#include "indent.h"

#define INDENT_VERSION  "2.0"

/* profile types */
#define PRO_SPECIAL     1       /* special case */
#define PRO_BOOL        2       /* boolean */
#define PRO_INT         3       /* integer */

/* profile specials for booleans */
#define ON              1       /* turn it on */
#define OFF             0       /* turn it off */

/* profile specials for specials */
#define IGN             1       /* ignore it */
#define CLI             2       /* case label indent (float) */
#define STDIN           3       /* use stdin */
#define KEY             4       /* type (keyword) */

static void scan_profile(FILE *);

#define KEY_FILE                5       /* only used for args */
#define VERSION                 6       /* only used for args */

const char *option_source = "?";

void add_typedefs_from_file(const char *str);

/*
 * N.B.: because of the way the table here is scanned, options whose names are
 * substrings of other options must occur later; that is, with -lp vs -l, -lp
 * must be first.  Also, while (most) booleans occur more than once, the last
 * default value is the one actually assigned.
 */
struct pro {
    const char *p_name;         /* name, e.g. -bl, -cli */
    int         p_type;         /* type (int, bool, special) */
    int         p_default;      /* the default value (if int) */
    int         p_special;      /* depends on type */
    int        *p_obj;          /* the associated variable */
}           pro[] = {

    {"T", PRO_SPECIAL, 0, KEY, 0},
    {"U", PRO_SPECIAL, 0, KEY_FILE, 0},
    {"-version", PRO_SPECIAL, 0, VERSION, 0},
    {"P", PRO_SPECIAL, 0, IGN, 0},
    {"bacc", PRO_BOOL, false, ON, &opt.blanklines_around_conditional_compilation},
    {"badp", PRO_BOOL, false, ON, &opt.blanklines_after_declarations_at_proctop},
    {"bad", PRO_BOOL, false, ON, &opt.blanklines_after_declarations},
    {"bap", PRO_BOOL, false, ON, &opt.blanklines_after_procs},
    {"bbb", PRO_BOOL, false, ON, &opt.blanklines_before_blockcomments},
    {"bc", PRO_BOOL, true, OFF, &opt.leave_comma},
    {"bl", PRO_BOOL, true, OFF, &opt.btype_2},
    {"br", PRO_BOOL, true, ON, &opt.btype_2},
    {"bs", PRO_BOOL, false, ON, &opt.Bill_Shannon},
    {"cdb", PRO_BOOL, true, ON, &opt.comment_delimiter_on_blankline},
    {"cd", PRO_INT, 0, 0, &opt.decl_com_ind},
    {"ce", PRO_BOOL, true, ON, &opt.cuddle_else},
    {"ci", PRO_INT, 0, 0, &opt.continuation_indent},
    {"cli", PRO_SPECIAL, 0, CLI, 0},
    {"cs", PRO_BOOL, false, ON, &opt.space_after_cast},
    {"c", PRO_INT, 33, 0, &opt.com_ind},
    {"di", PRO_INT, 16, 0, &opt.decl_indent},
    {"dj", PRO_BOOL, false, ON, &opt.ljust_decl},
    {"d", PRO_INT, 0, 0, &opt.unindent_displace},
    {"eei", PRO_BOOL, false, ON, &opt.extra_expression_indent},
    {"ei", PRO_BOOL, true, ON, &opt.else_if},
    {"fbs", PRO_BOOL, true, ON, &opt.function_brace_split},
    {"fc1", PRO_BOOL, true, ON, &opt.format_col1_comments},
    {"fcb", PRO_BOOL, true, ON, &opt.format_block_comments},
    {"ip", PRO_BOOL, true, ON, &opt.indent_parameters},
    {"i", PRO_INT, 8, 0, &opt.ind_size},
    {"lc", PRO_INT, 0, 0, &opt.block_comment_max_col},
    {"ldi", PRO_INT, -1, 0, &opt.local_decl_indent},
    {"lpl", PRO_BOOL, false, ON, &opt.lineup_to_parens_always},
    {"lp", PRO_BOOL, true, ON, &opt.lineup_to_parens},
    {"l", PRO_INT, 78, 0, &opt.max_col},
    {"nbacc", PRO_BOOL, false, OFF, &opt.blanklines_around_conditional_compilation},
    {"nbadp", PRO_BOOL, false, OFF, &opt.blanklines_after_declarations_at_proctop},
    {"nbad", PRO_BOOL, false, OFF, &opt.blanklines_after_declarations},
    {"nbap", PRO_BOOL, false, OFF, &opt.blanklines_after_procs},
    {"nbbb", PRO_BOOL, false, OFF, &opt.blanklines_before_blockcomments},
    {"nbc", PRO_BOOL, true, ON, &opt.leave_comma},
    {"nbs", PRO_BOOL, false, OFF, &opt.Bill_Shannon},
    {"ncdb", PRO_BOOL, true, OFF, &opt.comment_delimiter_on_blankline},
    {"nce", PRO_BOOL, true, OFF, &opt.cuddle_else},
    {"ncs", PRO_BOOL, false, OFF, &opt.space_after_cast},
    {"ndj", PRO_BOOL, false, OFF, &opt.ljust_decl},
    {"neei", PRO_BOOL, false, OFF, &opt.extra_expression_indent},
    {"nei", PRO_BOOL, true, OFF, &opt.else_if},
    {"nfbs", PRO_BOOL, true, OFF, &opt.function_brace_split},
    {"nfc1", PRO_BOOL, true, OFF, &opt.format_col1_comments},
    {"nfcb", PRO_BOOL, true, OFF, &opt.format_block_comments},
    {"nip", PRO_BOOL, true, OFF, &opt.indent_parameters},
    {"nlpl", PRO_BOOL, false, OFF, &opt.lineup_to_parens_always},
    {"nlp", PRO_BOOL, true, OFF, &opt.lineup_to_parens},
    {"npcs", PRO_BOOL, false, OFF, &opt.proc_calls_space},
    {"npro", PRO_SPECIAL, 0, IGN, 0},
    {"npsl", PRO_BOOL, true, OFF, &opt.procnames_start_line},
    {"nps", PRO_BOOL, false, OFF, &opt.pointer_as_binop},
    {"nsc", PRO_BOOL, true, OFF, &opt.star_comment_cont},
    {"nsob", PRO_BOOL, false, OFF, &opt.swallow_optional_blanklines},
    {"nut", PRO_BOOL, true, OFF, &opt.use_tabs},
    {"nv", PRO_BOOL, false, OFF, &opt.verbose},
    {"pcs", PRO_BOOL, false, ON, &opt.proc_calls_space},
    {"psl", PRO_BOOL, true, ON, &opt.procnames_start_line},
    {"ps", PRO_BOOL, false, ON, &opt.pointer_as_binop},
    {"sc", PRO_BOOL, true, ON, &opt.star_comment_cont},
    {"sob", PRO_BOOL, false, ON, &opt.swallow_optional_blanklines},
    {"st", PRO_SPECIAL, 0, STDIN, 0},
    {"ta", PRO_BOOL, false, ON, &opt.auto_typedefs},
    {"ts", PRO_INT, 8, 0, &opt.tabsize},
    {"ut", PRO_BOOL, true, ON, &opt.use_tabs},
    {"v", PRO_BOOL, false, ON, &opt.verbose},
    /* whew! */
    {0, 0, 0, 0, 0}
};

/*
 * set_profile reads $HOME/.indent.pro and ./.indent.pro and handles arguments
 * given in these files.
 */
void
set_profile(const char *profile_name)
{
    FILE *f;
    char fname[PATH_MAX];
    static char prof[] = ".indent.pro";

    if (profile_name == NULL)
        snprintf(fname, sizeof(fname), "%s/%s", getenv("HOME"), prof);
    else
        snprintf(fname, sizeof(fname), "%s", profile_name + 2);
    if ((f = fopen(option_source = fname, "r")) != NULL) {
        scan_profile(f);
        (void) fclose(f);
    }
    if ((f = fopen(option_source = prof, "r")) != NULL) {
        scan_profile(f);
        (void) fclose(f);
    }
    option_source = "Command line";
}

static void
scan_profile(FILE *f)
{
    int         comment, i;
    char        *p;
    char        buf[BUFSIZ];

    while (1) {
        p = buf;
        comment = 0;
        while ((i = getc(f)) != EOF) {
            if (i == '*' && !comment && p > buf && p[-1] == '/') {
                comment = p - buf;
                *p++ = i;
            } else if (i == '/' && comment && p > buf && p[-1] == '*') {
                p = buf + comment - 1;
                comment = 0;
            } else if (isspace((unsigned char)i)) {
                if (p > buf && !comment)
                    break;
            } else {
                *p++ = i;
            }
        }
        if (p != buf) {
            *p++ = 0;
            if (opt.verbose)
                printf("profile: %s\n", buf);
            set_option(buf);
        }
        else if (i == EOF)
            return;
    }
}

static const char *
eqin(const char *s1, const char *s2)
{
    while (*s1) {
        if (*s1++ != *s2++)
            return (NULL);
    }
    return (s2);
}

/*
 * Set the defaults.
 */
void
set_defaults(void)
{
    struct pro *p;

    /*
     * Because ps.case_indent is a float, we can't initialize it from the
     * table:
     */
    opt.case_indent = 0.0;      /* -cli0.0 */
    for (p = pro; p->p_name; p++)
        if (p->p_type != PRO_SPECIAL)
            *p->p_obj = p->p_default;
}

void
set_option(char *arg)
{
    struct      pro *p;
    const char  *param_start;

    arg++;                      /* ignore leading "-" */
    for (p = pro; p->p_name; p++)
        if (*p->p_name == *arg && (param_start = eqin(p->p_name, arg)) != NULL)
            goto found;
    errx(1, "%s: unknown parameter \"%s\"", option_source, arg - 1);
found:
    switch (p->p_type) {

    case PRO_SPECIAL:
        switch (p->p_special) {

        case IGN:
            break;

        case CLI:
            if (*param_start == 0)
                goto need_param;
            opt.case_indent = atof(param_start);
            break;

        case STDIN:
            if (input == NULL)
                input = stdin;
            if (output == NULL)
                output = stdout;
            break;

        case KEY:
            if (*param_start == 0)
                goto need_param;
            add_typename(param_start);
            break;

        case KEY_FILE:
            if (*param_start == 0)
                goto need_param;
            add_typedefs_from_file(param_start);
            break;

        case VERSION:
            printf("FreeBSD indent %s\n", INDENT_VERSION);
            exit(0);

        default:
            errx(1, "set_option: internal error: p_special %d", p->p_special);
        }
        break;

    case PRO_BOOL:
        if (p->p_special == OFF)
            *p->p_obj = false;
        else
            *p->p_obj = true;
        break;

    case PRO_INT:
        if (!isdigit((unsigned char)*param_start)) {
    need_param:
            errx(1, "%s: ``%s'' requires a parameter", option_source, p->p_name);
        }
        *p->p_obj = atoi(param_start);
        break;

    default:
        errx(1, "set_option: internal error: p_type %d", p->p_type);
    }
}

void
add_typedefs_from_file(const char *str)
{
    FILE *file;
    char line[BUFSIZ];

    if ((file = fopen(str, "r")) == NULL) {
        fprintf(stderr, "indent: cannot open file %s\n", str);
        exit(1);
    }
    while ((fgets(line, BUFSIZ, file)) != NULL) {
        /* Remove trailing whitespace */
        line[strcspn(line, " \t\n\r")] = '\0';
        add_typename(line);
    }
    fclose(file);
}