]> git.sesse.net Git - rdpsrv/blobdiff - Xserver/include/extensions/extutil.h
Import X server from vnc-3.3.7.
[rdpsrv] / Xserver / include / extensions / extutil.h
diff --git a/Xserver/include/extensions/extutil.h b/Xserver/include/extensions/extutil.h
new file mode 100644 (file)
index 0000000..6f3425e
--- /dev/null
@@ -0,0 +1,222 @@
+/*
+ * $XConsortium: extutil.h,v 1.15 94/10/07 15:36:33 kaleb Exp $
+ *
+Copyright (c) 1989  X Consortium
+
+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 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
+X CONSORTIUM 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.
+
+Except as contained in this notice, the name of the X Consortium shall not be
+used in advertising or otherwise to promote the sale, use or other dealings
+in this Software without prior written authorization from the X Consortium.
+ *
+ * Author:  Jim Fulton, MIT X Consortium
+ * 
+ *                     Xlib Extension-Writing Utilities
+ *
+ * This package contains utilities for writing the client API for various
+ * protocol extensions.  THESE INTERFACES ARE NOT PART OF THE X STANDARD AND
+ * ARE SUBJECT TO CHANGE!
+ */
+
+#ifndef _EXTUTIL_H_
+#define _EXTUTIL_H_
+
+/*
+ * We need to keep a list of open displays since the Xlib display list isn't
+ * public.  We also have to per-display info in a separate block since it isn't
+ * stored directly in the Display structure.
+ */
+typedef struct _XExtDisplayInfo {
+    struct _XExtDisplayInfo *next;     /* keep a linked list */
+    Display *display;                  /* which display this is */
+    XExtCodes *codes;                  /* the extension protocol codes */
+    XPointer data;                     /* extra data for extension to use */
+} XExtDisplayInfo;
+
+typedef struct _XExtensionInfo {
+    XExtDisplayInfo *head;             /* start of list */
+    XExtDisplayInfo *cur;              /* most recently used */
+    int ndisplays;                     /* number of displays */
+} XExtensionInfo;
+
+typedef struct _XExtensionHooks {
+    int (*create_gc)(
+#if NeedNestedPrototypes
+             Display*                  /* display */,
+             GC                        /* gc */,
+             XExtCodes*                /* codes */
+#endif
+);
+    int (*copy_gc)(
+#if NeedNestedPrototypes
+             Display*                  /* display */,
+              GC                       /* gc */,
+              XExtCodes*               /* codes */
+#endif
+);
+    int (*flush_gc)(
+#if NeedNestedPrototypes
+             Display*                  /* display */,
+              GC                       /* gc */,
+              XExtCodes*               /* codes */
+#endif
+);
+    int (*free_gc)(
+#if NeedNestedPrototypes
+             Display*                  /* display */,
+              GC                       /* gc */,
+              XExtCodes*               /* codes */
+#endif
+);
+    int (*create_font)(
+#if NeedNestedPrototypes
+             Display*                  /* display */,
+              XFontStruct*             /* fs */,
+              XExtCodes*               /* codes */
+#endif
+);
+    int (*free_font)(
+#if NeedNestedPrototypes
+             Display*                  /* display */,
+              XFontStruct*             /* fs */,
+              XExtCodes*               /* codes */
+#endif
+);
+    int (*close_display)(
+#if NeedNestedPrototypes
+             Display*                  /* display */,
+              XExtCodes*               /* codes */
+#endif
+);
+    Bool (*wire_to_event)(
+#if NeedNestedPrototypes
+              Display*                 /* display */,
+               XEvent*                 /* re */,
+               xEvent*                 /* event */
+#endif
+);
+    Status (*event_to_wire)(
+#if NeedNestedPrototypes
+             Display*                  /* display */,
+              XEvent*                  /* re */,
+              xEvent*                  /* event */
+#endif
+);
+    int (*error)(
+#if NeedNestedPrototypes
+             Display*                  /* display */,
+              xError*                  /* err */,
+              XExtCodes*               /* codes */,
+              int*                     /* ret_code */
+#endif
+);
+    char *(*error_string)(
+#if NeedNestedPrototypes
+               Display*                /* display */,
+                int                    /* code */,
+                XExtCodes*             /* codes */,
+                char*                  /* buffer */,
+                int                    /* nbytes */
+#endif
+);
+} XExtensionHooks;
+
+extern XExtensionInfo *XextCreateExtension(
+#if NeedFunctionPrototypes
+    void
+#endif
+);
+extern void XextDestroyExtension(
+#if NeedFunctionPrototypes
+    XExtensionInfo*    /* info */
+#endif
+);
+extern XExtDisplayInfo *XextAddDisplay(
+#if NeedFunctionPrototypes
+    XExtensionInfo*    /* extinfo */,
+    Display*           /* dpy */,
+    char*              /* ext_name */,
+    XExtensionHooks*   /* hooks */,
+    int                        /* nevents */,
+    XPointer           /* data */
+#endif
+);
+extern int XextRemoveDisplay(
+#if NeedFunctionPrototypes
+    XExtensionInfo*    /* extinfo */,
+    Display*           /* dpy */
+#endif
+);
+extern XExtDisplayInfo *XextFindDisplay(
+#if NeedFunctionPrototypes
+    XExtensionInfo*    /* extinfo */,
+    Display*           /* dpy */
+#endif
+);
+
+#define XextHasExtension(i) ((i) && ((i)->codes))
+#define XextCheckExtension(dpy,i,name,val) \
+  if (!XextHasExtension(i)) { XMissingExtension (dpy, name); return val; }
+#define XextSimpleCheckExtension(dpy,i,name) \
+  if (!XextHasExtension(i)) { XMissingExtension (dpy, name); return; }
+
+
+/*
+ * helper macros to generate code that is common to all extensions; caller
+ * should prefix it with static if extension source is in one file; this
+ * could be a utility function, but have to stack 6 unused arguments for 
+ * something that is called many, many times would be bad.
+ */
+#define XEXT_GENERATE_FIND_DISPLAY(proc,extinfo,extname,hooks,nev,data) \
+XExtDisplayInfo *proc (dpy) \
+    register Display *dpy; \
+{ \
+    XExtDisplayInfo *dpyinfo; \
+    if (!extinfo) { if (!(extinfo = XextCreateExtension())) return NULL; } \
+    if (!(dpyinfo = XextFindDisplay (extinfo, dpy))) \
+      dpyinfo = XextAddDisplay (extinfo,dpy,extname,hooks,nev,data); \
+    return dpyinfo; \
+}
+
+#define XEXT_GENERATE_CLOSE_DISPLAY(proc,extinfo) \
+int proc (dpy, codes) \
+    Display *dpy; \
+    XExtCodes *codes; \
+{ \
+    return XextRemoveDisplay (extinfo, dpy); \
+}
+
+#define XEXT_GENERATE_ERROR_STRING(proc,extname,nerr,errl) \
+char *proc (dpy, code, codes, buf, n) \
+    Display  *dpy; \
+    int code; \
+    XExtCodes *codes; \
+    char *buf; \
+    int n; \
+{  \
+    code -= codes->first_error;  \
+    if (code >= 0 && code < nerr) { \
+       char tmp[256]; \
+       sprintf (tmp, "%s.%d", extname, code); \
+       XGetErrorDatabaseText (dpy, "XProtoError", tmp, errl[code], buf, n); \
+       return buf; \
+    } \
+    return (char *)0; \
+}
+
+#endif