/*
 * Copyright (c) 2009, Oracle and/or its affiliates. All rights reserved.
 *
 * 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.
 */

#ifndef XSCOPE_EXTENSIONS_H
#define XSCOPE_EXTENSIONS_H

#include "scope.h"

#define EXTENSION_MIN_REQ 128   /* lowest possible extension request code */
#define EXTENSION_MAX_REQ 255   /* highest possible extension request code */
#define EXTENSION_MIN_EV   64   /* lowest possible extension event code  */
#define EXTENSION_MAX_EV  127   /* highest possible extension event code */
#define EXTENSION_MIN_ERR 128   /* lowest possible extension error code  */
#define EXTENSION_MAX_ERR 255   /* highest possible extension error code */
#define NUM_EXTENSIONS    128   /* maximum possible number of extensions */
#define NUM_EXT_EVENTS     64   /* maximum possible number of extension events */

/* special processing in extensions.c to capture extension info */
extern void ProcessQueryExtensionRequest(long seq, const unsigned char *buf);
extern void ProcessQueryExtensionReply(long seq, const unsigned char *buf);

extern void ExtensionRequest(FD fd, const unsigned char *buf, short Request);
extern void ExtensionReply(FD fd, const unsigned char *buf,
                           short Request, short RequestMinor);
extern void ExtensionError(FD fd, const unsigned char *buf, short Error);
extern void ExtensionEvent(FD fd, const unsigned char *buf, short Event);

/* X11 Extension decoders in decode_*.c */
extern void InitializeBIGREQ(const unsigned char *buf);
extern void InitializeGLX(const unsigned char *buf);
extern void InitializeLBX(const unsigned char *buf);
extern void InitializeMITSHM(const unsigned char *buf);
extern void InitializeRANDR(const unsigned char *buf);
extern void InitializeRENDER(const unsigned char *buf);
extern void InitializeWCP(const unsigned char *buf);

/* X11 Extension types shared across multiple extensions */
extern void InitializeCommonRenderTypes(void);

/* Called from Initialize* to register the extension-specific decoders */
typedef void (*extension_decode_req_ptr) (FD fd, const unsigned char *buf);
typedef void (*extension_decode_reply_ptr) (FD fd, const unsigned char *buf,
                                            short RequestMinor);
typedef void (*extension_decode_error_ptr) (FD fd, const unsigned char *buf);
typedef void (*extension_decode_event_ptr) (FD fd, const unsigned char *buf);

extern void InitializeExtensionDecoder(int Request,
                                       extension_decode_req_ptr reqd,
                                       extension_decode_reply_ptr repd);
extern void InitializeExtensionErrorDecoder(int Error,
                                            extension_decode_error_ptr errd);
extern void InitializeExtensionEventDecoder(int Event,
                                            extension_decode_event_ptr evd);
extern void InitializeGenericEventDecoder(int Request,
                                          extension_decode_event_ptr evd);

#endif                          /* XSCOPE_EXTENSIONS_H */