ncurses 5.3
[ncurses.git] / menu / mf_common.h
1 /****************************************************************************
2  * Copyright (c) 1998,2000 Free Software Foundation, Inc.                   *
3  *                                                                          *
4  * Permission is hereby granted, free of charge, to any person obtaining a  *
5  * copy of this software and associated documentation files (the            *
6  * "Software"), to deal in the Software without restriction, including      *
7  * without limitation the rights to use, copy, modify, merge, publish,      *
8  * distribute, distribute with modifications, sublicense, and/or sell       *
9  * copies of the Software, and to permit persons to whom the Software is    *
10  * furnished to do so, subject to the following conditions:                 *
11  *                                                                          *
12  * The above copyright notice and this permission notice shall be included  *
13  * in all copies or substantial portions of the Software.                   *
14  *                                                                          *
15  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS  *
16  * OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF               *
17  * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.   *
18  * IN NO EVENT SHALL THE ABOVE COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM,   *
19  * DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR    *
20  * OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR    *
21  * THE USE OR OTHER DEALINGS IN THE SOFTWARE.                               *
22  *                                                                          *
23  * Except as contained in this notice, the name(s) of the above copyright   *
24  * holders shall not be used in advertising or otherwise to promote the     *
25  * sale, use or other dealings in this Software without prior written       *
26  * authorization.                                                           *
27  ****************************************************************************/
28
29 /****************************************************************************
30  *   Author:  Juergen Pfeifer, 1995,1997                                    *
31  *   Contact: http://www.familiepfeifer.de/Contact.aspx?Lang=en             *
32  ****************************************************************************/
33
34 /* Common internal header for menu and form library */
35
36 #ifndef MF_COMMON_H_incl
37 #define MF_COMMON_H_incl 1
38
39 #include <ncurses_cfg.h>
40 #include <curses.h>
41
42 #include <stdlib.h>
43 #include <sys/types.h>
44 #include <assert.h>
45 #include <string.h>
46 #include <ctype.h>
47 #include <errno.h>
48
49 #if DECL_ERRNO
50 extern int errno;
51 #endif
52
53 /* in case of debug version we ignore the suppression of assertions */
54 #ifdef TRACE
55 #  ifdef NDEBUG
56 #    undef NDEBUG
57 #  endif
58 #endif
59
60 #include <nc_alloc.h>
61
62 #if USE_RCS_IDS
63 #define MODULE_ID(id) static const char Ident[] = id;
64 #else
65 #define MODULE_ID(id) /*nothing*/
66 #endif
67
68
69 /* Maximum regular 8-bit character code */
70 #define MAX_REGULAR_CHARACTER (0xff)
71
72 #define SET_ERROR(code) (errno=(code))
73 #define GET_ERROR() (errno)
74 #define RETURN(code) return( SET_ERROR(code) )
75
76 /* The few common values in the status fields for menus and forms */
77 #define _POSTED         (0x01)  /* menu or form is posted                  */
78 #define _IN_DRIVER      (0x02)  /* menu or form is processing hook routine */
79
80 /* Call object hook */
81 #define Call_Hook( object, handler ) \
82    if ( (object) && ((object)->handler) )\
83    {\
84         (object)->status |= _IN_DRIVER;\
85         (object)->handler(object);\
86         (object)->status &= ~_IN_DRIVER;\
87    }
88
89 #define INLINE
90
91 #ifndef TRACE
92 #  if CC_HAS_INLINE_FUNCS
93 #    undef INLINE
94 #    define INLINE inline
95 #  endif
96 #endif
97
98 #endif /* MF_COMMON_H_incl */