1
/* Copyright (C) 2000 MySQL AB
3
This program is free software; you can redistribute it and/or modify
4
it under the terms of the GNU General Public License as published by
5
the Free Software Foundation; version 2 of the License.
7
This program is distributed in the hope that it will be useful,
8
but WITHOUT ANY WARRANTY; without even the implied warranty of
9
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
10
GNU General Public License for more details.
12
You should have received a copy of the GNU General Public License
13
along with this program; if not, write to the Free Software
14
Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA */
16
#include "mysys_priv.h"
17
#include "mysys_err.h"
22
/* Define some external variables for error handling */
26
my_error family functions have to be used according following rules:
27
- if message have not parameters use my_message(ER_CODE, ER(ER_CODE), MYF(N))
28
- if message registered use my_error(ER_CODE, MYF(N), ...).
29
- With some special text of errror message use:
30
my_printf_error(ER_CODE, format, MYF(N), ...)
33
char errbuff[NRERRBUFFS][ERRMSGSIZE];
36
Message texts are registered into a linked list of 'my_err_head' structs.
37
Each struct contains (1.) an array of pointers to C character strings with
38
'\0' termination, (2.) the error number for the first message in the array
39
(array index 0) and (3.) the error number for the last message in the array
40
(array index (last - first)).
41
The array may contain gaps with NULL pointers and pointers to empty strings.
42
Both kinds of gaps will be translated to "Unknown error %d.", if my_error()
43
is called with a respective error number.
44
The list of header structs is sorted in increasing order of error numbers.
45
Negative error numbers are allowed. Overlap of error numbers is not allowed.
46
Not registered error numbers will be translated to "Unknown error %d.".
48
static struct my_err_head
50
struct my_err_head *meh_next; /* chain link */
51
const char **meh_errmsgs; /* error messages array */
52
int meh_first; /* error number matching array slot 0 */
53
int meh_last; /* error number matching last slot */
54
} my_errmsgs_globerrs = {NULL, globerrs, EE_ERROR_FIRST, EE_ERROR_LAST};
56
static struct my_err_head *my_errmsgs_list= &my_errmsgs_globerrs;
69
void my_error(int nr, myf MyFlags, ...)
72
struct my_err_head *meh_p;
74
char ebuff[ERRMSGSIZE + 20];
75
DBUG_ENTER("my_error");
76
DBUG_PRINT("my", ("nr: %d MyFlags: %d errno: %d", nr, MyFlags, errno));
78
/* Search for the error messages array, which could contain the message. */
79
for (meh_p= my_errmsgs_list; meh_p; meh_p= meh_p->meh_next)
80
if (nr <= meh_p->meh_last)
83
/* get the error message string. Default, if NULL or empty string (""). */
84
if (! (format= (meh_p && (nr >= meh_p->meh_first)) ?
85
meh_p->meh_errmsgs[nr - meh_p->meh_first] : NULL) || ! *format)
86
(void) my_snprintf (ebuff, sizeof(ebuff), "Unknown error %d", nr);
89
va_start(args,MyFlags);
90
(void) my_vsnprintf (ebuff, sizeof(ebuff), format, args);
93
(*error_handler_hook)(nr, ebuff, MyFlags);
109
void my_printf_error(uint error, const char *format, myf MyFlags, ...)
112
char ebuff[ERRMSGSIZE+20];
113
DBUG_ENTER("my_printf_error");
114
DBUG_PRINT("my", ("nr: %d MyFlags: %d errno: %d Format: %s",
115
error, MyFlags, errno, format));
117
va_start(args,MyFlags);
118
(void) my_vsnprintf (ebuff, sizeof(ebuff), format, args);
120
(*error_handler_hook)(error, ebuff, MyFlags);
125
Give message using error_handler_hook
134
void my_message(uint error, const char *str, register myf MyFlags)
136
(*error_handler_hook)(error, str, MyFlags);
141
Register error messages for use with my_error().
145
errmsgs array of pointers to error messages
146
first error number of first message in the array
147
last error number of last message in the array
150
The pointer array is expected to contain addresses to NUL-terminated
151
C character strings. The array contains (last - first + 1) pointers.
152
NULL pointers and empty strings ("") are allowed. These will be mapped to
153
"Unknown error" when my_error() is called with a matching error number.
154
This function registers the error numbers 'first' to 'last'.
155
No overlapping with previously registered error numbers is allowed.
162
int my_error_register(const char **errmsgs, int first, int last)
164
struct my_err_head *meh_p;
165
struct my_err_head **search_meh_pp;
167
/* Allocate a new header structure. */
168
if (! (meh_p= (struct my_err_head*) my_malloc(sizeof(struct my_err_head),
171
meh_p->meh_errmsgs= errmsgs;
172
meh_p->meh_first= first;
173
meh_p->meh_last= last;
175
/* Search for the right position in the list. */
176
for (search_meh_pp= &my_errmsgs_list;
178
search_meh_pp= &(*search_meh_pp)->meh_next)
180
if ((*search_meh_pp)->meh_last > first)
184
/* Error numbers must be unique. No overlapping is allowed. */
185
if (*search_meh_pp && ((*search_meh_pp)->meh_first <= last))
187
my_free((uchar*)meh_p, MYF(0));
191
/* Insert header into the chain. */
192
meh_p->meh_next= *search_meh_pp;
193
*search_meh_pp= meh_p;
199
Unregister formerly registered error messages.
202
my_error_unregister()
203
first error number of first message
204
last error number of last message
207
This function unregisters the error numbers 'first' to 'last'.
208
These must have been previously registered by my_error_register().
209
'first' and 'last' must exactly match the registration.
210
If a matching registration is present, the header is removed from the
211
list and the pointer to the error messages pointers array is returned.
212
Otherwise, NULL is returned.
215
non-NULL OK, returns address of error messages pointers array.
216
NULL Error, no such number range registered.
219
const char **my_error_unregister(int first, int last)
221
struct my_err_head *meh_p;
222
struct my_err_head **search_meh_pp;
223
const char **errmsgs;
225
/* Search for the registration in the list. */
226
for (search_meh_pp= &my_errmsgs_list;
228
search_meh_pp= &(*search_meh_pp)->meh_next)
230
if (((*search_meh_pp)->meh_first == first) &&
231
((*search_meh_pp)->meh_last == last))
234
if (! *search_meh_pp)
237
/* Remove header from the chain. */
238
meh_p= *search_meh_pp;
239
*search_meh_pp= meh_p->meh_next;
241
/* Save the return value and free the header. */
242
errmsgs= meh_p->meh_errmsgs;
243
my_free((uchar*) meh_p, MYF(0));
249
void my_error_unregister_all(void)
251
struct my_err_head *list, *next;
252
for (list= my_errmsgs_globerrs.meh_next; list; list= next)
254
next= list->meh_next;
255
my_free((uchar*) list, MYF(0));
257
my_errmsgs_list= &my_errmsgs_globerrs;
added
removed
mysys/my_error.c
