blob: 81748227e5f82e4ea46d134a8df75db83b60ec69 (
plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
|
/** BEGIN COPYRIGHT BLOCK
* Copyright 2001 Sun Microsystems, Inc.
* Portions copyright 1999, 2001-2003 Netscape Communications Corporation.
* All rights reserved.
* END COPYRIGHT BLOCK **/
#ifndef PUBLIC_NSACL_NSERRDEF_H
#define PUBLIC_NSACL_NSERRDEF_H
/*
* Type: NSEFrame_t
*
* Description:
*
* This type describes the structure of an error frame. An error
* frame contains the following items:
*
* ef_retcode - This is a copy of the traditional error code,
* as might be returned as a function value to
* indicate an error. The purpose of the error
* code is to provide the caller of a function
* with sufficient information to determine how
* to process the error. That is, it does not
* need to identify a specific error, but only
* has to distinguish between classes of errors
* as needed by the caller to respond differently.
* Usually this should be a small number of values.
*
* ef_errorid - This is an integer identifier which uniquely
* identifies errors in a module or library.
* That is, there should be only one place in
* the source code of the module or library which
* generates a particular error id. The error id
* is used to select an error message in an error
* message file.
*
* ef_program - This is a pointer to a string which identifies
* the module or library context of ef_errorid.
* The string is used to construct the name of
* the message file in which an error message for
* ef_errorid can be found.
*
* ef_errc - This is the number of values stored in ef_errc[]
* for the current error id.
*
* ef_errv - This is an array of strings which are relevant
* to a particular error id. These strings can
* be included in an error message retrieved from
* a message file. The strings in a message file
* can contain "%s" sprintf() format codes. The
* ef_errv[] strings are passed to sprintf() along
* with the error message string.
*/
#define NSERRMAXARG 8 /* size of ef_errv[] */
typedef struct NSEFrame_s NSEFrame_t;
struct NSEFrame_s {
NSEFrame_t * ef_next; /* next error frame on NSErr_t list */
long ef_retcode; /* error return code */
long ef_errorid; /* error unique identifier */
char * ef_program; /* context for ef_errorid */
int ef_errc; /* number of strings in ef_errv[] */
char * ef_errv[NSERRMAXARG];/* arguments for formatting error message */
};
/*
* Description (NSErr_t)
*
* This type describes the structure of a header for a list of
* error frames. The header contains a pointer to the first
* and last error frames on the list. The first error frame
* is normally the one most recently generated, which usually
* represents the highest-level interpretation available for an
* error that is propogating upward in a call chain. These
* structures are generally allocated as automatic or static
* variables.
*/
typedef struct NSErr_s NSErr_t;
struct NSErr_s {
NSEFrame_t * err_first; /* first error frame */
NSEFrame_t * err_last; /* last error frame */
NSEFrame_t *(*err_falloc)(NSErr_t * errp); /* error frame allocator */
void (*err_ffree)(NSErr_t * errp,
NSEFrame_t * efp); /* error frame deallocator */
};
/* Define an initializer for an NSErr_t */
#define NSERRINIT { 0, 0, 0, 0 }
#ifndef INTNSACL
#define nserrDispose (*__nsacl_table->f_nserrDispose)
#define nserrFAlloc (*__nsacl_table->f_nserrFAlloc)
#define nserrFFree (*__nsacl_table->f_nserrFFree)
#define nserrGenerate (*__nsacl_table->f_nserrGenerate)
#endif /* !INTNSACL */
#endif /* !PUBLIC_NSACL_NSERRDEF_H */
|
