/***************************************************************************/

/*                                                                         */

/*  t1gload.c                                                              */

/*                                                                         */

/*    Type 1 Glyph Loader (body).                                          */

/*                                                                         */

/*  Copyright 1996-2001, 2002, 2003, 2004, 2005, 2006, 2008, 2009, 2010 by */

/*  David Turner, Robert Wilhelm, and Werner Lemberg.                      */

/*                                                                         */

/*  This file is part of the FreeType project, and may only be used,       */

/*  modified, and distributed under the terms of the FreeType project      */

/*  license, LICENSE.TXT.  By continuing to use, modify, or distribute     */

/*  this file you indicate that you have read the license and              */

/*  understand and accept it fully.                                        */

/*                                                                         */

/***************************************************************************/

#include <ft2build.h>

#include "t1gload.h"

#include FT_INTERNAL_CALC_H

#include FT_INTERNAL_DEBUG_H

#include FT_INTERNAL_STREAM_H

#include FT_OUTLINE_H

#include FT_INTERNAL_POSTSCRIPT_AUX_H

#include "t1errors.h"

  /*************************************************************************/

  /*                                                                       */

  /* The macro FT_COMPONENT is used in trace mode.  It is an implicit      */

  /* parameter of the FT_TRACE() and FT_ERROR() macros, used to print/log  */

  /* messages during execution.                                            */

  /*                                                                       */

#undef  FT_COMPONENT

