source: trunk/poppler/freetype2/src/base/ftobjs.c @ 262

Last change on this file since 262 was 262, checked in by Eugene Romanenko, 13 years ago

PDF plugin: freetype library updated to version 2.3.8

File size: 120.9 KB
Line 
1/***************************************************************************/
2/*                                                                         */
3/*  ftobjs.c                                                               */
4/*                                                                         */
5/*    The FreeType private base classes (body).                            */
6/*                                                                         */
7/*  Copyright 1996-2001, 2002, 2003, 2004, 2005, 2006, 2007, 2008, 2009 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#include <ft2build.h>
20#include FT_LIST_H
21#include FT_OUTLINE_H
22#include FT_INTERNAL_VALIDATE_H
23#include FT_INTERNAL_OBJECTS_H
24#include FT_INTERNAL_DEBUG_H
25#include FT_INTERNAL_RFORK_H
26#include FT_INTERNAL_STREAM_H
27#include FT_INTERNAL_SFNT_H    /* for SFNT_Load_Table_Func */
28#include FT_TRUETYPE_TABLES_H
29#include FT_TRUETYPE_TAGS_H
30#include FT_TRUETYPE_IDS_H
31#include FT_OUTLINE_H
32
33#include FT_SERVICE_SFNT_H
34#include FT_SERVICE_POSTSCRIPT_NAME_H
35#include FT_SERVICE_GLYPH_DICT_H
36#include FT_SERVICE_TT_CMAP_H
37#include FT_SERVICE_KERNING_H
38#include FT_SERVICE_TRUETYPE_ENGINE_H
39
40#include "ftbase.h"
41
42#define GRID_FIT_METRICS
43
44
45  FT_BASE_DEF( FT_Pointer )
46  ft_service_list_lookup( FT_ServiceDesc  service_descriptors,
47                          const char*     service_id )
48  {
49    FT_Pointer      result = NULL;
50    FT_ServiceDesc  desc   = service_descriptors;
51
52
53    if ( desc && service_id )
54    {
55      for ( ; desc->serv_id != NULL; desc++ )
56      {
57        if ( ft_strcmp( desc->serv_id, service_id ) == 0 )
58        {
59          result = (FT_Pointer)desc->serv_data;
60          break;
61        }
62      }
63    }
64
65    return result;
66  }
67
68
69  FT_BASE_DEF( void )
70  ft_validator_init( FT_Validator        valid,
71                     const FT_Byte*      base,
72                     const FT_Byte*      limit,
73                     FT_ValidationLevel  level )
74  {
75    valid->base  = base;
76    valid->limit = limit;
77    valid->level = level;
78    valid->error = FT_Err_Ok;
79  }
80
81
82  FT_BASE_DEF( FT_Int )
83  ft_validator_run( FT_Validator  valid )
84  {
85    /* This function doesn't work!  None should call it. */
86    FT_UNUSED( valid );
87
88    return -1;
89  }
90
91
92  FT_BASE_DEF( void )
93  ft_validator_error( FT_Validator  valid,
94                      FT_Error      error )
95  {
96    /* since the cast below also disables the compiler's */
97    /* type check, we introduce a dummy variable, which  */
98    /* will be optimized away                            */
99    volatile ft_jmp_buf* jump_buffer = &valid->jump_buffer;
100
101
102    valid->error = error;
103
104    /* throw away volatileness; use `jump_buffer' or the  */
105    /* compiler may warn about an unused local variable   */
106    ft_longjmp( *(ft_jmp_buf*) jump_buffer, 1 );
107  }
108
109
110  /*************************************************************************/
111  /*************************************************************************/
112  /*************************************************************************/
113  /****                                                                 ****/
114  /****                                                                 ****/
115  /****                           S T R E A M                           ****/
116  /****                                                                 ****/
117  /****                                                                 ****/
118  /*************************************************************************/
119  /*************************************************************************/
120  /*************************************************************************/
121
122
123  /* create a new input stream from an FT_Open_Args structure */
124  /*                                                          */
125  FT_BASE_DEF( FT_Error )
126  FT_Stream_New( FT_Library           library,
127                 const FT_Open_Args*  args,
128                 FT_Stream           *astream )
129  {
130    FT_Error   error;
131    FT_Memory  memory;
132    FT_Stream  stream;
133
134
135    *astream = 0;
136
137    if ( !library )
138      return FT_Err_Invalid_Library_Handle;
139
140    if ( !args )
141      return FT_Err_Invalid_Argument;
142
143    memory   = library->memory;
144
145    if ( FT_NEW( stream ) )
146      goto Exit;
147
148    stream->memory = memory;
149
150    if ( args->flags & FT_OPEN_MEMORY )
151    {
152      /* create a memory-based stream */
153      FT_Stream_OpenMemory( stream,
154                            (const FT_Byte*)args->memory_base,
155                            args->memory_size );
156    }
157    else if ( args->flags & FT_OPEN_PATHNAME )
158    {
159      /* create a normal system stream */
160      error = FT_Stream_Open( stream, args->pathname );
161      stream->pathname.pointer = args->pathname;
162    }
163    else if ( ( args->flags & FT_OPEN_STREAM ) && args->stream )
164    {
165      /* use an existing, user-provided stream */
166
167      /* in this case, we do not need to allocate a new stream object */
168      /* since the caller is responsible for closing it himself       */
169      FT_FREE( stream );
170      stream = args->stream;
171    }
172    else
173      error = FT_Err_Invalid_Argument;
174
175    if ( error )
176      FT_FREE( stream );
177    else
178      stream->memory = memory;  /* just to be certain */
179
180    *astream = stream;
181
182  Exit:
183    return error;
184  }
185
186
187  FT_BASE_DEF( void )
188  FT_Stream_Free( FT_Stream  stream,
189                  FT_Int     external )
190  {
191    if ( stream )
192    {
193      FT_Memory  memory = stream->memory;
194
195
196      FT_Stream_Close( stream );
197
198      if ( !external )
199        FT_FREE( stream );
200    }
201  }
202
203
204  /*************************************************************************/
205  /*                                                                       */
206  /* The macro FT_COMPONENT is used in trace mode.  It is an implicit      */
207  /* parameter of the FT_TRACE() and FT_ERROR() macros, used to print/log  */
208  /* messages during execution.                                            */
209  /*                                                                       */
210#undef  FT_COMPONENT
211#define FT_COMPONENT  trace_objs
212
213
214  /*************************************************************************/
215  /*************************************************************************/
216  /*************************************************************************/
217  /****                                                                 ****/
218  /****                                                                 ****/
219  /****               FACE, SIZE & GLYPH SLOT OBJECTS                   ****/
220  /****                                                                 ****/
221  /****                                                                 ****/
222  /*************************************************************************/
223  /*************************************************************************/
224  /*************************************************************************/
225
226
227  static FT_Error
228  ft_glyphslot_init( FT_GlyphSlot  slot )
229  {
230    FT_Driver         driver = slot->face->driver;
231    FT_Driver_Class   clazz  = driver->clazz;
232    FT_Memory         memory = driver->root.memory;
233    FT_Error          error  = FT_Err_Ok;
234    FT_Slot_Internal  internal;
235
236
237    slot->library = driver->root.library;
238
239    if ( FT_NEW( internal ) )
240      goto Exit;
241
242    slot->internal = internal;
243
244    if ( FT_DRIVER_USES_OUTLINES( driver ) )
245      error = FT_GlyphLoader_New( memory, &internal->loader );
246
247    if ( !error && clazz->init_slot )
248      error = clazz->init_slot( slot );
249
250  Exit:
251    return error;
252  }
253
254
255  FT_BASE_DEF( void )
256  ft_glyphslot_free_bitmap( FT_GlyphSlot  slot )
257  {
258    if ( slot->internal && ( slot->internal->flags & FT_GLYPH_OWN_BITMAP ) )
259    {
260      FT_Memory  memory = FT_FACE_MEMORY( slot->face );
261
262
263      FT_FREE( slot->bitmap.buffer );
264      slot->internal->flags &= ~FT_GLYPH_OWN_BITMAP;
265    }
266    else
267    {
268      /* assume that the bitmap buffer was stolen or not */
269      /* allocated from the heap                         */
270      slot->bitmap.buffer = NULL;
271    }
272  }
273
274
275  FT_BASE_DEF( void )
276  ft_glyphslot_set_bitmap( FT_GlyphSlot  slot,
277                           FT_Byte*      buffer )
278  {
279    ft_glyphslot_free_bitmap( slot );
280
281    slot->bitmap.buffer = buffer;
282
283    FT_ASSERT( (slot->internal->flags & FT_GLYPH_OWN_BITMAP) == 0 );
284  }
285
286
287  FT_BASE_DEF( FT_Error )
288  ft_glyphslot_alloc_bitmap( FT_GlyphSlot  slot,
289                             FT_ULong      size )
290  {
291    FT_Memory  memory = FT_FACE_MEMORY( slot->face );
292    FT_Error   error;
293
294
295    if ( slot->internal->flags & FT_GLYPH_OWN_BITMAP )
296      FT_FREE( slot->bitmap.buffer );
297    else
298      slot->internal->flags |= FT_GLYPH_OWN_BITMAP;
299
300    (void)FT_ALLOC( slot->bitmap.buffer, size );
301    return error;
302  }
303
304
305  static void
306  ft_glyphslot_clear( FT_GlyphSlot  slot )
307  {
308    /* free bitmap if needed */
309    ft_glyphslot_free_bitmap( slot );
310
311    /* clear all public fields in the glyph slot */
312    FT_ZERO( &slot->metrics );
313    FT_ZERO( &slot->outline );
314
315    slot->bitmap.width      = 0;
316    slot->bitmap.rows       = 0;
317    slot->bitmap.pitch      = 0;
318    slot->bitmap.pixel_mode = 0;
319    /* `slot->bitmap.buffer' has been handled by ft_glyphslot_free_bitmap */
320
321    slot->bitmap_left   = 0;
322    slot->bitmap_top    = 0;
323    slot->num_subglyphs = 0;
324    slot->subglyphs     = 0;
325    slot->control_data  = 0;
326    slot->control_len   = 0;
327    slot->other         = 0;
328    slot->format        = FT_GLYPH_FORMAT_NONE;
329
330    slot->linearHoriAdvance = 0;
331    slot->linearVertAdvance = 0;
332    slot->lsb_delta         = 0;
333    slot->rsb_delta         = 0;
334  }
335
336
337  static void
338  ft_glyphslot_done( FT_GlyphSlot  slot )
339  {
340    FT_Driver        driver = slot->face->driver;
341    FT_Driver_Class  clazz  = driver->clazz;
342    FT_Memory        memory = driver->root.memory;
343
344
345    if ( clazz->done_slot )
346      clazz->done_slot( slot );
347
348    /* free bitmap buffer if needed */
349    ft_glyphslot_free_bitmap( slot );
350
351    /* free glyph loader */
352    if ( FT_DRIVER_USES_OUTLINES( driver ) )
353    {
354      FT_GlyphLoader_Done( slot->internal->loader );
355      slot->internal->loader = 0;
356    }
357
358    FT_FREE( slot->internal );
359  }
360
361
362  /* documentation is in ftobjs.h */
363
364  FT_BASE_DEF( FT_Error )
365  FT_New_GlyphSlot( FT_Face        face,
366                    FT_GlyphSlot  *aslot )
367  {
368    FT_Error         error;
369    FT_Driver        driver;
370    FT_Driver_Class  clazz;
371    FT_Memory        memory;
372    FT_GlyphSlot     slot;
373
374
375    if ( !face || !face->driver )
376      return FT_Err_Invalid_Argument;
377
378    driver = face->driver;
379    clazz  = driver->clazz;
380    memory = driver->root.memory;
381
382    FT_TRACE4(( "FT_New_GlyphSlot: Creating new slot object\n" ));
383    if ( !FT_ALLOC( slot, clazz->slot_object_size ) )
384    {
385      slot->face = face;
386
387      error = ft_glyphslot_init( slot );
388      if ( error )
389      {
390        ft_glyphslot_done( slot );
391        FT_FREE( slot );
392        goto Exit;
393      }
394
395      slot->next  = face->glyph;
396      face->glyph = slot;
397
398      if ( aslot )
399        *aslot = slot;
400    }
401    else if ( aslot )
402      *aslot = 0;
403
404
405  Exit:
406    FT_TRACE4(( "FT_New_GlyphSlot: Return %d\n", error ));
407    return error;
408  }
409
410
411  /* documentation is in ftobjs.h */
412
413  FT_BASE_DEF( void )
414  FT_Done_GlyphSlot( FT_GlyphSlot  slot )
415  {
416    if ( slot )
417    {
418      FT_Driver     driver = slot->face->driver;
419      FT_Memory     memory = driver->root.memory;
420      FT_GlyphSlot  prev;
421      FT_GlyphSlot  cur;
422
423
424      /* Remove slot from its parent face's list */
425      prev = NULL;
426      cur  = slot->face->glyph;
427
428      while ( cur )
429      {
430        if ( cur == slot )
431        {
432          if ( !prev )
433            slot->face->glyph = cur->next;
434          else
435            prev->next = cur->next;
436
437          ft_glyphslot_done( slot );
438          FT_FREE( slot );
439          break;
440        }
441        prev = cur;
442        cur  = cur->next;
443      }
444    }
445  }
446
447
448  /* documentation is in freetype.h */
449
450  FT_EXPORT_DEF( void )
451  FT_Set_Transform( FT_Face     face,
452                    FT_Matrix*  matrix,
453                    FT_Vector*  delta )
454  {
455    FT_Face_Internal  internal;
456
457
458    if ( !face )
459      return;
460
461    internal = face->internal;
462
463    internal->transform_flags = 0;
464
465    if ( !matrix )
466    {
467      internal->transform_matrix.xx = 0x10000L;
468      internal->transform_matrix.xy = 0;
469      internal->transform_matrix.yx = 0;
470      internal->transform_matrix.yy = 0x10000L;
471      matrix = &internal->transform_matrix;
472    }
473    else
474      internal->transform_matrix = *matrix;
475
476    /* set transform_flags bit flag 0 if `matrix' isn't the identity */
477    if ( ( matrix->xy | matrix->yx ) ||
478         matrix->xx != 0x10000L      ||
479         matrix->yy != 0x10000L      )
480      internal->transform_flags |= 1;
481
482    if ( !delta )
483    {
484      internal->transform_delta.x = 0;
485      internal->transform_delta.y = 0;
486      delta = &internal->transform_delta;
487    }
488    else
489      internal->transform_delta = *delta;
490
491    /* set transform_flags bit flag 1 if `delta' isn't the null vector */
492    if ( delta->x | delta->y )
493      internal->transform_flags |= 2;
494  }
495
496
497  static FT_Renderer
498  ft_lookup_glyph_renderer( FT_GlyphSlot  slot );
499
500
501#ifdef GRID_FIT_METRICS
502  static void
503  ft_glyphslot_grid_fit_metrics( FT_GlyphSlot  slot,
504                                 FT_Bool       vertical )
505  {
506    FT_Glyph_Metrics*  metrics = &slot->metrics;
507    FT_Pos             right, bottom;
508
509
510    if ( vertical )
511    {
512      metrics->horiBearingX = FT_PIX_FLOOR( metrics->horiBearingX );
513      metrics->horiBearingY = FT_PIX_CEIL ( metrics->horiBearingY );
514
515      right  = FT_PIX_CEIL( metrics->vertBearingX + metrics->width );
516      bottom = FT_PIX_CEIL( metrics->vertBearingY + metrics->height );
517
518      metrics->vertBearingX = FT_PIX_FLOOR( metrics->vertBearingX );
519      metrics->vertBearingY = FT_PIX_FLOOR( metrics->vertBearingY );
520
521      metrics->width  = right - metrics->vertBearingX;
522      metrics->height = bottom - metrics->vertBearingY;
523    }
524    else
525    {
526      metrics->vertBearingX = FT_PIX_FLOOR( metrics->vertBearingX );
527      metrics->vertBearingY = FT_PIX_FLOOR( metrics->vertBearingY );
528
529      right  = FT_PIX_CEIL ( metrics->horiBearingX + metrics->width );
530      bottom = FT_PIX_FLOOR( metrics->horiBearingY - metrics->height );
531
532      metrics->horiBearingX = FT_PIX_FLOOR( metrics->horiBearingX );
533      metrics->horiBearingY = FT_PIX_CEIL ( metrics->horiBearingY );
534
535      metrics->width  = right - metrics->horiBearingX;
536      metrics->height = metrics->horiBearingY - bottom;
537    }
538
539    metrics->horiAdvance = FT_PIX_ROUND( metrics->horiAdvance );
540    metrics->vertAdvance = FT_PIX_ROUND( metrics->vertAdvance );
541  }
542#endif /* GRID_FIT_METRICS */
543
544
545  /* documentation is in freetype.h */
546
547  FT_EXPORT_DEF( FT_Error )
548  FT_Load_Glyph( FT_Face   face,
549                 FT_UInt   glyph_index,
550                 FT_Int32  load_flags )
551  {
552    FT_Error      error;
553    FT_Driver     driver;
554    FT_GlyphSlot  slot;
555    FT_Library    library;
556    FT_Bool       autohint = FALSE;
557    FT_Module     hinter;
558
559
560    if ( !face || !face->size || !face->glyph )
561      return FT_Err_Invalid_Face_Handle;
562
563    /* The validity test for `glyph_index' is performed by the */
564    /* font drivers.                                           */
565
566    slot = face->glyph;
567    ft_glyphslot_clear( slot );
568
569    driver  = face->driver;
570    library = driver->root.library;
571    hinter  = library->auto_hinter;
572
573    /* resolve load flags dependencies */
574
575    if ( load_flags & FT_LOAD_NO_RECURSE )
576      load_flags |= FT_LOAD_NO_SCALE         |
577                    FT_LOAD_IGNORE_TRANSFORM;
578
579    if ( load_flags & FT_LOAD_NO_SCALE )
580    {
581      load_flags |= FT_LOAD_NO_HINTING |
582                    FT_LOAD_NO_BITMAP;
583
584      load_flags &= ~FT_LOAD_RENDER;
585    }
586
587    /*
588     * Determine whether we need to auto-hint or not.
589     * The general rules are:
590     *
591     * - Do only auto-hinting if we have a hinter module,
592     *   a scalable font format dealing with outlines,
593     *   and no transforms except simple slants.
594     *
595     * - Then, autohint if FT_LOAD_FORCE_AUTOHINT is set
596     *   or if we don't have a native font hinter.
597     *
598     * - Otherwise, auto-hint for LIGHT hinting mode.
599     *
600     * - Exception: The font is `tricky' and requires
601     *   the native hinter to load properly.
602     */
603
604    if ( hinter                                   &&
605         !( load_flags & FT_LOAD_NO_HINTING )     &&
606         !( load_flags & FT_LOAD_NO_AUTOHINT )    &&
607         FT_DRIVER_IS_SCALABLE( driver )          &&
608         FT_DRIVER_USES_OUTLINES( driver )        &&
609         !FT_IS_TRICKY( face )                    &&
610         face->internal->transform_matrix.yy > 0  &&
611         face->internal->transform_matrix.yx == 0 )
612    {
613      if ( ( load_flags & FT_LOAD_FORCE_AUTOHINT ) ||
614           !FT_DRIVER_HAS_HINTER( driver )         )
615        autohint = TRUE;
616      else
617      {
618        FT_Render_Mode  mode = FT_LOAD_TARGET_MODE( load_flags );
619
620
621        if ( mode == FT_RENDER_MODE_LIGHT             ||
622             face->internal->ignore_unpatented_hinter )
623          autohint = TRUE;
624      }
625    }
626
627    if ( autohint )
628    {
629      FT_AutoHinter_Service  hinting;
630
631
632      /* try to load embedded bitmaps first if available            */
633      /*                                                            */
634      /* XXX: This is really a temporary hack that should disappear */
635      /*      promptly with FreeType 2.1!                           */
636      /*                                                            */
637      if ( FT_HAS_FIXED_SIZES( face )             &&
638          ( load_flags & FT_LOAD_NO_BITMAP ) == 0 )
639      {
640        error = driver->clazz->load_glyph( slot, face->size,
641                                           glyph_index,
642                                           load_flags | FT_LOAD_SBITS_ONLY );
643
644        if ( !error && slot->format == FT_GLYPH_FORMAT_BITMAP )
645          goto Load_Ok;
646      }
647
648      {
649        FT_Face_Internal  internal        = face->internal;
650        FT_Int            transform_flags = internal->transform_flags;
651
652
653        /* since the auto-hinter calls FT_Load_Glyph by itself, */
654        /* make sure that glyphs aren't transformed             */
655        internal->transform_flags = 0;
656
657        /* load auto-hinted outline */
658        hinting = (FT_AutoHinter_Service)hinter->clazz->module_interface;
659
660        error   = hinting->load_glyph( (FT_AutoHinter)hinter,
661                                       slot, face->size,
662                                       glyph_index, load_flags );
663
664        internal->transform_flags = transform_flags;
665      }
666    }
667    else
668    {
669      error = driver->clazz->load_glyph( slot,
670                                         face->size,
671                                         glyph_index,
672                                         load_flags );
673      if ( error )
674        goto Exit;
675
676      if ( slot->format == FT_GLYPH_FORMAT_OUTLINE )
677      {
678        /* check that the loaded outline is correct */
679        error = FT_Outline_Check( &slot->outline );
680        if ( error )
681          goto Exit;
682
683#ifdef GRID_FIT_METRICS
684        if ( !( load_flags & FT_LOAD_NO_HINTING ) )
685          ft_glyphslot_grid_fit_metrics( slot,
686              FT_BOOL( load_flags & FT_LOAD_VERTICAL_LAYOUT ) );
687#endif
688      }
689    }
690
691  Load_Ok:
692    /* compute the advance */
693    if ( load_flags & FT_LOAD_VERTICAL_LAYOUT )
694    {
695      slot->advance.x = 0;
696      slot->advance.y = slot->metrics.vertAdvance;
697    }
698    else
699    {
700      slot->advance.x = slot->metrics.horiAdvance;
701      slot->advance.y = 0;
702    }
703
704    /* compute the linear advance in 16.16 pixels */
705    if ( ( load_flags & FT_LOAD_LINEAR_DESIGN ) == 0  &&
706         ( FT_IS_SCALABLE( face ) )                   )
707    {
708      FT_Size_Metrics*  metrics = &face->size->metrics;
709
710
711      /* it's tricky! */
712      slot->linearHoriAdvance = FT_MulDiv( slot->linearHoriAdvance,
713                                           metrics->x_scale, 64 );
714
715      slot->linearVertAdvance = FT_MulDiv( slot->linearVertAdvance,
716                                           metrics->y_scale, 64 );
717    }
718
719    if ( ( load_flags & FT_LOAD_IGNORE_TRANSFORM ) == 0 )
720    {
721      FT_Face_Internal  internal = face->internal;
722
723
724      /* now, transform the glyph image if needed */
725      if ( internal->transform_flags )
726      {
727        /* get renderer */
728        FT_Renderer  renderer = ft_lookup_glyph_renderer( slot );
729
730
731        if ( renderer )
732          error = renderer->clazz->transform_glyph(
733                                     renderer, slot,
734                                     &internal->transform_matrix,
735                                     &internal->transform_delta );
736        /* transform advance */
737        FT_Vector_Transform( &slot->advance, &internal->transform_matrix );
738      }
739    }
740
741    /* do we need to render the image now? */
742    if ( !error                                    &&
743         slot->format != FT_GLYPH_FORMAT_BITMAP    &&
744         slot->format != FT_GLYPH_FORMAT_COMPOSITE &&
745         load_flags & FT_LOAD_RENDER )
746    {
747      FT_Render_Mode  mode = FT_LOAD_TARGET_MODE( load_flags );
748
749
750      if ( mode == FT_RENDER_MODE_NORMAL      &&
751           (load_flags & FT_LOAD_MONOCHROME ) )
752        mode = FT_RENDER_MODE_MONO;
753
754      error = FT_Render_Glyph( slot, mode );
755    }
756
757  Exit:
758    return error;
759  }
760
761
762  /* documentation is in freetype.h */
763
764  FT_EXPORT_DEF( FT_Error )
765  FT_Load_Char( FT_Face   face,
766                FT_ULong  char_code,
767                FT_Int32  load_flags )
768  {
769    FT_UInt  glyph_index;
770
771
772    if ( !face )
773      return FT_Err_Invalid_Face_Handle;
774
775    glyph_index = (FT_UInt)char_code;
776    if ( face->charmap )
777      glyph_index = FT_Get_Char_Index( face, char_code );
778
779    return FT_Load_Glyph( face, glyph_index, load_flags );
780  }
781
782
783  /* destructor for sizes list */
784  static void
785  destroy_size( FT_Memory  memory,
786                FT_Size    size,
787                FT_Driver  driver )
788  {
789    /* finalize client-specific data */
790    if ( size->generic.finalizer )
791      size->generic.finalizer( size );
792
793    /* finalize format-specific stuff */
794    if ( driver->clazz->done_size )
795      driver->clazz->done_size( size );
796
797    FT_FREE( size->internal );
798    FT_FREE( size );
799  }
800
801
802  static void
803  ft_cmap_done_internal( FT_CMap  cmap );
804
805
806  static void
807  destroy_charmaps( FT_Face    face,
808                    FT_Memory  memory )
809  {
810    FT_Int  n;
811
812
813    if ( !face )
814      return;
815
816    for ( n = 0; n < face->num_charmaps; n++ )
817    {
818      FT_CMap  cmap = FT_CMAP( face->charmaps[n] );
819
820
821      ft_cmap_done_internal( cmap );
822
823      face->charmaps[n] = NULL;
824    }
825
826    FT_FREE( face->charmaps );
827    face->num_charmaps = 0;
828  }
829
830
831  /* destructor for faces list */
832  static void
833  destroy_face( FT_Memory  memory,
834                FT_Face    face,
835                FT_Driver  driver )
836  {
837    FT_Driver_Class  clazz = driver->clazz;
838
839
840    /* discard auto-hinting data */
841    if ( face->autohint.finalizer )
842      face->autohint.finalizer( face->autohint.data );
843
844    /* Discard glyph slots for this face.                           */
845    /* Beware!  FT_Done_GlyphSlot() changes the field `face->glyph' */
846    while ( face->glyph )
847      FT_Done_GlyphSlot( face->glyph );
848
849    /* discard all sizes for this face */
850    FT_List_Finalize( &face->sizes_list,
851                      (FT_List_Destructor)destroy_size,
852                      memory,
853                      driver );
854    face->size = 0;
855
856    /* now discard client data */
857    if ( face->generic.finalizer )
858      face->generic.finalizer( face );
859
860    /* discard charmaps */
861    destroy_charmaps( face, memory );
862
863    /* finalize format-specific stuff */
864    if ( clazz->done_face )
865      clazz->done_face( face );
866
867    /* close the stream for this face if needed */
868    FT_Stream_Free(
869      face->stream,
870      ( face->face_flags & FT_FACE_FLAG_EXTERNAL_STREAM ) != 0 );
871
872    face->stream = 0;
873
874    /* get rid of it */
875    if ( face->internal )
876    {
877      FT_FREE( face->internal );
878    }
879    FT_FREE( face );
880  }
881
882
883  static void
884  Destroy_Driver( FT_Driver  driver )
885  {
886    FT_List_Finalize( &driver->faces_list,
887                      (FT_List_Destructor)destroy_face,
888                      driver->root.memory,
889                      driver );
890
891    /* check whether we need to drop the driver's glyph loader */
892    if ( FT_DRIVER_USES_OUTLINES( driver ) )
893      FT_GlyphLoader_Done( driver->glyph_loader );
894  }
895
896
897  /*************************************************************************/
898  /*                                                                       */
899  /* <Function>                                                            */
900  /*    find_unicode_charmap                                               */
901  /*                                                                       */
902  /* <Description>                                                         */
903  /*    This function finds a Unicode charmap, if there is one.            */
904  /*    And if there is more than one, it tries to favour the more         */
905  /*    extensive one, i.e., one that supports UCS-4 against those which   */
906  /*    are limited to the BMP (said UCS-2 encoding.)                      */
907  /*                                                                       */
908  /*    This function is called from open_face() (just below), and also    */
909  /*    from FT_Select_Charmap( ..., FT_ENCODING_UNICODE ).                */
910  /*                                                                       */
911  static FT_Error
912  find_unicode_charmap( FT_Face  face )
913  {
914    FT_CharMap*  first;
915    FT_CharMap*  cur;
916
917
918    /* caller should have already checked that `face' is valid */
919    FT_ASSERT( face );
920
921    first = face->charmaps;
922
923    if ( !first )
924      return FT_Err_Invalid_CharMap_Handle;
925
926    /*
927     *  The original TrueType specification(s) only specified charmap
928     *  formats that are capable of mapping 8 or 16 bit character codes to
929     *  glyph indices.
930     *
931     *  However, recent updates to the Apple and OpenType specifications
932     *  introduced new formats that are capable of mapping 32-bit character
933     *  codes as well.  And these are already used on some fonts, mainly to
934     *  map non-BMP Asian ideographs as defined in Unicode.
935     *
936     *  For compatibility purposes, these fonts generally come with
937     *  *several* Unicode charmaps:
938     *
939     *   - One of them in the "old" 16-bit format, that cannot access
940     *     all glyphs in the font.
941     *
942     *   - Another one in the "new" 32-bit format, that can access all
943     *     the glyphs.
944     *
945     *  This function has been written to always favor a 32-bit charmap
946     *  when found.  Otherwise, a 16-bit one is returned when found.
947     */
948
949    /* Since the `interesting' table, with IDs (3,10), is normally the */
950    /* last one, we loop backwards.  This loses with type1 fonts with  */
951    /* non-BMP characters (<.0001%), this wins with .ttf with non-BMP  */
952    /* chars (.01% ?), and this is the same about 99.99% of the time!  */
953
954    cur = first + face->num_charmaps;  /* points after the last one */
955
956    for ( ; --cur >= first; )
957    {
958      if ( cur[0]->encoding == FT_ENCODING_UNICODE )
959      {
960        /* XXX If some new encodings to represent UCS-4 are added, */
961        /*     they should be added here.                          */
962        if ( ( cur[0]->platform_id == TT_PLATFORM_MICROSOFT &&
963               cur[0]->encoding_id == TT_MS_ID_UCS_4        )     ||
964             ( cur[0]->platform_id == TT_PLATFORM_APPLE_UNICODE &&
965               cur[0]->encoding_id == TT_APPLE_ID_UNICODE_32    ) )
966        {
967          face->charmap = cur[0];
968          return FT_Err_Ok;
969        }
970      }
971    }
972
973    /* We do not have any UCS-4 charmap.                */
974    /* Do the loop again and search for UCS-2 charmaps. */
975    cur = first + face->num_charmaps;
976
977    for ( ; --cur >= first; )
978    {
979      if ( cur[0]->encoding == FT_ENCODING_UNICODE )
980      {
981        face->charmap = cur[0];
982        return FT_Err_Ok;
983      }
984    }
985
986    return FT_Err_Invalid_CharMap_Handle;
987  }
988
989
990  /*************************************************************************/
991  /*                                                                       */
992  /* <Function>                                                            */
993  /*    find_variant_selector_charmap                                      */
994  /*                                                                       */
995  /* <Description>                                                         */
996  /*    This function finds the variant selector charmap, if there is one. */
997  /*    There can only be one (platform=0, specific=5, format=14).         */
998  /*                                                                       */
999  static FT_CharMap
1000  find_variant_selector_charmap( FT_Face  face )
1001  {
1002    FT_CharMap*  first;
1003    FT_CharMap*  end;
1004    FT_CharMap*  cur;
1005
1006
1007    /* caller should have already checked that `face' is valid */
1008    FT_ASSERT( face );
1009
1010    first = face->charmaps;
1011
1012    if ( !first )
1013      return NULL;
1014
1015    end = first + face->num_charmaps;  /* points after the last one */
1016
1017    for ( cur = first; cur < end; ++cur )
1018    {
1019      if ( cur[0]->platform_id == TT_PLATFORM_APPLE_UNICODE    &&
1020           cur[0]->encoding_id == TT_APPLE_ID_VARIANT_SELECTOR &&
1021           FT_Get_CMap_Format( cur[0] ) == 14                  )
1022        return cur[0];
1023    }
1024
1025    return NULL;
1026  }
1027
1028
1029  /*************************************************************************/
1030  /*                                                                       */
1031  /* <Function>                                                            */
1032  /*    open_face                                                          */
1033  /*                                                                       */
1034  /* <Description>                                                         */
1035  /*    This function does some work for FT_Open_Face().                   */
1036  /*                                                                       */
1037  static FT_Error
1038  open_face( FT_Driver      driver,
1039             FT_Stream      stream,
1040             FT_Long        face_index,
1041             FT_Int         num_params,
1042             FT_Parameter*  params,
1043             FT_Face       *aface )
1044  {
1045    FT_Memory         memory;
1046    FT_Driver_Class   clazz;
1047    FT_Face           face = 0;
1048    FT_Error          error, error2;
1049    FT_Face_Internal  internal = NULL;
1050
1051
1052    clazz  = driver->clazz;
1053    memory = driver->root.memory;
1054
1055    /* allocate the face object and perform basic initialization */
1056    if ( FT_ALLOC( face, clazz->face_object_size ) )
1057      goto Fail;
1058
1059    if ( FT_NEW( internal ) )
1060      goto Fail;
1061
1062    face->internal = internal;
1063
1064    face->driver   = driver;
1065    face->memory   = memory;
1066    face->stream   = stream;
1067
1068#ifdef FT_CONFIG_OPTION_INCREMENTAL
1069    {
1070      int  i;
1071
1072
1073      face->internal->incremental_interface = 0;
1074      for ( i = 0; i < num_params && !face->internal->incremental_interface;
1075            i++ )
1076        if ( params[i].tag == FT_PARAM_TAG_INCREMENTAL )
1077          face->internal->incremental_interface =
1078            (FT_Incremental_Interface)params[i].data;
1079    }
1080#endif
1081
1082    if ( clazz->init_face )
1083      error = clazz->init_face( stream,
1084                                face,
1085                                (FT_Int)face_index,
1086                                num_params,
1087                                params );
1088    if ( error )
1089      goto Fail;
1090
1091    /* select Unicode charmap by default */
1092    error2 = find_unicode_charmap( face );
1093
1094    /* if no Unicode charmap can be found, FT_Err_Invalid_CharMap_Handle */
1095    /* is returned.                                                      */
1096
1097    /* no error should happen, but we want to play safe */
1098    if ( error2 && error2 != FT_Err_Invalid_CharMap_Handle )
1099    {
1100      error = error2;
1101      goto Fail;
1102    }
1103
1104    *aface = face;
1105
1106  Fail:
1107    if ( error )
1108    {
1109      destroy_charmaps( face, memory );
1110      if ( clazz->done_face )
1111        clazz->done_face( face );
1112      FT_FREE( internal );
1113      FT_FREE( face );
1114      *aface = 0;
1115    }
1116
1117    return error;
1118  }
1119
1120
1121  /* there's a Mac-specific extended implementation of FT_New_Face() */
1122  /* in src/base/ftmac.c                                             */
1123
1124#if !defined( FT_MACINTOSH ) || defined( DARWIN_NO_CARBON )
1125
1126  /* documentation is in freetype.h */
1127
1128  FT_EXPORT_DEF( FT_Error )
1129  FT_New_Face( FT_Library   library,
1130               const char*  pathname,
1131               FT_Long      face_index,
1132               FT_Face     *aface )
1133  {
1134    FT_Open_Args  args;
1135
1136
1137    /* test for valid `library' and `aface' delayed to FT_Open_Face() */
1138    if ( !pathname )
1139      return FT_Err_Invalid_Argument;
1140
1141    args.flags    = FT_OPEN_PATHNAME;
1142    args.pathname = (char*)pathname;
1143
1144    return FT_Open_Face( library, &args, face_index, aface );
1145  }
1146
1147#endif  /* defined( FT_MACINTOSH ) && !defined( DARWIN_NO_CARBON ) */
1148
1149
1150  /* documentation is in freetype.h */
1151
1152  FT_EXPORT_DEF( FT_Error )
1153  FT_New_Memory_Face( FT_Library      library,
1154                      const FT_Byte*  file_base,
1155                      FT_Long         file_size,
1156                      FT_Long         face_index,
1157                      FT_Face        *aface )
1158  {
1159    FT_Open_Args  args;
1160
1161
1162    /* test for valid `library' and `face' delayed to FT_Open_Face() */
1163    if ( !file_base )
1164      return FT_Err_Invalid_Argument;
1165
1166    args.flags       = FT_OPEN_MEMORY;
1167    args.memory_base = file_base;
1168    args.memory_size = file_size;
1169
1170    return FT_Open_Face( library, &args, face_index, aface );
1171  }
1172
1173
1174#ifdef FT_CONFIG_OPTION_MAC_FONTS
1175
1176  /* The behavior here is very similar to that in base/ftmac.c, but it     */
1177  /* is designed to work on non-mac systems, so no mac specific calls.     */
1178  /*                                                                       */
1179  /* We look at the file and determine if it is a mac dfont file or a mac  */
1180  /* resource file, or a macbinary file containing a mac resource file.    */
1181  /*                                                                       */
1182  /* Unlike ftmac I'm not going to look at a `FOND'.  I don't really see   */
1183  /* the point, especially since there may be multiple `FOND' resources.   */
1184  /* Instead I'll just look for `sfnt' and `POST' resources, ordered as    */
1185  /* they occur in the file.                                               */
1186  /*                                                                       */
1187  /* Note that multiple `POST' resources do not mean multiple postscript   */
1188  /* fonts; they all get jammed together to make what is essentially a     */
1189  /* pfb file.                                                             */
1190  /*                                                                       */
1191  /* We aren't interested in `NFNT' or `FONT' bitmap resources.            */
1192  /*                                                                       */
1193  /* As soon as we get an `sfnt' load it into memory and pass it off to    */
1194  /* FT_Open_Face.                                                         */
1195  /*                                                                       */
1196  /* If we have a (set of) `POST' resources, massage them into a (memory)  */
1197  /* pfb file and pass that to FT_Open_Face.  (As with ftmac.c I'm not     */
1198  /* going to try to save the kerning info.  After all that lives in the   */
1199  /* `FOND' which isn't in the file containing the `POST' resources so     */
1200  /* we don't really have access to it.                                    */
1201
1202
1203  /* Finalizer for a memory stream; gets called by FT_Done_Face(). */
1204  /* It frees the memory it uses.                                  */
1205  /* From ftmac.c.                                                 */
1206  static void
1207  memory_stream_close( FT_Stream  stream )
1208  {
1209    FT_Memory  memory = stream->memory;
1210
1211
1212    FT_FREE( stream->base );
1213
1214    stream->size  = 0;
1215    stream->base  = 0;
1216    stream->close = 0;
1217  }
1218
1219
1220  /* Create a new memory stream from a buffer and a size. */
1221  /* From ftmac.c.                                        */
1222  static FT_Error
1223  new_memory_stream( FT_Library           library,
1224                     FT_Byte*             base,
1225                     FT_ULong             size,
1226                     FT_Stream_CloseFunc  close,
1227                     FT_Stream           *astream )
1228  {
1229    FT_Error   error;
1230    FT_Memory  memory;
1231    FT_Stream  stream;
1232
1233
1234    if ( !library )
1235      return FT_Err_Invalid_Library_Handle;
1236
1237    if ( !base )
1238      return FT_Err_Invalid_Argument;
1239
1240    *astream = 0;
1241    memory = library->memory;
1242    if ( FT_NEW( stream ) )
1243      goto Exit;
1244
1245    FT_Stream_OpenMemory( stream, base, size );
1246
1247    stream->close = close;
1248
1249    *astream = stream;
1250
1251  Exit:
1252    return error;
1253  }
1254
1255
1256  /* Create a new FT_Face given a buffer and a driver name. */
1257  /* from ftmac.c */
1258  FT_LOCAL_DEF( FT_Error )
1259  open_face_from_buffer( FT_Library   library,
1260                         FT_Byte*     base,
1261                         FT_ULong     size,
1262                         FT_Long      face_index,
1263                         const char*  driver_name,
1264                         FT_Face     *aface )
1265  {
1266    FT_Open_Args  args;
1267    FT_Error      error;
1268    FT_Stream     stream = NULL;
1269    FT_Memory     memory = library->memory;
1270
1271
1272    error = new_memory_stream( library,
1273                               base,
1274                               size,
1275                               memory_stream_close,
1276                               &stream );
1277    if ( error )
1278    {
1279      FT_FREE( base );
1280      return error;
1281    }
1282
1283    args.flags = FT_OPEN_STREAM;
1284    args.stream = stream;
1285    if ( driver_name )
1286    {
1287      args.flags = args.flags | FT_OPEN_DRIVER;
1288      args.driver = FT_Get_Module( library, driver_name );
1289    }
1290
1291#ifdef FT_MACINTOSH
1292    /* At this point, face_index has served its purpose;      */
1293    /* whoever calls this function has already used it to     */
1294    /* locate the correct font data.  We should not propagate */
1295    /* this index to FT_Open_Face() (unless it is negative).  */
1296
1297    if ( face_index > 0 )
1298      face_index = 0;
1299#endif
1300
1301    error = FT_Open_Face( library, &args, face_index, aface );
1302
1303    if ( error == FT_Err_Ok )
1304      (*aface)->face_flags &= ~FT_FACE_FLAG_EXTERNAL_STREAM;
1305    else
1306#ifdef FT_MACINTOSH
1307      FT_Stream_Free( stream, 0 );
1308#else
1309    {
1310      FT_Stream_Close( stream );
1311      FT_FREE( stream );
1312    }
1313#endif
1314
1315    return error;
1316  }
1317
1318
1319  /* Look up `TYP1' or `CID ' table from sfnt table directory.       */
1320  /* `offset' and `length' must exclude the binary header in tables. */
1321
1322  /* Type 1 and CID-keyed font drivers should recognize sfnt-wrapped */
1323  /* format too.  Here, since we can't expect that the TrueType font */
1324  /* driver is loaded unconditially, we must parse the font by       */
1325  /* ourselves.  We are only interested in the name of the table and */
1326  /* the offset.                                                     */
1327
1328  static FT_Error
1329  ft_lookup_PS_in_sfnt_stream( FT_Stream  stream,
1330                               FT_Long    face_index,
1331                               FT_ULong*  offset,
1332                               FT_ULong*  length,
1333                               FT_Bool*   is_sfnt_cid )
1334  {
1335    FT_Error   error;
1336    FT_UShort  numTables;
1337    FT_Long    pstable_index;
1338    FT_ULong   tag;
1339    int        i;
1340
1341
1342    *offset = 0;
1343    *length = 0;
1344    *is_sfnt_cid = FALSE;
1345
1346    /* TODO: support for sfnt-wrapped PS/CID in TTC format */
1347
1348    /* version check for 'typ1' (should be ignored?) */
1349    if ( FT_READ_ULONG( tag ) )
1350      return error;
1351    if ( tag != TTAG_typ1 )
1352      return FT_Err_Unknown_File_Format;
1353
1354    if ( FT_READ_USHORT( numTables ) )
1355      return error;
1356    if ( FT_STREAM_SKIP( 2 * 3 ) ) /* skip binary search header */
1357      return error;
1358
1359    pstable_index = -1;
1360    *is_sfnt_cid  = FALSE;
1361
1362    for ( i = 0; i < numTables; i++ )
1363    {
1364      if ( FT_READ_ULONG( tag )     || FT_STREAM_SKIP( 4 )      ||
1365           FT_READ_ULONG( *offset ) || FT_READ_ULONG( *length ) )
1366        return error;
1367
1368      if ( tag == TTAG_CID )
1369      {
1370        pstable_index++;
1371        *offset += 22;
1372        *length -= 22;
1373        *is_sfnt_cid = TRUE;
1374        if ( face_index < 0 )
1375          return FT_Err_Ok;
1376      }
1377      else if ( tag == TTAG_TYP1 )
1378      {
1379        pstable_index++;
1380        *offset += 24;
1381        *length -= 24;
1382        *is_sfnt_cid = FALSE;
1383        if ( face_index < 0 )
1384          return FT_Err_Ok;
1385      }
1386      if ( face_index >= 0 && pstable_index == face_index )
1387        return FT_Err_Ok;
1388    }
1389    return FT_Err_Table_Missing;
1390  }
1391
1392
1393  FT_LOCAL_DEF( FT_Error )
1394  open_face_PS_from_sfnt_stream( FT_Library     library,
1395                                 FT_Stream      stream,
1396                                 FT_Long        face_index,
1397                                 FT_Int         num_params,
1398                                 FT_Parameter  *params,
1399                                 FT_Face       *aface )
1400  {
1401    FT_Error   error;
1402    FT_Memory  memory = library->memory;
1403    FT_ULong   offset, length;
1404    FT_Long    pos;
1405    FT_Bool    is_sfnt_cid;
1406    FT_Byte*   sfnt_ps;
1407
1408    FT_UNUSED( num_params );
1409    FT_UNUSED( params );
1410
1411
1412    pos = FT_Stream_Pos( stream );
1413
1414    error = ft_lookup_PS_in_sfnt_stream( stream,
1415                                         face_index,
1416                                         &offset,
1417                                         &length,
1418                                         &is_sfnt_cid );
1419    if ( error )
1420      return error;
1421
1422    if ( FT_Stream_Seek( stream, pos + offset ) )
1423      goto Exit;
1424
1425    if ( FT_ALLOC( sfnt_ps, (FT_Long)length ) )
1426      goto Exit;
1427
1428    error = FT_Stream_Read( stream, (FT_Byte *)sfnt_ps, length );
1429    if ( error )
1430      goto Exit;
1431
1432    error = open_face_from_buffer( library,
1433                                   sfnt_ps,
1434                                   length,
1435                                   face_index < 0 ? face_index : 0,
1436                                   is_sfnt_cid ? "cid" : "type1",
1437                                   aface );
1438  Exit:
1439    FT_Stream_Seek( stream, pos );
1440    return error;
1441  }
1442
1443
1444#if !defined( FT_MACINTOSH ) || defined( DARWIN_NO_CARBON )
1445
1446  /* The resource header says we've got resource_cnt `POST' (type1) */
1447  /* resources in this file.  They all need to be coalesced into    */
1448  /* one lump which gets passed on to the type1 driver.             */
1449  /* Here can be only one PostScript font in a file so face_index   */
1450  /* must be 0 (or -1).                                             */
1451  /*                                                                */
1452  static FT_Error
1453  Mac_Read_POST_Resource( FT_Library  library,
1454                          FT_Stream   stream,
1455                          FT_Long    *offsets,
1456                          FT_Long     resource_cnt,
1457                          FT_Long     face_index,
1458                          FT_Face    *aface )
1459  {
1460    FT_Error   error  = FT_Err_Cannot_Open_Resource;
1461    FT_Memory  memory = library->memory;
1462    FT_Byte*   pfb_data;
1463    int        i, type, flags;
1464    FT_Long    len;
1465    FT_Long    pfb_len, pfb_pos, pfb_lenpos;
1466    FT_Long    rlen, temp;
1467
1468
1469    if ( face_index == -1 )
1470      face_index = 0;
1471    if ( face_index != 0 )
1472      return error;
1473
1474    /* Find the length of all the POST resources, concatenated.  Assume */
1475    /* worst case (each resource in its own section).                   */
1476    pfb_len = 0;
1477    for ( i = 0; i < resource_cnt; ++i )
1478    {
1479      error = FT_Stream_Seek( stream, offsets[i] );
1480      if ( error )
1481        goto Exit;
1482      if ( FT_READ_LONG( temp ) )
1483        goto Exit;
1484      pfb_len += temp + 6;
1485    }
1486
1487    if ( FT_ALLOC( pfb_data, (FT_Long)pfb_len + 2 ) )
1488      goto Exit;
1489
1490    pfb_data[0] = 0x80;
1491    pfb_data[1] = 1;            /* Ascii section */
1492    pfb_data[2] = 0;            /* 4-byte length, fill in later */
1493    pfb_data[3] = 0;
1494    pfb_data[4] = 0;
1495    pfb_data[5] = 0;
1496    pfb_pos     = 6;
1497    pfb_lenpos  = 2;
1498
1499    len = 0;
1500    type = 1;
1501    for ( i = 0; i < resource_cnt; ++i )
1502    {
1503      error = FT_Stream_Seek( stream, offsets[i] );
1504      if ( error )
1505        goto Exit2;
1506      if ( FT_READ_LONG( rlen ) )
1507        goto Exit;
1508      if ( FT_READ_USHORT( flags ) )
1509        goto Exit;
1510      rlen -= 2;                    /* the flags are part of the resource */
1511      if ( ( flags >> 8 ) == type )
1512        len += rlen;
1513      else
1514      {
1515        pfb_data[pfb_lenpos    ] = (FT_Byte)( len );
1516        pfb_data[pfb_lenpos + 1] = (FT_Byte)( len >> 8 );
1517        pfb_data[pfb_lenpos + 2] = (FT_Byte)( len >> 16 );
1518        pfb_data[pfb_lenpos + 3] = (FT_Byte)( len >> 24 );
1519
1520        if ( ( flags >> 8 ) == 5 )      /* End of font mark */
1521          break;
1522
1523        pfb_data[pfb_pos++] = 0x80;
1524
1525        type = flags >> 8;
1526        len = rlen;
1527
1528        pfb_data[pfb_pos++] = (FT_Byte)type;
1529        pfb_lenpos          = pfb_pos;
1530        pfb_data[pfb_pos++] = 0;        /* 4-byte length, fill in later */
1531        pfb_data[pfb_pos++] = 0;
1532        pfb_data[pfb_pos++] = 0;
1533        pfb_data[pfb_pos++] = 0;
1534      }
1535
1536      error = FT_Stream_Read( stream, (FT_Byte *)pfb_data + pfb_pos, rlen );
1537      pfb_pos += rlen;
1538    }
1539
1540    pfb_data[pfb_pos++] = 0x80;
1541    pfb_data[pfb_pos++] = 3;
1542
1543    pfb_data[pfb_lenpos    ] = (FT_Byte)( len );
1544    pfb_data[pfb_lenpos + 1] = (FT_Byte)( len >> 8 );
1545    pfb_data[pfb_lenpos + 2] = (FT_Byte)( len >> 16 );
1546    pfb_data[pfb_lenpos + 3] = (FT_Byte)( len >> 24 );
1547
1548    return open_face_from_buffer( library,
1549                                  pfb_data,
1550                                  pfb_pos,
1551                                  face_index,
1552                                  "type1",
1553                                  aface );
1554
1555  Exit2:
1556    FT_FREE( pfb_data );
1557
1558  Exit:
1559    return error;
1560  }
1561
1562
1563  /* The resource header says we've got resource_cnt `sfnt'      */
1564  /* (TrueType/OpenType) resources in this file.  Look through   */
1565  /* them for the one indicated by face_index, load it into mem, */
1566  /* pass it on the the truetype driver and return it.           */
1567  /*                                                             */
1568  static FT_Error
1569  Mac_Read_sfnt_Resource( FT_Library  library,
1570                          FT_Stream   stream,
1571                          FT_Long    *offsets,
1572                          FT_Long     resource_cnt,
1573                          FT_Long     face_index,
1574                          FT_Face    *aface )
1575  {
1576    FT_Memory  memory = library->memory;
1577    FT_Byte*   sfnt_data;
1578    FT_Error   error;
1579    FT_Long    flag_offset;
1580    FT_Long    rlen;
1581    int        is_cff;
1582    FT_Long    face_index_in_resource = 0;
1583
1584
1585    if ( face_index == -1 )
1586      face_index = 0;
1587    if ( face_index >= resource_cnt )
1588      return FT_Err_Cannot_Open_Resource;
1589
1590    flag_offset = offsets[face_index];
1591    error = FT_Stream_Seek( stream, flag_offset );
1592    if ( error )
1593      goto Exit;
1594
1595    if ( FT_READ_LONG( rlen ) )
1596      goto Exit;
1597    if ( rlen == -1 )
1598      return FT_Err_Cannot_Open_Resource;
1599
1600    error = open_face_PS_from_sfnt_stream( library,
1601                                           stream,
1602                                           face_index,
1603                                           0, NULL,
1604                                           aface );
1605    if ( !error )
1606      goto Exit;
1607
1608    if ( FT_ALLOC( sfnt_data, (FT_Long)rlen ) )
1609      return error;
1610    error = FT_Stream_Read( stream, (FT_Byte *)sfnt_data, rlen );
1611    if ( error )
1612      goto Exit;
1613
1614    is_cff = rlen > 4 && !ft_memcmp( sfnt_data, "OTTO", 4 );
1615    error = open_face_from_buffer( library,
1616                                   sfnt_data,
1617                                   rlen,
1618                                   face_index_in_resource,
1619                                   is_cff ? "cff" : "truetype",
1620                                   aface );
1621
1622  Exit:
1623    return error;
1624  }
1625
1626
1627  /* Check for a valid resource fork header, or a valid dfont    */
1628  /* header.  In a resource fork the first 16 bytes are repeated */
1629  /* at the location specified by bytes 4-7.  In a dfont bytes   */
1630  /* 4-7 point to 16 bytes of zeroes instead.                    */
1631  /*                                                             */
1632  static FT_Error
1633  IsMacResource( FT_Library  library,
1634                 FT_Stream   stream,
1635                 FT_Long     resource_offset,
1636                 FT_Long     face_index,
1637                 FT_Face    *aface )
1638  {
1639    FT_Memory  memory = library->memory;
1640    FT_Error   error;
1641    FT_Long    map_offset, rdara_pos;
1642    FT_Long    *data_offsets;
1643    FT_Long    count;
1644
1645
1646    error = FT_Raccess_Get_HeaderInfo( library, stream, resource_offset,
1647                                       &map_offset, &rdara_pos );
1648    if ( error )
1649      return error;
1650
1651    error = FT_Raccess_Get_DataOffsets( library, stream,
1652                                        map_offset, rdara_pos,
1653                                        TTAG_POST,
1654                                        &data_offsets, &count );
1655    if ( !error )
1656    {
1657      error = Mac_Read_POST_Resource( library, stream, data_offsets, count,
1658                                      face_index, aface );
1659      FT_FREE( data_offsets );
1660      /* POST exists in an LWFN providing a single face */
1661      if ( !error )
1662        (*aface)->num_faces = 1;
1663      return error;
1664    }
1665
1666    error = FT_Raccess_Get_DataOffsets( library, stream,
1667                                        map_offset, rdara_pos,
1668                                        TTAG_sfnt,
1669                                        &data_offsets, &count );
1670    if ( !error )
1671    {
1672      FT_Long  face_index_internal = face_index % count;
1673
1674
1675      error = Mac_Read_sfnt_Resource( library, stream, data_offsets, count,
1676                                      face_index_internal, aface );
1677      FT_FREE( data_offsets );
1678      if ( !error )
1679        (*aface)->num_faces = count;
1680    }
1681
1682    return error;
1683  }
1684
1685
1686  /* Check for a valid macbinary header, and if we find one   */
1687  /* check that the (flattened) resource fork in it is valid. */
1688  /*                                                          */
1689  static FT_Error
1690  IsMacBinary( FT_Library  library,
1691               FT_Stream   stream,
1692               FT_Long     face_index,
1693               FT_Face    *aface )
1694  {
1695    unsigned char  header[128];
1696    FT_Error       error;
1697    FT_Long        dlen, offset;
1698
1699
1700    if ( NULL == stream )
1701      return FT_Err_Invalid_Stream_Operation;
1702
1703    error = FT_Stream_Seek( stream, 0 );
1704    if ( error )
1705      goto Exit;
1706
1707    error = FT_Stream_Read( stream, (FT_Byte*)header, 128 );
1708    if ( error )
1709      goto Exit;
1710
1711    if (            header[ 0] !=  0 ||
1712                    header[74] !=  0 ||
1713                    header[82] !=  0 ||
1714                    header[ 1] ==  0 ||
1715                    header[ 1] >  33 ||
1716                    header[63] !=  0 ||
1717         header[2 + header[1]] !=  0 )
1718      return FT_Err_Unknown_File_Format;
1719
1720    dlen = ( header[0x53] << 24 ) |
1721           ( header[0x54] << 16 ) |
1722           ( header[0x55] <<  8 ) |
1723             header[0x56];
1724#if 0
1725    rlen = ( header[0x57] << 24 ) |
1726           ( header[0x58] << 16 ) |
1727           ( header[0x59] <<  8 ) |
1728             header[0x5a];
1729#endif /* 0 */
1730    offset = 128 + ( ( dlen + 127 ) & ~127 );
1731
1732    return IsMacResource( library, stream, offset, face_index, aface );
1733
1734  Exit:
1735    return error;
1736  }
1737
1738
1739  static FT_Error
1740  load_face_in_embedded_rfork( FT_Library           library,
1741                               FT_Stream            stream,
1742                               FT_Long              face_index,
1743                               FT_Face             *aface,
1744                               const FT_Open_Args  *args )
1745  {
1746
1747#undef  FT_COMPONENT
1748#define FT_COMPONENT  trace_raccess
1749
1750    FT_Memory  memory = library->memory;
1751    FT_Error   error  = FT_Err_Unknown_File_Format;
1752    int        i;
1753
1754    char *     file_names[FT_RACCESS_N_RULES];
1755    FT_Long    offsets[FT_RACCESS_N_RULES];
1756    FT_Error   errors[FT_RACCESS_N_RULES];
1757
1758    FT_Open_Args  args2;
1759    FT_Stream     stream2 = 0;
1760
1761
1762    FT_Raccess_Guess( library, stream,
1763                      args->pathname, file_names, offsets, errors );
1764
1765    for ( i = 0; i < FT_RACCESS_N_RULES; i++ )
1766    {
1767      if ( errors[i] )
1768      {
1769        FT_TRACE3(( "Error[%d] has occurred in rule %d\n", errors[i], i ));
1770        continue;
1771      }
1772
1773      args2.flags    = FT_OPEN_PATHNAME;
1774      args2.pathname = file_names[i] ? file_names[i] : args->pathname;
1775
1776      FT_TRACE3(( "Try rule %d: %s (offset=%d) ...",
1777                  i, args2.pathname, offsets[i] ));
1778
1779      error = FT_Stream_New( library, &args2, &stream2 );
1780      if ( error )
1781      {
1782        FT_TRACE3(( "failed\n" ));
1783        continue;
1784      }
1785
1786      error = IsMacResource( library, stream2, offsets[i],
1787                             face_index, aface );
1788      FT_Stream_Free( stream2, 0 );
1789
1790      FT_TRACE3(( "%s\n", error ? "failed": "successful" ));
1791
1792      if ( !error )
1793          break;
1794    }
1795
1796    for (i = 0; i < FT_RACCESS_N_RULES; i++)
1797    {
1798      if ( file_names[i] )
1799        FT_FREE( file_names[i] );
1800    }
1801
1802    /* Caller (load_mac_face) requires FT_Err_Unknown_File_Format. */
1803    if ( error )
1804      error = FT_Err_Unknown_File_Format;
1805
1806    return error;
1807
1808#undef  FT_COMPONENT
1809#define FT_COMPONENT  trace_objs
1810
1811  }
1812
1813
1814  /* Check for some macintosh formats without Carbon framework.    */
1815  /* Is this a macbinary file?  If so look at the resource fork.   */
1816  /* Is this a mac dfont file?                                     */
1817  /* Is this an old style resource fork? (in data)                 */
1818  /* Else call load_face_in_embedded_rfork to try extra rules      */
1819  /* (defined in `ftrfork.c').                                     */
1820  /*                                                               */
1821  static FT_Error
1822  load_mac_face( FT_Library           library,
1823                 FT_Stream            stream,
1824                 FT_Long              face_index,
1825                 FT_Face             *aface,
1826                 const FT_Open_Args  *args )
1827  {
1828    FT_Error error;
1829    FT_UNUSED( args );
1830
1831
1832    error = IsMacBinary( library, stream, face_index, aface );
1833    if ( FT_ERROR_BASE( error ) == FT_Err_Unknown_File_Format )
1834    {
1835
1836#undef  FT_COMPONENT
1837#define FT_COMPONENT  trace_raccess
1838
1839      FT_TRACE3(( "Try as dfont: %s ...", args->pathname ));
1840
1841      error = IsMacResource( library, stream, 0, face_index, aface );
1842
1843      FT_TRACE3(( "%s\n", error ? "failed" : "successful" ));
1844
1845#undef  FT_COMPONENT
1846#define FT_COMPONENT  trace_objs
1847
1848    }
1849
1850    if ( ( FT_ERROR_BASE( error ) == FT_Err_Unknown_File_Format      ||
1851           FT_ERROR_BASE( error ) == FT_Err_Invalid_Stream_Operation ) &&
1852         ( args->flags & FT_OPEN_PATHNAME )                            )
1853      error = load_face_in_embedded_rfork( library, stream,
1854                                           face_index, aface, args );
1855    return error;
1856  }
1857#endif
1858
1859#endif  /* !FT_MACINTOSH && FT_CONFIG_OPTION_MAC_FONTS */
1860
1861
1862  /* documentation is in freetype.h */
1863
1864  FT_EXPORT_DEF( FT_Error )
1865  FT_Open_Face( FT_Library           library,
1866                const FT_Open_Args*  args,
1867                FT_Long              face_index,
1868                FT_Face             *aface )
1869  {
1870    FT_Error     error;
1871    FT_Driver    driver;
1872    FT_Memory    memory;
1873    FT_Stream    stream = 0;
1874    FT_Face      face = 0;
1875    FT_ListNode  node = 0;
1876    FT_Bool      external_stream;
1877    FT_Module*   cur;
1878    FT_Module*   limit;
1879
1880
1881    /* test for valid `library' delayed to */
1882    /* FT_Stream_New()                     */
1883
1884    if ( ( !aface && face_index >= 0 ) || !args )
1885      return FT_Err_Invalid_Argument;
1886
1887    external_stream = FT_BOOL( ( args->flags & FT_OPEN_STREAM ) &&
1888                               args->stream                     );
1889
1890    /* create input stream */
1891    error = FT_Stream_New( library, args, &stream );
1892    if ( error )
1893      goto Fail3;
1894
1895    memory = library->memory;
1896
1897    /* If the font driver is specified in the `args' structure, use */
1898    /* it.  Otherwise, we scan the list of registered drivers.      */
1899    if ( ( args->flags & FT_OPEN_DRIVER ) && args->driver )
1900    {
1901      driver = FT_DRIVER( args->driver );
1902
1903      /* not all modules are drivers, so check... */
1904      if ( FT_MODULE_IS_DRIVER( driver ) )
1905      {
1906        FT_Int         num_params = 0;
1907        FT_Parameter*  params     = 0;
1908
1909
1910        if ( args->flags & FT_OPEN_PARAMS )
1911        {
1912          num_params = args->num_params;
1913          params     = args->params;
1914        }
1915
1916        error = open_face( driver, stream, face_index,
1917                           num_params, params, &face );
1918        if ( !error )
1919          goto Success;
1920      }
1921      else
1922        error = FT_Err_Invalid_Handle;
1923
1924      FT_Stream_Free( stream, external_stream );
1925      goto Fail;
1926    }
1927    else
1928    {
1929      /* check each font driver for an appropriate format */
1930      cur   = library->modules;
1931      limit = cur + library->num_modules;
1932
1933
1934      for ( ; cur < limit; cur++ )
1935      {
1936        /* not all modules are font drivers, so check... */
1937        if ( FT_MODULE_IS_DRIVER( cur[0] ) )
1938        {
1939          FT_Int         num_params = 0;
1940          FT_Parameter*  params     = 0;
1941
1942
1943          driver = FT_DRIVER( cur[0] );
1944
1945          if ( args->flags & FT_OPEN_PARAMS )
1946          {
1947            num_params = args->num_params;
1948            params     = args->params;
1949          }
1950
1951          error = open_face( driver, stream, face_index,
1952                             num_params, params, &face );
1953          if ( !error )
1954            goto Success;
1955
1956#ifdef FT_CONFIG_OPTION_MAC_FONTS
1957          if ( ft_strcmp( cur[0]->clazz->module_name, "truetype" ) == 0 &&
1958               FT_ERROR_BASE( error ) == FT_Err_Table_Missing           )
1959          {
1960            /* TrueType but essential tables are missing */
1961            if ( FT_Stream_Seek( stream, 0 ) )
1962              break;
1963
1964            error = open_face_PS_from_sfnt_stream( library,
1965                                                   stream,
1966                                                   face_index,
1967                                                   num_params,
1968                                                   params,
1969                                                   aface );
1970            if ( !error )
1971            {
1972              FT_Stream_Free( stream, external_stream );
1973              return error;
1974            }
1975          }
1976#endif
1977
1978          if ( FT_ERROR_BASE( error ) != FT_Err_Unknown_File_Format )
1979            goto Fail3;
1980        }
1981      }
1982
1983  Fail3:
1984    /* If we are on the mac, and we get an FT_Err_Invalid_Stream_Operation */
1985    /* it may be because we have an empty data fork, so we need to check   */
1986    /* the resource fork.                                                  */
1987    if ( FT_ERROR_BASE( error ) != FT_Err_Cannot_Open_Stream       &&
1988         FT_ERROR_BASE( error ) != FT_Err_Unknown_File_Format      &&
1989         FT_ERROR_BASE( error ) != FT_Err_Invalid_Stream_Operation )
1990      goto Fail2;
1991
1992#if !defined( FT_MACINTOSH ) && defined( FT_CONFIG_OPTION_MAC_FONTS )
1993    error = load_mac_face( library, stream, face_index, aface, args );
1994    if ( !error )
1995    {
1996      /* We don't want to go to Success here.  We've already done that. */
1997      /* On the other hand, if we succeeded we still need to close this */
1998      /* stream (we opened a different stream which extracted the       */
1999      /* interesting information out of this stream here.  That stream  */
2000      /* will still be open and the face will point to it).             */
2001      FT_Stream_Free( stream, external_stream );
2002      return error;
2003    }
2004
2005    if ( FT_ERROR_BASE( error ) != FT_Err_Unknown_File_Format )
2006      goto Fail2;
2007#endif  /* !FT_MACINTOSH && FT_CONFIG_OPTION_MAC_FONTS */
2008
2009      /* no driver is able to handle this format */
2010      error = FT_Err_Unknown_File_Format;
2011
2012  Fail2:
2013      FT_Stream_Free( stream, external_stream );
2014      goto Fail;
2015    }
2016
2017  Success:
2018    FT_TRACE4(( "FT_Open_Face: New face object, adding to list\n" ));
2019
2020    /* set the FT_FACE_FLAG_EXTERNAL_STREAM bit for FT_Done_Face */
2021    if ( external_stream )
2022      face->face_flags |= FT_FACE_FLAG_EXTERNAL_STREAM;
2023
2024    /* add the face object to its driver's list */
2025    if ( FT_NEW( node ) )
2026      goto Fail;
2027
2028    node->data = face;
2029    /* don't assume driver is the same as face->driver, so use */
2030    /* face->driver instead.                                   */
2031    FT_List_Add( &face->driver->faces_list, node );
2032
2033    /* now allocate a glyph slot object for the face */
2034    FT_TRACE4(( "FT_Open_Face: Creating glyph slot\n" ));
2035
2036    if ( face_index >= 0 )
2037    {
2038      error = FT_New_GlyphSlot( face, NULL );
2039      if ( error )
2040        goto Fail;
2041
2042      /* finally, allocate a size object for the face */
2043      {
2044        FT_Size  size;
2045
2046
2047        FT_TRACE4(( "FT_Open_Face: Creating size object\n" ));
2048
2049        error = FT_New_Size( face, &size );
2050        if ( error )
2051          goto Fail;
2052
2053        face->size = size;
2054      }
2055    }
2056
2057    /* some checks */
2058
2059    if ( FT_IS_SCALABLE( face ) )
2060    {
2061      if ( face->height < 0 )
2062        face->height = (FT_Short)-face->height;
2063
2064      if ( !FT_HAS_VERTICAL( face ) )
2065        face->max_advance_height = (FT_Short)face->height;
2066    }
2067
2068    if ( FT_HAS_FIXED_SIZES( face ) )
2069    {
2070      FT_Int  i;
2071
2072
2073      for ( i = 0; i < face->num_fixed_sizes; i++ )
2074      {
2075        FT_Bitmap_Size*  bsize = face->available_sizes + i;
2076
2077
2078        if ( bsize->height < 0 )
2079          bsize->height = (FT_Short)-bsize->height;
2080        if ( bsize->x_ppem < 0 )
2081          bsize->x_ppem = (FT_Short)-bsize->x_ppem;
2082        if ( bsize->y_ppem < 0 )
2083          bsize->y_ppem = -bsize->y_ppem;
2084      }
2085    }
2086
2087    /* initialize internal face data */
2088    {
2089      FT_Face_Internal  internal = face->internal;
2090
2091
2092      internal->transform_matrix.xx = 0x10000L;
2093      internal->transform_matrix.xy = 0;
2094      internal->transform_matrix.yx = 0;
2095      internal->transform_matrix.yy = 0x10000L;
2096
2097      internal->transform_delta.x = 0;
2098      internal->transform_delta.y = 0;
2099    }
2100
2101    if ( aface )
2102      *aface = face;
2103    else
2104      FT_Done_Face( face );
2105
2106    goto Exit;
2107
2108  Fail:
2109    FT_Done_Face( face );
2110
2111  Exit:
2112    FT_TRACE4(( "FT_Open_Face: Return %d\n", error ));
2113
2114    return error;
2115  }
2116
2117
2118  /* documentation is in freetype.h */
2119
2120  FT_EXPORT_DEF( FT_Error )
2121  FT_Attach_File( FT_Face      face,
2122                  const char*  filepathname )
2123  {
2124    FT_Open_Args  open;
2125
2126
2127    /* test for valid `face' delayed to FT_Attach_Stream() */
2128
2129    if ( !filepathname )
2130      return FT_Err_Invalid_Argument;
2131
2132    open.stream   = NULL;
2133    open.flags    = FT_OPEN_PATHNAME;
2134    open.pathname = (char*)filepathname;
2135
2136    return FT_Attach_Stream( face, &open );
2137  }
2138
2139
2140  /* documentation is in freetype.h */
2141
2142  FT_EXPORT_DEF( FT_Error )
2143  FT_Attach_Stream( FT_Face        face,
2144                    FT_Open_Args*  parameters )
2145  {
2146    FT_Stream  stream;
2147    FT_Error   error;
2148    FT_Driver  driver;
2149
2150    FT_Driver_Class  clazz;
2151
2152
2153    /* test for valid `parameters' delayed to FT_Stream_New() */
2154
2155    if ( !face )
2156      return FT_Err_Invalid_Face_Handle;
2157
2158    driver = face->driver;
2159    if ( !driver )
2160      return FT_Err_Invalid_Driver_Handle;
2161
2162    error = FT_Stream_New( driver->root.library, parameters, &stream );
2163    if ( error )
2164      goto Exit;
2165
2166    /* we implement FT_Attach_Stream in each driver through the */
2167    /* `attach_file' interface                                  */
2168
2169    error = FT_Err_Unimplemented_Feature;
2170    clazz = driver->clazz;
2171    if ( clazz->attach_file )
2172      error = clazz->attach_file( face, stream );
2173
2174    /* close the attached stream */
2175    FT_Stream_Free( stream,
2176                    (FT_Bool)( parameters->stream &&
2177                               ( parameters->flags & FT_OPEN_STREAM ) ) );
2178
2179  Exit:
2180    return error;
2181  }
2182
2183
2184  /* documentation is in freetype.h */
2185
2186  FT_EXPORT_DEF( FT_Error )
2187  FT_Done_Face( FT_Face  face )
2188  {
2189    FT_Error     error;
2190    FT_Driver    driver;
2191    FT_Memory    memory;
2192    FT_ListNode  node;
2193
2194
2195    error = FT_Err_Invalid_Face_Handle;
2196    if ( face && face->driver )
2197    {
2198      driver = face->driver;
2199      memory = driver->root.memory;
2200
2201      /* find face in driver's list */
2202      node = FT_List_Find( &driver->faces_list, face );
2203      if ( node )
2204      {
2205        /* remove face object from the driver's list */
2206        FT_List_Remove( &driver->faces_list, node );
2207        FT_FREE( node );
2208
2209        /* now destroy the object proper */
2210        destroy_face( memory, face, driver );
2211        error = FT_Err_Ok;
2212      }
2213    }
2214    return error;
2215  }
2216
2217
2218  /* documentation is in ftobjs.h */
2219
2220  FT_EXPORT_DEF( FT_Error )
2221  FT_New_Size( FT_Face   face,
2222               FT_Size  *asize )
2223  {
2224    FT_Error         error;
2225    FT_Memory        memory;
2226    FT_Driver        driver;
2227    FT_Driver_Class  clazz;
2228
2229    FT_Size          size = 0;
2230    FT_ListNode      node = 0;
2231
2232
2233    if ( !face )
2234      return FT_Err_Invalid_Face_Handle;
2235
2236    if ( !asize )
2237      return FT_Err_Invalid_Size_Handle;
2238
2239    if ( !face->driver )
2240      return FT_Err_Invalid_Driver_Handle;
2241
2242    *asize = 0;
2243
2244    driver = face->driver;
2245    clazz  = driver->clazz;
2246    memory = face->memory;
2247
2248    /* Allocate new size object and perform basic initialisation */
2249    if ( FT_ALLOC( size, clazz->size_object_size ) || FT_NEW( node ) )
2250      goto Exit;
2251
2252    size->face = face;
2253
2254    /* for now, do not use any internal fields in size objects */
2255    size->internal = 0;
2256
2257    if ( clazz->init_size )
2258      error = clazz->init_size( size );
2259
2260    /* in case of success, add to the face's list */
2261    if ( !error )
2262    {
2263      *asize     = size;
2264      node->data = size;
2265      FT_List_Add( &face->sizes_list, node );
2266    }
2267
2268  Exit:
2269    if ( error )
2270    {
2271      FT_FREE( node );
2272      FT_FREE( size );
2273    }
2274
2275    return error;
2276  }
2277
2278
2279  /* documentation is in ftobjs.h */
2280
2281  FT_EXPORT_DEF( FT_Error )
2282  FT_Done_Size( FT_Size  size )
2283  {
2284    FT_Error     error;
2285    FT_Driver    driver;
2286    FT_Memory    memory;
2287    FT_Face      face;
2288    FT_ListNode  node;
2289
2290
2291    if ( !size )
2292      return FT_Err_Invalid_Size_Handle;
2293
2294    face = size->face;
2295    if ( !face )
2296      return FT_Err_Invalid_Face_Handle;
2297
2298    driver = face->driver;
2299    if ( !driver )
2300      return FT_Err_Invalid_Driver_Handle;
2301
2302    memory = driver->root.memory;
2303
2304    error = FT_Err_Ok;
2305    node  = FT_List_Find( &face->sizes_list, size );
2306    if ( node )
2307    {
2308      FT_List_Remove( &face->sizes_list, node );
2309      FT_FREE( node );
2310
2311      if ( face->size == size )
2312      {
2313        face->size = 0;
2314        if ( face->sizes_list.head )
2315          face->size = (FT_Size)(face->sizes_list.head->data);
2316      }
2317
2318      destroy_size( memory, size, driver );
2319    }
2320    else
2321      error = FT_Err_Invalid_Size_Handle;
2322
2323    return error;
2324  }
2325
2326
2327  /* documentation is in ftobjs.h */
2328
2329  FT_BASE_DEF( FT_Error )
2330  FT_Match_Size( FT_Face          face,
2331                 FT_Size_Request  req,
2332                 FT_Bool          ignore_width,
2333                 FT_ULong*        size_index )
2334  {
2335    FT_Int   i;
2336    FT_Long  w, h;
2337
2338
2339    if ( !FT_HAS_FIXED_SIZES( face ) )
2340      return FT_Err_Invalid_Face_Handle;
2341
2342    /* FT_Bitmap_Size doesn't provide enough info... */
2343    if ( req->type != FT_SIZE_REQUEST_TYPE_NOMINAL )
2344      return FT_Err_Unimplemented_Feature;
2345
2346    w = FT_REQUEST_WIDTH ( req );
2347    h = FT_REQUEST_HEIGHT( req );
2348
2349    if ( req->width && !req->height )
2350      h = w;
2351    else if ( !req->width && req->height )
2352      w = h;
2353
2354    w = FT_PIX_ROUND( w );
2355    h = FT_PIX_ROUND( h );
2356
2357    for ( i = 0; i < face->num_fixed_sizes; i++ )
2358    {
2359      FT_Bitmap_Size*  bsize = face->available_sizes + i;
2360
2361
2362      if ( h != FT_PIX_ROUND( bsize->y_ppem ) )
2363        continue;
2364
2365      if ( w == FT_PIX_ROUND( bsize->x_ppem ) || ignore_width )
2366      {
2367        if ( size_index )
2368          *size_index = (FT_ULong)i;
2369
2370        return FT_Err_Ok;
2371      }
2372    }
2373
2374    return FT_Err_Invalid_Pixel_Size;
2375  }
2376
2377
2378  /* documentation is in ftobjs.h */
2379
2380  FT_BASE_DEF( void )
2381  ft_synthesize_vertical_metrics( FT_Glyph_Metrics*  metrics,
2382                                  FT_Pos             advance )
2383  {
2384    /* the factor 1.2 is a heuristical value */
2385    if ( !advance )
2386      advance = metrics->height * 12 / 10;
2387
2388    metrics->vertBearingX = -( metrics->width / 2 );
2389    metrics->vertBearingY = ( advance - metrics->height ) / 2;
2390    metrics->vertAdvance  = advance;
2391  }
2392
2393
2394  static void
2395  ft_recompute_scaled_metrics( FT_Face           face,
2396                               FT_Size_Metrics*  metrics )
2397  {
2398    /* Compute root ascender, descender, test height, and max_advance */
2399
2400#ifdef GRID_FIT_METRICS
2401    metrics->ascender    = FT_PIX_CEIL( FT_MulFix( face->ascender,
2402                                                   metrics->y_scale ) );
2403
2404    metrics->descender   = FT_PIX_FLOOR( FT_MulFix( face->descender,
2405                                                    metrics->y_scale ) );
2406
2407    metrics->height      = FT_PIX_ROUND( FT_MulFix( face->height,
2408                                                    metrics->y_scale ) );
2409
2410    metrics->max_advance = FT_PIX_ROUND( FT_MulFix( face->max_advance_width,
2411                                                    metrics->x_scale ) );
2412#else /* !GRID_FIT_METRICS */
2413    metrics->ascender    = FT_MulFix( face->ascender,
2414                                      metrics->y_scale );
2415
2416    metrics->descender   = FT_MulFix( face->descender,
2417                                      metrics->y_scale );
2418
2419    metrics->height      = FT_MulFix( face->height,
2420                                      metrics->y_scale );
2421
2422    metrics->max_advance = FT_MulFix( face->max_advance_width,
2423                                      metrics->x_scale );
2424#endif /* !GRID_FIT_METRICS */
2425  }
2426
2427
2428  FT_BASE_DEF( void )
2429  FT_Select_Metrics( FT_Face   face,
2430                     FT_ULong  strike_index )
2431  {
2432    FT_Size_Metrics*  metrics;
2433    FT_Bitmap_Size*   bsize;
2434
2435
2436    metrics = &face->size->metrics;
2437    bsize   = face->available_sizes + strike_index;
2438
2439    metrics->x_ppem = (FT_UShort)( ( bsize->x_ppem + 32 ) >> 6 );
2440    metrics->y_ppem = (FT_UShort)( ( bsize->y_ppem + 32 ) >> 6 );
2441
2442    if ( FT_IS_SCALABLE( face ) )
2443    {
2444      metrics->x_scale = FT_DivFix( bsize->x_ppem,
2445                                    face->units_per_EM );
2446      metrics->y_scale = FT_DivFix( bsize->y_ppem,
2447                                    face->units_per_EM );
2448
2449      ft_recompute_scaled_metrics( face, metrics );
2450    }
2451    else
2452    {
2453      metrics->x_scale     = 1L << 22;
2454      metrics->y_scale     = 1L << 22;
2455      metrics->ascender    = bsize->y_ppem;
2456      metrics->descender   = 0;
2457      metrics->height      = bsize->height << 6;
2458      metrics->max_advance = bsize->x_ppem;
2459    }
2460  }
2461
2462
2463  FT_BASE_DEF( void )
2464  FT_Request_Metrics( FT_Face          face,
2465                      FT_Size_Request  req )
2466  {
2467    FT_Size_Metrics*  metrics;
2468
2469
2470    metrics = &face->size->metrics;
2471
2472    if ( FT_IS_SCALABLE( face ) )
2473    {
2474      FT_Long  w = 0, h = 0, scaled_w = 0, scaled_h = 0;
2475
2476
2477      switch ( req->type )
2478      {
2479      case FT_SIZE_REQUEST_TYPE_NOMINAL:
2480        w = h = face->units_per_EM;
2481        break;
2482
2483      case FT_SIZE_REQUEST_TYPE_REAL_DIM:
2484        w = h = face->ascender - face->descender;
2485        break;
2486
2487      case FT_SIZE_REQUEST_TYPE_BBOX:
2488        w = face->bbox.xMax - face->bbox.xMin;
2489        h = face->bbox.yMax - face->bbox.yMin;
2490        break;
2491
2492      case FT_SIZE_REQUEST_TYPE_CELL:
2493        w = face->max_advance_width;
2494        h = face->ascender - face->descender;
2495        break;
2496
2497      case FT_SIZE_REQUEST_TYPE_SCALES:
2498        metrics->x_scale = (FT_Fixed)req->width;
2499        metrics->y_scale = (FT_Fixed)req->height;
2500        if ( !metrics->x_scale )
2501          metrics->x_scale = metrics->y_scale;
2502        else if ( !metrics->y_scale )
2503          metrics->y_scale = metrics->x_scale;
2504        goto Calculate_Ppem;
2505
2506      case FT_SIZE_REQUEST_TYPE_MAX:
2507        break;
2508      }
2509
2510      /* to be on the safe side */
2511      if ( w < 0 )
2512        w = -w;
2513
2514      if ( h < 0 )
2515        h = -h;
2516
2517      scaled_w = FT_REQUEST_WIDTH ( req );
2518      scaled_h = FT_REQUEST_HEIGHT( req );
2519
2520      /* determine scales */
2521      if ( req->width )
2522      {
2523        metrics->x_scale = FT_DivFix( scaled_w, w );
2524
2525        if ( req->height )
2526        {
2527          metrics->y_scale = FT_DivFix( scaled_h, h );
2528
2529          if ( req->type == FT_SIZE_REQUEST_TYPE_CELL )
2530          {
2531            if ( metrics->y_scale > metrics->x_scale )
2532              metrics->y_scale = metrics->x_scale;
2533            else
2534              metrics->x_scale = metrics->y_scale;
2535          }
2536        }
2537        else
2538        {
2539          metrics->y_scale = metrics->x_scale;
2540          scaled_h = FT_MulDiv( scaled_w, h, w );
2541        }
2542      }
2543      else
2544      {
2545        metrics->x_scale = metrics->y_scale = FT_DivFix( scaled_h, h );
2546        scaled_w = FT_MulDiv( scaled_h, w, h );
2547      }
2548
2549  Calculate_Ppem:
2550      /* calculate the ppems */
2551      if ( req->type != FT_SIZE_REQUEST_TYPE_NOMINAL )
2552      {
2553        scaled_w = FT_MulFix( face->units_per_EM, metrics->x_scale );
2554        scaled_h = FT_MulFix( face->units_per_EM, metrics->y_scale );
2555      }
2556
2557      metrics->x_ppem = (FT_UShort)( ( scaled_w + 32 ) >> 6 );
2558      metrics->y_ppem = (FT_UShort)( ( scaled_h + 32 ) >> 6 );
2559
2560      ft_recompute_scaled_metrics( face, metrics );
2561    }
2562    else
2563    {
2564      FT_ZERO( metrics );
2565      metrics->x_scale = 1L << 22;
2566      metrics->y_scale = 1L << 22;
2567    }
2568  }
2569
2570
2571  /* documentation is in freetype.h */
2572
2573  FT_EXPORT_DEF( FT_Error )
2574  FT_Select_Size( FT_Face  face,
2575                  FT_Int   strike_index )
2576  {
2577    FT_Driver_Class  clazz;
2578
2579
2580    if ( !face || !FT_HAS_FIXED_SIZES( face ) )
2581      return FT_Err_Invalid_Face_Handle;
2582
2583    if ( strike_index < 0 || strike_index >= face->num_fixed_sizes )
2584      return FT_Err_Invalid_Argument;
2585
2586    clazz = face->driver->clazz;
2587
2588    if ( clazz->select_size )
2589      return clazz->select_size( face->size, (FT_ULong)strike_index );
2590
2591    FT_Select_Metrics( face, (FT_ULong)strike_index );
2592
2593    return FT_Err_Ok;
2594  }
2595
2596
2597  /* documentation is in freetype.h */
2598
2599  FT_EXPORT_DEF( FT_Error )
2600  FT_Request_Size( FT_Face          face,
2601                   FT_Size_Request  req )
2602  {
2603    FT_Driver_Class  clazz;
2604    FT_ULong         strike_index;
2605
2606
2607    if ( !face )
2608      return FT_Err_Invalid_Face_Handle;
2609
2610    if ( !req || req->width < 0 || req->height < 0 ||
2611         req->type >= FT_SIZE_REQUEST_TYPE_MAX )
2612      return FT_Err_Invalid_Argument;
2613
2614    clazz = face->driver->clazz;
2615
2616    if ( clazz->request_size )
2617      return clazz->request_size( face->size, req );
2618
2619    /*
2620     * The reason that a driver doesn't have `request_size' defined is
2621     * either that the scaling here suffices or that the supported formats
2622     * are bitmap-only and size matching is not implemented.
2623     *
2624     * In the latter case, a simple size matching is done.
2625     */
2626    if ( !FT_IS_SCALABLE( face ) && FT_HAS_FIXED_SIZES( face ) )
2627    {
2628      FT_Error  error;
2629
2630
2631      error = FT_Match_Size( face, req, 0, &strike_index );
2632      if ( error )
2633        return error;
2634
2635      FT_TRACE3(( "FT_Request_Size: bitmap strike %lu matched\n",
2636                  strike_index ));
2637
2638      return FT_Select_Size( face, (FT_Int)strike_index );
2639    }
2640
2641    FT_Request_Metrics( face, req );
2642
2643    return FT_Err_Ok;
2644  }
2645
2646
2647  /* documentation is in freetype.h */
2648
2649  FT_EXPORT_DEF( FT_Error )
2650  FT_Set_Char_Size( FT_Face     face,
2651                    FT_F26Dot6  char_width,
2652                    FT_F26Dot6  char_height,
2653                    FT_UInt     horz_resolution,
2654                    FT_UInt     vert_resolution )
2655  {
2656    FT_Size_RequestRec  req;
2657
2658
2659    if ( !char_width )
2660      char_width = char_height;
2661    else if ( !char_height )
2662      char_height = char_width;
2663
2664    if ( !horz_resolution )
2665      horz_resolution = vert_resolution;
2666    else if ( !vert_resolution )
2667      vert_resolution = horz_resolution;
2668
2669    if ( char_width  < 1 * 64 )
2670      char_width  = 1 * 64;
2671    if ( char_height < 1 * 64 )
2672      char_height = 1 * 64;
2673
2674    if ( !horz_resolution )
2675      horz_resolution = vert_resolution = 72;
2676
2677    req.type           = FT_SIZE_REQUEST_TYPE_NOMINAL;
2678    req.width          = char_width;
2679    req.height         = char_height;
2680    req.horiResolution = horz_resolution;
2681    req.vertResolution = vert_resolution;
2682
2683    return FT_Request_Size( face, &req );
2684  }
2685
2686
2687  /* documentation is in freetype.h */
2688
2689  FT_EXPORT_DEF( FT_Error )
2690  FT_Set_Pixel_Sizes( FT_Face  face,
2691                      FT_UInt  pixel_width,
2692                      FT_UInt  pixel_height )
2693  {
2694    FT_Size_RequestRec  req;
2695
2696
2697    if ( pixel_width == 0 )
2698      pixel_width = pixel_height;
2699    else if ( pixel_height == 0 )
2700      pixel_height = pixel_width;
2701
2702    if ( pixel_width  < 1 )
2703      pixel_width  = 1;
2704    if ( pixel_height < 1 )
2705      pixel_height = 1;
2706
2707    /* use `>=' to avoid potential compiler warning on 16bit platforms */
2708    if ( pixel_width  >= 0xFFFFU )
2709      pixel_width  = 0xFFFFU;
2710    if ( pixel_height >= 0xFFFFU )
2711      pixel_height = 0xFFFFU;
2712
2713    req.type           = FT_SIZE_REQUEST_TYPE_NOMINAL;
2714    req.width          = pixel_width << 6;
2715    req.height         = pixel_height << 6;
2716    req.horiResolution = 0;
2717    req.vertResolution = 0;
2718
2719    return FT_Request_Size( face, &req );
2720  }
2721
2722
2723  /* documentation is in freetype.h */
2724
2725  FT_EXPORT_DEF( FT_Error )
2726  FT_Get_Kerning( FT_Face     face,
2727                  FT_UInt     left_glyph,
2728                  FT_UInt     right_glyph,
2729                  FT_UInt     kern_mode,
2730                  FT_Vector  *akerning )
2731  {
2732    FT_Error   error = FT_Err_Ok;
2733    FT_Driver  driver;
2734
2735
2736    if ( !face )
2737      return FT_Err_Invalid_Face_Handle;
2738
2739    if ( !akerning )
2740      return FT_Err_Invalid_Argument;
2741
2742    driver = face->driver;
2743
2744    akerning->x = 0;
2745    akerning->y = 0;
2746
2747    if ( driver->clazz->get_kerning )
2748    {
2749      error = driver->clazz->get_kerning( face,
2750                                          left_glyph,
2751                                          right_glyph,
2752                                          akerning );
2753      if ( !error )
2754      {
2755        if ( kern_mode != FT_KERNING_UNSCALED )
2756        {
2757          akerning->x = FT_MulFix( akerning->x, face->size->metrics.x_scale );
2758          akerning->y = FT_MulFix( akerning->y, face->size->metrics.y_scale );
2759
2760          if ( kern_mode != FT_KERNING_UNFITTED )
2761          {
2762            /* we scale down kerning values for small ppem values */
2763            /* to avoid that rounding makes them too big.         */
2764            /* `25' has been determined heuristically.            */
2765            if ( face->size->metrics.x_ppem < 25 )
2766              akerning->x = FT_MulDiv( akerning->x,
2767                                       face->size->metrics.x_ppem, 25 );
2768            if ( face->size->metrics.y_ppem < 25 )
2769              akerning->y = FT_MulDiv( akerning->y,
2770                                       face->size->metrics.y_ppem, 25 );
2771
2772            akerning->x = FT_PIX_ROUND( akerning->x );
2773            akerning->y = FT_PIX_ROUND( akerning->y );
2774          }
2775        }
2776      }
2777    }
2778
2779    return error;
2780  }
2781
2782
2783  /* documentation is in freetype.h */
2784
2785  FT_EXPORT_DEF( FT_Error )
2786  FT_Get_Track_Kerning( FT_Face    face,
2787                        FT_Fixed   point_size,
2788                        FT_Int     degree,
2789                        FT_Fixed*  akerning )
2790  {
2791    FT_Service_Kerning  service;
2792    FT_Error            error = FT_Err_Ok;
2793
2794
2795    if ( !face )
2796      return FT_Err_Invalid_Face_Handle;
2797
2798    if ( !akerning )
2799      return FT_Err_Invalid_Argument;
2800
2801    FT_FACE_FIND_SERVICE( face, service, KERNING );
2802    if ( !service )
2803      return FT_Err_Unimplemented_Feature;
2804
2805    error = service->get_track( face,
2806                                point_size,
2807                                degree,
2808                                akerning );
2809
2810    return error;
2811  }
2812
2813
2814  /* documentation is in freetype.h */
2815
2816  FT_EXPORT_DEF( FT_Error )
2817  FT_Select_Charmap( FT_Face      face,
2818                     FT_Encoding  encoding )
2819  {
2820    FT_CharMap*  cur;
2821    FT_CharMap*  limit;
2822
2823
2824    if ( !face )
2825      return FT_Err_Invalid_Face_Handle;
2826
2827    if ( encoding == FT_ENCODING_NONE )
2828      return FT_Err_Invalid_Argument;
2829
2830    /* FT_ENCODING_UNICODE is special.  We try to find the `best' Unicode */
2831    /* charmap available, i.e., one with UCS-4 characters, if possible.   */
2832    /*                                                                    */
2833    /* This is done by find_unicode_charmap() above, to share code.       */
2834    if ( encoding == FT_ENCODING_UNICODE )
2835      return find_unicode_charmap( face );
2836
2837    cur = face->charmaps;
2838    if ( !cur )
2839      return FT_Err_Invalid_CharMap_Handle;
2840
2841    limit = cur + face->num_charmaps;
2842
2843    for ( ; cur < limit; cur++ )
2844    {
2845      if ( cur[0]->encoding == encoding )
2846      {
2847        face->charmap = cur[0];
2848        return 0;
2849      }
2850    }
2851
2852    return FT_Err_Invalid_Argument;
2853  }
2854
2855
2856  /* documentation is in freetype.h */
2857
2858  FT_EXPORT_DEF( FT_Error )
2859  FT_Set_Charmap( FT_Face     face,
2860                  FT_CharMap  charmap )
2861  {
2862    FT_CharMap*  cur;
2863    FT_CharMap*  limit;
2864
2865
2866    if ( !face )
2867      return FT_Err_Invalid_Face_Handle;
2868
2869    cur = face->charmaps;
2870    if ( !cur )
2871      return FT_Err_Invalid_CharMap_Handle;
2872    if ( FT_Get_CMap_Format( charmap ) == 14 )
2873      return FT_Err_Invalid_Argument;
2874
2875    limit = cur + face->num_charmaps;
2876
2877    for ( ; cur < limit; cur++ )
2878    {
2879      if ( cur[0] == charmap )
2880      {
2881        face->charmap = cur[0];
2882        return 0;
2883      }
2884    }
2885    return FT_Err_Invalid_Argument;
2886  }
2887
2888
2889  /* documentation is in freetype.h */
2890
2891  FT_EXPORT_DEF( FT_Int )
2892  FT_Get_Charmap_Index( FT_CharMap  charmap )
2893  {
2894    FT_Int  i;
2895
2896
2897    for ( i = 0; i < charmap->face->num_charmaps; i++ )
2898      if ( charmap->face->charmaps[i] == charmap )
2899        break;
2900
2901    FT_ASSERT( i < charmap->face->num_charmaps );
2902
2903    return i;
2904  }
2905
2906
2907  static void
2908  ft_cmap_done_internal( FT_CMap  cmap )
2909  {
2910    FT_CMap_Class  clazz  = cmap->clazz;
2911    FT_Face        face   = cmap->charmap.face;
2912    FT_Memory      memory = FT_FACE_MEMORY(face);
2913
2914
2915    if ( clazz->done )
2916      clazz->done( cmap );
2917
2918    FT_FREE( cmap );
2919  }
2920
2921
2922  FT_BASE_DEF( void )
2923  FT_CMap_Done( FT_CMap  cmap )
2924  {
2925    if ( cmap )
2926    {
2927      FT_Face    face   = cmap->charmap.face;
2928      FT_Memory  memory = FT_FACE_MEMORY( face );
2929      FT_Error   error;
2930      FT_Int     i, j;
2931
2932
2933      for ( i = 0; i < face->num_charmaps; i++ )
2934      {
2935        if ( (FT_CMap)face->charmaps[i] == cmap )
2936        {
2937          FT_CharMap  last_charmap = face->charmaps[face->num_charmaps - 1];
2938
2939
2940          if ( FT_RENEW_ARRAY( face->charmaps,
2941                               face->num_charmaps,
2942                               face->num_charmaps - 1 ) )
2943            return;
2944
2945          /* remove it from our list of charmaps */
2946          for ( j = i + 1; j < face->num_charmaps; j++ )
2947          {
2948            if ( j == face->num_charmaps - 1 )
2949              face->charmaps[j - 1] = last_charmap;
2950            else
2951              face->charmaps[j - 1] = face->charmaps[j];
2952          }
2953
2954          face->num_charmaps--;
2955
2956          if ( (FT_CMap)face->charmap == cmap )
2957            face->charmap = NULL;
2958
2959          ft_cmap_done_internal( cmap );
2960
2961          break;
2962        }
2963      }
2964    }
2965  }
2966
2967
2968  FT_BASE_DEF( FT_Error )
2969  FT_CMap_New( FT_CMap_Class  clazz,
2970               FT_Pointer     init_data,
2971               FT_CharMap     charmap,
2972               FT_CMap       *acmap )
2973  {
2974    FT_Error   error = FT_Err_Ok;
2975    FT_Face    face;
2976    FT_Memory  memory;
2977    FT_CMap    cmap;
2978
2979
2980    if ( clazz == NULL || charmap == NULL || charmap->face == NULL )
2981      return FT_Err_Invalid_Argument;
2982
2983    face   = charmap->face;
2984    memory = FT_FACE_MEMORY( face );
2985
2986    if ( !FT_ALLOC( cmap, clazz->size ) )
2987    {
2988      cmap->charmap = *charmap;
2989      cmap->clazz   = clazz;
2990
2991      if ( clazz->init )
2992      {
2993        error = clazz->init( cmap, init_data );
2994        if ( error )
2995          goto Fail;
2996      }
2997
2998      /* add it to our list of charmaps */
2999      if ( FT_RENEW_ARRAY( face->charmaps,
3000                           face->num_charmaps,
3001                           face->num_charmaps + 1 ) )
3002        goto Fail;
3003
3004      face->charmaps[face->num_charmaps++] = (FT_CharMap)cmap;
3005    }
3006
3007  Exit:
3008    if ( acmap )
3009      *acmap = cmap;
3010
3011    return error;
3012
3013  Fail:
3014    ft_cmap_done_internal( cmap );
3015    cmap = NULL;
3016    goto Exit;
3017  }
3018
3019
3020  /* documentation is in freetype.h */
3021
3022  FT_EXPORT_DEF( FT_UInt )
3023  FT_Get_Char_Index( FT_Face   face,
3024                     FT_ULong  charcode )
3025  {
3026    FT_UInt  result = 0;
3027
3028
3029    if ( face && face->charmap )
3030    {
3031      FT_CMap  cmap = FT_CMAP( face->charmap );
3032
3033
3034      result = cmap->clazz->char_index( cmap, charcode );
3035    }
3036    return  result;
3037  }
3038
3039
3040  /* documentation is in freetype.h */
3041
3042  FT_EXPORT_DEF( FT_ULong )
3043  FT_Get_First_Char( FT_Face   face,
3044                     FT_UInt  *agindex )
3045  {
3046    FT_ULong  result = 0;
3047    FT_UInt   gindex = 0;
3048
3049
3050    if ( face && face->charmap )
3051    {
3052      gindex = FT_Get_Char_Index( face, 0 );
3053      if ( gindex == 0 )
3054        result = FT_Get_Next_Char( face, 0, &gindex );
3055    }
3056
3057    if ( agindex  )
3058      *agindex = gindex;
3059
3060    return result;
3061  }
3062
3063
3064  /* documentation is in freetype.h */
3065
3066  FT_EXPORT_DEF( FT_ULong )
3067  FT_Get_Next_Char( FT_Face   face,
3068                    FT_ULong  charcode,
3069                    FT_UInt  *agindex )
3070  {
3071    FT_ULong  result = 0;
3072    FT_UInt   gindex = 0;
3073
3074
3075    if ( face && face->charmap )
3076    {
3077      FT_UInt32  code = (FT_UInt32)charcode;
3078      FT_CMap    cmap = FT_CMAP( face->charmap );
3079
3080
3081      gindex = cmap->clazz->char_next( cmap, &code );
3082      result = ( gindex == 0 ) ? 0 : code;
3083    }
3084
3085    if ( agindex )
3086      *agindex = gindex;
3087
3088    return result;
3089  }
3090
3091
3092  /* documentation is in freetype.h */
3093
3094  FT_EXPORT_DEF( FT_UInt )
3095  FT_Face_GetCharVariantIndex( FT_Face   face,
3096                               FT_ULong  charcode,
3097                               FT_ULong  variantSelector )
3098  {
3099    FT_UInt  result = 0;
3100
3101
3102    if ( face && face->charmap &&
3103        face->charmap->encoding == FT_ENCODING_UNICODE )
3104    {
3105      FT_CharMap  charmap = find_variant_selector_charmap( face );
3106      FT_CMap     ucmap = FT_CMAP( face->charmap );
3107
3108
3109      if ( charmap != NULL )
3110      {
3111        FT_CMap  vcmap = FT_CMAP( charmap );
3112
3113
3114        result = vcmap->clazz->char_var_index( vcmap, ucmap, charcode,
3115                                               variantSelector );
3116      }
3117    }
3118
3119    return result;
3120  }
3121
3122
3123  /* documentation is in freetype.h */
3124
3125  FT_EXPORT_DEF( FT_Int )
3126  FT_Face_GetCharVariantIsDefault( FT_Face   face,
3127                                   FT_ULong  charcode,
3128                                   FT_ULong  variantSelector )
3129  {
3130    FT_Int  result = -1;
3131
3132
3133    if ( face )
3134    {
3135      FT_CharMap  charmap = find_variant_selector_charmap( face );
3136
3137
3138      if ( charmap != NULL )
3139      {
3140        FT_CMap  vcmap = FT_CMAP( charmap );
3141
3142
3143        result = vcmap->clazz->char_var_default( vcmap, charcode,
3144                                                 variantSelector );
3145      }
3146    }
3147
3148    return result;
3149  }
3150
3151
3152  /* documentation is in freetype.h */
3153
3154  FT_EXPORT_DEF( FT_UInt32* )
3155  FT_Face_GetVariantSelectors( FT_Face  face )
3156  {
3157    FT_UInt32  *result = NULL;
3158
3159
3160    if ( face )
3161    {
3162      FT_CharMap  charmap = find_variant_selector_charmap( face );
3163
3164
3165      if ( charmap != NULL )
3166      {
3167        FT_CMap    vcmap  = FT_CMAP( charmap );
3168        FT_Memory  memory = FT_FACE_MEMORY( face );
3169
3170
3171        result = vcmap->clazz->variant_list( vcmap, memory );
3172      }
3173    }
3174
3175    return result;
3176  }
3177
3178
3179  /* documentation is in freetype.h */
3180
3181  FT_EXPORT_DEF( FT_UInt32* )
3182  FT_Face_GetVariantsOfChar( FT_Face   face,
3183                             FT_ULong  charcode )
3184  {
3185    FT_UInt32  *result = NULL;
3186
3187
3188    if ( face )
3189    {
3190      FT_CharMap  charmap = find_variant_selector_charmap( face );
3191
3192
3193      if ( charmap != NULL )
3194      {
3195        FT_CMap    vcmap  = FT_CMAP( charmap );
3196        FT_Memory  memory = FT_FACE_MEMORY( face );
3197
3198
3199        result = vcmap->clazz->charvariant_list( vcmap, memory, charcode );
3200      }
3201    }
3202    return result;
3203  }
3204
3205
3206  /* documentation is in freetype.h */
3207
3208  FT_EXPORT_DEF( FT_UInt32* )
3209  FT_Face_GetCharsOfVariant( FT_Face   face,
3210                             FT_ULong  variantSelector )
3211  {
3212    FT_UInt32  *result = NULL;
3213
3214
3215    if ( face )
3216    {
3217      FT_CharMap  charmap = find_variant_selector_charmap( face );
3218
3219
3220      if ( charmap != NULL )
3221      {
3222        FT_CMap    vcmap  = FT_CMAP( charmap );
3223        FT_Memory  memory = FT_FACE_MEMORY( face );
3224
3225
3226        result = vcmap->clazz->variantchar_list( vcmap, memory,
3227                                                 variantSelector );
3228      }
3229    }
3230
3231    return result;
3232  }
3233
3234
3235  /* documentation is in freetype.h */
3236
3237  FT_EXPORT_DEF( FT_UInt )
3238  FT_Get_Name_Index( FT_Face     face,
3239                     FT_String*  glyph_name )
3240  {
3241    FT_UInt  result = 0;
3242
3243
3244    if ( face && FT_HAS_GLYPH_NAMES( face ) )
3245    {
3246      FT_Service_GlyphDict  service;
3247
3248
3249      FT_FACE_LOOKUP_SERVICE( face,
3250                              service,
3251                              GLYPH_DICT );
3252
3253      if ( service && service->name_index )
3254        result = service->name_index( face, glyph_name );
3255    }
3256
3257    return result;
3258  }
3259
3260
3261  /* documentation is in freetype.h */
3262
3263  FT_EXPORT_DEF( FT_Error )
3264  FT_Get_Glyph_Name( FT_Face     face,
3265                     FT_UInt     glyph_index,
3266                     FT_Pointer  buffer,
3267                     FT_UInt     buffer_max )
3268  {
3269    FT_Error  error = FT_Err_Invalid_Argument;
3270
3271
3272    /* clean up buffer */
3273    if ( buffer && buffer_max > 0 )
3274      ((FT_Byte*)buffer)[0] = 0;
3275
3276    if ( face                                     &&
3277         glyph_index <= (FT_UInt)face->num_glyphs &&
3278         FT_HAS_GLYPH_NAMES( face )               )
3279    {
3280      FT_Service_GlyphDict  service;
3281
3282
3283      FT_FACE_LOOKUP_SERVICE( face,
3284                              service,
3285                              GLYPH_DICT );
3286
3287      if ( service && service->get_name )
3288        error = service->get_name( face, glyph_index, buffer, buffer_max );
3289    }
3290
3291    return error;
3292  }
3293
3294
3295  /* documentation is in freetype.h */
3296
3297  FT_EXPORT_DEF( const char* )
3298  FT_Get_Postscript_Name( FT_Face  face )
3299  {
3300    const char*  result = NULL;
3301
3302
3303    if ( !face )
3304      goto Exit;
3305
3306    if ( !result )
3307    {
3308      FT_Service_PsFontName  service;
3309
3310
3311      FT_FACE_LOOKUP_SERVICE( face,
3312                              service,
3313                              POSTSCRIPT_FONT_NAME );
3314
3315      if ( service && service->get_ps_font_name )
3316        result = service->get_ps_font_name( face );
3317    }
3318
3319  Exit:
3320    return result;
3321  }
3322
3323
3324  /* documentation is in tttables.h */
3325
3326  FT_EXPORT_DEF( void* )
3327  FT_Get_Sfnt_Table( FT_Face      face,
3328                     FT_Sfnt_Tag  tag )
3329  {
3330    void*                  table = 0;
3331    FT_Service_SFNT_Table  service;
3332
3333
3334    if ( face && FT_IS_SFNT( face ) )
3335    {
3336      FT_FACE_FIND_SERVICE( face, service, SFNT_TABLE );
3337      if ( service != NULL )
3338        table = service->get_table( face, tag );
3339    }
3340
3341    return table;
3342  }
3343
3344
3345  /* documentation is in tttables.h */
3346
3347  FT_EXPORT_DEF( FT_Error )
3348  FT_Load_Sfnt_Table( FT_Face    face,
3349                      FT_ULong   tag,
3350                      FT_Long    offset,
3351                      FT_Byte*   buffer,
3352                      FT_ULong*  length )
3353  {
3354    FT_Service_SFNT_Table  service;
3355
3356
3357    if ( !face || !FT_IS_SFNT( face ) )
3358      return FT_Err_Invalid_Face_Handle;
3359
3360    FT_FACE_FIND_SERVICE( face, service, SFNT_TABLE );
3361    if ( service == NULL )
3362      return FT_Err_Unimplemented_Feature;
3363
3364    return service->load_table( face, tag, offset, buffer, length );
3365  }
3366
3367
3368  /* documentation is in tttables.h */
3369
3370  FT_EXPORT_DEF( FT_Error )
3371  FT_Sfnt_Table_Info( FT_Face    face,
3372                      FT_UInt    table_index,
3373                      FT_ULong  *tag,
3374                      FT_ULong  *length )
3375  {
3376    FT_Service_SFNT_Table  service;
3377
3378
3379    if ( !face || !FT_IS_SFNT( face ) )
3380      return FT_Err_Invalid_Face_Handle;
3381
3382    FT_FACE_FIND_SERVICE( face, service, SFNT_TABLE );
3383    if ( service == NULL )
3384      return FT_Err_Unimplemented_Feature;
3385
3386    return service->table_info( face, table_index, tag, length );
3387  }
3388
3389
3390  /* documentation is in tttables.h */
3391
3392  FT_EXPORT_DEF( FT_ULong )
3393  FT_Get_CMap_Language_ID( FT_CharMap  charmap )
3394  {
3395    FT_Service_TTCMaps  service;
3396    FT_Face             face;
3397    TT_CMapInfo         cmap_info;
3398
3399
3400    if ( !charmap || !charmap->face )
3401      return 0;
3402
3403    face = charmap->face;
3404    FT_FACE_FIND_SERVICE( face, service, TT_CMAP );
3405    if ( service == NULL )
3406      return 0;
3407    if ( service->get_cmap_info( charmap, &cmap_info ))
3408      return 0;
3409
3410    return cmap_info.language;
3411  }
3412
3413
3414  /* documentation is in tttables.h */
3415
3416  FT_EXPORT_DEF( FT_Long )
3417  FT_Get_CMap_Format( FT_CharMap  charmap )
3418  {
3419    FT_Service_TTCMaps  service;
3420    FT_Face             face;
3421    TT_CMapInfo         cmap_info;
3422
3423
3424    if ( !charmap || !charmap->face )
3425      return -1;
3426
3427    face = charmap->face;
3428    FT_FACE_FIND_SERVICE( face, service, TT_CMAP );
3429    if ( service == NULL )
3430      return -1;
3431    if ( service->get_cmap_info( charmap, &cmap_info ))
3432      return -1;
3433
3434    return cmap_info.format;
3435  }
3436
3437
3438  /* documentation is in ftsizes.h */
3439
3440  FT_EXPORT_DEF( FT_Error )
3441  FT_Activate_Size( FT_Size  size )
3442  {
3443    FT_Face  face;
3444
3445
3446    if ( size == NULL )
3447      return FT_Err_Invalid_Argument;
3448
3449    face = size->face;
3450    if ( face == NULL || face->driver == NULL )
3451      return FT_Err_Invalid_Argument;
3452
3453    /* we don't need anything more complex than that; all size objects */
3454    /* are already listed by the face                                  */
3455    face->size = size;
3456
3457    return FT_Err_Ok;
3458  }
3459
3460
3461  /*************************************************************************/
3462  /*************************************************************************/
3463  /*************************************************************************/
3464  /****                                                                 ****/
3465  /****                                                                 ****/
3466  /****                        R E N D E R E R S                        ****/
3467  /****                                                                 ****/
3468  /****                                                                 ****/
3469  /*************************************************************************/
3470  /*************************************************************************/
3471  /*************************************************************************/
3472
3473  /* lookup a renderer by glyph format in the library's list */
3474  FT_BASE_DEF( FT_Renderer )
3475  FT_Lookup_Renderer( FT_Library       library,
3476                      FT_Glyph_Format  format,
3477                      FT_ListNode*     node )
3478  {
3479    FT_ListNode  cur;
3480    FT_Renderer  result = 0;
3481
3482
3483    if ( !library )
3484      goto Exit;
3485
3486    cur = library->renderers.head;
3487
3488    if ( node )
3489    {
3490      if ( *node )
3491        cur = (*node)->next;
3492      *node = 0;
3493    }
3494
3495    while ( cur )
3496    {
3497      FT_Renderer  renderer = FT_RENDERER( cur->data );
3498
3499
3500      if ( renderer->glyph_format == format )
3501      {
3502        if ( node )
3503          *node = cur;
3504
3505        result = renderer;
3506        break;
3507      }
3508      cur = cur->next;
3509    }
3510
3511  Exit:
3512    return result;
3513  }
3514
3515
3516  static FT_Renderer
3517  ft_lookup_glyph_renderer( FT_GlyphSlot  slot )
3518  {
3519    FT_Face      face    = slot->face;
3520    FT_Library   library = FT_FACE_LIBRARY( face );
3521    FT_Renderer  result  = library->cur_renderer;
3522
3523
3524    if ( !result || result->glyph_format != slot->format )
3525      result = FT_Lookup_Renderer( library, slot->format, 0 );
3526
3527    return result;
3528  }
3529
3530
3531  static void
3532  ft_set_current_renderer( FT_Library  library )
3533  {
3534    FT_Renderer  renderer;
3535
3536
3537    renderer = FT_Lookup_Renderer( library, FT_GLYPH_FORMAT_OUTLINE, 0 );
3538    library->cur_renderer = renderer;
3539  }
3540
3541
3542  static FT_Error
3543  ft_add_renderer( FT_Module  module )
3544  {
3545    FT_Library   library = module->library;
3546    FT_Memory    memory  = library->memory;
3547    FT_Error     error;
3548    FT_ListNode  node;
3549
3550
3551    if ( FT_NEW( node ) )
3552      goto Exit;
3553
3554    {
3555      FT_Renderer         render = FT_RENDERER( module );
3556      FT_Renderer_Class*  clazz  = (FT_Renderer_Class*)module->clazz;
3557
3558
3559      render->clazz        = clazz;
3560      render->glyph_format = clazz->glyph_format;
3561
3562      /* allocate raster object if needed */
3563      if ( clazz->glyph_format == FT_GLYPH_FORMAT_OUTLINE &&
3564           clazz->raster_class->raster_new )
3565      {
3566        error = clazz->raster_class->raster_new( memory, &render->raster );
3567        if ( error )
3568          goto Fail;
3569
3570        render->raster_render = clazz->raster_class->raster_render;
3571        render->render        = clazz->render_glyph;
3572      }
3573
3574      /* add to list */
3575      node->data = module;
3576      FT_List_Add( &library->renderers, node );
3577
3578      ft_set_current_renderer( library );
3579    }
3580
3581  Fail:
3582    if ( error )
3583      FT_FREE( node );
3584
3585  Exit:
3586    return error;
3587  }
3588
3589
3590  static void
3591  ft_remove_renderer( FT_Module  module )
3592  {
3593    FT_Library   library = module->library;
3594    FT_Memory    memory  = library->memory;
3595    FT_ListNode  node;
3596
3597
3598    node = FT_List_Find( &library->renderers, module );
3599    if ( node )
3600    {
3601      FT_Renderer  render = FT_RENDERER( module );
3602
3603
3604      /* release raster object, if any */
3605      if ( render->raster )
3606        render->clazz->raster_class->raster_done( render->raster );
3607
3608      /* remove from list */
3609      FT_List_Remove( &library->renderers, node );
3610      FT_FREE( node );
3611
3612      ft_set_current_renderer( library );
3613    }
3614  }
3615
3616
3617  /* documentation is in ftrender.h */
3618
3619  FT_EXPORT_DEF( FT_Renderer )
3620  FT_Get_Renderer( FT_Library       library,
3621                   FT_Glyph_Format  format )
3622  {
3623    /* test for valid `library' delayed to FT_Lookup_Renderer() */
3624
3625    return FT_Lookup_Renderer( library, format, 0 );
3626  }
3627
3628
3629  /* documentation is in ftrender.h */
3630
3631  FT_EXPORT_DEF( FT_Error )
3632  FT_Set_Renderer( FT_Library     library,
3633                   FT_Renderer    renderer,
3634                   FT_UInt        num_params,
3635                   FT_Parameter*  parameters )
3636  {
3637    FT_ListNode  node;
3638    FT_Error     error = FT_Err_Ok;
3639
3640
3641    if ( !library )
3642      return FT_Err_Invalid_Library_Handle;
3643
3644    if ( !renderer )
3645      return FT_Err_Invalid_Argument;
3646
3647    node = FT_List_Find( &library->renderers, renderer );
3648    if ( !node )
3649    {
3650      error = FT_Err_Invalid_Argument;
3651      goto Exit;
3652    }
3653
3654    FT_List_Up( &library->renderers, node );
3655
3656    if ( renderer->glyph_format == FT_GLYPH_FORMAT_OUTLINE )
3657      library->cur_renderer = renderer;
3658
3659    if ( num_params > 0 )
3660    {
3661      FT_Renderer_SetModeFunc  set_mode = renderer->clazz->set_mode;
3662
3663
3664      for ( ; num_params > 0; num_params-- )
3665      {
3666        error = set_mode( renderer, parameters->tag, parameters->data );
3667        if ( error )
3668          break;
3669      }
3670    }
3671
3672  Exit:
3673    return error;
3674  }
3675
3676
3677  FT_BASE_DEF( FT_Error )
3678  FT_Render_Glyph_Internal( FT_Library      library,
3679                            FT_GlyphSlot    slot,
3680                            FT_Render_Mode  render_mode )
3681  {
3682    FT_Error     error = FT_Err_Ok;
3683    FT_Renderer  renderer;
3684
3685
3686    /* if it is already a bitmap, no need to do anything */
3687    switch ( slot->format )
3688    {
3689    case FT_GLYPH_FORMAT_BITMAP:   /* already a bitmap, don't do anything */
3690      break;
3691
3692    default:
3693      {
3694        FT_ListNode  node   = 0;
3695        FT_Bool      update = 0;
3696
3697
3698        /* small shortcut for the very common case */
3699        if ( slot->format == FT_GLYPH_FORMAT_OUTLINE )
3700        {
3701          renderer = library->cur_renderer;
3702          node     = library->renderers.head;
3703        }
3704        else
3705          renderer = FT_Lookup_Renderer( library, slot->format, &node );
3706
3707        error = FT_Err_Unimplemented_Feature;
3708        while ( renderer )
3709        {
3710          error = renderer->render( renderer, slot, render_mode, NULL );
3711          if ( !error ||
3712               FT_ERROR_BASE( error ) != FT_Err_Cannot_Render_Glyph )
3713            break;
3714
3715          /* FT_Err_Cannot_Render_Glyph is returned if the render mode   */
3716          /* is unsupported by the current renderer for this glyph image */
3717          /* format.                                                     */
3718
3719          /* now, look for another renderer that supports the same */
3720          /* format.                                               */
3721          renderer = FT_Lookup_Renderer( library, slot->format, &node );
3722          update   = 1;
3723        }
3724
3725        /* if we changed the current renderer for the glyph image format */
3726        /* we need to select it as the next current one                  */
3727        if ( !error && update && renderer )
3728          FT_Set_Renderer( library, renderer, 0, 0 );
3729      }
3730    }
3731
3732    return error;
3733  }
3734
3735
3736  /* documentation is in freetype.h */
3737
3738  FT_EXPORT_DEF( FT_Error )
3739  FT_Render_Glyph( FT_GlyphSlot    slot,
3740                   FT_Render_Mode  render_mode )
3741  {
3742    FT_Library  library;
3743
3744
3745    if ( !slot )
3746      return FT_Err_Invalid_Argument;
3747
3748    library = FT_FACE_LIBRARY( slot->face );
3749
3750    return FT_Render_Glyph_Internal( library, slot, render_mode );
3751  }
3752
3753
3754  /*************************************************************************/
3755  /*************************************************************************/
3756  /*************************************************************************/
3757  /****                                                                 ****/
3758  /****                                                                 ****/
3759  /****                         M O D U L E S                           ****/
3760  /****                                                                 ****/
3761  /****                                                                 ****/
3762  /*************************************************************************/
3763  /*************************************************************************/
3764  /*************************************************************************/
3765
3766
3767  /*************************************************************************/
3768  /*                                                                       */
3769  /* <Function>                                                            */
3770  /*    Destroy_Module                                                     */
3771  /*                                                                       */
3772  /* <Description>                                                         */
3773  /*    Destroys a given module object.  For drivers, this also destroys   */
3774  /*    all child faces.                                                   */
3775  /*                                                                       */
3776  /* <InOut>                                                               */
3777  /*     module :: A handle to the target driver object.                   */
3778  /*                                                                       */
3779  /* <Note>                                                                */
3780  /*     The driver _must_ be LOCKED!                                      */
3781  /*                                                                       */
3782  static void
3783  Destroy_Module( FT_Module  module )
3784  {
3785    FT_Memory         memory  = module->memory;
3786    FT_Module_Class*  clazz   = module->clazz;
3787    FT_Library        library = module->library;
3788
3789
3790    /* finalize client-data - before anything else */
3791    if ( module->generic.finalizer )
3792      module->generic.finalizer( module );
3793
3794    if ( library && library->auto_hinter == module )
3795      library->auto_hinter = 0;
3796
3797    /* if the module is a renderer */
3798    if ( FT_MODULE_IS_RENDERER( module ) )
3799      ft_remove_renderer( module );
3800
3801    /* if the module is a font driver, add some steps */
3802    if ( FT_MODULE_IS_DRIVER( module ) )
3803      Destroy_Driver( FT_DRIVER( module ) );
3804
3805    /* finalize the module object */
3806    if ( clazz->module_done )
3807      clazz->module_done( module );
3808
3809    /* discard it */
3810    FT_FREE( module );
3811  }
3812
3813
3814  /* documentation is in ftmodapi.h */
3815
3816  FT_EXPORT_DEF( FT_Error )
3817  FT_Add_Module( FT_Library              library,
3818                 const FT_Module_Class*  clazz )
3819  {
3820    FT_Error   error;
3821    FT_Memory  memory;
3822    FT_Module  module;
3823    FT_UInt    nn;
3824
3825
3826#define FREETYPE_VER_FIXED  ( ( (FT_Long)FREETYPE_MAJOR << 16 ) | \
3827                                FREETYPE_MINOR                  )
3828
3829    if ( !library )
3830      return FT_Err_Invalid_Library_Handle;
3831
3832    if ( !clazz )
3833      return FT_Err_Invalid_Argument;
3834
3835    /* check freetype version */
3836    if ( clazz->module_requires > FREETYPE_VER_FIXED )
3837      return FT_Err_Invalid_Version;
3838
3839    /* look for a module with the same name in the library's table */
3840    for ( nn = 0; nn < library->num_modules; nn++ )
3841    {
3842      module = library->modules[nn];
3843      if ( ft_strcmp( module->clazz->module_name, clazz->module_name ) == 0 )
3844      {
3845        /* this installed module has the same name, compare their versions */
3846        if ( clazz->module_version <= module->clazz->module_version )
3847          return FT_Err_Lower_Module_Version;
3848
3849        /* remove the module from our list, then exit the loop to replace */
3850        /* it by our new version..                                        */
3851        FT_Remove_Module( library, module );
3852        break;
3853      }
3854    }
3855
3856    memory = library->memory;
3857    error  = FT_Err_Ok;
3858
3859    if ( library->num_modules >= FT_MAX_MODULES )
3860    {
3861      error = FT_Err_Too_Many_Drivers;
3862      goto Exit;
3863    }
3864
3865    /* allocate module object */
3866    if ( FT_ALLOC( module, clazz->module_size ) )
3867      goto Exit;
3868
3869    /* base initialization */
3870    module->library = library;
3871    module->memory  = memory;
3872    module->clazz   = (FT_Module_Class*)clazz;
3873
3874    /* check whether the module is a renderer - this must be performed */
3875    /* before the normal module initialization                         */
3876    if ( FT_MODULE_IS_RENDERER( module ) )
3877    {
3878      /* add to the renderers list */
3879      error = ft_add_renderer( module );
3880      if ( error )
3881        goto Fail;
3882    }
3883
3884    /* is the module a auto-hinter? */
3885    if ( FT_MODULE_IS_HINTER( module ) )
3886      library->auto_hinter = module;
3887
3888    /* if the module is a font driver */
3889    if ( FT_MODULE_IS_DRIVER( module ) )
3890    {
3891      /* allocate glyph loader if needed */
3892      FT_Driver  driver = FT_DRIVER( module );
3893
3894
3895      driver->clazz = (FT_Driver_Class)module->clazz;
3896      if ( FT_DRIVER_USES_OUTLINES( driver ) )
3897      {
3898        error = FT_GlyphLoader_New( memory, &driver->glyph_loader );
3899        if ( error )
3900          goto Fail;
3901      }
3902    }
3903
3904    if ( clazz->module_init )
3905    {
3906      error = clazz->module_init( module );
3907      if ( error )
3908        goto Fail;
3909    }
3910
3911    /* add module to the library's table */
3912    library->modules[library->num_modules++] = module;
3913
3914  Exit:
3915    return error;
3916
3917  Fail:
3918    if ( FT_MODULE_IS_DRIVER( module ) )
3919    {
3920      FT_Driver  driver = FT_DRIVER( module );
3921
3922
3923      if ( FT_DRIVER_USES_OUTLINES( driver ) )
3924        FT_GlyphLoader_Done( driver->glyph_loader );
3925    }
3926
3927    if ( FT_MODULE_IS_RENDERER( module ) )
3928    {
3929      FT_Renderer  renderer = FT_RENDERER( module );
3930
3931
3932      if ( renderer->raster )
3933        renderer->clazz->raster_class->raster_done( renderer->raster );
3934    }
3935
3936    FT_FREE( module );
3937    goto Exit;
3938  }
3939
3940
3941  /* documentation is in ftmodapi.h */
3942
3943  FT_EXPORT_DEF( FT_Module )
3944  FT_Get_Module( FT_Library   library,
3945                 const char*  module_name )
3946  {
3947    FT_Module   result = 0;
3948    FT_Module*  cur;
3949    FT_Module*  limit;
3950
3951
3952    if ( !library || !module_name )
3953      return result;
3954
3955    cur   = library->modules;
3956    limit = cur + library->num_modules;
3957
3958    for ( ; cur < limit; cur++ )
3959      if ( ft_strcmp( cur[0]->clazz->module_name, module_name ) == 0 )
3960      {
3961        result = cur[0];
3962        break;
3963      }
3964
3965    return result;
3966  }
3967
3968
3969  /* documentation is in ftobjs.h */
3970
3971  FT_BASE_DEF( const void* )
3972  FT_Get_Module_Interface( FT_Library   library,
3973                           const char*  mod_name )
3974  {
3975    FT_Module  module;
3976
3977
3978    /* test for valid `library' delayed to FT_Get_Module() */
3979
3980    module = FT_Get_Module( library, mod_name );
3981
3982    return module ? module->clazz->module_interface : 0;
3983  }
3984
3985
3986  FT_BASE_DEF( FT_Pointer )
3987  ft_module_get_service( FT_Module    module,
3988                         const char*  service_id )
3989  {
3990    FT_Pointer  result = NULL;
3991
3992    if ( module )
3993    {
3994      FT_ASSERT( module->clazz && module->clazz->get_interface );
3995
3996     /* first, look for the service in the module
3997      */
3998      if ( module->clazz->get_interface )
3999        result = module->clazz->get_interface( module, service_id );
4000
4001      if ( result == NULL )
4002      {
4003       /* we didn't find it, look in all other modules then
4004        */
4005        FT_Library  library = module->library;
4006        FT_Module*  cur     = library->modules;
4007        FT_Module*  limit   = cur + library->num_modules;
4008
4009        for ( ; cur < limit; cur++ )
4010        {
4011          if ( cur[0] != module )
4012          {
4013            FT_ASSERT( cur[0]->clazz );
4014
4015            if ( cur[0]->clazz->get_interface )
4016            {
4017              result = cur[0]->clazz->get_interface( cur[0], service_id );
4018              if ( result != NULL )
4019                break;
4020            }
4021          }
4022        }
4023      }
4024    }
4025
4026    return result;
4027  }
4028
4029
4030  /* documentation is in ftmodapi.h */
4031
4032  FT_EXPORT_DEF( FT_Error )
4033  FT_Remove_Module( FT_Library  library,
4034                    FT_Module   module )
4035  {
4036    /* try to find the module from the table, then remove it from there */
4037
4038    if ( !library )
4039      return FT_Err_Invalid_Library_Handle;
4040
4041    if ( module )
4042    {
4043      FT_Module*  cur   = library->modules;
4044      FT_Module*  limit = cur + library->num_modules;
4045
4046
4047      for ( ; cur < limit; cur++ )
4048      {
4049        if ( cur[0] == module )
4050        {
4051          /* remove it from the table */
4052          library->num_modules--;
4053          limit--;
4054          while ( cur < limit )
4055          {
4056            cur[0] = cur[1];
4057            cur++;
4058          }
4059          limit[0] = 0;
4060
4061          /* destroy the module */
4062          Destroy_Module( module );
4063
4064          return FT_Err_Ok;
4065        }
4066      }
4067    }
4068    return FT_Err_Invalid_Driver_Handle;
4069  }
4070
4071
4072  /*************************************************************************/
4073  /*************************************************************************/
4074  /*************************************************************************/
4075  /****                                                                 ****/
4076  /****                                                                 ****/
4077  /****                         L I B R A R Y                           ****/
4078  /****                                                                 ****/
4079  /****                                                                 ****/
4080  /*************************************************************************/
4081  /*************************************************************************/
4082  /*************************************************************************/
4083
4084
4085  /* documentation is in ftmodapi.h */
4086
4087  FT_EXPORT_DEF( FT_Error )
4088  FT_New_Library( FT_Memory    memory,
4089                  FT_Library  *alibrary )
4090  {
4091    FT_Library  library = 0;
4092    FT_Error    error;
4093
4094
4095    if ( !memory )
4096      return FT_Err_Invalid_Argument;
4097
4098#ifdef FT_DEBUG_LEVEL_ERROR
4099    /* init debugging support */
4100    ft_debug_init();
4101#endif
4102
4103    /* first of all, allocate the library object */
4104    if ( FT_NEW( library ) )
4105      return error;
4106
4107    library->memory = memory;
4108
4109    /* allocate the render pool */
4110    library->raster_pool_size = FT_RENDER_POOL_SIZE;
4111#if FT_RENDER_POOL_SIZE > 0
4112    if ( FT_ALLOC( library->raster_pool, FT_RENDER_POOL_SIZE ) )
4113      goto Fail;
4114#endif
4115
4116    /* That's ok now */
4117    *alibrary = library;
4118
4119    return FT_Err_Ok;
4120
4121  Fail:
4122    FT_FREE( library );
4123    return error;
4124  }
4125
4126
4127  /* documentation is in freetype.h */
4128
4129  FT_EXPORT_DEF( void )
4130  FT_Library_Version( FT_Library   library,
4131                      FT_Int      *amajor,
4132                      FT_Int      *aminor,
4133                      FT_Int      *apatch )
4134  {
4135    FT_Int  major = 0;
4136    FT_Int  minor = 0;
4137    FT_Int  patch = 0;
4138
4139
4140    if ( library )
4141    {
4142      major = library->version_major;
4143      minor = library->version_minor;
4144      patch = library->version_patch;
4145    }
4146
4147    if ( amajor )
4148      *amajor = major;
4149
4150    if ( aminor )
4151      *aminor = minor;
4152
4153    if ( apatch )
4154      *apatch = patch;
4155  }
4156
4157
4158  /* documentation is in ftmodapi.h */
4159
4160  FT_EXPORT_DEF( FT_Error )
4161  FT_Done_Library( FT_Library  library )
4162  {
4163    FT_Memory  memory;
4164
4165
4166    if ( !library )
4167      return FT_Err_Invalid_Library_Handle;
4168
4169    memory = library->memory;
4170
4171    /* Discard client-data */
4172    if ( library->generic.finalizer )
4173      library->generic.finalizer( library );
4174
4175    /* Close all faces in the library.  If we don't do
4176     * this, we can have some subtle memory leaks.
4177     * Example:
4178     *
4179     *  - the cff font driver uses the pshinter module in cff_size_done
4180     *  - if the pshinter module is destroyed before the cff font driver,
4181     *    opened FT_Face objects managed by the driver are not properly
4182     *    destroyed, resulting in a memory leak
4183     */
4184    {
4185      FT_UInt  n;
4186
4187
4188      for ( n = 0; n < library->num_modules; n++ )
4189      {
4190        FT_Module  module = library->modules[n];
4191        FT_List    faces;
4192
4193
4194        if ( ( module->clazz->module_flags & FT_MODULE_FONT_DRIVER ) == 0 )
4195          continue;
4196
4197        faces = &FT_DRIVER(module)->faces_list;
4198        while ( faces->head )
4199        {
4200          FT_Done_Face( FT_FACE( faces->head->data ) );
4201          if ( faces->head )
4202            FT_ERROR(( "FT_Done_Library: failed to free some faces\n" ));
4203        }
4204      }
4205    }
4206
4207    /* Close all other modules in the library */
4208#if 1
4209    /* XXX Modules are removed in the reversed order so that  */
4210    /* type42 module is removed before truetype module.  This */
4211    /* avoids double free in some occasions.  It is a hack.   */
4212    while ( library->num_modules > 0 )
4213      FT_Remove_Module( library,
4214                        library->modules[library->num_modules - 1] );
4215#else
4216    {
4217      FT_UInt  n;
4218
4219
4220      for ( n = 0; n < library->num_modules; n++ )
4221      {
4222        FT_Module  module = library->modules[n];
4223
4224
4225        if ( module )
4226        {
4227          Destroy_Module( module );
4228          library->modules[n] = 0;
4229        }
4230      }
4231    }
4232#endif
4233
4234    /* Destroy raster objects */
4235    FT_FREE( library->raster_pool );
4236    library->raster_pool_size = 0;
4237
4238    FT_FREE( library );
4239    return FT_Err_Ok;
4240  }
4241
4242
4243  /* documentation is in ftmodapi.h */
4244
4245  FT_EXPORT_DEF( void )
4246  FT_Set_Debug_Hook( FT_Library         library,
4247                     FT_UInt            hook_index,
4248                     FT_DebugHook_Func  debug_hook )
4249  {
4250    if ( library && debug_hook &&
4251         hook_index <
4252           ( sizeof ( library->debug_hooks ) / sizeof ( void* ) ) )
4253      library->debug_hooks[hook_index] = debug_hook;
4254  }
4255
4256
4257  /* documentation is in ftmodapi.h */
4258
4259  FT_EXPORT_DEF( FT_TrueTypeEngineType )
4260  FT_Get_TrueType_Engine_Type( FT_Library  library )
4261  {
4262    FT_TrueTypeEngineType  result = FT_TRUETYPE_ENGINE_TYPE_NONE;
4263
4264
4265    if ( library )
4266    {
4267      FT_Module  module = FT_Get_Module( library, "truetype" );
4268
4269
4270      if ( module )
4271      {
4272        FT_Service_TrueTypeEngine  service;
4273
4274
4275        service = (FT_Service_TrueTypeEngine)
4276                    ft_module_get_service( module,
4277                                           FT_SERVICE_ID_TRUETYPE_ENGINE );
4278        if ( service )
4279          result = service->engine_type;
4280      }
4281    }
4282
4283    return result;
4284  }
4285
4286
4287#ifdef FT_CONFIG_OPTION_OLD_INTERNALS
4288
4289  FT_BASE_DEF( FT_Error )
4290  ft_stub_set_char_sizes( FT_Size     size,
4291                          FT_F26Dot6  width,
4292                          FT_F26Dot6  height,
4293                          FT_UInt     horz_res,
4294                          FT_UInt     vert_res )
4295  {
4296    FT_Size_RequestRec  req;
4297    FT_Driver           driver = size->face->driver;
4298
4299
4300    if ( driver->clazz->request_size )
4301    {
4302      req.type   = FT_SIZE_REQUEST_TYPE_NOMINAL;
4303      req.width  = width;
4304      req.height = height;
4305
4306      if ( horz_res == 0 )
4307        horz_res = vert_res;
4308
4309      if ( vert_res == 0 )
4310        vert_res = horz_res;
4311
4312      if ( horz_res == 0 )
4313        horz_res = vert_res = 72;
4314
4315      req.horiResolution = horz_res;
4316      req.vertResolution = vert_res;
4317
4318      return driver->clazz->request_size( size, &req );
4319    }
4320
4321    return 0;
4322  }
4323
4324
4325  FT_BASE_DEF( FT_Error )
4326  ft_stub_set_pixel_sizes( FT_Size  size,
4327                           FT_UInt  width,
4328                           FT_UInt  height )
4329  {
4330    FT_Size_RequestRec  req;
4331    FT_Driver           driver = size->face->driver;
4332
4333
4334    if ( driver->clazz->request_size )
4335    {
4336      req.type           = FT_SIZE_REQUEST_TYPE_NOMINAL;
4337      req.width          = width  << 6;
4338      req.height         = height << 6;
4339      req.horiResolution = 0;
4340      req.vertResolution = 0;
4341
4342      return driver->clazz->request_size( size, &req );
4343    }
4344
4345    return 0;
4346  }
4347
4348#endif /* FT_CONFIG_OPTION_OLD_INTERNALS */
4349
4350
4351  FT_EXPORT_DEF( FT_Error )
4352  FT_Get_SubGlyph_Info( FT_GlyphSlot  glyph,
4353                        FT_UInt       sub_index,
4354                        FT_Int       *p_index,
4355                        FT_UInt      *p_flags,
4356                        FT_Int       *p_arg1,
4357                        FT_Int       *p_arg2,
4358                        FT_Matrix    *p_transform )
4359  {
4360    FT_Error  error = FT_Err_Invalid_Argument;
4361
4362
4363    if ( glyph != NULL                              &&
4364         glyph->format == FT_GLYPH_FORMAT_COMPOSITE &&
4365         sub_index < glyph->num_subglyphs           )
4366    {
4367      FT_SubGlyph  subg = glyph->subglyphs + sub_index;
4368
4369
4370      *p_index     = subg->index;
4371      *p_flags     = subg->flags;
4372      *p_arg1      = subg->arg1;
4373      *p_arg2      = subg->arg2;
4374      *p_transform = subg->transform;
4375    }
4376
4377    return error;
4378  }
4379
4380
4381  /* documentation is in freetype.h */
4382
4383  FT_EXPORT_DEF( FT_UShort )
4384  FT_Get_FSType_Flags( FT_Face  face )
4385  {
4386    PS_FontInfoRec  font_info;
4387    TT_OS2*         os2;
4388
4389
4390    /* look at FSType before fsType for Type42 */
4391
4392    if ( !FT_Get_PS_Font_Info( face, &font_info ) &&
4393         font_info.fs_type != 0                   )
4394      return font_info.fs_type;
4395
4396    if ( ( os2 = (TT_OS2*)FT_Get_Sfnt_Table( face, ft_sfnt_os2 ) ) != NULL &&
4397         os2->version != 0xFFFFU                                           )
4398      return os2->fsType;
4399
4400    return 0;
4401  }
4402
4403
4404/* END */
Note: See TracBrowser for help on using the repository browser.