menu/mf_common.h

   1 /****************************************************************************
   2  * Copyright (c) 1998-2004,2012 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  ****************************************************************************/
  32
  33 /* $Id: mf_common.h,v 0.24 2012/06/10 00:06:54 tom Exp $ */
  34
  35 /* Common internal header for menu and form library */
  36
  37 #ifndef MF_COMMON_H_incl
  38 #define MF_COMMON_H_incl 1
  39
  40 #include <ncurses_cfg.h>
  41 #include <curses.h>
  42
  43 #include <stdlib.h>
  44 #include <sys/types.h>
  45 #include <assert.h>
  46 #include <string.h>
  47 #include <ctype.h>
  48 #include <errno.h>
  49
  50 #if DECL_ERRNO
  51 extern int errno;
  52 #endif
  53
  54 /* in case of debug version we ignore the suppression of assertions */
  55 #ifdef TRACE
  56 #  ifdef NDEBUG
  57 #    undef NDEBUG
  58 #  endif
  59 #endif
  60
  61 #include <nc_alloc.h>
  62
  63 #if USE_RCS_IDS
  64 #define MODULE_ID(id) static const char Ident[] = id;
  65 #else
  66 #define MODULE_ID(id)           /*nothing */
  67 #endif
  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
  75 #ifdef TRACE
  76 #define RETURN(code)    returnCode( SET_ERROR(code) )
  77 #else
  78 #define RETURN(code)    return( SET_ERROR(code) )
  79 #endif
  80
  81 /* The few common values in the status fields for menus and forms */
  82 #define _POSTED         (0x01U) /* menu or form is posted                  */
  83 #define _IN_DRIVER      (0x02U) /* menu or form is processing hook routine */
  84
  85 #define SetStatus(target,mask) (target)->status |= (unsigned short) (mask)
  86 #define ClrStatus(target,mask) (target)->status = (unsigned short) (target->status & (~mask))
  87
  88 /* Call object hook */
  89 #define Call_Hook( object, handler ) \
  90    if ( (object) != 0 && ((object)->handler) != (void *) 0 )\
  91    {\
  92         SetStatus(object, _IN_DRIVER);\
  93         (object)->handler(object);\
  94         ClrStatus(object, _IN_DRIVER);\
  95    }
  96
  97 #endif /* MF_COMMON_H_incl */