#define FT_COMPONENT  trace_t1gload

  /*************************************************************************/

  /*************************************************************************/

  /*************************************************************************/

  /**********                                                      *********/

  /**********            COMPUTE THE MAXIMUM ADVANCE WIDTH         *********/

  /**********                                                      *********/

  /**********    The following code is in charge of computing      *********/

  /**********    the maximum advance width of the font.  It        *********/

  /**********    quickly processes each glyph charstring to        *********/

  /**********    extract the value from either a `sbw' or `seac'   *********/

  /**********    operator.                                         *********/

  /**********                                                      *********/

  /*************************************************************************/

  /*************************************************************************/

  /*************************************************************************/

  FT_LOCAL_DEF( FT_Error )

  T1_Parse_Glyph_And_Get_Char_String( T1_Decoder  decoder,

                                      FT_UInt     glyph_index,

                                      FT_Data*    char_string )

  {

    T1_Face   face  = (T1_Face)decoder->builder.face;

    T1_Font   type1 = &face->type1;

    FT_Error  error = T1_Err_Ok;

#ifdef FT_CONFIG_OPTION_INCREMENTAL

    FT_Incremental_InterfaceRec *inc =

                      face->root.internal->incremental_interface;

#endif

    decoder->font_matrix = type1->font_matrix;

    decoder->font_offset = type1->font_offset;

#ifdef FT_CONFIG_OPTION_INCREMENTAL

    /* For incremental fonts get the character data using the */

    /* callback function.                                     */

    if ( inc )

      error = inc->funcs->get_glyph_data( inc->object,

                                          glyph_index, char_string );

    else

#endif /* FT_CONFIG_OPTION_INCREMENTAL */

    /* For ordinary fonts get the character data stored in the face record. */

    {

      char_string->pointer = type1->charstrings[glyph_index];

      char_string->length  = (FT_Int)type1->charstrings_len[glyph_index];

    }

    if ( !error )

      error = decoder->funcs.parse_charstrings(

                decoder, (FT_Byte*)char_string->pointer,

                char_string->length );

#ifdef FT_CONFIG_OPTION_INCREMENTAL

    /* Incremental fonts can optionally override the metrics. */

    if ( !error && inc && inc->funcs->get_glyph_metrics )

    {

      FT_Incremental_MetricsRec  metrics;

      metrics.bearing_x = FIXED_TO_INT( decoder->builder.left_bearing.x );

      metrics.bearing_y = 0;

      metrics.advance   = FIXED_TO_INT( decoder->builder.advance.x );

      metrics.advance_v = FIXED_TO_INT( decoder->builder.advance.y );

      error = inc->funcs->get_glyph_metrics( inc->object,

                                             glyph_index, FALSE, &metrics );

      decoder->builder.left_bearing.x = INT_TO_FIXED( metrics.bearing_x );

      decoder->builder.advance.x      = INT_TO_FIXED( metrics.advance );

      decoder->builder.advance.y      = INT_TO_FIXED( metrics.advance_v );

    }

#endif /* FT_CONFIG_OPTION_INCREMENTAL */

    return error;

  }

  FT_CALLBACK_DEF( FT_Error )

  T1_Parse_Glyph( T1_Decoder  decoder,

                  FT_UInt     glyph_index )

  {

    FT_Data   glyph_data;

    FT_Error  error = T1_Parse_Glyph_And_Get_Char_String(

                        decoder, glyph_index, &glyph_data );

#ifdef FT_CONFIG_OPTION_INCREMENTAL

    if ( !error )

    {

      T1_Face  face = (T1_Face)decoder->builder.face;

      if ( face->root.internal->incremental_interface )

        face->root.internal->incremental_interface->funcs->free_glyph_data(

          face->root.internal->incremental_interface->object,

          &glyph_data );

    }

#endif /* FT_CONFIG_OPTION_INCREMENTAL */

    return error;

  }

  FT_LOCAL_DEF( FT_Error )

  T1_Compute_Max_Advance( T1_Face  face,

                          FT_Pos*  max_advance )

  {

    FT_Error       error;

    T1_DecoderRec  decoder;

    FT_Int         glyph_index;

    T1_Font        type1 = &face->type1;

    PSAux_Service  psaux = (PSAux_Service)face->psaux;

    FT_ASSERT( ( face->len_buildchar == 0 ) == ( face->buildchar == NULL ) );

    *max_advance = 0;

    /* initialize load decoder */

    error = psaux->t1_decoder_funcs->init( &decoder,

                                           (FT_Face)face,

                                           0, /* size       */

                                           0, /* glyph slot */

                                           (FT_Byte**)type1->glyph_names,

                                           face->blend,

                                           0,

                                           FT_RENDER_MODE_NORMAL,

                                           T1_Parse_Glyph );

    if ( error )

      return error;

    decoder.builder.metrics_only = 1;

    decoder.builder.load_points  = 0;

    decoder.num_subrs     = type1->num_subrs;

    decoder.subrs         = type1->subrs;

    decoder.subrs_len     = type1->subrs_len;

    decoder.buildchar     = face->buildchar;

    decoder.len_buildchar = face->len_buildchar;

    *max_advance = 0;

    /* for each glyph, parse the glyph charstring and extract */

    /* the advance width                                      */

    for ( glyph_index = 0; glyph_index < type1->num_glyphs; glyph_index++ )

    {

      /* now get load the unscaled outline */

      error = T1_Parse_Glyph( &decoder, glyph_index );

      if ( glyph_index == 0 || decoder.builder.advance.x > *max_advance )

        *max_advance = decoder.builder.advance.x;

      /* ignore the error if one occurred - skip to next glyph */

    }

    psaux->t1_decoder_funcs->done( &decoder );

    return T1_Err_Ok;

  }

  FT_LOCAL_DEF( FT_Error )

  T1_Get_Advances( T1_Face    face,

                   FT_UInt    first,

                   FT_UInt    count,

                   FT_ULong   load_flags,

                   FT_Fixed*  advances )

  {

    T1_DecoderRec  decoder;

    T1_Font        type1 = &face->type1;

    PSAux_Service  psaux = (PSAux_Service)face->psaux;

    FT_UInt        nn;

    FT_Error       error;

    if ( load_flags & FT_LOAD_VERTICAL_LAYOUT )

    {

      for ( nn = 0; nn < count; nn++ )

        advances[nn] = 0;

      return T1_Err_Ok;

    }

    error = psaux->t1_decoder_funcs->init( &decoder,

                                           (FT_Face)face,

                                           0, /* size       */

                                           0, /* glyph slot */

                                           (FT_Byte**)type1->glyph_names,

                                           face->blend,

                                           0,

                                           FT_RENDER_MODE_NORMAL,

                                           T1_Parse_Glyph );

    if ( error )

      return error;

    decoder.builder.metrics_only = 1;

    decoder.builder.load_points  = 0;

    decoder.num_subrs = type1->num_subrs;

    decoder.subrs     = type1->subrs;

    decoder.subrs_len = type1->subrs_len;

    decoder.buildchar     = face->buildchar;

    decoder.len_buildchar = face->len_buildchar;

    for ( nn = 0; nn < count; nn++ )

    {

      error = T1_Parse_Glyph( &decoder, first + nn );

      if ( !error )

        advances[nn] = FIXED_TO_INT( decoder.builder.advance.x );

      else

        advances[nn] = 0;

    }

    return T1_Err_Ok;

  }

  FT_LOCAL_DEF( FT_Error )

  T1_Load_Glyph( T1_GlyphSlot  glyph,

                 T1_Size       size,

                 FT_UInt       glyph_index,

                 FT_Int32      load_flags )

  {

    FT_Error                error;

    T1_DecoderRec           decoder;

    T1_Face                 face = (T1_Face)glyph->root.face;

    FT_Bool                 hinting;

    T1_Font                 type1         = &face->type1;

    PSAux_Service           psaux         = (PSAux_Service)face->psaux;

    const T1_Decoder_Funcs  decoder_funcs = psaux->t1_decoder_funcs;

    FT_Matrix               font_matrix;

    FT_Vector               font_offset;

    FT_Data                 glyph_data;

    FT_Bool                 must_finish_decoder = FALSE;

#ifdef FT_CONFIG_OPTION_INCREMENTAL

    FT_Bool                 glyph_data_loaded = 0;

#endif

#ifdef FT_CONFIG_OPTION_INCREMENTAL

    if ( glyph_index >= (FT_UInt)face->root.num_glyphs &&

         !face->root.internal->incremental_interface   )

#else

    if ( glyph_index >= (FT_UInt)face->root.num_glyphs )

#endif /* FT_CONFIG_OPTION_INCREMENTAL */

    {

      error = T1_Err_Invalid_Argument;

      goto Exit;

    }

    FT_ASSERT( ( face->len_buildchar == 0 ) == ( face->buildchar == NULL ) );

    if ( load_flags & FT_LOAD_NO_RECURSE )

      load_flags |= FT_LOAD_NO_SCALE | FT_LOAD_NO_HINTING;

    if ( size )

    {

      glyph->x_scale = size->root.metrics.x_scale;

      glyph->y_scale = size->root.metrics.y_scale;

    }

    else

    {

      glyph->x_scale = 0x10000L;

      glyph->y_scale = 0x10000L;

    }

    glyph->root.outline.n_points   = 0;

    glyph->root.outline.n_contours = 0;

    hinting = FT_BOOL( ( load_flags & FT_LOAD_NO_SCALE   ) == 0 &&

                       ( load_flags & FT_LOAD_NO_HINTING ) == 0 );

    glyph->root.format = FT_GLYPH_FORMAT_OUTLINE;

    error = decoder_funcs->init( &decoder,

                                 (FT_Face)face,

                                 (FT_Size)size,

                                 (FT_GlyphSlot)glyph,

                                 (FT_Byte**)type1->glyph_names,

                                 face->blend,

                                 FT_BOOL( hinting ),

                                 FT_LOAD_TARGET_MODE( load_flags ),

                                 T1_Parse_Glyph );

    if ( error )

      goto Exit;

    must_finish_decoder = TRUE;

    decoder.builder.no_recurse = FT_BOOL(

                                   ( load_flags & FT_LOAD_NO_RECURSE ) != 0 );

    decoder.num_subrs     = type1->num_subrs;

    decoder.subrs         = type1->subrs;

    decoder.subrs_len     = type1->subrs_len;

    decoder.buildchar     = face->buildchar;

    decoder.len_buildchar = face->len_buildchar;

    /* now load the unscaled outline */

    error = T1_Parse_Glyph_And_Get_Char_String( &decoder, glyph_index,

                                                &glyph_data );

    if ( error )

      goto Exit;

#ifdef FT_CONFIG_OPTION_INCREMENTAL

    glyph_data_loaded = 1;

#endif

    font_matrix = decoder.font_matrix;

    font_offset = decoder.font_offset;

    /* save new glyph tables */

    decoder_funcs->done( &decoder );

    must_finish_decoder = FALSE;

    /* now, set the metrics -- this is rather simple, as   */

    /* the left side bearing is the xMin, and the top side */

    /* bearing the yMax                                    */

    if ( !error )

    {

      glyph->root.outline.flags &= FT_OUTLINE_OWNER;

      glyph->root.outline.flags |= FT_OUTLINE_REVERSE_FILL;

      /* for composite glyphs, return only left side bearing and */

      /* advance width                                           */

      if ( load_flags & FT_LOAD_NO_RECURSE )

      {

        FT_Slot_Internal  internal = glyph->root.internal;

        glyph->root.metrics.horiBearingX =

          FIXED_TO_INT( decoder.builder.left_bearing.x );

        glyph->root.metrics.horiAdvance  =

          FIXED_TO_INT( decoder.builder.advance.x );

        internal->glyph_matrix      = font_matrix;

        internal->glyph_delta       = font_offset;

        internal->glyph_transformed = 1;

      }

      else

      {

        FT_BBox            cbox;

        FT_Glyph_Metrics*  metrics = &glyph->root.metrics;

        FT_Vector          advance;

        /* copy the _unscaled_ advance width */

        metrics->horiAdvance =

          FIXED_TO_INT( decoder.builder.advance.x );

        glyph->root.linearHoriAdvance =

          FIXED_TO_INT( decoder.builder.advance.x );

        glyph->root.internal->glyph_transformed = 0;

        if ( load_flags & FT_LOAD_VERTICAL_LAYOUT ) 

        {

          /* make up vertical ones */

          metrics->vertAdvance = ( face->type1.font_bbox.yMax -

                                   face->type1.font_bbox.yMin ) >> 16;

          glyph->root.linearVertAdvance = metrics->vertAdvance;

        }

        else

        {

          metrics->vertAdvance =

            FIXED_TO_INT( decoder.builder.advance.y );

          glyph->root.linearVertAdvance =

            FIXED_TO_INT( decoder.builder.advance.y );

        }

        glyph->root.format = FT_GLYPH_FORMAT_OUTLINE;

        if ( size && size->root.metrics.y_ppem < 24 )

          glyph->root.outline.flags |= FT_OUTLINE_HIGH_PRECISION;

#if 1

        /* apply the font matrix, if any */

        if ( font_matrix.xx != 0x10000L || font_matrix.yy != font_matrix.xx ||

             font_matrix.xy != 0        || font_matrix.yx != 0              )

          FT_Outline_Transform( &glyph->root.outline, &font_matrix );

        if ( font_offset.x || font_offset.y )

          FT_Outline_Translate( &glyph->root.outline,

                                font_offset.x,

                                font_offset.y );

        advance.x = metrics->horiAdvance;

        advance.y = 0;

        FT_Vector_Transform( &advance, &font_matrix );

        metrics->horiAdvance = advance.x + font_offset.x;

        advance.x = 0;

        advance.y = metrics->vertAdvance;

        FT_Vector_Transform( &advance, &font_matrix );

        metrics->vertAdvance = advance.y + font_offset.y;

#endif

        if ( ( load_flags & FT_LOAD_NO_SCALE ) == 0 )

        {

          /* scale the outline and the metrics */

          FT_Int       n;

          FT_Outline*  cur = decoder.builder.base;

          FT_Vector*   vec = cur->points;

          FT_Fixed     x_scale = glyph->x_scale;

          FT_Fixed     y_scale = glyph->y_scale;

          /* First of all, scale the points, if we are not hinting */

          if ( !hinting || ! decoder.builder.hints_funcs )

            for ( n = cur->n_points; n > 0; n--, vec++ )

            {

              vec->x = FT_MulFix( vec->x, x_scale );

              vec->y = FT_MulFix( vec->y, y_scale );

            }

          /* Then scale the metrics */

          metrics->horiAdvance = FT_MulFix( metrics->horiAdvance, x_scale );

          metrics->vertAdvance = FT_MulFix( metrics->vertAdvance, y_scale );

        }

        /* compute the other metrics */

        FT_Outline_Get_CBox( &glyph->root.outline, &cbox );

        metrics->width  = cbox.xMax - cbox.xMin;

        metrics->height = cbox.yMax - cbox.yMin;

        metrics->horiBearingX = cbox.xMin;

        metrics->horiBearingY = cbox.yMax;

        if ( load_flags & FT_LOAD_VERTICAL_LAYOUT ) 

        {

          /* make up vertical ones */

          ft_synthesize_vertical_metrics( metrics,

                                          metrics->vertAdvance );

        }

      }

      /* Set control data to the glyph charstrings.  Note that this is */

      /* _not_ zero-terminated.                                        */

      glyph->root.control_data = (FT_Byte*)glyph_data.pointer;

      glyph->root.control_len  = glyph_data.length;

    }

  Exit:

#ifdef FT_CONFIG_OPTION_INCREMENTAL

    if ( glyph_data_loaded && face->root.internal->incremental_interface )

    {

      face->root.internal->incremental_interface->funcs->free_glyph_data(

        face->root.internal->incremental_interface->object,

        &glyph_data );

      /* Set the control data to null - it is no longer available if   */

      /* loaded incrementally.                                         */

      glyph->root.control_data = 0;

      glyph->root.control_len  = 0;

    }

#endif

    if ( must_finish_decoder )

      decoder_funcs->done( &decoder );

    return error;

  }

/* END */