74fe172698ba936102e120dae998c9ebd09cfbdfvboxsync/* $XFree86: xc/include/extensions/xtrapemacros.h,v 1.2 2001/11/21 23:06:58 tsi Exp $ */
74fe172698ba936102e120dae998c9ebd09cfbdfvboxsync#define __XTRAPEMACROS__ "@(#)xtrapemacros.h 1.9 - 90/09/18 "
74fe172698ba936102e120dae998c9ebd09cfbdfvboxsync/*****************************************************************************
74fe172698ba936102e120dae998c9ebd09cfbdfvboxsyncCopyright 1987, 1988, 1989, 1990, 1991, 1994 by Digital Equipment Corp.,
74fe172698ba936102e120dae998c9ebd09cfbdfvboxsyncPermission to use, copy, modify, and distribute this software and its
74fe172698ba936102e120dae998c9ebd09cfbdfvboxsyncdocumentation for any purpose and without fee is hereby granted,
74fe172698ba936102e120dae998c9ebd09cfbdfvboxsyncprovided that the above copyright notice appear in all copies and that
74fe172698ba936102e120dae998c9ebd09cfbdfvboxsyncboth that copyright notice and this permission notice appear in
74fe172698ba936102e120dae998c9ebd09cfbdfvboxsyncsupporting documentation, and that the name of Digital not be
74fe172698ba936102e120dae998c9ebd09cfbdfvboxsyncused in advertising or publicity pertaining to distribution of the
74fe172698ba936102e120dae998c9ebd09cfbdfvboxsyncsoftware without specific, written prior permission.
74fe172698ba936102e120dae998c9ebd09cfbdfvboxsyncDIGITAL DISCLAIMS ALL WARRANTIES WITH REGARD TO THIS SOFTWARE, INCLUDING
74fe172698ba936102e120dae998c9ebd09cfbdfvboxsyncALL IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS, IN NO EVENT SHALL
74fe172698ba936102e120dae998c9ebd09cfbdfvboxsyncDIGITAL BE LIABLE FOR ANY SPECIAL, INDIRECT OR CONSEQUENTIAL DAMAGES OR
74fe172698ba936102e120dae998c9ebd09cfbdfvboxsyncANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS,
74fe172698ba936102e120dae998c9ebd09cfbdfvboxsyncWHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION,
74fe172698ba936102e120dae998c9ebd09cfbdfvboxsyncARISING OUT OF OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS
74fe172698ba936102e120dae998c9ebd09cfbdfvboxsync*****************************************************************************/
74fe172698ba936102e120dae998c9ebd09cfbdfvboxsync * CONTRIBUTORS:
74fe172698ba936102e120dae998c9ebd09cfbdfvboxsync * Dick Annicchiarico
74fe172698ba936102e120dae998c9ebd09cfbdfvboxsync * Robert Chesler
74fe172698ba936102e120dae998c9ebd09cfbdfvboxsync * Dan Coutu
74fe172698ba936102e120dae998c9ebd09cfbdfvboxsync * Gene Durso
74fe172698ba936102e120dae998c9ebd09cfbdfvboxsync * Marc Evans
74fe172698ba936102e120dae998c9ebd09cfbdfvboxsync * Alan Jamison
74fe172698ba936102e120dae998c9ebd09cfbdfvboxsync * Mark Henry
74fe172698ba936102e120dae998c9ebd09cfbdfvboxsync * Ken Miller
74fe172698ba936102e120dae998c9ebd09cfbdfvboxsync * DESCRIPTION:
74fe172698ba936102e120dae998c9ebd09cfbdfvboxsync * This include file is designed to provide the *visible*
74fe172698ba936102e120dae998c9ebd09cfbdfvboxsync * interface to XTrap data structures. Fields can be set
74fe172698ba936102e120dae998c9ebd09cfbdfvboxsync * using these macros by client programs unless otherwise
74fe172698ba936102e120dae998c9ebd09cfbdfvboxsync * specified; however, use of Trap Context convenience
74fe172698ba936102e120dae998c9ebd09cfbdfvboxsync * routines is strongly encouraged (XETrapContext.c)
74fe172698ba936102e120dae998c9ebd09cfbdfvboxsync/* msleep macro to replace msleep() for portability reasons */
74fe172698ba936102e120dae998c9ebd09cfbdfvboxsync/* Copying TC's assumes that the new TC must be created */
74fe172698ba936102e120dae998c9ebd09cfbdfvboxsync (dest = XECreateTC(((src)->dpy), (mask), (&((src)->values))))
74fe172698ba936102e120dae998c9ebd09cfbdfvboxsync/* Expands to SET each element of the TCValues structure
74fe172698ba936102e120dae998c9ebd09cfbdfvboxsync * Returns the TCValues Mask so that the Set can be entered
74fe172698ba936102e120dae998c9ebd09cfbdfvboxsync * as an argument to the XEChangeTC() routine call
74fe172698ba936102e120dae998c9ebd09cfbdfvboxsync/* Note: req_cb & evt_cb would only be used if you wanted to
74fe172698ba936102e120dae998c9ebd09cfbdfvboxsync * *share* callbacks between Trap Contexts. Normally,
74fe172698ba936102e120dae998c9ebd09cfbdfvboxsync * XEAddRequestCB() and XEAddEventCB() would be used.
74fe172698ba936102e120dae998c9ebd09cfbdfvboxsync#define XETrapSetCfgReqCB(tcv,x) ((tcv)->req_cb = (x))
74fe172698ba936102e120dae998c9ebd09cfbdfvboxsync#define XETrapSetCfgEvtCB(tcv,x) ((tcv)->evt_cb = (x))
74fe172698ba936102e120dae998c9ebd09cfbdfvboxsync#define XETrapSetCfgMaxPktSize(tcv,x) ((tcv)->v.max_pkt_size = (x))
74fe172698ba936102e120dae998c9ebd09cfbdfvboxsync#define XETrapSetCfgCmdKey(tcv,x) ((tcv)->v.cmd_key = (x))
74fe172698ba936102e120dae998c9ebd09cfbdfvboxsync/* Note: e is only pertinent for "valid" or "data" */
74fe172698ba936102e120dae998c9ebd09cfbdfvboxsync memcpy((tcv)->v.flags.e, (a), sizeof((tcv)->v.flags.e))
74fe172698ba936102e120dae998c9ebd09cfbdfvboxsync/* Fields returned in the "GetAvailable" request */
74fe172698ba936102e120dae998c9ebd09cfbdfvboxsync#define XETrapGetAvailPFIdent(avail) ((avail)->pf_ident)
74fe172698ba936102e120dae998c9ebd09cfbdfvboxsync#define XETrapGetAvailRelease(avail) ((avail)->xtrap_release)
74fe172698ba936102e120dae998c9ebd09cfbdfvboxsync#define XETrapGetAvailVersion(avail) ((avail)->xtrap_version)
74fe172698ba936102e120dae998c9ebd09cfbdfvboxsync#define XETrapGetAvailRevision(avail) ((avail)->xtrap_revision)
74fe172698ba936102e120dae998c9ebd09cfbdfvboxsync#define XETrapGetAvailMaxPktSize(avail) ((avail)->max_pkt_size)
74fe172698ba936102e120dae998c9ebd09cfbdfvboxsync memcpy((a), (avail)->valid, sizeof((avail)->valid))
74fe172698ba936102e120dae998c9ebd09cfbdfvboxsync#define XETrapGetAvailOpCode(avail) ((avail)->major_opcode)
74fe172698ba936102e120dae998c9ebd09cfbdfvboxsync/* Macro's for creating current request and trap context macros */
74fe172698ba936102e120dae998c9ebd09cfbdfvboxsync#define XETrapGetCfgMaxPktSize(cfg) ((cfg)->max_pkt_size)
74fe172698ba936102e120dae998c9ebd09cfbdfvboxsync memcpy((a), (cfg)->flags.e, sizeof((cfg)->flags.e))
74fe172698ba936102e120dae998c9ebd09cfbdfvboxsync/* Request values are in "Xproto.h" of the flavor X_RequestType */
74fe172698ba936102e120dae998c9ebd09cfbdfvboxsync/* Event types are in "X.h" of the flavor EventType (e.g. KeyPress) */
74fe172698ba936102e120dae998c9ebd09cfbdfvboxsync/* Fields returned int the "GetCurrent" Request */
74fe172698ba936102e120dae998c9ebd09cfbdfvboxsync memcpy((a), (cur)->state_flags, sizeof((cur)->state_flags))
74fe172698ba936102e120dae998c9ebd09cfbdfvboxsync#define XETrapGetCurMaxPktSize(cur) (XETrapGetCfgMaxPktSize(&((cur)->config)))
74fe172698ba936102e120dae998c9ebd09cfbdfvboxsync#define XETrapGetCurCmdKey(cur) (XETrapGetCfgCmdKey(&((cur)->config)))
74fe172698ba936102e120dae998c9ebd09cfbdfvboxsync/* Note: e is only pertinent for "valid" or "data" */
74fe172698ba936102e120dae998c9ebd09cfbdfvboxsync#define XETrapGetCurCFlags(cur,e,a) (XETrapGetCfgFlags(&((cur)->config),e,a))
74fe172698ba936102e120dae998c9ebd09cfbdfvboxsync#define XETrapGetCurFlagCmd(cur,e) (XETrapGetCfgFlagCmd(&((cur)->config),e))
74fe172698ba936102e120dae998c9ebd09cfbdfvboxsync/* Request values are in "Xproto.h" of the flavor X_RequestType */
74fe172698ba936102e120dae998c9ebd09cfbdfvboxsync#define XETrapGetCurFlagReq(cur,r) (XETrapGetCfgFlagReq(&((cur)->config),r))
74fe172698ba936102e120dae998c9ebd09cfbdfvboxsync/* Event types are in "X.h" of the flavor EventType (e.g. KeyPress) */
74fe172698ba936102e120dae998c9ebd09cfbdfvboxsync#define XETrapGetCurFlagEvt(cur,e) (XETrapGetCfgFlagEvt(&((cur)->config),e))
74fe172698ba936102e120dae998c9ebd09cfbdfvboxsync/* Fields returned int the "GetStatistics" Request */
74fe172698ba936102e120dae998c9ebd09cfbdfvboxsync#define XETrapGetStatsReq(stat,e) ((stat)->requests[(e)])
74fe172698ba936102e120dae998c9ebd09cfbdfvboxsync#define XETrapGetStatsEvt(stat,e) ((stat)->events[(e)])
74fe172698ba936102e120dae998c9ebd09cfbdfvboxsync/* Fields returned in the "GetVersion" request */
74fe172698ba936102e120dae998c9ebd09cfbdfvboxsync#define XETrapGetVersRelease(vers) ((vers)->xtrap_release)
74fe172698ba936102e120dae998c9ebd09cfbdfvboxsync#define XETrapGetVersVersion(vers) ((vers)->xtrap_version)
74fe172698ba936102e120dae998c9ebd09cfbdfvboxsync#define XETrapGetVersRevision(vers) ((vers)->xtrap_revision)
74fe172698ba936102e120dae998c9ebd09cfbdfvboxsync/* Fields returned in the "GetLastInpTime" request */
74fe172698ba936102e120dae998c9ebd09cfbdfvboxsync#define XETrapGetLastInpTime(time_rep) ((time_rep)->last_time)
74fe172698ba936102e120dae998c9ebd09cfbdfvboxsync/* Expands to GET each element of the TCValues structure */
74fe172698ba936102e120dae998c9ebd09cfbdfvboxsync#define XETrapGetTCTime(tc) ((tc)->values.last_time)
74fe172698ba936102e120dae998c9ebd09cfbdfvboxsync/* TC specific flags */
74fe172698ba936102e120dae998c9ebd09cfbdfvboxsync memcpy((a), (tc)->values.tc_flags, sizeof((tc)->values.tc_flags))
74fe172698ba936102e120dae998c9ebd09cfbdfvboxsync#define XETrapGetTCMaxPktSize(tc) (XETrapGetCfgMaxPktSize(&((tc)->values.v)))
74fe172698ba936102e120dae998c9ebd09cfbdfvboxsync#define XETrapGetTCCmdKey(tc) (XETrapGetCfgCmdKey(&((tc)->values.v)))
74fe172698ba936102e120dae998c9ebd09cfbdfvboxsync/* Note: e is only pertinent for "valid" or "data" */
74fe172698ba936102e120dae998c9ebd09cfbdfvboxsync#define XETrapGetTCFlags(tc,e,a) (XETrapGetCfgFlags(&((tc)->values.v),e,a))
74fe172698ba936102e120dae998c9ebd09cfbdfvboxsync (XETrapGetCfgFlagColorReplies(&((tc)->values.v),e))
74fe172698ba936102e120dae998c9ebd09cfbdfvboxsync/* Request values are in "Xproto.h" of the flavor X_RequestType */
74fe172698ba936102e120dae998c9ebd09cfbdfvboxsync/* Event types are in "X.h" of the flavor EventType (e.g. KeyPress) */
74fe172698ba936102e120dae998c9ebd09cfbdfvboxsync/* The following can/should *not* be set directly! */
74fe172698ba936102e120dae998c9ebd09cfbdfvboxsync#define XETrapGetValues(tc) memcpy((x),(tc)->values,sizeof((tc)->values))
74fe172698ba936102e120dae998c9ebd09cfbdfvboxsync#define XETrapGetHeaderTimestamp(phdr) ((phdr)->timestamp)
74fe172698ba936102e120dae998c9ebd09cfbdfvboxsync#define XETrapGetHeaderScreen(phdr) ((phdr)->screen)
74fe172698ba936102e120dae998c9ebd09cfbdfvboxsync#define XETrapGetHeaderWindowX(phdr) ((phdr)->win_x)
74fe172698ba936102e120dae998c9ebd09cfbdfvboxsync#define XETrapGetHeaderWindowY(phdr) ((phdr)->win_y)
74fe172698ba936102e120dae998c9ebd09cfbdfvboxsync#define XETrapGetHeaderClient(phdr) ((phdr)->client)
74fe172698ba936102e120dae998c9ebd09cfbdfvboxsync/* Condition handling macros */
74fe172698ba936102e120dae998c9ebd09cfbdfvboxsync#if !defined(vms) && \
74fe172698ba936102e120dae998c9ebd09cfbdfvboxsync (!defined(_InitExceptionHandling) || !defined(_ClearExceptionHandling))
74fe172698ba936102e120dae998c9ebd09cfbdfvboxsync# define _SetSIGBUSHandling(rtn) (void)signal(SIGBUS, rtn)
74fe172698ba936102e120dae998c9ebd09cfbdfvboxsync# define _SetSIGSEGVHandling(rtn) (void)signal(SIGSEGV, rtn)
74fe172698ba936102e120dae998c9ebd09cfbdfvboxsync# define _SetSIGFPEHandling(rtn) (void)signal(SIGFPE, rtn)
74fe172698ba936102e120dae998c9ebd09cfbdfvboxsync# define _SetSIGILLHandling(rtn) (void)signal(SIGILL, rtn)
74fe172698ba936102e120dae998c9ebd09cfbdfvboxsync# define _SetSIGSYSHandling(rtn) (void)signal(SIGSYS, rtn)
74fe172698ba936102e120dae998c9ebd09cfbdfvboxsync# define _SetSIGHUPHandling(rtn) (void)signal(SIGHUP, rtn)
74fe172698ba936102e120dae998c9ebd09cfbdfvboxsync# define _SetSIGPIPEHandling(rtn) (void)signal(SIGPIPE, rtn)
74fe172698ba936102e120dae998c9ebd09cfbdfvboxsync# define _SetSIGTERMHandling(rtn) (void)signal(SIGTERM, rtn)
74fe172698ba936102e120dae998c9ebd09cfbdfvboxsync#else /* vms */
74fe172698ba936102e120dae998c9ebd09cfbdfvboxsync _SetSIGSEGVHandling(rtn); /* Accvio/Segment error */ \
74fe172698ba936102e120dae998c9ebd09cfbdfvboxsync _SetSIGFPEHandling(rtn); /* Floating point exception */ \
74fe172698ba936102e120dae998c9ebd09cfbdfvboxsync _SetSIGILLHandling(rtn); /* Illegal instruction */ \
74fe172698ba936102e120dae998c9ebd09cfbdfvboxsync _SetSIGSYSHandling(rtn); /* Param error in sys call */ \
74fe172698ba936102e120dae998c9ebd09cfbdfvboxsync#endif /* vms */
74fe172698ba936102e120dae998c9ebd09cfbdfvboxsync#endif /* _InitExceptionHandling */
74fe172698ba936102e120dae998c9ebd09cfbdfvboxsync _SetSIGSEGVHandling(SIG_DFL); /* Accvio/Segment error */ \
74fe172698ba936102e120dae998c9ebd09cfbdfvboxsync _SetSIGFPEHandling(SIG_DFL); /* Floating point exception */ \
74fe172698ba936102e120dae998c9ebd09cfbdfvboxsync _SetSIGILLHandling(SIG_DFL); /* Illegal instruction */ \
74fe172698ba936102e120dae998c9ebd09cfbdfvboxsync _SetSIGSYSHandling(SIG_DFL); /* Param error in sys call */ \
74fe172698ba936102e120dae998c9ebd09cfbdfvboxsync#endif /* vms */
74fe172698ba936102e120dae998c9ebd09cfbdfvboxsync#endif /* _ClearExceptionHandling */
74fe172698ba936102e120dae998c9ebd09cfbdfvboxsync#endif /* __XTRAPEMACROS__ */