xserver-multidpi/include/xkbfile.h
Daniel Stone fbd7768946 XKB: Ditch XkbFileInfo
Sorry about the megacommit, but this touches on a lot of stuff.

Get rid of XkbFileInfo, which was pretty seriously redundant, and move the
only useful thing it had (defined) into XkbDescRec.  defined will be removed
pretty soon anyway.  Is the compat map pointer non-NULL? Then you have a
compat map, congratulations! Anyhow, I digress.

All functions that took an XkbFileInfoPtr now take an XkbDescPtr, _except_
XkmReadFile, which returns an XkbDescPtr *, because people want to deal in
XkbDescPtrs, not XkbDescRecs.
2008-02-17 22:52:08 +02:00

437 lines
9.8 KiB
C

/************************************************************
Copyright (c) 1994 by Silicon Graphics Computer Systems, Inc.
Permission to use, copy, modify, and distribute this
software and its documentation for any purpose and without
fee is hereby granted, provided that the above copyright
notice appear in all copies and that both that copyright
notice and this permission notice appear in supporting
documentation, and that the name of Silicon Graphics not be
used in advertising or publicity pertaining to distribution
of the software without specific prior written permission.
Silicon Graphics makes no representation about the suitability
of this software for any purpose. It is provided "as is"
without any express or implied warranty.
SILICON GRAPHICS DISCLAIMS ALL WARRANTIES WITH REGARD TO THIS
SOFTWARE, INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY
AND FITNESS FOR A PARTICULAR PURPOSE. IN NO EVENT SHALL SILICON
GRAPHICS BE LIABLE FOR ANY SPECIAL, INDIRECT OR CONSEQUENTIAL
DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE,
DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE
OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH
THE USE OR PERFORMANCE OF THIS SOFTWARE.
********************************************************/
#ifndef _XKBFILE_H_
#define _XKBFILE_H_ 1
/***====================================================================***/
#define XkbXKMFile 0
#define XkbCFile 1
#define XkbXKBFile 2
#define XkbMessage 3
#define XkbMapDefined (1<<0)
#define XkbStateDefined (1<<1)
typedef void (*XkbFileAddOnFunc)(
FILE * /* file */,
XkbDescPtr /* result */,
Bool /* topLevel */,
Bool /* showImplicit */,
int /* fileSection */,
void * /* priv */
);
/***====================================================================***/
#define _XkbSuccess 0
#define _XkbErrMissingNames 1
#define _XkbErrMissingTypes 2
#define _XkbErrMissingReqTypes 3
#define _XkbErrMissingSymbols 4
#define _XkbErrMissingVMods 5
#define _XkbErrMissingIndicators 6
#define _XkbErrMissingCompatMap 7
#define _XkbErrMissingSymInterps 8
#define _XkbErrMissingGeometry 9
#define _XkbErrIllegalDoodad 10
#define _XkbErrIllegalTOCType 11
#define _XkbErrIllegalContents 12
#define _XkbErrEmptyFile 13
#define _XkbErrFileNotFound 14
#define _XkbErrFileCannotOpen 15
#define _XkbErrBadValue 16
#define _XkbErrBadMatch 17
#define _XkbErrBadTypeName 18
#define _XkbErrBadTypeWidth 19
#define _XkbErrBadFileType 20
#define _XkbErrBadFileVersion 21
#define _XkbErrBadFileFormat 22
#define _XkbErrBadAlloc 23
#define _XkbErrBadLength 24
#define _XkbErrXReqFailure 25
#define _XkbErrBadImplementation 26
extern char * _XkbErrMessages[];
extern unsigned _XkbErrCode;
extern char * _XkbErrLocation;
extern unsigned _XkbErrData;
/***====================================================================***/
_XFUNCPROTOBEGIN
extern char * XkbIndentText(
unsigned /* size */
);
extern char * XkbAtomText(
Atom /* atm */,
unsigned /* format */
);
extern char * XkbKeysymText(
KeySym /* sym */,
unsigned /* format */
);
extern char * XkbStringText(
char * /* str */,
unsigned /* format */
);
extern char * XkbKeyNameText(
char * /* name */,
unsigned /* format */
);
extern char *
XkbModIndexText(
unsigned /* ndx */,
unsigned /* format */
);
extern char *
XkbModMaskText(
unsigned /* mask */,
unsigned /* format */
);
extern char * XkbVModIndexText(
XkbDescPtr /* xkb */,
unsigned /* ndx */,
unsigned /* format */
);
extern char * XkbVModMaskText(
XkbDescPtr /* xkb */,
unsigned /* modMask */,
unsigned /* mask */,
unsigned /* format */
);
extern char * XkbConfigText(
unsigned /* config */,
unsigned /* format */
);
extern char * XkbSIMatchText(
unsigned /* type */,
unsigned /* format */
);
extern char * XkbIMWhichStateMaskText(
unsigned /* use_which */,
unsigned /* format */
);
extern char * XkbAccessXDetailText(
unsigned /* state */,
unsigned /* format */
);
extern char * XkbNKNDetailMaskText(
unsigned /* detail */,
unsigned /* format */
);
extern char * XkbControlsMaskText(
unsigned /* ctrls */,
unsigned /* format */
);
extern char * XkbGeomFPText(
int /* val */,
unsigned /* format */
);
extern char * XkbDoodadTypeText(
unsigned /* type */,
unsigned /* format */
);
extern char * XkbActionTypeText(
unsigned /* type */,
unsigned /* format */
);
extern char * XkbActionText(
XkbDescPtr /* xkb */,
XkbAction * /* action */,
unsigned /* format */
);
extern char * XkbBehaviorText(
XkbDescPtr /* xkb */,
XkbBehavior * /* behavior */,
unsigned /* format */
);
/***====================================================================***/
#define _XkbKSLower (1<<0)
#define _XkbKSUpper (1<<1)
#define XkbKSIsLower(k) (_XkbKSCheckCase(k)&_XkbKSLower)
#define XkbKSIsUpper(k) (_XkbKSCheckCase(k)&_XkbKSUpper)
#define XkbKSIsKeypad(k) (((k)>=XK_KP_Space)&&((k)<=XK_KP_Equal))
#define XkbKSIsDeadKey(k) \
(((k)>=XK_dead_grave)&&((k)<=XK_dead_semivoiced_sound))
extern unsigned _XkbKSCheckCase(
KeySym /* sym */
);
extern int XkbFindKeycodeByName(
XkbDescPtr /* xkb */,
char * /* name */,
Bool /* use_aliases */
);
extern Bool XkbLookupGroupAndLevel(
XkbDescPtr /* xkb */,
int /* key */,
int * /* mods_inout */,
int * /* grp_inout */,
int * /* lvl_rtrn */
);
/***====================================================================***/
extern Atom XkbInternAtom(
char * /* name */,
Bool /* onlyIfExists */
);
extern void XkbInitAtoms(void);
/***====================================================================***/
#ifdef _XKBGEOM_H_
#define XkbDW_Unknown 0
#define XkbDW_Doodad 1
#define XkbDW_Section 2
typedef struct _XkbDrawable {
int type;
int priority;
union {
XkbDoodadPtr doodad;
XkbSectionPtr section;
} u;
struct _XkbDrawable * next;
} XkbDrawableRec,*XkbDrawablePtr;
extern XkbDrawablePtr
XkbGetOrderedDrawables(
XkbGeometryPtr /* geom */,
XkbSectionPtr /* section */
);
extern void
XkbFreeOrderedDrawables(
XkbDrawablePtr /* draw */
);
#endif
/***====================================================================***/
extern unsigned XkbConvertGetByNameComponents(
Bool /* toXkm */,
unsigned /* orig */
);
extern unsigned XkbConvertXkbComponents(
Bool /* toXkm */,
unsigned /* orig */
);
extern Bool XkbNameMatchesPattern(
char * /* name */,
char * /* pattern */
);
/***====================================================================***/
extern Bool XkbWriteXKBKeycodes(
FILE * /* file */,
XkbDescPtr /* result */,
Bool /* topLevel */,
Bool /* showImplicit */,
XkbFileAddOnFunc /* addOn */,
void * /* priv */
);
extern Bool XkbWriteXKBKeyTypes(
FILE * /* file */,
XkbDescPtr /* result */,
Bool /* topLevel */,
Bool /* showImplicit */,
XkbFileAddOnFunc /* addOn */,
void * /* priv */
);
extern Bool XkbWriteXKBCompatMap(
FILE * /* file */,
XkbDescPtr /* result */,
Bool /* topLevel */,
Bool /* showImplicit */,
XkbFileAddOnFunc /* addOn */,
void * /* priv */
);
extern Bool XkbWriteXKBSymbols(
FILE * /* file */,
XkbDescPtr /* result */,
Bool /* topLevel */,
Bool /* showImplicit */,
XkbFileAddOnFunc /* addOn */,
void * /* priv */
);
extern Bool XkbWriteXKBGeometry(
FILE * /* file */,
XkbDescPtr /* result */,
Bool /* topLevel */,
Bool /* showImplicit */,
XkbFileAddOnFunc /* addOn */,
void * /* priv */
);
extern Bool XkbWriteXKBSemantics(
FILE * /* file */,
XkbDescPtr /* result */,
Bool /* topLevel */,
Bool /* showImplicit */,
XkbFileAddOnFunc /* addOn */,
void * /* priv */
);
extern Bool XkbWriteXKBLayout(
FILE * /* file */,
XkbDescPtr /* result */,
Bool /* topLevel */,
Bool /* showImplicit */,
XkbFileAddOnFunc /* addOn */,
void * /* priv */
);
extern Bool XkbWriteXKBKeymap(
FILE * /* file */,
XkbDescPtr /* result */,
Bool /* topLevel */,
Bool /* showImplicit */,
XkbFileAddOnFunc /* addOn */,
void * /* priv */
);
extern Bool XkbWriteXKBFile(
FILE * /* file */,
XkbDescPtr /* result */,
Bool /* showImplicit */,
XkbFileAddOnFunc /* addOn */,
void * /* priv */
);
extern Bool XkbWriteCFile(
FILE * /* file */,
char * /* name */,
XkbDescPtr /* info */
);
extern Bool XkbWriteXKMFile(
FILE * /* file */,
XkbDescPtr /* result */
);
extern Bool XkbWriteToServer(
XkbDescPtr /* result */
);
extern void XkbEnsureSafeMapName(
char * /* name */
);
extern Bool XkbWriteXKBKeymapForNames(
FILE * /* file */,
XkbComponentNamesPtr /* names */,
XkbDescPtr /* xkb */,
unsigned /* want */,
unsigned /* need */
);
extern Status XkbMergeFile(
XkbDescPtr /* xkb */
);
/***====================================================================***/
extern Bool XkmProbe(
FILE * /* file */
);
extern unsigned XkmReadFile(
FILE * /* file */,
unsigned /* need */,
unsigned /* want */,
XkbDescPtr * /* result */
);
#ifdef _XKMFORMAT_H_
extern Bool XkmReadTOC(
FILE * /* file */,
xkmFileInfo * /* file_info */,
int /* max_toc */,
xkmSectionInfo * /* toc */
);
extern xkmSectionInfo *XkmFindTOCEntry(
xkmFileInfo * /* finfo */,
xkmSectionInfo * /* toc */,
unsigned /* type */
);
extern Bool XkmReadFileSection(
FILE * /* file */,
xkmSectionInfo * /* toc */,
XkbDescPtr /* result */,
unsigned * /* loaded_rtrn */
);
extern char * XkmReadFileSectionName(
FILE * /* file */,
xkmSectionInfo * /* toc */
);
#endif /* _XKMFORMAT_H */
_XFUNCPROTOEND
#endif /* _XKBFILE_H_ */