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