source: trunk/poppler/freetype-2.1.10/src/base/ftobjs.c @ 2

Last change on this file since 2 was 2, checked in by Eugene Romanenko, 15 years ago

First import

File size: 90.8 KB
Line 
1/***************************************************************************/
2/*                                                                         */
3/*  ftobjs.c                                                               */
4/*                                                                         */
5/*    The FreeType private base classes (body).                            */
6/*                                                                         */
7/*  Copyright 1996-2001, 2002, 2003, 2004, 2005 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_IDS_H
30#include FT_OUTLINE_H
31
32#include FT_SERVICE_SFNT_H
33#include FT_SERVICE_POSTSCRIPT_NAME_H
34#include FT_SERVICE_GLYPH_DICT_H
35#include FT_SERVICE_TT_CMAP_H
36
37
38  FT_BASE_DEF( FT_Pointer )
39  ft_service_list_lookup( FT_ServiceDesc  service_descriptors,
40                          const char*     service_id )
41  {
42    FT_Pointer      result = NULL;
43    FT_ServiceDesc  desc   = service_descriptors;
44
45
46    if ( desc && service_id )
47    {
48      for ( ; desc->serv_id != NULL; desc++ )
49      {
50        if ( ft_strcmp( desc->serv_id, service_id ) == 0 )
51        {
52          result = (FT_Pointer)desc->serv_data;
53          break;
54        }
55      }
56    }
57
58    return result;
59  }
60
61
62  FT_BASE_DEF( void )
63  ft_validator_init( FT_Validator        valid,
64                     const FT_Byte*      base,
65                     const FT_Byte*      limit,
66                     FT_ValidationLevel  level )
67  {
68    valid->base  = base;
69    valid->limit = limit;
70    valid->level = level;
71    valid->error = FT_Err_Ok;
72  }
73
74
75  FT_BASE_DEF( FT_Int )
76  ft_validator_run( FT_Validator  valid )
77  {
78    int  result;
79
80
81    result = ft_setjmp( valid->jump_buffer );
82    return result;
83  }
84
85
86  FT_BASE_DEF( void )
87  ft_validator_error( FT_Validator  valid,
88                      FT_Error      error )
89  {
90    valid->error = error;
91    ft_longjmp( valid->jump_buffer, 1 );
92  }
93
94
95  /*************************************************************************/
96  /*************************************************************************/
97  /*************************************************************************/
98  /****                                                                 ****/
99  /****                                                                 ****/
100  /****                           S T R E A M                           ****/
101  /****                                                                 ****/
102  /****                                                                 ****/
103  /*************************************************************************/
104  /*************************************************************************/
105  /*************************************************************************/
106
107
108  /* create a new input stream from an FT_Open_Args structure */
109  /*                                                          */
110  FT_BASE_DEF( FT_Error )
111  FT_Stream_New( FT_Library           library,
112                 const FT_Open_Args*  args,
113                 FT_Stream           *astream )
114  {
115    FT_Error   error;
116    FT_Memory  memory;
117    FT_Stream  stream;
118
119
120    if ( !library )
121      return FT_Err_Invalid_Library_Handle;
122
123    if ( !args )
124      return FT_Err_Invalid_Argument;
125
126    *astream = 0;
127    memory   = library->memory;
128
129    if ( FT_NEW( stream ) )
130      goto Exit;
131
132    stream->memory = memory;
133
134    if ( args->flags & FT_OPEN_MEMORY )
135    {
136      /* create a memory-based stream */
137      FT_Stream_OpenMemory( stream,
138                            (const FT_Byte*)args->memory_base,
139                            args->memory_size );
140    }
141    else if ( args->flags & FT_OPEN_PATHNAME )
142    {
143      /* create a normal system stream */
144      error = FT_Stream_Open( stream, args->pathname );
145      stream->pathname.pointer = args->pathname;
146    }
147    else if ( ( args->flags & FT_OPEN_STREAM ) && args->stream )
148    {
149      /* use an existing, user-provided stream */
150
151      /* in this case, we do not need to allocate a new stream object */
152      /* since the caller is responsible for closing it himself       */
153      FT_FREE( stream );
154      stream = args->stream;
155    }
156    else
157      error = FT_Err_Invalid_Argument;
158
159    if ( error )
160      FT_FREE( stream );
161    else
162      stream->memory = memory;  /* just to be certain */
163
164    *astream = stream;
165
166  Exit:
167    return error;
168  }
169
170
171  FT_BASE_DEF( void )
172  FT_Stream_Free( FT_Stream  stream,
173                  FT_Int     external )
174  {
175    if ( stream )
176    {
177      FT_Memory  memory = stream->memory;
178
179
180      FT_Stream_Close( stream );
181
182      if ( !external )
183        FT_FREE( stream );
184    }
185  }
186
187
188#undef  FT_COMPONENT
189#define FT_COMPONENT  trace_objs
190
191
192  /*************************************************************************/
193  /*************************************************************************/
194  /*************************************************************************/
195  /****                                                                 ****/
196  /****                                                                 ****/
197  /****               FACE, SIZE & GLYPH SLOT OBJECTS                   ****/
198  /****                                                                 ****/
199  /****                                                                 ****/
200  /*************************************************************************/
201  /*************************************************************************/
202  /*************************************************************************/
203
204
205  static FT_Error
206  ft_glyphslot_init( FT_GlyphSlot  slot )
207  {
208    FT_Driver         driver = slot->face->driver;
209    FT_Driver_Class   clazz  = driver->clazz;
210    FT_Memory         memory = driver->root.memory;
211    FT_Error          error  = FT_Err_Ok;
212    FT_Slot_Internal  internal;
213
214
215    slot->library = driver->root.library;
216
217    if ( FT_NEW( internal ) )
218      goto Exit;
219
220    slot->internal = internal;
221
222    if ( FT_DRIVER_USES_OUTLINES( driver ) )
223      error = FT_GlyphLoader_New( memory, &internal->loader );
224
225    if ( !error && clazz->init_slot )
226      error = clazz->init_slot( slot );
227
228  Exit:
229    return error;
230  }
231
232
233  FT_BASE_DEF( void )
234  ft_glyphslot_free_bitmap( FT_GlyphSlot  slot )
235  {
236    if ( slot->internal->flags & FT_GLYPH_OWN_BITMAP )
237    {
238      FT_Memory  memory = FT_FACE_MEMORY( slot->face );
239
240
241      FT_FREE( slot->bitmap.buffer );
242      slot->internal->flags &= ~FT_GLYPH_OWN_BITMAP;
243    }
244    else
245    {
246      /* assume that the bitmap buffer was stolen or not */
247      /* allocated from the heap                         */
248      slot->bitmap.buffer = NULL;
249    }
250  }
251
252
253  FT_BASE_DEF( void )
254  ft_glyphslot_set_bitmap( FT_GlyphSlot  slot,
255                           FT_Byte*      buffer )
256  {
257    ft_glyphslot_free_bitmap( slot );
258
259    slot->bitmap.buffer = buffer;
260
261    FT_ASSERT( (slot->internal->flags & FT_GLYPH_OWN_BITMAP) == 0 );
262  }
263
264
265  FT_BASE_DEF( FT_Error )
266  ft_glyphslot_alloc_bitmap( FT_GlyphSlot  slot,
267                             FT_ULong      size )
268  {
269    FT_Memory  memory = FT_FACE_MEMORY( slot->face );
270
271
272    if ( slot->internal->flags & FT_GLYPH_OWN_BITMAP )
273      FT_FREE( slot->bitmap.buffer );
274    else
275      slot->internal->flags |= FT_GLYPH_OWN_BITMAP;
276
277    return FT_MEM_ALLOC( slot->bitmap.buffer, size );
278  }
279
280
281  static void
282  ft_glyphslot_clear( FT_GlyphSlot  slot )
283  {
284    /* free bitmap if needed */
285    ft_glyphslot_free_bitmap( slot );
286
287    /* clear all public fields in the glyph slot */
288    FT_ZERO( &slot->metrics );
289    FT_ZERO( &slot->outline );
290
291    slot->bitmap.width      = 0;
292    slot->bitmap.rows       = 0;
293    slot->bitmap.pitch      = 0;
294    slot->bitmap.pixel_mode = 0;
295    /* `slot->bitmap.buffer' has been handled by ft_glyphslot_free_bitmap */
296
297    slot->bitmap_left   = 0;
298    slot->bitmap_top    = 0;
299    slot->num_subglyphs = 0;
300    slot->subglyphs     = 0;
301    slot->control_data  = 0;
302    slot->control_len   = 0;
303    slot->other         = 0;
304    slot->format        = FT_GLYPH_FORMAT_NONE;
305
306    slot->linearHoriAdvance = 0;
307    slot->linearVertAdvance = 0;
308    slot->lsb_delta         = 0;
309    slot->rsb_delta         = 0;
310  }
311
312
313  static void
314  ft_glyphslot_done( FT_GlyphSlot  slot )
315  {
316    FT_Driver         driver = slot->face->driver;
317    FT_Driver_Class   clazz  = driver->clazz;
318    FT_Memory         memory = driver->root.memory;
319
320
321    if ( clazz->done_slot )
322      clazz->done_slot( slot );
323
324    /* free bitmap buffer if needed */
325    ft_glyphslot_free_bitmap( slot );
326
327    /* free glyph loader */
328    if ( FT_DRIVER_USES_OUTLINES( driver ) )
329    {
330      FT_GlyphLoader_Done( slot->internal->loader );
331      slot->internal->loader = 0;
332    }
333
334    FT_FREE( slot->internal );
335  }
336
337
338  /* documentation is in ftobjs.h */
339
340  FT_BASE_DEF( FT_Error )
341  FT_New_GlyphSlot( FT_Face        face,
342                    FT_GlyphSlot  *aslot )
343  {
344    FT_Error          error;
345    FT_Driver         driver;
346    FT_Driver_Class   clazz;
347    FT_Memory         memory;
348    FT_GlyphSlot      slot;
349
350
351    if ( !face || !face->driver )
352      return FT_Err_Invalid_Argument;
353
354    driver = face->driver;
355    clazz  = driver->clazz;
356    memory = driver->root.memory;
357
358    FT_TRACE4(( "FT_New_GlyphSlot: Creating new slot object\n" ));
359    if ( !FT_ALLOC( slot, clazz->slot_object_size ) )
360    {
361      slot->face = face;
362
363      error = ft_glyphslot_init( slot );
364      if ( error )
365      {
366        ft_glyphslot_done( slot );
367        FT_FREE( slot );
368        goto Exit;
369      }
370
371      slot->next  = face->glyph;
372      face->glyph = slot;
373
374      if ( aslot )
375        *aslot = slot;
376    }
377    else if ( aslot )
378      *aslot = 0;
379
380
381  Exit:
382    FT_TRACE4(( "FT_New_GlyphSlot: Return %d\n", error ));
383    return error;
384  }
385
386
387  /* documentation is in ftobjs.h */
388
389  FT_BASE_DEF( void )
390  FT_Done_GlyphSlot( FT_GlyphSlot  slot )
391  {
392    if ( slot )
393    {
394      FT_Driver     driver = slot->face->driver;
395      FT_Memory     memory = driver->root.memory;
396      FT_GlyphSlot  prev;
397      FT_GlyphSlot  cur;
398
399
400      /* Remove slot from its parent face's list */
401      prev = NULL;
402      cur  = slot->face->glyph;
403
404      while ( cur )
405      {
406        if ( cur == slot )
407        {
408          if ( !prev )
409            slot->face->glyph = cur->next;
410          else
411            prev->next = cur->next;
412
413          ft_glyphslot_done( slot );
414          FT_FREE( slot );
415          break;
416        }
417        prev = cur;
418        cur  = cur->next;
419      }
420    }
421  }
422
423
424  /* documentation is in freetype.h */
425
426  FT_EXPORT_DEF( void )
427  FT_Set_Transform( FT_Face     face,
428                    FT_Matrix*  matrix,
429                    FT_Vector*  delta )
430  {
431    FT_Face_Internal  internal;
432
433
434    if ( !face )
435      return;
436
437    internal = face->internal;
438
439    internal->transform_flags = 0;
440
441    if ( !matrix )
442    {
443      internal->transform_matrix.xx = 0x10000L;
444      internal->transform_matrix.xy = 0;
445      internal->transform_matrix.yx = 0;
446      internal->transform_matrix.yy = 0x10000L;
447      matrix = &internal->transform_matrix;
448    }
449    else
450      internal->transform_matrix = *matrix;
451
452    /* set transform_flags bit flag 0 if `matrix' isn't the identity */
453    if ( ( matrix->xy | matrix->yx ) ||
454         matrix->xx != 0x10000L      ||
455         matrix->yy != 0x10000L      )
456      internal->transform_flags |= 1;
457
458    if ( !delta )
459    {
460      internal->transform_delta.x = 0;
461      internal->transform_delta.y = 0;
462      delta = &internal->transform_delta;
463    }
464    else
465      internal->transform_delta = *delta;
466
467    /* set transform_flags bit flag 1 if `delta' isn't the null vector */
468    if ( delta->x | delta->y )
469      internal->transform_flags |= 2;
470  }
471
472
473  static FT_Renderer
474  ft_lookup_glyph_renderer( FT_GlyphSlot  slot );
475
476
477  /* documentation is in freetype.h */
478
479  FT_EXPORT_DEF( FT_Error )
480  FT_Load_Glyph( FT_Face   face,
481                 FT_UInt   glyph_index,
482                 FT_Int32  load_flags )
483  {
484    FT_Error      error;
485    FT_Driver     driver;
486    FT_GlyphSlot  slot;
487    FT_Library    library;
488    FT_Bool       autohint;
489    FT_Module     hinter;
490
491
492    if ( !face || !face->size || !face->glyph )
493      return FT_Err_Invalid_Face_Handle;
494
495    if ( glyph_index >= (FT_UInt)face->num_glyphs )
496      return FT_Err_Invalid_Argument;
497
498    slot = face->glyph;
499    ft_glyphslot_clear( slot );
500
501    driver = face->driver;
502
503    /* if the flag NO_RECURSE is set, we disable hinting and scaling */
504    if ( load_flags & FT_LOAD_NO_RECURSE )
505    {
506      /* disable scaling, hinting, and transformation */
507      load_flags |= FT_LOAD_NO_SCALE         |
508                    FT_LOAD_NO_HINTING       |
509                    FT_LOAD_NO_BITMAP        |
510                    FT_LOAD_IGNORE_TRANSFORM;
511
512      /* disable bitmap rendering */
513      load_flags &= ~FT_LOAD_RENDER;
514    }
515
516    /* do we need to load the glyph through the auto-hinter? */
517    library  = driver->root.library;
518    hinter   = library->auto_hinter;
519    autohint =
520      FT_BOOL( hinter                                      &&
521               !( load_flags & ( FT_LOAD_NO_SCALE    |
522                                 FT_LOAD_NO_HINTING  |
523                                 FT_LOAD_NO_AUTOHINT ) )   &&
524               FT_DRIVER_IS_SCALABLE( driver )             &&
525               FT_DRIVER_USES_OUTLINES( driver )           );
526    if ( autohint )
527    {
528      if ( FT_DRIVER_HAS_HINTER( driver ) &&
529           !( load_flags & FT_LOAD_FORCE_AUTOHINT ) )
530        autohint = 0;
531    }
532
533    /* don't apply autohinting if glyph is vertically distorted or */
534    /* mirrored                                                    */
535    if ( autohint && !( face->internal->transform_matrix.yy <= 0 ||
536                        face->internal->transform_matrix.yx != 0 ) )
537    {
538      FT_AutoHinter_Service  hinting;
539
540
541      /* try to load embedded bitmaps first if available            */
542      /*                                                            */
543      /* XXX: This is really a temporary hack that should disappear */
544      /*      promptly with FreeType 2.1!                           */
545      /*                                                            */
546      if ( FT_HAS_FIXED_SIZES( face )             &&
547          ( load_flags & FT_LOAD_NO_BITMAP ) == 0 )
548      {
549        error = driver->clazz->load_glyph( slot, face->size,
550                                           glyph_index,
551                                           load_flags | FT_LOAD_SBITS_ONLY );
552
553        if ( !error && slot->format == FT_GLYPH_FORMAT_BITMAP )
554          goto Load_Ok;
555      }
556
557      /* load auto-hinted outline */
558      hinting = (FT_AutoHinter_Service)hinter->clazz->module_interface;
559
560      error   = hinting->load_glyph( (FT_AutoHinter)hinter,
561                                     slot, face->size,
562                                     glyph_index, load_flags );
563    }
564    else
565    {
566      error = driver->clazz->load_glyph( slot,
567                                         face->size,
568                                         glyph_index,
569                                         load_flags );
570      if ( error )
571        goto Exit;
572
573      /* check that the loaded outline is correct */
574      error = FT_Outline_Check( &slot->outline );
575      if ( error )
576        goto Exit;
577    }
578
579  Load_Ok:
580    /* compute the advance */
581    if ( load_flags & FT_LOAD_VERTICAL_LAYOUT )
582    {
583      slot->advance.x = 0;
584      slot->advance.y = slot->metrics.vertAdvance;
585    }
586    else
587    {
588      slot->advance.x = slot->metrics.horiAdvance;
589      slot->advance.y = 0;
590    }
591
592    /* compute the linear advance in 16.16 pixels */
593    if ( ( load_flags & FT_LOAD_LINEAR_DESIGN ) == 0  &&
594         ( face->face_flags & FT_FACE_FLAG_SCALABLE ) )
595    {
596      FT_Size_Metrics*  metrics = &face->size->metrics;
597
598
599      slot->linearHoriAdvance = FT_MulDiv( slot->linearHoriAdvance,
600                                           metrics->x_scale, 64 );
601
602      slot->linearVertAdvance = FT_MulDiv( slot->linearVertAdvance,
603                                           metrics->y_scale, 64 );
604    }
605
606    if ( ( load_flags & FT_LOAD_IGNORE_TRANSFORM ) == 0 )
607    {
608      FT_Face_Internal  internal = face->internal;
609
610
611      /* now, transform the glyph image if needed */
612      if ( internal->transform_flags )
613      {
614        /* get renderer */
615        FT_Renderer  renderer = ft_lookup_glyph_renderer( slot );
616
617
618        if ( renderer )
619          error = renderer->clazz->transform_glyph(
620                                     renderer, slot,
621                                     &internal->transform_matrix,
622                                     &internal->transform_delta );
623        /* transform advance */
624        FT_Vector_Transform( &slot->advance, &internal->transform_matrix );
625      }
626    }
627
628    /* do we need to render the image now? */
629    if ( !error                                    &&
630         slot->format != FT_GLYPH_FORMAT_BITMAP    &&
631         slot->format != FT_GLYPH_FORMAT_COMPOSITE &&
632         load_flags & FT_LOAD_RENDER )
633    {
634      FT_Render_Mode  mode = FT_LOAD_TARGET_MODE( load_flags );
635
636
637      if ( mode == FT_RENDER_MODE_NORMAL      &&
638           (load_flags & FT_LOAD_MONOCHROME ) )
639        mode = FT_RENDER_MODE_MONO;
640
641      error = FT_Render_Glyph( slot, mode );
642    }
643
644  Exit:
645    return error;
646  }
647
648
649  /* documentation is in freetype.h */
650
651  FT_EXPORT_DEF( FT_Error )
652  FT_Load_Char( FT_Face   face,
653                FT_ULong  char_code,
654                FT_Int32  load_flags )
655  {
656    FT_UInt  glyph_index;
657
658
659    if ( !face )
660      return FT_Err_Invalid_Face_Handle;
661
662    glyph_index = (FT_UInt)char_code;
663    if ( face->charmap )
664      glyph_index = FT_Get_Char_Index( face, char_code );
665
666    return FT_Load_Glyph( face, glyph_index, load_flags );
667  }
668
669
670  /* destructor for sizes list */
671  static void
672  destroy_size( FT_Memory  memory,
673                FT_Size    size,
674                FT_Driver  driver )
675  {
676    /* finalize client-specific data */
677    if ( size->generic.finalizer )
678      size->generic.finalizer( size );
679
680    /* finalize format-specific stuff */
681    if ( driver->clazz->done_size )
682      driver->clazz->done_size( size );
683
684    FT_FREE( size->internal );
685    FT_FREE( size );
686  }
687
688
689  static void
690  ft_cmap_done_internal( FT_CMap  cmap );
691
692
693  static void
694  destroy_charmaps( FT_Face    face,
695                    FT_Memory  memory )
696  {
697    FT_Int  n;
698
699
700    for ( n = 0; n < face->num_charmaps; n++ )
701    {
702      FT_CMap  cmap = FT_CMAP( face->charmaps[n] );
703
704
705      ft_cmap_done_internal( cmap );
706
707      face->charmaps[n] = NULL;
708    }
709
710    FT_FREE( face->charmaps );
711    face->num_charmaps = 0;
712  }
713
714
715  /* destructor for faces list */
716  static void
717  destroy_face( FT_Memory  memory,
718                FT_Face    face,
719                FT_Driver  driver )
720  {
721    FT_Driver_Class  clazz = driver->clazz;
722
723
724    /* discard auto-hinting data */
725    if ( face->autohint.finalizer )
726      face->autohint.finalizer( face->autohint.data );
727
728    /* Discard glyph slots for this face.                           */
729    /* Beware!  FT_Done_GlyphSlot() changes the field `face->glyph' */
730    while ( face->glyph )
731      FT_Done_GlyphSlot( face->glyph );
732
733    /* discard all sizes for this face */
734    FT_List_Finalize( &face->sizes_list,
735                      (FT_List_Destructor)destroy_size,
736                      memory,
737                      driver );
738    face->size = 0;
739
740    /* now discard client data */
741    if ( face->generic.finalizer )
742      face->generic.finalizer( face );
743
744    /* discard charmaps */
745    destroy_charmaps( face, memory );
746
747    /* finalize format-specific stuff */
748    if ( clazz->done_face )
749      clazz->done_face( face );
750
751    /* close the stream for this face if needed */
752    FT_Stream_Free(
753      face->stream,
754      ( face->face_flags & FT_FACE_FLAG_EXTERNAL_STREAM ) != 0 );
755
756    face->stream = 0;
757
758    /* get rid of it */
759    if ( face->internal )
760    {
761      FT_FREE( face->internal );
762    }
763    FT_FREE( face );
764  }
765
766
767  static void
768  Destroy_Driver( FT_Driver  driver )
769  {
770    FT_List_Finalize( &driver->faces_list,
771                      (FT_List_Destructor)destroy_face,
772                      driver->root.memory,
773                      driver );
774
775    /* check whether we need to drop the driver's glyph loader */
776    if ( FT_DRIVER_USES_OUTLINES( driver ) )
777      FT_GlyphLoader_Done( driver->glyph_loader );
778  }
779
780
781  /*************************************************************************/
782  /*                                                                       */
783  /* <Function>                                                            */
784  /*    find_unicode_charmap                                               */
785  /*                                                                       */
786  /* <Description>                                                         */
787  /*    This function finds a Unicode charmap, if there is one.            */
788  /*    And if there is more than one, it tries to favour the more         */
789  /*    extensive one, i.e., one that supports UCS-4 against those which   */
790  /*    are limited to the BMP (said UCS-2 encoding.)                      */
791  /*                                                                       */
792  /*    This function is called from open_face() (just below), and also    */
793  /*    from FT_Select_Charmap( ..., FT_ENCODING_UNICODE).                 */
794  /*                                                                       */
795  static FT_Error
796  find_unicode_charmap( FT_Face  face )
797  {
798    FT_CharMap*  first;
799    FT_CharMap*  cur;
800    FT_CharMap*  unicmap = NULL;  /* some UCS-2 map, if we found it */
801
802
803    /* caller should have already checked that `face' is valid */
804    FT_ASSERT( face );
805
806    first = face->charmaps;
807
808    if ( !first )
809      return FT_Err_Invalid_CharMap_Handle;
810
811    /*
812     *  The original TrueType specification(s) only specified charmap
813     *  formats that are capable of mapping 8 or 16 bit character codes to
814     *  glyph indices.
815     *
816     *  However, recent updates to the Apple and OpenType specifications
817     *  introduced new formats that are capable of mapping 32-bit character
818     *  codes as well.  And these are already used on some fonts, mainly to
819     *  map non-BMP Asian ideographs as defined in Unicode.
820     *
821     *  For compatibility purposes, these fonts generally come with
822     *  *several* Unicode charmaps:
823     *
824     *   - One of them in the "old" 16-bit format, that cannot access
825     *     all glyphs in the font.
826     *
827     *   - Another one in the "new" 32-bit format, that can access all
828     *     the glyphs.
829     *
830     *  This function has been written to always favor a 32-bit charmap
831     *  when found.  Otherwise, a 16-bit one is returned when found.
832     */
833
834    /* Since the `interesting' table, with IDs (3,10), is normally the */
835    /* last one, we loop backwards.  This looses with type1 fonts with */
836    /* non-BMP characters (<.0001%), this wins with .ttf with non-BMP  */
837    /* chars (.01% ?), and this is the same about 99.99% of the time!  */
838
839    cur = first + face->num_charmaps;  /* points after the last one */
840
841    for ( ; --cur >= first; )
842    {
843      if ( cur[0]->encoding == FT_ENCODING_UNICODE )
844      {
845        unicmap = cur;  /* record we found a Unicode charmap */
846
847        /* XXX If some new encodings to represent UCS-4 are added,  */
848        /*     they should be added here.                           */
849        if ( ( cur[0]->platform_id == TT_PLATFORM_MICROSOFT &&
850               cur[0]->encoding_id == TT_MS_ID_UCS_4        )          ||
851             ( cur[0]->platform_id == TT_PLATFORM_APPLE_UNICODE &&
852               cur[0]->encoding_id == TT_APPLE_ID_UNICODE_32    )      )
853
854        /* Hurray!  We found a UCS-4 charmap.  We can stop the scan! */
855        {
856          face->charmap = cur[0];
857          return 0;
858        }
859      }
860    }
861
862    /* We do not have any UCS-4 charmap.  Sigh.                         */
863    /* Let's see if we have some other kind of Unicode charmap, though. */
864    if ( unicmap != NULL )
865    {
866      face->charmap = unicmap[0];
867      return 0;
868    }
869
870    /* Chou blanc! */
871    return FT_Err_Invalid_CharMap_Handle;
872  }
873
874
875  /*************************************************************************/
876  /*                                                                       */
877  /* <Function>                                                            */
878  /*    open_face                                                          */
879  /*                                                                       */
880  /* <Description>                                                         */
881  /*    This function does some work for FT_Open_Face().                   */
882  /*                                                                       */
883  static FT_Error
884  open_face( FT_Driver      driver,
885             FT_Stream      stream,
886             FT_Long        face_index,
887             FT_Int         num_params,
888             FT_Parameter*  params,
889             FT_Face       *aface )
890  {
891    FT_Memory         memory;
892    FT_Driver_Class   clazz;
893    FT_Face           face = 0;
894    FT_Error          error, error2;
895    FT_Face_Internal  internal;
896
897
898    clazz  = driver->clazz;
899    memory = driver->root.memory;
900
901    /* allocate the face object and perform basic initialization */
902    if ( FT_ALLOC( face, clazz->face_object_size ) )
903      goto Fail;
904
905    if ( FT_NEW( internal ) )
906      goto Fail;
907
908    face->internal = internal;
909
910    face->driver   = driver;
911    face->memory   = memory;
912    face->stream   = stream;
913
914#ifdef FT_CONFIG_OPTION_INCREMENTAL
915    {
916      int  i;
917
918
919      face->internal->incremental_interface = 0;
920      for ( i = 0; i < num_params && !face->internal->incremental_interface;
921            i++ )
922        if ( params[i].tag == FT_PARAM_TAG_INCREMENTAL )
923          face->internal->incremental_interface = params[i].data;
924    }
925#endif
926
927    error = clazz->init_face( stream,
928                              face,
929                              (FT_Int)face_index,
930                              num_params,
931                              params );
932    if ( error )
933      goto Fail;
934
935    /* select Unicode charmap by default */
936    error2 = find_unicode_charmap( face );
937
938    /* if no Unicode charmap can be found, FT_Err_Invalid_CharMap_Handle */
939    /* is returned.                                                      */
940
941    /* no error should happen, but we want to play safe */
942    if ( error2 && error2 != FT_Err_Invalid_CharMap_Handle )
943    {
944      error = error2;
945      goto Fail;
946    }
947
948    *aface = face;
949
950  Fail:
951    if ( error )
952    {
953      destroy_charmaps( face, memory );
954      clazz->done_face( face );
955      FT_FREE( internal );
956      FT_FREE( face );
957      *aface = 0;
958    }
959
960    return error;
961  }
962
963
964  /* there's a Mac-specific extended implementation of FT_New_Face() */
965  /* in src/base/ftmac.c                                             */
966
967#ifndef FT_MACINTOSH
968
969  /* documentation is in freetype.h */
970
971  FT_EXPORT_DEF( FT_Error )
972  FT_New_Face( FT_Library   library,
973               const char*  pathname,
974               FT_Long      face_index,
975               FT_Face     *aface )
976  {
977    FT_Open_Args  args;
978
979
980    /* test for valid `library' and `aface' delayed to FT_Open_Face() */
981    if ( !pathname )
982      return FT_Err_Invalid_Argument;
983
984    args.flags    = FT_OPEN_PATHNAME;
985    args.pathname = (char*)pathname;
986
987    return FT_Open_Face( library, &args, face_index, aface );
988  }
989
990#endif  /* !FT_MACINTOSH */
991
992
993  /* documentation is in freetype.h */
994
995  FT_EXPORT_DEF( FT_Error )
996  FT_New_Memory_Face( FT_Library      library,
997                      const FT_Byte*  file_base,
998                      FT_Long         file_size,
999                      FT_Long         face_index,
1000                      FT_Face        *aface )
1001  {
1002    FT_Open_Args  args;
1003
1004
1005    /* test for valid `library' and `face' delayed to FT_Open_Face() */
1006    if ( !file_base )
1007      return FT_Err_Invalid_Argument;
1008
1009    args.flags       = FT_OPEN_MEMORY;
1010    args.memory_base = file_base;
1011    args.memory_size = file_size;
1012
1013    return FT_Open_Face( library, &args, face_index, aface );
1014  }
1015
1016
1017#if !defined( FT_MACINTOSH ) && defined( FT_CONFIG_OPTION_MAC_FONTS )
1018
1019  /* The behavior here is very similar to that in base/ftmac.c, but it     */
1020  /* is designed to work on non-mac systems, so no mac specific calls.     */
1021  /*                                                                       */
1022  /* We look at the file and determine if it is a mac dfont file or a mac  */
1023  /* resource file, or a macbinary file containing a mac resource file.    */
1024  /*                                                                       */
1025  /* Unlike ftmac I'm not going to look at a `FOND'.  I don't really see   */
1026  /* the point, especially since there may be multiple `FOND' resources.   */
1027  /* Instead I'll just look for `sfnt' and `POST' resources, ordered as    */
1028  /* they occur in the file.                                               */
1029  /*                                                                       */
1030  /* Note that multiple `POST' resources do not mean multiple postscript   */
1031  /* fonts; they all get jammed together to make what is essentially a     */
1032  /* pfb file.                                                             */
1033  /*                                                                       */
1034  /* We aren't interested in `NFNT' or `FONT' bitmap resources.            */
1035  /*                                                                       */
1036  /* As soon as we get an `sfnt' load it into memory and pass it off to    */
1037  /* FT_Open_Face.                                                         */
1038  /*                                                                       */
1039  /* If we have a (set of) `POST' resources, massage them into a (memory)  */
1040  /* pfb file and pass that to FT_Open_Face.  (As with ftmac.c I'm not     */
1041  /* going to try to save the kerning info.  After all that lives in the   */
1042  /* `FOND' which isn't in the file containing the `POST' resources so     */
1043  /* we don't really have access to it.                                    */
1044
1045
1046  /* Finalizer for a memory stream; gets called by FT_Done_Face().
1047     It frees the memory it uses. */
1048  /* from ftmac.c */
1049  static void
1050  memory_stream_close( FT_Stream  stream )
1051  {
1052    FT_Memory  memory = stream->memory;
1053
1054
1055    FT_FREE( stream->base );
1056
1057    stream->size  = 0;
1058    stream->base  = 0;
1059    stream->close = 0;
1060  }
1061
1062
1063  /* Create a new memory stream from a buffer and a size. */
1064  /* from ftmac.c */
1065  static FT_Error
1066  new_memory_stream( FT_Library           library,
1067                     FT_Byte*             base,
1068                     FT_ULong             size,
1069                     FT_Stream_CloseFunc  close,
1070                     FT_Stream           *astream )
1071  {
1072    FT_Error   error;
1073    FT_Memory  memory;
1074    FT_Stream  stream;
1075
1076
1077    if ( !library )
1078      return FT_Err_Invalid_Library_Handle;
1079
1080    if ( !base )
1081      return FT_Err_Invalid_Argument;
1082
1083    *astream = 0;
1084    memory = library->memory;
1085    if ( FT_NEW( stream ) )
1086      goto Exit;
1087
1088    FT_Stream_OpenMemory( stream, base, size );
1089
1090    stream->close = close;
1091
1092    *astream = stream;
1093
1094  Exit:
1095    return error;
1096  }
1097
1098
1099  /* Create a new FT_Face given a buffer and a driver name. */
1100  /* from ftmac.c */
1101  static FT_Error
1102  open_face_from_buffer( FT_Library   library,
1103                         FT_Byte*     base,
1104                         FT_ULong     size,
1105                         FT_Long      face_index,
1106                         const char*  driver_name,
1107                         FT_Face     *aface )
1108  {
1109    FT_Open_Args  args;
1110    FT_Error      error;
1111    FT_Stream     stream;
1112    FT_Memory     memory = library->memory;
1113
1114
1115    error = new_memory_stream( library,
1116                               base,
1117                               size,
1118                               memory_stream_close,
1119                               &stream );
1120    if ( error )
1121    {
1122      FT_FREE( base );
1123      return error;
1124    }
1125
1126    args.flags = FT_OPEN_STREAM;
1127    args.stream = stream;
1128    if ( driver_name )
1129    {
1130      args.flags = args.flags | FT_OPEN_DRIVER;
1131      args.driver = FT_Get_Module( library, driver_name );
1132    }
1133
1134    error = FT_Open_Face( library, &args, face_index, aface );
1135
1136    if ( error == FT_Err_Ok )
1137      (*aface)->face_flags &= ~FT_FACE_FLAG_EXTERNAL_STREAM;
1138    else
1139    {
1140      FT_Stream_Close( stream );
1141      FT_FREE( stream );
1142    }
1143
1144    return error;
1145  }
1146
1147
1148  /* The resource header says we've got resource_cnt `POST' (type1) */
1149  /* resources in this file.  They all need to be coalesced into    */
1150  /* one lump which gets passed on to the type1 driver.             */
1151  /* Here can be only one PostScript font in a file so face_index   */
1152  /* must be 0 (or -1).                                             */
1153  /*                                                                */
1154  static FT_Error
1155  Mac_Read_POST_Resource( FT_Library  library,
1156                          FT_Stream   stream,
1157                          FT_Long    *offsets,
1158                          FT_Long     resource_cnt,
1159                          FT_Long     face_index,
1160                          FT_Face    *aface )
1161  {
1162    FT_Error   error  = FT_Err_Cannot_Open_Resource;
1163    FT_Memory  memory = library->memory;
1164    FT_Byte*   pfb_data;
1165    int        i, type, flags;
1166    FT_Long    len;
1167    FT_Long    pfb_len, pfb_pos, pfb_lenpos;
1168    FT_Long    rlen, temp;
1169
1170
1171    if ( face_index == -1 )
1172      face_index = 0;
1173    if ( face_index != 0 )
1174      return error;
1175
1176    /* Find the length of all the POST resources, concatenated.  Assume */
1177    /* worst case (each resource in its own section).                   */
1178    pfb_len = 0;
1179    for ( i = 0; i < resource_cnt; ++i )
1180    {
1181      error = FT_Stream_Seek( stream, offsets[i] );
1182      if ( error )
1183        goto Exit;
1184      if ( FT_READ_LONG( temp ) )
1185        goto Exit;
1186      pfb_len += temp + 6;
1187    }
1188
1189    if ( FT_ALLOC( pfb_data, (FT_Long)pfb_len + 2 ) )
1190      goto Exit;
1191
1192    pfb_data[0] = 0x80;
1193    pfb_data[1] = 1;            /* Ascii section */
1194    pfb_data[2] = 0;            /* 4-byte length, fill in later */
1195    pfb_data[3] = 0;
1196    pfb_data[4] = 0;
1197    pfb_data[5] = 0;
1198    pfb_pos     = 7;
1199    pfb_lenpos  = 2;
1200
1201    len = 0;
1202    type = 1;
1203    for ( i = 0; i < resource_cnt; ++i )
1204    {
1205      error = FT_Stream_Seek( stream, offsets[i] );
1206      if ( error )
1207        goto Exit2;
1208      if ( FT_READ_LONG( rlen ) )
1209        goto Exit;
1210      if ( FT_READ_USHORT( flags ) )
1211        goto Exit;
1212      rlen -= 2;                    /* the flags are part of the resource */
1213      if ( ( flags >> 8 ) == type )
1214        len += rlen;
1215      else
1216      {
1217        pfb_data[pfb_lenpos    ] = (FT_Byte)( len );
1218        pfb_data[pfb_lenpos + 1] = (FT_Byte)( len >> 8 );
1219        pfb_data[pfb_lenpos + 2] = (FT_Byte)( len >> 16 );
1220        pfb_data[pfb_lenpos + 3] = (FT_Byte)( len >> 24 );
1221
1222        if ( ( flags >> 8 ) == 5 )      /* End of font mark */
1223          break;
1224
1225        pfb_data[pfb_pos++] = 0x80;
1226
1227        type = flags >> 8;
1228        len = rlen;
1229
1230        pfb_data[pfb_pos++] = (FT_Byte)type;
1231        pfb_lenpos          = (FT_Byte)pfb_pos;
1232        pfb_data[pfb_pos++] = 0;        /* 4-byte length, fill in later */
1233        pfb_data[pfb_pos++] = 0;
1234        pfb_data[pfb_pos++] = 0;
1235        pfb_data[pfb_pos++] = 0;
1236      }
1237
1238      error = FT_Stream_Read( stream, (FT_Byte *)pfb_data + pfb_pos, rlen );
1239      pfb_pos += rlen;
1240    }
1241
1242    pfb_data[pfb_pos++] = 0x80;
1243    pfb_data[pfb_pos++] = 3;
1244
1245    pfb_data[pfb_lenpos    ] = (FT_Byte)( len );
1246    pfb_data[pfb_lenpos + 1] = (FT_Byte)( len >> 8 );
1247    pfb_data[pfb_lenpos + 2] = (FT_Byte)( len >> 16 );
1248    pfb_data[pfb_lenpos + 3] = (FT_Byte)( len >> 24 );
1249
1250    return open_face_from_buffer( library,
1251                                  pfb_data,
1252                                  pfb_pos,
1253                                  face_index,
1254                                  "type1",
1255                                  aface );
1256
1257  Exit2:
1258    FT_FREE( pfb_data );
1259
1260  Exit:
1261    return error;
1262  }
1263
1264
1265  /* The resource header says we've got resource_cnt `sfnt'      */
1266  /* (TrueType/OpenType) resources in this file.  Look through   */
1267  /* them for the one indicated by face_index, load it into mem, */
1268  /* pass it on the the truetype driver and return it.           */
1269  /*                                                             */
1270  static FT_Error
1271  Mac_Read_sfnt_Resource( FT_Library  library,
1272                          FT_Stream   stream,
1273                          FT_Long    *offsets,
1274                          FT_Long     resource_cnt,
1275                          FT_Long     face_index,
1276                          FT_Face    *aface )
1277  {
1278    FT_Memory  memory = library->memory;
1279    FT_Byte*   sfnt_data;
1280    FT_Error   error;
1281    FT_Long    flag_offset;
1282    FT_Long    rlen;
1283    int        is_cff;
1284
1285
1286    if ( face_index == -1 )
1287      face_index = 0;
1288    if ( face_index >= resource_cnt )
1289      return FT_Err_Cannot_Open_Resource;
1290
1291    flag_offset = offsets[face_index];
1292    error = FT_Stream_Seek( stream, flag_offset );
1293    if ( error )
1294      goto Exit;
1295
1296    if ( FT_READ_LONG( rlen ) )
1297      goto Exit;
1298    if ( rlen == -1 )
1299      return FT_Err_Cannot_Open_Resource;
1300
1301    if ( FT_ALLOC( sfnt_data, (FT_Long)rlen ) )
1302      return error;
1303    error = FT_Stream_Read( stream, (FT_Byte *)sfnt_data, rlen );
1304    if ( error )
1305      goto Exit;
1306
1307    is_cff = rlen > 4 && sfnt_data[0] == 'O' &&
1308                         sfnt_data[1] == 'T' &&
1309                         sfnt_data[2] == 'T' &&
1310                         sfnt_data[3] == 'O';
1311
1312    error = open_face_from_buffer( library,
1313                                   sfnt_data,
1314                                   rlen,
1315                                   face_index,
1316                                   is_cff ? "cff" : "truetype",
1317                                   aface );
1318
1319  Exit:
1320    return error;
1321  }
1322
1323
1324  /* Check for a valid resource fork header, or a valid dfont    */
1325  /* header.  In a resource fork the first 16 bytes are repeated */
1326  /* at the location specified by bytes 4-7.  In a dfont bytes   */
1327  /* 4-7 point to 16 bytes of zeroes instead.                    */
1328  /*                                                             */
1329  static FT_Error
1330  IsMacResource( FT_Library  library,
1331                 FT_Stream   stream,
1332                 FT_Long     resource_offset,
1333                 FT_Long     face_index,
1334                 FT_Face    *aface )
1335  {
1336    FT_Memory  memory = library->memory;
1337    FT_Error   error;
1338    FT_Long    map_offset, rdara_pos;
1339    FT_Long    *data_offsets;
1340    FT_Long    count;
1341
1342
1343    error = FT_Raccess_Get_HeaderInfo( library, stream, resource_offset,
1344                                       &map_offset, &rdara_pos );
1345    if ( error )
1346      return error;
1347
1348    error = FT_Raccess_Get_DataOffsets( library, stream,
1349                                        map_offset, rdara_pos,
1350                                        FT_MAKE_TAG( 'P', 'O', 'S', 'T' ),
1351                                        &data_offsets, &count );
1352    if ( !error )
1353    {
1354      error = Mac_Read_POST_Resource( library, stream, data_offsets, count,
1355                                      face_index, aface );
1356      FT_FREE( data_offsets );
1357      return error;
1358    }
1359
1360    error = FT_Raccess_Get_DataOffsets( library, stream,
1361                                        map_offset, rdara_pos,
1362                                        FT_MAKE_TAG( 's', 'f', 'n', 't' ),
1363                                        &data_offsets, &count );
1364    if ( !error )
1365    {
1366      error = Mac_Read_sfnt_Resource( library, stream, data_offsets, count,
1367                                      face_index, aface );
1368      FT_FREE( data_offsets );
1369    }
1370
1371    return error;
1372  }
1373
1374
1375  /* Check for a valid macbinary header, and if we find one   */
1376  /* check that the (flattened) resource fork in it is valid. */
1377  /*                                                          */
1378  static FT_Error
1379  IsMacBinary( FT_Library  library,
1380               FT_Stream   stream,
1381               FT_Long     face_index,
1382               FT_Face    *aface )
1383  {
1384    unsigned char  header[128];
1385    FT_Error       error;
1386    FT_Long        dlen, offset;
1387
1388
1389    error = FT_Stream_Seek( stream, 0 );
1390    if ( error )
1391      goto Exit;
1392
1393    error = FT_Stream_Read( stream, (FT_Byte*)header, 128 );
1394    if ( error )
1395      goto Exit;
1396
1397    if (            header[ 0] !=  0 ||
1398                    header[74] !=  0 ||
1399                    header[82] !=  0 ||
1400                    header[ 1] ==  0 ||
1401                    header[ 1] >  33 ||
1402                    header[63] !=  0 ||
1403         header[2 + header[1]] !=  0 )
1404      return FT_Err_Unknown_File_Format;
1405
1406    dlen = ( header[0x53] << 24 ) |
1407           ( header[0x54] << 16 ) |
1408           ( header[0x55] <<  8 ) |
1409             header[0x56];
1410#if 0
1411    rlen = ( header[0x57] << 24 ) |
1412           ( header[0x58] << 16 ) |
1413           ( header[0x59] <<  8 ) |
1414             header[0x5a];
1415#endif /* 0 */
1416    offset = 128 + ( ( dlen + 127 ) & ~127 );
1417
1418    return IsMacResource( library, stream, offset, face_index, aface );
1419
1420  Exit:
1421    return error;
1422  }
1423
1424
1425  static FT_Error
1426  load_face_in_embedded_rfork( FT_Library           library,
1427                               FT_Stream            stream,
1428                               FT_Long              face_index,
1429                               FT_Face             *aface,
1430                               const FT_Open_Args  *args )
1431  {
1432
1433#undef  FT_COMPONENT
1434#define FT_COMPONENT  trace_raccess
1435
1436    FT_Memory  memory = library->memory;
1437    FT_Error   error  = FT_Err_Unknown_File_Format;
1438    int        i;
1439
1440    char *     file_names[FT_RACCESS_N_RULES];
1441    FT_Long    offsets[FT_RACCESS_N_RULES];
1442    FT_Error   errors[FT_RACCESS_N_RULES];
1443
1444    FT_Open_Args  args2;
1445    FT_Stream     stream2;
1446
1447
1448    FT_Raccess_Guess( library, stream,
1449                      args->pathname, file_names, offsets, errors );
1450
1451    for ( i = 0; i < FT_RACCESS_N_RULES; i++ )
1452    {
1453      if ( errors[i] )
1454      {
1455        FT_TRACE3(( "Error[%d] has occurred in rule %d\n", errors[i], i ));
1456        continue;
1457      }
1458
1459      args2.flags    = FT_OPEN_PATHNAME;
1460      args2.pathname = file_names[i] ? file_names[i] : args->pathname;
1461
1462      FT_TRACE3(( "Try rule %d: %s (offset=%d) ...",
1463                  i, args2.pathname, offsets[i] ));
1464
1465      error = FT_Stream_New( library, &args2, &stream2 );
1466      if ( error )
1467      {
1468        FT_TRACE3(( "failed\n" ));
1469        continue;
1470      }
1471
1472      error = IsMacResource( library, stream2, offsets[i],
1473                             face_index, aface );
1474      FT_Stream_Close( stream2 );
1475
1476      FT_TRACE3(( "%s\n", error ? "failed": "successful" ));
1477
1478      if ( !error )
1479          break;
1480    }
1481
1482    for (i = 0; i < FT_RACCESS_N_RULES; i++)
1483    {
1484      if ( file_names[i] )
1485        FT_FREE( file_names[i] );
1486    }
1487
1488    /* Caller (load_mac_face) requires FT_Err_Unknown_File_Format. */
1489    if ( error )
1490      error = FT_Err_Unknown_File_Format;
1491
1492    return error;
1493
1494#undef  FT_COMPONENT
1495#define FT_COMPONENT  trace_objs
1496
1497  }
1498
1499
1500  /* Check for some macintosh formats.                             */
1501  /* Is this a macbinary file?  If so look at the resource fork.   */
1502  /* Is this a mac dfont file?                                     */
1503  /* Is this an old style resource fork? (in data)                 */
1504  /* Else call load_face_in_embedded_rfork to try extra rules      */
1505  /* (defined in `ftrfork.c').                                     */
1506  /*                                                               */
1507  static FT_Error
1508  load_mac_face( FT_Library           library,
1509                 FT_Stream            stream,
1510                 FT_Long              face_index,
1511                 FT_Face             *aface,
1512                 const FT_Open_Args  *args )
1513  {
1514    FT_Error error;
1515    FT_UNUSED( args );
1516
1517
1518    error = IsMacBinary( library, stream, face_index, aface );
1519    if ( FT_ERROR_BASE( error ) == FT_Err_Unknown_File_Format )
1520    {
1521
1522#undef  FT_COMPONENT
1523#define FT_COMPONENT  trace_raccess
1524
1525      FT_TRACE3(( "Try as dfont: %s ...", args->pathname ));
1526
1527      error = IsMacResource( library, stream, 0, face_index, aface );
1528
1529      FT_TRACE3(( "%s\n", error ? "failed" : "successful" ));
1530
1531#undef  FT_COMPONENT
1532#define FT_COMPONENT  trace_objs
1533
1534    }
1535
1536    if ( ( FT_ERROR_BASE( error ) == FT_Err_Unknown_File_Format      ||
1537           FT_ERROR_BASE( error ) == FT_Err_Invalid_Stream_Operation ) &&
1538         ( args->flags & FT_OPEN_PATHNAME )                            )
1539      error = load_face_in_embedded_rfork( library, stream,
1540                                           face_index, aface, args );
1541    return error;
1542  }
1543
1544#endif  /* !FT_MACINTOSH && FT_CONFIG_OPTION_MAC_FONTS */
1545
1546
1547  /* documentation is in freetype.h */
1548
1549  FT_EXPORT_DEF( FT_Error )
1550  FT_Open_Face( FT_Library           library,
1551                const FT_Open_Args*  args,
1552                FT_Long              face_index,
1553                FT_Face             *aface )
1554  {
1555    FT_Error     error;
1556    FT_Driver    driver;
1557    FT_Memory    memory;
1558    FT_Stream    stream;
1559    FT_Face      face = 0;
1560    FT_ListNode  node = 0;
1561    FT_Bool      external_stream;
1562
1563
1564    /* test for valid `library' delayed to */
1565    /* FT_Stream_New()                     */
1566
1567    if ( ( !aface && face_index >= 0 ) || !args )
1568      return FT_Err_Invalid_Argument;
1569
1570    external_stream = FT_BOOL( ( args->flags & FT_OPEN_STREAM ) &&
1571                               args->stream                     );
1572
1573    /* create input stream */
1574    error = FT_Stream_New( library, args, &stream );
1575    if ( error )
1576      goto Exit;
1577
1578    memory = library->memory;
1579
1580    /* If the font driver is specified in the `args' structure, use */
1581    /* it.  Otherwise, we scan the list of registered drivers.      */
1582    if ( ( args->flags & FT_OPEN_DRIVER ) && args->driver )
1583    {
1584      driver = FT_DRIVER( args->driver );
1585
1586      /* not all modules are drivers, so check... */
1587      if ( FT_MODULE_IS_DRIVER( driver ) )
1588      {
1589        FT_Int         num_params = 0;
1590        FT_Parameter*  params     = 0;
1591
1592
1593        if ( args->flags & FT_OPEN_PARAMS )
1594        {
1595          num_params = args->num_params;
1596          params     = args->params;
1597        }
1598
1599        error = open_face( driver, stream, face_index,
1600                           num_params, params, &face );
1601        if ( !error )
1602          goto Success;
1603      }
1604      else
1605        error = FT_Err_Invalid_Handle;
1606
1607      FT_Stream_Free( stream, external_stream );
1608      goto Fail;
1609    }
1610    else
1611    {
1612      /* check each font driver for an appropriate format */
1613      FT_Module*  cur   = library->modules;
1614      FT_Module*  limit = cur + library->num_modules;
1615
1616
1617      for ( ; cur < limit; cur++ )
1618      {
1619        /* not all modules are font drivers, so check... */
1620        if ( FT_MODULE_IS_DRIVER( cur[0] ) )
1621        {
1622          FT_Int         num_params = 0;
1623          FT_Parameter*  params     = 0;
1624
1625
1626          driver = FT_DRIVER( cur[0] );
1627
1628          if ( args->flags & FT_OPEN_PARAMS )
1629          {
1630            num_params = args->num_params;
1631            params     = args->params;
1632          }
1633
1634          error = open_face( driver, stream, face_index,
1635                             num_params, params, &face );
1636          if ( !error )
1637            goto Success;
1638
1639          if ( FT_ERROR_BASE( error ) != FT_Err_Unknown_File_Format )
1640            goto Fail3;
1641        }
1642      }
1643
1644  Fail3:
1645    /* If we are on the mac, and we get an FT_Err_Invalid_Stream_Operation */
1646    /* it may be because we have an empty data fork, so we need to check   */
1647    /* the resource fork.                                                  */
1648    if ( FT_ERROR_BASE( error ) != FT_Err_Unknown_File_Format      &&
1649         FT_ERROR_BASE( error ) != FT_Err_Invalid_Stream_Operation )
1650      goto Fail2;
1651
1652#if !defined( FT_MACINTOSH ) && defined( FT_CONFIG_OPTION_MAC_FONTS )
1653    error = load_mac_face( library, stream, face_index, aface, args );
1654    if ( !error )
1655    {
1656      /* We don't want to go to Success here.  We've already done that. */
1657      /* On the other hand, if we succeeded we still need to close this */
1658      /* stream (we opened a different stream which extracted the       */
1659      /* interesting information out of this stream here.  That stream  */
1660      /* will still be open and the face will point to it).             */
1661      FT_Stream_Free( stream, external_stream );
1662      return error;
1663    }
1664
1665    if ( FT_ERROR_BASE( error ) != FT_Err_Unknown_File_Format )
1666      goto Fail2;
1667#endif  /* !FT_MACINTOSH && FT_CONFIG_OPTION_MAC_FONTS */
1668
1669      /* no driver is able to handle this format */
1670      error = FT_Err_Unknown_File_Format;
1671
1672  Fail2:
1673      FT_Stream_Free( stream, external_stream );
1674      goto Fail;
1675    }
1676
1677  Success:
1678    FT_TRACE4(( "FT_Open_Face: New face object, adding to list\n" ));
1679
1680    /* set the FT_FACE_FLAG_EXTERNAL_STREAM bit for FT_Done_Face */
1681    if ( external_stream )
1682      face->face_flags |= FT_FACE_FLAG_EXTERNAL_STREAM;
1683
1684    /* add the face object to its driver's list */
1685    if ( FT_NEW( node ) )
1686      goto Fail;
1687
1688    node->data = face;
1689    /* don't assume driver is the same as face->driver, so use */
1690    /* face->driver instead.                                   */
1691    FT_List_Add( &face->driver->faces_list, node );
1692
1693    /* now allocate a glyph slot object for the face */
1694    FT_TRACE4(( "FT_Open_Face: Creating glyph slot\n" ));
1695
1696    error = FT_New_GlyphSlot( face, NULL );
1697    if ( error )
1698      goto Fail;
1699
1700    /* finally, allocate a size object for the face */
1701    {
1702      FT_Size  size;
1703
1704
1705      FT_TRACE4(( "FT_Open_Face: Creating size object\n" ));
1706
1707      error = FT_New_Size( face, &size );
1708      if ( error )
1709        goto Fail;
1710
1711      face->size = size;
1712    }
1713
1714    /* initialize internal face data */
1715    {
1716      FT_Face_Internal  internal = face->internal;
1717
1718
1719      internal->transform_matrix.xx = 0x10000L;
1720      internal->transform_matrix.xy = 0;
1721      internal->transform_matrix.yx = 0;
1722      internal->transform_matrix.yy = 0x10000L;
1723
1724      internal->transform_delta.x = 0;
1725      internal->transform_delta.y = 0;
1726    }
1727
1728    if ( aface )
1729      *aface = face;
1730    goto Exit;
1731
1732  Fail:
1733    FT_Done_Face( face );
1734
1735  Exit:
1736    FT_TRACE4(( "FT_Open_Face: Return %d\n", error ));
1737
1738    return error;
1739  }
1740
1741
1742  /* documentation is in freetype.h */
1743
1744  FT_EXPORT_DEF( FT_Error )
1745  FT_Attach_File( FT_Face      face,
1746                  const char*  filepathname )
1747  {
1748    FT_Open_Args  open;
1749
1750
1751    /* test for valid `face' delayed to FT_Attach_Stream() */
1752
1753    if ( !filepathname )
1754      return FT_Err_Invalid_Argument;
1755
1756    open.stream   = NULL;
1757    open.flags    = FT_OPEN_PATHNAME;
1758    open.pathname = (char*)filepathname;
1759
1760    return FT_Attach_Stream( face, &open );
1761  }
1762
1763
1764  /* documentation is in freetype.h */
1765
1766  FT_EXPORT_DEF( FT_Error )
1767  FT_Attach_Stream( FT_Face        face,
1768                    FT_Open_Args*  parameters )
1769  {
1770    FT_Stream  stream;
1771    FT_Error   error;
1772    FT_Driver  driver;
1773
1774    FT_Driver_Class  clazz;
1775
1776
1777    /* test for valid `parameters' delayed to FT_Stream_New() */
1778
1779    if ( !face )
1780      return FT_Err_Invalid_Face_Handle;
1781
1782    driver = face->driver;
1783    if ( !driver )
1784      return FT_Err_Invalid_Driver_Handle;
1785
1786    error = FT_Stream_New( driver->root.library, parameters, &stream );
1787    if ( error )
1788      goto Exit;
1789
1790    /* we implement FT_Attach_Stream in each driver through the */
1791    /* `attach_file' interface                                  */
1792
1793    error = FT_Err_Unimplemented_Feature;
1794    clazz = driver->clazz;
1795    if ( clazz->attach_file )
1796      error = clazz->attach_file( face, stream );
1797
1798    /* close the attached stream */
1799    FT_Stream_Free( stream,
1800                    (FT_Bool)( parameters->stream &&
1801                               ( parameters->flags & FT_OPEN_STREAM ) ) );
1802
1803  Exit:
1804    return error;
1805  }
1806
1807
1808  /* documentation is in freetype.h */
1809
1810  FT_EXPORT_DEF( FT_Error )
1811  FT_Done_Face( FT_Face  face )
1812  {
1813    FT_Error     error;
1814    FT_Driver    driver;
1815    FT_Memory    memory;
1816    FT_ListNode  node;
1817
1818
1819    error = FT_Err_Invalid_Face_Handle;
1820    if ( face && face->driver )
1821    {
1822      driver = face->driver;
1823      memory = driver->root.memory;
1824
1825      /* find face in driver's list */
1826      node = FT_List_Find( &driver->faces_list, face );
1827      if ( node )
1828      {
1829        /* remove face object from the driver's list */
1830        FT_List_Remove( &driver->faces_list, node );
1831        FT_FREE( node );
1832
1833        /* now destroy the object proper */
1834        destroy_face( memory, face, driver );
1835        error = FT_Err_Ok;
1836      }
1837    }
1838    return error;
1839  }
1840
1841
1842  /* documentation is in ftobjs.h */
1843
1844  FT_EXPORT_DEF( FT_Error )
1845  FT_New_Size( FT_Face   face,
1846               FT_Size  *asize )
1847  {
1848    FT_Error         error;
1849    FT_Memory        memory;
1850    FT_Driver        driver;
1851    FT_Driver_Class  clazz;
1852
1853    FT_Size          size = 0;
1854    FT_ListNode      node = 0;
1855
1856
1857    if ( !face )
1858      return FT_Err_Invalid_Face_Handle;
1859
1860    if ( !asize )
1861      return FT_Err_Invalid_Size_Handle;
1862
1863    if ( !face->driver )
1864      return FT_Err_Invalid_Driver_Handle;
1865
1866    *asize = 0;
1867
1868    driver = face->driver;
1869    clazz  = driver->clazz;
1870    memory = face->memory;
1871
1872    /* Allocate new size object and perform basic initialisation */
1873    if ( FT_ALLOC( size, clazz->size_object_size ) || FT_NEW( node ) )
1874      goto Exit;
1875
1876    size->face = face;
1877
1878    /* for now, do not use any internal fields in size objects */
1879    size->internal = 0;
1880
1881    if ( clazz->init_size )
1882      error = clazz->init_size( size );
1883
1884    /* in case of success, add to the face's list */
1885    if ( !error )
1886    {
1887      *asize     = size;
1888      node->data = size;
1889      FT_List_Add( &face->sizes_list, node );
1890    }
1891
1892  Exit:
1893    if ( error )
1894    {
1895      FT_FREE( node );
1896      FT_FREE( size );
1897    }
1898
1899    return error;
1900  }
1901
1902
1903  /* documentation is in ftobjs.h */
1904
1905  FT_EXPORT_DEF( FT_Error )
1906  FT_Done_Size( FT_Size  size )
1907  {
1908    FT_Error     error;
1909    FT_Driver    driver;
1910    FT_Memory    memory;
1911    FT_Face      face;
1912    FT_ListNode  node;
1913
1914
1915    if ( !size )
1916      return FT_Err_Invalid_Size_Handle;
1917
1918    face = size->face;
1919    if ( !face )
1920      return FT_Err_Invalid_Face_Handle;
1921
1922    driver = face->driver;
1923    if ( !driver )
1924      return FT_Err_Invalid_Driver_Handle;
1925
1926    memory = driver->root.memory;
1927
1928    error = FT_Err_Ok;
1929    node  = FT_List_Find( &face->sizes_list, size );
1930    if ( node )
1931    {
1932      FT_List_Remove( &face->sizes_list, node );
1933      FT_FREE( node );
1934
1935      if ( face->size == size )
1936      {
1937        face->size = 0;
1938        if ( face->sizes_list.head )
1939          face->size = (FT_Size)(face->sizes_list.head->data);
1940      }
1941
1942      destroy_size( memory, size, driver );
1943    }
1944    else
1945      error = FT_Err_Invalid_Size_Handle;
1946
1947    return error;
1948  }
1949
1950
1951  static void
1952  ft_recompute_scaled_metrics( FT_Face           face,
1953                               FT_Size_Metrics*  metrics )
1954  {
1955    /* Compute root ascender, descender, test height, and max_advance */
1956
1957    metrics->ascender    = FT_PIX_CEIL( FT_MulFix( face->ascender,
1958                                                   metrics->y_scale ) );
1959
1960    metrics->descender   = FT_PIX_FLOOR( FT_MulFix( face->descender,
1961                                                    metrics->y_scale ) );
1962
1963    metrics->height      = FT_PIX_ROUND( FT_MulFix( face->height,
1964                                                    metrics->y_scale ) );
1965
1966    metrics->max_advance = FT_PIX_ROUND( FT_MulFix( face->max_advance_width,
1967                                                    metrics->x_scale ) );
1968  }
1969
1970
1971  /* documentation is in freetype.h */
1972
1973  FT_EXPORT_DEF( FT_Error )
1974  FT_Set_Char_Size( FT_Face     face,
1975                    FT_F26Dot6  char_width,
1976                    FT_F26Dot6  char_height,
1977                    FT_UInt     horz_resolution,
1978                    FT_UInt     vert_resolution )
1979  {
1980    FT_Error          error = FT_Err_Ok;
1981    FT_Driver         driver;
1982    FT_Driver_Class   clazz;
1983    FT_Size_Metrics*  metrics;
1984    FT_Long           dim_x, dim_y;
1985
1986
1987    if ( !face || !face->size || !face->driver )
1988      return FT_Err_Invalid_Face_Handle;
1989
1990    driver  = face->driver;
1991    metrics = &face->size->metrics;
1992    clazz   = driver->clazz;
1993
1994    if ( !char_width )
1995      char_width = char_height;
1996
1997    else if ( !char_height )
1998      char_height = char_width;
1999
2000    if ( !horz_resolution )
2001      horz_resolution = 72;
2002
2003    if ( !vert_resolution )
2004      vert_resolution = 72;
2005
2006    /* default processing -- this can be overridden by the driver */
2007    if ( char_width  < 1 * 64 )
2008      char_width  = 1 * 64;
2009    if ( char_height < 1 * 64 )
2010      char_height = 1 * 64;
2011
2012    /* Compute pixel sizes in 26.6 units */
2013    dim_x = ( char_width  * horz_resolution + 36 ) / 72;
2014    dim_y = ( char_height * vert_resolution + 36 ) / 72;
2015
2016    {
2017      FT_UShort  x_ppem = (FT_UShort)( ( dim_x + 32 ) >> 6 );
2018      FT_UShort  y_ppem = (FT_UShort)( ( dim_y + 32 ) >> 6 );
2019
2020
2021      /* Don't take, say, 12.5x12.5 equal to 13x13.  If working with */
2022      /* fractional font sizes this would hide slightly different    */
2023      /* font metrics.  Consequently, the next two lines are         */
2024      /* disabled.                                                   */
2025#if 0
2026      if ( x_ppem == metrics->x_ppem && y_ppem == metrics->y_ppem )
2027        return FT_Err_Ok;
2028#endif
2029
2030      metrics->x_ppem = x_ppem;
2031      metrics->y_ppem = y_ppem;
2032    }
2033
2034    metrics->x_scale = 0x10000L;
2035    metrics->y_scale = 0x10000L;
2036
2037    if ( face->face_flags & FT_FACE_FLAG_SCALABLE )
2038    {
2039      metrics->x_scale = FT_DivFix( dim_x, face->units_per_EM );
2040      metrics->y_scale = FT_DivFix( dim_y, face->units_per_EM );
2041
2042      ft_recompute_scaled_metrics( face, metrics );
2043    }
2044
2045    if ( clazz->set_char_sizes )
2046      error = clazz->set_char_sizes( face->size,
2047                                     char_width,
2048                                     char_height,
2049                                     horz_resolution,
2050                                     vert_resolution );
2051    return error;
2052  }
2053
2054
2055  /* documentation is in freetype.h */
2056
2057  FT_EXPORT_DEF( FT_Error )
2058  FT_Set_Pixel_Sizes( FT_Face  face,
2059                      FT_UInt  pixel_width,
2060                      FT_UInt  pixel_height )
2061  {
2062    FT_Error          error = FT_Err_Ok;
2063    FT_Driver         driver;
2064    FT_Driver_Class   clazz;
2065    FT_Size_Metrics*  metrics;
2066
2067
2068    if ( !face || !face->size || !face->driver )
2069      return FT_Err_Invalid_Face_Handle;
2070
2071    driver  = face->driver;
2072    metrics = &face->size->metrics;
2073    clazz   = driver->clazz;
2074
2075    if ( pixel_width == 0 )
2076      pixel_width = pixel_height;
2077
2078    else if ( pixel_height == 0 )
2079      pixel_height = pixel_width;
2080
2081    if ( pixel_width  < 1 )
2082      pixel_width  = 1;
2083    if ( pixel_height < 1 )
2084      pixel_height = 1;
2085
2086    /* use `>=' to avoid potention compiler warning on 16bit platforms */
2087    if ( pixel_width  >= 0xFFFFU )
2088      pixel_width  = 0xFFFFU;
2089    if ( pixel_height >= 0xFFFFU )
2090      pixel_height = 0xFFFFU;
2091
2092    metrics->x_ppem = (FT_UShort)pixel_width;
2093    metrics->y_ppem = (FT_UShort)pixel_height;
2094
2095    if ( face->face_flags & FT_FACE_FLAG_SCALABLE )
2096    {
2097      metrics->x_scale = FT_DivFix( metrics->x_ppem << 6,
2098                                    face->units_per_EM );
2099
2100      metrics->y_scale = FT_DivFix( metrics->y_ppem << 6,
2101                                    face->units_per_EM );
2102
2103      ft_recompute_scaled_metrics( face, metrics );
2104    }
2105
2106    if ( clazz->set_pixel_sizes )
2107      error = clazz->set_pixel_sizes( face->size,
2108                                      pixel_width,
2109                                      pixel_height );
2110    return error;
2111  }
2112
2113
2114  /* documentation is in freetype.h */
2115
2116  FT_EXPORT_DEF( FT_Error )
2117  FT_Get_Kerning( FT_Face     face,
2118                  FT_UInt     left_glyph,
2119                  FT_UInt     right_glyph,
2120                  FT_UInt     kern_mode,
2121                  FT_Vector  *akerning )
2122  {
2123    FT_Error   error = FT_Err_Ok;
2124    FT_Driver  driver;
2125
2126
2127    if ( !face )
2128      return FT_Err_Invalid_Face_Handle;
2129
2130    if ( !akerning )
2131      return FT_Err_Invalid_Argument;
2132
2133    driver = face->driver;
2134
2135    akerning->x = 0;
2136    akerning->y = 0;
2137
2138    if ( driver->clazz->get_kerning )
2139    {
2140      error = driver->clazz->get_kerning( face,
2141                                          left_glyph,
2142                                          right_glyph,
2143                                          akerning );
2144      if ( !error )
2145      {
2146        if ( kern_mode != FT_KERNING_UNSCALED )
2147        {
2148          akerning->x = FT_MulFix( akerning->x, face->size->metrics.x_scale );
2149          akerning->y = FT_MulFix( akerning->y, face->size->metrics.y_scale );
2150
2151          if ( kern_mode != FT_KERNING_UNFITTED )
2152          {
2153            /* we scale down kerning values for small ppem values */
2154            /* to avoid that rounding makes them too big.         */
2155            /* `25' has been determined heuristically.            */
2156            if ( face->size->metrics.x_ppem < 25 )
2157              akerning->x = FT_MulDiv( akerning->x,
2158                                       face->size->metrics.x_ppem, 25 );
2159            if ( face->size->metrics.y_ppem < 25 )
2160              akerning->y = FT_MulDiv( akerning->y,
2161                                       face->size->metrics.y_ppem, 25 );
2162
2163            akerning->x = FT_PIX_ROUND( akerning->x );
2164            akerning->y = FT_PIX_ROUND( akerning->y );
2165          }
2166        }
2167      }
2168    }
2169
2170    return error;
2171  }
2172
2173
2174  /* documentation is in freetype.h */
2175
2176  FT_EXPORT_DEF( FT_Error )
2177  FT_Select_Charmap( FT_Face      face,
2178                     FT_Encoding  encoding )
2179  {
2180    FT_CharMap*  cur;
2181    FT_CharMap*  limit;
2182
2183
2184    if ( !face )
2185      return FT_Err_Invalid_Face_Handle;
2186
2187    /* FT_ENCODING_UNICODE is special.  We try to find the `best' Unicode */
2188    /* charmap available, i.e., one with UCS-4 characters, if possible.   */
2189    /*                                                                    */
2190    /* This is done by find_unicode_charmap() above, to share code.       */
2191    if ( encoding == FT_ENCODING_UNICODE )
2192      return find_unicode_charmap( face );
2193
2194    cur = face->charmaps;
2195    if ( !cur )
2196      return FT_Err_Invalid_CharMap_Handle;
2197
2198    limit = cur + face->num_charmaps;
2199
2200    for ( ; cur < limit; cur++ )
2201    {
2202      if ( cur[0]->encoding == encoding )
2203      {
2204        face->charmap = cur[0];
2205        return 0;
2206      }
2207    }
2208
2209    return FT_Err_Invalid_Argument;
2210  }
2211
2212
2213  /* documentation is in freetype.h */
2214
2215  FT_EXPORT_DEF( FT_Error )
2216  FT_Set_Charmap( FT_Face     face,
2217                  FT_CharMap  charmap )
2218  {
2219    FT_CharMap*  cur;
2220    FT_CharMap*  limit;
2221
2222
2223    if ( !face )
2224      return FT_Err_Invalid_Face_Handle;
2225
2226    cur = face->charmaps;
2227    if ( !cur )
2228      return FT_Err_Invalid_CharMap_Handle;
2229
2230    limit = cur + face->num_charmaps;
2231
2232    for ( ; cur < limit; cur++ )
2233    {
2234      if ( cur[0] == charmap )
2235      {
2236        face->charmap = cur[0];
2237        return 0;
2238      }
2239    }
2240    return FT_Err_Invalid_Argument;
2241  }
2242
2243
2244  /* documentation is in freetype.h */
2245
2246  FT_EXPORT_DEF( FT_Int )
2247  FT_Get_Charmap_Index( FT_CharMap  charmap )
2248  {
2249    FT_Int  i;
2250
2251
2252    for ( i = 0; i < charmap->face->num_charmaps; i++ )
2253      if ( charmap->face->charmaps[i] == charmap )
2254        break;
2255
2256    FT_ASSERT( i < charmap->face->num_charmaps );
2257
2258    return i;
2259  }
2260
2261
2262  static void
2263  ft_cmap_done_internal( FT_CMap  cmap )
2264  {
2265    FT_CMap_Class  clazz  = cmap->clazz;
2266    FT_Face        face   = cmap->charmap.face;
2267    FT_Memory      memory = FT_FACE_MEMORY(face);
2268
2269
2270    if ( clazz->done )
2271      clazz->done( cmap );
2272
2273    FT_FREE( cmap );
2274  }
2275
2276
2277  FT_BASE_DEF( void )
2278  FT_CMap_Done( FT_CMap  cmap )
2279  {
2280    if ( cmap )
2281    {
2282      FT_Face    face   = cmap->charmap.face;
2283      FT_Memory  memory = FT_FACE_MEMORY( face );
2284      FT_Error   error;
2285      FT_Int     i, j;
2286
2287
2288      for ( i = 0; i < face->num_charmaps; i++ )
2289      {
2290        if ( (FT_CMap)face->charmaps[i] == cmap )
2291        {
2292          FT_CharMap  last_charmap = face->charmaps[face->num_charmaps - 1];
2293
2294
2295          if ( FT_RENEW_ARRAY( face->charmaps,
2296                               face->num_charmaps,
2297                               face->num_charmaps - 1 ) )
2298            return;
2299
2300          /* remove it from our list of charmaps */
2301          for ( j = i + 1; j < face->num_charmaps; j++ )
2302          {
2303            if ( j == face->num_charmaps - 1 )
2304              face->charmaps[j - 1] = last_charmap;
2305            else
2306              face->charmaps[j - 1] = face->charmaps[j];
2307          }
2308
2309          face->num_charmaps--;
2310
2311          if ( (FT_CMap)face->charmap == cmap )
2312            face->charmap = NULL;
2313
2314          ft_cmap_done_internal( cmap );
2315
2316          break;
2317        }
2318      }
2319    }
2320  }
2321
2322
2323  FT_BASE_DEF( FT_Error )
2324  FT_CMap_New( FT_CMap_Class   clazz,
2325               FT_Pointer      init_data,
2326               FT_CharMap      charmap,
2327               FT_CMap        *acmap )
2328  {
2329    FT_Error   error = FT_Err_Ok;
2330    FT_Face    face;
2331    FT_Memory  memory;
2332    FT_CMap    cmap;
2333
2334
2335    if ( clazz == NULL || charmap == NULL || charmap->face == NULL )
2336      return FT_Err_Invalid_Argument;
2337
2338    face   = charmap->face;
2339    memory = FT_FACE_MEMORY( face );
2340
2341    if ( !FT_ALLOC( cmap, clazz->size ) )
2342    {
2343      cmap->charmap = *charmap;
2344      cmap->clazz   = clazz;
2345
2346      if ( clazz->init )
2347      {
2348        error = clazz->init( cmap, init_data );
2349        if ( error )
2350          goto Fail;
2351      }
2352
2353      /* add it to our list of charmaps */
2354      if ( FT_RENEW_ARRAY( face->charmaps,
2355                           face->num_charmaps,
2356                           face->num_charmaps + 1 ) )
2357        goto Fail;
2358
2359      face->charmaps[face->num_charmaps++] = (FT_CharMap)cmap;
2360    }
2361
2362  Exit:
2363    if ( acmap )
2364      *acmap = cmap;
2365
2366    return error;
2367
2368  Fail:
2369    ft_cmap_done_internal( cmap );
2370    cmap = NULL;
2371    goto Exit;
2372  }
2373
2374
2375  /* documentation is in freetype.h */
2376
2377  FT_EXPORT_DEF( FT_UInt )
2378  FT_Get_Char_Index( FT_Face   face,
2379                     FT_ULong  charcode )
2380  {
2381    FT_UInt  result = 0;
2382
2383
2384    if ( face && face->charmap )
2385    {
2386      FT_CMap  cmap = FT_CMAP( face->charmap );
2387
2388
2389      result = cmap->clazz->char_index( cmap, charcode );
2390    }
2391    return  result;
2392  }
2393
2394
2395  /* documentation is in freetype.h */
2396
2397  FT_EXPORT_DEF( FT_ULong )
2398  FT_Get_First_Char( FT_Face   face,
2399                     FT_UInt  *agindex )
2400  {
2401    FT_ULong  result = 0;
2402    FT_UInt   gindex = 0;
2403
2404
2405    if ( face && face->charmap )
2406    {
2407      gindex = FT_Get_Char_Index( face, 0 );
2408      if ( gindex == 0 )
2409        result = FT_Get_Next_Char( face, 0, &gindex );
2410    }
2411
2412    if ( agindex  )
2413      *agindex = gindex;
2414
2415    return result;
2416  }
2417
2418
2419  /* documentation is in freetype.h */
2420
2421  FT_EXPORT_DEF( FT_ULong )
2422  FT_Get_Next_Char( FT_Face   face,
2423                    FT_ULong  charcode,
2424                    FT_UInt  *agindex )
2425  {
2426    FT_ULong  result = 0;
2427    FT_UInt   gindex = 0;
2428
2429
2430    if ( face && face->charmap )
2431    {
2432      FT_UInt32  code = (FT_UInt32)charcode;
2433      FT_CMap    cmap = FT_CMAP( face->charmap );
2434
2435
2436      gindex = cmap->clazz->char_next( cmap, &code );
2437      result = ( gindex == 0 ) ? 0 : code;
2438    }
2439
2440    if ( agindex )
2441      *agindex = gindex;
2442
2443    return result;
2444  }
2445
2446
2447  /* documentation is in freetype.h */
2448
2449  FT_EXPORT_DEF( FT_UInt )
2450  FT_Get_Name_Index( FT_Face     face,
2451                     FT_String*  glyph_name )
2452  {
2453    FT_UInt  result = 0;
2454
2455
2456    if ( face && FT_HAS_GLYPH_NAMES( face ) )
2457    {
2458      FT_Service_GlyphDict  service;
2459
2460
2461      FT_FACE_LOOKUP_SERVICE( face,
2462                              service,
2463                              GLYPH_DICT );
2464
2465      if ( service && service->name_index )
2466        result = service->name_index( face, glyph_name );
2467    }
2468
2469    return result;
2470  }
2471
2472
2473  /* documentation is in freetype.h */
2474
2475  FT_EXPORT_DEF( FT_Error )
2476  FT_Get_Glyph_Name( FT_Face     face,
2477                     FT_UInt     glyph_index,
2478                     FT_Pointer  buffer,
2479                     FT_UInt     buffer_max )
2480  {
2481    FT_Error  error = FT_Err_Invalid_Argument;
2482
2483
2484    /* clean up buffer */
2485    if ( buffer && buffer_max > 0 )
2486      ((FT_Byte*)buffer)[0] = 0;
2487
2488    if ( face                                     &&
2489         glyph_index <= (FT_UInt)face->num_glyphs &&
2490         FT_HAS_GLYPH_NAMES( face )               )
2491    {
2492      FT_Service_GlyphDict  service;
2493
2494
2495      FT_FACE_LOOKUP_SERVICE( face,
2496                              service,
2497                              GLYPH_DICT );
2498
2499      if ( service && service->get_name )
2500        error = service->get_name( face, glyph_index, buffer, buffer_max );
2501    }
2502
2503    return error;
2504  }
2505
2506
2507  /* documentation is in freetype.h */
2508
2509  FT_EXPORT_DEF( const char* )
2510  FT_Get_Postscript_Name( FT_Face  face )
2511  {
2512    const char*  result = NULL;
2513
2514
2515    if ( !face )
2516      goto Exit;
2517
2518    if ( !result )
2519    {
2520      FT_Service_PsFontName  service;
2521
2522
2523      FT_FACE_LOOKUP_SERVICE( face,
2524                              service,
2525                              POSTSCRIPT_FONT_NAME );
2526
2527      if ( service && service->get_ps_font_name )
2528        result = service->get_ps_font_name( face );
2529    }
2530
2531  Exit:
2532    return result;
2533  }
2534
2535
2536  /* documentation is in tttables.h */
2537
2538  FT_EXPORT_DEF( void* )
2539  FT_Get_Sfnt_Table( FT_Face      face,
2540                     FT_Sfnt_Tag  tag )
2541  {
2542    void*                  table = 0;
2543    FT_Service_SFNT_Table  service;
2544
2545
2546    if ( face && FT_IS_SFNT( face ) )
2547    {
2548      FT_FACE_FIND_SERVICE( face, service, SFNT_TABLE );
2549      if ( service != NULL )
2550        table = service->get_table( face, tag );
2551    }
2552
2553    return table;
2554  }
2555
2556
2557  /* documentation is in tttables.h */
2558
2559  FT_EXPORT_DEF( FT_Error )
2560  FT_Load_Sfnt_Table( FT_Face    face,
2561                      FT_ULong   tag,
2562                      FT_Long    offset,
2563                      FT_Byte*   buffer,
2564                      FT_ULong*  length )
2565  {
2566    FT_Service_SFNT_Table  service;
2567
2568
2569    if ( !face || !FT_IS_SFNT( face ) )
2570      return FT_Err_Invalid_Face_Handle;
2571
2572    FT_FACE_FIND_SERVICE( face, service, SFNT_TABLE );
2573    if ( service == NULL )
2574      return FT_Err_Unimplemented_Feature;
2575
2576    return service->load_table( face, tag, offset, buffer, length );
2577  }
2578
2579
2580  /* documentation is in tttables.h */
2581
2582  FT_EXPORT_DEF( FT_Error )
2583  FT_Sfnt_Table_Info( FT_Face    face,
2584                      FT_UInt    table_index,
2585                      FT_ULong  *tag,
2586                      FT_ULong  *length )
2587  {
2588    FT_Service_SFNT_Table  service;
2589
2590
2591    if ( !face || !FT_IS_SFNT( face ) )
2592      return FT_Err_Invalid_Face_Handle;
2593
2594    FT_FACE_FIND_SERVICE( face, service, SFNT_TABLE );
2595    if ( service == NULL )
2596      return FT_Err_Unimplemented_Feature;
2597
2598    return service->table_info( face, table_index, tag, length );
2599  }
2600
2601
2602  /* documentation is in tttables.h */
2603
2604  FT_EXPORT_DEF( FT_ULong )
2605  FT_Get_CMap_Language_ID( FT_CharMap  charmap )
2606  {
2607    FT_Service_TTCMaps  service;
2608    FT_Face             face;
2609    TT_CMapInfo         cmap_info;
2610
2611
2612    if ( !charmap || !charmap->face )
2613      return 0;
2614
2615    face = charmap->face;
2616    FT_FACE_FIND_SERVICE( face, service, TT_CMAP );
2617    if ( service == NULL )
2618      return 0;
2619    if ( service->get_cmap_info( charmap, &cmap_info ))
2620      return 0;
2621
2622    return cmap_info.language;
2623  }
2624
2625
2626  /* documentation is in ftsizes.h */
2627
2628  FT_EXPORT_DEF( FT_Error )
2629  FT_Activate_Size( FT_Size  size )
2630  {
2631    FT_Face  face;
2632
2633
2634    if ( size == NULL )
2635      return FT_Err_Bad_Argument;
2636
2637    face = size->face;
2638    if ( face == NULL || face->driver == NULL )
2639      return FT_Err_Bad_Argument;
2640
2641    /* we don't need anything more complex than that; all size objects */
2642    /* are already listed by the face                                  */
2643    face->size = size;
2644
2645    return FT_Err_Ok;
2646  }
2647
2648
2649  /*************************************************************************/
2650  /*************************************************************************/
2651  /*************************************************************************/
2652  /****                                                                 ****/
2653  /****                                                                 ****/
2654  /****                        R E N D E R E R S                        ****/
2655  /****                                                                 ****/
2656  /****                                                                 ****/
2657  /*************************************************************************/
2658  /*************************************************************************/
2659  /*************************************************************************/
2660
2661  /* lookup a renderer by glyph format in the library's list */
2662  FT_BASE_DEF( FT_Renderer )
2663  FT_Lookup_Renderer( FT_Library       library,
2664                      FT_Glyph_Format  format,
2665                      FT_ListNode*     node )
2666  {
2667    FT_ListNode  cur;
2668    FT_Renderer  result = 0;
2669
2670
2671    if ( !library )
2672      goto Exit;
2673
2674    cur = library->renderers.head;
2675
2676    if ( node )
2677    {
2678      if ( *node )
2679        cur = (*node)->next;
2680      *node = 0;
2681    }
2682
2683    while ( cur )
2684    {
2685      FT_Renderer  renderer = FT_RENDERER( cur->data );
2686
2687
2688      if ( renderer->glyph_format == format )
2689      {
2690        if ( node )
2691          *node = cur;
2692
2693        result = renderer;
2694        break;
2695      }
2696      cur = cur->next;
2697    }
2698
2699  Exit:
2700    return result;
2701  }
2702
2703
2704  static FT_Renderer
2705  ft_lookup_glyph_renderer( FT_GlyphSlot  slot )
2706  {
2707    FT_Face      face    = slot->face;
2708    FT_Library   library = FT_FACE_LIBRARY( face );
2709    FT_Renderer  result  = library->cur_renderer;
2710
2711
2712    if ( !result || result->glyph_format != slot->format )
2713      result = FT_Lookup_Renderer( library, slot->format, 0 );
2714
2715    return result;
2716  }
2717
2718
2719  static void
2720  ft_set_current_renderer( FT_Library  library )
2721  {
2722    FT_Renderer  renderer;
2723
2724
2725    renderer = FT_Lookup_Renderer( library, FT_GLYPH_FORMAT_OUTLINE, 0 );
2726    library->cur_renderer = renderer;
2727  }
2728
2729
2730  static FT_Error
2731  ft_add_renderer( FT_Module  module )
2732  {
2733    FT_Library   library = module->library;
2734    FT_Memory    memory  = library->memory;
2735    FT_Error     error;
2736    FT_ListNode  node;
2737
2738
2739    if ( FT_NEW( node ) )
2740      goto Exit;
2741
2742    {
2743      FT_Renderer         render = FT_RENDERER( module );
2744      FT_Renderer_Class*  clazz  = (FT_Renderer_Class*)module->clazz;
2745
2746
2747      render->clazz        = clazz;
2748      render->glyph_format = clazz->glyph_format;
2749
2750      /* allocate raster object if needed */
2751      if ( clazz->glyph_format == FT_GLYPH_FORMAT_OUTLINE &&
2752           clazz->raster_class->raster_new )
2753      {
2754        error = clazz->raster_class->raster_new( memory, &render->raster );
2755        if ( error )
2756          goto Fail;
2757
2758        render->raster_render = clazz->raster_class->raster_render;
2759        render->render        = clazz->render_glyph;
2760      }
2761
2762      /* add to list */
2763      node->data = module;
2764      FT_List_Add( &library->renderers, node );
2765
2766      ft_set_current_renderer( library );
2767    }
2768
2769  Fail:
2770    if ( error )
2771      FT_FREE( node );
2772
2773  Exit:
2774    return error;
2775  }
2776
2777
2778  static void
2779  ft_remove_renderer( FT_Module  module )
2780  {
2781    FT_Library   library = module->library;
2782    FT_Memory    memory  = library->memory;
2783    FT_ListNode  node;
2784
2785
2786    node = FT_List_Find( &library->renderers, module );
2787    if ( node )
2788    {
2789      FT_Renderer  render = FT_RENDERER( module );
2790
2791
2792      /* release raster object, if any */
2793      if ( render->raster )
2794        render->clazz->raster_class->raster_done( render->raster );
2795
2796      /* remove from list */
2797      FT_List_Remove( &library->renderers, node );
2798      FT_FREE( node );
2799
2800      ft_set_current_renderer( library );
2801    }
2802  }
2803
2804
2805  /* documentation is in ftrender.h */
2806
2807  FT_EXPORT_DEF( FT_Renderer )
2808  FT_Get_Renderer( FT_Library       library,
2809                   FT_Glyph_Format  format )
2810  {
2811    /* test for valid `library' delayed to FT_Lookup_Renderer() */
2812
2813    return FT_Lookup_Renderer( library, format, 0 );
2814  }
2815
2816
2817  /* documentation is in ftrender.h */
2818
2819  FT_EXPORT_DEF( FT_Error )
2820  FT_Set_Renderer( FT_Library     library,
2821                   FT_Renderer    renderer,
2822                   FT_UInt        num_params,
2823                   FT_Parameter*  parameters )
2824  {
2825    FT_ListNode  node;
2826    FT_Error     error = FT_Err_Ok;
2827
2828
2829    if ( !library )
2830      return FT_Err_Invalid_Library_Handle;
2831
2832    if ( !renderer )
2833      return FT_Err_Invalid_Argument;
2834
2835    node = FT_List_Find( &library->renderers, renderer );
2836    if ( !node )
2837    {
2838      error = FT_Err_Invalid_Argument;
2839      goto Exit;
2840    }
2841
2842    FT_List_Up( &library->renderers, node );
2843
2844    if ( renderer->glyph_format == FT_GLYPH_FORMAT_OUTLINE )
2845      library->cur_renderer = renderer;
2846
2847    if ( num_params > 0 )
2848    {
2849      FT_Renderer_SetModeFunc  set_mode = renderer->clazz->set_mode;
2850
2851
2852      for ( ; num_params > 0; num_params-- )
2853      {
2854        error = set_mode( renderer, parameters->tag, parameters->data );
2855        if ( error )
2856          break;
2857      }
2858    }
2859
2860  Exit:
2861    return error;
2862  }
2863
2864
2865  FT_BASE_DEF( FT_Error )
2866  FT_Render_Glyph_Internal( FT_Library      library,
2867                            FT_GlyphSlot    slot,
2868                            FT_Render_Mode  render_mode )
2869  {
2870    FT_Error     error = FT_Err_Ok;
2871    FT_Renderer  renderer;
2872
2873
2874    /* if it is already a bitmap, no need to do anything */
2875    switch ( slot->format )
2876    {
2877    case FT_GLYPH_FORMAT_BITMAP:   /* already a bitmap, don't do anything */
2878      break;
2879
2880    default:
2881      {
2882        FT_ListNode  node   = 0;
2883        FT_Bool      update = 0;
2884
2885
2886        /* small shortcut for the very common case */
2887        if ( slot->format == FT_GLYPH_FORMAT_OUTLINE )
2888        {
2889          renderer = library->cur_renderer;
2890          node     = library->renderers.head;
2891        }
2892        else
2893          renderer = FT_Lookup_Renderer( library, slot->format, &node );
2894
2895        error = FT_Err_Unimplemented_Feature;
2896        while ( renderer )
2897        {
2898          error = renderer->render( renderer, slot, render_mode, NULL );
2899          if ( !error ||
2900               FT_ERROR_BASE( error ) != FT_Err_Cannot_Render_Glyph )
2901            break;
2902
2903          /* FT_Err_Cannot_Render_Glyph is returned if the render mode   */
2904          /* is unsupported by the current renderer for this glyph image */
2905          /* format.                                                     */
2906
2907          /* now, look for another renderer that supports the same */
2908          /* format.                                               */
2909          renderer = FT_Lookup_Renderer( library, slot->format, &node );
2910          update   = 1;
2911        }
2912
2913        /* if we changed the current renderer for the glyph image format */
2914        /* we need to select it as the next current one                  */
2915        if ( !error && update && renderer )
2916          FT_Set_Renderer( library, renderer, 0, 0 );
2917      }
2918    }
2919
2920    return error;
2921  }
2922
2923
2924  /* documentation is in freetype.h */
2925
2926  FT_EXPORT_DEF( FT_Error )
2927  FT_Render_Glyph( FT_GlyphSlot    slot,
2928                   FT_Render_Mode  render_mode )
2929  {
2930    FT_Library  library;
2931
2932
2933    if ( !slot )
2934      return FT_Err_Invalid_Argument;
2935
2936    library = FT_FACE_LIBRARY( slot->face );
2937
2938    return FT_Render_Glyph_Internal( library, slot, render_mode );
2939  }
2940
2941
2942  /*************************************************************************/
2943  /*************************************************************************/
2944  /*************************************************************************/
2945  /****                                                                 ****/
2946  /****                                                                 ****/
2947  /****                         M O D U L E S                           ****/
2948  /****                                                                 ****/
2949  /****                                                                 ****/
2950  /*************************************************************************/
2951  /*************************************************************************/
2952  /*************************************************************************/
2953
2954
2955  /*************************************************************************/
2956  /*                                                                       */
2957  /* <Function>                                                            */
2958  /*    Destroy_Module                                                     */
2959  /*                                                                       */
2960  /* <Description>                                                         */
2961  /*    Destroys a given module object.  For drivers, this also destroys   */
2962  /*    all child faces.                                                   */
2963  /*                                                                       */
2964  /* <InOut>                                                               */
2965  /*     module :: A handle to the target driver object.                   */
2966  /*                                                                       */
2967  /* <Note>                                                                */
2968  /*     The driver _must_ be LOCKED!                                      */
2969  /*                                                                       */
2970  static void
2971  Destroy_Module( FT_Module  module )
2972  {
2973    FT_Memory         memory  = module->memory;
2974    FT_Module_Class*  clazz   = module->clazz;
2975    FT_Library        library = module->library;
2976
2977
2978    /* finalize client-data - before anything else */
2979    if ( module->generic.finalizer )
2980      module->generic.finalizer( module );
2981
2982    if ( library && library->auto_hinter == module )
2983      library->auto_hinter = 0;
2984
2985    /* if the module is a renderer */
2986    if ( FT_MODULE_IS_RENDERER( module ) )
2987      ft_remove_renderer( module );
2988
2989    /* if the module is a font driver, add some steps */
2990    if ( FT_MODULE_IS_DRIVER( module ) )
2991      Destroy_Driver( FT_DRIVER( module ) );
2992
2993    /* finalize the module object */
2994    if ( clazz->module_done )
2995      clazz->module_done( module );
2996
2997    /* discard it */
2998    FT_FREE( module );
2999  }
3000
3001
3002  /* documentation is in ftmodule.h */
3003
3004  FT_EXPORT_DEF( FT_Error )
3005  FT_Add_Module( FT_Library              library,
3006                 const FT_Module_Class*  clazz )
3007  {
3008    FT_Error   error;
3009    FT_Memory  memory;
3010    FT_Module  module;
3011    FT_UInt    nn;
3012
3013
3014#define FREETYPE_VER_FIXED  ( ( (FT_Long)FREETYPE_MAJOR << 16 ) | \
3015                                FREETYPE_MINOR                  )
3016
3017    if ( !library )
3018      return FT_Err_Invalid_Library_Handle;
3019
3020    if ( !clazz )
3021      return FT_Err_Invalid_Argument;
3022
3023    /* check freetype version */
3024    if ( clazz->module_requires > FREETYPE_VER_FIXED )
3025      return FT_Err_Invalid_Version;
3026
3027    /* look for a module with the same name in the library's table */
3028    for ( nn = 0; nn < library->num_modules; nn++ )
3029    {
3030      module = library->modules[nn];
3031      if ( ft_strcmp( module->clazz->module_name, clazz->module_name ) == 0 )
3032      {
3033        /* this installed module has the same name, compare their versions */
3034        if ( clazz->module_version <= module->clazz->module_version )
3035          return FT_Err_Lower_Module_Version;
3036
3037        /* remove the module from our list, then exit the loop to replace */
3038        /* it by our new version..                                        */
3039        FT_Remove_Module( library, module );
3040        break;
3041      }
3042    }
3043
3044    memory = library->memory;
3045    error  = FT_Err_Ok;
3046
3047    if ( library->num_modules >= FT_MAX_MODULES )
3048    {
3049      error = FT_Err_Too_Many_Drivers;
3050      goto Exit;
3051    }
3052
3053    /* allocate module object */
3054    if ( FT_ALLOC( module, clazz->module_size ) )
3055      goto Exit;
3056
3057    /* base initialization */
3058    module->library = library;
3059    module->memory  = memory;
3060    module->clazz   = (FT_Module_Class*)clazz;
3061
3062    /* check whether the module is a renderer - this must be performed */
3063    /* before the normal module initialization                         */
3064    if ( FT_MODULE_IS_RENDERER( module ) )
3065    {
3066      /* add to the renderers list */
3067      error = ft_add_renderer( module );
3068      if ( error )
3069        goto Fail;
3070    }
3071
3072    /* is the module a auto-hinter? */
3073    if ( FT_MODULE_IS_HINTER( module ) )
3074      library->auto_hinter = module;
3075
3076    /* if the module is a font driver */
3077    if ( FT_MODULE_IS_DRIVER( module ) )
3078    {
3079      /* allocate glyph loader if needed */
3080      FT_Driver  driver = FT_DRIVER( module );
3081
3082
3083      driver->clazz = (FT_Driver_Class)module->clazz;
3084      if ( FT_DRIVER_USES_OUTLINES( driver ) )
3085      {
3086        error = FT_GlyphLoader_New( memory, &driver->glyph_loader );
3087        if ( error )
3088          goto Fail;
3089      }
3090    }
3091
3092    if ( clazz->module_init )
3093    {
3094      error = clazz->module_init( module );
3095      if ( error )
3096        goto Fail;
3097    }
3098
3099    /* add module to the library's table */
3100    library->modules[library->num_modules++] = module;
3101
3102  Exit:
3103    return error;
3104
3105  Fail:
3106    if ( FT_MODULE_IS_DRIVER( module ) )
3107    {
3108      FT_Driver  driver = FT_DRIVER( module );
3109
3110
3111      if ( FT_DRIVER_USES_OUTLINES( driver ) )
3112        FT_GlyphLoader_Done( driver->glyph_loader );
3113    }
3114
3115    if ( FT_MODULE_IS_RENDERER( module ) )
3116    {
3117      FT_Renderer  renderer = FT_RENDERER( module );
3118
3119
3120      if ( renderer->raster )
3121        renderer->clazz->raster_class->raster_done( renderer->raster );
3122    }
3123
3124    FT_FREE( module );
3125    goto Exit;
3126  }
3127
3128
3129  /* documentation is in ftmodule.h */
3130
3131  FT_EXPORT_DEF( FT_Module )
3132  FT_Get_Module( FT_Library   library,
3133                 const char*  module_name )
3134  {
3135    FT_Module   result = 0;
3136    FT_Module*  cur;
3137    FT_Module*  limit;
3138
3139
3140    if ( !library || !module_name )
3141      return result;
3142
3143    cur   = library->modules;
3144    limit = cur + library->num_modules;
3145
3146    for ( ; cur < limit; cur++ )
3147      if ( ft_strcmp( cur[0]->clazz->module_name, module_name ) == 0 )
3148      {
3149        result = cur[0];
3150        break;
3151      }
3152
3153    return result;
3154  }
3155
3156
3157  /* documentation is in ftobjs.h */
3158
3159  FT_BASE_DEF( const void* )
3160  FT_Get_Module_Interface( FT_Library   library,
3161                           const char*  mod_name )
3162  {
3163    FT_Module  module;
3164
3165
3166    /* test for valid `library' delayed to FT_Get_Module() */
3167
3168    module = FT_Get_Module( library, mod_name );
3169
3170    return module ? module->clazz->module_interface : 0;
3171  }
3172
3173
3174  FT_BASE_DEF( FT_Pointer )
3175  ft_module_get_service( FT_Module    module,
3176                         const char*  service_id )
3177  {
3178    FT_Pointer  result = NULL;
3179
3180    if ( module )
3181    {
3182      FT_ASSERT( module->clazz && module->clazz->get_interface );
3183
3184     /* first, look for the service in the module
3185      */
3186      if ( module->clazz->get_interface )
3187        result = module->clazz->get_interface( module, service_id );
3188
3189      if ( result == NULL )
3190      {
3191       /* we didn't find it, look in all other modules then
3192        */
3193        FT_Library  library = module->library;
3194        FT_Module*  cur     = library->modules;
3195        FT_Module*  limit   = cur + library->num_modules;
3196
3197        for ( ; cur < limit; cur++ )
3198        {
3199          if ( cur[0] != module )
3200          {
3201            FT_ASSERT( cur[0]->clazz );
3202
3203            if ( cur[0]->clazz->get_interface )
3204            {
3205              result = cur[0]->clazz->get_interface( cur[0], service_id );
3206              if ( result != NULL )
3207                break;
3208            }
3209          }
3210        }
3211      }
3212    }
3213
3214    return result;
3215  }
3216
3217
3218  /* documentation is in ftmodule.h */
3219
3220  FT_EXPORT_DEF( FT_Error )
3221  FT_Remove_Module( FT_Library  library,
3222                    FT_Module   module )
3223  {
3224    /* try to find the module from the table, then remove it from there */
3225
3226    if ( !library )
3227      return FT_Err_Invalid_Library_Handle;
3228
3229    if ( module )
3230    {
3231      FT_Module*  cur   = library->modules;
3232      FT_Module*  limit = cur + library->num_modules;
3233
3234
3235      for ( ; cur < limit; cur++ )
3236      {
3237        if ( cur[0] == module )
3238        {
3239          /* remove it from the table */
3240          library->num_modules--;
3241          limit--;
3242          while ( cur < limit )
3243          {
3244            cur[0] = cur[1];
3245            cur++;
3246          }
3247          limit[0] = 0;
3248
3249          /* destroy the module */
3250          Destroy_Module( module );
3251
3252          return FT_Err_Ok;
3253        }
3254      }
3255    }
3256    return FT_Err_Invalid_Driver_Handle;
3257  }
3258
3259
3260  /*************************************************************************/
3261  /*************************************************************************/
3262  /*************************************************************************/
3263  /****                                                                 ****/
3264  /****                                                                 ****/
3265  /****                         L I B R A R Y                           ****/
3266  /****                                                                 ****/
3267  /****                                                                 ****/
3268  /*************************************************************************/
3269  /*************************************************************************/
3270  /*************************************************************************/
3271
3272
3273  /* documentation is in ftmodule.h */
3274
3275  FT_EXPORT_DEF( FT_Error )
3276  FT_New_Library( FT_Memory    memory,
3277                  FT_Library  *alibrary )
3278  {
3279    FT_Library  library = 0;
3280    FT_Error    error;
3281
3282
3283    if ( !memory )
3284      return FT_Err_Invalid_Argument;
3285
3286#ifdef FT_DEBUG_LEVEL_ERROR
3287    /* init debugging support */
3288    ft_debug_init();
3289#endif
3290
3291    /* first of all, allocate the library object */
3292    if ( FT_NEW( library ) )
3293      return error;
3294
3295    library->memory = memory;
3296
3297    /* allocate the render pool */
3298    library->raster_pool_size = FT_RENDER_POOL_SIZE;
3299    if ( FT_ALLOC( library->raster_pool, FT_RENDER_POOL_SIZE ) )
3300      goto Fail;
3301
3302    /* That's ok now */
3303    *alibrary = library;
3304
3305    return FT_Err_Ok;
3306
3307  Fail:
3308    FT_FREE( library );
3309    return error;
3310  }
3311
3312
3313  /* documentation is in freetype.h */
3314
3315  FT_EXPORT_DEF( void )
3316  FT_Library_Version( FT_Library   library,
3317                      FT_Int      *amajor,
3318                      FT_Int      *aminor,
3319                      FT_Int      *apatch )
3320  {
3321    FT_Int  major = 0;
3322    FT_Int  minor = 0;
3323    FT_Int  patch = 0;
3324
3325
3326    if ( library )
3327    {
3328      major = library->version_major;
3329      minor = library->version_minor;
3330      patch = library->version_patch;
3331    }
3332
3333    if ( amajor )
3334      *amajor = major;
3335
3336    if ( aminor )
3337      *aminor = minor;
3338
3339    if ( apatch )
3340      *apatch = patch;
3341  }
3342
3343
3344  /* documentation is in ftmodule.h */
3345
3346  FT_EXPORT_DEF( FT_Error )
3347  FT_Done_Library( FT_Library  library )
3348  {
3349    FT_Memory  memory;
3350
3351
3352    if ( !library )
3353      return FT_Err_Invalid_Library_Handle;
3354
3355    memory = library->memory;
3356
3357    /* Discard client-data */
3358    if ( library->generic.finalizer )
3359      library->generic.finalizer( library );
3360
3361    /* Close all modules in the library */
3362#if 1
3363    while ( library->num_modules > 0 )
3364      FT_Remove_Module( library, library->modules[0] );
3365#else
3366    {
3367      FT_UInt  n;
3368
3369
3370      for ( n = 0; n < library->num_modules; n++ )
3371      {
3372        FT_Module  module = library->modules[n];
3373
3374
3375        if ( module )
3376        {
3377          Destroy_Module( module );
3378          library->modules[n] = 0;
3379        }
3380      }
3381    }
3382#endif
3383
3384    /* Destroy raster objects */
3385    FT_FREE( library->raster_pool );
3386    library->raster_pool_size = 0;
3387
3388    FT_FREE( library );
3389    return FT_Err_Ok;
3390  }
3391
3392
3393  /* documentation is in ftmodule.h */
3394
3395  FT_EXPORT_DEF( void )
3396  FT_Set_Debug_Hook( FT_Library         library,
3397                     FT_UInt            hook_index,
3398                     FT_DebugHook_Func  debug_hook )
3399  {
3400    if ( library && debug_hook &&
3401         hook_index <
3402           ( sizeof ( library->debug_hooks ) / sizeof ( void* ) ) )
3403      library->debug_hooks[hook_index] = debug_hook;
3404  }
3405
3406
3407/* END */
Note: See TracBrowser for help on using the repository browser.