1*37da2899SCharles.Forsyth /***************************************************************************/ 2*37da2899SCharles.Forsyth /* */ 3*37da2899SCharles.Forsyth /* ftstream.h */ 4*37da2899SCharles.Forsyth /* */ 5*37da2899SCharles.Forsyth /* Stream handling (specification). */ 6*37da2899SCharles.Forsyth /* */ 7*37da2899SCharles.Forsyth /* Copyright 1996-2001, 2002 by */ 8*37da2899SCharles.Forsyth /* David Turner, Robert Wilhelm, and Werner Lemberg. */ 9*37da2899SCharles.Forsyth /* */ 10*37da2899SCharles.Forsyth /* This file is part of the FreeType project, and may only be used, */ 11*37da2899SCharles.Forsyth /* modified, and distributed under the terms of the FreeType project */ 12*37da2899SCharles.Forsyth /* license, LICENSE.TXT. By continuing to use, modify, or distribute */ 13*37da2899SCharles.Forsyth /* this file you indicate that you have read the license and */ 14*37da2899SCharles.Forsyth /* understand and accept it fully. */ 15*37da2899SCharles.Forsyth /* */ 16*37da2899SCharles.Forsyth /***************************************************************************/ 17*37da2899SCharles.Forsyth 18*37da2899SCharles.Forsyth 19*37da2899SCharles.Forsyth #ifndef __FTSTREAM_H__ 20*37da2899SCharles.Forsyth #define __FTSTREAM_H__ 21*37da2899SCharles.Forsyth 22*37da2899SCharles.Forsyth 23*37da2899SCharles.Forsyth #include <ft2build.h> 24*37da2899SCharles.Forsyth #include FT_SYSTEM_H 25*37da2899SCharles.Forsyth #include FT_INTERNAL_OBJECTS_H 26*37da2899SCharles.Forsyth 27*37da2899SCharles.Forsyth 28*37da2899SCharles.Forsyth FT_BEGIN_HEADER 29*37da2899SCharles.Forsyth 30*37da2899SCharles.Forsyth 31*37da2899SCharles.Forsyth /* format of an 8-bit frame_op value: */ 32*37da2899SCharles.Forsyth /* */ 33*37da2899SCharles.Forsyth /* bit 76543210 */ 34*37da2899SCharles.Forsyth /* xxxxxxes */ 35*37da2899SCharles.Forsyth /* */ 36*37da2899SCharles.Forsyth /* s is set to 1 if the value is signed. */ 37*37da2899SCharles.Forsyth /* e is set to 1 if the value is little-endian. */ 38*37da2899SCharles.Forsyth /* xxx is a command. */ 39*37da2899SCharles.Forsyth 40*37da2899SCharles.Forsyth #define FT_FRAME_OP_SHIFT 2 41*37da2899SCharles.Forsyth #define FT_FRAME_OP_SIGNED 1 42*37da2899SCharles.Forsyth #define FT_FRAME_OP_LITTLE 2 43*37da2899SCharles.Forsyth #define FT_FRAME_OP_COMMAND( x ) ( x >> FT_FRAME_OP_SHIFT ) 44*37da2899SCharles.Forsyth 45*37da2899SCharles.Forsyth #define FT_MAKE_FRAME_OP( command, little, sign ) \ 46*37da2899SCharles.Forsyth ( ( command << FT_FRAME_OP_SHIFT ) | ( little << 1 ) | sign ) 47*37da2899SCharles.Forsyth 48*37da2899SCharles.Forsyth #define FT_FRAME_OP_END 0 49*37da2899SCharles.Forsyth #define FT_FRAME_OP_START 1 /* start a new frame */ 50*37da2899SCharles.Forsyth #define FT_FRAME_OP_BYTE 2 /* read 1-byte value */ 51*37da2899SCharles.Forsyth #define FT_FRAME_OP_SHORT 3 /* read 2-byte value */ 52*37da2899SCharles.Forsyth #define FT_FRAME_OP_LONG 4 /* read 4-byte value */ 53*37da2899SCharles.Forsyth #define FT_FRAME_OP_OFF3 5 /* read 3-byte value */ 54*37da2899SCharles.Forsyth #define FT_FRAME_OP_BYTES 6 /* read a bytes sequence */ 55*37da2899SCharles.Forsyth 56*37da2899SCharles.Forsyth 57*37da2899SCharles.Forsyth typedef enum FT_Frame_Op_ 58*37da2899SCharles.Forsyth { 59*37da2899SCharles.Forsyth ft_frame_end = 0, 60*37da2899SCharles.Forsyth ft_frame_start = FT_MAKE_FRAME_OP( FT_FRAME_OP_START, 0, 0 ), 61*37da2899SCharles.Forsyth 62*37da2899SCharles.Forsyth ft_frame_byte = FT_MAKE_FRAME_OP( FT_FRAME_OP_BYTE, 0, 0 ), 63*37da2899SCharles.Forsyth ft_frame_schar = FT_MAKE_FRAME_OP( FT_FRAME_OP_BYTE, 0, 1 ), 64*37da2899SCharles.Forsyth 65*37da2899SCharles.Forsyth ft_frame_ushort_be = FT_MAKE_FRAME_OP( FT_FRAME_OP_SHORT, 0, 0 ), 66*37da2899SCharles.Forsyth ft_frame_short_be = FT_MAKE_FRAME_OP( FT_FRAME_OP_SHORT, 0, 1 ), 67*37da2899SCharles.Forsyth ft_frame_ushort_le = FT_MAKE_FRAME_OP( FT_FRAME_OP_SHORT, 1, 0 ), 68*37da2899SCharles.Forsyth ft_frame_short_le = FT_MAKE_FRAME_OP( FT_FRAME_OP_SHORT, 1, 1 ), 69*37da2899SCharles.Forsyth 70*37da2899SCharles.Forsyth ft_frame_ulong_be = FT_MAKE_FRAME_OP( FT_FRAME_OP_LONG, 0, 0 ), 71*37da2899SCharles.Forsyth ft_frame_long_be = FT_MAKE_FRAME_OP( FT_FRAME_OP_LONG, 0, 1 ), 72*37da2899SCharles.Forsyth ft_frame_ulong_le = FT_MAKE_FRAME_OP( FT_FRAME_OP_LONG, 1, 0 ), 73*37da2899SCharles.Forsyth ft_frame_long_le = FT_MAKE_FRAME_OP( FT_FRAME_OP_LONG, 1, 1 ), 74*37da2899SCharles.Forsyth 75*37da2899SCharles.Forsyth ft_frame_uoff3_be = FT_MAKE_FRAME_OP( FT_FRAME_OP_OFF3, 0, 0 ), 76*37da2899SCharles.Forsyth ft_frame_off3_be = FT_MAKE_FRAME_OP( FT_FRAME_OP_OFF3, 0, 1 ), 77*37da2899SCharles.Forsyth ft_frame_uoff3_le = FT_MAKE_FRAME_OP( FT_FRAME_OP_OFF3, 1, 0 ), 78*37da2899SCharles.Forsyth ft_frame_off3_le = FT_MAKE_FRAME_OP( FT_FRAME_OP_OFF3, 1, 1 ), 79*37da2899SCharles.Forsyth 80*37da2899SCharles.Forsyth ft_frame_bytes = FT_MAKE_FRAME_OP( FT_FRAME_OP_BYTES, 0, 0 ), 81*37da2899SCharles.Forsyth ft_frame_skip = FT_MAKE_FRAME_OP( FT_FRAME_OP_BYTES, 0, 1 ) 82*37da2899SCharles.Forsyth 83*37da2899SCharles.Forsyth } FT_Frame_Op; 84*37da2899SCharles.Forsyth 85*37da2899SCharles.Forsyth 86*37da2899SCharles.Forsyth typedef struct FT_Frame_Field_ 87*37da2899SCharles.Forsyth { 88*37da2899SCharles.Forsyth FT_Byte value; 89*37da2899SCharles.Forsyth FT_Byte size; 90*37da2899SCharles.Forsyth FT_UShort offset; 91*37da2899SCharles.Forsyth 92*37da2899SCharles.Forsyth } FT_Frame_Field; 93*37da2899SCharles.Forsyth 94*37da2899SCharles.Forsyth 95*37da2899SCharles.Forsyth /* Construct an FT_Frame_Field out of a structure type and a field name. */ 96*37da2899SCharles.Forsyth /* The structure type must be set in the FT_STRUCTURE macro before */ 97*37da2899SCharles.Forsyth /* calling the FT_FRAME_START() macro. */ 98*37da2899SCharles.Forsyth /* */ 99*37da2899SCharles.Forsyth #define FT_FIELD_SIZE( f ) \ 100*37da2899SCharles.Forsyth (FT_Byte)sizeof ( ((FT_STRUCTURE*)0)->f ) 101*37da2899SCharles.Forsyth 102*37da2899SCharles.Forsyth #define FT_FIELD_SIZE_DELTA( f ) \ 103*37da2899SCharles.Forsyth (FT_Byte)sizeof ( ((FT_STRUCTURE*)0)->f[0] ) 104*37da2899SCharles.Forsyth 105*37da2899SCharles.Forsyth #define FT_FIELD_OFFSET( f ) \ 106*37da2899SCharles.Forsyth (FT_UShort)( offsetof( FT_STRUCTURE, f ) ) 107*37da2899SCharles.Forsyth 108*37da2899SCharles.Forsyth #define FT_FRAME_FIELD( frame_op, field ) \ 109*37da2899SCharles.Forsyth { \ 110*37da2899SCharles.Forsyth frame_op, \ 111*37da2899SCharles.Forsyth FT_FIELD_SIZE( field ), \ 112*37da2899SCharles.Forsyth FT_FIELD_OFFSET( field ) \ 113*37da2899SCharles.Forsyth } 114*37da2899SCharles.Forsyth 115*37da2899SCharles.Forsyth #define FT_MAKE_EMPTY_FIELD( frame_op ) { frame_op, 0, 0 } 116*37da2899SCharles.Forsyth 117*37da2899SCharles.Forsyth #define FT_FRAME_START( size ) { ft_frame_start, 0, size } 118*37da2899SCharles.Forsyth #define FT_FRAME_END { ft_frame_end, 0, 0 } 119*37da2899SCharles.Forsyth 120*37da2899SCharles.Forsyth #define FT_FRAME_LONG( f ) FT_FRAME_FIELD( ft_frame_long_be, f ) 121*37da2899SCharles.Forsyth #define FT_FRAME_ULONG( f ) FT_FRAME_FIELD( ft_frame_ulong_be, f ) 122*37da2899SCharles.Forsyth #define FT_FRAME_SHORT( f ) FT_FRAME_FIELD( ft_frame_short_be, f ) 123*37da2899SCharles.Forsyth #define FT_FRAME_USHORT( f ) FT_FRAME_FIELD( ft_frame_ushort_be, f ) 124*37da2899SCharles.Forsyth #define FT_FRAME_OFF3( f ) FT_FRAME_FIELD( ft_frame_off3_be, f ) 125*37da2899SCharles.Forsyth #define FT_FRAME_UOFF3( f ) FT_FRAME_FIELD( ft_frame_uoff3_be, f ) 126*37da2899SCharles.Forsyth #define FT_FRAME_BYTE( f ) FT_FRAME_FIELD( ft_frame_byte, f ) 127*37da2899SCharles.Forsyth #define FT_FRAME_CHAR( f ) FT_FRAME_FIELD( ft_frame_schar, f ) 128*37da2899SCharles.Forsyth 129*37da2899SCharles.Forsyth #define FT_FRAME_LONG_LE( f ) FT_FRAME_FIELD( ft_frame_long_le, f ) 130*37da2899SCharles.Forsyth #define FT_FRAME_ULONG_LE( f ) FT_FRAME_FIELD( ft_frame_ulong_le, f ) 131*37da2899SCharles.Forsyth #define FT_FRAME_SHORT_LE( f ) FT_FRAME_FIELD( ft_frame_short_le, f ) 132*37da2899SCharles.Forsyth #define FT_FRAME_USHORT_LE( f ) FT_FRAME_FIELD( ft_frame_ushort_le, f ) 133*37da2899SCharles.Forsyth #define FT_FRAME_OFF3_LE( f ) FT_FRAME_FIELD( ft_frame_off3_le, f ) 134*37da2899SCharles.Forsyth #define FT_FRAME_UOFF3_LE( f ) FT_FRAME_FIELD( ft_frame_uoff3_le, f ) 135*37da2899SCharles.Forsyth 136*37da2899SCharles.Forsyth #define FT_FRAME_SKIP_LONG { ft_frame_long_be, 0, 0 } 137*37da2899SCharles.Forsyth #define FT_FRAME_SKIP_SHORT { ft_frame_short_be, 0, 0 } 138*37da2899SCharles.Forsyth #define FT_FRAME_SKIP_BYTE { ft_frame_byte, 0, 0 } 139*37da2899SCharles.Forsyth 140*37da2899SCharles.Forsyth #define FT_FRAME_BYTES( field, count ) \ 141*37da2899SCharles.Forsyth { \ 142*37da2899SCharles.Forsyth ft_frame_bytes, \ 143*37da2899SCharles.Forsyth count, \ 144*37da2899SCharles.Forsyth FT_FIELD_OFFSET( field ) \ 145*37da2899SCharles.Forsyth } 146*37da2899SCharles.Forsyth 147*37da2899SCharles.Forsyth #define FT_FRAME_SKIP_BYTES( count ) { ft_frame_skip, count, 0 } 148*37da2899SCharles.Forsyth 149*37da2899SCharles.Forsyth 150*37da2899SCharles.Forsyth /*************************************************************************/ 151*37da2899SCharles.Forsyth /* */ 152*37da2899SCharles.Forsyth /* Integer extraction macros -- the `buffer' parameter must ALWAYS be of */ 153*37da2899SCharles.Forsyth /* type `char*' or equivalent (1-byte elements). */ 154*37da2899SCharles.Forsyth /* */ 155*37da2899SCharles.Forsyth 156*37da2899SCharles.Forsyth #define FT_BYTE_( p, i ) ( ((const FT_Byte*)(p))[(i)] ) 157*37da2899SCharles.Forsyth #define FT_INT8_( p, i ) ( ((const FT_Char*)(p))[(i)] ) 158*37da2899SCharles.Forsyth 159*37da2899SCharles.Forsyth #define FT_INT16( x ) ( (FT_Int16)(x) ) 160*37da2899SCharles.Forsyth #define FT_UINT16( x ) ( (FT_UInt16)(x) ) 161*37da2899SCharles.Forsyth #define FT_INT32( x ) ( (FT_Int32)(x) ) 162*37da2899SCharles.Forsyth #define FT_UINT32( x ) ( (FT_UInt32)(x) ) 163*37da2899SCharles.Forsyth 164*37da2899SCharles.Forsyth #define FT_BYTE_I16( p, i, s ) ( FT_INT16( FT_BYTE_( p, i ) ) << (s) ) 165*37da2899SCharles.Forsyth #define FT_BYTE_U16( p, i, s ) ( FT_UINT16( FT_BYTE_( p, i ) ) << (s) ) 166*37da2899SCharles.Forsyth #define FT_BYTE_I32( p, i, s ) ( FT_INT32( FT_BYTE_( p, i ) ) << (s) ) 167*37da2899SCharles.Forsyth #define FT_BYTE_U32( p, i, s ) ( FT_UINT32( FT_BYTE_( p, i ) ) << (s) ) 168*37da2899SCharles.Forsyth 169*37da2899SCharles.Forsyth #define FT_INT8_I16( p, i, s ) ( FT_INT16( FT_INT8_( p, i ) ) << (s) ) 170*37da2899SCharles.Forsyth #define FT_INT8_U16( p, i, s ) ( FT_UINT16( FT_INT8_( p, i ) ) << (s) ) 171*37da2899SCharles.Forsyth #define FT_INT8_I32( p, i, s ) ( FT_INT32( FT_INT8_( p, i ) ) << (s) ) 172*37da2899SCharles.Forsyth #define FT_INT8_U32( p, i, s ) ( FT_UINT32( FT_INT8_( p, i ) ) << (s) ) 173*37da2899SCharles.Forsyth 174*37da2899SCharles.Forsyth 175*37da2899SCharles.Forsyth #define FT_PEEK_SHORT( p ) FT_INT16( FT_INT8_I16( p, 0, 8) | \ 176*37da2899SCharles.Forsyth FT_BYTE_I16( p, 1, 0) ) 177*37da2899SCharles.Forsyth 178*37da2899SCharles.Forsyth #define FT_PEEK_USHORT( p ) FT_UINT16( FT_BYTE_U16( p, 0, 8 ) | \ 179*37da2899SCharles.Forsyth FT_BYTE_U16( p, 1, 0 ) ) 180*37da2899SCharles.Forsyth 181*37da2899SCharles.Forsyth #define FT_PEEK_LONG( p ) FT_INT32( FT_INT8_I32( p, 0, 24 ) | \ 182*37da2899SCharles.Forsyth FT_BYTE_I32( p, 1, 16 ) | \ 183*37da2899SCharles.Forsyth FT_BYTE_I32( p, 2, 8 ) | \ 184*37da2899SCharles.Forsyth FT_BYTE_I32( p, 3, 0 ) ) 185*37da2899SCharles.Forsyth 186*37da2899SCharles.Forsyth #define FT_PEEK_ULONG( p ) FT_UINT32( FT_BYTE_U32( p, 0, 24 ) | \ 187*37da2899SCharles.Forsyth FT_BYTE_U32( p, 1, 16 ) | \ 188*37da2899SCharles.Forsyth FT_BYTE_U32( p, 2, 8 ) | \ 189*37da2899SCharles.Forsyth FT_BYTE_U32( p, 3, 0 ) ) 190*37da2899SCharles.Forsyth 191*37da2899SCharles.Forsyth #define FT_PEEK_OFF3( p ) FT_INT32( FT_INT8_I32( p, 0, 16 ) | \ 192*37da2899SCharles.Forsyth FT_BYTE_I32( p, 1, 8 ) | \ 193*37da2899SCharles.Forsyth FT_BYTE_I32( p, 2, 0 ) ) 194*37da2899SCharles.Forsyth 195*37da2899SCharles.Forsyth #define FT_PEEK_UOFF3( p ) FT_UINT32( FT_BYTE_U32( p, 0, 16 ) | \ 196*37da2899SCharles.Forsyth FT_BYTE_U32( p, 1, 8 ) | \ 197*37da2899SCharles.Forsyth FT_BYTE_U32( p, 2, 0 ) ) 198*37da2899SCharles.Forsyth 199*37da2899SCharles.Forsyth #define FT_PEEK_SHORT_LE( p ) FT_INT16( FT_INT8_I16( p, 1, 8 ) | \ 200*37da2899SCharles.Forsyth FT_BYTE_I16( p, 0, 0 ) ) 201*37da2899SCharles.Forsyth 202*37da2899SCharles.Forsyth #define FT_PEEK_USHORT_LE( p ) FT_UINT16( FT_BYTE_U16( p, 1, 8 ) | \ 203*37da2899SCharles.Forsyth FT_BYTE_U16( p, 0, 0 ) ) 204*37da2899SCharles.Forsyth 205*37da2899SCharles.Forsyth #define FT_PEEK_LONG_LE( p ) FT_INT32( FT_INT8_I32( p, 3, 24 ) | \ 206*37da2899SCharles.Forsyth FT_BYTE_I32( p, 2, 16 ) | \ 207*37da2899SCharles.Forsyth FT_BYTE_I32( p, 1, 8 ) | \ 208*37da2899SCharles.Forsyth FT_BYTE_I32( p, 0, 0 ) ) 209*37da2899SCharles.Forsyth 210*37da2899SCharles.Forsyth #define FT_PEEK_ULONG_LE( p ) FT_UINT32( FT_BYTE_U32( p, 3, 24 ) | \ 211*37da2899SCharles.Forsyth FT_BYTE_U32( p, 2, 16 ) | \ 212*37da2899SCharles.Forsyth FT_BYTE_U32( p, 1, 8 ) | \ 213*37da2899SCharles.Forsyth FT_BYTE_U32( p, 0, 0 ) ) 214*37da2899SCharles.Forsyth 215*37da2899SCharles.Forsyth #define FT_PEEK_OFF3_LE( p ) FT_INT32( FT_INT8_I32( p, 2, 16 ) | \ 216*37da2899SCharles.Forsyth FT_BYTE_I32( p, 1, 8 ) | \ 217*37da2899SCharles.Forsyth FT_BYTE_I32( p, 0, 0 ) ) 218*37da2899SCharles.Forsyth 219*37da2899SCharles.Forsyth #define FT_PEEK_UOFF3_LE( p ) FT_UINT32( FT_BYTE_U32( p, 2, 16 ) | \ 220*37da2899SCharles.Forsyth FT_BYTE_U32( p, 1, 8 ) | \ 221*37da2899SCharles.Forsyth FT_BYTE_U32( p, 0, 0 ) ) 222*37da2899SCharles.Forsyth 223*37da2899SCharles.Forsyth 224*37da2899SCharles.Forsyth #define FT_NEXT_CHAR( buffer ) \ 225*37da2899SCharles.Forsyth ( (signed char)*buffer++ ) 226*37da2899SCharles.Forsyth 227*37da2899SCharles.Forsyth #define FT_NEXT_BYTE( buffer ) \ 228*37da2899SCharles.Forsyth ( (unsigned char)*buffer++ ) 229*37da2899SCharles.Forsyth 230*37da2899SCharles.Forsyth #define FT_NEXT_SHORT( buffer ) \ 231*37da2899SCharles.Forsyth ( (short)( buffer += 2, FT_PEEK_SHORT( buffer - 2 ) ) ) 232*37da2899SCharles.Forsyth 233*37da2899SCharles.Forsyth #define FT_NEXT_USHORT( buffer ) \ 234*37da2899SCharles.Forsyth ( (unsigned short)( buffer += 2, FT_PEEK_USHORT( buffer - 2 ) ) ) 235*37da2899SCharles.Forsyth 236*37da2899SCharles.Forsyth #define FT_NEXT_OFF3( buffer ) \ 237*37da2899SCharles.Forsyth ( (long)( buffer += 3, FT_PEEK_OFF3( buffer - 3 ) ) ) 238*37da2899SCharles.Forsyth 239*37da2899SCharles.Forsyth #define FT_NEXT_UOFF3( buffer ) \ 240*37da2899SCharles.Forsyth ( (unsigned long)( buffer += 3, FT_PEEK_UOFF3( buffer - 3 ) ) ) 241*37da2899SCharles.Forsyth 242*37da2899SCharles.Forsyth #define FT_NEXT_LONG( buffer ) \ 243*37da2899SCharles.Forsyth ( (long)( buffer += 4, FT_PEEK_LONG( buffer - 4 ) ) ) 244*37da2899SCharles.Forsyth 245*37da2899SCharles.Forsyth #define FT_NEXT_ULONG( buffer ) \ 246*37da2899SCharles.Forsyth ( (unsigned long)( buffer += 4, FT_PEEK_ULONG( buffer - 4 ) ) ) 247*37da2899SCharles.Forsyth 248*37da2899SCharles.Forsyth 249*37da2899SCharles.Forsyth #define FT_NEXT_SHORT_LE( buffer ) \ 250*37da2899SCharles.Forsyth ( (short)( buffer += 2, FT_PEEK_SHORT_LE( buffer - 2 ) ) ) 251*37da2899SCharles.Forsyth 252*37da2899SCharles.Forsyth #define FT_NEXT_USHORT_LE( buffer ) \ 253*37da2899SCharles.Forsyth ( (unsigned short)( buffer += 2, FT_PEEK_USHORT_LE( buffer - 2 ) ) ) 254*37da2899SCharles.Forsyth 255*37da2899SCharles.Forsyth #define FT_NEXT_OFF3_LE( buffer ) \ 256*37da2899SCharles.Forsyth ( (long)( buffer += 3, FT_PEEK_OFF3_LE( buffer - 3 ) ) ) 257*37da2899SCharles.Forsyth 258*37da2899SCharles.Forsyth #define FT_NEXT_UOFF3_LE( buffer ) \ 259*37da2899SCharles.Forsyth ( (unsigned long)( buffer += 3, FT_PEEK_UOFF3_LE( buffer - 3 ) ) ) 260*37da2899SCharles.Forsyth 261*37da2899SCharles.Forsyth #define FT_NEXT_LONG_LE( buffer ) \ 262*37da2899SCharles.Forsyth ( (long)( buffer += 4, FT_PEEK_LONG_LE( buffer - 4 ) ) ) 263*37da2899SCharles.Forsyth 264*37da2899SCharles.Forsyth #define FT_NEXT_ULONG_LE( buffer ) \ 265*37da2899SCharles.Forsyth ( (unsigned long)( buffer += 4, FT_PEEK_ULONG_LE( buffer - 4 ) ) ) 266*37da2899SCharles.Forsyth 267*37da2899SCharles.Forsyth 268*37da2899SCharles.Forsyth /*************************************************************************/ 269*37da2899SCharles.Forsyth /* */ 270*37da2899SCharles.Forsyth /* Each GET_xxxx() macro uses an implicit `stream' variable. */ 271*37da2899SCharles.Forsyth /* */ 272*37da2899SCharles.Forsyth #define FT_GET_MACRO( func, type ) ( (type)func( stream ) ) 273*37da2899SCharles.Forsyth 274*37da2899SCharles.Forsyth #define FT_GET_CHAR() FT_GET_MACRO( FT_Stream_GetChar, FT_Char ) 275*37da2899SCharles.Forsyth #define FT_GET_BYTE() FT_GET_MACRO( FT_Stream_GetChar, FT_Byte ) 276*37da2899SCharles.Forsyth #define FT_GET_SHORT() FT_GET_MACRO( FT_Stream_GetShort, FT_Short ) 277*37da2899SCharles.Forsyth #define FT_GET_USHORT() FT_GET_MACRO( FT_Stream_GetShort, FT_UShort ) 278*37da2899SCharles.Forsyth #define FT_GET_OFF3() FT_GET_MACRO( FT_Stream_GetOffset, FT_Long ) 279*37da2899SCharles.Forsyth #define FT_GET_UOFF3() FT_GET_MACRO( FT_Stream_GetOffset, FT_ULong ) 280*37da2899SCharles.Forsyth #define FT_GET_LONG() FT_GET_MACRO( FT_Stream_GetLong, FT_Long ) 281*37da2899SCharles.Forsyth #define FT_GET_ULONG() FT_GET_MACRO( FT_Stream_GetLong, FT_ULong ) 282*37da2899SCharles.Forsyth #define FT_GET_TAG4() FT_GET_MACRO( FT_Stream_GetLong, FT_ULong ) 283*37da2899SCharles.Forsyth 284*37da2899SCharles.Forsyth #define FT_GET_SHORT_LE() FT_GET_MACRO( FT_Stream_GetShortLE, FT_Short ) 285*37da2899SCharles.Forsyth #define FT_GET_USHORT_LE() FT_GET_MACRO( FT_Stream_GetShortLE, FT_UShort ) 286*37da2899SCharles.Forsyth #define FT_GET_LONG_LE() FT_GET_MACRO( FT_Stream_GetLongLE, FT_Long ) 287*37da2899SCharles.Forsyth #define FT_GET_ULONG_LE() FT_GET_MACRO( FT_Stream_GetLongLE, FT_ULong ) 288*37da2899SCharles.Forsyth 289*37da2899SCharles.Forsyth #define FT_READ_MACRO( func, type, var ) \ 290*37da2899SCharles.Forsyth ( var = (type)func( stream, &error ), \ 291*37da2899SCharles.Forsyth error != FT_Err_Ok ) 292*37da2899SCharles.Forsyth 293*37da2899SCharles.Forsyth #define FT_READ_BYTE( var ) FT_READ_MACRO( FT_Stream_ReadChar, FT_Byte, var ) 294*37da2899SCharles.Forsyth #define FT_READ_CHAR( var ) FT_READ_MACRO( FT_Stream_ReadChar, FT_Char, var ) 295*37da2899SCharles.Forsyth #define FT_READ_SHORT( var ) FT_READ_MACRO( FT_Stream_ReadShort, FT_Short, var ) 296*37da2899SCharles.Forsyth #define FT_READ_USHORT( var ) FT_READ_MACRO( FT_Stream_ReadShort, FT_UShort, var ) 297*37da2899SCharles.Forsyth #define FT_READ_OFF3( var ) FT_READ_MACRO( FT_Stream_ReadOffset, FT_Long, var ) 298*37da2899SCharles.Forsyth #define FT_READ_UOFF3( var ) FT_READ_MACRO( FT_Stream_ReadOffset, FT_ULong, var ) 299*37da2899SCharles.Forsyth #define FT_READ_LONG( var ) FT_READ_MACRO( FT_Stream_ReadLong, FT_Long, var ) 300*37da2899SCharles.Forsyth #define FT_READ_ULONG( var ) FT_READ_MACRO( FT_Stream_ReadLong, FT_ULong, var ) 301*37da2899SCharles.Forsyth 302*37da2899SCharles.Forsyth #define FT_READ_SHORT_LE( var ) FT_READ_MACRO( FT_Stream_ReadShortLE, FT_Short, var ) 303*37da2899SCharles.Forsyth #define FT_READ_USHORT_LE( var ) FT_READ_MACRO( FT_Stream_ReadShortLE, FT_UShort, var ) 304*37da2899SCharles.Forsyth #define FT_READ_LONG_LE( var ) FT_READ_MACRO( FT_Stream_ReadLongLE, FT_Long, var ) 305*37da2899SCharles.Forsyth #define FT_READ_ULONG_LE( var ) FT_READ_MACRO( FT_Stream_ReadLongLE, FT_ULong, var ) 306*37da2899SCharles.Forsyth 307*37da2899SCharles.Forsyth 308*37da2899SCharles.Forsyth #ifndef FT_CONFIG_OPTION_NO_DEFAULT_SYSTEM 309*37da2899SCharles.Forsyth 310*37da2899SCharles.Forsyth /* initialize a stream for reading a regular system stream */ 311*37da2899SCharles.Forsyth FT_EXPORT( FT_Error ) 312*37da2899SCharles.Forsyth FT_Stream_Open( FT_Stream stream, 313*37da2899SCharles.Forsyth const char* filepathname ); 314*37da2899SCharles.Forsyth 315*37da2899SCharles.Forsyth #endif /* FT_CONFIG_OPTION_NO_DEFAULT_SYSTEM */ 316*37da2899SCharles.Forsyth 317*37da2899SCharles.Forsyth 318*37da2899SCharles.Forsyth /* initialize a stream for reading in-memory data */ 319*37da2899SCharles.Forsyth FT_BASE( void ) 320*37da2899SCharles.Forsyth FT_Stream_OpenMemory( FT_Stream stream, 321*37da2899SCharles.Forsyth const FT_Byte* base, 322*37da2899SCharles.Forsyth FT_ULong size ); 323*37da2899SCharles.Forsyth 324*37da2899SCharles.Forsyth /* close a stream (does not destroy the stream structure) */ 325*37da2899SCharles.Forsyth FT_BASE( void ) 326*37da2899SCharles.Forsyth FT_Stream_Close( FT_Stream stream ); 327*37da2899SCharles.Forsyth 328*37da2899SCharles.Forsyth 329*37da2899SCharles.Forsyth /* seek within a stream. position is relative to start of stream */ 330*37da2899SCharles.Forsyth FT_BASE( FT_Error ) 331*37da2899SCharles.Forsyth FT_Stream_Seek( FT_Stream stream, 332*37da2899SCharles.Forsyth FT_ULong pos ); 333*37da2899SCharles.Forsyth 334*37da2899SCharles.Forsyth /* skip bytes in a stream */ 335*37da2899SCharles.Forsyth FT_BASE( FT_Error ) 336*37da2899SCharles.Forsyth FT_Stream_Skip( FT_Stream stream, 337*37da2899SCharles.Forsyth FT_Long distance ); 338*37da2899SCharles.Forsyth 339*37da2899SCharles.Forsyth /* return current stream position */ 340*37da2899SCharles.Forsyth FT_BASE( FT_Long ) 341*37da2899SCharles.Forsyth FT_Stream_Pos( FT_Stream stream ); 342*37da2899SCharles.Forsyth 343*37da2899SCharles.Forsyth /* read bytes from a stream into a user-allocated buffer, returns an */ 344*37da2899SCharles.Forsyth /* error if not all bytes could be read. */ 345*37da2899SCharles.Forsyth FT_BASE( FT_Error ) 346*37da2899SCharles.Forsyth FT_Stream_Read( FT_Stream stream, 347*37da2899SCharles.Forsyth FT_Byte* buffer, 348*37da2899SCharles.Forsyth FT_ULong count ); 349*37da2899SCharles.Forsyth 350*37da2899SCharles.Forsyth /* read bytes from a stream at a given position */ 351*37da2899SCharles.Forsyth FT_BASE( FT_Error ) 352*37da2899SCharles.Forsyth FT_Stream_ReadAt( FT_Stream stream, 353*37da2899SCharles.Forsyth FT_ULong pos, 354*37da2899SCharles.Forsyth FT_Byte* buffer, 355*37da2899SCharles.Forsyth FT_ULong count ); 356*37da2899SCharles.Forsyth 357*37da2899SCharles.Forsyth /* Enter a frame of `count' consecutive bytes in a stream. Returns an */ 358*37da2899SCharles.Forsyth /* error if the frame could not be read/accessed. The caller can use */ 359*37da2899SCharles.Forsyth /* the FT_Stream_Get_XXX functions to retrieve frame data without */ 360*37da2899SCharles.Forsyth /* error checks. */ 361*37da2899SCharles.Forsyth /* */ 362*37da2899SCharles.Forsyth /* You must _always_ call FT_Stream_ExitFrame() once you have entered */ 363*37da2899SCharles.Forsyth /* a stream frame! */ 364*37da2899SCharles.Forsyth /* */ 365*37da2899SCharles.Forsyth FT_BASE( FT_Error ) 366*37da2899SCharles.Forsyth FT_Stream_EnterFrame( FT_Stream stream, 367*37da2899SCharles.Forsyth FT_ULong count ); 368*37da2899SCharles.Forsyth 369*37da2899SCharles.Forsyth /* exit a stream frame */ 370*37da2899SCharles.Forsyth FT_BASE( void ) 371*37da2899SCharles.Forsyth FT_Stream_ExitFrame( FT_Stream stream ); 372*37da2899SCharles.Forsyth 373*37da2899SCharles.Forsyth /* Extract a stream frame. If the stream is disk-based, a heap block */ 374*37da2899SCharles.Forsyth /* is allocated and the frame bytes are read into it. If the stream */ 375*37da2899SCharles.Forsyth /* is memory-based, this function simply set a pointer to the data. */ 376*37da2899SCharles.Forsyth /* */ 377*37da2899SCharles.Forsyth /* Useful to optimize access to memory-based streams transparently. */ 378*37da2899SCharles.Forsyth /* */ 379*37da2899SCharles.Forsyth /* All extracted frames must be `freed` with a call to the function */ 380*37da2899SCharles.Forsyth /* FT_Stream_ReleaseFrame(). */ 381*37da2899SCharles.Forsyth /* */ 382*37da2899SCharles.Forsyth FT_BASE( FT_Error ) 383*37da2899SCharles.Forsyth FT_Stream_ExtractFrame( FT_Stream stream, 384*37da2899SCharles.Forsyth FT_ULong count, 385*37da2899SCharles.Forsyth FT_Byte** pbytes ); 386*37da2899SCharles.Forsyth 387*37da2899SCharles.Forsyth /* release an extract frame (see FT_Stream_ExtractFrame) */ 388*37da2899SCharles.Forsyth FT_BASE( void ) 389*37da2899SCharles.Forsyth FT_Stream_ReleaseFrame( FT_Stream stream, 390*37da2899SCharles.Forsyth FT_Byte** pbytes ); 391*37da2899SCharles.Forsyth 392*37da2899SCharles.Forsyth /* read a byte from an entered frame */ 393*37da2899SCharles.Forsyth FT_BASE( FT_Char ) 394*37da2899SCharles.Forsyth FT_Stream_GetChar( FT_Stream stream ); 395*37da2899SCharles.Forsyth 396*37da2899SCharles.Forsyth /* read a 16-bit big-endian integer from an entered frame */ 397*37da2899SCharles.Forsyth FT_BASE( FT_Short ) 398*37da2899SCharles.Forsyth FT_Stream_GetShort( FT_Stream stream ); 399*37da2899SCharles.Forsyth 400*37da2899SCharles.Forsyth /* read a 24-bit big-endian integer from an entered frame */ 401*37da2899SCharles.Forsyth FT_BASE( FT_Long ) 402*37da2899SCharles.Forsyth FT_Stream_GetOffset( FT_Stream stream ); 403*37da2899SCharles.Forsyth 404*37da2899SCharles.Forsyth /* read a 32-bit big-endian integer from an entered frame */ 405*37da2899SCharles.Forsyth FT_BASE( FT_Long ) 406*37da2899SCharles.Forsyth FT_Stream_GetLong( FT_Stream stream ); 407*37da2899SCharles.Forsyth 408*37da2899SCharles.Forsyth /* read a 16-bit little-endian integer from an entered frame */ 409*37da2899SCharles.Forsyth FT_BASE( FT_Short ) 410*37da2899SCharles.Forsyth FT_Stream_GetShortLE( FT_Stream stream ); 411*37da2899SCharles.Forsyth 412*37da2899SCharles.Forsyth /* read a 32-bit little-endian integer from an entered frame */ 413*37da2899SCharles.Forsyth FT_BASE( FT_Long ) 414*37da2899SCharles.Forsyth FT_Stream_GetLongLE( FT_Stream stream ); 415*37da2899SCharles.Forsyth 416*37da2899SCharles.Forsyth 417*37da2899SCharles.Forsyth /* read a byte from a stream */ 418*37da2899SCharles.Forsyth FT_BASE( FT_Char ) 419*37da2899SCharles.Forsyth FT_Stream_ReadChar( FT_Stream stream, 420*37da2899SCharles.Forsyth FT_Error* error ); 421*37da2899SCharles.Forsyth 422*37da2899SCharles.Forsyth /* read a 16-bit big-endian integer from a stream */ 423*37da2899SCharles.Forsyth FT_BASE( FT_Short ) 424*37da2899SCharles.Forsyth FT_Stream_ReadShort( FT_Stream stream, 425*37da2899SCharles.Forsyth FT_Error* error ); 426*37da2899SCharles.Forsyth 427*37da2899SCharles.Forsyth /* read a 24-bit big-endian integer from a stream */ 428*37da2899SCharles.Forsyth FT_BASE( FT_Long ) 429*37da2899SCharles.Forsyth FT_Stream_ReadOffset( FT_Stream stream, 430*37da2899SCharles.Forsyth FT_Error* error ); 431*37da2899SCharles.Forsyth 432*37da2899SCharles.Forsyth /* read a 32-bit big-endian integer from a stream */ 433*37da2899SCharles.Forsyth FT_BASE( FT_Long ) 434*37da2899SCharles.Forsyth FT_Stream_ReadLong( FT_Stream stream, 435*37da2899SCharles.Forsyth FT_Error* error ); 436*37da2899SCharles.Forsyth 437*37da2899SCharles.Forsyth /* read a 16-bit little-endian integer from a stream */ 438*37da2899SCharles.Forsyth FT_BASE( FT_Short ) 439*37da2899SCharles.Forsyth FT_Stream_ReadShortLE( FT_Stream stream, 440*37da2899SCharles.Forsyth FT_Error* error ); 441*37da2899SCharles.Forsyth 442*37da2899SCharles.Forsyth /* read a 32-bit little-endian integer from a stream */ 443*37da2899SCharles.Forsyth FT_BASE( FT_Long ) 444*37da2899SCharles.Forsyth FT_Stream_ReadLongLE( FT_Stream stream, 445*37da2899SCharles.Forsyth FT_Error* error ); 446*37da2899SCharles.Forsyth 447*37da2899SCharles.Forsyth /* Read a structure from a stream. The structure must be described */ 448*37da2899SCharles.Forsyth /* by an array of FT_Frame_Field records. */ 449*37da2899SCharles.Forsyth FT_BASE( FT_Error ) 450*37da2899SCharles.Forsyth FT_Stream_ReadFields( FT_Stream stream, 451*37da2899SCharles.Forsyth const FT_Frame_Field* fields, 452*37da2899SCharles.Forsyth void* structure ); 453*37da2899SCharles.Forsyth 454*37da2899SCharles.Forsyth 455*37da2899SCharles.Forsyth #define FT_STREAM_POS() \ 456*37da2899SCharles.Forsyth FT_Stream_Pos( stream ) 457*37da2899SCharles.Forsyth 458*37da2899SCharles.Forsyth #define FT_STREAM_SEEK( position ) \ 459*37da2899SCharles.Forsyth FT_SET_ERROR( FT_Stream_Seek( stream, position ) ) 460*37da2899SCharles.Forsyth 461*37da2899SCharles.Forsyth #define FT_STREAM_SKIP( distance ) \ 462*37da2899SCharles.Forsyth FT_SET_ERROR( FT_Stream_Skip( stream, distance ) ) 463*37da2899SCharles.Forsyth 464*37da2899SCharles.Forsyth #define FT_STREAM_READ( buffer, count ) \ 465*37da2899SCharles.Forsyth FT_SET_ERROR( FT_Stream_Read( stream, \ 466*37da2899SCharles.Forsyth (FT_Byte*)buffer, \ 467*37da2899SCharles.Forsyth count ) ) 468*37da2899SCharles.Forsyth 469*37da2899SCharles.Forsyth #define FT_STREAM_READ_AT( position, buffer, count ) \ 470*37da2899SCharles.Forsyth FT_SET_ERROR( FT_Stream_ReadAt( stream, \ 471*37da2899SCharles.Forsyth position, \ 472*37da2899SCharles.Forsyth (FT_Byte*)buffer, \ 473*37da2899SCharles.Forsyth count ) ) 474*37da2899SCharles.Forsyth 475*37da2899SCharles.Forsyth #define FT_STREAM_READ_FIELDS( fields, object ) \ 476*37da2899SCharles.Forsyth FT_SET_ERROR( FT_Stream_ReadFields( stream, fields, object ) ) 477*37da2899SCharles.Forsyth 478*37da2899SCharles.Forsyth 479*37da2899SCharles.Forsyth #define FT_FRAME_ENTER( size ) \ 480*37da2899SCharles.Forsyth FT_SET_ERROR( FT_Stream_EnterFrame( stream, size ) ) 481*37da2899SCharles.Forsyth 482*37da2899SCharles.Forsyth #define FT_FRAME_EXIT() \ 483*37da2899SCharles.Forsyth FT_Stream_ExitFrame( stream ) 484*37da2899SCharles.Forsyth 485*37da2899SCharles.Forsyth #define FT_FRAME_EXTRACT( size, bytes ) \ 486*37da2899SCharles.Forsyth FT_SET_ERROR( FT_Stream_ExtractFrame( stream, size, \ 487*37da2899SCharles.Forsyth (FT_Byte**)&(bytes) ) ) 488*37da2899SCharles.Forsyth 489*37da2899SCharles.Forsyth #define FT_FRAME_RELEASE( bytes ) \ 490*37da2899SCharles.Forsyth FT_Stream_ReleaseFrame( stream, (FT_Byte**)&(bytes) ) 491*37da2899SCharles.Forsyth 492*37da2899SCharles.Forsyth 493*37da2899SCharles.Forsyth FT_END_HEADER 494*37da2899SCharles.Forsyth 495*37da2899SCharles.Forsyth #endif /* __FTSTREAM_H__ */ 496*37da2899SCharles.Forsyth 497*37da2899SCharles.Forsyth 498*37da2899SCharles.Forsyth /* END */ 499