source: vbox/trunk/src/VBox/Additions/x11/x11include/xorg-server-1.3.0.0/indirect_table.h@ 86603

/*
 * (C) Copyright IBM Corporation 2005, 2006
 * 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, sub license,
 * 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 NON-INFRINGEMENT.  IN NO EVENT SHALL
 * IBM,
 * AND/OR THEIR SUPPLIERS 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.
 */

/**
 * \file indirect_table.h
 *
 * \author Ian Romanick <[email protected]>
 */

#ifndef INDIRECT_TABLE_H
#define INDIRECT_TABLE_H

#include <inttypes.h>

/**
 */
struct __glXDispatchInfo {
    /**
     * Number of significant bits in the protocol opcode.  Opcodes with values
     * larger than ((1 << bits) - 1) are invalid.
     */
    unsigned bits;

    /**
     */
    const int_fast16_t * dispatch_tree;
    
    /**
     * Array of protocol decode and dispatch functions index by the opcode
     * search tree (i.e., \c dispatch_tree).  The first element in each pair
     * is the non-byte-swapped version, and the second element is the
     * byte-swapped version.
     */
    const void *(*dispatch_functions)[2];

    /**
     * Pointer to size validation data.  This table is indexed with the same
     * value as ::dispatch_functions.
     *
     * The first element in the pair is the size, in bytes, of the fixed-size
     * portion of the protocol.
     *
     * For opcodes that have a variable-size portion, the second value is an
     * index in \c size_func_table to calculate that size.  If there is no
     * variable-size portion, this index will be ~0.
     *
     * \note
     * If size checking is not to be performed on this type of protocol
     * data, this pointer will be \c NULL.
     */
    const int_fast16_t (*size_table)[2];

    /**
     * Array of functions used to calculate the variable-size portion of
     * protocol messages.  Indexed by the second element of the entries
     * in \c ::size_table.
     *
     * \note
     * If size checking is not to be performed on this type of protocol
     * data, this pointer will be \c NULL.
     */
    const gl_proto_size_func *size_func_table;
};

/**
 * Sentinel value for an empty leaf in the \c dispatch_tree.
 */
#define EMPTY_LEAF         INT_FAST16_MIN

/**
 * Declare the index \c x as a leaf index.
 */
#define LEAF(x)            -x

/**
 * Determine if an index is a leaf index.
 */
#define IS_LEAF_INDEX(x)   ((x) <= 0)

extern const struct __glXDispatchInfo Single_dispatch_info;
extern const struct __glXDispatchInfo Render_dispatch_info;
extern const struct __glXDispatchInfo VendorPriv_dispatch_info;

#endif /* INDIRECT_TABLE_H */