include/extnsionst.h

   1 /***********************************************************
   2
   3 Copyright 1987, 1998  The Open Group
   4
   5 Permission to use, copy, modify, distribute, and sell this software and its
   6 documentation for any purpose is hereby granted without fee, provided that
   7 the above copyright notice appear in all copies and that both that
   8 copyright notice and this permission notice appear in supporting
   9 documentation.
  10
  11 The above copyright notice and this permission notice shall be included in
  12 all copies or substantial portions of the Software.
  13
  14 THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
  15 IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
  16 FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.  IN NO EVENT SHALL THE
  17 OPEN GROUP BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN
  18 AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
  19 CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
  20
  21 Except as contained in this notice, the name of The Open Group shall not be
  22 used in advertising or otherwise to promote the sale, use or other dealings
  23 in this Software without prior written authorization from The Open Group.
  24
  25 Copyright 1987 by Digital Equipment Corporation, Maynard, Massachusetts.
  26
  27                         All Rights Reserved
  28
  29 Permission to use, copy, modify, and distribute this software and its
  30 documentation for any purpose and without fee is hereby granted,
  31 provided that the above copyright notice appear in all copies and that
  32 both that copyright notice and this permission notice appear in
  33 supporting documentation, and that the name of Digital not be
  34 used in advertising or publicity pertaining to distribution of the
  35 software without specific, written prior permission.
  36
  37 DIGITAL DISCLAIMS ALL WARRANTIES WITH REGARD TO THIS SOFTWARE, INCLUDING
  38 ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS, IN NO EVENT SHALL
  39 DIGITAL BE LIABLE FOR ANY SPECIAL, INDIRECT OR CONSEQUENTIAL DAMAGES OR
  40 ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS,
  41 WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION,
  42 ARISING OUT OF OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS
  43 SOFTWARE.
  44
  45 ******************************************************************/
  46
  47 #ifndef EXTENSIONSTRUCT_H
  48 #define EXTENSIONSTRUCT_H
  49
  50 #include "dix.h"
  51 #include "misc.h"
  52 #include "screenint.h"
  53 #include "extension.h"
  54 #include "gc.h"
  55 #include "privates.h"
  56
  57 typedef struct _ExtensionEntry {
  58     int index;
  59     void (*CloseDown) (         /* called at server shutdown */
  60                           struct _ExtensionEntry * /* extension */ );
  61     char *name;                 /* extension name */
  62     int base;                   /* base request number */
  63     int eventBase;
  64     int eventLast;
  65     int errorBase;
  66     int errorLast;
  67     int num_aliases;
  68     char **aliases;
  69     pointer extPrivate;
  70     unsigned short (*MinorOpcode) (     /* called for errors */
  71                                       ClientPtr /* client */ );
  72     PrivateRec *devPrivates;
  73 } ExtensionEntry;
  74
  75 /*
  76  * The arguments may be different for extension event swapping functions.
  77  * Deal with this by casting when initializing the event's EventSwapVector[]
  78  * entries.
  79  */
  80 typedef void (*EventSwapPtr) (xEvent *, xEvent *);
  81
  82 extern _X_EXPORT EventSwapPtr EventSwapVector[128];
  83
  84 extern _X_EXPORT void
  85 NotImplemented(                 /* FIXME: this may move to another file... */
  86                   xEvent *, xEvent *) _X_NORETURN;
  87
  88 #define    SetGCVector(pGC, VectorElement, NewRoutineAddress, Atom)    \
  89     pGC->VectorElement = NewRoutineAddress;
  90
  91 #define    GetGCValue(pGC, GCElement)    (pGC->GCElement)
  92
  93 extern _X_EXPORT ExtensionEntry *
  94 AddExtension(const char * /*name */ ,
  95              int /*NumEvents */ ,
  96              int /*NumErrors */ ,
  97              int (* /*MainProc */ )(ClientPtr /*client */ ),
  98              int (* /*SwappedMainProc */ )(ClientPtr /*client */ ),
  99              void (* /*CloseDownProc */ )(ExtensionEntry * /*extension */ ),
 100              unsigned short (* /*MinorOpcodeProc */ )(ClientPtr /*client */ )
 101     );
 102
 103 extern _X_EXPORT Bool
 104 AddExtensionAlias(const char * /*alias */ ,
 105                   ExtensionEntry * /*extension */ );
 106
 107 extern _X_EXPORT ExtensionEntry *
 108 CheckExtension(const char *extname);
 109 extern _X_EXPORT ExtensionEntry *
 110 GetExtensionEntry(int major);
 111
 112 #endif                          /* EXTENSIONSTRUCT_H */