xref: /illumos-gate/usr/src/lib/libtecla/common/errmsg.h (revision 1da57d551424de5a9d469760be7c4b4d4f10a755)
1 #ifndef errmsg_h
2 #define errmsg_h
3 
4 /*
5  * Copyright (c) 2000, 2001, 2002, 2003, 2004 by Martin C. Shepherd.
6  *
7  * All rights reserved.
8  *
9  * Permission is hereby granted, free of charge, to any person obtaining a
10  * copy of this software and associated documentation files (the
11  * "Software"), to deal in the Software without restriction, including
12  * without limitation the rights to use, copy, modify, merge, publish,
13  * distribute, and/or sell copies of the Software, and to permit persons
14  * to whom the Software is furnished to do so, provided that the above
15  * copyright notice(s) and this permission notice appear in all copies of
16  * the Software and that both the above copyright notice(s) and this
17  * permission notice appear in supporting documentation.
18  *
19  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS
20  * OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
21  * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT
22  * OF THIRD PARTY RIGHTS. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR
23  * HOLDERS INCLUDED IN THIS NOTICE BE LIABLE FOR ANY CLAIM, OR ANY SPECIAL
24  * INDIRECT OR CONSEQUENTIAL DAMAGES, OR ANY DAMAGES WHATSOEVER RESULTING
25  * FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT,
26  * NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION
27  * WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
28  *
29  * Except as contained in this notice, the name of a copyright holder
30  * shall not be used in advertising or otherwise to promote the sale, use
31  * or other dealings in this Software without prior written authorization
32  * of the copyright holder.
33  */
34 
35 /*
36  * Set the longest expected length of an error message (excluding its
37  * '\0' terminator. Since any message over a nominal terminal width of
38  * 80 characters is going to look a mess, it makes no sense to support
39  * huge lengths. Note that many uses of strings declared with this
40  * macro assume that it will be at least 81, so don't reduce it below
41  * this limit.
42  */
43 #define ERR_MSG_LEN 128
44 
45 /*
46  * Provide an opaque typedef to the error-message object.
47  */
48 typedef struct ErrMsg ErrMsg;
49 
50 /*
51  * The following token is used to terminate the argument lists of calls
52  * to _err_record_msg().
53  */
54 #define END_ERR_MSG ((const char *)0)
55 
56 /*
57  * Allocate a new error-message buffer.
58  */
59 ErrMsg *_new_ErrMsg(void);
60 
61 /*
62  * Delete an error message buffer.
63  */
64 ErrMsg *_del_ErrMsg(ErrMsg *err);
65 
66 /*
67  * Concatenate a list of string arguments into the specified buffer, buff[],
68  * which has an allocated size of buffdim characters.
69  * The last argument must be END_ERR_MSG to terminate the argument list.
70  */
71 void _err_record_msg(ErrMsg *err, ...);
72 
73 /*
74  * Replace the current error message with an empty string.
75  */
76 void _err_clear_msg(ErrMsg *err);
77 
78 /*
79  * Return a pointer to the error message buffer. This is
80  * a '\0' terminated character array containing ERR_MSG_LEN+1
81  * elements.
82  */
83 char *_err_get_msg(ErrMsg *err);
84 
85 #endif
86