Home | History | Annotate | Line # | Download | only in lint1
ckgetopt.c revision 1.21 
      1 /* $NetBSD: ckgetopt.c,v 1.21 2024/02/03 12:57:12 rillig Exp $ */
      2 
      3 /*-
      4  * Copyright (c) 2021 The NetBSD Foundation, Inc.
      5  * All rights reserved.
      6  *
      7  * This code is derived from software contributed to The NetBSD Foundation
      8  * by Roland Illig <rillig (at) NetBSD.org>.
      9  *
     10  * Redistribution and use in source and binary forms, with or without
     11  * modification, are permitted provided that the following conditions
     12  * are met:
     13  * 1. Redistributions of source code must retain the above copyright
     14  *    notice, this list of conditions and the following disclaimer.
     15  * 2. Redistributions in binary form must reproduce the above copyright
     16  *    notice, this list of conditions and the following disclaimer in the
     17  *    documentation and/or other materials provided with the distribution.
     18  *
     19  * THIS SOFTWARE IS PROVIDED BY THE NETBSD FOUNDATION, INC. AND CONTRIBUTORS
     20  * ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
     21  * TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
     22  * PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL THE FOUNDATION OR CONTRIBUTORS
     23  * BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
     24  * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
     25  * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
     26  * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
     27  * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
     28  * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
     29  * POSSIBILITY OF SUCH DAMAGE.
     30  */
     31 
     32 #if HAVE_NBTOOL_CONFIG_H
     33 #include "nbtool_config.h"
     34 #endif
     35 
     36 #include <sys/cdefs.h>
     37 #if defined(__RCSID)
     38 __RCSID("$NetBSD: ckgetopt.c,v 1.21 2024/02/03 12:57:12 rillig Exp $");
     39 #endif
     40 
     41 #include <stdbool.h>
     42 #include <stdlib.h>
     43 #include <string.h>
     44 
     45 #include "lint1.h"
     46 
     47 /*
     48  * In a typical while loop for parsing getopt options, ensure that each
     49  * option from the options string is handled, and that each handled option
     50  * is listed in the options string.
     51  */
     52 
     53 static struct {
     54 	/*-
     55 	 * 0	means outside a while loop with a getopt call.
     56 	 * 1	means directly inside a while loop with a getopt call.
     57 	 * > 1	means in a nested while loop; this is used for finishing the
     58 	 *	check at the correct point.
     59 	 */
     60 	int while_level;
     61 
     62 	/*
     63 	 * The options string from the getopt call.  Whenever an option is
     64 	 * handled by a case label, it is set to ' '.  In the end, only ' ' and
     65 	 * ':' should remain.
     66 	 */
     67 	pos_t options_pos;
     68 	char *options;
     69 
     70 	/*
     71 	 * The nesting level of switch statements, is only modified if
     72 	 * while_level > 0.  Only the case labels at switch_level == 1 are
     73 	 * relevant, all nested case labels are ignored.
     74 	 */
     75 	int switch_level;
     76 } ck;
     77 
     78 /* Return whether tn has the form '(c = getopt(argc, argv, "str")) != -1'. */
     79 static bool
     80 is_getopt_condition(const tnode_t *tn, char **out_options)
     81 {
     82 	const tnode_t *call, *last_arg;
     83 	const buffer *str;
     84 
     85 	if (tn != NULL
     86 	    && tn->tn_op == NE
     87 	    && tn->tn_left->tn_op == ASSIGN
     88 	    && tn->tn_right->tn_op == CON
     89 	    && tn->tn_right->tn_u._tn_val.v_tspec == INT
     90 	    && tn->tn_right->tn_u._tn_val.u.integer == -1
     91 
     92 	    && (call = tn->tn_left->tn_right)->tn_op == CALL
     93 	    && call->tn_left->tn_op == ADDR
     94 	    && call->tn_left->tn_left->tn_op == NAME
     95 	    && strcmp(call->tn_left->tn_left->tn_sym->s_name, "getopt") == 0
     96 
     97 	    && call->tn_right->tn_op == PUSH
     98 
     99 	    && (last_arg = call->tn_right->tn_left)->tn_op == CVT
    100 	    && last_arg->tn_left->tn_op == ADDR
    101 	    && last_arg->tn_left->tn_left->tn_op == STRING
    102 	    && (str = last_arg->tn_left->tn_left->tn_string)->data != NULL) {
    103 		*out_options = xstrdup(str->data);
    104 		return true;
    105 	}
    106 	return false;
    107 }
    108 
    109 static void
    110 check_unlisted_option(char opt)
    111 {
    112 	if (opt == ':' && ck.options[0] != ':')
    113 		goto warn;
    114 
    115 	char *optptr = strchr(ck.options, opt);
    116 	if (optptr != NULL)
    117 		*optptr = ' ';
    118 	else if (opt != '?')
    119 	warn:
    120 		/* option '%c' should be listed in the options string */
    121 		warning(339, opt);
    122 }
    123 
    124 static void
    125 check_unhandled_option(void)
    126 {
    127 	for (const char *opt = ck.options; *opt != '\0'; opt++) {
    128 		if (*opt == ' ' || *opt == ':')
    129 			continue;
    130 
    131 		/* option '%c' should be handled in the switch */
    132 		warning_at(338, &ck.options_pos, *opt);
    133 	}
    134 }
    135 
    136 
    137 void
    138 check_getopt_begin_while(const tnode_t *tn)
    139 {
    140 	if (ck.while_level == 0) {
    141 		if (!is_getopt_condition(tn, &ck.options))
    142 			return;
    143 		ck.options_pos = curr_pos;
    144 	}
    145 	ck.while_level++;
    146 }
    147 
    148 void
    149 check_getopt_begin_switch(void)
    150 {
    151 	if (ck.while_level > 0)
    152 		ck.switch_level++;
    153 }
    154 
    155 void
    156 check_getopt_case_label(int64_t value)
    157 {
    158 	if (ck.switch_level == 1 && value == (char)value)
    159 		check_unlisted_option((char)value);
    160 }
    161 
    162 void
    163 check_getopt_end_switch(void)
    164 {
    165 	if (ck.switch_level == 0)
    166 		return;
    167 
    168 	ck.switch_level--;
    169 	if (ck.switch_level == 0)
    170 		check_unhandled_option();
    171 }
    172 
    173 void
    174 check_getopt_end_while(void)
    175 {
    176 	if (ck.while_level == 0)
    177 		return;
    178 
    179 	ck.while_level--;
    180 	if (ck.while_level != 0)
    181 		return;
    182 
    183 	free(ck.options);
    184 	ck.options = NULL;
    185 }
    186