home *** CD-ROM | disk | FTP | other *** search
/ InfoMagic Source Code 1993 July / THE_SOURCE_CODE_CD_ROM.iso / X / mit / extensions / server / PEX / include / pexExtract.h < prev    next >
Encoding:
C/C++ Source or Header  |  1993-07-21  |  12.0 KB  |  341 lines
  1. /* $XConsortium: pexExtract.h,v 5.7 91/12/11 18:11:43 hersh Exp $ */
  2.  
  3.  
  4. /***********************************************************
  5. Copyright 1989, 1990, 1991 by Sun Microsystems, Inc. and the X Consortium.
  6.  
  7.                         All Rights Reserved
  8.  
  9. Permission to use, copy, modify, and distribute this software and its 
  10. documentation for any purpose and without fee is hereby granted, 
  11. provided that the above copyright notice appear in all copies and that
  12. both that copyright notice and this permission notice appear in 
  13. supporting documentation, and that the names of Sun Microsystems,
  14. the X Consortium, and MIT not be used in advertising or publicity 
  15. pertaining to distribution of the software without specific, written 
  16. prior permission.  
  17.  
  18. SUN MICROSYSTEMS DISCLAIMS ALL WARRANTIES WITH REGARD TO THIS SOFTWARE, 
  19. INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS, IN NO EVENT 
  20. SHALL SUN MICROSYSTEMS BE LIABLE FOR ANY SPECIAL, INDIRECT OR CONSEQUENTIAL 
  21. DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS,
  22. WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION,
  23. ARISING OUT OF OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS
  24. SOFTWARE.
  25.  
  26. ******************************************************************/
  27.  
  28. #ifndef PEX_EXTRACT_H
  29. #define PEX_EXTRACT_H    1
  30.  
  31. /**  Note that these extract macros, when dealing with data items which
  32.  ** require more than a few bytes of storage (the only exceptions being
  33.  ** CARD8, CARD16, and CARD32), simply set the destination to point into
  34.  ** the packet from which the data is being "extracted".  This is 
  35.  ** legal since the data is in the correct format (PEX format) in
  36.  ** that packet.  The pointer into the packet is then
  37.  ** incremented by the appropriate number of bytes.
  38.  **/
  39.  
  40. #define REFER_COORD3D(dstPtr, srcPtr) {        \
  41.     (dstPtr) = (ddCoord3D *)(srcPtr);        \
  42.     (srcPtr) = ((CARD8 *) (srcPtr)) + sizeof(pexCoord3D); }
  43.  
  44. #define REFER_LISTOF_COORD3D(num, dstPtr, srcPtr) {    \
  45.     (dstPtr) = (ddCoord3D *)(srcPtr);            \
  46.     (srcPtr) = ((CARD8 *) (srcPtr)) + num * sizeof(pexCoord3D); }
  47.  
  48. #define REFER_LISTOF_COORD2D(num, dstPtr, srcPtr) {    \
  49.     (dstPtr) = (ddCoord2D *)(srcPtr);            \
  50.     (srcPtr) = ((CARD8 *) (srcPtr)) + num * sizeof(pexCoord2D); }
  51.  
  52. #define REFER_LISTOF_CARD16(num, dstPtr, srcPtr) {    \
  53.     (dstPtr) = (CARD16 *)(srcPtr);            \
  54.     (srcPtr) = ((CARD8 *) (srcPtr)) + num * sizeof(CARD16); }
  55.  
  56. #define REFER_CARD8(dst, srcPtr) {        \
  57.     (dst) = *((CARD8 *)(srcPtr));        \
  58.     (srcPtr) = ((CARD8 *) (srcPtr)) + sizeof(CARD8); }
  59.  
  60. #define REFER_CARD16(dst, srcPtr) {        \
  61.     (dst) = *((CARD16 *)(srcPtr));        \
  62.     (srcPtr) = ((CARD8 *) (srcPtr)) + sizeof(CARD16); }
  63.  
  64. #define REFER_CARD32(dst, srcPtr) {        \
  65.     (dst) = *((CARD32 *)(srcPtr));        \
  66.     (srcPtr) = ((CARD8 *) (srcPtr)) + sizeof(CARD32); }
  67.  
  68. #define REFER_FLOAT(dst, srcPtr) {        \
  69.     (dst) = *((PEXFLOAT *)(srcPtr));        \
  70.     (srcPtr) = ((CARD8 *) (srcPtr)) + sizeof(PEXFLOAT); }
  71.  
  72. /** This is a very general macro which will set the destination pointer to
  73.  ** be whatever the src pointer is, typecast to the specified type.  The
  74.  ** src pointer is then incremented by the size of the specified type
  75.  ** multiplied by a factor representing the number of such structures to 
  76.  ** be skipped over.
  77.  **/
  78.  
  79. #define REFER_STRUCT(num, data_type, dstPtr, srcPtr) {        \
  80.     (dstPtr) = (data_type *)(srcPtr);                \
  81.     (srcPtr) = ((CARD8 *) (srcPtr)) + num * sizeof(data_type); }
  82.  
  83.  
  84. /*
  85.     The next set of macros actually copy the data from a packet
  86.     into the destination data structure.
  87. */
  88.  
  89. #define EXTRACT_COORD3D(dstPtr, srcPtr) {  \
  90.     (dstPtr)->x = ((pexCoord3D *)((srcPtr)))->x;  \
  91.     (dstPtr)->y = ((pexCoord3D *)(srcPtr))->y;  \
  92.     (dstPtr)->z = ((pexCoord3D *)(srcPtr))->z;  \
  93.     (srcPtr) = ((CARD8 *) (srcPtr)) + sizeof(pexCoord3D); }
  94.  
  95. #define EXTRACT_VECTOR3D(dstPtr, srcPtr) {  \
  96.     (dstPtr)->x = ((pexVector3D *)((srcPtr)))->x;  \
  97.     (dstPtr)->y = ((pexVector3D *)(srcPtr))->y;  \
  98.     (dstPtr)->z = ((pexVector3D *)(srcPtr))->z;  \
  99.     (srcPtr) = ((CARD8 *) (srcPtr)) + sizeof(pexVector3D); }
  100.  
  101. #define EXTRACT_LISTOF_COORD3D(num, dstPtr, srcPtr) \
  102.     EXTRACT_STRUCT(num, ddCoord3D, dstPtr, srcPtr)
  103.  
  104. #define EXTRACT_COORD2D(dstPtr, srcPtr) {  \
  105.     (dstPtr)->x = ((pexCoord2D *)(srcPtr))->x;  \
  106.     (dstPtr)->y = ((pexCoord2D *)(srcPtr))->y;  \
  107.     (srcPtr) = ((CARD8 *) (srcPtr)) + sizeof(pexCoord2D); }
  108.  
  109. #define EXTRACT_VECTOR2D(dstPtr, srcPtr) {  \
  110.     (dstPtr)->x = ((pexVector2D *)(srcPtr))->x;  \
  111.     (dstPtr)->y = ((pexVector2D *)(srcPtr))->y;  \
  112.     (srcPtr) = ((CARD8 *) (srcPtr)) + sizeof(pexVector2D); }
  113.  
  114. #define EXTRACT_LISTOF_COORD2D(num, dstPtr, srcPtr) \
  115.     EXTRACT_STRUCT(num, ddCoord2D, dstPtr, srcPtr)
  116.  
  117. /* Takes a CARD8 from a 4 byte Protocol Field  */
  118. #define EXTRACT_CARD8_FROM_4B(dst, srcPtr)    {   \
  119.     (dst) = (CARD8) (*((CARD32 *)(srcPtr)));        \
  120.     (srcPtr) = ((CARD8 *) (srcPtr)) + sizeof(CARD32); }
  121.  
  122. #define EXTRACT_CARD8(dst, srcPtr)    {   \
  123.     (dst) = *((CARD8 *)(srcPtr));        \
  124.     (srcPtr) = ((CARD8 *) (srcPtr)) + sizeof(CARD8); }
  125.  
  126. /* Takes a CARD16 from a 4 byte Protocol Field  */
  127. #define EXTRACT_CARD16_FROM_4B(dst, srcPtr)    {   \
  128.     (dst) = (CARD16) (*((CARD32 *)(srcPtr)));        \
  129.     (srcPtr) = ((CARD8 *) (srcPtr)) + sizeof(CARD32); }
  130.  
  131. /* Takes a INT16 from a 4 byte Protocol Field  */
  132. #define EXTRACT_INT16_FROM_4B(dst, srcPtr)    {   \
  133.     (dst) = (INT16) (*((CARD32 *)(srcPtr)));        \
  134.     (srcPtr) = ((CARD8 *) (srcPtr)) + sizeof(CARD32); }
  135.  
  136. #define EXTRACT_CARD16(dst, srcPtr)    {   \
  137.     (dst) = *((CARD16 *)(srcPtr));        \
  138.     (srcPtr) = ((CARD8 *) (srcPtr)) + sizeof(CARD16); }
  139.  
  140. #define EXTRACT_INT16(dst, srcPtr)    {   \
  141.     (dst) = *((INT16 *)(srcPtr));        \
  142.     (srcPtr) = ((CARD8 *) (srcPtr)) + sizeof(INT16); }
  143.  
  144. #define EXTRACT_CARD32(dst, srcPtr)    {   \
  145.     (dst) = *((CARD32 *)(srcPtr));        \
  146.     (srcPtr) = ((CARD8 *) (srcPtr)) + sizeof(CARD32); }
  147.  
  148. #define EXTRACT_FLOAT(dst, srcPtr)    {   \
  149.     (dst) = *((PEXFLOAT *)(srcPtr));        \
  150.     (srcPtr) = ((CARD8 *) (srcPtr)) + sizeof(PEXFLOAT); }
  151.  
  152.  
  153. #define EXTRACT_COLOUR_SPECIFIER(dst, srcPtr) { \
  154.     EXTRACT_CARD16 ((dst).colourType, (srcPtr));\
  155.     SKIP_PADDING ((srcPtr), 2);\
  156.     switch ((dst).colourType) {\
  157.         case PEXIndexedColour: {\
  158.         EXTRACT_CARD16((dst).colour.indexed.index, (srcPtr));\
  159.         SKIP_PADDING((srcPtr),2);\
  160.         break;\
  161.         }\
  162.         case PEXRgbFloatColour: {\
  163.         EXTRACT_FLOAT((dst).colour.rgbFloat.red,(srcPtr));\
  164.         EXTRACT_FLOAT((dst).colour.rgbFloat.green,(srcPtr));\
  165.         EXTRACT_FLOAT((dst).colour.rgbFloat.blue,(srcPtr));\
  166.         break;\
  167.         }\
  168.         case PEXCieFloatColour: {\
  169.         EXTRACT_FLOAT((dst).colour.cieFloat.x,(srcPtr));\
  170.         EXTRACT_FLOAT((dst).colour.cieFloat.y,(srcPtr));\
  171.         EXTRACT_FLOAT((dst).colour.cieFloat.z,(srcPtr));\
  172.         break;\
  173.         }\
  174.         case PEXHsvFloatColour: {\
  175.         EXTRACT_FLOAT((dst).colour.hsvFloat.hue,(srcPtr));\
  176.         EXTRACT_FLOAT((dst).colour.hsvFloat.saturation,(srcPtr));\
  177.         EXTRACT_FLOAT((dst).colour.hsvFloat.value,(srcPtr));\
  178.         break;\
  179.         }\
  180.         case PEXHlsFloatColour: {\
  181.         EXTRACT_FLOAT((dst).colour.hlsFloat.hue,(srcPtr));\
  182.         EXTRACT_FLOAT((dst).colour.hlsFloat.lightness,(srcPtr));\
  183.         EXTRACT_FLOAT((dst).colour.hlsFloat.saturation,(srcPtr));\
  184.         break;\
  185.         }\
  186.         case PEXRgb8Colour: {\
  187.         EXTRACT_CARD8((dst).colour.rgb8.red,(srcPtr));\
  188.         EXTRACT_CARD8((dst).colour.rgb8.green,(srcPtr));\
  189.         EXTRACT_CARD8((dst).colour.rgb8.blue,(srcPtr));\
  190.         SKIP_PADDING((srcPtr),1);\
  191.         break;\
  192.         }\
  193.         case PEXRgb16Colour: {\
  194.         EXTRACT_CARD16((dst).colour.rgb16.red,(srcPtr));\
  195.         EXTRACT_CARD16((dst).colour.rgb16.green,(srcPtr));\
  196.         EXTRACT_CARD16((dst).colour.rgb16.blue,(srcPtr));\
  197.         SKIP_PADDING((srcPtr),2);\
  198.         break;\
  199.         }\
  200.     }}
  201.  
  202. #define EXTRACT_STRUCT(num, data_type, dstPtr, srcPtr) {\
  203.     bcopy(    (char *)(srcPtr), (char *)(dstPtr), \
  204.         (int)(num * sizeof(data_type)));\
  205.     (srcPtr) = ((CARD8 *) (srcPtr)) + num * sizeof(data_type); }
  206.  
  207. /*
  208.     The next set of macros actually copy the data from a structure
  209.     into the destination reply packet.
  210. */
  211.  
  212. #define PACK_COORD3D(srcPtr, dstPtr)    {       \
  213.     ((pexCoord3D *)(dstPtr))->x = (srcPtr)->x;  \
  214.     ((pexCoord3D *)(dstPtr))->y = (srcPtr)->y;  \
  215.     ((pexCoord3D *)(dstPtr))->z = (srcPtr)->z;  \
  216.     (dstPtr) = ((CARD8 *) (dstPtr)) + sizeof(pexCoord3D); }
  217.  
  218. #define PACK_LISTOF_COORD3D(NUM, SRC, DST)  \
  219.     PACK_LISTOF_STRUCT(NUM, pexCoord3D, SRC, DST)
  220.  
  221. #define PACK_COORD2D(srcPtr, dstPtr)    {       \
  222.     ((pexCoord2D *)(dstPtr))->x = (srcPtr)->x;  \
  223.     ((pexCoord2D *)(dstPtr))->y = (srcPtr)->y;  \
  224.     (dstPtr) = ((CARD8 *) (dstPtr)) + sizeof(pexCoord2D); }
  225.  
  226. #define PACK_LISTOF_COORD2D(NUM, SRC, DST)  \
  227.     PACK_LISTOF_STRUCT(NUM, pexCoord2D, SRC, DST)
  228.  
  229. #define PACK_VECTOR3D(srcPtr, dstPtr)    {       \
  230.     ((pexVector3D *)(dstPtr))->x = (srcPtr)->x; \
  231.     ((pexVector3D *)(dstPtr))->y = (srcPtr)->y; \
  232.     ((pexVector3D *)(dstPtr))->z = (srcPtr)->z; \
  233.     (dstPtr) = ((CARD8 *) (dstPtr)) + sizeof(pexCoord3D); }
  234.  
  235. #define PACK_VECTOR2D(srcPtr, dstPtr) {         \
  236.     ((pexVector2D *)(dstPtr))->x = (srcPtr)->x; \
  237.     ((pexVector2D *)(dstPtr))->y = (srcPtr)->y; \
  238.     (dstPtr) = ((CARD8 *) (dstPtr)) + sizeof(pexCoord2D); }
  239.  
  240.  
  241. #define PACK_CARD8(src, dstPtr)    {\
  242.     *((CARD8 *)(dstPtr)) = (CARD8)(src);\
  243.     (dstPtr) = ((CARD8 *) (dstPtr)) + sizeof(CARD8); }
  244.  
  245. #define PACK_CARD16(src, dstPtr)    {   \
  246.     *((CARD16 *)(dstPtr)) = (CARD16)(src);  \
  247.     (dstPtr) = ((CARD8 *) (dstPtr)) + sizeof(CARD16); }
  248.  
  249. #define PACK_INT16(src, dstPtr)    {       \
  250.     *((INT16 *)(dstPtr)) = (INT16)(src);\
  251.     (dstPtr) = ((CARD8 *) (dstPtr)) + sizeof(INT16); }
  252.  
  253. #define PACK_CARD32(src, dstPtr)    {   \
  254.     *((CARD32 *)(dstPtr)) = (CARD32)(src);  \
  255.     (dstPtr) = ((CARD8 *) (dstPtr)) + sizeof(CARD32); }
  256.  
  257. #define PACK_FLOAT(src, dstPtr)    {\
  258.     *((PEXFLOAT *)(dstPtr)) = (PEXFLOAT)(src);\
  259.     (dstPtr) = ((CARD8 *) (dstPtr)) + sizeof(PEXFLOAT); }
  260.  
  261.  
  262. #define PACK_COLOUR_SPECIFIER(src, dstPtr) {\
  263.     PACK_CARD16 ((src).colourType, (dstPtr));\
  264.     SKIP_PADDING ((dstPtr), 2);\
  265.     switch ((src).colourType) {\
  266.         case PEXIndexedColour: {\
  267.         PACK_CARD16((src).colour.indexed.index,(dstPtr));\
  268.         SKIP_PADDING((dstPtr),2);\
  269.         break;\
  270.         }\
  271.         case PEXRgbFloatColour: {\
  272.         PACK_FLOAT((src).colour.rgbFloat.red,(dstPtr));\
  273.         PACK_FLOAT((src).colour.rgbFloat.green,(dstPtr));\
  274.         PACK_FLOAT((src).colour.rgbFloat.blue,(dstPtr));\
  275.         break;\
  276.         }\
  277.         case PEXCieFloatColour: {\
  278.         PACK_FLOAT((src).colour.cieFloat.x,(dstPtr));\
  279.         PACK_FLOAT((src).colour.cieFloat.y,(dstPtr));\
  280.         PACK_FLOAT((src).colour.cieFloat.z,(dstPtr));\
  281.         break;\
  282.         }\
  283.         case PEXHsvFloatColour: {\
  284.         PACK_FLOAT((src).colour.hsvFloat.hue,(dstPtr));\
  285.         PACK_FLOAT((src).colour.hsvFloat.saturation,(dstPtr));\
  286.         PACK_FLOAT((src).colour.hsvFloat.value,(dstPtr));\
  287.         break;\
  288.         }\
  289.         case PEXHlsFloatColour: {\
  290.         PACK_FLOAT((src).colour.hlsFloat.hue,(dstPtr));\
  291.         PACK_FLOAT((src).colour.hlsFloat.lightness,(dstPtr));\
  292.         PACK_FLOAT((src).colour.hlsFloat.saturation,(dstPtr));\
  293.         break;\
  294.         }\
  295.         case PEXRgb8Colour: {\
  296.         PACK_CARD8((src).colour.rgb8.red,(dstPtr));\
  297.         PACK_CARD8((src).colour.rgb8.green,(dstPtr));\
  298.         PACK_CARD8((src).colour.rgb8.blue,(dstPtr));\
  299.         SKIP_PADDING((dstPtr),1);\
  300.         break;\
  301.         }\
  302.         case PEXRgb16Colour: {\
  303.         PACK_CARD16((src).colour.rgb16.red,(dstPtr));\
  304.         PACK_CARD16((src).colour.rgb16.green,(dstPtr));\
  305.         PACK_CARD16((src).colour.rgb16.blue,(dstPtr));\
  306.         SKIP_PADDING((dstPtr),2);\
  307.         break;\
  308.         }\
  309.     }}
  310.  
  311. #define PACK_STRUCT(data_type,srcPtr,dstPtr)    {       \
  312.     bcopy(  (char *)(srcPtr), (char *)(dstPtr),        \
  313.         sizeof(data_type));                \
  314.     SKIP_STRUCT(dstPtr, 1, data_type); }
  315.  
  316. #define PACK_LISTOF_STRUCT(num,data_type,srcPtr,dstPtr){\
  317.     bcopy(  (char *)(srcPtr), (char *)(dstPtr),        \
  318.         (int)(num * sizeof(data_type)));    \
  319.     SKIP_STRUCT(dstPtr, num, data_type); }
  320. /*
  321.     Other useful macros
  322.  */
  323.  
  324. #define SKIP_PADDING(skipPtr, bytesToSkip) \
  325.   (skipPtr) = ((CARD8 *) (skipPtr)) + bytesToSkip
  326.  
  327. #define SKIP_STRUCT(skipPtr, num, data_type) \
  328.    (skipPtr) = (unsigned char *)(((data_type *)skipPtr) + (num))
  329.  
  330. #define SIZE_COLOURSPEC(cs) ColourSpecSizes[cs.colourType]
  331.  
  332. /*
  333. ###define SIZE_COLOURSPEC(cs) \
  334.     (cs->colourType == PEXIndexedColour)?sizeof(CARD32):\
  335.     ((cs->colourType == PEXRgb8Colour)?sizeof(CARD32):\
  336.         ((cs->colourType == PEXRgb16Colour)?2*sizeof(CARD32):\
  337.         3*sizeof(PEXFLOAT) ) )
  338. */
  339.  
  340. #endif /* PEX_EXTRACT_H */
  341.