xref: /freebsd/lib/libc/regex/regerror.c (revision d0b2dbfa0ecf2bbc9709efc5e20baf8e4b44bbbf)
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 #include <sys/types.h>
43 #include <stdio.h>
44 #include <string.h>
45 #include <limits.h>
46 #include <stdlib.h>
47 #include <regex.h>
48 
49 #include "utils.h"
50 
51 /* ========= begin header generated by ./mkh ========= */
52 #ifdef __cplusplus
53 extern "C" {
54 #endif
55 
56 /* === regerror.c === */
57 static const char *regatoi(const regex_t *preg, char *localbuf);
58 
59 #ifdef __cplusplus
60 }
61 #endif
62 /* ========= end header generated by ./mkh ========= */
63 /*
64  = #define	REG_NOMATCH	 1
65  = #define	REG_BADPAT	 2
66  = #define	REG_ECOLLATE	 3
67  = #define	REG_ECTYPE	 4
68  = #define	REG_EESCAPE	 5
69  = #define	REG_ESUBREG	 6
70  = #define	REG_EBRACK	 7
71  = #define	REG_EPAREN	 8
72  = #define	REG_EBRACE	 9
73  = #define	REG_BADBR	10
74  = #define	REG_ERANGE	11
75  = #define	REG_ESPACE	12
76  = #define	REG_BADRPT	13
77  = #define	REG_EMPTY	14
78  = #define	REG_ASSERT	15
79  = #define	REG_INVARG	16
80  = #define	REG_ILLSEQ	17
81  = #define	REG_ATOI	255	// convert name to number (!)
82  = #define	REG_ITOA	0400	// convert number to name (!)
83  */
84 static struct rerr {
85 	int code;
86 	const char *name;
87 	const char *explain;
88 } rerrs[] = {
89 	{REG_NOMATCH,	"REG_NOMATCH",	"regexec() failed to match"},
90 	{REG_BADPAT,	"REG_BADPAT",	"invalid regular expression"},
91 	{REG_ECOLLATE,	"REG_ECOLLATE",	"invalid collating element"},
92 	{REG_ECTYPE,	"REG_ECTYPE",	"invalid character class"},
93 	{REG_EESCAPE,	"REG_EESCAPE",	"trailing backslash (\\)"},
94 	{REG_ESUBREG,	"REG_ESUBREG",	"invalid backreference number"},
95 	{REG_EBRACK,	"REG_EBRACK",	"brackets ([ ]) not balanced"},
96 	{REG_EPAREN,	"REG_EPAREN",	"parentheses not balanced"},
97 	{REG_EBRACE,	"REG_EBRACE",	"braces not balanced"},
98 	{REG_BADBR,	"REG_BADBR",	"invalid repetition count(s)"},
99 	{REG_ERANGE,	"REG_ERANGE",	"invalid character range"},
100 	{REG_ESPACE,	"REG_ESPACE",	"out of memory"},
101 	{REG_BADRPT,	"REG_BADRPT",	"repetition-operator operand invalid"},
102 	{REG_EMPTY,	"REG_EMPTY",	"empty (sub)expression"},
103 	{REG_ASSERT,	"REG_ASSERT",	"\"can't happen\" -- you found a bug"},
104 	{REG_INVARG,	"REG_INVARG",	"invalid argument to regex routine"},
105 	{REG_ILLSEQ,	"REG_ILLSEQ",	"illegal byte sequence"},
106 	{0,		"",		"*** unknown regexp error code ***"}
107 };
108 
109 /*
110  - regerror - the interface to error numbers
111  = extern size_t regerror(int, const regex_t *, char *, size_t);
112  */
113 /* ARGSUSED */
114 size_t
115 regerror(int errcode,
116 	 const regex_t * __restrict preg,
117 	 char * __restrict errbuf,
118 	 size_t errbuf_size)
119 {
120 	struct rerr *r;
121 	size_t len;
122 	int target = errcode &~ REG_ITOA;
123 	const char *s;
124 	char convbuf[50];
125 
126 	if (errcode == REG_ATOI)
127 		s = regatoi(preg, convbuf);
128 	else {
129 		for (r = rerrs; r->code != 0; r++)
130 			if (r->code == target)
131 				break;
132 
133 		if (errcode&REG_ITOA) {
134 			if (r->code != 0)
135 				(void) strcpy(convbuf, r->name);
136 			else
137 				sprintf(convbuf, "REG_0x%x", target);
138 			assert(strlen(convbuf) < sizeof(convbuf));
139 			s = convbuf;
140 		} else
141 			s = r->explain;
142 	}
143 
144 	len = strlen(s) + 1;
145 	if (errbuf_size > 0) {
146 		if (errbuf_size > len)
147 			(void) strcpy(errbuf, s);
148 		else {
149 			(void) strncpy(errbuf, s, errbuf_size-1);
150 			errbuf[errbuf_size-1] = '\0';
151 		}
152 	}
153 
154 	return(len);
155 }
156 
157 /*
158  - regatoi - internal routine to implement REG_ATOI
159  == static char *regatoi(const regex_t *preg, char *localbuf);
160  */
161 static const char *
162 regatoi(const regex_t *preg, char *localbuf)
163 {
164 	struct rerr *r;
165 
166 	for (r = rerrs; r->code != 0; r++)
167 		if (strcmp(r->name, preg->re_endp) == 0)
168 			break;
169 	if (r->code == 0)
170 		return("0");
171 
172 	sprintf(localbuf, "%d", r->code);
173 	return(localbuf);
174 }
175