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