/*  pcfread.c    FreeType font driver for pcf fonts  Copyright 2000-2001, 2002 by  Francesco Zappa NardelliPermission is hereby granted, free of charge, to any person obtaining a copyof this software and associated documentation files (the "Software"), to dealin the Software without restriction, including without limitation the rightsto use, copy, modify, merge, publish, distribute, sublicense, and/or sellcopies of the Software, and to permit persons to whom the Software isfurnished to do so, subject to the following conditions:The above copyright notice and this permission notice shall be included inall copies or substantial portions of the Software.THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS ORIMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.  IN NO EVENT SHALL THEAUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHERLIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS INTHE SOFTWARE.*/#include <ft2build.h>#include FT_INTERNAL_DEBUG_H#include FT_INTERNAL_STREAM_H#include FT_INTERNAL_OBJECTS_H#include "pcf.h"#include "pcfdriver.h"#include "pcferror.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_pcfread#if defined( FT_DEBUG_LEVEL_TRACE )  static const char*  tableNames[] =  {    "prop", "accl", "mtrcs", "bmps", "imtrcs",    "enc", "swidth", "names", "accel"  };#endif  static  const FT_Frame_Field  pcf_toc_header[] =  {#undef  FT_STRUCTURE#define FT_STRUCTURE  PCF_TocRec    FT_FRAME_START( 8 ),      FT_FRAME_ULONG_LE( version ),      FT_FRAME_ULONG_LE( count ),    FT_FRAME_END  };  static  const FT_Frame_Field  pcf_table_header[] =  {#undef  FT_STRUCTURE#define FT_STRUCTURE  PCF_TableRec    FT_FRAME_START( 16  ),      FT_FRAME_ULONG_LE( type ),      FT_FRAME_ULONG_LE( format ),      FT_FRAME_ULONG_LE( size ),      FT_FRAME_ULONG_LE( offset ),    FT_FRAME_END  };  static FT_Error  pcf_read_TOC( FT_Stream  stream,                PCF_Face   face )  {    FT_Error   error;    PCF_Toc    toc = &face->toc;    PCF_Table  tables;    FT_Memory  memory = FT_FACE(face)->memory;    FT_UInt    n;    if ( FT_STREAM_SEEK ( 0 )                          ||         FT_STREAM_READ_FIELDS ( pcf_toc_header, toc ) )      return PCF_Err_Cannot_Open_Resource;    if ( toc->version != PCF_FILE_VERSION )      return PCF_Err_Invalid_File_Format;    if ( FT_NEW_ARRAY( face->toc.tables, toc->count ) )      return PCF_Err_Out_Of_Memory;    tables = face->toc.tables;    for ( n = 0; n < toc->count; n++ )    {      if ( FT_STREAM_READ_FIELDS( pcf_table_header, tables ) )        goto Exit;      tables++;    }#if defined( FT_DEBUG_LEVEL_TRACE )    {      FT_UInt      i, j;      const char*  name = "?";      FT_TRACE4(( "Tables count: %ld\n", face->toc.count ));      tables = face->toc.tables;      for ( i = 0; i < toc->count; i++ )      {        for( j = 0; j < sizeof ( tableNames ) / sizeof ( tableNames[0] ); j++ )          if ( tables[i].type == (FT_UInt)( 1 << j ) )            name = tableNames[j];        FT_TRACE4(( "Table %d: type=%-6s format=0x%04lX "                    "size=0x%06lX (%8ld) offset=0x%04lX\n",                    i, name,                    tables[i].format,                    tables[i].size, tables[i].size,                    tables[i].offset ));      }    }#endif    return PCF_Err_Ok;  Exit:    FT_FREE( face->toc.tables );    return error;  }  static  const FT_Frame_Field  pcf_metric_header[] =  {#undef  FT_STRUCTURE#define FT_STRUCTURE  PCF_MetricRec    FT_FRAME_START( 12 ),      FT_FRAME_SHORT_LE( leftSideBearing ),      FT_FRAME_SHORT_LE( rightSideBearing ),      FT_FRAME_SHORT_LE( characterWidth ),      FT_FRAME_SHORT_LE( ascent ),      FT_FRAME_SHORT_LE( descent ),      FT_FRAME_SHORT_LE( attributes ),    FT_FRAME_END  };  static  const FT_Frame_Field  pcf_metric_msb_header[] =  {#undef  FT_STRUCTURE#define FT_STRUCTURE  PCF_MetricRec    FT_FRAME_START( 12 ),      FT_FRAME_SHORT( leftSideBearing ),      FT_FRAME_SHORT( rightSideBearing ),      FT_FRAME_SHORT( characterWidth ),      FT_FRAME_SHORT( ascent ),      FT_FRAME_SHORT( descent ),      FT_FRAME_SHORT( attributes ),    FT_FRAME_END  };  static  const FT_Frame_Field  pcf_compressed_metric_header[] =  {#undef  FT_STRUCTURE#define FT_STRUCTURE  PCF_Compressed_MetricRec    FT_FRAME_START( 5 ),      FT_FRAME_BYTE( leftSideBearing ),      FT_FRAME_BYTE( rightSideBearing ),      FT_FRAME_BYTE( characterWidth ),      FT_FRAME_BYTE( ascent ),      FT_FRAME_BYTE( descent ),    FT_FRAME_END  };  static FT_Error  pcf_get_metric( FT_Stream   stream,                  FT_ULong    format,                  PCF_Metric  metric )  {    FT_Error  error = PCF_Err_Ok;    if ( PCF_FORMAT_MATCH( format, PCF_DEFAULT_FORMAT ) )    {      const FT_Frame_Field*  fields;      /* parsing normal metrics */      fields = PCF_BYTE_ORDER( format ) == MSBFirst               ? pcf_metric_msb_header               : pcf_metric_header;      /* the following sets 'error' but doesn't return in case of failure */      (void)FT_STREAM_READ_FIELDS( fields, metric );    }    else    {      PCF_Compressed_MetricRec  compr;      /* parsing compressed metrics */      if ( FT_STREAM_READ_FIELDS( pcf_compressed_metric_header, &compr ) )        goto Exit;      metric->leftSideBearing  = (FT_Short)( compr.leftSideBearing  - 0x80 );      metric->rightSideBearing = (FT_Short)( compr.rightSideBearing - 0x80 );      metric->characterWidth   = (FT_Short)( compr.characterWidth   - 0x80 );      metric->ascent           = (FT_Short)( compr.ascent           - 0x80 );      metric->descent          = (FT_Short)( compr.descent          - 0x80 );      metric->attributes       = 0;    }  Exit:    return error;  }  static FT_Error  pcf_seek_to_table_type( FT_Stream  stream,                          PCF_Table  tables,                          FT_Int     ntables,                          FT_ULong   type,                          FT_ULong  *aformat,                          FT_ULong  *asize )  {    FT_Error  error = 0;    FT_Int    i;    for ( i = 0; i < ntables; i++ )      if ( tables[i].type == type )      {        if ( stream->pos > tables[i].offset )          return PCF_Err_Invalid_Stream_Skip;        if ( FT_STREAM_SKIP( tables[i].offset - stream->pos ) )          return PCF_Err_Invalid_Stream_Skip;        *asize   = tables[i].size;  /* unused - to be removed */        *aformat = tables[i].format;        return PCF_Err_Ok;      }    return PCF_Err_Invalid_File_Format;  }  static FT_Bool  pcf_has_table_type( PCF_Table  tables,                      FT_Int     ntables,                      FT_ULong   type )  {    FT_Int  i;    for ( i = 0; i < ntables; i++ )      if ( tables[i].type == type )        return TRUE;    return FALSE;  }  static  const FT_Frame_Field  pcf_property_header[] =  {#undef  FT_STRUCTURE#define FT_STRUCTURE  PCF_ParsePropertyRec    FT_FRAME_START( 9 ),      FT_FRAME_LONG_LE( name ),      FT_FRAME_BYTE   ( isString ),      FT_FRAME_LONG_LE( value ),    FT_FRAME_END  };  static  const FT_Frame_Field  pcf_property_msb_header[] =  {#undef  FT_STRUCTURE#define FT_STRUCTURE  PCF_ParsePropertyRec    FT_FRAME_START( 9 ),      FT_FRAME_LONG( name ),      FT_FRAME_BYTE( isString ),      FT_FRAME_LONG( value ),    FT_FRAME_END  };  static PCF_Property  pcf_find_property( PCF_Face          face,                     const FT_String*  prop )  {    PCF_Property  properties = face->properties;    FT_Bool       found      = 0;    int           i;    for ( i = 0 ; i < face->nprops && !found; i++ )    {      if ( !ft_strcmp( properties[i].name, prop ) )        found = 1;    }    if ( found )      return properties + i - 1;    else      return NULL;  }  static FT_Error  pcf_get_properties( FT_Stream  stream,                      PCF_Face   face )  {    PCF_ParseProperty  props      = 0;    PCF_Property       properties = 0;    FT_Int             nprops, i;    FT_ULong           format, size;    FT_Error           error;    FT_Memory          memory     = FT_FACE(face)->memory;    FT_ULong           string_size;    FT_String*         strings    = 0;    error = pcf_seek_to_table_type( stream,                                    face->toc.tables,                                    face->toc.count,                                    PCF_PROPERTIES,                                    &format,                                    &size );    if ( error )      goto Bail;    if ( FT_READ_ULONG_LE( format ) )      goto Bail;    FT_TRACE4(( "get_prop: format = %ld\n", format ));    if ( !PCF_FORMAT_MATCH( format, PCF_DEFAULT_FORMAT ) )      goto Bail;    if ( PCF_BYTE_ORDER( format ) == MSBFirst )      (void)FT_READ_ULONG( nprops );    else      (void)FT_READ_ULONG_LE( nprops );    if ( error )      goto Bail;    FT_TRACE4(( "get_prop: nprop = %d\n", nprops ));    if ( FT_NEW_ARRAY( props, nprops ) )      goto Bail;    for ( i = 0; i < nprops; i++ )    {      if ( PCF_BYTE_ORDER( format ) == MSBFirst )      {        if ( FT_STREAM_READ_FIELDS( pcf_property_msb_header, props + i ) )          goto Bail;      }      else      {        if ( FT_STREAM_READ_FIELDS( pcf_property_header, props + i ) )          goto Bail;      }    }    /* pad the property array                                            */    /*                                                                   */    /* clever here - nprops is the same as the number of odd-units read, */    /* as only isStringProp are odd length   (Keith Packard)             */    /*                                                                   */    if ( nprops & 3 )    {      i = 4 - ( nprops & 3 );      FT_Stream_Skip( stream, i );    }    if ( PCF_BYTE_ORDER( format ) == MSBFirst )      (void)FT_READ_ULONG( string_size );    else      (void)FT_READ_ULONG_LE( string_size );    if ( error )      goto Bail;    FT_TRACE4(( "get_prop: string_size = %ld\n", string_size ));    if ( FT_NEW_ARRAY( strings, string_size ) )      goto Bail;    error = FT_Stream_Read( stream, (FT_Byte*)strings, string_size );    if ( error )      goto Bail;    if ( FT_NEW_ARRAY( properties, nprops ) )      goto Bail;    for ( i = 0; i < nprops; i++ )    {      /* XXX: make atom */      if ( FT_NEW_ARRAY( properties[i].name,                         ft_strlen( strings + props[i].name ) + 1 ) )        goto Bail;      ft_strcpy( properties[i].name,strings + props[i].name );      properties[i].isString = props[i].isString;      if ( props[i].isString )      {        if ( FT_NEW_ARRAY( properties[i].value.atom,                           ft_strlen( strings + props[i].value ) + 1 ) )          goto Bail;        ft_strcpy( properties[i].value.atom, strings + props[i].value );      }      else        properties[i].value.integer = props[i].value;    }    face->properties = properties;    face->nprops = nprops;    FT_FREE( props );    FT_FREE( strings );    return PCF_Err_Ok;  Bail:    FT_FREE( props );    FT_FREE( strings );    return error;  }  static FT_Error  pcf_get_metrics( FT_Stream  stream,                   PCF_Face   face )  {    FT_Error    error    = PCF_Err_Ok;    FT_Memory   memory   = FT_FACE(face)->memory;    FT_ULong    format   = 0;    FT_ULong    size     = 0;    PCF_Metric  metrics  = 0;    int         i;    int         nmetrics = -1;    error = pcf_seek_to_table_type( stream,                                    face->toc.tables,                                    face->toc.count,                                    PCF_METRICS,                                    &format,                                    &size );    if ( error )      return error;    error = FT_READ_ULONG_LE( format );    if ( !PCF_FORMAT_MATCH( format, PCF_DEFAULT_FORMAT )     &&         !PCF_FORMAT_MATCH( format, PCF_COMPRESSED_METRICS ) )      return PCF_Err_Invalid_File_Format;    if ( PCF_FORMAT_MATCH( format, PCF_DEFAULT_FORMAT ) )    {      if ( PCF_BYTE_ORDER( format ) == MSBFirst )        (void)FT_READ_ULONG( nmetrics );      else        (void)FT_READ_ULONG_LE( nmetrics );    }    else    {      if ( PCF_BYTE_ORDER( format ) == MSBFirst )        (void)FT_READ_USHORT( nmetrics );      else        (void)FT_READ_USHORT_LE( nmetrics );    }    if ( error || nmetrics == -1 )      return PCF_Err_Invalid_File_Format;    face->nmetrics = nmetrics;    if ( FT_NEW_ARRAY( face->metrics, nmetrics ) )      return PCF_Err_Out_Of_Memory;    metrics = face->metrics;    for ( i = 0; i < nmetrics; i++ )    {      pcf_get_metric( stream, format, metrics + i );      metrics[i].bits = 0;      FT_TRACE4(( "%d : width=%d, "                  "lsb=%d, rsb=%d, ascent=%d, descent=%d, swidth=%d\n",                  i,                  ( metrics + i )->characterWidth,                  ( metrics + i )->leftSideBearing,                  ( metrics + i )->rightSideBearing,                  ( metrics + i )->ascent,                  ( metrics + i )->descent,