Copyright (c) 1999, Oracle and/or its affiliates.
Permission is hereby granted, free of charge, to any person obtaining a
copy of this software and associated documentation files (the "Software"),
to deal in the Software without restriction, including without limitation
the rights to use, copy, modify, merge, publish, distribute, sublicense,
and/or sell copies of the Software, and to permit persons to whom the
Software is furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice (including the next
paragraph) shall be included in all copies or substantial portions of the
Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL
THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
DEALINGS IN THE SOFTWARE.
Bool XkbSetDebuggingFlags "(\^Display *" "display" "\^," "unsigned int " "mask" "\^," "unsigned int " "flags" "\^," "char *" "msg" "\^," "unsigned int " "ctrls_mask" "\^," "unsigned int " "ctrls" "\^," "unsigned int *" "ret_flags" "\^," "unsigned int *" "ret_ctrls" "\^);"
display connection to X server
mask mask selecting debug output flags to change
flags values for debug output flags selected by mask
msg message to print right now
ctrls_mask mask selecting debug controls to change
ctrls values for debug controls selected by ctrls_mask
ret_flags resulting state of all debug output flags
ret_ctrls resulting state of all debug controls
The debugging aids are intended for use primarily by Xkb implementors and are optional in any implementation. There are two bitmasks that may be used to control debugging. One bitmask controls the output of debugging information, and the other controls behavior. Both bitmasks are initially all zeros. To change the values of any of the debug controls, use XkbSetDebuggingFlags. XkbSetDebuggingFlags modifies the debug output flags as specified by mask and flags, modifies the debug controls flags as specified by ctrls_mask and ctrls, prints the message msg, and backfills ret_flags and ret_ctrls with the resulting debug output and debug controls flags. When bits are set in the debug output masks, mask and flags, Xkb prints debug information corresponding to each bit at appropriate points during its processing. The device to which the output is written is implementation-dependent, but is normally the same device to which X server error messages are directed; thus the bits that can be set in mask and flags is implementation-specific. To turn on a debug output selection, set the bit for the output in the mask parameter and set the corresponding bit in the flags parameter. To turn off event selection for an event, set the bit for the output in the mask parameter and do not set the corresponding bit in the flags parameter. When bits are set in the debug controls masks, ctrls_mask and ctrls, Xkb modifies its behavior according to each controls bit. ctrls_mask and ctrls are related in the same way that mask and flags are. The valid controls bits are defined in Table 1.
| Table 1 Debug Control Masks |
| Debug Control Mask Value Meaning |
| XkbDF_DisableLocks (1 << 0) Disable actions that lock modifiers |
15 True The XkbSetDebuggingFlags function returns True when successful.
15 False The XkbSetDebuggingFlags function returns False when not successful.
15 BadAlloc Unable to allocate storage