Home | History | Annotate | Line # | Download | only in sh 
      1 /*	$NetBSD: syntax.h,v 1.14 2025/07/03 11:28:06 kre Exp $	*/
      2 
      3 /*-
      4  * Copyright (c) 1991, 1993
      5  *	The Regents of the University of California.  All rights reserved.
      6  *
      7  * This code is derived from software contributed to Berkeley by
      8  * Kenneth Almquist.
      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  * 3. Neither the name of the University nor the names of its contributors
     19  *    may be used to endorse or promote products derived from this software
     20  *    without specific prior written permission.
     21  *
     22  * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
     23  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
     24  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
     25  * ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
     26  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
     27  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
     28  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
     29  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
     30  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
     31  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
     32  * SUCH DAMAGE.
     33  */
     34 
     35 #include <sys/cdefs.h>
     36 #include <ctype.h>
     37 #include <limits.h>
     38 
     39 #undef	CEOF			/* remove system defined version */
     40 
     41 /* Syntax classes */
     42 #define CWORD 0			/* character is nothing special */
     43 #define CNL 1			/* newline character */
     44 #define CBACK 2			/* a backslash character */
     45 #define CSQUOTE 3		/* single quote */
     46 #define CDQUOTE 4		/* double quote */
     47 #define CBQUOTE 5		/* backwards single quote */
     48 #define CVAR 6			/* a dollar sign */
     49 #define CENDVAR 7		/* a '}' character */
     50 #define CLP 8			/* a left paren in arithmetic */
     51 #define CRP 9			/* a right paren in arithmetic */
     52 #define CEOF 10			/* end of file */
     53 #define CSPCL 11		/* these terminate a word */
     54 #define CCTL 12			/* like CWORD, except it must be escaped */
     55 #define CSBACK 13		/* a backslash in a single quote syntax */
     56 #define CFAKE 14		/* a delimiter that does not exist */
     57 	/*
     58 	 * note CSBACK == (CCTL|1)
     59 	 * the code does not rely upon that, but keeping it allows a
     60 	 * smart enough compiler to optimise some tests
     61 	 */
     62 
     63 /* Syntax classes for is_ functions */
     64 #define ISDIGIT 01		/* a digit */
     65 #define ISUPPER 02		/* an upper case letter */
     66 #define ISLOWER 04		/* a lower case letter */
     67 #define ISUNDER 010		/* an underscore */
     68 #define ISSPECL 020		/* the name of a special parameter */
     69 #define ISSPACE 040		/* a white space character */
     70 
     71 #define PEOF	(CHAR_MIN - 1)
     72 #define PFAKE	(CHAR_MIN - 2)
     73 #define SYNBASE	(-PFAKE)
     74 
     75 
     76 #define BASESYNTAX (basesyntax + SYNBASE)
     77 #define DQSYNTAX (dqsyntax + SYNBASE)
     78 #define SQSYNTAX (sqsyntax + SYNBASE)
     79 #define ARISYNTAX (arisyntax + SYNBASE)
     80 
     81 /* These defines assume that the digits are contiguous (which is guaranteed) */
     82 #define	is_digit(c)	((unsigned)((c) - '0') <= 9)
     83 #define	sh_ctype(c)	(is_type+SYNBASE)[(int)(c)]
     84 #define	is_upper(c)	(sh_ctype(c) & ISUPPER)
     85 #define	is_lower(c)	(sh_ctype(c) & ISLOWER)
     86 #define	is_alpha(c)	(sh_ctype(c) & (ISUPPER|ISLOWER))
     87 #define	is_name(c)	(sh_ctype(c) & (ISUPPER|ISLOWER|ISUNDER))
     88 #define	is_in_name(c)	(sh_ctype(c) & (ISUPPER|ISLOWER|ISUNDER|ISDIGIT))
     89 #define	is_special(c)	(sh_ctype(c) & (ISSPECL|ISDIGIT))
     90 #define	is_space(c)	(sh_ctype(c) & ISSPACE)
     91 #define	digit_val(c)	((c) - '0')
     92 
     93 /* true if the arg char needs CTLESC to protect it */
     94 #define	NEEDESC(c)	(SQSYNTAX[(int)(c)] == CCTL || \
     95 			 SQSYNTAX[(int)(c)] == CSBACK)
     96 
     97 #define	ISCTL(c)	((c) >= CTL_FIRST && (c) <= CTL_LAST)
     98 #if 0				/* alternative form (generally slower) */
     99 #define	ISCTL(c)	(BASESYNTAX[(int)(c)] == CCTL)
    100 #endif
    101 
    102 extern const char basesyntax[];
    103 extern const char dqsyntax[];
    104 extern const char sqsyntax[];
    105 extern const char arisyntax[];
    106 extern const char is_type[];
    107