nuclear@0: /***************************************************************************/ nuclear@0: /* */ nuclear@0: /* ftstream.h */ nuclear@0: /* */ nuclear@0: /* Stream handling (specification). */ nuclear@0: /* */ nuclear@0: /* Copyright 1996-2001, 2002, 2004, 2005, 2006 by */ nuclear@0: /* David Turner, Robert Wilhelm, and Werner Lemberg. */ nuclear@0: /* */ nuclear@0: /* This file is part of the FreeType project, and may only be used, */ nuclear@0: /* modified, and distributed under the terms of the FreeType project */ nuclear@0: /* license, LICENSE.TXT. By continuing to use, modify, or distribute */ nuclear@0: /* this file you indicate that you have read the license and */ nuclear@0: /* understand and accept it fully. */ nuclear@0: /* */ nuclear@0: /***************************************************************************/ nuclear@0: nuclear@0: nuclear@0: #ifndef __FTSTREAM_H__ nuclear@0: #define __FTSTREAM_H__ nuclear@0: nuclear@0: nuclear@0: #include nuclear@0: #include FT_SYSTEM_H nuclear@0: #include FT_INTERNAL_OBJECTS_H nuclear@0: nuclear@0: nuclear@0: FT_BEGIN_HEADER nuclear@0: nuclear@0: nuclear@0: /* format of an 8-bit frame_op value: */ nuclear@0: /* */ nuclear@0: /* bit 76543210 */ nuclear@0: /* xxxxxxes */ nuclear@0: /* */ nuclear@0: /* s is set to 1 if the value is signed. */ nuclear@0: /* e is set to 1 if the value is little-endian. */ nuclear@0: /* xxx is a command. */ nuclear@0: nuclear@0: #define FT_FRAME_OP_SHIFT 2 nuclear@0: #define FT_FRAME_OP_SIGNED 1 nuclear@0: #define FT_FRAME_OP_LITTLE 2 nuclear@0: #define FT_FRAME_OP_COMMAND( x ) ( x >> FT_FRAME_OP_SHIFT ) nuclear@0: nuclear@0: #define FT_MAKE_FRAME_OP( command, little, sign ) \ nuclear@0: ( ( command << FT_FRAME_OP_SHIFT ) | ( little << 1 ) | sign ) nuclear@0: nuclear@0: #define FT_FRAME_OP_END 0 nuclear@0: #define FT_FRAME_OP_START 1 /* start a new frame */ nuclear@0: #define FT_FRAME_OP_BYTE 2 /* read 1-byte value */ nuclear@0: #define FT_FRAME_OP_SHORT 3 /* read 2-byte value */ nuclear@0: #define FT_FRAME_OP_LONG 4 /* read 4-byte value */ nuclear@0: #define FT_FRAME_OP_OFF3 5 /* read 3-byte value */ nuclear@0: #define FT_FRAME_OP_BYTES 6 /* read a bytes sequence */ nuclear@0: nuclear@0: nuclear@0: typedef enum FT_Frame_Op_ nuclear@0: { nuclear@0: ft_frame_end = 0, nuclear@0: ft_frame_start = FT_MAKE_FRAME_OP( FT_FRAME_OP_START, 0, 0 ), nuclear@0: nuclear@0: ft_frame_byte = FT_MAKE_FRAME_OP( FT_FRAME_OP_BYTE, 0, 0 ), nuclear@0: ft_frame_schar = FT_MAKE_FRAME_OP( FT_FRAME_OP_BYTE, 0, 1 ), nuclear@0: nuclear@0: ft_frame_ushort_be = FT_MAKE_FRAME_OP( FT_FRAME_OP_SHORT, 0, 0 ), nuclear@0: ft_frame_short_be = FT_MAKE_FRAME_OP( FT_FRAME_OP_SHORT, 0, 1 ), nuclear@0: ft_frame_ushort_le = FT_MAKE_FRAME_OP( FT_FRAME_OP_SHORT, 1, 0 ), nuclear@0: ft_frame_short_le = FT_MAKE_FRAME_OP( FT_FRAME_OP_SHORT, 1, 1 ), nuclear@0: nuclear@0: ft_frame_ulong_be = FT_MAKE_FRAME_OP( FT_FRAME_OP_LONG, 0, 0 ), nuclear@0: ft_frame_long_be = FT_MAKE_FRAME_OP( FT_FRAME_OP_LONG, 0, 1 ), nuclear@0: ft_frame_ulong_le = FT_MAKE_FRAME_OP( FT_FRAME_OP_LONG, 1, 0 ), nuclear@0: ft_frame_long_le = FT_MAKE_FRAME_OP( FT_FRAME_OP_LONG, 1, 1 ), nuclear@0: nuclear@0: ft_frame_uoff3_be = FT_MAKE_FRAME_OP( FT_FRAME_OP_OFF3, 0, 0 ), nuclear@0: ft_frame_off3_be = FT_MAKE_FRAME_OP( FT_FRAME_OP_OFF3, 0, 1 ), nuclear@0: ft_frame_uoff3_le = FT_MAKE_FRAME_OP( FT_FRAME_OP_OFF3, 1, 0 ), nuclear@0: ft_frame_off3_le = FT_MAKE_FRAME_OP( FT_FRAME_OP_OFF3, 1, 1 ), nuclear@0: nuclear@0: ft_frame_bytes = FT_MAKE_FRAME_OP( FT_FRAME_OP_BYTES, 0, 0 ), nuclear@0: ft_frame_skip = FT_MAKE_FRAME_OP( FT_FRAME_OP_BYTES, 0, 1 ) nuclear@0: nuclear@0: } FT_Frame_Op; nuclear@0: nuclear@0: nuclear@0: typedef struct FT_Frame_Field_ nuclear@0: { nuclear@0: FT_Byte value; nuclear@0: FT_Byte size; nuclear@0: FT_UShort offset; nuclear@0: nuclear@0: } FT_Frame_Field; nuclear@0: nuclear@0: nuclear@0: /* Construct an FT_Frame_Field out of a structure type and a field name. */ nuclear@0: /* The structure type must be set in the FT_STRUCTURE macro before */ nuclear@0: /* calling the FT_FRAME_START() macro. */ nuclear@0: /* */ nuclear@0: #define FT_FIELD_SIZE( f ) \ nuclear@0: (FT_Byte)sizeof ( ((FT_STRUCTURE*)0)->f ) nuclear@0: nuclear@0: #define FT_FIELD_SIZE_DELTA( f ) \ nuclear@0: (FT_Byte)sizeof ( ((FT_STRUCTURE*)0)->f[0] ) nuclear@0: nuclear@0: #define FT_FIELD_OFFSET( f ) \ nuclear@0: (FT_UShort)( offsetof( FT_STRUCTURE, f ) ) nuclear@0: nuclear@0: #define FT_FRAME_FIELD( frame_op, field ) \ nuclear@0: { \ nuclear@0: frame_op, \ nuclear@0: FT_FIELD_SIZE( field ), \ nuclear@0: FT_FIELD_OFFSET( field ) \ nuclear@0: } nuclear@0: nuclear@0: #define FT_MAKE_EMPTY_FIELD( frame_op ) { frame_op, 0, 0 } nuclear@0: nuclear@0: #define FT_FRAME_START( size ) { ft_frame_start, 0, size } nuclear@0: #define FT_FRAME_END { ft_frame_end, 0, 0 } nuclear@0: nuclear@0: #define FT_FRAME_LONG( f ) FT_FRAME_FIELD( ft_frame_long_be, f ) nuclear@0: #define FT_FRAME_ULONG( f ) FT_FRAME_FIELD( ft_frame_ulong_be, f ) nuclear@0: #define FT_FRAME_SHORT( f ) FT_FRAME_FIELD( ft_frame_short_be, f ) nuclear@0: #define FT_FRAME_USHORT( f ) FT_FRAME_FIELD( ft_frame_ushort_be, f ) nuclear@0: #define FT_FRAME_OFF3( f ) FT_FRAME_FIELD( ft_frame_off3_be, f ) nuclear@0: #define FT_FRAME_UOFF3( f ) FT_FRAME_FIELD( ft_frame_uoff3_be, f ) nuclear@0: #define FT_FRAME_BYTE( f ) FT_FRAME_FIELD( ft_frame_byte, f ) nuclear@0: #define FT_FRAME_CHAR( f ) FT_FRAME_FIELD( ft_frame_schar, f ) nuclear@0: nuclear@0: #define FT_FRAME_LONG_LE( f ) FT_FRAME_FIELD( ft_frame_long_le, f ) nuclear@0: #define FT_FRAME_ULONG_LE( f ) FT_FRAME_FIELD( ft_frame_ulong_le, f ) nuclear@0: #define FT_FRAME_SHORT_LE( f ) FT_FRAME_FIELD( ft_frame_short_le, f ) nuclear@0: #define FT_FRAME_USHORT_LE( f ) FT_FRAME_FIELD( ft_frame_ushort_le, f ) nuclear@0: #define FT_FRAME_OFF3_LE( f ) FT_FRAME_FIELD( ft_frame_off3_le, f ) nuclear@0: #define FT_FRAME_UOFF3_LE( f ) FT_FRAME_FIELD( ft_frame_uoff3_le, f ) nuclear@0: nuclear@0: #define FT_FRAME_SKIP_LONG { ft_frame_long_be, 0, 0 } nuclear@0: #define FT_FRAME_SKIP_SHORT { ft_frame_short_be, 0, 0 } nuclear@0: #define FT_FRAME_SKIP_BYTE { ft_frame_byte, 0, 0 } nuclear@0: nuclear@0: #define FT_FRAME_BYTES( field, count ) \ nuclear@0: { \ nuclear@0: ft_frame_bytes, \ nuclear@0: count, \ nuclear@0: FT_FIELD_OFFSET( field ) \ nuclear@0: } nuclear@0: nuclear@0: #define FT_FRAME_SKIP_BYTES( count ) { ft_frame_skip, count, 0 } nuclear@0: nuclear@0: nuclear@0: /*************************************************************************/ nuclear@0: /* */ nuclear@0: /* Integer extraction macros -- the `buffer' parameter must ALWAYS be of */ nuclear@0: /* type `char*' or equivalent (1-byte elements). */ nuclear@0: /* */ nuclear@0: nuclear@0: #define FT_BYTE_( p, i ) ( ((const FT_Byte*)(p))[(i)] ) nuclear@0: #define FT_INT8_( p, i ) ( ((const FT_Char*)(p))[(i)] ) nuclear@0: nuclear@0: #define FT_INT16( x ) ( (FT_Int16)(x) ) nuclear@0: #define FT_UINT16( x ) ( (FT_UInt16)(x) ) nuclear@0: #define FT_INT32( x ) ( (FT_Int32)(x) ) nuclear@0: #define FT_UINT32( x ) ( (FT_UInt32)(x) ) nuclear@0: nuclear@0: #define FT_BYTE_I16( p, i, s ) ( FT_INT16( FT_BYTE_( p, i ) ) << (s) ) nuclear@0: #define FT_BYTE_U16( p, i, s ) ( FT_UINT16( FT_BYTE_( p, i ) ) << (s) ) nuclear@0: #define FT_BYTE_I32( p, i, s ) ( FT_INT32( FT_BYTE_( p, i ) ) << (s) ) nuclear@0: #define FT_BYTE_U32( p, i, s ) ( FT_UINT32( FT_BYTE_( p, i ) ) << (s) ) nuclear@0: nuclear@0: #define FT_INT8_I16( p, i, s ) ( FT_INT16( FT_INT8_( p, i ) ) << (s) ) nuclear@0: #define FT_INT8_U16( p, i, s ) ( FT_UINT16( FT_INT8_( p, i ) ) << (s) ) nuclear@0: #define FT_INT8_I32( p, i, s ) ( FT_INT32( FT_INT8_( p, i ) ) << (s) ) nuclear@0: #define FT_INT8_U32( p, i, s ) ( FT_UINT32( FT_INT8_( p, i ) ) << (s) ) nuclear@0: nuclear@0: nuclear@0: #define FT_PEEK_SHORT( p ) FT_INT16( FT_INT8_I16( p, 0, 8) | \ nuclear@0: FT_BYTE_I16( p, 1, 0) ) nuclear@0: nuclear@0: #define FT_PEEK_USHORT( p ) FT_UINT16( FT_BYTE_U16( p, 0, 8 ) | \ nuclear@0: FT_BYTE_U16( p, 1, 0 ) ) nuclear@0: nuclear@0: #define FT_PEEK_LONG( p ) FT_INT32( FT_INT8_I32( p, 0, 24 ) | \ nuclear@0: FT_BYTE_I32( p, 1, 16 ) | \ nuclear@0: FT_BYTE_I32( p, 2, 8 ) | \ nuclear@0: FT_BYTE_I32( p, 3, 0 ) ) nuclear@0: nuclear@0: #define FT_PEEK_ULONG( p ) FT_UINT32( FT_BYTE_U32( p, 0, 24 ) | \ nuclear@0: FT_BYTE_U32( p, 1, 16 ) | \ nuclear@0: FT_BYTE_U32( p, 2, 8 ) | \ nuclear@0: FT_BYTE_U32( p, 3, 0 ) ) nuclear@0: nuclear@0: #define FT_PEEK_OFF3( p ) FT_INT32( FT_INT8_I32( p, 0, 16 ) | \ nuclear@0: FT_BYTE_I32( p, 1, 8 ) | \ nuclear@0: FT_BYTE_I32( p, 2, 0 ) ) nuclear@0: nuclear@0: #define FT_PEEK_UOFF3( p ) FT_UINT32( FT_BYTE_U32( p, 0, 16 ) | \ nuclear@0: FT_BYTE_U32( p, 1, 8 ) | \ nuclear@0: FT_BYTE_U32( p, 2, 0 ) ) nuclear@0: nuclear@0: #define FT_PEEK_SHORT_LE( p ) FT_INT16( FT_INT8_I16( p, 1, 8 ) | \ nuclear@0: FT_BYTE_I16( p, 0, 0 ) ) nuclear@0: nuclear@0: #define FT_PEEK_USHORT_LE( p ) FT_UINT16( FT_BYTE_U16( p, 1, 8 ) | \ nuclear@0: FT_BYTE_U16( p, 0, 0 ) ) nuclear@0: nuclear@0: #define FT_PEEK_LONG_LE( p ) FT_INT32( FT_INT8_I32( p, 3, 24 ) | \ nuclear@0: FT_BYTE_I32( p, 2, 16 ) | \ nuclear@0: FT_BYTE_I32( p, 1, 8 ) | \ nuclear@0: FT_BYTE_I32( p, 0, 0 ) ) nuclear@0: nuclear@0: #define FT_PEEK_ULONG_LE( p ) FT_UINT32( FT_BYTE_U32( p, 3, 24 ) | \ nuclear@0: FT_BYTE_U32( p, 2, 16 ) | \ nuclear@0: FT_BYTE_U32( p, 1, 8 ) | \ nuclear@0: FT_BYTE_U32( p, 0, 0 ) ) nuclear@0: nuclear@0: #define FT_PEEK_OFF3_LE( p ) FT_INT32( FT_INT8_I32( p, 2, 16 ) | \ nuclear@0: FT_BYTE_I32( p, 1, 8 ) | \ nuclear@0: FT_BYTE_I32( p, 0, 0 ) ) nuclear@0: nuclear@0: #define FT_PEEK_UOFF3_LE( p ) FT_UINT32( FT_BYTE_U32( p, 2, 16 ) | \ nuclear@0: FT_BYTE_U32( p, 1, 8 ) | \ nuclear@0: FT_BYTE_U32( p, 0, 0 ) ) nuclear@0: nuclear@0: nuclear@0: #define FT_NEXT_CHAR( buffer ) \ nuclear@0: ( (signed char)*buffer++ ) nuclear@0: nuclear@0: #define FT_NEXT_BYTE( buffer ) \ nuclear@0: ( (unsigned char)*buffer++ ) nuclear@0: nuclear@0: #define FT_NEXT_SHORT( buffer ) \ nuclear@0: ( (short)( buffer += 2, FT_PEEK_SHORT( buffer - 2 ) ) ) nuclear@0: nuclear@0: #define FT_NEXT_USHORT( buffer ) \ nuclear@0: ( (unsigned short)( buffer += 2, FT_PEEK_USHORT( buffer - 2 ) ) ) nuclear@0: nuclear@0: #define FT_NEXT_OFF3( buffer ) \ nuclear@0: ( (long)( buffer += 3, FT_PEEK_OFF3( buffer - 3 ) ) ) nuclear@0: nuclear@0: #define FT_NEXT_UOFF3( buffer ) \ nuclear@0: ( (unsigned long)( buffer += 3, FT_PEEK_UOFF3( buffer - 3 ) ) ) nuclear@0: nuclear@0: #define FT_NEXT_LONG( buffer ) \ nuclear@0: ( (long)( buffer += 4, FT_PEEK_LONG( buffer - 4 ) ) ) nuclear@0: nuclear@0: #define FT_NEXT_ULONG( buffer ) \ nuclear@0: ( (unsigned long)( buffer += 4, FT_PEEK_ULONG( buffer - 4 ) ) ) nuclear@0: nuclear@0: nuclear@0: #define FT_NEXT_SHORT_LE( buffer ) \ nuclear@0: ( (short)( buffer += 2, FT_PEEK_SHORT_LE( buffer - 2 ) ) ) nuclear@0: nuclear@0: #define FT_NEXT_USHORT_LE( buffer ) \ nuclear@0: ( (unsigned short)( buffer += 2, FT_PEEK_USHORT_LE( buffer - 2 ) ) ) nuclear@0: nuclear@0: #define FT_NEXT_OFF3_LE( buffer ) \ nuclear@0: ( (long)( buffer += 3, FT_PEEK_OFF3_LE( buffer - 3 ) ) ) nuclear@0: nuclear@0: #define FT_NEXT_UOFF3_LE( buffer ) \ nuclear@0: ( (unsigned long)( buffer += 3, FT_PEEK_UOFF3_LE( buffer - 3 ) ) ) nuclear@0: nuclear@0: #define FT_NEXT_LONG_LE( buffer ) \ nuclear@0: ( (long)( buffer += 4, FT_PEEK_LONG_LE( buffer - 4 ) ) ) nuclear@0: nuclear@0: #define FT_NEXT_ULONG_LE( buffer ) \ nuclear@0: ( (unsigned long)( buffer += 4, FT_PEEK_ULONG_LE( buffer - 4 ) ) ) nuclear@0: nuclear@0: nuclear@0: /*************************************************************************/ nuclear@0: /* */ nuclear@0: /* Each GET_xxxx() macro uses an implicit `stream' variable. */ nuclear@0: /* */ nuclear@0: #if 0 nuclear@0: #define FT_GET_MACRO( type ) FT_NEXT_ ## type ( stream->cursor ) nuclear@0: nuclear@0: #define FT_GET_CHAR() FT_GET_MACRO( CHAR ) nuclear@0: #define FT_GET_BYTE() FT_GET_MACRO( BYTE ) nuclear@0: #define FT_GET_SHORT() FT_GET_MACRO( SHORT ) nuclear@0: #define FT_GET_USHORT() FT_GET_MACRO( USHORT ) nuclear@0: #define FT_GET_OFF3() FT_GET_MACRO( OFF3 ) nuclear@0: #define FT_GET_UOFF3() FT_GET_MACRO( UOFF3 ) nuclear@0: #define FT_GET_LONG() FT_GET_MACRO( LONG ) nuclear@0: #define FT_GET_ULONG() FT_GET_MACRO( ULONG ) nuclear@0: #define FT_GET_TAG4() FT_GET_MACRO( ULONG ) nuclear@0: nuclear@0: #define FT_GET_SHORT_LE() FT_GET_MACRO( SHORT_LE ) nuclear@0: #define FT_GET_USHORT_LE() FT_GET_MACRO( USHORT_LE ) nuclear@0: #define FT_GET_LONG_LE() FT_GET_MACRO( LONG_LE ) nuclear@0: #define FT_GET_ULONG_LE() FT_GET_MACRO( ULONG_LE ) nuclear@0: nuclear@0: #else nuclear@0: #define FT_GET_MACRO( func, type ) ( (type)func( stream ) ) nuclear@0: nuclear@0: #define FT_GET_CHAR() FT_GET_MACRO( FT_Stream_GetChar, FT_Char ) nuclear@0: #define FT_GET_BYTE() FT_GET_MACRO( FT_Stream_GetChar, FT_Byte ) nuclear@0: #define FT_GET_SHORT() FT_GET_MACRO( FT_Stream_GetShort, FT_Short ) nuclear@0: #define FT_GET_USHORT() FT_GET_MACRO( FT_Stream_GetShort, FT_UShort ) nuclear@0: #define FT_GET_OFF3() FT_GET_MACRO( FT_Stream_GetOffset, FT_Long ) nuclear@0: #define FT_GET_UOFF3() FT_GET_MACRO( FT_Stream_GetOffset, FT_ULong ) nuclear@0: #define FT_GET_LONG() FT_GET_MACRO( FT_Stream_GetLong, FT_Long ) nuclear@0: #define FT_GET_ULONG() FT_GET_MACRO( FT_Stream_GetLong, FT_ULong ) nuclear@0: #define FT_GET_TAG4() FT_GET_MACRO( FT_Stream_GetLong, FT_ULong ) nuclear@0: nuclear@0: #define FT_GET_SHORT_LE() FT_GET_MACRO( FT_Stream_GetShortLE, FT_Short ) nuclear@0: #define FT_GET_USHORT_LE() FT_GET_MACRO( FT_Stream_GetShortLE, FT_UShort ) nuclear@0: #define FT_GET_LONG_LE() FT_GET_MACRO( FT_Stream_GetLongLE, FT_Long ) nuclear@0: #define FT_GET_ULONG_LE() FT_GET_MACRO( FT_Stream_GetLongLE, FT_ULong ) nuclear@0: #endif nuclear@0: nuclear@0: #define FT_READ_MACRO( func, type, var ) \ nuclear@0: ( var = (type)func( stream, &error ), \ nuclear@0: error != FT_Err_Ok ) nuclear@0: nuclear@0: #define FT_READ_BYTE( var ) FT_READ_MACRO( FT_Stream_ReadChar, FT_Byte, var ) nuclear@0: #define FT_READ_CHAR( var ) FT_READ_MACRO( FT_Stream_ReadChar, FT_Char, var ) nuclear@0: #define FT_READ_SHORT( var ) FT_READ_MACRO( FT_Stream_ReadShort, FT_Short, var ) nuclear@0: #define FT_READ_USHORT( var ) FT_READ_MACRO( FT_Stream_ReadShort, FT_UShort, var ) nuclear@0: #define FT_READ_OFF3( var ) FT_READ_MACRO( FT_Stream_ReadOffset, FT_Long, var ) nuclear@0: #define FT_READ_UOFF3( var ) FT_READ_MACRO( FT_Stream_ReadOffset, FT_ULong, var ) nuclear@0: #define FT_READ_LONG( var ) FT_READ_MACRO( FT_Stream_ReadLong, FT_Long, var ) nuclear@0: #define FT_READ_ULONG( var ) FT_READ_MACRO( FT_Stream_ReadLong, FT_ULong, var ) nuclear@0: nuclear@0: #define FT_READ_SHORT_LE( var ) FT_READ_MACRO( FT_Stream_ReadShortLE, FT_Short, var ) nuclear@0: #define FT_READ_USHORT_LE( var ) FT_READ_MACRO( FT_Stream_ReadShortLE, FT_UShort, var ) nuclear@0: #define FT_READ_LONG_LE( var ) FT_READ_MACRO( FT_Stream_ReadLongLE, FT_Long, var ) nuclear@0: #define FT_READ_ULONG_LE( var ) FT_READ_MACRO( FT_Stream_ReadLongLE, FT_ULong, var ) nuclear@0: nuclear@0: nuclear@0: #ifndef FT_CONFIG_OPTION_NO_DEFAULT_SYSTEM nuclear@0: nuclear@0: /* initialize a stream for reading a regular system stream */ nuclear@0: FT_BASE( FT_Error ) nuclear@0: FT_Stream_Open( FT_Stream stream, nuclear@0: const char* filepathname ); nuclear@0: nuclear@0: #endif /* FT_CONFIG_OPTION_NO_DEFAULT_SYSTEM */ nuclear@0: nuclear@0: nuclear@0: /* create a new (input) stream from an FT_Open_Args structure */ nuclear@0: FT_BASE( FT_Error ) nuclear@0: FT_Stream_New( FT_Library library, nuclear@0: const FT_Open_Args* args, nuclear@0: FT_Stream *astream ); nuclear@0: nuclear@0: /* free a stream */ nuclear@0: FT_BASE( void ) nuclear@0: FT_Stream_Free( FT_Stream stream, nuclear@0: FT_Int external ); nuclear@0: nuclear@0: /* initialize a stream for reading in-memory data */ nuclear@0: FT_BASE( void ) nuclear@0: FT_Stream_OpenMemory( FT_Stream stream, nuclear@0: const FT_Byte* base, nuclear@0: FT_ULong size ); nuclear@0: nuclear@0: /* close a stream (does not destroy the stream structure) */ nuclear@0: FT_BASE( void ) nuclear@0: FT_Stream_Close( FT_Stream stream ); nuclear@0: nuclear@0: nuclear@0: /* seek within a stream. position is relative to start of stream */ nuclear@0: FT_BASE( FT_Error ) nuclear@0: FT_Stream_Seek( FT_Stream stream, nuclear@0: FT_ULong pos ); nuclear@0: nuclear@0: /* skip bytes in a stream */ nuclear@0: FT_BASE( FT_Error ) nuclear@0: FT_Stream_Skip( FT_Stream stream, nuclear@0: FT_Long distance ); nuclear@0: nuclear@0: /* return current stream position */ nuclear@0: FT_BASE( FT_Long ) nuclear@0: FT_Stream_Pos( FT_Stream stream ); nuclear@0: nuclear@0: /* read bytes from a stream into a user-allocated buffer, returns an */ nuclear@0: /* error if not all bytes could be read. */ nuclear@0: FT_BASE( FT_Error ) nuclear@0: FT_Stream_Read( FT_Stream stream, nuclear@0: FT_Byte* buffer, nuclear@0: FT_ULong count ); nuclear@0: nuclear@0: /* read bytes from a stream at a given position */ nuclear@0: FT_BASE( FT_Error ) nuclear@0: FT_Stream_ReadAt( FT_Stream stream, nuclear@0: FT_ULong pos, nuclear@0: FT_Byte* buffer, nuclear@0: FT_ULong count ); nuclear@0: nuclear@0: /* try to read bytes at the end of a stream; return number of bytes */ nuclear@0: /* really available */ nuclear@0: FT_BASE( FT_ULong ) nuclear@0: FT_Stream_TryRead( FT_Stream stream, nuclear@0: FT_Byte* buffer, nuclear@0: FT_ULong count ); nuclear@0: nuclear@0: /* Enter a frame of `count' consecutive bytes in a stream. Returns an */ nuclear@0: /* error if the frame could not be read/accessed. The caller can use */ nuclear@0: /* the FT_Stream_Get_XXX functions to retrieve frame data without */ nuclear@0: /* error checks. */ nuclear@0: /* */ nuclear@0: /* You must _always_ call FT_Stream_ExitFrame() once you have entered */ nuclear@0: /* a stream frame! */ nuclear@0: /* */ nuclear@0: FT_BASE( FT_Error ) nuclear@0: FT_Stream_EnterFrame( FT_Stream stream, nuclear@0: FT_ULong count ); nuclear@0: nuclear@0: /* exit a stream frame */ nuclear@0: FT_BASE( void ) nuclear@0: FT_Stream_ExitFrame( FT_Stream stream ); nuclear@0: nuclear@0: /* Extract a stream frame. If the stream is disk-based, a heap block */ nuclear@0: /* is allocated and the frame bytes are read into it. If the stream */ nuclear@0: /* is memory-based, this function simply set a pointer to the data. */ nuclear@0: /* */ nuclear@0: /* Useful to optimize access to memory-based streams transparently. */ nuclear@0: /* */ nuclear@0: /* All extracted frames must be `freed' with a call to the function */ nuclear@0: /* FT_Stream_ReleaseFrame(). */ nuclear@0: /* */ nuclear@0: FT_BASE( FT_Error ) nuclear@0: FT_Stream_ExtractFrame( FT_Stream stream, nuclear@0: FT_ULong count, nuclear@0: FT_Byte** pbytes ); nuclear@0: nuclear@0: /* release an extract frame (see FT_Stream_ExtractFrame) */ nuclear@0: FT_BASE( void ) nuclear@0: FT_Stream_ReleaseFrame( FT_Stream stream, nuclear@0: FT_Byte** pbytes ); nuclear@0: nuclear@0: /* read a byte from an entered frame */ nuclear@0: FT_BASE( FT_Char ) nuclear@0: FT_Stream_GetChar( FT_Stream stream ); nuclear@0: nuclear@0: /* read a 16-bit big-endian integer from an entered frame */ nuclear@0: FT_BASE( FT_Short ) nuclear@0: FT_Stream_GetShort( FT_Stream stream ); nuclear@0: nuclear@0: /* read a 24-bit big-endian integer from an entered frame */ nuclear@0: FT_BASE( FT_Long ) nuclear@0: FT_Stream_GetOffset( FT_Stream stream ); nuclear@0: nuclear@0: /* read a 32-bit big-endian integer from an entered frame */ nuclear@0: FT_BASE( FT_Long ) nuclear@0: FT_Stream_GetLong( FT_Stream stream ); nuclear@0: nuclear@0: /* read a 16-bit little-endian integer from an entered frame */ nuclear@0: FT_BASE( FT_Short ) nuclear@0: FT_Stream_GetShortLE( FT_Stream stream ); nuclear@0: nuclear@0: /* read a 32-bit little-endian integer from an entered frame */ nuclear@0: FT_BASE( FT_Long ) nuclear@0: FT_Stream_GetLongLE( FT_Stream stream ); nuclear@0: nuclear@0: nuclear@0: /* read a byte from a stream */ nuclear@0: FT_BASE( FT_Char ) nuclear@0: FT_Stream_ReadChar( FT_Stream stream, nuclear@0: FT_Error* error ); nuclear@0: nuclear@0: /* read a 16-bit big-endian integer from a stream */ nuclear@0: FT_BASE( FT_Short ) nuclear@0: FT_Stream_ReadShort( FT_Stream stream, nuclear@0: FT_Error* error ); nuclear@0: nuclear@0: /* read a 24-bit big-endian integer from a stream */ nuclear@0: FT_BASE( FT_Long ) nuclear@0: FT_Stream_ReadOffset( FT_Stream stream, nuclear@0: FT_Error* error ); nuclear@0: nuclear@0: /* read a 32-bit big-endian integer from a stream */ nuclear@0: FT_BASE( FT_Long ) nuclear@0: FT_Stream_ReadLong( FT_Stream stream, nuclear@0: FT_Error* error ); nuclear@0: nuclear@0: /* read a 16-bit little-endian integer from a stream */ nuclear@0: FT_BASE( FT_Short ) nuclear@0: FT_Stream_ReadShortLE( FT_Stream stream, nuclear@0: FT_Error* error ); nuclear@0: nuclear@0: /* read a 32-bit little-endian integer from a stream */ nuclear@0: FT_BASE( FT_Long ) nuclear@0: FT_Stream_ReadLongLE( FT_Stream stream, nuclear@0: FT_Error* error ); nuclear@0: nuclear@0: /* Read a structure from a stream. The structure must be described */ nuclear@0: /* by an array of FT_Frame_Field records. */ nuclear@0: FT_BASE( FT_Error ) nuclear@0: FT_Stream_ReadFields( FT_Stream stream, nuclear@0: const FT_Frame_Field* fields, nuclear@0: void* structure ); nuclear@0: nuclear@0: nuclear@0: #define FT_STREAM_POS() \ nuclear@0: FT_Stream_Pos( stream ) nuclear@0: nuclear@0: #define FT_STREAM_SEEK( position ) \ nuclear@0: FT_SET_ERROR( FT_Stream_Seek( stream, position ) ) nuclear@0: nuclear@0: #define FT_STREAM_SKIP( distance ) \ nuclear@0: FT_SET_ERROR( FT_Stream_Skip( stream, distance ) ) nuclear@0: nuclear@0: #define FT_STREAM_READ( buffer, count ) \ nuclear@0: FT_SET_ERROR( FT_Stream_Read( stream, \ nuclear@0: (FT_Byte*)buffer, \ nuclear@0: count ) ) nuclear@0: nuclear@0: #define FT_STREAM_READ_AT( position, buffer, count ) \ nuclear@0: FT_SET_ERROR( FT_Stream_ReadAt( stream, \ nuclear@0: position, \ nuclear@0: (FT_Byte*)buffer, \ nuclear@0: count ) ) nuclear@0: nuclear@0: #define FT_STREAM_READ_FIELDS( fields, object ) \ nuclear@0: FT_SET_ERROR( FT_Stream_ReadFields( stream, fields, object ) ) nuclear@0: nuclear@0: nuclear@0: #define FT_FRAME_ENTER( size ) \ nuclear@0: FT_SET_ERROR( \ nuclear@0: FT_DEBUG_INNER( FT_Stream_EnterFrame( stream, size ) ) ) nuclear@0: nuclear@0: #define FT_FRAME_EXIT() \ nuclear@0: FT_DEBUG_INNER( FT_Stream_ExitFrame( stream ) ) nuclear@0: nuclear@0: #define FT_FRAME_EXTRACT( size, bytes ) \ nuclear@0: FT_SET_ERROR( \ nuclear@0: FT_DEBUG_INNER( FT_Stream_ExtractFrame( stream, size, \ nuclear@0: (FT_Byte**)&(bytes) ) ) ) nuclear@0: nuclear@0: #define FT_FRAME_RELEASE( bytes ) \ nuclear@0: FT_DEBUG_INNER( FT_Stream_ReleaseFrame( stream, \ nuclear@0: (FT_Byte**)&(bytes) ) ) nuclear@0: nuclear@0: nuclear@0: FT_END_HEADER nuclear@0: nuclear@0: #endif /* __FTSTREAM_H__ */ nuclear@0: nuclear@0: nuclear@0: /* END */