xref: /netbsd/lib/libc/regex/regerror.c (revision bb690fe7)
1 /*	$NetBSD: regerror.c,v 1.26 2022/11/05 11:33:55 riastradh Exp $	*/
2 
3 /*-
4  * SPDX-License-Identifier: BSD-3-Clause
5  *
6  * Copyright (c) 1992, 1993, 1994 Henry Spencer.
7  * Copyright (c) 1992, 1993, 1994
8  *	The Regents of the University of California.  All rights reserved.
9  *
10  * This code is derived from software contributed to Berkeley by
11  * Henry Spencer.
12  *
13  * Redistribution and use in source and binary forms, with or without
14  * modification, are permitted provided that the following conditions
15  * are met:
16  * 1. Redistributions of source code must retain the above copyright
17  *    notice, this list of conditions and the following disclaimer.
18  * 2. Redistributions in binary form must reproduce the above copyright
19  *    notice, this list of conditions and the following disclaimer in the
20  *    documentation and/or other materials provided with the distribution.
21  * 3. Neither the name of the University nor the names of its contributors
22  *    may be used to endorse or promote products derived from this software
23  *    without specific prior written permission.
24  *
25  * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
26  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
27  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
28  * ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
29  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
30  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
31  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
32  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
33  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
34  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
35  * SUCH DAMAGE.
36  *
37  *	@(#)regerror.c	8.4 (Berkeley) 3/20/94
38  */
39 
40 #if HAVE_NBTOOL_CONFIG_H
41 #include "nbtool_config.h"
42 #endif
43 
44 #include <sys/cdefs.h>
45 #if 0
46 static char sccsid[] = "@(#)regerror.c	8.4 (Berkeley) 3/20/94";
47 __FBSDID("$FreeBSD: head/lib/libc/regex/regerror.c 326025 2017-11-20 19:49:47Z pfg $");
48 #endif
49 __RCSID("$NetBSD: regerror.c,v 1.26 2022/11/05 11:33:55 riastradh Exp $");
50 
51 #include "namespace.h"
52 #include <sys/types.h>
53 #include <stdio.h>
54 #include <string.h>
55 #include <limits.h>
56 #include <stdlib.h>
57 #include <regex.h>
58 
59 #include "utils.h"
60 
61 #ifdef __weak_alias
__weak_alias(regerror,_regerror)62 __weak_alias(regerror,_regerror)
63 #endif
64 
65 /* ========= begin header generated by ./mkh ========= */
66 #ifdef __cplusplus
67 extern "C" {
68 #endif
69 
70 /* === regerror.c === */
71 static const char *regatoi(const regex_t *preg, char *localbufm, size_t buflen);
72 
73 #ifdef __cplusplus
74 }
75 #endif
76 /* ========= end header generated by ./mkh ========= */
77 /*
78  = #define	REG_NOMATCH	 1
79  = #define	REG_BADPAT	 2
80  = #define	REG_ECOLLATE	 3
81  = #define	REG_ECTYPE	 4
82  = #define	REG_EESCAPE	 5
83  = #define	REG_ESUBREG	 6
84  = #define	REG_EBRACK	 7
85  = #define	REG_EPAREN	 8
86  = #define	REG_EBRACE	 9
87  = #define	REG_BADBR	10
88  = #define	REG_ERANGE	11
89  = #define	REG_ESPACE	12
90  = #define	REG_BADRPT	13
91  = #define	REG_EMPTY	14
92  = #define	REG_ASSERT	15
93  = #define	REG_INVARG	16
94  = #define	REG_ENOSYS	17
95  = #define	REG_ILLSEQ	18
96  = #define	REG_ATOI	255	// convert name to number (!)
97  = #define	REG_ITOA	0400	// convert number to name (!)
98  */
99 static const struct rerr {
100 	int code;
101 	const char *name;
102 	const char *explain;
103 } rerrs[] = {
104 	{REG_NOMATCH,	"REG_NOMATCH",	"regexec() failed to match"},
105 	{REG_BADPAT,	"REG_BADPAT",	"invalid regular expression"},
106 	{REG_ECOLLATE,	"REG_ECOLLATE",	"invalid collating element"},
107 	{REG_ECTYPE,	"REG_ECTYPE",	"invalid character class"},
108 	{REG_EESCAPE,	"REG_EESCAPE",	"trailing backslash (\\)"},
109 	{REG_ESUBREG,	"REG_ESUBREG",	"invalid backreference number"},
110 	{REG_EBRACK,	"REG_EBRACK",	"brackets ([ ]) not balanced"},
111 	{REG_EPAREN,	"REG_EPAREN",	"parentheses not balanced"},
112 	{REG_EBRACE,	"REG_EBRACE",	"braces not balanced"},
113 	{REG_BADBR,	"REG_BADBR",	"invalid repetition count(s)"},
114 	{REG_ERANGE,	"REG_ERANGE",	"invalid character range"},
115 	{REG_ESPACE,	"REG_ESPACE",	"out of memory"},
116 	{REG_BADRPT,	"REG_BADRPT",	"repetition-operator operand invalid"},
117 	{REG_EMPTY,	"REG_EMPTY",	"empty (sub)expression"},
118 	{REG_ASSERT,	"REG_ASSERT",	"\"can't happen\" -- you found a bug"},
119 	{REG_INVARG,	"REG_INVARG",	"invalid argument to regex routine"},
120 	{REG_ILLSEQ,	"REG_ILLSEQ",	"illegal byte sequence"},
121 	{0,		"",		"*** unknown regexp error code ***"}
122 };
123 
124 /*
125  - regerror - the interface to error numbers
126  = extern size_t regerror(int, const regex_t *, char *, size_t);
127  */
128 /* ARGSUSED */
129 size_t
regerror(int errcode,const regex_t * __restrict preg,char * __restrict errbuf,size_t errbuf_size)130 regerror(int errcode,
131 	 const regex_t * __restrict preg,
132 	 char * __restrict errbuf,
133 	 size_t errbuf_size)
134 {
135 	const struct rerr *r;
136 	size_t len;
137 	int target = errcode &~ REG_ITOA;
138 	const char *s;
139 	char convbuf[50];
140 
141 	_DIAGASSERT(errcode != REG_ATOI || preg != NULL);
142 	_DIAGASSERT(errbuf_size == 0 || errbuf != NULL);
143 
144 	if (errcode == REG_ATOI) {
145 		s = regatoi(preg, convbuf, sizeof convbuf);
146 	} else {
147 		for (r = rerrs; r->code != 0; r++)
148 			if (r->code == target)
149 				break;
150 
151 		if (errcode&REG_ITOA) {
152 			if (r->code != 0)
153 				(void) strlcpy(convbuf, r->name, sizeof(convbuf));
154 			else
155 				snprintf(convbuf, sizeof(convbuf), "REG_0x%x", target);
156 			s = convbuf;
157 		} else
158 			s = r->explain;
159 	}
160 
161 	len = strlen(s) + 1;
162 	if (errbuf_size > 0)
163 		(void) strlcpy(errbuf, s, errbuf_size);
164 
165 	return(len);
166 }
167 
168 /*
169  - regatoi - internal routine to implement REG_ATOI
170  == static char *regatoi(const regex_t *preg, char *localbuf);
171  */
172 static const char *
regatoi(const regex_t * preg,char * localbuf,size_t buflen)173 regatoi(const regex_t *preg, char *localbuf, size_t buflen)
174 {
175 	const struct rerr *r;
176 
177 	for (r = rerrs; r->code != 0; r++)
178 		if (strcmp(r->name, preg->re_endp) == 0)
179 			break;
180 	if (r->code == 0)
181 		return "0";
182 
183 	snprintf(localbuf, buflen, "%d", r->code);
184 	return localbuf;
185 }
186