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