Further rationalise our usage of assert()
[openafs.git] / src / opr / opr.h
1 #ifndef OPENAFS_OPR_OPR_H
2 #define OPENAFS_OPR_OPR_H 1
3
4 /* macros */
5
6 /* should use offsetof() if available */
7 #define opr_containerof(ptr, structure, member) \
8    ((structure *)((char *)(ptr)-(char *)(&((structure *)NULL)->member)))
9
10 /* assert.c */
11
12 #ifdef AFS_NT40_ENV
13 # define opr_abort() opr_NTAbort()
14 extern void opr_NTAbort(void);
15 #else
16 # define opr_abort() abort()
17 #endif
18
19 extern void opr_AssertionFailed(char *, int) AFS_NORETURN;
20 extern void opr_AssertFailU(const char *, const char *, int) AFS_NORETURN;
21
22 /* opr_Assert is designed to work in a similar way to the operating
23  * system's assert function. This means that in future, it may compile
24  * to a no-op if NDEBUG is defined
25  */
26
27 #define opr_Assert(ex) \
28     do {if (!(ex)) opr_AssertionFailed(__FILE__, __LINE__);} while(0)
29
30 /* opr_Verify is an assertion function which is guaranteed to always
31  * invoke its expression, regardless of the debugging level selected
32  * at compile time */
33
34 #define opr_Verify(ex) \
35     do {if (!(ex)) opr_AssertionFailed(__FILE__, __LINE__);} while(0)
36
37 /* casestrcpy.c */
38 #define lcstring opr_lcstring
39 #define ucstring opr_ucstring
40 #define stolower opr_stolower
41 #define stoupper opr_stoupper
42 /* XXX str* is in the implementation namespace when <string.h> is included */
43 #define strcompose opr_strcompose
44
45 extern char *opr_lcstring(char *d, const char *s, int n) AFS_NONNULL((1,2));
46 extern char *opr_ucstring(char *d, const char *s, int n) AFS_NONNULL((1,2));
47 extern void opr_stolower(char *s) AFS_NONNULL(());
48 extern void opr_stoupper(char *s) AFS_NONNULL(());
49 extern char *opr_strcompose(char *buf, size_t len, ...) AFS_NONNULL((1));
50
51 #endif